Avoid out of bounds reads from blas_quick_divide_table on big systems
[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   if (y > 64) return x/y;
200         
201   y = blas_quick_divide_table[y];
202
203   __asm__ __volatile__  ("mull %0" :"=d" (result) :"a"(x), "0" (y));
204
205   return result;
206 }
207 #endif
208 #endif
209
210 #endif
211
212 #ifndef PAGESIZE
213 #define PAGESIZE        ( 4 << 10)
214 #endif
215 #define HUGE_PAGESIZE   ( 2 << 20)
216
217 #define BUFFER_SIZE     (32 << 20)
218
219 #define SEEK_ADDRESS
220
221 #ifdef F_INTERFACE_G77
222 #define RETURN_BY_STACK
223 #define NEED_F2CCONV
224 #endif
225
226 #ifdef F_INTERFACE_G95
227 #define RETURN_BY_PACKED
228 #endif
229
230 #ifdef F_INTERFACE_GFORT
231 #ifdef OS_WINDOWS
232 #ifndef DOUBLE
233 #define RETURN_BY_REGS
234 #else
235 #define RETURN_BY_STACK
236 #endif
237 #else
238 #define RETURN_BY_PACKED
239 #endif
240 #endif
241
242 #ifdef F_INTERFACE_INTEL
243 #define RETURN_BY_STACK
244 #endif
245
246 #ifdef F_INTERFACE_FUJITSU
247 #define RETURN_BY_STACK
248 #endif
249
250 #ifdef F_INTERFACE_FLANG
251 #define RETURN_BY_STACK
252 #endif
253
254 #ifdef F_INTERFACE_PGI
255 #define RETURN_BY_STACK
256 #endif
257
258 #ifdef F_INTERFACE_PATHSCALE
259 #define RETURN_BY_PACKED
260 #endif
261
262 #ifdef F_INTERFACE_SUN
263 #define RETURN_BY_PACKED
264 #endif
265
266 #ifdef ASSEMBLER
267
268 #if defined(PILEDRIVER) || defined(BULLDOZER) || defined(STEAMROLLER) || defined(EXCAVATOR)
269 //Enable some optimazation for barcelona.
270 #define BARCELONA_OPTIMIZATION
271 #endif
272
273 #if defined(HAVE_3DNOW)
274 #define EMMS    femms
275 #elif defined(HAVE_MMX)
276 #define EMMS    emms
277 #endif
278
279 #ifndef EMMS
280 #define EMMS
281 #endif
282
283 #define BRANCH          .byte 0x3e
284 #define NOBRANCH        .byte 0x2e
285 #define PADDING         .byte 0x66
286
287 #ifdef OS_WINDOWS
288 #define ARG1    %rcx
289 #define ARG2    %rdx
290 #define ARG3    %r8
291 #define ARG4    %r9
292 #else
293 #define ARG1    %rdi
294 #define ARG2    %rsi
295 #define ARG3    %rdx
296 #define ARG4    %rcx
297 #define ARG5    %r8
298 #define ARG6    %r9
299 #endif
300
301 #ifndef COMPLEX
302 #ifdef XDOUBLE
303 #define LOCAL_BUFFER_SIZE  QLOCAL_BUFFER_SIZE
304 #elif defined DOUBLE
305 #define LOCAL_BUFFER_SIZE  DLOCAL_BUFFER_SIZE
306 #else
307 #define LOCAL_BUFFER_SIZE  SLOCAL_BUFFER_SIZE
308 #endif
309 #else
310 #ifdef XDOUBLE
311 #define LOCAL_BUFFER_SIZE  XLOCAL_BUFFER_SIZE
312 #elif defined DOUBLE
313 #define LOCAL_BUFFER_SIZE  ZLOCAL_BUFFER_SIZE
314 #else
315 #define LOCAL_BUFFER_SIZE  CLOCAL_BUFFER_SIZE
316 #endif
317 #endif
318
319 #if defined(OS_WINDOWS)
320 #if   LOCAL_BUFFER_SIZE > 16384
321 #define STACK_TOUCHING \
322         movl    $0,  4096 * 4(%rsp);\
323         movl    $0,  4096 * 3(%rsp);\
324         movl    $0,  4096 * 2(%rsp);\
325         movl    $0,  4096 * 1(%rsp);
326 #elif LOCAL_BUFFER_SIZE > 12288
327 #define STACK_TOUCHING \
328         movl    $0,  4096 * 3(%rsp);\
329         movl    $0,  4096 * 2(%rsp);\
330         movl    $0,  4096 * 1(%rsp);
331 #elif LOCAL_BUFFER_SIZE > 8192
332 #define STACK_TOUCHING \
333         movl    $0,  4096 * 2(%rsp);\
334         movl    $0,  4096 * 1(%rsp);
335 #elif LOCAL_BUFFER_SIZE > 4096
336 #define STACK_TOUCHING \
337         movl    $0,  4096 * 1(%rsp);
338 #else
339 #define STACK_TOUCHING
340 #endif
341 #else
342 #define STACK_TOUCHING
343 #endif
344
345 #if defined(CORE2)
346 #define movapd  movaps
347 #define andpd   andps
348 #define movlpd  movlps
349 #define movhpd  movhps
350 #endif
351
352 #ifndef F_INTERFACE
353 #define REALNAME ASMNAME
354 #else
355 #define REALNAME ASMFNAME
356 #endif
357
358 #ifdef OS_DARWIN
359 #define PROLOGUE .text;.align 5; .globl REALNAME; REALNAME:
360 #define EPILOGUE        .subsections_via_symbols
361 #define PROFCODE
362 #endif
363
364 #ifdef OS_WINDOWS
365 #define SAVEREGISTERS \
366         subq    $256, %rsp;\
367         movups  %xmm6,    0(%rsp);\
368         movups  %xmm7,   16(%rsp);\
369         movups  %xmm8,   32(%rsp);\
370         movups  %xmm9,   48(%rsp);\
371         movups  %xmm10,  64(%rsp);\
372         movups  %xmm11,  80(%rsp);\
373         movups  %xmm12,  96(%rsp);\
374         movups  %xmm13, 112(%rsp);\
375         movups  %xmm14, 128(%rsp);\
376         movups  %xmm15, 144(%rsp)
377
378 #define RESTOREREGISTERS \
379         movups     0(%rsp), %xmm6;\
380         movups    16(%rsp), %xmm7;\
381         movups    32(%rsp), %xmm8;\
382         movups    48(%rsp), %xmm9;\
383         movups    64(%rsp), %xmm10;\
384         movups    80(%rsp), %xmm11;\
385         movups    96(%rsp), %xmm12;\
386         movups   112(%rsp), %xmm13;\
387         movups   128(%rsp), %xmm14;\
388         movups   144(%rsp), %xmm15;\
389         addq    $256, %rsp
390 #else
391 #define SAVEREGISTERS
392 #define RESTOREREGISTERS
393 #endif
394
395 #if defined(OS_WINDOWS) && !defined(C_PGI)
396 #define PROLOGUE \
397         .text; \
398         .align 16; \
399         .globl REALNAME ;\
400         .def REALNAME;.scl      2;.type 32;.endef; \
401 REALNAME:
402
403 #define PROFCODE
404
405 #define EPILOGUE .end
406 #endif
407
408 #if defined(OS_LINUX) || defined(OS_FREEBSD) || defined(OS_NETBSD) || defined(__ELF__) || defined(C_PGI)
409 #define PROLOGUE \
410         .text; \
411         .align 512; \
412         .globl REALNAME ;\
413        .type REALNAME, @function; \
414 REALNAME:
415
416 #ifdef PROFILE
417 #define PROFCODE call *mcount@GOTPCREL(%rip)
418 #else
419 #define PROFCODE
420 #endif
421
422 #define EPILOGUE \
423         .size    REALNAME, .-REALNAME; \
424         .section .note.GNU-stack,"",@progbits
425
426
427 #endif
428
429 #endif
430
431 #ifdef XDOUBLE
432 #define FLD     fldt
433 #define FST     fstpt
434 #define MOVQ    movq
435 #elif defined(DOUBLE)
436 #define FLD     fldl
437 #define FST     fstpl
438 #define FSTU    fstl
439 #define FMUL    fmull
440 #define FADD    faddl
441 #define MOVSD   movsd
442 #define MULSD   mulsd
443 #define MULPD   mulpd
444 #define CMPEQPD cmpeqpd
445 #define COMISD  comisd
446 #define PSRLQ   psrlq
447 #define ANDPD   andpd
448 #define ADDPD   addpd
449 #define ADDSD   addsd
450 #define SUBPD   subpd
451 #define SUBSD   subsd
452 #define MOVQ    movq
453 #define MOVUPD  movupd
454 #define XORPD   xorpd
455 #else
456 #define FLD     flds
457 #define FST     fstps
458 #define FSTU    fsts
459 #define FMUL    fmuls
460 #define FADD    fadds
461 #define MOVSD   movss
462 #define MULSD   mulss
463 #define MULPD   mulps
464 #define CMPEQPD cmpeqps
465 #define COMISD  comiss
466 #define PSRLQ   psrld
467 #define ANDPD   andps
468 #define ADDPD   addps
469 #define ADDSD   addss
470 #define SUBPD   subps
471 #define SUBSD   subss
472 #define MOVQ    movd
473 #define MOVUPD  movups
474 #define XORPD   xorps
475 #endif
476
477 #define HALT    hlt
478
479 #ifdef OS_DARWIN
480 #define ALIGN_2 .align 2
481 #define ALIGN_3 .align 3
482 #define ALIGN_4 .align 4
483 #define ALIGN_5 .align 5
484 #define ffreep  fstp
485 #endif
486
487 #ifndef ALIGN_2
488 #define ALIGN_2 .align 4
489 #endif
490
491 #ifndef ALIGN_3
492 #define ALIGN_3 .align 8
493 #endif
494
495 #ifndef ALIGN_4
496 #define ALIGN_4 .align 16
497 #endif
498
499 #ifndef ALIGN_5
500 #define ALIGN_5 .align 32
501 #endif
502
503 #ifndef ALIGN_6
504 #define ALIGN_6 .align 64
505 #endif
506
507 // ffreep %st(0).
508 // Because Clang didn't support ffreep, we directly use the opcode.
509 // Please check out http://www.sandpile.org/x86/opc_fpu.htm
510 #ifndef ffreep
511 #define ffreep .byte 0xdf, 0xc0 #
512 #endif
513 #endif