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 #define CEED_INTERN CEED_EXTERN __attribute__((visibility ("hidden"))) 27 #define CEED_UNUSED __attribute__((unused)) 28 29 #define CEED_MAX_RESOURCE_LEN 1024 30 #define CEED_MAX_BACKEND_PRIORITY UINT_MAX 31 #define CEED_ALIGN 64 32 #define CEED_COMPOSITE_MAX 16 33 #define CEED_EPSILON 1E-16 34 35 /// CEED_DEBUG_COLOR default value, forward CeedDebug* declarations & macros 36 #ifndef CEED_DEBUG_COLOR 37 #define CEED_DEBUG_COLOR 0 38 #endif 39 CEED_EXTERN void CeedDebugImpl(const Ceed,const char *,...); 40 CEED_EXTERN void CeedDebugImpl256(const Ceed,const unsigned char,const char *, 41 ...); 42 #define CeedDebug1(ceed,format, ...) CeedDebugImpl(ceed,format, ## __VA_ARGS__) 43 #define CeedDebug256(ceed,color, ...) CeedDebugImpl256(ceed,color, ## __VA_ARGS__) 44 #define CeedDebug(...) CeedDebug256(ceed,(unsigned char)CEED_DEBUG_COLOR, ## __VA_ARGS__) 45 46 /// Handle for object handling TensorContraction 47 /// @ingroup CeedBasis 48 typedef struct CeedTensorContract_private *CeedTensorContract; 49 50 /* In the next 3 functions, p has to be the address of a pointer type, i.e. p 51 has to be a pointer to a pointer. */ 52 CEED_INTERN int CeedMallocArray(size_t n, size_t unit, void *p); 53 CEED_INTERN int CeedCallocArray(size_t n, size_t unit, void *p); 54 CEED_INTERN int CeedReallocArray(size_t n, size_t unit, void *p); 55 CEED_INTERN int CeedFree(void *p); 56 57 #define CeedChk(ierr) do { int ierr_ = ierr; if (ierr_) return ierr_; } while (0) 58 #define CeedChkBackend(ierr) do { int ierr_ = ierr; if (ierr_) { if (ierr_ > CEED_ERROR_SUCCESS) return CEED_ERROR_BACKEND; else return ierr_; } } while (0) 59 /* Note that CeedMalloc and CeedCalloc will, generally, return pointers with 60 different memory alignments: CeedMalloc returns pointers aligned at 61 CEED_ALIGN bytes, while CeedCalloc uses the alignment of calloc. */ 62 #define CeedMalloc(n, p) CeedMallocArray((n), sizeof(**(p)), p) 63 #define CeedCalloc(n, p) CeedCallocArray((n), sizeof(**(p)), p) 64 #define CeedRealloc(n, p) CeedReallocArray((n), sizeof(**(p)), p) 65 66 /// Handle for object describing CeedQFunction fields 67 /// @ingroup CeedQFunctionBackend 68 typedef struct CeedQFunctionField_private *CeedQFunctionField; 69 /// Handle for object describing CeedOperator fields 70 /// @ingroup CeedOperatorBackend 71 typedef struct CeedOperatorField_private *CeedOperatorField; 72 73 CEED_EXTERN int CeedRegister(const char *prefix, 74 int (*init)(const char *, Ceed), 75 unsigned int priority); 76 77 CEED_EXTERN int CeedIsDebug(Ceed ceed, bool *is_debug); 78 CEED_EXTERN int CeedGetParent(Ceed ceed, Ceed *parent); 79 CEED_EXTERN int CeedGetDelegate(Ceed ceed, Ceed *delegate); 80 CEED_EXTERN int CeedSetDelegate(Ceed ceed, Ceed delegate); 81 CEED_EXTERN int CeedGetObjectDelegate(Ceed ceed, Ceed *delegate, 82 const char *obj_name); 83 CEED_EXTERN int CeedSetObjectDelegate(Ceed ceed, Ceed delegate, 84 const char *obj_name); 85 CEED_EXTERN int CeedGetOperatorFallbackResource(Ceed ceed, 86 const char **resource); 87 CEED_EXTERN int CeedSetOperatorFallbackResource(Ceed ceed, 88 const char *resource); 89 CEED_EXTERN int CeedGetOperatorFallbackParentCeed(Ceed ceed, Ceed *parent); 90 CEED_EXTERN int CeedSetDeterministic(Ceed ceed, bool is_deterministic); 91 CEED_EXTERN int CeedSetBackendFunction(Ceed ceed, 92 const char *type, void *object, 93 const char *func_name, int (*f)()); 94 CEED_EXTERN int CeedGetData(Ceed ceed, void *data); 95 CEED_EXTERN int CeedSetData(Ceed ceed, void *data); 96 97 CEED_EXTERN int CeedVectorGetCeed(CeedVector vec, Ceed *ceed); 98 CEED_EXTERN int CeedVectorGetState(CeedVector vec, uint64_t *state); 99 CEED_EXTERN int CeedVectorAddReference(CeedVector vec); 100 CEED_EXTERN int CeedVectorGetData(CeedVector vec, void *data); 101 CEED_EXTERN int CeedVectorSetData(CeedVector vec, void *data); 102 103 CEED_EXTERN int CeedElemRestrictionGetCeed(CeedElemRestriction rstr, 104 Ceed *ceed); 105 CEED_EXTERN int CeedElemRestrictionGetStrides(CeedElemRestriction rstr, 106 CeedInt (*strides)[3]); 107 CEED_EXTERN int CeedElemRestrictionGetOffsets(CeedElemRestriction rstr, 108 CeedMemType mem_type, const CeedInt **offsets); 109 CEED_EXTERN int CeedElemRestrictionRestoreOffsets(CeedElemRestriction rstr, 110 const CeedInt **offsets); 111 CEED_EXTERN int CeedElemRestrictionIsStrided(CeedElemRestriction rstr, 112 bool *is_strided); 113 CEED_EXTERN int CeedElemRestrictionHasBackendStrides( CeedElemRestriction rstr, 114 bool *has_backend_strides); 115 CEED_EXTERN int CeedElemRestrictionGetELayout(CeedElemRestriction rstr, 116 CeedInt (*layout)[3]); 117 CEED_EXTERN int CeedElemRestrictionSetELayout(CeedElemRestriction rstr, 118 CeedInt layout[3]); 119 CEED_EXTERN int CeedElemRestrictionGetData(CeedElemRestriction rstr, 120 void *data); 121 CEED_EXTERN int CeedElemRestrictionSetData(CeedElemRestriction rstr, 122 void *data); 123 124 CEED_EXTERN int CeedBasisGetCollocatedGrad(CeedBasis basis, 125 CeedScalar *colo_grad_1d); 126 CEED_EXTERN int CeedHouseholderApplyQ(CeedScalar *A, const CeedScalar *Q, 127 const CeedScalar *tau, CeedTransposeMode t_mode, CeedInt m, CeedInt n, 128 CeedInt k, CeedInt row, CeedInt col); 129 CEED_EXTERN int CeedBasisGetCeed(CeedBasis basis, Ceed *ceed); 130 CEED_EXTERN int CeedBasisIsTensor(CeedBasis basis, bool *is_tensor); 131 CEED_EXTERN int CeedBasisGetData(CeedBasis basis, void *data); 132 CEED_EXTERN int CeedBasisSetData(CeedBasis basis, void *data); 133 134 CEED_EXTERN int CeedBasisGetTopologyDimension(CeedElemTopology topo, 135 CeedInt *dim); 136 137 CEED_EXTERN int CeedBasisGetTensorContract(CeedBasis basis, 138 CeedTensorContract *contract); 139 CEED_EXTERN int CeedBasisSetTensorContract(CeedBasis basis, 140 CeedTensorContract *contract); 141 CEED_EXTERN int CeedTensorContractCreate(Ceed ceed, CeedBasis basis, 142 CeedTensorContract *contract); 143 CEED_EXTERN int CeedTensorContractApply(CeedTensorContract contract, CeedInt A, 144 CeedInt B, CeedInt C, CeedInt J, 145 const CeedScalar *__restrict__ t, 146 CeedTransposeMode t_mode, 147 const CeedInt Add, 148 const CeedScalar *__restrict__ u, 149 CeedScalar *__restrict__ v); 150 CEED_EXTERN int CeedTensorContractGetCeed(CeedTensorContract contract, 151 Ceed *ceed); 152 CEED_EXTERN int CeedTensorContractGetData(CeedTensorContract contract, 153 void *data); 154 CEED_EXTERN int CeedTensorContractSetData(CeedTensorContract contract, 155 void *data); 156 CEED_EXTERN int CeedTensorContractDestroy(CeedTensorContract *contract); 157 158 CEED_EXTERN int CeedQFunctionRegister(const char *, const char *, CeedInt, 159 CeedQFunctionUser, int (*init)(Ceed, const char *, CeedQFunction)); 160 CEED_EXTERN int CeedQFunctionSetFortranStatus(CeedQFunction qf, bool status); 161 CEED_EXTERN int CeedQFunctionGetCeed(CeedQFunction qf, Ceed *ceed); 162 CEED_EXTERN int CeedQFunctionGetVectorLength(CeedQFunction qf, 163 CeedInt *vec_length); 164 CEED_EXTERN int CeedQFunctionGetNumArgs(CeedQFunction qf, 165 CeedInt *num_input_fields, 166 CeedInt *num_output_fields); 167 CEED_EXTERN int CeedQFunctionGetSourcePath(CeedQFunction qf, char **source); 168 CEED_EXTERN int CeedQFunctionGetUserFunction(CeedQFunction qf, 169 CeedQFunctionUser *f); 170 CEED_EXTERN int CeedQFunctionGetContext(CeedQFunction qf, 171 CeedQFunctionContext *ctx); 172 CEED_EXTERN int CeedQFunctionGetInnerContext(CeedQFunction qf, 173 CeedQFunctionContext *ctx); 174 CEED_EXTERN int CeedQFunctionIsIdentity(CeedQFunction qf, bool *is_identity); 175 CEED_EXTERN int CeedQFunctionGetData(CeedQFunction qf, void *data); 176 CEED_EXTERN int CeedQFunctionSetData(CeedQFunction qf, void *data); 177 CEED_EXTERN int CeedQFunctionGetFields(CeedQFunction qf, 178 CeedQFunctionField **input_fields, 179 CeedQFunctionField **output_fields); 180 CEED_EXTERN int CeedQFunctionFieldGetName(CeedQFunctionField qf_field, 181 char **field_name); 182 CEED_EXTERN int CeedQFunctionFieldGetSize(CeedQFunctionField qf_field, 183 CeedInt *size); 184 CEED_EXTERN int CeedQFunctionFieldGetEvalMode(CeedQFunctionField qf_field, 185 CeedEvalMode *eval_mode); 186 187 CEED_EXTERN int CeedQFunctionContextGetCeed(CeedQFunctionContext cxt, 188 Ceed *ceed); 189 CEED_EXTERN int CeedQFunctionContextGetState(CeedQFunctionContext ctx, 190 uint64_t *state); 191 CEED_EXTERN int CeedQFunctionContextGetContextSize(CeedQFunctionContext ctx, 192 size_t *ctx_size); 193 CEED_EXTERN int CeedQFunctionContextGetBackendData(CeedQFunctionContext ctx, 194 void *data); 195 CEED_EXTERN int CeedQFunctionContextSetBackendData(CeedQFunctionContext ctx, 196 void *data); 197 198 CEED_EXTERN int CeedOperatorGetCeed(CeedOperator op, Ceed *ceed); 199 CEED_EXTERN int CeedOperatorGetNumElements(CeedOperator op, CeedInt *num_elem); 200 CEED_EXTERN int CeedOperatorGetNumQuadraturePoints(CeedOperator op, 201 CeedInt *numqpts); 202 CEED_EXTERN int CeedOperatorGetNumArgs(CeedOperator op, CeedInt *num_args); 203 CEED_EXTERN int CeedOperatorIsSetupDone(CeedOperator op, bool *is_setup_done); 204 CEED_EXTERN int CeedOperatorGetQFunction(CeedOperator op, CeedQFunction *qf); 205 CEED_EXTERN int CeedOperatorIsComposite(CeedOperator op, bool *is_composite); 206 CEED_EXTERN int CeedOperatorGetNumSub(CeedOperator op, CeedInt *num_suboperators); 207 CEED_EXTERN int CeedOperatorGetSubList(CeedOperator op, 208 CeedOperator **sub_operators); 209 CEED_EXTERN int CeedOperatorGetData(CeedOperator op, void *data); 210 CEED_EXTERN int CeedOperatorSetData(CeedOperator op, void *data); 211 CEED_EXTERN int CeedOperatorSetSetupDone(CeedOperator op); 212 213 CEED_EXTERN int CeedOperatorGetFields(CeedOperator op, 214 CeedOperatorField **input_fields, 215 CeedOperatorField **output_fields); 216 CEED_EXTERN int CeedOperatorFieldGetElemRestriction(CeedOperatorField op_field, 217 CeedElemRestriction *rstr); 218 CEED_EXTERN int CeedOperatorFieldGetBasis(CeedOperatorField op_field, 219 CeedBasis *basis); 220 CEED_EXTERN int CeedOperatorFieldGetVector(CeedOperatorField op_field, 221 CeedVector *vec); 222 223 CEED_INTERN int CeedMatrixMultiply(Ceed ceed, const CeedScalar *mat_A, 224 const CeedScalar *mat_B, CeedScalar *mat_C, 225 CeedInt m, CeedInt n, CeedInt kk); 226 227 #endif 228