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_FIELD_MAX 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 #define CEED_DEBUG_COLOR_NONE 255 70 71 CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...); 72 CEED_EXTERN bool CeedDebugFlag(const Ceed ceed); 73 CEED_EXTERN bool CeedDebugFlagEnv(void); 74 #define CeedDebug256(ceed, color, ...) \ 75 { if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ## __VA_ARGS__); } 76 #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ## __VA_ARGS__) 77 #define CeedDebugEnv256(color, ...) \ 78 { if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ## __VA_ARGS__); } 79 #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ## __VA_ARGS__) 80 81 /// Handle for object handling TensorContraction 82 /// @ingroup CeedBasis 83 typedef struct CeedTensorContract_private *CeedTensorContract; 84 85 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 86 has to be a pointer to a pointer. */ 87 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 88 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 89 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 90 CEED_INTERN int CeedFree(void *p); 91 92 #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 93 #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 94 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 95 different memory alignments: CeedMalloc returns pointers aligned at 96 CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 97 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 98 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 99 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 100 101 CEED_EXTERN int CeedRegister(const char *prefix, 102 int (*init)(const char *, Ceed), 103 unsigned int priority); 104 CEED_EXTERN int CeedRegisterImpl(const char *prefix, 105 int (*init)(const char *, Ceed), 106 unsigned int priority); 107 108 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 109 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 110 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 111 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 112 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 113 const char *obj_name); 114 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 115 const char *obj_name); 116 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, 117 CeedBasis *active_basis); 118 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 119 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 120 const char **resource); 121 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 122 const char *resource); 123 CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 124 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 125 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 126 const char *type, void *object, 127 const char *func_name, int (*f)()); 128 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 129 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 130 CEED_EXTERN int CeedReference(Ceed ceed); 131 132 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 133 CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 134 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 135 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 136 CEED_EXTERN int CeedVectorReference(CeedVector vec); 137 138 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 139 CeedInt (*strides)[3]); 140 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 141 CeedMemType mem_type, const CeedInt **offsets); 142 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 143 const CeedInt **offsets); 144 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 145 bool *is_strided); 146 CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, 147 bool *has_backend_strides); 148 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 149 CeedInt (*layout)[3]); 150 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 151 CeedInt layout[3]); 152 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 153 void *data); 154 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 155 void *data); 156 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 157 158 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 159 CeedScalar *colo_grad_1d); 160 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 161 const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, CeedInt n, 162 CeedInt k, CeedInt row, CeedInt col); 163 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 164 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 165 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 166 CEED_EXTERN int CeedBasisReference(CeedBasis basis); 167 168 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 169 CeedInt *dim); 170 171 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 172 CeedTensorContract *contract); 173 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 174 CeedTensorContract contract); 175 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 176 CeedTensorContract *contract); 177 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 178 CeedInt B, CeedInt C, CeedInt J, 179 const CeedScalar *__restrict__ t, 180 CeedTransposeMode t_mode, 181 const CeedInt Add, 182 const CeedScalar *__restrict__ u, 183 CeedScalar *__restrict__ v); 184 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 185 Ceed *ceed); 186 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 187 void *data); 188 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 189 void *data); 190 CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 191 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 192 193 CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 194 CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 195 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 196 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 197 CeedInt *vec_length); 198 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 199 CeedInt *num_input_fields, 200 CeedInt *num_output_fields); 201 CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name); 202 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path); 203 CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer); 204 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 205 CeedQFunctionUser *f); 206 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 207 CeedQFunctionContext *ctx); 208 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 209 CeedQFunctionContext *ctx); 210 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 211 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 212 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 213 CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 214 215 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext cxt, 216 Ceed *ceed); 217 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 218 uint64_t *state); 219 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 220 void *data); 221 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 222 void *data); 223 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 224 225 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 226 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 227 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 228 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 229 CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 230 CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 231 CeedOperator **sub_operators); 232 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 233 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 234 CEED_EXTERN int CeedOperatorReference(CeedOperator op); 235 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 236 237 CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 238 const CeedScalar *mat_B, CeedScalar *mat_C, 239 CeedInt m, CeedInt n, CeedInt kk); 240 241 #endif 242