1drmaa_misc(3) Grid Engine DRMAA drmaa_misc(3)
2
6 drmaa_strerror, drmaa_get_contact, drmaa_version, drmaa_get_DRM_system
7 - Miscellaneous DRMAA functions.
8
10 #include "drmaa.h"
11 const char *drmaa_strerror(
13 int drmaa_errno
14 );
15 int drmaa_get_contact(
17 char *contact,
18 size_t contact_len,
19 char *error_diagnosis,
20 size_t error_diag_len
21 );
22 int drmaa_version(
24 unsigned int *major,
25 unsigned int *minor,
26 char *error_diagnosis,
27 size_t error_diag_len
28 );
29 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 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
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 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. The opaque string contains the information
53 required by drmaa_init() to reconnect to the current session instead of
54 creating a new session. drmaa_init(3) function.
55 The drmaa_get_contact() function returns the same value before and
57 after drmaa_init(3) is called.
58 drmaa_version()
60 The drmaa_version() function returns into the integers pointed to by
61 major and minor, the major and minor version numbers of the DRMAA
62 library. For a DRMAA 1.0 compliant implementation `1' and `0' will be
63 returned in major and minor, respectively.
64 drmaa_get_DRM_system()
66 The drmaa_get_DRM_system() function returns into drm_system up to
67 drm_system_len characters of a string containing Grid Engine product
68 and version information.
69 The drmaa_get_DRM_system() function returns the same value before and
71 after drmaa_init(3) is called.
72 drmaa_get_DRMAA_implementation()
74 The drmaa_get_DRMAA_implementation() function returns into drm_system
75 up to drm_system_len characters of a string containing the Grid Engine
76 DRMAA implementation version information. In the current implementa‐
77 tion, the drmaa_get_DRMAA_implementation() function returns the same
78 result as the drmaa_get_DRM_system() function.
79 The drmaa_get_DRMAA_implementation() function returns the same value
81 before and after drmaa_init(3) is called.
82
84 GE_ROOT Specifies the location of the Grid Engine standard con‐
85 figuration files.
86 GE_CELL If set, specifies the default Grid Engine cell to be
88 used. To address a Grid Engine cell Grid Engine uses (in
89 the order of precedence):
90 The name of the cell specified in the environment
92 variable GE_CELL, if it is set.
93 The name of the default cell, i.e. default.
95 GE_DEBUG_LEVEL If set, specifies that debug information should be writ‐
98 ten to stderr. In addition the level of detail in which
99 debug information is generated is defined.
100 GE_QMASTER_PORT
102 If set, specifies the tcp port on which ge_qmaster(8) is
103 expected to listen for communication requests. Most
104 installations will use a services map entry instead to
105 define that port.
106
108 Upon successful completion, drmaa_get_contact(), drmaa_version(), and
109 drmaa_get_DRM_system() return DRMAA_ERRNO_SUCCESS. Other values indi‐
110 cate an error. Up to error_diag_len characters of error related diag‐
111 nosis information is then provided in the buffer error_diagnosis.
112
114 The drmaa_get_contact(), drmaa_version(), drmaa_get_DRM_system(), and
115 drmaa_get_DRMAA_implementation() will fail if:
116 DRMAA_ERRNO_INTERNAL_ERROR
118 Unexpected or internal DRMAA error, like system call failure, etc.
119 DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
121 Could not contact DRM system for this request.
122 DRMAA_ERRNO_AUTH_FAILURE
124 The specified request is not processed successfully due to authoriza‐
125 tion failure.
126 DRMAA_ERRNO_INVALID_ARGUMENT
128 The input value for an argument is invalid.
129 DRMAA_ERRNO_NO_MEMORY
131 Failed allocating memory.
132 The drmaa_get_contact() and drmaa_get_DRM_system() will fail if:
134 DRMAA_ERRNO_NO_ACTIVE_SESSION
136 Failed because there is no active session.
137
139 drmaa_session(3).
140GE 6.2u5 $Date: 2008/07/08 09:10:04 $ drmaa_misc(3)