xref: /petsc/src/vec/is/sf/impls/basic/sfbasic.h (revision cd62000487352d7c447823794a883667dfb859d7)
1 #if !defined(__SFBASIC_H)
2 #define __SFBASIC_H
3 
4 #include <petsc/private/sfimpl.h> /*I "petscsf.h" I*/
5 
6 typedef struct _n_PetscSFLink* PetscSFLink;
7 
8 #define SFBASICHEADER \
9   PetscMPIInt      niranks;         /* Number of incoming ranks (ranks accessing my roots) */                                      \
10   PetscMPIInt      ndiranks;        /* Number of incoming ranks (ranks accessing my roots) in distinguished set */                 \
11   PetscMPIInt      *iranks;         /* Array of ranks that reference my roots */                                                   \
12   PetscInt         itotal;          /* Total number of graph edges referencing my roots */                                         \
13   PetscInt         *ioffset;        /* Array of length niranks+1 holding offset in irootloc[] for each rank */                     \
14   PetscInt         *irootloc;       /* Incoming roots referenced by ranks starting at ioffset[rank] */                             \
15   PetscInt         *irootloc_d[2];  /* A copy of irootloc[local/remote] in device memory if needed */                              \
16   PetscInt         rootbuflen[2];   /* Length (in unit) of root buffers, in layout of [PETSCSF_LOCAL/REMOTE] */                    \
17   PetscBool        rootcontig[2];   /* True means the local/remote segments of indices in irootloc[] are contiguous ... */         \
18   PetscInt         rootstart[2];    /* ... and start from rootstart[0] and rootstart[1] respectively */                            \
19   PetscSFPackOpt   rootpackopt[2];  /* Pack optimization plans based on patterns in irootloc[]. NULL for no optimizations */       \
20   PetscBool        rootdups[2];     /* Indices of roots in irootloc[local/remote] have dups. Used for data-race test */            \
21   PetscInt         nrootreqs;       /* Number of MPI reqests */                                                                    \
22   PetscSFLink      avail;           /* One or more entries per MPI Datatype, lazily constructed */                                 \
23   PetscSFLink      inuse            /* Buffers being used for transactions that have not yet completed */
24 
25 typedef struct {
26   SFBASICHEADER;
27 } PetscSF_Basic;
28 
29 PETSC_STATIC_INLINE PetscErrorCode PetscSFGetRootInfo_Basic(PetscSF sf,PetscInt *nrootranks,PetscInt *ndrootranks,const PetscMPIInt **rootranks,const PetscInt **rootoffset,const PetscInt **rootloc)
30 {
31   PetscSF_Basic *bas = (PetscSF_Basic*)sf->data;
32 
33   PetscFunctionBegin;
34   if (nrootranks)  *nrootranks  = bas->niranks;
35   if (ndrootranks) *ndrootranks = bas->ndiranks;
36   if (rootranks)   *rootranks   = bas->iranks;
37   if (rootoffset)  *rootoffset  = bas->ioffset;
38   if (rootloc)     *rootloc     = bas->irootloc;
39   PetscFunctionReturn(0);
40 }
41 
42 PETSC_STATIC_INLINE PetscErrorCode PetscSFGetLeafInfo_Basic(PetscSF sf,PetscInt *nleafranks,PetscInt *ndleafranks,const PetscMPIInt **leafranks,const PetscInt **leafoffset,const PetscInt **leafloc,const PetscInt **leafrremote)
43 {
44   PetscFunctionBegin;
45   if (nleafranks)  *nleafranks  = sf->nranks;
46   if (ndleafranks) *ndleafranks = sf->ndranks;
47   if (leafranks)   *leafranks   = sf->ranks;
48   if (leafoffset)  *leafoffset  = sf->roffset;
49   if (leafloc)     *leafloc     = sf->rmine;
50   if (leafrremote) *leafrremote = sf->rremote;
51   PetscFunctionReturn(0);
52 }
53 
54 PETSC_INTERN PetscErrorCode PetscSFSetUp_Basic(PetscSF);
55 PETSC_INTERN PetscErrorCode PetscSFView_Basic(PetscSF,PetscViewer);
56 PETSC_INTERN PetscErrorCode PetscSFReset_Basic(PetscSF);
57 PETSC_INTERN PetscErrorCode PetscSFDestroy_Basic(PetscSF);
58 PETSC_INTERN PetscErrorCode PetscSFBcastAndOpEnd_Basic  (PetscSF,MPI_Datatype,PetscMemType,const void*,PetscMemType,      void*,      MPI_Op);
59 PETSC_INTERN PetscErrorCode PetscSFReduceEnd_Basic      (PetscSF,MPI_Datatype,PetscMemType,const void*,PetscMemType,      void*,      MPI_Op);
60 PETSC_INTERN PetscErrorCode PetscSFFetchAndOpBegin_Basic(PetscSF,MPI_Datatype,PetscMemType,      void*,PetscMemType,const void*,void*,MPI_Op);
61 PETSC_INTERN PetscErrorCode PetscSFCreateEmbeddedSF_Basic(PetscSF,PetscInt,const PetscInt*,PetscSF*);
62 PETSC_INTERN PetscErrorCode PetscSFGetLeafRanks_Basic(PetscSF,PetscInt*,const PetscMPIInt**,const PetscInt**,const PetscInt**);
63 #endif
64