openmpi/orte/mca/plm/bproc/plm_bproc.c

/* -*- C -*-
 *
 * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2006 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) 2007      Los Alamos National Security, LLC.  All rights
 *                         reserved. 
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 *
 */
/**
 * @file:
 * Part of the bproc launcher. See plm_bproc.h for an overview of how it works.
 */

#include "orte_config.h"

#if HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif  /* HAVE_SYS_TYPES_H */
#ifdef HAVE_SYS_STAT_H
#include <sys/stat.h>
#endif  /* HAVE_SYS_STAT_H */
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif  /* HAVE_UNISTD_H */
#include <errno.h>
#include <signal.h>
#ifdef HAVE_FCNTL_H
#include <fcntl.h>
#endif  /* HAVE_FCNTL_H */
#ifdef HAVE_STRING_H
#include <string.h>
#endif  /* HAVE_STRING_H */
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif

#include "opal/mca/installdirs/installdirs.h"
#include "opal/class/opal_list.h"
#include "opal/class/opal_list.h"
#include "opal/event/event.h"
#include "opal/mca/base/mca_base_param.h"
#include "opal/util/argv.h"
#include "opal/util/output.h"
#include "opal/util/opal_environ.h"
#include "opal/util/path.h"
#include "opal/util/os_path.h"
#include "opal/util/show_help.h"
#include "opal/util/trace.h"

#include "orte/dss/dss.h"
#include "orte/mca/errmgr/errmgr.h"
#include "orte/mca/iof/iof.h"
#include "orte/mca/oob/base/base.h"
#include "orte/mca/ras/ras.h"
#include "orte/mca/rmaps/rmaps.h"
#include "orte/mca/rml/rml.h"
#include "orte/runtime/orte_wait.h"
#include "orte/runtime/runtime.h"
#include "orte/runtime/params.h"

#include "orte/mca/plm/base/plm_private.h"
#include "plm_bproc.h"

static bool daemons_launched;
static bool bynode;

static int plm_tm_init(void);
static int plm_tm_launch_job(orte_job_t *jdata);
static int plm_tm_terminate_job(orte_jobid_t jobid);
static int plm_tm_terminate_orteds(void);
static int plm_tm_signal_job(orte_jobid_t jobid, int32_t signal);
static int plm_tm_finalize(void);

static int plm_tm_connect(void);
static int plm_tm_disconnect(void);

/**
 * Initialization of the bproc module with all the needed function pointers
 */
orte_plm_base_module_t orte_plm_tm_module = {
    plm_bproc_init,
    orte_plm_base_set_hnp_name,
    plm_bproc_launch_job,
    NULL,
    plm_bproc_terminate_job,
    plm_bproc_terminate_orteds,
    plm_bproc_signal_job,
    plm_bproc_finalize
};


/**
 * Init the module
 */
static int plm_bproc_init(void)
{
    int rc;
    
    if (ORTE_SUCCESS != (rc = orte_plm_base_comm_start())) {
        ORTE_ERROR_LOG(rc);
    }
    return rc;
}


/**
 * Creates a list of nodes from a job map that should participate in the next launch cycle.
 * @param map a pointer to the job map
 * @param node_array a pointer to an integer array that will contain the node names
 * @param num_nodes a pointer to the place where we will store the number of nodes in the array
 * @param num_procs the number of processes that a node must have to be placed on the list
 */
static int bproc_node_list(orte_job_map_t *map, int *node_array, int *num_nodes, int num_procs)
{
    opal_list_item_t *item;
    orte_node_t **nodes;
    orte_std_cntr_t i;
    
    OPAL_TRACE(1);
    
    /* initialize all */
    *num_nodes = 0;
    memset((void*)node_array, -1, sizeof(int) * map->num_nodes);

    /* build the node list */
    nodes = (orte_node_t**)map->nodes->addr;
    for (i=0; i < map->num_nodes; i++) {
        if (nodes[i]->num_procs >= num_procs) {
            node_array[(*num_nodes)++] = atoi(nodes[i]->name);
        }
    }

    return ORTE_SUCCESS;
}

/**
 * Sets up the bproc io structs for the specified rank on the nodes
 *
 * @param jobid
 * @param io A pointer to an array of 3 bproc_io_t structs
 * @param node_rank the rank on the node we are setting up the structs for
 * @param app_context the application context number
 * @retval ORTE_SUCCESS
 * @retval error
 */
static int bproc_setup_io(orte_jobid_t jobid, struct bproc_io_t * io,
                          int node_rank, int app_context) {
    char *frontend = NULL, *path = NULL, *job = NULL;
    int rc, i;

    OPAL_TRACE(1);

    rc = orte_ns.convert_jobid_to_string(&job, jobid);
    if(ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }
    /* build the directory tree the io files will be in */
    if (0 > asprintf(&frontend, OPAL_PATH_SEP"tmp"OPAL_PATH_SEP"openmpi-bproc-%s"OPAL_PATH_SEP"%s"OPAL_PATH_SEP"%s-%d"OPAL_PATH_SEP"%d",
                     orte_system_info.user, orte_universe_info.name, job,
                     app_context, node_rank)) {
        rc = ORTE_ERR_OUT_OF_RESOURCE;
        ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
        goto cleanup;
    }

    for(i = 0; i < 3; i++)  {
        if(0 > asprintf(&path, "%s"OPAL_PATH_SEP"%d", frontend, i)) {
            rc = ORTE_ERR_OUT_OF_RESOURCE;
            ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
            goto cleanup;
        }
        if (mca_plm_bproc_component.debug) {
            opal_output(0, "mpirun bproc io setup. Path: %s\n", path);
        }
        io[i].fd = i;
        io[i].type = BPROC_IO_FILE;
#if defined BPROC_API_VERSION && BPROC_API_VERSION >= 4
        io[i].flags = 0;
#else
        io[i].send_info = 0;
#endif
        if(0 == i) {
            io[i].d.file.flags = O_RDONLY;
        } else {
            io[i].d.file.flags = O_WRONLY;
        }
        io[i].d.file.offset = 0;
        io[i].d.file.mode = 0;
        strncpy(io[i].d.file.name, path, 256);
        free(path);
    }

 cleanup:
    if (NULL != frontend) {
       free(frontend);
    }
    if (NULL != job) {
        free(job);
    }
    return rc;
}

/**
 * Callback for orte_wait_cb. This function ONLY gets called for
 * normal termination, or termination caused by a signal. If the
 * process abnormally terminates by other than a signal, we go through
 * another function so it can tell us that it was abnormal.
 * Bproc doesn't really let us do it through here.
 * @param wpid the process's pid
 * @param status tells why the process died
 * @param data a pointer to the process's name
 */
static void orte_plm_bproc_waitpid_cb(pid_t wpid, int status, void *data) {
    orte_process_name_t * proc = (orte_process_name_t*) data;
    int rc;
    
    OPAL_TRACE(1);
    
    /* set the state of this process */
    if(WIFEXITED(status)) {
            rc = orte_smr.set_proc_state(proc, ORTE_PROC_STATE_TERMINATED, status);
    } else {
        rc = orte_smr.set_proc_state(proc, ORTE_PROC_STATE_ABORTED, status);
    }
    if(ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
    }
    free(proc);
}

/**
 * Callback for orte_wait_cb for the daemons. If a daemon unexpectedly dies
 * before we are done launching, we abort the job.
 * @param wpid the daemons's pid
 * @param status tells why the daemon died
 * @param data a pointer to the node the daemon was on
 */
static void orte_plm_bproc_waitpid_daemon_cb(pid_t wpid, int status, void *data) {

    OPAL_TRACE(1);
     
    if(!daemons_launched) {
        /* if a daemon exits before we are done launching the user apps we send a
         * message to ourself so we will break out of the receive loop and exit */
        orte_buffer_t ack;
        int rc;
        int src[4] = {-1, -1};
        src[2] = wpid;
        src[3] = *(int*)data;
        if(WIFSIGNALED(status)) {
            src[1] = WTERMSIG(status);
        }
        OBJ_CONSTRUCT(&ack, orte_buffer_t);
        rc = orte_dss.pack(&ack, &src, 4, ORTE_INT);
        if(ORTE_SUCCESS != rc) {
            ORTE_ERROR_LOG(rc);
        }
        rc = mca_oob_send_packed(ORTE_PROC_MY_NAME, &ack, ORTE_RML_TAG_BPROC, 0);
        if(0 > rc) {
            ORTE_ERROR_LOG(rc);
        }
    }
    OPAL_THREAD_LOCK(&mca_plm_bproc_component.lock);
    if(0 < mca_plm_bproc_component.num_daemons) {
        mca_plm_bproc_component.num_daemons--;
    }
    opal_condition_signal(&mca_plm_bproc_component.condition);
    OPAL_THREAD_UNLOCK(&mca_plm_bproc_component.lock);
    if(0 < mca_plm_bproc_component.debug) {
        opal_output(0, "in orte_plm_bproc_waitpid_daemon_cb, %d daemons left\n",
                    mca_plm_bproc_component.num_daemons);
    }
}

#ifdef MCA_plm_bproc_scyld
/**
 * compatibility function for scyld bproc and pre 3.2.0 LANL bproc. See the
 * bproc documentation for details
 */
static int bproc_vexecmove_io(int nnodes, int *nodes, int *pids,
                              struct bproc_io_t *io, int iolen, const char *cmd,
                              char * const argv[], char * envp[]) {
    int i;
    char * rank;

    OPAL_TRACE(1);
    
    for(i = 0; i < nnodes; i++) {
        pids[i] = fork();
        if(0 == pids[i]) {
            /* set BPROC_RANK so the proc can get its name */
            if (0 > asprintf(&rank, "%d", i)) {
                ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
                exit(-1);
            }
            opal_setenv("BPROC_RANK", rank, true, &envp);
            bproc_execmove_io(nodes[i], io, iolen, cmd, argv, envp);
            /* if we get here, there was an error */
            opal_show_help("help-plm-bproc.txt", "bproc-vexecmove-launch", true,
                           cmd, nodes[i], errno);
            ORTE_ERROR_LOG(ORTE_ERROR);
            exit(-1);
        } else if(-1 == pids[i]) {
            opal_show_help("help-plm-bproc.txt", "bproc-vexecmove-fork", true,
                           errno);
            ORTE_ERROR_LOG(ORTE_ERROR);
            return -1;
        }
    }
    return nnodes;
}

/**
 * compatibility function for scyld bproc and pre 3.2.0 LANL bproc. See the
 * bproc documentation for details
 */
static int bproc_vexecmove(int nnodes, int *nodes, int *pids, const char *cmd,
                           char * const argv[], char * envp[]) {
    return bproc_vexecmove_io(nnodes, nodes, pids, NULL, 0, cmd, argv, envp);
}
#endif

/**
 * Sets up the passed environment for processes launched by the bproc launcher.
 * @param env a pointer to the environment to setup
 */
static void orte_plm_bproc_setup_env(char *** env)
{
    char ** merged;
    char * var;
    char * param;
    int rc;
    int num_env;

    OPAL_TRACE(1);
    
    num_env = opal_argv_count(*env);
    /* append mca parameters to our environment */
    if(ORTE_SUCCESS != (rc = mca_base_param_build_env(env, &num_env, false))) {
        ORTE_ERROR_LOG(rc);
    }

    /* ns replica contact info */
    if(NULL == orte_process_info.ns_replica) {
        orte_dss.copy((void**)&orte_process_info.ns_replica, orte_process_info.my_name, ORTE_NAME);
        orte_process_info.ns_replica_uri = orte_rml.get_uri();
    }
    var = mca_base_param_environ_variable("ns","replica","uri");
    opal_setenv(var,orte_process_info.ns_replica_uri, true, env);
    free(var);

    /* make sure the username used to create the bproc directory is the same on
     * the backend as the frontend */
    var = mca_base_param_environ_variable("plm","bproc","username");
    opal_setenv(var, orte_system_info.user, true, env);
    free(var);

    /* gpr replica contact info */
    if(NULL == orte_process_info.gpr_replica) {
        orte_dss.copy((void**)&orte_process_info.gpr_replica, orte_process_info.my_name, ORTE_NAME);
        orte_process_info.gpr_replica_uri = orte_rml.get_uri();
    }
    var = mca_base_param_environ_variable("gpr","replica","uri");
    opal_setenv(var,orte_process_info.gpr_replica_uri, true, env);
    free(var);

    /* universe directory - needs to match orted */
    var = mca_base_param_environ_variable("universe", NULL, NULL);
    asprintf(&param, "%s@%s:%s", orte_universe_info.uid,
                orte_universe_info.host, orte_universe_info.name);
    opal_setenv(var, param, true, env);
    free(param);
    free(var);

    /* merge in environment - merge ensures we don't overwrite anything we just set */
    merged = opal_environ_merge(*env, environ);
    opal_argv_free(*env);
    *env = merged;
    
    /* make sure hostname doesn't get pushed to backend node */
    opal_unsetenv("HOSTNAME", env);
    
    /* make sure the frontend hostname does not get pushed out to the backend */
    var = mca_base_param_environ_variable("orte", "base", "nodename");
    opal_unsetenv(var, env);
    free(var);
    
}

/**
 * Launches the daemons
 * @param cellid         the cellid of the job
 * @param envp           a pointer to the environment to use for the daemons
 * @param node_arrays    an array that holds the node arrays for each app context
 * @param node_array_lens an array of lengths of the node arrays
 * @param num_contexts   the number of application contexts
 * @param num_procs      the numer of processes in the job
 * @param global_vpid_start the starting vpid for the user's processes
 * @param jobid          the jobid for the user processes
 * @retval ORTE_SUCCESS
 * @retval error
 */
static int orte_plm_bproc_launch_daemons(orte_job_map_t *map, char ***envp) {
    int * daemon_list = NULL;
    int num_daemons = 0;
    int rc, i;
    int * pids = NULL;
    int argc;
    char ** argv = NULL;
    char * param;
    char * var;
    int stride;
    char * orted_path;
    orte_vpid_t daemon_vpid_start;
    orte_std_cntr_t idx;
    struct stat buf;
    opal_list_t daemons;
    orte_plm_daemon_info_t *dmn;
    opal_list_item_t *item;
    struct timeval joblaunchstart, launchstart, launchstop;

    OPAL_TRACE(1);
    
    if (orte_plm_base.timing) {
        if (0 != gettimeofday(&joblaunchstart, NULL)) {
            opal_output(0, "plm_bproc: could not obtain start time");
        }
    }
    
    /* indicate that the daemons have not completely launched yet */
    daemons_launched = false;
    
    /* setup a list that will contain the info for all the daemons
     * so we can store it on the registry when done
     */
    OBJ_CONSTRUCT(&daemons, opal_list_t);

    /* get the number of nodes in this job and allocate an array for
     * their names so we can pass that to bproc - populate the list
     * with the node names
     */
    num_daemons = map->num_nodes;
    if (0 == num_daemons) {
        /* nothing to do */
        OBJ_DESTRUCT(&daemons);
        return ORTE_SUCCESS;
    }
    
    if(NULL == (daemon_list = (int*)malloc(sizeof(int) * num_daemons))) {
        ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
        goto cleanup;
    }
    i = 0;
    for (item = opal_list_get_first(&map->nodes);
         item != opal_list_get_end(&map->nodes);
         item = opal_list_get_next(item)) {
        orte_mapped_node_t *node = (orte_mapped_node_t*)item;

        daemon_list[i++] = atoi(node->nodename);
    }

    /* allocate storage for bproc to return the daemon pids */
    if(NULL == (pids = (int*)malloc(sizeof(int) * num_daemons))) {
        ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
        goto cleanup;
    }

    /* allocate a range of vpids for the daemons */
    rc = orte_ns.reserve_range(0, num_daemons, &daemon_vpid_start);
    if(ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }

    /* setup the orted triggers for passing their launch info */
    if (ORTE_SUCCESS != (rc = orte_smr.init_orted_stage_gates(map->job, num_daemons, NULL, NULL))) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }
    
    /* setup the daemon environment */
    orte_plm_bproc_setup_env(envp);

    /* direct the daemons to drop contact files so the local procs
     * can learn how to contact them - this is used for routing
     * OOB messaging
     */
    var = mca_base_param_environ_variable("odls","base","drop_contact_file");
    opal_setenv(var,"1", true, envp);
    free(var);

    /* daemons calculate their process name using a "stride" of one, so
     * push that value into their environment */
    stride = 1;
    asprintf(&param, "%ld", (long)stride);
    var = mca_base_param_environ_variable("plm", "bproc", "stride");
    opal_setenv(var, param, true, envp);
    free(param);
    free(var);

    /* set up the base environment so the daemons can get their names once launched */
    rc = orte_ns_nds_bproc_put(ORTE_PROC_MY_NAME->cellid, 0, daemon_vpid_start,
                               0, num_daemons, envp);
    if(ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }

    argc = 0;
    opal_argv_append(&argc, &argv, mca_plm_bproc_component.orted);
    /* check for debug flags */
#if 0
    if (mca_plm_bproc_component.debug) {
         opal_argv_append(&argc, &argv, "--debug");
         opal_argv_append(&argc, &argv, "--debug-daemons");
    }
#endif 

    opal_argv_append(&argc, &argv, "--bootproxy");
    orte_ns.convert_jobid_to_string(&param, map->job);
    opal_argv_append(&argc, &argv, param);
    free(param);

    /* pass along the universe name and location info */
    opal_argv_append(&argc, &argv, "--universe");
    asprintf(&param, "%s@%s:%s", orte_universe_info.uid,
                orte_universe_info.host, orte_universe_info.name);
    opal_argv_append(&argc, &argv, param);
    free(param);

    /* tell orted not to demonize itself */
    opal_argv_append(&argc, &argv, "--no-daemonize");

    /* find orted */
    if(0 == stat(mca_plm_bproc_component.orted, &buf)) {
        orted_path = strdup(mca_plm_bproc_component.orted);
    } else {
        orted_path = opal_path_findv(mca_plm_bproc_component.orted, 0, environ, NULL);
        if(NULL == orted_path) {
            orted_path = opal_os_path( false, opal_install_dirs.bindir, mca_plm_bproc_component.orted, NULL );
            if( (NULL != orted_path) || (0 != stat(orted_path, &buf)) ) {
                char *path = getenv("PATH");
                if (NULL == path) {
                    path = ("PATH is empty!");
                }
                opal_show_help("help-plm-bproc.txt", "no-orted", true,
                               mca_plm_bproc_component.orted,
                               mca_plm_bproc_component.orted, path, opal_install_dirs.bindir);
                rc = ORTE_ERROR;
                ORTE_ERROR_LOG(rc);
                goto cleanup;
            }
        }
    }

    if(0 < mca_plm_bproc_component.debug) {
        opal_output(0, "PLS_BPROC DEBUG: launching %d daemons. cmd: %s ",
                    num_daemons, orted_path);
    }

    /* launch the daemons */
    if (orte_plm_base.timing) {
        if (0 != gettimeofday(&launchstart, NULL)) {
            opal_output(0, "plm_bproc: could not obtain start time");
        }
    }

    if (mca_plm_bproc_component.do_not_launch) {
        for (i=0; i < num_daemons; i++) pids[i] = i+1;
        rc = num_daemons;
    } else {
        rc = bproc_vexecmove(num_daemons, daemon_list, pids, orted_path, argv, *envp);
    }
    
    if (orte_plm_base.timing) {
        if (0 != gettimeofday(&launchstop, NULL)) {
             opal_output(0, "plm_bproc: could not obtain stop time");
         } else {
             opal_output(0, "plm_bproc: daemon launch time is %ld usec",
                         (launchstop.tv_sec - launchstart.tv_sec)*1000000 + 
                         (launchstop.tv_usec - launchstart.tv_usec));
         }
    }
    
    if(rc != num_daemons) {
        opal_show_help("help-plm-bproc.txt", "daemon-launch-number", true,
                       num_daemons, rc, orted_path);
        rc = ORTE_ERROR;
        goto cleanup;
    }
    
    if(0 < mca_plm_bproc_component.debug) {
        opal_output(0, "PLS_BPROC DEBUG: %d daemons launched. First pid: %d\n",
                    rc, *pids);
    }

    for(i = 0; i < num_daemons; i++) {
        if(0 >= pids[i]) {
            opal_show_help("help-plm-bproc.txt", "daemon-launch-bad-pid", true,
                           daemon_list[i], pids[i], errno, orted_path);
            rc = ORTE_ERROR;
            ORTE_ERROR_LOG(rc);
            goto cleanup;
        } else {
            if (0 > asprintf(&param, "%d", daemon_list[i])) {
                rc = ORTE_ERR_OUT_OF_RESOURCE;
                ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
                goto cleanup;
            }
            rc = orte_plm_bproc_set_node_pid(ORTE_PROC_MY_NAME->cellid, param, map->job, pids[i]);
            if(ORTE_SUCCESS != rc) {
                ORTE_ERROR_LOG(rc);
                goto cleanup;
            }

            dmn = OBJ_NEW(orte_plm_daemon_info_t);
            rc = orte_ns.create_process_name(&(dmn->name), ORTE_PROC_MY_NAME->cellid, 0,
                                             daemon_vpid_start + i);
            if(ORTE_SUCCESS != rc) {
                ORTE_ERROR_LOG(rc);
                goto cleanup;
            }
            dmn->cell = dmn->name->cellid;
            dmn->nodename = strdup(param);
            dmn->active_job = map->job;
            opal_list_append(&daemons, &dmn->super);
            
            free(param);
        }
    }
    
    /* store the daemon info */
    if (ORTE_SUCCESS != (rc = orte_plm_base_store_active_daemons(&daemons))) {
        ORTE_ERROR_LOG(rc);
    }

    /* setup the callbacks - this needs to be done *after* we store the
     * daemon info so that short-lived apps don't cause mpirun to
     * try and terminate the orteds before we record them
     */
    if (!mca_plm_bproc_component.do_not_launch) {
        for (i=0; i < num_daemons; i++) {
            rc = orte_wait_cb(pids[i], orte_plm_bproc_waitpid_daemon_cb,
                              &daemon_list[i]);
            if(ORTE_SUCCESS != rc) {
                ORTE_ERROR_LOG(rc);
                goto cleanup;
            }
        }
    
        /* wait for communication back from the daemons, which indicates they have
         * sucessfully set up the pty/pipes and IO forwarding which the user apps
         * will use  */
        for(i = 0; i < num_daemons; i++) {
            orte_buffer_t ack;
            int src[4];
            OBJ_CONSTRUCT(&ack, orte_buffer_t);
            rc = mca_oob_recv_packed(ORTE_NAME_WILDCARD, &ack, ORTE_RML_TAG_BPROC);
            if(0 > rc) {
                ORTE_ERROR_LOG(rc);
                OBJ_DESTRUCT(&ack);
                goto cleanup;
            }
            idx = 4;
            rc = orte_dss.unpack(&ack, &src, &idx, ORTE_INT);
            if(ORTE_SUCCESS != rc) {
                ORTE_ERROR_LOG(rc);
            }
            OBJ_DESTRUCT(&ack);
            
            if(-1 == src[0]) {
                /* one of the daemons has failed to properly launch. The error is sent
                * by orte_plm_bproc_waitpid_daemon_cb  */
                if(-1 == src[1]) { /* did not die on a signal */
                    opal_show_help("help-plm-bproc.txt", "daemon-died-no-signal", true,
                                   src[2], src[3]);
                } else { /* died on a signal */
                    opal_show_help("help-plm-bproc.txt", "daemon-died-signal", true,
                                   src[2], src[3], src[1]);
                }
                rc = ORTE_ERROR;
                ORTE_ERROR_LOG(rc);
                orte_plm_bproc_terminate_job(map->job, &orte_abort_timeout, NULL);
                goto cleanup;
            }
        }
    }

    /* indicate that the daemons have now launched */
    daemons_launched = true;

    if (orte_plm_base.timing) {
        if (0 != gettimeofday(&launchstop, NULL)) {
            opal_output(0, "plm_bproc: could not obtain stop time");
        } else {
            opal_output(0, "plm_bproc: total job launch time is %ld usec",
                        (launchstop.tv_sec - joblaunchstart.tv_sec)*1000000 + 
                        (launchstop.tv_usec - joblaunchstart.tv_usec));
        }
    }
        
cleanup:
    if(NULL != argv) {
        opal_argv_free(argv);
    }
    if(NULL != pids) {
        free(pids);
    }
    if(NULL != orted_path) {
        free(orted_path);
    }
    while (NULL != (item = opal_list_remove_first(&daemons))) {
        OBJ_RELEASE(item);
    }
    OBJ_DESTRUCT(&daemons);

    return rc;
}


static int
orte_plm_bproc_node_failed(orte_gpr_notify_message_t *msg) 
{
    orte_jobid_t job;
    
    /* respond to a node failure reported by the smr. We know that
     * this function will only be called when one or more nodes in
     * our allocation fails, so we just need to respond to it. The
     * complication is that the failure could occur in any of several
     * states:
     * (a) before we start to launch the daemons
     * (b) while we are launching the daemons
     * (c) after the daemons are launched, while we are launching the app
     * (d) during app launch
     * (e) after app launch, but before completion
     * (f) while the app is finalizing
     * (g) while we are cleaning up after the app has finalized
     */
    
    printf("mpirun has detected a dead node within the job and is terminating\n");
    
    /* extract the jobid from the returned data */
    orte_schema.extract_jobid_from_std_trigger_name(&job, msg->target);
    
    /* terminate all jobs in the in the job family */
    orte_plm_bproc_terminate_job(job, &orte_abort_timeout, NULL);
    
    /* kill the daemons */
    orte_plm_bproc_terminate_job(0, &orte_abort_timeout, NULL);
    
    /* shouldn't ever get here.. */
    exit(1);
    
}


/**
 * Launches the application processes
 * @param cellid         the cellid of the job
 * @param jobid          the jobid of the job
 * @param map            a pointer to the mapping of this application
 * @param num_processes  the number of processes in this job
 * @param vpid_start     the starting vpid for this app context
 * @param global_vpid_start the starting vpid for the user's processes
 * @param app_context    the application context number
 * @param node_array     the node array for this context
 * @param node_array_len the length of the node array
 * @retval ORTE_SUCCESS
 * @retval error
 */
static int orte_plm_bproc_launch_app(orte_job_map_t* map, int num_slots,
                                     orte_vpid_t vpid_start, int app_context) {
    int *node_array, num_nodes, cycle;
    int rc, i, j, stride;
    orte_std_cntr_t num_processes;
    int *pids = NULL;
    char *var, *param;
    orte_process_name_t * proc_name;
    struct bproc_io_t bproc_io[3];
    char **env;
    int dbg;

    OPAL_TRACE(1);
    
    /* point to the env array for this app_context */
    env = opal_argv_copy(map->apps[app_context]->env);

    /* set up app context */
    asprintf(&param, "%d", app_context);
    var = mca_base_param_environ_variable("plm", "bproc", "app_context");
    opal_setenv(var, param, true, &env);
    free(param);
    free(var);
    
    /* set the app_context number into the environment for the attributes */
    var = mca_base_param_environ_variable("orte","app","num");
    asprintf(&param, "%ld", (long)app_context);
    opal_setenv(var, param, true, &env);
    free(param);
    free(var);
 
    /* set the vpid-to-vpid stride based on the mapping mode */
    if (bynode) {
        /* we are mapping by node, so we want to set the stride
         * length (i.e., the step size between vpids that is used
         * to compute the process name) to 1
         */
        stride = 1;
    } else {
        /* we are mapping by slot, so we want to set the stride
        * length (i.e., the step size between vpids that is used
        * to compute the process name) to the number of slots
        */
        stride = num_slots;
    }
    /* and push that value into the process' environment */
    asprintf(&param, "%ld", (long)stride);
    var = mca_base_param_environ_variable("plm", "bproc", "stride");
    opal_setenv(var, param, true, &env);
    free(param);
    free(var);
    
    /* set up the node_array to handle the launch */
    node_array = (int*)malloc(map->num_nodes * sizeof(int));
    if (NULL == node_array) {
        ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
        return ORTE_ERR_OUT_OF_RESOURCE;
    }
    
    /* initialize the cycle count. Computing the process name under Bproc
     * is a complex matter when mapping by slot as Bproc's inherent
     * methodology is to do everything by node. When mapping by slot, the
     * first num_slots number of launch cycles all have a vpid_start that
     * will differ by one - i.e., the processes on a given node will have
     * vpids that differ by only one.
     *
     * However, when we oversubscribe, we enter into a cyclic arrangement.
     * During each cycle, the above description of how names are assigned
     * is accurate. However, each cycle (i.e., each collection of num_nodes
     * processes that we launch) will have a vpid start that is offset by
     * num_slots * num_nodes. We have to compensate for that here when we
     * calculate and pass the vpid_start param so that the processes can
     * correctly compute their name
     */
    cycle = 1;
    
    /* launch the processes */
    i = 1;
    num_processes = map->vpid_range;
    
    rc = orte_plm_bproc_node_list(map, node_array, &num_nodes, i);
    if(ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }
    opal_output_verbose(1, orte_plm_base.plm_output,
                        "launching app %s", map->apps[app_context]->app);

    while(0 != num_nodes) {
        if (0 < mca_plm_bproc_component.debug) {
            opal_output_verbose(1, orte_plm_base.plm_output,
                                "\tlaunching cycle %d", i);
            for (dbg=0; dbg<num_nodes; dbg++) {
                opal_output_verbose(1, orte_plm_base.plm_output,
                                    "\t\tlaunching on node %d", node_array[dbg]);
            }
        }

        /* setup environment so the procs can figure out their names */
        rc = orte_ns_nds_bproc_put(ORTE_PROC_MY_NAME->cellid, map->job, vpid_start, map->vpid_start,
                                   num_processes, &env);
        if(ORTE_SUCCESS != rc) {
            ORTE_ERROR_LOG(rc);
            goto cleanup;
        }

        rc = orte_plm_bproc_setup_io(map->job, bproc_io, i - 1, app_context);
        if(ORTE_SUCCESS != rc) {
            ORTE_ERROR_LOG(rc);
            goto cleanup;
        }
        if(0 < mca_plm_bproc_component.debug) {
            opal_output(0, "plm_bproc: launching %d processes:", num_nodes);
        }

        /* allocate space for bproc to return the pids */
        pids = (int*)malloc(num_nodes * sizeof(int));
        if (NULL == pids) {
            ORTE_ERROR_LOG(ORTE_ERR_OUT_OF_RESOURCE);
            rc = ORTE_ERR_OUT_OF_RESOURCE;
            goto cleanup;
        }
        
        if (mca_plm_bproc_component.do_not_launch) {
            for (j=0; j < num_nodes; j++) pids[j] = j+1;
            rc = num_nodes;
        } else {
            rc = bproc_vexecmove_io(num_nodes, node_array, pids, bproc_io, 3,
                                    map->apps[app_context]->app,
                                    map->apps[app_context]->argv, env);
        }
        
        if(0 < mca_plm_bproc_component.debug) {
            opal_output(0, "plm_bproc: %d processes launched. First pid: %d",
                        rc, *pids);
        }
        if(rc != num_nodes) {
            opal_show_help("help-plm-bproc.txt", "proc-launch-number", true,
                           num_nodes, rc, map->apps[app_context]->app);
            rc = ORTE_ERROR;
            goto cleanup;
        }
        
        for(j = 0; j < num_nodes; j++) {
            if(0 >= pids[j]) {
                opal_show_help("help-plm-bproc.txt", "proc-launch-bad-pid", true,
                               node_array[j], pids[j], errno, map->apps[app_context]->app);
                rc = ORTE_ERROR;
                ORTE_ERROR_LOG(rc);
                goto cleanup;
            } else {
                rc = orte_ns.create_process_name(&proc_name, ORTE_PROC_MY_NAME->cellid, map->job,
                                                 vpid_start + j*stride);
                if(ORTE_SUCCESS != rc) {
                    ORTE_ERROR_LOG(rc);
                    goto cleanup;
                }
                orte_plm_bproc_set_proc_pid(proc_name, pids[j], node_array[j]);
                if(ORTE_SUCCESS != rc) {
                    ORTE_ERROR_LOG(rc);
                    goto cleanup;
                }
                if (!mca_plm_bproc_component.do_not_launch) {
                    rc = orte_wait_cb(pids[j], orte_plm_bproc_waitpid_cb, proc_name);
                    if(ORTE_SUCCESS != rc) {
                        ORTE_ERROR_LOG(rc);
                        goto cleanup;
                    }
                }
            }
        }
        free(pids);
        pids = NULL;
        i++;
        if (bynode) {
            /* we are mapping by node, so the vpid_start must increment by
             * the number of nodes
             */
            vpid_start += num_nodes;
        } else {
            /* we are mapping by slot. Here is where we need to check our
             * cyclic condition - if we are at the end of a cycle, then
             * we need to increment the vpid_start by num_slots*num_nodes.
             * Otherwise, we just increment it by one.
             */
            if (cycle == num_slots) {
                 /* end of cycle condition */
                vpid_start += num_slots * num_nodes - 1;
                cycle = 1;
            } else {
                vpid_start += 1;
                cycle++;
            }
        }
        
        rc = orte_plm_bproc_node_list(map, node_array, &num_nodes, i);
        if(ORTE_SUCCESS != rc) {
            ORTE_ERROR_LOG(rc);
            goto cleanup;
        }
    }

cleanup:
    if(NULL != pids) {
        free(pids);
    }
    
    free(node_array);
    
    if (NULL != env) opal_argv_free(env);
    return rc;
}

/**
 * The main bproc launcher. See plm_bproc.h for a high level overview of how
 * the bproc launching works.
 * Here we:
 * -# Launch the deamons on the backend nodes.
 * -# The daemons setup files for io forwarding then connect back to us to
 *     tells us they are ready for the actual apps.
 * -# Launch the apps on the backend nodes
 *
 * @param jobid the jobid of the job to launch
 * @retval ORTE_SUCCESS
 * @retval error
 */
int orte_plm_bproc_launch(orte_jobid_t jobid) {
    orte_job_map_t* map;
    orte_mapped_node_t *map_node;
    orte_vpid_t vpid_launch;
    int rc;
    int num_slots;
    int context;
    int i;
    char cwd_save[OMPI_PATH_MAX + 1];
    orte_ras_node_t *ras_node;
    char **daemon_env;
    opal_list_t nodelist;

    OPAL_TRACE(1);
    
    /* make sure the plm_bproc receive function has been started */
    if (ORTE_SUCCESS != (rc = orte_plm_bproc_comm_start())) {
        ORTE_ERROR_LOG(rc);
        return rc;
    }
    
    /* save the current working directory */
    if (NULL == getcwd(cwd_save, sizeof(cwd_save))) {
        ORTE_ERROR_LOG(ORTE_ERR_NOT_FOUND);
        return ORTE_ERR_NOT_FOUND;
    }
    cwd_save[sizeof(cwd_save) - 1] = '\0';
    
    /* get the job map */
    if(ORTE_SUCCESS != (rc = orte_rmaps.get_job_map(&map, jobid))) {
        ORTE_ERROR_LOG(rc);
        return rc;
    }

    /* set the mapping mode */
    if (NULL != map->mapping_mode && 0 == strcmp("bynode", map->mapping_mode)) {
        bynode = true;
    } else {
        bynode = false;
    }
    
    /* check all of the app_contexts for sanity */
    for (i=0; i < map->num_apps; i++) {
        /* Check that the cwd is sane.  We have to chdir there in
           to check the executable, because the executable could
           have been specified as a relative path to the wdir */
        rc = orte_rmgr.check_context_cwd(map->apps[i], true);
        if (ORTE_SUCCESS != rc) {
            goto cleanup;
        }

        /* Check that the app exists and is executable */
        rc = orte_rmgr.check_context_app(map->apps[i]);
        if (ORTE_SUCCESS != rc) {
            goto cleanup;
        }

        /* Return to the original dir */
        if (0 != chdir(cwd_save)) {
            rc = ORTE_ERR_IN_ERRNO;
            goto cleanup;
        }
    }

    /* For Bproc, we need to know how many slots were allocated on each
     * node so the spawned processes can computer their name. Only Bproc
     * needs to do this, so we choose not to modify the mapped_node struct
     * to hold this info - bproc can go get it.
     *
     * Since Bproc also requires that the slots allocated on each node
     * be the same, we really only need to lookup a single node. So grab
     * the data for the first node on the map
     *
     * RHC: Unfortunately, the user may have passed these nodes to us
     * via a hostfile or -host argument. In that case, we cannot trust
     * that the slots allocated on each node are the same - and we get
     * erratic behavior if they don't. Until we can verify that Bproc
     * now supports clusters with differing numbers of slots on each node,
     * we have to protect the system by erroring out. So - even though this
     * will slow down the launch on large clusters - we have to get the
     * allocation and check to ensure that all the slots match
     */
    OBJ_CONSTRUCT(&nodelist, opal_list_t);
    if (ORTE_SUCCESS != (rc = orte_ras.node_query(&nodelist))) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }
    if (NULL == (ras_node = (orte_ras_node_t*)opal_list_remove_first(&nodelist))) {
        ORTE_ERROR_LOG(ORTE_ERR_NOT_FOUND);
        rc = ORTE_ERR_NOT_FOUND;
        goto cleanup;
    }
    num_slots = ras_node->node_slots;
    OBJ_RELEASE(ras_node);
    while (NULL != (ras_node = (orte_ras_node_t*)opal_list_remove_first(&nodelist))) {
        if (num_slots != ras_node->node_slots) {
            /* mismatch - error out */
            opal_show_help("help-plm-bproc.txt", "mismatched-slots", true);
            ORTE_ERROR_LOG(ORTE_ERR_NOT_SUPPORTED);
            rc = ORTE_ERR_NOT_SUPPORTED;
            goto cleanup;
        }
        OBJ_RELEASE(ras_node);
    }
    OBJ_DESTRUCT(&nodelist);
    
    
    if(0 < mca_plm_bproc_component.debug) {
        opal_output(0, "plm_bproc: --- starting to launch procs ---");
    }

    /* save the daemon environment */
    daemon_env = opal_argv_copy(map->apps[0]->env);

    /* for each application context, setup its env */
    for(i=0; i < map->num_apps; i++) {
        orte_plm_bproc_setup_env(&map->apps[i]->env);
    }
    
    /* tell the smr which nodes to monitor so we can be notified 
       when the node's state changes, useful for aborting when 
        a bproc node up and dies */
    if (ORTE_SUCCESS != (rc = orte_smr.begin_monitoring(map, orte_plm_bproc_node_failed, NULL))) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }
    
    /* launch the daemons on all nodes which have processes assigned to them */
    rc = orte_plm_bproc_launch_daemons(map, &daemon_env);
    opal_argv_free(daemon_env);

    if(ORTE_SUCCESS != rc) {
        ORTE_ERROR_LOG(rc);
        goto cleanup;
    }
    
    vpid_launch = map->vpid_start;

    /* for each application context launch the app */
    for(context=0; context < map->num_apps; context++) {
        rc = orte_rmgr.check_context_cwd(map->apps[context], true);
        if (ORTE_SUCCESS != rc) {
            goto cleanup;
        }

        rc = orte_plm_bproc_launch_app(map, num_slots, vpid_launch, context);
        if(ORTE_SUCCESS != rc) {
            ORTE_ERROR_LOG(rc);
            goto cleanup;
        }
        vpid_launch += map->apps[context]->num_procs;
    }

cleanup:
    chdir(cwd_save);

    OBJ_RELEASE(map);

    if (mca_plm_bproc_component.do_not_launch) {
        /* indicate that we failed to launch, but do so silently */
        return ORTE_ERR_SILENT;
    }
    
    return rc;
}

/**
 * Terminate all processes associated with this job */
int orte_plm_bproc_terminate_job(orte_jobid_t jobid, struct timeval *timeout, opal_list_t *attrs) {
    pid_t* pids;
    orte_std_cntr_t i, num_pids;
    int rc;
    
    OPAL_TRACE(1);
    
    if(0 < mca_plm_bproc_component.debug) {
        opal_output(0, "orte_plm_bproc: terminating job %ld", jobid);
    }
    
    /* kill application process */
    if(ORTE_SUCCESS != (rc = orte_plm_bproc_get_proc_pids(jobid, &pids, &num_pids, attrs)))
        return rc;
    for(i=0; i<num_pids; i++) {
        if(mca_plm_bproc_component.debug) {
            opal_output(0, "orte_plm_bproc: killing proc: %d\n", pids[i]);
        }
        kill(pids[i], mca_plm_bproc_component.terminate_sig);
    }
    if(NULL != pids)
        free(pids);

    /* dont kill daemons - mpirun will do this for us */
    return ORTE_SUCCESS;
}

/**
* Terminate the orteds for a given job
 */
int orte_plm_bproc_terminate_orteds(orte_jobid_t jobid, struct timeval *timeout, opal_list_t *attrs)
{
    int rc;
    opal_list_t daemons;
    opal_list_item_t *item;

    OPAL_TRACE(1);
    
    /* construct the list of active daemons on this job */
    OBJ_CONSTRUCT(&daemons, opal_list_t);
    if (ORTE_SUCCESS != (rc = orte_plm_base_get_active_daemons(&daemons, jobid, attrs))) {
        ORTE_ERROR_LOG(rc);
        goto CLEANUP;
    }

    /* now tell them to die! */
    if (ORTE_SUCCESS != (rc = orte_plm_base_orted_exit(&daemons, timeout))) {
        ORTE_ERROR_LOG(rc);
    }

CLEANUP:
    while (NULL != (item = opal_list_remove_first(&daemons))) {
        OBJ_RELEASE(item);
    }
    OBJ_DESTRUCT(&daemons);
    return rc;
}

/**
 * Terminate a specific process.
 */
int orte_plm_bproc_terminate_proc(const orte_process_name_t* proc_name) {
    int rc;
    pid_t pid;

    OPAL_TRACE(1);
    
    if(ORTE_SUCCESS != (rc = orte_plm_bproc_get_proc_pid(proc_name, &pid)))
        return rc;
    if(kill(pid, mca_plm_bproc_component.terminate_sig) != 0) {
        switch(errno) {
            case EINVAL:
                return ORTE_ERR_BAD_PARAM;
            case ESRCH:
                return ORTE_ERR_NOT_FOUND;
            case EPERM:
                return ORTE_ERR_PERM;
            default:
                return ORTE_ERROR;
        }
    }
    return ORTE_SUCCESS;
}

/**
 * Signal all processes associated with this job
 */
int orte_plm_bproc_signal_job(orte_jobid_t jobid, int32_t signal, opal_list_t *attrs) {
    pid_t* pids;
    orte_std_cntr_t i, num_pids;
    int rc;

    OPAL_TRACE(1);
    
    /* signal application process */
    if(ORTE_SUCCESS != (rc = orte_plm_bproc_get_proc_pids(jobid, &pids, &num_pids, attrs)))
        return rc;
    for(i=0; i<num_pids; i++) {
        if(mca_plm_bproc_component.debug) {
            opal_output(0, "orte_plm_bproc: signaling proc: %d\n", pids[i]);
        }
        kill(pids[i], (int)signal);
    }
    if(NULL != pids)
        free(pids);

    /** dont signal daemons - this is strictly for signalling application processes */
    return ORTE_SUCCESS;
}

/**
 * Signal a specific process.
 */
int orte_plm_bproc_signal_proc(const orte_process_name_t* proc_name, int32_t signal) {
    int rc;
    pid_t pid;

    OPAL_TRACE(1);
    
    if(ORTE_SUCCESS != (rc = orte_plm_bproc_get_proc_pid(proc_name, &pid)))
        return rc;
    if(kill(pid, (int)signal) != 0) {
        switch(errno) {
            case EINVAL:
                return ORTE_ERR_BAD_PARAM;
            case ESRCH:
                return ORTE_ERR_NOT_FOUND;
            case EPERM:
                return ORTE_ERR_PERM;
            default:
                return ORTE_ERROR;
        }
    }
    return ORTE_SUCCESS;
}

/**
 * Cancel an operation involving comm to an orted
 */
int orte_plm_bproc_cancel_operation(void)
{
    int rc;
    
    OPAL_TRACE(1);
    
    if (ORTE_SUCCESS != (rc = orte_plm_base_orted_cancel_operation())) {
        ORTE_ERROR_LOG(rc);
    }
    
    return rc;
}


/**
 * Module cleanup
 */
int orte_plm_bproc_finalize(void)
{
   return ORTE_SUCCESS;
}


/*
 * Handle threading issues.
 */

#if OMPI_HAVE_POSIX_THREADS && OMPI_THREADS_HAVE_DIFFERENT_PIDS

struct orte_plm_bproc_stack_t {
    opal_condition_t cond;
    opal_mutex_t mutex;
    bool complete;
    orte_jobid_t jobid;
    int rc;
};
typedef struct orte_plm_bproc_stack_t orte_plm_bproc_stack_t;

static void orte_plm_bproc_stack_construct(orte_plm_bproc_stack_t* stack)
{
    OBJ_CONSTRUCT(&stack->mutex, opal_mutex_t);
    OBJ_CONSTRUCT(&stack->cond, opal_condition_t);
    stack->rc = 0;
    stack->complete = false;
}

static void orte_plm_bproc_stack_destruct(orte_plm_bproc_stack_t* stack)
{
    OBJ_DESTRUCT(&stack->mutex);
    OBJ_DESTRUCT(&stack->cond);
}

static OBJ_CLASS_INSTANCE(
    orte_plm_bproc_stack_t,
    opal_object_t,
    orte_plm_bproc_stack_construct,
    orte_plm_bproc_stack_destruct);


static void orte_plm_bproc_launch_cb(int fd, short event, void* args)
{

    orte_plm_bproc_stack_t *stack = (orte_plm_bproc_stack_t*)args;
    stack->rc = orte_plm_bproc_launch(stack->jobid);
    OPAL_THREAD_LOCK(&stack->mutex);
    stack->complete = true;
    opal_condition_signal(&stack->cond);
    OPAL_THREAD_UNLOCK(&stack->mutex);
}

int orte_plm_bproc_launch_threaded(orte_jobid_t jobid)
{
    struct timeval tv = { 0, 0 };
    struct opal_event event;
    struct orte_plm_bproc_stack_t stack;

    OBJ_CONSTRUCT(&stack, orte_plm_bproc_stack_t);

    stack.jobid = jobid;
    opal_evtimer_set(&event, orte_plm_bproc_launch_cb, &stack);
    opal_evtimer_add(&event, &tv);

    OPAL_THREAD_LOCK(&stack.mutex);
    while(stack.complete == false)
         opal_condition_wait(&stack.cond, &stack.mutex);
    OPAL_THREAD_UNLOCK(&stack.mutex);
    OBJ_DESTRUCT(&stack);
    return stack.rc;
}

#endif