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 Univa Grid Engine job with attributes
defined in the DRMAA job template, jt. On success up to job_id_len
bytes of the job identifier are returned into the buffer, job_id.
drmaa_run_bulk_jobs()
The drmaa_run_bulk_jobs() submits a Univa Grid Engine array job very
much as if the qsub(1) option `-t start-end:incr' had been used along
with the additional attributes defined in the DRMAA job template, jt.
The same constraints regarding value ranges are also in effect for the
parameters start, end, and incr as for qsub(5) -t. On success a DRMAA
job id string vector containing job identifiers for each array job task
is returned into jobids. The job identifiers in the job id string vec-
drmaa_get_num_job_ids()
The drmaa_get_num_job_ids() returns into size 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 associ-
ated with the DRMAA job id string vector, values. This operation has no
effect on the actual Univa Grid Engine array job tasks.
ENVIRONMENTAL VARIABLES
SGE_ROOT Specifies the location of the Univa Grid Engine standard
configuration files.
SGE_CELL If set, specifies the default Univa Grid Engine cell to
be used. To address a Univa Grid Engine cell Univa 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 writ-
ten 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 sge_qmaster(8)
is expected to listen for communication 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 indi-
cate an error. Up to error_diag_len characters of error related diag-
nosis information is then provided in the buffer error_diagnosis.
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.
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
drmaa_attributes(3), drmaa_jobtemplate(3).
UGE 8.0.0 $Date: 2008/07/08 09:10:05 $ drmaa_submit(3)
Man(1) output converted with
man2html