mca/base: add priority output to mca_base_select

hjelmn · hjelmn · commit 1e069fcecf28 · 2015-10-22T11:02:04.000-06:00
The mca_base_select function uses returned priorities to select the best component/module. This priority may be of use to the caller so pass that information back in an optional argument. If the priority is not needed pass NULL. Signed-off-by: Nathan Hjelm <hjelmn@lanl.gov> (cherry picked from open-mpi/ompi@8b5810f)
diff --git a/ompi/mca/crcp/base/crcp_base_select.c b/ompi/mca/crcp/base/crcp_base_select.c
@@ -162,7 +162,7 @@ int ompi_crcp_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("crcp", ompi_crcp_base_framework.framework_output,
                                         &ompi_crcp_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         return OMPI_ERROR;
     }
diff --git a/ompi/mca/mtl/base/base.h b/ompi/mca/mtl/base/base.h
@@ -1,3 +1,4 @@
+/* -*- 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
@@ -9,6 +10,8 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2006 The Regents of the University of California.
  *                         All rights reserved.
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -34,7 +37,8 @@ BEGIN_C_DECLS
 OMPI_DECLSPEC extern mca_mtl_base_component_t* ompi_mtl_base_selected_component;
 
 OMPI_DECLSPEC int ompi_mtl_base_select(bool enable_progress_threads,
-                                       bool enable_mpi_threads);
+                                       bool enable_mpi_threads,
+                                       int *priority);
 
 OMPI_DECLSPEC extern mca_base_framework_t ompi_mtl_base_framework;
 
diff --git a/ompi/mca/mtl/base/mtl_base_frame.c b/ompi/mca/mtl/base/mtl_base_frame.c
@@ -1,3 +1,4 @@
+/* -*- 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
@@ -54,14 +55,16 @@ ompi_mtl_base_select(bool enable_progress_threads,
     int ret = OMPI_ERR_NOT_FOUND;
     mca_mtl_base_component_t *best_component = NULL;
     mca_mtl_base_module_t *best_module = NULL;
+    int best_priority;
 
     /*
      * Select the best component
      */
     if( OPAL_SUCCESS != mca_base_select("mtl", ompi_mtl_base_framework.framework_output,
                                         &ompi_mtl_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component,
+                                        &best_priority) ) {
         /* notify caller that no available component found */
         return ret;
     }
diff --git a/opal/mca/base/base.h b/opal/mca/base/base.h
@@ -134,7 +134,8 @@ OPAL_DECLSPEC int mca_base_close(void);
 OPAL_DECLSPEC int mca_base_select(const char *type_name, int output_id,
                                   opal_list_t *components_available,
                                   mca_base_module_t **best_module,
-                                  mca_base_component_t **best_component);
+                                  mca_base_component_t **best_component,
+                                  int *priority_out);
 
 /**
  * A function for component query functions to discover if they have
diff --git a/opal/mca/base/mca_base_components_select.c b/opal/mca/base/mca_base_components_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -33,7 +34,8 @@
 int mca_base_select(const char *type_name, int output_id,
                     opal_list_t *components_available,
                     mca_base_module_t **best_module,
-                    mca_base_component_t **best_component)
+                    mca_base_component_t **best_component,
+                    int *priority_out)
 {
     mca_base_component_list_item_t *cli = NULL;
     mca_base_component_t *component = NULL;
@@ -108,6 +110,9 @@ int mca_base_select(const char *type_name, int output_id,
         }
     }
 
+    if (priority_out) {
+        *priority_out = best_priority;
+    }
 
     /*
      * Finished querying all components.
diff --git a/opal/mca/compress/base/compress_base_select.c b/opal/mca/compress/base/compress_base_select.c
@@ -1,9 +1,12 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2010 The Trustees of Indiana University.
  *                         All rights reserved.
  * Copyright (c) 2015      Research Organization for Information Science
  *                         and Technology (RIST). All rights reserved.
  *
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -43,7 +46,7 @@ int opal_compress_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("compress", opal_compress_base_framework.framework_output,
                                         &opal_compress_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         exit_status = OPAL_ERROR;
         goto cleanup;
diff --git a/opal/mca/crs/base/crs_base_select.c b/opal/mca/crs/base/crs_base_select.c
@@ -58,7 +58,7 @@ int opal_crs_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("crs", opal_crs_base_framework.framework_output,
                                         &opal_crs_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         return OPAL_ERROR;
     }
diff --git a/opal/mca/dl/base/dl_base_select.c b/opal/mca/dl/base/dl_base_select.c
@@ -1,9 +1,12 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2010 The Trustees of Indiana University.
  *                         All rights reserved.
  *
  * Copyright (c) 2015 Cisco Systems, Inc.  All rights reserved.
  * $COPYRIGHT$
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  *
  * Additional copyrights may follow
  *
@@ -37,7 +40,7 @@ int opal_dl_base_select(void)
                                         opal_dl_base_framework.framework_output,
                                         &opal_dl_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         exit_status = OPAL_ERROR;
         goto cleanup;
diff --git a/opal/mca/memchecker/base/memchecker_base_select.c b/opal/mca/memchecker/base/memchecker_base_select.c
@@ -1,8 +1,11 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2007 High Performance Computing Center Stuttgart,
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2008 The Trustees of Indiana University.
  *                         All rights reserved.
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -40,7 +43,7 @@ int opal_memchecker_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("memchecker", opal_memchecker_base_framework.framework_output,
                                         &opal_memchecker_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         exit_status = OPAL_ERR_NOT_FOUND;
         goto cleanup;
diff --git a/opal/mca/pmix/base/pmix_base_select.c b/opal/mca/pmix/base/pmix_base_select.c
@@ -1,5 +1,8 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2014-2015 Intel, Inc. All rights reserved.
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -31,7 +34,7 @@ int opal_pmix_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("pmix", opal_pmix_base_framework.framework_output,
                                         &opal_pmix_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* notify caller that no available component found */
         return OPAL_ERR_NOT_FOUND;
     }
diff --git a/opal/mca/pstat/base/pstat_base_select.c b/opal/mca/pstat/base/pstat_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -10,6 +11,8 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2007      Cisco Systems, Inc. All rights reserved.
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -42,7 +45,7 @@ int opal_pstat_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("pstat", opal_pstat_base_framework.framework_output,
                                         &opal_pstat_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* It is okay if we don't find a runnable component - default
          * to the unsupported default.
          */
diff --git a/orte/mca/dfs/base/dfs_base_select.c b/orte/mca/dfs/base/dfs_base_select.c
@@ -1,5 +1,7 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
- * Copyright (c) 2012      Los Alamos National Security, Inc.  All rights reserved.
+ * Copyright (c) 2012-2015 Los Alamos National Security, Inc.  All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -31,7 +33,7 @@ int orte_dfs_base_select(void)
     if (OPAL_SUCCESS != mca_base_select("dfs", orte_dfs_base_framework.framework_output,
                                         &orte_dfs_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component)) {
+                                        (mca_base_component_t **) &best_component, NULL)) {
         /* This will only happen if no component was selected, which
          * is okay - we don't have to select anything
          */
diff --git a/orte/mca/errmgr/base/errmgr_base_select.c b/orte/mca/errmgr/base/errmgr_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2010 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -10,7 +11,8 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2010      Cisco Systems, Inc.  All rights reserved.
- * Copyright (c) 2012-2013 Los Alamos National Security, Inc.  All rights reserved.
+ * Copyright (c) 2012-2015 Los Alamos National Security, Inc.  All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -43,7 +45,7 @@ int orte_errmgr_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("errmgr", orte_errmgr_base_framework.framework_output,
                                         &orte_errmgr_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         exit_status = ORTE_ERROR;
         goto cleanup;
diff --git a/orte/mca/ess/base/ess_base_select.c b/orte/mca/ess/base/ess_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -10,7 +11,7 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2011 Cisco Systems, Inc.  All rights reserved.
- * Copyright (c) 2013      Los Alamos National Security, LLC.  All rights reserved.
+ * Copyright (c) 2013-2015 Los Alamos National Security, LLC.  All rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -39,7 +40,7 @@ orte_ess_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("ess", orte_ess_base_framework.framework_output,
                                         &orte_ess_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* error message emitted by fn above */
         return ORTE_ERR_SILENT;
     }
diff --git a/orte/mca/filem/base/filem_base_select.c b/orte/mca/filem/base/filem_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University.
  *                         All rights reserved.
@@ -7,7 +8,7 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
- * Copyright (c) 2012      Los Alamos National Security, LLC.
+ * Copyright (c) 2012-2015 Los Alamos National Security, LLC.
  *                         All rights reserved
  * $COPYRIGHT$
  *
@@ -42,7 +43,7 @@ int orte_filem_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("filem", orte_filem_base_framework.framework_output,
                                         &orte_filem_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* It is okay to not select anything - we'll just retain
          * the default none module
          */
diff --git a/orte/mca/iof/base/iof_base_select.c b/orte/mca/iof/base/iof_base_select.c
@@ -1,3 +1,4 @@
+/* -*- 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
@@ -9,6 +10,8 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -45,7 +48,7 @@ int orte_iof_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("iof", orte_iof_base_framework.framework_output,
                                         &orte_iof_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* it is okay to not find a module if we are a CM process */
         if (ORTE_PROC_IS_CM) {
             return ORTE_SUCCESS;
diff --git a/orte/mca/odls/base/odls_base_select.c b/orte/mca/odls/base/odls_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -9,6 +10,8 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
+ * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -42,7 +45,7 @@ int orte_odls_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("odls", orte_odls_base_framework.framework_output,
                                         &orte_odls_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         return ORTE_ERR_NOT_FOUND;
     }
diff --git a/orte/mca/plm/base/plm_base_select.c b/orte/mca/plm/base/plm_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -9,9 +10,9 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
- * Copyright (c) 2011-2013 Los Alamos National Security, LLC.
+ * Copyright (c) 2011-2015 Los Alamos National Security, LLC.
  *                         All rights reserved.
-* Copyright (c) 2015      Intel, Inc. All rights reserved.
+ * Copyright (c) 2015      Intel, Inc. All rights reserved.
  * $COPYRIGHT$
  *
  * Additional copyrights may follow
@@ -49,7 +50,7 @@ int orte_plm_base_select(void)
     if (OPAL_SUCCESS == (rc = mca_base_select("plm", orte_plm_base_framework.framework_output,
                                               &orte_plm_base_framework.framework_components,
                                               (mca_base_module_t **) &best_module,
-                                              (mca_base_component_t **) &best_component))) {
+                                              (mca_base_component_t **) &best_component, NULL))) {
         /* Save the winner */
         orte_plm = *best_module;
     }
diff --git a/orte/mca/ras/base/ras_base_select.c b/orte/mca/ras/base/ras_base_select.c
@@ -1,3 +1,4 @@
+/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
 /*
  * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
  *                         University Research and Technology
@@ -9,7 +10,7 @@
  *                         University of Stuttgart.  All rights reserved.
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
- * Copyright (c) 2011-2013 Los Alamos National Security, LLC.  All rights
+ * Copyright (c) 2011-2015 Los Alamos National Security, LLC.  All rights
  *                         reserved.
  * $COPYRIGHT$
  *
@@ -45,7 +46,7 @@ int orte_ras_base_select(void)
     if( OPAL_SUCCESS != mca_base_select("ras", orte_ras_base_framework.framework_output,
                                         &orte_ras_base_framework.framework_components,
                                         (mca_base_module_t **) &best_module,
-                                        (mca_base_component_t **) &best_component) ) {
+                                        (mca_base_component_t **) &best_component, NULL) ) {
         /* This will only happen if no component was selected */
         /* If we didn't find one to select, that is okay */
         return ORTE_SUCCESS;
diff --git a/orte/mca/routed/base/routed_base_frame.c b/orte/mca/routed/base/routed_base_frame.c
diff --git a/orte/mca/state/base/state_base_select.c b/orte/mca/state/base/state_base_select.c

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ int ompi_crcp_base_select(void)`
`162`	`162`	`if( OPAL_SUCCESS != mca_base_select("crcp", ompi_crcp_base_framework.framework_output,`
`163`	`163`	`&ompi_crcp_base_framework.framework_components,`
`164`	`164`	`(mca_base_module_t **) &best_module,`
`165`		`- (mca_base_component_t **) &best_component) ) {`
	`165`	`+ (mca_base_component_t **) &best_component, NULL) ) {`
`166`	`166`	`/* This will only happen if no component was selected */`
`167`	`167`	`return OMPI_ERROR;`
`168`	`168`	`}`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ int opal_crs_base_select(void)`
`58`	`58`	`if( OPAL_SUCCESS != mca_base_select("crs", opal_crs_base_framework.framework_output,`
`59`	`59`	`&opal_crs_base_framework.framework_components,`
`60`	`60`	`(mca_base_module_t **) &best_module,`
`61`		`- (mca_base_component_t **) &best_component) ) {`
	`61`	`+ (mca_base_component_t **) &best_component, NULL) ) {`
`62`	`62`	`/* This will only happen if no component was selected */`
`63`	`63`	`return OPAL_ERROR;`
`64`	`64`	`}`