1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
|
/*
Insofar as copyright might be relevant for a header, the DRMAA2
definition, which contains this header, has the following notice.
Copyright (c) Open Grid Forum (2012). Some Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are
included as references to the derived portions on all such copies and
derivative works. The published OGF document from which such works
are derived, however, may not be modified in any way, such as by
removing the copyright notice or references to the OGF or other
organizations, except as needed for the purpose of developing new or
updated OGF documents in conformance with the procedures defined in
the OGF Document Process, or as required to translate it into
languages other than English. OGF, with the approval of its board, may
remove this restriction for inclusion of OGF document content for the
purpose of producing standards in cooperation with other international
standards bodies.
The limited permissions granted above are perpetual and will not be
revoked by the OGF or its successors or assignees.
*/
#include <time.h>
#ifndef DRMAA2_H
#define DRMAA2_H
/* Marks SGE additions. They can't be abstracted into an included
header if the structs are extended for SGE specifics. */
#define SGE 1
typedef enum drmaa2_jstate {
DRMAA2_UNDETERMINED = 0,
DRMAA2_QUEUED = 1,
DRMAA2_QUEUED_HELD = 2,
DRMAA2_RUNNING = 3,
DRMAA2_SUSPENDED = 4,
DRMAA2_REQUEUED = 5,
DRMAA2_REQUEUED_HELD = 6,
DRMAA2_DONE = 7,
DRMAA2_FAILED = 8
} drmaa2_jstate;
typedef enum drmaa2_os {
DRMAA2_OTHER_OS = 0,
DRMAA2_AIX = 1,
DRMAA2_BSD = 2,
DRMAA2_LINUX = 3,
DRMAA2_HPUX = 4,
DRMAA2_IRIX = 5,
DRMAA2_MACOS = 6,
DRMAA2_SUNOS = 7,
DRMAA2_TRU64 = 8,
DRMAA2_UNIXWARE = 9,
DRMAA2_WIN = 10,
DRMAA2_WINNT = 11
} drmaa2_os;
typedef enum drmaa2_cpu {
DRMAA2_OTHER_CPU = 0,
DRMAA2_ALPHA = 1,
DRMAA2_ARM = 2,
DRMAA2_ARM64 = 3,
DRMAA2_CELL = 4,
DRMAA2_PARISC = 5,
DRMAA2_PARISC64 = 6,
DRMAA2_X86 = 7,
DRMAA2_X64 = 8,
DRMAA2_IA64 = 9,
DRMAA2_MIPS = 10,
DRMAA2_MIPS64 = 11,
DRMAA2_PPC = 12,
DRMAA2_PPC64 = 13,
DRMAA2_SPARC = 14,
DRMAA2_SPARC64 = 15
} drmaa2_cpu;
typedef enum drmaa2_limit {
DRMAA2_CORE_FILE_SIZE = 0,
DRMAA2_CPU_TIME = 1,
DRMAA2_DATA_SIZE = 2,
DRMAA2_FILE_SIZE = 3,
DRMAA2_OPEN_FILES = 4,
DRMAA2_STACK_SIZE = 5,
DRMAA2_VIRTUAL_MEMORY = 6,
DRMAA2_WALLCLOCK_TIME = 7
} drmaa2_limit;
typedef enum drmaa2_event {
DRMAA2_NEW_STATE = 0,
DRMAA2_MIGRATED = 1,
DRMAA2_ATTRIBUTE_CHANGE = 2
} drmaa2_event;
typedef enum drmaa2_capability {
DRMAA2_ADVANCE_RESERVATION = 0,
DRMAA2_RESERVE_SLOTS = 1,
DRMAA2_CALLBACK = 2,
DRMAA2_BULK_JOBS_MAXPARALLEL = 3,
DRMAA2_JT_EMAIL = 4,
DRMAA2_JT_STAGING = 5,
DRMAA2_JT_DEADLINE = 6,
DRMAA2_JT_MAXSLOTS = 7,
DRMAA2_JT_ACCOUNTINGID = 8,
DRMAA2_RT_STARTNOW = 9,
DRMAA2_RT_DURATION = 10,
DRMAA2_RT_MACHINEOS = 11,
DRMAA2_RT_MACHINEARCH = 12
} drmaa2_capability;
typedef enum drmaa2_bool {
DRMAA2_FALSE = 0,
DRMAA2_TRUE = 1
} drmaa2_bool;
typedef enum drmaa2_error {
DRMAA2_SUCCESS = 0,
DRMAA2_DENIED_BY_DRMS = 1,
DRMAA2_DRM_COMMUNICATION = 2,
DRMAA2_TRY_LATER = 3,
DRMAA2_SESSION_MANAGEMENT = 4,
DRMAA2_TIMEOUT = 5,
DRMAA2_INTERNAL = 6,
DRMAA2_INVALID_ARGUMENT = 7,
DRMAA2_INVALID_SESSION = 8,
DRMAA2_INVALID_STATE = 9,
DRMAA2_OUT_OF_RESOURCE = 10,
DRMAA2_UNSUPPORTED_ATTRIBUTE = 11,
DRMAA2_UNSUPPORTED_OPERATION = 12,
DRMAA2_IMPLEMENTATION_SPECIFIC = 13,
DRMAA2_LASTERROR = 14
} drmaa2_error;
typedef char * drmaa2_string;
void drmaa2_string_free(drmaa2_string *);
drmaa2_error drmaa2_lasterror(void);
drmaa2_string drmaa2_lasterror_text(void);
struct drmaa2_list_s; /*forward*/
typedef struct drmaa2_list_s * drmaa2_list;
typedef struct drmaa2_list_s * drmaa2_string_list;
typedef struct drmaa2_list_s * drmaa2_j_list;
typedef struct drmaa2_list_s * drmaa2_queueinfo_list;
typedef struct drmaa2_list_s * drmaa2_machineinfo_list;
typedef struct drmaa2_list_s * drmaa2_slotinfo_list;
typedef struct drmaa2_list_s * drmaa2_r_list;
typedef enum drmaa2_listtype {
DRMAA2_STRINGLIST,
DRMAA2_JOBLIST,
DRMAA2_QUEUEINFOLIST,
DRMAA2_MACHINEINFOLIST,
DRMAA2_SLOTINFOLIST,
DRMAA2_RESERVATIONLIST
} drmaa2_listtype;
typedef void (*drmaa2_list_entryfree)(void **value);
drmaa2_list drmaa2_list_create (const drmaa2_listtype t, const drmaa2_list_entryfree callback);
void drmaa2_list_free ( drmaa2_list * l);
const void * drmaa2_list_get (const drmaa2_list l, long pos);
drmaa2_error drmaa2_list_add ( drmaa2_list l, const void * value);
drmaa2_error drmaa2_list_del ( drmaa2_list l, long pos);
long drmaa2_list_size (const drmaa2_list l);
struct drmaa2_dict_s; /*forward*/
typedef struct drmaa2_dict_s * drmaa2_dict;
typedef void (*drmaa2_dict_entryfree)(char **key, char **val);
drmaa2_dict drmaa2_dict_create (const drmaa2_dict_entryfree callback);
void drmaa2_dict_free ( drmaa2_dict * d);
drmaa2_string_list drmaa2_dict_list (const drmaa2_dict d);
drmaa2_bool drmaa2_dict_has (const drmaa2_dict d, const char * key);
const char * drmaa2_dict_get (const drmaa2_dict d, const char * key);
drmaa2_error drmaa2_dict_del ( drmaa2_dict d, const char * key);
drmaa2_error drmaa2_dict_set ( drmaa2_dict d, const char * key, const char * val);
#define DRMAA2_ZERO_TIME ((time_t) 0)
#define DRMAA2_INFINITE_TIME ((time_t) -1)
#define DRMAA2_NOW ((time_t) -2)
#define DRMAA2_HOME_DIR "$DRMAA2_HOME_DIR$"
#define DRMAA2_WORKING_DIR "$DRMAA2_WORKING_DIR$"
#define DRMAA2_INDEX "$DRMAA2_INDEX$"
#define DRMAA2_UNSET_BOOL DRMAA2_FALSE
#define DRMAA2_UNSET_STRING NULL
#define DRMAA2_UNSET_NUM -1
#define DRMAA2_UNSET_ENUM -1
#define DRMAA2_UNSET_LIST NULL
#define DRMAA2_UNSET_DICT NULL
#define DRMAA2_UNSET_TIME ((time_t) -3)
#define DRMAA2_UNSET_CALLBACK NULL
#define DRMAA2_UNSET_JINFO NULL
typedef struct {
drmaa2_string jobId;
int exitStatus;
drmaa2_string terminatingSignal;
drmaa2_string annotation;
drmaa2_jstate jobState;
drmaa2_string jobSubState;
drmaa2_string_list allocatedMachines;
drmaa2_string submissionMachine;
drmaa2_string jobOwner;
long long slots;
drmaa2_string queueName;
time_t wallclockTime;
long long cpuTime;
time_t submissionTime;
time_t dispatchTime;
time_t finishTime;
} drmaa2_jinfo_s;
typedef drmaa2_jinfo_s * drmaa2_jinfo;
drmaa2_jinfo drmaa2_jinfo_create (void);
void drmaa2_jinfo_free (drmaa2_jinfo * ji);
typedef struct {
drmaa2_string machineName;
long long slots;
} drmaa2_slotinfo_s;
typedef drmaa2_slotinfo_s * drmaa2_slotinfo;
void drmaa2_slotinfo_free (drmaa2_slotinfo * si);
typedef struct {
drmaa2_string reservationId;
drmaa2_string reservationName;
time_t reservedStartTime;
time_t reservedEndTime;
drmaa2_string_list usersACL;
long long reservedSlots;
drmaa2_slotinfo_list reservedMachines;
} drmaa2_rinfo_s;
typedef drmaa2_rinfo_s * drmaa2_rinfo;
void drmaa2_rinfo_free (drmaa2_rinfo * ri);
typedef struct {
drmaa2_string remoteCommand;
drmaa2_string_list args;
drmaa2_bool submitAsHold;
drmaa2_bool rerunnable;
drmaa2_dict jobEnvironment;
drmaa2_string workingDirectory;
drmaa2_string jobCategory;
drmaa2_string_list email;
drmaa2_bool emailOnStarted;
drmaa2_bool emailOnTerminated;
drmaa2_string jobName;
drmaa2_string inputPath;
drmaa2_string outputPath;
drmaa2_string errorPath;
drmaa2_bool joinFiles;
drmaa2_string reservationId;
drmaa2_string queueName;
long long minSlots;
long long maxSlots;
long long priority;
drmaa2_string_list candidateMachines;
long long minPhysMemory;
drmaa2_os machineOS;
drmaa2_cpu machineArch;
time_t startTime;
time_t deadlineTime;
drmaa2_dict stageInFiles;
drmaa2_dict stageOutFiles;
drmaa2_dict resourceLimits;
drmaa2_string accountingId;
} drmaa2_jtemplate_s;
typedef drmaa2_jtemplate_s * drmaa2_jtemplate;
drmaa2_jtemplate drmaa2_jtemplate_create (void);
void drmaa2_jtemplate_free (drmaa2_jtemplate * jt);
typedef struct {
drmaa2_string reservationName;
time_t startTime;
time_t endTime;
time_t duration;
long long minSlots;
long long maxSlots;
drmaa2_string jobCategory;
drmaa2_string_list usersACL;
drmaa2_string_list candidateMachines;
long long minPhysMemory;
drmaa2_os machineOS;
drmaa2_cpu machineArch;
} drmaa2_rtemplate_s;
typedef drmaa2_rtemplate_s * drmaa2_rtemplate;
drmaa2_rtemplate drmaa2_rtemplate_create (void);
void drmaa2_rtemplate_free (drmaa2_rtemplate * rt);
typedef struct {
drmaa2_event event;
drmaa2_string jobId;
drmaa2_string sessionName;
drmaa2_jstate jobState;
} drmaa2_notification_s;
typedef drmaa2_notification_s * drmaa2_notification;
void drmaa2_notification_free (drmaa2_notification * n);
typedef struct {
drmaa2_string name;
} drmaa2_queueinfo_s;
typedef drmaa2_queueinfo_s * drmaa2_queueinfo;
void drmaa2_queueinfo_free (drmaa2_queueinfo * qi);
typedef struct {
drmaa2_string major;
drmaa2_string minor;
} drmaa2_version_s;
typedef drmaa2_version_s * drmaa2_version;
void drmaa2_version_free (drmaa2_version * v);
typedef struct {
drmaa2_string name;
drmaa2_bool available;
long long sockets;
long long coresPerSocket;
long long threadsPerCore;
float load;
long long physMemory;
long long virtMemory;
drmaa2_os machineOS;
drmaa2_version machineOSVersion;
drmaa2_cpu machineArch;
} drmaa2_machineinfo_s;
typedef drmaa2_machineinfo_s * drmaa2_machineinfo;
void drmaa2_machineinfo_free (drmaa2_machineinfo * mi);
drmaa2_string_list drmaa2_jtemplate_impl_spec (void);
drmaa2_string_list drmaa2_jinfo_impl_spec (void);
drmaa2_string_list drmaa2_rtemplate_impl_spec (void);
drmaa2_string_list drmaa2_rinfo_impl_spec (void);
drmaa2_string_list drmaa2_queueinfo_impl_spec (void);
drmaa2_string_list drmaa2_machineinfo_impl_spec (void);
drmaa2_string_list drmaa2_notification_impl_spec (void);
drmaa2_string drmaa2_get_instance_value (const void * instance, const char * name);
drmaa2_string drmaa2_describe_attribute (const void * instance, const char * name);
drmaa2_error drmaa2_set_instance_value ( void * instance, const char * name, const char * value);
typedef void (*drmaa2_callback)(drmaa2_notification * notification);
struct drmaa2_jsession_s; /*forward*/
struct drmaa2_rsession_s; /*forward*/
struct drmaa2_msession_s; /*forward*/
struct drmaa2_j_s; /*forward*/
struct drmaa2_jarray_s; /*forward*/
struct drmaa2_r_s; /*forward*/
typedef struct drmaa2_jsession_s * drmaa2_jsession;
typedef struct drmaa2_rsession_s * drmaa2_rsession;
typedef struct drmaa2_msession_s * drmaa2_msession;
typedef struct drmaa2_j_s * drmaa2_j;
typedef struct drmaa2_jarray_s * drmaa2_jarray;
typedef struct drmaa2_r_s * drmaa2_r;
void drmaa2_jsession_free(drmaa2_jsession * js);
void drmaa2_rsession_free(drmaa2_rsession * rs);
void drmaa2_msession_free(drmaa2_msession * ms);
void drmaa2_j_free (drmaa2_j * j);
void drmaa2_jarray_free (drmaa2_jarray * ja);
void drmaa2_r_free (drmaa2_r * r);
drmaa2_string drmaa2_rsession_get_contact (const drmaa2_rsession rs);
drmaa2_string drmaa2_rsession_get_session_name (const drmaa2_rsession rs);
drmaa2_r drmaa2_rsession_get_reservation (const drmaa2_rsession rs, const drmaa2_string reservationId);
drmaa2_r drmaa2_rsession_request_reservation (const drmaa2_rsession rs, const drmaa2_rtemplate rt);
drmaa2_r_list drmaa2_rsession_get_reservations (const drmaa2_rsession rs);
drmaa2_string drmaa2_r_get_id (const drmaa2_r r);
drmaa2_string drmaa2_r_get_session_name (const drmaa2_r r);
drmaa2_rtemplate drmaa2_r_get_reservation_template (const drmaa2_r r);
drmaa2_rinfo drmaa2_r_get_info (const drmaa2_r r);
drmaa2_error drmaa2_r_terminate (drmaa2_r r);
drmaa2_string drmaa2_jarray_get_id (const drmaa2_jarray ja);
drmaa2_j_list drmaa2_jarray_get_jobs (const drmaa2_jarray ja);
drmaa2_string drmaa2_jarray_get_session_name (const drmaa2_jarray ja);
drmaa2_jtemplate drmaa2_jarray_get_job_template (const drmaa2_jarray ja);
drmaa2_error drmaa2_jarray_suspend (drmaa2_jarray ja);
drmaa2_error drmaa2_jarray_resume (drmaa2_jarray ja);
drmaa2_error drmaa2_jarray_hold (drmaa2_jarray ja);
drmaa2_error drmaa2_jarray_release (drmaa2_jarray ja);
drmaa2_error drmaa2_jarray_terminate (drmaa2_jarray ja);
drmaa2_string drmaa2_jsession_get_contact (const drmaa2_jsession js);
drmaa2_string drmaa2_jsession_get_session_name (const drmaa2_jsession js);
drmaa2_string_list drmaa2_jsession_get_job_categories (const drmaa2_jsession js);
drmaa2_j_list drmaa2_jsession_get_jobs (const drmaa2_jsession js,
const drmaa2_jinfo filter);
drmaa2_jarray drmaa2_jsession_get_job_array (const drmaa2_jsession js,
const drmaa2_string jobarrayId);
drmaa2_j drmaa2_jsession_run_job (const drmaa2_jsession js,
const drmaa2_jtemplate jt);
drmaa2_jarray drmaa2_jsession_run_bulk_jobs (const drmaa2_jsession js,
const drmaa2_jtemplate jt,
unsigned long begin_index,
unsigned long end_index,
unsigned long step,
unsigned long max_parallel);
drmaa2_j drmaa2_jsession_wait_any_started (const drmaa2_jsession js,
const drmaa2_j_list l,
const time_t timeout);
drmaa2_j drmaa2_jsession_wait_any_terminated (const drmaa2_jsession js,
const drmaa2_j_list l,
const time_t timeout);
drmaa2_string drmaa2_j_get_id (const drmaa2_j j);
drmaa2_string drmaa2_j_get_session_name (const drmaa2_j j);
drmaa2_jtemplate drmaa2_j_get_jt (const drmaa2_j j);
drmaa2_error drmaa2_j_suspend (drmaa2_j j);
drmaa2_error drmaa2_j_resume (drmaa2_j j);
drmaa2_error drmaa2_j_hold (drmaa2_j j);
drmaa2_error drmaa2_j_release (drmaa2_j j);
drmaa2_error drmaa2_j_terminate (drmaa2_j j);
drmaa2_jstate drmaa2_j_get_state (const drmaa2_j j, drmaa2_string * substate);
drmaa2_jinfo drmaa2_j_get_info (const drmaa2_j j);
drmaa2_error drmaa2_j_wait_started (const drmaa2_j j, const time_t timeout);
drmaa2_error drmaa2_j_wait_terminated (const drmaa2_j j, const time_t timeout);
drmaa2_r_list drmaa2_msession_get_all_reservations (const drmaa2_msession ms);
drmaa2_j_list drmaa2_msession_get_all_jobs (const drmaa2_msession ms,
const drmaa2_jinfo filter);
drmaa2_queueinfo_list drmaa2_msession_get_all_queues (const drmaa2_msession ms,
const drmaa2_string_list names);
drmaa2_machineinfo_list drmaa2_msession_get_all_machines (const drmaa2_msession ms,
const drmaa2_string_list names);
drmaa2_string drmaa2_get_drms_name (void);
drmaa2_version drmaa2_get_drms_version (void);
drmaa2_string drmaa2_get_drmaa_name (void);
drmaa2_version drmaa2_get_drmaa_version (void);
drmaa2_bool drmaa2_supports (const drmaa2_capability c);
drmaa2_jsession drmaa2_create_jsession (const char * session_name, const char * contact);
drmaa2_rsession drmaa2_create_rsession (const char * session_name, const char * contact);
drmaa2_jsession drmaa2_open_jsession (const char * session_name);
drmaa2_rsession drmaa2_open_rsession (const char * session_name);
drmaa2_msession drmaa2_open_msession (const char * session_name);
drmaa2_error drmaa2_close_jsession (drmaa2_jsession js);
drmaa2_error drmaa2_close_rsession (drmaa2_rsession rs);
drmaa2_error drmaa2_close_msession (drmaa2_msession ms);
drmaa2_error drmaa2_destroy_jsession (const char * session_name);
drmaa2_error drmaa2_destroy_rsession (const char * session_name);
drmaa2_string_list drmaa2_get_jsession_names (void);
drmaa2_string_list drmaa2_get_rsession_names (void);
drmaa2_error drmaa2_register_event_notification (const drmaa2_callback callback);
#if SGE
#include "drmaa2_list_dict.h"
drmaa2_error _drmaa2_err_set (drmaa2_error error, const char *message);
#endif
#endif
|
