1 /* 2 A star forest (SF) describes a communication pattern 3 */ 4 #pragma once 5 6 #include <petscsys.h> 7 #include <petscsftypes.h> 8 #include <petscvec.h> /* for Vec, VecScatter etc */ 9 10 /* SUBMANSEC = PetscSF */ 11 12 PETSC_EXTERN PetscClassId PETSCSF_CLASSID; 13 14 /*E 15 PetscSFPattern - Pattern of the `PetscSF` graph 16 17 Values: 18 + `PETSCSF_PATTERN_GENERAL` - A general graph. One sets the graph with `PetscSFSetGraph()` and usually does not use this enum directly. 19 . `PETSCSF_PATTERN_ALLGATHER` - A graph that every rank gathers all roots from all ranks (like `MPI_Allgather()`). One sets the graph with `PetscSFSetGraphWithPattern()`. 20 . `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()`. 21 - `PETSCSF_PATTERN_ALLTOALL` - A graph that every rank gathers different roots from all ranks (like `MPI_Alltoall()`). One sets the graph with `PetscSFSetGraphWithPattern()`. 22 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 23 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 24 create a new MPI datatype for the multiple data items, e.g., by `MPI_Type_contiguous`. 25 Level: beginner 26 27 .seealso: `PetscSF`, `PetscSFSetGraph()`, `PetscSFSetGraphWithPattern()` 28 E*/ 29 typedef enum { 30 PETSCSF_PATTERN_GENERAL = 0, 31 PETSCSF_PATTERN_ALLGATHER, 32 PETSCSF_PATTERN_GATHER, 33 PETSCSF_PATTERN_ALLTOALL 34 } PetscSFPattern; 35 36 /*E 37 PetscSFWindowSyncType - Type of synchronization for `PETSCSFWINDOW` 38 39 Values: 40 + `PETSCSF_WINDOW_SYNC_FENCE` - simplest model, synchronizing across communicator 41 . `PETSCSF_WINDOW_SYNC_LOCK` - passive model, less synchronous, requires less setup than `PETSCSF_WINDOW_SYNC_ACTIVE`, but may require more handshakes 42 - `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`) 43 44 Level: advanced 45 46 .seealso: `PetscSF`, `PetscSFWindowSetSyncType()`, `PetscSFWindowGetSyncType()` 47 E*/ 48 typedef enum { 49 PETSCSF_WINDOW_SYNC_FENCE, 50 PETSCSF_WINDOW_SYNC_LOCK, 51 PETSCSF_WINDOW_SYNC_ACTIVE 52 } PetscSFWindowSyncType; 53 PETSC_EXTERN const char *const PetscSFWindowSyncTypes[]; 54 55 /*E 56 PetscSFWindowFlavorType - Flavor for the creation of MPI windows for `PETSCSFWINDOW` 57 58 Values: 59 + `PETSCSF_WINDOW_FLAVOR_CREATE` - Use `MPI_Win_create()`, no reuse 60 . `PETSCSF_WINDOW_FLAVOR_DYNAMIC` - Use `MPI_Win_create_dynamic()` and dynamically attach pointers 61 . `PETSCSF_WINDOW_FLAVOR_ALLOCATE` - Use `MPI_Win_allocate()` 62 - `PETSCSF_WINDOW_FLAVOR_SHARED` - Use `MPI_Win_allocate_shared()` 63 64 Level: advanced 65 66 .seealso: `PetscSF`, `PetscSFWindowSetFlavorType()`, `PetscSFWindowGetFlavorType()` 67 E*/ 68 typedef enum { 69 PETSCSF_WINDOW_FLAVOR_CREATE, 70 PETSCSF_WINDOW_FLAVOR_DYNAMIC, 71 PETSCSF_WINDOW_FLAVOR_ALLOCATE, 72 PETSCSF_WINDOW_FLAVOR_SHARED 73 } PetscSFWindowFlavorType; 74 PETSC_EXTERN const char *const PetscSFWindowFlavorTypes[]; 75 76 /*E 77 PetscSFDuplicateOption - Aspects to preserve when duplicating a `PetscSF` 78 79 Values: 80 + `PETSCSF_DUPLICATE_CONFONLY` - configuration only, user must call `PetscSFSetGraph()` 81 . `PETSCSF_DUPLICATE_RANKS` - communication ranks preserved, but different graph (allows simpler setup after calling `PetscSFSetGraph()`) 82 - `PETSCSF_DUPLICATE_GRAPH` - entire graph duplicated 83 84 Level: beginner 85 86 .seealso: `PetscSF`, `PetscSFDuplicate()` 87 E*/ 88 typedef enum { 89 PETSCSF_DUPLICATE_CONFONLY, 90 PETSCSF_DUPLICATE_RANKS, 91 PETSCSF_DUPLICATE_GRAPH 92 } PetscSFDuplicateOption; 93 PETSC_EXTERN const char *const PetscSFDuplicateOptions[]; 94 95 /*E 96 PetscSFConcatenateRootMode - Modes of root concatenation when concatenating `PetscSF`s 97 98 Values: 99 + `PETSCSF_CONCATENATE_ROOTMODE_LOCAL` - concatenate root spaces locally (separately on each rank) 100 . `PETSCSF_CONCATENATE_ROOTMODE_SHARED` - do not concatenate roots; root space is considered the same for each input `PetscSF` (checked in debug mode) 101 - `PETSCSF_CONCATENATE_ROOTMODE_GLOBAL` - concatenate root spaces globally 102 103 Level: advanced 104 105 .seealso: `PetscSF`, `PetscSFConcatenate()` 106 E*/ 107 typedef enum { 108 PETSCSF_CONCATENATE_ROOTMODE_LOCAL, 109 PETSCSF_CONCATENATE_ROOTMODE_SHARED, 110 PETSCSF_CONCATENATE_ROOTMODE_GLOBAL, 111 } PetscSFConcatenateRootMode; 112 PETSC_EXTERN const char *const PetscSFConcatenateRootModes[]; 113 114 PETSC_EXTERN PetscFunctionList PetscSFList; 115 PETSC_EXTERN PetscErrorCode PetscSFRegister(const char[], PetscErrorCode (*)(PetscSF)); 116 117 PETSC_EXTERN PetscErrorCode PetscSFInitializePackage(void); 118 PETSC_EXTERN PetscErrorCode PetscSFFinalizePackage(void); 119 PETSC_EXTERN PetscErrorCode PetscSFCreate(MPI_Comm, PetscSF *); 120 PETSC_EXTERN PetscErrorCode PetscSFDestroy(PetscSF *); 121 PETSC_EXTERN PetscErrorCode PetscSFSetType(PetscSF, PetscSFType); 122 PETSC_EXTERN PetscErrorCode PetscSFGetType(PetscSF, PetscSFType *); 123 PETSC_EXTERN PetscErrorCode PetscSFView(PetscSF, PetscViewer); 124 PETSC_EXTERN PetscErrorCode PetscSFViewFromOptions(PetscSF, PetscObject, const char[]); 125 PETSC_EXTERN PetscErrorCode PetscSFSetUp(PetscSF); 126 PETSC_EXTERN PetscErrorCode PetscSFSetFromOptions(PetscSF); 127 PETSC_EXTERN PetscErrorCode PetscSFDuplicate(PetscSF, PetscSFDuplicateOption, PetscSF *); 128 PETSC_EXTERN PetscErrorCode PetscSFWindowSetSyncType(PetscSF, PetscSFWindowSyncType); 129 PETSC_EXTERN PetscErrorCode PetscSFWindowGetSyncType(PetscSF, PetscSFWindowSyncType *); 130 PETSC_EXTERN PetscErrorCode PetscSFWindowSetFlavorType(PetscSF, PetscSFWindowFlavorType); 131 PETSC_EXTERN PetscErrorCode PetscSFWindowGetFlavorType(PetscSF, PetscSFWindowFlavorType *); 132 PETSC_EXTERN PetscErrorCode PetscSFWindowSetInfo(PetscSF, MPI_Info); 133 PETSC_EXTERN PetscErrorCode PetscSFWindowGetInfo(PetscSF, MPI_Info *); 134 PETSC_EXTERN PetscErrorCode PetscSFSetRankOrder(PetscSF, PetscBool); 135 PETSC_EXTERN PetscErrorCode PetscSFSetGraph(PetscSF, PetscInt, PetscInt, PetscInt *, PetscCopyMode, PetscSFNode *, PetscCopyMode); 136 PETSC_EXTERN PetscErrorCode PetscSFSetGraphWithPattern(PetscSF, PetscLayout, PetscSFPattern); 137 PETSC_EXTERN PetscErrorCode PetscSFGetGraph(PetscSF, PetscInt *, PetscInt *, const PetscInt **, const PetscSFNode **); 138 PETSC_EXTERN PetscErrorCode PetscSFGetLeafRange(PetscSF, PetscInt *, PetscInt *); 139 PETSC_EXTERN PetscErrorCode PetscSFCreateEmbeddedRootSF(PetscSF, PetscInt, const PetscInt *, PetscSF *); 140 PETSC_EXTERN PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF, PetscInt, const PetscInt *, PetscSF *); 141 PETSC_EXTERN PetscErrorCode PetscSFReset(PetscSF); 142 PETSC_EXTERN PetscErrorCode PetscSFSetUpRanks(PetscSF, MPI_Group); 143 PETSC_EXTERN PetscErrorCode PetscSFGetRootRanks(PetscSF, PetscInt *, const PetscMPIInt **, const PetscInt **, const PetscInt **, const PetscInt **); 144 PETSC_EXTERN PetscErrorCode PetscSFGetLeafRanks(PetscSF, PetscInt *, const PetscMPIInt **, const PetscInt **, const PetscInt **); 145 PETSC_EXTERN PetscErrorCode PetscSFGetGroups(PetscSF, MPI_Group *, MPI_Group *); 146 PETSC_EXTERN PetscErrorCode PetscSFGetMultiSF(PetscSF, PetscSF *); 147 PETSC_EXTERN PetscErrorCode PetscSFCreateInverseSF(PetscSF, PetscSF *); 148 PETSC_EXTERN PetscErrorCode PetscSFConcatenate(MPI_Comm, PetscInt, PetscSF[], PetscSFConcatenateRootMode, PetscInt[], PetscSF *); 149 150 /* Build PetscSF from PetscLayout */ 151 PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF, PetscLayout, PetscInt, PetscInt *, PetscCopyMode, const PetscInt *); 152 PETSC_EXTERN PetscErrorCode PetscSFGetGraphLayout(PetscSF, PetscLayout *, PetscInt *, const PetscInt *[], PetscInt *[]); 153 PETSC_EXTERN PetscErrorCode PetscSFCreateFromLayouts(PetscLayout, PetscLayout, PetscSF *); 154 PETSC_EXTERN PetscErrorCode PetscSFCreateByMatchingIndices(PetscLayout, PetscInt, const PetscInt *, const PetscInt *, PetscInt, PetscInt, const PetscInt *, const PetscInt *, PetscInt, PetscSF *, PetscSF *); 155 PETSC_EXTERN PetscErrorCode PetscSFMerge(PetscSF, PetscSF, PetscSF *); 156 PETSC_EXTERN PetscErrorCode PetscSFSetGraphFromCoordinates(PetscSF, PetscInt, PetscInt, PetscInt, PetscReal, const PetscReal *, const PetscReal *); 157 158 /* PetscSection interoperability */ 159 PETSC_EXTERN PetscErrorCode PetscSFSetGraphSection(PetscSF, PetscSection, PetscSection); 160 PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **); 161 PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection); 162 PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt[], PetscSection, PetscSF *); 163 164 /* Reduce rootdata to leafdata using provided operation */ 165 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); 166 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); 167 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); 168 169 /* Reduce leafdata into rootdata using provided operation */ 170 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); 171 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); 172 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); 173 174 /* Atomically modifies (using provided operation) rootdata using leafdata from each leaf, value at root at time of modification is returned in leafupdate. */ 175 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); 176 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); 177 178 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); 179 180 /* Compute the degree of every root vertex (number of leaves in its star) */ 181 PETSC_EXTERN PetscErrorCode PetscSFComputeDegreeBegin(PetscSF, const PetscInt **); 182 PETSC_EXTERN PetscErrorCode PetscSFComputeDegreeEnd(PetscSF, const PetscInt **); 183 PETSC_EXTERN PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF, const PetscInt[], PetscInt *, PetscInt *[]); 184 /* Concatenate data from all leaves into roots */ 185 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); 186 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); 187 /* Distribute distinct values to each leaf from roots */ 188 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); 189 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); 190 191 PETSC_EXTERN PetscErrorCode PetscSFCompose(PetscSF, PetscSF, PetscSF *); 192 PETSC_EXTERN PetscErrorCode PetscSFComposeInverse(PetscSF, PetscSF, PetscSF *); 193 194 #define MPIU_REPLACE MPI_REPLACE PETSC_DEPRECATED_MACRO(3, 15, 0, "MPI_REPLACE", ) 195 196 PETSC_DEPRECATED_FUNCTION(3, 12, 0, "PetscSFGetRootRanks()", ) 197 static inline PetscErrorCode PetscSFGetRanks(PetscSF sf, PetscInt *nranks, const PetscMPIInt **ranks, const PetscInt **roffset, const PetscInt **rmine, const PetscInt **rremote) 198 { 199 return PetscSFGetRootRanks(sf, nranks, ranks, roffset, rmine, rremote); 200 } 201 202 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscSFCreateEmbeddedRootSF()", ) 203 static inline PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF sf, PetscInt nselected, const PetscInt *selected, PetscSF *esf) 204 { 205 return PetscSFCreateEmbeddedRootSF(sf, nselected, selected, esf); 206 } 207 208 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscSFBcastBegin()", ) 209 static inline PetscErrorCode PetscSFBcastAndOpBegin(PetscSF sf, MPI_Datatype unit, const void *rootdata, void *leafdata, MPI_Op op) 210 { 211 return PetscSFBcastBegin(sf, unit, rootdata, leafdata, op); 212 } 213 214 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscSFBcastEnd()", ) 215 static inline PetscErrorCode PetscSFBcastAndOpEnd(PetscSF sf, MPI_Datatype unit, const void *rootdata, void *leafdata, MPI_Op op) 216 { 217 return PetscSFBcastEnd(sf, unit, rootdata, leafdata, op); 218 } 219 220 PETSC_DEPRECATED_FUNCTION(3, 15, 0, "PetscSFBcastWithMemTypeBegin()", ) 221 static inline PetscErrorCode PetscSFBcastAndOpWithMemtypeBegin(PetscSF sf, MPI_Datatype unit, PetscMemType rootmtype, const void *rootdata, PetscMemType leafmtype, void *leafdata, MPI_Op op) 222 { 223 return PetscSFBcastWithMemTypeBegin(sf, unit, rootmtype, rootdata, leafmtype, leafdata, op); 224 } 225