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