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