Merge branch 'develop' of https://github.com/wernsaar/OpenBLAS into wernsaar-develop
[platform/upstream/openblas.git] / common_x86.h
1 /*********************************************************************/
2 /* Copyright 2009, 2010 The University of Texas at Austin.           */
3 /* All rights reserved.                                              */
4 /*                                                                   */
5 /* Redistribution and use in source and binary forms, with or        */
6 /* without modification, are permitted provided that the following   */
7 /* conditions are met:                                               */
8 /*                                                                   */
9 /*   1. Redistributions of source code must retain the above         */
10 /*      copyright notice, this list of conditions and the following  */
11 /*      disclaimer.                                                  */
12 /*                                                                   */
13 /*   2. Redistributions in binary form must reproduce the above      */
14 /*      copyright notice, this list of conditions and the following  */
15 /*      disclaimer in the documentation and/or other materials       */
16 /*      provided with the distribution.                              */
17 /*                                                                   */
18 /*    THIS  SOFTWARE IS PROVIDED  BY THE  UNIVERSITY OF  TEXAS AT    */
19 /*    AUSTIN  ``AS IS''  AND ANY  EXPRESS OR  IMPLIED WARRANTIES,    */
20 /*    INCLUDING, BUT  NOT LIMITED  TO, THE IMPLIED  WARRANTIES OF    */
21 /*    MERCHANTABILITY  AND FITNESS FOR  A PARTICULAR  PURPOSE ARE    */
22 /*    DISCLAIMED.  IN  NO EVENT SHALL THE UNIVERSITY  OF TEXAS AT    */
23 /*    AUSTIN OR CONTRIBUTORS BE  LIABLE FOR ANY DIRECT, INDIRECT,    */
24 /*    INCIDENTAL,  SPECIAL, EXEMPLARY,  OR  CONSEQUENTIAL DAMAGES    */
25 /*    (INCLUDING, BUT  NOT LIMITED TO,  PROCUREMENT OF SUBSTITUTE    */
26 /*    GOODS  OR  SERVICES; LOSS  OF  USE,  DATA,  OR PROFITS;  OR    */
27 /*    BUSINESS INTERRUPTION) HOWEVER CAUSED  AND ON ANY THEORY OF    */
28 /*    LIABILITY, WHETHER  IN CONTRACT, STRICT  LIABILITY, OR TORT    */
29 /*    (INCLUDING NEGLIGENCE OR OTHERWISE)  ARISING IN ANY WAY OUT    */
30 /*    OF  THE  USE OF  THIS  SOFTWARE,  EVEN  IF ADVISED  OF  THE    */
31 /*    POSSIBILITY OF SUCH DAMAGE.                                    */
32 /*                                                                   */
33 /* The views and conclusions contained in the software and           */
34 /* documentation are those of the authors and should not be          */
35 /* interpreted as representing official policies, either expressed   */
36 /* or implied, of The University of Texas at Austin.                 */
37 /*********************************************************************/
38
39 #ifndef COMMON_X86
40 #define COMMON_X86
41
42 #ifndef ASSEMBLER
43
44 #define MB
45 #define WMB
46
47 #ifdef C_SUN
48 #define __asm__ __asm
49 #define __volatile__
50 #endif
51
52 static void __inline blas_lock(volatile BLASULONG *address){
53
54   int ret;
55
56   do {
57     while (*address) {YIELDING;};
58     
59     __asm__ __volatile__(
60                          "xchgl %0, %1\n"
61                          : "=r"(ret), "=m"(*address)
62                          : "0"(1), "m"(*address)
63                          : "memory");
64
65   } while (ret);
66
67 }
68
69 static __inline unsigned long long rpcc(void){
70   unsigned int a, d;
71
72   __asm__ __volatile__ ("rdtsc" : "=a" (a), "=d" (d));
73   
74   return ((unsigned long long)a + ((unsigned long long)d << 32));  
75 };
76
77 static __inline unsigned long getstackaddr(void){
78   unsigned long addr;
79
80   __asm__ __volatile__ ("mov %%esp, %0"
81                          : "=r"(addr) : : "memory");
82
83   return addr;  
84 };
85
86
87 static __inline long double sqrt_long(long double val) {
88   long double result;
89
90   __asm__ __volatile__ ("fldt %1\n"
91                     "fsqrt\n"
92                     "fstpt %0\n" : "=m" (result) : "m"(val));
93   return result;
94 }
95
96 #define SQRT(a)  sqrt_long(a)
97
98 /* This is due to gcc's bug */
99 void cpuid(int op, int *eax, int *ebx, int *ecx, int *edx);
100
101 #define WHEREAMI
102
103 static inline int WhereAmI(void){
104   int eax, ebx, ecx, edx;
105   int apicid;
106
107   cpuid(1, &eax, &ebx, &ecx, &edx);
108   apicid  = BITMASK(ebx, 24, 0xff);
109
110   return apicid;
111 }
112
113 #ifdef ENABLE_SSE_EXCEPTION
114
115 #define IDEBUG_START \
116 { \
117   unsigned int fp_sse_mode, new_fp_mode; \
118   __asm__ __volatile__ ("stmxcsr %0" : "=m" (fp_sse_mode) : ); \
119   new_fp_mode = fp_sse_mode & ~0xd00; \
120   __asm__ __volatile__ ("ldmxcsr %0" : : "m" (new_fp_mode) );
121
122 #define IDEBUG_END \
123   __asm__ __volatile__ ("ldmxcsr %0" : : "m" (fp_sse_mode) ); \
124 }
125
126 #endif
127
128 #ifdef XDOUBLE
129 #define GET_IMAGE(res)  __asm__ __volatile__("fstpt %0" : "=m"(res) : : "memory")
130 #elif defined(DOUBLE)
131 #define GET_IMAGE(res)  __asm__ __volatile__("fstpl %0" : "=m"(res) : : "memory")
132 #else
133 #define GET_IMAGE(res)  __asm__ __volatile__("fstps %0" : "=m"(res) : : "memory");
134 #endif
135
136 #define GET_IMAGE_CANCEL        __asm__ __volatile__ ("ffree %st")
137
138 #ifdef SMP
139 extern unsigned int blas_quick_divide_table[];
140
141 static __inline int blas_quickdivide(unsigned int x, unsigned int y){
142
143   unsigned int result;
144
145   if (y <= 1) return x;
146
147   y = blas_quick_divide_table[y];
148
149   __asm__ __volatile__  ("mull %0" :"=d" (result) :"a"(x), "0" (y));
150
151   return result;
152 }
153 #endif
154
155 #endif
156
157 #ifndef PAGESIZE
158 #define PAGESIZE        ( 4 << 10)
159 #endif
160 #define HUGE_PAGESIZE   ( 4 << 20)
161
162 #define BUFFER_SIZE     (16 << 20)
163
164 #define SEEK_ADDRESS
165
166 #if defined(DOUBLE) || defined(XDOUBLE)
167 #define MMXLOAD         movq
168 #define MMXSTORE        movq
169 #else
170 #define MMXLOAD         movd
171 #define MMXSTORE        movd
172 #endif
173
174 #if defined(PILEDRIVER) || defined(BULLDOZER)
175 //Enable some optimazation for barcelona.
176 #define BARCELONA_OPTIMIZATION
177 #endif
178
179 #if defined(HAVE_3DNOW)
180 #define EMMS    femms
181 #elif defined(HAVE_MMX)
182 #define EMMS    emms
183 #endif
184
185 #ifndef EMMS
186 #define EMMS
187 #endif
188
189 #if defined(CORE2) || defined(PENTIUM4)
190 #define movapd  movaps
191 #endif
192
193 #define BRANCH          .byte 0x3e
194 #define NOBRANCH        .byte 0x2e
195 #define PADDING         .byte 0x66;
196 #define HALT            hlt
197
198 #ifndef COMPLEX
199 #ifdef XDOUBLE
200 #define LOCAL_BUFFER_SIZE  QLOCAL_BUFFER_SIZE
201 #elif defined DOUBLE
202 #define LOCAL_BUFFER_SIZE  DLOCAL_BUFFER_SIZE
203 #else
204 #define LOCAL_BUFFER_SIZE  SLOCAL_BUFFER_SIZE
205 #endif
206 #else
207 #ifdef XDOUBLE
208 #define LOCAL_BUFFER_SIZE  XLOCAL_BUFFER_SIZE
209 #elif defined DOUBLE
210 #define LOCAL_BUFFER_SIZE  ZLOCAL_BUFFER_SIZE
211 #else
212 #define LOCAL_BUFFER_SIZE  CLOCAL_BUFFER_SIZE
213 #endif
214 #endif
215
216 #if defined(OS_WINDOWS)
217 #if   LOCAL_BUFFER_SIZE > 16384
218 #define STACK_TOUCHING \
219         movl    $0,  4096 * 4(%esp);\
220         movl    $0,  4096 * 3(%esp);\
221         movl    $0,  4096 * 2(%esp);\
222         movl    $0,  4096 * 1(%esp);
223 #elif LOCAL_BUFFER_SIZE > 12288
224 #define STACK_TOUCHING \
225         movl    $0,  4096 * 3(%esp);\
226         movl    $0,  4096 * 2(%esp);\
227         movl    $0,  4096 * 1(%esp);
228 #elif LOCAL_BUFFER_SIZE > 8192
229 #define STACK_TOUCHING \
230         movl    $0,  4096 * 2(%esp);\
231         movl    $0,  4096 * 1(%esp);
232 #elif LOCAL_BUFFER_SIZE > 4096
233 #define STACK_TOUCHING \
234         movl    $0,  4096 * 1(%esp);
235 #else
236 #define STACK_TOUCHING
237 #endif
238 #else
239 #define STACK_TOUCHING
240 #endif
241
242 #ifndef F_INTERFACE
243 #define REALNAME ASMNAME
244 #else
245 #define REALNAME ASMFNAME
246 #endif
247
248 #if defined(F_INTERFACE_PATHSCALE) || defined(F_INTERFACE_OPEN64)
249 #define RETURN_BY_STRUCT
250 #elif defined(F_INTERFACE_GFORT) || defined(F_INTERFACE_G95)
251 #define RETURN_BY_COMPLEX
252 #else
253 #define RETURN_BY_STACK
254 #endif
255
256 #ifdef OS_DARWIN
257 #define PROLOGUE .text;.align 5; .globl REALNAME; REALNAME:
258 #define EPILOGUE        .subsections_via_symbols
259 #define PROFCODE
260 #endif
261
262 #if defined(OS_WINNT) || defined(OS_CYGWIN_NT) || defined(OS_INTERIX)
263 #define SAVEREGISTERS \
264         subl    $32, %esp;\
265         movups  %xmm6,    0(%esp);\
266         movups  %xmm7,   16(%esp)
267
268 #define RESTOREREGISTERS \
269         movups     0(%esp), %xmm6;\
270         movups    16(%esp), %xmm7;\
271         addl    $32, %esp
272 #else
273 #define SAVEREGISTERS
274 #define RESTOREREGISTERS
275 #endif
276
277 #if defined(OS_WINNT) || defined(OS_CYGWIN_NT) || defined(OS_INTERIX)
278 #define PROLOGUE \
279         .text; \
280         .align 16; \
281         .globl REALNAME ;\
282         .def REALNAME;.scl      2;.type 32;.endef; \
283 REALNAME:
284
285 #define PROFCODE
286
287 #define EPILOGUE .end    REALNAME
288 #endif
289
290 #if defined(OS_LINUX) || defined(OS_FREEBSD) || defined(OS_NETBSD) || defined(__ELF__)
291 #define PROLOGUE \
292         .text; \
293         .align 16; \
294         .globl REALNAME ;\
295        .type REALNAME, @function; \
296 REALNAME:
297
298 #ifdef PROFILE
299 #define PROFCODE call mcount
300 #else
301 #define PROFCODE
302 #endif
303
304 #define EPILOGUE \
305         .size    REALNAME, .-REALNAME; \
306         .section .note.GNU-stack,"",%progbits
307
308 #endif
309
310 #ifdef XDOUBLE
311 #define FLD     fldt
312 #define FST     fstpt
313 #define FSTU    fstt
314 #define FMUL    fmult
315 #define FADD    faddt
316 #define FSUB    fsubt
317 #define FSUBR   fsubrt
318 #elif defined(DOUBLE)
319 #define FLD     fldl
320 #define FST     fstpl
321 #define FSTU    fstl
322 #define FMUL    fmull
323 #define FADD    faddl
324 #define FSUB    fsubl
325 #define FSUBR   fsubrl
326 #else
327 #define FLD     flds
328 #define FST     fstps
329 #define FSTU    fsts
330 #define FMUL    fmuls
331 #define FADD    fadds
332 #define FSUB    fsubs
333 #define FSUBR   fsubrs
334 #endif
335 #endif
336
337 #ifdef C_SUN
338 #define ffreep  fstp
339 #endif
340
341 #ifdef __APPLE__
342 #define ALIGN_2 .align 2
343 #define ALIGN_3 .align 3
344 #define ALIGN_4 .align 4
345 #define ALIGN_5 .align 5
346 #define ffreep  fstp
347 #endif
348
349 #ifndef ALIGN_2
350 #define ALIGN_2 .align 4
351 #endif
352
353 #ifndef ALIGN_3
354 #define ALIGN_3 .align 8
355 #endif
356
357 #ifndef ALIGN_4
358 #define ALIGN_4 .align 16
359 #endif
360
361 #ifndef ALIGN_5
362 #define ALIGN_5 .align 32
363 #endif
364
365 #ifndef ALIGN_6
366 #define ALIGN_6 .align 64
367 #endif
368 // ffreep %st(0). 
369 // Because Clang didn't support ffreep, we directly use the opcode.
370 // Please check out http://www.sandpile.org/x86/opc_fpu.htm 
371 #ifndef ffreep
372 #define ffreep .byte 0xdf, 0xc0 #
373 #endif