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