Merge branch 'master' of http://darcs.haskell.org/ghc
[ghc.git] / rules / build-package.mk
1 # -----------------------------------------------------------------------------
2 #
3 # (c) 2009 The University of Glasgow
4 #
5 # This file is part of the GHC build system.
6 #
7 # To understand how the build system works and how to modify it, see
8 # http://hackage.haskell.org/trac/ghc/wiki/Building/Architecture
9 # http://hackage.haskell.org/trac/ghc/wiki/Building/Modifying
10 #
11 # -----------------------------------------------------------------------------
12
13
14 # Build a package with the stage-1 compiler, multiple ways. A typical
15 # libraries/foo/ghc.mk will look like this:
16 #
17 # $(eval $(call build-package,libraries/base,dist-install))
18 #
19 # The package metadata is generated from the .cabal file and placed in
20 # package-data.mk. It will look something like this:
21 #
22 # libraries/base_dist_MODULES = GHC.Base Data.Tuple ...
23 # libraries/base_dist_PACKAGE = base
24 # libraries/base_dist_VERSION = 4.0.0.0
25 # libraries/base_dist_HC_OPTS = -package ghc-prim-0.1.0.0 -XRank2Types ...
26 # libraries/base_dist_C_SRCS = cbits/PrelIOUtils.c ...
27 # libraries/base_dist_S_SRCS = cbits/foo.S ...
28 # libraries/base_dist_CC_OPTS = -Iinclude ...
29 # libraries/base_dist_LD_OPTS = -package ghc-prim-0.1.0.0
30
31 define build-package
32 $(call trace, build-package($1,$2,$3))
33 $(call profStart, build-package($1,$2,$3))
34 # $1 = dir
35 # $2 = distdir
36 # $3 = GHC stage to use (0 == bootstrapping compiler)
37
38 ifeq "$$(findstring $3,0 1 2)" ""
39 $$(error $1/$2: stage argument to build-package should be 0, 1, or 2)
40 endif
41
42 $(call clean-target,$1,$2,$1/$2)
43
44 distclean : clean_$1_$2_config
45
46 maintainer-clean : distclean
47
48 .PHONY: clean_$1_$2_config
49 clean_$1_$2_config:
50 $$(call removeFiles,$1/config.log $1/config.status $(wildcard $1/include/Hs*Config.h))
51 $$(call removeTrees,$1/autom4te.cache)
52
53 ifneq "$$($1_$2_NOT_NEEDED)" "YES"
54 $$(eval $$(call build-package-helper,$1,$2,$3))
55 endif
56 $(call profEnd, build-package($1,$2,$3))
57 endef
58
59
60 define build-package-helper
61 # $1 = dir
62 # $2 = distdir
63 # $3 = GHC stage to use (0 == bootstrapping compiler)
64
65 # --- CONFIGURATION
66
67 $(call package-config,$1,$2,$3)
68
69 ifeq "$3" "1"
70 $$($1_PACKAGE)_INSTALL_INFO = $1_$2
71 endif
72
73 # Bootstrapping libs are only built one way
74 ifeq "$3" "0"
75 $1_$2_WAYS = v
76 else
77 $1_$2_WAYS = $$(filter-out $$($1_$2_EXCLUDED_WAYS),$$(GhcLibWays))
78 endif
79
80 # We must use a different dependency file if $(GhcLibWays) changes, so
81 # encode the ways into the name of the file.
82 $1_$2_WAYS_DASHED = $$(subst $$(space),,$$(patsubst %,-%,$$(strip $$($1_$2_WAYS))))
83 $1_$2_depfile_base = $1/$2/build/.depend$$($1_$2_WAYS_DASHED)
84
85 $(call build-package-data,$1,$2,$3)
86 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
87 ifeq "$3" "0"
88 include $1/$2/package-data.mk
89 else ifeq "$(phase)" "final"
90 include $1/$2/package-data.mk
91 endif
92 # Each Haskell compilation in this package will depend on the
93 # package-data.mk file because e.g. if the version of the package
94 # changes we need to recompile everything in it.
95 $1_$2_PKGDATA_DEP = $1/$2/package-data.mk
96 endif
97
98 # We don't bother splitting the bootstrap packages (built with stage 0)
99 ifeq "$$($1_$2_SplitObjs)" ""
100 ifeq "$$(SplitObjs) $3" "YES 1"
101 $1_$2_SplitObjs = YES
102 else
103 $1_$2_SplitObjs = NO
104 endif
105 endif
106
107 $(call hs-sources,$1,$2)
108 $(call c-sources,$1,$2)
109 $(call includes-sources,$1,$2)
110
111 $(call dependencies,$1,$2,$3)
112
113 # Now generate all the build rules for each way in this directory:
114 $$(foreach way,$$($1_$2_WAYS),$$(eval \
115 $$(call c-objs,$1,$2,$$(way)) \
116 $$(call c-suffix-rules,$1,$2,$$(way),YES) \
117 $$(call cmm-objs,$1,$2,$$(way)) \
118 $$(call cmm-suffix-rules,$1,$2,$$(way)) \
119 $$(call build-package-way,$1,$2,$$(way),$3) \
120 ))
121
122 # Programs will need to depend on either the vanilla lib (if -static
123 # is the default) or the dyn lib (if -dynamic is the default). We
124 # conservatively make them depend on both, to keep things simple.
125 # If dyn libs are not being built then $$($1_$2_dyn_LIB) will just
126 # expand to the empty string, and be ignored.
127 $1_$2_PROGRAM_DEP_LIB = $$($1_$2_v_LIB) $$($1_$2_dyn_LIB)
128
129 # C and S files are possibly built the "dyn" way.
130 ifeq "$$(BuildSharedLibs)" "YES"
131 $(call c-objs,$1,$2,dyn)
132 $(call c-suffix-rules,$1,$2,dyn,YES)
133 endif
134
135 $(call all-target,$1,all_$1_$2)
136 # This give us things like
137 # all_libraries: all_libraries/base_dist-install
138 ifneq "$$($1_$2_GROUP)" ""
139 all_$$($1_$2_GROUP): all_$1_$2
140 endif
141
142 ifneq "$$(CHECKED_$1)" "YES"
143 CHECKED_$1 = YES
144 check_packages: check_$1
145 .PHONY: check_$1
146 check_$1: $$(GHC_CABAL_INPLACE)
147 CROSS_COMPILE="$(CrossCompilePrefix)" $$(GHC_CABAL_INPLACE) check $1
148 endif
149
150 ifneq "$3" "0"
151 $(call haddock,$1,$2)
152 endif
153
154 # Don't put bootstrapping packages in the bindist
155 ifneq "$3" "0"
156 BINDIST_EXTRAS += $1/*.cabal $$(wildcard $1/*.buildinfo) $1/$2/setup-config $1/LICENSE
157 BINDIST_EXTRAS += $$($1_$2_INSTALL_INCLUDES_SRCS)
158 endif
159
160 endef
161