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
|
<HTML>
<BODY BGCOLOR=white>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
NAME
drmaa_run_job, drmaa_run_bulk_jobs, drmaa_get_next_job_id,
drmaa_get_num_job_ids, drmaa_release_job_ids - Job submis-
sion
SYNOPSIS
#include "drmaa.h"
int drmaa_run_job(
char *job_id,
size_t job_id_len,
drmaa_job_template_t *jt,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_run_bulk_jobs(
drmaa_job_ids_t **jobids,
drmaa_job_template_t *jt,
int start,
int end,
int incr,
char *error_diagnosis,
size_t error_diag_len
);
int drmaa_get_next_job_id(
drmaa_job_ids_t* values,
char *value,
int value_len
);
int drmaa_get_num_job_ids(
drmaa_job_ids_t* values,
int *size
);
void drmaa_release_job_ids(
drmaa_job_ids_t* values
);
DESCRIPTION
drmaa_run_job() submits an Sun Grid Engine job with attri-
butes defined in the DRMAA job template, <I>jt</I>. On success up
to <I>job</I>_<I>id</I>_<I>len</I> bytes of the job identifier are returned into
the buffer, <I>job</I>_<I>id</I>.
drmaa_run_bulk_jobs()
The drmaa_run_bulk_jobs() submits a Sun Grid Engine array
job very much as if the <B><A HREF="../htmlman1/qsub.html?pathrev=V62u5_TAG">qsub(1)</A></B> option `-t <I>start</I>-<I>end</I>:<I>incr</I>'
had been used along with the additional attributes defined
in the DRMAA job template, <I>jt</I>. The same constraints
regarding value ranges are also in effect for the parameters
<I>start</I>, <I>end</I>, and <I>incr</I> as for <B><A HREF="../htmlman5/qsub.html?pathrev=V62u5_TAG">qsub(5)</A></B> -t. On success a DRMAA
job id string vector containing job identifiers for each
array job task is returned into <I>jobids</I>. The job identifiers
in the job id string vector can be extracted using
<B><A HREF="../htmlman3/drmaa_get_next_job_id.html?pathrev=V62u5_TAG">drmaa_get_next_job_id(3)</A></B>. The number of identifiers in the
job id string vector can be determined using
<B><A HREF="../htmlman3/drmaa_get_num_job_ids.html?pathrev=V62u5_TAG">drmaa_get_num_job_ids(3)</A></B>. Note that this function is only
available in the 1.0 implementation. The caller is respon-
sible for releasing the job id string vector returned into
<I>jobids</I> using <B><A HREF="../htmlman3/drmaa_release_job_ids.html?pathrev=V62u5_TAG">drmaa_release_job_ids(3)</A></B>.
drmaa_get_next_job_id()
Each time drmaa_get_next_job_id() 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 job id string vector, <I>values</I>. Once the
job ids list has been exhausted,
DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.
drmaa_get_num_job_ids()
The drmaa_get_num_job_ids() returns into <I>size</I> the number of
entries in the DRMAA job ids string vector. This function
is only available in the 1.0 implementation.
drmaa_release_job_ids()
The drmaa_release_attr_job_id() function releases all
resources associated with the DRMAA job id string vector,
<I>values</I>. This operation has no effect on the actual Sun Grid
Engine array job tasks.
ENVIRONMENTAL VARIABLES
SGE_ROOT Specifies the location of the Sun Grid Engine
standard configuration files.
SGE_CELL If set, specifies the default Sun Grid Engine
cell to be used. To address a Sun Grid Engine
cell Sun Grid Engine uses (in the order of
precedence):
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?pathrev=V62u5_TAG">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_run_job(),
drmaa_run_bulk_jobs(), and drmaa_get_next_job_id() 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 infor-
mation is then provided in the buffer <I>error</I>_<I>diagnosis</I>.
ERRORS
The drmaa_run_job(), drmaa_run_bulk_jobs(), and
drmaa_get_next_job_id() 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_run_job() and drmaa_run_bulk_jobs() functions will
fail if:
DRMAA_ERRNO_TRY_LATER
The DRM system indicated that it is too busy to accept the
job. A retry may succeed, however.
DRMAA_ERRNO_DENIED_BY_DRM
The DRM system rejected the job. The job will never be
accepted due to DRM configuration or job template settings.
The drmaa_get_next_job_id() will fail if:
DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
When there are no more entries in the vector.
SEE ALSO
<B><A HREF="../htmlman3/drmaa_attributes.html?pathrev=V62u5_TAG">drmaa_attributes(3)</A></B>, <B><A HREF="../htmlman3/drmaa_jobtemplate.html?pathrev=V62u5_TAG">drmaa_jobtemplate(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>
|
