make API used by modules available externally

- use case: modules that are not compiled directly into Darshan but
would like to register modules and store data there

darshan-runtime/Makefile.in

@@ -195,6 +195,8 @@ endif
 	install -m 755 darshan-gen-cxx.pl $(bindir)
 	install -m 755 darshan-gen-fortran.pl $(bindir)
 	install -m 755 darshan-config $(bindir)
+	install -d $(includedir)
+	install -m 644 $(srcdir)/darshan-module-api.h $(includedir)
 	install -d $(datarootdir)/craype-1.x/modulefiles/darshan
 	install -m 755 share/craype-1.x/darshan-module $(datarootdir)/craype-1.x/modulefiles/darshan/$(DARSHAN_VERSION)
 	install -d $(datarootdir)/craype-2.x/modulefiles/darshan

darshan-runtime/configure

@@ -667,6 +667,7 @@ infodir
 docdir
 oldincludedir
 includedir
+runstatedir
 localstatedir
 sharedstatedir
 sysconfdir
@@ -753,6 +754,7 @@ datadir='${datarootdir}'
 sysconfdir='${prefix}/etc'
 sharedstatedir='${prefix}/com'
 localstatedir='${prefix}/var'
+runstatedir='${localstatedir}/run'
 includedir='${prefix}/include'
 oldincludedir='/usr/include'
 docdir='${datarootdir}/doc/${PACKAGE_TARNAME}'
@@ -1005,6 +1007,15 @@ do
   | -silent | --silent | --silen | --sile | --sil)
     silent=yes ;;
 
+  -runstatedir | --runstatedir | --runstatedi | --runstated \
+  | --runstate | --runstat | --runsta | --runst | --runs \
+  | --run | --ru | --r)
+    ac_prev=runstatedir ;;
+  -runstatedir=* | --runstatedir=* | --runstatedi=* | --runstated=* \
+  | --runstate=* | --runstat=* | --runsta=* | --runst=* | --runs=* \
+  | --run=* | --ru=* | --r=*)
+    runstatedir=$ac_optarg ;;
+
   -sbindir | --sbindir | --sbindi | --sbind | --sbin | --sbi | --sb)
     ac_prev=sbindir ;;
   -sbindir=* | --sbindir=* | --sbindi=* | --sbind=* | --sbin=* \
@@ -1142,7 +1153,7 @@ fi
 for ac_var in	exec_prefix prefix bindir sbindir libexecdir datarootdir \
 		datadir sysconfdir sharedstatedir localstatedir includedir \
 		oldincludedir docdir infodir htmldir dvidir pdfdir psdir \
-		libdir localedir mandir
+		libdir localedir mandir runstatedir
 do
   eval ac_val=\$$ac_var
   # Remove trailing slashes.
@@ -1295,6 +1306,7 @@ Fine tuning of the installation directories:
   --sysconfdir=DIR        read-only single-machine data [PREFIX/etc]
   --sharedstatedir=DIR    modifiable architecture-independent data [PREFIX/com]
   --localstatedir=DIR     modifiable single-machine data [PREFIX/var]
+  --runstatedir=DIR       modifiable per-process data [LOCALSTATEDIR/run]
   --libdir=DIR            object code libraries [EPREFIX/lib]
   --includedir=DIR        C header files [PREFIX/include]
   --oldincludedir=DIR     C header files for non-gcc [/usr/include]
@@ -3496,7 +3508,7 @@ ac_fn_c_check_header_mongrel "$LINENO" "zlib.h" "ac_cv_header_zlib_h" "$ac_inclu
 if test "x$ac_cv_header_zlib_h" = xyes; then :
 
 else
-  as_fn_error $? "z.h not found" "$LINENO" 5
+  as_fn_error $? "zlib.h not found" "$LINENO" 5
 fi
 
 

darshan-runtime/darshan-module-api.h

+/*
+ * Copyright (C) 2015 University of Chicago.
+ * See COPYRIGHT notice in top-level directory.
+ *
+ */
+
+#ifndef __DARSHAN_MODULE_API_H
+#define __DARSHAN_MODULE_API_H
+
+#include <unistd.h>
+#include <sys/types.h>
+#include <stdint.h>
+#include <mpi.h>
+
+#include "darshan-log-format.h"
+
+/* macros for declaring wrapper functions and calling MPI routines
+ * consistently regardless of whether static or dynamic linking is used
+ */
+#ifdef DARSHAN_PRELOAD
+
+#include <dlfcn.h>
+#include <stdlib.h>
+
+#define DARSHAN_FORWARD_DECL(__func,__ret,__args) \
+  __ret (*__real_ ## __func)__args = NULL
+
+#define DARSHAN_DECL(__func) __func
+
+/* creates P* variant of MPI symbols for LD_PRELOAD so that we can handle
+ * language bindings that map to MPI or PMPI symbols under the covers.
+ */
+#define DARSHAN_WRAPPER_MAP(__func,__ret,__args,__fcall) \
+	__ret __func __args { \
+		__ret i; \
+		i = __fcall; \
+		return i; \
+	}
+
+/* Map the desired function call to a pointer called __real_NAME at run
+ * time.  Note that we fall back to looking for the same symbol with a P
+ * prefix to handle MPI bindings that call directly to the PMPI layer.
+ */
+#define MAP_OR_FAIL(__func) \
+    if (!(__real_ ## __func)) \
+    { \
+        __real_ ## __func = dlsym(RTLD_NEXT, #__func); \
+        if(!(__real_ ## __func)) { \
+            fprintf(stderr, "Darshan failed to map symbol: %s\n", #__func); \
+            exit(1); \
+       } \
+    }
+
+#else
+
+#define DARSHAN_FORWARD_DECL(__name,__ret,__args) \
+  extern __ret __real_ ## __name __args;
+
+#define DARSHAN_DECL(__name) __wrap_ ## __name
+
+/* creates P* variant of MPI symbols for static linking so that we can handle
+ * language bindings that map to MPI or PMPI symbols under the covers.
+ */
+#define DARSHAN_WRAPPER_MAP(__func,__ret,__args,__fcall) \
+	__ret __wrap_ ## __func __args { \
+		__ret i; \
+		i = __wrap_ ## __fcall; \
+		return i; \
+	}
+
+#define MAP_OR_FAIL(__func)
+
+#endif
+
+/* default number of records to attempt to store for each module */
+#define DARSHAN_DEF_MOD_REC_COUNT 1024
+
+/* module developers must define a 'darshan_module_shutdown' function
+ * for allowing darshan-core to call into a module and retrieve final
+ * output data to be saved in the log.
+ *
+ * NOTE: module developers can use this function to run collective
+ * MPI operations at shutdown time. Typically this functionality
+ * has been used to reduce records shared globablly (given in the
+ * 'shared_recs' array) into a single data record.
+ */
+typedef void (*darshan_module_shutdown)(
+    MPI_Comm mod_comm,  /* MPI communicator to run collectives with */
+    darshan_record_id *shared_recs, /* list of shared data record ids */
+    int shared_rec_count, /* count of shared data records */
+    void **mod_buf, /* output parameter to save module buffer address */
+    int *mod_buf_sz /* output parameter to save module buffer size */
+);
+
+/* stores FS info from statfs calls for a given mount point */
+struct darshan_fs_info
+{
+    int fs_type;
+    int block_size;
+    int ost_count;
+    int mdt_count;
+};
+
+/* darshan_instrument_fs_data()
+ *
+ * Allow file system-specific modules to instrument data for the file
+ * stored at 'path'. 'fs_type' is checked to determine the underlying
+ * filesystem and calls into the corresponding file system instrumentation
+ * module, if defined -- currently we only have a Lustre module. 'fd' is
+ * the file descriptor corresponding to the file, which may be needed by
+ * the file system to retrieve specific parameters.
+ */
+void darshan_instrument_fs_data(
+    int fs_type,
+    const char *path,
+    int fd);
+
+/*****************************************************
+* darshan-core functions exported to darshan modules *
+*****************************************************/
+
+/* darshan_core_register_module()
+ *
+ * Register module identifier 'mod_id' with the darshan-core runtime
+ * environment, allowing the module to store I/O characterization data.
+ * 'mod_shutdown_func is a pointer to a function responsible for
+ * shutting down the module and returning final output data to darshan-core.
+ * 'inout_mod_buf_size' is an input/output argument, with it being
+ * set to the requested amount of module memory on input, and set to
+ * the amount allocated by darshan-core on output. If given, 'rank' is
+ * a pointer to an integer which will contain the calling process's
+ * MPI rank on return. If given, 'sys_mem_alignment' is a pointer to
+ * an integer which will contain the memory alignment value Darshan
+ * was configured with on return.
+ */
+void darshan_core_register_module(
+    darshan_module_id mod_id,
+    darshan_module_shutdown mod_shutdown_func,
+    int *inout_mod_buf_size,
+    int *rank,
+    int *sys_mem_alignment);
+
+/* darshan_core_unregister_module()
+ * 
+ * Unregisters module identifier 'mod_id' with the darshan-core runtime,
+ * removing the given module from the resulting I/O characterization log.
+ */
+void darshan_core_unregister_module(
+    darshan_module_id mod_id);
+
+/* darshan_core_gen_record_id()
+ *
+ * Returns the Darshan record ID correpsonding to input string 'name'.
+ */
+darshan_record_id darshan_core_gen_record_id(
+    const char *name);
+
+/* darshan_core_register_record()
+ *
+ * Register a record with the darshan-core runtime, allowing it to be
+ * properly tracked and (potentially) correlated with records from other
+ * modules. 'rec_id' is the Darshan record id as given by the
+ * `darshan_core_gen_record_id` function. 'name' is the the name of the
+ * Darshan record (e.g., the full file path), which is ignored if NULL is
+ * passed. 'mod_id' is the identifier of the calling module. 'rec_len'
+ * is the size of the record being registered with Darshan. If given,
+ * 'fs_info' is a pointer to a structure containing information on
+ * the underlying FS this record is associated with (determined by
+ * matching the file name prefix with Darshan's list of tracked mount
+ * points). Returns a pointer to the address the record should be
+ * written to on success, NULL on failure.
+ */
+void *darshan_core_register_record(
+    darshan_record_id rec_id,
+    const char *name,
+    darshan_module_id mod_id,
+    int rec_len,
+    struct darshan_fs_info *fs_info);
+
+/* darshan_core_wtime()
+ *
+ * Returns the elapsed time relative to (roughly) the start of
+ * the application.
+ */
+double darshan_core_wtime(void);
+
+/* darshan_core_excluded_path()
+ *
+ * Returns true (1) if the given file path 'path' is in Darshan's
+ * list of excluded file paths, false (0) otherwise.
+ */
+int darshan_core_excluded_path(
+    const char * path);
+
+/* darshan_core_disabled_instrumentation
+ *
+ * Returns true (1) if Darshan has currently disabled instrumentation,
+ * false (0) otherwise. If instrumentation is disabled, modules should
+ * no longer update any file records as part of the intercepted function
+ * wrappers.
+ */
+int darshan_core_disabled_instrumentation(void);
+
+#endif /* __DARSHAN_MODULE_API_H */

darshan-runtime/darshan.h

@@ -14,192 +14,6 @@
 
 #include "darshan-log-format.h"
 #include "darshan-common.h"
-
-/* macros for declaring wrapper functions and calling MPI routines
- * consistently regardless of whether static or dynamic linking is used
- */
-#ifdef DARSHAN_PRELOAD
-
-#include <dlfcn.h>
-#include <stdlib.h>
-
-#define DARSHAN_FORWARD_DECL(__func,__ret,__args) \
-  __ret (*__real_ ## __func)__args = NULL
-
-#define DARSHAN_DECL(__func) __func
-
-/* creates P* variant of MPI symbols for LD_PRELOAD so that we can handle
- * language bindings that map to MPI or PMPI symbols under the covers.
- */
-#define DARSHAN_WRAPPER_MAP(__func,__ret,__args,__fcall) \
-	__ret __func __args { \
-		__ret i; \
-		i = __fcall; \
-		return i; \
-	}
-
-/* Map the desired function call to a pointer called __real_NAME at run
- * time.  Note that we fall back to looking for the same symbol with a P
- * prefix to handle MPI bindings that call directly to the PMPI layer.
- */
-#define MAP_OR_FAIL(__func) \
-    if (!(__real_ ## __func)) \
-    { \
-        __real_ ## __func = dlsym(RTLD_NEXT, #__func); \
-        if(!(__real_ ## __func)) { \
-            fprintf(stderr, "Darshan failed to map symbol: %s\n", #__func); \
-            exit(1); \
-       } \
-    }
-
-#else
-
-#define DARSHAN_FORWARD_DECL(__name,__ret,__args) \
-  extern __ret __real_ ## __name __args;
-
-#define DARSHAN_DECL(__name) __wrap_ ## __name
-
-/* creates P* variant of MPI symbols for static linking so that we can handle
- * language bindings that map to MPI or PMPI symbols under the covers.
- */
-#define DARSHAN_WRAPPER_MAP(__func,__ret,__args,__fcall) \
-	__ret __wrap_ ## __func __args { \
-		__ret i; \
-		i = __wrap_ ## __fcall; \
-		return i; \
-	}
-
-#define MAP_OR_FAIL(__func)
-
-#endif
-
-/* default number of records to attempt to store for each module */
-#define DARSHAN_DEF_MOD_REC_COUNT 1024
-
-/* module developers must define a 'darshan_module_shutdown' function
- * for allowing darshan-core to call into a module and retrieve final
- * output data to be saved in the log.
- *
- * NOTE: module developers can use this function to run collective
- * MPI operations at shutdown time. Typically this functionality
- * has been used to reduce records shared globablly (given in the
- * 'shared_recs' array) into a single data record.
- */
-typedef void (*darshan_module_shutdown)(
-    MPI_Comm mod_comm,  /* MPI communicator to run collectives with */
-    darshan_record_id *shared_recs, /* list of shared data record ids */
-    int shared_rec_count, /* count of shared data records */
-    void **mod_buf, /* output parameter to save module buffer address */
-    int *mod_buf_sz /* output parameter to save module buffer size */
-);
-
-/* stores FS info from statfs calls for a given mount point */
-struct darshan_fs_info
-{
-    int fs_type;
-    int block_size;
-    int ost_count;
-    int mdt_count;
-};
-
-/* darshan_instrument_fs_data()
- *
- * Allow file system-specific modules to instrument data for the file
- * stored at 'path'. 'fs_type' is checked to determine the underlying
- * filesystem and calls into the corresponding file system instrumentation
- * module, if defined -- currently we only have a Lustre module. 'fd' is
- * the file descriptor corresponding to the file, which may be needed by
- * the file system to retrieve specific parameters.
- */
-void darshan_instrument_fs_data(
-    int fs_type,
-    const char *path,
-    int fd);
-
-/*****************************************************
-* darshan-core functions exported to darshan modules *
-*****************************************************/
-
-/* darshan_core_register_module()
- *
- * Register module identifier 'mod_id' with the darshan-core runtime
- * environment, allowing the module to store I/O characterization data.
- * 'mod_shutdown_func is a pointer to a function responsible for
- * shutting down the module and returning final output data to darshan-core.
- * 'inout_mod_buf_size' is an input/output argument, with it being
- * set to the requested amount of module memory on input, and set to
- * the amount allocated by darshan-core on output. If given, 'rank' is
- * a pointer to an integer which will contain the calling process's
- * MPI rank on return. If given, 'sys_mem_alignment' is a pointer to
- * an integer which will contain the memory alignment value Darshan
- * was configured with on return.
- */
-void darshan_core_register_module(
-    darshan_module_id mod_id,
-    darshan_module_shutdown mod_shutdown_func,
-    int *inout_mod_buf_size,
-    int *rank,
-    int *sys_mem_alignment);
-
-/* darshan_core_unregister_module()
- * 
- * Unregisters module identifier 'mod_id' with the darshan-core runtime,
- * removing the given module from the resulting I/O characterization log.
- */
-void darshan_core_unregister_module(
-    darshan_module_id mod_id);
-
-/* darshan_core_gen_record_id()
- *
- * Returns the Darshan record ID correpsonding to input string 'name'.
- */
-darshan_record_id darshan_core_gen_record_id(
-    const char *name);
-
-/* darshan_core_register_record()
- *
- * Register a record with the darshan-core runtime, allowing it to be
- * properly tracked and (potentially) correlated with records from other
- * modules. 'rec_id' is the Darshan record id as given by the
- * `darshan_core_gen_record_id` function. 'name' is the the name of the
- * Darshan record (e.g., the full file path), which is ignored if NULL is
- * passed. 'mod_id' is the identifier of the calling module. 'rec_len'
- * is the size of the record being registered with Darshan. If given,
- * 'fs_info' is a pointer to a structure containing information on
- * the underlying FS this record is associated with (determined by
- * matching the file name prefix with Darshan's list of tracked mount
- * points). Returns a pointer to the address the record should be
- * written to on success, NULL on failure.
- */
-void *darshan_core_register_record(
-    darshan_record_id rec_id,
-    const char *name,
-    darshan_module_id mod_id,
-    int rec_len,
-    struct darshan_fs_info *fs_info);
-
-/* darshan_core_wtime()
- *
- * Returns the elapsed time relative to (roughly) the start of
- * the application.
- */
-double darshan_core_wtime(void);
-
-/* darshan_core_excluded_path()
- *
- * Returns true (1) if the given file path 'path' is in Darshan's
- * list of excluded file paths, false (0) otherwise.
- */
-int darshan_core_excluded_path(
-    const char * path);
-
-/* darshan_core_disabled_instrumentation
- *
- * Returns true (1) if Darshan has currently disabled instrumentation,
- * false (0) otherwise. If instrumentation is disabled, modules should
- * no longer update any file records as part of the intercepted function
- * wrappers.
- */
-int darshan_core_disabled_instrumentation(void);
+#include "darshan-module-api.h"
 
 #endif /* __DARSHAN_H */