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
|
/*
* Copyright (c) 2013-2022 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2013 Inria. All rights reserved.
* Copyright (c) 2014-2020 Intel, Inc. All rights reserved.
* Copyright (c) 2014-2016 Research Organization for Information Science
* and Technology (RIST). All rights reserved.
* Copyright (c) 2017 Cisco Systems, Inc. All rights reserved
* Copyright (c) 2020 Amazon.com, Inc. or its affiliates. All Rights
* reserved.
* Copyright (c) 2021 Nanook Consulting. All rights reserved.
* Copyright (c) 2022 Triad National Security, LLC. All rights
* reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef OPAL_PROC_H
#define OPAL_PROC_H
#include "opal_config.h"
#include "opal/class/opal_list.h"
#include "opal/mca/hwloc/hwloc-internal.h"
#include "opal/mca/pmix/pmix-internal.h"
#include "opal/types.h"
#if OPAL_ENABLE_HETEROGENEOUS_SUPPORT
# include <arpa/inet.h>
#endif
/**
* This is a transparent handle proposed to the upper layer as a mean
* to store whatever information it needs in order to efficiently
* retrieve the RTE process naming scheme, and get access to the RTE
* information associated with it. The only direct usage of this type
* is to be copied from one structure to another, otherwise it should
* only be used via the accessors defined below.
*/
#define OPAL_JOBID_T OPAL_UINT32
#define OPAL_JOBID_MAX UINT32_MAX - 2
#define OPAL_JOBID_MIN 0
#define OPAL_JOBID_INVALID (OPAL_JOBID_MAX + 2)
#define OPAL_JOBID_WILDCARD (OPAL_JOBID_MAX + 1)
#define OPAL_VPID_T OPAL_UINT32
#define OPAL_VPID_MAX UINT32_MAX - 2
#define OPAL_VPID_MIN 0
#define OPAL_VPID_INVALID (OPAL_VPID_MAX + 2)
#define OPAL_VPID_WILDCARD (OPAL_VPID_MAX + 1)
#define OPAL_PROC_MY_NAME (opal_proc_local_get()->proc_name)
#define OPAL_PROC_MY_HOSTNAME (opal_process_info.nodename)
#define OPAL_NAME_WILDCARD (&opal_name_wildcard)
OPAL_DECLSPEC extern opal_process_name_t opal_name_wildcard;
#define OPAL_NAME_INVALID (&opal_name_invalid)
OPAL_DECLSPEC extern opal_process_name_t opal_name_invalid;
#define OPAL_NAME_ARGS(n) \
(unsigned long) ((NULL == n) ? (unsigned long) OPAL_JOBID_INVALID \
: (unsigned long) (n)->jobid), \
(unsigned long) ((NULL == n) ? (unsigned long) OPAL_VPID_INVALID \
: (unsigned long) (n)->vpid)
#if OPAL_ENABLE_HETEROGENEOUS_SUPPORT && !defined(WORDS_BIGENDIAN)
# define OPAL_PROCESS_NAME_NTOH(guid) opal_process_name_ntoh_intr(&(guid))
static inline __opal_attribute_always_inline__ void
opal_process_name_ntoh_intr(opal_process_name_t *name)
{
name->jobid = ntohl(name->jobid);
name->vpid = ntohl(name->vpid);
}
# define OPAL_PROCESS_NAME_HTON(guid) opal_process_name_hton_intr(&(guid))
static inline __opal_attribute_always_inline__ void
opal_process_name_hton_intr(opal_process_name_t *name)
{
name->jobid = htonl(name->jobid);
name->vpid = htonl(name->vpid);
}
#else
# define OPAL_PROCESS_NAME_NTOH(guid)
# define OPAL_PROCESS_NAME_HTON(guid)
#endif
typedef struct opal_proc_t {
/** allow proc to be placed on a list */
opal_list_item_t super;
/** this process' name */
opal_process_name_t proc_name;
/** architecture of this process */
uint32_t proc_arch;
/** flags for this proc */
opal_hwloc_locality_t proc_flags;
/** Base convertor for the proc described by this process */
struct opal_convertor_t *proc_convertor;
} opal_proc_t;
OBJ_CLASS_DECLARATION(opal_proc_t);
typedef struct {
opal_list_item_t super;
opal_process_name_t name;
} opal_namelist_t;
OBJ_CLASS_DECLARATION(opal_namelist_t);
typedef struct opal_process_info_t {
opal_process_name_t my_name;
pmix_proc_t myprocid;
bool nativelaunch; /**< launched by mpirun */
char *nodename; /**< string name for this node */
char *top_session_dir; /**< Top-level session directory */
char *job_session_dir; /**< Session directory for job */
char *proc_session_dir; /**< Session directory for the process */
uint32_t num_local_peers; /**< number of procs from my job that share my node with me */
uint16_t my_local_rank; /**< local rank on this node within my job */
uint16_t my_node_rank;
uint16_t my_numa_rank; /**< rank on this processes NUMA node. A value of UINT16_MAX indicates unavailable numa_rank */
char *cpuset; /**< String-representation of bitmap where we are bound */
char *locality; /**< String-representation of process locality */
pid_t pid;
uint32_t num_procs;
uint32_t app_num;
uint32_t univ_size;
char *app_sizes;
char *app_ldrs;
char *command;
uint32_t num_apps;
char *initial_wdir;
uint32_t reincarnation;
bool proc_is_bound;
char *initial_errhandler;
bool is_singleton; /**<note this value can transition from false to true in some cases */
} opal_process_info_t;
OPAL_DECLSPEC extern opal_process_info_t opal_process_info;
OPAL_DECLSPEC extern opal_proc_t *opal_proc_local_get(void);
OPAL_DECLSPEC extern int opal_proc_local_set(opal_proc_t *proc);
OPAL_DECLSPEC extern void opal_proc_set_name(opal_process_name_t *name);
/**
* Compare two processor name and return an integer greater than,
* equal to, or less than 0, according as the proc_name of proc1
* is greater than, equal to, or less than the proc_name of proc2.
*/
typedef int (*opal_compare_proc_fct_t)(const opal_process_name_t, const opal_process_name_t);
OPAL_DECLSPEC extern opal_compare_proc_fct_t opal_compare_proc;
/* Provide print functions that will be overwritten by the RTE layer */
OPAL_DECLSPEC extern char *(*opal_process_name_print)(const opal_process_name_t);
OPAL_DECLSPEC extern int (*opal_convert_string_to_process_name)(opal_process_name_t *name,
const char *name_string);
OPAL_DECLSPEC extern int (*opal_convert_process_name_to_string)(char **name_string,
const opal_process_name_t *name);
OPAL_DECLSPEC extern char *(*opal_vpid_print)(const opal_vpid_t);
OPAL_DECLSPEC extern char *(*opal_jobid_print)(const opal_jobid_t);
OPAL_DECLSPEC extern int (*opal_snprintf_jobid)(char *name_string, size_t size, opal_jobid_t jobid);
OPAL_DECLSPEC extern int (*opal_convert_string_to_jobid)(opal_jobid_t *jobid,
const char *jobid_string);
/**
* Lookup an opal_proc_t by name
*
* @param name (IN) name to lookup
*/
OPAL_DECLSPEC extern struct opal_proc_t *(*opal_proc_for_name)(const opal_process_name_t name);
#define OPAL_NAME_PRINT(OPAL_PN) opal_process_name_print(OPAL_PN)
#define OPAL_JOBID_PRINT(OPAL_PN) opal_jobid_print(OPAL_PN)
#define OPAL_VPID_PRINT(OPAL_PN) opal_vpid_print(OPAL_PN)
/* provide a safe way to retrieve the hostname of a proc, including
* our own. This is to be used by all BTLs so we don't retrieve hostnames
* unless needed. The returned value MUST NOT be free'd as it is
* owned by the proc_t */
OPAL_DECLSPEC extern char *(*opal_get_proc_hostname)(const opal_proc_t *proc);
#endif /* OPAL_PROC_H */
|
