Merge pull request #1014 from darshan-hpc/snyder/dev-daos-module-3.4

ENH: DAOS and DFS modules

Author: shanedsnyder

darshan-runtime/configure.ac

@@ -487,6 +487,46 @@ if test "x$enable_darshan_runtime" = xyes ; then
                    use --with-pnetcdf to provide the PnetCDF install prefix, if needed.]))
    fi
 
+   # inform about DAOS installs not found in default locations
+   AC_ARG_WITH([daos],
+      [AS_HELP_STRING([--with-daos@<:@=DIR@:>@],
+                      [Installation directory for DAOS.])],
+      [], [with_daos=no]
+   )
+
+   # DAOS module (disabled by default)
+   AC_ARG_ENABLE([daos-mod],
+      [AS_HELP_STRING([--enable-daos-mod],
+                      [Enables compilation and use of DAOS module])],
+      [], [enable_daos_mod=no]
+   )
+   if test "x$enable_daos_mod" = xyes ; then
+      AC_CHECK_HEADERS(m4_normalize([daos_types.h daos_prop.h daos_pool.h daos_cont.h
+				     daos_obj.h daos_array.h daos_fs.h]),
+		      [],
+                      [AC_MSG_ERROR([Cannot find required DAOS headers])],
+                      [[
+		      #ifdef HAVE_DAOS_TYPES_H
+                      # include <daos_types.h>
+                      #endif
+		      #ifdef HAVE_DAOS_PROP_H
+                      # include <daos_prop.h>
+                      #endif
+		      #ifdef HAVE_DAOS_CONT_H
+		      # include <daos_cont.h>
+		      #endif
+		      #ifdef HAVE_DAOS_OBJ_H
+                      # include <daos_obj.h>
+                      #endif
+		      #ifdef HAVE_DAOS_ARRAY_H
+                      # include <daos_array.h>
+                      #endif
+                      ]])
+   elif test "x$enable_daos_mod" != xno ; then
+      AC_MSG_ERROR(m4_normalize([--enable-daos-mod does not take any argument,
+                   use --with-daos to provide the DAOS install prefix, if needed.]))
+   fi
+
    # BG/Q module
    AC_ARG_ENABLE([bgq-mod],
       [AS_HELP_STRING([--disable-bgq-mod],
@@ -809,6 +849,7 @@ AM_CONDITIONAL(BUILD_MDHIM_MODULE,  [test "x$enable_mdhim_mod"   = xyes])
 AM_CONDITIONAL(BUILD_APMPI_MODULE,  [test "x$enable_apmpi_mod"   = xyes])
 AM_CONDITIONAL(BUILD_APXC_MODULE,   [test "x$enable_apxc_mod"    = xyes])
 AM_CONDITIONAL(BUILD_HEATMAP_MODULE,[test "x$enable_heatmap_mod" = xyes])
+AM_CONDITIONAL(BUILD_DAOS_MODULE,   [test "x$enable_daos_mod"    = xyes])
 AM_CONDITIONAL(HAVE_LDMS,           [test "x$enable_ldms_mod"    = xyes])
 
 AC_CONFIG_FILES(Makefile \
@@ -884,6 +925,7 @@ if test "x$enable_darshan_runtime" = xyes ; then
            AUTOPERF MPI  module support  - $enable_apmpi_mod
            AUTOPERF XC   module support  - $enable_apxc_mod
            HDF5          module support  - $enable_hdf5_mod
+           DAOS          module support  - $enable_daos_mod
            PnetCDF       module support  - $enable_pnetcdf_mod
            BG/Q          module support  - $enable_bgq_mod
            Lustre        module support  - $enable_lustre_mod

darshan-runtime/doc/darshan-runtime.txt

@@ -146,6 +146,10 @@ make install
 ** NOTE: PnetCDF instrumentation only works on PnetCDF library versions >=1.8
 * `--disable-lustre-mod`: disables compilation and use of Darshan's Lustre
   module (default=enabled)
+* `--enable-daos-mod`: enables compilation and use of Darshan's DAOS module
+  (default=disabled)
+* `--with-daos=DIR`: installation directory for DAOS
+** NOTE: Users must call `--enable-daos-mod` to enable DAOS modules, `--with-daos` is only used to additionally provide a DAOS install prefix.
 * `--enable-mdhim-mod`: enables compilation and use of Darshan's MDHIM module
   (default=disabled)
 * `--enable-ldms-mod`:  enables compilation and use of Darshan’s LDMS runtime module (default=disabled)

darshan-runtime/lib/Makefile.am

@@ -71,6 +71,11 @@ if BUILD_HEATMAP_MODULE
    AM_CPPFLAGS += -DDARSHAN_HEATMAP
 endif
 
+if BUILD_DAOS_MODULE
+   C_SRCS += darshan-dfs.c darshan-daos.c
+   AM_CPPFLAGS += -DDARSHAN_DAOS
+endif
+
 .m4.c:
 	$(M4) $(AM_M4FLAGS) $(M4FLAGS) $< >$@
 
@@ -138,5 +143,7 @@ EXTRA_DIST = $(H_SRCS) \
              darshan-bgq.c \
              darshan-lustre.c \
              darshan-mdhim.c \
-             darshan-heatmap.c
+	     darshan-heatmap.c \
+	     darshan-dfs.c \
+	     darshan-daos.c
 

darshan-runtime/lib/darshan-core.c

@@ -116,7 +116,7 @@ static int darshan_should_instrument_rank(
     struct darshan_core_runtime *core);
 static void darshan_fs_info_from_path(
     const char *path, struct darshan_fs_info *fs_info);
-static int darshan_add_name_record_ref(
+static int darshan_update_name_record_ref(
     struct darshan_core_runtime *core, darshan_record_id rec_id,
     const char *name, darshan_module_id mod_id);
 static void darshan_get_user_name(
@@ -1301,51 +1301,87 @@ static void darshan_fs_info_from_path(const char *path, struct darshan_fs_info *
     return;
 }
 
-static int darshan_add_name_record_ref(struct darshan_core_runtime *core,
+static int darshan_update_name_record_ref(struct darshan_core_runtime *core,
     darshan_record_id rec_id, const char *name, darshan_module_id mod_id)
 {
-    struct darshan_core_name_record_ref *ref;
-    struct darshan_core_name_record_ref *check_ref;
-    int record_size = sizeof(darshan_record_id) + strlen(name) + 1;
+    int is_new_rec = 0;
+    struct darshan_core_name_record_ref *ref, *check_ref;
 
-    if((record_size + core->name_mem_used) > core->config.name_mem)
-        return(0);
+    /* if no name given, use the empty string */
+    if(!name) name = "";
 
-    /* drop core lock while we allocate reference.  Note that
-     * this means we must check for existence again in hash table once we
-     * re-acquire the lock, but this code path will only happen once per
-     * file.
-     */
-    __DARSHAN_CORE_UNLOCK();
-    ref = malloc(sizeof(*ref));
-    __DARSHAN_CORE_LOCK();
+    /* check to see if we've already stored the id->name mapping for this record */
+    HASH_FIND(hlink, core->name_hash, &rec_id, sizeof(rec_id), ref);
     if(!ref)
     {
-        return(0);
-    }
-    memset(ref, 0, sizeof(*ref));
+        /* drop core lock while we allocate reference.  Note that
+         * this means we must check for existence again in hash table once we
+         * re-acquire the lock, but this code path will only happen once per
+         * file.
+         */
+        __DARSHAN_CORE_UNLOCK();
+        ref = malloc(sizeof(*ref));
+        __DARSHAN_CORE_LOCK();
+        if(!ref)
+        {
+            return(0);
+        }
+        memset(ref, 0, sizeof(*ref));
 
-    /* make sure no one else added it while we dropped the lock */
-    HASH_FIND(hlink, core->name_hash, &rec_id,
-        sizeof(darshan_record_id), check_ref);
-    if(check_ref)
-        return(1);
+        HASH_FIND(hlink, core->name_hash, &rec_id, sizeof(rec_id), check_ref);
+        if(check_ref)
+        {
+            /* someone else added the ref while we dropped the lock */
+            free(ref);
+            ref = check_ref;
+        }
+        else
+        {
+            /* we need to allocate and add a new record ref */
+            is_new_rec = 1;
+        }
+    }
 
-    /* initialize the name record */
-    ref->name_record = (struct darshan_name_record *)
-        ((char *)core->log_name_p + core->name_mem_used);
-    memset(ref->name_record, 0, record_size);
-    ref->name_record->id = rec_id;
-    strcpy(ref->name_record->name, name);
-    DARSHAN_MOD_FLAG_SET(ref->mod_flags, mod_id);
+    /* set a new name record reference in 2 scenarios:
+     *   1.) creation of a new record ref
+     *   2.) detecting zero-length name on an existing record ref
+     *       (i.e., initial creator of the ref didn't specify a name)
+     */
+    if(is_new_rec || ((strlen(ref->name_record->name) == 0) && strlen(name) > 0))
+    {
+        int record_size = sizeof(darshan_record_id) + strlen(name) + 1;
+        if((record_size + core->name_mem_used) > core->config.name_mem)
+        {
+            /* no more room for this name record */
+            if(is_new_rec) free(ref);
+            return(0);
+        }
+        else
+        {
+            /* initialize new name record structure */
+            ref->name_record = (struct darshan_name_record *)
+                ((char *)core->log_name_p + core->name_mem_used);
+            memset(ref->name_record, 0, record_size);
+            ref->name_record->id = rec_id;
+            strcpy(ref->name_record->name, name);
 
-    HASH_ADD(hlink, core->name_hash, name_record->id,
-        sizeof(darshan_record_id), ref);
-    core->name_mem_used += record_size;
+            core->name_mem_used += record_size;
 #ifdef __DARSHAN_ENABLE_MMAP_LOGS
-    core->log_hdr_p->name_map.len += record_size;
+            core->log_hdr_p->name_map.len += record_size;
 #endif
+        }
+    }
+
+    DARSHAN_MOD_FLAG_SET(ref->mod_flags, mod_id);
 
+    if(is_new_rec)
+    {
+        /* add new record reference */
+        HASH_ADD(hlink, core->name_hash, name_record->id,
+            sizeof(darshan_record_id), ref);
+    }
+
+    /* successfully updated core record ref */
     return(1);
 }
 
@@ -2207,6 +2243,9 @@ static int darshan_core_name_is_excluded(const char *name, darshan_module_id mod
     int tmp_index = 0;
     struct darshan_core_regex *regex;
 
+    if(!name)
+        return(0);
+
     /* set flag if this module's record names are based on file paths */
     name_is_path = 1;
     if((mod_id == DARSHAN_APMPI_MOD) || (mod_id == DARSHAN_APXC_MOD) ||
@@ -2606,9 +2645,7 @@ void *darshan_core_register_record(
     size_t rec_size,
     struct darshan_fs_info *fs_info)
 {
-    struct darshan_core_name_record_ref *ref;
     void *rec_buf;
-    int ret;
 
     __DARSHAN_CORE_LOCK();
     if(!__darshan_core)
@@ -2625,35 +2662,19 @@ void *darshan_core_register_record(
         return(NULL);
     }
 
-    /* register a name record if a name is given for this record */
-    if(name)
+    if(darshan_core_name_is_excluded(name, mod_id))
     {
-        if(darshan_core_name_is_excluded(name, mod_id))
-        {
-            /* do not register record if name matches any exclusion rules */
-            __DARSHAN_CORE_UNLOCK();
-            return(NULL);
-        }
+        /* do not register record if name matches any exclusion rules */
+        __DARSHAN_CORE_UNLOCK();
+        return(NULL);
     }
 
-    /* check to see if we've already stored the id->name mapping for
-     * this record, and add a new name record if not
-     */
-    HASH_FIND(hlink, __darshan_core->name_hash, &rec_id,
-        sizeof(darshan_record_id), ref);
-    if(!ref)
+    if(!darshan_update_name_record_ref(__darshan_core, rec_id, name, mod_id))
     {
-        ret = darshan_add_name_record_ref(__darshan_core, rec_id, name, mod_id);
-        if(ret == 0)
-        {
-            DARSHAN_MOD_FLAG_SET(__darshan_core->log_hdr_p->partial_flag, mod_id);
-            __DARSHAN_CORE_UNLOCK();
-            return(NULL);
-        }
-    }
-    else
-    {
-        DARSHAN_MOD_FLAG_SET(ref->mod_flags, mod_id);
+        /* unable to update record ref, fail and set this module's partial flag */
+        DARSHAN_MOD_FLAG_SET(__darshan_core->log_hdr_p->partial_flag, mod_id);
+        __DARSHAN_CORE_UNLOCK();
+        return(NULL);
     }
 
     __darshan_core->mod_array[mod_id]->rec_mem_avail -= rec_size;
@@ -2683,7 +2704,7 @@ void *darshan_core_register_record(
     if(fs_info)
         darshan_fs_info_from_path(name, fs_info);
 
-    return(rec_buf);;
+    return(rec_buf);
 }
 
 char *darshan_core_lookup_record_name(darshan_record_id rec_id)