From 6aff723b0801d5df591f986f5606fa2ec4742cac Mon Sep 17 00:00:00 2001 From: Gerhard Theurich Date: Mon, 23 Oct 2023 15:59:02 -0700 Subject: [PATCH] Document Darwin's dynamic preload environment variable DYLD_INSERT_LIBRARIES. --- src/Infrastructure/Trace/doc/Trace_usage.tex | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/Infrastructure/Trace/doc/Trace_usage.tex b/src/Infrastructure/Trace/doc/Trace_usage.tex index f18e2b3ea4..8dfc63f507 100644 --- a/src/Infrastructure/Trace/doc/Trace_usage.tex +++ b/src/Infrastructure/Trace/doc/Trace_usage.tex @@ -248,11 +248,13 @@ \subsubsection{Include MPI Communication in the Profile} Note that for either option, ESMF must be built with {\tt ESMF\_TRACE\_BUILD\_LIB=ON}, which is the default. -In {\em dynamically linked applications}, the {\tt LD\_PRELOAD} environment variable -must be used when executing the MPI application. This instructs the dynamic -linker to interpose certain MPI symbols so they can be captured by the ESMF -profiler. To simplify this process, a script is provided at -{\tt \$(ESMF\_INSTALL\_LIBDIR)/preload.sh} that sets the {\tt LD\_PRELOAD} variable. +In {\em dynamically linked applications}, the {\tt LD\_PRELOAD} (Linux) or +{\tt DYLD\_INSERT\_LIBRARIES} (Darwin) environment variable must be used when +executing the MPI application. This instructs the dynamic loader to interpose +certain MPI symbols so they can be captured by the ESMF profiler. To simplify +this process, a script is provided at {\tt \$(ESMF\_INSTALL\_LIBDIR)/preload.sh} +that sets the appropriate variable. + For example, if you typically execute your application as as follows: \begin{verbatim}