drmaa_misc(3)

1drmaa_misc(3)                  Grid Engine DRMAA                 drmaa_misc(3)
2
3
4

NAME

6       drmaa_strerror,  drmaa_get_contact, drmaa_version, drmaa_get_DRM_system
7       - Miscellaneous DRMAA functions.
8

SYNOPSIS

10       #include "drmaa.h"
11
12       const char *drmaa_strerror(
13              int drmaa_errno
14       );
15
16       int drmaa_get_contact(
17              char *contact,
18              size_t contact_len,
19              char *error_diagnosis,
20              size_t error_diag_len
21       );
22
23       int drmaa_version(
24              unsigned int *major,
25              unsigned int *minor,
26              char *error_diagnosis,
27              size_t error_diag_len
28       );
29
30       int drmaa_get_DRM_system(
31              char *drm_system,
32              size_t drm_system_len,
33              char *error_diagnosis,
34              size_t error_diag_len
35       );
36
37       int drmaa_get_DRMAA_implementation(
38              char *drm_impl,
39              size_t drm_impl_len,
40              char *error_diagnosis,
41              size_t error_diag_len
42       );
43

DESCRIPTION

45       The drmaa_strerror() function returns a message  text  associated  with
46       the  DRMAA  error  number,  drmaa_errno.  For invalid DRMAA error codes
47       `NULL' is returned.
48
49   drmaa_get_contact()
50       The drmaa_get_contact() returns an  opaque  string  containing  contact
51       information  related  to  the current DRMAA session to be used with the
52       drmaa_init(3) function. In the 1.0 implementation,  the  opaque  string
53       contains  the  information required by drmaa_init() to reconnect to the
54       current session instead of creating a new session. In the  0.95  imple‐
55       mentation,  however,  the drmaa_get_contact() function returns an empty
56       string, and the contact parameter has no effect  on  the  drmaa_init(3)
57       function.
58
59       The  drmaa_get_contact()  function  returns  the  same value before and
60       after drmaa_init(3) is called.
61
62   drmaa_version()
63       The drmaa_version() function returns into the integers  pointed  to  by
64       major  and  minor,  the  major  and  minor version numbers of the DRMAA
65       library.  For a DRMAA 1.0 compliant implementation `1' and `0' will  be
66       returned in major and minor, respectively.
67
68   drmaa_get_DRM_system()
69       The  drmaa_get_DRM_system()  function  returns  into  drm_system  up to
70       drm_system_len characters of a string containing  Grid  Engine  product
71       and version information.
72
73       The  drmaa_get_DRM_system()  function returns the same value before and
74       after drmaa_init(3) is called.
75
76   drmaa_get_DRMAA_implementation()
77       The drmaa_get_DRMAA_implementation() function returns  into  drm_system
78       up  to drm_system_len characters of a string containing the Grid Engine
79       DRMAA implementation version information.  In the  current  implementa‐
80       tion,  the  drmaa_get_DRMAA_implementation()  function returns the same
81       result as the drmaa_get_DRM_system() function.
82
83       The drmaa_get_DRMAA_implementation() function returns  the  same  value
84       before and after drmaa_init(3) is called.
85

ENVIRONMENTAL VARIABLES

87       SGE_ROOT       Specifies  the location of the Grid Engine standard con‐
88                      figuration files.
89
90       SGE_CELL       If set, specifies the default Grid  Engine  cell  to  be
91                      used. To address a Grid Engine cell Grid Engine uses (in
92                      the order of precedence):
93
94                             The name of the cell specified in the environment
95                             variable SGE_CELL, if it is set.
96
97                             The name of the default cell, i.e. default.
98
99
100       SGE_DEBUG_LEVEL
101                      If set, specifies that debug information should be writ‐
102                      ten to stderr. In addition the level of detail in  which
103                      debug information is generated is defined.
104
105       SGE_QMASTER_PORT
106                      If  set,  specifies the tcp port on which sge_qmaster(8)
107                      is expected to listen for communication requests.   Most
108                      installations  will  use a services map entry instead to
109                      define that port.
110

RETURN VALUES

112       Upon successful completion, drmaa_get_contact(),  drmaa_version(),  and
113       drmaa_get_DRM_system()  return  DRMAA_ERRNO_SUCCESS. Other values indi‐
114       cate an error.  Up to error_diag_len characters of error related  diag‐
115       nosis information is then provided in the buffer error_diagnosis.
116

ERRORS

118       The  drmaa_get_contact(),  drmaa_version(), drmaa_get_DRM_system(), and
119       drmaa_get_DRMAA_implementation() will fail if:
120
121   DRMAA_ERRNO_INTERNAL_ERROR
122       Unexpected or internal DRMAA error, like system call failure, etc.
123
124   DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
125       Could not contact DRM system for this request.
126
127   DRMAA_ERRNO_AUTH_FAILURE
128       The specified request is not processed successfully due  to  authoriza‐
129       tion failure.
130
131   DRMAA_ERRNO_INVALID_ARGUMENT
132       The input value for an argument is invalid.
133
134   DRMAA_ERRNO_NO_MEMORY
135       Failed allocating memory.
136
137       The drmaa_get_contact() and drmaa_get_DRM_system() will fail if:
138
139   DRMAA_ERRNO_NO_ACTIVE_SESSION
140       Failed because there is no active session.
141

NAME

SYNOPSIS

DESCRIPTION

ENVIRONMENTAL VARIABLES

RETURN VALUES

ERRORS

SEE ALSO