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 types and macros used in user QFunction source code 10 #ifndef _ceed_qfunction_defs_h 11 #define _ceed_qfunction_defs_h 12 13 #include <stddef.h> 14 #include <stdint.h> 15 16 /** 17 @ingroup CeedQFunction 18 This macro defines compiler attributes to the CEED_QFUNCTION to force inlining for called functions. 19 The `inline` declaration does not necessarily enforce a compiler to inline a function. 20 This can be detrimental to performance, so here we force inlining to occur unless inlining has been forced off (like during debugging). 21 **/ 22 #ifndef CEED_QFUNCTION_ATTR 23 #ifndef __NO_INLINE__ 24 #if defined(__GNUC__) || defined(__clang__) 25 #define CEED_QFUNCTION_ATTR __attribute__((flatten)) 26 #elif defined(__INTEL_COMPILER) 27 #define CEED_QFUNCTION_ATTR _Pragma("forceinline") 28 #else 29 #define CEED_QFUNCTION_ATTR 30 #endif 31 #else 32 #define CEED_QFUNCTION_ATTR 33 #endif 34 #if defined(__GNUC__) || defined(__clang__) 35 #define CEED_QFUNCTION_HELPER_ATTR CEED_QFUNCTION_ATTR __attribute__((always_inline)) 36 #else 37 #define CEED_QFUNCTION_HELPER_ATTR CEED_QFUNCTION_ATTR 38 #endif 39 #endif 40 41 /** 42 @ingroup CeedQFunction 43 This macro populates the correct function annotations for User QFunction source for code generation backends or populates default values for CPU 44 backends. It also creates a variable `name_loc` populated with the correct source path for creating the respective User QFunction. 45 **/ 46 #ifndef CEED_QFUNCTION 47 #define CEED_QFUNCTION(name) \ 48 static const char name##_loc[] = __FILE__ ":" #name; \ 49 CEED_QFUNCTION_ATTR static int name 50 #endif 51 52 /** 53 @ingroup CeedQFunction 54 This macro populates the correct function annotations for User QFunction helper function source for code generation backends or populates default 55 values for CPU backends. 56 **/ 57 #ifndef CEED_QFUNCTION_HELPER 58 #define CEED_QFUNCTION_HELPER CEED_QFUNCTION_HELPER_ATTR static inline 59 #endif 60 61 /** 62 @ingroup CeedQFunction 63 Using VLA syntax to reshape User QFunction inputs and outputs can make user code more readable. 64 VLA is a C99 feature that is not supported by the C++ dialect used by CUDA. 65 This macro allows users to use the VLA syntax with the CUDA backends. 66 **/ 67 #ifndef CEED_Q_VLA 68 #define CEED_Q_VLA Q 69 #endif 70 71 /** 72 @ingroup Ceed 73 This macro provides the appropriate SIMD Pragma for the compilation environment. 74 Code generation backends may redefine this macro, as needed. 75 **/ 76 #ifndef CeedPragmaSIMD 77 #if defined(__INTEL_COMPILER) 78 #define CeedPragmaSIMD _Pragma("vector") 79 /// Cannot use Intel pragma ivdep because it miscompiles unpacking symmetric tensors, as in Poisson2DApply, where the SIMD loop body contains 80 /// temporaries such as the following. 81 /// 82 /// const CeedScalar dXdxdXdxT[2][2] = {{qd[i+0*Q], qd[i+2*Q]}, 83 /// {qd[i+2*Q], qd[i+1*Q]}}; 84 /// for (int j=0; j<2; j++) 85 /// vg[i+j*Q] = (du[0] * dXdxdXdxT[0][j] + du[1] * dXdxdXdxT[1][j]); 86 /// 87 /// Miscompilation with pragma ivdep observed with icc (ICC) 19.0.5.281 20190815 at -O2 and above. 88 #elif defined(__GNUC__) && __GNUC__ >= 5 89 #define CeedPragmaSIMD _Pragma("GCC ivdep") 90 #elif defined(_OPENMP) && _OPENMP >= 201307 // OpenMP-4.0 (July, 2013) 91 #define CeedPragmaSIMD _Pragma("omp simd") 92 #else 93 #define CeedPragmaSIMD 94 #endif 95 #endif 96 97 /// Integer type, used for indexing 98 /// @ingroup Ceed 99 typedef int32_t CeedInt; 100 #define CeedInt_FMT "d" 101 102 /// Integer type, used array sizes 103 /// @ingroup Ceed 104 typedef ptrdiff_t CeedSize; 105 106 /// Scalar (floating point) types 107 /// 108 /// @ingroup Ceed 109 typedef enum { 110 /// Single precision 111 CEED_SCALAR_FP32, 112 /// Double precision 113 CEED_SCALAR_FP64 114 } CeedScalarType; 115 /// Base scalar type for the library to use: change which header is included to change the precision. 116 #include "ceed-f64.h" // IWYU pragma: export 117 118 /// Ceed Errors 119 /// 120 /// This enum is used to specify the type of error returned by a function. 121 /// A zero error code is success, negative error codes indicate terminal errors and positive error codes indicate nonterminal errors. 122 /// With nonterminal errors the object state has not been modified, but with terminal errors the object data is likely modified or corrupted. 123 /// @ingroup Ceed 124 typedef enum { 125 /// Success error code 126 CEED_ERROR_SUCCESS = 0, 127 /// Minor error, generic 128 CEED_ERROR_MINOR = 1, 129 /// Minor error, dimension mismatch in inputs 130 CEED_ERROR_DIMENSION = 2, 131 /// Minor error, incomplete object setup 132 CEED_ERROR_INCOMPLETE = 3, 133 /// Minor error, incompatible arguments/configuration 134 CEED_ERROR_INCOMPATIBLE = 4, 135 /// Minor error, access lock problem 136 CEED_ERROR_ACCESS = 5, 137 /// Major error, generic 138 CEED_ERROR_MAJOR = -1, 139 /// Major error, internal backend error 140 CEED_ERROR_BACKEND = -2, 141 /// Major error, operation unsupported by current backend 142 CEED_ERROR_UNSUPPORTED = -3, 143 } CeedErrorType; 144 145 #endif 146