1 // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 2 // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 3 // reserved. See files LICENSE and NOTICE for details. 4 // 5 // This file is part of CEED, a collection of benchmarks, miniapps, software 6 // libraries and APIs for efficient high-order finite element and spectral 7 // element discretizations for exascale applications. For more information and 8 // source code availability see http://github.com/ceed. 9 // 10 // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 11 // a collaborative effort of two U.S. Department of Energy organizations (Office 12 // of Science and the National Nuclear Security Administration) responsible for 13 // the planning and preparation of a capable exascale ecosystem, including 14 // software, applications, hardware, advanced system engineering and early 15 // testbed platforms, in support of the nation's exascale computing imperative. 16 17 /// @file 18 /// Public header for backend components of libCEED 19 #ifndef _ceed_backend_h 20 #define _ceed_backend_h 21 22 #include <ceed/ceed.h> 23 #include <stdbool.h> 24 25 #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden"))) 26 #define CEED_UNUSED __attribute__((unused)) 27 28 #define CEED_MAX_RESOURCE_LEN 1024 29 #define CEED_ALIGN 64 30 #define CEED_COMPOSITE_MAX 16 31 #define CEED_EPSILON 1E-16 32 33 /// CEED_DEBUG_COLOR default value, forward CeedDebug* declarations & macros 34 #ifndef CEED_DEBUG_COLOR 35 #define CEED_DEBUG_COLOR 0 36 #endif 37 CEED_EXTERN void CeedDebugImpl(const Ceed,const char *,...); 38 CEED_EXTERN void CeedDebugImpl256(const Ceed,const unsigned char,const char *, 39 ...); 40 #define CeedDebug1(ceed,format, ...) CeedDebugImpl(ceed,format, ## __VA_ARGS__) 41 #define CeedDebug256(ceed,color, ...) CeedDebugImpl256(ceed,color, ## __VA_ARGS__) 42 #define CeedDebug(...) CeedDebug256(ceed,(unsigned char)CEED_DEBUG_COLOR, ## __VA_ARGS__) 43 44 /// Handle for object handling TensorContraction 45 /// @ingroup CeedBasis 46 typedef struct CeedTensorContract_private *CeedTensorContract; 47 48 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 49 has to be a pointer to a pointer. */ 50 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 51 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 52 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 53 CEED_INTERN int CeedFree(void *p); 54 55 #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 56 #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 57 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 58 different memory alignments: CeedMalloc returns pointers aligned at 59 CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 60 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 61 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 62 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 63 64 /// Handle for object describing CeedQFunction fields 65 /// @ingroup CeedQFunctionBackend 66 typedef struct CeedQFunctionField_private *CeedQFunctionField; 67 /// Handle for object describing CeedOperator fields 68 /// @ingroup CeedOperatorBackend 69 typedef struct CeedOperatorField_private *CeedOperatorField; 70 71 CEED_EXTERN int CeedRegister(const char *prefix, 72 int (*init)(const char *, Ceed), 73 unsigned int priority); 74 75 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 76 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 77 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 78 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 79 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 80 const char *obj_name); 81 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 82 const char *obj_name); 83 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 84 const char **resource); 85 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 86 const char *resource); 87 CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 88 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 89 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 90 const char *type, void *object, 91 const char *func_name, int (*f)()); 92 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 93 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 94 95 CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 96 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 97 CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 98 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 99 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 100 101 CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, 102 Ceed *ceed); 103 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 104 CeedInt (*strides)[3]); 105 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 106 CeedMemType mem_type, const CeedInt **offsets); 107 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 108 const CeedInt **offsets); 109 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 110 bool *is_strided); 111 CEED_EXTERN int CeedElemRestrictionHasBackendStrides( CeedElemRestriction rstr, 112 bool *has_backend_strides); 113 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 114 CeedInt (*layout)[3]); 115 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 116 CeedInt layout[3]); 117 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 118 void *data); 119 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 120 void *data); 121 122 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 123 CeedScalar *colo_grad_1d); 124 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 125 const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, CeedInt n, 126 CeedInt k, CeedInt row, CeedInt col); 127 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 128 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 129 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 130 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 131 132 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 133 CeedInt *dim); 134 135 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 136 CeedTensorContract *contract); 137 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 138 CeedTensorContract *contract); 139 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 140 CeedTensorContract *contract); 141 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 142 CeedInt B, CeedInt C, CeedInt J, 143 const CeedScalar *__restrict__ t, 144 CeedTransposeMode t_mode, 145 const CeedInt Add, 146 const CeedScalar *__restrict__ u, 147 CeedScalar *__restrict__ v); 148 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 149 Ceed *ceed); 150 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 151 void *data); 152 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 153 void *data); 154 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 155 156 CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 157 CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 158 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 159 CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 160 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 161 CeedInt *vec_length); 162 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 163 CeedInt *num_input_fields, 164 CeedInt *num_output_fields); 165 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source); 166 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 167 CeedQFunctionUser *f); 168 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 169 CeedQFunctionContext *ctx); 170 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 171 CeedQFunctionContext *ctx); 172 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 173 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 174 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 175 CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, 176 CeedQFunctionField **input_fields, 177 CeedQFunctionField **output_fields); 178 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, 179 char **field_name); 180 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, 181 CeedInt *size); 182 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, 183 CeedEvalMode *eval_mode); 184 185 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext cxt, 186 Ceed *ceed); 187 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 188 uint64_t *state); 189 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, 190 size_t *ctx_size); 191 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 192 void *data); 193 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 194 void *data); 195 196 CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 197 CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 198 CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, 199 CeedInt *numqpts); 200 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 201 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 202 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 203 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 204 CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 205 CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 206 CeedOperator **sub_operators); 207 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 208 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 209 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 210 211 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, 212 CeedOperatorField **input_fields, 213 CeedOperatorField **output_fields); 214 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, 215 CeedElemRestriction *rstr); 216 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, 217 CeedBasis *basis); 218 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, 219 CeedVector *vec); 220 221 CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 222 const CeedScalar *mat_B, CeedScalar *mat_C, 223 CeedInt m, CeedInt n, CeedInt kk); 224 225 #endif 226