← Back to branch summary

~ubuntu-branches/ubuntu/utopic/gridengine/utopic

« back to all changes in this revision

Viewing changes to doc/htmlman/htmlman3/drmaa_release_job_ids.html

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2008-06-25 22:36:13 UTC
  • Revision ID: james.westby@ubuntu.com-20080625223613-tvd9xlhuoct9kyhm
Tags: upstream-6.2~beta2
Import upstream version 6.2~beta2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/htmlman/htmlman3/drmaa_release_job_ids.html
 
1
<HTML>
 
2
<BODY BGCOLOR=white>
 
3
<PRE>
 
4
<!-- Manpage converted by man2html 3.0.1 -->
 
5
NAME
 
6
     drmaa_run_job,  drmaa_run_bulk_jobs,  drmaa_get_next_job_id,
 
7
     drmaa_get_num_job_ids,  drmaa_release_job_ids  - Job submis-
 
8
     sion
 
9
 
 
10
SYNOPSIS
 
11
     #include "drmaa.h"
 
12
 
 
13
     int drmaa_run_job(
 
14
          char *job_id,
 
15
          size_t job_id_len,
 
16
          drmaa_job_template_t *jt,
 
17
          char *error_diagnosis,
 
18
          size_t error_diag_len
 
19
     );
 
20
 
 
21
     int drmaa_run_bulk_jobs(
 
22
          drmaa_job_ids_t **jobids,
 
23
          drmaa_job_template_t *jt,
 
24
          int start,
 
25
          int end,
 
26
          int incr,
 
27
          char *error_diagnosis,
 
28
          size_t error_diag_len
 
29
     );
 
30
 
 
31
     int drmaa_get_next_job_id(
 
32
          drmaa_job_ids_t* values,
 
33
          char *value,
 
34
          int value_len
 
35
     );
 
36
 
 
37
     int drmaa_get_num_job_ids(
 
38
          drmaa_job_ids_t* values,
 
39
          int *size
 
40
     );
 
41
 
 
42
     void drmaa_release_job_ids(
 
43
          drmaa_job_ids_t* values
 
44
     );
 
45
 
 
46
DESCRIPTION
 
47
     drmaa_run_job() submits an Grid Engine job  with  attributes
 
48
     defined  in  the  DRMAA  job  template, <I>jt</I>. On success up to
 
49
     <I>job</I>_<I>id</I>_<I>len</I> bytes of the job identifier are returned into the
 
50
     buffer, <I>job</I>_<I>id</I>.
 
51
 
 
52
  drmaa_run_bulk_jobs()
 
53
     The drmaa_run_bulk_jobs() submits a Grid  Engine  array  job
 
54
     very  much  as if the <B><A HREF="../htmlman1/qsub.html">qsub(1)</A></B> option `-t <I>start</I>-<I>end</I>:<I>incr</I>' had
 
55
     been used along with the additional  attributes  defined  in
 
56
     the  DRMAA job template, <I>jt</I>.  The same constraints regarding
 
57
     value ranges are also in effect for  the  parameters  <I>start</I>,
 
58
     <I>end</I>,  and  <I>incr</I> as for <B><A HREF="../htmlman5/qsub.html">qsub(5)</A></B> -t. On success a DRMAA job id
 
59
     string vector containing job identifiers for each array  job
 
60
     task is returned into <I>jobids</I>. The job identifiers in the job
 
61
     id    string    vector    can     be     extracted     using
 
62
     <B><A HREF="../htmlman3/drmaa_get_next_job_id.html">drmaa_get_next_job_id(3)</A></B>.   The number of identifiers in the
 
63
     job   id   string   vector   can   be    determined    using
 
64
     <B><A HREF="../htmlman3/drmaa_get_num_job_ids.html">drmaa_get_num_job_ids(3)</A></B>.   Note  that this function is only
 
65
     available in the 1.0 implementation.  The caller is  respon-
 
66
     sible  for  releasing the job id string vector returned into
 
67
     <I>jobids</I> using <B><A HREF="../htmlman3/drmaa_release_job_ids.html">drmaa_release_job_ids(3)</A></B>.
 
68
 
 
69
  drmaa_get_next_job_id()
 
70
     Each time drmaa_get_next_job_id() is called it returns  into
 
71
     the  buffer,  <I>value</I>, up to <I>value</I>_<I>len</I> bytes of the next entry
 
72
     stored in the DRMAA job id string vector, <I>values</I>.  With  the
 
73
     DRMAA 1.0 library, once the job ids list has been exhausted,
 
74
     DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.   With  the  DRMAA
 
75
     0.95  library,  once  the  job  ids list has been exhausted,
 
76
     DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned.   In  order
 
77
     to  use the DRMAA 0.95 library, you must define the DRMAA_95
 
78
     macro, either in your application directly or through a com-
 
79
     piler flag, such as -DDRMAA_95.
 
80
 
 
81
  drmaa_get_num_job_ids()
 
82
     The drmaa_get_num_job_ids() returns into <I>size</I> the number  of
 
83
     entries  in  the DRMAA job ids string vector.  This function
 
84
     is only available in the 1.0 implementation.
 
85
 
 
86
  drmaa_release_job_ids()
 
87
     The  drmaa_release_attr_job_id()   function   releases   all
 
88
     resources  associated  with  the DRMAA job id string vector,
 
89
     <I>values</I>. This operation has no  effect  on  the  actual  Grid
 
90
     Engine array job tasks.
 
91
 
 
92
ENVIRONMENTAL VARIABLES
 
93
     SGE_ROOT       Specifies the location  of  the  Grid  Engine
 
94
                    standard configuration files.
 
95
 
 
96
     SGE_CELL       If set, specifies  the  default  Grid  Engine
 
97
                    cell  to  be  used.  To address a Grid Engine
 
98
                    cell Grid Engine uses (in the order  of  pre-
 
99
                    cedence):
 
100
 
 
101
                         The name of the cell  specified  in  the
 
102
                         environment  variable SGE_CELL, if it is
 
103
                         set.
 
104
 
 
105
                         The  name  of  the  default  cell,  i.e.
 
106
                         default.
 
107
 
 
108
 
 
109
     SGE_DEBUG_LEVEL
 
110
                    If  set,  specifies  that  debug  information
 
111
                    should  be written to stderr. In addition the
 
112
                    level of detail in which debug information is
 
113
                    generated is defined.
 
114
 
 
115
     SGE_QMASTER_PORT
 
116
                    If set,  specifies  the  tcp  port  on  which
 
117
                    <B><A HREF="../htmlman8/sge_qmaster.html">sge_qmaster(8)</A></B> is expected to listen for com-
 
118
                    munication requests.  Most installations will
 
119
                    use  a  services  map entry instead to define
 
120
                    that port.
 
121
 
 
122
RETURN VALUES
 
123
     Upon      successful      completion,       drmaa_run_job(),
 
124
     drmaa_run_bulk_jobs(),  and  drmaa_get_next_job_id()  return
 
125
     DRMAA_ERRNO_SUCCESS. Other values indicate an error.  Up  to
 
126
     <I>error</I>_<I>diag</I>_<I>len</I>  characters of error related diagnosis infor-
 
127
     mation is then provided in the buffer <I>error</I>_<I>diagnosis</I>.
 
128
 
 
129
ERRORS
 
130
     The     drmaa_run_job(),     drmaa_run_bulk_jobs(),      and
 
131
     drmaa_get_next_job_id() will fail if:
 
132
 
 
133
  DRMAA_ERRNO_INTERNAL_ERROR
 
134
     Unexpected  or  internal  DRMAA  error,  like  system   call
 
135
     failure, etc.
 
136
 
 
137
  DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
 
138
     Could not contact DRM system for this request.
 
139
 
 
140
  DRMAA_ERRNO_AUTH_FAILURE
 
141
     The specified request is not processed successfully  due  to
 
142
     authorization failure.
 
143
 
 
144
  DRMAA_ERRNO_INVALID_ARGUMENT
 
145
     The input value for an argument is invalid.
 
146
 
 
147
  DRMAA_ERRNO_NO_ACTIVE_SESSION
 
148
     Failed because there is no active session.
 
149
 
 
150
  DRMAA_ERRNO_NO_MEMORY
 
151
     Failed allocating memory.
 
152
 
 
153
     The drmaa_run_job() and drmaa_run_bulk_jobs() functions will
 
154
     fail if:
 
155
 
 
156
  DRMAA_ERRNO_TRY_LATER
 
157
     The DRM system indicated that it is too busy to  accept  the
 
158
     job. A retry may succeed, however.
 
159
 
 
160
 
 
161
  DRMAA_ERRNO_DENIED_BY_DRM
 
162
     The DRM system rejected the  job.  The  job  will  never  be
 
163
     accepted due to DRM configuration or job template settings.
 
164
 
 
165
     The drmaa_get_next_job_id() will fail if:
 
166
 
 
167
  DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
 
168
     When there are no more entries in the vector.
 
169
 
 
170
SEE ALSO
 
171
     <B><A HREF="../htmlman3/drmaa_attributes.html">drmaa_attributes(3)</A></B>, <B><A HREF="../htmlman3/drmaa_jobtemplate.html">drmaa_jobtemplate(3)</A></B>.
 
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
</PRE>
 
214
<HR>
 
215
<ADDRESS>
 
216
Man(1) output converted with
 
217
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 
218
</ADDRESS>
 
219
</BODY>
 
220
</HTML>