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 <limits.h> 24 #include <stdbool.h> 25 26 #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden"))) 27 #define CEED_UNUSED __attribute__((unused)) 28 29 #define CEED_MAX_RESOURCE_LEN 1024 30 #define CEED_MAX_BACKEND_PRIORITY UINT_MAX 31 #define CEED_ALIGN 64 32 #define CEED_COMPOSITE_MAX 16 33 #define CEED_EPSILON 1E-16 34 35 /** 36 @ingroup Ceed 37 This macro provides the ability to disable optimization flags for functions that 38 are sensitive to floting point optimizations. 39 **/ 40 #ifndef CeedPragmaOptimizeOff 41 # if defined(__clang__) 42 # define CeedPragmaOptimizeOff _Pragma("clang optimize off") 43 # elif defined(__GNUC__) 44 # define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0") 45 # elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 46 # define CeedPragmaOptimizeOff _Pragma("optimize('', off)") 47 # else 48 # define CeedPragmaOptimizeOff 49 # endif 50 #endif 51 52 /** 53 @ingroup Ceed 54 This macro restores previously set optimization flags after CeedPragmaOptimizeOff. 55 **/ 56 #ifndef CeedPragmaOptimizeOn 57 # if defined(__clang__) 58 # define CeedPragmaOptimizeOn _Pragma("clang optimize on") 59 # elif defined(__GNUC__) 60 # define CeedPragmaOptimizeOn _Pragma("GCC pop_options") 61 # elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 62 # define CeedPragmaOptimizeOff _Pragma("optimize('', on)") 63 # else 64 # define CeedPragmaOptimizeOn 65 # endif 66 #endif 67 68 /// CEED_DEBUG_COLOR default value, forward CeedDebug* declarations & macros 69 #ifndef CEED_DEBUG_COLOR 70 #define CEED_DEBUG_COLOR 0 71 #endif 72 CEED_EXTERN void CeedDebugImpl(const Ceed,const char *,...); 73 CEED_EXTERN void CeedDebugImpl256(const Ceed,const unsigned char,const char *, 74 ...); 75 #define CeedDebug1(ceed,format, ...) CeedDebugImpl(ceed,format, ## __VA_ARGS__) 76 #define CeedDebug256(ceed,color, ...) CeedDebugImpl256(ceed,color, ## __VA_ARGS__) 77 #define CeedDebug(...) CeedDebug256(ceed,(unsigned char)CEED_DEBUG_COLOR, ## __VA_ARGS__) 78 79 /// Handle for object handling TensorContraction 80 /// @ingroup CeedBasis 81 typedef struct CeedTensorContract_private *CeedTensorContract; 82 83 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 84 has to be a pointer to a pointer. */ 85 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 86 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 87 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 88 CEED_INTERN int CeedFree(void *p); 89 90 #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 91 #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 92 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 93 different memory alignments: CeedMalloc returns pointers aligned at 94 CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 95 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 96 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 97 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 98 99 /// Handle for object describing CeedQFunction fields 100 /// @ingroup CeedQFunctionBackend 101 typedef struct CeedQFunctionField_private *CeedQFunctionField; 102 /// Handle for object describing CeedOperator fields 103 /// @ingroup CeedOperatorBackend 104 typedef struct CeedOperatorField_private *CeedOperatorField; 105 106 CEED_EXTERN int CeedRegister(const char *prefix, 107 int (*init)(const char *, Ceed), 108 unsigned int priority); 109 110 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 111 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 112 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 113 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 114 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 115 const char *obj_name); 116 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 117 const char *obj_name); 118 CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 119 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, 120 CeedBasis *active_basis); 121 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 122 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 123 const char **resource); 124 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 125 const char *resource); 126 CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 127 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 128 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 129 const char *type, void *object, 130 const char *func_name, int (*f)()); 131 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 132 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 133 CEED_EXTERN int CeedReference(Ceed ceed); 134 135 CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 136 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 137 CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 138 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 139 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 140 CEED_EXTERN int CeedVectorReference(CeedVector vec); 141 142 CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, 143 Ceed *ceed); 144 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 145 CeedInt (*strides)[3]); 146 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 147 CeedMemType mem_type, const CeedInt **offsets); 148 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 149 const CeedInt **offsets); 150 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 151 bool *is_strided); 152 CEED_EXTERN int CeedElemRestrictionHasBackendStrides( CeedElemRestriction rstr, 153 bool *has_backend_strides); 154 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 155 CeedInt (*layout)[3]); 156 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 157 CeedInt layout[3]); 158 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 159 void *data); 160 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 161 void *data); 162 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 163 164 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 165 CeedScalar *colo_grad_1d); 166 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 167 const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, CeedInt n, 168 CeedInt k, CeedInt row, CeedInt col); 169 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 170 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 171 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 172 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 173 CEED_EXTERN int CeedBasisReference(CeedBasis basis); 174 175 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 176 CeedInt *dim); 177 178 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 179 CeedTensorContract *contract); 180 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 181 CeedTensorContract contract); 182 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 183 CeedTensorContract *contract); 184 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 185 CeedInt B, CeedInt C, CeedInt J, 186 const CeedScalar *__restrict__ t, 187 CeedTransposeMode t_mode, 188 const CeedInt Add, 189 const CeedScalar *__restrict__ u, 190 CeedScalar *__restrict__ v); 191 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 192 Ceed *ceed); 193 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 194 void *data); 195 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 196 void *data); 197 CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 198 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 199 200 CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 201 CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 202 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 203 CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 204 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 205 CeedInt *vec_length); 206 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 207 CeedInt *num_input_fields, 208 CeedInt *num_output_fields); 209 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source); 210 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 211 CeedQFunctionUser *f); 212 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 213 CeedQFunctionContext *ctx); 214 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 215 CeedQFunctionContext *ctx); 216 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 217 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 218 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 219 CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 220 CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, 221 CeedQFunctionField **input_fields, 222 CeedQFunctionField **output_fields); 223 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, 224 char **field_name); 225 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, 226 CeedInt *size); 227 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, 228 CeedEvalMode *eval_mode); 229 230 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext cxt, 231 Ceed *ceed); 232 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 233 uint64_t *state); 234 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, 235 size_t *ctx_size); 236 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 237 void *data); 238 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 239 void *data); 240 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 241 242 CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 243 CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 244 CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, 245 CeedInt *num_qpts); 246 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 247 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 248 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 249 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 250 CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 251 CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 252 CeedOperator **sub_operators); 253 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 254 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 255 CEED_EXTERN int CeedOperatorReference(CeedOperator op); 256 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 257 258 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, 259 CeedOperatorField **input_fields, 260 CeedOperatorField **output_fields); 261 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, 262 CeedElemRestriction *rstr); 263 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, 264 CeedBasis *basis); 265 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, 266 CeedVector *vec); 267 268 CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 269 const CeedScalar *mat_B, CeedScalar *mat_C, 270 CeedInt m, CeedInt n, CeedInt kk); 271 272 #endif 273