configuration.h 7.38 KB
Newer Older
Philip Carns's avatar
Philip Carns committed
1
2
3
4
5
6
/*
 * Copyright (C) 2013 University of Chicago.
 * See COPYRIGHT notice in top-level directory.
 *
 */

7
8
9
#ifndef __CONFIGURATION_H__
#define __CONFIGURATION_H__

10
11
12
#include <inttypes.h>
#include <mpi.h>
#include "codes/txt_configfile.h"
13
14
15
16

#define CONFIGURATION_MAX_NAME 256
#define CONFIGURATION_MAX_GROUPS 10
#define CONFIGURATION_MAX_TYPES 10
17
#define CONFIGURATION_MAX_ANNOS 10
18
19
20
21

typedef struct config_lptype_s
{
    char     name[CONFIGURATION_MAX_NAME];
22
    char     anno[CONFIGURATION_MAX_NAME];
23
24
25
26
27
28
29
30
31
32
33
    uint64_t count;
} config_lptype_t;

typedef struct config_lpgroup_s
{
    char     name[CONFIGURATION_MAX_NAME];
    uint64_t repetitions;
    config_lptype_t lptypes[CONFIGURATION_MAX_TYPES];
    uint64_t lptypes_count;
} config_lpgroup_t;

34
35
36
37
38
39
40
41
42
43
44
45
46
47
// mapping of lp type to the list of annotations used. Used for convenience when
// models are performing configuraiton code 
typedef struct config_anno_map_s
{
    char     lp_name[CONFIGURATION_MAX_NAME];
    // only explicit annotations tracked here - use a flag to indicate a
    // non-annotated LP type
    uint64_t num_unanno_lps;
    uint64_t num_annos;
    // maintain the number of lps that have the particular annotation 
    uint64_t num_anno_lps[CONFIGURATION_MAX_ANNOS];
    char   * annotations[CONFIGURATION_MAX_ANNOS];
} config_anno_map_t;

48
typedef struct config_lpgroups_s
49
50
{
    uint64_t lpgroups_count;
51
52
53
    config_lpgroup_t lpgroups[CONFIGURATION_MAX_GROUPS];
    uint64_t lpannos_count;
    config_anno_map_t lpannos[CONFIGURATION_MAX_TYPES];
54
} config_lpgroups_t;
55

56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/*
 * Load a configuration on the system (collectively)
 *
 * filepath - path and name of file
 * comm     - communicator to distribute file on
 * handle   - output of configuration
 *
 * return 0 on success
 */
int configuration_load (const char * filepath,
                        MPI_Comm comm,
                        ConfigHandle *handle);

/*
 * Free any resources allocated on load.
 *
 * handle - configuration handle
 */
int configuration_free (ConfigHandle *handle);

/*
 * Get's the value for a give section/key pair.
 * Caller's responsible for transforming it to a useable type.
 * Assumes the key name is a KEY configuration type.
 * 
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
84
 * annotation - optional annotation to look for (NULL -> no annotation)
85
86
87
88
89
90
 * value - pointer to string
 * length - maximum length of string
 */
int configuration_get_value(ConfigHandle *handle,
                            const char * section_name,
                            const char * key_name,
91
                            const char * annotation,
92
93
94
                            char *value,
                            size_t length);

95
96
97
98
99
100
101
102
103
/*
 * Gets the value for a given section/key pair, and interprets it as a path
 * relative to the location of the configuration file.
 * Assumes the key name is a KEY configuration type.
 * Assumes unix path conventions.
 *
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
104
 * annotation - optional annotation to look for (NULL -> no annotation)
105
106
107
108
109
110
 * value - pointer to string
 * length - maximum length of string */
int configuration_get_value_relpath(
        ConfigHandle *handle,
        const char * section_name,
        const char * key_name,
111
        const char * annotation,
112
113
114
        char *value,
        size_t length);

115
116
117
118
119
120
121
122
123

/*
 * Get's the values for a give section/key pair which has multiple values.
 * Caller's responsible for transforming it to a useable type.
 * Assumes the key name is a MULTIKEY configuration type.
 * 
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
124
 * annotation - optional annotation to look for (NULL -> no annotation)
125
126
127
128
129
130
 * values - array of points to values (must be freed by caller)
 * length - number of value items
 */
int configuration_get_multivalue(ConfigHandle *handle,
                                 const char * section_name,
                                 const char * key_name,
131
                                 const char * annotation,
132
133
134
                                 char ***values,
                                 size_t *length);

135
136
137
138
139
140
141
/*
 * Get's the value for a give section/key pair and converts it to an int.
 * Assumes the key name is a KEY configuration type.
 * 
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
142
 * annotation - optional annotation to look for (NULL -> no annotation)
143
144
145
146
147
 * value - returned as a pointer to an integer
 */
int configuration_get_value_int (ConfigHandle *handle,
                                 const char *section_name,
                                 const char *key_name,
148
                                 const char * annotation,
149
150
151
152
153
154
155
156
157
158
                                 int *value);

/*
 * Get's the value for a give section/key pair and converts it to an
 * unsigned int.
 * Assumes the key name is a KEY configuration type.
 * 
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
159
 * annotation - optional annotation to look for (NULL -> no annotation)
160
161
162
163
164
 * value - returned as a pointer to an unsigned integer
 */
int configuration_get_value_uint (ConfigHandle *handle,
                                  const char *section_name,
                                  const char *key_name,
165
                                  const char * annotation,
166
167
168
169
170
171
172
173
174
                                  unsigned int *value);

/*
 * Get's the value for a give section/key pair and converts it to a long int.
 * Assumes the key name is a KEY configuration type.
 * 
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
175
 * annotation - optional annotation to look for (NULL -> no annotation)
176
177
178
179
180
 * value - returned as a pointer to a long integer
 */
int configuration_get_value_longint (ConfigHandle *handle,
                                     const char *section_name,
                                     const char *key_name,
181
                                     const char * annotation,
182
183
184
185
186
187
188
189
190
                                     long int *value);

/*
 * Get's the value for a give section/key pair and converts it to a double.
 * Assumes the key name is a KEY configuration type.
 * 
 * handle - configuration handle
 * section_name - name of the section the key is in
 * key_name - name of the key
191
 * annotation - optional annotation to look for (NULL -> no annotation)
192
193
194
195
196
 * value - returned as a pointer to a double
 */
int configuration_get_value_double (ConfigHandle *handle,
                                    const char *section_name,
                                    const char *key_name,
197
                                    const char * annotation,
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
                                    double *value);

/*
 * Get the LPGROUPS configuration from the config file which is stored
 * in the associated data structures.
 *
 * handle - configuration handle
 * section_name - name of section which has the lptypes
 * lpgroups - data structure to hold the lpgroup info
 */
int configuration_get_lpgroups (ConfigHandle *handle,
                                const char *section_name,
                                config_lpgroups_t *lpgroups);

/*
 * Forward reference to the configuration handle
 */
extern ConfigHandle config;
216
217

#endif
Philip Carns's avatar
Philip Carns committed
218
219
220
221
222
223
224
225
226

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