buildinfo files need a $$(wildcard)
[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 # $1 = dir
33 # $2 = distdir
34 # $3 = GHC stage to use (0 == bootstrapping compiler)
35
36 ifeq "$$(findstring $3,0 1 2)" ""
37 $$(error $1/$2: stage argument to build-package should be 0, 1, or 2)
38 endif
39
40 # We don't install things compiled by stage 0, so no need to put them
41 # in the bindist.
42 ifneq "$$(BINDIST) $3" "YES 0"
43
44 $(call all-target,$1,all_$1_$2)
45 $(call clean-target,$1,$2,$1/$2)
46 # This give us things like
47 # all_libraries: all_libraries/base_dist-install
48 ifneq "$$($1_$2_GROUP)" ""
49 all_$$($1_$2_GROUP): all_$1_$2
50 endif
51
52 distclean : clean_$1_$2_config
53
54 maintainer-clean : distclean
55
56 .PHONY: clean_$1_$2_config
57 clean_$1_$2_config:
58 "$$(RM)" $$(RM_OPTS) $1/config.log $1/config.status $1/include/Hs*Config.h
59 "$$(RM)" $$(RM_OPTS) -r $1/autom4te.cache
60
61 # --- CONFIGURATION
62
63 $1_$2_USE_BOOT_LIBS = YES
64 $(call package-config,$1,$2,$3)
65
66 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
67 include $1/$2/package-data.mk
68 endif
69
70 ifeq "$$($1_$2_DISABLE)" "YES"
71
72 ifeq "$$(DEBUG)" "YES"
73 $$(warning $1/$2 disabled)
74 endif
75
76 # A package is disabled when we want to bring its package-data.mk file
77 # up-to-date first, or due to other build dependencies.
78
79 $(call all-target,$1_$2,$1/$2/package-data.mk)
80
81 ifneq "$$(BINDIST)" "YES"
82 # We have a rule for package-data.mk only when the package is
83 # disabled, because we want the build to fail if we haven't run phase 0.
84 $(call build-package-data,$1,$2)
85 endif
86
87 else
88
89 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
90 ifeq "$$($1_$2_VERSION)" ""
91 $$(error phase ordering error: $1/$2 is enabled, but $1/$2/package-data.mk does not exist)
92 endif
93 endif
94
95 # Sometimes we need to modify the automatically-generated package-data.mk
96 # bindings in a special way for the GHC build system, so allow that here:
97 $($1_PACKAGE_MAGIC)
98
99 # Bootstrapping libs are only built one way
100 ifeq "$3" "0"
101 $1_$2_WAYS = v
102 else
103 $1_$2_WAYS = $$(GhcLibWays)
104 endif
105
106 $(call hs-sources,$1,$2)
107 $(call c-sources,$1,$2)
108 $(call includes-sources,$1,$2)
109
110 # --- DEPENDENCIES
111
112 # We must use a different dependency file if $(GhcLibWays) changes, so
113 # encode the ways into the name of the file.
114 $1_$2_WAYS_DASHED = $$(subst $$(space),,$$(patsubst %,-%,$$(strip $$($1_$2_WAYS))))
115 $1_$2_depfile = $1/$2/build/.depend$$($1_$2_WAYS_DASHED)
116
117 $(call build-dependencies,$1,$2)
118
119 # --- BUILDING
120
121 # We don't bother splitting the bootstrap packages (built with stage 0)
122 ifeq "$$($1_$2_SplitObjs)" ""
123 ifeq "$$(SplitObjs) $3" "YES 1"
124 $1_$2_SplitObjs = YES
125 else
126 $1_$2_SplitObjs = NO
127 endif
128 endif
129
130 $(call distdir-opts,$1,$2,$3)
131
132 # C and S files are possibly built the "dyn" way.
133 ifeq "$(BuildSharedLibs)" "YES"
134 $(call c-objs,$1,$2,dyn)
135 $(call c-suffix-rules,$1,$2,dyn,YES)
136 endif
137
138 # Now generate all the build rules for each way in this directory:
139 $$(foreach way,$$($1_$2_WAYS),$$(eval \
140 $$(call c-objs,$1,$2,$$(way)) \
141 $$(call c-suffix-rules,$1,$2,$$(way),YES) \
142 $$(call cmm-objs,$1,$2,$$(way)) \
143 $$(call cmm-suffix-rules,$1,$2,$$(way)) \
144 $$(call build-package-way,$1,$2,$$(way),$3) \
145 ))
146
147 $(call haddock,$1,$2)
148
149 endif # package-data.mk exists
150
151 # Don't put bootstrapping packages in the bindist
152 ifneq "$3" "0"
153 BINDIST_EXTRAS += $1/*.cabal $$(wildcard $1/*.buildinfo) $1/$2/setup-config $1/LICENSE
154 BINDIST_EXTRAS += $$($1_$2_INSTALL_INCLUDES_SRCS)
155 endif
156
157 endif
158
159 endef
160