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