pm/util/env.c

/*
 * Copyright (C) by Argonne National Laboratory
 *     See COPYRIGHT in top-level directory
 */

#include "mpichconf.h"

#include <stdio.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_STDLIB_H
#include <stdlib.h>
#endif
#ifdef HAVE_STRING_H
#include <string.h>
#endif
#if defined(HAVE_PUTENV) && defined(NEEDS_PUTENV_DECL)
extern int putenv(char *string);
#endif

#include "pmutil.h"
#include "process.h"
#include "env.h"
#include "cmnargs.h"    /* for mpiexec_usage */

/*
 *
 */

/*
 * This routine may be called by MPIE_Args to handle any environment arguments
 * Returns the number of arguments to skip (0 if argument is not recognized
 * as an environment control)
 */
int MPIE_ArgsCheckForEnv(int argc, char *argv[], ProcessWorld * pWorld, EnvInfo ** appEnv)
{
    int i, incr = 0;
    EnvInfo *env;
    char *cmd;

    if (strncmp(argv[0], "-env", 4) == 0) {
        if (!*appEnv) {
            env = (EnvInfo *) MPL_malloc(sizeof(EnvInfo), MPL_MEM_PM);
            env->includeAll = 1;
            env->envPairs = 0;
            env->envNames = 0;
            *appEnv = env;
        } else
            env = *appEnv;
        cmd = argv[0] + 4;
    } else if (strncmp(argv[0], "-genv", 5) == 0) {
        if (!pWorld->genv) {
            env = (EnvInfo *) MPL_malloc(sizeof(EnvInfo), MPL_MEM_PM);
            env->includeAll = 1;
            env->envPairs = 0;
            env->envNames = 0;
            pWorld->genv = env;
        }
        env = pWorld->genv;
        cmd = argv[0] + 5;
    } else
        return 0;

    /* genv and env commands have the same form, just affect different
     * env structures.  We handle this by identifying which structure,
     * then checkout the remaining command */
    if (!cmd[0]) {
        /* A basic name value command */
        EnvData *p;
        if (!argv[1] || !argv[2]) {
            mpiexec_usage("Missing arguments to -env or -genv");
        }
        p = (EnvData *) MPL_malloc(sizeof(EnvData), MPL_MEM_PM);
        p->name = (const char *) MPL_strdup(argv[1]);
        p->value = (const char *) MPL_strdup(argv[2]);
        p->envvalue = 0;
        p->nextData = env->envPairs;
        env->envPairs = p;

        incr = 3;
    } else if (strcmp(cmd, "none") == 0) {
        env->includeAll = 0;
        incr = 1;
    } else if (strcmp(cmd, "list") == 0) {
        /* argv[1] has a list of names, separated by commas */
        EnvData *p;
        char *lPtr = argv[1], *name;
        int namelen;

        if (!argv[1]) {
            mpiexec_usage("Missing argument to -envlist or -genvlist");
        }
        while (*lPtr) {
            name = lPtr++;
            while (*lPtr && *lPtr != ',')
                lPtr++;
            /* The length of any environment string will fit in an int */
            namelen = (int) (lPtr - name);
            p = (EnvData *) MPL_malloc(sizeof(EnvData), MPL_MEM_PM);
            p->value = 0;
            p->name = (const char *) MPL_malloc(namelen + 1, MPL_MEM_PM);
            p->envvalue = 0;
            for (i = 0; i < namelen; i++)
                ((char *) p->name)[i] = name[i];
            ((char *) p->name)[namelen] = 0;

            p->nextData = env->envNames;
            env->envNames = p;
            if (*lPtr == ',')
                lPtr++;
        }
        incr = 2;
    } else {
        /* Unrecognized env argument. */
        incr = 0;
    }

    return incr;
}

/*
  Setup the environment of a process for a given process state.
  This handles the options for the process world and app

  Input Arguments:
  pState - process state structure
  envp   - Base (pre-existing) environment.  Note that this should
           be the envp from main() (see below)
  maxclient - size of client_envp array

  Output Arguments:
  client_envp -

  Side Effects:
  If envnone or genvnone was selected, the environment variables in envp
  will be removed with unsetenv() or by direct manipulation of the envp
  array (for systems that do not support unsetenv, envp must be the
  array pass into main()).

  Returns the number of items set in client_envp, or -1 on error.
 */
int MPIE_EnvSetup(ProcessState * pState, char *envp[], char *client_envp[], int maxclient)
{
    ProcessWorld *pWorld;
    ProcessApp *app;
    EnvInfo *env;
    EnvData *wPairs = 0, *wNames = 0, *aPairs = 0, *aNames = 0;
    int includeAll = 1;
    int irc = 0;
    int debug = 1;

    app = pState->app;
    pWorld = app->pWorld;

    /* Get the world defaults */
    env = pWorld->genv;
    if (env) {
        includeAll = env->includeAll;
        wPairs = env->envPairs;
        wNames = env->envNames;
    }

    /* Get the app values (overrides includeAll) */
    env = app->env;
    if (env) {
        if (includeAll) {
            /* Let the local env set envnone (there is no way to undo
             * -genvnone) */
            includeAll = env->includeAll;
        }
        aPairs = env->envPairs;
        aNames = env->envNames;
    }

    if (includeAll) {
        if (envp) {
            int j;
            for (j = 0; envp[j] && j < maxclient; j++) {
                putenv(envp[j]);
                client_envp[j] = envp[j];
            }
            irc = j;
        } else
            irc = 0;
    } else {
        MPIE_UnsetAllEnv(envp);
        irc = 0;
    }

    while (wPairs) {
        if (putenv((char *) (wPairs->envvalue))) {
            irc = -1;
            if (debug)
                perror("putenv(wPairs) failed: ");
        }
        wPairs = wPairs->nextData;
    }

    while (wNames) {
        if (putenv((char *) (wNames->envvalue))) {
            irc = -1;
            if (debug)
                perror("putenv(wNames) failed: ");
        }
        wNames = wNames->nextData;
    }

    while (aPairs) {
        if (putenv((char *) (aPairs->envvalue))) {
            irc = -1;
            if (debug)
                perror("putenv(aPairs) failed: ");
        }
        aPairs = aPairs->nextData;
    }

    while (aNames) {
        if (putenv((char *) (aNames->envvalue))) {
            irc = -1;
            if (debug) {
                perror("putenv(aNames) failed: ");
            }
        }
        aNames = aNames->nextData;
    }

    return irc;
}

/*
  Initialize the environment data

  Builds the envvalue version of the data, using the given data.
  if getValue is true, get the value for the name with getenv .
 */
int MPIE_EnvInitData(EnvData * elist, int getValue)
{
    const char *value;
    char *str;
    int rc;
    size_t slen;

    while (elist) {
        /* Skip variables that already have value strings */
        if (!elist->envvalue) {
            if (getValue) {
                value = (const char *) getenv(elist->name);
            } else {
                value = elist->value;
            }
            if (!value) {
                /* Special case for an empty value */
                value = "";
            }
            slen = strlen(elist->name) + strlen(value) + 2;
            str = (char *) MPL_malloc(slen, MPL_MEM_PM);
            if (!str) {
                return 1;
            }
            MPL_strncpy(str, elist->name, slen);
            if (value && *value) {
                rc = MPL_strnapp(str, "=", slen);
                rc += MPL_strnapp(str, value, slen);
                if (rc) {
                    return 1;
                }
            }
            elist->envvalue = (const char *) str;
        }
        elist = elist->nextData;
    }
    return 0;
}

/*
 * Add an enviroinment variable to the global list of variables
 */
int MPIE_Putenv(ProcessWorld * pWorld, const char *env_string)
{
    EnvInfo *genv;
    EnvData *p;

    /* FIXME: This should be getGenv (so allocation/init in one place) */
    if (!pWorld->genv) {
        genv = (EnvInfo *) MPL_malloc(sizeof(EnvInfo), MPL_MEM_PM);
        genv->includeAll = 1;
        genv->envPairs = 0;
        genv->envNames = 0;
        pWorld->genv = genv;
    }
    genv = pWorld->genv;

    p = (EnvData *) MPL_malloc(sizeof(EnvData), MPL_MEM_PM);
    if (!p)
        return 1;
    p->name = 0;
    p->value = 0;
    p->envvalue = (const char *) MPL_strdup(env_string);
    if (!p->envvalue)
        return 1;
    p->nextData = genv->envPairs;
    genv->envPairs = p;

    return 0;
}


/* Unset all environment variables.

   Not all systems support unsetenv (e.g., System V derived systems such
   as Solaris), so we have to provide our own implementation.

   In addition, there are various ways to determine the "current" environment
   variables.  One is to pass a third arg to main; the other is a global
   variable.

   Also, we prefer the environ variable over envp, because exec often
   prefers what is in environ rather than the envp (envp appears to be a
   copy, and unsetting the env doesn't always change the environment
   that exec creates.  This seems wrong, but it was what was observed
   on Linux).

*/
#ifdef HAVE_EXTERN_ENVIRON
#ifdef NEEDS_ENVIRON_DECL
extern char **environ;
#endif
int MPIE_UnsetAllEnv(char *envp[])
{
    /* Ignore envp because environ is the real array that controls
     * the environment used by getenv/putenv/etc */
    char **ep = environ;

    while (*ep)
        *ep++ = 0;
    return 0;
}
#elif defined(HAVE_UNSETENV)
int MPIE_UnsetAllEnv(char *envp[])
{
    int j;

    for (j = 0; envp[j]; j++) {
        unsetenv(envp[j]);
    }
    return 0;
}
#else
/* No known way to unset the environment.  Return failure */
int MPIE_UnsetAllEnv(char *envp[])
{
    return 1;
}
#endif