[Darshan-commits] [Darshan] branch, master, updated. darshan-2.3.1-pre1-26-g547fa7a

[Service Account]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "".

The branch, master has been updated
       via  547fa7af4c5993f4a89eb46412d7d7c52de4fc32 (commit)
      from  c904d6e0ad7b094ccf905ce297323d748cda31ae (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 547fa7af4c5993f4a89eb46412d7d7c52de4fc32
Author: Phil Carns <carns at mcs.anl.gov>
Date:   Sun Feb 8 10:30:28 2015 -0500

    documentation updates for profiling conf files

-----------------------------------------------------------------------

Summary of changes:
 ChangeLog                               |    5 ++-
 darshan-runtime/doc/darshan-runtime.txt |   50 +++++++++++++++++++++++++++----
 2 files changed, 47 insertions(+), 8 deletions(-)


Diff of changes:
diff --git a/ChangeLog b/ChangeLog
index 6706143..fa9950b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -4,6 +4,9 @@ Darshan Release Change Log
 
 darshan-2.3.1-pre2
 =============
+* added documentation and example configuration files for using the -profile
+  or $MPICC_PROFILE hooks to add instrumentation to MPICH-based MPI
+  implementations without generating custom wrapper scripts
 * Add wrappers for mkstemp(), mkostemp(), mkstemps(), and mkostemps()
   (reported by Tom Peterka)
 * Change OPEN_TIMESTAMP field to report timestamp right before open() is
@@ -29,8 +32,6 @@ darshan-2.3.1-pre2
 * update darshan-gen-fortran.pl and darshan-gen-cxx.pl to support new library
   naming conventions in MPICH 3.1.1 and higher
 * update documentation to reflect known issues with some versions of MPICH
-* added example mpicc profile configuration files, see share/mpi-profile/ 
-  subdirectory within installation directory
 
 darshan-2.3.0
 =============
diff --git a/darshan-runtime/doc/darshan-runtime.txt b/darshan-runtime/doc/darshan-runtime.txt
index da01a47..4b4897c 100644
--- a/darshan-runtime/doc/darshan-runtime.txt
+++ b/darshan-runtime/doc/darshan-runtime.txt
@@ -143,13 +143,17 @@ for details if you intend to force one mode or the other.
 
 == Instrumenting statically-linked applications
 
-Statically linked executables must be instrumented at compile time.  The
-simplest way to do this is to generate an MPI compiler script (e.g. `mpicc`)
-that includes the link options and libraries needed by Darshan.  Once this
-is done, Darshan instrumentation is transparent; you simply compile
-applications using the darshan-enabled MPI compiler scripts.
+Statically linked executables must be instrumented at compile time.
+The simplest methods to do this are to either generate a customized
+MPI compiler script (e.g. `mpicc`) that includes the link options and
+libraries needed by Darshan, or to use existing profiling configuration
+hooks for existing MPI compiler scripts.  Once this is done, Darshan
+instrumentation is transparent; you simply compile applications using
+the darshan-enabled MPI compiler scripts.
 
-For MPICH-based MPI libraries, such as MPICH1, MPICH2, or MVAPICH, these
+=== Using customized compiler wrapper scripts
+
+For MPICH-based MPI libraries, such as MPICH1, MPICH2, or MVAPICH, custom
 wrapper scripts can be generated automatically.  The following example
 illustrates how to produce wrappers for C, C++, and Fortran compilers:
 
@@ -160,6 +164,40 @@ darshan-gen-fortran.pl `which mpif77` --output mpif77.darshan
 darshan-gen-fortran.pl `which mpif90` --output mpif90.darshan
 -----
 
+=== Using a profile configuration 
+
+The MPICH MPI implementation supports the specification of a profiling library
+configuration, then it can be used to insert Darshan instrumentation without
+modifying the existing MPI compiler script.  Example profiling configuration
+files are installed with Darshan 2.3.1 and later.  You can enable a profiling
+configuration using environment variables or command line arguments to the
+compiler scripts:
+
+Example for MPICH 3.1.1 or newer:
+----
+export MPICC_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-cc
+export MPICXX_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-cxx
+export MPIFORT_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-f
+----
+
+Example for MPICH 3.1 or earlier:
+----
+export MPICC_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-cc
+export MPICXX_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-cxx
+export MPICF77_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-f
+export MPICF90_PROFILE=$DARSHAN_PREFIX/share/mpi-profile/darshan-f
+----
+
+Examples for command line use:
+----
+mpicc -profile=$DARSHAN_PREFIX/share/mpi-profile/darshan-c <args>
+mpicxx -profile=$DARSHAN_PREFIX/share/mpi-profile/darshan-cxx <args>
+mpif77 -profile=$DARSHAN_PREFIX/share/mpi-profile/darshan-f <args>
+mpif90 -profile=$DARSHAN_PREFIX/share/mpi-profile/darshan-f <args>
+----
+
+=== Other configurations
+
 Please see the Cray recipe in this document for instructions on
 instrumenting statically-linked applications on that platform.
 


hooks/post-receive
--