Actual source code: petscsf.h
1: /*
2: A star forest (SF) describes a communication pattern
3: */
4: #ifndef PETSCSF_H
5: #define PETSCSF_H
7: #include <petscsys.h>
8: #include <petscsftypes.h>
9: #include <petscvec.h>
11: /* SUBMANSEC = PetscSF */
13: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;
15: #define PETSCSFBASIC "basic"
16: #define PETSCSFNEIGHBOR "neighbor"
17: #define PETSCSFALLGATHERV "allgatherv"
18: #define PETSCSFALLGATHER "allgather"
19: #define PETSCSFGATHERV "gatherv"
20: #define PETSCSFGATHER "gather"
21: #define PETSCSFALLTOALL "alltoall"
22: #define PETSCSFWINDOW "window"
24: /*E
25: PetscSFPattern - Pattern of the PetscSF graph
27: $ `PETSCSF_PATTERN_GENERAL` - A general graph. One sets the graph with PetscSFSetGraph() and usually does not use this enum directly.
28: $ `PETSCSF_PATTERN_ALLGATHER` - A graph that every rank gathers all roots from all ranks (like `MPI_Allgather()`). One sets the graph with `PetscSFSetGraphWithPattern()`.
29: $ `PETSCSF_PATTERN_GATHER` - A graph that rank 0 gathers all roots from all ranks (like `MPI_Gatherv()` with root=0). One sets the graph with `PetscSFSetGraphWithPattern()`.
30: $ `PETSCSF_PATTERN_ALLTOALL` - A graph that every rank gathers different roots from all ranks (like `MPI_Alltoall()`). One sets the graph with `PetscSFSetGraphWithPattern()`.
31: In an ALLTOALL graph, we assume each process has <size> leaves and <size> roots, with each leaf connecting to a remote root. Here <size> is
32: the size of the communicator. This does not mean one can not communicate multiple data items between a pair of processes. One just needs to
33: create a new MPI datatype for the multiple data items, e.g., by `MPI_Type_contiguous`.
34: Level: beginner
36: .seealso: `PetscSFSetGraph()`, `PetscSFSetGraphWithPattern()`
37: E*/
38: typedef enum {
39: PETSCSF_PATTERN_GENERAL = 0,
40: PETSCSF_PATTERN_ALLGATHER,
41: PETSCSF_PATTERN_GATHER,
42: PETSCSF_PATTERN_ALLTOALL
43: } PetscSFPattern;
45: /*E
46: PetscSFWindowSyncType - Type of synchronization for `PETSCSFWINDOW`
48: $ `PETSCSF_WINDOW_SYNC_FENCE` - simplest model, synchronizing across communicator
49: $ `PETSCSF_WINDOW_SYNC_LOCK` - passive model, less synchronous, requires less setup than PETSCSF_WINDOW_SYNC_ACTIVE, but may require more handshakes
50: $ `PETSCSF_WINDOW_SYNC_ACTIVE` - active model, provides most information to MPI implementation, needs to construct 2-way process groups (more setup than PETSCSF_WINDOW_SYNC_LOCK)
52: Level: advanced
54: .seealso: `PetscSFWindowSetSyncType()`, `PetscSFWindowGetSyncType()`
55: E*/
56: typedef enum {
57: PETSCSF_WINDOW_SYNC_FENCE,
58: PETSCSF_WINDOW_SYNC_LOCK,
59: PETSCSF_WINDOW_SYNC_ACTIVE
60: } PetscSFWindowSyncType;
61: PETSC_EXTERN const char *const PetscSFWindowSyncTypes[];
63: /*E
64: PetscSFWindowFlavorType - Flavor for the creation of MPI windows for PETSCSFWINDOW
66: $ `PETSCSF_WINDOW_FLAVOR_CREATE` - Use `MPI_Win_create()`, no reuse
67: $ `PETSCSF_WINDOW_FLAVOR_DYNAMIC` - Use `MPI_Win_create_dynamic()` and dynamically attach pointers
68: $ `PETSCSF_WINDOW_FLAVOR_ALLOCATE` - Use `MPI_Win_allocate()`
69: $ `PETSCSF_WINDOW_FLAVOR_SHARED` - Use `MPI_Win_allocate_shared()`
71: Level: advanced
73: .seealso: `PetscSFWindowSetFlavorType()`, `PetscSFWindowGetFlavorType()`
74: E*/
75: typedef enum {
76: PETSCSF_WINDOW_FLAVOR_CREATE,
77: PETSCSF_WINDOW_FLAVOR_DYNAMIC,
78: PETSCSF_WINDOW_FLAVOR_ALLOCATE,
79: PETSCSF_WINDOW_FLAVOR_SHARED
80: } PetscSFWindowFlavorType;
81: PETSC_EXTERN const char *const PetscSFWindowFlavorTypes[];
83: /*E
84: PetscSFDuplicateOption - Aspects to preserve when duplicating a `PetscSF`
86: $ `PETSCSF_DUPLICATE_CONFONLY` - configuration only, user must call `PetscSFSetGraph()`
87: $ `PETSCSF_DUPLICATE_RANKS` - communication ranks preserved, but different graph (allows simpler setup after calling `PetscSFSetGraph()`)
88: $ `PETSCSF_DUPLICATE_GRAPH` - entire graph duplicated
90: Level: beginner
92: .seealso: `PetscSFDuplicate()`
93: E*/
94: typedef enum {
95: PETSCSF_DUPLICATE_CONFONLY,
96: PETSCSF_DUPLICATE_RANKS,
97: PETSCSF_DUPLICATE_GRAPH
98: } PetscSFDuplicateOption;
99: PETSC_EXTERN const char *const PetscSFDuplicateOptions[];
101: PETSC_EXTERN PetscFunctionList PetscSFList;
102: PETSC_EXTERN PetscErrorCode PetscSFRegister(const char[], PetscErrorCode (*)(PetscSF));
104: PETSC_EXTERN PetscErrorCode PetscSFInitializePackage(void);
105: PETSC_EXTERN PetscErrorCode PetscSFFinalizePackage(void);
106: PETSC_EXTERN PetscErrorCode PetscSFCreate(MPI_Comm, PetscSF *);
107: PETSC_EXTERN PetscErrorCode PetscSFDestroy(PetscSF *);
108: PETSC_EXTERN PetscErrorCode PetscSFSetType(PetscSF, PetscSFType);
109: PETSC_EXTERN PetscErrorCode PetscSFGetType(PetscSF, PetscSFType *);
110: PETSC_EXTERN PetscErrorCode PetscSFView(PetscSF, PetscViewer);
111: PETSC_EXTERN PetscErrorCode PetscSFViewFromOptions(PetscSF, PetscObject, const char[]);
112: PETSC_EXTERN PetscErrorCode PetscSFSetUp(PetscSF);
113: PETSC_EXTERN PetscErrorCode PetscSFSetFromOptions(PetscSF);
114: PETSC_EXTERN PetscErrorCode PetscSFDuplicate(PetscSF, PetscSFDuplicateOption, PetscSF *);
115: PETSC_EXTERN PetscErrorCode PetscSFWindowSetSyncType(PetscSF, PetscSFWindowSyncType);
116: PETSC_EXTERN PetscErrorCode PetscSFWindowGetSyncType(PetscSF, PetscSFWindowSyncType *);
117: PETSC_EXTERN PetscErrorCode PetscSFWindowSetFlavorType(PetscSF, PetscSFWindowFlavorType);
118: PETSC_EXTERN PetscErrorCode PetscSFWindowGetFlavorType(PetscSF, PetscSFWindowFlavorType *);
119: PETSC_EXTERN PetscErrorCode PetscSFWindowSetInfo(PetscSF, MPI_Info);
120: PETSC_EXTERN PetscErrorCode PetscSFWindowGetInfo(PetscSF, MPI_Info *);
121: PETSC_EXTERN PetscErrorCode PetscSFSetRankOrder(PetscSF, PetscBool);
122: PETSC_EXTERN PetscErrorCode PetscSFSetGraph(PetscSF, PetscInt, PetscInt, PetscInt *, PetscCopyMode, PetscSFNode *, PetscCopyMode);
123: PETSC_EXTERN PetscErrorCode PetscSFSetGraphWithPattern(PetscSF, PetscLayout, PetscSFPattern);
124: PETSC_EXTERN PetscErrorCode PetscSFGetGraph(PetscSF, PetscInt *, PetscInt *, const PetscInt **, const PetscSFNode **);
125: PETSC_EXTERN PetscErrorCode PetscSFGetLeafRange(PetscSF, PetscInt *, PetscInt *);
126: PETSC_EXTERN PetscErrorCode PetscSFCreateEmbeddedRootSF(PetscSF, PetscInt, const PetscInt *, PetscSF *);
127: PETSC_EXTERN PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF, PetscInt, const PetscInt *, PetscSF *);
128: PETSC_EXTERN PetscErrorCode PetscSFReset(PetscSF);
129: PETSC_EXTERN PetscErrorCode PetscSFSetUpRanks(PetscSF, MPI_Group);
130: PETSC_EXTERN PetscErrorCode PetscSFGetRootRanks(PetscSF, PetscInt *, const PetscMPIInt **, const PetscInt **, const PetscInt **, const PetscInt **);
131: PETSC_EXTERN PetscErrorCode PetscSFGetLeafRanks(PetscSF, PetscInt *, const PetscMPIInt **, const PetscInt **, const PetscInt **);
132: PETSC_EXTERN PetscErrorCode PetscSFGetGroups(PetscSF, MPI_Group *, MPI_Group *);
133: PETSC_EXTERN PetscErrorCode PetscSFGetMultiSF(PetscSF, PetscSF *);
134: PETSC_EXTERN PetscErrorCode PetscSFCreateInverseSF(PetscSF, PetscSF *);
135: PETSC_EXTERN PetscErrorCode PetscSFConcatenate(MPI_Comm, PetscInt, PetscSF[], PetscBool, PetscInt[], PetscSF *);
137: /* Build PetscSF from PetscLayout */
138: PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF, PetscLayout, PetscInt, PetscInt *, PetscCopyMode, const PetscInt *);
139: PETSC_EXTERN PetscErrorCode PetscSFGetGraphLayout(PetscSF, PetscLayout *, PetscInt *, const PetscInt *[], PetscInt *[]);
140: PETSC_EXTERN PetscErrorCode PetscSFCreateFromLayouts(PetscLayout, PetscLayout, PetscSF *);
141: PETSC_EXTERN PetscErrorCode PetscSFCreateByMatchingIndices(PetscLayout, PetscInt, const PetscInt *, const PetscInt *, PetscInt, PetscInt, const PetscInt *, const PetscInt *, PetscInt, PetscSF *, PetscSF *);
143: /* PetscSection interoperability */
144: PETSC_EXTERN PetscErrorCode PetscSFSetGraphSection(PetscSF, PetscSection, PetscSection);
145: PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **);
146: PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection);
147: PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt[], PetscSection, PetscSF *);
149: /* Reduce rootdata to leafdata using provided operation */
150: PETSC_EXTERN PetscErrorCode PetscSFBcastBegin(PetscSF, MPI_Datatype, const void *, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
151: PETSC_EXTERN PetscErrorCode PetscSFBcastEnd(PetscSF, MPI_Datatype, const void *, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
152: PETSC_EXTERN PetscErrorCode PetscSFBcastWithMemTypeBegin(PetscSF, MPI_Datatype, PetscMemType, const void *, PetscMemType, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 2);
154: /* Reduce leafdata into rootdata using provided operation */
155: PETSC_EXTERN PetscErrorCode PetscSFReduceBegin(PetscSF, MPI_Datatype, const void *, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
156: PETSC_EXTERN PetscErrorCode PetscSFReduceEnd(PetscSF, MPI_Datatype, const void *, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
157: PETSC_EXTERN PetscErrorCode PetscSFReduceWithMemTypeBegin(PetscSF, MPI_Datatype, PetscMemType, const void *, PetscMemType, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 2);
159: /* Atomically modifies (using provided operation) rootdata using leafdata from each leaf, value at root at time of modification is returned in leafupdate. */
160: PETSC_EXTERN PetscErrorCode PetscSFFetchAndOpBegin(PetscSF, MPI_Datatype, void *, const void *, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(5, 2);
161: PETSC_EXTERN PetscErrorCode PetscSFFetchAndOpEnd(PetscSF, MPI_Datatype, void *, const void *, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(5, 2);
163: PETSC_EXTERN PetscErrorCode PetscSFFetchAndOpWithMemTypeBegin(PetscSF, MPI_Datatype, PetscMemType, void *, PetscMemType, const void *, PetscMemType, void *, MPI_Op) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(6, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(8, 2);
165: /* Compute the degree of every root vertex (number of leaves in its star) */
166: PETSC_EXTERN PetscErrorCode PetscSFComputeDegreeBegin(PetscSF, const PetscInt **);
167: PETSC_EXTERN PetscErrorCode PetscSFComputeDegreeEnd(PetscSF, const PetscInt **);
168: PETSC_EXTERN PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF, const PetscInt[], PetscInt *, PetscInt *[]);
169: /* Concatenate data from all leaves into roots */
170: PETSC_EXTERN PetscErrorCode PetscSFGatherBegin(PetscSF, MPI_Datatype, const void *, void *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
171: PETSC_EXTERN PetscErrorCode PetscSFGatherEnd(PetscSF, MPI_Datatype, const void *, void *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
172: /* Distribute distinct values to each leaf from roots */
173: PETSC_EXTERN PetscErrorCode PetscSFScatterBegin(PetscSF, MPI_Datatype, const void *, void *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
174: PETSC_EXTERN PetscErrorCode PetscSFScatterEnd(PetscSF, MPI_Datatype, const void *, void *) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(3, 2) PETSC_ATTRIBUTE_MPI_POINTER_WITH_TYPE(4, 2);
176: PETSC_EXTERN PetscErrorCode PetscSFCompose(PetscSF, PetscSF, PetscSF *);
177: PETSC_EXTERN PetscErrorCode PetscSFComposeInverse(PetscSF, PetscSF, PetscSF *);
179: #define MPIU_REPLACE MPI_REPLACE PETSC_DEPRECATED_MACRO("GCC warning \"MPIU_REPLACE macro is deprecated use MPI_REPLACE (since version 3.15)\"")
181: PETSC_DEPRECATED_FUNCTION("Use PetscSFGetRootRanks (since v3.12)")
182: static inline PetscErrorCode PetscSFGetRanks(PetscSF sf, PetscInt *nranks, const PetscMPIInt **ranks, const PetscInt **roffset, const PetscInt **rmine, const PetscInt **rremote)
183: {
184: return PetscSFGetRootRanks(sf, nranks, ranks, roffset, rmine, rremote);
185: }
187: PETSC_DEPRECATED_FUNCTION("Use PetscSFCreateEmbeddedRootSF (since v3.15)")
188: static inline PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF sf, PetscInt nselected, const PetscInt *selected, PetscSF *esf)
189: {
190: return PetscSFCreateEmbeddedRootSF(sf, nselected, selected, esf);
191: }
193: PETSC_DEPRECATED_FUNCTION("Use PetscSFBcastBegin (since v3.15)")
194: static inline PetscErrorCode PetscSFBcastAndOpBegin(PetscSF sf, MPI_Datatype unit, const void *rootdata, void *leafdata, MPI_Op op)
195: {
196: return PetscSFBcastBegin(sf, unit, rootdata, leafdata, op);
197: }
199: PETSC_DEPRECATED_FUNCTION("Use PetscSFBcastEnd (since v3.15)")
200: static inline PetscErrorCode PetscSFBcastAndOpEnd(PetscSF sf, MPI_Datatype unit, const void *rootdata, void *leafdata, MPI_Op op)
201: {
202: return PetscSFBcastEnd(sf, unit, rootdata, leafdata, op);
203: }
205: PETSC_DEPRECATED_FUNCTION("Use PetscSFBcastWithMemTypeBegin (since v3.15)")
206: static inline PetscErrorCode PetscSFBcastAndOpWithMemtypeBegin(PetscSF sf, MPI_Datatype unit, PetscMemType rootmtype, const void *rootdata, PetscMemType leafmtype, void *leafdata, MPI_Op op)
207: {
208: return PetscSFBcastWithMemTypeBegin(sf, unit, rootmtype, rootdata, leafmtype, leafdata, op);
209: }
211: #endif