Fix show_help output to include tools

rhc54 · rhc54 · commit 0daf8e253792 · 2022-07-15T08:02:42.000-06:00
Ensure that show_help is distributed to attached tools.

Signed-off-by: Ralph Castain &lt;rhc@pmix.org&gt;
diff --git a/src/mca/plog/base/plog_base_stubs.c b/src/mca/plog/base/plog_base_stubs.c
@@ -85,6 +85,11 @@ pmix_status_t pmix_plog_base_log(const pmix_proc_t *source, const pmix_info_t da
         return PMIX_ERR_INIT;
     }
 
+    /* if there is no data to output, then nothing to do */
+    if (NULL == data) {
+        return PMIX_OPERATION_SUCCEEDED;
+    }
+
     /* we have to serialize our way thru here as we are going
      * to construct a list of the available modules, and those
      * can only be on one list at a time */
@@ -142,9 +147,9 @@ pmix_status_t pmix_plog_base_log(const pmix_proc_t *source, const pmix_info_t da
         }
         all_complete = false;
         for (m = 0; m < pmix_plog_globals.actives.size; m++) {
-            if (NULL
-                == (active = (pmix_plog_base_active_module_t *)
-                        pmix_pointer_array_get_item(&pmix_plog_globals.actives, m))) {
+            active = (pmix_plog_base_active_module_t *)
+                            pmix_pointer_array_get_item(&pmix_plog_globals.actives, m);
+            if (NULL == active) {
                 continue;
             }
             /* if this channel is included in the ones serviced by this
@@ -177,8 +182,7 @@ pmix_status_t pmix_plog_base_log(const pmix_proc_t *source, const pmix_info_t da
     }
     if (all_complete) {
         /* nothing we need do */
-        while (NULL != pmix_list_remove_first(&channels))
-            ;
+        while (NULL != pmix_list_remove_first(&channels));
         PMIX_DESTRUCT(&channels);
         PMIX_RELEASE(mycount);
         PMIX_RELEASE_THREAD(&pmix_plog_globals.lock);
@@ -254,8 +258,7 @@ pmix_status_t pmix_plog_base_log(const pmix_proc_t *source, const pmix_info_t da
     }
 
     /* cannot release the modules - just remove everything from the list */
-    while (NULL != pmix_list_remove_first(&channels))
-        ;
+    while (NULL != pmix_list_remove_first(&channels));
     PMIX_DESTRUCT(&channels);
 
     rc = mycount->status; // save the status as it could change when the lock is released
diff --git a/src/mca/plog/default/plog_default.c b/src/mca/plog/default/plog_default.c
@@ -43,16 +43,18 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
                            void *cbdata);
 
 /* Module def */
-pmix_plog_module_t pmix_plog_default_module = {.name = "default",
-                                               .channels = NULL,
-                                               .init = init,
-                                               .finalize = NULL,
-                                               .log = mylog};
+pmix_plog_module_t pmix_plog_default_module = {
+    .name = "default",
+    .channels = NULL,
+    .init = init,
+    .finalize = NULL,
+    .log = mylog
+};
 
 /* local object */
 typedef struct {
     pmix_object_t super;
-    pmix_info_t *data;
+    const pmix_info_t *data;
     size_t ndata;
     pmix_op_cbfunc_t cbfunc;
     void *cbdata;
@@ -62,13 +64,8 @@ static void lcon(local_caddy_t *p)
     p->data = NULL;
     p->ndata = 0;
 }
-static void ldes(local_caddy_t *p)
-{
-    if (NULL != p->data) {
-        PMIX_INFO_FREE(p->data, p->ndata);
-    }
-}
-static PMIX_CLASS_INSTANCE(local_caddy_t, pmix_object_t, lcon, ldes);
+static PMIX_CLASS_INSTANCE(local_caddy_t, pmix_object_t,
+                           lcon, NULL);
 
 static int init(void)
 {
@@ -94,19 +91,6 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
                            void *cbdata)
 {
     local_caddy_t *cd;
-    size_t ntodo, n;
-
-    /* if none of the prior modules performed a requested logging
-     * operation, then we will try here */
-    ntodo = 0;
-    for (n = 0; n < ndata; n++) {
-        if (!PMIX_INFO_OP_IS_COMPLETE(&data[n])) {
-            ++ntodo;
-        }
-    }
-    if (0 == ntodo) {
-        return PMIX_ERR_TAKE_NEXT_OPTION;
-    }
 
     /* send it upwards for potential handling. This might seem
      * odd in the case where we are a gateway, but we must allow
@@ -116,24 +100,11 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
     if (NULL == cd) {
         return PMIX_ERR_NOMEM;
     }
+    cd->data = data;
+    cd->ndata = ndata;
     cd->cbfunc = cbfunc;
     cd->cbdata = cbdata;
 
-    /* separate out the ones that weren't completed */
-    PMIX_INFO_CREATE(cd->data, ntodo);
-    if (NULL == cd->data) {
-        PMIX_RELEASE(cd);
-        return PMIX_ERR_NOMEM;
-    }
-    cd->ndata = ntodo;
-    ntodo = 0;
-    for (n = 0; n < ndata; n++) {
-        if (!PMIX_INFO_OP_IS_COMPLETE(&data[n])) {
-            PMIX_INFO_XFER(&cd->data[ntodo], (pmix_info_t *) &data[n]);
-            ++ntodo;
-        }
-    }
-
     /* ask the host to log the remainder */
     pmix_host_server.log(source, cd->data, cd->ndata, directives, ndirs, localcbfn, (void *) cd);
 
diff --git a/src/mca/plog/stdfd/plog_stdfd.c b/src/mca/plog/stdfd/plog_stdfd.c
@@ -21,6 +21,7 @@
 
 #include "pmix_config.h"
 #include "pmix_common.h"
+#include "pmix_server.h"
 
 #include <string.h>
 #ifdef HAVE_SYS_TIME_H
@@ -45,10 +46,12 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
                            void *cbdata);
 
 /* Module def */
-pmix_plog_module_t pmix_plog_stdfd_module = {.name = "stdfd",
-                                             .init = init,
-                                             .finalize = finalize,
-                                             .log = mylog};
+pmix_plog_module_t pmix_plog_stdfd_module = {
+    .name = "stdfd",
+    .init = init,
+    .finalize = finalize,
+    .log = mylog
+};
 
 static int init(void)
 {
@@ -63,13 +66,45 @@ static void finalize(void)
     pmix_argv_free(pmix_plog_stdfd_module.channels);
 }
 
+typedef struct{
+    pmix_object_t super;
+    pmix_proc_t source;
+    pmix_byte_object_t bo;
+} pmix_iof_deliver_t;
+static void pdcon(pmix_iof_deliver_t *p)
+{
+    p->bo.bytes = NULL;
+    p->bo.size = 0;
+}
+static void pddes(pmix_iof_deliver_t *p)
+{
+    if (NULL != p->bo.bytes) {
+        free(p->bo.bytes);
+    }
+}
+static PMIX_CLASS_INSTANCE(pmix_iof_deliver_t,
+                           pmix_object_t,
+                           pdcon, pddes);
+
+static void lkcbfunc(pmix_status_t status, void *cbdata)
+{
+    pmix_iof_deliver_t *p = (pmix_iof_deliver_t*)cbdata;
+
+    /* nothing to do here - we use this solely to
+     * ensure that IOF_deliver doesn't block */
+    if (PMIX_SUCCESS != status) {
+        PMIX_ERROR_LOG(status);
+    }
+    PMIX_RELEASE(p);
+}
+
 static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[], size_t ndata,
                            const pmix_info_t directives[], size_t ndirs, pmix_op_cbfunc_t cbfunc,
                            void *cbdata)
 {
     size_t n;
     pmix_status_t rc;
-    pmix_byte_object_t bo;
+    pmix_iof_deliver_t *p;
 
     /* if there is no data, then we don't handle it */
     if (NULL == data || 0 == ndata) {
@@ -103,19 +138,27 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
             continue;
         }
         if (0 == strncmp(data[n].key, PMIX_LOG_STDERR, PMIX_MAX_KEYLEN)) {
-            bo.bytes = data[n].value.data.string;
-            bo.size = strlen(bo.bytes);
-            pmix_iof_write_output(source, PMIX_FWD_STDERR_CHANNEL, &bo);
-            /* flag that we did this one */
-            PMIX_INFO_OP_COMPLETED(&data[n]);
-            rc = PMIX_SUCCESS;
+            p = PMIX_NEW(pmix_iof_deliver_t);
+            PMIX_XFER_PROCID(&p->source, source);
+            p->bo.size = strlen(data[n].value.data.string) + 1; // include NULL terminator
+            p->bo.bytes = (char*)malloc(p->bo.size);
+            memcpy(p->bo.bytes, data[n].value.data.string, p->bo.size);
+            rc = PMIx_server_IOF_deliver(&p->source, PMIX_FWD_STDERR_CHANNEL, &p->bo, NULL, 0, lkcbfunc, (void*)p);
+            if (PMIX_SUCCESS != rc) {
+                PMIX_ERROR_LOG(rc);
+                PMIX_RELEASE(p);
+            }
         } else if (0 == strncmp(data[n].key, PMIX_LOG_STDOUT, PMIX_MAX_KEYLEN)) {
-            bo.bytes = data[n].value.data.string;
-            bo.size = strlen(bo.bytes);
-            pmix_iof_write_output(source, PMIX_FWD_STDOUT_CHANNEL, &bo);
-            /* flag that we did this one */
-            PMIX_INFO_OP_COMPLETED(&data[n]);
-            rc = PMIX_SUCCESS;
+            p = PMIX_NEW(pmix_iof_deliver_t);
+            PMIX_XFER_PROCID(&p->source, source);
+            p->bo.size = strlen(data[n].value.data.string) + 1; // include NULL terminator
+            p->bo.bytes = (char*)malloc(p->bo.size);
+            memcpy(p->bo.bytes, data[n].value.data.string, p->bo.size);
+            rc = PMIx_server_IOF_deliver(&p->source, PMIX_FWD_STDOUT_CHANNEL, &p->bo, NULL, 0, lkcbfunc, (void*)p);
+            if (PMIX_SUCCESS != rc) {
+                PMIX_ERROR_LOG(rc);
+                PMIX_RELEASE(p);
+            }
         }
     }
     return rc;
diff --git a/src/mca/plog/syslog/plog_syslog.c b/src/mca/plog/syslog/plog_syslog.c
@@ -52,10 +52,12 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
                            void *cbdata);
 
 /* Module def */
-pmix_plog_module_t pmix_plog_syslog_module = {.name = "syslog",
-                                              .init = init,
-                                              .finalize = finalize,
-                                              .log = mylog};
+pmix_plog_module_t pmix_plog_syslog_module = {
+    .name = "syslog",
+    .init = init,
+    .finalize = finalize,
+    .log = mylog
+};
 
 static pmix_status_t init(void)
 {
@@ -109,28 +111,28 @@ static pmix_status_t mylog(const pmix_proc_t *source, const pmix_info_t data[],
 
     /* check to see if there are any syslog entries */
     for (n = 0; n < ndata; n++) {
-        if (0 == strncmp(data[n].key, PMIX_LOG_SYSLOG, PMIX_MAX_KEYLEN)) {
+        if (PMIX_CHECK_KEY(&data[n], PMIX_LOG_SYSLOG)) {
             /* we default to using the local syslog */
-            rc = write_local(source, timestamp, pri, data[n].value.data.string, data, ndata);
-            if (PMIX_SUCCESS == rc) {
-                /* flag that we did this one */
-                PMIX_INFO_OP_COMPLETED(&data[n]);
+            rc = write_local(source, timestamp, pri,
+                             data[n].value.data.string, data, ndata);
+            if (PMIX_SUCCESS != rc) {
+                return rc;
             }
-        } else if (0 == strncmp(data[n].key, PMIX_LOG_LOCAL_SYSLOG, PMIX_MAX_KEYLEN)) {
-            rc = write_local(source, timestamp, pri, data[n].value.data.string, data, ndata);
-            if (PMIX_SUCCESS == rc) {
-                /* flag that we did this one */
-                PMIX_INFO_OP_COMPLETED(&data[n]);
+        } else if (PMIX_CHECK_KEY(&data[n], PMIX_LOG_LOCAL_SYSLOG)) {
+            rc = write_local(source, timestamp, pri,
+                             data[n].value.data.string, data, ndata);
+            if (PMIX_SUCCESS != rc) {
+                return rc;
             }
-        } else if (0 == strncmp(data[n].key, PMIX_LOG_GLOBAL_SYSLOG, PMIX_MAX_KEYLEN)) {
+        } else if (PMIX_CHECK_KEY(&data[n], PMIX_LOG_GLOBAL_SYSLOG)) {
             /* only do this if we are a gateway server */
             if (PMIX_PEER_IS_GATEWAY(pmix_globals.mypeer)) {
-                rc = write_local(source, timestamp, pri, data[n].value.data.string, data, ndata);
-                if (PMIX_SUCCESS == rc) {
-                    /* flag that we did this one */
-                    PMIX_INFO_OP_COMPLETED(&data[n]);
+                rc = write_local(source, timestamp, pri,
+                                 data[n].value.data.string, data, ndata);
+                if (PMIX_SUCCESS != rc) {
+                    return rc;
                 }
-            }
+           }
         }
     }
 
