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