forked from hpcugent/slurm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpmi.c
1998 lines (1651 loc) · 51.8 KB
/
pmi.c
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
/*****************************************************************************\
* pmi.c - Process Management Interface for MPICH2
* See http://www-unix.mcs.anl.gov/mpi/mpich2/
*
* NOTE: Dynamic Process Management functions (PMI part 2) are not supported
* at this time. Functions required for MPI-1 (PMI part 1) are supported.
*****************************************************************************
* COPYRIGHT: For the function definitions
*
* The following is a notice of limited availability of the code, and
* disclaimer which must be included in the prologue of the code and in all
* source listings of the code.
*
* Copyright Notice + 2002 University of Chicago
*
* Permission is hereby granted to use, reproduce, prepare derivative
* works, and to redistribute to others. This software was authored by:
*
* Argonne National Laboratory Group
* W. Gropp: (630) 252-4318; FAX: (630) 252-5986; e-mail: gropp@mcs.anl.gov
* E. Lusk: (630) 252-7852; FAX: (630) 252-5986; e-mail: lusk@mcs.anl.gov
* Mathematics and Computer Science Division Argonne National Laboratory,
* Argonne IL 60439
*
* GOVERNMENT LICENSE
*
* Portions of this material resulted from work developed under a U.S.
* Government Contract and are subject to the following license: the
* Government is granted for itself and others acting on its behalf a
* paid-up, nonexclusive, irrevocable worldwide license in this computer
* software to reproduce, prepare derivative works, and perform publicly
* and display publicly.
*
* DISCLAIMER
*
* This computer code material was prepared, in part, as an account of work
* sponsored by an agency of the United States Government. Neither the
* United States, nor the University of Chicago, nor any of their
* employees, makes any warranty express or implied, or assumes any legal
* liability or responsibility for the accuracy, completeness, or
* usefulness of any information, apparatus, product, or process disclosed,
* or represents that its use would not infringe privately owned rights.
*
* MCS Division <http://www.mcs.anl.gov> Argonne National Laboratory
* <http://www.anl.gov> University of Chicago <http://www.uchicago.edu>
*****************************************************************************
* COPYRIGHT: For the implementation of the functions
*
* Copyright (C) 2005-2007 The Regents of the University of California.
* Copyright (C) 2008-2010 Lawrence Livermore National Security.
* Produced at Lawrence Livermore National Laboratory (cf, DISCLAIMER).
* Written by Morris Jette <jette1@llnl.gov>
* CODE-OCEC-09-009. All rights reserved.
*
* This file is part of Slurm, a resource management program.
* For details, see <https://slurm.schedmd.com/>.
* Please also read the included file: DISCLAIMER.
*
* Slurm is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License as published by the Free
* Software Foundation; either version 2 of the License, or (at your option)
* any later version.
*
* In addition, as a special exception, the copyright holders give permission
* to link the code of portions of this program with the OpenSSL library under
* certain conditions as described in each individual source file, and
* distribute linked combinations including the two. You must obey the GNU
* General Public License in all respects for all of the code used other than
* OpenSSL. If you modify file(s) with this exception, you may extend this
* exception to your version of the file(s), but you are not obligated to do
* so. If you do not wish to do so, delete this exception statement from your
* version. If you delete this exception statement from all source files in
* the program, then also delete it here.
*
* Slurm 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.
*
* You should have received a copy of the GNU General Public License along
* with Slurm; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
\*****************************************************************************/
#define _GNU_SOURCE
#include <pthread.h>
#include <signal.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "slurm/pmi.h"
#include "slurm/slurm.h"
#include "slurm/slurm_errno.h"
#include "src/api/slurm_pmi.h"
#include "src/common/macros.h"
#include "src/slurmd/slurmstepd/slurmstepd_job.h"
#define KVS_STATE_LOCAL 0
#define KVS_STATE_DEFUNCT 1
#define KVS_KEY_STATE_GLOBAL 0
#define KVS_KEY_STATE_LOCAL 1
#define KVS_KEY_STATE_DISABLED 2
/* default key names form is jobid.stepid[.taskid.sequence] */
struct kvs_rec {
char * kvs_name;
uint16_t kvs_state; /* see KVS_STATE_* */
uint32_t kvs_cnt; /* count of key-pairs */
uint16_t kvs_inx; /* iteration index */
uint16_t * kvs_key_states; /* see KVS_KEY_STATE_* */
char ** kvs_keys;
char ** kvs_values;
};
#define _DEBUG 0
#ifdef WITH_PMI_NOMEM_ERROR_FUNC
# undef pmi_nomem_error
extern void pmi_nomem_error(char *file, int line, char *mesg);
#else /* !WITH_PMI_NOMEM_ERROR_FUNC */
# ifndef pmi_nomem_error
static void pmi_nomem_error(char *file, int line, char *mesg)
{
fprintf(stderr, "ERROR: [%s:%d] %s: %s\n",
file, line, mesg, strerror(errno));
abort();
}
# endif /* !pmi_nomem_error */
#endif /* !WITH_PMI_NOMEM_ERROR_FUNC */
static void _del_kvs_rec( struct kvs_rec *kvs_ptr );
static void _init_kvs( char kvsname[] );
inline static void _kvs_dump(void);
static int _kvs_put( const char kvsname[], const char key[],
const char value[], int local);
static void _kvs_swap(struct kvs_rec *kvs_ptr, int inx1, int inx2);
static void _kvs_disable_local_keys(void);
/* Global variables */
long pmi_jobid;
long pmi_stepid;
int pmi_init = 0;
int pmi_size;
int pmi_spawned;
int pmi_rank;
int pmi_debug;
/* By default PMI protocol does not allow
* for duplicate keys.
*/
static int pmi_kvs_no_dup_keys = 1;
static pthread_mutex_t kvs_mutex = PTHREAD_MUTEX_INITIALIZER;
int kvs_rec_cnt = 0;
struct kvs_rec *kvs_recs;
int kvs_name_sequence = 0;
static char *pmi_opt_str =
"pmi command line options \n"
" \n"
" \n"
" \n";
static int IsPmiKey(char *);
static void _pmi_mutex_lock(pthread_mutex_t *mutex)
{
if (pthread_mutex_lock(mutex) != 0)
fprintf(stderr, "_pmi_mutex_lock\n");
}
static void _pmi_mutex_unlock(pthread_mutex_t *mutex)
{
if (pthread_mutex_unlock(mutex) != 0)
fprintf(stderr, "_pmi_mutex_unlock\n");
}
/* PMI Group functions */
/*@
PMI_Init - initialize the Process Manager Interface
Output Parameter:
. spawned - spawned flag
Return values:
+ PMI_SUCCESS - initialization completed successfully
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - initialization failed
Notes:
Initialize PMI for this process group. The value of spawned indicates whether
this process was created by 'PMI_Spawn_multiple'. 'spawned' will be 'PMI_TRUE'
if this process group has a parent and 'PMI_FALSE' if it does not.
@*/
int PMI_Init( int *spawned )
{
char *env;
env = getenv("PMI_DEBUG");
if (env)
pmi_debug = atoi(env);
else
pmi_debug = 0;
if (pmi_debug)
fprintf(stderr, "In: PMI_Init\n");
/* In MPI implementations, there will be no duplicate
* keys put into the KVS usually. Hence the checking
* for duplicate keys can be skipped. However if the
* user wants to have duplicate keys he must set
* this env variable. If a duplicate key is found
* the previous value will be discarded.
*/
env = getenv("SLURM_PMI_KVS_DUP_KEYS");
if (env)
pmi_kvs_no_dup_keys = 0;
if (spawned == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init)
goto replay;
env = getenv("SLURM_JOB_ID");
if (env)
pmi_jobid = atoi(env);
else
pmi_jobid = 0;
env = getenv("SLURM_STEPID");
if (env)
pmi_stepid = atoi(env);
else
pmi_stepid = 0;
env = getenv("PMI_SPAWNED");
if (env)
pmi_spawned = atoi(env);
else
pmi_spawned = 0;
env = getenv("SLURM_NPROCS");
if (!env)
env = getenv("PMI_SIZE");
if (env)
pmi_size = atoi(env);
else
pmi_size = 1;
env = getenv("SLURM_PROCID");
if (!env)
env = getenv("PMI_RANK");
if (env)
pmi_rank = atoi(env);
else
pmi_rank = 0;
pmi_init = 1;
replay: if (pmi_spawned)
*spawned = PMI_TRUE;
else
*spawned = PMI_FALSE;
return PMI_SUCCESS;
}
/*@
PMI_Initialized - check if PMI has been initialized
Output Parameter:
. initialized - boolean value
Return values:
+ PMI_SUCCESS - initialized successfully set
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to set the variable
Notes:
On successful output, initialized will either be 'PMI_TRUE' or 'PMI_FALSE'.
+ PMI_TRUE - initialize has been called.
- PMI_FALSE - initialize has not been called or previously failed.
@*/
int PMI_Initialized( PMI_BOOL *initialized )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Initialized\n");
if (initialized == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init)
*initialized = PMI_TRUE;
else
*initialized = PMI_FALSE;
return PMI_SUCCESS;
}
/*@
PMI_Finalize - finalize the Process Manager Interface
Return values:
+ PMI_SUCCESS - finalization completed successfully
- PMI_FAIL - finalization failed
Notes:
Finalize PMI for this process group.
@*/
int PMI_Finalize( void )
{
int i;
if (pmi_debug)
fprintf(stderr, "In: PMI_Finalize\n");
pmi_init = 0;
_pmi_mutex_lock(&kvs_mutex); /* DO NOT use slurm_mutex_un/lock */
for (i=0; i<kvs_rec_cnt; i++)
_del_kvs_rec(&kvs_recs[i]);
if (kvs_recs)
free(kvs_recs);
kvs_recs = NULL;
kvs_rec_cnt = 0;
_pmi_mutex_unlock(&kvs_mutex); /* DO NOT use slurm_mutex_un/lock */
slurm_pmi_finalize();
return PMI_SUCCESS;
}
static void _del_kvs_rec(struct kvs_rec *kvs_ptr)
{
int i;
if (kvs_ptr == NULL)
return;
for (i = 0; i < kvs_ptr->kvs_cnt; i++) {
if (kvs_ptr->kvs_keys[i])
free(kvs_ptr->kvs_keys[i]);
if (kvs_ptr->kvs_values[i])
free(kvs_ptr->kvs_values[i]);
}
if (kvs_ptr->kvs_name)
free(kvs_ptr->kvs_name);
return;
}
/*@
PMI_Get_size - obtain the size of the process group
Output Parameters:
. size - pointer to an integer that receives the size of the process group
Return values:
+ PMI_SUCCESS - size successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to return the size
Notes:
This function returns the size of the process group to which the local process
belongs.
@*/
int PMI_Get_size( int *size )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_size\n");
if (size == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
*size = pmi_size;
return PMI_SUCCESS;
}
/*@
PMI_Get_rank - obtain the rank of the local process in the process group
Output Parameters:
. rank - pointer to an integer that receives the rank in the process group
Return values:
+ PMI_SUCCESS - rank successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to return the rank
Notes:
This function returns the rank of the local process in its process group.
@*/
int PMI_Get_rank( int *rank )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_rank\n");
if (rank == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
*rank = pmi_rank;
return PMI_SUCCESS;
}
/*@
PMI_Get_universe_size - obtain the universe size
(NOTE: "universe size" indicates the maximum recommended
process count for the job.)
Output Parameters:
. size - pointer to an integer that receives the size
Return values:
+ PMI_SUCCESS - size successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to return the size
@*/
int PMI_Get_universe_size( int *size )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_universe_size\n");
if (size == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
*size = pmi_size;
return PMI_SUCCESS;
}
/*@
PMI_Get_appnum - obtain the application number
Output parameters:
. appnum - pointer to an integer that receives the appnum
Return values:
+ PMI_SUCCESS - appnum successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to return the size
@*/
int PMI_Get_appnum( int *appnum )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_appnum\n");
if (appnum == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
*appnum = pmi_jobid;
return PMI_SUCCESS;
}
/*@
PMI_Publish_name - publish a name
Input parameters:
. service_name - string representing the service being published
. port - string representing the port on which to contact the service
Return values:
+ PMI_SUCCESS - port for service successfully published
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to publish service
@*/
int PMI_Publish_name( const char service_name[], const char port[] )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Publish_name - NOT SUPPORTED\n");
if ((service_name == NULL) || (port == NULL))
return PMI_ERR_INVALID_ARG;
/* FIXME */
return PMI_FAIL;
}
/*@
PMI_Unpublish_name - unpublish a name
Input parameters:
. service_name - string representing the service being unpublished
Return values:
+ PMI_SUCCESS - port for service successfully published
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to unpublish service
@*/
int PMI_Unpublish_name( const char service_name[] )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Unpublish_name - NOT SUPPORTED\n");
if (service_name == NULL)
return PMI_ERR_INVALID_ARG;
/* FIXME */
return PMI_FAIL;
}
/*@
PMI_Lookup_name - lookup a service by name
Input parameters:
. service_name - string representing the service being published
Output parameters:
. port - string representing the port on which to contact the service
Return values:
+ PMI_SUCCESS - port for service successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to lookup service
@*/
int PMI_Lookup_name( const char service_name[], char port[] )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Lookup_name - NOT SUPPORTED\n");
if ((service_name == NULL) || (port == NULL))
return PMI_ERR_INVALID_ARG;
/* FIXME */
return PMI_FAIL;
}
/*@
PMI_Get_id - obtain the id of the process group
Input Parameter:
. length - length of the id_str character array
Output Parameter:
. id_str - character array that receives the id of the process group
Return values:
+ PMI_SUCCESS - id successfully obtained
. PMI_ERR_INVALID_ARG - invalid id_str argument
. PMI_ERR_INVALID_LENGTH - invalid length argument
- PMI_FAIL - unable to return the id
Notes:
This function returns a string that uniquely identifies the process group
that the local process belongs to. The string passed in must be at least
as long as the number returned by 'PMI_Get_id_length_max()'.
@*/
int PMI_Get_id( char id_str[], int length )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_id\n");
if (length < PMI_MAX_ID_LEN)
return PMI_ERR_INVALID_LENGTH;
if (id_str == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
snprintf(id_str, length, "%ld.%ld", pmi_jobid, pmi_stepid);
return PMI_SUCCESS;
}
/*@
PMI_Get_kvs_domain_id - obtain the id of the PMI domain
Input Parameter:
. length - length of id_str character array
Output Parameter:
. id_str - character array that receives the id of the PMI domain
Return values:
+ PMI_SUCCESS - id successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
. PMI_ERR_INVALID_LENGTH - invalid length argument
- PMI_FAIL - unable to return the id
Notes:
This function returns a string that uniquely identifies the PMI domain
where keyval spaces can be shared. The string passed in must be at least
as long as the number returned by 'PMI_Get_id_length_max()'.
@*/
int PMI_Get_kvs_domain_id( char id_str[], int length )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_kvs_domain_id\n");
if (length < PMI_MAX_ID_LEN)
return PMI_ERR_INVALID_LENGTH;
if (id_str == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
snprintf(id_str, length, "%ld.%ld", pmi_jobid, pmi_stepid);
return PMI_SUCCESS;
}
/*@
PMI_Get_id_length_max - obtain the maximum length of an id string
Output Parameters:
. length - the maximum length of an id string
Return values:
+ PMI_SUCCESS - length successfully set
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to return the maximum length
Notes:
This function returns the maximum length of a process group id string.
@*/
int PMI_Get_id_length_max( int *length )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_id_length_max\n");
if (length == NULL)
return PMI_ERR_INVALID_ARG;
*length = PMI_MAX_ID_LEN;
return PMI_SUCCESS;
}
/*@
PMI_Barrier - barrier across the process group
Return values:
+ PMI_SUCCESS - barrier successfully finished
- PMI_FAIL - barrier failed
Notes:
This function is a collective call across all processes in the process group
the local process belongs to. It will not return until all the processes
have called 'PMI_Barrier()'.
@*/
int PMI_Barrier( void )
{
kvs_comm_set_t *kvs_set_ptr = NULL;
struct kvs_comm *kvs_ptr;
int i, j, k, rc = PMI_SUCCESS;
if (pmi_debug)
fprintf(stderr, "In: PMI_Barrier\n");
if (pmi_init == 0)
return PMI_FAIL;
/* Simple operation without srun (no-op) */
if ((pmi_jobid == 0) && (pmi_stepid == 0))
return rc;
/* Issue the RPC */
if (slurm_pmi_get_kvs_comm_set(&kvs_set_ptr, pmi_rank, pmi_size))
return PMI_FAIL;
if (kvs_set_ptr == NULL)
return PMI_SUCCESS;
if (pmi_debug)
fprintf(stderr, "Past PMI_Barrier\n");
_kvs_disable_local_keys();
for (i=0; i<kvs_set_ptr->kvs_comm_recs; i++) {
kvs_ptr = kvs_set_ptr->kvs_comm_ptr[i];
for (j=0; j<kvs_ptr->kvs_cnt; j++) {
k = _kvs_put(kvs_ptr->kvs_name,
kvs_ptr->kvs_keys[j],
kvs_ptr->kvs_values[j],
0);
if (k != PMI_SUCCESS)
rc = k;
}
}
/* Release temporary storage from RPC */
slurm_pmi_free_kvs_comm_set(kvs_set_ptr);
return rc;
}
/*@
PMI_Get_clique_size - obtain the number of processes on the local node
Output Parameters:
. size - pointer to an integer that receives the size of the clique
Return values:
+ PMI_SUCCESS - size successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to return the clique size
Notes:
This function returns the number of processes in the local process group that
are on the local node along with the local process. This is a simple topology
function to distinguish between processes that can communicate through IPC
mechanisms (e.g., shared memory) and other network mechanisms.
@*/
int PMI_Get_clique_size( int *size )
{
char *env;
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_clique_size\n");
if (size == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
/* Simple operation without srun */
if ((pmi_jobid == 0) && (pmi_stepid == 0)) {
*size = 1;
return PMI_SUCCESS;
}
env = getenv("SLURM_GTIDS");
if (env) {
int i, tids=1;
for (i=0; env[i]; i++) {
if (env[i] == ',')
tids++;
}
*size = tids;
return PMI_SUCCESS;
}
return PMI_FAIL;
}
/*@
PMI_Get_clique_ranks - get the ranks of the local processes in the process group
Input Parameters:
. length - length of the ranks array
Output Parameters:
. ranks - pointer to an array of integers that receive the local ranks
Return values:
+ PMI_SUCCESS - ranks successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
. PMI_ERR_INVALID_LENGTH - invalid length argument
- PMI_FAIL - unable to return the ranks
Notes:
This function returns the ranks of the processes on the local node. The array
must be at least as large as the size returned by 'PMI_Get_clique_size()'. This
is a simple topology function to distinguish between processes that can
communicate through IPC mechanisms (e.g., shared memory) and other network
mechanisms.
@*/
int PMI_Get_clique_ranks( int ranks[], int length )
{
char *env;
if (pmi_debug)
fprintf(stderr, "In: PMI_Get_clique_ranks\n");
if (ranks == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
/* Simple operation without srun */
if ((pmi_jobid == 0) && (pmi_stepid == 0)) {
if (length < 1)
return PMI_ERR_INVALID_LENGTH;
ranks[0] = 0;
return PMI_SUCCESS;
}
env = getenv("SLURM_GTIDS");
if (env) {
int i = 0;
char *tid, *tids, *last = NULL;
tids = strdup(env);
tid = strtok_r(tids, ",", &last);
while (tid) {
if (i >= length) {
free(tids);
return PMI_ERR_INVALID_LENGTH;
}
ranks[i++] = atoi(tid);
tid = strtok_r(NULL, ",", &last);
}
free(tids);
return PMI_SUCCESS;
}
return PMI_FAIL;
}
/*@
PMI_Abort - abort the process group associated with this process
Input Parameters:
+ exit_code - exit code to be returned by this process
- error_msg - error message to be printed
Return values:
. none - this function should not return
@*/
int PMI_Abort(int exit_code, const char error_msg[])
{
if ((pmi_debug) || (error_msg != NULL)) {
if (error_msg == NULL)
error_msg = "NULL";
fprintf(stderr, "In: PMI_Abort(%d, %s)\n", exit_code, error_msg);
}
if (pmi_init) {
if ((pmi_jobid == 0) && (pmi_stepid == 0)) {
/* Simple operation without srun */
kill(0, SIGKILL);
} else {
slurm_pmi_kill_job_step((uint32_t) pmi_jobid,
(uint32_t) pmi_stepid, SIGKILL);
}
}
exit(exit_code);
}
/* PMI Keymap functions */
/*@
PMI_KVS_Get_my_name - obtain the name of the keyval space the local process
group has access to
Input Parameters:
. length - length of the kvsname character array
Output Parameters:
. kvsname - a string that receives the keyval space name
Return values:
+ PMI_SUCCESS - kvsname successfully obtained
. PMI_ERR_INVALID_ARG - invalid argument
. PMI_ERR_INVALID_LENGTH - invalid length argument
- PMI_FAIL - unable to return the kvsname
Notes:
This function returns the name of the keyval space that this process and all
other processes in the process group have access to. The output parameter,
kvsname, must be at least as long as the value returned by
'PMI_KVS_Get_name_length_max()'.
@*/
int PMI_KVS_Get_my_name( char kvsname[], int length )
{
int size;
if (pmi_debug)
fprintf(stderr, "In: PMI_KVS_Get_my_name\n");
if (kvsname == NULL)
return PMI_ERR_INVALID_ARG;
if (pmi_init == 0)
return PMI_FAIL;
size = snprintf(kvsname, length, "%ld.%ld", pmi_jobid, pmi_stepid);
if (size >= length) /* truncated */
return PMI_ERR_INVALID_LENGTH;
_pmi_mutex_lock(&kvs_mutex); /* DO NOT use slurm_mutex_un/lock */
_init_kvs(kvsname);
_pmi_mutex_unlock(&kvs_mutex); /* DO NOT use slurm_mutex_un/lock */
return PMI_SUCCESS;
}
static void _init_kvs( char kvsname[] )
{
int i;
i = kvs_rec_cnt;
kvs_rec_cnt++;
kvs_recs = realloc(kvs_recs, (sizeof(struct kvs_rec) * kvs_rec_cnt));
if (!kvs_recs)
pmi_nomem_error(__FILE__, __LINE__, "_init_kvs");
/* DO NOT CHANGE TO STRNDUP(), NOT SUPPORTED ON AIX */
kvs_recs[i].kvs_name = malloc(PMI_MAX_KVSNAME_LEN);
if (!kvs_recs[i].kvs_name)
pmi_nomem_error(__FILE__, __LINE__, "_init_kvs");
strncpy(kvs_recs[i].kvs_name, kvsname, PMI_MAX_KVSNAME_LEN);
kvs_recs[i].kvs_state = KVS_STATE_LOCAL;
kvs_recs[i].kvs_cnt = 0;
kvs_recs[i].kvs_inx = 0;
kvs_recs[i].kvs_key_states = NULL;
kvs_recs[i].kvs_keys = NULL;
kvs_recs[i].kvs_values = NULL;
}
/*@
PMI_KVS_Get_name_length_max - obtain the length necessary to store a kvsname
Output Parameter:
. length - maximum length required to hold a keyval space name
Return values:
+ PMI_SUCCESS - length successfully set
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to set the length
Notes:
This function returns the string length required to store a keyval space name.
A routine is used rather than setting a maximum value in 'pmi.h' to allow
different implementations of PMI to be used with the same executable. These
different implementations may allow different maximum lengths; by using a
routine here, we can interface with a variety of implementations of PMI.
@*/
int PMI_KVS_Get_name_length_max( int *length )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_KVS_Get_name_length_max\n");
if (length == NULL)
return PMI_ERR_INVALID_ARG;
*length = PMI_MAX_KVSNAME_LEN;
return PMI_SUCCESS;
}
/*@
PMI_KVS_Get_key_length_max - obtain the length necessary to store a key
Output Parameter:
. length - maximum length required to hold a key string.
Return values:
+ PMI_SUCCESS - length successfully set
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to set the length
Notes:
This function returns the string length required to store a key.
@*/
int PMI_KVS_Get_key_length_max( int *length )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_KVS_Get_key_length_max\n");
if (length == NULL)
return PMI_ERR_INVALID_ARG;
*length = PMI_MAX_KEY_LEN;
return PMI_SUCCESS;
}
/*@
PMI_KVS_Get_value_length_max - obtain the length necessary to store a value
Output Parameter:
. length - maximum length required to hold a keyval space value
Return values:
+ PMI_SUCCESS - length successfully set
. PMI_ERR_INVALID_ARG - invalid argument
- PMI_FAIL - unable to set the length
Notes:
This function returns the string length required to store a value from a
keyval space.
@*/
int PMI_KVS_Get_value_length_max( int *length )
{
if (pmi_debug)
fprintf(stderr, "In: PMI_KVS_Get_value_length_max\n");