Adding -mca comm_method to print table of communication methods

ompi/mca/hook/comm_method/Makefile.am

@@ -0,0 +1,20 @@
+#
+# Copyright (c) 2018      IBM Corporation.  All rights reserved.
+# $COPYRIGHT$
+#
+# Additional copyrights may follow
+#
+# $HEADER$
+#
+
+sources = \
+	hook_comm_method.h \
+	hook_comm_method_component.c \
+	hook_comm_method_fns.c
+
+# This component will only ever be built statically -- never as a DSO.
+
+noinst_LTLIBRARIES = libmca_hook_comm_method.la
+
+libmca_hook_comm_method_la_SOURCES = $(sources)
+libmca_hook_comm_method_la_LDFLAGS = -module -avoid-version

ompi/mca/hook/comm_method/configure.m4

@@ -0,0 +1,25 @@
+#
+# Copyright (c) 2018      IBM Corporation.  All rights reserved.
+#
+# $COPYRIGHT$
+#
+# Additional copyrights may follow
+#
+# $HEADER$
+#
+
+# Make this a static component
+AC_DEFUN([MCA_ompi_hook_comm_method_COMPILE_MODE], [
+    AC_MSG_CHECKING([for MCA component $2:$3 compile mode])
+    $4="static"
+    AC_MSG_RESULT([$$4])
+])
+
+# MCA_hook_comm_method_CONFIG([action-if-can-compile],
+#                      [action-if-cant-compile])
+# ------------------------------------------------
+AC_DEFUN([MCA_ompi_hook_comm_method_CONFIG],[
+    AC_CONFIG_FILES([ompi/mca/hook/comm_method/Makefile])
+
+    $1
+])

ompi/mca/hook/comm_method/hook_comm_method.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2016-2018 IBM Corporation. All rights reserved.
+ * $COPYRIGHT$
+ *
+ * Additional copyrights may follow
+ *
+ * $HEADER$
+ */
+#ifndef MCA_HOOK_COMM_METHOD_H
+#define MCA_HOOK_COMM_METHOD_H
+
+#include "ompi_config.h"
+
+#include "ompi/constants.h"
+
+#include "ompi/mca/hook/hook.h"
+#include "ompi/mca/hook/base/base.h"
+
+BEGIN_C_DECLS
+
+OMPI_MODULE_DECLSPEC extern const ompi_hook_base_component_1_0_0_t mca_hook_comm_method_component;
+
+extern int mca_hook_comm_method_verbose;
+extern int mca_hook_comm_method_output;
+extern bool hook_comm_method_enable_mpi_init;
+extern bool hook_comm_method_enable_mpi_finalize;
+extern int hook_comm_method_max;
+extern int hook_comm_method_brief;
+extern char *hook_comm_method_fakefile;
+
+void ompi_hook_comm_method_mpi_init_bottom(int argc, char **argv, int requested, int *provided);
+
+void ompi_hook_comm_method_mpi_finalize_top(void);
+
+END_C_DECLS
+
+#endif /* MCA_HOOK_COMM_METHOD_H */

ompi/mca/hook/comm_method/hook_comm_method_component.c

@@ -0,0 +1,179 @@
+/*
+ * Copyright (c) 2016-2018 IBM Corporation. All rights reserved.
+ * $COPYRIGHT$
+ *
+ * Additional copyrights may follow
+ *
+ * $HEADER$
+ */
+
+#include "ompi_config.h"
+
+#include "hook_comm_method.h"
+
+static int ompi_hook_comm_method_component_open(void);
+static int ompi_hook_comm_method_component_close(void);
+static int ompi_hook_comm_method_component_register(void);
+
+/*
+ * Public string showing the component version number
+ */
+const char *mca_hook_comm_method_component_version_string =
+    "Open MPI 'comm_method' hook MCA component version " OMPI_VERSION;
+
+/*
+ * Instantiate the public struct with all of our public information
+ * and pointers to our public functions in it
+ */
+const ompi_hook_base_component_1_0_0_t mca_hook_comm_method_component = {
+
+    /* First, the mca_component_t struct containing meta information
+     * about the component itself */
+    .hookm_version = {
+        OMPI_HOOK_BASE_VERSION_1_0_0,
+
+        /* Component name and version */
+        .mca_component_name = "comm_method",
+        MCA_BASE_MAKE_VERSION(component, OMPI_MAJOR_VERSION, OMPI_MINOR_VERSION,
+                              OMPI_RELEASE_VERSION),
+
+        /* Component open and close functions */
+        .mca_open_component = ompi_hook_comm_method_component_open,
+        .mca_close_component = ompi_hook_comm_method_component_close,
+        .mca_register_component_params = ompi_hook_comm_method_component_register,
+
+        // Force this component to always be considered - component must be static
+        //.mca_component_flags = MCA_BASE_COMPONENT_FLAG_ALWAYS_CONSIDER,
+    },
+    .hookm_data = {
+        /* The component is checkpoint ready */
+        MCA_BASE_METADATA_PARAM_CHECKPOINT
+    },
+
+    /* Component functions */
+    .hookm_mpi_initialized_top = NULL,
+    .hookm_mpi_initialized_bottom = NULL,
+
+    .hookm_mpi_finalized_top = NULL,
+    .hookm_mpi_finalized_bottom = NULL,
+
+    .hookm_mpi_init_top = NULL,
+    .hookm_mpi_init_top_post_opal = NULL,
+    .hookm_mpi_init_bottom = ompi_hook_comm_method_mpi_init_bottom,
+    .hookm_mpi_init_error = NULL,
+
+    .hookm_mpi_finalize_top = ompi_hook_comm_method_mpi_finalize_top,
+    .hookm_mpi_finalize_bottom = NULL,
+};
+
+int mca_hook_comm_method_verbose = 0;
+int mca_hook_comm_method_output  = -1;
+bool hook_comm_method_enable_mpi_init = false;
+bool hook_comm_method_enable_mpi_finalize = false;
+int hook_comm_method_max = 12;
+int hook_comm_method_brief = 0;
+char *hook_comm_method_fakefile = NULL;
+
+static int ompi_hook_comm_method_component_open(void)
+{
+    // Nothing to do
+    return OMPI_SUCCESS;
+}
+
+static int ompi_hook_comm_method_component_close(void)
+{
+    // Nothing to do
+    return OMPI_SUCCESS;
+}
+
+static int ompi_hook_comm_method_component_register(void)
+{
+
+    /*
+     * Component verbosity level
+     */
+    // Inherit the verbosity of the base framework, but also allow this to be overridden
+    if( ompi_hook_base_framework.framework_verbose > MCA_BASE_VERBOSE_NONE ) {
+        mca_hook_comm_method_verbose = ompi_hook_base_framework.framework_verbose;
+    }
+    else {
+        mca_hook_comm_method_verbose = MCA_BASE_VERBOSE_NONE;
+    }
+    (void) mca_base_component_var_register(&mca_hook_comm_method_component.hookm_version, "verbose",
+                                           NULL,
+                                           MCA_BASE_VAR_TYPE_INT, NULL,
+                                           0, 0,
+                                           OPAL_INFO_LVL_9,
+                                           MCA_BASE_VAR_SCOPE_READONLY,
+                                           &mca_hook_comm_method_verbose);
+
+    mca_hook_comm_method_output = opal_output_open(NULL);
+    opal_output_set_verbosity(mca_hook_comm_method_output, mca_hook_comm_method_verbose);
+
+    /*
+     * If the component is active for mpi_init / mpi_finalize
+     */
+    hook_comm_method_enable_mpi_init = false;
+    (void) mca_base_component_var_register(&mca_hook_comm_method_component.hookm_version, "enable_mpi_init",
+                                           "Enable comm_method behavior on mpi_init",
+                                           MCA_BASE_VAR_TYPE_BOOL, NULL,
+                                           0, 0,
+                                           OPAL_INFO_LVL_3,
+                                           MCA_BASE_VAR_SCOPE_READONLY,
+                                           &hook_comm_method_enable_mpi_init);
+
+    hook_comm_method_enable_mpi_finalize = false;
+    (void) mca_base_component_var_register(&mca_hook_comm_method_component.hookm_version, "enable_mpi_finalize",
+                                           "Enable comm_method behavior on mpi_finalize",
+                                           MCA_BASE_VAR_TYPE_BOOL, NULL,
+                                           0, 0,
+                                           OPAL_INFO_LVL_3,
+                                           MCA_BASE_VAR_SCOPE_READONLY,
+                                           &hook_comm_method_enable_mpi_finalize);
+
+    // User can set the comm_method mca variable too
+    int hook_comm_method = -1;
+    (void) mca_base_var_register("ompi", NULL, NULL, "comm_method",
+                                 "Enable comm_method behavior (1) mpi_init or (2) mpi_finalize",
+                                 MCA_BASE_VAR_TYPE_INT, NULL,
+                                 0, 0,
+                                 OPAL_INFO_LVL_3,
+                                 MCA_BASE_VAR_SCOPE_READONLY,
+                                 &hook_comm_method);
+
+    if( 1 == hook_comm_method ) {
+        hook_comm_method_enable_mpi_init = true;
+    }
+    else if( 2 == hook_comm_method ) {
+        hook_comm_method_enable_mpi_finalize = true;
+    }
+
+    // comm_method_max
+    (void) mca_base_var_register("ompi", NULL, NULL, "comm_method_max",
+                                 "Number of hosts for which to print unabbreviated 2d table of comm methods.",
+                                 MCA_BASE_VAR_TYPE_INT, NULL,
+                                 0, 0,
+                                 OPAL_INFO_LVL_3,
+                                 MCA_BASE_VAR_SCOPE_READONLY,
+                                 &hook_comm_method_max);
+    // comm_method_brief
+    (void) mca_base_var_register("ompi", NULL, NULL, "comm_method_brief",
+                                 "Only print the comm method summary, skip the 2d table.",
+                                 MCA_BASE_VAR_TYPE_INT, NULL,
+                                 0, 0,
+                                 OPAL_INFO_LVL_3,
+                                 MCA_BASE_VAR_SCOPE_READONLY,
+                                 &hook_comm_method_brief);
+
+    // comm_method_fakefile is just for debugging, allows complete override of all the
+    // comm method in the table
+    (void) mca_base_var_register("ompi", NULL, NULL, "comm_method_fakefile",
+                                 "For debugging only: read comm methods from a file",
+                                 MCA_BASE_VAR_TYPE_STRING, NULL,
+                                 0, 0,
+                                 OPAL_INFO_LVL_3,
+                                 MCA_BASE_VAR_SCOPE_READONLY,
+                                 &hook_comm_method_fakefile);
+
+    return OMPI_SUCCESS;
+}