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
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
|
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 v4.2.2
---------------------------------
OpenPMIx v4.2.2 is based on the PMIx v4.2.1 Standard and includes the following EXTENSIONS:
APIs
------
void PMIx_Cpuset_destruct(pmix_cpuset_t *cpuset)
Destruct a pmix_cpuset_t object
void PMIx_Data_array_destruct(pmix_data_array_t *d)
Destruct a pmix_data_array_t object
pmix_status_t PMIx_Info_list_insert(void *ptr, pmix_info_t *info)
Append a pmix_info_t object to a list, marking it as not to be
destructed upon release of that list. This protects the included
data from release.
pmix_value_cmp_t PMIx_Value_compare(pmix_value_t *v1,
pmix_value_t *v2)
Compare two pmix_value_t objects, returning an enum indicating
whether they are equal, v1 is greater, v2 is greater, or that
the types don't match
const char* PMIx_Value_comparison_string(pmix_value_cmp_t cmp)
Pretty-print a string representation of the pmix_value_cmp_t value compare enum
void PMIx_Value_destruct(pmix_value_t *val)
Destruct a pmix_value_t object
The following APIs have been slightly modified to add a "const"
qualifier to their input parameter:
const char* PMIx_Get_attribute_string(const char *attribute)
const char* PMIx_Get_attribute_name(const char *attrstring)
char* PMIx_Info_string(const pmix_info_t *info)
char* PMIx_Value_string(const pmix_value_t *value)
This is not expected to cause any issues for users.
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_ERR_PROC_REQUESTED_ABORT - process called PMIx_Abort
PMIX_ERR_PROC_KILLED_BY_CMD - process was terminated by RTE command
PMIX_ERR_PROC_FAILED_TO_START - process failed to start
PMIX_ERR_PROC_ABORTED_BY_SIG - process aborted by signal (e.g., segmentation fault)
PMIX_ERR_PROC_SENSOR_BOUND_EXCEEDED - process terminated due to exceeding a sensor boundary
PMIX_ERR_EXIT_NONZERO_TERM - process exited normally, but with a non-zero status
Attributes
------------
PMIX_BIND_PROGRESS_THREAD "pmix.bind.pt" // (char*) Comma-delimited ranges of CPUs that the internal PMIx progress
// thread shall be bound to
PMIX_BIND_REQUIRED "pmix.bind.reqd" // (bool) Return error if the internal PMIx progress thread cannot be bound
PMIX_COLOCATE_PROCS "pmix.colproc" // (pmix_data_array_t*) Array of pmix_proc_t identifying the procs
// with which the new job's procs are to be colocated
PMIX_COLOCATE_NPERPROC "pmix.colnum.proc" // (uint16_t) Number of procs to colocate with each identified proc
PMIX_COLOCATE_NPERNODE "pmix.colnum.node" // (uint16_t) Number of procs to colocate on the node of each identified proc
PMIX_EVENT_ONESHOT "pmix.evone" // (bool) when registering, indicate that this event handler is to be deleted
// after being invoked
PMIX_GROUP_ADD_MEMBERS "pmix.grp.add" // (pmix_data_array_t*) Array of pmix_proc_t identifying procs that are not
// included in the membership specified in the procs array passed to
// the PMIx_Group_construct[_nb] call, but are to be included in the
// final group. The identified procs will be sent an invitation to
// join the group during the construction procedure. This is used when
// some members of the proposed group do not know the full membership
// and therefore cannot include all members in the call to construct.
PMIX_GROUP_LOCAL_CID "pmix.grp.lclid" // (size_t) local context ID for the specified process member of a group
PMIX_IOF_TAG_DETAILED_OUTPUT "pmix.iof.tagdet" // (bool) Tag output with the [local jobid,rank][hostname:pid] and channel it comes from
PMIX_IOF_TAG_FULLNAME_OUTPUT "pmix.iof.tagfull" // (bool) Tag output with the [nspace,rank] and channel it comes from
PMIX_LOG_AGG "pmix.log.agg" // (bool) Whether to aggregate and prevent duplicate logging messages
// based on key value pairs.
PMIX_LOG_KEY "pmix.log.key" // (char*) key to a logging message
PMIX_LOG_VAL "pmix.log.val" // (char*) value to a logging message
PMIX_MYSERVER_URI "pmix.mysrvr.uri" // (char*) URI of this proc's listener socket
PMIX_QUALIFIED_VALUE "pmix.qual.val" // (pmix_data_array_t*) Value being provided consists of the primary
// key-value pair in first position, followed by one or more
// key-value qualifiers to be used when subsequently retrieving
// the primary value
PMIX_WDIR_USER_SPECIFIED "pmix.wdir.user" // (bool) User specified the working directory
PMIX_RUNTIME_OPTIONS "pmix.runopt" // (char*) Environment-specific runtime directives that control job behavior
PMIX_ABORT_NON_ZERO_TERM "pmix.abnz" // (bool) Abort the spawned job if any process terminates with non-zero status
PMIX_DO_NOT_LAUNCH "pmix.dnl" // (bool) Execute all procedures to prepare the requested job for launch,
// but do not launch it. Typically combined with the PMIX_DISPLAY_MAP
// or PMIX_DISPLAY_MAP_DETAILED for debugging purposes.
PMIX_SHOW_LAUNCH_PROGRESS "pmix.showprog" // (bool) Provide periodic progress reports on job launch procedure (e.g., after
// every 100 processes have been spawned)
PMIX_AGGREGATE_HELP "pmix.agg.help" // (bool) Aggregate help messages, reporting each unique help message once
// accompanied by the number of processes that reported it
PMIX_REPORT_CHILD_SEP "pmix.rptchildsep" // (bool) Report the exit status of any child jobs spawned by the primary job
// separately. If false, then the final exit status reported will be
// zero if the primary job and all spawned jobs exit normally, or the
// first non-zero status returned by either primary or child jobs.
PMIX_DISPLAY_MAP_DETAILED "pmix.dispmapdet" // (bool) display a highly detailed placement map upon spawn
PMIX_DISPLAY_ALLOCATION "pmix.dispalloc" // (bool) display the resource allocation
PMIX_DISPLAY_TOPOLOGY "pmix.disptopo" // (char*) comma-delimited list of hosts whose topology is
// to be displayed
PMIX_SORTED_PROC_ARRAY "pmix.sorted.parr" // (bool) Proc array being passed has been sorted
The attribute PMIX_DEBUG_STOP_IN_APP has been modified to only support a PMIX_BOOL value instead of an optional array of ranks due to
questions over the use-case calling for stopping a subset of a job's processes while allowing others to run "free".
Datatypes
------------
pmix_value_cmp_t - an enum indicating the relative value of
two pmix_value_t objects. Values include:
* PMIX_EQUAL
* PMIX_VALUE1_GREATER
* PMIX_VALUE2_GREATER
* PMIX_VALUE_TYPE_DIFFERENT
* PMIX_VALUE_INCOMPATIBLE_OBJECTS
* PMIX_VALUE_COMPARISON_NOT_AVAIL
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
Datatype static initializers
----------------------------
Static initializers were added for each complex data type (i.e., a data type
defined as a struct). The following are for datatypes beyond those in v4.2 of
the Standard:
PMIX_PROC_STATS_STATIC_INIT
PMIX_DISK_STATS_STATIC_INIT
PMIX_NET_STATS_STATIC_INIT
PMIX_NODE_STATS_STATIC_INIT
Macros
---------
PMIX_XFER_PROCID - transfer a pmix_proc_t to another one (non-destructive copy)
PMIX_INFO_SET_END - mark this pmix_info_t as being at the end of an array
PMIX_INFO_SET_PERSISTENT - mark that the data in this pmix_info_t is not to
be released by PMIX_Info_destruct (or its macro form)
PMIX_INFO_SET_QUALIFIER - mark this pmix_info_t as a qualifier to the
primary key
PMIX_INFO_IS_PERSISTENT - test if this pmix_info_t has been marked as persistent
PMIX_INFO_IS_QUALIFIER - test if this pmix_info_t has been marked as a qualifier
PMIX_DATA_ARRAY_INIT - initialize a pmix_data_array_t
PMIX_CHECK_TRUE - check if a pmix_value_t is boolean "true" (supports
string as well as traditional boolean values)
PMIX_CHECK_BOOL - check if a pmix_value_t is a boolean value (supports
string as well as traditional boolean values)
- 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.2.1
---------------------------------
OpenPMIx v4.2.1 is based on the PMIx v4.2.1 Standard and includes the following EXTENSIONS:
APIs
------
void PMIx_Cpuset_destruct(pmix_cpuset_t *cpuset)
Destruct a pmix_cpuset_t object
void PMIx_Data_array_destruct(pmix_data_array_t *d)
Destruct a pmix_data_array_t object
pmix_status_t PMIx_Info_list_insert(void *ptr, pmix_info_t *info)
Append a pmix_info_t object to a list, marking it as not to be
destructed upon release of that list. This protects the included
data from release.
pmix_value_cmp_t PMIx_Value_compare(pmix_value_t *v1,
pmix_value_t *v2)
Compare two pmix_value_t objects, returning an enum indicating
whether they are equal, v1 is greater, v2 is greater, or that
the types don't match
const char* PMIx_Value_comparison_string(pmix_value_cmp_t cmp)
Pretty-print a string representation of the pmix_value_cmp_t value compare enum
void PMIx_Value_destruct(pmix_value_t *val)
Destruct a pmix_value_t object
The following APIs have been slightly modified to add a "const"
qualifier to their input parameter:
const char* PMIx_Get_attribute_string(const char *attribute)
const char* PMIx_Get_attribute_name(const char *attrstring)
char* PMIx_Info_string(const pmix_info_t *info)
char* PMIx_Value_string(const pmix_value_t *value)
This is not expected to cause any issues for users.
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_BIND_PROGRESS_THREAD "pmix.bind.pt" // (char*) Comma-delimited ranges of CPUs that the internal PMIx progress
// thread shall be bound to
PMIX_BIND_REQUIRED "pmix.bind.reqd" // (bool) Return error if the internal PMIx progress thread cannot be bound
PMIX_COLOCATE_PROCS "pmix.colproc" // (pmix_data_array_t*) Array of pmix_proc_t identifying the procs
// with which the new job's procs are to be colocated
PMIX_COLOCATE_NPERPROC "pmix.colnum.proc" // (uint16_t) Number of procs to colocate with each identified proc
PMIX_COLOCATE_NPERNODE "pmix.colnum.node" // (uint16_t) Number of procs to colocate on the node of each identified proc
PMIX_EVENT_ONESHOT "pmix.evone" // (bool) when registering, indicate that this event handler is to be deleted
// after being invoked
PMIX_GROUP_ADD_MEMBERS "pmix.grp.add" // (pmix_data_array_t*) Array of pmix_proc_t identifying procs that are not
// included in the membership specified in the procs array passed to
// the PMIx_Group_construct[_nb] call, but are to be included in the
// final group. The identified procs will be sent an invitation to
// join the group during the construction procedure. This is used when
// some members of the proposed group do not know the full membership
// and therefore cannot include all members in the call to construct.
PMIX_GROUP_LOCAL_CID "pmix.grp.lclid" // (size_t) local context ID for the specified process member of a group
PMIX_IOF_TAG_DETAILED_OUTPUT "pmix.iof.tagdet" // (bool) Tag output with the [local jobid,rank][hostname:pid] and channel it comes from
PMIX_IOF_TAG_FULLNAME_OUTPUT "pmix.iof.tagfull" // (bool) Tag output with the [nspace,rank] and channel it comes from
PMIX_LOG_AGG "pmix.log.agg" // (bool) Whether to aggregate and prevent duplicate logging messages
// based on key value pairs.
PMIX_LOG_KEY "pmix.log.key" // (char*) key to a logging message
PMIX_LOG_VAL "pmix.log.val" // (char*) value to a logging message
PMIX_MYSERVER_URI "pmix.mysrvr.uri" // (char*) URI of this proc's listener socket
PMIX_QUALIFIED_VALUE "pmix.qual.val" // (pmix_data_array_t*) Value being provided consists of the primary
// key-value pair in first position, followed by one or more
// key-value qualifiers to be used when subsequently retrieving
// the primary value
PMIX_WDIR_USER_SPECIFIED "pmix.wdir.user" // (bool) User specified the working directory
PMIX_RUNTIME_OPTIONS "pmix.runopt" // (char*) Environment-specific runtime directives that control job behavior
PMIX_ABORT_NON_ZERO_TERM "pmix.abnz" // (bool) Abort the spawned job if any process terminates with non-zero status
PMIX_DO_NOT_LAUNCH "pmix.dnl" // (bool) Execute all procedures to prepare the requested job for launch,
// but do not launch it. Typically combined with the PMIX_DISPLAY_MAP
// or PMIX_DISPLAY_MAP_DETAILED for debugging purposes.
PMIX_SHOW_LAUNCH_PROGRESS "pmix.showprog" // (bool) Provide periodic progress reports on job launch procedure (e.g., after
// every 100 processes have been spawned)
PMIX_AGGREGATE_HELP "pmix.agg.help" // (bool) Aggregate help messages, reporting each unique help message once
// accompanied by the number of processes that reported it
PMIX_REPORT_CHILD_SEP "pmix.rptchildsep" // (bool) Report the exit status of any child jobs spawned by the primary job
// separately. If false, then the final exit status reported will be
// zero if the primary job and all spawned jobs exit normally, or the
// first non-zero status returned by either primary or child jobs.
PMIX_DISPLAY_MAP_DETAILED "pmix.dispmapdet" // (bool) display a highly detailed placement map upon spawn
PMIX_DISPLAY_ALLOCATION "pmix.dispalloc" // (bool) display the resource allocation
PMIX_DISPLAY_TOPOLOGY "pmix.disptopo" // (char*) comma-delimited list of hosts whose topology is
// to be displayed
Datatypes
------------
pmix_value_cmp_t - an enum indicating the relative value of
two pmix_value_t objects. Values include:
* PMIX_EQUAL
* PMIX_VALUE1_GREATER
* PMIX_VALUE2_GREATER
* PMIX_VALUE_TYPE_DIFFERENT
* PMIX_VALUE_INCOMPATIBLE_OBJECTS
* PMIX_VALUE_COMPARISON_NOT_AVAIL
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
Datatype static initializers
----------------------------
Static initializers were added for each complex data type (i.e., a data type
defined as a struct). The following are for datatypes beyond those in v4.2 of
the Standard:
PMIX_PROC_STATS_STATIC_INIT
PMIX_DISK_STATS_STATIC_INIT
PMIX_NET_STATS_STATIC_INIT
PMIX_NODE_STATS_STATIC_INIT
Macros
---------
PMIX_XFER_PROCID - transfer a pmix_proc_t to another one (non-destructive copy)
PMIX_INFO_SET_END - mark this pmix_info_t as being at the end of an array
PMIX_INFO_SET_PERSISTENT - mark that the data in this pmix_info_t is not to
be released by PMIX_Info_destruct (or its macro form)
PMIX_INFO_SET_QUALIFIER - mark this pmix_info_t as a qualifier to the
primary key
PMIX_INFO_IS_PERSISTENT - test if this pmix_info_t has been marked as persistent
PMIX_INFO_IS_QUALIFIER - test if this pmix_info_t has been marked as a qualifier
PMIX_DATA_ARRAY_INIT - initialize a pmix_data_array_t
PMIX_CHECK_TRUE - check if a pmix_value_t is boolean "true" (supports
string as well as traditional boolean values)
PMIX_CHECK_BOOL - check if a pmix_value_t is a boolean value (supports
string as well as traditional boolean values)
- 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.2.0
---------------------------------
OpenPMIx v4.2.0 is based on the PMIx v4.2 Standard and includes the following EXTENSIONS:
APIs
------
void PMIx_Cpuset_destruct(pmix_cpuset_t *cpuset)
Destruct a pmix_cpuset_t object
void PMIx_Data_array_destruct(pmix_data_array_t *d)
Destruct a pmix_data_array_t object
pmix_status_t PMIx_Info_list_insert(void *ptr, pmix_info_t *info)
Append a pmix_info_t object to a list, marking it as not to be
destructed upon release of that list. This protects the included
data from release.
pmix_value_cmp_t PMIx_Value_compare(pmix_value_t *v1,
pmix_value_t *v2)
Compare two pmix_value_t objects, returning an enum indicating
whether they are equal, v1 is greater, v2 is greater, or that
the types don't match
const char* PMIx_Value_comparison_string(pmix_value_cmp_t cmp)
Pretty-print a string representation of the pmix_value_cmp_t value compare enum
void PMIx_Value_destruct(pmix_value_t *val)
Destruct a pmix_value_t object
The following APIs have been slightly modified to add a "const"
qualifier to their input parameter:
const char* PMIx_Get_attribute_string(const char *attribute)
const char* PMIx_Get_attribute_name(const char *attrstring)
char* PMIx_Info_string(const pmix_info_t *info)
char* PMIx_Value_string(const pmix_value_t *value)
This is not expected to cause any issues for users.
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_BIND_PROGRESS_THREAD "pmix.bind.pt" // (char*) Comma-delimited ranges of CPUs that the internal PMIx progress
// thread shall be bound to
PMIX_BIND_REQUIRED "pmix.bind.reqd" // (bool) Return error if the internal PMIx progress thread cannot be bound
PMIX_COLOCATE_PROCS "pmix.colproc" // (pmix_data_array_t*) Array of pmix_proc_t identifying the procs
// with which the new job's procs are to be colocated
PMIX_COLOCATE_NPERPROC "pmix.colnum.proc" // (uint16_t) Number of procs to colocate with each identified proc
PMIX_COLOCATE_NPERNODE "pmix.colnum.node" // (uint16_t) Number of procs to colocate on the node of each identified proc
PMIX_EVENT_ONESHOT "pmix.evone" // (bool) when registering, indicate that this event handler is to be deleted
// after being invoked
PMIX_GROUP_ADD_MEMBERS "pmix.grp.add" // (pmix_data_array_t*) Array of pmix_proc_t identifying procs that are not
// included in the membership specified in the procs array passed to
// the PMIx_Group_construct[_nb] call, but are to be included in the
// final group. The identified procs will be sent an invitation to
// join the group during the construction procedure. This is used when
// some members of the proposed group do not know the full membership
// and therefore cannot include all members in the call to construct.
PMIX_GROUP_LOCAL_CID "pmix.grp.lclid" // (size_t) local context ID for the specified process member of a group
PMIX_IOF_TAG_DETAILED_OUTPUT "pmix.iof.tagdet" // (bool) Tag output with the [local jobid,rank][hostname:pid] and channel it comes from
PMIX_IOF_TAG_FULLNAME_OUTPUT "pmix.iof.tagfull" // (bool) Tag output with the [nspace,rank] and channel it comes from
PMIX_LOG_AGG "pmix.log.agg" // (bool) Whether to aggregate and prevent duplicate logging messages
// based on key value pairs.
PMIX_LOG_KEY "pmix.log.key" // (char*) key to a logging message
PMIX_LOG_VAL "pmix.log.val" // (char*) value to a logging message
PMIX_MYSERVER_URI "pmix.mysrvr.uri" // (char*) URI of this proc's listener socket
PMIX_QUALIFIED_VALUE "pmix.qual.val" // (pmix_data_array_t*) Value being provided consists of the primary
// key-value pair in first position, followed by one or more
// key-value qualifiers to be used when subsequently retrieving
// the primary value
PMIX_WDIR_USER_SPECIFIED "pmix.wdir.user" // (bool) User specified the working directory
Datatypes
------------
pmix_value_cmp_t - an enum indicating the relative value of
two pmix_value_t objects. Values include:
* PMIX_EQUAL
* PMIX_VALUE1_GREATER
* PMIX_VALUE2_GREATER
* PMIX_VALUE_TYPE_DIFFERENT
* PMIX_VALUE_INCOMPATIBLE_OBJECTS
* PMIX_VALUE_COMPARISON_NOT_AVAIL
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
Datatype static initializers
----------------------------
Static initializers were added for each complex data type (i.e., a data type
defined as a struct). The following are for datatypes beyond those in v4.2 of
the Standard:
PMIX_PROC_STATS_STATIC_INIT
PMIX_DISK_STATS_STATIC_INIT
PMIX_NET_STATS_STATIC_INIT
PMIX_NODE_STATS_STATIC_INIT
Macros
---------
PMIX_XFER_PROCID - transfer a pmix_proc_t to another one (non-destructive copy)
PMIX_INFO_SET_END - mark this pmix_info_t as being at the end of an array
PMIX_INFO_SET_PERSISTENT - mark that the data in this pmix_info_t is not to
be released by PMIX_Info_destruct (or its macro form)
PMIX_INFO_SET_QUALIFIER - mark this pmix_info_t as a qualifier to the
primary key
PMIX_INFO_IS_PERSISTENT - test if this pmix_info_t has been marked as persistent
PMIX_INFO_IS_QUALIFIER - test if this pmix_info_t has been marked as a qualifier
PMIX_DATA_ARRAY_INIT - initialize a pmix_data_array_t
- 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
---------------------------------
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_OUTPUT_RAW "pmix.iof.raw" // (bool) Do not buffer output to be written as complete lines - output
// characters as the stream delivers them
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_IOF_OUTPUT_RAW "pmix.iof.raw" // (bool) Do not buffer output to be written as complete lines - output
// characters as the stream delivers them
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
PMIX_BIND_PROGRESS_THREAD "pmix.bind.pt" // (char*) Comma-delimited ranges of CPUs that the internal PMIx progress
// thread shall be bound to
PMIX_BIND_REQUIRED "pmix.bind.reqd" // (bool) Return error if the internal PMIx progress thread cannot be bound
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
Datatype static initializers
----------------------------
Static initializers were added for each complex data type (i.e., a data type
defined as a struct):
PMIX_COORD_STATIC_INIT
PMIX_CPUSET_STATIC_INIT
PMIX_TOPOLOGY_STATIC_INIT
PMIX_GEOMETRY_STATIC_INIT
PMIX_DEVICE_DIST_STATIC_INIT
PMIX_BYTE_OBJECT_STATIC_INIT
PMIX_ENDPOINT_STATIC_INIT
PMIX_ENVAR_STATIC_INIT
PMIX_PROC_STATIC_INIT
PMIX_PROC_INFO_STATIC_INIT
PMIX_DATA_ARRAY_STATIC_INIT
PMIX_DATA_BUFFER_STATIC_INIT
PMIX_PROC_STATS_STATIC_INIT
PMIX_DISK_STATS_STATIC_INIT
PMIX_NET_STATS_STATIC_INIT
PMIX_NODE_STATS_STATIC_INIT
PMIX_VALUE_STATIC_INIT
PMIX_INFO_STATIC_INIT
PMIX_LOOKUP_STATIC_INIT
PMIX_APP_STATIC_INIT
PMIX_QUERY_STATIC_INIT
PMIX_REGATTR_STATIC_INIT
PMIX_FABRIC_STATIC_INIT
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
|
