fix build error
[platform/upstream/openblas.git] / GotoBLAS_02QuickInstall.txt
1                 Quick installation for GotoBLAS2
2
3 ***************************************************************************
4 ***************************************************************************
5 **                                                                       **
6 **                                                                       **
7 **                    Just type "make" <<return>>.                       **
8 **                                                                       **
9 **           If you're not satisfied with this library,                  **
10 **           please read following instruction and customize it.         **
11 **                                                                       **
12 **                                                                       **
13 ***************************************************************************
14 ***************************************************************************
15
16
17 1. REALLY REALLY quick way to build library
18
19     Type "make" or "gmake".
20
21    $shell> make
22
23    The script will detect Fortran compiler, number of cores and
24    architecture which you're using. If default gcc binary type is
25    64bit, 64 bit library will be created. Otherwise 32 bit library
26    will be created.
27
28    After finishing compile, you'll find various information about
29    generated library.
30
31  =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
32
33  GotoBLAS2 build complete.
34
35   OS               ... Linux
36   Architecture     ... x86_64
37   BINARY           ... 64bit
38   C compiler       ... GCC  (command line : gcc)
39   Fortran compiler ... PATHSCALE  (command line : pathf90)
40   Library Name     ... libgoto_barcelonap-r1.27.a (Multi threaded; Max
41   num-threads is 16)
42
43  =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
44
45
46 2. Specifying 32bit or 64bit library
47
48    If you need 32bit binary,
49
50    $shell> make BINARY=32
51
52    If you need 64bit binary,
53
54    $shell> make BINARY=64
55
56
57 3. Specifying target architecture
58
59    If you need library for different architecture, you can use TARGET
60    option. You can find current available options in top of getarch.c.
61    For example, if you need library for Intel core2 architecture,
62    you'll find FORCE_CORE2 option in getarch.c. Therefore you can
63    specify TARGET=CORE2 (get rid of FORCE_) with make.
64
65    $shell> make TARGET=CORE2
66
67    Also if you want GotoBLAS2 to support multiple architecture,
68
69    $shell> make DYNAMIC_ARCH=1
70
71    All kernel will be included in the library and dynamically switched
72    the best architecutre at run time.
73
74
75 4. Specifying for enabling multi-threaded
76
77    Script will detect number of cores and will enable multi threaded
78    library if number of cores is more than two. If you still want to
79    create single threaded library,
80
81    $shell> make USE_THREAD=0
82
83    Or if you need threaded library by force,
84
85    $shell> make USE_THREAD=1
86
87
88 5. Specifying target OS
89
90    Target architecture will be determined by the CC. If you
91    specify cross compiler for MIPS, you can create library for
92    MIPS architecture.
93
94    $shell> make CC=mips64el-linux-gcc TARGET=SICORTEX
95
96    Or you can specify your favorite C compiler with absolute path.
97
98    $shell> make CC=/opt/intel/cc/32/10.0.026/bin/icc TARGET=BARCELONA
99
100    Binary type (32bit/64bit) is determined by checking CC, you
101    can control binary type with this option.
102
103    $shell> make CC="pathcc -m32"
104
105    In this case, 32bit library will be created.
106
107
108 6. Specifying Fortran compiler
109
110    If you need to support other Fortran compiler, you can specify with
111    FC option.
112
113    $shell> make FC=gfortran
114
115
116 7. Other useful options
117
118    You'll find other useful options in Makefile.rule.