openmpi/orte/mca/ess/bproc/ess_bproc_module.c

/*
 * Copyright (c) 2004-2005 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/constants.h"

#include <sys/bproc.h>

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

#include "orte/mca/ess/ess.h"
#include "orte/mca/ess/base/base.h"
#include "orte/mca/errmgr/base/base.h"
#include "orte/util/show_help.h"
#include "orte/runtime/orte_globals.h"
#include "orte/util/name_fns.h"

#include "ess_bproc.h"

static int bproc_set_name(void);

static int rte_init(char flags);
static int rte_finalize(void);
static bool proc_is_local(orte_process_name_t *proc);
static char* proc_get_hostname(orte_process_name_t *proc);
static uint32_t proc_get_arch(orte_process_name_t *proc);
static uint8_t proc_get_local_rank(orte_process_name_t *proc);
static uint8_t proc_get_node_rank(orte_process_name_t *proc);
static int update_arch(orte_process_name_t *proc, uint32_t arch);

orte_ess_base_module_t orte_ess_bproc_module = {
    rte_init,
    rte_finalize,
    orte_ess_base_app_abort,
    proc_is_local,
    proc_get_hostname,
    proc_get_arch,
    proc_get_local_rank,
    proc_get_node_rank,
    update_arch,
    NULL  /* no FT support for Bproc */
};

static opal_pointer_array_t nidmap;
static orte_pmap_t *pmap = NULL;
static orte_vpid_t nprocs;

static int rte_init(char flags)
{
    int ret;
    char *error = NULL;
    
    /* run the prolog */
    if (ORTE_SUCCESS != (ret = orte_ess_base_std_prolog())) {
        error = "orte_ess_base_std_prolog";
        goto error;
    }
    
    /* Start by getting a unique name from the enviro */
    bproc_set_name();
    
    /* if I am a daemon, complete my setup using the
     * default procedure
     */
    if (orte_proc_info.daemon) {
        if (ORTE_SUCCESS != (ret = orte_ess_base_orted_setup())) {
            ORTE_ERROR_LOG(ret);
            error = "orte_ess_base_orted_setup";
            goto error;
        }
        
    } else if (orte_proc_info.tool) {
        /* otherwise, if I am a tool proc, use that procedure */
        if (ORTE_SUCCESS != (ret = orte_ess_base_tool_setup())) {
            ORTE_ERROR_LOG(ret);
            error = "orte_ess_base_tool_setup";
            goto error;
        }
        
    } else {
        /* otherwise, I must be an application process - use
         * the default procedure to finish my setup
         */
        if (ORTE_SUCCESS != (ret = orte_ess_base_app_setup())) {
            ORTE_ERROR_LOG(ret);
            error = "orte_ess_base_app_setup";
            goto error;
        }
        
        /* setup the nidmap arrays */
        OBJ_CONSTRUCT(&nidmap, opal_pointer_array_t);
        opal_pointer_array_init(&nidmap, 8, INT32_MAX, 8);
        
        /* if one was provided, build my nidmap */
        if (ORTE_SUCCESS != (ret = orte_ess_base_build_nidmap(orte_proc_info.sync_buf,
                                                              &nidmap, &pmap, &nprocs))) {
            ORTE_ERROR_LOG(ret);
            error = "orte_ess_base_build_nidmap";
            goto error;
        }
    }
    
    return ORTE_SUCCESS;
    
error:
    orte_show_help("help-orte-runtime.txt",
                   "orte_init:startup:internal-failure",
                   true, error, ORTE_ERROR_NAME(ret), ret);
    
    return ret;
}

static int rte_finalize(void)
{
    int ret;
    orte_nid_t **nids;
    int32_t i;
    
    /* if I am a daemon, finalize using the default procedure */
    if (orte_proc_info.daemon) {
        if (ORTE_SUCCESS != (ret = orte_ess_base_orted_finalize())) {
            ORTE_ERROR_LOG(ret);
        }
    } else if (orte_proc_info.tool) {
        /* otherwise, if I am a tool proc, use that procedure */
        if (ORTE_SUCCESS != (ret = orte_ess_base_tool_finalize())) {
            ORTE_ERROR_LOG(ret);
        }
    } else {
        /* otherwise, I must be an application process - deconstruct
         * my nidmap arrays
         */
        nids = (orte_nid_t**)nidmap.addr;
        for (i=0; i < nidmap.size; i++) {
            if (NULL == nids[i]) {
                break;
            }
            if (NULL != nids[i]->name) {
                free(nids[i]->name);
                nids[i]->name = NULL;
            }
        }
        OBJ_DESTRUCT(&nidmap);
        free(pmap);
        pmap = NULL;
        
        /* use the default procedure to finish */
        if (ORTE_SUCCESS != (ret = orte_ess_base_app_finalize())) {
            ORTE_ERROR_LOG(ret);
        }
    }
    
    return ret;    
}

static bool proc_is_local(orte_process_name_t *proc)
{
    if (pmap[proc->vpid].node == (int32_t)ORTE_PROC_MY_DAEMON->vpid) {
        OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                             "%s ess:bproc: proc %s is LOCAL",
                             ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                             ORTE_NAME_PRINT(proc)));
        return true;
    }
    
    OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                         "%s ess:bproc: proc %s is REMOTE",
                         ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                         ORTE_NAME_PRINT(proc)));
    
    return false;
    
}

/* the daemon's vpid does not necessairly correlate
 * to the node's index in the node array since
 * some nodes may not have a daemon on them. Thus,
 * we have to search for the daemon in the array.
 * Fortunately, this is rarely done
 */
static int32_t find_daemon_node(orte_vpid_t vpid)
{
    int32_t i;
    orte_nid_t **nids;
    
    nids = (orte_nid_t**)nidmap.addr;
    for (i=0; i < nidmap.size; i++) {
        if (NULL == nids[i]) {
            break;
        }
        if (vpid == nids[i]->daemon) {
            return i;
        }
    }
    
    return -1;
}

static char* proc_get_hostname(orte_process_name_t *proc)
{
    int32_t node;
    orte_nid_t **nids;
    
    if (ORTE_PROC_MY_DAEMON->jobid == proc->jobid) {
        /* looking for the daemon's hostname */
        node = find_daemon_node(proc->vpid);
        if (0 > node) {
            return NULL;
        }
    } else {
        node = pmap[proc->vpid].node;
    }
    nids = (orte_nid_t**)nidmap.addr;
    
    OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                         "%s ess:bproc: proc %s is on host %s",
                         ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                         ORTE_NAME_PRINT(proc),
                         nids[node]->name));
    
    return nids[node]->name;
}

static uint32_t proc_get_arch(orte_process_name_t *proc)
{
    int32_t node;
    orte_nid_t **nids;
    
    if (ORTE_PROC_MY_DAEMON->jobid == proc->jobid) {
        /* looking for the daemon's arch */
        node = find_daemon_node(proc->vpid);
        if (0 > node) {
            return 0;
        }
    } else {
        node = pmap[proc->vpid].node;
    }
    nids = (orte_nid_t**)nidmap.addr;
    
    OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                         "%s ess:bproc: proc %s has arch %0x",
                         ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                         ORTE_NAME_PRINT(proc),
                         nids[node]->arch));
    
    return nids[node]->arch;
}

static int update_arch(orte_process_name_t *proc, uint32_t arch)
{
    
    int32_t node;
    orte_nid_t **nids;
    
    node = pmap[proc->vpid].node;
    nids = (orte_nid_t**)nidmap.addr;
    
    OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                         "%s ess:bproc: updating proc %s to arch %0x",
                         ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                         ORTE_NAME_PRINT(proc),
                         arch));
    
    nids[node]->arch = arch;
    return ORTE_SUCCESS;
}

static uint8_t proc_get_local_rank(orte_process_name_t *proc)
{
    
    OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                         "%s ess:bproc: proc %s has local rank %d",
                         ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                         ORTE_NAME_PRINT(proc),
                         (int)pmap[proc->vpid].local_rank));
    
    return pmap[proc->vpid].local_rank;
}

static uint8_t proc_get_node_rank(orte_process_name_t *proc)
{
    
    OPAL_OUTPUT_VERBOSE((2, orte_ess_base_output,
                         "%s ess:bproc: proc %s has node rank %d",
                         ORTE_NAME_PRINT(ORTE_PROC_MY_NAME),
                         ORTE_NAME_PRINT(proc),
                         (int)pmap[proc->vpid].node_rank));
    
    return pmap[proc->vpid].node_rank;
}

/**
 * Sets up the process name from the information put into the environment
 * by the bproc launcher.
 * @retval ORTE_SUCCESS
 * @retval error
 */
static int bproc_set_name(void)
{
    int rc;
    int id;
    char *jobid_str, *vpid_string, *bproc_rank_string;
    orte_jobid_t jobid;
    orte_vpid_t vpid_start;
    int stride, bproc_rank;
    
    id = mca_base_param_register_string("orte", "ess", "jobid", NULL, NULL);
    mca_base_param_lookup_string(id, &jobid_str);
    if (NULL == jobid_str) {
        ORTE_ERROR_LOG(ORTE_ERR_NOT_FOUND);
        return ORTE_ERR_NOT_FOUND;
    }
    if (ORTE_SUCCESS != (rc = orte_util_convert_string_to_jobid(&jobid, jobid_str))) {
        ORTE_ERROR_LOG(rc);
        return(rc);
    }
    free(jobid_str);
    ORTE_PROC_MY_NAME->jobid = jobid;
    
    /* BPROC_RANK is set by bproc when we do a parallel launch */
    bproc_rank_string = getenv("BPROC_RANK");
    if (NULL == bproc_rank_string) {
        opal_output(0, "ess:bproc_get: Error: Environment variable "
                    "BPROC_RANK not found.\n");
        ORTE_ERROR_LOG(ORTE_ERR_NOT_FOUND);
        return ORTE_ERR_NOT_FOUND;
    }
    bproc_rank = (int)strtol(bproc_rank_string, NULL, 10);
    
    /* to compute our process name, we need to know two other things: the
     * stride (i.e., the size of the step between vpids in this launch
     * wave) and the starting vpid of this launch. Get those values here
     */
    id = mca_base_param_register_int("orte", "ess_bproc", "stride", NULL, -1);
    mca_base_param_lookup_int(id, &stride);
    if (stride < 0) {
        ORTE_ERROR_LOG(ORTE_ERR_NOT_FOUND);
        return ORTE_ERR_NOT_FOUND;
    }
    
    id = mca_base_param_register_string("orte", "ess_bproc", "vpid_start", NULL, NULL);
    mca_base_param_lookup_string(id, &vpid_string);
    if (NULL == vpid_string) {
        ORTE_ERROR_LOG(ORTE_ERR_NOT_FOUND);
        return ORTE_ERR_NOT_FOUND;
    }
    rc = orte_util_convert_string_to_vpid(&vpid_start, vpid_string);
    if (ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
        return(rc);
    }
    
    /* compute our vpid */
    ORTE_PROC_MY_NAME->vpid = vpid_start + (bproc_rank * stride);

    
    if(NULL != orte_proc_info.nodename) {
        free(orte_proc_info.nodename);
    }
    asprintf(&orte_proc_info.nodename, "%d", bproc_currnode());

    return ORTE_SUCCESS;
}