git.sesse.net Git - stockfish/blob - src/Makefile

   1 # Stockfish, a UCI chess playing engine derived from Glaurung 2.1
   2 # Copyright (C) 2004-2021 The Stockfish developers (see AUTHORS file)
   3 #
   4 # Stockfish is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # Stockfish is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17
  18 ### ==========================================================================
  19 ### Section 1. General Configuration
  20 ### ==========================================================================
  21
  22 ### Executable name
  23 ifeq ($(COMP),mingw)
  24 EXE = stockfish.exe
  25 else
  26 EXE = stockfish
  27 endif
  28
  29 ### Installation dir definitions
  30 PREFIX = /usr/local
  31 BINDIR = $(PREFIX)/bin
  32
  33 ### Built-in benchmark for pgo-builds
  34 ifeq ($(SDE_PATH),)
  35         PGOBENCH = ./$(EXE) bench
  36 else
  37         PGOBENCH = $(SDE_PATH) -- ./$(EXE) bench
  38 endif
  39
  40 ### Source and object files
  41 SRCS = benchmark.cpp bitbase.cpp bitboard.cpp endgame.cpp evaluate.cpp main.cpp \
  42         material.cpp misc.cpp movegen.cpp movepick.cpp pawns.cpp position.cpp psqt.cpp \
  43         search.cpp thread.cpp timeman.cpp tt.cpp uci.cpp ucioption.cpp tune.cpp syzygy/tbprobe.cpp \
  44         nnue/evaluate_nnue.cpp nnue/features/half_ka_v2_hm.cpp
  45
  46 OBJS = $(notdir $(SRCS:.cpp=.o))
  47
  48 VPATH = syzygy:nnue:nnue/features
  49
  50 ### Establish the operating system name
  51 KERNEL = $(shell uname -s)
  52 ifeq ($(KERNEL),Linux)
  53         OS = $(shell uname -o)
  54 endif
  55
  56 ### ==========================================================================
  57 ### Section 2. High-level Configuration
  58 ### ==========================================================================
  59 #
  60 # flag                --- Comp switch      --- Description
  61 # ----------------------------------------------------------------------------
  62 #
  63 # debug = yes/no      --- -DNDEBUG         --- Enable/Disable debug mode
  64 # sanitize = none/<sanitizer> ... (-fsanitize )
  65 #                     --- ( undefined )    --- enable undefined behavior checks
  66 #                     --- ( thread    )    --- enable threading error checks
  67 #                     --- ( address   )    --- enable memory access checks
  68 #                     --- ...etc...        --- see compiler documentation for supported sanitizers
  69 # optimize = yes/no   --- (-O3/-fast etc.) --- Enable/Disable optimizations
  70 # arch = (name)       --- (-arch)          --- Target architecture
  71 # bits = 64/32        --- -DIS_64BIT       --- 64-/32-bit operating system
  72 # prefetch = yes/no   --- -DUSE_PREFETCH   --- Use prefetch asm-instruction
  73 # popcnt = yes/no     --- -DUSE_POPCNT     --- Use popcnt asm-instruction
  74 # pext = yes/no       --- -DUSE_PEXT       --- Use pext x86_64 asm-instruction
  75 # sse = yes/no        --- -msse            --- Use Intel Streaming SIMD Extensions
  76 # mmx = yes/no        --- -mmmx            --- Use Intel MMX instructions
  77 # sse2 = yes/no       --- -msse2           --- Use Intel Streaming SIMD Extensions 2
  78 # ssse3 = yes/no      --- -mssse3          --- Use Intel Supplemental Streaming SIMD Extensions 3
  79 # sse41 = yes/no      --- -msse4.1         --- Use Intel Streaming SIMD Extensions 4.1
  80 # avx2 = yes/no       --- -mavx2           --- Use Intel Advanced Vector Extensions 2
  81 # avx512 = yes/no     --- -mavx512bw       --- Use Intel Advanced Vector Extensions 512
  82 # vnni256 = yes/no    --- -mavx512vnni     --- Use Intel Vector Neural Network Instructions 256
  83 # vnni512 = yes/no    --- -mavx512vnni     --- Use Intel Vector Neural Network Instructions 512
  84 # neon = yes/no       --- -DUSE_NEON       --- Use ARM SIMD architecture
  85 #
  86 # Note that Makefile is space sensitive, so when adding new architectures
  87 # or modifying existing flags, you have to make sure there are no extra spaces
  88 # at the end of the line for flag values.
  89 #
  90 # Example of use for these flags:
  91 # make build ARCH=x86-64-avx512 debug=on sanitize="address undefined"
  92
  93
  94 ### 2.1. General and architecture defaults
  95
  96 ifeq ($(ARCH),)
  97    ARCH = x86-64-modern
  98    help_skip_sanity = yes
  99 endif
 100 # explicitly check for the list of supported architectures (as listed with make help),
 101 # the user can override with `make ARCH=x86-32-vnni256 SUPPORTED_ARCH=true`
 102 ifeq ($(ARCH), $(filter $(ARCH), \
 103                  x86-64-vnni512 x86-64-vnni256 x86-64-avx512 x86-64-bmi2 x86-64-avx2 \
 104                  x86-64-sse41-popcnt x86-64-modern x86-64-ssse3 x86-64-sse3-popcnt \
 105                  x86-64 x86-32-sse41-popcnt x86-32-sse2 x86-32 ppc-64 ppc-32 e2k \
 106                  armv7 armv7-neon armv8 apple-silicon general-64 general-32))
 107    SUPPORTED_ARCH=true
 108 else
 109    SUPPORTED_ARCH=false
 110 endif
 111
 112 optimize = yes
 113 debug = no
 114 sanitize = none
 115 bits = 64
 116 prefetch = no
 117 popcnt = no
 118 pext = no
 119 sse = no
 120 mmx = no
 121 sse2 = no
 122 ssse3 = no
 123 sse41 = no
 124 avx2 = no
 125 avx512 = no
 126 vnni256 = no
 127 vnni512 = no
 128 neon = no
 129 STRIP = strip
 130
 131 ### 2.2 Architecture specific
 132
 133 ifeq ($(findstring x86,$(ARCH)),x86)
 134
 135 # x86-32/64
 136
 137 ifeq ($(findstring x86-32,$(ARCH)),x86-32)
 138         arch = i386
 139         bits = 32
 140         sse = yes
 141         mmx = yes
 142 else
 143         arch = x86_64
 144         sse = yes
 145         sse2 = yes
 146 endif
 147
 148 ifeq ($(findstring -sse,$(ARCH)),-sse)
 149         sse = yes
 150 endif
 151
 152 ifeq ($(findstring -popcnt,$(ARCH)),-popcnt)
 153         popcnt = yes
 154 endif
 155
 156 ifeq ($(findstring -mmx,$(ARCH)),-mmx)
 157         mmx = yes
 158 endif
 159
 160 ifeq ($(findstring -sse2,$(ARCH)),-sse2)
 161         sse = yes
 162         sse2 = yes
 163 endif
 164
 165 ifeq ($(findstring -ssse3,$(ARCH)),-ssse3)
 166         sse = yes
 167         sse2 = yes
 168         ssse3 = yes
 169 endif
 170
 171 ifeq ($(findstring -sse41,$(ARCH)),-sse41)
 172         sse = yes
 173         sse2 = yes
 174         ssse3 = yes
 175         sse41 = yes
 176 endif
 177
 178 ifeq ($(findstring -modern,$(ARCH)),-modern)
 179         popcnt = yes
 180         sse = yes
 181         sse2 = yes
 182         ssse3 = yes
 183         sse41 = yes
 184 endif
 185
 186 ifeq ($(findstring -avx2,$(ARCH)),-avx2)
 187         popcnt = yes
 188         sse = yes
 189         sse2 = yes
 190         ssse3 = yes
 191         sse41 = yes
 192         avx2 = yes
 193 endif
 194
 195 ifeq ($(findstring -bmi2,$(ARCH)),-bmi2)
 196         popcnt = yes
 197         sse = yes
 198         sse2 = yes
 199         ssse3 = yes
 200         sse41 = yes
 201         avx2 = yes
 202         pext = yes
 203 endif
 204
 205 ifeq ($(findstring -avx512,$(ARCH)),-avx512)
 206         popcnt = yes
 207         sse = yes
 208         sse2 = yes
 209         ssse3 = yes
 210         sse41 = yes
 211         avx2 = yes
 212         pext = yes
 213         avx512 = yes
 214 endif
 215
 216 ifeq ($(findstring -vnni256,$(ARCH)),-vnni256)
 217         popcnt = yes
 218         sse = yes
 219         sse2 = yes
 220         ssse3 = yes
 221         sse41 = yes
 222         avx2 = yes
 223         pext = yes
 224         vnni256 = yes
 225 endif
 226
 227 ifeq ($(findstring -vnni512,$(ARCH)),-vnni512)
 228         popcnt = yes
 229         sse = yes
 230         sse2 = yes
 231         ssse3 = yes
 232         sse41 = yes
 233         avx2 = yes
 234         pext = yes
 235         avx512 = yes
 236         vnni512 = yes
 237 endif
 238
 239 ifeq ($(sse),yes)
 240         prefetch = yes
 241 endif
 242
 243 # 64-bit pext is not available on x86-32
 244 ifeq ($(bits),32)
 245         pext = no
 246 endif
 247
 248 else
 249
 250 # all other architectures
 251
 252 ifeq ($(ARCH),general-32)
 253         arch = any
 254         bits = 32
 255 endif
 256
 257 ifeq ($(ARCH),general-64)
 258         arch = any
 259 endif
 260
 261 ifeq ($(ARCH),armv7)
 262         arch = armv7
 263         prefetch = yes
 264         bits = 32
 265 endif
 266
 267 ifeq ($(ARCH),armv7-neon)
 268         arch = armv7
 269         prefetch = yes
 270         popcnt = yes
 271         neon = yes
 272         bits = 32
 273 endif
 274
 275 ifeq ($(ARCH),armv8)
 276         arch = armv8
 277         prefetch = yes
 278         popcnt = yes
 279         neon = yes
 280 endif
 281
 282 ifeq ($(ARCH),apple-silicon)
 283         arch = arm64
 284         prefetch = yes
 285         popcnt = yes
 286         neon = yes
 287 endif
 288
 289 ifeq ($(ARCH),ppc-32)
 290         arch = ppc
 291         bits = 32
 292 endif
 293
 294 ifeq ($(ARCH),ppc-64)
 295         arch = ppc64
 296         popcnt = yes
 297         prefetch = yes
 298 endif
 299
 300 ifeq ($(findstring e2k,$(ARCH)),e2k)
 301         arch = e2k
 302         mmx = yes
 303         bits = 64
 304         sse = yes
 305         sse2 = yes
 306         ssse3 = yes
 307         sse41 = yes
 308         popcnt = yes
 309 endif
 310
 311 endif
 312
 313 ### ==========================================================================
 314 ### Section 3. Low-level Configuration
 315 ### ==========================================================================
 316
 317 ### 3.1 Selecting compiler (default = gcc)
 318 CXXFLAGS += -Wall -Wcast-qual -fno-exceptions -std=c++17 $(EXTRACXXFLAGS)
 319 DEPENDFLAGS += -std=c++17
 320 LDFLAGS += $(EXTRALDFLAGS)
 321
 322 ifeq ($(COMP),)
 323         COMP=gcc
 324 endif
 325
 326 ifeq ($(COMP),gcc)
 327         comp=gcc
 328         CXX=g++
 329         CXXFLAGS += -pedantic -Wextra -Wshadow
 330
 331         ifeq ($(arch),$(filter $(arch),armv7 armv8))
 332                 ifeq ($(OS),Android)
 333                         CXXFLAGS += -m$(bits)
 334                         LDFLAGS += -m$(bits)
 335                 endif
 336         else
 337                 CXXFLAGS += -m$(bits)
 338                 LDFLAGS += -m$(bits)
 339         endif
 340
 341         ifeq ($(arch),$(filter $(arch),armv7))
 342                 LDFLAGS += -latomic
 343         endif
 344
 345         ifneq ($(KERNEL),Darwin)
 346            LDFLAGS += -Wl,--no-as-needed
 347         endif
 348 endif
 349
 350 ifeq ($(COMP),mingw)
 351         comp=mingw
 352
 353         ifeq ($(KERNEL),Linux)
 354                 ifeq ($(bits),64)
 355                         ifeq ($(shell which x86_64-w64-mingw32-c++-posix),)
 356                                 CXX=x86_64-w64-mingw32-c++
 357                         else
 358                                 CXX=x86_64-w64-mingw32-c++-posix
 359                         endif
 360                 else
 361                         ifeq ($(shell which i686-w64-mingw32-c++-posix),)
 362                                 CXX=i686-w64-mingw32-c++
 363                         else
 364                                 CXX=i686-w64-mingw32-c++-posix
 365                         endif
 366                 endif
 367         else
 368                 CXX=g++
 369         endif
 370
 371         CXXFLAGS += -pedantic -Wextra -Wshadow
 372         LDFLAGS += -static
 373 endif
 374
 375 ifeq ($(COMP),icc)
 376         comp=icc
 377         CXX=icpc
 378         CXXFLAGS += -diag-disable 1476,10120 -Wcheck -Wabi -Wdeprecated -strict-ansi
 379 endif
 380
 381 ifeq ($(COMP),clang)
 382         comp=clang
 383         CXX=clang++
 384         CXXFLAGS += -pedantic -Wextra -Wshadow
 385
 386         ifneq ($(KERNEL),Darwin)
 387         ifneq ($(KERNEL),OpenBSD)
 388         ifneq ($(KERNEL),FreeBSD)
 389         ifneq ($(RTLIB),compiler-rt)
 390                 LDFLAGS += -latomic
 391         endif
 392         endif
 393         endif
 394         endif
 395
 396         ifeq ($(arch),$(filter $(arch),armv7 armv8))
 397                 ifeq ($(OS),Android)
 398                         CXXFLAGS += -m$(bits)
 399                         LDFLAGS += -m$(bits)
 400                 endif
 401         else
 402                 CXXFLAGS += -m$(bits)
 403                 LDFLAGS += -m$(bits)
 404         endif
 405 endif
 406
 407 ifeq ($(KERNEL),Darwin)
 408         CXXFLAGS += -mmacosx-version-min=10.14
 409         LDFLAGS += -mmacosx-version-min=10.14
 410         ifneq ($(arch),any)
 411                 CXXFLAGS += -arch $(arch)
 412                 LDFLAGS += -arch $(arch)
 413         endif
 414         XCRUN = xcrun
 415 endif
 416
 417 # To cross-compile for Android, NDK version r21 or later is recommended.
 418 # In earlier NDK versions, you'll need to pass -fno-addrsig if using GNU binutils.
 419 # Currently we don't know how to make PGO builds with the NDK yet.
 420 ifeq ($(COMP),ndk)
 421         CXXFLAGS += -stdlib=libc++ -fPIE
 422         comp=clang
 423         ifeq ($(arch),armv7)
 424                 CXX=armv7a-linux-androideabi16-clang++
 425                 CXXFLAGS += -mthumb -march=armv7-a -mfloat-abi=softfp -mfpu=neon
 426                 STRIP=arm-linux-androideabi-strip
 427         endif
 428         ifeq ($(arch),armv8)
 429                 CXX=aarch64-linux-android21-clang++
 430                 STRIP=aarch64-linux-android-strip
 431         endif
 432         LDFLAGS += -static-libstdc++ -pie -lm -latomic
 433 endif
 434
 435 ifeq ($(comp),icc)
 436         profile_make = icc-profile-make
 437         profile_use = icc-profile-use
 438 else ifeq ($(comp),clang)
 439         profile_make = clang-profile-make
 440         profile_use = clang-profile-use
 441 else
 442         profile_make = gcc-profile-make
 443         profile_use = gcc-profile-use
 444 endif
 445
 446 ### Travis CI script uses COMPILER to overwrite CXX
 447 ifdef COMPILER
 448         COMPCXX=$(COMPILER)
 449 endif
 450
 451 ### Allow overwriting CXX from command line
 452 ifdef COMPCXX
 453         CXX=$(COMPCXX)
 454 endif
 455
 456 ### Sometimes gcc is really clang
 457 ifeq ($(COMP),gcc)
 458         gccversion = $(shell $(CXX) --version)
 459         gccisclang = $(findstring clang,$(gccversion))
 460         ifneq ($(gccisclang),)
 461                 profile_make = clang-profile-make
 462                 profile_use = clang-profile-use
 463         endif
 464 endif
 465
 466 ### On mingw use Windows threads, otherwise POSIX
 467 ifneq ($(comp),mingw)
 468         CXXFLAGS += -DUSE_PTHREADS
 469         # On Android Bionic's C library comes with its own pthread implementation bundled in
 470         ifneq ($(OS),Android)
 471                 # Haiku has pthreads in its libroot, so only link it in on other platforms
 472                 ifneq ($(KERNEL),Haiku)
 473                         ifneq ($(COMP),ndk)
 474                                 LDFLAGS += -lpthread
 475                         endif
 476                 endif
 477         endif
 478 endif
 479
 480 ### 3.2.1 Debugging
 481 ifeq ($(debug),no)
 482         CXXFLAGS += -DNDEBUG
 483 else
 484         CXXFLAGS += -g
 485 endif
 486
 487 ### 3.2.2 Debugging with undefined behavior sanitizers
 488 ifneq ($(sanitize),none)
 489         CXXFLAGS += -g3 $(addprefix -fsanitize=,$(sanitize))
 490         LDFLAGS += $(addprefix -fsanitize=,$(sanitize))
 491 endif
 492
 493 ### 3.3 Optimization
 494 ifeq ($(optimize),yes)
 495
 496         CXXFLAGS += -O3
 497
 498         ifeq ($(comp),gcc)
 499                 ifeq ($(OS), Android)
 500                         CXXFLAGS += -fno-gcse -mthumb -march=armv7-a -mfloat-abi=softfp
 501                 endif
 502         endif
 503
 504         ifeq ($(comp),$(filter $(comp),gcc clang icc))
 505                 ifeq ($(KERNEL),Darwin)
 506                         CXXFLAGS += -mdynamic-no-pic
 507                 endif
 508         endif
 509
 510         ifeq ($(comp),clang)
 511                 CXXFLAGS += -fexperimental-new-pass-manager
 512         endif
 513 endif
 514
 515 ### 3.4 Bits
 516 ifeq ($(bits),64)
 517         CXXFLAGS += -DIS_64BIT
 518 endif
 519
 520 ### 3.5 prefetch
 521 ifeq ($(prefetch),yes)
 522         ifeq ($(sse),yes)
 523                 CXXFLAGS += -msse
 524         endif
 525 else
 526         CXXFLAGS += -DNO_PREFETCH
 527 endif
 528
 529 ### 3.6 popcnt
 530 ifeq ($(popcnt),yes)
 531         ifeq ($(arch),$(filter $(arch),ppc64 armv7 armv8 arm64))
 532                 CXXFLAGS += -DUSE_POPCNT
 533         else ifeq ($(comp),icc)
 534                 CXXFLAGS += -msse3 -DUSE_POPCNT
 535         else
 536                 CXXFLAGS += -msse3 -mpopcnt -DUSE_POPCNT
 537         endif
 538 endif
 539
 540 ifeq ($(avx2),yes)
 541         CXXFLAGS += -DUSE_AVX2
 542         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 543                 CXXFLAGS += -mavx2
 544         endif
 545 endif
 546
 547 ifeq ($(avx512),yes)
 548         CXXFLAGS += -DUSE_AVX512
 549         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 550                 CXXFLAGS += -mavx512f -mavx512bw
 551         endif
 552 endif
 553
 554 ifeq ($(vnni256),yes)
 555         CXXFLAGS += -DUSE_VNNI
 556         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 557                 CXXFLAGS += -mavx512f -mavx512bw -mavx512vnni -mavx512dq -mavx512vl -mprefer-vector-width=256
 558         endif
 559 endif
 560
 561 ifeq ($(vnni512),yes)
 562         CXXFLAGS += -DUSE_VNNI
 563         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 564                 CXXFLAGS += -mavx512vnni -mavx512dq -mavx512vl
 565         endif
 566 endif
 567
 568 ifeq ($(sse41),yes)
 569         CXXFLAGS += -DUSE_SSE41
 570         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 571                 CXXFLAGS += -msse4.1
 572         endif
 573 endif
 574
 575 ifeq ($(ssse3),yes)
 576         CXXFLAGS += -DUSE_SSSE3
 577         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 578                 CXXFLAGS += -mssse3
 579         endif
 580 endif
 581
 582 ifeq ($(sse2),yes)
 583         CXXFLAGS += -DUSE_SSE2
 584         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 585                 CXXFLAGS += -msse2
 586         endif
 587 endif
 588
 589 ifeq ($(mmx),yes)
 590         CXXFLAGS += -DUSE_MMX
 591         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 592                 CXXFLAGS += -mmmx
 593         endif
 594 endif
 595
 596 ifeq ($(neon),yes)
 597         CXXFLAGS += -DUSE_NEON
 598         ifeq ($(KERNEL),Linux)
 599         ifneq ($(COMP),ndk)
 600         ifneq ($(arch),armv8)
 601                 CXXFLAGS += -mfpu=neon
 602         endif
 603         endif
 604         endif
 605 endif
 606
 607 ### 3.7 pext
 608 ifeq ($(pext),yes)
 609         CXXFLAGS += -DUSE_PEXT
 610         ifeq ($(comp),$(filter $(comp),gcc clang mingw))
 611                 CXXFLAGS += -mbmi2
 612         endif
 613 endif
 614
 615 ### 3.8 Link Time Optimization
 616 ### This is a mix of compile and link time options because the lto link phase
 617 ### needs access to the optimization flags.
 618 ifeq ($(optimize),yes)
 619 ifeq ($(debug), no)
 620         ifeq ($(comp),clang)
 621                 CXXFLAGS += -flto
 622                 ifneq ($(findstring MINGW,$(KERNEL)),)
 623                         CXXFLAGS += -fuse-ld=lld
 624                 else ifneq ($(findstring MSYS,$(KERNEL)),)
 625                         CXXFLAGS += -fuse-ld=lld
 626                 endif
 627                 LDFLAGS += $(CXXFLAGS)
 628
 629 # GCC and CLANG use different methods for parallelizing LTO and CLANG pretends to be
 630 # GCC on some systems.
 631         else ifeq ($(comp),gcc)
 632         ifeq ($(gccisclang),)
 633                 CXXFLAGS += -flto
 634                 LDFLAGS += $(CXXFLAGS) -flto=jobserver
 635                 ifneq ($(findstring MINGW,$(KERNEL)),)
 636                         LDFLAGS += -save-temps
 637                 else ifneq ($(findstring MSYS,$(KERNEL)),)
 638                         LDFLAGS += -save-temps
 639                 endif
 640         else
 641                 CXXFLAGS += -flto
 642                 LDFLAGS += $(CXXFLAGS)
 643         endif
 644
 645 # To use LTO and static linking on windows, the tool chain requires a recent gcc:
 646 # gcc version 10.1 in msys2 or TDM-GCC version 9.2 are known to work, older might not.
 647 # So, only enable it for a cross from Linux by default.
 648         else ifeq ($(comp),mingw)
 649         ifeq ($(KERNEL),Linux)
 650         ifneq ($(arch),i386)
 651                 CXXFLAGS += -flto
 652                 LDFLAGS += $(CXXFLAGS) -flto=jobserver
 653         endif
 654         endif
 655         endif
 656 endif
 657 endif
 658
 659 ### 3.9 Android 5 can only run position independent executables. Note that this
 660 ### breaks Android 4.0 and earlier.
 661 ifeq ($(OS), Android)
 662         CXXFLAGS += -fPIE
 663         LDFLAGS += -fPIE -pie
 664 endif
 665
 666 ### ==========================================================================
 667 ### Section 4. Public Targets
 668 ### ==========================================================================
 669
 670
 671 help:
 672         @echo ""
 673         @echo "To compile stockfish, type: "
 674         @echo ""
 675         @echo "make target ARCH=arch [COMP=compiler] [COMPCXX=cxx]"
 676         @echo ""
 677         @echo "Supported targets:"
 678         @echo ""
 679         @echo "help                    > Display architecture details"
 680         @echo "build                   > Standard build"
 681         @echo "net                     > Download the default nnue net"
 682         @echo "profile-build           > Faster build (with profile-guided optimization)"
 683         @echo "strip                   > Strip executable"
 684         @echo "install                 > Install executable"
 685         @echo "clean                   > Clean up"
 686         @echo ""
 687         @echo "Supported archs:"
 688         @echo ""
 689         @echo "x86-64-vnni512          > x86 64-bit with vnni support 512bit wide"
 690         @echo "x86-64-vnni256          > x86 64-bit with vnni support 256bit wide"
 691         @echo "x86-64-avx512           > x86 64-bit with avx512 support"
 692         @echo "x86-64-bmi2             > x86 64-bit with bmi2 support"
 693         @echo "x86-64-avx2             > x86 64-bit with avx2 support"
 694         @echo "x86-64-sse41-popcnt     > x86 64-bit with sse41 and popcnt support"
 695         @echo "x86-64-modern           > common modern CPU, currently x86-64-sse41-popcnt"
 696         @echo "x86-64-ssse3            > x86 64-bit with ssse3 support"
 697         @echo "x86-64-sse3-popcnt      > x86 64-bit with sse3 and popcnt support"
 698         @echo "x86-64                  > x86 64-bit generic (with sse2 support)"
 699         @echo "x86-32-sse41-popcnt     > x86 32-bit with sse41 and popcnt support"
 700         @echo "x86-32-sse2             > x86 32-bit with sse2 support"
 701         @echo "x86-32                  > x86 32-bit generic (with mmx and sse support)"
 702         @echo "ppc-64                  > PPC 64-bit"
 703         @echo "ppc-32                  > PPC 32-bit"
 704         @echo "armv7                   > ARMv7 32-bit"
 705         @echo "armv7-neon              > ARMv7 32-bit with popcnt and neon"
 706         @echo "armv8                   > ARMv8 64-bit with popcnt and neon"
 707         @echo "e2k                     > Elbrus 2000"
 708         @echo "apple-silicon           > Apple silicon ARM64"
 709         @echo "general-64              > unspecified 64-bit"
 710         @echo "general-32              > unspecified 32-bit"
 711         @echo ""
 712         @echo "Supported compilers:"
 713         @echo ""
 714         @echo "gcc                     > Gnu compiler (default)"
 715         @echo "mingw                   > Gnu compiler with MinGW under Windows"
 716         @echo "clang                   > LLVM Clang compiler"
 717         @echo "icc                     > Intel compiler"
 718         @echo "ndk                     > Google NDK to cross-compile for Android"
 719         @echo ""
 720         @echo "Simple examples. If you don't know what to do, you likely want to run: "
 721         @echo ""
 722         @echo "make -j build ARCH=x86-64  (A portable, slow compile for 64-bit systems)"
 723         @echo "make -j build ARCH=x86-32  (A portable, slow compile for 32-bit systems)"
 724         @echo ""
 725         @echo "Advanced examples, for experienced users looking for performance: "
 726         @echo ""
 727         @echo "make    help  ARCH=x86-64-bmi2"
 728         @echo "make -j profile-build ARCH=x86-64-bmi2 COMP=gcc COMPCXX=g++-9.0"
 729         @echo "make -j build ARCH=x86-64-ssse3 COMP=clang"
 730         @echo ""
 731         @echo "-------------------------------"
 732 ifeq ($(SUPPORTED_ARCH)$(help_skip_sanity), true)
 733         @echo "The selected architecture $(ARCH) will enable the following configuration: "
 734         @$(MAKE) ARCH=$(ARCH) COMP=$(COMP) config-sanity
 735 else
 736         @echo "Specify a supported architecture with the ARCH option for more details"
 737         @echo ""
 738 endif
 739
 740
 741 .PHONY: help build profile-build strip install clean net objclean profileclean \
 742         config-sanity icc-profile-use icc-profile-make gcc-profile-use gcc-profile-make \
 743         clang-profile-use clang-profile-make
 744
 745 build: net config-sanity
 746         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) all
 747
 748 profile-build: net config-sanity objclean profileclean
 749         @echo ""
 750         @echo "Step 1/4. Building instrumented executable ..."
 751         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) $(profile_make)
 752         @echo ""
 753         @echo "Step 2/4. Running benchmark for pgo-build ..."
 754         $(PGOBENCH) > /dev/null
 755         @echo ""
 756         @echo "Step 3/4. Building optimized executable ..."
 757         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) objclean
 758         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) $(profile_use)
 759         @echo ""
 760         @echo "Step 4/4. Deleting profile data ..."
 761         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) profileclean
 762
 763 strip:
 764         $(STRIP) $(EXE)
 765
 766 install:
 767         -mkdir -p -m 755 $(BINDIR)
 768         -cp $(EXE) $(BINDIR)
 769         -strip $(BINDIR)/$(EXE)
 770
 771 # clean all
 772 clean: objclean profileclean
 773         @rm -f .depend *~ core
 774
 775 # evaluation network (nnue)
 776 net:
 777         $(eval nnuenet := $(shell grep EvalFileDefaultName evaluate.h | grep define | sed 's/.*\(nn-[a-z0-9]\{12\}.nnue\).*/\1/'))
 778         @echo "Default net: $(nnuenet)"
 779         $(eval nnuedownloadurl := https://tests.stockfishchess.org/api/nn/$(nnuenet))
 780         $(eval curl_or_wget := $(shell if hash curl 2>/dev/null; then echo "curl -skL"; elif hash wget 2>/dev/null; then echo "wget -qO-"; fi))
 781         @if test -f "$(nnuenet)"; then \
 782             echo "Already available."; \
 783          else \
 784             if [ "x$(curl_or_wget)" = "x" ]; then \
 785                echo "Automatic download failed: neither curl nor wget is installed. Install one of these tools or download the net manually"; exit 1; \
 786             else \
 787                echo "Downloading $(nnuedownloadurl)"; $(curl_or_wget) $(nnuedownloadurl) > $(nnuenet);\
 788             fi; \
 789         fi;
 790         $(eval shasum_command := $(shell if hash shasum 2>/dev/null; then echo "shasum -a 256 "; elif hash sha256sum 2>/dev/null; then echo "sha256sum "; fi))
 791         @if [ "x$(shasum_command)" != "x" ]; then \
 792             if [ "$(nnuenet)" != "nn-"`$(shasum_command) $(nnuenet) | cut -c1-12`".nnue" ]; then \
 793                 echo "Failed download or $(nnuenet) corrupted, please delete!"; exit 1; \
 794             fi \
 795          else \
 796             echo "shasum / sha256sum not found, skipping net validation"; \
 797         fi
 798
 799 # clean binaries and objects
 800 objclean:
 801         @rm -f $(EXE) *.o ./syzygy/*.o ./nnue/*.o ./nnue/features/*.o
 802
 803 # clean auxiliary profiling files
 804 profileclean:
 805         @rm -rf profdir
 806         @rm -f bench.txt *.gcda *.gcno ./syzygy/*.gcda ./nnue/*.gcda ./nnue/features/*.gcda *.s
 807         @rm -f stockfish.profdata *.profraw
 808         @rm -f stockfish.exe.lto_wrapper_args
 809         @rm -f stockfish.exe.ltrans.out
 810         @rm -f ./-lstdc++.res
 811
 812 default:
 813         help
 814
 815 ### ==========================================================================
 816 ### Section 5. Private Targets
 817 ### ==========================================================================
 818
 819 all: $(EXE) .depend
 820
 821 config-sanity: net
 822         @echo ""
 823         @echo "Config:"
 824         @echo "debug: '$(debug)'"
 825         @echo "sanitize: '$(sanitize)'"
 826         @echo "optimize: '$(optimize)'"
 827         @echo "arch: '$(arch)'"
 828         @echo "bits: '$(bits)'"
 829         @echo "kernel: '$(KERNEL)'"
 830         @echo "os: '$(OS)'"
 831         @echo "prefetch: '$(prefetch)'"
 832         @echo "popcnt: '$(popcnt)'"
 833         @echo "pext: '$(pext)'"
 834         @echo "sse: '$(sse)'"
 835         @echo "mmx: '$(mmx)'"
 836         @echo "sse2: '$(sse2)'"
 837         @echo "ssse3: '$(ssse3)'"
 838         @echo "sse41: '$(sse41)'"
 839         @echo "avx2: '$(avx2)'"
 840         @echo "avx512: '$(avx512)'"
 841         @echo "vnni256: '$(vnni256)'"
 842         @echo "vnni512: '$(vnni512)'"
 843         @echo "neon: '$(neon)'"
 844         @echo ""
 845         @echo "Flags:"
 846         @echo "CXX: $(CXX)"
 847         @echo "CXXFLAGS: $(CXXFLAGS)"
 848         @echo "LDFLAGS: $(LDFLAGS)"
 849         @echo ""
 850         @echo "Testing config sanity. If this fails, try 'make help' ..."
 851         @echo ""
 852         @test "$(debug)" = "yes" || test "$(debug)" = "no"
 853         @test "$(optimize)" = "yes" || test "$(optimize)" = "no"
 854         @test "$(SUPPORTED_ARCH)" = "true"
 855         @test "$(arch)" = "any" || test "$(arch)" = "x86_64" || test "$(arch)" = "i386" || \
 856          test "$(arch)" = "ppc64" || test "$(arch)" = "ppc" || test "$(arch)" = "e2k" || \
 857          test "$(arch)" = "armv7" || test "$(arch)" = "armv8" || test "$(arch)" = "arm64"
 858         @test "$(bits)" = "32" || test "$(bits)" = "64"
 859         @test "$(prefetch)" = "yes" || test "$(prefetch)" = "no"
 860         @test "$(popcnt)" = "yes" || test "$(popcnt)" = "no"
 861         @test "$(pext)" = "yes" || test "$(pext)" = "no"
 862         @test "$(sse)" = "yes" || test "$(sse)" = "no"
 863         @test "$(mmx)" = "yes" || test "$(mmx)" = "no"
 864         @test "$(sse2)" = "yes" || test "$(sse2)" = "no"
 865         @test "$(ssse3)" = "yes" || test "$(ssse3)" = "no"
 866         @test "$(sse41)" = "yes" || test "$(sse41)" = "no"
 867         @test "$(avx2)" = "yes" || test "$(avx2)" = "no"
 868         @test "$(avx512)" = "yes" || test "$(avx512)" = "no"
 869         @test "$(vnni256)" = "yes" || test "$(vnni256)" = "no"
 870         @test "$(vnni512)" = "yes" || test "$(vnni512)" = "no"
 871         @test "$(neon)" = "yes" || test "$(neon)" = "no"
 872         @test "$(comp)" = "gcc" || test "$(comp)" = "icc" || test "$(comp)" = "mingw" || test "$(comp)" = "clang" \
 873         || test "$(comp)" = "armv7a-linux-androideabi16-clang"  || test "$(comp)" = "aarch64-linux-android21-clang"
 874
 875 $(EXE): $(OBJS)
 876         +$(CXX) -o $@ $(OBJS) $(LDFLAGS)
 877
 878 clang-profile-make:
 879         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
 880         EXTRACXXFLAGS='-fprofile-instr-generate ' \
 881         EXTRALDFLAGS=' -fprofile-instr-generate' \
 882         all
 883
 884 clang-profile-use:
 885         $(XCRUN) llvm-profdata merge -output=stockfish.profdata *.profraw
 886         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
 887         EXTRACXXFLAGS='-fprofile-instr-use=stockfish.profdata' \
 888         EXTRALDFLAGS='-fprofile-use ' \
 889         all
 890
 891 gcc-profile-make:
 892         @mkdir -p profdir
 893         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
 894         EXTRACXXFLAGS='-fprofile-generate=profdir' \
 895         EXTRALDFLAGS='-lgcov' \
 896         all
 897
 898 gcc-profile-use:
 899         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
 900         EXTRACXXFLAGS='-fprofile-use=profdir -fno-peel-loops -fno-tracer' \
 901         EXTRALDFLAGS='-lgcov' \
 902         all
 903
 904 icc-profile-make:
 905         @mkdir -p profdir
 906         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
 907         EXTRACXXFLAGS='-prof-gen=srcpos -prof_dir ./profdir' \
 908         all
 909
 910 icc-profile-use:
 911         $(MAKE) ARCH=$(ARCH) COMP=$(COMP) \
 912         EXTRACXXFLAGS='-prof_use -prof_dir ./profdir' \
 913         all
 914
 915 .depend: $(SRCS)
 916         -@$(CXX) $(DEPENDFLAGS) -MM $(SRCS) > $@ 2> /dev/null
 917
 918 -include .depend