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
|
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2004-2010 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2005 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2015 Los Alamos National Security, LLC. All rights
* reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
/**
* @file
*
* Checkpoint/Restart Coordination Protocol (CRCP) Interface
*
*/
#ifndef MCA_CRCP_H
#define MCA_CRCP_H
#include "ompi_config.h"
#include "opal/class/opal_object.h"
#include "ompi/mca/mca.h"
#include "opal/mca/base/base.h"
#include "opal/mca/crs/crs.h"
#include "opal/mca/crs/base/base.h"
#include "opal/mca/btl/btl.h"
#include "opal/mca/btl/base/base.h"
#include "opal/class/opal_free_list.h"
#include "ompi/datatype/ompi_datatype.h"
#include "ompi/request/request.h"
#include "ompi/mca/pml/pml.h"
#include "ompi/mca/pml/base/base.h"
BEGIN_C_DECLS
/**
* Module initialization function.
* Returns OMPI_SUCCESS
*/
typedef int (*ompi_crcp_base_module_init_fn_t)
(void);
/**
* Module finalization function.
* Returns OMPI_SUCCESS
*/
typedef int (*ompi_crcp_base_module_finalize_fn_t)
(void);
/************************
* MPI Quiesce Interface
************************/
/**
* MPI_Quiesce_start component interface
*/
typedef int (*ompi_crcp_base_quiesce_start_fn_t)
(MPI_Info *info);
/**
* MPI_Quiesce_end component interface
*/
typedef int (*ompi_crcp_base_quiesce_end_fn_t)
(MPI_Info *info);
/************************
* PML Wrapper hooks
* PML Wrapper is the CRCPW PML component
************************/
/**
* To allow us to work before and after a PML command
*/
enum ompi_crcp_base_pml_states_t {
OMPI_CRCP_PML_PRE,
OMPI_CRCP_PML_POST,
OMPI_CRCP_PML_SKIP,
OMPI_CRCP_PML_DONE
};
typedef enum ompi_crcp_base_pml_states_t ompi_crcp_base_pml_states_t;
struct ompi_crcp_base_pml_state_t {
opal_free_list_item_t super;
ompi_crcp_base_pml_states_t state;
int error_code;
mca_pml_base_component_t *wrapped_pml_component;
mca_pml_base_module_t *wrapped_pml_module;
};
typedef struct ompi_crcp_base_pml_state_t ompi_crcp_base_pml_state_t;
OMPI_DECLSPEC OBJ_CLASS_DECLARATION(ompi_crcp_base_pml_state_t);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_enable_fn_t)
(bool enable, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_add_comm_fn_t)
( struct ompi_communicator_t* comm , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_del_comm_fn_t)
( struct ompi_communicator_t* comm , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_add_procs_fn_t)
( struct ompi_proc_t **procs, size_t nprocs , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_del_procs_fn_t)
( struct ompi_proc_t **procs, size_t nprocs , ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_progress_fn_t)
(ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_iprobe_fn_t)
(int dst, int tag, struct ompi_communicator_t* comm, int *matched,
ompi_status_public_t* status, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_probe_fn_t)
( int dst, int tag, struct ompi_communicator_t* comm,
ompi_status_public_t* status, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_isend_init_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int dst, int tag,
mca_pml_base_send_mode_t mode, struct ompi_communicator_t* comm,
struct ompi_request_t **request, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_isend_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int dst, int tag,
mca_pml_base_send_mode_t mode, struct ompi_communicator_t* comm,
struct ompi_request_t **request, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_send_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int dst, int tag,
mca_pml_base_send_mode_t mode, struct ompi_communicator_t* comm,
ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_irecv_init_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int src, int tag,
struct ompi_communicator_t* comm, struct ompi_request_t **request,
ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_irecv_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int src, int tag,
struct ompi_communicator_t* comm, struct ompi_request_t **request,
ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_recv_fn_t)
( void *buf, size_t count, ompi_datatype_t *datatype, int src, int tag,
struct ompi_communicator_t* comm, ompi_status_public_t* status,
ompi_crcp_base_pml_state_t*);
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_dump_fn_t)
( struct ompi_communicator_t* comm, int verbose, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_start_fn_t)
( size_t count, ompi_request_t** requests, ompi_crcp_base_pml_state_t* );
typedef ompi_crcp_base_pml_state_t* (*ompi_crcp_base_pml_ft_event_fn_t)
(int state, ompi_crcp_base_pml_state_t*);
/* Request Interface */
typedef int (*ompi_crcp_base_request_complete_fn_t)
(struct ompi_request_t *request);
/************************
* BTL Wrapper hooks
* JJH: Wrapper BTL not currently implemented.
************************/
/**
* To allow us to work before and after a BTL command
*/
enum ompi_crcp_base_btl_states_t {
OMPI_CRCP_BTL_PRE,
OMPI_CRCP_BTL_POST,
OMPI_CRCP_BTL_SKIP,
OMPI_CRCP_BTL_DONE
};
typedef enum ompi_crcp_base_btl_states_t ompi_crcp_base_btl_states_t;
struct ompi_crcp_base_btl_state_t {
opal_free_list_item_t super;
ompi_crcp_base_btl_states_t state;
int error_code;
mca_btl_base_descriptor_t* des;
mca_btl_base_component_t *wrapped_btl_component;
mca_btl_base_module_t *wrapped_btl_module;
};
typedef struct ompi_crcp_base_btl_state_t ompi_crcp_base_btl_state_t;
OBJ_CLASS_DECLARATION(ompi_crcp_base_btl_state_t);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_add_procs_fn_t)
( struct mca_btl_base_module_t* btl,
size_t nprocs,
struct ompi_proc_t** procs,
struct mca_btl_base_endpoint_t** endpoints,
struct opal_bitmap_t* reachable,
ompi_crcp_base_btl_state_t* );
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_del_procs_fn_t)
( struct mca_btl_base_module_t* btl,
size_t nprocs,
struct ompi_proc_t** procs,
struct mca_btl_base_endpoint_t**,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_register_fn_t)
( struct mca_btl_base_module_t* btl,
mca_btl_base_tag_t tag,
mca_btl_base_module_recv_cb_fn_t cbfunc,
void* cbdata,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_finalize_fn_t)
( struct mca_btl_base_module_t* btl,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_alloc_fn_t)
( struct mca_btl_base_module_t* btl,
size_t size,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_free_fn_t)
( struct mca_btl_base_module_t* btl,
mca_btl_base_descriptor_t* descriptor,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_prepare_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
mca_rcache_base_registration_t* registration,
struct opal_convertor_t* convertor,
size_t reserve,
size_t* size,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_send_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
struct mca_btl_base_descriptor_t* descriptor,
mca_btl_base_tag_t tag,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_put_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
struct mca_btl_base_descriptor_t* descriptor,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_get_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
struct mca_btl_base_descriptor_t* descriptor,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_dump_fn_t)
( struct mca_btl_base_module_t* btl,
struct mca_btl_base_endpoint_t* endpoint,
int verbose,
ompi_crcp_base_btl_state_t*);
typedef ompi_crcp_base_btl_state_t* (*mca_crcp_base_btl_module_ft_event_fn_t)
(int state,
ompi_crcp_base_btl_state_t*);
/**
* Structure for CRCP components.
*/
struct ompi_crcp_base_component_2_0_0_t {
/** MCA base component */
mca_base_component_t base_version;
/** MCA base data */
mca_base_component_data_t base_data;
/** Verbosity Level */
int verbose;
/** Output Handle for opal_output */
int output_handle;
/** Default Priority */
int priority;
};
typedef struct ompi_crcp_base_component_2_0_0_t ompi_crcp_base_component_2_0_0_t;
typedef struct ompi_crcp_base_component_2_0_0_t ompi_crcp_base_component_t;
/**
* Structure for CRCP modules
*/
struct ompi_crcp_base_module_1_0_0_t {
/** Initialization Function */
ompi_crcp_base_module_init_fn_t crcp_init;
/** Finalization Function */
ompi_crcp_base_module_finalize_fn_t crcp_finalize;
/**< MPI_Quiesce Interface Functions ******************/
ompi_crcp_base_quiesce_start_fn_t quiesce_start;
ompi_crcp_base_quiesce_end_fn_t quiesce_end;
/**< PML Wrapper Functions ****************************/
ompi_crcp_base_pml_enable_fn_t pml_enable;
ompi_crcp_base_pml_add_comm_fn_t pml_add_comm;
ompi_crcp_base_pml_del_comm_fn_t pml_del_comm;
ompi_crcp_base_pml_add_procs_fn_t pml_add_procs;
ompi_crcp_base_pml_del_procs_fn_t pml_del_procs;
ompi_crcp_base_pml_progress_fn_t pml_progress;
ompi_crcp_base_pml_iprobe_fn_t pml_iprobe;
ompi_crcp_base_pml_probe_fn_t pml_probe;
ompi_crcp_base_pml_isend_init_fn_t pml_isend_init;
ompi_crcp_base_pml_isend_fn_t pml_isend;
ompi_crcp_base_pml_send_fn_t pml_send;
ompi_crcp_base_pml_irecv_init_fn_t pml_irecv_init;
ompi_crcp_base_pml_irecv_fn_t pml_irecv;
ompi_crcp_base_pml_recv_fn_t pml_recv;
ompi_crcp_base_pml_dump_fn_t pml_dump;
ompi_crcp_base_pml_start_fn_t pml_start;
ompi_crcp_base_pml_ft_event_fn_t pml_ft_event;
/**< Request complete Function ****************************/
ompi_crcp_base_request_complete_fn_t request_complete;
/**< BTL Wrapper Functions ****************************/
mca_crcp_base_btl_module_add_procs_fn_t btl_add_procs;
mca_crcp_base_btl_module_del_procs_fn_t btl_del_procs;
mca_crcp_base_btl_module_register_fn_t btl_register;
mca_crcp_base_btl_module_finalize_fn_t btl_finalize;
mca_crcp_base_btl_module_alloc_fn_t btl_alloc;
mca_crcp_base_btl_module_free_fn_t btl_free;
mca_crcp_base_btl_module_prepare_fn_t btl_prepare_src;
mca_crcp_base_btl_module_prepare_fn_t btl_prepare_dst;
mca_crcp_base_btl_module_send_fn_t btl_send;
mca_crcp_base_btl_module_put_fn_t btl_put;
mca_crcp_base_btl_module_get_fn_t btl_get;
mca_crcp_base_btl_module_dump_fn_t btl_dump;
mca_crcp_base_btl_module_ft_event_fn_t btl_ft_event;
};
typedef struct ompi_crcp_base_module_1_0_0_t ompi_crcp_base_module_1_0_0_t;
typedef struct ompi_crcp_base_module_1_0_0_t ompi_crcp_base_module_t;
OMPI_DECLSPEC extern ompi_crcp_base_module_t ompi_crcp;
/**
* Macro for use in components that are of type CRCP
*/
#define OMPI_CRCP_BASE_VERSION_2_0_0 \
OMPI_MCA_BASE_VERSION_2_1_0("crcp", 2, 0, 0)
/**
* Macro to call the CRCP Request Complete function
*/
#if OPAL_ENABLE_FT_CR == 1
#define OMPI_CRCP_REQUEST_COMPLETE(req) \
if( NULL != ompi_crcp.request_complete) { \
ompi_crcp.request_complete(req); \
}
#else
#define OMPI_CRCP_REQUEST_COMPLETE(req) ;
#endif
END_C_DECLS
#endif /* OMPI_CRCP_H */
|
