openmpi/orte/mca/notifier/base/notifier_base_select.c

/*
 * Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2005 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  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 (c) 2009      Cisco Systems, Inc.  All rights reserved.
 * Copyright (c) 2014-2015 Intel, Inc. All rights reserved.
 * $COPYRIGHT$
 * 
 * Additional copyrights may follow
 * 
 * $HEADER$
 */


#include "orte_config.h"

#ifdef HAVE_STRING_H
#include <string.h>
#endif

#include "opal/mca/mca.h"
#include "opal/mca/base/base.h"
#include "opal/util/argv.h"
#include "opal/util/output.h"
#include "opal/class/opal_pointer_array.h"

#include "orte/mca/notifier/base/base.h"

/* Global variables */
/*
 * orte_notifier_base_selected is set to true if at least 1 module has
 * been selected for the notifier log API interface.
 */
static bool orte_notifier_base_selected = false;

/** 
 * Function for weeding out notifier components that don't want to run.
 *
 * Call the init function on all available compoenent 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 called in a opal_list_t.
 */

int orte_notifier_base_select(void)
{
    mca_base_component_list_item_t *cli = NULL;
    orte_notifier_base_component_t *component = NULL;
    mca_base_module_t *module = NULL;
    orte_notifier_active_module_t *i_module;
    int priority = 0, i, j, low_i;
    opal_pointer_array_t tmp_array;
    bool none_found;
    orte_notifier_active_module_t *tmp_module = NULL, *tmp_module_sw = NULL;


    if (orte_notifier_base_selected) {
        return ORTE_SUCCESS;
    }
    orte_notifier_base_selected = true;

    OBJ_CONSTRUCT(&tmp_array, opal_pointer_array_t);

    opal_output_verbose(10, orte_notifier_base_framework.framework_output,
                        "notifier:base:select: Auto-selecting components");

    /*
     * Traverse the list of available components.
     * For each call their 'query' functions to determine relative priority.
     */
    none_found = true;
    OPAL_LIST_FOREACH(cli, &orte_notifier_base_framework.framework_components, mca_base_component_list_item_t) {
        component = (orte_notifier_base_component_t *) cli->cli_component;

        /*
         * If there is a query function then use it.
         */
        if (NULL == component->base_version.mca_query_component) {
            opal_output_verbose(5, orte_notifier_base_framework.framework_output,
                                "notifier:base:select Skipping component [%s]. It does not implement a query function",
                                component->base_version.mca_component_name );
            continue;
        }

        /*
         * Query this component for the module and priority
         */
        opal_output_verbose(5, orte_notifier_base_framework.framework_output,
                            "notifier:base:select Querying component [%s]",
                            component->base_version.mca_component_name);

        component->base_version.mca_query_component(&module, &priority);

        /*
         * If no module was returned or negative priority, then skip component
         */
        if (NULL == module || priority < 0) {
            opal_output_verbose(5, orte_notifier_base_framework.framework_output,
                                "notifier:base:select Skipping component [%s]. Query failed to return a module",
                                component->base_version.mca_component_name );
            continue;
        }

        /*
         * Append them to the temporary list, we will sort later
         */
        opal_output_verbose(5, orte_notifier_base_framework.framework_output,
                            "notifier:base:select Query of component [%s] set priority to %d", 
                            component->base_version.mca_component_name, priority);
        tmp_module = OBJ_NEW(orte_notifier_active_module_t);
        tmp_module->component = component;
        tmp_module->module    = (orte_notifier_base_module_t*)module;
        tmp_module->priority  = priority;

        opal_pointer_array_add(&tmp_array, (void*)tmp_module);
        none_found = false;
    }

    if (none_found) {
        /* okay for no modules to be found */
        return ORTE_SUCCESS;
    }

    /*
     * Sort the list by decending priority
     */
    priority = 0;
    for(j = 0; j < tmp_array.size; ++j) {
        tmp_module_sw = (orte_notifier_active_module_t*)opal_pointer_array_get_item(&tmp_array, j);
        if( NULL == tmp_module_sw ) {
            continue;
        }

        low_i   = -1;
        priority = tmp_module_sw->priority;

        for(i = 0; i < tmp_array.size; ++i) {
            tmp_module = (orte_notifier_active_module_t*)opal_pointer_array_get_item(&tmp_array, i);
            if( NULL == tmp_module ) {
                continue;
            }
            if( tmp_module->priority > priority ) {
                low_i = i;
                priority = tmp_module->priority;
            }
        }

        if( low_i >= 0 ) {
            tmp_module = (orte_notifier_active_module_t*)opal_pointer_array_get_item(&tmp_array, low_i);
            if ( NULL == tmp_module ) {
                continue;
            }
            opal_pointer_array_set_item(&tmp_array, low_i, NULL);
            j--; /* Try this entry again, if it is not the lowest */
        } else {
            tmp_module = tmp_module_sw;
            opal_pointer_array_set_item(&tmp_array, j, NULL);
        }
        if ( tmp_module ) {
            opal_output_verbose(5, orte_notifier_base_framework.framework_output,
                                "notifier:base:select Add module with priority [%s] %d",
                                tmp_module->component->base_version.mca_component_name, tmp_module->priority);
            opal_pointer_array_add(&orte_notifier_base.modules, tmp_module);
        }
    }
    OBJ_DESTRUCT(&tmp_array);

    /*
     * Initialize each of the modules in priority order from
     * highest to lowest
     */
    for(i = 0; i < orte_notifier_base.modules.size; ++i) {
        i_module = (orte_notifier_active_module_t*)opal_pointer_array_get_item(&orte_notifier_base.modules, i);
        if( NULL == i_module ) {
            continue;
        }
        if( NULL != i_module->module->init ) {
            opal_output_verbose(5, orte_notifier_base_framework.framework_output,
                                "notifier:base:init module called with priority [%s] %d",
                                i_module->component->base_version.mca_component_name, i_module->priority);
            if (ORTE_SUCCESS != i_module->module->init()) {
                opal_pointer_array_set_item(&orte_notifier_base.modules, i, NULL);
                OBJ_RELEASE(i_module);
            }
        }
    }

    return ORTE_SUCCESS;
}