FreeBSD: fix OS_FreeBSD -> OS_FREEBSD typos
[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(HAVE_3DNOW)
175 #define EMMS    femms
176 #elif defined(HAVE_MMX)
177 #define EMMS    emms
178 #endif
179
180 #ifndef EMMS
181 #define EMMS
182 #endif
183
184 #if defined(CORE2) || defined(PENTIUM4)
185 #define movapd  movaps
186 #endif
187
188 #define BRANCH          .byte 0x3e
189 #define NOBRANCH        .byte 0x2e
190 #define PADDING         .byte 0x66;
191 #define HALT            hlt
192
193 #ifndef COMPLEX
194 #ifdef XDOUBLE
195 #define LOCAL_BUFFER_SIZE  QLOCAL_BUFFER_SIZE
196 #elif defined DOUBLE
197 #define LOCAL_BUFFER_SIZE  DLOCAL_BUFFER_SIZE
198 #else
199 #define LOCAL_BUFFER_SIZE  SLOCAL_BUFFER_SIZE
200 #endif
201 #else
202 #ifdef XDOUBLE
203 #define LOCAL_BUFFER_SIZE  XLOCAL_BUFFER_SIZE
204 #elif defined DOUBLE
205 #define LOCAL_BUFFER_SIZE  ZLOCAL_BUFFER_SIZE
206 #else
207 #define LOCAL_BUFFER_SIZE  CLOCAL_BUFFER_SIZE
208 #endif
209 #endif
210
211 #if defined(OS_WINDOWS)
212 #if   LOCAL_BUFFER_SIZE > 16384
213 #define STACK_TOUCHING \
214         movl    $0,  4096 * 4(%esp);\
215         movl    $0,  4096 * 3(%esp);\
216         movl    $0,  4096 * 2(%esp);\
217         movl    $0,  4096 * 1(%esp);
218 #elif LOCAL_BUFFER_SIZE > 12288
219 #define STACK_TOUCHING \
220         movl    $0,  4096 * 3(%esp);\
221         movl    $0,  4096 * 2(%esp);\
222         movl    $0,  4096 * 1(%esp);
223 #elif LOCAL_BUFFER_SIZE > 8192
224 #define STACK_TOUCHING \
225         movl    $0,  4096 * 2(%esp);\
226         movl    $0,  4096 * 1(%esp);
227 #elif LOCAL_BUFFER_SIZE > 4096
228 #define STACK_TOUCHING \
229         movl    $0,  4096 * 1(%esp);
230 #else
231 #define STACK_TOUCHING
232 #endif
233 #else
234 #define STACK_TOUCHING
235 #endif
236
237 #ifndef F_INTERFACE
238 #define REALNAME ASMNAME
239 #else
240 #define REALNAME ASMFNAME
241 #endif
242
243 #if defined(F_INTERFACE_PATHSCALE) || defined(F_INTERFACE_OPEN64)
244 #define RETURN_BY_STRUCT
245 #elif defined(F_INTERFACE_GFORT) || defined(F_INTERFACE_G95)
246 #define RETURN_BY_COMPLEX
247 #else
248 #define RETURN_BY_STACK
249 #endif
250
251 #ifdef OS_DARWIN
252 #define PROLOGUE .text;.align 5; .globl REALNAME; REALNAME:
253 #define EPILOGUE        .subsections_via_symbols
254 #define PROFCODE
255 #endif
256
257 #if defined(OS_WINNT) || defined(OS_CYGWIN_NT) || defined(OS_INERIX)
258 #define SAVEREGISTERS \
259         subl    $32, %esp;\
260         movups  %xmm6,    0(%esp);\
261         movups  %xmm7,   16(%esp)
262
263 #define RESTOREREGISTERS \
264         movups     0(%esp), %xmm6;\
265         movups    16(%esp), %xmm7;\
266         addl    $32, %esp
267 #else
268 #define SAVEREGISTERS
269 #define RESTOREREGISTERS
270 #endif
271
272 #if defined(OS_WINNT) || defined(OS_CYGWIN_NT) || defined(OS_INERIX)
273 #define PROLOGUE \
274         .text; \
275         .align 16; \
276         .globl REALNAME ;\
277         .def REALNAME;.scl      2;.type 32;.endef; \
278 REALNAME:
279
280 #define PROFCODE
281
282 #define EPILOGUE .end    REALNAME
283 #endif
284
285 #if defined(OS_LINUX) || defined(OS_FREEBSD) || defined(OS_NetBSD) || defined(__ELF__)
286 #define PROLOGUE \
287         .text; \
288         .align 16; \
289         .globl REALNAME ;\
290        .type REALNAME, @function; \
291 REALNAME:
292
293 #ifdef PROFILE
294 #define PROFCODE call mcount
295 #else
296 #define PROFCODE
297 #endif
298
299 #define EPILOGUE .size   REALNAME, .-REALNAME
300
301 #endif
302
303 #ifdef XDOUBLE
304 #define FLD     fldt
305 #define FST     fstpt
306 #define FSTU    fstt
307 #define FMUL    fmult
308 #define FADD    faddt
309 #define FSUB    fsubt
310 #define FSUBR   fsubrt
311 #elif defined(DOUBLE)
312 #define FLD     fldl
313 #define FST     fstpl
314 #define FSTU    fstl
315 #define FMUL    fmull
316 #define FADD    faddl
317 #define FSUB    fsubl
318 #define FSUBR   fsubrl
319 #else
320 #define FLD     flds
321 #define FST     fstps
322 #define FSTU    fsts
323 #define FMUL    fmuls
324 #define FADD    fadds
325 #define FSUB    fsubs
326 #define FSUBR   fsubrs
327 #endif
328 #endif
329
330 #ifdef C_SUN
331 #define ffreep  fstp
332 #endif
333
334 #ifdef __APPLE__
335 #define ALIGN_2 .align 2
336 #define ALIGN_3 .align 3
337 #define ALIGN_4 .align 4
338 #define ffreep  fstp
339 #endif
340
341 #ifndef ALIGN_2
342 #define ALIGN_2 .align 4
343 #endif
344
345 #ifndef ALIGN_3
346 #define ALIGN_3 .align 8
347 #endif
348
349 #ifndef ALIGN_4
350 #define ALIGN_4 .align 16
351 #endif
352
353 #ifndef ALIGN_5
354 #define ALIGN_5 .align 32
355 #endif
356
357 #ifndef ALIGN_6
358 #define ALIGN_6 .align 64
359 #endif