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
|
/*
* Copyright (c) 2013 Mellanox Technologies, Inc.
* All rights reserved.
* Copyright (c) 2019 Research Organization for Information Science
* and Technology (RIST). All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/**
* @file
*
* Interface into the SHMEM portion of the Open SHMEM Run Time Environment
*/
#ifndef OSHMEM_SHMEM_RUNTIME_H
#define OSHMEM_SHMEM_RUNTIME_H
#include "oshmem_config.h"
#include "shmem.h"
#include "opal/class/opal_list.h"
#include "opal/class/opal_hash_table.h"
#include "ompi/include/mpi.h"
#include <pthread.h>
BEGIN_C_DECLS
/* Global variables and symbols for the SHMEM layer */
/** Is oshmem initialized? */
OSHMEM_DECLSPEC extern bool oshmem_shmem_initialized;
/** Has oshmem been aborted **/
OSHMEM_DECLSPEC extern bool oshmem_shmem_aborted;
/** Do we have multiple threads? */
OSHMEM_DECLSPEC extern bool oshmem_mpi_thread_multiple;
/** Thread level requested to \c MPI_Init_thread() */
OSHMEM_DECLSPEC extern int oshmem_mpi_thread_requested;
/** Thread level provided by Open MPI */
OSHMEM_DECLSPEC extern int oshmem_mpi_thread_provided;
/** Identifier of the main thread */
OSHMEM_DECLSPEC extern struct opal_thread_t *oshmem_mpi_main_thread;
OSHMEM_DECLSPEC extern MPI_Comm oshmem_comm_world;
typedef pthread_mutex_t shmem_internal_mutex_t;
OSHMEM_DECLSPEC extern shmem_internal_mutex_t shmem_internal_mutex_alloc;
OSHMEM_DECLSPEC extern shmem_ctx_t oshmem_ctx_default;
# define SHMEM_MUTEX_INIT(_mutex) \
do { \
if (oshmem_mpi_thread_provided == SHMEM_THREAD_MULTIPLE) \
pthread_mutex_init(&_mutex, NULL); \
} while (0)
# define SHMEM_MUTEX_DESTROY(_mutex) \
do { \
if (oshmem_mpi_thread_provided == SHMEM_THREAD_MULTIPLE) \
pthread_mutex_destroy(&_mutex); \
} while (0)
# define SHMEM_MUTEX_LOCK(_mutex) \
do { \
if (oshmem_mpi_thread_provided == SHMEM_THREAD_MULTIPLE) \
pthread_mutex_lock(&_mutex); \
} while (0)
# define SHMEM_MUTEX_UNLOCK(_mutex) \
do { \
if (oshmem_mpi_thread_provided == SHMEM_THREAD_MULTIPLE) \
pthread_mutex_unlock(&_mutex); \
} while (0)
/** Bitflags to be used for the modex exchange for the various thread
* levels. Required to support heterogeneous environments */
#define OSHMEM_THREADLEVEL_SINGLE_BF 0x00000001
#define OSHMEM_THREADLEVEL_FUNNELED_BF 0x00000002
#define OSHMEM_THREADLEVEL_SERIALIZED_BF 0x00000004
#define OSHMEM_THREADLEVEL_MULTIPLE_BF 0x00000008
/** In ompi_mpi_init: the lists of Fortran 90 matching datatypes.
* We need these lists and hashtables in order to satisfy the new
* requirements introduced in MPI 2-1 Sect. 10.2.5,
* MPI_TYPE_CREATE_F90_xxxx, page 295, line 47.
*/
extern opal_hash_table_t ompi_mpi_f90_integer_hashtable;
extern opal_hash_table_t ompi_mpi_f90_real_hashtable;
extern opal_hash_table_t ompi_mpi_f90_complex_hashtable;
/** version string of ompi */
OSHMEM_DECLSPEC extern const char oshmem_version_string[];
/**
* Initialize the Open SHMEM environment
*
* @param argc argc, typically from main() (IN)
* @param argv argv, typically from main() (IN)
* @param requested Thread support that is requested (IN)
* @param provided Thread support that is provided (OUT)
*
* @returns OSHMEM_SUCCESS if successful
* @returns Error code if unsuccessful
*
* Initialize all support code needed for SHMEM applications. This
* function should only be called by SHMEM applications (including
* singletons). If this function is called, ompi_init() and
* ompi_rte_init() should *not* be called.
*
* It is permissible to pass in (0, NULL) for (argc, argv).
*/
int oshmem_shmem_init(int argc, char **argv, int requested, int *provided);
/**
* Finalize the Open SHMEM environment
*
* @returns OSHMEM_SUCCESS if successful
* @returns Error code if unsuccessful
*
*/
int oshmem_shmem_finalize(void);
/**
* Abort SHMEM processes
*/
OSHMEM_DECLSPEC int oshmem_shmem_abort(int errcode);
/**
* Broadcast between all PEs
*/
OSHMEM_DECLSPEC int oshmem_shmem_bcast(void *buf, int elem_size, int root);
/**
* Allgather between all PEs
*/
OSHMEM_DECLSPEC int oshmem_shmem_allgather(void *send_buf, void *rcv_buf, int elem_size);
/**
* Allgatherv between all PEs
*/
OSHMEM_DECLSPEC int oshmem_shmem_allgatherv(void *send_buf, void* rcv_buf, int send_count,
int *rcv_size, int* displs);
/**
* Barrier between all PEs
*/
OSHMEM_DECLSPEC void oshmem_shmem_barrier(void);
/**
* Register OSHMEM specific runtime parameters
*/
OSHMEM_DECLSPEC int oshmem_shmem_register_params(void);
#if OSHMEM_PARAM_CHECK == 1
#define RUNTIME_CHECK_ERROR(...) \
do { \
fprintf(stderr, "[%s]%s[%s:%d:%s] ", \
ompi_process_info.nodename, \
OMPI_NAME_PRINT(OMPI_PROC_MY_NAME), \
__FILE__, __LINE__, __func__); \
fprintf(stderr, __VA_ARGS__); \
} while(0);
/* check if this routine is implemented. Can be used for routines that do
* not return error code. */
#define RUNTIME_CHECK_IMPL_RC(x) \
if (x <= -1) \
{ \
int _rc = x; \
RUNTIME_CHECK_ERROR("Internal error is appeared rc = %d\n", (_rc)); \
}
/**
* Check if SHMEM API generates internal error return code
* Note: most API does not return error code
*/
#define RUNTIME_CHECK_RC(x) \
if (OPAL_UNLIKELY(OSHMEM_SUCCESS != (x))) \
{ \
RUNTIME_CHECK_ERROR("Internal error is appeared rc = %d\n", (x)); \
}
/**
* Check if we called start_pes() and passed initialization phase
*/
#define RUNTIME_CHECK_INIT() \
if (OPAL_UNLIKELY(!oshmem_shmem_initialized)) \
{ \
RUNTIME_CHECK_ERROR("SHMEM is not initialized\n"); \
oshmem_shmem_abort(-1); \
}
/**
* Check if we target PE is valid
*/
#define RUNTIME_CHECK_PE(x) \
if (OPAL_UNLIKELY(((x) < 0) || \
((int)(x) > (int)(ompi_process_info.num_procs - 1)))) \
{ \
RUNTIME_CHECK_ERROR("Target PE #%d is not in valid range\n", (x)); \
oshmem_shmem_abort(-1); \
}
/**
* Check if required address is in symmetric address space
*/
#include "oshmem/mca/memheap/memheap.h"
#define RUNTIME_CHECK_ADDR(x) \
if (OPAL_UNLIKELY(!MCA_MEMHEAP_CALL(is_symmetric_addr((x))))) \
{ \
RUNTIME_CHECK_ERROR("Required address %p is not in symmetric space\n", ((void*)x)); \
oshmem_shmem_abort(-1); \
}
/* Check if address is in symmetric space or size is zero */
#define RUNTIME_CHECK_ADDR_SIZE(x,s) \
if (OPAL_UNLIKELY((s) && !MCA_MEMHEAP_CALL(is_symmetric_addr((x))))) \
{ \
RUNTIME_CHECK_ERROR("Required address %p is not in symmetric space\n", ((void*)x)); \
oshmem_shmem_abort(-1); \
}
#define RUNTIME_CHECK_WITH_MEMHEAP_SIZE(x) \
if (OPAL_UNLIKELY((long)(x) > MCA_MEMHEAP_CALL(size))) \
{ \
RUNTIME_CHECK_ERROR("Requested (%ld)bytes and it exceeds symmetric space size (%ld)bytes\n", (long)(x), MCA_MEMHEAP_CALL(size)); \
}
#else
#define RUNTIME_CHECK_RC(x) (x = x)
#define RUNTIME_CHECK_INIT()
#define RUNTIME_CHECK_PE(x)
#define RUNTIME_CHECK_ADDR(x)
#define RUNTIME_CHECK_ADDR_SIZE(x,s)
#define RUNTIME_CHECK_WITH_MEMHEAP_SIZE(x)
#define RUNTIME_CHECK_IMPL_RC(x)
#endif /* OSHMEM_PARAM_CHECK */
#define RUNTIME_SHMEM_NOT_IMPLEMENTED_API_ABORT() \
do { \
SHMEM_API_ERROR("Called non-implemented API: %s", __func__); \
oshmem_shmem_abort(OSHMEM_ERR_NOT_IMPLEMENTED); \
} while (0)
#define RUNTIME_SHMEM_NOT_IMPLEMENTED_API_ABORT_RET_SIZE_T() \
do { \
RUNTIME_SHMEM_NOT_IMPLEMENTED_API_ABORT(); \
return SIZE_MAX; \
} while (0)
END_C_DECLS
#endif /* OSHMEM_SHMEM_RUNTIME_H */
|
