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

drmaa_get_vector_attribute, drmaa_get_next_attr_value, drmaa_get_num_attr_values, drmaa_release_attr_values \- xxQS_NAMExx DRMAA job template handling

.PP

.\"

.SH SYNOPSIS

.B #include """drmaa.h"""

.PP

.\"

.nf

\fBint drmaa_allocate_job_template(\fB

.RS

\fBdrmaa_job_template_t **jt,\fB

\fBchar *error_diagnosis,\fB

\fBsize_t error_diag_len\fB

.RE

.fi

\fB);\fB

.PP

.nf

\fBint drmaa_delete_job_template(\fB

.RS

\fBdrmaa_job_template_t *jt,\fB

\fBchar *error_diagnosis,\fB

\fBsize_t error_diag_len\fB

.RE

.fi

\fB);\fB

.PP

.nf

\fBint drmaa_set_attribute(\fB

.RS

\fBdrmaa_job_template_t *jt,\fB

\fBconst char *name,\fB

\fBconst char *value,\fB

\fBchar *error_diagnosis,\fB

\fBsize_t error_diag_len\fB

.RE

.fi

\fB);\fB

.PP

.nf

\fBint drmaa_get_attribute(\fB

.RS

\fBdrmaa_job_template_t *jt,\fB

\fBconst char *name,\fB

\fBchar *value,\fB

\fBsize_t value_len,\fB

\fBchar *error_diagnosis,

\fBsize_t error_diag_len\fB

.RE

.fi

\fB);\fB

.PP

.nf

\fBint drmaa_set_vector_attribute(\fB

.RS

\fBdrmaa_job_template_t *jt,\fB

\fBconst char *name,\fB

\fBconst char *value[],\fB

\fBchar *error_diagnosis,\fB

\fBsize_t error_diag_len\fB

.RE

.fi

\fB);\fB

.PP

.nf

\fBint drmaa_get_vector_attribute(\fB

.RS

\fBdrmaa_job_template_t *jt,\fB

\fBconst char *name,\fB

\fBdrmaa_attr_values_t **values,\fB

\fBchar *error_diagnosis,\fB

\fBsize_t error_diag_len\fB

.RE

.fi

\fB);\fB

100

.PP

101

.nf

102

\fBint drmaa_get_next_attr_value(\fB

103

.RS

104

\fBdrmaa_attr_values_t* values,\fB

105

\fBchar *value,\fB

106

\fBint value_len

107

.RE

108

.fi

109

\fB);\fB

110

.PP

111

.nf

112

\fBint drmaa_get_num_attr_values(\fB

113

.RS

114

\fBdrmaa_attr_values_t* values,\fB

115

\fBint *size\fB

116

.RE

117

.fi

118

);\fB

119

.PP

120

.nf

121

\fBvoid drmaa_release_attr_values(\fB

122

.RS

123

\fBdrmaa_attr_values_t* values

124

.RE

125

.fi

126

\fB);\fB

127

.PP

128

.nf

129

.\"

130

.\"

131

.\"

132

.SH DESCRIPTION

133

The drmaa_allocate_job_template() function allocates a new DRMAA job template

134

into \fIjt\fP. DRMAA job templates describe specifics of jobs that are submitted

135

using

136

.M drmaa_run_job 3

137

and

138

.M drmaa_run_bulk_jobs 3 .

139

.\"

140

.SS "drmaa_delete_job_template()"

141

The drmaa_delete_job_template() function releases all resources associated

142

with the DRMAA job template \fIjt\fP. Jobs that were submitted using the job

143

template are not affected.

144

.PP

145

.\"

146

.SS "drmaa_set_attribute()"

147

The drmaa_set_attribute() function stores the \fIvalue\fP under \fIname\fP

148

for the given DRMAA job template, \fIjt\fP . Only non-vector attributes may be

149

passed.

150

.PP

151

.\"

152

.SS "drmaa_get_attribute()"

153

The drmaa_get_attribute() function returns into \fIvalue\fP up to \fIvalue_len\fP

154

bytes from the string stored for the non-vector attribute, \fIname\fP, in the

155

DRMAA job template, \fIjt\fP.

156

.PP

157

.\"

158

.SS "drmaa_set_vector_attribute()"

159

The drmaa_set_vector_attribute() function stores the strings in \fIvalue\fP under

160

\fIname\fP in the list of vector attributes for the given DRMAA job template,

161

\fIjt\fP . Only vector attributes may be passed. The \fIvalue\fP pointer array

162

must be \fINULL\fP terminated.

163

.PP

164

.\"

165

.SS "drmaa_get_vector_attribute()"

166

The drmaa_get_vector_attribute() function returns into \fIvalues\fP a DRMAA attribute

167

string vector containing all string values stored in the vector attribute, \fIname\fP.

168

The values in the DRMAA values string vector can be extracted using

169

.M drmaa_get_next_attr_value 3 .

170

The caller is responsible for releasing the DRMAA values string

171

vector returned into \fIvalues\fP using

172

.M drmaa_release_attr_values 3 .

173

.PP

174

.\"

175

.SS "drmaa_get_next_attr_value()"

176

Each time drmaa_get_next_attr_value() is called it returns into \fIvalue\fP up to \fIvalue_len\fP

177

bytes of the next entry stored in the DRMAA values string vector, \fIvalues\fP.

178

With the DRMAA 1.0 library, once the values list has been exhausted,

179

DRMAA_ERRNO_NO_MORE_ELEMENTS is returned. With the DRMAA 0.95 library, once the values list

180

has been exhausted, DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned. In order

181

to use the DRMAA 0.95 library, you must define the DRMAA_95 macro, either in your

182

application directly or through a compiler flag, such as -DDRMAA_95.

183

.PP

184

.\"

185

.SS "drmaa_get_num_attr_values()"

186

The drmaa_get_num_attr_values() returns into \fIsize\fP the number of entries

187

in the DRMAA values string vector. This function is only available in the 1.0

188

implementation.

189

.PP

190

.\"

191

.SS "drmaa_release_attr_values()"

192

The drmaa_release_attr_values() function releases all resources associated with the DRMAA values

193

string vector, \fIvalues\fP.

194

.PP

195

.\"

196

.\"

197

.\"

198

.SH "ENVIRONMENTAL VARIABLES"

199

.\"

200

.IP "\fBxxQS_NAME_Sxx_ROOT\fP" 1.5i

201

Specifies the location of the xxQS_NAMExx standard configuration files.

202

.\"

203

.IP "\fBxxQS_NAME_Sxx_CELL\fP" 1.5i

204

If set, specifies the default xxQS_NAMExx cell to be used. To address a xxQS_NAMExx

205

cell xxQS_NAMExx uses (in the order of precedence):

206

.sp 1

207

.RS

208

.RS

209

The name of the cell specified in the environment

210

variable xxQS_NAME_Sxx_CELL, if it is set.

211

.sp 1

212

The name of the default cell, i.e. \fBdefault\fP.

213

.sp 1

214

.RE

215

.RE

216

.\"

217

.IP "\fBxxQS_NAME_Sxx_DEBUG_LEVEL\fP" 1.5i

218

If set, specifies that debug information

219

should be written to stderr. In addition the level of

220

detail in which debug information is generated is defined.

221

.\"

222

.IP "\fBxxQS_NAME_Sxx_QMASTER_PORT\fP" 1.5i

223

If set, specifies the tcp port on which

224

.M xxqs_name_sxx_qmaster 8

225

is expected to listen for communication requests.

226

Most installations will use a services map entry instead

227

to define that port.

228

.\"

229

.\"

230

.\"

231

.SH "RETURN VALUES"

232

Upon successful completion, drmaa_allocate_job_template(), drmaa_delete_job_template(),

233

drmaa_set_attribute(), drmaa_get_attribute(), drmaa_set_vector_attribute(),

234

drmaa_get_vector_attribute(), and drmaa_get_next_attr_value()

235

return DRMAA_ERRNO_SUCCESS. Other values indicate an error.

236

Up to \fIerror_diag_len\fP characters of error related diagnosis

237

information is then provided in the buffer \fIerror_diagnosis\fP.

238

.PP

239

.\"

240

.\"

241

.\"

242

.SH "ERRORS"

243

The drmaa_allocate_job_template(), drmaa_delete_job_template(),

244

drmaa_set_attribute(), drmaa_get_attribute(), drmaa_set_vector_attribute(),

245

drmaa_get_vector_attribute(), and drmaa_get_next_attr_value()

246

functions will fail if:

247

.\"

248

.SS "DRMAA_ERRNO_INTERNAL_ERROR"

249

Unexpected or internal DRMAA error, like system call failure, etc.

250

.\"

251

.SS "DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE"

252

Could not contact DRM system for this request.

253

.\"

254

.SS "DRMAA_ERRNO_AUTH_FAILURE"

255

The specified request is not processed successfully due to authorization failure.

256

.\"

257

.SS "DRMAA_ERRNO_INVALID_ARGUMENT"

258

The input value for an argument is invalid.

259

.\"

260

.SS "DRMAA_ERRNO_NO_ACTIVE_SESSION"

261

Failed because there is no active session.

262

.\"

263

.SS "DRMAA_ERRNO_NO_MEMORY"

264

Failed allocating memory.

265

.\"

266

.PP

267

The drmaa_set_attribute() and drmaa_set_vector_attribute() will fail if:

268

.SS "DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT"

269

The format for the attribute value is invalid.

270

.\"

271

.SS "DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE"

272

The value for the attribute is invalid.

273

.\"

274

.SS "DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES"

275

The value of this attribute is conflicting with a previously set attributes.

276

.\"

277

.PP

278

The drmaa_get_attribute() and drmaa_get_vector_attribute() will fail if:

279

.SS "DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE"

280

The specified attribute is not set in the DRMAA job template.

281

.\"

282

.PP

283

The drmaa_get_next_attr_value() will fail if:

284

.SS "DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE"

285

When there are no more entries in the vector.

286

.\"

287

.PP

288

.\"

289

.\"

290

.\"

291

.SH "SEE ALSO"

292

.M drmaa_submit 3 and

293

.M drmaa_attributes 3 .

Older »