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 /// Handle for object handling assembled QFunction data 86 /// @ingroup CeedOperator 87 typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData; 88 89 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 90 has to be a pointer to a pointer. */ 91 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 92 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 93 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 94 CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy); 95 CEED_INTERN int CeedFree(void *p); 96 97 #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 98 #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 99 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 100 different memory alignments: CeedMalloc returns pointers aligned at 101 CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 102 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 103 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 104 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 105 106 CEED_EXTERN int CeedRegister(const char *prefix, 107 int (*init)(const char *, Ceed), 108 unsigned int priority); 109 CEED_EXTERN int CeedRegisterImpl(const char *prefix, 110 int (*init)(const char *, Ceed), 111 unsigned int priority); 112 113 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 114 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 115 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 116 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 117 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 118 const char *obj_name); 119 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 120 const char *obj_name); 121 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, 122 CeedBasis *active_basis); 123 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 124 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 125 const char **resource); 126 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 127 const char *resource); 128 CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 129 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 130 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 131 const char *type, void *object, 132 const char *func_name, int (*f)()); 133 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 134 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 135 CEED_EXTERN int CeedReference(Ceed ceed); 136 137 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 138 CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, 139 bool *has_borrowed_array_of_type); 140 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 141 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 142 CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 143 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 144 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 145 CEED_EXTERN int CeedVectorReference(CeedVector vec); 146 147 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 148 CeedInt (*strides)[3]); 149 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 150 CeedMemType mem_type, const CeedInt **offsets); 151 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 152 const CeedInt **offsets); 153 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 154 bool *is_strided); 155 CEED_EXTERN int CeedElemRestrictionIsOriented(CeedElemRestriction rstr, 156 bool *is_oriented); 157 CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, 158 bool *has_backend_strides); 159 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 160 CeedInt (*layout)[3]); 161 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 162 CeedInt layout[3]); 163 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 164 void *data); 165 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 166 void *data); 167 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 168 169 /// Type of FE space; 170 /// @ingroup CeedBasis 171 typedef enum { 172 /// H1 FE space 173 CEED_FE_SPACE_H1 = 1, 174 /// H(div) FE space 175 CEED_FE_SPACE_HDIV = 2, 176 } CeedFESpace; 177 CEED_EXTERN const char *const CeedFESpaces[]; 178 179 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 180 CeedScalar *colo_grad_1d); 181 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 182 const CeedScalar *tau, CeedTransposeMode t_mode, 183 CeedInt m, CeedInt n, CeedInt k, 184 CeedInt row, CeedInt col); 185 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 186 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 187 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 188 CEED_EXTERN int CeedBasisReference(CeedBasis basis); 189 190 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 191 CeedInt *dim); 192 193 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 194 CeedTensorContract *contract); 195 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 196 CeedTensorContract contract); 197 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 198 CeedTensorContract *contract); 199 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 200 CeedInt B, CeedInt C, CeedInt J, 201 const CeedScalar *__restrict__ t, 202 CeedTransposeMode t_mode, 203 const CeedInt Add, 204 const CeedScalar *__restrict__ u, 205 CeedScalar *__restrict__ v); 206 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 207 Ceed *ceed); 208 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 209 void *data); 210 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 211 void *data); 212 CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 213 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 214 215 CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 216 CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 217 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 218 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 219 CeedInt *vec_length); 220 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 221 CeedInt *num_input_fields, 222 CeedInt *num_output_fields); 223 CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name); 224 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path); 225 CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer); 226 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 227 CeedQFunctionUser *f); 228 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 229 CeedQFunctionContext *ctx); 230 CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data); 231 CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data); 232 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 233 CeedQFunctionContext *ctx); 234 CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data); 235 CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data); 236 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 237 CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable); 238 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 239 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 240 CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 241 242 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, 243 Ceed *ceed); 244 CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, 245 bool *has_valid_data); 246 CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, 247 CeedMemType mem_type, bool *has_borrowed_data_of_type); 248 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 249 uint64_t *state); 250 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 251 void *data); 252 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 253 void *data); 254 CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, 255 CeedContextFieldLabel field_label, 256 CeedContextFieldType field_type, void *value); 257 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 258 259 CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data); 260 CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data); 261 CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data); 262 CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update); 263 CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed); 264 CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy); 265 CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup); 266 CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr); 267 CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr); 268 CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data); 269 270 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 271 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 272 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 273 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 274 CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 275 CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 276 CeedOperator **sub_operators); 277 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 278 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 279 CEED_EXTERN int CeedOperatorReference(CeedOperator op); 280 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 281 282 CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 283 const CeedScalar *mat_B, CeedScalar *mat_C, 284 CeedInt m, CeedInt n, CeedInt kk); 285 286 #endif 287