1 // Copyright (c) 2017-2022, Lawrence Livermore National Security, LLC and other CEED contributors. 2 // All Rights Reserved. See the top-level LICENSE and NOTICE files for details. 3 // 4 // SPDX-License-Identifier: BSD-2-Clause 5 // 6 // This file is part of CEED: http://github.com/ceed 7 8 /// @file 9 /// Public header for backend components of libCEED 10 #ifndef _ceed_backend_h 11 #define _ceed_backend_h 12 13 #include <ceed/ceed.h> 14 #include <limits.h> 15 #include <stdbool.h> 16 17 #ifdef __cplusplus 18 # define CEED_INTERN extern "C" CEED_VISIBILITY(hidden) 19 #else 20 # define CEED_INTERN extern CEED_VISIBILITY(hidden) 21 #endif 22 23 #define CEED_UNUSED __attribute__((unused)) 24 25 #define CEED_MAX_RESOURCE_LEN 1024 26 #define CEED_MAX_BACKEND_PRIORITY UINT_MAX 27 #define CEED_ALIGN 64 28 #define CEED_COMPOSITE_MAX 16 29 #define CEED_FIELD_MAX 16 30 31 /** 32 @ingroup Ceed 33 This macro provides the ability to disable optimization flags for functions that 34 are sensitive to floting point optimizations. 35 **/ 36 #ifndef CeedPragmaOptimizeOff 37 # if defined(__clang__) 38 # define CeedPragmaOptimizeOff _Pragma("clang optimize off") 39 # elif defined(__GNUC__) 40 # define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0") 41 # elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 42 # define CeedPragmaOptimizeOff _Pragma("optimize('', off)") 43 # else 44 # define CeedPragmaOptimizeOff 45 # endif 46 #endif 47 48 /** 49 @ingroup Ceed 50 This macro restores previously set optimization flags after CeedPragmaOptimizeOff. 51 **/ 52 #ifndef CeedPragmaOptimizeOn 53 # if defined(__clang__) 54 # define CeedPragmaOptimizeOn _Pragma("clang optimize on") 55 # elif defined(__GNUC__) 56 # define CeedPragmaOptimizeOn _Pragma("GCC pop_options") 57 # elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 58 # define CeedPragmaOptimizeOff _Pragma("optimize('', on)") 59 # else 60 # define CeedPragmaOptimizeOn 61 # endif 62 #endif 63 64 /// CEED_DEBUG_COLOR default value, forward CeedDebug* declarations & macros 65 #define CEED_DEBUG_COLOR_NONE 255 66 67 CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...); 68 CEED_EXTERN bool CeedDebugFlag(const Ceed ceed); 69 CEED_EXTERN bool CeedDebugFlagEnv(void); 70 #define CeedDebug256(ceed, color, ...) \ 71 { if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ## __VA_ARGS__); } 72 #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ## __VA_ARGS__) 73 #define CeedDebugEnv256(color, ...) \ 74 { if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ## __VA_ARGS__); } 75 #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ## __VA_ARGS__) 76 77 /// Handle for object handling TensorContraction 78 /// @ingroup CeedBasis 79 typedef struct CeedTensorContract_private *CeedTensorContract; 80 81 /// Handle for object handling assembled QFunction data 82 /// @ingroup CeedOperator 83 typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData; 84 85 /// Handle for object handling assembled Operator data 86 /// @ingroup CeedOperator 87 typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData; 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 CeedGetOperatorFallbackResource(Ceed ceed, 122 const char **resource); 123 CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed); 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 CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 136 CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, 137 bool *has_borrowed_array_of_type); 138 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 139 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 140 CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 141 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 142 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 143 CEED_EXTERN int CeedVectorReference(CeedVector vec); 144 145 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 146 CeedInt (*strides)[3]); 147 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 148 CeedMemType mem_type, const CeedInt **offsets); 149 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 150 const CeedInt **offsets); 151 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 152 bool *is_strided); 153 CEED_EXTERN int CeedElemRestrictionIsOriented(CeedElemRestriction rstr, 154 bool *is_oriented); 155 CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, 156 bool *has_backend_strides); 157 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 158 CeedInt (*layout)[3]); 159 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 160 CeedInt layout[3]); 161 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 162 void *data); 163 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 164 void *data); 165 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 166 CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops); 167 168 /// Type of FE space; 169 /// @ingroup CeedBasis 170 typedef enum { 171 /// H1 FE space 172 CEED_FE_SPACE_H1 = 1, 173 /// H(div) FE space 174 CEED_FE_SPACE_HDIV = 2, 175 } CeedFESpace; 176 CEED_EXTERN const char *const CeedFESpaces[]; 177 178 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 179 CeedScalar *colo_grad_1d); 180 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 181 const CeedScalar *tau, CeedTransposeMode t_mode, 182 CeedInt m, CeedInt n, CeedInt k, 183 CeedInt row, CeedInt col); 184 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 185 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 186 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 187 CEED_EXTERN int CeedBasisReference(CeedBasis basis); 188 CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops); 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 CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops); 242 243 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, 244 Ceed *ceed); 245 CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, 246 bool *has_valid_data); 247 CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, 248 CeedMemType mem_type, bool *has_borrowed_data_of_type); 249 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 250 uint64_t *state); 251 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 252 void *data); 253 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 254 void *data); 255 CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, 256 const char *field_name, CeedContextFieldLabel *field_label); 257 CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, 258 CeedContextFieldLabel field_label, 259 CeedContextFieldType field_type, void *value); 260 CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, 261 CeedContextFieldLabel field_label, double *values); 262 CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, 263 CeedContextFieldLabel field_label, int *values); 264 CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, 265 CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f); 266 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 267 268 CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data); 269 CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data); 270 CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data); 271 CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update); 272 CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed); 273 CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy); 274 CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup); 275 CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr); 276 CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr); 277 CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data); 278 279 CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data); 280 CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_eval_mode_in, const CeedEvalMode **eval_mode_in, CeedInt *num_eval_mode_out, const CeedEvalMode **eval_mode_out); 281 CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedBasis *basis_in, const CeedScalar **B_in, CeedBasis *basis_out, const CeedScalar **B_out); 282 CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data); 283 284 CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data); 285 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, 286 CeedBasis *active_basis); 287 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 288 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 289 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 290 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 291 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 292 CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 293 CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 294 CeedOperator **sub_operators); 295 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 296 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 297 CEED_EXTERN int CeedOperatorReference(CeedOperator op); 298 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 299 300 CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 301 const CeedScalar *mat_B, CeedScalar *mat_C, 302 CeedInt m, CeedInt n, CeedInt kk); 303 304 #endif 305