ghc.mk 57.7 KB
Newer Older
1 2
# -----------------------------------------------------------------------------
#
3
# (c) 2009-2013 The University of Glasgow
4 5 6 7
#
# This file is part of the GHC build system.
#
# To understand how the build system works and how to modify it, see
8 9
#      http://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
#      http://ghc.haskell.org/trac/ghc/wiki/Building/Modifying
10 11 12
#
# -----------------------------------------------------------------------------

13 14 15
# ToDo List.
#
#   * remove old Makefiles, add new stubs for building in subdirs
Simon Marlow's avatar
Simon Marlow committed
16 17 18 19 20
#     * docs/Makefile
#     * docs/storage-mgmt/Makefile
#     * docs/vh/Makefile
#     * rts/dotnet/Makefile
#     * utils/Makefile
21 22 23 24 25 26 27 28 29 30 31
#   * add Makefiles for the rest of the utils/ programs that aren't built
#     by default (need to exclude them from 'make all' too)

# Possible cleanups:
#
#   * per-source-file dependencies instead of one .depend file?
#   * eliminate undefined variables, and use --warn-undefined-variables?
#   * put outputs from different ways in different subdirs of distdir/build,
#     then we don't have to use -osuf/-hisuf.  We would have to install
#     them in different places too, so we'd need ghc-pkg support for packages
#     of different ways.
32
#   * make PACKAGES_STAGE1 generated by './configure' or './boot'?
33 34 35 36 37 38
#   * we should use a directory of package.conf files rather than a single
#     file for the inplace package database, so that we can express
#     dependencies more accurately.  Otherwise it's possible to get into
#     a state where the package database is out of date, and the build
#     system doesn't know.

39 40 41 42
# Approximate build order.
#
# The actual build order is defined by dependencies, and the phase
# ordering used to ensure correct ordering of makefile-generation; see
43
#    http://ghc.haskell.org/trac/ghc/wiki/Building/Architecture/Idiom/PhaseOrdering
44 45 46
#
#     * With bootstrapping compiler:
#           o Build utils/ghc-cabal
47
#           o Build utils/ghc-pkg
48
#           o Build utils/hsc2hs
49 50
#           o Build utils/genprimopcode
#           o Build utils/deriveConstants
51
#     * For each package:
thomie's avatar
thomie committed
52
#	    o configure, generate package-data.mk and inplace-pkg-config
53
#           o register each package into inplace/lib/package.conf
54
#     * build libffi (if not disabled by --with-system-libffi)
55
#     * With bootstrapping compiler:
56
#	    o Build libraries/{filepath,hpc,Cabal}
57
#           o Build compiler (stage 1)
thomie's avatar
thomie committed
58
#     * With stage 1 compiler:
59
#           o Build libraries/*
60
#	    o Build rts
61 62
#           o Build utils/* (except haddock)
#           o Build compiler (stage 2)
thomie's avatar
thomie committed
63
#     * With stage 2 compiler:
64
#           o Build utils/haddock
65
#           o Build compiler (stage 3) (optional)
66 67 68 69
#     * With haddock:
#           o libraries/*
#           o compiler

70 71
.PHONY: default all haddock

72 73
# We need second expansion for the way we handle directories, so that
#     | $$$$(dir $$$$@)/.
Ian Lynagh's avatar
Ian Lynagh committed
74
# expands to the directory of a rule that uses a % pattern.
75 76
.SECONDEXPANSION:

77 78
default : all

79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

##################################################
# Check that we have a new enough 'make'

HAVE_EVAL := NO
$(eval HAVE_EVAL := YES)

ifeq "$(HAVE_EVAL)" "NO"
$(error Your make does not support eval. You need GNU make >= 3.81)
endif

ifeq "$(abspath /)" ""
$(error Your make does not support abspath. You need GNU make >= 3.81)
endif
##################################################

95
# -----------------------------------------------------------------------------
96 97 98 99
# Catch make if it runs away into an infinite loop
ifeq      "$(MAKE_RESTARTS)" ""
else ifeq "$(MAKE_RESTARTS)" "1"
else
100
$(error Make has restarted itself $(MAKE_RESTARTS) times; is there a makefile bug? See http://ghc.haskell.org/trac/ghc/wiki/Building/Troubleshooting#Makehasrestarteditself3timesisthereamakefilebug for details)
101 102
endif

103 104 105 106 107 108 109 110
# -----------------------------------------------------------------------------
# Misc GNU make utils

nothing=
space=$(nothing) $(nothing)
comma=,

# -----------------------------------------------------------------------------
111 112
# Makefile debugging
#
113 114 115 116 117 118 119
# to see the effective value used for a Makefile variable, do
#  make show VALUE=MY_VALUE
#

show:
	@echo '$(VALUE)="$($(VALUE))"'

120 121 122 123 124 125 126 127
# echo is used by the nightly builders to query the build system for
# information.
# Using printf means that we don't get a trailing newline. We escape
# backslashes and double quotes in the string to protect them from the
# shell, and percent signs to protect them from printf.
echo:
	@printf "$(subst %,%%,$(subst ",\",$(subst \,\\\\,$($(VALUE)))))"

128 129 130
# -----------------------------------------------------------------------------
# Include subsidiary build-system bits

131 132
include mk/tree.mk

133
ifneq "$(CLEANING)" "YES"
134 135 136 137
include mk/config.mk
ifeq "$(ProjectVersion)" ""
$(error Please run ./configure first)
endif
138
endif
139

140 141
include mk/ways.mk

142 143
# (Optional) build-specific configuration
include mk/custom-settings.mk
144 145 146 147 148

# The user can reset SRC_HC_OPTS from mk/build.mk. Since we try to append
# '-Wall' to it in mk/warnings.mk, we have to include mk/warnings.mk after
# mk/custom-settings.mk.
include mk/warnings.mk
149

150 151 152 153 154
# -----------------------------------------------------------------------------
# Check for inconsistent settings, after reading mk/build.mk.
# Although mk/config.mk should always contain consistent settings (set by
# configure), mk/build.mk can contain pretty much anything.

155
ifneq "$(CLEANING)" "YES"
156

157
ifeq "$(DYNAMIC_GHC_PROGRAMS)" "YES"
158
ifeq "$(findstring dyn,$(GhcLibWays))" ""
159
$(error dyn is not in $$(GhcLibWays), but $$(DYNAMIC_GHC_PROGRAMS) is YES)
160 161 162
endif
else
ifeq "$(findstring v,$(GhcLibWays))" ""
163
$(error v is not in $$(GhcLibWays), and $$(DYNAMIC_GHC_PROGRAMS) is not YES)
164
endif
165
endif
166

167 168 169 170 171
ifeq "$(GhcProfiled)" "YES"
ifeq "$(findstring p,$(GhcLibWays))" ""
$(error p is not in $$(GhcLibWays), and $$(GhcProfiled) is YES)
endif
endif
172

173 174 175
ifeq "$(BUILD_SPHINX_HTML)" "YES"
ifeq "$(SPHINXBUILD)" ""
$(error BUILD_SPHINX_HTML=YES, but `sphinx-build` was not found. \
176 177
  Create a file `mk/validate.mk` containing `BUILD_SPHINX_HTML=NO` \
  (when validating), or install `sphinx-build` and rerun `./configure`. \
178 179 180 181
  See https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation)
endif
endif

182 183 184 185
ifeq "$(BUILD_SPHINX_PDF)" "YES"
ifeq "$(XELATEX)" ""
$(error BUILD_SPHINX_PDF=YES, but `xelatex` was not found. \
  Install `xelatex`, then rerun `./configure`. \
186 187 188 189 190 191 192 193 194
  See https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation)
endif
endif

ifeq "$(HSCOLOUR_SRCS)" "YES"
ifeq "$(HSCOLOUR_CMD)" ""
$(error HSCOLOUR_SRCS=YES, but HSCOLOUR_CMD is empty. \
  Run `cabal install hscolour`, then rerun `./configure`. \
  See https://ghc.haskell.org/trac/ghc/wiki/Building/Preparation)
195
endif
196 197
endif

198 199 200 201 202 203 204 205
ifeq "$(HADDOCK_DOCS)" "YES"
ifneq "$(CrossCompiling) $(Stage1Only)" "NO NO"
$(error Can not build haddock docs when CrossCompiling or Stage1Only. \
  Set HADDOCK_DOCS=NO in your mk/build.mk file. \
  See Note [No stage2 packages when CrossCompiling or Stage1Only])
endif
endif

206 207 208
endif # CLEANING

# -----------------------------------------------------------------------------
209

210 211 212 213
ifeq "$(phase)" ""
phase = final
endif

214 215 216
# -----------------------------------------------------------------------------
# Utility definitions

217
include rules/prof.mk
218
include rules/trace.mk
219
include rules/library-path.mk
220
include rules/add-dependency.mk
221
include rules/make-command.mk
222
include rules/pretty_commands.mk
223

224 225 226 227 228 229 230 231 232
# -----------------------------------------------------------------------------
# Macros for standard targets

include rules/all-target.mk
include rules/clean-target.mk

# -----------------------------------------------------------------------------
# The inplace tree

233
$(eval $(call clean-target,root,inplace,inplace/bin inplace/lib))
234 235 236 237 238 239 240

# -----------------------------------------------------------------------------
# Whether to build dependencies or not

# When we're just doing 'make clean' or 'make show', then we don't need
# to build dependencies.

241
ifeq "$(CLEANING)" "YES"
242 243 244
NO_INCLUDE_DEPS = YES
NO_INCLUDE_PKGDATA = YES
endif
Ian Lynagh's avatar
Ian Lynagh committed
245 246 247 248
ifneq "$(findstring bootstrapping-files,$(MAKECMDGOALS))" ""
NO_INCLUDE_DEPS = YES
NO_INCLUDE_PKGDATA = YES
endif
249 250 251 252 253 254 255 256 257 258 259 260 261
ifeq "$(findstring show,$(MAKECMDGOALS))" "show"
NO_INCLUDE_DEPS = YES
# We want package-data.mk for show
endif

# -----------------------------------------------------------------------------
# Ways

include rules/way-prelims.mk

$(foreach way,$(ALL_WAYS),\
  $(eval $(call way-prelims,$(way))))

262
ifeq "$(DYNAMIC_GHC_PROGRAMS)" "YES"
263
GHCI_WAY = dyn
264
HADDOCK_WAY = dyn
265 266
else
GHCI_WAY = v
267
HADDOCK_WAY = v
268 269
endif

270 271 272 273 274 275 276
WINDOWS_DYN_PROG_RTS := rts
ifeq "$(GhcThreaded)" "YES"
WINDOWS_DYN_PROG_RTS := $(WINDOWS_DYN_PROG_RTS)_thr
endif
ifeq "$(GhcDebugged)" "YES"
WINDOWS_DYN_PROG_RTS := $(WINDOWS_DYN_PROG_RTS)_debug
endif
277
WINDOWS_DYN_PROG_RTS := $(WINDOWS_DYN_PROG_RTS)_dyn_LIB_FILE
278

279 280 281
# -----------------------------------------------------------------------------
# Compilation Flags

282
include rules/distdir-opts.mk
283 284 285 286 287 288 289 290 291 292
include rules/distdir-way-opts.mk

# -----------------------------------------------------------------------------
# Finding source files and object files

include rules/hs-sources.mk
include rules/c-sources.mk
include rules/includes-sources.mk
include rules/hs-objs.mk
include rules/c-objs.mk
293
include rules/cmm-objs.mk
294 295 296 297

# -----------------------------------------------------------------------------
# Suffix rules

298 299 300
# Suffix rules cause "make clean" to fail on Windows (trac #3233)
# so we don't make any when cleaning.
ifneq "$(CLEANING)" "YES"
301
include rules/hs-suffix-rules-srcdir.mk
302
include rules/hs-suffix-way-rules-srcdir.mk
303
include rules/hs-suffix-way-rules.mk
304 305
include rules/hi-rule.mk
include rules/c-suffix-rules.mk
306
include rules/cmm-suffix-rules.mk
307
endif
308

309 310 311 312 313 314 315 316
# -----------------------------------------------------------------------------
# Building package-data.mk files from .cabal files

include rules/package-config.mk

# -----------------------------------------------------------------------------
# Building dependencies

317
include rules/dependencies.mk
318
include rules/build-dependencies.mk
319
include rules/include-dependencies.mk
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342

# -----------------------------------------------------------------------------
# Build package-data.mk files

include rules/build-package-data.mk

# -----------------------------------------------------------------------------
# Build and install a program

include rules/build-prog.mk
include rules/shell-wrapper.mk

# -----------------------------------------------------------------------------
# Build a perl script

include rules/build-perl.mk

# -----------------------------------------------------------------------------
# Build a package

include rules/build-package.mk
include rules/build-package-way.mk
include rules/haddock.mk
343
include rules/tags-package.mk
344
include rules/foreachLibrary.mk
345 346

# -----------------------------------------------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
347
# Registering hand-written package descriptions (used in rts)
348 349 350 351 352 353

include rules/manual-package-config.mk

# -----------------------------------------------------------------------------
# Docs

354
include rules/sphinx.mk
355 356

# -----------------------------------------------------------------------------
357
# Making bindists and sdists
358 359

include rules/bindist.mk
360
include rules/sdist-ghc-file.mk
361 362

# -----------------------------------------------------------------------------
363 364 365 366 367 368 369 370 371 372 373 374
# Directories

# Don't try to delete directories:
.PRECIOUS: %/.

# Create build directories on demand.  NB. the | below: this indicates
# that $(MKDIRHIER) is an order-only dependency, which means that this
# rule fires after building mkdirhier, but we won't try to recreate
# directories if mkdirhier changes.
%/. : | $(MKDIRHIER)
	"$(MKDIRHIER)" $@

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
# -----------------------------------------------------------------------------
# Lax dependencies

ifeq "$(LAX_DEPENDENCIES)" "YES"
LAX_DEPS_FOLLOW = |
else
LAX_DEPS_FOLLOW =
endif

# This is a bit of a hack. When LAX_DEPS_FOLLOW is | some rules end up
# looking like
#     target: a | b | c
# The first | signals the start of the order-only dependencies, but make
# treats the second | as a dependency. So we need to tell make how to
# build that dependency.

.PHONY: |
| :
	@:
394

395
# -----------------------------------------------------------------------------
396 397 398
# Packages to build
# The lists of packages that we *actually* going to build in each stage:
#
rodlogic's avatar
rodlogic committed
399
#  $(PACKAGES_STAGE0)
400 401 402 403 404
#  $(PACKAGES_STAGE1)
#  $(PACKAGES_STAGE2)
#
# Note that we need to add them to these variables in dependency
# order, as this is the order that they get configured in.
405

406
ifeq "$(CLEANING)" "YES"
407

408 409 410 411 412 413 414 415
define addLibraryForCleaning
# We just add all packages to both the stage 0 and stage 1 lists.
# Stage 2 gets cleaned in the same way as stage 1, so no need to
# add it there.
PACKAGES_STAGE0 += $1
PACKAGES_STAGE1 += $1
endef
$(eval $(call foreachLibrary,addLibraryForCleaning))
416

417
else # CLEANING
418

419 420 421 422
# Packages that are built by stage0. These packages are dependencies of
# programs such as GHC and ghc-pkg, that we do not assume the stage0
# compiler already has installed (or up-to-date enough).

patrickdoc's avatar
patrickdoc committed
423
PACKAGES_STAGE0 = binary text transformers mtl parsec Cabal/Cabal hpc ghc-boot-th ghc-boot template-haskell ghc-heap ghci
424
ifeq "$(Windows_Host)" "NO"
425
PACKAGES_STAGE0 += terminfo
426
endif
427

428 429 430 431 432 433 434 435
PACKAGES_STAGE1 += ghc-prim
PACKAGES_STAGE1 += $(INTEGER_LIBRARY)
PACKAGES_STAGE1 += base
PACKAGES_STAGE1 += filepath
PACKAGES_STAGE1 += array
PACKAGES_STAGE1 += deepseq
PACKAGES_STAGE1 += bytestring
PACKAGES_STAGE1 += containers
436

437
ifeq "$(Windows_Target)" "YES"
438 439 440
PACKAGES_STAGE1 += Win32
endif
PACKAGES_STAGE1 += time
441
ifeq "$(Windows_Target)" "NO"
442
PACKAGES_STAGE1 += unix
443
endif
444

445 446 447 448 449
PACKAGES_STAGE1 += directory
PACKAGES_STAGE1 += process
PACKAGES_STAGE1 += hpc
PACKAGES_STAGE1 += pretty
PACKAGES_STAGE1 += binary
450 451 452 453
PACKAGES_STAGE1 += text
PACKAGES_STAGE1 += transformers
PACKAGES_STAGE1 += mtl
PACKAGES_STAGE1 += parsec
454
PACKAGES_STAGE1 += Cabal/Cabal
455
PACKAGES_STAGE1 += ghc-boot-th
456 457
PACKAGES_STAGE1 += ghc-boot
PACKAGES_STAGE1 += template-haskell
458
PACKAGES_STAGE1 += ghc-compact
patrickdoc's avatar
patrickdoc committed
459
PACKAGES_STAGE1 += ghc-heap
460

461
ifeq "$(HADDOCK_DOCS)" "YES"
462
PACKAGES_STAGE1 += xhtml
463 464
endif

465
ifeq "$(WITH_TERMINFO)" "YES"
466
PACKAGES_STAGE1 += terminfo
467 468
else
libraries/haskeline_CONFIGURE_OPTS += --flags=-terminfo
469
endif
470

471
PACKAGES_STAGE1 += stm
472
PACKAGES_STAGE1 += haskeline
473
PACKAGES_STAGE1 += ghci
474
PACKAGES_STAGE1 += libiserv
475

476 477 478
# See Note [No stage2 packages when CrossCompiling or Stage1Only].
# See Note [Stage1Only vs stage=1] in mk/config.mk.in.
ifeq "$(CrossCompiling) $(Stage1Only)" "NO NO"
479 480 481
define addExtraPackage
ifeq "$2" "-"
# Do nothing; this package is already handled above
482 483
else ifeq "$2" "extra"
ifeq "$$(BUILD_EXTRA_PKGS)" "YES"
484 485
PACKAGES_STAGE2 += $1
endif
486
else
487
$$(error Unknown package tag: $2)
488
endif
489
endef
490 491
$(eval $(call foreachLibrary,addExtraPackage))
endif
492

493 494
# We install all packages that we build.
INSTALL_PACKAGES := $(addprefix libraries/,$(PACKAGES_STAGE1))
495
# See Note [Stage1Only vs stage=1] in mk/config.mk.in.
496
ifneq "$(Stage1Only)" "YES"
497
INSTALL_PACKAGES += compiler
498
endif
499
INSTALL_PACKAGES += $(addprefix libraries/,$(PACKAGES_STAGE2))
500

501
endif # CLEANING
502

503
# -------------------------------------------
504
# Note [Dependencies between package-data.mk files].
505 506 507

# We cannot run ghc-cabal to configure a package until we have
# configured and registered all of its dependencies.  So the following
508 509
# hack forces all the configure steps to happen in exactly the following order:
#
510
#  $(PACKAGES_STAGE1) ghc(stage2) $(PACKAGES_STAGE2)
511 512 513
#
# Ideally we should use the correct dependencies here to allow more
# parallelism, but we don't know the dependencies until we've
Gabor Greif's avatar
Gabor Greif committed
514
# generated the package-data.mk files.
515
define fixed_pkg_dep
516
libraries/$1/$2/package-data.mk : $$(fixed_pkg_prev)
517
fixed_pkg_prev:=libraries/$1/$2/package-data.mk
518 519 520 521
endef

ifneq "$(BINDIST)" "YES"
fixed_pkg_prev=
522
$(foreach pkg,$(PACKAGES_STAGE1),$(eval $(call fixed_pkg_dep,$(pkg),dist-install)))
523

524 525 526 527 528 529 530 531 532 533
# Intermezzo: utils that we build with the stage1 compiler. They depend on
# the stage1 packages, so we have to make sure those packages get configured
# and registered before we can start with these. Note that they don't depend on
# eachother, so we can configure them in parallel.
utils/ghc-cabal/dist-install/package-data.mk: $(fixed_pkg_prev)
utils/hpc/dist-install/package-data.mk: $(fixed_pkg_prev)
utils/ghc-pkg/dist-install/package-data.mk: $(fixed_pkg_prev)
utils/hsc2hs/dist-install/package-data.mk: $(fixed_pkg_prev)
utils/compare_sizes/dist-install/package-data.mk: $(fixed_pkg_prev)
utils/runghc/dist-install/package-data.mk: $(fixed_pkg_prev)
534 535 536
utils/iserv/stage2/package-data.mk: $(fixed_pkg_prev)
utils/iserv/stage2_p/package-data.mk: $(fixed_pkg_prev)
utils/iserv/stage2_dyn/package-data.mk: $(fixed_pkg_prev)
537 538 539
ifeq "$(Windows_Host)" "YES"
utils/gen-dll/dist-install/package-data.mk: $(fixed_pkg_prev)
endif
540

541 542 543 544
# the GHC package doesn't live in libraries/, so we add its dependency manually:
compiler/stage2/package-data.mk: $(fixed_pkg_prev)

# and continue with PACKAGES_STAGE2, which depend on GHC:
545
fixed_pkg_prev:=compiler/stage2/package-data.mk
546
$(foreach pkg,$(PACKAGES_STAGE2),$(eval $(call fixed_pkg_dep,$(pkg),dist-install)))
547

548 549
ghc/stage1/package-data.mk: compiler/stage1/package-data.mk
ghc/stage2/package-data.mk: compiler/stage2/package-data.mk
550

551 552 553 554 555
# Utils that we build with the stage2 compiler.
# They depend on the ghc library and some other libraries, but depending on
# the ghc library's package-data.mk is sufficient, as that in turn depends on
# all the other libraries' package-data.mk files.
utils/haddock/dist/package-data.mk: compiler/stage2/package-data.mk
Ian Lynagh's avatar
Ian Lynagh committed
556
utils/ghctags/dist-install/package-data.mk: compiler/stage2/package-data.mk
557 558
utils/check-api-annotations/dist-install/package-data.mk: compiler/stage2/package-data.mk
utils/check-ppr/dist-install/package-data.mk: compiler/stage2/package-data.mk
559

Ian Lynagh's avatar
Ian Lynagh committed
560
# add the final package.conf dependency: ghc-prim depends on RTS
561
libraries/ghc-prim/dist-install/package-data.mk : rts/dist/package.conf.inplace
562 563
endif

564 565
# --------------------------------
# Misc package-related settings
566

ian@well-typed.com's avatar
ian@well-typed.com committed
567 568 569 570 571
# Run Haddock for the packages that will be installed. We need to handle
# compiler specially due to the different dist directory name.
$(foreach p,$(INSTALL_PACKAGES),$(eval $p_dist-install_DO_HADDOCK = YES))
compiler_stage2_DO_HADDOCK = YES

572
BOOT_PKG_CONSTRAINTS := \
573
    $(foreach d,$(PACKAGES_STAGE0),\
574 575
        $(foreach p,$(basename $(notdir $(wildcard libraries/$d/*.cabal))),\
            --constraint "$p == $(shell grep -i "^Version:" libraries/$d/$p.cabal | sed "s/[^0-9.]//g")"))
Simon Marlow's avatar
Simon Marlow committed
576

577
# The actual .a and .so/.dll files: needed for dependencies.
578 579 580 581
$(foreach way,$(GhcLibWays),$(eval ALL_STAGE1_$(way)_LIBS = $$(foreach lib,$$(PACKAGES_STAGE1),$$(libraries/$$(lib)_dist-install_$(way)_LIB))))

ALL_STAGE1_LIBS = $(ALL_STAGE1_v_LIBS)

582
ifeq "$(BuildSharedLibs)" "YES"
583
ALL_STAGE1_LIBS += $(foreach lib,$(PACKAGES_STAGE1),$(libraries/$(lib)_dist-install_dyn_LIB))
584
endif
585
BOOT_LIBS = $(foreach lib,$(PACKAGES_STAGE0),$(libraries/$(lib)_dist-boot_v_LIB))
586

587 588 589
# Only build internal interpreter support for the stage2 ghci lib
libraries/ghci_dist-install_CONFIGURE_OPTS += --flags=ghci

590
# ----------------------------------------
591 592 593 594
# Special magic for the ghc-prim package

# We want the ghc-prim package to include the GHC.Prim module when it
# is registered, but not when it is built, because GHC.Prim is not a
595
# real source module, it is built-in to GHC.
596

597
# Strip it out again before building the package:
598 599 600 601
define libraries/ghc-prim_PACKAGE_MAGIC
libraries/ghc-prim_dist-install_MODULES := $$(filter-out GHC.Prim,$$(libraries/ghc-prim_dist-install_MODULES))
endef

602
PRIMOPS_TXT_STAGE1 = compiler/stage1/build/primops.txt
603

604 605
libraries/ghc-prim/dist-install/build/GHC/PrimopWrappers.hs : $$(genprimopcode_INPLACE) $(PRIMOPS_TXT_STAGE1) | $$(dir $$@)/.
	"$(genprimopcode_INPLACE)" --make-haskell-wrappers < $(PRIMOPS_TXT_STAGE1) >$@
606

607 608
# Required so that Haddock documents the primops.
libraries/ghc-prim_dist-install_EXTRA_HADDOCK_SRCS = libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs
609

610 611 612 613 614
# ----------------------------------------
# Special magic for the integer package

ifneq "$(CLEANING)" "YES"
ifeq "$(INTEGER_LIBRARY)" "integer-gmp"
615
libraries/base_dist-install_CONFIGURE_OPTS += --flags=integer-gmp
616
compiler_stage2_CONFIGURE_OPTS += --flags=integer-gmp
Ian Lynagh's avatar
Ian Lynagh committed
617 618
else ifeq "$(INTEGER_LIBRARY)" "integer-simple"
libraries/base_dist-install_CONFIGURE_OPTS += --flags=integer-simple
619
compiler_stage2_CONFIGURE_OPTS += --flags=integer-simple
620 621 622 623 624
else
$(error Unknown integer library: $(INTEGER_LIBRARY))
endif
endif

625 626
# -----------------------------------------------------------------------------
# Include build instructions from all subdirs
627 628
BUILD_DIRS += utils/mkdirhier
BUILD_DIRS += utils/touchy
629
BUILD_DIRS += utils/unlit
630
BUILD_DIRS += utils/hp2ps
631
BUILD_DIRS += driver/split
632
BUILD_DIRS += utils/genprimopcode
633
BUILD_DIRS += driver
634
BUILD_DIRS += driver/ghci
635 636 637
BUILD_DIRS += driver/ghc
BUILD_DIRS += driver/haddock
BUILD_DIRS += libffi
638
BUILD_DIRS += utils/deriveConstants
639 640
BUILD_DIRS += includes
BUILD_DIRS += rts
rodlogic's avatar
rodlogic committed
641
BUILD_DIRS += bindisttest
642
BUILD_DIRS += utils/genapply
643 644 645
ifeq "$(Windows_Host)" "YES"
BUILD_DIRS += utils/gen-dll
endif
646

647 648 649 650
# When cleaning, don't add any library packages to BUILD_DIRS. We include
# ghc.mk files for all BUILD_DIRS, but they don't exist until after running
# `./boot`. Running `make clean` before anything else, as well as running
# `make maintainer-clean` twice, should work.
651
ifneq "$(CLEANING)" "YES"
652 653 654 655 656 657
# These are deliberately in reverse order, so as to ensure that
# there is no need to have them in dependency order. That's important
# because it's tricky to ensure that they are in dependency order when
# cross-compiling, as some packages may only be in PACKAGES_STAGE0
# or PACKAGES_STAGE1.
BUILD_DIRS += $(patsubst %, libraries/%, $(PACKAGES_STAGE2))
658
BUILD_DIRS += $(patsubst %, libraries/%, $(PACKAGES_STAGE1))
659
BUILD_DIRS += $(patsubst %, libraries/%, $(filter-out $(PACKAGES_STAGE1),$(PACKAGES_STAGE0)))
660
endif
661

Ian Lynagh's avatar
Ian Lynagh committed
662
BUILD_DIRS += libraries/integer-gmp/gmp
663 664
BUILD_DIRS += utils/haddock
BUILD_DIRS += utils/haddock/doc
665
BUILD_DIRS += compiler
666 667
BUILD_DIRS += utils/hsc2hs
BUILD_DIRS += utils/ghc-pkg
668
BUILD_DIRS += utils/testremove
669
BUILD_DIRS += utils/ghctags
670 671
BUILD_DIRS += utils/check-api-annotations
BUILD_DIRS += utils/check-ppr
672
BUILD_DIRS += utils/ghc-cabal
673
BUILD_DIRS += utils/hpc
674
BUILD_DIRS += utils/runghc
675
BUILD_DIRS += ghc
676
BUILD_DIRS += docs/users_guide
677 678
BUILD_DIRS += utils/count_lines
BUILD_DIRS += utils/compare_sizes
679
BUILD_DIRS += utils/iserv
680

Ian Lynagh's avatar
Ian Lynagh committed
681
# ----------------------------------------------
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
# Actually include the sub-ghc.mk's

ifeq "$(CLEANING)" "YES"
# Don't exclude any BUILD_DIRS when cleaning. When you for example build
# haddock once, but later set HADDOCK_DOCS back to NO, then 'make clean'
# should still clean the haddock directory.
else # CLEANING
ifeq "$(BINDIST)" "YES"
BUILD_DIRS := $(filter-out utils/mkdirhier,$(BUILD_DIRS))
BUILD_DIRS := $(filter-out utils/genprimopcode,$(BUILD_DIRS))
BUILD_DIRS := $(filter-out bindisttest,$(BUILD_DIRS))
BUILD_DIRS := $(filter-out utils/genapply,$(BUILD_DIRS))
endif
ifeq "$(HADDOCK_DOCS)" "NO"
BUILD_DIRS := $(filter-out utils/haddock,$(BUILD_DIRS))
BUILD_DIRS := $(filter-out utils/haddock/doc,$(BUILD_DIRS))
endif
699
ifeq "$(BUILD_SPHINX_HTML) $(BUILD_SPHINX_PDF)" "NO NO"
harendra's avatar
harendra committed
700
BUILD_DIRS := $(filter-out docs/users_guide,$(BUILD_DIRS))
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
# Don't to build this little utility if we're not building the User's Guide.
endif
ifeq "$(Windows_Host)" "NO"
BUILD_DIRS := $(filter-out utils/touchy,$(BUILD_DIRS))
endif
ifeq "$(GhcUnregisterised)" "YES"
BUILD_DIRS := $(filter-out driver/split,$(BUILD_DIRS))
endif
ifeq "$(GhcWithInterpreter)" "NO"
# runghc is just GHCi in disguise
BUILD_DIRS := $(filter-out utils/runghc,$(BUILD_DIRS))
endif
ifneq "$(INTEGER_LIBRARY)" "integer-gmp"
BUILD_DIRS := $(filter-out libraries/integer-gmp/gmp,$(BUILD_DIRS))
endif
ifneq "$(CrossCompiling) $(Stage1Only)" "NO NO"
# See Note [No stage2 packages when CrossCompiling or Stage1Only].
# See Note [Stage1Only vs stage=1] in mk/config.mk.in.
BUILD_DIRS := $(filter-out utils/ghctags,$(BUILD_DIRS))
720 721
BUILD_DIRS := $(filter-out utils/check-api-annotations,$(BUILD_DIRS))
BUILD_DIRS := $(filter-out utils/check-ppr,$(BUILD_DIRS))
722 723
endif
endif # CLEANING
724

725
include $(patsubst %, %/ghc.mk, $(BUILD_DIRS))
726

727 728 729 730 731
# A useful pseudo-target (must be after the include above, because it needs
# the value of things like $(libraries/base_dist-install_v_LIB).
.PHONY: stage1_libs
stage1_libs : $(ALL_STAGE1_LIBS)

732 733 734 735 736 737
# We need this extra dependency when building our own libffi, because
# GHCi.FFI.hs #includes ffi.h
ifneq "$(UseSystemLibFFI)" "YES"
libraries/ghci/dist-install/build/GHCi/FFI.hs : $(libffi_HEADERS)
endif

738 739
# ----------------------------------------------
# Per-package compiler flags
rodlogic's avatar
rodlogic committed
740
#
741
# If you want to add per-package compiler flags, see `mk/warnings.mk`.
742

743
# Add $(GhcLib(Extra)HcOpts) to all package builds
744
$(foreach pkg,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2),$(eval libraries/$(pkg)_dist-install_HC_OPTS += $$(GhcLibHcOpts)))
745
$(foreach pkg,$(PACKAGES_STAGE1) $(PACKAGES_STAGE2),$(eval libraries/$(pkg)_dist-install_EXTRA_HC_OPTS += $$(GhcLibExtraHcOpts)))
746

747
# Add $(GhcBootLib(Extra)HcOpts) to all stage0 package builds
748
$(foreach pkg,$(PACKAGES_STAGE0),$(eval libraries/$(pkg)_dist-boot_HC_OPTS += $$(GhcBootLibHcOpts)))
749
$(foreach pkg,$(PACKAGES_STAGE0),$(eval libraries/$(pkg)_dist-boot_EXTRA_HC_OPTS += $$(GhcBootLibExtraHcOpts)))
750

751 752 753 754 755 756 757 758
# -----------------------------------------------------------------------------
# Bootstrapping libraries

# We need to build a few libraries with the installed GHC, since GHC itself
# and some of the tools depend on them:

ifneq "$(BINDIST)" "YES"

759
ifneq "$(BOOTSTRAPPING_CONF)" ""
760
ifeq "$(wildcard $(BOOTSTRAPPING_CONF))" ""
761
$(shell "$(GHC_PKG)" init $(BOOTSTRAPPING_CONF))
762
endif
763
endif
764

765
$(eval $(call clean-target,root,bootstrapping_conf,$(BOOTSTRAPPING_CONF)))
766 767 768 769 770

# register the boot packages in strict sequence, because running
# multiple ghc-pkgs in parallel doesn't work (registrations may get
# lost).
fixed_pkg_prev=
771
$(foreach pkg,$(PACKAGES_STAGE0),$(eval $(call fixed_pkg_dep,$(pkg),dist-boot)))
772 773
# ghc-pkg, unlike other utils that we build with the stage0 compiler (TODO: is
# this really true?), depends on several boot packages (e.g. Cabal and
774
# ghc-boot). They need to be configured before ghc-pkg, so we add a
775 776
# dependency between their package-data.mk files. See also Note
# [Dependencies between package-data.mk files].
777 778
utils/ghc-pkg/dist/package-data.mk: $(fixed_pkg_prev)
compiler/stage1/package-data.mk:    $(fixed_pkg_prev)
779
endif
780

781
ifneq "$(BINDIST)" "YES"
782
# Make sure we have all the GHCi libs by the time we've built
783
# ghc-stage2.
784
#
Zejun Wu's avatar
Zejun Wu committed
785 786 787 788 789
GHCI_LIBS = \
    $(foreach way,$(GhcLibWays),\
        $(foreach lib,$(PACKAGES_STAGE1),\
            $(libraries/$(lib)_dist-install_$(way)_GHCI_LIB)) \
        $(compiler_stage2_$(way)_GHCI_LIB))
790

791
ifeq "$(UseArchivesForGhci)" "NO"
792
ghc/stage2/build/tmp/$(ghc_stage2_PROG) : $(GHCI_LIBS)
793
endif
794

Ian Lynagh's avatar
Ian Lynagh committed
795 796 797 798 799 800
ifeq "$(UseArchivesForGhci)" "YES"
GHCI_lib_way = v
else
GHCI_lib_way = GHCI
endif

801 802 803
# Deps for TH uses in libraries
$(foreach way, $(GhcLibWays),$(eval \
libraries/vector/dist-install/build/Data/Vector/Fusion/Stream/Monadic.$($(way)_osuf): \
Ian Lynagh's avatar
Ian Lynagh committed
804
    $(libraries/primitive_dist-install_$(GHCI_lib_way)_LIB) \
805
  ))
806 807
endif

808 809 810 811 812 813 814 815 816 817 818 819 820
# -----------------------------------------------
# Haddock-related bits

# Build the Haddock contents and index
ifeq "$(HADDOCK_DOCS)" "YES"
libraries/dist-haddock/index.html: $(haddock_INPLACE) $(ALL_HADDOCK_FILES)
	cd libraries && sh gen_contents_index --intree
ifeq "$(phase)" "final"
$(eval $(call all-target,library_doc_index,libraries/dist-haddock/index.html))
endif
INSTALL_LIBRARY_DOCS += libraries/dist-haddock/*
endif

821 822 823
# -----------------------------------------------------------------------------
# Creating a local mingw copy on Windows

824
ifeq "$(Windows_Host)" "YES"
825 826 827 828

install : install_mingw
.PHONY: install_mingw
install_mingw : $(INPLACE_MINGW)
829
	"$(CP)" -Rp $(INPLACE_MINGW) $(prefix)
830

Ian Lynagh's avatar
Ian Lynagh committed
831 832 833 834 835
install : install_perl
.PHONY: install_perl
install_perl : $(INPLACE_PERL)
	"$(CP)" -Rp $(INPLACE_PERL) $(prefix)

836
endif # Windows_Host
837

838
ifneq "$(BINDIST)" "YES"
839
$(ghc-prim-$(libraries/ghc-prim_dist-install_VERSION)_HADDOCK_FILE): \
840
    libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs
841
endif # BINDIST
842 843

libraries/ghc-prim/dist-install/build/autogen/GHC/Prim.hs: \
844
                            $(PRIMOPS_TXT_STAGE1) $$(genprimopcode_INPLACE) \
845
                          | $$(dir $$@)/.
846
	"$(genprimopcode_INPLACE)" --make-haskell-source < $< > $@
847

848 849 850
.PHONY: tags
tags: tags_compiler

851 852 853
.PHONY: TAGS
TAGS: TAGS_compiler

854 855 856
# -----------------------------------------------------------------------------
# Installation

857
install: install_libs install_packages install_libexecs \
858
         install_bins install_libexec_scripts
859 860 861
ifeq "$(HADDOCK_DOCS)" "YES"
install: install_docs
endif
862

863 864 865
define installLibsTo
# $1 = libraries to install
# $2 = directory to install to
866 867 868 869 870
#
# The .dll case calls STRIP_CMD explicitly, instead of `install -s`, because
# on Win64, "install -s" calls a strip that doesn't understand 64bit binaries.
# For some reason, this means the DLLs end up non-executable, which means
# executables that use them just segfault.
871
	$(INSTALL_DIR) $2
872
	for i in $1; do \
873 874
		case $$i in \
		  *.a) \
875
		    $(INSTALL_DATA) $(INSTALL_OPTS) $$i $2; \
876
		    $(RANLIB_CMD) $2/`basename $$i` ;; \
877
		  *.dll) \
878
		    $(INSTALL_PROGRAM) $(INSTALL_OPTS) $$i $2 ; \
879
		    $(STRIP_CMD) $2/`basename $$i` ;; \
880
		  *.so) \
881
		    $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $2 ;; \
882
		  *.dylib) \
883
		    $(INSTALL_SHLIB) $(INSTALL_OPTS) $$i $2;; \
884
		  *) \
885
		    $(INSTALL_DATA) $(INSTALL_OPTS) $$i $2; \
886 887
		esac; \
	done
888 889
endef

890
install_bins: $(INSTALL_BINS) $(INSTALL_SCRIPTS)
891
	$(INSTALL_DIR) "$(DESTDIR)$(bindir)"
892
ifneq "$(INSTALL_BINS)" ""
893
	for i in $(INSTALL_BINS); do \
894
		$(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i "$(DESTDIR)$(bindir)" ;  \
895
	done
896
endif
897
ifneq "$(INSTALL_SCRIPTS)" ""
898 899 900
	for i in $(INSTALL_SCRIPTS); do \
		$(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i "$(DESTDIR)$(bindir)" ;  \
	done
901
endif
902 903 904

install_libs: $(INSTALL_LIBS)
	$(call installLibsTo, $(INSTALL_LIBS), "$(DESTDIR)$(ghclibdir)")
905

906 907 908 909 910 911 912 913 914 915 916 917
# We rename ghc-stage2, so that the right program name is used in error
# messages etc. But not on windows.
RENAME_LIBEXEC_GHC_STAGE_TO_GHC = YES
ifeq "$(Stage1Only) $(Windows_Host)" "YES YES"
# resulting ghc-stage1 is built to run on windows
RENAME_LIBEXEC_GHC_STAGE_TO_GHC = NO
endif
ifeq "$(Stage1Only) $(Windows_Target)" "NO YES"
# resulting ghc-stage1 is built to run on windows
RENAME_LIBEXEC_GHC_STAGE_TO_GHC = NO
endif

918
install_libexecs:  $(INSTALL_LIBEXECS)
919
ifneq "$(INSTALL_LIBEXECS)" ""
920
	$(INSTALL_DIR) "$(DESTDIR)$(ghclibexecdir)/bin"
921
	for i in $(INSTALL_LIBEXECS); do \
922
		$(INSTALL_PROGRAM) $(INSTALL_BIN_OPTS) $$i "$(DESTDIR)$(ghclibexecdir)/bin"; \
923
	done
924
ifeq "$(RENAME_LIBEXEC_GHC_STAGE_TO_GHC)" "YES"
925
	"$(MV)" "$(DESTDIR)$(ghclibexecdir)/bin/ghc-stage$(INSTALL_GHC_STAGE)" "$(DESTDIR)$(ghclibexecdir)/bin/ghc"
926
endif
927
endif
928

929 930 931 932 933
install_libexec_scripts: $(INSTALL_LIBEXEC_SCRIPTS)
ifneq "$(INSTALL_LIBEXEC_SCRIPTS)" ""
	$(INSTALL_DIR) "$(DESTDIR)$(ghclibexecdir)/bin"
	for i in $(INSTALL_LIBEXEC_SCRIPTS); do \
		$(INSTALL_SCRIPT) $(INSTALL_OPTS) $$i "$(DESTDIR)$(ghclibexecdir)/bin"; \
934
	done
935
endif
936

937
install_docs: $(INSTALL_DOCS)
938
	$(INSTALL_DIR) "$(DESTDIR)$(docdir)"
939
ifneq "$(INSTALL_DOCS)" ""
940
	for i in $(INSTALL_DOCS); do \
941
		$(INSTALL_DOC) $(INSTALL_OPTS) $$i "$(DESTDIR)$(docdir)"; \
942
	done
943
endif
944 945
	$(INSTALL_DIR) "$(DESTDIR)$(docdir)/html"
	$(INSTALL_DOC) $(INSTALL_OPTS) docs/index.html "$(DESTDIR)$(docdir)/html"
946
ifneq "$(INSTALL_LIBRARY_DOCS)" ""
947
	$(INSTALL_DIR) "$(DESTDIR)$(docdir)/html/libraries"
948
	for i in $(INSTALL_LIBRARY_DOCS); do \
949
		$(INSTALL_DOC) $(INSTALL_OPTS) $$i "$(DESTDIR)$(docdir)/html/libraries/"; \
950
	done
951 952
	$(INSTALL_DATA) $(INSTALL_OPTS) libraries/prologue.txt "$(DESTDIR)$(docdir)/html/libraries/"
	$(INSTALL_SCRIPT) $(INSTALL_OPTS) libraries/gen_contents_index "$(DESTDIR)$(docdir)/html/libraries/"
953 954
endif
ifneq "$(INSTALL_HTML_DOC_DIRS)" ""
955
	for i in $(INSTALL_HTML_DOC_DIRS); do \
956
		$(CP) -Rp $$i "$(DESTDIR)$(docdir)/html"; \
957
	done
958
endif
959

960
INSTALLED_PACKAGE_CONF=$(DESTDIR)$(topdir)/package.conf.d
961

962
ifeq "$(BINDIST) $(CrossCompiling)" "NO YES"
963 964 965 966 967
# when installing ghc-stage2 we can't run target's
# 'ghc-pkg' and 'ghc-stage2' but those are needed for registration.
INSTALLED_GHC_REAL=$(TOP)/inplace/bin/ghc-stage1
INSTALLED_GHC_PKG_REAL=$(TOP)/$(ghc-pkg_DIST_BINARY)
else # CrossCompiling
968 969
# Install packages in the right order, so that ghc-pkg doesn't complain.
# Also, install ghc-pkg first.
970
ifeq "$(Windows_Host)" "NO"
971 972
INSTALLED_GHC_REAL=$(DESTDIR)$(ghclibexecdir)/bin/ghc
INSTALLED_GHC_PKG_REAL=$(DESTDIR)$(ghclibexecdir)/bin/ghc-pkg
973
else
Simon Marlow's avatar
Simon Marlow committed
974
INSTALLED_GHC_REAL=$(DESTDIR)$(bindir)/ghc.exe
975 976
INSTALLED_GHC_PKG_REAL=$(DESTDIR)$(bindir)/ghc-pkg.exe
endif
977
endif # CrossCompiling
978

979
# Set the INSTALL_DISTDIR_p for each package; compiler is special
980
$(foreach p,$(filter-out compiler,$(INSTALL_PACKAGES)),\
981
   $(eval INSTALL_DISTDIR_$p = dist-install))
982 983
INSTALL_DISTDIR_compiler = stage2

984
# Now we can do the installation
985
install_packages: install_libexecs
986
install_packages: rts/dist/package.conf.install
987
	$(INSTALL_DIR) "$(DESTDIR)$(topdir)"
988
	$(call removeTrees,"$(INSTALLED_PACKAGE_CONF)")
989 990
	$(INSTALL_DIR) "$(INSTALLED_PACKAGE_CONF)"
	$(INSTALL_DIR) "$(DESTDIR)$(topdir)/rts"
991
	$(call installLibsTo, $(RTS_INSTALL_LIBS), "$(DESTDIR)$(topdir)/rts")
992
	$(foreach p, $(INSTALL_PACKAGES),                             \
993
	    $(call make-command,                                      \
994
	           "$(ghc-cabal_INPLACE)" copy                        \
995
	                                  $p $(INSTALL_DISTDIR_$p)    \
ian@well-typed.com's avatar
ian@well-typed.com committed
996
	                                  "$(STRIP_CMD)"              \
997 998 999
	                                  '$(DESTDIR)'                \
	                                  '$(prefix)'                 \
	                                  '$(ghclibdir)'              \
1000 1001
	                                  '$(docdir)/html/libraries'  \
	                                  '$(GhcLibWays)'))
1002
	"$(INSTALLED_GHC_PKG_REAL)" --force --global-package-db "$(INSTALLED_PACKAGE_CONF)" update rts/dist/package.conf.install
1003
	$(foreach p, $(INSTALL_PACKAGES),                             \
1004
	    $(call make-command,                                      \
1005
	           "$(ghc-cabal_INPLACE)" register                    \
ian@well-typed.com's avatar
ian@well-typed.com committed
1006
	                                  $p $(INSTALL_DISTDIR_$p)    \
1007 1008 1009 1010 1011 1012 1013 1014
	                                  "$(INSTALLED_GHC_REAL)"     \
	                                  "$(INSTALLED_GHC_PKG_REAL)" \
	                                  "$(DESTDIR)$(topdir)"       \
	                                  '$(DESTDIR)'                \
	                                  '$(prefix)'                 \
	                                  '$(ghclibdir)'              \
	                                  '$(docdir)/html/libraries'  \
	                                  $(RelocatableBuild)))
1015
# when we install the packages above, ghc-pkg obeys umask when creating
1016 1017 1018 1019 1020
# the package.conf files, but for everything else we specify the
# permissions. We therefore now fix the permissions of package.cache.
# This means "sudo make install" does the right thing even if it runs
# with an 077 umask.
	for f in '$(INSTALLED_PACKAGE_CONF)'/*; do $(CREATE_DATA) "$$f"; done
1021

1022 1023
# Finally, update package.cache to ensure it's newer than the registration
# files. This avoids #13375.
1024
	"$(INSTALLED_GHC_PKG_REAL)" --global-package-db "$(INSTALLED_PACKAGE_CONF)" recache
1025

1026 1027 1028
# -----------------------------------------------------------------------------
# Binary distributions

Simon Marlow's avatar
Simon Marlow committed
1029 1030 1031 1032
ifneq "$(CLEANING)" "YES"
# This rule seems to hold some files open on Windows which prevents
# cleaning, perhaps due to the $(wildcard).

1033
$(eval $(call bindist-list,.,\
1034
    LICENSE \
1035 1036
    README \
    INSTALL \
1037
    configure config.sub config.guess install-sh \
1038
    settings.in \
Moritz Angermann's avatar
Moritz Angermann committed
1039
    llvm-targets \
1040
    llvm-passes \
1041
    packages \
1042 1043 1044
    Makefile \
    mk/config.mk.in \
    $(INPLACE_BIN)/mkdirhier \
1045
    utils/ghc-cabal/dist-install/build/tmp/ghc-cabal \
Ian Lynagh's avatar
Ian Lynagh committed
1046 1047 1048 1049 1050
    $(BINDIST_WRAPPERS) \
    $(BINDIST_PERL_SOURCES) \
    $(BINDIST_LIBS) \
    $(BINDIST_HI) \
    $(BINDIST_EXTRAS) \
1051
    $(includes_H_FILES) \
Ian Lynagh's avatar
Ian Lynagh committed
1052 1053
    $(includes_DERIVEDCONSTANTS) \
    $(includes_GHCCONSTANTS) \
1054
    $(libffi_HEADERS) \
1055 1056 1057
    $(INSTALL_LIBEXECS) \
    $(INSTALL_LIBEXEC_SCRIPTS) \
    $(INSTALL_BINS) \
1058
    $(INSTALL_SCRIPTS) \
1059
    $(INSTALL_MANPAGES) \
Ian Lynagh's avatar
Ian Lynagh committed
1060
    $(INSTALL_DOCS) \
1061
    $(INSTALL_LIBRARY_DOCS) \
Ian Lynagh's avatar
Ian Lynagh committed
1062
    $(addsuffix /*,$(INSTALL_HTML_DOC_DIRS)) \
Ian Lynagh's avatar
Ian Lynagh committed
1063
    docs/index.html \
1064
    $(wildcard compiler/stage2/doc) \
Ian Lynagh's avatar
Ian Lynagh committed
1065 1066
    $(wildcard libraries/*/dist-install/doc/) \
    $(wildcard libraries/*/*/dist-install/doc/) \
1067
    $(filter-out settings llvm-targets llvm-passes,$(INSTALL_LIBS)) \
1068
    $(RTS_INSTALL_LIBS) \
1069
    $(filter-out %/project.mk mk/config.mk %/mk/install.mk,$(MAKEFILE_LIST)) \
Ian Lynagh's avatar
Ian Lynagh committed
1070 1071 1072 1073 1074
    mk/project.mk \
    mk/install.mk.in \
    bindist.mk \
    libraries/gen_contents_index \
    libraries/prologue.txt \
1075
 ))
Simon Marlow's avatar
Simon Marlow committed
1076
endif
1077 1078 1079
# mk/project.mk gets an absolute path, so we manually include it in
# the bindist with a relative path

Ian Lynagh's avatar
Ian Lynagh committed
1080
BIN_DIST_MK = $(BIN_DIST_PREP_DIR)/bindist.mk
Ian Lynagh's avatar
Ian Lynagh committed
1081

1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
# Note [Persist CrossCompiling in binary distributions]
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#
# The build system uses the CrossCompiling variable to decide whether or not we
# should build various packages that must be built using the compiler.
# Consequently, it is important that we persist its value in the binary
# distribution so we know during `make install` not to go looking for files that
# would have been built for these packages. Failing to do this causes #13325.
#
# See Note [No stage2 packages when CrossCompiling or Stage1Only].

1093
unix-binary-dist-prep:
1094
	$(call removeTrees,bindistprep/)
1095
	"$(MKDIRHIER)" $(BIN_DIST_PREP_DIR)
1096
	set -e; for i in packages LICENSE compiler ghc rts libraries utils docs libffi includes driver mk rules Makefile aclocal.m4 config.sub config.guess install-sh settings.in llvm-targets llvm-passes ghc.mk inplace distrib/configure.ac distrib/README distrib/INSTALL; do ln -s ../../$$i $(BIN_DIST_PREP_DIR)/; done
Ian Lynagh's avatar
Ian Lynagh committed
1097
	echo "HADDOCK_DOCS       = $(HADDOCK_DOCS)"       >> $(BIN_DIST_MK)
1098 1099
	echo "BUILD_SPHINX_HTML  = $(BUILD_SPHINX_HTML)"  >> $(BIN_DIST_MK)
	echo "BUILD_SPHINX_PDF   = $(BUILD_SPHINX_PDF)"   >> $(BIN_DIST_MK)
1100
	echo "BUILD_MAN          = $(BUILD_MAN)"          >> $(BIN_DIST_MK)
ian@well-typed.com's avatar
ian@well-typed.com committed
1101
	echo "override ghc-cabal_INPLACE = utils/ghc-cabal/dist-install/build/tmp/ghc-cabal-bindist" >> $(BIN_DIST_MK)
1102
	echo "UseSystemLibFFI    = $(UseSystemLibFFI)"    >> $(BIN_DIST_MK)
1103 1104
# See Note [Persist CrossCompiling in binary distributions]
	echo "CrossCompiling     = $(CrossCompiling)"     >> $(BIN_DIST_MK)
Ian Lynagh's avatar
Ian Lynagh committed
1105
	cd $(BIN_DIST_PREP_DIR) && autoreconf
1106
	$(call removeFiles,$(BIN_DIST_PREP_TAR))
1107 1108
# h means "follow symlinks", e.g. if aclocal.m4 is a symlink to a source
# tree then we want to include the real file, not a symlink to it
1109 1110
	sort bindist-list | uniq > bindist-list.uniq
	cd bindistprep && "$(TAR_CMD)" hcf - -T ../bindist-list.uniq | $(TAR_COMP_CMD) -c > ../$(BIN_DIST_PREP_TAR_COMP)
1111

1112
windows-binary-dist-prep:
1113
	$(call removeTrees,bindistprep/)
1114
	$(MAKE) prefix=$(TOP)/$(BIN_DIST_PREP_DIR) install
1115
	cd bindistprep && "$(TAR_CMD)" cf - $(BIN_DIST_NAME) | $(TAR_COMP_CMD) -c > ../$(BIN_DIST_PREP_TAR_COMP)
1116

1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
# tryTimes tries to run its third argument multiple times, until it
# succeeds. Don't call it directly; call try10Times instead.
# The first and second argument to tryTimes are lists of values.
# The length of the first argument is the number of times we have
# already tried. The length of the second argument is the number more
# times we will try.
tryTimes = $(if $2, \
                { echo 'Try $(words x $1): $3' ; $3 ; } || \
                $(call tryTimes,x $1,$(wordlist 2,$(words $2),$2),$3), \
                )

# Try to run the argument 10 times. If all 10 fail, fail.
try10Times = $(call tryTimes,,x x x x x x x x x x,$1) { echo Failed; false; }
1130 1131 1132

.PHONY: publish-binary-dist
publish-binary-dist:
1133
	$(call try10Times,$(PublishCp) $(BIN_DIST_TAR_COMP) $(PublishLocation)/dist)
1134

1135
ifeq "$(mingw32_TARGET_OS)" "1"
1136
DOCDIR_TO_PUBLISH = $(BIN_DIST_INST_DIR)/doc
1137
else
1138
DOCDIR_TO_PUBLISH = $(BIN_DIST_INST_DIR)/share/doc/ghc
1139 1140
endif

Ian Lynagh's avatar
Ian Lynagh committed
1141 1142
.PHONY: publish-docs
publish-docs:
1143
	$(call try10Times,$(PublishCp) -r $(DOCDIR_TO_PUBLISH)/* $(PublishLocation)/docs)
Ian Lynagh's avatar
Ian Lynagh committed
1144

1145 1146 1147 1148 1149
# -----------------------------------------------------------------------------
# Source distributions

# Do it like this:
#
1150 1151
#	$ ./boot
#	$ ./configure
1152 1153 1154
#	$ make sdist
#

1155
# A source dist is built from a (partial) build tree, because we
1156
# require some extra files not contained in a git checkout: the
1157 1158
# output from Happy and Alex, for example.
#
1159 1160
# The steps performed by 'make sdist' are as follows:
#   - build those extra files
1161 1162 1163 1164 1165 1166 1167
#   - create a complete link-tree of the current build tree in /tmp
#   - run 'make distclean' on that tree
#   - remove a bunch of other files that we know shouldn't be in the dist

#
# Directory in which we're going to build the src dist
#
1168 1169 1170
SRC_DIST_ROOT      = sdistprep
SRC_DIST_BASE_NAME = ghc-$(ProjectVersion)

1171 1172 1173
SRC_DIST_GHC_NAME                 = ghc-$(ProjectVersion)-src
SRC_DIST_GHC_ROOT                 = $(SRC_DIST_ROOT)/ghc
SRC_DIST_GHC_DIR                  = $(SRC_DIST_GHC_ROOT)/$(SRC_DIST_BASE_NAME)
1174
SRC_DIST_GHC_TARBALL              = $(SRC_DIST_ROOT)/$(SRC_DIST_GHC_NAME).tar.$(TAR_COMP_EXT)
1175

1176 1177 1178
SRC_DIST_WINDOWS_TARBALLS_NAME    = ghc-$(ProjectVersion)-windows-extra-src
SRC_DIST_WINDOWS_TARBALLS_ROOT    = $(SRC_DIST_ROOT)/windows-tarballs
SRC_DIST_WINDOWS_TARBALLS_DIR     = $(SRC_DIST_WINDOWS_TARBALLS_ROOT)/$(SRC_DIST_BASE_NAME)
1179
SRC_DIST_WINDOWS_TARBALLS_TARBALL = $(SRC_DIST_ROOT)/$(SRC_DIST_WINDOWS_TARBALLS_NAME).tar.$(TAR_COMP_EXT)
1180 1181 1182 1183

SRC_DIST_TESTSUITE_NAME           = ghc-$(ProjectVersion)-testsuite
SRC_DIST_TESTSUITE_ROOT           = $(SRC_DIST_ROOT)/testsuite-ghc
SRC_DIST_TESTSUITE_DIR            = $(SRC_DIST_TESTSUITE_ROOT)/$(SRC_DIST_BASE_NAME)
1184
SRC_DIST_TESTSUITE_TARBALL        = $(SRC_DIST_ROOT)/$(SRC_DIST_TESTSUITE_NAME).tar.$(TAR_COMP_EXT)
1185 1186 1187 1188

#
# Files to include in source distributions
#
1189
SRC_DIST_GHC_DIRS = mk rules docs distrib bindisttest libffi includes \
1190
    utils docs rts compiler ghc driver libraries libffi-tarballs
1191 1192
SRC_DIST_GHC_FILES += \
    configure.ac config.guess config.sub configure \
1193
    aclocal.m4 README.md ANNOUNCE HACKING.md INSTALL.md LICENSE Makefile \
1194
    install-sh settings.in llvm-targets llvm-passes VERSION GIT_COMMIT_ID \
1195
    boot packages ghc.mk MAKEHELP.md
1196

1197 1198 1199 1200 1201
.PHONY: VERSION
VERSION:
	@if test -f $@ && test "`cat $@`" = "$(ProjectVersion)"; \
	then echo "$@ needs no update"; \
	else echo "update $@ ($(ProjectVersion))"; echo "$(ProjectVersion)" > $@; fi
1202

1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
.PHONY: GIT_COMMIT_ID
GIT_COMMIT_ID:
	@if test -d .git && test "`git rev-parse HEAD`" != "$(ProjectGitCommitId)"; then \
	   echo "******************************************************************************"; \
	   echo "Stale ProjectGitCommitId (=$(ProjectGitCommitId)) detected!"; \
           echo "'git rev-parse HEAD' says: `git rev-parse HEAD`"; \
	   echo "Please re-run './configure' before creating source-distribution"; \
	   echo "******************************************************************************"; \
	   exit 1; \
	fi
	@if test -f $@ && test "`cat $@`" = "$(ProjectGitCommitId)"; \
	then echo "$@ needs no update"; \
	else echo "update $@ ($(ProjectGitCommitId))"; echo -n "$(ProjectGitCommitId)" > $@; fi

1217
sdist-ghc-prep-tree : VERSION GIT_COMMIT_ID
1218

1219
# Extra packages which shouldn't be in the source distribution: see #8801
Ben Gamari's avatar
Ben Gamari committed
1220
EXTRA_PACKAGES=parallel
1221

1222 1223
.PHONY: sdist-ghc-prep-tree
sdist-ghc-prep-tree :
1224 1225
	$(call removeTrees,$(SRC_DIST_GHC_ROOT))
	$(call removeFiles,$(SRC_DIST_GHC_TARBALL))
1226 1227 1228 1229
	mkdir -p $(SRC_DIST_ROOT)
	mkdir -p $(SRC_DIST_GHC_ROOT)
	mkdir -p $(SRC_DIST_GHC_DIR)
	cd $(SRC_DIST_GHC_DIR) && for i in $(SRC_DIST_GHC_DIRS); do mkdir -p $$i; ( cd $$i && lndir $(TOP)/$$i ); done
1230 1231 1232 1233 1234 1235
	cd $(SRC_DIST_GHC_DIR) && for i in $(SRC_DIST_GHC_FILES); do $(LN_S) $(TOP)/$$i .; done
	cd $(SRC_DIST_GHC_DIR) && $(MAKE) distclean
	$(call removeTrees,$(SRC_DIST_GHC_DIR)/libraries/tarballs/)
	$(call removeTrees,$(SRC_DIST_GHC_DIR)/libraries/stamp/)
	$(call removeTrees,$(SRC_DIST_GHC_DIR)/compiler/stage[123])
	$(call removeFiles,$(SRC_DIST_GHC_DIR)/mk/build.mk)
1236
	for i in $(EXTRA_PACKAGES); do $(RM) $(RM_OPTS_REC) $(SRC_DIST_GHC_DIR)/libraries/$$i/; done
1237 1238
	cd $(SRC_DIST_GHC_DIR) && "$(FIND)" $(SRC_DIST_GHC_DIRS) \( -name .git -o -name "autom4te*" -o -name "*~" -o -name "\#*" -o -name ".\#*" -o -name "log" -o -name "*-SAVE" -o -name "*.orig" -o -name "*.rej" \) -print | "$(XARGS)" $(XARGS_OPTS) "$(RM)" $(RM_OPTS_REC)

1239 1240 1241 1242 1243 1244 1245 1246 1247
# Add files generated by alex and happy.
# These rules depend on sdist-ghc-prep-tree.
$(eval $(call sdist-ghc-file,compiler,stage2,cmm,CmmLex,x))
$(eval $(call sdist-ghc-file,compiler,stage2,cmm,CmmParse,y))
$(eval $(call sdist-ghc-file,compiler,stage2,parser,Lexer,x))
$(eval $(call sdist-ghc-file,compiler,stage2,parser,Parser,y))
$(eval $(call sdist-ghc-file,utils/hpc,dist-install,,HpcParser,y))
$(eval $(call sdist-ghc-file,utils/genprimopcode,dist,,Lexer,x))
$(eval $(call sdist-ghc-file,utils/genprimopcode,dist,,Parser,y))
1248 1249 1250 1251 1252 1253 1254 1255 1256

# Recent Cabal library versions have a pre-generated Lexer.hs in the source
# repo, and have moved Lexer.x out of the way, so trying to generate it from
# here no longer works, and is no longer necessary.
# According to https://github.com/haskell/cabal/issues/4633 however, this is
# only a temporary solution, so we will probably have to adjust to whatever
# the proper solution is going to be once there is one.
#
# $(eval $(call sdist-ghc-file2,libraries/Cabal/Cabal,dist-install,Distribution/Parsec,Lexer,x))
1257 1258 1259 1260

.PHONY: sdist-ghc-prep
sdist-ghc-prep : sdist-ghc-prep-tree

1261 1262 1263 1264
.PHONY: sdist-windows-tarballs-prep
sdist-windows-tarballs-prep :
	$(call removeTrees,$(SRC_DIST_WINDOWS_TARBALLS_ROOT))
	$(call removeFiles,$(SRC_DIST_WINDOWS_TARBALLS_TARBALL))
1265 1266 1267 1268
	mkdir -p $(SRC_DIST_ROOT)
	mkdir -p $(SRC_DIST_WINDOWS_TARBALLS_ROOT)
	mkdir -p $(SRC_DIST_WINDOWS_TARBALLS_DIR)
	mkdir -p $(SRC_DIST_WINDOWS_TARBALLS_DIR)/ghc-tarballs
1269 1270 1271
	cd $(SRC_DIST_WINDOWS_TARBALLS_DIR)/ghc-tarballs && lndir $(TOP)/ghc-tarballs
	$(call removeTrees,$(SRC_DIST_WINDOWS_TARBALLS_DIR)/ghc-tarballs/.git)

1272 1273 1274 1275
.PHONY: sdist-testsuite-prep
sdist-testsuite-prep :
	$(call removeTrees,$(SRC_DIST_TESTSUITE_ROOT))
	$(call removeFiles,$(SRC_DIST_TESTSUITE_TARBALL))
1276 1277 1278 1279
	mkdir -p $(SRC_DIST_ROOT)
	mkdir -p $(SRC_DIST_TESTSUITE_ROOT)
	mkdir -p $(SRC_DIST_TESTSUITE_DIR)
	mkdir -p $(SRC_DIST_TESTSUITE_DIR)/testsuite
1280
	cd $(SRC_DIST_TESTSUITE_DIR)/testsuite && lndir $(TOP)/testsuite
1281
	cd $(SRC_DIST_TESTSUITE_DIR)/testsuite && $(MAKE) distclean
1282

1283 1284
.PHONY: sdist-ghc
sdist-ghc: sdist-ghc-prep
1285
	cd $(SRC_DIST_GHC_ROOT)              && "$(TAR_CMD)" chf - $(SRC_DIST_BASE_NAME) 2> src_ghc_log               | $(TAR_COMP_CMD) -c > $(TOP)/$(SRC_DIST_GHC_TARBALL)
1286 1287 1288

.PHONY: sdist-windows-tarballs
sdist-windows-tarballs: sdist-windows-tarballs-prep
1289
	cd $(SRC_DIST_WINDOWS_TARBALLS_ROOT) && "$(TAR_CMD)" chf - $(SRC_DIST_BASE_NAME) 2> windows_extra_src_ghc_log | $(TAR_COMP_CMD) -c > $(TOP)/$(SRC_DIST_WINDOWS_TARBALLS_TARBALL)
1290 1291 1292

.PHONY: sdist-testsuite
sdist-testsuite: sdist-testsuite-prep
1293
	cd $(SRC_DIST_TESTSUITE_ROOT)        && "$(TAR_CMD)" chf - $(SRC_DIST_BASE_NAME) 2> testsuite_log             | $(TAR_COMP_CMD) -c > $(TOP)/$(SRC_DIST_TESTSUITE_TARBALL)
1294

1295 1296 1297 1298

.PHONY: sdist
sdist : sdist-ghc sdist-windows-tarballs sdist-testsuite

1299 1300
sdist-manifest : $(SRC_DIST_GHC_TARBALL)
	tar tjf $(SRC_DIST_GHC_TARBALL) | sed "s|^ghc-$(ProjectVersion)/||" | sort >sdist-manifest
1301 1302 1303 1304 1305 1306

# Upload the distribution(s)
# Retrying is to work around buggy firewalls that corrupt large file transfers
# over SSH.
ifneq "$(PublishLocation)" ""
publish-sdist :
1307 1308
	$(call try10Times,$(PublishCp) $(SRC_DIST_GHC_TARBALL) $(PublishLocation)/dist)
	$(call try10Times,$(PublishCp) $(SRC_DIST_TESTSUITE_TARBALL) $(PublishLocation)/dist)
1309 1310
endif

1311 1312 1313 1314 1315 1316 1317 1318 1319
# -----------------------------------------------------------------------------
# sdisting libraries

# Use manually, with e.g.:
#     make sdist_directory

sdist_%:
	inplace/bin/ghc-cabal sdist libraries/$* dist-install

1320 1321 1322 1323 1324
# -----------------------------------------------------------------------------
# Cleaning

.PHONY: clean