xref: /petsc/include/petscblaslapack_mangle.h (revision 55e7fe800d976e85ed2b5cd8bfdef564daa37bd9)
1 /*
2       This file deals with the BLAS/LAPACK naming convention on
3       non-Microsoft systems, which may append an underscore, use
4       upper or lower case, and/or use a configurable symbol suffix.
5 */
6 #if !defined(_BLASLAPACK_MANGLE_H)
7 #define _BLASLAPACK_MANGLE_H
8 
9 /****************************************************************************/
10 /* macros to mangle BLAS/LAPACK names as needed for linking */
11 
12 /* token pasting, with an extra level of indirection so that we
13    can paste the contents of other preprocessor #definitions */
14 #define PETSC_PASTE2_(a,b) a ## b
15 #define PETSC_PASTE2(a,b) PETSC_PASTE2_(a,b)
16 #define PETSC_PASTE3_(a,b,c) a ## b ## c
17 #define PETSC_PASTE3(a,b,c) PETSC_PASTE3_(a,b,c)
18 
19 #if !defined(PETSC_BLASLAPACK_SUFFIX)
20 # if defined(PETSC_BLASLAPACK_UNDERSCORE)
21 #  define PETSC_BLASLAPACK_SUFFIX_ _
22 # else
23 #  define PETSC_BLASLAPACK_SUFFIX_
24 # endif
25 #else
26 # if defined(PETSC_BLASLAPACK_UNDERSCORE)
27 #  define PETSC_BLASLAPACK_SUFFIX_ PETSC_PASTE2(PETSC_BLASLAPACK_SUFFIX,_)
28 # else
29 #  define PETSC_BLASLAPACK_SUFFIX_ PETSC_BLASLAPACK_SUFFIX
30 # endif
31 #endif
32 
33 /* complex/real and single/double/quad/half precision prefixes: */
34 #if !defined(PETSC_USE_COMPLEX)
35 # if defined(PETSC_BLASLAPACK_CAPS)
36 #  if defined(PETSC_USE_REAL_SINGLE)
37 #   define PETSC_BLASLAPACK_PREFIX_ S
38 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX C
39 #  elif defined(PETSC_USE_REAL_DOUBLE)
40 #   define PETSC_BLASLAPACK_PREFIX_ D
41 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX Z
42 #  elif defined(PETSC_USE_REAL___FLOAT128)
43 #   define PETSC_BLASLAPACK_PREFIX_ Q
44 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX W
45 #  else
46 #   define PETSC_BLASLAPACK_PREFIX_ H
47 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX K
48 #  endif
49 # else
50 #  if defined(PETSC_USE_REAL_SINGLE)
51 #   define PETSC_BLASLAPACK_PREFIX_ s
52 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX c
53 #  elif defined(PETSC_USE_REAL_DOUBLE)
54 #   define PETSC_BLASLAPACK_PREFIX_ d
55 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX z
56 #  elif defined(PETSC_USE_REAL___FLOAT128)
57 #   define PETSC_BLASLAPACK_PREFIX_ q
58 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX w
59 #  else
60 #   define PETSC_BLASLAPACK_PREFIX_ h
61 #   define PETSC_BLASLAPACK_PREFIX_COMPLEX k
62 #  endif
63 # endif
64 # define PETSC_BLASLAPACK_RPREFIX_ PETSC_BLASLAPACK_PREFIX_
65 # define PETSC_BLASLAPACK_PREFIX_REAL PETSC_BLASLAPACK_PREFIX_
66 #else
67 # if defined(PETSC_BLASLAPACK_CAPS)
68 #  if defined(PETSC_USE_REAL_SINGLE)
69 #   define PETSC_BLASLAPACK_PREFIX_ C
70 #   define PETSC_BLASLAPACK_PREFIX_REAL S
71 #   define PETSC_BLASLAPACK_RPREFIX_ SC
72 #  elif defined(PETSC_USE_REAL_DOUBLE)
73 #   define PETSC_BLASLAPACK_PREFIX_ Z
74 #   define PETSC_BLASLAPACK_PREFIX_REAL D
75 #   define PETSC_BLASLAPACK_RPREFIX_ DZ
76 #  elif defined(PETSC_USE_REAL___FLOAT128)
77 #   define PETSC_BLASLAPACK_PREFIX_ W
78 #   define PETSC_BLASLAPACK_PREFIX_REAL Q
79 #   define PETSC_BLASLAPACK_RPREFIX_ QW
80 #  else
81 #   define PETSC_BLASLAPACK_PREFIX_ K
82 #   define PETSC_BLASLAPACK_PREFIX_REAL H
83 #   define PETSC_BLASLAPACK_RPREFIX_ HK
84 #  endif
85 # else
86 #  if defined(PETSC_USE_REAL_SINGLE)
87 #   define PETSC_BLASLAPACK_PREFIX_ c
88 #   define PETSC_BLASLAPACK_PREFIX_REAL s
89 #   define PETSC_BLASLAPACK_RPREFIX_ sc
90 #  elif defined(PETSC_USE_REAL_DOUBLE)
91 #   define PETSC_BLASLAPACK_PREFIX_ z
92 #   define PETSC_BLASLAPACK_PREFIX_REAL d
93 #   define PETSC_BLASLAPACK_RPREFIX_ dz
94 #  elif defined(PETSC_USE_REAL___FLOAT128)
95 #   define PETSC_BLASLAPACK_PREFIX_ w
96 #   define PETSC_BLASLAPACK_PREFIX_REAL q
97 #   define PETSC_BLASLAPACK_RPREFIX_ qw
98 #  else
99 #   define PETSC_BLASLAPACK_PREFIX_ k
100 #   define PETSC_BLASLAPACK_PREFIX_REAL h
101 #   define PETSC_BLASLAPACK_RPREFIX_ hk
102 #  endif
103 # endif
104 # define PETSC_BLASLAPACK_PREFIX_COMPLEX PETSC_BLASLAPACK_PREFIX_
105 #endif
106 
107 /* define macros PETSCBLAS to mangle BLAS/LAPACK subroutine names, and
108    PETSCBLASR for functions returning real values */
109 #if defined(PETSC_BLASLAPACK_CAPS)
110 #  define PETSCBLAS(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_, X, PETSC_BLASLAPACK_SUFFIX_)
111 #  define PETSCBLASREAL(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_REAL, X, PETSC_BLASLAPACK_SUFFIX_)
112 #  define PETSCBLASCOMPLEX(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_COMPLEX, X, PETSC_BLASLAPACK_SUFFIX_)
113 #  define PETSCBLASR(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_RPREFIX_, X, PETSC_BLASLAPACK_SUFFIX_)
114 #else
115 #  define PETSCBLAS(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_, x, PETSC_BLASLAPACK_SUFFIX_)
116 #  define PETSCBLASREAL(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_REAL, x, PETSC_BLASLAPACK_SUFFIX_)
117 #  define PETSCBLASCOMPLEX(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_COMPLEX, x, PETSC_BLASLAPACK_SUFFIX_)
118 #  define PETSCBLASR(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_RPREFIX_, x, PETSC_BLASLAPACK_SUFFIX_)
119 #endif
120 
121 /****************************************************************************/
122 /* definitions of BLAS and LAPACK symbols */
123 
124 /* Subroutine names that are the same for real/complex data: */
125 /* no character-string arguments: */
126 #define LAPACKgeqrf_ PETSCBLAS(geqrf,GEQRF)
127 #define LAPACKgetrf_ PETSCBLAS(getrf,GETRF)
128 #define LAPACKgetri_ PETSCBLAS(getri,GETRI)
129 #define BLASnrm2_    PETSCBLASR(nrm2,NRM2)
130 #define BLASscal_    PETSCBLAS(scal,SCAL)
131 #define BLAScopy_    PETSCBLAS(copy,COPY)
132 #define BLASswap_    PETSCBLAS(swap,SWAP)
133 #define BLASaxpy_    PETSCBLAS(axpy,AXPY)
134 #define BLASasum_    PETSCBLASR(asum,ASUM)
135 #define LAPACKpttrf_ PETSCBLAS(pttrf,PTTRF) /* factorization of a spd tridiagonal matrix */
136 #define LAPACKpttrs_ PETSCBLAS(pttrs,PTTRS) /* solve a spd tridiagonal matrix system */
137 #define LAPACKstein_ PETSCBLAS(stein,STEIN) /* eigenvectors of real symm tridiagonal matrix */
138 #define LAPACKgesv_  PETSCBLAS(gesv,GESV)
139 #define LAPACKgelss_ PETSCBLAS(gelss,GELSS)
140 #define LAPACKgerfs_ PETSCBLAS(gerfs,GERFS)
141 #define LAPACKtgsen_ PETSCBLAS(tgsen,TGSEN)
142 /* character-string arguments: */
143 #define LAPACKpotrf_ PETSCBLAS(potrf,POTRF)
144 #define LAPACKpotri_ PETSCBLAS(potri,POTRI)
145 #define LAPACKpotrs_ PETSCBLAS(potrs,POTRS)
146 #define LAPACKsytrf_ PETSCBLAS(sytrf,SYTRF)
147 #define LAPACKsytrs_ PETSCBLAS(sytrs,SYTRS)
148 #define LAPACKsytri_ PETSCBLAS(sytri,SYTRI)
149 #define BLASgemv_    PETSCBLAS(gemv,GEMV)
150 #define LAPACKgetrs_ PETSCBLAS(getrs,GETRS)
151 #define BLAStrmv_    PETSCBLAS(trmv,TRMV)
152 #define BLASgemm_    PETSCBLAS(gemm,GEMM)
153 #define BLASsymm_    PETSCBLAS(symm,SYMM)
154 #define BLASsyrk_    PETSCBLAS(syrk,SYRK)
155 #define BLASsyr2k_   PETSCBLAS(syr2k,SYR2K)
156 #define BLAStrsm_    PETSCBLAS(trsm,TRSM)
157 #define LAPACKgesvd_ PETSCBLAS(gesvd,GESVD)
158 #define LAPACKgeev_  PETSCBLAS(geev,GEEV)
159 #define LAPACKgels_  PETSCBLAS(gels,GELS)
160 #define LAPACKsteqr_ PETSCBLAS(steqr,STEQR)  /* eigenvalues and eigenvectors of symm tridiagonal */
161 #define LAPACKREALsteqr_ PETSCBLASREAL(steqr,STEQR)
162 #define LAPACKhseqr_ PETSCBLAS(hseqr,HSEQR)
163 #define LAPACKgges_  PETSCBLAS(gges,GGES)
164 #define LAPACKtrsen_ PETSCBLAS(trsen,TRSEN)
165 #define LAPACKhgeqz_ PETSCBLAS(hgeqz,HGEQZ)
166 #define LAPACKtrtrs_ PETSCBLAS(trtrs,TRTRS)
167 
168 /* Subroutine names that differ for real/complex data: */
169 #if !defined(PETSC_USE_COMPLEX)
170 # define LAPACKorgqr_ PETSCBLAS(orgqr,ORGQR)
171 # define LAPACKormqr_ PETSCBLAS(ormqr,ORMQR)
172 # define BLASdot_     PETSCBLAS(dot,DOT)
173 # define BLASdotu_    PETSCBLAS(dot,DOT)
174 
175 # define LAPACKsyev_  PETSCBLAS(syev,SYEV)  /* eigenvalues and eigenvectors of a symm matrix */
176 # define LAPACKsyevx_ PETSCBLAS(syevx,SYEVX) /* selected eigenvalues and eigenvectors of a symm matrix */
177 # define LAPACKsygv_  PETSCBLAS(sygv,SYGV)
178 # define LAPACKsygvx_ PETSCBLAS(sygvx,SYGVX)
179 
180   /* stebz does not exist for complex data */
181 # define LAPACKstebz_ PETSCBLAS(stebz,STEBZ) /* eigenvalues of symm tridiagonal matrix */
182 #else
183 # define LAPACKhetrf_ PETSCBLAS(hetrf,HETRF)
184 # define LAPACKhetrs_ PETSCBLAS(hetrs,HETRS)
185 # define LAPACKhetri_ PETSCBLAS(hetri,HETRI)
186 # define LAPACKorgqr_ PETSCBLAS(ungqr,UNGQR)
187 # define LAPACKormqr_ PETSCBLAS(unmqr,UNMQR)
188    /* note: dot and dotu are handled separately for complex data */
189 
190 # define LAPACKsyev_  PETSCBLAS(heev,HEEV)  /* eigenvalues and eigenvectors of a symm matrix */
191 # define LAPACKsyevx_ PETSCBLAS(heevx,HEEVX) /* selected eigenvalues and eigenvectors of a symm matrix */
192 # define LAPACKsygv_  PETSCBLAS(hegv,HEGV)
193 # define LAPACKsygvx_ PETSCBLAS(hegvx,HEGVX)
194 #endif
195 
196 #endif
197