Update 0.2.16 doc
[platform/upstream/openblas.git] / Makefile.rule
1 #
2 #  Beginning of user configuration
3 #
4
5 # This library's version
6 VERSION = 0.2.16
7
8 # If you set the suffix, the library name will be libopenblas_$(LIBNAMESUFFIX).a
9 # and libopenblas_$(LIBNAMESUFFIX).so. Meanwhile, the soname in shared library
10 # is libopenblas_$(LIBNAMESUFFIX).so.0.
11 # LIBNAMESUFFIX = omp
12
13 # You can specify the target architecture, otherwise it's
14 # automatically detected.
15 # TARGET = PENRYN
16
17 # If you want to support multiple architecture in one binary
18 # DYNAMIC_ARCH = 1
19
20 # C compiler including binary type(32bit / 64bit). Default is gcc.
21 # Don't use Intel Compiler or PGI, it won't generate right codes as I expect.
22 # CC = gcc
23
24 # Fortran compiler. Default is g77.
25 # FC = gfortran
26
27 # Even you can specify cross compiler. Meanwhile, please set HOSTCC.
28
29 # cross compiler for Windows
30 # CC = x86_64-w64-mingw32-gcc
31 # FC = x86_64-w64-mingw32-gfortran
32
33 # cross compiler for 32bit ARM
34 # CC = arm-linux-gnueabihf-gcc
35 # FC = arm-linux-gnueabihf-gfortran
36
37 # cross compiler for 64bit ARM
38 # CC = aarch64-linux-gnu-gcc
39 # FC = aarch64-linux-gnu-gfortran
40
41
42 # If you use the cross compiler, please set this host compiler.
43 # HOSTCC = gcc
44
45 # If you need 32bit binary, define BINARY=32, otherwise define BINARY=64
46 # BINARY=64
47
48 # About threaded BLAS. It will be automatically detected if you don't
49 # specify it.
50 # For force setting for single threaded, specify USE_THREAD = 0
51 # For force setting for multi  threaded, specify USE_THREAD = 1
52 # USE_THREAD = 0
53
54 # If you're going to use this library with OpenMP, please comment it in.
55 # USE_OPENMP = 1
56
57 # You can define maximum number of threads. Basically it should be
58 # less than actual number of cores. If you don't specify one, it's
59 # automatically detected by the the script.
60 # NUM_THREADS = 24
61
62 # if you don't need to install the static library, please comment it in.
63 # NO_STATIC = 1
64
65 # if you don't need generate the shared library, please comment it in.
66 # NO_SHARED = 1
67
68 # If you don't need CBLAS interface, please comment it in.
69 # NO_CBLAS = 1
70
71 # If you only want CBLAS interface without installing Fortran compiler,
72 # please comment it in.
73 # ONLY_CBLAS = 1
74
75 # If you don't need LAPACK, please comment it in.
76 # If you set NO_LAPACK=1, the library automatically sets NO_LAPACKE=1.
77 # NO_LAPACK = 1
78
79 # If you don't need LAPACKE (C Interface to LAPACK), please comment it in.
80 # NO_LAPACKE = 1
81
82 # Build LAPACK Deprecated functions since LAPACK 3.6.0
83 # BUILD_LAPACK_DEPRECATED = 1
84
85 # If you want to use legacy threaded Level 3 implementation.
86 # USE_SIMPLE_THREADED_LEVEL3 = 1
87
88 # If you want to drive whole 64bit region by BLAS. Not all Fortran
89 # compiler supports this. It's safe to keep comment it out if you
90 # are not sure(equivalent to "-i8" option).
91 # INTERFACE64 = 1
92
93 # Unfortunately most of kernel won't give us high quality buffer.
94 # BLAS tries to find the best region before entering main function,
95 # but it will consume time. If you don't like it, you can disable one.
96 NO_WARMUP = 1
97
98 # If you want to disable CPU/Memory affinity on Linux.
99 NO_AFFINITY = 1
100
101 # if you are compiling for Linux and you have more than 16 numa nodes or more than 256 cpus
102 # BIGNUMA = 1
103
104 # Don't use AVX kernel on Sandy Bridge. It is compatible with old compilers
105 # and OS. However, the performance is low.
106 # NO_AVX = 1
107
108 # Don't use Haswell optimizations if binutils is too old (e.g. RHEL6)
109 # NO_AVX2 = 1
110
111 # Don't use parallel make.
112 # NO_PARALLEL_MAKE = 1
113
114 # Force number of make jobs. The default is the number of logical CPU of the host.
115 # This is particularly useful when using distcc
116 # MAKE_NB_JOBS = 2
117
118 # If you would like to know minute performance report of GotoBLAS.
119 # FUNCTION_PROFILE = 1
120
121 # Support for IEEE quad precision(it's *real* REAL*16)( under testing)
122 # QUAD_PRECISION = 1
123
124 # Theads are still working for a while after finishing BLAS operation
125 # to reduce thread activate/deactivate overhead. You can determine
126 # time out to improve performance. This number should be from 4 to 30
127 # which corresponds to (1 << n) cycles. For example, if you set to 26,
128 # thread will be running for (1 << 26) cycles(about 25ms on 3.0GHz
129 # system). Also you can control this mumber by THREAD_TIMEOUT
130 # CCOMMON_OPT   += -DTHREAD_TIMEOUT=26
131
132 # Using special device driver for mapping physically contigous memory
133 # to the user space. If bigphysarea is enabled, it will use it.
134 # DEVICEDRIVER_ALLOCATION = 1
135
136 # If you need to synchronize FP CSR between threads (for x86/x86_64 only).
137 # CONSISTENT_FPCSR = 1
138
139 # If any gemm arguement m, n or k is less or equal this threshold, gemm will be execute
140 # with single thread. You can use this flag to avoid the overhead of multi-threading
141 # in small matrix sizes. The default value is 4.
142 # GEMM_MULTITHREAD_THRESHOLD = 4
143
144 # If you need santy check by comparing reference BLAS. It'll be very
145 # slow (Not implemented yet).
146 # SANITY_CHECK = 1
147
148 # The installation directory.
149 # PREFIX = /opt/OpenBLAS
150
151 # Common Optimization Flag;
152 # The default -O2 is enough.
153 # COMMON_OPT = -O2
154
155 # gfortran option for LAPACK
156 # enable this flag only on 64bit Linux and if you need a thread safe lapack library
157 # FCOMMON_OPT = -frecursive
158
159 # Profiling flags
160 COMMON_PROF = -pg
161
162 # Build Debug version
163 # DEBUG = 1
164
165 # Set maximum stack allocation.
166 # The default value is 2048. 0 disable stack allocation a may reduce GER and GEMV
167 # performance. For details, https://github.com/xianyi/OpenBLAS/pull/482
168 #
169 # MAX_STACK_ALLOC = 0
170
171 # Add a prefix or suffix to all exported symbol names in the shared library.
172 # Avoid conflicts with other BLAS libraries, especially when using
173 # 64 bit integer interfaces in OpenBLAS.
174 # For details, https://github.com/xianyi/OpenBLAS/pull/459
175 #
176 # The same prefix and suffix are also added to the library name,
177 # i.e. you get lib$(SYMBOLPREFIX)openblas$(SYMBOLSUFFIX) rather than libopenblas
178 #
179 # SYMBOLPREFIX=
180 # SYMBOLSUFFIX=
181
182 #
183 #  End of user configuration
184 #