openmpi/src/mca/coll/sm/coll_sm_component.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$
 * 
 * Additional copyrights may follow
 * 
 * $HEADER$
 *
 * These symbols are in a file by themselves to provide nice linker
 * semantics.  Since linkers generally pull in symbols by object
 * files, keeping these symbols as the only symbols in this file
 * prevents utility programs such as "ompi_info" from having to import
 * entire components just to query their version and parameters.
 */

#include "ompi_config.h"

#include "include/constants.h"
#include "mca/coll/coll.h"
#include "coll_sm.h"
#include "mca/coll/sm/coll-sm-version.h"


/*
 * Public string showing the coll ompi_sm component version number
 */
const char *mca_coll_sm_component_version_string =
    "Open MPI sm collective MCA component version " MCA_coll_sm_VERSION;


/*
 * Local functions
 */

static int sm_open(void);


/*
 * Instantiate the public struct with all of our public information
 * and pointers to our public functions in it
 */

const mca_coll_base_component_1_0_0_t mca_coll_sm_component = {

    /* First, the mca_component_t struct containing meta information
       about the component itself */

    {
        /* Indicate that we are a coll v1.0.0 component (which also
           implies a specific MCA version) */

        MCA_COLL_BASE_VERSION_1_0_0,

        /* Component name and version */

        "sm",
        MCA_coll_sm_MAJOR_VERSION,
        MCA_coll_sm_MINOR_VERSION,
        MCA_coll_sm_RELEASE_VERSION,

        /* Component open and close functions */

        sm_open,
        NULL
    },

    /* Next the MCA v1.0.0 component meta data */

    {
        /* Whether the component is checkpointable or not */

        true
    },

    /* Initialization / querying functions */

    mca_coll_sm_init_query,
    mca_coll_sm_comm_query,
    mca_coll_sm_comm_unquery,
};


/*
 * Open the component
 */
static int sm_open(void)
{
    /* If we want to be selected (i.e., all procs on one node), then
       we should have a high priority */
    
    mca_coll_sm_param_priority = 
        mca_base_param_register_int("coll", "sm", "priority", NULL, 75);

    return OMPI_SUCCESS;
}