Address pedantic compiler warnings (#2581)

samuelkgutierrez · web-flow · commit b54565f81718 · 2022-05-12T08:11:18.000-07:00
* Change how the global pmix_regattr_input_t dictionary is created.

This commit changes how the pmix_regattr_input_t dictionary is created.
It addresses a 'defined but not used' warning (or error) that is
generated when pedantic developer flags are enabled by
--enable-devel-check.

In particular, construct_dictionary.py now generates two files:
pmix_dictionary.h and pmix_dictionary.c. The previous methodology
generated a single file named dictionary.h. Please note that we changed
the name of the generated files to more closely match OpenPMIx's file
naming convention. Since the dictionary's symbol is now exported, we
also changed its name to pmix_dictionary. Additionally, the generated
array is now declared as const to match its intended usage.

construct_dictionary.py was also modified to address some warnings
generated by flake8. These changes were trivial.

Signed-off-by: Samuel K. Gutierrez &lt;samuel@lanl.gov&gt;

* Fix issues identified by Ralph.

Fixes 'no newline at end of file' warning and multiple definitions of
PMIX_INDEX_BOUNDARY.

Signed-off-by: Samuel K. Gutierrez &lt;samuel@lanl.gov&gt;

* Silence the remaining picky compiler warnings.

With this commit a build configured with --enable-devel-check now
compiles cleanly on my setup.

Signed-off-by: Samuel K. Gutierrez &lt;samuel@lanl.gov&gt;
diff --git a/contrib/construct_dictionary.py b/contrib/construct_dictionary.py
@@ -2,6 +2,7 @@
 # Copyright (c) 2020      Intel, Inc.  All rights reserved.
 # Copyright (c) 2020      Cisco Systems, Inc.  All rights reserved
 # Copyright (c) 2021-2022 Nanook Consulting.  All rights reserved.
+# Copyright (c) 2022      Triad National Security, LLC. All rights reserved.
 # $COPYRIGHT$
 #
 # Construct a dictionary for translating attributes to/from
@@ -10,11 +11,14 @@
 #
 
 from __future__ import print_function
-import os, os.path, sys, shutil
+import os
+import os.path
+import sys
 from optparse import OptionParser, OptionGroup
 
 index = 0
 
+
 def harvest_constants(options, path, constants):
     global index
     # open the file
@@ -234,6 +238,47 @@ def harvest_constants(options, path, constants):
     inputfile.close()
     return 0
 
+
+def _write_header(options, base_path, num_elements):
+    contents = '''/*
+ * This file is autogenerated by construct_dictionary.py.
+ * Do not edit this file by hand.
+ */
+
+#include "src/include/pmix_config.h"
+#include "src/include/pmix_globals.h"
+#include "include/pmix_common.h"
+
+#ifndef PMIX_DICTIONARY_H
+#define PMIX_DICTIONARY_H
+
+BEGIN_C_DECLS
+
+PMIX_EXPORT extern const pmix_regattr_input_t pmix_dictionary[{}];
+
+#define PMIX_INDEX_BOUNDARY {}
+
+END_C_DECLS
+
+#endif\n
+'''.format(num_elements, num_elements - 1)
+
+    if options.dryrun:
+        constants = sys.stdout
+        outpath = None
+    else:
+        outpath = os.path.join(base_path, "pmix_dictionary.h")
+        try:
+            constants = open(outpath, "w+")
+        except Exception as e:
+            print("{outpath} CANNOT BE OPENED - DICTIONARY COULD NOT BE CONSTRUCTED: {e}"
+                  .format(outpath=outpath, e=e))
+            return 1
+    constants.write(contents)
+    constants.close()
+    return 0
+
+
 def main():
     parser = OptionParser("usage: %prog [options]")
     debugGroup = OptionGroup(parser, "Debug Options")
@@ -272,24 +317,23 @@ def main():
         constants = sys.stdout
         outpath = None
     else:
-        outpath = os.path.join(build_src_include_dir, "dictionary.h")
+        outpath = os.path.join(build_src_include_dir, "pmix_dictionary.c")
         try:
             constants = open(outpath, "w+")
         except Exception as e:
             print("{outpath} CANNOT BE OPENED - DICTIONARY COULD NOT BE CONSTRUCTED: {e}"
                   .format(outpath=outpath, e=e))
             return 1
 
-    # write the header
+    # write the source file
     constants.write("""/*
  * This file is autogenerated by construct_dictionary.py.
  * Do not edit this file by hand.
  */
 
-#include "src/include/pmix_config.h"
-#include "src/include/pmix_globals.h"
+#include "src/include/pmix_dictionary.h"
 
-static pmix_regattr_input_t dictionary[] = {
+const pmix_regattr_input_t pmix_dictionary[] = {
 """)
 
     # scan across the header files in the src directory
@@ -323,9 +367,12 @@ def main():
     {.index = UINT32_MAX, .name = "", .string = "", .type = PMIX_POINTER, .description = (char *[]){"NONE", NULL}}
 };
 """)
-    constants.write("\n#define PMIX_INDEX_BOUNDARY  " + str(index) + "\n")
+    constants.write("\n")
     constants.close()
-    return 0
+
+    # write the header
+    return _write_header(options, build_src_include_dir, index + 1)
+
 
 if __name__ == '__main__':
     exit(main())
diff --git a/examples/dmodex.c b/examples/dmodex.c
@@ -17,6 +17,7 @@
  * Copyright (c) 2015      Mellanox Technologies, Inc.  All rights reserved.
  * Copyright (c) 2019-2022 IBM Corporation.  All rights reserved.
  * Copyright (c) 2021-2022 Nanook Consulting  All rights reserved.
+ * Copyright (c) 2022      Triad National Security, LLC. All rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -142,7 +143,7 @@ int main(int argc, char **argv)
     }
     PMIX_ARGV_FREE(peers);
 
-    snprintf(proc.nspace, PMIX_MAX_NSLEN, "%s",  myproc.nspace);
+    PMIX_LOAD_NSPACE(proc.nspace, myproc.nspace);
     /* get the committed data - ask for someone who doesn't exist as well */
     for (n = 0; n < nprocs; n++) {
         if (all_local) {
diff --git a/src/common/pmix_attributes.c b/src/common/pmix_attributes.c
@@ -5,6 +5,7 @@
  *                         All rights reserved.
  * Copyright (c) 2016      IBM Corporation.  All rights reserved.
  * Copyright (c) 2021-2022 Nanook Consulting  All rights reserved.
+ * Copyright (c) 2022      Triad National Security, LLC. All rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -26,7 +27,7 @@
 #include "src/util/pmix_hash.h"
 
 #include "src/common/pmix_attributes.h"
-#include "src/include/dictionary.h"
+#include "src/include/pmix_dictionary.h"
 
 static bool initialized = false;
 static pmix_list_t client_attrs;
@@ -72,13 +73,13 @@ PMIX_EXPORT void pmix_init_registered_attrs(void)
 
         /* cycle across the dictionary and load a hash
          * table with translations of key -> index */
-        for (n=0; UINT32_MAX != dictionary[n].index; n++) {
+        for (n=0; UINT32_MAX != pmix_dictionary[n].index; n++) {
             p = (pmix_regattr_input_t*)pmix_malloc(sizeof(pmix_regattr_input_t));
-            p->index = dictionary[n].index;
-            p->name = strdup(dictionary[n].name);
-            p->string = strdup(dictionary[n].string);
-            p->type = dictionary[n].type;
-            p->description = pmix_argv_copy(dictionary[n].description);
+            p->index = pmix_dictionary[n].index;
+            p->name = strdup(pmix_dictionary[n].name);
+            p->string = strdup(pmix_dictionary[n].string);
+            p->type = pmix_dictionary[n].type;
+            p->description = pmix_argv_copy(pmix_dictionary[n].description);
             pmix_hash_register_key(p->index, p);
         }
         initialized = true;
@@ -850,9 +851,9 @@ PMIX_EXPORT const char *pmix_attributes_lookup(char *attr)
 {
     size_t n;
 
-    for (n = 0; 0 != strlen(dictionary[n].name); n++) {
-        if (0 == strcasecmp(dictionary[n].name, attr)) {
-            return dictionary[n].string;
+    for (n = 0; 0 != strlen(pmix_dictionary[n].name); n++) {
+        if (0 == strcasecmp(pmix_dictionary[n].name, attr)) {
+            return pmix_dictionary[n].string;
         }
     }
     return NULL;
@@ -862,9 +863,9 @@ PMIX_EXPORT const char *pmix_attributes_reverse_lookup(char *attrstring)
 {
     size_t n;
 
-    for (n = 0; 0 != strlen(dictionary[n].name); n++) {
-        if (0 == strcasecmp(dictionary[n].string, attrstring)) {
-            return dictionary[n].name;
+    for (n = 0; 0 != strlen(pmix_dictionary[n].name); n++) {
+        if (0 == strcasecmp(pmix_dictionary[n].string, attrstring)) {
+            return pmix_dictionary[n].name;
         }
     }
     return NULL;
@@ -874,9 +875,9 @@ PMIX_EXPORT const pmix_regattr_input_t *pmix_attributes_lookup_term(char *attr)
 {
     size_t n;
 
-    for (n = 0; 0 != strlen(dictionary[n].name); n++) {
-        if (0 == strcmp(dictionary[n].name, attr)) {
-            return &dictionary[n];
+    for (n = 0; 0 != strlen(pmix_dictionary[n].name); n++) {
+        if (0 == strcmp(pmix_dictionary[n].name, attr)) {
+            return &pmix_dictionary[n];
         }
     }
     return NULL;
diff --git a/src/include/Makefile.am b/src/include/Makefile.am
@@ -15,6 +15,7 @@
 # Copyright (c) 2017      Research Organization for Information Science
 #                         and Technology (RIST). All rights reserved.
 # Copyright (c) 2021-2022 Nanook Consulting  All rights reserved.
+# Copyright (c) 2022      Triad National Security, LLC. All rights reserved.
 # $COPYRIGHT$
 #
 # Additional copyrights may follow
@@ -32,7 +33,8 @@ noinst_LTLIBRARIES = libpmixglobal.la
 
 libpmixglobal_la_SOURCES = \
 	pmix_globals.h \
-        pmix_globals.c
+    pmix_globals.c \
+    pmix_dictionary.c
 
 headers = pmix_globals.h
 
@@ -49,17 +51,22 @@ headers += \
         pmix_portable_platform.h \
         pmix_portable_platform_real.h \
         pmix_frameworks.h \
-        dictionary.h
+        pmix_dictionary.h
 
 nobase_pmix_HEADERS = $(headers)
 
-# Need to ensure that dictionary.h is built first -- before any other
-# targets.
-BUILT_SOURCES = dictionary.h
+# Files that are generated here.
+libpmixglobal_gen = \
+	pmix_dictionary.h \
+    pmix_dictionary.c
 
-dictionary.h: $(top_srcdir)/include/pmix_common.h.in \
-              $(top_srcdir)/include/pmix_deprecated.h \
-              $(top_srcdir)/src/common/pmix_attributes.c
-	$(PYTHON) $(top_srcdir)/contrib/construct_dictionary.py
+# Need to ensure that pmix_dictionary.h and pmix_dictionary.c are built first --
+# before any other targets.
+BUILT_SOURCES = $(libpmixglobal_gen)
 
-MAINTAINERCLEANFILES = dictionary.h
+$(libpmixglobal_gen): $(top_srcdir)/include/pmix_common.h.in \
+                      $(top_srcdir)/include/pmix_deprecated.h \
+                      $(top_srcdir)/src/common/pmix_attributes.c
+	        $(PYTHON) $(top_srcdir)/contrib/construct_dictionary.py
+
+MAINTAINERCLEANFILES = $(libpmixglobal_gen)
diff --git a/src/runtime/pmix_init.c b/src/runtime/pmix_init.c
@@ -19,6 +19,7 @@
  * Copyright (c) 2015      Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2021-2022 Nanook Consulting  All rights reserved.
+ * Copyright (c) 2022      Triad National Security, LLC. All rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -57,7 +58,7 @@
 #include "src/client/pmix_client_ops.h"
 #include "src/common/pmix_attributes.h"
 #include "src/event/pmix_event.h"
-#include "src/include/dictionary.h"
+#include "src/include/pmix_dictionary.h"
 #include "src/include/pmix_types.h"
 #include "src/util/pmix_error.h"
 #include "src/util/pmix_keyval_parse.h"
diff --git a/src/util/pmix_hash.c b/src/util/pmix_hash.c
@@ -31,7 +31,7 @@
 
 #include "src/class/pmix_hash_table.h"
 #include "src/class/pmix_pointer_array.h"
-#include "src/include/dictionary.h"
+#include "src/include/pmix_dictionary.h"
 #include "src/include/pmix_globals.h"
 #include "src/include/pmix_hash_string.h"
 #include "src/mca/bfrops/bfrops.h"
diff --git a/test/test_v2/server_callbacks.c b/test/test_v2/server_callbacks.c
@@ -6,7 +6,7 @@
  *                         All rights reserved.
  * Copyright (c) 2016      IBM Corporation.  All rights reserved.
  * Copyright (c) 2021-2022 Nanook Consulting  All rights reserved.
- * Copyright (c) 2021      Triad National Security, LLC
+ * Copyright (c) 2021-2022 Triad National Security, LLC
  *                         All rights reserved.
  * $COPYRIGHT$
  *
@@ -320,7 +320,9 @@ pmix_status_t spawn_fn(const pmix_proc_t *proc, const pmix_info_t job_info[], si
     cb->cbdata = cbdata;
 
     spawn_wait = true;
-    PMIx_server_register_nspace("foobar", napps, NULL, 0, release_cb, (void *) cb);
+    pmix_nspace_t foobar;
+    PMIX_LOAD_NSPACE(foobar, "foobar");
+    PMIx_server_register_nspace(foobar, napps, NULL, 0, release_cb, (void *) cb);
     return PMIX_SUCCESS;
 }
 static int numconnect = 0;
diff --git a/test/test_v2/test_fence_basic.c b/test/test_v2/test_fence_basic.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021      Triad National Security, LLC.
+ * Copyright (c) 2021-2022 Triad National Security, LLC.
  *                         All rights reserved.
  *
  * $COPYRIGHT$
@@ -32,7 +32,7 @@ int main(int argc, char *argv[]) {
     pmixt_post_init(&this_proc, &l_params, &v_params);
 
     PMIX_PROC_CONSTRUCT(&job_proc);
-    strncpy(job_proc.nspace, this_proc.nspace, PMIX_MAX_NSLEN);
+    PMIX_LOAD_NSPACE(job_proc.nspace, this_proc.nspace);
     job_proc.rank = PMIX_RANK_WILDCARD;
 
 
diff --git a/test/test_v2/test_fence_partial.c b/test/test_v2/test_fence_partial.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021      Triad National Security, LLC.
+ * Copyright (c) 2021-2022 Triad National Security, LLC.
  *                         All rights reserved.
  *
  * Copyright (c) 2021      Nanook Consulting  All rights reserved.
@@ -67,7 +67,7 @@ int main(int argc, char *argv[]) {
     int rc;
     long int my_node_num;
     size_t i, j, k, node_num_participants;
-    uint32_t num_procs, num_nodes;
+    uint32_t num_procs = 0, num_nodes = 0;
     size_t ninfo = 0;
     test_params params;
     validation_params v_params;
@@ -87,7 +87,7 @@ int main(int argc, char *argv[]) {
     pmixt_post_init(&this_proc, &params, &v_params);
 
     PMIX_PROC_CONSTRUCT(&job_proc);
-    strncpy(job_proc.nspace, this_proc.nspace, PMIX_MAX_NSLEN);
+    PMIX_LOAD_NSPACE(job_proc.nspace, this_proc.nspace);
     job_proc.rank = PMIX_RANK_WILDCARD;
 
     PMIXT_CHECK(PMIx_Get(&job_proc, PMIX_JOB_SIZE, NULL, 0, &val), params, v_params);
@@ -141,7 +141,7 @@ int main(int argc, char *argv[]) {
             for (i = 1, j = 0; i < num_nodes; i = i + 2){
                 for (k = 0; k < nodes[i].pmix_local_size; k++) {
                     PMIX_PROC_CONSTRUCT(&node_procs[j]);
-                    strncpy(node_procs[j].nspace, this_proc.nspace, PMIX_MAX_NSLEN);
+                    PMIX_LOAD_NSPACE(node_procs[j].nspace, this_proc.nspace);
                     node_procs[j].rank = nodes[i].pmix_rank[k];
                     TEST_VERBOSE(("participating node_procs[%d].rank = %u", j, node_procs[j].rank));
                     j++;
diff --git a/test/test_v2/test_fence_wildcard.c b/test/test_v2/test_fence_wildcard.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2021      Triad National Security, LLC.
+ * Copyright (c) 2021-2022 Triad National Security, LLC.
  *                         All rights reserved.
  *
  * Copyright (c) 2021      Nanook Consulting  All rights reserved.
@@ -83,7 +83,7 @@ int main(int argc, char *argv[]) {
     pmixt_post_init(&this_proc, &l_params, &v_params);
 
     PMIX_PROC_CONSTRUCT(&job_proc);
-    strncpy(job_proc.nspace, this_proc.nspace, PMIX_MAX_NSLEN);
+    PMIX_LOAD_NSPACE(job_proc.nspace, this_proc.nspace);
     job_proc.rank = PMIX_RANK_WILDCARD;
 
     if (l_params.time_fence) {
diff --git a/test/test_v2/test_server.c b/test/test_v2/test_server.c
@@ -4,7 +4,7 @@
  *                         All rights reserved.
  * Copyright (c) 2016-2019 Research Organization for Information Science
  *                         and Technology (RIST).  All rights reserved.
- * Copyright (c) 2020-2021 Triad National Security, LLC
+ * Copyright (c) 2020-2022 Triad National Security, LLC
  *                         All rights reserved.
  * Copyright (c) 2021-2022 Nanook Consulting.  All rights reserved.
  * $COPYRIGHT$
@@ -761,7 +761,7 @@ static void server_read_cb(int fd, short event, void *arg)
     msg_hdr_t msg_hdr;
     char *msg_buf = NULL;
     static char *fence_buf = NULL;
-    int i, n, p, temp_nodeid, fence_idx=0, rc;
+    int i, n, p, temp_nodeid = -1, fence_idx=0, rc;
     static int fences_in_flight = 0;
     bool fence_found = false, node_found = false;
     // hard limits to fences in flight, procs, and nodes below
