openmpi/orte/mca/rml/ftrm/rml_ftrm_module.c

/*
 * Copyright (c) 2004-2007 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$
 * 
 * Additional copyrights may follow
 * 
 * $HEADER$
 */

#include "orte_config.h"
#include "orte/orte_constants.h"

#include "opal/util/output.h"
#include "opal/mca/base/base.h"
#include "opal/mca/base/mca_base_param.h"

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

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

#include "rml_ftrm.h"

orte_rml_component_t wrapped_component;
orte_rml_module_t   wrapped_module;

/*
 * Init (Module)
 */
static int num_inits = 0;

int orte_rml_ftrm_module_init(void)
{
    int ret;

    /*
     * This is the first time init was called
     * just need to swap some pointers
     * Called from rml_base_select.c
     */
    if( 0 == num_inits ) {
        /* Copy the wrapped versions */
        wrapped_module    = orte_rml;
        wrapped_component = orte_rml_component;
        /* Replace with ourselves */
        orte_rml           = orte_rml_ftrm_module;
        orte_rml_component = mca_rml_ftrm_component;

        opal_output_verbose(20, rml_ftrm_output_handle,
                            "orte_rml_ftrm: module_init(): Wrapped Component (%s)",
                            wrapped_component.rml_version.mca_component_name);
    }
    /*
     * This is *not* the first time we have been called
     * now we need to send this information to the actual 
     * component.
     * Called from orte_init_stage1.c
     */
    else {
        opal_output_verbose(20, rml_ftrm_output_handle,
                            "orte_rml_ftrm: module_init(): Normal...");

        if( NULL != wrapped_module.init ) {
            if( ORTE_SUCCESS != (ret = wrapped_module.init() ) ) {
                return ret;
            }
        }
    }

    num_inits++;

    return ORTE_SUCCESS;
}
    
/*
 * Finalize (Module)
 */
int orte_rml_ftrm_module_finalize(void)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: module_finalize()");


    if( NULL != wrapped_module.fini ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.fini() ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}


/*
 * Get URI
 */
char * orte_rml_ftrm_get_uri(void)
{
    char * rtn_val = NULL;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: get_uri()");


    if( NULL != wrapped_module.get_uri ) {
        rtn_val = wrapped_module.get_uri();
    }

    return rtn_val;
}

/*
 * Set URI
 */
int orte_rml_ftrm_set_uri(const char* uri)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: set_uri()");

    if( NULL != wrapped_module.set_uri ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.set_uri(uri) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Parse URis
 */
int orte_rml_ftrm_parse_uris(const char* uri,
                             orte_process_name_t* peer, char*** uris)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: parse_uris()");

    if( NULL != wrapped_module.parse_uris ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.parse_uris(uri, peer, uris) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}


/*
 * Ping
 */
int orte_rml_ftrm_ping(const char* uri, const struct timeval* tv)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: ping()");

    if( NULL != wrapped_module.ping ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.ping(uri, tv) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}


/*
 * Send
 */
int orte_rml_ftrm_send(orte_process_name_t* peer,
                       struct iovec *msg,
                       int count,
                       int tag,
                       int flags)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: send()");

    if( NULL != wrapped_module.send ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.send(peer, msg, count, tag, flags) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Send Non-blocking
 */
int orte_rml_ftrm_send_nb(orte_process_name_t* peer,
                          struct iovec* msg,
                          int count,
                          orte_rml_tag_t tag,
                          int flags,
                          orte_rml_callback_fn_t cbfunc,
                          void* cbdata)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: send_nb()");

    if( NULL != wrapped_module.send_nb ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.send_nb(peer, msg, count, tag, flags, cbfunc, cbdata) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Send Buffer
 */
int orte_rml_ftrm_send_buffer(orte_process_name_t* peer,
                              orte_buffer_t* buffer,
                              orte_rml_tag_t tag,
                              int flags)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: send_buffer()");

    if( NULL != wrapped_module.send_buffer ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.send_buffer(peer, buffer, tag, flags) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Send Buffer Non-blocking
 */
int orte_rml_ftrm_send_buffer_nb(orte_process_name_t* peer,
                                 orte_buffer_t* buffer,
                                 orte_rml_tag_t tag,
                                 int flags,
                                 orte_rml_buffer_callback_fn_t cbfunc,
                                 void* cbdata)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: send_buffer_nb()");

    if( NULL != wrapped_module.send_buffer_nb ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.send_buffer_nb(peer, buffer, tag, flags, cbfunc, cbdata) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}


/*
 * Recv
 */
int orte_rml_ftrm_recv(orte_process_name_t* peer,
                       struct iovec *msg,
                       int count,
                       orte_rml_tag_t tag,
                       int flags)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: recv()");

    if( NULL != wrapped_module.recv ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.recv(peer, msg, count, tag, flags) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Recv Non-blocking
 */
int orte_rml_ftrm_recv_nb(orte_process_name_t* peer,
                          struct iovec* msg,
                          int count,
                          orte_rml_tag_t tag,
                          int flags,
                          orte_rml_callback_fn_t cbfunc,
                          void* cbdata)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: recv_nb()");

    if( NULL != wrapped_module.recv_nb ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.recv_nb(peer, msg, count, tag, flags, cbfunc, cbdata) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Recv Buffer
 */
int orte_rml_ftrm_recv_buffer(orte_process_name_t* peer,
                              orte_buffer_t *buf,
                              orte_rml_tag_t tag)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: recv_buffer()");

    if( NULL != wrapped_module.recv_buffer ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.recv_buffer(peer, buf, tag) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Recv Buffer Non-blocking
 */
int orte_rml_ftrm_recv_buffer_nb(orte_process_name_t* peer,
                                 orte_rml_tag_t tag,
                                 int flags,
                                 orte_rml_buffer_callback_fn_t cbfunc,
                                 void* cbdata)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: recv_buffer_nb()");

    if( NULL != wrapped_module.recv_buffer_nb ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.recv_buffer_nb(peer, tag, flags, cbfunc, cbdata) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

/*
 * Recv Cancel
 */
int orte_rml_ftrm_recv_cancel(orte_process_name_t* peer, orte_rml_tag_t tag)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: recv_cancel()");

    if( NULL != wrapped_module.recv_cancel ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.recv_cancel(peer, tag) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}


/*
 * Xcast
 */
int orte_rml_ftrm_xcast(orte_jobid_t job,
                        orte_buffer_t *buffer,
                        orte_rml_tag_t tag)
{
    int ret;
    
    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: xcast()");
    
    if( NULL != wrapped_module.xcast ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.xcast(job, buffer, tag) ) ) {
            return ret;
        }
    }
    
    return ORTE_SUCCESS;
}

int orte_rml_ftrm_xcast_nb(orte_jobid_t job,
                           orte_buffer_t *buffer,
                           orte_rml_tag_t tag)
{
    int ret;
    
    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: xcast_nb()");
    
    if( NULL != wrapped_module.xcast_gate ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.xcast_nb(job, buffer, tag) ) ) {
            return ret;
        }
    }
    
    return ORTE_SUCCESS;
}

int orte_rml_ftrm_xcast_gate(orte_gpr_trigger_cb_fn_t cbfunc)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: xcast_gate()");

    if( NULL != wrapped_module.xcast_gate ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.xcast_gate(cbfunc) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}


/*
 * Register a callback on loss of connection
 */
int orte_rml_ftrm_add_exception_handler(orte_rml_exception_callback_t cbfunc)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: add_exception_handler()");

    if( NULL != wrapped_module.add_exception_handler ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.add_exception_handler(cbfunc) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

int orte_rml_ftrm_del_exception_handler(orte_rml_exception_callback_t cbfunc)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: del_exception_handler()");

    if( NULL != wrapped_module.del_exception_handler ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.del_exception_handler(cbfunc) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

int orte_rml_ftrm_register_contact_info(void)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: register_contact_info()");

    if( NULL != wrapped_module.register_contact_info ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.register_contact_info() ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

int orte_rml_ftrm_register_subscription(orte_jobid_t job, char *trigger)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: register_subscription()");

    if( NULL != wrapped_module.register_subscription ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.register_subscription(job, trigger) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

int orte_rml_ftrm_get_contact_info(orte_process_name_t *name, orte_gpr_notify_data_t **data)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: get_contact_info()");

    if( NULL != wrapped_module.get_contact_info ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.get_contact_info(name, data) ) ) {
            return ret;
        }
    }

    return ORTE_SUCCESS;
}

void orte_rml_ftrm_update_contact_info(orte_gpr_notify_data_t* data, void* cbdata)
{

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: update_contact_info()");

    if( NULL != wrapped_module.update_contact_info ) {
        wrapped_module.update_contact_info(data, cbdata);
    }
}

/*
 * FT Event
 */
int orte_rml_ftrm_ft_event(int state)
{
    int ret;

    opal_output_verbose(20, rml_ftrm_output_handle,
                        "orte_rml_ftrm: ft_event()");

    if(OPAL_CRS_CHECKPOINT == state) {
        ;
    }
    else if(OPAL_CRS_CONTINUE == state) {
        ;
    }
    else if(OPAL_CRS_RESTART == state) {
        ;
    }
    else if(OPAL_CRS_TERM == state ) {
        ;
    }
    else {
        ;
    }

    /*
     * The wrapped component is responsible for calling the OOB modules
     */
    if( NULL != wrapped_module.ft_event ) {
        if( ORTE_SUCCESS != (ret = wrapped_module.ft_event(state))) {
            return ret;
        }
    }

    if(OPAL_CRS_CHECKPOINT == state) {
        ;
    }
    else if(OPAL_CRS_CONTINUE == state) {
        ;
    }
    else if(OPAL_CRS_RESTART == state) {
        ;
    }
    else if(OPAL_CRS_TERM == state ) {
        ;
    }
    else {
        ;
    }

    return ORTE_SUCCESS;
}