openmpi/ompi/mca/btl/base/btl_base_select.c

/*
 * Copyright (c) 2004-2005 The Trustees of Indiana University.
 *                         All rights reserved.
 * Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
 *                         All rights reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart, 
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * $COPYRIGHT$
 * 
 * Additional copyrights may follow
 * 
 * $HEADER$
 */

#include "ompi_config.h"

#include "opal/util/argv.h"
#include "runtime/runtime.h"
#include "mca/mca.h"
#include "mca/base/base.h"
#include "mca/pml/pml.h"
#include "mca/btl/btl.h"
#include "mca/btl/base/base.h"

OBJ_CLASS_INSTANCE(
   mca_btl_base_selected_module_t,
   opal_list_item_t,
   NULL,
   NULL);

/**
 * Function for weeding out btl components that don't want to run.
 *
 * Call the init function on all available components to find out if
 * they want to run.  Select all components that don't fail.  Failing
 * components will be closed and unloaded.  The selected modules will
 * be returned to the caller in a opal_list_t.
 */
int mca_btl_base_select(bool enable_progress_threads,
                        bool enable_mpi_threads)
{
  int i, num_btls;
  opal_list_item_t *item;
  mca_base_component_list_item_t *cli;
  mca_btl_base_component_t *component;
  mca_btl_base_module_t **modules;
  mca_btl_base_selected_module_t *sm;

  char** include = opal_argv_split(mca_btl_base_include, ',');
  char** exclude = opal_argv_split(mca_btl_base_exclude, ',');

  /* Traverse the list of opened modules; call their init
     functions. */

  item  = opal_list_get_first(&mca_btl_base_components_opened);
  while(item != opal_list_get_end(&mca_btl_base_components_opened)) {
    opal_list_item_t *next = opal_list_get_next(item);
    cli = (mca_base_component_list_item_t *) item;

    component = (mca_btl_base_component_t *) cli->cli_component;

    /* if there is an include list - item must be in the list to be included */
    if ( NULL != include ) {
        char** argv = include; 
        bool found = false;
        while(argv && *argv) {
            if(strcmp(component->btl_version.mca_component_name,*argv) == 0) {
                found = true;
                break;
            }
            argv++;
        }
        if(found == false) {
            item = next;
            continue;
        }

    /* otherwise - check the exclude list to see if this item has been specifically excluded */
    } else if ( NULL != exclude ) {
        char** argv = exclude; 
        bool found = false;
        while(argv && *argv) {
            if(strcmp(component->btl_version.mca_component_name,*argv) == 0) {
                found = true;
                break;
            }
            argv++;
        }
        if(found == true) {
            item = next;
            continue;
        }
    }

    opal_output_verbose(10, mca_btl_base_output, 
                       "select: initializing %s component %s",
                       component->btl_version.mca_type_name,
                       component->btl_version.mca_component_name);
    if (NULL == component->btl_init) {
      opal_output_verbose(10, mca_btl_base_output,
                         "select: no init function; ignoring component");
    } else {
      modules = component->btl_init(&num_btls, enable_progress_threads,
                                     enable_mpi_threads);

      /* If the component didn't initialize, remove it from the opened
         list and remove it from the component repository */

      if (NULL == modules) {
        opal_output_verbose(10, mca_btl_base_output,
                           "select: init returned failure");
        opal_output_verbose(10, mca_btl_base_output,
                            "select: module %s unloaded",
                            component->btl_version.mca_component_name);

        mca_base_component_repository_release((mca_base_component_t *) component);
        opal_list_remove_item(&mca_btl_base_components_opened, item);
      } 

      /* Otherwise, it initialized properly.  Save it. */

      else {
        opal_output_verbose(10, mca_btl_base_output,
                           "select: init returned success");

        for (i = 0; i < num_btls; ++i) {
          sm = OBJ_NEW(mca_btl_base_selected_module_t);
          if (NULL == sm) {
            return OMPI_ERR_OUT_OF_RESOURCE;
          }
          sm->btl_component = component;
          sm->btl_module = modules[i];
          opal_list_append(&mca_btl_base_modules_initialized,
                          (opal_list_item_t*) sm);
        }
        free(modules);
      }
    }
    item = next;
  }

  /* Finished querying all components.  Check for the bozo case. */

  if (0 == opal_list_get_size(&mca_btl_base_modules_initialized)) {
    /* JMS Replace with show_help */
    orte_abort(1, "No btl components available.  This shouldn't happen.");
  }
  return OMPI_SUCCESS;
}