forked from openpmix/openpmix
-
Notifications
You must be signed in to change notification settings - Fork 0
/
EXCEPTIONS
351 lines (301 loc) · 17.2 KB
/
EXCEPTIONS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
Exceptions to the base PMIx Standard are listed here for each OpenPMIx release. These exceptions
are not indicative of any intent to stray from the Standard, but instead represent the difference
between the pace of development of the library versus the normal Standard's process. Accordingly,
it is expected that the exceptions listed below will make their way into a future release of the
PMIx Standard and then be removed from the list of exceptions in some future OpenPMIx release.
==========================================================================================
OpenPMIx master branch
---------------------------------
OpenPMIx master branch is based on the PMIx v4.1 Standard and includes the following EXTENSIONS:
APIs
------
PMIx_Data_embed - Embed a data payload into a buffer.
Constants
------------
PMIX_DATA_BUFFER - data type for packing/unpacking of pmix_data_buffer_t objects
PMIX_DISK_STATS - data type for packing/unpacking of pmix_disk_stats_t objects
PMIX_NET_STATS - data type for packing/unpacking of pmix_net_stats_t objects
PMIX_NODE_STATS - data type for packing/unpacking of pmix_node_stats_t objects
PMIX_PROC_STATS - data type for packing/unpacking of pmix_proc_stats_t objects
PMIX_ERR_JOB_EXE_NOT_FOUND - specified executable not found
PMIX_ERR_JOB_INSUFFICIENT_RESOURCES - insufficient resources to spawn job
PMIX_ERR_JOB_SYS_OP_FAILED - system library operation failed
PMIX_ERR_JOB_WDIR_NOT_FOUND - specified working directory not found
PMIX_READY_FOR_DEBUG - event indicating job/proc is ready for debug (accompanied by PMIX_BREAKPOINT indicating where proc is waiting)
PMIX_STOR_ACCESS - data type for packing/unpacking of pmix_storage_accessibility_t values
PMIX_STOR_ACCESS_TYPE - data type for packing/unpacking of pmix_storage_access_type_t objects
PMIX_STOR_MEDIUM - data type for packing/unpacking of pmix_storage_medium_t objects
PMIX_STOR_PERSIST - data type for packing/unpacking of pmix_storage_persistence_t objects
Attributes
------------
PMIX_BREAKPOINT "pmix.brkpnt" // (char*) string ID of the breakpoint where the process(es) is(are) waiting
PMIX_DEBUG_STOP_IN_APP "pmix.dbg.notify" // (varies) direct specified ranks to stop at application-specific point and
// notify ready-to-debug. Can be any of three data types:
// (a) bool - true indicating all ranks, false indicating none
// (b) pmix_rank_t - the rank of one proc, or WILDCARD for all
// (c) a pmix_data_array_t if an array of individual processes
// are specified
PMIX_ENVARS_HARVESTED "pmix.evar.hvstd" // (bool) Envars have been harvested by the spawn requestor
PMIX_IOF_FILE_ONLY "pmix.iof.fonly" // (bool) output only into designated files - do not also output
// a copy to stdout/stderr
PMIX_IOF_FILE_PATTERN "pmix.iof.fpt" // (bool) Specified output file is to be treated as a pattern and not
// automatically annotated by nspace, rank, or other parameters
PMIX_IOF_LOCAL_OUTPUT "pmix.iof.local" // (bool) Write output streams to local stdout/err
PMIX_IOF_MERGE_STDERR_STDOUT "pmix.iof.mrg" // (bool) merge stdout and stderr streams from application procs
PMIX_IOF_OUTPUT_TO_DIRECTORY "pmix.iof.dir" // (char*) direct application output into files of form
// "<directory>/<jobid>/rank.<rank>/stdout[err]"
PMIX_IOF_OUTPUT_TO_FILE "pmix.iof.file" // (char*) direct application output into files of form
// "<filename>.rank" with both stdout and stderr redirected into it
PMIX_IOF_RANK_OUTPUT "pmix.iof.rank" // (bool) Tag output with the rank it came from
PMIX_NODE_OVERSUBSCRIBED "pmix.ndosub" // (bool) true if number of procs from this job on this node
// exceeds the number of slots allocated to it
PMIX_SINGLETON "pmix.singleton" // (char*) String representation (nspace.rank) of proc ID for the singleton
// the server was started to support
PMIX_JOB_TIMEOUT "pmix.job.time" // (int) time in sec before job should time out (0 => infinite)
PMIX_SPAWN_TIMEOUT "pmix.sp.time" // (int) time in sec before spawn operation should time out (0 => infinite)
// Logically equivalent to passing the PMIX_TIMEOUT attribute to the
// PMIx_Spawn API, it is provided as a separate attribute to distinguish
// it from the PMIX_JOB_TIMEOUT attribute
PMIX_LOCAL_COLLECTIVE_STATUS "pmix.loc.col.st" // (pmix_status_t) status code for local collective operation bei>
// reported to host by server library
Datatypes
------------
pmix_disk_stats_t - contains statistics on disk read/write operations
pmix_net_stats_t - contains statistics on network activity
pmix_node_stats_t - contains statistics on node resource usage
pmix_proc_stats_t - contains statistics on process resource usage
Macros
---------
PMIX_VALUE_XFER_DIRECT - directly transfer a pmix_value_t to another one (non-destructive copy)
PMIX_XFER_PROCID - transfer a pmix_proc_t to another one (non-destructive copy)
- Macros supporting pmix_disk_stats_t objects
PMIX_DISK_STATS_CONSTRUCT
PMIX_DISK_STATS_CREATE
PMIX_DISK_STATS_DESTRUCT
PMIX_DISK_STATS_FREE
PMIX_DISK_STATS_RELEASE
- Macros supporting pmix_net_stats_t objects
PMIX_NET_STATS_CONSTRUCT
PMIX_NET_STATS_CREATE
PMIX_NET_STATS_DESTRUCT
PMIX_NET_STATS_FREE
PMIX_NET_STATS_RELEASE
- Macros supporting pmix_node_stats_t objects
PMIX_NODE_STATS_CONSTRUCT
PMIX_NODE_STATS_CREATE
PMIX_NODE_STATS_DESTRUCT
PMIX_NODE_STATS_RELEASE
- Macros supporting pmix_proc_stats_t objects
PMIX_PROC_STATS_CONSTRUCT
PMIX_PROC_STATS_CREATE
PMIX_PROC_STATS_DESTRUCT
PMIX_PROC_STATS_FREE
PMIX_PROC_STATS_RELEASE
OpenPMIx master branch renamed one constant:
Constants
------------
PMIX_DEBUG_WAIT_FOR_NOTIFY - renamed to PMIX_READY_FOR_DEBUG
==========================================================================================
OpenPMIx v4.1.1
---------------------------------
OpenPMIx v4.1.1 is based on the PMIx v4.1 Standard and includes the following EXTENSIONS:
APIs
------
PMIx_Data_embed - Embed a data payload into a buffer.
Constants
------------
PMIX_DATA_BUFFER - data type for packing/unpacking of pmix_data_buffer_t objects
PMIX_DISK_STATS - data type for packing/unpacking of pmix_disk_stats_t objects
PMIX_NET_STATS - data type for packing/unpacking of pmix_net_stats_t objects
PMIX_NODE_STATS - data type for packing/unpacking of pmix_node_stats_t objects
PMIX_PROC_STATS - data type for packing/unpacking of pmix_proc_stats_t objects
PMIX_ERR_JOB_EXE_NOT_FOUND - specified executable not found
PMIX_ERR_JOB_INSUFFICIENT_RESOURCES - insufficient resources to spawn job
PMIX_ERR_JOB_SYS_OP_FAILED - system library operation failed
PMIX_ERR_JOB_WDIR_NOT_FOUND - specified working directory not found
PMIX_READY_FOR_DEBUG - event indicating job/proc is ready for debug (accompanied by PMIX_BREAKPOINT indicating where proc is waiting)
Attributes
------------
PMIX_BREAKPOINT "pmix.brkpnt" // (char*) string ID of the breakpoint where the process(es) is(are) waiting
PMIX_DEBUG_STOP_IN_APP "pmix.dbg.notify" // (varies) direct specified ranks to stop at application-specific point and
// notify ready-to-debug. Can be any of three data types:
// (a) bool - true indicating all ranks, false indicating none
// (b) pmix_rank_t - the rank of one proc, or WILDCARD for all
// (c) a pmix_data_array_t if an array of individual processes
// are specified
PMIX_ENVARS_HARVESTED "pmix.evar.hvstd" // (bool) Envars have been harvested by the spawn requestor
PMIX_IOF_FILE_ONLY "pmix.iof.fonly" // (bool) output only into designated files - do not also output
// a copy to stdout/stderr
PMIX_IOF_FILE_PATTERN "pmix.iof.fpt" // (bool) Specified output file is to be treated as a pattern and not
// automatically annotated by nspace, rank, or other parameters
PMIX_IOF_LOCAL_OUTPUT "pmix.iof.local" // (bool) Write output streams to local stdout/err
PMIX_IOF_MERGE_STDERR_STDOUT "pmix.iof.mrg" // (bool) merge stdout and stderr streams from application procs
PMIX_IOF_OUTPUT_TO_DIRECTORY "pmix.iof.dir" // (char*) direct application output into files of form
// "<directory>/<jobid>/rank.<rank>/stdout[err]"
PMIX_IOF_OUTPUT_TO_FILE "pmix.iof.file" // (char*) direct application output into files of form
// "<filename>.rank" with both stdout and stderr redirected into it
PMIX_IOF_RANK_OUTPUT "pmix.iof.rank" // (bool) Tag output with the rank it came from
PMIX_NODE_OVERSUBSCRIBED "pmix.ndosub" // (bool) true if number of procs from this job on this node
// exceeds the number of slots allocated to it
Datatypes
------------
pmix_disk_stats_t - contains statistics on disk read/write operations
pmix_net_stats_t - contains statistics on network activity
pmix_node_stats_t - contains statistics on node resource usage
pmix_proc_stats_t - contains statistics on process resource usage
Macros
---------
PMIX_VALUE_XFER_DIRECT - directly transfer a pmix_value_t to another one (non-destructive copy)
PMIX_XFER_PROCID - transfer a pmix_proc_t to another one (non-destructive copy)
- Macros supporting pmix_disk_stats_t objects
PMIX_DISK_STATS_CONSTRUCT
PMIX_DISK_STATS_CREATE
PMIX_DISK_STATS_DESTRUCT
PMIX_DISK_STATS_FREE
PMIX_DISK_STATS_RELEASE
- Macros supporting pmix_net_stats_t objects
PMIX_NET_STATS_CONSTRUCT
PMIX_NET_STATS_CREATE
PMIX_NET_STATS_DESTRUCT
PMIX_NET_STATS_FREE
PMIX_NET_STATS_RELEASE
- Macros supporting pmix_node_stats_t objects
PMIX_NODE_STATS_CONSTRUCT
PMIX_NODE_STATS_CREATE
PMIX_NODE_STATS_DESTRUCT
PMIX_NODE_STATS_RELEASE
- Macros supporting pmix_proc_stats_t objects
PMIX_PROC_STATS_CONSTRUCT
PMIX_PROC_STATS_CREATE
PMIX_PROC_STATS_DESTRUCT
PMIX_PROC_STATS_FREE
PMIX_PROC_STATS_RELEASE
OpenPMIx v4.1.1 renamed one constant:
Constants
------------
PMIX_DEBUG_WAIT_FOR_NOTIFY - renamed to PMIX_READY_FOR_DEBUG
==========================================================================================
OpenPMIx v4.1.0
---------------------------------
OpenPMIx v4.1.0 is based on the PMIx v4.1 Standard and includes the following EXTENSIONS:
APIs
------
PMIx_Data_embed - Embed a data payload into a buffer.
Constants
------------
PMIX_DATA_BUFFER - data type for packing/unpacking of pmix_data_buffer_t objects
PMIX_DISK_STATS - data type for packing/unpacking of pmix_disk_stats_t objects
PMIX_NET_STATS - data type for packing/unpacking of pmix_net_stats_t objects
PMIX_NODE_STATS - data type for packing/unpacking of pmix_node_stats_t objects
PMIX_PROC_STATS - data type for packing/unpacking of pmix_proc_stats_t objects
PMIX_ERR_JOB_EXE_NOT_FOUND - specified executable not found
PMIX_ERR_JOB_INSUFFICIENT_RESOURCES - insufficient resources to spawn job
PMIX_ERR_JOB_SYS_OP_FAILED - system library operation failed
PMIX_ERR_JOB_WDIR_NOT_FOUND - specified working directory not found
PMIX_READY_FOR_DEBUG - event indicating job/proc is ready for debug (accompanied by PMIX_BREAKPOINT indicating where proc is waiting)
Attributes
------------
PMIX_BREAKPOINT "pmix.brkpnt" // (char*) string ID of the breakpoint where the process(es) is(are) waiting
PMIX_ENVARS_HARVESTED "pmix.evar.hvstd" // (bool) Envars have been harvested by the spawn requestor
PMIX_IOF_FILE_ONLY "pmix.iof.fonly" // (bool) output only into designated files - do not also output
// a copy to stdout/stderr
PMIX_IOF_FILE_PATTERN "pmix.iof.fpt" // (bool) Specified output file is to be treated as a pattern and not
// automatically annotated by nspace, rank, or other parameters
PMIX_IOF_LOCAL_OUTPUT "pmix.iof.local" // (bool) Write output streams to local stdout/err
PMIX_IOF_MERGE_STDERR_STDOUT "pmix.iof.mrg" // (bool) merge stdout and stderr streams from application procs
PMIX_IOF_OUTPUT_TO_DIRECTORY "pmix.iof.dir" // (char*) direct application output into files of form
// "<directory>/<jobid>/rank.<rank>/stdout[err]"
PMIX_IOF_OUTPUT_TO_FILE "pmix.iof.file" // (char*) direct application output into files of form
// "<filename>.rank" with both stdout and stderr redirected into it
PMIX_IOF_RANK_OUTPUT "pmix.iof.rank" // (bool) Tag output with the rank it came from
PMIX_NODE_OVERSUBSCRIBED "pmix.ndosub" // (bool) true if number of procs from this job on this node
// exceeds the number of slots allocated to it
The following attributes were also included in OpenPMIx v4.1.0 as an early form of support for
the Storage portion of the Standard, but later dropped by the Standard:
PMIX_STORAGE_AVAIL_BW
PMIX_STORAGE_BW
PMIX_STORAGE_CAPACITY_AVAIL
PMIX_STORAGE_CAPACITY_FREE
PMIX_STORAGE_OBJECTS_AVAIL
PMIX_STORAGE_OBJECTS_FREE
Datatypes
------------
pmix_disk_stats_t - contains statistics on disk read/write operations
pmix_net_stats_t - contains statistics on network activity
pmix_node_stats_t - contains statistics on node resource usage
pmix_proc_stats_t - contains statistics on process resource usage
Macros
---------
PMIX_VALUE_XFER_DIRECT - directly transfer a pmix_value_t to another one (non-destructive copy)
PMIX_XFER_PROCID - transfer a pmix_proc_t to another one (non-destructive copy)
- Macros supporting pmix_disk_stats_t objects
PMIX_DISK_STATS_CONSTRUCT
PMIX_DISK_STATS_CREATE
PMIX_DISK_STATS_DESTRUCT
PMIX_DISK_STATS_FREE
PMIX_DISK_STATS_RELEASE
- Macros supporting pmix_net_stats_t objects
PMIX_NET_STATS_CONSTRUCT
PMIX_NET_STATS_CREATE
PMIX_NET_STATS_DESTRUCT
PMIX_NET_STATS_FREE
PMIX_NET_STATS_RELEASE
- Macros supporting pmix_node_stats_t objects
PMIX_NODE_STATS_CONSTRUCT
PMIX_NODE_STATS_CREATE
PMIX_NODE_STATS_DESTRUCT
PMIX_NODE_STATS_RELEASE
- Macros supporting pmix_proc_stats_t objects
PMIX_PROC_STATS_CONSTRUCT
PMIX_PROC_STATS_CREATE
PMIX_PROC_STATS_DESTRUCT
PMIX_PROC_STATS_FREE
PMIX_PROC_STATS_RELEASE
OpenPMIx v4.1.0 DOES NOT INCLUDE support for the storage definitions in the PMIx v4.1 Standard, and renamed one constant. This includes the following:
Constants
------------
PMIX_DEBUG_WAIT_FOR_NOTIFY - renamed to PMIX_READY_FOR_DEBUG
Attributes
-----------
PMIX_STORAGE_ACCESSIBILITY
PMIX_STORAGE_ACCESSIBILITY_CLUSTER
PMIX_STORAGE_ACCESSIBILITY_JOB
PMIX_STORAGE_ACCESSIBILITY_NODE
PMIX_STORAGE_ACCESSIBILITY_RACK
PMIX_STORAGE_ACCESSIBILITY_REMOTE
PMIX_STORAGE_ACCESSIBILITY_SESSION
PMIX_STORAGE_ACCESS_RD
PMIX_STORAGE_ACCESS_RDWR
PMIX_STORAGE_ACCESS_TYPE
PMIX_STORAGE_ACCESS_WR
PMIX_STORAGE_BW_CUR
PMIX_STORAGE_BW_MAX
PMIX_STORAGE_CAPACITY_USED
PMIX_STORAGE_IOPS_CUR
PMIX_STORAGE_IOPS_MAX
PMIX_STORAGE_MEDIUM
PMIX_STORAGE_MEDIUM_HDD
PMIX_STORAGE_MEDIUM_NVME
PMIX_STORAGE_MEDIUM_PMEM
PMIX_STORAGE_MEDIUM_RAM
PMIX_STORAGE_MEDIUM_SSD
PMIX_STORAGE_MEDIUM_TAPE
PMIX_STORAGE_MEDIUM_UNKNOWN
PMIX_STORAGE_MINIMAL_XFER_SIZE
PMIX_STORAGE_OBJECTS_USED
PMIX_STORAGE_PERSISTENCE
PMIX_STORAGE_PERSISTENCE_ARCHIVE
PMIX_STORAGE_PERSISTENCE_JOB
PMIX_STORAGE_PERSISTENCE_NODE
PMIX_STORAGE_PERSISTENCE_PROJECT
PMIX_STORAGE_PERSISTENCE_SCRATCH
PMIX_STORAGE_PERSISTENCE_SESSION
PMIX_STORAGE_PERSISTENCE_TEMPORARY
PMIX_STORAGE_SUGGESTED_XFER_SIZE
PMIX_STORAGE_VERSION
Datatypes
------------
pmix_storage_access_type_t
pmix_storage_accessibility_t
pmix_storage_medium_t
pmix_storage_persistence_t