-
Notifications
You must be signed in to change notification settings - Fork 29
/
psm2.h
1767 lines (1624 loc) · 75.9 KB
/
psm2.h
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
/*
This file is provided under a dual BSD/GPLv2 license. When using or
redistributing this file, you may do so under either license.
GPL LICENSE SUMMARY
Copyright(c) 2017 Intel Corporation.
This program is free software; you can redistribute it and/or modify
it under the terms of version 2 of the GNU General Public License as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
Contact Information:
Intel Corporation, www.intel.com
BSD LICENSE
Copyright(c) 2017 Intel Corporation.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
* Neither the name of Intel Corporation nor the names of its
contributors may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef PSM2_H
#define PSM2_H
#include <stdint.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C" {
#endif
/*!
* @file psm2.h
* @page psm2_main PSM2 API
*
* @brief PSM2 OPA Messaging Library
*
* The PSM2 OPA Messaging API, or PSM2 API, is Intel's low-level
* user-level communications interface for the OPA family of products.
* PSM2 users are enabled with mechanisms necessary to implement higher level
* communications interfaces in parallel environments.
*
* Since PSM2 targets clusters of multicore processors, it internally implements
* two levels of communication: intra-node shared memory communication and
* inter-node OPA communication. Both of these levels are encapsulated
* below the interface and the user is free to assume that intra-node and
* inter-node communication is transparently handled within PSM.
*
* @section compat Compatibility
*
* PSM2 can coexist with other QLogic/Pathscale software distributions, such as
* OpenIB/OpenFabrics, which allows applications to simultaneously target
* PSM-based and non PSM-based applications on a single node without changing
* any system-level configuration. However, PSM2 does not support running
* PSM-based and non PSM-based communication within the same user process.
*
* Except where noted, PSM2 does not assume an SPMD (single program, multiple
* data) parallel model and extends to MPMD (multiple program, multiple data)
* environments in specific areas. However, PSM2 assumes the runtime environment
* to be homogeneous on all nodes in bit width (32-bit or 64-bit) and endianness
* (little or big) and will fail at startup if any of these assumptions do not
* hold. For homogeneous systems PSM2 can run either in 32-bit or 64-bit
* environments. Even though both environments should expect similar
* performance from the API, PSM2 has chosen to favor 64-bit environments in
* some minor areas.
*
* @section ep_model Endpoint Communication Model
*
* PSM2 follows an endpoint communication model where an endpoint is defined as
* an object (or handle) instantiated to support sending and receiving messages
* to other endpoints. In order to prevent PSM2 from being tied to a particular
* parallel model (such as SPMD), control over the parallel layout of endpoints
* is retained by the user. Opening endpoints (@ref psm2_ep_open) and
* connecting endpoints to enable communication (@ref psm2_ep_connect) are two
* decoupled mechanisms. Users that do not dynamically change the number of
* endpoints beyond parallel startup will probably lump both mechanisms
* together at startup. Users that wish to manipulate the location and number
* of endpoints at runtime can do so by explicitly connecting sets or subsets
* of endpoints.
*
* As a side effect, this greater flexibility forces the user to cope with a
* two-stage initialization process. In the first stage of opening an endpoint
* (@ref psm2_ep_open), a user obtains an opaque handle to the endpoint and a
* globally distributable endpoint identifier (@ref psm2_epid_t). Prior to the
* second stage of connecting endpoints (@ref psm2_ep_connect), a user must
* distribute all relevent endpoint identifiers through an out-of-band
* mechanism. Once the endpoint identifiers are successfully distributed to
* all processes that wish to communicate, the user
* connects all endpoint identifiers to the locally opened endpoint
* (@ref psm2_ep_connect). In connecting the endpoints, the user obtains an
* opaque endpoint address (@ref psm2_epaddr_t), which is required for all PSM
* communication primitives.
*
*
* @section components PSM2 Components
*
* PSM2 exposes a single endpoint initialization model, but enables various
* levels of communication functionality and semantics through @e components.
* The first major component available in PSM2 is PSM2 Matched Queues
* (@ref psm2_mq), and the second is PSM2 Active Message (@ref psm2_am).
*
* Matched Queues (MQ) present a queue-based communication model with the
* distinction that queue consumers use a 3-tuple of metadata to match incoming
* messages against a list of preposted receive buffers. The MQ semantics are
* sufficiently akin to MPI to cover the entire MPI-1.2 standard.
*
* The Active Message (AM) component presents a request/reply model where
* the arrival of a message triggers the execution of consumer-provided
* handler code. This can be used to implement many one-sided and two-sided
* communications paradigms.
*
* With future releases of the PSM2 interface, more components will
* be exposed to accommodate users that implement parallel communication
* models that deviate from the Matched Queue semantics. For example, PSM
* plans to expose a connection management component to make it easier to
* handle endpoint management for clients without their own connection
* managers.
*
*
* @section progress PSM2 Communication Progress Guarantees
*
* PSM2 internally ensures progress of both intra-node and inter-node messages,
* but not autonomously. This means that while performance does not depend
* greatly on how the user decides to schedule communication progress,
* explicit progress calls are required for correctness. The @ref psm2_poll
* function is available to make progress over all PSM2 components in a generic
* manner. For more information on making progress over many communication
* operations in the MQ component, see the @ref mq_progress documentation.
*
*
* @section completion PSM2 Completion semantics
*
* PSM2 implements the MQ component, which documents its own
* message completion semantics (@ref mq_completion).
*
*
* @section error_handling PSM2 Error handling
*
* PSM2 exposes a list of user and runtime errors enumerated in @ref psm2_error.
* While most errors are fatal in that the user is not expected to be able to
* recover from them, PSM2 still allows some level of control. By
* default, PSM2 returns all errors to the user but as a convenience, allows
* users to either defer errors internally to PSM2 or to have PSM2 return all
* errors to the user (callers to PSM2 functions). PSM2 attempts to deallocate
* its resources as a best effort, but exits are always non-collective with
* respect to endpoints opened in other processes. The user is expected to be
* able to handle non-collective exits from any endpoint and in turn cleanly
* and independently terminate the parallel environment. Local error handling
* can be handled in three modes:
*
* Errors and error handling can be individually registered either globally or
* per-endpoint:
* @li @b Per-endpoint error handling captures errors for functions where the
* error scoping is determined to be over an endpoint. This includes all
* communication functions that include an EP or MQ handle as the first
* parameter.
*
* @li @b Global error handling captures errors for functions where a
* particular endpoint cannot be identified or for @ref psm2_ep_open, where
* errors (if any) occur before the endpoint is opened.
*
* Error handling is controlled by registering error handlers (@ref
* psm2_error_register_handler). The global error handler can
* be set at any time (even before @ref psm2_init), whereas a per-endpoint error
* handler can be set as soon as a new endpoint is successfully created. If a
* per-endpoint handle is not registered, the per-endpoint handler inherits
* from the global error handler at time of open.
*
* PSM2 predefines two different mechanisms for handling errors:
*
* @li PSM-internal error handler (@ref PSM2_ERRHANDLER_PSM_HANDLER)
* @li No-op PSM2 error handler where errors are returned
* (@ref PSM2_ERRHANDLER_NO_HANDLER)
*
* The default PSM-internal error handler effectively frees the user from
* explicitly handling the return values of ever PSM2 function but may not
* return to the user in a function determined to have caused a fatal error.
*
* The No-op PSM2 error handler bypasses all error handling functionality and
* always returns the error to the user. The user can then use @ref
* psm2_error_get_string to obtain a generic string from an error code (compared
* to a more detailed error message available through registering of error
* handlers).
*
* For even more control, users can register their own error handlers to have
* access to more precise error strings and selectively control when an when
* not to return to callers of PSM2 functions. All error handlers shown defer
* error handling to PSM2 for errors that are not recognized using @ref
* psm2_error_defer. Deferring an error from a custom error handler is
* equivalent to relying on the default error handler.
*
* @section env_var Environment variables
*
* Some PSM2 behaviour can be controlled via environment variables.
*
* @li @b PSM2_DEVICES. PSM2 implements three devices for communication which
* are, in order, @c self, @c shm and @c hfi. For PSM2 jobs that do not
* require shared-memory communications, @b PSM2_DEVICES can be specified as @c
* self, @c hfi. Similarly, for shared-memory only jobs, the @c hfi device
* can be disabled. It is up to the user to ensure that the endpoint ids
* passed in @ref psm2_ep_connect do not require a device that has been
* explicitly disabled by the user. In some instances, enabling only the
* devices that are required may improve performance.
*
* @li @b PSM2_TRACEMASK. Depending on the value of the tracemask, various parts
* of PSM2 will output debugging information. With a default value of @c 0x1,
* informative messages will be printed (this value should be considered a
* minimum). At @c 0x101, startup and finalization messages are added to the
* output. At @c 0x1c3, every communication event is logged and should hence
* be used for extreme debugging only.
*
* @li @b PSM2_MULTI_EP. By default, only one PSM2 endpoint may be opened in
* a process. With the correct setting of this environment variable, a process
* may open more than one PSM2 endpoint. In order to enable multiple endpoint
* per process support, the value of this environment variable should be set
* to "1" or "yes".
*
* @section thr_sfty Thread safety and reentrancy
* Unless specifically noted otherwise, all PSM2 functions should not be considered
* to be thread safe or reentrant.
*/
/** @brief Local endpoint handle (opaque)
* @ingroup ep
*
* Handle returned to the user when a new local endpoint is created. The
* handle is a local handle to be used in all communication functions and is
* not intended to globally identify the opened endpoint in any way.
*
* All open endpoint handles can be globally identified using the endpoint id
* integral type (@ref psm2_epid_t) and all communication must use an endpoint
* address (@ref psm2_epaddr_t) that can be obtained by connecting a local
* endpoint to one or more endpoint identifiers.
*
* @remark The local endpoint handle is opaque to the user. */
typedef struct psm2_ep *psm2_ep_t;
/** @brief MQ handle (opaque)
* @ingroup mq
*
* Handle returned to the user when a new Matched queue is created (@ref
* psm2_mq_init). */
typedef struct psm2_mq *psm2_mq_t;
/*! @defgroup init PSM2 Initialization and Maintenance
* @{
*/
#define PSM2_VERNO 0x0202 /*!< Header-defined Version number */
#define PSM2_VERNO_MAJOR 0x02 /*!< Header-defined Major Version Number */
#define PSM2_VERNO_MINOR 0x02 /*!< Header-defined Minor Version Number */
#define PSM2_VERNO_COMPAT_MAJOR 0x01 /*!<Minimum PSM1 Major Version Number for Compatibility */
/*! @brief PSM2 Error type
*/
enum psm2_error {
/*! Interface-wide "ok", guaranteed to be 0. */
PSM2_OK = 0,
/*! No events progressed on @ref psm2_poll (not fatal) */
PSM2_OK_NO_PROGRESS = 1,
/*! Error in a function parameter */
PSM2_PARAM_ERR = 3,
/*! PSM2 ran out of memory */
PSM2_NO_MEMORY = 4,
/*! PSM2 has not been initialized by @ref psm2_init */
PSM2_INIT_NOT_INIT = 5,
/*! API version passed in @ref psm2_init is incompatible */
PSM2_INIT_BAD_API_VERSION = 6,
/*! PSM2 Could not set affinity */
PSM2_NO_AFFINITY = 7,
/*! PSM2 Unresolved internal error */
PSM2_INTERNAL_ERR = 8,
/*! PSM2 could not set up shared memory segment */
PSM2_SHMEM_SEGMENT_ERR = 9,
/*! PSM2 option is a read-only option */
PSM2_OPT_READONLY = 10,
/*! PSM2 operation timed out */
PSM2_TIMEOUT = 11,
/*! Too many endpoints */
PSM2_TOO_MANY_ENDPOINTS = 12,
/*! PSM2 is finalized */
PSM2_IS_FINALIZED = 13,
/*! Endpoint was closed */
PSM2_EP_WAS_CLOSED = 20,
/*! PSM2 Could not find an OPA Unit */
PSM2_EP_NO_DEVICE = 21,
/*! User passed a bad unit or port number */
PSM2_EP_UNIT_NOT_FOUND = 22,
/*! Failure in initializing endpoint */
PSM2_EP_DEVICE_FAILURE = 23,
/*! Error closing the endpoing error */
PSM2_EP_CLOSE_TIMEOUT = 24,
/*! No free ports could be obtained */
PSM2_EP_NO_PORTS_AVAIL = 25,
/*! Could not detect network connectivity */
PSM2_EP_NO_NETWORK = 26,
/*! Invalid Unique job-wide UUID Key */
PSM2_EP_INVALID_UUID_KEY = 27,
/*! Internal out of resources */
PSM2_EP_NO_RESOURCES = 28,
/*! Endpoint connect status unknown (because of other failures or if
* connect attempt timed out) */
PSM2_EPID_UNKNOWN = 40,
/*! Endpoint could not be reached by any PSM2 component */
PSM2_EPID_UNREACHABLE = 41,
/*! At least one of the connecting nodes was incompatible in endianess */
PSM2_EPID_INVALID_NODE = 43,
/*! At least one of the connecting nodes provided an invalid MTU */
PSM2_EPID_INVALID_MTU = 44,
/*! At least one of the connecting nodes provided a bad key */
PSM2_EPID_INVALID_UUID_KEY = 45,
/*! At least one of the connecting nodes is running an incompatible
* PSM2 protocol version */
PSM2_EPID_INVALID_VERSION = 46,
/*! At least one node provided garbled information */
PSM2_EPID_INVALID_CONNECT = 47,
/*! EPID was already connected */
PSM2_EPID_ALREADY_CONNECTED = 48,
/*! EPID is duplicated, network connectivity problem */
PSM2_EPID_NETWORK_ERROR = 49,
/*! EPID incompatible partition keys */
PSM2_EPID_INVALID_PKEY = 50,
/*! Unable to resolve path for endpoint */
PSM2_EPID_PATH_RESOLUTION = 51,
/*! MQ Non-blocking request is incomplete */
PSM2_MQ_NO_COMPLETIONS = 60,
/*! MQ Message has been truncated at the receiver */
PSM2_MQ_TRUNCATION = 61,
/*! AM reply error */
PSM2_AM_INVALID_REPLY = 70,
/*! Info query invalid query error */
PSM2_IQ_INVALID_QUERY = 71,
/*! Reserved Value to indicate highest ENUM value */
PSM2_ERROR_LAST = 80
};
/*! Backwards header compatibility for a confusing error return name */
#define PSM2_MQ_INCOMPLETE PSM2_MQ_NO_COMPLETIONS
/*! @see psm2_error */
typedef enum psm2_error psm2_error_t;
/*! @brief PSM2 Error type
*/
enum psm2_component {
/*! PSM2 core library */
PSM2_COMPONENT_CORE = 0,
/*! MQ component */
PSM2_COMPONENT_MQ = 1,
/*! AM component */
PSM2_COMPONENT_AM = 2,
/*! IB component */
PSM2_COMPONENT_IB = 3
};
/*! @see psm2_component */
typedef enum psm2_component psm2_component_t;
/*! @brief PSM2 Path resolution mechanism
*/
enum psm2_path_res {
/*! PSM2 no path resolution */
PSM2_PATH_RES_NONE = 0,
/*! Use OFED Plus for path resolution */
PSM2_PATH_RES_OPP = 1,
/*! Use OFED UMAD for path resolution */
PSM2_PATH_RES_UMAD = 2
};
/*! @see psm2_path_resolution */
typedef enum psm2_path_res psm2_path_res_t;
/** @brief Initialize PSM2 interface
*
* Call to initialize the PSM2 library for a desired API revision number.
*
* @param[in,out] api_verno_major As input a pointer to an integer that holds
* @ref PSM2_VERNO_MAJOR. As output, the pointer
* is updated with the major revision number of
* the loaded library.
* @param[in,out] api_verno_minor As input, a pointer to an integer that holds
* @ref PSM2_VERNO_MINOR. As output, the pointer
* is updated with the minor revision number of
* the loaded library.
*
* @pre The user has not called any other PSM2 library call except @ref
* psm2_error_register_handler to register a global error handler.
*
* @post Depending on the environment variable @ref PSM2_MULTI_EP being set and
* its contents, support for opening multiple endpoints is either enabled
* or disabled.
*
* @warning PSM2 initialization is a precondition for all functions used in the
* PSM2 library.
*
* @returns PSM2_OK The PSM2 interface could be opened and the desired API
* revision can be provided.
* @returns PSM2_INIT_BAD_API_VERSION The PSM2 library cannot compatibility for
* the desired API version.
*
* @code{.c}
// In this example, we want to handle our own errors before doing init,
// since we don't want a fatal error if OPA is not found.
// Note that @ref psm2_error_register_handler
// (and @ref psm2_uuid_generate and @ref psm2_get_capability_mask)
// are the only function that can be called before @ref psm2_init
int try_to_initialize_psm() {
int verno_major = PSM2_VERNO_MAJOR;
int verno_minor = PSM2_VERNO_MINOR;
int err = psm2_error_register_handler(NULL, // Global handler
PSM2_ERRHANDLER_NO_HANDLER); // return errors
if (err) {
fprintf(stderr, "Couldn't register global handler: %s\n",
psm2_error_get_string(err));
return -1;
}
err = psm2_init(&verno_major, &verno_minor);
if (err || verno_major > PSM2_VERNO_MAJOR) {
if (err)
fprintf(stderr, "PSM2 initialization failure: %s\n",
psm2_error_get_string(err));
else
fprintf(stderr, "PSM2 loaded an unexpected/unsupported "
"version (%d.%d)\n", verno_major, verno_minor);
return -1;
}
// We were able to initialize PSM2 but will defer all further error
// handling since most of the errors beyond this point will be fatal.
int err = psm2_error_register_handler(NULL, // Global handler
PSM2_ERRHANDLER_PSM_HANDLER);
if (err) {
fprintf(stderr, "Couldn't register global errhandler: %s\n",
psm2_error_get_string(err));
return -1;
}
return 1;
}
@endcode
*/
psm2_error_t psm2_init(int *api_verno_major, int *api_verno_minor);
/*! @brief PSM2 capabilities definitions
*
* Each capability is defined as a separate bit,
* i.e. next capabilities must be defined as
* consecutive bits : 0x2, 0x4 ... and so on.
*/
#define PSM2_MULTI_EP_CAP 0x1 /* Multiple Endpoints capability */
#define PSM2_LIB_REFCOUNT_CAP 0x2 /* Library finalization is managed with reference count */
/** @brief PSM2 capabilities provider
*
* @param[in] req_cap_mask Requested capabilities are given as bit field.
*
* @returns internal capabilities bit field ANDed with a requested bit mask */
uint64_t psm2_get_capability_mask(uint64_t req_cap_mask);
/** @brief Finalize PSM2 interface
*
* Single call to finalize PSM2 and close all unclosed endpoints
*
* @post The user guarantees not to make any further PSM2 calls, including @ref
* psm2_init.
*
* @returns PSM2_OK Always returns @c PSM2_OK */
psm2_error_t psm2_finalize(void);
/** @brief Error handling opaque token
*
* A token is required for users that register their own handlers and wish to
* defer further error handling to PSM. */
typedef struct psm2_error_token *psm2_error_token_t;
/** @brief Error handling function
*
* Users can handle errors explicitly instead of relying on PSM's own error
* handler. There is one global error handler and error handlers that can be
* individually set for each opened endpoint. By default, endpoints will
* inherit the global handler registered at the time of open.
*
* @param[in] ep Handle associated to the endpoint over which the error occurred
* or @c NULL if the error is being handled by the global error
* handler.
* @param[in] error PSM2 error identifier
* @param[in] error_string A descriptive error string of maximum length @ref
* PSM2_ERRSTRING_MAXLEN.
* @param[in] token Opaque PSM2 token associated with the particular event that
* generated the error. The token can be used to extract the
* error string and can be passed to @ref psm2_error_defer to
* defer any remaining or unhandled error handling to PSM.
*
* @post If the error handler returns, the error returned is propagated to the
* caller. */
typedef psm2_error_t(*psm2_ep_errhandler_t) (psm2_ep_t ep,
const psm2_error_t error,
const char *error_string,
psm2_error_token_t token);
#define PSM2_ERRHANDLER_DEFAULT ((psm2_ep_errhandler_t)-1)
/**< Obsolete names, only here for backwards compatibility */
#define PSM2_ERRHANDLER_NOP ((psm2_ep_errhandler_t)-2)
/**< Obsolete names, only here for backwards compatibility */
#define PSM2_ERRHANDLER_PSM_HANDLER ((psm2_ep_errhandler_t)-1)
/**< PSM2 error handler as explained in @ref error_handling */
#define PSM2_ERRHANDLER_NO_HANDLER ((psm2_ep_errhandler_t)-2)
/**< Bypasses the default PSM2 error handler and returns all errors to the user
* (this is the default) */
#define PSM2_ERRSTRING_MAXLEN 512 /**< Maximum error string length. */
/** @brief PSM2 error handler registration
*
* Function to register error handlers on a global basis and on a per-endpoint
* basis. PSM2_ERRHANDLER_PSM_HANDLER and PSM2_ERRHANDLER_NO_HANDLER are special
* pre-defined handlers to respectively enable use of the default PSM-internal
* handler or the no-handler that disables registered error handling and
* returns all errors to the caller (both are documented in @ref
* error_handling).
*
* @param[in] ep Handle of the endpoint over which the error handler should be
* registered. With ep set to @c NULL, the behavior of the
* global error handler can be controlled.
* @param[in] errhandler Handler to register. Can be a user-specific error
* handling function or PSM2_ERRHANDLER_PSM_HANDLER or
* PSM2_ERRHANDLER_NO_HANDLER.
*
* @remark When ep is set to @c NULL, this is the only function that can be
* called before @ref psm2_init
*/
psm2_error_t
psm2_error_register_handler(psm2_ep_t ep, const psm2_ep_errhandler_t errhandler);
/** @brief PSM2 deferred error handler
*
* Function to handle fatal PSM2 errors if no error handler is installed or if
* the user wishes to defer further error handling to PSM. Depending on the
* type of error, PSM2 may or may not return from the function call.
*
* @param[in] err_token Error token initially passed to error handler
*
* @pre The user is calling into the function because it has decided that PSM
* should handle an error case.
*
* @post The function may or may not return depending on the error
*/
psm2_error_t psm2_error_defer(psm2_error_token_t err_token);
/** @brief Get generic error string from error
*
* Function to return the default error string associated to a PSM2 error.
*
* While a more detailed and precise error string is usually available within
* error handlers, this function is available to obtain an error string out of
* an error handler context or when a no-op error handler is registered.
*
* @param[in] error PSM2 error
*/
const char *psm2_error_get_string(psm2_error_t error);
/** @brief Option key/pair structure
*
* Currently only used in MQ.
*/
struct psm2_optkey {
uint32_t key; /**< Option key */
void *value; /**< Option value */
};
/*! @} */
/*! @defgroup ep PSM2 Device Endpoint Management
* @{
*/
/** @brief Endpoint ID
*
* Integral type of size 8 bytes that can be used by the user to globally
* identify a successfully opened endpoint. Although the contents of the
* endpoint id integral type remains opaque to the user, unique network id and
* OPA port number can be extracted using @ref psm2_epid_nid and @ref
* psm2_epid_context.
*/
typedef uint64_t psm2_epid_t;
/** @brief Endpoint Address (opaque)
*
* Remote endpoint addresses are created when the user binds an endpoint ID
* to a particular endpoint handle using @ref psm2_ep_connect. A given endpoint
* address is only guaranteed to be valid over a single endpoint.
*/
typedef struct psm2_epaddr *psm2_epaddr_t;
/** @brief PSM2 Unique UID
*
* PSM2 type equivalent to the DCE-1 uuid_t, used to uniquely identify an
* endpoint within a particular job. Since PSM2 does not participate in job
* allocation and management, users are expected to generate a unique ID to
* associate endpoints to a particular parallel or collective job.
* @see psm2_uuid_generate
*/
typedef uint8_t psm2_uuid_t[16];
/** @brief Get Endpoint identifier's Unique Network ID */
uint64_t psm2_epid_nid(psm2_epid_t epid);
/** @brief Get Endpoint identifier's OPA context number */
uint64_t psm2_epid_context(psm2_epid_t epid);
/** @brief Get Endpoint identifier's OPA port (deprecated, use
* @ref psm2_epid_context instead) */
uint64_t psm2_epid_port(psm2_epid_t epid);
/** @brief List the number of available OPA units
*
* Function used to determine the number of locally available OPA units.
* For @c N units, valid unit numbers in @ref psm2_ep_open are @c 0 to @c N-1.
*
* @returns PSM2_OK unless the user has not called @ref psm2_init
*/
psm2_error_t psm2_ep_num_devunits(uint32_t *num_units);
/** @brief Utility to generate UUIDs for @ref psm2_ep_open
*
* This function is available as a utility for generating unique job-wide ids.
* See discussion in @ref psm2_ep_open for further information.
*
* @remark This function does not require PSM2 to be initialized.
*/
void psm2_uuid_generate(psm2_uuid_t uuid_out);
/* Affinity modes for the affinity member of struct psm2_ep_open_opts */
#define PSM2_EP_OPEN_AFFINITY_SKIP 0 /**< Disable setting affinity */
#define PSM2_EP_OPEN_AFFINITY_SET 1 /**< Enable setting affinity unless
already set */
#define PSM2_EP_OPEN_AFFINITY_FORCE 2 /**< Enable setting affinity regardless
of current affinity setting */
/* Default values for some constants */
#define PSM2_EP_OPEN_PKEY_DEFAULT 0xffffffffffffffffULL
/**< Default protection key */
/** @brief Endpoint Open Options
*
* These options are available for opening a PSM2 endpoint. Each is
* individually documented and setting each option to -1 or passing NULL as the
* options parameter in @ref psm2_ep_open instructs PSM2 to use
* implementation-defined defaults.
*
* Each option is documented in @ref psm2_ep_open
*/
struct psm2_ep_open_opts {
int64_t timeout; /**< timeout in nanoseconds to open device */
int unit; /**< OPA Unit ID to open on */
int affinity; /**< How PSM2 should set affinity */
int shm_mbytes; /**< Megabytes used for intra-node, deprecated */
int sendbufs_num; /**< Preallocated send buffers */
uint64_t network_pkey; /**< Network Protection Key (v1.01) */
int port; /**< IB port to use (1 to N) */
int outsl; /**< IB SL to use when sending pkts */
uint64_t service_id; /* IB Service ID to use for endpoint */
psm2_path_res_t path_res_type; /* Path resolution type */
int senddesc_num; /* Preallocated send descriptors */
int imm_size; /* Immediate data size for endpoint */
};
/** @brief OPA endpoint creation
*
* Function used to create a new local communication endpoint on an OPA
* adapter. The returned endpoint handle is required in all PSM2 communication
* operations, as PSM2 can manage communication over multiple endpoints. An
* opened endpoint has no global context until the user connects the endpoint
* to other global endpoints by way of @ref psm2_ep_connect. All local endpoint
* handles are globally identified by endpoint IDs (@ref psm2_epid_t) which are
* also returned when an endpoint is opened. It is assumed that the user can
* provide an out-of-band mechanism to distribute the endpoint IDs in order to
* establish connections between endpoints (@ref psm2_ep_connect for more
* information).
*
* @param[in] unique_job_key Endpoint key, to uniquely identify the endpoint in
* a parallel job. It is up to the user to ensure
* that the key is globally unique over a period long
* enough to prevent duplicate keys over the same set
* of endpoints (see comments below).
*
* @param[in] opts Open options of type @ref psm2_ep_open_opts
* (see @ref psm2_ep_open_opts_get_defaults).
*
* @param[out] ep User-supplied storage to return a pointer to the newly
* created endpoint. The returned pointer of type @ref psm2_ep_t
* is a local handle and cannot be used to globally identify the
* endpoint.
* @param[out] epid User-supplied storage to return the endpoint ID associated
* to the newly created local endpoint returned in the @c ep
* handle. The endpoint ID is an integral type suitable for
* uniquely identifying the local endpoint.
*
* PSM2 does not internally verify the consistency of the uuid, it is up to the
* user to ensure that the uid is unique enough not to collide with other
* currently-running jobs. Users can employ three mechanisms to obtain a uuid.
*
* 1. Use the supplied @ref psm2_uuid_generate utility
*
* 2. Use an OS or library-specific uuid generation utility, that complies with
* OSF DCE 1.1, such as @c uuid_generate on Linux or @c uuid_create on
* FreeBSD.
* (see http://www.opengroup.org/onlinepubs/009629399/uuid_create.htm)
*
* 3. Manually pack a 16-byte string using a utility such as /dev/random or
* other source with enough entropy and proper seeding to prevent two nodes
* from generating the same uuid_t.
*
* The following options are relevent when opening an endpoint:
* @li @c timeout establishes the number of nanoseconds to wait before
* failing to open a port (with -1, defaults to 15 secs).
* @li @c unit sets the OPA unit number to use to open a port (with
* -1, PSM2 determines the best unit to open the port). If @c
* HFI_UNIT is set in the environment, this setting is ignored.
* @li @c affinity enables or disables PSM2 setting processor affinity. The
* option can be controlled to either disable (@ref
* PSM2_EP_OPEN_AFFINITY_SKIP) or enable the affinity setting
* only if it is already unset (@ref
* PSM2_EP_OPEN_AFFINITY_SET) or regardless of affinity being
* set or not (@ref PSM2_EP_OPEN_AFFINITY_FORCE).
* If @c HFI_NO_CPUAFFINITY is set in the environment, this
* setting is ignored.
* @li @c shm_mbytes sets a maximum number of megabytes that can be allocated
* to each local endpoint ID connected through this
* endpoint (with -1, defaults to 10 MB).
* @li @c sendbufs_num sets the number of send buffers that can be
* pre-allocated for communication (with -1, defaults to
* 512 buffers of MTU size).
* @li @c network_pkey sets the protection key to employ for point-to-point
* PSM2 communication. Unless a specific value is used,
* this parameter should be set to
* PSM2_EP_OPEN_PKEY_DEFAULT.
*
* @warning By default, PSM2 limits the user to calling @ref psm2_ep_open only
* once per process and subsequent calls will fail. In order to enable creation
* of multiple endoints per process, one must properly set the environment variable
* @ref PSM2_MULTI_EP before calling @ref psm2_init.
*
* @code{.c}
// In order to open an endpoint and participate in a job, each endpoint has
// to be distributed a unique 16-byte UUID key from an out-of-band source.
// Presumably this can come from the parallel spawning utility either
// indirectly through an implementors own spawning interface or as in this
// example, the UUID is set as a string in an environment variable
// propagated to all endpoints in the job.
int try_to_open_psm2_endpoint(psm2_ep_t *ep, // output endpoint handle
psm2_epid_t *epid, // output endpoint identifier
int unit) // unit of our choice
{
struct psm2_ep_open_opts epopts;
psm2_uuid_t job_uuid;
char *c;
// Let PSM2 assign its default values to the endpoint options.
psm2_ep_open_opts_get_defaults(&epopts);
// We want a stricter timeout and a specific unit
epopts.timeout = 15*1e9; // 15 second timeout
epopts.unit = unit; // We want a specific unit, -1 would let PSM
// choose the unit for us.
epopts.port = port; // We want a specific unit, <= 0 would let PSM
// choose the port for us.
// We've already set affinity, don't let PSM2 do so if it wants to.
if (epopts.affinity == PSM2_EP_OPEN_AFFINITY_SET)
epopts.affinity = PSM2_EP_OPEN_AFFINITY_SKIP;
// ENDPOINT_UUID is set to the same value in the environment of all the
// processes that wish to communicate over PSM2 and was generated by
// the process spawning utility
c = getenv("ENDPOINT_UUID");
if (c && *c)
implementor_string_to_16byte_packing(c, job_uuid);
else {
fprintf(stderr, "Can't find UUID for endpoint\n);
return -1;
}
// Assume we don't want to handle errors here.
psm2_ep_open(job_uuid, &epopts, ep, epid);
return 1;
}
@endcode
*/
psm2_error_t
psm2_ep_open(const psm2_uuid_t unique_job_key,
const struct psm2_ep_open_opts *opts, psm2_ep_t *ep,
psm2_epid_t *epid);
/** @brief Endpoint open default options.
*
* Function used to initialize the set of endpoint options to their default
* values for use in @ref psm2_ep_open.
*
* @param[out] opts Endpoint Open options.
*
* @warning For portable operation, users should always call this function
* prior to calling @ref psm2_ep_open.
*
* @return PSM2_OK If result could be updated
* @return PSM2_INIT_NOT_INIT If psm has not been initialized.
*/
psm2_error_t
psm2_ep_open_opts_get_defaults(struct psm2_ep_open_opts *opts);
/** @brief Endpoint shared memory query
*
* Function used to determine if a remote endpoint shares memory with a
* currently opened local endpiont.
*
* @param[in] ep Endpoint handle
* @param[in] epid Endpoint ID
*
* @param[out] result Result is non-zero if the remote endpoint shares memory with the local
* endpoint @c ep, or zero otherwise.
*
* @return PSM2_OK If result could be updated
* @return PSM2_EPID_UNKNOWN If the epid is not recognized
*/
psm2_error_t
psm2_ep_epid_share_memory(psm2_ep_t ep, psm2_epid_t epid, int *result);
/** @brief Close endpoint
* @param[in] ep PSM2 endpoint handle
* @param[in] mode One of @ref PSM2_EP_CLOSE_GRACEFUL or @ref PSM2_EP_CLOSE_FORCE
* @param[in] timeout How long to wait in nanoseconds if mode is
* PSM2_EP_CLOSE_GRACEFUL, 0 waits forever. If @c mode is
* @ref PSM2_EP_CLOSE_FORCE, this parameter is ignored.
*
* The following errors are returned, others are handled by the per-endpoint
* error handler:
*
* @return PSM2_OK Endpoint was successfully closed without force or
* successfully closed with force within the supplied timeout.
* @return PSM2_EP_CLOSE_TIMEOUT Endpoint could not be successfully closed
* within timeout.
*/
psm2_error_t psm2_ep_close(psm2_ep_t ep, int mode, int64_t timeout);
#define PSM2_EP_CLOSE_GRACEFUL 0 /**< Graceful mode in @ref psm2_ep_close */
#define PSM2_EP_CLOSE_FORCE 1 /**< Forceful mode in @ref psm2_ep_close */
/** @brief Provide mappings for network id to hostname
*
* Since PSM2 does not assume or rely on the availability of an external
* networkid-to-hostname mapping service, users can provide one or more of
* these mappings. The @ref psm2_map_nid_hostname function allows a list of
* network ids to be associated to hostnames.
*
* This function is not mandatory for correct operation but may allow PSM2 to
* provide better diagnostics when remote endpoints are unavailable and can
* otherwise only be identified by their network id.
*
* @param[in] num Number elements in @c nid and @c hostnames arrays
* @param[in] nids User-provided array of network ids (i.e. OPA LIDs),
* should be obtained by calling @ref psm2_epid_nid on each
* epid.
* @param[in] hostnames User-provided array of hostnames (array of
* NUL-terimated strings) where each hostname index
* maps to the provided nid hostname.
*
* @warning Duplicate nids may be provided in the input @c nids array, only
* the first corresponding hostname will be remembered.
*
* @pre The user may or may not have already provided a hostname mappings.
* @post The user may free any dynamically allocated memory passed to the
* function.
*
*/
psm2_error_t
psm2_map_nid_hostname(int num, const uint64_t *nids, const char **hostnames);
/** @brief Connect one or more remote endpoints to a local endpoint
*
* Function to non-collectively establish a connection to a set of endpoint IDs
* and translate endpoint IDs into endpoint addresses. Establishing a remote
* connection with a set of remote endpoint IDs does not imply a collective
* operation and the user is free to connect unequal sets on each process.
* Similarly, a given endpoint address does not imply that a pairwise
* communication context exists between the local endpoint and remote endpoint.
*
* @param[in] ep PSM2 endpoint handle
*
* @param[in] num_of_epid The number of endpoints to connect to, which
* also establishes the number of elements contained in
* all of the function's array-based parameters.
*
* @param[in] array_of_epid User-allocated array that contains @c num_of_epid
* valid endpoint identifiers. Each endpoint id (or
* epid) has been obtained through an out-of-band
* mechanism and each endpoint must have been opened
* with the same uuid key.
*
* @param[in] array_of_epid_mask User-allocated array that contains
* @c num_of_epid integers. This array of masks
* allows users to select which of the epids in @c
* array_of_epid should be connected. If the integer
* at index i is zero, psm does not attempt to connect
* to the epid at index i in @c array_of_epid. If
* this parameter is NULL, psm will try to connect to
* each epid.
*
* @param[out] array_of_errors User-allocated array of at least @c num_of_epid
* elements. If the function does not return
* PSM2_OK, this array can be consulted for each
* endpoint not masked off by @c array_of_epid_mask
* to know why the endpoint could not be connected.
* Endpoints that could not be connected because of
* an unrelated failure will be marked as @ref
* PSM2_EPID_UNKNOWN. If the function returns
* PSM2_OK, the errors for all endpoints will also
* contain PSM2_OK.
*
* @param[out] array_of_epaddr User-allocated array of at least @c num_of_epid
* elements of type psm2_epaddr_t. Each
* successfully connected endpoint is updated with
* an endpoint address handle that corresponds to
* the endpoint id at the same index in @c
* array_of_epid. Handles are only updated if the
* endpoint could be connected and if its error in
* array_of_errors is PSM2_OK.
*
* @param[in] timeout Timeout in nanoseconds after which connection attempts
* will be abandoned. Setting this value to 0 disables
* timeout and waits until all endpoints have been
* successfully connected or until an error is detected.
*
* @pre The user has opened a local endpoint and obtained a list of endpoint
* IDs to connect to a given endpoint handle using an out-of-band
* mechanism not provided by PSM.
*
* @post If the connect is successful, @c array_of_epaddr is updated with valid
* endpoint addresses.
*
* @post If unsuccessful, the user can query the return status of each
* individual remote endpoint in @c array_of_errors.
*
* @post The user can call into @ref psm2_ep_connect many times with the same
* endpoint ID and the function is guaranteed to return the same output
* parameters.
*
* @post PSM2 does not keep any reference to the arrays passed into the
* function and the caller is free to deallocate them.
*
* The error value with the highest importance is returned by
* the function if some portion of the communication failed. Users should
* always refer to individual errors in @c array_of_errors whenever the
* function cannot return PSM2_OK.
*
* @returns PSM2_OK The entire set of endpoint IDs were successfully connected
* and endpoint addresses are available for all endpoint IDs.
*
* @code{.c}