Merge pull request #2773 from jjhursey/topic/hook-fwk

Add a 'hook' framework

ompi/mca/hook/Makefile.am

@@ -0,0 +1,27 @@
+#
+# Copyright (c) 2017      IBM Corporation.  All rights reserved.
+# $COPYRIGHT$
+#
+# Additional copyrights may follow
+#
+# $HEADER$
+#
+
+# main library setup
+noinst_LTLIBRARIES = libmca_hook.la
+libmca_hook_la_SOURCES =
+
+# local files
+headers = hook.h
+libmca_hook_la_SOURCES += $(headers)
+
+# Conditionally install the header files
+if WANT_INSTALL_HEADERS
+ompidir = $(ompiincludedir)/$(subdir)
+nobase_ompi_HEADERS = $(headers)
+endif
+
+include base/Makefile.am
+
+distclean-local:
+	rm -f base/static-components.h

ompi/mca/hook/base/Makefile.am

@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2017      IBM Corporation.  All rights reserved.
+# $COPYRIGHT$
+#
+# Additional copyrights may follow
+#
+# $HEADER$
+#
+
+dist_ompidata_DATA = base/help-mca-hook-base.txt
+
+headers += \
+        base/base.h
+
+libmca_hook_la_SOURCES += \
+        base/hook_base.c

ompi/mca/hook/base/base.h

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2017      IBM Corporation.  All rights reserved.
+ * $COPYRIGHT$
+ *
+ * Additional copyrights may follow
+ *
+ * $HEADER$
+ */
+
+#ifndef OMPI_HOOK_BASE_H
+#define OMPI_HOOK_BASE_H
+
+#include "ompi_config.h"
+
+#include "ompi/mca/mca.h"
+#include "opal/mca/base/mca_base_framework.h"
+
+#include "ompi/mca/hook/hook.h"
+
+BEGIN_C_DECLS
+
+/**
+ * Framework struct declaration for this framework
+ */
+OMPI_DECLSPEC extern mca_base_framework_t ompi_hook_base_framework;
+
+
+/**
+ * Dynamically register function pointers to be called from outside of the hook
+ * framework. For example, a collective component could register a callback
+ * at the bottom of init to perform some action.
+ */
+OMPI_DECLSPEC int ompi_hook_base_register_callbacks(ompi_hook_base_component_t *comp);
+OMPI_DECLSPEC int ompi_hook_base_deregister_callbacks(ompi_hook_base_component_t *comp);
+
+/**
+ * Wrapper functions matching the interface functions
+ */
+OMPI_DECLSPEC void ompi_hook_base_mpi_initialized_top(int *flag);
+OMPI_DECLSPEC void ompi_hook_base_mpi_initialized_bottom(int *flag);
+
+OMPI_DECLSPEC void ompi_hook_base_mpi_init_thread_top(int *argc, char ***argv, int required, int *provided);
+OMPI_DECLSPEC void ompi_hook_base_mpi_init_thread_bottom(int *argc, char ***argv, int required, int *provided);
+
+OMPI_DECLSPEC void ompi_hook_base_mpi_finalized_top(int *flag);
+OMPI_DECLSPEC void ompi_hook_base_mpi_finalized_bottom(int *flag);
+
+OMPI_DECLSPEC void ompi_hook_base_mpi_init_top(int argc, char **argv, int requested, int *provided);
+OMPI_DECLSPEC void ompi_hook_base_mpi_init_top_post_opal(int argc, char **argv, int requested, int *provided);
+OMPI_DECLSPEC void ompi_hook_base_mpi_init_bottom(int argc, char **argv, int requested, int *provided);
+OMPI_DECLSPEC void ompi_hook_base_mpi_init_error(int argc, char **argv, int requested, int *provided);
+
+OMPI_DECLSPEC void ompi_hook_base_mpi_finalize_top(void);
+OMPI_DECLSPEC void ompi_hook_base_mpi_finalize_bottom(void);
+
+END_C_DECLS
+
+#endif /* OMPI_BASE_HOOK_H */

ompi/mca/hook/base/help-mca-hook-base.txt

@@ -0,0 +1,19 @@
+# -*- text -*-
+#
+# Copyright (c) 2017      IBM Corporation.  All rights reserved.
+# $COPYRIGHT$
+#
+# Additional copyrights may follow
+#
+# $HEADER$
+#
+# This is the US/English help file for Open MPI MCA hook-specific
+# error messages.
+#
+[hook:missing-required-component]
+Error: A request was made to exclude a hook component from consideration that
+is required to be included. This component (noted below) can -not- be excluded
+from consideration. The program will fail at this time.
+
+Framework: %s
+Component: %s