codes-workload.h 4.92 KB
Newer Older
1
2
3
4
5
6
/*
 * Copyright (C) 2013 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
 */

7
/* I/O workload generator API to be used for reading I/O operations into
Philip Carns's avatar
Philip Carns committed
8
9
10
 * storage system simulations.  This API just describes the operations to be
 * executed; it does not service the operations.
 */
11
12
13
14
15

#ifndef CODES_WORKLOAD_H
#define CODES_WORKLOAD_H

#include "ross.h"
Jonathan Jenkins's avatar
Jonathan Jenkins committed
16
#define MAX_NAME_LENGTH_WKLD 512
17

18
typedef struct bgp_params bgp_params;
19
typedef struct darshan_params darshan_params;
20
typedef struct recorder_params recorder_params;
21
typedef struct codes_workload_info codes_workload_info;
22
23
24

struct bgp_params
{
25
    /* We have the number of ranks passed in from the bg/p model because
26
27
28
     * the I/O lang workloads have no information about the number of ranks.
     * Only the bg/p config file knows the number of ranks. */
    int num_cns;
29
30
    /* flag - use path to find kernel files relative to the metafile */
    int use_relpath;
Jonathan Jenkins's avatar
Jonathan Jenkins committed
31
32
33
34
    char io_kernel_meta_path[MAX_NAME_LENGTH_WKLD];
    char bgp_config_file[MAX_NAME_LENGTH_WKLD];
    char io_kernel_path[MAX_NAME_LENGTH_WKLD];
    char io_kernel_def_path[MAX_NAME_LENGTH_WKLD];
35
36
};

37
38
39
struct darshan_params
{
    char log_file_path[MAX_NAME_LENGTH_WKLD];
40
    int64_t aggregator_cnt;
41
42
};

43
44
45
struct recorder_params
{
    char trace_dir_path[MAX_NAME_LENGTH_WKLD];
46
    int64_t nprocs;
47
48
49
};


50
51
52
53
54
struct codes_workload_info
{
    int group_id; /* group id */
    int min_rank; /* minimum rank in the collective operation */
    int max_rank; /* maximum rank in the collective operation */
55
    int local_rank; /* local rank? never being used in the bg/p model */
56
57
58
    int num_lrank; /* number of ranks participating in the collective operation*/
};

59
60
61
62
/* supported I/O operations */
enum codes_workload_op_type
{
    /* terminator; there are no more operations for this rank */
63
    CODES_WK_END = 1,
64
65
66
67
68
69
    /* sleep/delay to simulate computation or other activity */
    CODES_WK_DELAY,
    /* block until specified ranks have reached the same point */
    CODES_WK_BARRIER,
    /* open */
    CODES_WK_OPEN,
70
    /* close */
71
72
73
74
75
76
77
78
79
80
81
82
83
84
    CODES_WK_CLOSE,
    /* write */
    CODES_WK_WRITE,
    /* read */
    CODES_WK_READ
};

/* I/O operation paramaters */
struct codes_workload_op
{
    /* TODO: do we need different "classes" of operations to differentiate
     * between different APIs?
     */

Philip Carns's avatar
Philip Carns committed
85
    /* what type of operation this is */
86
87
    enum codes_workload_op_type op_type;

Philip Carns's avatar
Philip Carns committed
88
    /* parameters for each operation type */
89
90
91
92
93
94
    union
    {
        struct {
            double seconds;
        } delay;
        struct {
Philip Carns's avatar
Philip Carns committed
95
            int count;  /* num ranks in barrier, -1 means "all" */
96
97
98
            int root;   /* root rank */
        } barrier;
        struct {
99
            uint64_t file_id;      /* integer identifier for the file */
100
101
102
            int create_flag;  /* file must be created, not just opened */
        } open;
        struct {
103
            uint64_t file_id;  /* file to operate on */
104
105
106
107
            off_t offset; /* offset and size */
            size_t size;
        } write;
        struct {
108
            uint64_t file_id;  /* file to operate on */
109
110
111
112
            off_t offset; /* offset and size */
            size_t size;
        } read;
        struct {
113
            uint64_t file_id;  /* file to operate on */
114
        } close;
115
    }u;
116
117
118
119
};

/* load and initialize workload of of type "type" with parameters specified by
 * "params".  The rank is the caller's relative rank within the collection
120
 * of processes that will participate in this workload.
121
122
123
124
 *
 * This function is intended to be called by a compute node LP in a model
 * and may be called multiple times over the course of a
 * simulation in order to execute different application workloads.
125
 *
126
127
128
129
130
131
132
133
134
 * Returns and identifier that can be used to retrieve operations later.
 * Returns -1 on failure.
 */
int codes_workload_load(const char* type, const char* params, int rank);

/* Retrieves the next I/O operation to execute.  the wkld_id is the
 * identifier returned by the init() function.  The op argument is a pointer
 * to a structure to be filled in with I/O operation information.
 */
135
void codes_workload_get_next(int wkld_id, int rank, struct codes_workload_op *op);
136
137

/* Reverse of the above function. */
138
void codes_workload_get_next_rc(int wkld_id, int rank, const struct codes_workload_op *op);
139

140
141
142
/* Retrieve the number of ranks contained in a workload */
int codes_workload_get_rank_cnt(const char* type, const char* params);

143
144
145
/* for debugging/logging: print an individual operation to the specified file */
void codes_workload_print_op(FILE *f, struct codes_workload_op *op, int rank);

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
/* NOTE: there is deliberately no finalize function; we don't have any
 * reliable way to tell when a workload is truly done and will not
 * participate in further reverse computation.   The underlying generators
 * will shut down automatically once they have issued their last event.
 */

#endif /* CODES_WORKLOAD_H */

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