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