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.h> 14 #include <limits.h> 15 #include <stdbool.h> 16 17 #if defined(__clang_analyzer__) 18 #define CEED_INTERN 19 #elif defined(__cplusplus) 20 #define CEED_INTERN extern "C" CEED_VISIBILITY(hidden) 21 #else 22 #define CEED_INTERN extern CEED_VISIBILITY(hidden) 23 #endif 24 25 #define CEED_UNUSED __attribute__((unused)) 26 27 #define CEED_MAX_RESOURCE_LEN 1024 28 #define CEED_MAX_BACKEND_PRIORITY UINT_MAX 29 #define CEED_ALIGN 64 30 #define CEED_COMPOSITE_MAX 16 31 #define CEED_FIELD_MAX 16 32 33 /** 34 @ingroup Ceed 35 This macro provides the ability to disable optimization flags for functions that are sensitive to floating point optimizations. 36 **/ 37 #ifndef CeedPragmaOptimizeOff 38 #if defined(__clang__) 39 #define CeedPragmaOptimizeOff _Pragma("clang optimize off") 40 #elif defined(__GNUC__) 41 #define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0") 42 #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 43 #define CeedPragmaOptimizeOff _Pragma("optimize('', off)") 44 #else 45 #define CeedPragmaOptimizeOff 46 #endif 47 #endif 48 49 /** 50 @ingroup Ceed 51 This macro restores previously set optimization flags after CeedPragmaOptimizeOff. 52 **/ 53 #ifndef CeedPragmaOptimizeOn 54 #if defined(__clang__) 55 #define CeedPragmaOptimizeOn _Pragma("clang optimize on") 56 #elif defined(__GNUC__) 57 #define CeedPragmaOptimizeOn _Pragma("GCC pop_options") 58 #elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 59 #define CeedPragmaOptimizeOff _Pragma("optimize('', on)") 60 #else 61 #define CeedPragmaOptimizeOn 62 #endif 63 #endif 64 65 /// Common colors for CeedDebug256 debugging output. 66 /// Set CEED_DEBUG=1 to activate debugging output. 67 /// @ingroup CeedBackend 68 typedef enum { 69 /// Success color 70 CEED_DEBUG_COLOR_SUCCESS = 108, 71 /// Warning color 72 CEED_DEBUG_COLOR_WARNING = 208, 73 /// Error color 74 CEED_DEBUG_COLOR_ERROR = 196, 75 /// Use native terminal coloring 76 CEED_DEBUG_COLOR_NONE = 255, 77 } CeedDebugColor; 78 79 CEED_EXTERN void CeedDebugImpl256(const unsigned char, const char *, ...); 80 CEED_EXTERN bool CeedDebugFlag(const Ceed ceed); 81 CEED_EXTERN bool CeedDebugFlagEnv(void); 82 #define CeedDebug256(ceed, color, ...) \ 83 { \ 84 if (CeedDebugFlag(ceed)) CeedDebugImpl256(color, ##__VA_ARGS__); \ 85 } 86 #define CeedDebug(ceed, ...) CeedDebug256(ceed, (unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__) 87 #define CeedDebugEnv256(color, ...) \ 88 { \ 89 if (CeedDebugFlagEnv()) CeedDebugImpl256(color, ##__VA_ARGS__); \ 90 } 91 #define CeedDebugEnv(...) CeedDebugEnv256((unsigned char)CEED_DEBUG_COLOR_NONE, ##__VA_ARGS__) 92 93 /// Handle for object handling TensorContraction 94 /// @ingroup CeedBasis 95 typedef struct CeedTensorContract_private *CeedTensorContract; 96 97 /// Handle for object handling assembled QFunction data 98 /// @ingroup CeedOperator 99 typedef struct CeedQFunctionAssemblyData_private *CeedQFunctionAssemblyData; 100 101 /// Handle for object handling assembled Operator data 102 /// @ingroup CeedOperator 103 typedef struct CeedOperatorAssemblyData_private *CeedOperatorAssemblyData; 104 105 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p has to be a pointer to a pointer. */ 106 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 107 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 108 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 109 CEED_INTERN int CeedStringAllocCopy(const char *source, char **copy); 110 CEED_INTERN int CeedFree(void *p); 111 112 #define CeedChk(ierr) \ 113 do { \ 114 int ierr_ = ierr; \ 115 if (ierr_) return ierr_; \ 116 } while (0) 117 #define CeedChkBackend(ierr) \ 118 do { \ 119 int ierr_ = ierr; \ 120 if (ierr_) { \ 121 if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; \ 122 else return ierr_; \ 123 } \ 124 } while (0) 125 126 #define CeedCall(...) \ 127 do { \ 128 int ierr_q_ = __VA_ARGS__; \ 129 CeedChk(ierr_q_); \ 130 } while (0) 131 #define CeedCallBackend(...) \ 132 do { \ 133 int ierr_q_ = __VA_ARGS__; \ 134 CeedChkBackend(ierr_q_); \ 135 } while (0) 136 137 #define CeedCheck(cond, ceed, ecode, ...) \ 138 do { \ 139 if (!(cond)) { \ 140 return CeedError(ceed, ecode, __VA_ARGS__); \ 141 } \ 142 } while (0) 143 144 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with different memory alignments: 145 CeedMalloc returns pointers aligned at CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 146 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 147 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 148 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 149 150 CEED_EXTERN int CeedRegister(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority); 151 CEED_EXTERN int CeedRegisterImpl(const char *prefix, int (*init)(const char *, Ceed), unsigned int priority); 152 153 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 154 CEED_EXTERN int CeedGetResourceRoot(Ceed ceed, const char *resource, const char *delineator, char **resource_root); 155 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 156 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 157 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 158 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, const char *obj_name); 159 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, const char *obj_name); 160 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, const char **resource); 161 CEED_EXTERN int CeedGetOperatorFallbackCeed(Ceed ceed, Ceed *fallback_ceed); 162 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, const char *resource); 163 CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 164 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 165 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, const char *type, void *object, const char *func_name, int (*f)()); 166 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 167 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 168 CEED_EXTERN int CeedReference(Ceed ceed); 169 170 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 171 CEED_EXTERN int CeedVectorHasBorrowedArrayOfType(CeedVector vec, CeedMemType mem_type, bool *has_borrowed_array_of_type); 172 CEED_EXTERN int CeedVectorHasValidArray(CeedVector vec, bool *has_valid_array); 173 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 174 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 175 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 176 CEED_EXTERN int CeedVectorReference(CeedVector vec); 177 178 CEED_EXTERN int CeedElemRestrictionApplyUnsigned(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedVector u, CeedVector ru, 179 CeedRequest *request); 180 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, CeedInt (*strides)[3]); 181 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, CeedMemType mem_type, const CeedInt **offsets); 182 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, const CeedInt **offsets); 183 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, bool *is_strided); 184 CEED_EXTERN int CeedElemRestrictionIsOriented(CeedElemRestriction rstr, bool *is_oriented); 185 CEED_EXTERN int CeedElemRestrictionHasBackendStrides(CeedElemRestriction rstr, bool *has_backend_strides); 186 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, CeedInt (*layout)[3]); 187 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, CeedInt layout[3]); 188 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, void *data); 189 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, void *data); 190 CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 191 CEED_EXTERN int CeedElemRestrictionGetFlopsEstimate(CeedElemRestriction rstr, CeedTransposeMode t_mode, CeedSize *flops); 192 193 /// Type of FE space; 194 /// @ingroup CeedBasis 195 typedef enum { 196 /// H^1 FE space 197 CEED_FE_SPACE_H1 = 1, 198 /// H(div) FE space 199 CEED_FE_SPACE_HDIV = 2, 200 /// H(curl) FE space 201 CEED_FE_SPACE_HCURL = 3, 202 } CeedFESpace; 203 CEED_EXTERN const char *const CeedFESpaces[]; 204 205 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, CeedScalar *colo_grad_1d); 206 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 207 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 208 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 209 CEED_EXTERN int CeedBasisReference(CeedBasis basis); 210 CEED_EXTERN int CeedBasisGetNumQuadratureComponents(CeedBasis basis, CeedEvalMode eval_mode, CeedInt *q_comp); 211 CEED_EXTERN int CeedBasisGetFlopsEstimate(CeedBasis basis, CeedTransposeMode t_mode, CeedEvalMode eval_mode, CeedSize *flops); 212 CEED_EXTERN int CeedBasisGetFESpace(CeedBasis basis, CeedFESpace *fe_space); 213 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, CeedInt *dim); 214 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, CeedTensorContract *contract); 215 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, CeedTensorContract contract); 216 217 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, CeedTensorContract *contract); 218 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt J, const CeedScalar *__restrict__ t, 219 CeedTransposeMode t_mode, const CeedInt Add, const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v); 220 CEED_EXTERN int CeedTensorContractStridedApply(CeedTensorContract contract, CeedInt A, CeedInt B, CeedInt C, CeedInt D, CeedInt J, 221 const CeedScalar *__restrict__ t, CeedTransposeMode t_mode, const CeedInt add, 222 const CeedScalar *__restrict__ u, CeedScalar *__restrict__ v); 223 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, Ceed *ceed); 224 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, void *data); 225 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, void *data); 226 CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 227 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 228 229 CEED_EXTERN int CeedQFunctionRegister(const char *name, const char *source, CeedInt vec_length, CeedQFunctionUser f, 230 int (*init)(Ceed, const char *, CeedQFunction)); 231 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 232 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, CeedInt *vec_length); 233 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, CeedInt *num_input_fields, CeedInt *num_output_fields); 234 CEED_EXTERN int CeedQFunctionGetKernelName(CeedQFunction qf, char **kernel_name); 235 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source_path); 236 CEED_EXTERN int CeedQFunctionLoadSourceToBuffer(CeedQFunction qf, char **source_buffer); 237 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, CeedQFunctionUser *f); 238 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, CeedQFunctionContext *ctx); 239 CEED_EXTERN int CeedQFunctionGetContextData(CeedQFunction qf, CeedMemType mem_type, void *data); 240 CEED_EXTERN int CeedQFunctionRestoreContextData(CeedQFunction qf, void *data); 241 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, CeedQFunctionContext *ctx); 242 CEED_EXTERN int CeedQFunctionGetInnerContextData(CeedQFunction qf, CeedMemType mem_type, void *data); 243 CEED_EXTERN int CeedQFunctionRestoreInnerContextData(CeedQFunction qf, void *data); 244 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 245 CEED_EXTERN int CeedQFunctionIsContextWritable(CeedQFunction qf, bool *is_writable); 246 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 247 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 248 CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 249 CEED_EXTERN int CeedQFunctionGetFlopsEstimate(CeedQFunction qf, CeedSize *flops); 250 251 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext ctx, Ceed *ceed); 252 CEED_EXTERN int CeedQFunctionContextHasValidData(CeedQFunctionContext ctx, bool *has_valid_data); 253 CEED_EXTERN int CeedQFunctionContextHasBorrowedDataOfType(CeedQFunctionContext ctx, CeedMemType mem_type, bool *has_borrowed_data_of_type); 254 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, uint64_t *state); 255 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, void *data); 256 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, void *data); 257 CEED_EXTERN int CeedQFunctionContextGetFieldLabel(CeedQFunctionContext ctx, const char *field_name, CeedContextFieldLabel *field_label); 258 CEED_EXTERN int CeedQFunctionContextSetGeneric(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type, 259 void *value); 260 CEED_EXTERN int CeedQFunctionContextGetGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type, 261 size_t *num_values, void *value); 262 CEED_EXTERN int CeedQFunctionContextRestoreGenericRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, CeedContextFieldType field_type, 263 void *value); 264 CEED_EXTERN int CeedQFunctionContextSetDouble(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, double *values); 265 CEED_EXTERN int CeedQFunctionContextGetDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, 266 const double **values); 267 CEED_EXTERN int CeedQFunctionContextRestoreDoubleRead(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const double **values); 268 CEED_EXTERN int CeedQFunctionContextSetInt32(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, int *values); 269 CEED_EXTERN int CeedQFunctionContextGetInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, size_t *num_values, const int **values); 270 CEED_EXTERN int CeedQFunctionContextRestoreInt32Read(CeedQFunctionContext ctx, CeedContextFieldLabel field_label, const int **values); 271 CEED_EXTERN int CeedQFunctionContextGetDataDestroy(CeedQFunctionContext ctx, CeedMemType *f_mem_type, CeedQFunctionContextDataDestroyUser *f); 272 CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 273 274 CEED_EXTERN int CeedQFunctionAssemblyDataCreate(Ceed ceed, CeedQFunctionAssemblyData *data); 275 CEED_EXTERN int CeedQFunctionAssemblyDataReference(CeedQFunctionAssemblyData data); 276 CEED_EXTERN int CeedQFunctionAssemblyDataSetReuse(CeedQFunctionAssemblyData data, bool reuse_assembly_data); 277 CEED_EXTERN int CeedQFunctionAssemblyDataSetUpdateNeeded(CeedQFunctionAssemblyData data, bool needs_data_update); 278 CEED_EXTERN int CeedQFunctionAssemblyDataIsUpdateNeeded(CeedQFunctionAssemblyData data, bool *is_update_needed); 279 CEED_EXTERN int CeedQFunctionAssemblyDataReferenceCopy(CeedQFunctionAssemblyData data, CeedQFunctionAssemblyData *data_copy); 280 CEED_EXTERN int CeedQFunctionAssemblyDataIsSetup(CeedQFunctionAssemblyData data, bool *is_setup); 281 CEED_EXTERN int CeedQFunctionAssemblyDataSetObjects(CeedQFunctionAssemblyData data, CeedVector vec, CeedElemRestriction rstr); 282 CEED_EXTERN int CeedQFunctionAssemblyDataGetObjects(CeedQFunctionAssemblyData data, CeedVector *vec, CeedElemRestriction *rstr); 283 CEED_EXTERN int CeedQFunctionAssemblyDataDestroy(CeedQFunctionAssemblyData *data); 284 285 CEED_EXTERN int CeedOperatorAssemblyDataCreate(Ceed ceed, CeedOperator op, CeedOperatorAssemblyData *data); 286 CEED_EXTERN int CeedOperatorAssemblyDataGetEvalModes(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedInt **num_eval_modes_in, 287 const CeedEvalMode ***eval_modes_in, CeedSize ***eval_mode_offsets_in, 288 CeedInt **num_eval_modes_out, const CeedEvalMode ***eval_modes_out, 289 CeedSize ***eval_mode_offsets_out, CeedSize *num_output_components); 290 CEED_EXTERN int CeedOperatorAssemblyDataGetBases(CeedOperatorAssemblyData data, CeedInt *num_active_bases, CeedBasis **active_bases, 291 const CeedScalar ***assembled_bases_in, const CeedScalar ***assembled_bases_out); 292 CEED_EXTERN int CeedOperatorAssemblyDataGetElemRestrictions(CeedOperatorAssemblyData data, CeedInt *num_active_elem_rstrs, 293 CeedElemRestriction **active_elem_rstrs); 294 CEED_EXTERN int CeedOperatorAssemblyDataDestroy(CeedOperatorAssemblyData *data); 295 296 CEED_EXTERN int CeedOperatorGetOperatorAssemblyData(CeedOperator op, CeedOperatorAssemblyData *data); 297 CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, CeedBasis *active_basis); 298 CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 299 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 300 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 301 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 302 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 303 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 304 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 305 CEED_EXTERN int CeedOperatorReference(CeedOperator op); 306 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 307 308 CEED_INTERN int CeedMatrixMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, const CeedScalar *mat_B, CeedScalar *mat_C, CeedInt m, CeedInt n, 309 CeedInt kk); 310 CEED_EXTERN int CeedQRFactorization(Ceed ceed, CeedScalar *mat, CeedScalar *tau, CeedInt m, CeedInt n); 311 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *mat_A, const CeedScalar *mat_Q, const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, 312 CeedInt n, CeedInt k, CeedInt row, CeedInt col); 313 CEED_EXTERN int CeedSymmetricSchurDecomposition(Ceed ceed, CeedScalar *mat, CeedScalar *lambda, CeedInt n); 314 CEED_EXTERN int CeedSimultaneousDiagonalization(Ceed ceed, CeedScalar *mat_A, CeedScalar *mat_B, CeedScalar *x, CeedScalar *lambda, CeedInt n); 315 316 #endif 317