1ec3da8bcSJed Brown // Copyright (c) 2017, Lawrence Livermore National Security, LLC. Produced at 2ec3da8bcSJed Brown // the Lawrence Livermore National Laboratory. LLNL-CODE-734707. All Rights 3ec3da8bcSJed Brown // reserved. See files LICENSE and NOTICE for details. 4ec3da8bcSJed Brown // 5ec3da8bcSJed Brown // This file is part of CEED, a collection of benchmarks, miniapps, software 6ec3da8bcSJed Brown // libraries and APIs for efficient high-order finite element and spectral 7ec3da8bcSJed Brown // element discretizations for exascale applications. For more information and 8ec3da8bcSJed Brown // source code availability see http://github.com/ceed. 9ec3da8bcSJed Brown // 10ec3da8bcSJed Brown // The CEED research is supported by the Exascale Computing Project 17-SC-20-SC, 11ec3da8bcSJed Brown // a collaborative effort of two U.S. Department of Energy organizations (Office 12ec3da8bcSJed Brown // of Science and the National Nuclear Security Administration) responsible for 13ec3da8bcSJed Brown // the planning and preparation of a capable exascale ecosystem, including 14ec3da8bcSJed Brown // software, applications, hardware, advanced system engineering and early 15ec3da8bcSJed Brown // testbed platforms, in support of the nation's exascale computing imperative. 16ec3da8bcSJed Brown 17ec3da8bcSJed Brown /// @file 18ec3da8bcSJed Brown /// Public header for backend components of libCEED 19ec3da8bcSJed Brown #ifndef _ceed_backend_h 20ec3da8bcSJed Brown #define _ceed_backend_h 21ec3da8bcSJed Brown 22ec3da8bcSJed Brown #include <ceed/ceed.h> 23d0c91ce9Sjeremylt #include <limits.h> 24ec3da8bcSJed Brown #include <stdbool.h> 25ec3da8bcSJed Brown 26ec3da8bcSJed Brown #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden"))) 27ec3da8bcSJed Brown #define CEED_UNUSED __attribute__((unused)) 28ec3da8bcSJed Brown 29ec3da8bcSJed Brown #define CEED_MAX_RESOURCE_LEN 1024 30d0c91ce9Sjeremylt #define CEED_MAX_BACKEND_PRIORITY UINT_MAX 31ec3da8bcSJed Brown #define CEED_ALIGN 64 32ec3da8bcSJed Brown #define CEED_COMPOSITE_MAX 16 33ec3da8bcSJed Brown #define CEED_EPSILON 1E-16 34ec3da8bcSJed Brown 3503d18186Sjeremylt /** 3603d18186Sjeremylt @ingroup Ceed 37*eaf62fffSJeremy L Thompson This macro provides the ability to disable optimization flags for functions that 3803d18186Sjeremylt are sensitive to floting point optimizations. 3903d18186Sjeremylt **/ 4003d18186Sjeremylt #ifndef CeedPragmaOptimizeOff 4103d18186Sjeremylt # if defined(__clang__) 4203d18186Sjeremylt # define CeedPragmaOptimizeOff _Pragma("clang optimize off") 4303d18186Sjeremylt # elif defined(__GNUC__) 4403d18186Sjeremylt # define CeedPragmaOptimizeOff _Pragma("GCC push_options") _Pragma("GCC optimize 0") 4503d18186Sjeremylt # elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 4603d18186Sjeremylt # define CeedPragmaOptimizeOff _Pragma("optimize('', off)") 4703d18186Sjeremylt # else 4803d18186Sjeremylt # define CeedPragmaOptimizeOff 4903d18186Sjeremylt # endif 5003d18186Sjeremylt #endif 5103d18186Sjeremylt 5203d18186Sjeremylt /** 5303d18186Sjeremylt @ingroup Ceed 5403d18186Sjeremylt This macro restores previously set optimization flags after CeedPragmaOptimizeOff. 5503d18186Sjeremylt **/ 5603d18186Sjeremylt #ifndef CeedPragmaOptimizeOn 5703d18186Sjeremylt # if defined(__clang__) 5803d18186Sjeremylt # define CeedPragmaOptimizeOn _Pragma("clang optimize on") 5903d18186Sjeremylt # elif defined(__GNUC__) 6003d18186Sjeremylt # define CeedPragmaOptimizeOn _Pragma("GCC pop_options") 6103d18186Sjeremylt # elif defined(__INTEL_COMPILER) || defined(__INTEL_LLVM_COMPILER) 6203d18186Sjeremylt # define CeedPragmaOptimizeOff _Pragma("optimize('', on)") 6303d18186Sjeremylt # else 6403d18186Sjeremylt # define CeedPragmaOptimizeOn 6503d18186Sjeremylt # endif 6603d18186Sjeremylt #endif 6703d18186Sjeremylt 68ec3da8bcSJed Brown /// CEED_DEBUG_COLOR default value, forward CeedDebug* declarations & macros 69ec3da8bcSJed Brown #ifndef CEED_DEBUG_COLOR 70ec3da8bcSJed Brown #define CEED_DEBUG_COLOR 0 71ec3da8bcSJed Brown #endif 72ec3da8bcSJed Brown CEED_EXTERN void CeedDebugImpl(const Ceed,const char *,...); 73ec3da8bcSJed Brown CEED_EXTERN void CeedDebugImpl256(const Ceed,const unsigned char,const char *, 74ec3da8bcSJed Brown ...); 75ec3da8bcSJed Brown #define CeedDebug1(ceed,format, ...) CeedDebugImpl(ceed,format, ## __VA_ARGS__) 76ec3da8bcSJed Brown #define CeedDebug256(ceed,color, ...) CeedDebugImpl256(ceed,color, ## __VA_ARGS__) 77ec3da8bcSJed Brown #define CeedDebug(...) CeedDebug256(ceed,(unsigned char)CEED_DEBUG_COLOR, ## __VA_ARGS__) 78ec3da8bcSJed Brown 79ec3da8bcSJed Brown /// Handle for object handling TensorContraction 80ec3da8bcSJed Brown /// @ingroup CeedBasis 81ec3da8bcSJed Brown typedef struct CeedTensorContract_private *CeedTensorContract; 82ec3da8bcSJed Brown 83ec3da8bcSJed Brown /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 84ec3da8bcSJed Brown has to be a pointer to a pointer. */ 85ec3da8bcSJed Brown CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 86ec3da8bcSJed Brown CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 87ec3da8bcSJed Brown CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 88ec3da8bcSJed Brown CEED_INTERN int CeedFree(void *p); 89ec3da8bcSJed Brown 90ec3da8bcSJed Brown #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 91ec3da8bcSJed Brown #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 92ec3da8bcSJed Brown /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 93ec3da8bcSJed Brown different memory alignments: CeedMalloc returns pointers aligned at 94ec3da8bcSJed Brown CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 95ec3da8bcSJed Brown #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 96ec3da8bcSJed Brown #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 97ec3da8bcSJed Brown #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 98ec3da8bcSJed Brown 99ec3da8bcSJed Brown /// Handle for object describing CeedQFunction fields 100ec3da8bcSJed Brown /// @ingroup CeedQFunctionBackend 101ec3da8bcSJed Brown typedef struct CeedQFunctionField_private *CeedQFunctionField; 102ec3da8bcSJed Brown /// Handle for object describing CeedOperator fields 103ec3da8bcSJed Brown /// @ingroup CeedOperatorBackend 104ec3da8bcSJed Brown typedef struct CeedOperatorField_private *CeedOperatorField; 105ec3da8bcSJed Brown 106ec3da8bcSJed Brown CEED_EXTERN int CeedRegister(const char *prefix, 107ec3da8bcSJed Brown int (*init)(const char *, Ceed), 108ec3da8bcSJed Brown unsigned int priority); 109ec3da8bcSJed Brown 110d1d35e2fSjeremylt CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 111ec3da8bcSJed Brown CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 112ec3da8bcSJed Brown CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 113ec3da8bcSJed Brown CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 114ec3da8bcSJed Brown CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 115d1d35e2fSjeremylt const char *obj_name); 116ec3da8bcSJed Brown CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 117d1d35e2fSjeremylt const char *obj_name); 118*eaf62fffSJeremy L Thompson CEED_EXTERN int CeedOperatorCheckReady(CeedOperator op); 119*eaf62fffSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveBasis(CeedOperator op, 120*eaf62fffSJeremy L Thompson CeedBasis *active_basis); 121*eaf62fffSJeremy L Thompson CEED_EXTERN int CeedOperatorGetActiveElemRestriction(CeedOperator op, CeedElemRestriction *active_rstr); 122ec3da8bcSJed Brown CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 123ec3da8bcSJed Brown const char **resource); 124ec3da8bcSJed Brown CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 125ec3da8bcSJed Brown const char *resource); 126ec3da8bcSJed Brown CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 127d1d35e2fSjeremylt CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 128ec3da8bcSJed Brown CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 129ec3da8bcSJed Brown const char *type, void *object, 130d1d35e2fSjeremylt const char *func_name, int (*f)()); 131ec3da8bcSJed Brown CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 132ec3da8bcSJed Brown CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 1339560d06aSjeremylt CEED_EXTERN int CeedReference(Ceed ceed); 134ec3da8bcSJed Brown 135ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 136ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 137ec3da8bcSJed Brown CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 138ec3da8bcSJed Brown CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 139ec3da8bcSJed Brown CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 1409560d06aSjeremylt CEED_EXTERN int CeedVectorReference(CeedVector vec); 141ec3da8bcSJed Brown 142ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, 143ec3da8bcSJed Brown Ceed *ceed); 144ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 145ec3da8bcSJed Brown CeedInt (*strides)[3]); 146ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 147d1d35e2fSjeremylt CeedMemType mem_type, const CeedInt **offsets); 148ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 149ec3da8bcSJed Brown const CeedInt **offsets); 150ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 151d1d35e2fSjeremylt bool *is_strided); 152ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionHasBackendStrides( CeedElemRestriction rstr, 153d1d35e2fSjeremylt bool *has_backend_strides); 154ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 155ec3da8bcSJed Brown CeedInt (*layout)[3]); 156ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 157ec3da8bcSJed Brown CeedInt layout[3]); 158ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 159ec3da8bcSJed Brown void *data); 160ec3da8bcSJed Brown CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 161ec3da8bcSJed Brown void *data); 1629560d06aSjeremylt CEED_EXTERN int CeedElemRestrictionReference(CeedElemRestriction rstr); 163ec3da8bcSJed Brown 164ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 165d1d35e2fSjeremylt CeedScalar *colo_grad_1d); 166ec3da8bcSJed Brown CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 167d1d35e2fSjeremylt const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, CeedInt n, 168ec3da8bcSJed Brown CeedInt k, CeedInt row, CeedInt col); 169ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 170d1d35e2fSjeremylt CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 171ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 172ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 1739560d06aSjeremylt CEED_EXTERN int CeedBasisReference(CeedBasis basis); 174ec3da8bcSJed Brown 175ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 176ec3da8bcSJed Brown CeedInt *dim); 177ec3da8bcSJed Brown 178ec3da8bcSJed Brown CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 179ec3da8bcSJed Brown CeedTensorContract *contract); 180ec3da8bcSJed Brown CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 18134359f16Sjeremylt CeedTensorContract contract); 182ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 183ec3da8bcSJed Brown CeedTensorContract *contract); 184ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 185ec3da8bcSJed Brown CeedInt B, CeedInt C, CeedInt J, 186ec3da8bcSJed Brown const CeedScalar *__restrict__ t, 187d1d35e2fSjeremylt CeedTransposeMode t_mode, 188ec3da8bcSJed Brown const CeedInt Add, 189ec3da8bcSJed Brown const CeedScalar *__restrict__ u, 190ec3da8bcSJed Brown CeedScalar *__restrict__ v); 191ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 192ec3da8bcSJed Brown Ceed *ceed); 193ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 194ec3da8bcSJed Brown void *data); 195ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 196ec3da8bcSJed Brown void *data); 1979560d06aSjeremylt CEED_EXTERN int CeedTensorContractReference(CeedTensorContract contract); 198ec3da8bcSJed Brown CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 199ec3da8bcSJed Brown 200ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 201ec3da8bcSJed Brown CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 202ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 203ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 204ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 205d1d35e2fSjeremylt CeedInt *vec_length); 206ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 207d1d35e2fSjeremylt CeedInt *num_input_fields, 208d1d35e2fSjeremylt CeedInt *num_output_fields); 209ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source); 210ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 211ec3da8bcSJed Brown CeedQFunctionUser *f); 212ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 213ec3da8bcSJed Brown CeedQFunctionContext *ctx); 214ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 215ec3da8bcSJed Brown CeedQFunctionContext *ctx); 216d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 217ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 218ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 2199560d06aSjeremylt CEED_EXTERN int CeedQFunctionReference(CeedQFunction qf); 220ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, 221d1d35e2fSjeremylt CeedQFunctionField **input_fields, 222d1d35e2fSjeremylt CeedQFunctionField **output_fields); 223d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, 224d1d35e2fSjeremylt char **field_name); 225d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, 226ec3da8bcSJed Brown CeedInt *size); 227d1d35e2fSjeremylt CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, 228d1d35e2fSjeremylt CeedEvalMode *eval_mode); 229ec3da8bcSJed Brown 230ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext cxt, 231ec3da8bcSJed Brown Ceed *ceed); 232ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 233ec3da8bcSJed Brown uint64_t *state); 234ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, 235d1d35e2fSjeremylt size_t *ctx_size); 236ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 237ec3da8bcSJed Brown void *data); 238ec3da8bcSJed Brown CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 239ec3da8bcSJed Brown void *data); 2409560d06aSjeremylt CEED_EXTERN int CeedQFunctionContextReference(CeedQFunctionContext ctx); 241ec3da8bcSJed Brown 242ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 243d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 244ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, 245cd4dfc48Sjeremylt CeedInt *num_qpts); 246d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 247d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 248ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 249d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 250d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 251ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 252d1d35e2fSjeremylt CeedOperator **sub_operators); 253ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 254ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 2559560d06aSjeremylt CEED_EXTERN int CeedOperatorReference(CeedOperator op); 256ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 257ec3da8bcSJed Brown 258ec3da8bcSJed Brown CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, 259d1d35e2fSjeremylt CeedOperatorField **input_fields, 260d1d35e2fSjeremylt CeedOperatorField **output_fields); 261d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, 262ec3da8bcSJed Brown CeedElemRestriction *rstr); 263d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, 264ec3da8bcSJed Brown CeedBasis *basis); 265d1d35e2fSjeremylt CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, 266ec3da8bcSJed Brown CeedVector *vec); 267ec3da8bcSJed Brown 268d1d35e2fSjeremylt CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 269d1d35e2fSjeremylt const CeedScalar *mat_B, CeedScalar *mat_C, 270ec3da8bcSJed Brown CeedInt m, CeedInt n, CeedInt kk); 271ec3da8bcSJed Brown 272ec3da8bcSJed Brown #endif 273