1 /*********************************************************************/
2 /* Copyright 2009, 2010 The University of Texas at Austin. */
3 /* All rights reserved. */
5 /* Redistribution and use in source and binary forms, with or */
6 /* without modification, are permitted provided that the following */
7 /* conditions are met: */
9 /* 1. Redistributions of source code must retain the above */
10 /* copyright notice, this list of conditions and the following */
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. */
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. */
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 /*********************************************************************/
44 /* Assume C declarations for C++ */
45 #endif /* __cplusplus */
60 #include "config_kernel.h"
65 #undef ENABLE_SSE_EXCEPTION
67 #if defined(SMP_SERVER) || defined(SMP_ONDEMAND)
71 #if defined(OS_WINNT) || defined(OS_CYGWIN_NT) || defined(OS_INTERIX)
76 #define DOUBLE_DEFINED DOUBLE
81 #if !defined(NOINCLUDE) && !defined(ASSEMBLER)
86 #if !defined(_MSC_VER)
89 #define snprintf _snprintf
98 #if defined(OS_DARWIN) || defined(OS_FREEBSD) || defined(OS_NETBSD) || defined(OS_OPENBSD) || defined(OS_DRAGONFLY) || defined(OS_ANDROID)
104 //Android NDK only supports complex.h since Android 5.0
105 #if __ANDROID_API__ < 21
106 #define FORCE_OPENBLAS_COMPLEX_STRUCT
116 #define GOTO_ATOM ATOM
122 #define ATOM GOTO_ATOM
126 #include <sys/mman.h>
130 #include <sys/time.h>
134 #if defined(SMP) || defined(USE_LOCKING)
139 #if defined(OS_SUNOS)
145 #include <machine/builtins.h>
148 #if defined(ARCH_IA64) && defined(ENABLE_SSE_EXCEPTION)
154 #if defined(OS_WINDOWS) && defined(DOUBLE_DEFINED)
155 #define DOUBLE DOUBLE_DEFINED
156 #undef DOUBLE_DEFINED
162 #undef SMP_ALLOC_DEBUG
184 #define BITMASK(a, b, c) ((((a) >> (b)) & (c)))
186 #define ALLOCA_ALIGN 63UL
188 #define NUM_BUFFERS MAX(50,(MAX_CPU_NUMBER * 2 * MAX_PARALLEL_NUMBER))
190 #ifdef NEEDBUNDERSCORE
191 #define BLASFUNC(FUNC) FUNC##_
193 #define BLASFUNC(FUNC) FUNC
196 #undef USE_PTHREAD_LOCK
197 #undef USE_PTHREAD_SPINLOCK
199 #if defined(USE_PTHREAD_LOCK) && defined(USE_PTHREAD_SPINLOCK)
200 #error "You can't specify both LOCK operation!"
203 #if defined(SMP) || defined(USE_LOCKING)
204 #define USE_PTHREAD_LOCK
205 #undef USE_PTHREAD_SPINLOCK
209 #undef USE_PTHREAD_LOCK
210 #undef USE_PTHREAD_SPINLOCK
213 #if defined(USE_PTHREAD_LOCK)
214 #define LOCK_COMMAND(x) pthread_mutex_lock(x)
215 #define UNLOCK_COMMAND(x) pthread_mutex_unlock(x)
216 #elif defined(USE_PTHREAD_SPINLOCK)
218 typedef volatile int pthread_spinlock_t;
219 int pthread_spin_lock (pthread_spinlock_t *__lock);
220 int pthread_spin_unlock (pthread_spinlock_t *__lock);
222 #define LOCK_COMMAND(x) pthread_spin_lock(x)
223 #define UNLOCK_COMMAND(x) pthread_spin_unlock(x)
225 #define LOCK_COMMAND(x) blas_lock(x)
226 #define UNLOCK_COMMAND(x) blas_unlock(x)
229 #define GOTO_SHMID 0x510510
242 #ifdef QUAD_PRECISION
246 #elif defined EXPRECISION
247 #define xdouble long double
249 #define xdouble double
252 #if defined(OS_WINDOWS) && defined(__64BIT__)
253 typedef long long BLASLONG;
254 typedef unsigned long long BLASULONG;
256 typedef long BLASLONG;
257 typedef unsigned long BLASULONG;
262 typedef uint16_t bfloat16;
263 #define HALFCONVERSION 1
267 typedef BLASLONG blasint;
268 #if defined(OS_WINDOWS) && defined(__64BIT__)
269 #define blasabs(x) llabs(x)
271 #define blasabs(x) labs(x)
275 #define blasabs(x) abs(x)
288 #define FLOAT xdouble
289 #ifdef QUAD_PRECISION
290 #define XFLOAT xidouble
292 #ifdef QUAD_PRECISION
295 #define ZBASE_SHIFT 6
299 #define ZBASE_SHIFT 5
301 #elif defined(DOUBLE)
305 #define ZBASE_SHIFT 4
307 #define IFLOAT bfloat16
308 #define XFLOAT IFLOAT
312 #define ZBASE_SHIFT 2
317 #define ZBASE_SHIFT 3
335 #define Address_H(x) (((x)+(1<<15))>>16)
336 #define Address_L(x) ((x)-((Address_H(x))<<16))
338 #ifndef MAX_CPU_NUMBER
339 #define MAX_CPU_NUMBER 2
342 #if defined(OS_SUNOS)
343 #define YIELDING thr_yield()
346 #if defined(OS_WINDOWS)
347 #if defined(_MSC_VER) && !defined(__clang__)
348 #define YIELDING YieldProcessor()
350 #define YIELDING SwitchToThread()
354 #if defined(ARMV7) || defined(ARMV6) || defined(ARMV8) || defined(ARMV5)
355 #define YIELDING __asm__ __volatile__ ("nop;nop;nop;nop;nop;nop;nop;nop; \n");
360 #define YIELDING __asm__ __volatile__ ("nop;nop;nop;nop;nop;nop;nop;nop;\n");
365 #if defined(POWER8) || defined(POWER9) || defined(POWER10)
367 #define YIELDING __asm__ __volatile__ ("nop;nop;nop;nop;nop;nop;nop;nop;\n");
374 #define YIELDING __asm__ __volatile__ ("nop;nop;nop;nop;nop;nop;nop;nop;\n");
382 #define YIELDING __asm__ __volatile__ ("nop;nop;nop;nop;nop;nop;nop;nop;\n");
388 #define YIELDING sched_yield()
392 To alloc job_t on heap or statck.
393 please https://github.com/xianyi/OpenBLAS/issues/246
395 #if defined(OS_WINDOWS)
396 #define GETRF_MEM_ALLOC_THRESHOLD 32
397 #define BLAS3_MEM_ALLOC_THRESHOLD 32
400 #ifndef GETRF_MEM_ALLOC_THRESHOLD
401 #define GETRF_MEM_ALLOC_THRESHOLD 80
404 #ifndef BLAS3_MEM_ALLOC_THRESHOLD
405 #define BLAS3_MEM_ALLOC_THRESHOLD 32
408 #ifdef QUAD_PRECISION
409 #include "common_quad.h"
413 #include "common_alpha.h"
417 #include "common_x86.h"
421 #include "common_x86_64.h"
425 #include "common_ia64.h"
429 #include "common_power.h"
433 #include "common_sparc.h"
437 #include "common_mips.h"
441 #include "common_mips64.h"
445 #include "common_arm.h"
449 #include "common_arm64.h"
453 #include "common_zarch.h"
457 #ifdef OS_WINDOWSSTORE
458 typedef char env_var_t[MAX_PATH];
459 #define readenv(p, n) 0
461 #if defined(OS_WINDOWS) && !defined(OS_CYGWIN_NT)
462 typedef char env_var_t[MAX_PATH];
463 #define readenv(p, n) GetEnvironmentVariable((LPCTSTR)(n), (LPTSTR)(p), sizeof(p))
465 typedef char* env_var_t;
466 #define readenv(p, n) ((p)=getenv(n))
470 #if !defined(RPCC_DEFINED) && !defined(OS_WINDOWS)
471 #ifdef _POSIX_MONOTONIC_CLOCK
472 #if defined(__GLIBC_PREREQ) // cut the if condition if two lines, otherwise will fail at __GLIBC_PREREQ(2, 17)
473 #if __GLIBC_PREREQ(2, 17) // don't require -lrt
474 #define USE_MONOTONIC
476 #elif defined(OS_ANDROID)
477 #define USE_MONOTONIC
480 /* use similar scale as x86 rdtsc for timeouts to work correctly */
481 static inline unsigned long long rpcc(void){
484 clock_gettime(CLOCK_MONOTONIC, &ts);
485 return (unsigned long long)ts.tv_sec * 1000000000ull + ts.tv_nsec;
488 gettimeofday(&tv,NULL);
489 return (unsigned long long)tv.tv_sec * 1000000000ull + tv.tv_usec * 1000;
494 #endif // !RPCC_DEFINED
496 #if !defined(BLAS_LOCK_DEFINED) && defined(__GNUC__)
497 static void __inline blas_lock(volatile BLASULONG *address){
500 while (*address) {YIELDING;};
502 } while (!__sync_bool_compare_and_swap(address, 0, 1));
504 #define BLAS_LOCK_DEFINED
508 #error "rpcc() implementation is missing for your platform"
510 #ifndef BLAS_LOCK_DEFINED
511 #error "blas_lock() implementation is missing for your platform"
516 #include "common_linux.h"
519 #define MMAP_ACCESS (PROT_READ | PROT_WRITE)
522 #define MMAP_POLICY (MAP_PRIVATE | MAP_ANON)
524 #define MMAP_POLICY (MAP_PRIVATE | MAP_ANONYMOUS)
528 /* C99 supports complex floating numbers natively, which GCC also offers as an
529 extension since version 3.0. If neither are available, use a compatible
530 structure as fallback (see Clause 6.2.5.13 of the C99 standard). */
531 #if ((defined(__STDC_IEC_559_COMPLEX__) || __STDC_VERSION__ >= 199901L || \
532 (__GNUC__ >= 3 && !defined(__cplusplus))) && !(defined(FORCE_OPENBLAS_COMPLEX_STRUCT))) && !defined(_MSC_VER)
533 #define OPENBLAS_COMPLEX_C99
537 typedef float _Complex openblas_complex_float;
538 typedef double _Complex openblas_complex_double;
539 typedef xdouble _Complex openblas_complex_xdouble;
540 #define openblas_make_complex_float(real, imag) ((real) + ((imag) * _Complex_I))
541 #define openblas_make_complex_double(real, imag) ((real) + ((imag) * _Complex_I))
542 #define openblas_make_complex_xdouble(real, imag) ((real) + ((imag) * _Complex_I))
544 #define OPENBLAS_COMPLEX_STRUCT
545 typedef struct { float real, imag; } openblas_complex_float;
546 typedef struct { double real, imag; } openblas_complex_double;
547 typedef struct { xdouble real, imag; } openblas_complex_xdouble;
548 #define openblas_make_complex_float(real, imag) {(real), (imag)}
549 #define openblas_make_complex_double(real, imag) {(real), (imag)}
550 #define openblas_make_complex_xdouble(real, imag) {(real), (imag)}
555 #include "common_param.h"
558 #define STDERR stderr
562 #define MASK(a, b) (((a) + ((b) - 1)) & ~((b) - 1))
565 #if defined(XDOUBLE) || defined(DOUBLE)
566 #define FLOATRET FLOAT
569 #define FLOATRET double
571 #define FLOATRET float
577 /* Inclusion of a standard header file is needed for definition of __STDC_*
578 predefined macros with some compilers (e.g. GCC 4.7 on Linux). This occurs
579 as a side effect of including either <features.h> or <stdc-predef.h>. */
584 #define OPENBLAS_COMPLEX_FLOAT openblas_complex_xdouble
585 #define OPENBLAS_MAKE_COMPLEX_FLOAT(r,i) openblas_make_complex_xdouble(r,i)
586 #elif defined(DOUBLE)
587 #define OPENBLAS_COMPLEX_FLOAT openblas_complex_double
588 #define OPENBLAS_MAKE_COMPLEX_FLOAT(r,i) openblas_make_complex_double(r,i)
590 #define OPENBLAS_COMPLEX_FLOAT openblas_complex_float
591 #define OPENBLAS_MAKE_COMPLEX_FLOAT(r,i) openblas_make_complex_float(r,i)
594 #if defined(C_PGI) || defined(C_SUN)
595 #if defined(__STDC_IEC_559_COMPLEX__)
596 #define CREAL(X) creal(X)
597 #define CIMAG(X) cimag(X)
599 #define CREAL(X) (*((FLOAT *)&X + 0))
600 #define CIMAG(X) (*((FLOAT *)&X + 1))
603 #ifdef OPENBLAS_COMPLEX_STRUCT
604 #define CREAL(Z) ((Z).real)
605 #define CIMAG(Z) ((Z).imag)
607 #define CREAL __real__
608 #define CIMAG __imag__
622 #if defined(C_GCC) && (( __GNUC__ <= 3) || ((__GNUC__ == 4) && (__GNUC_MINOR__ < 2)))
629 #define inline __inline
635 #define MIN(a,b) (a>b? b:a)
639 #define MAX(a,b) (a<b? b:a)
642 #define TOUPPER(a) {if ((a) > 0x60) (a) -= 0x20;}
644 #if defined(__FreeBSD__) || defined(__APPLE__)
645 #define MAP_ANONYMOUS MAP_ANON
648 /* Common Memory Management Routine */
649 void blas_set_parameter(void);
650 int blas_get_cpu_number(void);
651 void *blas_memory_alloc (int);
652 void blas_memory_free (void *);
653 void *blas_memory_alloc_nolock (int); //use malloc without blas_lock
654 void blas_memory_free_nolock (void *);
656 int get_num_procs (void);
658 #if defined(OS_LINUX) && defined(SMP) && !defined(NO_AFFINITY)
659 int get_num_nodes (void);
660 int get_num_proc (int);
661 int get_node_equal (void);
664 void goto_set_num_threads(int);
666 void gotoblas_affinity_init(void);
667 void gotoblas_affinity_quit(void);
668 void gotoblas_dynamic_init(void);
669 void gotoblas_dynamic_quit(void);
670 void gotoblas_profile_init(void);
671 void gotoblas_profile_quit(void);
673 int support_avx512(void);
678 int omp_in_parallel(void);
679 int omp_get_num_procs(void);
681 __declspec(dllimport) int __cdecl omp_in_parallel(void);
682 __declspec(dllimport) int __cdecl omp_get_num_procs(void);
686 #if defined(C_GCC) && ( __GNUC__ < 7)
687 // workaround for GCC bug 65467
689 #define _Atomic volatile
692 #include <stdatomic.h>
695 #define _Atomic volatile
701 int omp_in_parallel (void) __attribute__ ((weak));
702 int omp_get_num_procs(void) __attribute__ ((weak));
706 static __inline void blas_unlock(volatile BLASULONG *address){
711 #ifdef OS_WINDOWSSTORE
712 static __inline int readenv_atoi(char *env) {
717 static __inline int readenv_atoi(char *env) {
719 return readenv(p,env) ? 0 : atoi(p);
722 static __inline int readenv_atoi(char *env) {
724 if (( p = getenv(env) ))
732 #if !defined(XDOUBLE) || !defined(QUAD_PRECISION)
734 static __inline void compinv(FLOAT *b, FLOAT ar, FLOAT ai){
741 (fabsl(ar)) >= (fabsl(ai))
743 (fabs (ar)) >= (fabs (ai))
745 (fabsf(ar)) >= (fabsf(ai))
749 den = (FLOAT)(ONE / (ar * (ONE + ratio * ratio)));
754 den = (FLOAT)(ONE /(ai * (ONE + ratio * ratio)));
769 void *blas_debug_alloc(int);
770 void *blas_debug_free(void *);
773 #define malloc(a) blas_debug_alloc(a)
774 #define free(a) blas_debug_free (a)
778 #define GEMMRETTYPE int
788 #define GEMMRETTYPE copyoverhead_t
793 #define KNAME(A, B) A
795 #define KNAME(A, B) A##B
798 #include "common_interface.h"
800 #include "common_reference.h"
802 #include "common_macro.h"
803 #include "common_level1.h"
804 #include "common_level2.h"
805 #include "common_level3.h"
806 #include "common_lapack.h"
809 # define OPENBLAS_CONST /* see comment in cblas.h */
814 #include "common_stackalloc.h"
819 #if defined(SMP_SERVER) && defined(SMP_ONDEMAND)
820 #error Both SMP_SERVER and SMP_ONDEMAND are specified.
823 #if defined(SMP_SERVER) || defined(SMP_ONDEMAND)
824 #include "common_thread.h"
831 #ifndef DEFAULT_CPU_NUMBER
832 #define DEFAULT_CPU_NUMBER 4
843 #if !defined(ASSEMBLER) && defined(FUNCTION_PROFILE)
847 unsigned long long calls, fops, area, cycles, tcycles;
850 extern func_profile_t function_profile_table[];
851 extern int gotoblas_profile;
854 #define NUMOPT QNUMOPT
856 #define NUMOPT DNUMOPT
858 #define NUMOPT SNUMOPT
861 #define FUNCTION_PROFILE_START() { unsigned long long profile_start = rpcc(), profile_end;
863 #define FUNCTION_PROFILE_END(COMP, AREA, OPS) \
864 if (gotoblas_profile) { \
865 profile_end = rpcc(); \
866 function_profile_table[PROFILE_FUNC_NAME].calls ++; \
867 function_profile_table[PROFILE_FUNC_NAME].area += SIZE * COMPSIZE * (AREA); \
868 function_profile_table[PROFILE_FUNC_NAME].fops += (COMP) * (OPS) / NUMOPT; \
869 function_profile_table[PROFILE_FUNC_NAME].cycles += (profile_end - profile_start); \
870 function_profile_table[PROFILE_FUNC_NAME].tcycles += blas_cpu_number * (profile_end - profile_start); \
874 #define FUNCTION_PROFILE_END(COMP, AREA, OPS) \
875 if (gotoblas_profile) { \
876 profile_end = rpcc(); \
877 function_profile_table[PROFILE_FUNC_NAME].calls ++; \
878 function_profile_table[PROFILE_FUNC_NAME].area += SIZE * COMPSIZE * (AREA); \
879 function_profile_table[PROFILE_FUNC_NAME].fops += (COMP) * (OPS) / NUMOPT; \
880 function_profile_table[PROFILE_FUNC_NAME].cycles += (profile_end - profile_start); \
881 function_profile_table[PROFILE_FUNC_NAME].tcycles += (profile_end - profile_start); \
887 #define FUNCTION_PROFILE_START()
888 #define FUNCTION_PROFILE_END(COMP, AREA, OPS)
892 #define PRINT_DEBUG_CNAME
893 #define PRINT_DEBUG_NAME
895 #define PRINT_DEBUG_CNAME if (readenv_atoi("GOTO_DEBUG")) fprintf(stderr, "GotoBLAS : %s\n", CHAR_CNAME)
896 #define PRINT_DEBUG_NAME if (readenv_atoi("GOTO_DEBUG")) fprintf(stderr, "GotoBLAS : %s\n", CHAR_NAME)
902 #endif /* __cplusplus */