File: base.h

package info (click to toggle)
openmpi 4.1.0-10
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 126,560 kB
  • sloc: ansic: 685,465; makefile: 42,952; f90: 19,220; sh: 7,002; java: 6,360; perl: 3,524; cpp: 2,227; python: 1,350; lex: 989; fortran: 61; tcl: 12
file content (201 lines) | stat: -rw-r--r-- 10,136 bytes parent folder | download | duplicates (3)
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
/* -*- 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$
 */
#ifndef OMPI_CRCP_BASE_H
#define OMPI_CRCP_BASE_H

#include "ompi_config.h"

#include "opal/mca/base/base.h"
#include "ompi/constants.h"

#include "ompi/mca/crcp/crcp.h"

/*
 * Global functions for MCA overall CRCP
 */

BEGIN_C_DECLS

    /**
     * Select an available component.
     *
     * @retval OMPI_SUCCESS Upon Success
     * @retval OMPI_NOT_FOUND If no component can be selected
     * @retval OMPI_ERROR Upon other failure
     *
     */
    OMPI_DECLSPEC int ompi_crcp_base_select(void);

    /**
     * Quiesce Interface (For MPI Ext.)
     */
    OMPI_DECLSPEC int ompi_crcp_base_quiesce_start(MPI_Info *info);
    OMPI_DECLSPEC int ompi_crcp_base_quiesce_end(MPI_Info *info);

    /**
     * 'None' component functions
     * These are to be used when no component is selected.
     * They just return success, and empty strings as necessary.
     */
    int ompi_crcp_base_none_open(void);
    int ompi_crcp_base_none_close(void);
    int ompi_crcp_base_none_query(mca_base_module_t **module, int *priority);

    int ompi_crcp_base_module_init(void);
    int ompi_crcp_base_module_finalize(void);

    /* Quiesce Interface */
    int ompi_crcp_base_none_quiesce_start(MPI_Info *info);
    int ompi_crcp_base_none_quiesce_end(MPI_Info *info);

    /* PML Interface */
    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_enable( bool enable, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_add_comm( struct ompi_communicator_t* comm, ompi_crcp_base_pml_state_t* );
    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_del_comm( struct ompi_communicator_t* comm, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_add_procs( struct ompi_proc_t **procs, size_t nprocs, ompi_crcp_base_pml_state_t* );
    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_del_procs( struct ompi_proc_t **procs, size_t nprocs, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_progress(ompi_crcp_base_pml_state_t*);

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_iprobe(int dst, int tag, struct ompi_communicator_t* comm, int *matched, ompi_status_public_t* status, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_probe( int dst, int tag, struct ompi_communicator_t* comm, ompi_status_public_t* status, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_isend_init( 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* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_isend( 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* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_send(  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* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_irecv_init( 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*);

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_irecv( 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* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_recv(  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*);

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_dump( struct ompi_communicator_t* comm, int verbose, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_start( size_t count, ompi_request_t** requests, ompi_crcp_base_pml_state_t* );

    ompi_crcp_base_pml_state_t* ompi_crcp_base_none_pml_ft_event(int state, ompi_crcp_base_pml_state_t*);

    /* Request Interface */
    int ompi_crcp_base_none_request_complete( struct ompi_request_t *request );

    /* BTL Interface */
    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_add_procs( 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* );

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_del_procs( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_register( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_finalize( struct mca_btl_base_module_t* btl,
                                      ompi_crcp_base_btl_state_t*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_alloc( struct mca_btl_base_module_t* btl,
                                   size_t size,
                                   ompi_crcp_base_btl_state_t*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_free( struct mca_btl_base_module_t* btl,
                                  mca_btl_base_descriptor_t* descriptor,
                                  ompi_crcp_base_btl_state_t*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_prepare_src( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_prepare_dst( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_send( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_put( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_get( 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*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_dump( struct mca_btl_base_module_t* btl,
                                  struct mca_btl_base_endpoint_t* endpoint,
                                  int verbose,
                                  ompi_crcp_base_btl_state_t*);

    ompi_crcp_base_btl_state_t*
    ompi_crcp_base_none_btl_ft_event(int state,
                                     ompi_crcp_base_btl_state_t*);

    OMPI_DECLSPEC extern mca_base_framework_t ompi_crcp_base_framework;
    OMPI_DECLSPEC extern ompi_crcp_base_component_t ompi_crcp_base_selected_component;
    OMPI_DECLSPEC extern ompi_crcp_base_module_t ompi_crcp;

END_C_DECLS

#endif /* OMPI_CRCP_BASE_H */