Skip to content

darshan-config: add a complete list of options configured #1054

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 4, 2025
Merged

darshan-config: add a complete list of options configured #1054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
894f88f
darshan-config: add a complete list of options configured
wkliao Jul 21, 2025
861d658
darshan-config.in - remove option name prefix --with
wkliao Jul 30, 2025
915522a
darshan-config.in - use DARSHAN_LOG_PATH and DARSHAN_LOG_ENV separately
wkliao Jul 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions darshan-runtime/configure.ac
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -651,6 +651,7 @@ if test "x$enable_darshan_runtime" = xyes ; then
)
])

rdtscp_num=
AC_ARG_ENABLE(rdtscp,
[ --enable-rdtscp=<num> Use RDTSCP intrinsic for timing, with specified base frequency],
[
Expand All @@ -662,6 +663,8 @@ if test "x$enable_darshan_runtime" = xyes ; then
fi
if test x$HAVE_RDTSCP != x1; then
AC_MSG_ERROR(attempted to enable rdtscp timer, but it is not supported on this platform)
else
rdtscp_num=${enableval}
fi
],
[]
Expand Down Expand Up @@ -832,6 +835,39 @@ else
with_jobid_env=
fi

AC_SUBST(ENABLE_LD_PRELOAD, ["$enable_ld_preload"])
AC_SUBST(ENABLE_CUSERID, ["$enable_cuserid"])
AC_SUBST(ENABLE_GROUP_READABLE_LOGS, ["$enable_group_readable_logs"])
AC_SUBST(ENABLE_MMAP_LOGS, ["$enable_mmap_logs"])
AC_SUBST(ENABLE_NULL_MOD, ["$enable_null_mod"])
AC_SUBST(ENABLE_POSIX_MOD, ["$enable_posix_mod"])
AC_SUBST(ENABLE_STDIO_MOD, ["$enable_stdio_mod"])
AC_SUBST(ENABLE_DXT_MOD, ["$enable_dxt_mod"])
AC_SUBST(ENABLE_HEATMAP_MOD, ["$enable_heatmap_mod"])
AC_SUBST(ENABLE_MPIIO_MOD, ["$enable_mpiio_mod"])
AC_SUBST(ENABLE_APMPI_MOD, ["$enable_apmpi_mod"])
AC_SUBST(ENABLE_APMPI_COLL_SYNC, ["$enable_apmpi_coll_sync"])
AC_SUBST(ENABLE_APXC_MOD, ["$enable_apxc_mod"])
AC_SUBST(ENABLE_HDF5_MOD, ["$enable_hdf5_mod"])
AC_SUBST(ENABLE_PNETCDF_MOD, ["$enable_pnetcdf_mod"])
AC_SUBST(ENABLE_DAOS_MOD, ["$enable_daos_mod"])
AC_SUBST(ENABLE_BGQ_MOD, ["$enable_bgq_mod"])
AC_SUBST(ENABLE_LUSTRE_MOD, ["$enable_lustre_mod"])
AC_SUBST(ENABLE_MDHIM_MOD, ["$enable_mdhim_mod"])
AC_SUBST(ENABLE_LDMS_MOD, ["$enable_ldms_mod"])
AC_SUBST(ENABLE_RDTSCP_NUM, ["$rdtscp_num"])
AC_SUBST(ENABLE_EXIT_WRAPPER, ["$enable_exit_wrapper"])
AC_SUBST(ZLIB_HOME, ["$ZLIB_HOME"])
AC_SUBST(MEM_ALIGN, ["$with_mem_align"])
AC_SUBST(DARSHAN_LOG_HINTS, ["$__DARSHAN_LOG_HINTS"])
AC_SUBST(JOBID_ENV, ["$with_jobid_env"])
AC_SUBST(USERNAME_ENV, ["$with_username_env"])
AC_SUBST(MOD_MEM, ["$with_mod_mem"])
AC_SUBST(NAME_MEM, ["$with_name_mem"])
AC_SUBST(HDF5_PATH, ["$with_hdf5"])
AC_SUBST(PNETCDF_PATH, ["$with_pnetcdf"])
AC_SUBST(DAOS_PATH, ["$with_daos"])
AC_SUBST(LDMS_PATH, ["$LDMS_HOME"])

AM_CONDITIONAL(ENABLE_MMAP_LOGS, [test "x$enable_mmap_logs" = xyes])
AM_CONDITIONAL(ENABLE_LDPRELOAD, [test "x$enable_ld_preload" = xyes])
Expand Down
277 changes: 250 additions & 27 deletions darshan-runtime/darshan-config.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/bin/sh
#
# See COPYRIGHT notice in top-level directory.
#
# @configure_input@

version="@PACKAGE_NAME@ @PACKAGE_VERSION@"

prefix="@prefix@"
exec_prefix="@exec_prefix@"
Expand All @@ -8,6 +14,118 @@ DARSHAN_LD_FLAGS="@LDFLAGS@"
DARSHAN_LOG_PATH="@__DARSHAN_LOG_PATH@"
DARSHAN_LOG_ENV="@__DARSHAN_LOG_ENV@"

C_COMPILER="@CC@"
C_COMPILER=`echo "$C_COMPILER" | sed -e 's/^[ \t]*//'`
CPPFLAGS="@CPPFLAGS@"
CPPFLAGS=`echo "$CPPFLAGS" | sed -e 's/^[ \t]*//'`
CFLAGS="@CFLAGS@"
CFLAGS=`echo "$CFLAGS" | sed -e 's/^[ \t]*//'`
LIBS="@LIBS@"
LIBS=`echo "$LIBS" | sed -e 's/^[ \t]*//'`

enable_ld_preload="@ENABLE_LD_PRELOAD@"
enable_cuserid="@ENABLE_CUSERID@"
enable_group_readable_logs="@ENABLE_GROUP_READABLE_LOGS@"
enable_mmap_logs="@ENABLE_MMAP_LOGS@"
enable_null_mod="@ENABLE_NULL_MOD@"
enable_posix_mod="@ENABLE_POSIX_MOD@"
enable_stdio_mod="@ENABLE_STDIO_MOD@"
enable_dxt_mod="@ENABLE_DXT_MOD@"
enable_heatmap_mod="@ENABLE_HEATMAP_MOD@"
enable_mpiio_mod="@ENABLE_MPIIO_MOD@"
enable_apmpi_mod="@ENABLE_APMPI_MOD@"
enable_apmpi_coll_sync="@ENABLE_APMPI_COLL_SYNC@"
enable_apxc_mod="@ENABLE_APXC_MOD@"
enable_hdf5_mod="@ENABLE_HDF5_MOD@"
enable_pnetcdf_mod="@ENABLE_PNETCDF_MOD@"
enable_daos_mod="@ENABLE_DAOS_MOD@"
enable_bgq_mod="@ENABLE_BGQ_MOD@"
enable_lustre_mod="@ENABLE_LUSTRE_MOD@"
enable_mdhim_mod="@ENABLE_MDHIM_MOD@"
enable_ldms_mod="@ENABLE_LDMS_MOD@"
enable_rdtscp_num="@ENABLE_RDTSCP_NUM@"
enable_exit_wrapper="@ENABLE_EXIT_WRAPPER@"

zlib_home="@ZLIB_HOME@"
mem_align="@MEM_ALIGN@"
log_hints="@DARSHAN_LOG_HINTS@"
jobid_env="@JOBID_ENV@"
if test "x$jobid_env" = xNONE ; then username_env= ; fi
username_env="@USERNAME_ENV@"
if test "x$username_env" = xno ; then username_env= ; fi
mod_mem="@MOD_MEM@"
if test "x$mod_mem" = xno ; then mod_mem= ; fi
name_mem="@NAME_MEM@"
if test "x$name_mem" = xno ; then name_mem= ; fi
hdf5_path="@HDF5_PATH@"
if test "x$hdf5_path" = xno ; then hdf5_path= ; fi
pnetcdf_path="@PNETCDF_PATH@"
if test "x$pnetcdf_path" = xno ; then pnetcdf_path= ; fi
daos_path="@DAOS_PATH@"
if test "x$daos_path" = xno ; then daos_path= ; fi
ldms_path="@LDMS_PATH@"
if test "x$ldms_path" = xno ; then ldms_path= ; fi

all()
{
echo
echo "This $version was built with the following features:"
echo
echo " --ld-preload -> $enable_ld_preload"
echo " --cuserid -> $enable_cuserid"
echo " --group-readable-logs -> $enable_group_readable_logs"
echo " --mmap-logs -> $enable_mmap_logs"
echo " --null-mod -> $enable_null_mod"
echo " --posix-mod -> $enable_posix_mod"
echo " --stdio-mod -> $enable_stdio_mod"
echo " --dxt-mod -> $enable_dxt_mod"
echo " --heatmap-mod -> $enable_heatmap_mod"
echo " --mpiio-mod -> $enable_mpiio_mod"
echo " --apmpi-mod -> $enable_apmpi_mod"
echo " --apmpi-coll-sync -> $enable_apmpi_coll_sync"
echo " --apxc-mod -> $enable_apxc_mod"
echo " --hdf5-mod -> $enable_hdf5_mod"
echo " --pnetcdf-mod -> $enable_pnetcdf_mod"
echo " --daos-mod -> $enable_daos_mod"
echo " --bgq-mod -> $enable_bgq_mod"
echo " --lustre-mod -> $enable_lustre_mod"
echo " --mdhim-mod -> $enable_mdhim_mod"
echo " --ldms-mod -> $enable_ldms_mod"
if test "x$enable_rdtscp_num" = x ; then
echo " --rdtscp -> no"
else
echo " --rdtscp -> $enable_rdtscp_num"
fi
echo " --exit-wrapper -> $enable_exit_wrapper"

echo
echo "This $version was built using the following compilers and flags:"
echo
echo " --cc -> $C_COMPILER"
echo " --cppflags -> $CPPFLAGS"
echo " --cflags -> $CFLAGS"
echo " --ldflags -> $LDFLAGS"
echo " --libs -> $LIBS"
echo ""
echo " --pre-ld-flags -> $PRE_LD_FLAGS"
echo " --post-ld-flags -> $POST_LD_FLAGS"
echo " --dyn-ld-flags -> $DYN_LD_FLAGS"
echo " --log-path -> $DARSHAN_LOG_PATH"
echo " --log-path-by-env -> $DARSHAN_LOG_ENV"
echo ""
echo " --zlib-path -> $zlib_home"
echo " --mem-align -> $mem_align"
echo " --log-hints -> $log_hints"
echo " --jobid-env -> $jobid_env"
echo " --username-env -> $username_env"
echo " --mod-mem -> $mod_mem"
echo " --name-mem -> $name_mem"
echo " --hdf5-path -> $hdf5_path"
echo " --pnetcdf-path -> $pnetcdf_path"
echo " --daos-path -> $daos_path"
echo " --ldms-path -> $ldms_path"
}

# NOTE:
# - we deliberately list libdarshan twice in the link command when
# statically linking. The first sets symbol wrapping options early in the
Expand All @@ -29,22 +147,86 @@ DYN_LD_FLAGS="-L$DARSHAN_LIB_PATH $DARSHAN_LD_FLAGS -Wl,-rpath=$DARSHAN_LIB_PATH
# LOG_ENV takes precedent over LOG_PATH, but both could be specified. The
# LOG_ENV may already be a comma saparated list, but we insert '$'
# characters to denote that these are environment variables.
if [ "$DARSHAN_LOG_ENV" ]; then
DARSHAN_LOG_ENV=`echo $DARSHAN_LOG_ENV | sed -e 's/^/\$/g'`
DARSHAN_LOG_ENV=`echo $DARSHAN_LOG_ENV | sed -e 's/,/,\$/g'`
fi
# if [ "$DARSHAN_LOG_ENV" ]; then
# DARSHAN_LOG_ENV=`echo $DARSHAN_LOG_ENV | sed -e 's/^/\$/g'`
# DARSHAN_LOG_ENV=`echo $DARSHAN_LOG_ENV | sed -e 's/,/,\$/g'`
# fi

# figure out if we need a comma separator to construct env and path list
if [ "$DARSHAN_LOG_ENV" -a "$DARSHAN_LOG_PATH" ]; then
DARSHAN_LOG_ALL="$DARSHAN_LOG_ENV,$DARSHAN_LOG_PATH"
elif [ "$DARSHAN_LOG_ENV" ]; then
DARSHAN_LOG_ALL=$DARSHAN_LOG_ENV
else
DARSHAN_LOG_ALL=$DARSHAN_LOG_PATH
fi
# if [ "$DARSHAN_LOG_ENV" -a "$DARSHAN_LOG_PATH" ]; then
# DARSHAN_LOG_ALL="$DARSHAN_LOG_ENV,$DARSHAN_LOG_PATH"
# elif [ "$DARSHAN_LOG_ENV" ]; then
# DARSHAN_LOG_ALL=$DARSHAN_LOG_ENV
# else
# DARSHAN_LOG_ALL=$DARSHAN_LOG_PATH
# fi

usage()
{
cat <<EOF
darshan-config is a utility program to display the build and installation
information of the Darshan runtime library.

Usage: darshan-config [OPTION]

Available values for OPTION include:

--help display this help message and exit
--all display all options
--cc C compiler used to build Darshan
--cflags C compiler flags used to build Darshan
--cppflags C pre-processor flags used to build Darshan
--ldflags Linker flags used to build Darshan
--libs Extra libraries used to build Darshan
--pre-ld-flags Linker flags for setting env variable LD_PRELOAD
--post-ld-flags Linker flags for statically linking
--dyn-ld-flags Linker flags for dynamically linking
--log-path Storage locations of Darshan log files
--log-path-by-env Comma separated list of environment variables to
check for log path location

--ld-preload Whether LD_PRELOAD library is enabled
--cuserid Whether cuserid() is used at run time
--group-readable-logs Whether log files are group readable
--mmap-logs Whether to use mmap I/O data to log file
--null-mod Whether NULL module is enabled
--posix-mod Whether POSIX module is enabled
--stdio-mod Whether STDIO module is enabled
--dxt-mod Whether DXT module is enabled
--heatmap-mod Whether HEATMAP module is enabled
--mpiio-mod Whether MPI-IO module is enabled
--apmpi-mod Whether AUTOPERF MPI module is enabled
--apmpi-coll-sync Whether sync for MPI collectives is enabled
--apxc-mod Whether AUTOPERF XC module is enabled
--hdf5-mod Whether HDF5 module is enabled
--pnetcdf-mod Whether PnetCDF module is enabled
--daos-mod Whether DAOS module is enabled
--bgq-mod Whether BG/Q module is enabled
--lustre-mod Whether Lustre module is enabled
--mdhim-mod Whether mdhim module is enabled
--ldms-mod Whether to include LDMS for runtime I/O monitoring
--rdtscp Frequency of using RDTSCP intrinsic for timing
--exit-wrapper Whether to wrap _exit() calls as last ditch shutdown
hook for the Darshan library when used in non-MPI mode

--zlib-path Root directory path of zlib installation
--mem-align Memory alignment in bytes
--log-hints List of MPI-IO hints for log file write
--jobid-env Name of environment variable that stores the jobid
--username-env Name of environment variable that stores the username
--mod-mem Maximum runtime memory consumption per process (in
MiB) across all instrumentation modules
--name-mem Maximum runtime memory consumption per process (in
MiB) for storing name records
--hdf5-path Installation directory for HDF5.
--pnetcdf-path Installation directory for PnetCDF.
--daos-path Installation directory for DAOS.
--ldms-path Root directory path of LDMS installation

EOF
exit $1
}

usage="\
Usage: darshan-config [--pre-ld-flags] [--post-ld-flags] [--dyn-ld-flags] [--log-path]"

if test $# -eq 0; then
echo "${usage}" 1>&2
Expand All @@ -58,22 +240,63 @@ while test $# -gt 0; do
esac

case $1 in
--pre-ld-flags)
echo $PRE_LD_FLAGS
;;
--post-ld-flags)
echo $POST_LD_FLAGS
;;
--dyn-ld-flags)
echo $DYN_LD_FLAGS
;;
--log-path)
echo $DARSHAN_LOG_ALL
;;
--help) usage 0 ;;
--all) all ;;

--version) echo "$version" ;;
--cc) echo "$C_COMPILER" ;;
--cflags) echo "$CFLAGS" ;;
--cppflags) echo "$CPPFLAGS" ;;
--libdir) echo "$DARSHAN_LIB_PATH" ;;
--ldflags) echo "$LDFLAGS" ;;
--libs) echo "$LIBS" ;;

--ld-preload) echo "$enable_ld_preload" ;;
--cuserid) echo "$enable_cuserid" ;;
--group-readable-logs) echo "$enable_group_readable_logs" ;;
--mmap-logs) echo "$enable_mmap_logs" ;;
--null-mod) echo "$enable_null_mod" ;;
--posix-mod) echo "$enable_posix_mod" ;;
--stdio-mod) echo "$enable_stdio_mod" ;;
--dxt-mod) echo "$enable_dxt_mod" ;;
--heatmap-mod) echo "$enable_heatmap_mod" ;;
--mpiio-mod) echo "$enable_mpiio_mod" ;;
--apmpi-mod) echo "$enable_apmpi_mod" ;;
--apmpi-coll-sync) echo "$enable_apmpi_coll_sync" ;;
--apxc-mod) echo "$enable_apxc_mod" ;;
--hdf5-mod) echo "$enable_hdf5_mod" ;;
--pnetcdf-mod) echo "$enable_pnetcdf_mod" ;;
--daos-mod) echo "$enable_daos_mod" ;;
--bgq-mod) echo "$enable_bgq_mod" ;;
--lustre-mod) echo "$enable_lustre_mod" ;;
--mdhim-mod) echo "$enable_mdhim_mod" ;;
--ldms-mod) echo "$enable_ldms_mod" ;;
--rdtscp) echo "$enable_rdtscp_num" ;;
--exit-wrapper) echo "$enable_exit_wrapper" ;;

--pre-ld-flags) echo "$PRE_LD_FLAGS" ;;
--post-ld-flags) echo "$POST_LD_FLAGS" ;;
--dyn-ld-flags) echo "$DYN_LD_FLAGS" ;;
--log-path) echo "$DARSHAN_LOG_PATH" ;;
--log-path-by-env) echo "$DARSHAN_LOG_ENV" ;;
--zlib-path) echo "$zlib_home" ;;
--mem-align) echo "$mem_align" ;;
--log-hints) echo "$log_hints" ;;
--jobid-env) echo "$jobid_env" ;;
--username-env) echo "$username_env" ;;
--mod-mem) echo "$mod_mem" ;;
--with-name-mem) echo "$name_mem" ;;
--hdf5-path) echo "$hdf5_path" ;;
--pnetcdf-path) echo "$pnetcdf_path" ;;
--daos-path) echo "$daos_path" ;;
--ldms-path) echo "$ldms_path" ;;
*)
echo "${usage}" 1>&2
exit 1
echo "unknown option: $1"
echo ""
usage 1
;;
esac
shift
done

exit 0