e7c2c964fcb22f3f9aed3ab19999cda461a74808
[stockfish] / src / Makefile
1 # Stockfish, a UCI chess playing engine derived from Glaurung 2.1
2 # Copyright (C) 2004-2008 Tord Romstad (Glaurung author)
3 # Copyright (C) 2008-2015 Marco Costalba, Joona Kiiski, Tord Romstad
4 # Copyright (C) 2015-2016 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
5 #
6 # Stockfish is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # Stockfish is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
20 ### ==========================================================================
21 ### Section 1. General Configuration
22 ### ==========================================================================
23
24 ### Establish the operating system name
25 KERNEL = $(shell uname -s)
26 ifeq ($(KERNEL),Linux)
27         OS = $(shell uname -o)
28 endif
29
30 ### Executable name
31 EXE = stockfish
32
33 ### Installation dir definitions
34 PREFIX = /usr/local
35 BINDIR = $(PREFIX)/bin
36
37 ### Built-in benchmark for pgo-builds
38 PGOBENCH = ./$(EXE) bench
39
40 ### Object files
41 OBJS = benchmark.o bitbase.o bitboard.o endgame.o evaluate.o main.o \
42         material.o misc.o movegen.o movepick.o pawns.o position.o psqt.o \
43         search.o thread.o timeman.o tt.o uci.o ucioption.o syzygy/tbprobe.o
44
45 ### ==========================================================================
46 ### Section 2. High-level Configuration
47 ### ==========================================================================
48 #
49 # flag                --- Comp switch --- Description
50 # ----------------------------------------------------------------------------
51 #
52 # debug = yes/no      --- -DNDEBUG         --- Enable/Disable debug mode
53 # sanitize = yes/no   --- (-fsanitize )    --- enable undefined behavior checks
54 # optimize = yes/no   --- (-O3/-fast etc.) --- Enable/Disable optimizations
55 # arch = (name)       --- (-arch)          --- Target architecture
56 # bits = 64/32        --- -DIS_64BIT       --- 64-/32-bit operating system
57 # prefetch = yes/no   --- -DUSE_PREFETCH   --- Use prefetch asm-instruction
58 # popcnt = yes/no     --- -DUSE_POPCNT     --- Use popcnt asm-instruction
59 # sse = yes/no        --- -msse            --- Use Intel Streaming SIMD Extensions
60 # pext = yes/no       --- -DUSE_PEXT       --- Use pext x86_64 asm-instruction
61 #
62 # Note that Makefile is space sensitive, so when adding new architectures
63 # or modifying existing flags, you have to make sure there are no extra spaces
64 # at the end of the line for flag values.
65
66 ### 2.1. General and architecture defaults
67 optimize = yes
68 debug = no
69 sanitize = no
70 bits = 32
71 prefetch = no
72 popcnt = no
73 sse = no
74 pext = no
75
76 ### 2.2 Architecture specific
77
78 ifeq ($(ARCH),general-32)
79         arch = any
80 endif
81
82 ifeq ($(ARCH),x86-32-old)
83         arch = i386
84 endif
85
86 ifeq ($(ARCH),x86-32)
87         arch = i386
88         prefetch = yes
89         sse = yes
90 endif
91
92 ifeq ($(ARCH),general-64)
93         arch = any
94         bits = 64
95 endif
96
97 ifeq ($(ARCH),x86-64)
98         arch = x86_64
99         bits = 64
100         prefetch = yes
101         sse = yes
102 endif
103
104 ifeq ($(ARCH),x86-64-modern)
105         arch = x86_64
106         bits = 64
107         prefetch = yes
108         popcnt = yes
109         sse = yes
110 endif
111
112 ifeq ($(ARCH),x86-64-bmi2)
113         arch = x86_64
114         bits = 64
115         prefetch = yes
116         popcnt = yes
117         sse = yes
118         pext = yes
119 endif
120
121 ifeq ($(ARCH),armv7)
122         arch = armv7
123         prefetch = yes
124 endif
125
126 ifeq ($(ARCH),ppc-32)
127         arch = ppc
128 endif
129
130 ifeq ($(ARCH),ppc-64)
131         arch = ppc64
132         bits = 64
133 endif
134
135
136 ### ==========================================================================
137 ### Section 3. Low-level configuration
138 ### ==========================================================================
139
140 ### 3.1 Selecting compiler (default = gcc)
141
142 CXXFLAGS += -Wall -Wcast-qual -fno-exceptions -fno-rtti -std=c++11 $(EXTRACXXFLAGS)
143 DEPENDFLAGS += -std=c++11
144 LDFLAGS += $(EXTRALDFLAGS)
145
146 ifeq ($(COMP),)
147         COMP=gcc
148 endif
149
150 ifeq ($(COMP),gcc)
151         comp=gcc
152         CXX=g++
153         CXXFLAGS += -pedantic -Wextra -Wshadow
154
155         ifeq ($(ARCH),armv7)
156                 ifeq ($(OS),Android)
157                         CXXFLAGS += -m$(bits)
158                 endif
159         else
160                 CXXFLAGS += -m$(bits)
161         endif
162
163         ifneq ($(KERNEL),Darwin)
164            LDFLAGS += -Wl,--no-as-needed
165         endif
166 endif
167
168 ifeq ($(COMP),mingw)
169         comp=mingw
170
171         ifeq ($(KERNEL),Linux)
172                 ifeq ($(bits),64)
173                         ifeq ($(shell which x86_64-w64-mingw32-c++-posix),)
174                                 CXX=x86_64-w64-mingw32-c++
175                         else
176                                 CXX=x86_64-w64-mingw32-c++-posix
177                         endif
178                 else
179                         ifeq ($(shell which i686-w64-mingw32-c++-posix),)
180                                 CXX=i686-w64-mingw32-c++
181                         else
182                                 CXX=i686-w64-mingw32-c++-posix
183                         endif
184                 endif
185         else
186                 CXX=g++
187         endif
188
189         CXXFLAGS += -Wextra -Wshadow
190         LDFLAGS += -static
191 endif
192
193 ifeq ($(COMP),icc)
194         comp=icc
195         CXX=icpc
196         CXXFLAGS += -diag-disable 1476,10120 -Wcheck -Wabi -Wdeprecated -strict-ansi
197 endif
198
199 ifeq ($(COMP),clang)
200         comp=clang
201         CXX=clang++
202         CXXFLAGS += -pedantic -Wextra -Wshadow
203
204         ifeq ($(ARCH),armv7)
205                 ifeq ($(OS),Android)
206                         CXXFLAGS += -m$(bits)
207                         LDFLAGS += -m$(bits)
208                 endif
209         else
210                 CXXFLAGS += -m$(bits)
211                 LDFLAGS += -m$(bits)
212         endif
213 endif
214
215 ifeq ($(comp),icc)
216         profile_make = icc-profile-make
217         profile_use = icc-profile-use
218 else
219         profile_make = gcc-profile-make
220         profile_use = gcc-profile-use
221 endif
222
223 ifeq ($(KERNEL),Darwin)
224         CXXFLAGS += -arch $(arch) -mmacosx-version-min=10.9
225         LDFLAGS += -arch $(arch) -mmacosx-version-min=10.9
226 endif
227
228 ### Travis CI script uses COMPILER to overwrite CXX
229 ifdef COMPILER
230         COMPCXX=$(COMPILER)
231 endif
232
233 ### Allow overwriting CXX from command line
234 ifdef COMPCXX
235         CXX=$(COMPCXX)
236 endif
237
238 ### On mingw use Windows threads, otherwise POSIX
239 ifneq ($(comp),mingw)
240         # On Android Bionic's C library comes with its own pthread implementation bundled in
241         ifneq ($(OS),Android)
242                 # Haiku has pthreads in its libroot, so only link it in on other platforms
243                 ifneq ($(KERNEL),Haiku)
244                         LDFLAGS += -lpthread
245                 endif
246         endif
247 endif
248
249 ### 3.2.1 Debugging
250 ifeq ($(debug),no)
251         CXXFLAGS += -DNDEBUG
252 else
253         CXXFLAGS += -g
254 endif
255
256 ### 3.2.2 Debugging with undefined behavior sanitizers
257 ifeq ($(sanitize),yes)
258         CXXFLAGS += -g3 -fsanitize=undefined
259         LDFLAGS += -fsanitize=undefined
260 endif
261
262 ### 3.3 Optimization
263 ifeq ($(optimize),yes)
264
265         CXXFLAGS += -O3
266
267         ifeq ($(comp),gcc)
268
269                 ifeq ($(KERNEL),Darwin)
270                         ifeq ($(arch),i386)
271                                 CXXFLAGS += -mdynamic-no-pic
272                         endif
273                         ifeq ($(arch),x86_64)
274                                 CXXFLAGS += -mdynamic-no-pic
275                         endif
276                 endif
277
278                 ifeq ($(OS), Android)
279                         CXXFLAGS += -fno-gcse -mthumb -march=armv7-a -mfloat-abi=softfp
280                 endif
281         endif
282
283         ifeq ($(comp),icc)
284                 ifeq ($(KERNEL),Darwin)
285                         CXXFLAGS += -mdynamic-no-pic
286                 endif
287         endif
288
289         ifeq ($(comp),clang)
290                 ifeq ($(KERNEL),Darwin)
291                                 CXXFLAGS += -flto
292                                 LDFLAGS += $(CXXFLAGS)
293                         ifeq ($(arch),i386)
294                                 CXXFLAGS += -mdynamic-no-pic
295                         endif
296                         ifeq ($(arch),x86_64)
297                                 CXXFLAGS += -mdynamic-no-pic
298                         endif
299                 endif
300         endif
301 endif
302
303 ### 3.4 Bits
304 ifeq ($(bits),64)
305         CXXFLAGS += -DIS_64BIT
306 endif
307
308 ### 3.5 prefetch
309 ifeq ($(prefetch),yes)
310         ifeq ($(sse),yes)
311                 CXXFLAGS += -msse
312                 DEPENDFLAGS += -msse
313         endif
314 else
315         CXXFLAGS += -DNO_PREFETCH
316 endif
317
318 ### 3.6 popcnt
319 ifeq ($(popcnt),yes)
320         ifeq ($(comp),icc)
321                 CXXFLAGS += -msse3 -DUSE_POPCNT
322         else
323                 CXXFLAGS += -msse3 -mpopcnt -DUSE_POPCNT
324         endif
325 endif
326
327 ### 3.7 pext
328 ifeq ($(pext),yes)
329         CXXFLAGS += -DUSE_PEXT
330         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
331                 CXXFLAGS += -mbmi2
332         endif
333 endif
334
335 ### 3.8 Link Time Optimization, it works since gcc 4.5 but not on mingw under Windows.
336 ### This is a mix of compile and link time options because the lto link phase
337 ### needs access to the optimization flags.
338 ifeq ($(comp),gcc)
339         ifeq ($(optimize),yes)
340         ifeq ($(debug),no)
341                 CXXFLAGS += -flto
342                 LDFLAGS += $(CXXFLAGS)
343         endif
344         endif
345 endif
346
347 ifeq ($(comp),mingw)
348         ifeq ($(KERNEL),Linux)
349         ifeq ($(optimize),yes)
350         ifeq ($(debug),no)
351                 CXXFLAGS += -flto
352                 LDFLAGS += $(CXXFLAGS)
353         endif
354         endif
355         endif
356 endif
357
358 ### 3.9 Android 5 can only run position independent executables. Note that this
359 ### breaks Android 4.0 and earlier.
360 ifeq ($(OS), Android)
361         CXXFLAGS += -fPIE
362         LDFLAGS += -fPIE -pie
363 endif
364
365
366 ### ==========================================================================
367 ### Section 4. Public targets
368 ### ==========================================================================
369
370 help:
371         @echo ""
372         @echo "To compile stockfish, type: "
373         @echo ""
374         @echo "make target ARCH=arch [COMP=compiler] [COMPCXX=cxx]"
375         @echo ""
376         @echo "Supported targets:"
377         @echo ""
378         @echo "build                   > Standard build"
379         @echo "profile-build           > PGO build"
380         @echo "strip                   > Strip executable"
381         @echo "install                 > Install executable"
382         @echo "clean                   > Clean up"
383         @echo ""
384         @echo "Supported archs:"
385         @echo ""
386         @echo "x86-64                  > x86 64-bit"
387         @echo "x86-64-modern           > x86 64-bit with popcnt support"
388         @echo "x86-64-bmi2             > x86 64-bit with pext support"
389         @echo "x86-32                  > x86 32-bit with SSE support"
390         @echo "x86-32-old              > x86 32-bit fall back for old hardware"
391         @echo "ppc-64                  > PPC 64-bit"
392         @echo "ppc-32                  > PPC 32-bit"
393         @echo "armv7                   > ARMv7 32-bit"
394         @echo "general-64              > unspecified 64-bit"
395         @echo "general-32              > unspecified 32-bit"
396         @echo ""
397         @echo "Supported compilers:"
398         @echo ""
399         @echo "gcc                     > Gnu compiler (default)"
400         @echo "mingw                   > Gnu compiler with MinGW under Windows"
401         @echo "clang                   > LLVM Clang compiler"
402         @echo "icc                     > Intel compiler"
403         @echo ""
404         @echo "Simple examples. If you don't know what to do, you likely want to run: "
405         @echo ""
406         @echo "make build ARCH=x86-64    (This is for 64-bit systems)"
407         @echo "make build ARCH=x86-32    (This is for 32-bit systems)"
408         @echo ""
409         @echo "Advanced examples, for experienced users: "
410         @echo ""
411         @echo "make build ARCH=x86-64 COMP=clang"
412         @echo "make profile-build ARCH=x86-64-modern COMP=gcc COMPCXX=g++-4.8"
413         @echo ""
414
415
416 .PHONY: help build profile-build strip install clean objclean profileclean help \
417         config-sanity icc-profile-use icc-profile-make gcc-profile-use gcc-profile-make
418
419 build: config-sanity
420         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) all
421
422 profile-build: config-sanity objclean profileclean
423         @echo ""
424         @echo "Step 1/4. Building instrumented executable ..."
425         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) $(profile_make)
426         @echo ""
427         @echo "Step 2/4. Running benchmark for pgo-build ..."
428         $(PGOBENCH) > /dev/null
429         @echo ""
430         @echo "Step 3/4. Building optimized executable ..."
431         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) objclean
432         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) $(profile_use)
433         @echo ""
434         @echo "Step 4/4. Deleting profile data ..."
435         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) profileclean
436
437 strip:
438         strip $(EXE)
439
440 install:
441         -mkdir -p -m 755 $(BINDIR)
442         -cp $(EXE) $(BINDIR)
443         -strip $(BINDIR)/$(EXE)
444
445 #clean all
446 clean: objclean profileclean
447         @rm -f .depend *~ core 
448
449 # clean binaries and objects
450 objclean:
451         @rm -f $(EXE) $(EXE).exe *.o ./syzygy/*.o
452
453 # clean auxiliary profiling files
454 profileclean:
455         @rm -rf profdir
456         @rm -f bench.txt *.gcda ./syzygy/*.gcda *.gcno ./syzygy/*.gcno
457
458 default:
459         help
460
461 ### ==========================================================================
462 ### Section 5. Private targets
463 ### ==========================================================================
464
465 all: $(EXE) .depend
466
467 config-sanity:
468         @echo ""
469         @echo "Config:"
470         @echo "debug: '$(debug)'"
471         @echo "sanitize: '$(sanitize)'"
472         @echo "optimize: '$(optimize)'"
473         @echo "arch: '$(arch)'"
474         @echo "bits: '$(bits)'"
475         @echo "kernel: '$(KERNEL)'"
476         @echo "os: '$(OS)'"
477         @echo "prefetch: '$(prefetch)'"
478         @echo "popcnt: '$(popcnt)'"
479         @echo "sse: '$(sse)'"
480         @echo "pext: '$(pext)'"
481         @echo ""
482         @echo "Flags:"
483         @echo "CXX: $(CXX)"
484         @echo "CXXFLAGS: $(CXXFLAGS)"
485         @echo "LDFLAGS: $(LDFLAGS)"
486         @echo ""
487         @echo "Testing config sanity. If this fails, try 'make help' ..."
488         @echo ""
489         @test "$(debug)" = "yes" || test "$(debug)" = "no"
490         @test "$(sanitize)" = "yes" || test "$(sanitize)" = "no"
491         @test "$(optimize)" = "yes" || test "$(optimize)" = "no"
492         @test "$(arch)" = "any" || test "$(arch)" = "x86_64" || test "$(arch)" = "i386" || \
493          test "$(arch)" = "ppc64" || test "$(arch)" = "ppc" || test "$(arch)" = "armv7"
494         @test "$(bits)" = "32" || test "$(bits)" = "64"
495         @test "$(prefetch)" = "yes" || test "$(prefetch)" = "no"
496         @test "$(popcnt)" = "yes" || test "$(popcnt)" = "no"
497         @test "$(sse)" = "yes" || test "$(sse)" = "no"
498         @test "$(pext)" = "yes" || test "$(pext)" = "no"
499         @test "$(comp)" = "gcc" || test "$(comp)" = "icc" || test "$(comp)" = "mingw" || test "$(comp)" = "clang"
500
501 $(EXE): $(OBJS)
502         $(CXX) -o $@ $(OBJS) $(LDFLAGS)
503
504 gcc-profile-make:
505         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
506         EXTRACXXFLAGS='-fprofile-generate' \
507         EXTRALDFLAGS='-lgcov' \
508         all
509
510 gcc-profile-use:
511         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
512         EXTRACXXFLAGS='-fprofile-use -fno-peel-loops -fno-tracer' \
513         EXTRALDFLAGS='-lgcov' \
514         all
515
516 icc-profile-make:
517         @mkdir -p profdir
518         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
519         EXTRACXXFLAGS='-prof-gen=srcpos -prof_dir ./profdir' \
520         all
521
522 icc-profile-use:
523         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
524         EXTRACXXFLAGS='-prof_use -prof_dir ./profdir' \
525         all
526
527 .depend:
528         -@$(CXX) $(DEPENDFLAGS) -MM $(OBJS:.o=.cpp) > $@ 2> /dev/null
529
530 -include .depend
531