Build system improvements
[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 # $1 = dir
34 # $2 = distdir
35 # $3 = GHC stage to use (0 == bootstrapping compiler)
36
37 ifeq "$$(findstring $3,0 1 2)" ""
38 $$(error $1/$2: stage argument to build-package should be 0, 1, or 2)
39 endif
40
41 $(call clean-target,$1,$2,$1/$2)
42
43 distclean : clean_$1_$2_config
44
45 maintainer-clean : distclean
46
47 .PHONY: clean_$1_$2_config
48 clean_$1_$2_config:
49 "$$(RM)" $$(RM_OPTS) $1/config.log $1/config.status $1/include/Hs*Config.h
50 "$$(RM)" $$(RM_OPTS_REC) $1/autom4te.cache
51
52 ifneq "$$($1_$2_NOT_NEEDED)" "YES"
53 $$(eval $$(call build-package-helper,$1,$2,$3))
54 endif
55 endef
56
57
58 define build-package-helper
59 # $1 = dir
60 # $2 = distdir
61 # $3 = GHC stage to use (0 == bootstrapping compiler)
62
63 # --- CONFIGURATION
64
65 $(call package-config,$1,$2,$3)
66
67 ########################################
68 ifeq "$$($1_$2_CONFIGURE_PHASE)" ""
69 $$(error No configure phase for $1_$2)
70 else ifeq "$$($1_$2_CONFIGURE_PHASE)" "$$(phase)"
71
72 ifeq "$$(DEBUG)" "YES"
73 $$(warning $1/$2 configure phase)
74 endif
75
76 ifneq "$$(BINDIST)" "YES"
77 $(call build-package-data,$1,$2,$3)
78 endif
79
80 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
81 include $1/$2/package-data.mk
82 endif
83
84 else ifeq "$$(phase_$$($1_$2_CONFIGURE_PHASE)_or_later)" "YES"
85
86 ifeq "$$(DEBUG)" "YES"
87 $$(warning $1/$2 build phase)
88 endif
89
90 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
91 include $1/$2/package-data.mk
92 ifeq "$$($1_$2_VERSION)" ""
93 $$(error No version for $1_$2 found)
94 endif
95 endif
96
97 $(call all-target,$1,all_$1_$2)
98
99 else
100
101 ifeq "$$(DEBUG)" "YES"
102 $$(warning $1/$2 disabled phase)
103 endif
104
105 endif
106 ########################################
107
108 # We don't install things compiled by stage 0, so no need to put them
109 # in the bindist.
110 ifneq "$$(BINDIST) $3" "YES 0"
111
112 # This give us things like
113 # all_libraries: all_libraries/base_dist-install
114 ifneq "$$($1_$2_GROUP)" ""
115 all_$$($1_$2_GROUP): all_$1_$2
116 endif
117
118 ifneq "$$(CHECKED_$1)" "YES"
119 CHECKED_$1 = YES
120 check_packages: check_$1
121 .PHONY: check_$1
122 check_$1: $$(GHC_CABAL_INPLACE)
123 $$(GHC_CABAL_INPLACE) check $1
124 endif
125
126 ifeq "$$(phase_$$($1_$2_CONFIGURE_PHASE)_done)" "YES"
127
128 # Sometimes we need to modify the automatically-generated package-data.mk
129 # bindings in a special way for the GHC build system, so allow that here:
130 $($1_PACKAGE_MAGIC)
131
132 # Bootstrapping libs are only built one way
133 ifeq "$3" "0"
134 $1_$2_WAYS = v
135 else
136 $1_$2_WAYS = $$(GhcLibWays)
137 endif
138
139 $(call hs-sources,$1,$2)
140 $(call c-sources,$1,$2)
141 $(call includes-sources,$1,$2)
142
143 # --- DEPENDENCIES
144
145 # We must use a different dependency file if $(GhcLibWays) changes, so
146 # encode the ways into the name of the file.
147 $1_$2_WAYS_DASHED = $$(subst $$(space),,$$(patsubst %,-%,$$(strip $$($1_$2_WAYS))))
148 $1_$2_depfile_base = $1/$2/build/.depend$$($1_$2_WAYS_DASHED)
149
150 $(call build-dependencies,$1,$2,$3)
151
152 # --- BUILDING
153
154 # We don't bother splitting the bootstrap packages (built with stage 0)
155 ifeq "$$($1_$2_SplitObjs)" ""
156 ifeq "$$(SplitObjs) $3" "YES 1"
157 $1_$2_SplitObjs = YES
158 else
159 $1_$2_SplitObjs = NO
160 endif
161 endif
162
163 # C and S files are possibly built the "dyn" way.
164 ifeq "$$(BuildSharedLibs)" "YES"
165 $(call c-objs,$1,$2,dyn)
166 $(call c-suffix-rules,$1,$2,dyn,YES)
167 endif
168
169 # Now generate all the build rules for each way in this directory:
170 $$(foreach way,$$($1_$2_WAYS),$$(eval \
171 $$(call c-objs,$1,$2,$$(way)) \
172 $$(call c-suffix-rules,$1,$2,$$(way),YES) \
173 $$(call cmm-objs,$1,$2,$$(way)) \
174 $$(call cmm-suffix-rules,$1,$2,$$(way)) \
175 $$(call build-package-way,$1,$2,$$(way),$3) \
176 ))
177
178 $(call haddock,$1,$2)
179
180 endif # package-data.mk exists
181
182 # Don't put bootstrapping packages in the bindist
183 ifneq "$3" "0"
184 BINDIST_EXTRAS += $1/*.cabal $$(wildcard $1/*.buildinfo) $1/$2/setup-config $1/LICENSE
185 BINDIST_EXTRAS += $$($1_$2_INSTALL_INCLUDES_SRCS)
186 endif
187
188 endif
189
190 endef
191