1drmaa_jobtemplate(3) Grid Engine DRMAA drmaa_jobtemplate(3)
2
6 drmaa_allocate_job_template, drmaa_delete_job_template,
7 drmaa_set_attribute, drmaa_get_attribute, drmaa_set_vector_attribute,
8 drmaa_get_vector_attribute, drmaa_get_next_attr_value,
9 drmaa_get_num_attr_values, drmaa_release_attr_values - Grid Engine
10 DRMAA job template handling
11
13 #include "drmaa.h"
14 int drmaa_allocate_job_template(
16 drmaa_job_template_t **jt,
17 char *error_diagnosis,
18 size_t error_diag_len
19 );
20 int drmaa_delete_job_template(
22 drmaa_job_template_t *jt,
23 char *error_diagnosis,
24 size_t error_diag_len
25 );
26 int drmaa_set_attribute(
28 drmaa_job_template_t *jt,
29 const char *name,
30 const char *value,
31 char *error_diagnosis,
32 size_t error_diag_len
33 );
34 int drmaa_get_attribute(
36 drmaa_job_template_t *jt,
37 const char *name,
38 char *value,
39 size_t value_len,
40 char *error_diagnosis,
41 size_t error_diag_len
42 );
43 int drmaa_set_vector_attribute(
45 drmaa_job_template_t *jt,
46 const char *name,
47 const char *value[],
48 char *error_diagnosis,
49 size_t error_diag_len
50 );
51 int drmaa_get_vector_attribute(
53 drmaa_job_template_t *jt,
54 const char *name,
55 drmaa_attr_values_t **values,
56 char *error_diagnosis,
57 size_t error_diag_len
58 );
59 int drmaa_get_next_attr_value(
61 drmaa_attr_values_t* values,
62 char *value,
63 int value_len
64 );
65 int drmaa_get_num_attr_values(
67 drmaa_attr_values_t* values,
68 int *size
69 );
70 void drmaa_release_attr_values(
72 drmaa_attr_values_t* values
73 );
74
76 The drmaa_allocate_job_template() function allocates a new DRMAA job
77 template into jt. DRMAA job templates describe specifics of jobs that
78 are submitted using drmaa_run_job(3) and drmaa_run_bulk_jobs(3).
79 drmaa_delete_job_template()
81 The drmaa_delete_job_template() function releases all resources associ‐
82 ated with the DRMAA job template jt. Jobs that were submitted using the
83 job template are not affected.
84 drmaa_set_attribute()
86 The drmaa_set_attribute() function stores the value under name for the
87 given DRMAA job template, jt . Only non-vector attributes may be
88 passed.
89 drmaa_get_attribute()
91 The drmaa_get_attribute() function returns into value up to value_len
92 bytes from the string stored for the non-vector attribute, name, in the
93 DRMAA job template, jt.
94 drmaa_set_vector_attribute()
96 The drmaa_set_vector_attribute() function stores the strings in value
97 under name in the list of vector attributes for the given DRMAA job
98 template, jt . Only vector attributes may be passed. The value pointer
99 array must be NULL terminated.
100 drmaa_get_vector_attribute()
102 The drmaa_get_vector_attribute() function returns into values a DRMAA
103 attribute string vector containing all string values stored in the vec‐
104 tor attribute, name. The values in the DRMAA values string vector can
105 be extracted using drmaa_get_next_attr_value(3). The caller is respon‐
106 sible for releasing the DRMAA values string vector returned into values
107 using drmaa_release_attr_values(3).
108 drmaa_get_next_attr_value()
110 Each time drmaa_get_next_attr_value() is called it returns into value
111 up to value_len bytes of the next entry stored in the DRMAA values
112 string vector, values. Once the values list has been exhausted,
113 DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.
114 drmaa_get_num_attr_values()
116 The drmaa_get_num_attr_values() returns into size the number of entries
117 in the DRMAA values string vector. This function is only available in
118 the 1.0 implementation.
119 drmaa_release_attr_values()
121 The drmaa_release_attr_values() function releases all resources associ‐
122 ated with the DRMAA values string vector, values.
123
125 GE_ROOT Specifies the location of the Grid Engine standard con‐
126 figuration files.
127 GE_CELL If set, specifies the default Grid Engine cell to be
129 used. To address a Grid Engine cell Grid Engine uses (in
130 the order of precedence):
131 The name of the cell specified in the environment
133 variable GE_CELL, if it is set.
134 The name of the default cell, i.e. default.
136 GE_DEBUG_LEVEL If set, specifies that debug information should be writ‐
139 ten to stderr. In addition the level of detail in which
140 debug information is generated is defined.
141 GE_QMASTER_PORT
143 If set, specifies the tcp port on which ge_qmaster(8) is
144 expected to listen for communication requests. Most
145 installations will use a services map entry instead to
146 define that port.
147
149 Upon successful completion, drmaa_allocate_job_template(),
150 drmaa_delete_job_template(), drmaa_set_attribute(),
151 drmaa_get_attribute(), drmaa_set_vector_attribute(), drmaa_get_vec‐
152 tor_attribute(), and drmaa_get_next_attr_value() return
153 DRMAA_ERRNO_SUCCESS. Other values indicate an error. Up to
154 error_diag_len characters of error related diagnosis information is
155 then provided in the buffer error_diagnosis.
156
158 The drmaa_allocate_job_template(), drmaa_delete_job_template(),
159 drmaa_set_attribute(), drmaa_get_attribute(), drmaa_set_vec‐
160 tor_attribute(), drmaa_get_vector_attribute(), and
161 drmaa_get_next_attr_value() functions will fail if:
162 DRMAA_ERRNO_INTERNAL_ERROR
164 Unexpected or internal DRMAA error, like system call failure, etc.
165 DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
167 Could not contact DRM system for this request.
168 DRMAA_ERRNO_AUTH_FAILURE
170 The specified request is not processed successfully due to authoriza‐
171 tion failure.
172 DRMAA_ERRNO_INVALID_ARGUMENT
174 The input value for an argument is invalid.
175 DRMAA_ERRNO_NO_ACTIVE_SESSION
177 Failed because there is no active session.
178 DRMAA_ERRNO_NO_MEMORY
180 Failed allocating memory.
181 The drmaa_set_attribute() and drmaa_set_vector_attribute() will fail
183 if:
184 DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT
186 The format for the attribute value is invalid.
187 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
189 The value for the attribute is invalid.
190 DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES
192 The value of this attribute is conflicting with a previously set
193 attributes.
194 The drmaa_get_attribute() and drmaa_get_vector_attribute() will fail
196 if:
197 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
199 The specified attribute is not set in the DRMAA job template.
200 The drmaa_get_next_attr_value() will fail if:
202 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
204 When there are no more entries in the vector.
205
207 drmaa_submit(3)and drmaa_attributes(3).
208GE 6.2u5 $Date: 2008/07/08 09:10:04 $ drmaa_jobtemplate(3)