Replace the "log" server module fn with a "log2"

The current "log" server module function was defined with
a void return. This contrasts with most of the other module
functions which characteristically return a pmix_status_t,
thereby supporting a return status that indicates if the
function is not supported or has been atomically completed.

Add a replacement "log2" function that is identical in signature
except for returning a pmix_status_t instead of void. Deprecate
the current "log" function.

Signed-off-by: Ralph Castain <[email protected]>

Provide better description for PMIx_Log arguments

Expand on the use of the "data" vs "directives" attribute
arrays, providing a couple of examples to help clarify
their use.

Signed-off-by: Ralph Castain <[email protected]>

Author: rhc54

Chap_API_Job_Mgmt.tex

@@ -886,48 +886,59 @@ \subsection{\code{PMIx_Log}}
 \returnsimple
 
 \reqattrstart
-If the \ac{PMIx} library does not itself perform this operation, then it is required to pass any attributes provided by the client to the host environment for processing. In addition, it must include the following attributes in the passed \refarg{info} array:
+If the \ac{PMIx} library does not itself perform this operation, then it is required to pass any attributes provided by the client to the host environment for processing. In addition, it must include the following attributes in the passed \refarg{directives} array:
 
 \pasteAttributeItem{PMIX_USERID}
 \pasteAttributeItem{PMIX_GRPID}
 
-Host environments or \ac{PMIx} libraries that implement support for this operation are required to support the following attributes:
+Host environments or \ac{PMIx} libraries that implement support for this operation are required to support the following attributes when provided as part of the \refarg{data} array:
 
 \pasteAttributeItem{PMIX_LOG_STDERR}
 \pasteAttributeItem{PMIX_LOG_STDOUT}
 \pasteAttributeItem{PMIX_LOG_SYSLOG}
-\pasteAttributeItem{PMIX_LOG_LOCAL_SYSLOG}
-\pasteAttributeItem{PMIX_LOG_GLOBAL_SYSLOG}
+
+Similarly, the following attributes must be supported when provided as part of the \refarg{directives} array:
+
 \pasteAttributeItem{PMIX_LOG_SYSLOG_PRI}
 \pasteAttributeItem{PMIX_LOG_ONCE}
 
 \reqattrend
 
 \optattrstart
-The following attributes are optional for host environments or \ac{PMIx} libraries that support this operation:
+The following attributes are optional for host environments or \ac{PMIx} libraries that support this operation when provided as part of the \refarg{data} array:
+
+\pasteAttributeItem{PMIX_LOG_EMAIL}
+\pasteAttributeItem{PMIX_LOG_JOB_RECORD}
+\pasteAttributeItem{PMIX_LOG_GLOBAL_DATASTORE}
+\pasteAttributeItem{PMIX_LOG_LOCAL_SYSLOG}
+\pasteAttributeItem{PMIX_LOG_GLOBAL_SYSLOG}
+
+Similarly, the following attributes are optional when provided as part of the \refarg{directives} array:
 
 \pasteAttributeItem{PMIX_LOG_SOURCE}
 \pasteAttributeItem{PMIX_LOG_TIMESTAMP}
 \pasteAttributeItem{PMIX_LOG_GENERATE_TIMESTAMP}
 \pasteAttributeItem{PMIX_LOG_TAG_OUTPUT}
 \pasteAttributeItem{PMIX_LOG_TIMESTAMP_OUTPUT}
 \pasteAttributeItem{PMIX_LOG_XML_OUTPUT}
-\pasteAttributeItem{PMIX_LOG_EMAIL}
-\pasteAttributeItem{PMIX_LOG_EMAIL_ADDR}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SENDER_ADDR}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SERVER}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SRVR_PORT}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SUBJECT}
-\pasteAttributeItem{PMIX_LOG_EMAIL_MSG}
-\pasteAttributeItem{PMIX_LOG_JOB_RECORD}
-\pasteAttributeItem{PMIX_LOG_GLOBAL_DATASTORE}
+
 
 \optattrend
 
 %%%%
 \descr
 
-Log data subject to the services offered by the host environment. The data to be logged is provided in the \refarg{data} array. The (optional) \refarg{directives} can be used to direct the choice of logging channel.
+Log data subject to the services offered by the host environment. The \refarg{data} array is used to specify the information that is to be logged, while the \refarg{directives} array is used to control formatting and other output options. For example, a user can:
+
+\begin{itemize}
+\item log a message to \code{stderr} by including \refattr{PMIX_LOG_STDERR} in the \refarg{data} array, with the message itself provided as a string value in that \refstruct{pmix_info_t} element. They can also have that message time-stamped by including the \refattr{PMIX_LOG_TIMESTAMP} attribute in the \refarg{directives} array.
+\item send an email to one or more recipients by including \refattr{PMIX_LOG_EMAIL} in the \refarg{data} array, with the \refstruct{pmix_data_array_t} value containing the message, recipient, and any required server information. Note that any \refarg{directives} (e.g., \refattr{PMIX_LOG_GENERATE_TIMESTAMP}) will be applied to the email request.
+\item log a message to the syslog on the system console by including \refattr{PMIX_LOG_GLOBAL_SYSLOG} in the \refarg{data} array, with the message itself provided as a string value in that \refstruct{pmix_info_t} element. The syslog priority could be set with \refattr{PMIX_LOG_SYSLOG_PRI} in the \refarg{directives} array.
+\end{itemize}
+
+Note that it is possible to log multiple messages to different channels using a single call to \refapi{PMIx_Log}. For instance, the above examples could be combined into a single call to \refapi{PMIx_Log}. In this case, only directives that are applicable to a channel will be used in outputting to that channel. For this example, a directive such as \refattr{PMIX_LOG_TIMESTAMP} would cause all three messages to be time-stamped, but a \refattr{PMIX_LOG_SYSLOG_PRI} directive would only be applied to the syslog channel.
+
+Multiple instances of the same attribute can be included in the \refarg{data} array - e.g., to send different emails to various recipients.
 
 \adviceuserstart
 It is strongly recommended that the \refapi{PMIx_Log} API not be used by applications for streaming data as it is not a ``performant'' transport and can perturb the application since it involves the local \ac{PMIx} server and host \ac{SMS} daemon. Note that a return of \refconst{PMIX_SUCCESS} only denotes that the data was successfully handed to the appropriate system call (for local channels) or the host environment and does not indicate receipt at the final destination.
@@ -973,49 +984,49 @@ \subsection{\code{PMIx_Log_nb}}
 \returnend
 
 \reqattrstart
-If the \ac{PMIx} library does not itself perform this operation, then it is required to pass any attributes provided by the client to the host environment for processing. In addition, it must include the following attributes in the passed \refarg{info} array:
+If the \ac{PMIx} library does not itself perform this operation, then it is required to pass any attributes provided by the client to the host environment for processing. In addition, it must include the following attributes in the passed \refarg{directives} array:
 
 \pasteAttributeItem{PMIX_USERID}
 \pasteAttributeItem{PMIX_GRPID}
 
-Host environments or \ac{PMIx} libraries that implement support for this operation are required to support the following attributes:
+Host environments or \ac{PMIx} libraries that implement support for this operation are required to support the following attributes when provided as part of the \refarg{data} array:
 
 \pasteAttributeItem{PMIX_LOG_STDERR}
 \pasteAttributeItem{PMIX_LOG_STDOUT}
 \pasteAttributeItem{PMIX_LOG_SYSLOG}
-\pasteAttributeItem{PMIX_LOG_LOCAL_SYSLOG}
-\pasteAttributeItem{PMIX_LOG_GLOBAL_SYSLOG}
+
+Similarly, the following attributes must be supported when provided as part of the \refarg{directives} array:
+
 \pasteAttributeItem{PMIX_LOG_SYSLOG_PRI}
 \pasteAttributeItem{PMIX_LOG_ONCE}
 
 \reqattrend
 
 \optattrstart
-The following attributes are optional for host environments or \ac{PMIx} libraries that support this operation:
+The following attributes are optional for host environments or \ac{PMIx} libraries that support this operation when provided as part of the \refarg{data} array:
+
+\pasteAttributeItem{PMIX_LOG_EMAIL}
+\pasteAttributeItem{PMIX_LOG_JOB_RECORD}
+\pasteAttributeItem{PMIX_LOG_GLOBAL_DATASTORE}
+\pasteAttributeItem{PMIX_LOG_LOCAL_SYSLOG}
+\pasteAttributeItem{PMIX_LOG_GLOBAL_SYSLOG}
+
+Similarly, the following attributes are optional when provided as part of the \refarg{directives} array:
 
 \pasteAttributeItem{PMIX_LOG_SOURCE}
 \pasteAttributeItem{PMIX_LOG_TIMESTAMP}
 \pasteAttributeItem{PMIX_LOG_GENERATE_TIMESTAMP}
 \pasteAttributeItem{PMIX_LOG_TAG_OUTPUT}
 \pasteAttributeItem{PMIX_LOG_TIMESTAMP_OUTPUT}
 \pasteAttributeItem{PMIX_LOG_XML_OUTPUT}
-\pasteAttributeItem{PMIX_LOG_EMAIL}
-\pasteAttributeItem{PMIX_LOG_EMAIL_ADDR}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SENDER_ADDR}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SERVER}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SRVR_PORT}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SUBJECT}
-\pasteAttributeItem{PMIX_LOG_EMAIL_MSG}
-\pasteAttributeItem{PMIX_LOG_JOB_RECORD}
-\pasteAttributeItem{PMIX_LOG_GLOBAL_DATASTORE}
+
 
 \optattrend
 
 %%%%
 \descr
 
-Log data subject to the services offered by the host environment. The data to be logged is provided in the \refarg{data} array. The (optional) \refarg{directives} can be used to direct the choice of logging channel.
-The callback function will be executed when the log operation has been completed. The \refarg{data} and \refarg{directives} arrays must be maintained until the callback is provided.
+Log data subject to the services offered by the host environment. See the description in \refapi{PMIx_Log} for details on use of the \refarg{data} and \refarg{directives} arrays.
 
 \adviceuserstart
 It is strongly recommended that the \refapi{PMIx_Log_nb} API not be used by applications for streaming data as it is not a ``performant'' transport and can perturb the application since it involves the local \ac{PMIx} server and host \ac{SMS} daemon. Note that a return of \refconst{PMIX_SUCCESS} only denotes that the data was successfully handed to the appropriate system call (for local channels) or the host environment and does not indicate receipt at the final destination.
@@ -1084,12 +1095,14 @@ \subsection{Log attributes}
 Only log this once with whichever channel can first support it, taking the channels in priority order.
 }
 %
-\declareAttribute{PMIX_LOG_MSG}{"pmix.log.msg"}{pmix_byte_object_t}{
-Message blob to be sent somewhere.
-}
-%
 \declareAttribute{PMIX_LOG_EMAIL}{"pmix.log.email"}{pmix_data_array_t}{
-Log via email based on \refstruct{pmix_info_t} containing directives.
+Log via email based on \refstruct{pmix_info_t} containing directives. The array must contain at least one of
+the \refattr{PMIX_LOG_BLOB} or \refattr{PMIX_LOG_MSG} attributes containing the body of the
+message. In addition, it must contain at least the \refattr{PMIX_LOG_EMAIL_ADDR} and \refattr{PMIX_LOG_EMAIL_SUBJECT}
+attributes identifying the intended recipients and the subject for the message. The array can optionally include
+the server information (\refattr{PMIX_LOG_EMAIL_SERVER} and \refattr{PMIX_LOG_EMAIL_SRVR_PORT}) if required by the
+local system, and a return email address for the sender (\refattr{PMIX_LOG_EMAIL_SENDER_ADDR}. No specific ordering
+of these directives is required.
 }
 %
 \declareAttribute{PMIX_LOG_EMAIL_ADDR}{"pmix.log.emaddr"}{char*}{
@@ -1104,8 +1117,12 @@ \subsection{Log attributes}
 Subject line for email.
 }
 %
-\declareAttribute{PMIX_LOG_EMAIL_MSG}{"pmix.log.emmsg"}{char*}{
-Message to be included in email.
+\declareAttribute{PMIX_LOG_MSG}{"pmix.log.msg"}{char*}{
+Message to be included in a log operation.
+}
+%
+\declareAttributeProvisional{PMIX_LOG_BLOB}{"pmix.log.blob"}{pmix_byte_object_t}{
+Message blob (e.g., PDF attachment) to be included in a log operation.
 }
 %
 \declareAttribute{PMIX_LOG_EMAIL_SERVER}{"pmix.log.esrvr"}{char*}{
@@ -1116,12 +1133,17 @@ \subsection{Log attributes}
 Port the email server is listening to.
 }
 %
-\declareAttribute{PMIX_LOG_GLOBAL_DATASTORE}{"pmix.log.gstore"}{bool}{
-Store the log data in a global data store (e.g., database).
+\declareAttributeProvisional{PMIX_LOG_GLOBAL_DATASTORE}{"pmix.log.gstore"}{pmix_data_array_t}{
+Store the log data in a global data store (e.g., database). Directs the host environment to
+store the provided message in a data store available
+to the host. The associated array must contain at least one of
+the \refattr{PMIX_LOG_BLOB} or \refattr{PMIX_LOG_MSG} attributes containing the data to be
+stored.
 }
 %
-\declareAttribute{PMIX_LOG_JOB_RECORD}{"pmix.log.jrec"}{bool}{
-Log the provided information to the host environment's job record.
+\declareAttributeProvisional{PMIX_LOG_JOB_RECORD}{"pmix.log.jrec"}{char*}{
+Log the provided message to the host environment's job record. An error must be returned if the host
+does not support this service.
 }
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Chap_API_Server.tex

@@ -955,7 +955,7 @@ \subsection{\code{PMIx_server_deregister_resources}}
 
 A \code{NULL} \refarg{cbfunc} reference indicates that the function is to be executed as a blocking operation.
 % TODO: If this is one of those functions that can be blocking or non-blocking, then
-% it needs a full return code explanation, not the returnsimple 
+% it needs a full return code explanation, not the returnsimple
 
 \advicermend
 
@@ -1996,7 +1996,7 @@ \subsection{\code{pmix_server_module_t} Module}
     pmix_server_notify_event_fn_t       notify_event;
     pmix_server_query_fn_t              query;
     pmix_server_tool_connection_fn_t    tool_connected;
-    pmix_server_log_fn_t                log;
+    pmix_server_log_fn_t                log;               // DEPRECATED
     pmix_server_alloc_fn_t              allocate;
     pmix_server_job_control_fn_t        job_control;
     pmix_server_monitor_fn_t            monitor;
@@ -2009,6 +2009,7 @@ \subsection{\code{pmix_server_module_t} Module}
     pmix_server_grp_fn_t                group;
     pmix_server_fabric_fn_t             fabric;
     pmix_server_client_connected2_fn_t  client_connected2;
+    pmix_server_log2_fn_t               log2;
 \} pmix_server_module_t;
 \end{codepar}
 \cspecificend
@@ -3375,8 +3376,9 @@ \subsubsection{PMIx Tool Connection Callback Function}
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-\subsection{\code{pmix_server_log_fn_t}}
-\declareapi{pmix_server_log_fn_t}
+\versionMarkerProvisional{6.0}
+\subsection{\code{pmix_server_log2_fn_t}}
+\declareapiProvisional{pmix_server_log2_fn_t}
 
 %%%%
 \summary
@@ -3386,8 +3388,8 @@ \subsection{\code{pmix_server_log_fn_t}}
 %%%%
 \format
 
-\copySignature{pmix_server_log_fn_t}{2.0}{
-typedef void (*pmix_server_log_fn_t)( \\
+\copySignature{pmix_server_log2_fn_t}{5.1}{
+typedef pmix_status_t (*pmix_server_log2_fn_t)( \\
 \hspace*{20\sigspace}const pmix_proc_t *client, \\
 \hspace*{20\sigspace}const pmix_info_t data[], size_t ndata, \\
 \hspace*{20\sigspace}const pmix_info_t directives[], size_t ndirs, \\
@@ -3404,38 +3406,95 @@ \subsection{\code{pmix_server_log_fn_t}}
 \argin{cbdata}{Data to be passed to the callback function (memory reference)}
 \end{arglist}
 
+Returns one of the following:
+
+\begin{itemize}
+    \item \refconst{PMIX_SUCCESS}, indicating that the request is being processed by the host environment - result will be returned in the provided \refarg{cbfunc}.
+    \item \refconst{PMIX_OPERATION_SUCCEEDED}, indicating that the request was immediately processed and returned \textit{success} - the \refarg{cbfunc} will not be called
+    \item \refconst{PMIX_ERR_NOT_SUPPORTED}, indicating that the host environment does not support the request, even though the function entry was provided in the server module - the \refarg{cbfunc} will not be called
+    \item a PMIx error constant indicating either an error in the input or that the request was immediately processed and failed - the \refarg{cbfunc} will not be called
+\end{itemize}
 
 \reqattrstart
-\ac{PMIx} libraries are required to pass any provided attributes to the host environment for processing. In addition, the following attributes are required to be included in the passed \refarg{info} array:
+If the \ac{PMIx} library calls this server module function, then it is required to pass any attributes provided by the client to the host environment for processing. In addition, it must include the following attributes in the passed \refarg{directives} array:
 
 \pasteAttributeItem{PMIX_USERID}
 \pasteAttributeItem{PMIX_GRPID}
 
-\divider
-
-Host environments that provide this module entry point are required to support the following attributes:
+Host environments that implement support for this operation are required to support the following attributes when provided as part of the \refarg{data} array:
 
 \pasteAttributeItem{PMIX_LOG_STDERR}
 \pasteAttributeItem{PMIX_LOG_STDOUT}
 \pasteAttributeItem{PMIX_LOG_SYSLOG}
 
+Similarly, the following attributes must be supported when provided as part of the \refarg{directives} array:
+
+\pasteAttributeItem{PMIX_LOG_SYSLOG_PRI}
+\pasteAttributeItem{PMIX_LOG_ONCE}
+
 \reqattrend
 
 \optattrstart
-The following attributes are optional for host environments that support this operation:
+The following attributes are optional for host environments that support this operation when provided as part of the \refarg{data} array:
 
-\pasteAttributeItem{PMIX_LOG_MSG}
 \pasteAttributeItem{PMIX_LOG_EMAIL}
-\pasteAttributeItem{PMIX_LOG_EMAIL_ADDR}
-\pasteAttributeItem{PMIX_LOG_EMAIL_SUBJECT}
-\pasteAttributeItem{PMIX_LOG_EMAIL_MSG}
+\pasteAttributeItem{PMIX_LOG_JOB_RECORD}
+\pasteAttributeItem{PMIX_LOG_GLOBAL_DATASTORE}
+\pasteAttributeItem{PMIX_LOG_LOCAL_SYSLOG}
+\pasteAttributeItem{PMIX_LOG_GLOBAL_SYSLOG}
+
+Similarly, the following attributes are optional when provided as part of the \refarg{directives} array:
+
+\pasteAttributeItem{PMIX_LOG_SOURCE}
+\pasteAttributeItem{PMIX_LOG_TIMESTAMP}
+\pasteAttributeItem{PMIX_LOG_GENERATE_TIMESTAMP}
+\pasteAttributeItem{PMIX_LOG_TAG_OUTPUT}
+\pasteAttributeItem{PMIX_LOG_TIMESTAMP_OUTPUT}
+\pasteAttributeItem{PMIX_LOG_XML_OUTPUT}
 
 \optattrend
 
 %%%%
 \descr
 
-Log data on behalf of a client. This function is not intended for output of computational results, but rather for reporting status and error messages. The host must not execute the callback function prior to returning from the \ac{API}.
+Log data on behalf of a client. This function is not intended for output of computational results, but rather for reporting status and error messages. See the description in \refapi{PMIx_Log} for further information on expected behavior.
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+\subsection{\code{pmix_server_log_fn_t}}
+\declareapiDEPNODISP{pmix_server_log_fn_t}
+
+%%%%
+\summary
+
+Log data on behalf of a client.
+
+%%%%
+\format
+
+\copySignature{pmix_server_log_fn_t}{2.0}{
+typedef void (*pmix_server_log_fn_t)( \\
+\hspace*{20\sigspace}const pmix_proc_t *client, \\
+\hspace*{20\sigspace}const pmix_info_t data[], size_t ndata, \\
+\hspace*{20\sigspace}const pmix_info_t directives[], size_t ndirs, \\
+\hspace*{20\sigspace}pmix_op_cbfunc_t cbfunc, void *cbdata);
+}
+
+\begin{arglist}
+\argin{client}{\refstruct{pmix_proc_t} structure (handle)}
+\argin{data}{Array of info structures (array of handles)}
+\argin{ndata}{Number of elements in the \refarg{data} array (integer)}
+\argin{directives}{Array of info structures (array of handles)}
+\argin{ndirs}{Number of elements in the \refarg{directives} array (integer)}
+\argin{cbfunc}{Callback function \refapi{pmix_op_cbfunc_t} (function reference)}
+\argin{cbdata}{Data to be passed to the callback function (memory reference)}
+\end{arglist}
+
+
+%%%%
+\descr
+
+Log data on behalf of a client. This function module entry has been \textbf{DEPRECATED} in favor of \refapi{pmix_server_log2_fn_t}.
 
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%