Merge pull request #801 from Keno/patch-3
[platform/upstream/openblas.git] / common_x86_64.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 #ifdef C_MSVC
45 #include <intrin.h>
46 #endif
47
48 #ifdef C_SUN
49 #define __asm__ __asm
50 #define __volatile__
51 #endif
52
53 /*
54 #ifdef HAVE_SSE2
55 #define MB   __asm__ __volatile__ ("mfence");
56 #define WMB  __asm__ __volatile__ ("sfence");
57 #else
58 #define MB
59 #define WMB
60 #endif
61 */
62
63 #define MB
64 #define WMB
65
66 static void __inline blas_lock(volatile BLASULONG *address){
67
68 #ifndef C_MSVC
69   int ret;
70 #else
71   BLASULONG ret;
72 #endif
73
74   do {
75     while (*address) {YIELDING;};
76
77 #ifndef C_MSVC
78     __asm__ __volatile__(
79                          "xchgl %0, %1\n"
80                          : "=r"(ret), "=m"(*address)
81                          : "0"(1), "m"(*address)
82                          : "memory");
83 #else
84     ret=InterlockedExchange64((volatile LONG64 *)(address), 1);
85 #endif
86   } while (ret);
87
88 }
89 #define BLAS_LOCK_DEFINED
90
91 static __inline BLASULONG rpcc(void){
92 #ifdef C_MSVC
93   return __rdtsc();
94 #else
95   BLASULONG a, d;
96
97   __asm__ __volatile__ ("rdtsc" : "=a" (a), "=d" (d));
98
99   return ((BLASULONG)a + ((BLASULONG)d << 32));
100 #endif
101 }
102 #define RPCC_DEFINED
103
104 #define RPCC64BIT
105
106 #ifndef C_MSVC
107 static __inline BLASULONG getstackaddr(void){
108   BLASULONG addr;
109
110   __asm__ __volatile__ ("movq %%rsp, %0"
111                          : "=r"(addr) : : "memory");
112
113   return addr;
114 }
115 #endif
116
117 static __inline void cpuid(int op, int *eax, int *ebx, int *ecx, int *edx){
118
119 #ifdef C_MSVC
120   int cpuinfo[4];
121   __cpuid(cpuinfo, op);
122   *eax=cpuinfo[0];
123   *ebx=cpuinfo[1];
124   *ecx=cpuinfo[2];
125   *edx=cpuinfo[3];
126 #else
127         __asm__ __volatile__("cpuid"
128                              : "=a" (*eax),
129                              "=b" (*ebx),
130                              "=c" (*ecx),
131                              "=d" (*edx)
132                              : "0" (op));
133 #endif
134 }
135
136 /*
137 #define WHEREAMI
138 */
139
140 static __inline int WhereAmI(void){
141   int eax, ebx, ecx, edx;
142   int apicid;
143
144   cpuid(1, &eax, &ebx, &ecx, &edx);
145   apicid  = BITMASK(ebx, 24, 0xff);
146
147   return apicid;
148 }
149
150
151 #ifdef CORE_BARCELONA
152 #define IFLUSH          gotoblas_iflush()
153 #define IFLUSH_HALF     gotoblas_iflush_half()
154 #endif
155
156 #ifdef ENABLE_SSE_EXCEPTION
157
158 #define IDEBUG_START \
159 { \
160   unsigned int fp_sse_mode, new_fp_mode; \
161   __asm__ __volatile__ ("stmxcsr %0" : "=m" (fp_sse_mode) : ); \
162   new_fp_mode = fp_sse_mode & ~0xd00; \
163   __asm__ __volatile__ ("ldmxcsr %0" : : "m" (new_fp_mode) );
164
165 #define IDEBUG_END \
166   __asm__ __volatile__ ("ldmxcsr %0" : : "m" (fp_sse_mode) ); \
167 }
168
169 #endif
170
171 #ifdef XDOUBLE
172 #define GET_IMAGE(res)  __asm__ __volatile__("fstpt %0" : "=m"(res) : : "memory")
173 #elif defined(DOUBLE)
174 #define GET_IMAGE(res)  __asm__ __volatile__("movsd %%xmm1, %0" : "=m"(res) : : "memory")
175 #else
176 #define GET_IMAGE(res)  __asm__ __volatile__("movss %%xmm1, %0" : "=m"(res) : : "memory")
177 #endif
178
179 #define GET_IMAGE_CANCEL
180
181 #ifdef SMP
182 #if defined(USE64BITINT)
183 static __inline blasint blas_quickdivide(blasint x, blasint y){
184   return x / y;
185 }
186 #elif defined (C_MSVC)
187 static __inline BLASLONG blas_quickdivide(BLASLONG x, BLASLONG y){
188   return x / y;
189 }
190 #else
191 extern unsigned int blas_quick_divide_table[];
192
193 static __inline int blas_quickdivide(unsigned int x, unsigned int y){
194
195   unsigned int result;
196
197   if (y <= 1) return x;
198
199   y = blas_quick_divide_table[y];
200
201   __asm__ __volatile__  ("mull %0" :"=d" (result) :"a"(x), "0" (y));
202
203   return result;
204 }
205 #endif
206 #endif
207
208 #endif
209
210 #ifndef PAGESIZE
211 #define PAGESIZE        ( 4 << 10)
212 #endif
213 #define HUGE_PAGESIZE   ( 2 << 20)
214
215 #define BUFFER_SIZE     (32 << 20)
216
217 #define SEEK_ADDRESS
218
219 #ifdef F_INTERFACE_G77
220 #define RETURN_BY_STACK
221 #define NEED_F2CCONV
222 #endif
223
224 #ifdef F_INTERFACE_G95
225 #define RETURN_BY_PACKED
226 #endif
227
228 #ifdef F_INTERFACE_GFORT
229 #ifdef OS_WINDOWS
230 #ifndef DOUBLE
231 #define RETURN_BY_REGS
232 #else
233 #define RETURN_BY_STACK
234 #endif
235 #else
236 #define RETURN_BY_PACKED
237 #endif
238 #endif
239
240 #ifdef F_INTERFACE_INTEL
241 #define RETURN_BY_STACK
242 #endif
243
244 #ifdef F_INTERFACE_FUJITSU
245 #define RETURN_BY_STACK
246 #endif
247
248 #ifdef F_INTERFACE_PGI
249 #define RETURN_BY_STACK
250 #endif
251
252 #ifdef F_INTERFACE_PATHSCALE
253 #define RETURN_BY_PACKED
254 #endif
255
256 #ifdef F_INTERFACE_SUN
257 #define RETURN_BY_PACKED
258 #endif
259
260 #ifdef ASSEMBLER
261
262 #if defined(PILEDRIVER) || defined(BULLDOZER) || defined(STEAMROLLER) || defined(EXCAVATOR)
263 //Enable some optimazation for barcelona.
264 #define BARCELONA_OPTIMIZATION
265 #endif
266
267 #if defined(HAVE_3DNOW)
268 #define EMMS    femms
269 #elif defined(HAVE_MMX)
270 #define EMMS    emms
271 #endif
272
273 #ifndef EMMS
274 #define EMMS
275 #endif
276
277 #define BRANCH          .byte 0x3e
278 #define NOBRANCH        .byte 0x2e
279 #define PADDING         .byte 0x66
280
281 #ifdef OS_WINDOWS
282 #define ARG1    %rcx
283 #define ARG2    %rdx
284 #define ARG3    %r8
285 #define ARG4    %r9
286 #else
287 #define ARG1    %rdi
288 #define ARG2    %rsi
289 #define ARG3    %rdx
290 #define ARG4    %rcx
291 #define ARG5    %r8
292 #define ARG6    %r9
293 #endif
294
295 #ifndef COMPLEX
296 #ifdef XDOUBLE
297 #define LOCAL_BUFFER_SIZE  QLOCAL_BUFFER_SIZE
298 #elif defined DOUBLE
299 #define LOCAL_BUFFER_SIZE  DLOCAL_BUFFER_SIZE
300 #else
301 #define LOCAL_BUFFER_SIZE  SLOCAL_BUFFER_SIZE
302 #endif
303 #else
304 #ifdef XDOUBLE
305 #define LOCAL_BUFFER_SIZE  XLOCAL_BUFFER_SIZE
306 #elif defined DOUBLE
307 #define LOCAL_BUFFER_SIZE  ZLOCAL_BUFFER_SIZE
308 #else
309 #define LOCAL_BUFFER_SIZE  CLOCAL_BUFFER_SIZE
310 #endif
311 #endif
312
313 #if defined(OS_WINDOWS)
314 #if   LOCAL_BUFFER_SIZE > 16384
315 #define STACK_TOUCHING \
316         movl    $0,  4096 * 4(%rsp);\
317         movl    $0,  4096 * 3(%rsp);\
318         movl    $0,  4096 * 2(%rsp);\
319         movl    $0,  4096 * 1(%rsp);
320 #elif LOCAL_BUFFER_SIZE > 12288
321 #define STACK_TOUCHING \
322         movl    $0,  4096 * 3(%rsp);\
323         movl    $0,  4096 * 2(%rsp);\
324         movl    $0,  4096 * 1(%rsp);
325 #elif LOCAL_BUFFER_SIZE > 8192
326 #define STACK_TOUCHING \
327         movl    $0,  4096 * 2(%rsp);\
328         movl    $0,  4096 * 1(%rsp);
329 #elif LOCAL_BUFFER_SIZE > 4096
330 #define STACK_TOUCHING \
331         movl    $0,  4096 * 1(%rsp);
332 #else
333 #define STACK_TOUCHING
334 #endif
335 #else
336 #define STACK_TOUCHING
337 #endif
338
339 #if defined(CORE2)
340 #define movapd  movaps
341 #define andpd   andps
342 #define movlpd  movlps
343 #define movhpd  movhps
344 #endif
345
346 #ifndef F_INTERFACE
347 #define REALNAME ASMNAME
348 #else
349 #define REALNAME ASMFNAME
350 #endif
351
352 #ifdef OS_DARWIN
353 #define PROLOGUE .text;.align 5; .globl REALNAME; REALNAME:
354 #define EPILOGUE        .subsections_via_symbols
355 #define PROFCODE
356 #endif
357
358 #ifdef OS_WINDOWS
359 #define SAVEREGISTERS \
360         subq    $256, %rsp;\
361         movups  %xmm6,    0(%rsp);\
362         movups  %xmm7,   16(%rsp);\
363         movups  %xmm8,   32(%rsp);\
364         movups  %xmm9,   48(%rsp);\
365         movups  %xmm10,  64(%rsp);\
366         movups  %xmm11,  80(%rsp);\
367         movups  %xmm12,  96(%rsp);\
368         movups  %xmm13, 112(%rsp);\
369         movups  %xmm14, 128(%rsp);\
370         movups  %xmm15, 144(%rsp)
371
372 #define RESTOREREGISTERS \
373         movups     0(%rsp), %xmm6;\
374         movups    16(%rsp), %xmm7;\
375         movups    32(%rsp), %xmm8;\
376         movups    48(%rsp), %xmm9;\
377         movups    64(%rsp), %xmm10;\
378         movups    80(%rsp), %xmm11;\
379         movups    96(%rsp), %xmm12;\
380         movups   112(%rsp), %xmm13;\
381         movups   128(%rsp), %xmm14;\
382         movups   144(%rsp), %xmm15;\
383         addq    $256, %rsp
384 #else
385 #define SAVEREGISTERS
386 #define RESTOREREGISTERS
387 #endif
388
389 #if defined(OS_WINDOWS) && !defined(C_PGI)
390 #define PROLOGUE \
391         .text; \
392         .align 16; \
393         .globl REALNAME ;\
394         .def REALNAME;.scl      2;.type 32;.endef; \
395 REALNAME:
396
397 #define PROFCODE
398
399 #define EPILOGUE .end
400 #endif
401
402 #if defined(OS_LINUX) || defined(OS_FREEBSD) || defined(OS_NETBSD) || defined(__ELF__) || defined(C_PGI)
403 #define PROLOGUE \
404         .text; \
405         .align 512; \
406         .globl REALNAME ;\
407        .type REALNAME, @function; \
408 REALNAME:
409
410 #ifdef PROFILE
411 #define PROFCODE call *mcount@GOTPCREL(%rip)
412 #else
413 #define PROFCODE
414 #endif
415
416 #define EPILOGUE \
417         .size    REALNAME, .-REALNAME; \
418         .section .note.GNU-stack,"",@progbits
419
420
421 #endif
422
423 #endif
424
425 #ifdef XDOUBLE
426 #define FLD     fldt
427 #define FST     fstpt
428 #define MOVQ    movq
429 #elif defined(DOUBLE)
430 #define FLD     fldl
431 #define FST     fstpl
432 #define FSTU    fstl
433 #define FMUL    fmull
434 #define FADD    faddl
435 #define MOVSD   movsd
436 #define MULSD   mulsd
437 #define MULPD   mulpd
438 #define CMPEQPD cmpeqpd
439 #define COMISD  comisd
440 #define PSRLQ   psrlq
441 #define ANDPD   andpd
442 #define ADDPD   addpd
443 #define ADDSD   addsd
444 #define SUBPD   subpd
445 #define SUBSD   subsd
446 #define MOVQ    movq
447 #define MOVUPD  movupd
448 #define XORPD   xorpd
449 #else
450 #define FLD     flds
451 #define FST     fstps
452 #define FSTU    fsts
453 #define FMUL    fmuls
454 #define FADD    fadds
455 #define MOVSD   movss
456 #define MULSD   mulss
457 #define MULPD   mulps
458 #define CMPEQPD cmpeqps
459 #define COMISD  comiss
460 #define PSRLQ   psrld
461 #define ANDPD   andps
462 #define ADDPD   addps
463 #define ADDSD   addss
464 #define SUBPD   subps
465 #define SUBSD   subss
466 #define MOVQ    movd
467 #define MOVUPD  movups
468 #define XORPD   xorps
469 #endif
470
471 #define HALT    hlt
472
473 #ifdef OS_DARWIN
474 #define ALIGN_2 .align 2
475 #define ALIGN_3 .align 3
476 #define ALIGN_4 .align 4
477 #define ALIGN_5 .align 5
478 #define ffreep  fstp
479 #endif
480
481 #ifndef ALIGN_2
482 #define ALIGN_2 .align 4
483 #endif
484
485 #ifndef ALIGN_3
486 #define ALIGN_3 .align 8
487 #endif
488
489 #ifndef ALIGN_4
490 #define ALIGN_4 .align 16
491 #endif
492
493 #ifndef ALIGN_5
494 #define ALIGN_5 .align 32
495 #endif
496
497 #ifndef ALIGN_6
498 #define ALIGN_6 .align 64
499 #endif
500
501 // ffreep %st(0).
502 // Because Clang didn't support ffreep, we directly use the opcode.
503 // Please check out http://www.sandpile.org/x86/opc_fpu.htm
504 #ifndef ffreep
505 #define ffreep .byte 0xdf, 0xc0 #
506 #endif
507 #endif