xref: /petsc/include/petscblaslapack_mangle.h (revision 0ecfd9fc350141c372c751a4adf2797bf0a87e35)
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 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_REAL S
39 #  elif defined(PETSC_USE_REAL_DOUBLE)
40 #   define PETSC_BLASLAPACK_PREFIX_ D
41 #   define PETSC_BLASLAPACK_PREFIX_REAL D
42 #  else
43 #   define PETSC_BLASLAPACK_PREFIX_ Q
44 #   define PETSC_BLASLAPACK_PREFIX_REAL Q
45 #  endif
46 # else
47 #  if defined(PETSC_USE_REAL_SINGLE)
48 #   define PETSC_BLASLAPACK_PREFIX_ s
49 #   define PETSC_BLASLAPACK_PREFIX_REAL s
50 #  elif defined(PETSC_USE_REAL_DOUBLE)
51 #   define PETSC_BLASLAPACK_PREFIX_ d
52 #   define PETSC_BLASLAPACK_PREFIX_REAL d
53 #  elif defined(PETSC_USE_REAL___FLOAT128)
54 #   define PETSC_BLASLAPACK_PREFIX_ q
55 #   define PETSC_BLASLAPACK_PREFIX_REAL q
56 #  else
57 #   define PETSC_BLASLAPACK_PREFIX_REAL h
58 #   define PETSC_BLASLAPACK_PREFIX_ h
59 #  endif
60 # endif
61 # define PETSC_BLASLAPACK_RPREFIX_ PETSC_BLASLAPACK_PREFIX_
62 #else
63 # if defined(PETSC_BLASLAPACK_CAPS)
64 #  if defined(PETSC_USE_REAL_SINGLE)
65 #   define PETSC_BLASLAPACK_PREFIX_ C
66 #   define PETSC_BLASLAPACK_PREFIX_REAL s
67 #   define PETSC_BLASLAPACK_RPREFIX_ SC
68 #  elif defined(PETSC_USE_REAL_DOUBLE)
69 #   define PETSC_BLASLAPACK_PREFIX_ Z
70 #   define PETSC_BLASLAPACK_PREFIX_REAL D
71 #   define PETSC_BLASLAPACK_RPREFIX_ DZ
72 #  elif defined(PETSC_USE_REAL___FLOAT128)
73 #   define PETSC_BLASLAPACK_PREFIX_ W
74 #   define PETSC_BLASLAPACK_PREFIX_REAL Q
75 #   define PETSC_BLASLAPACK_RPREFIX_ QW
76 #  else
77 #   define PETSC_BLASLAPACK_PREFIX_ HK
78 #   define PETSC_BLASLAPACK_PREFIX_REAL H
79 #   define PETSC_BLASLAPACK_RPREFIX_ K
80 #  endif
81 # else
82 #  if defined(PETSC_USE_REAL_SINGLE)
83 #   define PETSC_BLASLAPACK_PREFIX_ c
84 #   define PETSC_BLASLAPACK_PREFIX_REAL s
85 #   define PETSC_BLASLAPACK_RPREFIX_ sc
86 #  elif defined(PETSC_USE_REAL_DOUBLE)
87 #   define PETSC_BLASLAPACK_PREFIX_ z
88 #   define PETSC_BLASLAPACK_PREFIX_REAL d
89 #   define PETSC_BLASLAPACK_RPREFIX_ dz
90 #  elif defined(PETSC_USE_REAL___FLOAT128)
91 #   define PETSC_BLASLAPACK_PREFIX_ w
92 #   define PETSC_BLASLAPACK_PREFIX_REAL q
93 #   define PETSC_BLASLAPACK_RPREFIX_ qw
94 #  else
95 #   define PETSC_BLASLAPACK_PREFIX_ hk
96 #   define PETSC_BLASLAPACK_PREFIX_REAL h
97 #   define PETSC_BLASLAPACK_RPREFIX_ k
98 #  endif
99 # endif
100 #endif
101 
102 /* define macros PETSCBLAS to mangle BLAS/LAPACK subroutine names, and
103    PETSCBLASR for functions returning real values */
104 #if defined(PETSC_BLASLAPACK_CAPS)
105 #  define PETSCBLAS(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_, X, PETSC_BLASLAPACK_SUFFIX_)
106 #  define PETSCBLASREAL(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_REAL, X, PETSC_BLASLAPACK_SUFFIX_)
107 #  define PETSCBLASR(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_RPREFIX_, X, PETSC_BLASLAPACK_SUFFIX_)
108 #else
109 #  define PETSCBLAS(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_, x, PETSC_BLASLAPACK_SUFFIX_)
110 #  define PETSCBLASREAL(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_PREFIX_REAL, x, PETSC_BLASLAPACK_SUFFIX_)
111 #  define PETSCBLASR(x,X) PETSC_PASTE3(PETSC_BLASLAPACK_RPREFIX_, x, PETSC_BLASLAPACK_SUFFIX_)
112 #endif
113 
114 /****************************************************************************/
115 /* definitions of BLAS and LAPACK symbols */
116 
117 /* Subroutine names that are the same for real/complex data: */
118 /* no character-string arguments: */
119 #define LAPACKgeqrf_ PETSCBLAS(geqrf,GEQRF)
120 #define LAPACKgetrf_ PETSCBLAS(getrf,GETRF)
121 #define LAPACKgetri_ PETSCBLAS(getri,GETRI)
122 #define BLASnrm2_    PETSCBLASR(nrm2,NRM2)
123 #define BLASscal_    PETSCBLAS(scal,SCAL)
124 #define BLAScopy_    PETSCBLAS(copy,COPY)
125 #define BLASswap_    PETSCBLAS(swap,SWAP)
126 #define BLASaxpy_    PETSCBLAS(axpy,AXPY)
127 #define BLASasum_    PETSCBLASR(asum,ASUM)
128 #define LAPACKpttrf_ PETSCBLAS(pttrf,PTTRF) /* factorization of a spd tridiagonal matrix */
129 #define LAPACKpttrs_ PETSCBLAS(pttrs,PTTRS) /* solve a spd tridiagonal matrix system */
130 #define LAPACKstein_ PETSCBLAS(stein,STEIN) /* eigenvectors of real symm tridiagonal matrix */
131 #define LAPACKgesv_  PETSCBLAS(gesv,GESV)
132 #define LAPACKgelss_ PETSCBLAS(gelss,GELSS)
133 #define LAPACKgerfs_ PETSCBLAS(gerfs,GERFS)
134 #define LAPACKtgsen_ PETSCBLAS(tgsen,TGSEN)
135 /* character-string arguments: */
136 #define LAPACKpotrf_ PETSCBLAS(potrf,POTRF)
137 #define LAPACKpotri_ PETSCBLAS(potri,POTRI)
138 #define LAPACKpotrs_ PETSCBLAS(potrs,POTRS)
139 #define LAPACKsytrf_ PETSCBLAS(sytrf,SYTRF)
140 #define LAPACKsytrs_ PETSCBLAS(sytrs,SYTRS)
141 #define LAPACKsytri_ PETSCBLAS(sytri,SYTRI)
142 #define BLASgemv_    PETSCBLAS(gemv,GEMV)
143 #define LAPACKgetrs_ PETSCBLAS(getrs,GETRS)
144 #define BLAStrmv_    PETSCBLAS(trmv,TRMV)
145 #define BLASgemm_    PETSCBLAS(gemm,GEMM)
146 #define BLASsymm_    PETSCBLAS(symm,SYMM)
147 #define BLASsyrk_    PETSCBLAS(syrk,SYRK)
148 #define BLASsyr2k_   PETSCBLAS(syr2k,SYR2K)
149 #define BLAStrsm_    PETSCBLAS(trsm,TRSM)
150 #define LAPACKgesvd_ PETSCBLAS(gesvd,GESVD)
151 #define LAPACKgeev_  PETSCBLAS(geev,GEEV)
152 #define LAPACKgels_  PETSCBLAS(gels,GELS)
153 #define LAPACKsteqr_ PETSCBLAS(steqr,STEQR)  /* eigenvalues and eigenvectors of symm tridiagonal */
154 #define LAPACKREALsteqr_ PETSCBLASREAL(steqr,STEQR)
155 #define LAPACKhseqr_ PETSCBLAS(hseqr,HSEQR)
156 #define LAPACKgges_  PETSCBLAS(gges,GGES)
157 #define LAPACKtrsen_ PETSCBLAS(trsen,TRSEN)
158 #define LAPACKormqr_ PETSCBLAS(ormqr,ORMQR)
159 #define LAPACKhgeqz_ PETSCBLAS(hgeqz,HGEQZ)
160 #define LAPACKtrtrs_ PETSCBLAS(trtrs,TRTRS)
161 
162 /* Subroutine names that differ for real/complex data: */
163 #if !defined(PETSC_USE_COMPLEX)
164 # define LAPACKungqr_ PETSCBLAS(orgqr,ORGQR)
165 # define BLASdot_     PETSCBLAS(dot,DOT)
166 # define BLASdotu_    PETSCBLAS(dot,DOT)
167 
168 # define LAPACKsyev_  PETSCBLAS(syev,SYEV)  /* eigenvalues and eigenvectors of a symm matrix */
169 # define LAPACKsyevx_ PETSCBLAS(syevx,SYEVX) /* selected eigenvalues and eigenvectors of a symm matrix */
170 # define LAPACKsygv_  PETSCBLAS(sygv,SYGV)
171 # define LAPACKsygvx_ PETSCBLAS(sygvx,SYGVX)
172 
173   /* stebz does not exist for complex data */
174 # define LAPACKstebz_ PETSCBLAS(stebz,STEBZ) /* eigenvalues of symm tridiagonal matrix */
175 #else
176 # define LAPACKhetrf_ PETSCBLAS(hetrf,HETRF)
177 # define LAPACKhetrs_ PETSCBLAS(hetrs,HETRS)
178 # define LAPACKhetri_ PETSCBLAS(hetri,HETRI)
179 # define LAPACKungqr_ PETSCBLAS(ungqr,UNGQR)
180    /* note: dot and dotu are handled separately for complex data */
181 
182 # define LAPACKsyev_  PETSCBLAS(heev,HEEV)  /* eigenvalues and eigenvectors of a symm matrix */
183 # define LAPACKsyevx_ PETSCBLAS(heevx,HEEVX) /* selected eigenvalues and eigenvectors of a symm matrix */
184 # define LAPACKsygv_  PETSCBLAS(hegv,HEGV)
185 # define LAPACKsygvx_ PETSCBLAS(hegvx,HEGVX)
186 #endif
187 
188 #endif
189