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. With the DRMAA 1.0 library, once the values
113 list has been exhausted, DRMAA_ERRNO_NO_MORE_ELEMENTS is returned.
114 With the DRMAA 0.95 library, once the values list has been exhausted,
115 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned. In order to use the
116 DRMAA 0.95 library, you must define the DRMAA_95 macro, either in your
117 application directly or through a compiler flag, such as -DDRMAA_95.
118 drmaa_get_num_attr_values()
120 The drmaa_get_num_attr_values() returns into size the number of entries
121 in the DRMAA values string vector. This function is only available in
122 the 1.0 implementation.
123 drmaa_release_attr_values()
125 The drmaa_release_attr_values() function releases all resources associ‐
126 ated with the DRMAA values string vector, values.
127
129 SGE_ROOT Specifies the location of the Grid Engine standard con‐
130 figuration files.
131 SGE_CELL If set, specifies the default Grid Engine cell to be
133 used. To address a Grid Engine cell Grid Engine uses (in
134 the order of precedence):
135 The name of the cell specified in the environment
137 variable SGE_CELL, if it is set.
138 The name of the default cell, i.e. default.
140 SGE_DEBUG_LEVEL
143 If set, specifies that debug information should be writ‐
144 ten to stderr. In addition the level of detail in which
145 debug information is generated is defined.
146 SGE_QMASTER_PORT
148 If set, specifies the tcp port on which sge_qmaster(8)
149 is expected to listen for communication requests. Most
150 installations will use a services map entry instead to
151 define that port.
152
154 Upon successful completion, drmaa_allocate_job_template(),
155 drmaa_delete_job_template(), drmaa_set_attribute(),
156 drmaa_get_attribute(), drmaa_set_vector_attribute(), drmaa_get_vec‐
157 tor_attribute(), and drmaa_get_next_attr_value() return
158 DRMAA_ERRNO_SUCCESS. Other values indicate an error. Up to
159 error_diag_len characters of error related diagnosis information is
160 then provided in the buffer error_diagnosis.
161
163 The drmaa_allocate_job_template(), drmaa_delete_job_template(),
164 drmaa_set_attribute(), drmaa_get_attribute(), drmaa_set_vec‐
165 tor_attribute(), drmaa_get_vector_attribute(), and
166 drmaa_get_next_attr_value() functions will fail if:
167 DRMAA_ERRNO_INTERNAL_ERROR
169 Unexpected or internal DRMAA error, like system call failure, etc.
170 DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
172 Could not contact DRM system for this request.
173 DRMAA_ERRNO_AUTH_FAILURE
175 The specified request is not processed successfully due to authoriza‐
176 tion failure.
177 DRMAA_ERRNO_INVALID_ARGUMENT
179 The input value for an argument is invalid.
180 DRMAA_ERRNO_NO_ACTIVE_SESSION
182 Failed because there is no active session.
183 DRMAA_ERRNO_NO_MEMORY
185 Failed allocating memory.
186 The drmaa_set_attribute() and drmaa_set_vector_attribute() will fail
188 if:
189 DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT
191 The format for the attribute value is invalid.
192 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
194 The value for the attribute is invalid.
195 DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES
197 The value of this attribute is conflicting with a previously set
198 attributes.
199 The drmaa_get_attribute() and drmaa_get_vector_attribute() will fail
201 if:
202 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
204 The specified attribute is not set in the DRMAA job template.
205 The drmaa_get_next_attr_value() will fail if:
207 DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
209 When there are no more entries in the vector.
210
212 drmaa_submit(3)and drmaa_attributes(3).
213GE 6.1 $Date: 2007/01/20 07:18:23 $ drmaa_jobtemplate(3)