mca/base: add priority output to mca_base_select

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.

This is a modification of
open-mpi/ompi@8b5810f . The primary
difference is we left the original mca_base_select in place for
compatibility.

Signed-off-by: Nathan Hjelm <[email protected]>

Author: hjelmn

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
@@ -52,14 +53,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) ) {
+    if( OPAL_SUCCESS != mca_base_select_new ("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,
+                                             &best_priority) ) {
         /* notify caller that no available component found */
         return ret;
     }

opal/mca/base/base.h

@@ -11,7 +11,7 @@
  * Copyright (c) 2004-2005 The Regents of the University of California.
  *                         All rights reserved.
  * Copyright (c) 2009      Cisco Systems, Inc.  All rights reserved.
- * Copyright (c) 2013      Los Alamos National Security, LLC. All rights
+ * Copyright (c) 2013-2015 Los Alamos National Security, LLC. All rights
  *                         reserved.
  * $COPYRIGHT$
  * 
@@ -108,11 +108,20 @@ OPAL_DECLSPEC int mca_base_close(void);
 /**
  * A generic select function
  *
+ * The _new version is a 1.10.x only function. It is the version available
+ * 2.0.0 and beyond. The old version calls the new version with NULL for
+ * priority_out.
  */
-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);
+OPAL_DECLSPEC int mca_base_select_new (const char *type_name, int output_id,
+                                       opal_list_t *components_available,
+                                       mca_base_module_t **best_module,
+                                       mca_base_component_t **best_component,
+                                       int *priority_out);
+
+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);
 
 /**
  * A function for component query functions to discover if they have

opal/mca/base/mca_base_components_select.c

@@ -1,7 +1,10 @@
+/* -*- 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
  *                         Corporation.  All rights reserved.
+ * Copyright (c) 2014      Los Alamos National Security, LLC. All rights
+ *                         reserved.
  * $COPYRIGHT$
  * 
  * Additional copyrights may follow
@@ -26,11 +29,21 @@
 #include "opal/mca/base/mca_base_component_repository.h"
 #include "opal/constants.h"
 
+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)
+{
+    return mca_base_select_new (type_name, output_id, components_available,
+                                best_module, best_component, NULL);
+}
 
-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)
+
+int mca_base_select_new (const char *type_name, int output_id,
+                         opal_list_t *components_available,
+                         mca_base_module_t **best_module,
+                         mca_base_component_t **best_component,
+                         int *priority_out)
 {
     mca_base_component_list_item_t *cli = NULL;
     mca_base_component_t *component = NULL;
@@ -93,6 +106,9 @@ int mca_base_select(const char *type_name, int output_id,
         }
     }
 
+    if (priority_out) {
+        *priority_out = best_priority;
+    }
 
     /*
      * Finished querying all components.