-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathChap_Revisions.tex
1269 lines (1173 loc) · 47.8 KB
/
Chap_Revisions.tex
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
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\chapter{Revision History}
\label{chap:revisions}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 1.0
\section{Version 1.0: June 12, 2015}
\par
The \ac{PMIx} version 1.0 \textit{ad hoc} standard was defined in a set of header files as part of the v1.0.0 release of the OpenPMIx library prior to the creation of the formal \ac{PMIx} 2.0 standard.
Below are a summary listing of the interfaces defined in the 1.0 headers.
\begin{itemize}
\item Client APIs
\begin{compactitemize}
\item PMIx\_Init, \refapi{PMIx_Initialized}, \refapi{PMIx_Abort}, \refapi{PMIx_Finalize}
\item \refapi{PMIx_Put}, \refapi{PMIx_Commit},
\item \refapi{PMIx_Fence}, \refapi{PMIx_Fence_nb}
\item \refapi{PMIx_Get}, \refapi{PMIx_Get_nb}
\item \refapi{PMIx_Publish}, \refapi{PMIx_Publish_nb}
\item \refapi{PMIx_Lookup}, \refapi{PMIx_Lookup_nb}
\item \refapi{PMIx_Unpublish}, \refapi{PMIx_Unpublish_nb}
\item \refapi{PMIx_Spawn}, \refapi{PMIx_Spawn_nb}
\item \refapi{PMIx_Connect}, \refapi{PMIx_Connect_nb}
\item \refapi{PMIx_Disconnect}, \refapi{PMIx_Disconnect_nb}
\item \refapi{PMIx_Resolve_nodes}, \refapi{PMIx_Resolve_peers}
\end{compactitemize}
\item Server \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_server_init}, \refapi{PMIx_server_finalize}
\item \refapi{PMIx_generate_regex}, \refapi{PMIx_generate_ppn}
\item \refapi{PMIx_server_register_nspace}, \refapi{PMIx_server_deregister_nspace}
\item \refapi{PMIx_server_register_client}, \refapi{PMIx_server_deregister_client}
\item \refapi{PMIx_server_setup_fork}, \refapi{PMIx_server_dmodex_request}
\end{compactitemize}
\item Common \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_Get_version}, \refapi{PMIx_Store_internal}, \refapi{PMIx_Error_string}
\item PMIx_Register_errhandler, PMIx_Deregister_errhandler, PMIx_Notify_error
\end{compactitemize}
\end{itemize}
The \code{PMIx_Init} \ac{API} was subsequently modified in the v1.1.0 release of that library.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 2.0
\section{Version 2.0: Sept. 2018}
The following \acp{API} were introduced in v2.0 of the PMIx Standard:
\begin{itemize}
\item Client APIs
\begin{compactitemize}
\item \refapi{PMIx_Query_info_nb}, \refapi{PMIx_Log_nb}
\item \refapi{PMIx_Allocation_request_nb}, \refapi{PMIx_Job_control_nb}, \refapi{PMIx_Process_monitor_nb}, \refmacro{PMIx_Heartbeat}
\end{compactitemize}
\item Server \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_server_setup_application}, \refapi{PMIx_server_setup_local_support}
\end{compactitemize}
\item Tool \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_tool_init}, \refapi{PMIx_tool_finalize}
\end{compactitemize}
\item Common \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_Register_event_handler}, \refapi{PMIx_Deregister_event_handler}
\item \refapi{PMIx_Notify_event}
\item \refapi{PMIx_Proc_state_string}, \refapi{PMIx_Scope_string}
\item \refapi{PMIx_Persistence_string}, \refapi{PMIx_Data_range_string}
\item \refapi{PMIx_Info_directives_string}, \refapi{PMIx_Data_type_string}
\item \refapi{PMIx_Alloc_directive_string}
\item \refapi{PMIx_Data_pack}, \refapi{PMIx_Data_unpack}, \refapi{PMIx_Data_copy}
\item \refapi{PMIx_Data_print}, \refapi{PMIx_Data_copy_payload}
\end{compactitemize}
\end{itemize}
\subsection{Removed/Modified \acp{API}}
The \refapi{PMIx_Init} \ac{API} was modified in v2.0 of the standard from its \textit{ad hoc} v1.0 signature to include passing of a \refstruct{pmix_info_t} array for flexibility and ``future-proofing'' of the \ac{API}.
In addition, the \code{PMIx_Notify_error}, \code{PMIx_Register_errhandler}, and \code{PMIx_Deregister_errhandler} \acp{API} were replaced. This pre-dated official adoption of \ac{PMIx} as a Standard.
\subsection{Deprecated constants}
The following constants were deprecated in v2.0:
\begin{constantdesc}
\declareconstitemDEP{PMIX_MODEX}
\declareconstitemDEP{PMIX_INFO_ARRAY}
\end{constantdesc}
\subsection{Deprecated attributes}
The following attributes were deprecated in v2.0:
%
\declareAttributeDEP{PMIX_ERROR_NAME}{"pmix.errname"}{pmix_status_t}{
Specific error to be notified
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_COMM}{"pmix.errgroup.comm"}{bool}{
Set true to get comm errors notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_ABORT}{"pmix.errgroup.abort"}{bool}{
Set true to get abort errors notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_MIGRATE}{"pmix.errgroup.migrate"}{bool}{
Set true to get migrate errors notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_RESOURCE}{"pmix.errgroup.resource"}{bool}{
Set true to get resource errors notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_SPAWN}{"pmix.errgroup.spawn"}{bool}{
Set true to get spawn errors notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_NODE}{"pmix.errgroup.node"}{bool}{
Set true to get node status notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_LOCAL}{"pmix.errgroup.local"}{bool}{
Set true to get local errors notification
}
%
\declareAttributeDEP{PMIX_ERROR_GROUP_GENERAL}{"pmix.errgroup.gen"}{bool}{
Set true to get notified of generic errors
}
%
\declareAttributeDEP{PMIX_ERROR_HANDLER_ID}{"pmix.errhandler.id"}{int}{
Errhandler reference id of notification being reported
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 2.1
\section{Version 2.1: Dec. 2018}
The v2.1 update includes clarifications and corrections from the v2.0 document, plus addition of examples:
\begin{compactitemize}
\item Clarify description of \refapi{PMIx_Connect} and \refapi{PMIx_Disconnect} \acp{API}.
\item Explain that values for the \refattr{PMIX_COLLECTIVE_ALGO} are environment-dependent
\item Identify the namespace/rank values required for retrieving attribute-associated information using the \refapi{PMIx_Get} \ac{API}
\item Provide definitions for \refterm{session}, \refterm{job}, \refterm{application}, and other terms used throughout the document
\item Clarify definitions of \refattr{PMIX_UNIV_SIZE} versus \refattr{PMIX_JOB_SIZE}
\item Clarify server module function return values
\item Provide examples of the use of \refapi{PMIx_Get} for retrieval of information
\item Clarify the use of \refapi{PMIx_Get} versus \refapi{PMIx_Query_info_nb}
\item Clarify return values for non-blocking \acp{API} and emphasize that callback functions must not be invoked prior to return from the \ac{API}
\item Provide detailed example for construction of the \refapi{PMIx_server_register_nspace} input information array
\item Define information levels (e.g., \refterm{session} vs \refterm{job}) and associated attributes for both storing and retrieving values
\item Clarify roles of \ac{PMIx} server library and host environment for collective operations
\item Clarify definition of \refattr{PMIX_UNIV_SIZE}
\end{compactitemize}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 2.2
\section{Version 2.2: Jan 2019}
The v2.2 update includes the following clarifications and corrections from the v2.1 document:
\begin{compactitemize}
\item Direct modex upcall function (\refapi{pmix_server_dmodex_req_fn_t}) cannot complete atomically as the \ac{API} cannot return the requested information except via the provided callback function
\item Add missing \refstruct{pmix_data_array_t} definition and support macros
\item Add a rule divider between implementer and host environment required attributes for clarity
\item Add \refmacro{PMIX_QUERY_QUALIFIERS_CREATE} macro to simplify creation of \refstruct{pmix_query_t} qualifiers
\item Add \refmacro{PMIX_APP_INFO_CREATE} macro to simplify creation of \refstruct{pmix_app_t} directives
\item Add flag and \refmacro{PMIX_INFO_IS_END} macro for marking and detecting the end of a \refstruct{pmix_info_t} array
\item Clarify the allowed hierarchical nesting of the \refattr{PMIX_SESSION_INFO_ARRAY}, \refattr{PMIX_JOB_INFO_ARRAY}, and associated attributes
\end{compactitemize}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 3.0
\section{Version 3.0: Dec. 2018}
The following \acp{API} were introduced in v3.0 of the PMIx Standard:
\begin{itemize}
\item Client APIs
\begin{compactitemize}
\item \refapi{PMIx_Log}, \refapi{PMIx_Job_control}
\item \refapi{PMIx_Allocation_request}, \refapi{PMIx_Process_monitor}
\item \refapi{PMIx_Get_credential}, \refapi{PMIx_Validate_credential}
\end{compactitemize}
\item Server \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_server_IOF_deliver}
\item \refapi{PMIx_server_collect_inventory}, \refapi{PMIx_server_deliver_inventory}
\end{compactitemize}
\item Tool \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_IOF_pull}, \refapi{PMIx_IOF_push}, \refapi{PMIx_IOF_deregister}
\item \refapi{PMIx_tool_connect_to_server}
\end{compactitemize}
\item Common \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_IOF_channel_string}
\end{compactitemize}
\end{itemize}
The document added a chapter on security credentials, a new section for \ac{IO} forwarding to the Process Management chapter, and a few blocking forms of previously-existing non-blocking \acp{API}. Attributes supporting the new \acp{API} were introduced, as well as additional attributes for a few existing functions.
\subsection{Removed constants}
The following constants were removed in v3.0:
\refconst{PMIX_MODEX}\\
\refconst{PMIX_INFO_ARRAY}
\subsection{Deprecated attributes}
The following attributes were deprecated in v3.0:
\declareAttributeDEP{PMIX_COLLECTIVE_ALGO_REQD}{"pmix.calreqd"}{bool}{
If \code{true}, indicates that the requested choice of algorithm is mandatory.
}
\subsection{Removed attributes}
The following attributes were removed in v3.0:
%
\declareAttributeRM{PMIX_ERROR_NAME}{"pmix.errname"}{pmix_status_t}{
Specific error to be notified
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_COMM}{"pmix.errgroup.comm"}{bool}{
Set true to get comm errors notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_ABORT}{"pmix.errgroup.abort"}{bool}{
Set true to get abort errors notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_MIGRATE}{"pmix.errgroup.migrate"}{bool}{
Set true to get migrate errors notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_RESOURCE}{"pmix.errgroup.resource"}{bool}{
Set true to get resource errors notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_SPAWN}{"pmix.errgroup.spawn"}{bool}{
Set true to get spawn errors notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_NODE}{"pmix.errgroup.node"}{bool}{
Set true to get node status notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_LOCAL}{"pmix.errgroup.local"}{bool}{
Set true to get local errors notification
}
%
\declareAttributeRM{PMIX_ERROR_GROUP_GENERAL}{"pmix.errgroup.gen"}{bool}{
Set true to get notified of generic errors
}
%
\declareAttributeRM{PMIX_ERROR_HANDLER_ID}{"pmix.errhandler.id"}{int}{
Errhandler reference id of notification being reported
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 3.1
\section{Version 3.1: Jan. 2019}
The v3.1 update includes clarifications and corrections from the v3.0 document:
\begin{compactitemize}
\item Direct modex upcall function (\refapi{pmix_server_dmodex_req_fn_t}) cannot complete atomically as the \ac{API} cannot return the requested information except via the provided callback function
\item Fix typo in name of \refattr{PMIX_FWD_STDDIAG} attribute
\item Correctly identify the information retrieval and storage attributes as ``new'' to v3 of the standard
\item Add missing \refstruct{pmix_data_array_t} definition and support macros
\item Add a rule divider between implementer and host environment required attributes for clarity
\item Add \refmacro{PMIX_QUERY_QUALIFIERS_CREATE} macro to simplify creation of \refstruct{pmix_query_t} qualifiers
\item Add \refmacro{PMIX_APP_INFO_CREATE} macro to simplify creation of \refstruct{pmix_app_t} directives
\item Add new attributes to specify the level of information being requested where ambiguity may exist (see \ref{api:struct:attributes:retrieval})
\item Add new attributes to assemble information by its level for storage where ambiguity may exist (see \ref{api:struct:attributes:storage})
\item Add flag and \refmacro{PMIX_INFO_IS_END} macro for marking and detecting the end of a \refstruct{pmix_info_t} array
\item Clarify that \code{PMIX_NUM_SLOTS} is duplicative of (a) \refattr{PMIX_UNIV_SIZE} when used at the \refterm{session} level and (b) \refattr{PMIX_MAX_PROCS} when used at the \refterm{job} and \refterm{application} levels, but leave it in for backward compatibility.
\item Clarify difference between \refattr{PMIX_JOB_SIZE} and \refattr{PMIX_MAX_PROCS}
\item Clarify that \refapi{PMIx_server_setup_application} must be called per-\refterm{job} instead of per-\refterm{application} as the name implies. Unfortunately, this is a historical artifact. Note that both \refattr{PMIX_NODE_MAP} and \refattr{PMIX_PROC_MAP} must be included as input in the \refarg{info} array provided to that function. Further descriptive explanation of the ``instant on'' procedure will be provided in the next version of the \ac{PMIx} Standard.
\item Clarify how the \ac{PMIx} server expects data passed to the host by \refapi{pmix_server_fencenb_fn_t} should be aggregated across nodes, and provide a code snippet example
\end{compactitemize}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 3.2
\section{Version 3.2: Oct. 2020}
The v3.2 update includes clarifications and corrections from the v3.1 document:
\begin{compactitemize}
\item Correct an error in the \refapi{PMIx_Allocation_request} function signature, and clarify the allocation ID attributes
\item Rename the \refattr{PMIX_ALLOC_ID} attribute to \refattr{PMIX_ALLOC_REQ_ID} to clarify that this is a string the user provides as a means to identify their request to query status
\item Add a new \refattr{PMIX_ALLOC_ID} attribute that contains the identifier (provided by the host environment) for the resulting allocation which can later be used to reference the allocated resources in, for example, a call to \refapi{PMIx_Spawn}
\item Update the \refapi{PMIx_generate_regex} and \refapi{PMIx_generate_ppn} descriptions to clarify that the output from these generator functions may not be a NULL-terminated string, but instead could be a byte array of arbitrary binary content.
\item Add a new \refconst{PMIX_REGEX} constant that represents a regular expression data type.
\end{compactitemize}
\subsection{Deprecated constants}
The following constants were deprecated in v3.2:
\begin{constantdesc}
%
\declareconstitemDEP{PMIX_ERR_DATA_VALUE_NOT_FOUND}
Data value not found
%
\declareconstitemDEP{PMIX_ERR_HANDSHAKE_FAILED}
Connection handshake failed
%
\declareconstitemDEP{PMIX_ERR_IN_ERRNO}
Error defined in \code{errno}
%
\declareconstitemDEP{PMIX_ERR_INVALID_ARG}
Invalid argument
%
\declareconstitemDEP{PMIX_ERR_INVALID_ARGS}
Invalid arguments
%
\declareconstitemDEP{PMIX_ERR_INVALID_KEY}
Invalid key
%
\declareconstitemDEP{PMIX_ERR_INVALID_KEY_LENGTH}
Invalid key length
%
\declareconstitemDEP{PMIX_ERR_INVALID_KEYVALP}
Invalid key/value pair
%
\declareconstitemDEP{PMIX_ERR_INVALID_LENGTH}
Invalid argument length
%
\declareconstitemDEP{PMIX_ERR_INVALID_NAMESPACE}
Invalid namespace
%
\declareconstitemDEP{PMIX_ERR_INVALID_NUM_ARGS}
Invalid number of arguments
%
\declareconstitemDEP{PMIX_ERR_INVALID_NUM_PARSED}
Invalid number parsed
%
\declareconstitemDEP{PMIX_ERR_INVALID_SIZE}
Invalid size
%
\declareconstitemDEP{PMIX_ERR_INVALID_VAL}
Invalid value
%
\declareconstitemDEP{PMIX_ERR_INVALID_VAL_LENGTH}
Invalid value length
%
\declareconstitemDEP{PMIX_ERR_NOT_IMPLEMENTED}
Not implemented
%
\declareconstitemDEP{PMIX_ERR_PACK_MISMATCH}
Pack mismatch
%
\declareconstitemDEP{PMIX_ERR_PROC_ENTRY_NOT_FOUND}
Process not found
%
\declareconstitemDEP{PMIX_ERR_PROC_REQUESTED_ABORT}
Process is already requested to abort
%
\declareconstitemDEP{PMIX_ERR_READY_FOR_HANDSHAKE}
Ready for handshake
%
\declareconstitemDEP{PMIX_ERR_SERVER_FAILED_REQUEST}
Failed to connect to the server
%
\declareconstitemDEP{PMIX_ERR_SERVER_NOT_AVAIL}
Server is not available
%
\declareconstitemDEP{PMIX_ERR_SILENT}
Silent error
%
\declareconstitemDEP{PMIX_GDS_ACTION_COMPLETE}
The \ac{GDS} action has completed
%
\declareconstitemDEP{PMIX_NOTIFY_ALLOC_COMPLETE}
Notify that a requested allocation operation is complete - the result of
the request will be included in the \refarg{info} array
%
\end{constantdesc}
\subsection{Deprecated attributes}
The following attributes were deprecated in v3.2:
\declareAttributeDEP{PMIX_ARCH}{"pmix.arch"}{uint32_t}{
Architecture flag.
}
%
\declareAttributeDEP{PMIX_COLLECTIVE_ALGO}{"pmix.calgo"}{char*}{
Comma-delimited list of algorithms to use for the collective operation. \ac{PMIx} does not impose any requirements on a host environment's collective algorithms. Thus, the acceptable values for this attribute will be environment-dependent - users are encouraged to check their host environment for supported values.
}
%
\declareAttributeDEP{PMIX_DSTPATH}{"pmix.dstpath"}{char*}{
Path to shared memory data storage (dstore) files. Deprecated from Standard as being implementation specific.
}
%
\declareAttributeDEP{PMIX_HWLOC_HOLE_KIND}{"pmix.hwlocholek"}{char*}{
Kind of VM ``hole'' HWLOC should use for shared memory
}
%
\declareAttributeDEP{PMIX_HWLOC_SHARE_TOPO}{"pmix.hwlocsh"}{bool}{
Share the HWLOC topology via shared memory
}
%
\declareAttributeDEP{PMIX_HWLOC_SHMEM_ADDR}{"pmix.hwlocaddr"}{size_t}{
Address of the HWLOC shared memory segment.
}
%
\declareAttributeDEP{PMIX_HWLOC_SHMEM_FILE}{"pmix.hwlocfile"}{char*}{
Path to the HWLOC shared memory file.
}
%
\declareAttributeDEP{PMIX_HWLOC_SHMEM_SIZE}{"pmix.hwlocsize"}{size_t}{
Size of the HWLOC shared memory segment.
}
%
\declareAttributeDEP{PMIX_HWLOC_XML_V1}{"pmix.hwlocxml1"}{char*}{
\ac{XML} representation of local topology using HWLOC's v1.x format.
}
%
\declareAttributeDEP{PMIX_HWLOC_XML_V2}{"pmix.hwlocxml2"}{char*}{
\ac{XML} representation of local topology using HWLOC's v2.x format.
}
%
\declareAttributeDEP{PMIX_LOCAL_TOPO}{"pmix.ltopo"}{char*}{
\ac{XML} representation of local node topology.
}
%
\declareAttributeDEP{PMIX_MAPPER}{"pmix.mapper"}{char*}{
Mapping mechanism to use for placing spawned processes - when accessed using \refapi{PMIx_Get}, use the \refconst{PMIX_RANK_WILDCARD} value for the rank to discover the mapping mechanism used for the provided namespace.
}
%
\declareAttributeDEP{PMIX_MAP_BLOB}{"pmix.mblob"}{pmix_byte_object_t}{
Packed blob of process location.
}
%
\declareAttributeDEP{PMIX_NON_PMI}{"pmix.nonpmi"}{bool}{
Spawned processes will not call \refapi{PMIx_Init}.
}
%
\declareAttributeDEP{PMIX_PROC_BLOB}{"pmix.pblob"}{pmix_byte_object_t}{
Packed blob of process data.
}
%
\declareAttributeDEP{PMIX_PROC_URI}{"pmix.puri"}{char*}{
\ac{URI} containing contact information for the specified process.
}
%
\declareAttributeDEP{PMIX_TOPOLOGY_FILE}{"pmix.topo.file"}{char*}{
Full path to file containing \ac{XML} topology description
}
%
\declareAttributeDEP{PMIX_TOPOLOGY_SIGNATURE}{"pmix.toposig"}{char*}{
Topology signature string.
}
%
\declareAttributeDEP{PMIX_TOPOLOGY_XML}{"pmix.topo.xml"}{char*}{
\ac{XML}-based description of topology
}
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%% History: Version 4.0
\section{Version 4.0: Dec. 2020}
NOTE: The PMIx Standard document has undergone significant reorganization in an
effort to become more user-friendly. Highlights include:
\begin{compactitemize}
\item Moving all added, deprecated, and removed items to this revision log
section to make them more visible
\item Co-locating constants and attribute definitions with the primary
API that uses them - citations and hyperlinks are retained elsewhere
\item Splitting the Key-Value Management chapter into separate chapters on
the use of reserved keys, non-reserved keys, and non-process-related
key-value data exchange
\item Creating a new chapter on synchronization and data access methods
\item Removing references to specific implementations of \ac{PMIx} and to implementation-specific features
and/or behaviors
\end{compactitemize}
In addition to the reorganization, the following changes were introduced in v4.0 of the PMIx Standard:
\begin{compactitemize}
\item Clarified that the \refapi{PMIx_Fence_nb} operation can immediately return \refconst{PMIX_OPERATION_SUCCEEDED} in lieu of passing the request to a \ac{PMIx} server if only the calling process is involved in the operation
\item Added the \refapi{PMIx_Register_attributes} \ac{API} by which a host environment can register the attributes it supports for each server-to-host operation
\item Added the ability to query supported attributes from the \ac{PMIx} tool, client and server libraries, as well as the host environment via the new \refstruct{pmix_regattr_t} structure. Both human-readable and machine-parsable output is supported. New attributes to support this operation include:
\begin{compactitemize}
\item \refattr{PMIX_CLIENT_ATTRIBUTES}, \refattr{PMIX_SERVER_ATTRIBUTES}, \refattr{PMIX_TOOL_ATTRIBUTES}, and \refattr{PMIX_HOST_ATTRIBUTES} to identify which library supports the attribute; and
\item \refattr{PMIX_MAX_VALUE}, \refattr{PMIX_MIN_VALUE}, and \refattr{PMIX_ENUM_VALUE} to provide machine-parsable description of accepted values
\end{compactitemize}
\item Add \refconst{PMIX_APP_WILDCARD} to reference all applications within a given job
\item Fix signature of blocking APIs \refapi{PMIx_Allocation_request}, \refapi{PMIx_Job_control}, \refapi{PMIx_Process_monitor}, \refapi{PMIx_Get_credential}, and \refapi{PMIx_Validate_credential} to allow return of results
\item Update description to provide an option for blocking behavior of the \refapi{PMIx_Register_event_handler}, \refapi{PMIx_Deregister_event_handler}, \refapi{PMIx_Notify_event}, \refapi{PMIx_IOF_pull}, \refapi{PMIx_IOF_deregister}, and \refapi{PMIx_IOF_push} APIs. The need for blocking forms of these functions was not initially anticipated but has emerged over time. For these functions, the return value is sufficient to provide the caller with information otherwise returned via callback. Thus, use of a \code{NULL} value as the callback function parameter was deemed a minimal disruption method for providing the desired capability
\item Added a chapter on fabric support that includes new \acp{API}, datatypes, and attributes
\item Added a chapter on process sets and groups that includes new \acp{API} and attributes
\item Added \acp{API} and a new datatypes to support generation and parsing of \ac{PMIx} locality and cpuset strings
\item Added a new chapter on tools that provides deeper explanation on their operation and collecting all tool-relevant definitions into one location. Also introduced two new \acp{API} and removed restriction that limited tools to being connected to only one server at a time.
\item Extended behavior of \refapi{PMIx_server_init} to scalably expose the topology description to the local clients. This includes creating any required shared memory backing stores and/or \ac{XML} representations, plus ensuring that all necessary key-value pairs for clients to access the description are included in the job-level information provided to each client.
\item Added a new \ac{API} by which the host can manually progress the \ac{PMIx} library in lieu of the library's own progress thread.
s\end{compactitemize}
The above changes included introduction of the following \acp{API} and data types:
\begin{itemize}
\item Client APIs
\begin{compactitemize}
\item \refapi{PMIx_Group_construct}, \refapi{PMIx_Group_construct_nb}
\item \refapi{PMIx_Group_destruct}, \refapi{PMIx_Group_destruct_nb}
\item \refapi{PMIx_Group_invite}, \refapi{PMIx_Group_invite_nb}
\item \refapi{PMIx_Group_join}, \refapi{PMIx_Group_join_nb}
\item \refapi{PMIx_Group_leave}, \refapi{PMIx_Group_leave_nb}
\item \refapi{PMIx_Get_relative_locality}, \refapi{PMIx_Load_topology}
\item \refapi{PMIx_Parse_cpuset_string}, \refapi{PMIx_Get_cpuset}
\item \refapi{PMIx_Link_state_string}, \refapi{PMIx_Job_state_string}
\item \refapi{PMIx_Device_type_string}
\item \refapi{PMIx_Fabric_register}, \refapi{PMIx_Fabric_register_nb}
\item \refapi{PMIx_Fabric_update}, \refapi{PMIx_Fabric_update_nb}
\item \refapi{PMIx_Fabric_deregister}, \refapi{PMIx_Fabric_deregister_nb}
\item \refapi{PMIx_Compute_distances}, \refapi{PMIx_Compute_distances_nb}
\item \refapi{PMIx_Get_attribute_string}, \refapi{PMIx_Get_attribute_name}
\item \refapi{PMIx_Progress}
\end{compactitemize}
\item Server \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_server_generate_locality_string}
\item \refapi{PMIx_Register_attributes}
\item \refapi{PMIx_server_define_process_set}, \refapi{PMIx_server_delete_process_set}
\item \refapi{pmix_server_grp_fn_t}, \refapi{pmix_server_fabric_fn_t}
\item \refapi{pmix_server_client_connected2_fn_t}
\item \refapi{PMIx_server_generate_cpuset_string}
\item \refapi{PMIx_server_register_resources}, \refapi{PMIx_server_deregister_resources}
\end{compactitemize}
\item Tool \acp{API}
\begin{compactitemize}
\item \refapi{PMIx_tool_disconnect}
\item \refapi{PMIx_tool_set_server}
\item \refapi{PMIx_tool_attach_to_server}
\item \refapi{PMIx_tool_get_servers}
\end{compactitemize}
\item Data types
\begin{compactitemize}
\item \refstruct{pmix_regattr_t}
\item \refstruct{pmix_cpuset_t}
\item \refstruct{pmix_topology_t}
\item \refstruct{pmix_locality_t}
\item \refstruct{pmix_bind_envelope_t}
\item \refstruct{pmix_group_opt_t}
\item \refstruct{pmix_group_operation_t}
\item \refstruct{pmix_fabric_t}
\item \refstruct{pmix_device_distance_t}
\item \refstruct{pmix_coord_t}
\item \refstruct{pmix_coord_view_t}
\item \refstruct{pmix_geometry_t}
\item \refstruct{pmix_link_state_t}
\item \refstruct{pmix_job_state_t}
\item \refstruct{pmix_device_type_t}
\end{compactitemize}
\item Callback functions
\begin{compactitemize}
\item \refapi{pmix_device_dist_cbfunc_t}
\end{compactitemize}
\end{itemize}
\subsection{Added Constants}
%
\littleheader{General error constants}
\refconst{PMIX_ERR_EXISTS_OUTSIDE_SCOPE} \\
\refconst{PMIX_ERR_PARAM_VALUE_NOT_SUPPORTED} \\
\refconst{PMIX_ERR_EMPTY} \\
%
\littleheader{Data type constants}
\refconst{PMIX_COORD} \\
\refconst{PMIX_REGATTR} \\
\refconst{PMIX_REGEX} \\
\refconst{PMIX_JOB_STATE} \\
\refconst{PMIX_LINK_STATE} \\
\refconst{PMIX_PROC_CPUSET} \\
\refconst{PMIX_GEOMETRY} \\
\refconst{PMIX_DEVICE_DIST} \\
\refconst{PMIX_ENDPOINT} \\
\refconst{PMIX_TOPO} \\
\refconst{PMIX_DEVTYPE} \\
\refconst{PMIX_LOCTYPE} \\
\refconst{PMIX_DATA_TYPE_MAX} \\
\refconst{PMIX_COMPRESSED_BYTE_OBJECT} \\
%
\littleheader{Info directives}
\refconst{PMIX_INFO_REQD_PROCESSED} \\
%
\littleheader{Server constants}
\refconst{PMIX_ERR_REPEAT_ATTR_REGISTRATION} \\
%
%
\littleheader{Job-Mgmt constants}
\refconst{PMIX_ERR_CONFLICTING_CLEANUP_DIRECTIVES} \\
%
%
\littleheader{Publish constants}
\refconst{PMIX_ERR_DUPLICATE_KEY} \\
%
%
\littleheader{Tool constants}
%
\refconst{PMIX_LAUNCHER_READY} \\
\refconst{PMIX_ERR_IOF_FAILURE} \\
\refconst{PMIX_ERR_IOF_COMPLETE} \\
\refconst{PMIX_EVENT_JOB_START} \\
\refconst{PMIX_LAUNCH_COMPLETE} \\
\refconst{PMIX_EVENT_JOB_END} \\
\refconst{PMIX_EVENT_SESSION_START} \\
\refconst{PMIX_EVENT_SESSION_END} \\
\refconst{PMIX_ERR_PROC_TERM_WO_SYNC} \\
\refconst{PMIX_ERR_JOB_CANCELED} \\
\refconst{PMIX_ERR_JOB_ABORTED} \\
\refconst{PMIX_ERR_JOB_KILLED_BY_CMD} \\
\refconst{PMIX_ERR_JOB_ABORTED_BY_SIG} \\
\refconst{PMIX_ERR_JOB_TERM_WO_SYNC} \\
\refconst{PMIX_ERR_JOB_SENSOR_BOUND_EXCEEDED} \\
\refconst{PMIX_ERR_JOB_NON_ZERO_TERM} \\
\refconst{PMIX_ERR_JOB_ABORTED_BY_SYS_EVENT} \\
\refconst{PMIX_DEBUG_WAITING_FOR_NOTIFY} \\
\refconst{PMIX_DEBUGGER_RELEASE} \\
%
%
\littleheader{Fabric constants}
\refconst{PMIX_FABRIC_UPDATE_PENDING} \\
\refconst{PMIX_FABRIC_UPDATED} \\
\refconst{PMIX_FABRIC_UPDATE_ENDPOINTS} \\
\refconst{PMIX_COORD_VIEW_UNDEF} \\
\refconst{PMIX_COORD_LOGICAL_VIEW} \\
\refconst{PMIX_COORD_PHYSICAL_VIEW} \\
\refconst{PMIX_LINK_STATE_UNKNOWN} \\
\refconst{PMIX_LINK_DOWN} \\
\refconst{PMIX_LINK_UP} \\
\refconst{PMIX_FABRIC_REQUEST_INFO} \\
\refconst{PMIX_FABRIC_UPDATE_INFO} \\
%
%
\littleheader{Sets-Groups constants}
\refconst{PMIX_PROCESS_SET_DEFINE} \\
\refconst{PMIX_PROCESS_SET_DELETE} \\
\refconst{PMIX_GROUP_INVITED} \\
\refconst{PMIX_GROUP_LEFT} \\
\refconst{PMIX_GROUP_MEMBER_FAILED} \\
\refconst{PMIX_GROUP_INVITE_ACCEPTED} \\
\refconst{PMIX_GROUP_INVITE_DECLINED} \\
\refconst{PMIX_GROUP_INVITE_FAILED} \\
\refconst{PMIX_GROUP_MEMBERSHIP_UPDATE} \\
\refconst{PMIX_GROUP_CONSTRUCT_ABORT} \\
\refconst{PMIX_GROUP_CONSTRUCT_COMPLETE} \\
\refconst{PMIX_GROUP_LEADER_FAILED} \\
\refconst{PMIX_GROUP_LEADER_SELECTED} \\
\refconst{PMIX_GROUP_CONTEXT_ID_ASSIGNED} \\
%
%
\littleheader{Process-Mgmt constants}
\refconst{PMIX_ERR_JOB_ALLOC_FAILED} \\
\refconst{PMIX_ERR_JOB_APP_NOT_EXECUTABLE} \\
\refconst{PMIX_ERR_JOB_NO_EXE_SPECIFIED} \\
\refconst{PMIX_ERR_JOB_FAILED_TO_MAP} \\
\refconst{PMIX_ERR_JOB_FAILED_TO_LAUNCH} \\
\refconst{PMIX_LOCALITY_UNKNOWN} \\
\refconst{PMIX_LOCALITY_NONLOCAL} \\
\refconst{PMIX_LOCALITY_SHARE_HWTHREAD} \\
\refconst{PMIX_LOCALITY_SHARE_CORE} \\
\refconst{PMIX_LOCALITY_SHARE_L1CACHE} \\
\refconst{PMIX_LOCALITY_SHARE_L2CACHE} \\
\refconst{PMIX_LOCALITY_SHARE_L3CACHE} \\
\refconst{PMIX_LOCALITY_SHARE_PACKAGE} \\
\refconst{PMIX_LOCALITY_SHARE_NUMA} \\
\refconst{PMIX_LOCALITY_SHARE_NODE} \\
%
%
\littleheader{Events}
\refconst{PMIX_EVENT_SYS_BASE} \\
\refconst{PMIX_EVENT_NODE_DOWN} \\
\refconst{PMIX_EVENT_NODE_OFFLINE} \\
\refconst{PMIX_EVENT_SYS_OTHER} \\
%
%
\subsection{Added Attributes}
%
\littleheader{Sync-Access attributes}
%
\pasteAttributeItem{PMIX_COLLECT_GENERATED_JOB_INFO}
\pasteAttributeItem{PMIX_ALL_CLONES_PARTICIPATE}
\pasteAttributeItem{PMIX_GET_POINTER_VALUES}
\pasteAttributeItem{PMIX_GET_STATIC_VALUES}
\pasteAttributeItem{PMIX_GET_REFRESH_CACHE}
\pasteAttributeItem{PMIX_QUERY_RESULTS}
\pasteAttributeItem{PMIX_QUERY_QUALIFIERS}
\pasteAttributeItem{PMIX_QUERY_SUPPORTED_KEYS}
\pasteAttributeItem{PMIX_QUERY_SUPPORTED_QUALIFIERS}
\pasteAttributeItem{PMIX_QUERY_NAMESPACE_INFO}
\pasteAttributeItem{PMIX_QUERY_ATTRIBUTE_SUPPORT}
\pasteAttributeItem{PMIX_QUERY_AVAIL_SERVERS}
\pasteAttributeItem{PMIX_SERVER_INFO_ARRAY}
\pasteAttributeItem{PMIX_CLIENT_FUNCTIONS}
\pasteAttributeItem{PMIX_CLIENT_ATTRIBUTES}
\pasteAttributeItem{PMIX_SERVER_FUNCTIONS}
\pasteAttributeItem{PMIX_SERVER_ATTRIBUTES}
\pasteAttributeItem{PMIX_HOST_FUNCTIONS}
\pasteAttributeItem{PMIX_HOST_ATTRIBUTES}
\pasteAttributeItem{PMIX_TOOL_FUNCTIONS}
\pasteAttributeItem{PMIX_TOOL_ATTRIBUTES}
%
%
\littleheader{Server attributes}
%
\pasteAttributeItem{PMIX_TOPOLOGY2}
\pasteAttributeItem{PMIX_SERVER_SHARE_TOPOLOGY}
\pasteAttributeItem{PMIX_SERVER_SESSION_SUPPORT}
\pasteAttributeItem{PMIX_SERVER_START_TIME}
\pasteAttributeItem{PMIX_SERVER_SCHEDULER}
\pasteAttributeItem{PMIX_JOB_INFO_ARRAY}
\pasteAttributeItem{PMIX_APP_INFO_ARRAY}
\pasteAttributeItem{PMIX_PROC_INFO_ARRAY}
\pasteAttributeItem{PMIX_NODE_INFO_ARRAY}
\pasteAttributeItem{PMIX_MAX_VALUE}
\pasteAttributeItem{PMIX_MIN_VALUE}
\pasteAttributeItem{PMIX_ENUM_VALUE}
\pasteAttributeItem{PMIX_HOMOGENEOUS_SYSTEM}
\pasteAttributeItem{PMIX_REQUIRED_KEY}
%
%
\littleheader{Job-Mgmt attributes}
%
\pasteAttributeItem{PMIX_ALLOC_ID}
\pasteAttributeItem{PMIX_ALLOC_QUEUE}
%
%
\littleheader{Publish attributes}
%
\pasteAttributeItem{PMIX_ACCESS_PERMISSIONS}
\pasteAttributeItem{PMIX_ACCESS_USERIDS}
\pasteAttributeItem{PMIX_ACCESS_GRPIDS}
%
%
\littleheader{Reserved keys}
%
\pasteAttributeItem{PMIX_NUM_ALLOCATED_NODES}
\pasteAttributeItem{PMIX_NUM_NODES}
\pasteAttributeItem{PMIX_CMD_LINE}
\pasteAttributeItem{PMIX_APP_ARGV}
\pasteAttributeItem{PMIX_PACKAGE_RANK}
\pasteAttributeItem{PMIX_REINCARNATION}
\pasteAttributeItem{PMIX_HOSTNAME_ALIASES}
\pasteAttributeItem{PMIX_HOSTNAME_KEEP_FQDN}
\pasteAttributeItem{PMIX_CPUSET_BITMAP}
\pasteAttributeItem{PMIX_EXTERNAL_PROGRESS}
\pasteAttributeItem{PMIX_NODE_MAP_RAW}
\pasteAttributeItem{PMIX_PROC_MAP_RAW}
%
%
\littleheader{Tool attributes}
%
\pasteAttributeItem{PMIX_TOOL_CONNECT_OPTIONAL}
\pasteAttributeItem{PMIX_TOOL_ATTACHMENT_FILE}
\pasteAttributeItem{PMIX_LAUNCHER_RENDEZVOUS_FILE}
\pasteAttributeItem{PMIX_PRIMARY_SERVER}
\pasteAttributeItem{PMIX_NOHUP}
\pasteAttributeItem{PMIX_LAUNCHER_DAEMON}
\pasteAttributeItem{PMIX_FORKEXEC_AGENT}
\pasteAttributeItem{PMIX_EXEC_AGENT}
\pasteAttributeItem{PMIX_IOF_PUSH_STDIN}
\pasteAttributeItem{PMIX_IOF_COPY}
\pasteAttributeItem{PMIX_IOF_REDIRECT}
\pasteAttributeItem{PMIX_DEBUG_TARGET}
\pasteAttributeItem{PMIX_DEBUG_DAEMONS_PER_PROC}
\pasteAttributeItem{PMIX_DEBUG_DAEMONS_PER_NODE}
\pasteAttributeItem{PMIX_WAIT_FOR_CONNECTION}
\pasteAttributeItem{PMIX_LAUNCH_DIRECTIVES}
%
%
\littleheader{Fabric attributes}
\pasteAttributeItem{PMIX_SERVER_SCHEDULER}
\pasteAttributeItem{PMIX_FABRIC_COST_MATRIX}
\pasteAttributeItem{PMIX_FABRIC_GROUPS}
\pasteAttributeItem{PMIX_FABRIC_VENDOR}
\pasteAttributeItem{PMIX_FABRIC_IDENTIFIER}
\pasteAttributeItem{PMIX_FABRIC_INDEX}
\pasteAttributeItem{PMIX_FABRIC_NUM_DEVICES}
\pasteAttributeItem{PMIX_FABRIC_COORDINATES}
\pasteAttributeItem{PMIX_FABRIC_DIMS}
\pasteAttributeItem{PMIX_FABRIC_ENDPT}
\pasteAttributeItem{PMIX_FABRIC_SHAPE}
\pasteAttributeItem{PMIX_FABRIC_SHAPE_STRING}
\pasteAttributeItem{PMIX_SWITCH_PEERS}
\pasteAttributeItem{PMIX_FABRIC_PLANE}
\pasteAttributeItem{PMIX_FABRIC_SWITCH}
\pasteAttributeItem{PMIX_FABRIC_DEVICE}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_INDEX}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_NAME}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_VENDOR}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_BUS_TYPE}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_VENDORID}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_DRIVER}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_FIRMWARE}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_ADDRESS}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_COORDINATES}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_MTU}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_SPEED}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_STATE}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_TYPE}
\pasteAttributeItem{PMIX_FABRIC_DEVICE_PCI_DEVID}
%
%
\littleheader{Device attributes}
\pasteAttributeItem{PMIX_DEVICE_DISTANCES}
\pasteAttributeItem{PMIX_DEVICE_TYPE}
\pasteAttributeItem{PMIX_DEVICE_ID}
%
%
\littleheader{Sets-Groups attributes}
\pasteAttributeItem{PMIX_QUERY_NUM_PSETS}
\pasteAttributeItem{PMIX_QUERY_PSET_NAMES}
\pasteAttributeItem{PMIX_QUERY_PSET_MEMBERSHIP}
\pasteAttributeItem{PMIX_PSET_NAME}
\pasteAttributeItem{PMIX_PSET_MEMBERS}
\pasteAttributeItem{PMIX_PSET_NAMES}
\pasteAttributeItem{PMIX_QUERY_NUM_GROUPS}
\pasteAttributeItem{PMIX_QUERY_GROUP_NAMES}
\pasteAttributeItem{PMIX_QUERY_GROUP_MEMBERSHIP}
\pasteAttributeItem{PMIX_GROUP_ID}
\pasteAttributeItem{PMIX_GROUP_LEADER}
\pasteAttributeItem{PMIX_GROUP_OPTIONAL}
\pasteAttributeItem{PMIX_GROUP_NOTIFY_TERMINATION}
\pasteAttributeItem{PMIX_GROUP_FT_COLLECTIVE}
\pasteAttributeItem{PMIX_GROUP_ASSIGN_CONTEXT_ID}
\pasteAttributeItem{PMIX_GROUP_LOCAL_ONLY}
\pasteAttributeItem{PMIX_GROUP_CONTEXT_ID}
\pasteAttributeItem{PMIX_GROUP_ENDPT_DATA}
\pasteAttributeItem{PMIX_GROUP_NAMES}
%
%
\littleheader{Process Mgmt attributes}
\pasteAttributeItem{PMIX_OUTPUT_TO_DIRECTORY}
\pasteAttributeItem{PMIX_TIMEOUT_STACKTRACES}
\pasteAttributeItem{PMIX_TIMEOUT_REPORT_STATE}
\pasteAttributeItem{PMIX_NOTIFY_JOB_EVENTS}
\pasteAttributeItem{PMIX_NOTIFY_PROC_TERMINATION}
\pasteAttributeItem{PMIX_NOTIFY_PROC_ABNORMAL_TERMINATION}
\pasteAttributeItem{PMIX_LOG_PROC_TERMINATION}
\pasteAttributeItem{PMIX_LOG_PROC_ABNORMAL_TERMINATION}
\pasteAttributeItem{PMIX_LOG_JOB_EVENTS}
\pasteAttributeItem{PMIX_LOG_COMPLETION}
\pasteAttributeItem{PMIX_FIRST_ENVAR}
%
%
\littleheader{Event attributes}
\pasteAttributeItem{PMIX_EVENT_TIMESTAMP}
%
%
\subsection{Added Environmental Variables}
%
\littleheader{Tool environmental variables}
\refenvar{PMIX_LAUNCHER_RNDZ_URI} \\
\refenvar{PMIX_LAUNCHER_RNDZ_FILE} \\
\refenvar{PMIX_KEEPALIVE_PIPE} \\
%
%
\subsection{Added Macros}
%
\refmacro{PMIX_CHECK_RESERVED_KEY}
\refmacro{PMIX_INFO_WAS_PROCESSED}
\refmacro{PMIX_INFO_PROCESSED}
\refmacro{PMIX_INFO_LIST_START}
\refmacro{PMIX_INFO_LIST_ADD}
\refmacro{PMIX_INFO_LIST_XFER}
\refmacro{PMIX_INFO_LIST_CONVERT}
\refmacro{PMIX_INFO_LIST_RELEASE}
%
%
\subsection{Deprecated \acp{API}}
\declareapiDEP{pmix_evhdlr_reg_cbfunc_t}
Renamed to \refapi{pmix_hdlr_reg_cbfunc_t}
The \refapiDEP{pmix_server_client_connected_fn_t} server module entry point has
been \emph{deprecated} in favor of
\refapi{pmix_server_client_connected2_fn_t}
\declareapiDEP{PMIx_tool_connect_to_server}
Replaced by \refapi{PMIx_tool_attach_to_server} to allow return of the process identifier of the server to which the tool has attached.
\subsection{Deprecated constants}
The following constants were deprecated in v4.0:
\begin{constantdesc}
%
\declareconstitemDEP{PMIX_ERR_DEBUGGER_RELEASE}
Renamed to \refconst{PMIX_DEBUGGER_RELEASE}
%
\declareconstitemDEP{PMIX_ERR_JOB_TERMINATED}
Renamed to \refconst{PMIX_EVENT_JOB_END}
%
\declareconstitemDEP{PMIX_EXISTS}
Renamed to \refconst{PMIX_ERR_EXISTS}
%
\declareconstitemDEP{PMIX_ERR_PROC_ABORTED}
Consolidated with \refconst{PMIX_EVENT_PROC_TERMINATED}
%
\declareconstitemDEP{PMIX_ERR_PROC_ABORTING}
Consolidated with \refconst{PMIX_EVENT_PROC_TERMINATED}
%
\declareconstitemDEP{PMIX_ERR_LOST_CONNECTION_TO_SERVER}
Consolidated into \refconst{PMIX_ERR_LOST_CONNECTION}
%
\declareconstitemDEP{PMIX_ERR_LOST_PEER_CONNECTION}
Consolidated into \refconst{PMIX_ERR_LOST_CONNECTION}
%
\declareconstitemDEP{PMIX_ERR_LOST_CONNECTION_TO_CLIENT}
Consolidated into \refconst{PMIX_ERR_LOST_CONNECTION}
%
\declareconstitemDEP{PMIX_ERR_INVALID_TERMINATION}
Renamed to \refconst{PMIX_ERR_JOB_TERM_WO_SYNC}
%
\declareconstitemDEP{PMIX_PROC_TERMINATED}
Renamed to \refconst{PMIX_EVENT_PROC_TERMINATED}
%
\declareconstitemDEP{PMIX_ERR_NODE_DOWN}
Renamed to \refconst{PMIX_EVENT_NODE_DOWN}
%
\declareconstitemDEP{PMIX_ERR_NODE_OFFLINE}
Renamed to \refconst{PMIX_EVENT_NODE_OFFLINE}
%
\declareconstitemDEP{PMIX_ERR_SYS_OTHER}
Renamed to \refconst{PMIX_EVENT_SYS_OTHER}
%
\declareconstitemDEP{PMIX_CONNECT_REQUESTED}
Connection has been requested by a PMIx-based tool - deprecated as
not required.
%
\declareconstitemDEP{PMIX_PROC_HAS_CONNECTED}
A tool or client has connected to the \ac{PMIx} server - deprecated in
favor of the new \refapi{pmix_server_client_connected2_fn_t} server
module \ac{API}
%
\end{constantdesc}
\subsection{Removed constants}
The following constants were removed from the \ac{PMIx} Standard in v4.0
as they are internal to a particular \ac{PMIx} implementation.
\begin{constantdesc}
%!TEX encoding = UTF-8 Unicode
\declareconstitemRM{PMIX_ERR_HANDSHAKE_FAILED}
Connection handshake failed
%
\declareconstitemRM{PMIX_ERR_READY_FOR_HANDSHAKE}
Ready for handshake
%
\declareconstitemRM{PMIX_ERR_IN_ERRNO}
Error defined in \code{errno}
%
\declareconstitemRM{PMIX_ERR_INVALID_VAL_LENGTH}
Invalid value length
%
\declareconstitemRM{PMIX_ERR_INVALID_LENGTH}
Invalid argument length
%
\declareconstitemRM{PMIX_ERR_INVALID_NUM_ARGS}
Invalid number of arguments
%
\declareconstitemRM{PMIX_ERR_INVALID_ARGS}
Invalid arguments
%
\declareconstitemRM{PMIX_ERR_INVALID_NUM_PARSED}
Invalid number parsed
%
\declareconstitemRM{PMIX_ERR_INVALID_KEYVALP}
Invalid key/value pair
%
\declareconstitemRM{PMIX_ERR_INVALID_SIZE}
Invalid size
%