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-2019 Marco Costalba, Joona Kiiski, Gary Linscott, Tord Romstad
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.
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.
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/>.
20 ### ==========================================================================
21 ### Section 1. General Configuration
22 ### ==========================================================================
31 ### Installation dir definitions
33 BINDIR = $(PREFIX)/bin
35 ### Built-in benchmark for pgo-builds
36 PGOBENCH = ./$(EXE) bench
38 ### Source and object files
39 SRCS = benchmark.cpp bitbase.cpp bitboard.cpp endgame.cpp evaluate.cpp main.cpp \
40 material.cpp misc.cpp movegen.cpp movepick.cpp pawns.cpp position.cpp psqt.cpp \
41 search.cpp thread.cpp timeman.cpp tt.cpp uci.cpp ucioption.cpp tune.cpp syzygy/tbprobe.cpp \
42 nnue/evaluate_nnue.cpp nnue/features/half_kp.cpp
44 OBJS = $(notdir $(SRCS:.cpp=.o))
46 VPATH = syzygy:nnue:nnue/features
48 ### Establish the operating system name
49 KERNEL = $(shell uname -s)
50 ifeq ($(KERNEL),Linux)
51 OS = $(shell uname -o)
54 ### ==========================================================================
55 ### Section 2. High-level Configuration
56 ### ==========================================================================
58 # flag --- Comp switch --- Description
59 # ----------------------------------------------------------------------------
61 # debug = yes/no --- -DNDEBUG --- Enable/Disable debug mode
62 # sanitize = undefined/thread/no (-fsanitize )
63 # --- ( undefined ) --- enable undefined behavior checks
64 # --- ( thread ) --- enable threading error checks
65 # optimize = yes/no --- (-O3/-fast etc.) --- Enable/Disable optimizations
66 # arch = (name) --- (-arch) --- Target architecture
67 # bits = 64/32 --- -DIS_64BIT --- 64-/32-bit operating system
68 # prefetch = yes/no --- -DUSE_PREFETCH --- Use prefetch asm-instruction
69 # popcnt = yes/no --- -DUSE_POPCNT --- Use popcnt asm-instruction
70 # sse = yes/no --- -msse --- Use Intel Streaming SIMD Extensions
71 # ssse3 = yes/no --- -mssse3 --- Use Intel Supplemental Streaming SIMD Extensions 3
72 # sse41 = yes/no --- -msse4.1 --- Use Intel Streaming SIMD Extensions 4.1
73 # avx2 = yes/no --- -mavx2 --- Use Intel Advanced Vector Extensions 2
74 # pext = yes/no --- -DUSE_PEXT --- Use pext x86_64 asm-instruction
75 # avx512 = yes/no --- -mavx512bw --- Use Intel Advanced Vector Extensions 512
76 # neon = yes/no --- -DUSE_NEON --- Use ARM SIMD architecture
78 # Note that Makefile is space sensitive, so when adding new architectures
79 # or modifying existing flags, you have to make sure there are no extra spaces
80 # at the end of the line for flag values.
82 ### 2.1. General and architecture defaults
98 ### 2.2 Architecture specific
99 ifeq ($(ARCH),general-32)
104 ifeq ($(ARCH),x86-32-old)
109 ifeq ($(ARCH),x86-32)
116 ifeq ($(ARCH),general-64)
120 ifeq ($(ARCH),x86-64)
126 ifeq ($(ARCH),x86-64-sse3-popcnt)
133 ifeq ($(ARCH),x86-64-ssse3)
140 ifeq ($(ARCH),x86-64-modern)
149 ifeq ($(ARCH),x86-64-sse41-popcnt)
158 ifeq ($(ARCH),x86-64-avx2)
168 ifeq ($(ARCH),x86-64-bmi2)
179 ifeq ($(ARCH),x86-64-avx512)
204 ifeq ($(ARCH),apple-silicon)
211 ifeq ($(ARCH),ppc-32)
216 ifeq ($(ARCH),ppc-64)
222 ### ==========================================================================
223 ### Section 3. Low-level Configuration
224 ### ==========================================================================
226 ### 3.1 Selecting compiler (default = gcc)
227 CXXFLAGS += -Wall -Wcast-qual -fno-exceptions -std=c++17 $(EXTRACXXFLAGS)
228 DEPENDFLAGS += -std=c++17
229 LDFLAGS += $(EXTRALDFLAGS)
238 CXXFLAGS += -pedantic -Wextra -Wshadow
240 ifeq ($(ARCH),$(filter $(ARCH),armv7 armv8))
242 CXXFLAGS += -m$(bits)
246 CXXFLAGS += -m$(bits)
250 ifneq ($(KERNEL),Darwin)
251 LDFLAGS += -Wl,--no-as-needed
254 gccversion = $(shell $(CXX) --version)
255 gccisclang = $(findstring clang,$(gccversion))
261 ifeq ($(KERNEL),Linux)
263 ifeq ($(shell which x86_64-w64-mingw32-c++-posix),)
264 CXX=x86_64-w64-mingw32-c++
266 CXX=x86_64-w64-mingw32-c++-posix
269 ifeq ($(shell which i686-w64-mingw32-c++-posix),)
270 CXX=i686-w64-mingw32-c++
272 CXX=i686-w64-mingw32-c++-posix
279 CXXFLAGS += -Wextra -Wshadow
286 CXXFLAGS += -diag-disable 1476,10120 -Wcheck -Wabi -Wdeprecated -strict-ansi
292 CXXFLAGS += -pedantic -Wextra -Wshadow
294 ifneq ($(KERNEL),Darwin)
295 ifneq ($(KERNEL),OpenBSD)
300 ifeq ($(ARCH),$(filter $(ARCH),armv7 armv8))
302 CXXFLAGS += -m$(bits)
306 CXXFLAGS += -m$(bits)
312 profile_make = icc-profile-make
313 profile_use = icc-profile-use
316 profile_make = clang-profile-make
317 profile_use = clang-profile-use
319 profile_make = gcc-profile-make
320 profile_use = gcc-profile-use
324 ifeq ($(KERNEL),Darwin)
325 CXXFLAGS += -arch $(arch) -mmacosx-version-min=10.14
326 LDFLAGS += -arch $(arch) -mmacosx-version-min=10.14
329 ### Travis CI script uses COMPILER to overwrite CXX
334 ### Allow overwriting CXX from command line
339 ### On mingw use Windows threads, otherwise POSIX
340 ifneq ($(comp),mingw)
341 # On Android Bionic's C library comes with its own pthread implementation bundled in
342 ifneq ($(OS),Android)
343 # Haiku has pthreads in its libroot, so only link it in on other platforms
344 ifneq ($(KERNEL),Haiku)
357 ### 3.2.2 Debugging with undefined behavior sanitizers
358 ifneq ($(sanitize),no)
359 CXXFLAGS += -g3 -fsanitize=$(sanitize)
360 LDFLAGS += -fsanitize=$(sanitize)
364 ifeq ($(optimize),yes)
369 ifeq ($(OS), Android)
370 CXXFLAGS += -fno-gcse -mthumb -march=armv7-a -mfloat-abi=softfp
374 ifeq ($(comp),$(filter $(comp),gcc clang icc))
375 ifeq ($(KERNEL),Darwin)
376 CXXFLAGS += -mdynamic-no-pic
383 CXXFLAGS += -DIS_64BIT
387 ifeq ($(prefetch),yes)
393 CXXFLAGS += -DNO_PREFETCH
398 ifeq ($(arch),$(filter $(arch),ppc64 armv8-a arm64))
399 CXXFLAGS += -DUSE_POPCNT
400 else ifeq ($(comp),icc)
401 CXXFLAGS += -msse3 -DUSE_POPCNT
403 CXXFLAGS += -msse3 -mpopcnt -DUSE_POPCNT
408 CXXFLAGS += -DUSE_AVX2
409 ifeq ($(comp),$(filter $(comp),gcc clang mingw))
415 CXXFLAGS += -DUSE_AVX512
416 ifeq ($(comp),$(filter $(comp),gcc clang mingw))
417 CXXFLAGS += -mavx512bw
422 CXXFLAGS += -DUSE_SSE41
423 ifeq ($(comp),$(filter $(comp),gcc clang mingw))
429 CXXFLAGS += -DUSE_SSSE3
430 ifeq ($(comp),$(filter $(comp),gcc clang mingw))
436 CXXFLAGS += -DUSE_NEON
439 ifeq ($(arch),x86_64)
440 CXXFLAGS += -DUSE_SSE2
445 CXXFLAGS += -DUSE_PEXT
446 ifeq ($(comp),$(filter $(comp),gcc clang mingw))
451 ### 3.8 Link Time Optimization
452 ### This is a mix of compile and link time options because the lto link phase
453 ### needs access to the optimization flags.
454 ifeq ($(optimize),yes)
457 CXXFLAGS += -flto=thin
458 LDFLAGS += $(CXXFLAGS)
460 # GCC and CLANG use different methods for parallelizing LTO and CLANG pretends to be
461 # GCC on some systems.
462 else ifeq ($(comp),gcc)
463 ifeq ($(gccisclang),)
465 LDFLAGS += $(CXXFLAGS) -flto=jobserver
467 CXXFLAGS += -flto=thin
468 LDFLAGS += $(CXXFLAGS)
471 # To use LTO and static linking on windows, the tool chain requires a recent gcc:
472 # gcc version 10.1 in msys2 or TDM-GCC version 9.2 are know to work, older might not.
473 # So, only enable it for a cross from Linux by default.
474 else ifeq ($(comp),mingw)
475 ifeq ($(KERNEL),Linux)
477 LDFLAGS += $(CXXFLAGS) -flto=jobserver
483 ### 3.9 Android 5 can only run position independent executables. Note that this
484 ### breaks Android 4.0 and earlier.
485 ifeq ($(OS), Android)
487 LDFLAGS += -fPIE -pie
490 ### ==========================================================================
491 ### Section 4. Public Targets
492 ### ==========================================================================
496 @echo "To compile stockfish, type: "
498 @echo "make target ARCH=arch [COMP=compiler] [COMPCXX=cxx]"
500 @echo "Supported targets:"
502 @echo "build > Standard build"
503 @echo "profile-build > Standard build with PGO"
504 @echo "strip > Strip executable"
505 @echo "install > Install executable"
506 @echo "clean > Clean up"
507 @echo "net > Download the default nnue net"
509 @echo "Supported archs:"
511 @echo "x86-64-avx512 > x86 64-bit with avx512 support"
512 @echo "x86-64-bmi2 > x86 64-bit with bmi2 support"
513 @echo "x86-64-avx2 > x86 64-bit with avx2 support"
514 @echo "x86-64-sse41-popcnt > x86 64-bit with sse41 and popcnt support"
515 @echo "x86-64-modern > the same as previous (x86-64-sse41-popcnt)"
516 @echo "x86-64-ssse3 > x86 64-bit with ssse3 support"
517 @echo "x86-64-sse3-popcnt > x86 64-bit with sse3 and popcnt support"
518 @echo "x86-64 > x86 64-bit generic"
519 @echo "x86-32 > x86 32-bit (also enables SSE)"
520 @echo "x86-32-old > x86 32-bit fall back for old hardware"
521 @echo "ppc-64 > PPC 64-bit"
522 @echo "ppc-32 > PPC 32-bit"
523 @echo "armv7 > ARMv7 32-bit"
524 @echo "armv8 > ARMv8 64-bit"
525 @echo "apple-silicon > Apple silicon ARM64"
526 @echo "general-64 > unspecified 64-bit"
527 @echo "general-32 > unspecified 32-bit"
529 @echo "Supported compilers:"
531 @echo "gcc > Gnu compiler (default)"
532 @echo "mingw > Gnu compiler with MinGW under Windows"
533 @echo "clang > LLVM Clang compiler"
534 @echo "icc > Intel compiler"
536 @echo "Simple examples. If you don't know what to do, you likely want to run: "
538 @echo "make -j build ARCH=x86-64 (This is for 64-bit systems)"
539 @echo "make -j build ARCH=x86-32 (This is for 32-bit systems)"
541 @echo "Advanced examples, for experienced users: "
543 @echo "make -j build ARCH=x86-64-modern COMP=clang"
544 @echo "make -j profile-build ARCH=x86-64-bmi2 COMP=gcc COMPCXX=g++-4.8"
546 @echo "The selected architecture $(ARCH) enables the following configuration: "
548 @$(MAKE) ARCH=$(ARCH) COMP=$(COMP) config-sanity
551 .PHONY: help build profile-build strip install clean net objclean profileclean \
552 config-sanity icc-profile-use icc-profile-make gcc-profile-use gcc-profile-make \
553 clang-profile-use clang-profile-make
556 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) all
558 profile-build: config-sanity objclean profileclean
560 @echo "Step 1/4. Building instrumented executable ..."
561 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) $(profile_make)
563 @echo "Step 2/4. Running benchmark for pgo-build ..."
564 $(PGOBENCH) > /dev/null
566 @echo "Step 3/4. Building optimized executable ..."
567 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) objclean
568 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) $(profile_use)
570 @echo "Step 4/4. Deleting profile data ..."
571 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) profileclean
577 -mkdir -p -m 755 $(BINDIR)
579 -strip $(BINDIR)/$(EXE)
582 clean: objclean profileclean
583 @rm -f .depend *~ core
586 $(eval nnuenet := $(shell grep EvalFile ucioption.cpp | grep Option | sed 's/.*\(nn-[a-z0-9]\{12\}.nnue\).*/\1/'))
587 @echo "Default net: $(nnuenet)"
588 $(eval nnuedownloadurl := https://tests.stockfishchess.org/api/nn/$(nnuenet))
589 $(eval curl_or_wget := $(shell if hash curl 2>/dev/null; then echo "curl -sL"; elif hash wget 2>/dev/null; then echo "wget -qO-"; fi))
590 @if test -f "$(nnuenet)"; then echo "Already available."; else echo "Downloading $(nnuedownloadurl)"; $(curl_or_wget) $(nnuedownloadurl) > $(nnuenet); fi
592 # clean binaries and objects
594 @rm -f $(EXE) *.o ./syzygy/*.o ./nnue/*.o ./nnue/features/*.o
596 # clean auxiliary profiling files
599 @rm -f bench.txt *.gcda *.gcno ./syzygy/*.gcda ./nnue/*.gcda ./nnue/features/*.gcda
600 @rm -f stockfish.profdata *.profraw
605 ### ==========================================================================
606 ### Section 5. Private Targets
607 ### ==========================================================================
614 @echo "debug: '$(debug)'"
615 @echo "sanitize: '$(sanitize)'"
616 @echo "optimize: '$(optimize)'"
617 @echo "arch: '$(arch)'"
618 @echo "bits: '$(bits)'"
619 @echo "kernel: '$(KERNEL)'"
621 @echo "prefetch: '$(prefetch)'"
622 @echo "popcnt: '$(popcnt)'"
623 @echo "sse: '$(sse)'"
624 @echo "ssse3: '$(ssse3)'"
625 @echo "sse41: '$(sse41)'"
626 @echo "avx2: '$(avx2)'"
627 @echo "pext: '$(pext)'"
628 @echo "avx512: '$(avx512)'"
629 @echo "neon: '$(neon)'"
633 @echo "CXXFLAGS: $(CXXFLAGS)"
634 @echo "LDFLAGS: $(LDFLAGS)"
636 @echo "Testing config sanity. If this fails, try 'make help' ..."
638 @test "$(debug)" = "yes" || test "$(debug)" = "no"
639 @test "$(sanitize)" = "undefined" || test "$(sanitize)" = "thread" || test "$(sanitize)" = "address" || test "$(sanitize)" = "no"
640 @test "$(optimize)" = "yes" || test "$(optimize)" = "no"
641 @test "$(arch)" = "any" || test "$(arch)" = "x86_64" || test "$(arch)" = "i386" || \
642 test "$(arch)" = "ppc64" || test "$(arch)" = "ppc" || \
643 test "$(arch)" = "armv7" || test "$(arch)" = "armv8-a" || test "$(arch)" = "arm64"
644 @test "$(bits)" = "32" || test "$(bits)" = "64"
645 @test "$(prefetch)" = "yes" || test "$(prefetch)" = "no"
646 @test "$(popcnt)" = "yes" || test "$(popcnt)" = "no"
647 @test "$(sse)" = "yes" || test "$(sse)" = "no"
648 @test "$(ssse3)" = "yes" || test "$(ssse3)" = "no"
649 @test "$(sse41)" = "yes" || test "$(sse41)" = "no"
650 @test "$(avx2)" = "yes" || test "$(avx2)" = "no"
651 @test "$(pext)" = "yes" || test "$(pext)" = "no"
652 @test "$(avx512)" = "yes" || test "$(avx512)" = "no"
653 @test "$(neon)" = "yes" || test "$(neon)" = "no"
654 @test "$(comp)" = "gcc" || test "$(comp)" = "icc" || test "$(comp)" = "mingw" || test "$(comp)" = "clang"
657 +$(CXX) -o $@ $(OBJS) $(LDFLAGS)
660 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
661 EXTRACXXFLAGS='-fprofile-instr-generate ' \
662 EXTRALDFLAGS=' -fprofile-instr-generate' \
666 llvm-profdata merge -output=stockfish.profdata *.profraw
667 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
668 EXTRACXXFLAGS='-fprofile-instr-use=stockfish.profdata' \
669 EXTRALDFLAGS='-fprofile-use ' \
673 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
674 EXTRACXXFLAGS='-fprofile-generate' \
675 EXTRALDFLAGS='-lgcov' \
679 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
680 EXTRACXXFLAGS='-fprofile-use -fno-peel-loops -fno-tracer' \
681 EXTRALDFLAGS='-lgcov' \
686 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
687 EXTRACXXFLAGS='-prof-gen=srcpos -prof_dir ./profdir' \
691 $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
692 EXTRACXXFLAGS='-prof_use -prof_dir ./profdir' \
696 -@$(CXX) $(DEPENDFLAGS) -MM $(SRCS) > $@ 2> /dev/null