/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil ; -*- */
/*
 *
 *   Copyright (C) 2001 University of Chicago.
 *   See COPYRIGHT notice in top-level directory.
 */

/* cb_config_list.c
 *
 * The important, externally used functions from this file are:
 * ADIOI_cb_bcast_rank_map()
 * ADIOI_cb_gather_name_array()
 * ADIOI_cb_config_list_parse()
 * ADIOI_cb_copy_name_array()
 * ADIOI_cb_delete_name_array()
 *
 * Prototypes for these are in adio/include/adio_cb_config_list.h
 */

#include "adio.h"
#include "mpi.h"
#include "adio_cb_config_list.h"
#include <stdio.h>
#include <string.h>
#include <stdlib.h>

/* token types */
#define AGG_WILDCARD 1
#define AGG_STRING   2
#define AGG_COMMA    3
#define AGG_COLON    4
#define AGG_ERROR   -1
#define AGG_EOS      0

#undef CB_CONFIG_LIST_DEBUG

/* a couple of globals keep things simple */
int ADIOI_cb_config_list_keyval = MPI_KEYVAL_INVALID;
static char *yylval;
static char *token_ptr;

/* internal stuff */
static int get_max_procs(int cb_nodes);
static int match_procs(char *name, int max_per_proc, char *procnames[],
                       char used_procnames[],
                       int nr_procnames, int ranks[], int nr_ranks, int *nr_ranks_allocated);
static int match_this_proc(char *name, int cur_proc, int max_matches,
                           char *procnames[], char used_procnames[],
                           int nr_procnames, int ranks[], int nr_ranks, int nr_ranks_allocated);
static int find_name(char *name, char *procnames[], char used_procnames[],
                     int nr_procnames, int start_ind);
static int cb_config_list_lex(void);


/* ADIOI_cb_bcast_rank_map() - broadcast the rank array
 *
 * Parameters:
 * fd - ADIO_File for which update is occurring.  cb_nodes and ranklist
 * parameters must be up-to-date on rank 0 of the fd->comm.
 *
 * should probably be a void fn.
 */
int ADIOI_cb_bcast_rank_map(ADIO_File fd)
{
    int my_rank;
    char *value;
    int error_code = MPI_SUCCESS;
    static char myname[] = "ADIOI_cb_bcast_rank_map";
    char *p;
    int i;

    MPI_Bcast(&(fd->hints->cb_nodes), 1, MPI_INT, 0, fd->comm);
    if (fd->hints->cb_nodes > 0) {
        MPI_Comm_rank(fd->comm, &my_rank);
        if (my_rank != 0) {
            fd->hints->ranklist = ADIOI_Malloc(fd->hints->cb_nodes * sizeof(int));
            if (fd->hints->ranklist == NULL) {
                error_code = MPIO_Err_create_code(error_code,
                                                  MPIR_ERR_RECOVERABLE,
                                                  myname, __LINE__, MPI_ERR_OTHER, "**nomem2", 0);
                return error_code;
            }
        }
        MPI_Bcast(fd->hints->ranklist, fd->hints->cb_nodes, MPI_INT, 0, fd->comm);
    }
    /* TEMPORARY -- REMOVE WHEN NO LONGER UPDATING INFO FOR
     * FS-INDEP. */
    value = (char *) ADIOI_Malloc((MPI_MAX_INFO_VAL + 1) * sizeof(char));
    MPL_snprintf(value, MPI_MAX_INFO_VAL + 1, "%d", fd->hints->cb_nodes);
    ADIOI_Info_set(fd->info, "cb_nodes", value);
    p = value;
    /* the (by MPI rank) list of aggregators can be larger than
     * MPI_MAX_INFO_VAL, so we will simply truncate when we reach capacity. I
     * wasn't clever enough to figure out how to rewind and put '...' at the
     * end in the truncate case */
    for (i = 0; i < fd->hints->cb_nodes; i++) {
        int incr, remain = (MPI_MAX_INFO_VAL) - (p - value);
        incr = MPL_snprintf(p, remain, "%d ", fd->hints->ranklist[i]);
        if (incr >= remain)
            break;
        p += incr;
    }
    ADIOI_Info_set(fd->info, "romio_aggregator_list", value);
    ADIOI_Free(value);

    return 0;
}

/* ADIOI_cb_gather_name_array() - gather a list of processor names from all processes
 *                          in a communicator and store them on rank 0.
 *
 * This is a collective call on the communicator(s) passed in.
 *
 * Obtains a rank-ordered list of processor names from the processes in
 * "dupcomm".
 *
 * Returns 0 on success, -1 on failure.
 *
 * NOTE: Needs some work to cleanly handle out of memory cases!
 */
int ADIOI_cb_gather_name_array(MPI_Comm comm, MPI_Comm dupcomm, ADIO_cb_name_array * arrayp)
{
    char my_procname[MPI_MAX_PROCESSOR_NAME], **procname = 0;
    int *procname_len = NULL, my_procname_len, *disp = NULL, i;
    int commsize, commrank, found;
    ADIO_cb_name_array array = NULL;
    int alloc_size;

    if (ADIOI_cb_config_list_keyval == MPI_KEYVAL_INVALID) {
        /* cleaned up by ADIOI_End_call */
        MPI_Keyval_create((MPI_Copy_function *) ADIOI_cb_copy_name_array,
                          (MPI_Delete_function *) ADIOI_cb_delete_name_array,
                          &ADIOI_cb_config_list_keyval, NULL);
    } else {
        MPI_Attr_get(comm, ADIOI_cb_config_list_keyval, (void *) &array, &found);
        if (found) {
            ADIOI_Assert(array != NULL);
            *arrayp = array;
            return 0;
        }
    }

    MPI_Comm_size(dupcomm, &commsize);
    MPI_Comm_rank(dupcomm, &commrank);

    MPI_Get_processor_name(my_procname, &my_procname_len);

    /* allocate space for everything */
    array = (ADIO_cb_name_array) ADIOI_Malloc(sizeof(*array));
    if (array == NULL) {
        return -1;
    }
    array->refct = 2;   /* we're going to associate this with two comms */

    if (commrank == 0) {
        /* process 0 keeps the real list */
        array->namect = commsize;

        array->names = (char **) ADIOI_Malloc(sizeof(char *) * commsize);
        if (array->names == NULL) {
            return -1;
        }
        procname = array->names;        /* simpler to read */

        procname_len = (int *) ADIOI_Malloc(commsize * sizeof(int));
        if (procname_len == NULL) {
            return -1;
        }
    } else {
        /* everyone else just keeps an empty list as a placeholder */
        array->namect = 0;
        array->names = NULL;
    }
    /* gather lengths first */
    MPI_Gather(&my_procname_len, 1, MPI_INT, procname_len, 1, MPI_INT, 0, dupcomm);

    if (commrank == 0) {
#ifdef CB_CONFIG_LIST_DEBUG
        for (i = 0; i < commsize; i++) {
            FPRINTF(stderr, "len[%d] = %d\n", i, procname_len[i]);
        }
#endif

        alloc_size = 0;
        for (i = 0; i < commsize; i++) {
            /* add one to the lengths because we need to count the
             * terminator, and we are going to use this list of lengths
             * again in the gatherv.
             */
            alloc_size += ++procname_len[i];
        }

        procname[0] = ADIOI_Malloc(alloc_size);
        if (procname[0] == NULL) {
            ADIOI_Free(array);
            return -1;
        }

        for (i = 1; i < commsize; i++) {
            procname[i] = procname[i - 1] + procname_len[i - 1];
        }

        /* create our list of displacements for the gatherv.  we're going
         * to do everything relative to the start of the region allocated
         * for procname[0]
         */
        disp = ADIOI_Malloc(commsize * sizeof(int));
        disp[0] = 0;
        for (i = 1; i < commsize; i++) {
            disp[i] = (int) (procname[i] - procname[0]);
        }

    }

    /* now gather strings */
    if (commrank == 0) {
        MPI_Gatherv(my_procname, my_procname_len + 1, MPI_CHAR,
                    procname[0], procname_len, disp, MPI_CHAR, 0, dupcomm);
    } else {
        /* if we didn't do this, we would need to allocate procname[]
         * on all processes...which seems a little silly.
         */
        MPI_Gatherv(my_procname, my_procname_len + 1, MPI_CHAR,
                    NULL, NULL, NULL, MPI_CHAR, 0, dupcomm);
    }

    if (commrank == 0) {
        /* no longer need the displacements or lengths */
        ADIOI_Free(disp);
        ADIOI_Free(procname_len);

#ifdef CB_CONFIG_LIST_DEBUG
        for (i = 0; i < commsize; i++) {
            FPRINTF(stderr, "name[%d] = %s\n", i, procname[i]);
        }
#endif
    }

    /* store the attribute; we want to store SOMETHING on all processes
     * so that they can all tell if we have gone through this procedure
     * or not for the given communicator.
     *
     * specifically we put it on both the original comm, so we can find
     * it next time an open is performed on this same comm, and on the
     * dupcomm, so we can use it in I/O operations.
     */
    MPI_Attr_put(comm, ADIOI_cb_config_list_keyval, array);
    MPI_Attr_put(dupcomm, ADIOI_cb_config_list_keyval, array);
    *arrayp = array;
    return 0;
}


/* ADIOI_cb_config_list_parse() - parse the cb_config_list and build the
 * ranklist
 *
 * Parameters:
 * (pretty self explanatory)
 *
 * Returns number of ranks allocated in parsing, -1 on error.
 */
int ADIOI_cb_config_list_parse(char *config_list,
                               ADIO_cb_name_array array, int ranklist[], int cb_nodes)
{
    int token, max_procs, cur_rank = 0, nr_procnames;
    char *cur_procname, *cur_procname_p, **procnames;
    char *used_procnames;

    nr_procnames = array->namect;
    procnames = array->names;

    /* nothing big goes on the stack */
    /* we use info val here and for yylval because we know the string
     * cannot be any bigger than this.
     */
    cur_procname = ADIOI_Malloc((MPI_MAX_INFO_VAL + 1) * sizeof(char));
    if (cur_procname == NULL) {
        return -1;
    }

    yylval = ADIOI_Malloc((MPI_MAX_INFO_VAL + 1) * sizeof(char));
    if (yylval == NULL) {
        ADIOI_Free(cur_procname);
        return -1;
    }

    token_ptr = config_list;

    /* right away let's make sure cb_nodes isn't too big */
    if (cb_nodes > nr_procnames)
        cb_nodes = nr_procnames;

    /* used_procnames is used as a mask so that we don't have to destroy
     * our procnames array
     */
    used_procnames = ADIOI_Malloc(array->namect * sizeof(char));
    if (used_procnames == NULL) {
        ADIOI_Free(cur_procname);
        ADIOI_Free(yylval);
        yylval = NULL;
        return -1;
    }
    memset(used_procnames, 0, array->namect);

    /* optimization for "*:*"; arguably this could be done before we
     * build the list of processor names...but that would make things
     * messy.
     */
    if (strcmp(config_list, "*:*") == 0) {
        for (cur_rank = 0; cur_rank < cb_nodes; cur_rank++) {
            ranklist[cur_rank] = cur_rank;
        }
        ADIOI_Free(cur_procname);
        ADIOI_Free(yylval);
        yylval = NULL;
        ADIOI_Free(used_procnames);
        return cb_nodes;
    }

    while (cur_rank < cb_nodes) {
        token = cb_config_list_lex();

        if (token == AGG_EOS) {
            ADIOI_Free(cur_procname);
            ADIOI_Free(yylval);
            yylval = NULL;
            ADIOI_Free(used_procnames);
            return cur_rank;
        }

        if (token != AGG_WILDCARD && token != AGG_STRING) {
            /* maybe ignore and try to keep going? */
            FPRINTF(stderr, "error parsing config list\n");
            ADIOI_Free(cur_procname);
            ADIOI_Free(yylval);
            yylval = NULL;
            ADIOI_Free(used_procnames);
            return cur_rank;
        }

        if (token == AGG_WILDCARD) {
            cur_procname_p = NULL;
        } else {
            /* AGG_STRING is the only remaining case */
            /* save procname (for now) */
            ADIOI_Strncpy(cur_procname, yylval, MPI_MAX_INFO_VAL + 1);
            cur_procname_p = cur_procname;
        }

        /* after we have saved the current procname, we can grab max_procs */
        max_procs = get_max_procs(cb_nodes);

#ifdef CB_CONFIG_LIST_DEBUG
        if (token == AGG_WILDCARD) {
            FPRINTF(stderr, "looking for *:%d\n", max_procs);
        } else {
            FPRINTF(stderr, "looking for %s:%d\n", cur_procname, max_procs);
        }
#endif

        /* do the matching for this piece of the cb_config_list */
        match_procs(cur_procname_p, max_procs, procnames, used_procnames,
                    nr_procnames, ranklist, cb_nodes, &cur_rank);
    }
    ADIOI_Free(cur_procname);
    ADIOI_Free(yylval);
    yylval = NULL;
    ADIOI_Free(used_procnames);
    return cur_rank;
}

/* ADIOI_cb_copy_name_array() - attribute copy routine
 */
int ADIOI_cb_copy_name_array(MPI_Comm comm,
                             int keyval, void *extra, void *attr_in, void **attr_out, int *flag)
{
    ADIO_cb_name_array array;

    MPL_UNREFERENCED_ARG(comm);
    MPL_UNREFERENCED_ARG(keyval);
    MPL_UNREFERENCED_ARG(extra);

    array = (ADIO_cb_name_array) attr_in;
    if (array != NULL)
        array->refct++;

    *attr_out = attr_in;
    *flag = 1;  /* make a copy in the new communicator */

    return MPI_SUCCESS;
}

/* ADIOI_cb_delete_name_array() - attribute destructor
 */
int ADIOI_cb_delete_name_array(MPI_Comm comm, int keyval, void *attr_val, void *extra)
{
    ADIO_cb_name_array array;

    MPL_UNREFERENCED_ARG(comm);
    MPL_UNREFERENCED_ARG(extra);

    array = (ADIO_cb_name_array) attr_val;
    ADIOI_Assert(array != NULL);
    array->refct--;

    if (array->refct <= 0) {
        /* time to free the structures (names, array of ptrs to names, struct)
         */
        if (array->namect) {
            /* Note that array->names[i], where i > 0,
             * are just pointers into the allocated region array->names[0]
             */
            ADIOI_Free(array->names[0]);
        }
        if (array->names != NULL)
            ADIOI_Free(array->names);
        ADIOI_Free(array);
    }
    return MPI_SUCCESS;
}

/* match_procs() - given a name (or NULL for wildcard) and a max. number
 *                 of aggregator processes (per processor name), this
 *                 matches in the procnames[] array and puts appropriate
 *                 ranks in the ranks array.
 *
 * Parameters:
 * name - processor name (or NULL for wildcard)
 * max_per_proc - maximum # of processes to use for aggregation from a
 *                single processor
 * procnames - array of processor names
 * nr_procnames - length of procnames array
 * ranks - array of process ranks
 * nr_ranks - length of process ranks array (also max. # of aggregators)
 * nr_ranks_allocated - # of array entries which have been filled in,
 *                      which is also the index to the first empty entry
 *
 * Returns number of matches.
 */
static int match_procs(char *name,
                       int max_per_proc,
                       char *procnames[],
                       char used_procnames[],
                       int nr_procnames, int ranks[], int nr_ranks, int *nr_ranks_allocated)
{
    int wildcard_proc, cur_proc, old_nr_allocated, ret;

    /* save this so we can report on progress */
    old_nr_allocated = *nr_ranks_allocated;

    if (name == NULL) {
        /* wildcard case */

        /* optimize for *:0 case */
        if (max_per_proc == 0) {
            /* loop through procnames and mark them all as used */
            for (cur_proc = 0; cur_proc < nr_procnames; cur_proc++) {
                used_procnames[cur_proc] = 1;
            }
            return 0;
        }

        /* the plan here is to start at the beginning of the procnames
         * array looking for processor names to apply the wildcard to.
         *
         * we set wildcard_proc to 0 here but do the search inside the
         * while loop so that we aren't starting our search from the
         * beginning of the procnames array each time.
         */
        wildcard_proc = 0;

        while (nr_ranks - *nr_ranks_allocated > 0) {
            /* find a name */
            while ((wildcard_proc < nr_procnames) && (used_procnames[wildcard_proc] != 0)) {
                wildcard_proc++;
            }

            if (wildcard_proc == nr_procnames) {
                /* we have used up the entire procnames list */
                return *nr_ranks_allocated - old_nr_allocated;
            }
#ifdef CB_CONFIG_LIST_DEBUG
            FPRINTF(stderr, "performing wildcard match (*:%d) starting with %s (%d)\n",
                    max_per_proc, procnames[wildcard_proc], wildcard_proc);
#endif

            cur_proc = wildcard_proc;

#ifdef CB_CONFIG_LIST_DEBUG
            FPRINTF(stderr, "  assigning name %s (%d) to rank %d in mapping\n",
                    procnames[cur_proc], cur_proc, *nr_ranks_allocated);
#endif

            /* alloc max_per_proc from this host; cur_proc points to
             * the first one.  We want to save this name for use in
             * our while loop.
             */
            ranks[*nr_ranks_allocated] = cur_proc;
            *nr_ranks_allocated = *nr_ranks_allocated + 1;
            cur_proc++;

            /* so, to accomplish this we use the match_this_proc() to
             * alloc max_per_proc-1.  we increment cur_proc so that the
             * procnames[] entry doesn't get trashed.  then AFTER the call
             * we clean up the first instance of the name.
             */
            ret = match_this_proc(procnames[wildcard_proc], cur_proc,
                                  max_per_proc - 1, procnames, used_procnames,
                                  nr_procnames, ranks, nr_ranks, *nr_ranks_allocated);
            if (ret > 0)
                *nr_ranks_allocated = *nr_ranks_allocated + ret;

            /* clean up and point wildcard_proc to the next entry, since
             * we know that this one is NULL now.
             */
            used_procnames[wildcard_proc] = 1;
            wildcard_proc++;
        }
    } else {
        /* specific host was specified; this one is easy */
#ifdef CB_CONFIG_LIST_DEBUG
        FPRINTF(stderr, "performing name match (%s:%d)\n", name, max_per_proc);
#endif

        ret = match_this_proc(name, 0, max_per_proc, procnames, used_procnames,
                              nr_procnames, ranks, nr_ranks, *nr_ranks_allocated);
        if (ret > 0)
            *nr_ranks_allocated = *nr_ranks_allocated + ret;
    }
    return *nr_ranks_allocated - old_nr_allocated;
}

/* match_this_proc() - find each instance of processor name "name" in
 *                     the "procnames" array, starting with index "cur_proc"
 *                     and add the first "max_matches" into the "ranks"
 *                     array.  remove all instances of "name" from
 *                     "procnames".
 *
 * Parameters:
 * name - processor name to match
 * cur_proc - index into procnames[] at which to start matching
 * procnames - array of processor names
 * used_procnames - array of values indicating if a given procname has
 *                  been allocated or removed already
 * nr_procnames - length of procnames array
 * ranks - array of processor ranks
 * nr_ranks - length of ranks array
 * nr_ranks_allocated - number of ranks already filled in, or the next
 *                      entry to fill in (equivalent)
 *
 * Returns number of ranks filled in (allocated).
 */
static int match_this_proc(char *name,
                           int cur_proc,
                           int max_matches,
                           char *procnames[],
                           char used_procnames[],
                           int nr_procnames, int ranks[], int nr_ranks, int nr_ranks_allocated)
{
    int ranks_remaining, nr_to_alloc, old_nr_allocated;

    old_nr_allocated = nr_ranks_allocated;

    /* calculate how many ranks we want to allocate */
    ranks_remaining = nr_ranks - nr_ranks_allocated;
    nr_to_alloc = (max_matches < ranks_remaining) ? max_matches : ranks_remaining;

    while (nr_to_alloc > 0) {
        cur_proc = find_name(name, procnames, used_procnames, nr_procnames, cur_proc);
        if (cur_proc < 0) {
            /* didn't find it */
            return nr_ranks_allocated - old_nr_allocated;
        }

        /* need bounds checking on ranks */
#ifdef CB_CONFIG_LIST_DEBUG
        FPRINTF(stderr, "  assigning name %s (%d) to rank %d in mapping\n",
                procnames[cur_proc], cur_proc, nr_ranks_allocated);
#endif

        ranks[nr_ranks_allocated] = cur_proc;
        nr_ranks_allocated++;
        used_procnames[cur_proc] = 1;

        cur_proc++;
        nr_to_alloc--;
    }

    /* take all other instances of this host out of the list */
    while (cur_proc >= 0) {
        cur_proc = find_name(name, procnames, used_procnames, nr_procnames, cur_proc);
        if (cur_proc >= 0) {
#ifdef CB_CONFIG_LIST_DEBUG
            FPRINTF(stderr, "  taking name %s (%d) out of procnames\n",
                    procnames[cur_proc], cur_proc);
#endif
            used_procnames[cur_proc] = 1;
            cur_proc++;
        }
    }
    return nr_ranks_allocated - old_nr_allocated;
}


/* find_name() - finds the first entry in procnames[] which matches name,
 *               starting at index start_ind
 *
 * Returns an index [0..nr_procnames-1] on success, -1 if not found.
 */
static int find_name(char *name,
                     char *procnames[], char used_procnames[], int nr_procnames, int start_ind)
{
    int i;

    for (i = start_ind; i < nr_procnames; i++) {
        if (!used_procnames[i] && !strcmp(name, procnames[i]))
            break;
    }

    if (i < nr_procnames)
        return i;
    else
        return -1;
}

/* get_max_procs() - grab the maximum number of processes to use out of
 *                   the cb_config_list string
 *
 * Parameters:
 * cb_nodes - cb_nodes value.  this is returned when a "*" is encountered
 *            as the max_procs value.
 *
 * Returns # of processes, or -1 on error.
 */
static int get_max_procs(int cb_nodes)
{
    int token, max_procs = -1;
    char *errptr;

    token = cb_config_list_lex();

    switch (token) {
        case AGG_EOS:
        case AGG_COMMA:
            return 1;
        case AGG_COLON:
            token = cb_config_list_lex();
            if (token != AGG_WILDCARD && token != AGG_STRING)
                return -1;
            if (token == AGG_WILDCARD)
                max_procs = cb_nodes;
            else if (token == AGG_STRING) {
                max_procs = (int) strtol(yylval, &errptr, 10);
                if (*errptr != '\0') {
                    /* some garbage value; default to 1 */
                    max_procs = 1;
                }
            }
            /* strip off next comma (if there is one) */
            token = cb_config_list_lex();
            if (token != AGG_COMMA && token != AGG_EOS)
                return -1;

            /* return max_procs */
            if (max_procs < 0)
                return -1;
            else
                return max_procs;
    }
    return -1;
}


/* cb_config_list_lex() - lexical analyzer for cb_config_list language
 *
 * Returns a token of types defined at top of this file.
 */
#if defined(BGQPLATFORM)
/* On BlueGene, the ',' character shows up in get_processor_name, so we have to
 * use a different delimiter */
#define COLON ':'
#define COMMA ';'
#define DELIMS ":;"
#else
/* these tokens work for every other platform */
#define COLON ':'
#define COMMA ','
#define DELIMS ":,"
#endif

static int cb_config_list_lex(void)
{
    int slen;

    if (*token_ptr == '\0')
        return AGG_EOS;

    slen = (int) strcspn(token_ptr, DELIMS);

    if (*token_ptr == COLON) {
        token_ptr++;
        return AGG_COLON;
    }
    if (*token_ptr == COMMA) {
        token_ptr++;
        return AGG_COMMA;
    }

    if (*token_ptr == '*') {
        /* make sure that we don't have characters after the '*' */
        if (slen == 1) {
            token_ptr++;
            return AGG_WILDCARD;
        } else
            return AGG_ERROR;
    }

    /* last case: some kind of string.  for now we copy the string. */

    /* it would be a good idea to look at the string and make sure that
     * it doesn't have any illegal characters in it.  in particular we
     * should ensure that no one tries to use wildcards with strings
     * (e.g. "ccn*").
     */
    ADIOI_Strncpy(yylval, token_ptr, slen);
    yylval[slen] = '\0';
    token_ptr += slen;
    return AGG_STRING;
}
