opal: clean up init/finalize

This commit contains the following changes:

 - Remove the unused opal_test_init/opal_test_finalize
   functions. These functions are not used by anything in the code
   base or MTT. Tests use opal_init_util/opal_finalize_util instead.

 - Get rid of gotos in opal_init_util and opal_init. Replaced them
   with a cleaner solution.

 - Automatically register cleanup functions in init functions. The
   cleanup functions are executed in the reverse order of the
   initialization functions. The cleanup functions are run in
   opal_finalize_util() before tearing down the class system.

Signed-off-by: Nathan Hjelm <hjelmn@lanl.gov>

Author: hjelmn

opal/datatype/opal_datatype.h

@@ -16,6 +16,8 @@
  * Copyright (c) 2009      Oak Ridge National Labs.  All rights reserved.
  * Copyright (c) 2017-2018 Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
+ * Copyright (c) 2018      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -181,7 +183,6 @@ OPAL_DECLSPEC extern const opal_datatype_t opal_datatype_wchar;
  */
 int opal_datatype_register_params(void);
 OPAL_DECLSPEC int32_t opal_datatype_init( void );
-OPAL_DECLSPEC int32_t opal_datatype_finalize( void );
 OPAL_DECLSPEC opal_datatype_t* opal_datatype_create( int32_t expectedSize );
 OPAL_DECLSPEC int32_t opal_datatype_create_desc( opal_datatype_t * datatype, int32_t expectedSize );
 OPAL_DECLSPEC int32_t opal_datatype_commit( opal_datatype_t * pData );

opal/datatype/opal_datatype_module.c

@@ -17,6 +17,8 @@
  *                         reserved.
  * Copyright (c) 2015      Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
+ * Copyright (c) 2018      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -28,6 +30,7 @@
 
 #include <stddef.h>
 
+#include "opal/runtime/opal.h"
 #include "opal/util/arch.h"
 #include "opal/util/output.h"
 #include "opal/datatype/opal_datatype_internal.h"
@@ -204,6 +207,21 @@ int opal_datatype_register_params(void)
     return OPAL_SUCCESS;
 }
 
+static void opal_datatype_finalize (void)
+{
+    /* As the synonyms are just copies of the internal data we should not free them.
+     * Anyway they are over the limit of OPAL_DATATYPE_MAX_PREDEFINED so they will never get freed.
+     */
+
+    /* As they are statically allocated they cannot be released. But we
+     * can call OBJ_DESTRUCT, just to free all internally allocated ressources.
+     */
+    /* clear all master convertors */
+    opal_convertor_destroy_masters();
+
+    opal_output_close (opal_datatype_dfd);
+    opal_datatype_dfd = -1;
+}
 
 int32_t opal_datatype_init( void )
 {
@@ -242,27 +260,7 @@ int32_t opal_datatype_init( void )
         opal_output_set_verbosity(opal_datatype_dfd, opal_ddt_verbose);
     }
 
-    return OPAL_SUCCESS;
-}
-
-
-int32_t opal_datatype_finalize( void )
-{
-    /* As the synonyms are just copies of the internal data we should not free them.
-     * Anyway they are over the limit of OPAL_DATATYPE_MAX_PREDEFINED so they will never get freed.
-     */
-
-    /* As they are statically allocated they cannot be released. But we
-     * can call OBJ_DESTRUCT, just to free all internally allocated ressources.
-     */
-#if defined(VERBOSE)
-    if( opal_datatype_dfd != -1 )
-        opal_output_close( opal_datatype_dfd );
-    opal_datatype_dfd = -1;
-#endif /* VERBOSE */
-
-    /* clear all master convertors */
-    opal_convertor_destroy_masters();
+    opal_finalize_register_cleanup (opal_datatype_finalize);
 
     return OPAL_SUCCESS;
 }

opal/dss/dss.h

@@ -1,5 +1,5 @@
-/* -*- C -*-
- *
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
+/*
  * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
  *                         Corporation.  All rights reserved.
@@ -12,6 +12,8 @@
  *                         All rights reserved.
  * Copyright (c) 2012      Los Alamos National Security, Inc. All rights reserved.
  * Copyright (c) 2014-2017 Intel, Inc. All rights reserved.
+ * Copyright (c) 2018      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -357,12 +359,6 @@ OPAL_DECLSPEC int opal_dss_register_vars (void);
  */
 OPAL_DECLSPEC int opal_dss_open(void);
 
-/**
- * DSS finalize function
- */
-OPAL_DECLSPEC int opal_dss_close(void);
-
-
 /**
  * Copy a data value from one location to another.
  *

opal/dss/dss_open_close.c

@@ -1,4 +1,4 @@
-/* -*- Mode: C; c-basic-offset:4 ; -*- */
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -15,6 +15,8 @@
  * Copyright (c) 2015      Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2017      IBM Corporation. All rights reserved.
+ * Copyright (c) 2018      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -26,6 +28,7 @@
  */
 #include "opal_config.h"
 
+#include "opal/runtime/opal.h"
 #include "opal/mca/base/mca_base_var.h"
 
 #include "opal/dss/dss_internal.h"
@@ -312,6 +315,21 @@ int opal_dss_register_vars (void)
     return (0 > ret) ? ret : OPAL_SUCCESS;
 }
 
+static void opal_dss_close (void)
+{
+    opal_dss_initialized = false;
+
+    for (int i = 0 ; i < opal_pointer_array_get_size(&opal_dss_types) ; ++i) {
+        opal_dss_type_info_t *info = (opal_dss_type_info_t*)opal_pointer_array_get_item(&opal_dss_types, i);
+        if (NULL != info) {
+            opal_pointer_array_set_item(&opal_dss_types, i, NULL);
+            OBJ_RELEASE(info);
+        }
+    }
+
+    OBJ_DESTRUCT(&opal_dss_types);
+}
+
 int opal_dss_open(void)
 {
     int rc;
@@ -658,28 +676,8 @@ int opal_dss_open(void)
     /* All done */
 
     opal_dss_initialized = true;
-    return OPAL_SUCCESS;
-}
 
-
-int opal_dss_close(void)
-{
-    int32_t i;
-
-    if (!opal_dss_initialized) {
-        return OPAL_SUCCESS;
-    }
-    opal_dss_initialized = false;
-
-    for (i = 0 ; i < opal_pointer_array_get_size(&opal_dss_types) ; ++i) {
-        opal_dss_type_info_t *info = (opal_dss_type_info_t*)opal_pointer_array_get_item(&opal_dss_types, i);
-        if (NULL != info) {
-            opal_pointer_array_set_item(&opal_dss_types, i, NULL);
-            OBJ_RELEASE(info);
-        }
-    }
-
-    OBJ_DESTRUCT(&opal_dss_types);
+    opal_finalize_register_cleanup (opal_dss_close);
 
     return OPAL_SUCCESS;
 }

opal/mca/base/base.h

@@ -16,6 +16,8 @@
  * Copyright (c) 2015      Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
  * Copyright (c) 2017 IBM Corporation.  All rights reserved.
+ * Copyright (c) 2018      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -130,7 +132,7 @@ OPAL_DECLSPEC int mca_base_open(void);
  * It must be the last MCA function invoked.  It is normally invoked
  * during the finalize stage.
  */
-OPAL_DECLSPEC int mca_base_close(void);
+OPAL_DECLSPEC void mca_base_close(void);
 
 /**
  * A generic select function

opal/mca/base/mca_base_close.c

@@ -33,35 +33,34 @@ extern int mca_base_opened;
 /*
  * Main MCA shutdown.
  */
-int mca_base_close(void)
+
+void mca_base_close (void)
 {
     assert (mca_base_opened);
-    if (!--mca_base_opened) {
-        /* deregister all MCA base parameters */
-        int group_id = mca_base_var_group_find ("opal", "mca", "base");
+    if (--mca_base_opened) {
+        return;
+    }
 
-        if (-1 < group_id) {
-            mca_base_var_group_deregister (group_id);
-        }
+    /* deregister all MCA base parameters */
+    int group_id = mca_base_var_group_find ("opal", "mca", "base");
 
-        /* release the default paths */
-        if (NULL != mca_base_system_default_path) {
-            free(mca_base_system_default_path);
-        }
-        if (NULL != mca_base_user_default_path) {
-            free(mca_base_user_default_path);
-        }
+    if (-1 < group_id) {
+        mca_base_var_group_deregister (group_id);
+    }
 
-        /* Close down the component repository */
-        mca_base_component_repository_finalize();
+    /* release the default paths */
+    free (mca_base_system_default_path);
+    mca_base_system_default_path = NULL;
 
-        /* Shut down the dynamic component finder */
-        mca_base_component_find_finalize();
+    free (mca_base_user_default_path);
+    mca_base_user_default_path = NULL;
 
-        /* Close opal output stream 0 */
-        opal_output_close(0);
-    }
+    /* Close down the component repository */
+    mca_base_component_repository_finalize();
+
+    /* Shut down the dynamic component finder */
+    mca_base_component_find_finalize();
 
-    /* All done */
-    return OPAL_SUCCESS;
+    /* Close opal output stream 0 */
+    opal_output_close(0);
 }

opal/mca/base/mca_base_framework.c

@@ -5,6 +5,8 @@
  * Copyright (c) 2015 Cisco Systems, Inc.  All rights reserved.
  * Copyright (c) 2017 IBM Corporation.  All rights reserved.
  * Copyright (c) 2018      Amazon.com, Inc. or its affiliates.  All Rights reserved.
+ * Copyright (c) 2018      Triad National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -140,6 +142,22 @@ int mca_base_framework_register (struct mca_base_framework_t *framework,
     return OPAL_SUCCESS;
 }
 
+int mca_base_framework_register_list (mca_base_framework_t **frameworks, mca_base_register_flag_t flags)
+{
+    if (NULL == frameworks) {
+        return OPAL_ERR_BAD_PARAM;
+    }
+
+    for (int i = 0 ; frameworks[i] ; ++i) {
+        int ret = mca_base_framework_register (frameworks[i], flags);
+        if (OPAL_UNLIKELY(OPAL_SUCCESS != ret && OPAL_ERR_NOT_AVAILABLE != ret)) {
+            return ret;
+        }
+    }
+
+    return OPAL_SUCCESS;
+}
+
 int mca_base_framework_open (struct mca_base_framework_t *framework,
                              mca_base_open_flag_t flags) {
     int ret;
@@ -189,6 +207,22 @@ int mca_base_framework_open (struct mca_base_framework_t *framework,
     return ret;
 }
 
+int mca_base_framework_open_list (mca_base_framework_t **frameworks, mca_base_open_flag_t flags)
+{
+    if (NULL == frameworks) {
+        return OPAL_ERR_BAD_PARAM;
+    }
+
+    for (int i = 0 ; frameworks[i] ; ++i) {
+        int ret = mca_base_framework_open (frameworks[i], flags);
+        if (OPAL_UNLIKELY(OPAL_SUCCESS != ret && OPAL_ERR_NOT_AVAILABLE != ret)) {
+            return ret;
+        }
+    }
+
+    return OPAL_SUCCESS;
+}
+
 int mca_base_framework_close (struct mca_base_framework_t *framework) {
     bool is_open = mca_base_framework_is_open (framework);
     bool is_registered = mca_base_framework_is_registered (framework);
@@ -247,3 +281,19 @@ int mca_base_framework_close (struct mca_base_framework_t *framework) {
 
     return ret;
 }
+
+int mca_base_framework_close_list (mca_base_framework_t **frameworks)
+{
+    if (NULL == frameworks) {
+        return OPAL_ERR_BAD_PARAM;
+    }
+
+    for (int i = 0 ; frameworks[i] ; ++i) {
+        int ret = mca_base_framework_close (frameworks[i]);
+        if (OPAL_UNLIKELY(OPAL_SUCCESS != ret)) {
+            return ret;
+        }
+    }
+
+    return OPAL_SUCCESS;
+}