codes-jobmap.h 2.45 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13
/*
 * Copyright (C) 2015 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
 */

/* SUMMARY - namespace support for multiple groups of ids (jobs) with respect to a
 * flat namespace. Note that this API is meant for static job creation - a more
 * sophisticated method would need to be used to modify job mappings at
 * runtime.
 *
 * Example:
 *
Jonathan Jenkins's avatar
Jonathan Jenkins committed
14
 * job  0      1    2        (<-- jobmap defined "job" IDs)
15 16
 * rank 0 1 2  0 1  0 1 2 3  (<-- "job local" IDs)
 * ID   0 1 2  3 4  5 6 7 8  (<-- jobmap-defined LP relative "global" IDs)
17 18 19 20 21 22 23 24 25
 * LP   A B C  D E  F G H I  (<-- provided by codes-mapping)
 * */

#ifndef CODES_JOBMAP_H
#define CODES_JOBMAP_H

/** type markers and parameter defs for jobmaps **/

enum codes_jobmap_type {
26 27 28 29 30 31 32 33 34 35
    /* the "identity" jobmap is a shim for single-job workloads */
    CODES_JOBMAP_IDENTITY,
    /* the "list" jobmap allows the explicit specification of mappings from
     * jobs to lists of global ids through a text file, wiht one line per job
     */
    CODES_JOBMAP_LIST,
    /* the "dummy" jobmap is an example implementation for testing, and can be
     * seen as the inverse of the identity mapping.
     * It simply specifies N jobs, with exactly one rank per job, with a trivial
     * mapping */
36
    CODES_JOBMAP_DUMMY,
37 38 39 40
};

struct codes_jobmap_params_identity {
    int num_ranks;
41 42 43 44 45 46
};

struct codes_jobmap_params_dummy {
    int num_jobs;
};

Jonathan Jenkins's avatar
Jonathan Jenkins committed
47
struct codes_jobmap_params_list {
48
    char *alloc_file;
49
};
50 51


52 53
/** jobmap interface **/

54
struct codes_jobmap_ctx;
55 56 57 58 59 60 61 62 63 64
struct codes_jobmap_id {
    int job;
    int rank; // relative to job
};

struct codes_jobmap_ctx *
codes_jobmap_configure(enum codes_jobmap_type t, void const * params);

void codes_jobmap_destroy(struct codes_jobmap_ctx *c);

65 66 67 68 69 70 71
/* main mapping functions - bidirectional mapping is needed:
 * - global -> local ID for initialization
 * - local -> global ID for communication between local IDs
 *
 * functions return {-1, -1} and -1, respectively, for invalid id input */

struct codes_jobmap_id codes_jobmap_to_local_id(
72 73 74
        int id,
        struct codes_jobmap_ctx const * c);

75 76 77 78
int codes_jobmap_to_global_id(
        struct codes_jobmap_id id,
        struct codes_jobmap_ctx const * c);

79 80
int codes_jobmap_get_num_jobs(struct codes_jobmap_ctx const * c);

81 82
int codes_jobmap_get_num_ranks(int job_id, struct codes_jobmap_ctx const * c);

83 84 85 86 87 88 89 90 91 92 93
#endif

/*
 * Local variables:
 *  c-indent-level: 4
 *  c-basic-offset: 4
 *  indent-tabs-mode: nil
 * End:
 *
 * vim: ts=8 sts=4 sw=4 expandtab
 */