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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
|
<HTML>
<BODY BGCOLOR=white>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
NAME
drmaa_get_attribute_names, drmaa_get_vector_attribute_names,
drmaa_get_next_attr_name, drmaa_get_num_attr_names,
drmaa_release_attr_names - DRMAA job template attributes
SYNOPSIS
#include "drmaa.h"
int drmaa_get_attribute_names(
drmaa_attr_names_t **values,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_get_vector_attribute_names(
drmaa_attr_names_t **values,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_get_next_attr_name(
drmaa_attr_names_t* values,
char *value,
int value_len
);
int drmaa_get_next_attr_value(
drmaa_attr_values_t* values,
char *value,
int value_len
);
int drmaa_get_num_attr_names(
drmaa_attr_names_t* values,
int *size
);
void drmaa_release_attr_names(
drmaa_attr_names_t* values
);
DESCRIPTION
The drmaa_get_attribute_names() function returns into <I>values</I>
a DRMAA names string vector containing the set of supported
non-vector DRMAA job template attribute names. The set
includes supported DRMAA reserved attribute names and Grid
Engine native attribute names. The names in the names string
vector can be extracted using <B><A HREF="../htmlman3/drmaa_get_next_attr_name.html">drmaa_get_next_attr_name(3)</A></B>.
The number of names in the names string vector can be deter-
mined using <B><A HREF="../htmlman3/drmaa_get_num_attr_names.html">drmaa_get_num_attr_names(3)</A></B>. Note that this
function is only available in the 1.0 implementation. The
caller is responsible for releasing the names string vector
returned into <I>values</I> using <B><A HREF="../htmlman3/drmaa_release_attr_names.html">drmaa_release_attr_names(3)</A></B>. Use
<B><A HREF="../htmlman3/drmaa_set_attribute.html">drmaa_set_attribute(3)</A></B> and <B><A HREF="../htmlman3/drmaa_get_attribute.html">drmaa_get_attribute(3)</A></B> for set-
ting and inspecting non-vector attributes.
drmaa_get_vector_attribute_names()
The drmaa_get_vector_attribute_names() function returns into
<I>values</I> a DRMAA names string vector containing the set of
supported vector DRMAA job template attribute names. The set
includes supported DRMAA reserved attribute names and Grid
Engine native attribute names. The names in the names string
vector can be extracted using <B><A HREF="../htmlman3/drmaa_get_next_attr_name.html">drmaa_get_next_attr_name(3)</A></B>.
The caller is responsible for releasing the names string
vector returned into <I>values</I> using
<B><A HREF="../htmlman3/drmaa_release_attr_names.html">drmaa_release_attr_names(3)</A></B>. Use
<B><A HREF="../htmlman3/drmaa_set_vector_attribute.html">drmaa_set_vector_attribute(3)</A></B> and
<B><A HREF="../htmlman3/drmaa_get_vector_attribute.html">drmaa_get_vector_attribute(3)</A></B> for setting and inspecting
vector attributes.
drmaa_get_next_attr_name()
Each time drmaa_get_next_attr_name() is called it returns
into the buffer, <I>value</I>, up to <I>value</I>_<I>len</I> bytes of the next
entry stored in the DRMAA names string vector, <I>values</I>. With
the DRMAA 1.0 library, once the names list has been
exhausted, DRMAA_ERRNO_NO_MORE_ELEMENTS is returned. With
the DRMAA 0.95 library, once the names list has been
exhausted, DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned.
In order to use the DRMAA 0.95 library, you must define the
DRMAA_95 macro, either in your application directly or
through a compiler flag, such as -DDRMAA_95.
drmaa_get_num_attr_names()
The drmaa_get_num_attr_names() returns into <I>size</I> the number
of entries in the DRMAA names string vector. This function
is only available in the 1.0 implementation.
drmaa_release_attr_names()
The drmaa_release_attr_names() function releases all
resources associated with the DRMAA names string vector,
<I>values</I>.
Attribute Priorities
DRMAA job template attributes can be set from six different
sources. In order of precedence, from lowest to highest,
these are: options set by DRMAA automatically by default,
options set in the <B><A HREF="../htmlman5/sge_request.html">sge_request(5)</A></B> file(s), options set in
the script file, options set by the drmaa_job_category
attribute, options set by the drmaa_native_specification
attribute, and options set through other DRMAA attributes.
By default DRMAA sets four options for all jobs. These are
"-p 0", "-b yes", "-shell no", and "-w e". This means that
by default, all jobs will have priority 0, all jobs will be
treated as binary, i.e. no scripts args will be parsed, all
jobs will be executed without a wrapper shell, and jobs
which are unschedulable will cause a submit error.
The <B><A HREF="../htmlman5/sge_request.html">sge_request(5)</A></B> file, found in the
$SGE_ROOT/$SGE_CELL/common directory, may contain options to
be applied to all jobs. The .sge_request file found in the
user's home directory or the current working directory may
also contain options to be applied to certain jobs. See
<B><A HREF="../htmlman5/sge_request.html">sge_request(5)</A></B> for more information.
If the <B><A HREF="../htmlman5/sge_request.html">sge_request(5)</A></B> file contains "-b no" or if the
drmaa_native_specification attribute is set and contains "-b
no", the script file will be parsed for in-line arguments.
Otherwise, no scripts args will be interpreted. See <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B>
for more information.
If the drmaa_job_category attribute is set, and the category
it points to exists in one of the <B><A HREF="../htmlman5/qtask.html">qtask(5)</A></B> files, the
options associated with that category will be applied to the
job template. See <B><A HREF="../htmlman5/qtask.html">qtask(5)</A></B> and the drmaa_job_category
attribute below for more information.
If the drmaa_native_specification attribute is set, all
options contained therein will be applied to the job tem-
plate. See the drmaa_native_specification below for more
information.
Other DRMAA attributes will override any previous settings.
For example, if the sge_request file contains "-j y", but
the drmaa_join_files attribute is set to "n", the ultimate
result is that the input and output files will remain
separate.
For various reasons, some options are silently ignored by
DRMAA. Setting any of these options will have no effect.
The ignored options are: -cwd, -help, -t, -verify, -w w, and
-w v. The -cwd option can be reenabled by setting the
environment variable, SGE_DRMAA_ALLOW_CWD. However, the
-cwd option is not thread safe and should not be used in a
multi-threaded context.
Attribute Correlations
The following DRMAA attributes correspond to the following
<B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> options:
DRMAA Attribute qsub Option
-------------------------------------------------------
drmaa_remote_command script file
drmaa_v_argv script file args
drmaa_js_state = "drmaa_hold" -h
drmaa_v_env -v
drmaa_wd = $PWD -cwd
drmaa_job_category (qtsch qtask)*
drmaa_native_specification ALL*
drmaa_v_email -M
drmaa_block_email = "1" -m n
drmaa_start_time -a
drmaa_job_name -N
drmaa_input_path -i
drmaa_output_path -o
drmaa_error_path -e
drmaa_join_files -j
drmaa_transfer_files (prolog and epilog)*
* See the individual attribute description below
DRMAA JOB TEMPLATE ATTRIBUTES
drmaa_remote_command - "<remote_command>"
Specifies the remote command to execute. The <I>remote</I>_<I>command</I>
must be the path of an executable that is available at the
job's execution host. If the path is relative, it is
assumed to be relative to the working directory, usually set
through the drmaa_wd attribute. If working directory is not
set, the path is assumed to be relative to the user's home
directory.
The file pointed to by remote_command may either be an exe-
cutable binary or an executable script. If a script, it
must include the path to the shell in a #! line at the
beginning of the script. By default, the remote command
will be executed directly, as by <B><A HREF="../htmlman2/exec.html">exec(2)</A></B>. To have the
remote command executed in a shell, such as to preserve
environment settings, use the drmaa_native_specification
attribute to include the "-shell yes" option. Jobs which
are executed by a wrapper shell fail differently from jobs
which are executed directly. When a job which contains a
user error, such as an invalid path to the executable, is
executed by a wrapper shell, the job will execute success-
fully, but exit with a return code of 1. When a job which
contains such an error is executed directly, it will enter
the DRMAA_PS_FAILED state upon execution.
drmaa_js_state - "{drmaa_hold|drmaa_active}"
Specifies the job state at submission. The string values
'drmaa_hold' and 'drmaa_active' are supported. When
'drmaa_active' is used the job is submitted in a runnable
state. When 'drmaa_hold' is used the job is submitted in
user hold state (either DRMAA_PS_USER_ON_HOLD or
DRMAA_PS_USER_SYSTEM_ON_HOLD). This attribute is largely
equivalent to the <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> submit option '-h'.
drmaa_wd - "<directory_name>"
Specifies the directory name where the job will be executed.
A '$drmaa_hd_ph$' placeholder at the beginning of the
<I>directory</I>_<I>name</I> denotes the remaining string portion as a
relative directory name that is resolved relative to the job
user's home directory at the execution host. When the DRMAA
job template is used for bulk job submission (see also
<B><A HREF="../htmlman3/drmaa_run_bulk_job.html">drmaa_run_bulk_job(3)</A></B>) the '$drmaa_incr_ph$' placeholder can
be used at any position within <I>directory</I>_<I>name</I> to cause a
substitution with the parametric job's index. The
<I>directory</I>_<I>name</I> must be specified in a syntax that is common
at the host where the job is executed. If set to a relative
path and no placeholder is used, a path relative to the
user's home directory is assumed. If not set, the working
directory will default to the user's home directory. If set
and the given directory does not exist the job will enter
the DRMAA_PS_FAILED state when run.
Note that the working directory path is the path on the exe-
cution host. If binary mode is disabled, an attempt to find
the job script will be made, relative to the working direc-
tory path. That means that the path to the script must be
the same on both the submission and execution hosts.
drmaa_job_name - "<job_name>"
Specifies the job's name. Setting the job name is equivalent
to use of <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> submit option '-N' with <I>job</I>_<I>name</I> as option
argument.
drmaa_input_path - "[<hostname>]:<file_path>"
Specifies the standard input of the job. Unless set else-
where, if not explicitly set in the job template, the job is
started with an empty input stream. If the standard input is
set it specifies the network path of the job's input stream
file.
When the 'drmaa_transfer_files' job template attribute is
supported and contains the character 'i', the input file
will be fetched by Grid Engine from the specified host or
from the submit host if no <I>hostname</I> is specified. When the
'drmaa_transfer_files' job template attribute is not sup-
ported or does not contain the character 'i', the input file
is always expected at the host where the job is executed
regardless of any <I>hostname</I> specified.
If the DRMAA job template will be used for bulk job submis-
sion, (See also <B><A HREF="../htmlman3/drmaa_run_bulk_job.html">drmaa_run_bulk_job(3)</A></B>) the '$drmaa_incr_ph$'
placeholder can be used at any position within <I>file</I>_<I>path</I> to
cause a substitution with the parametric job's index. A
'$drmaa_hd_ph$' placeholder at the beginning of <I>file</I>_<I>path</I>
denotes the remaining portion of the <I>file</I>_<I>path</I> as a relative
file specification resolved relative to the job user's home
directory at the host where the file is located. A
'$drmaa_wd_ph$' placeholder at the beginning of <I>file</I>_<I>path</I>
denotes the remaining portion of the <I>file</I>_<I>path</I> as a relative
file specification resolved relative to the job's working
directory at the host where the file is located. The
<I>file</I>_<I>path</I> must be specified in a syntax that is common at
the host where the file is located. If set and the file
can't be read the job enters the state DRMAA_PS_FAILED.
drmaa_output_path - "[<hostname>]:<file_path>"
Specifies the standard output of the job. If not explicitly
set in the job template, the whereabouts of the job's output
stream is not defined. If set, this attribute specifies the
network path of the job's output stream file.
When the 'drmaa_transfer_files' job template attribute is
supported and contains the character 'o', the output file
will be transferred by Grid Engine to the specified host or
to the submit host if no <I>hostname</I> is specified. When the
'drmaa_transfer_files' job template attribute is not sup-
ported or does not contain the character 'o', the output
file is always kept at the host where the job is executed
regardless of any <I>hostname</I> specified.
If the DRMAA job template will be used for of bulk job sub-
mission (see also <B><A HREF="../htmlman3/drmaa_run_bulk_job.html">drmaa_run_bulk_job(3)</A></B>) the
'$drmaa_incr_ph$' placeholder can be used at any position
within the <I>file</I>_<I>path</I> to cause a substitution with the
parametric job's index. A '$drmaa_hd_ph$' placeholder at the
beginning of <I>file</I>_<I>path</I> denotes the remaining portion of the
<I>file</I>_<I>path</I> as a relative file specification resolved relative
to the job user's home directory at the host where the file
is located. A '$drmaa_wd_ph$' placeholder at the beginning
of the <I>file</I>_<I>path</I> denotes the remaining portion of <I>file</I>_<I>path</I>
as a relative file specification resolved relative to the
job's working directory at the host where the file is
located. The <I>file</I>_<I>path</I> must be specified in a syntax that is
common at the host where the file is located. If set and the
file can't be written before execution the job enters the
state DRMAA_PS_FAILED.
drmaa_error_path - "[<hostname>]:<file_path>"
Specifies the standard error of the job. If not explicitly
set in the job template, the whereabouts of the job's error
stream is not defined. If set, this attribute specifies the
network path of the job's error stream file.
When the 'drmaa_transfer_files' job template attribute is
supported and contains the character 'e', the output file
will be transferred by Grid Engine to the specified host or
to the submit host if no <I>hostname</I> is specified. When the
'drmaa_transfer_files' job template attribute is not sup-
ported or does not contain the character 'e', the error file
is always kept at the host where the job is executed
regardless of any <I>hostname</I> specified.
If the DRMAA job template will be used for of bulk job sub-
mission (see also <B><A HREF="../htmlman3/drmaa_run_bulk_job.html">drmaa_run_bulk_job(3)</A></B>) the
'$drmaa_incr_ph$' placeholder can be used at any position
within the <I>file</I>_<I>path</I> to cause a substitution with the
parametric job's index. A '$drmaa_hd_ph$' placeholder at the
beginning of the <I>file</I>_<I>path</I> denotes the remaining portion of
the <I>file</I>_<I>path</I> as a relative file specification resolved
relative to the job user's home directory at the host where
the file is located. A '$drmaa_wd_ph$' placeholder at the
beginning of the <I>file</I>_<I>path</I> denotes the remaining portion of
the <I>file</I>_<I>path</I> as a relative file specification resolved
relative to the job's working directory at the host where
the file is located. The <I>file</I>_<I>path</I> must be specified in a
syntax that is common at the host where the file is located.
If set and the file can't be written before execution the
job enters the state DRMAA_PS_FAILED. The attribute name is
drmaa_error_path.
drmaa_join_files - "{y|n}"
Specifies if the job's error stream should be intermixed
with the output stream. If not explicitly set in the job
template the attribute defaults to 'n'. Either 'y' or 'n'
can be specified. If 'y' is specified Grid Engine will
ignore the value of the 'drmaa_error_path' job template
attribute and intermix the standard error stream with the
standard output stream as specified with
'drmaa_output_path'.
drmaa_v_argv - "argv1 argv2 ..."
Specifies the arguments to the job.
drmaa_job_category - "<category>"
Specifies the DRMAA job category. The <I>category</I> string is
used by Grid Engine as a reference into the <B><A HREF="../htmlman5/qtask.html">qtask(5)</A></B> file.
Certain <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> options used in the referenced qtask file
line are applied to the job template before submission to
allow site-specific resolving of resources and/or policies.
The cluster qtask file, the local qtask file, and the user
qtask file are searched. Job settings resulting from job
template category are overridden by settings resulting from
the job template drmaa_native_specification attribute as
well as by explicit DRMAA job template settings.
In order to avoid collisions with command names in the qtask
files, it is recommended that DRMAA job category names take
the form: <category_name>.cat.
The options -help, -t, -verify, and -w w|v are ignored. The
-cwd option is ignored unless the $SGE_DRMAA_ALLOW_CWD
environment variable is set.
drmaa_native_specification - "<native_specification>"
Specifies Grid Engine native <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> options which will be
interpreted as part of the DRMAA job template. All options
available to <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> command may be used in the
<I>native</I>_<I>specification</I>, except for -help, -t, -verify, and -w
w|v. The -cwd option may only be used if the
SGE_DRMAA_ALLOW_CWD environment variable is set. This is
because the current parsing algorithm for -cwd is not
thread-safe. Options set in the <I>native</I> <I>specification</I> will
be overridden by the corresponding DRMAA attributes. See
<B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> for more information on qsub options.
drmaa_v_env - "<name1>=<value1> <name2>=<value2> ...
Specifies the job environment. Each environment <I>value</I>
defines the remote environment. The <I>value</I> overrides the
remote environment values if there is a collision.
drmaa_v_email - "<email1> <email2> ...
Specifies e-mail addresses that are used to report the job
completion and status.
drmaa_block_email - "{0|1}"
Specifies whether e-mail sending shall blocked or not. By
default email is not sent. If, however, a setting in a
cluster or user settings file or the email in association
with job events, the 'drmaa_block_email' attribute will
override that setting, causing no email to be sent.
drmaa_start_time - "[[[[CC]YY/]MM/]DD] hh:mm[:ss] [{-|+}UU:uu]"
Specifies the earliest time when the job may be eligible to
be run where
CC is the first two digits of the year (century-1)
YY is the last two digits of the year
MM is the two digits of the month [01,12]
DD is the two digit day of the month [01,31]
hh is the two digit hour of the day [00,23]
mm is the two digit minute of the day [00,59]
ss is the two digit second of the minute [00,61]
UU is the two digit hours since (before) UTC
uu is the two digit minutes since (before) UTC
If the optional UTC-offset is not specified, the offset
associated with the local timezone will be used. If the day
(DD) is not specified, the current day will be used unless
the specified hour:mm:ss has already elapsed, in which case
the next day will be used. Similarly for month (MM), year
(YY), and century-1 (CC). Example: The time: Sep 3 4:47:27
PM PDT 2002, could be represented as: 2002/09/03 16:47:27
-07:00.
drmaa_transfer_files - "[i][o][e]"
Specifies, which of the standard I/O files (stdin, stdout
and stderr) are to be transferred to/from the execution
host. If not set, defaults to "". Any combination of 'e',
'i' and 'o' may be specified. See drmaa_input_path,
drmaa_output_path and drmaa_error_path for information about
how to specify the standard input file, standard output file
and standard error file. The file transfer mechanism itself
must be configured by the administrator (see <B><A HREF="../htmlman5/sge_conf.html">sge_conf(5)</A></B> ).
When it is configured, the administrator has to enable
drmaa_transfer_files. If it is not configured,
"drmaa_transfer_files" is not enabled and can't be used.
ENVIRONMENTAL VARIABLES
SGE_DRMAA_ALLOW_CWD
Enables the parsing of the -cwd option from
the sge_request file(s), job category, and/or
the native specification attribute. This
option is disabled by default because the
algorithm for parsing the -cwd option is not
thread-safe.
SGE_ROOT Specifies the location of the Grid Engine
standard configuration files.
SGE_CELL If set, specifies the default Grid Engine
cell to be used. To address a Grid Engine
cell Grid Engine uses (in the order of pre-
cedence):
The name of the cell specified in the
environment variable SGE_CELL, if it is
set.
The name of the default cell, i.e.
default.
SGE_DEBUG_LEVEL
If set, specifies that debug information
should be written to stderr. In addition the
level of detail in which debug information is
generated is defined.
SGE_QMASTER_PORT
If set, specifies the tcp port on which
<B><A HREF="../htmlman8/sge_qmaster.html">sge_qmaster(8)</A></B> is expected to listen for com-
munication requests. Most installations will
use a services map entry instead to define
that port.
RETURN VALUES
Upon successful completion, drmaa_get_attribute_names(),
drmaa_get_vector_attribute_names(), and
drmaa_get_next_attr_name() return DRMAA_ERRNO_SUCCESS. Other
values indicate an error. Up to <I>error</I>_<I>diag</I>_<I>len</I> characters
of error related diagnosis information is then provided in
the buffer <I>error</I>_<I>diagnosis</I>.
ERRORS
The drmaa_get_attribute_names(),
drmaa_get_vector_attribute_names(), and
drmaa_get_next_attr_name() functions will fail if:
DRMAA_ERRNO_INTERNAL_ERROR
Unexpected or internal DRMAA error, like system call
failure, etc.
DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
Could not contact DRM system for this request.
DRMAA_ERRNO_AUTH_FAILURE
The specified request is not processed successfully due to
authorization failure.
DRMAA_ERRNO_INVALID_ARGUMENT
The input value for an argument is invalid.
DRMAA_ERRNO_NO_ACTIVE_SESSION
Failed because there is no active session.
DRMAA_ERRNO_NO_MEMORY
Failed allocating memory.
The drmaa_get_next_attr_name() will fail if:
DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
When there are no more entries in the vector.
SEE ALSO
<B><A HREF="../htmlman3/drmaa_jobtemplate.html">drmaa_jobtemplate(3)</A></B>and <B><A HREF="../htmlman3/drmaa_submit.html">drmaa_submit(3)</A></B>.
</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>
|
