Add a comment
[ghc.git] / rules / build-dependencies.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 define build-dependencies
14 $(call trace, build-dependencies($1,$2,$3))
15 $(call profStart, build-dependencies($1,$2,$3))
16 # $1 = dir
17 # $2 = distdir
18 # $3 = GHC stage to use (0 == bootstrapping compiler)
19
20 $1_$2_depfile_haskell = $$($1_$2_depfile_base).haskell
21 $1_$2_depfile_c_asm = $$($1_$2_depfile_base).c_asm
22
23 $1_$2_C_FILES_DEPS = $$(filter-out $$($1_$2_C_FILES_NODEPS),$$($1_$2_C_FILES))
24
25 $1_$2_MKDEPENDHS_FLAGS = -dep-makefile $$($1_$2_depfile_haskell).tmp $$(foreach way,$$($1_$2_WAYS),-dep-suffix "$$(patsubst %o,%,$$($$(way)_osuf))")
26 $1_$2_MKDEPENDHS_FLAGS += -include-pkg-deps
27
28 ifneq "$$(NO_GENERATED_MAKEFILE_RULES)" "YES"
29
30 # Some of the Haskell files (e.g. utils/hsc2hs/Main.hs) (directly or
31 # indirectly) include the generated includes files.
32 $$($1_$2_depfile_haskell) : $$(includes_H_CONFIG) $$(includes_H_PLATFORM)
33
34 $$($1_$2_depfile_haskell) : $$($1_$2_HS_SRCS) $$($1_$2_HS_BOOT_SRCS) $$$$($1_$2_HC_MK_DEPEND_DEP) | $$$$(dir $$$$@)/.
35 $$(call removeFiles,$$@.tmp)
36 ifneq "$$($1_$2_HS_SRCS)" ""
37 "$$($1_$2_HC_MK_DEPEND)" -M \
38 $$($1_$2_$$(firstword $$($1_$2_WAYS))_MOST_DIR_HC_OPTS) \
39 $$($1_$2_MKDEPENDHS_FLAGS) \
40 $$($1_$2_HS_SRCS)
41 endif
42 echo "$1_$2_depfile_haskell_EXISTS = YES" >> $$@.tmp
43 ifneq "$$($1_$2_SLASH_MODS)" ""
44 for dir in $$(sort $$(foreach mod,$$($1_$2_SLASH_MODS),$1/$2/build/$$(dir $$(mod)))); do \
45 if test ! -d $$$$dir; then mkdir -p $$$$dir; fi \
46 done
47 endif
48 # Some packages are from the bootstrapping compiler, so are not
49 # within the build tree. On Windows this causes a problem as they look
50 # like bad rules, due to the two colons, so we filter them out.
51 grep -v ' : [a-zA-Z]:/' $$@.tmp > $$@.tmp2
52 # Insert the calls to hi-rule. Basically, we look for the
53 # Foo.dyn_o Foo.o : Foo.hs
54 # lines, and create corresponding hi-rule lines
55 # $(eval $(call hi-rule,Foo.dyn_hi Foo.hi : %hi: %o Foo.hs))
56 sed '/hs$$$$/ p ; \
57 /hs$$$$/ s/o /hi /g ; \
58 /hs$$$$/ s/:/ : %hi: %o / ; \
59 /hs$$$$/ s/^/$$$$(eval $$$$(call hi-rule,/ ; \
60 /hs$$$$/ s/$$$$/))/ ; \
61 /hs-boot$$$$/ p ; \
62 /hs-boot$$$$/ s/o-boot /hi-boot /g ; \
63 /hs-boot$$$$/ s/:/ : %hi-boot: %o-boot / ; \
64 /hs-boot$$$$/ s/^/$$$$(eval $$$$(call hi-rule,/ ; \
65 /hs-boot$$$$/ s/$$$$/))/' \
66 $$@.tmp2 > $$@
67
68 # Some of the C files (directly or indirectly) include the generated
69 # includes files.
70 $$($1_$2_depfile_c_asm) : $$(includes_H_CONFIG) $$(includes_H_PLATFORM)
71
72 $$($1_$2_depfile_c_asm) : $$($1_$2_C_FILES_DEPS) $$($1_$2_S_FILES) $$($1_$2_CMM_FILES) | $$$$(dir $$$$@)/.
73 $$(call removeFiles,$$@.tmp)
74 ifneq "$$(strip $$($1_$2_C_FILES_DEPS) $$($1_$2_S_FILES)) $$($1_$2_CMM_FILES))" ""
75 # We ought to actually do this for each way in $$($1_$2_WAYS), but then
76 # it takes a long time to make the C deps for the RTS (30 seconds rather
77 # than 3), so instead we just pass the list of ways in and let addCFileDeps
78 # copy the deps for each way on the assumption that they are the same
79 $$(foreach f,$$($1_$2_C_FILES_DEPS) $$($1_$2_S_FILES) $$($1_$2_CMM_FILES), \
80 $$(call addCFileDeps,$1,$2,$$($1_$2_depfile_c_asm),$$f,$$($1_$2_WAYS)))
81 $$(call removeFiles,$$@.bit)
82 endif
83 echo "$1_$2_depfile_c_asm_EXISTS = YES" >> $$@.tmp
84 mv $$@.tmp $$@
85
86 endif # NO_GENERATED_MAKEFILE_RULES
87
88 # Note sed magic above: mkdependC can't do -odir stuff, so we have to
89 # munge the dependencies it generates to refer to the correct targets.
90
91 $(call profEnd, build-dependencies($1,$2,$3))
92 endef
93
94 # This comment is outside the "define addCFileDeps" as that definition
95 # is a list of command lines, and if it is inside it then we pass this
96 # comment to the shell every time we call the definition.
97 # $1 = dir
98 # $2 = distdir
99 # $3 = depfile
100 # $4 = file
101 # $5 = ways
102 #
103 # The formatting of this definition (e.g. the blank line above) is
104 # important, in order to get make to generate the right makefile code.
105 #
106 # 's|\\|/|g'
107 # We first normalise all slashes to be forward slashes. Note that
108 # $(TOP) also uses forward slashes.
109 # 's| /$$| \\|'
110 # But now we need to fix the line continuation characters that we
111 # just broke.
112 # "1s|\.o|\.$($w_osuf)|"
113 # We will have dependencies for .o files, so we need to fix them up
114 # for the right object suffix for the way we're doing
115 # "1s|^|$(dir $4)|"
116 # We always get deps for just foo.o when the file we're making is
117 # a/b/c/foo.o, so we need to prepend the directory of the source file
118 # "1s|$1/|$1/$2/build/|"
119 # Well, almost. We actually need to insert e.g. "dist/build" in the
120 # middle of that directory
121 # "1s|$2/build/$2/build|$2/build|g"
122 # But some source files, e.g. sm/Evac_thr.c, are also inside the
123 # "dist/build" directory, so now we've just made
124 # "dist/build/dist/build", so we need to remove the duplication
125 # again
126 # "s|$(TOP)/||g$(CASE_INSENSITIVE_SED)"
127 # Finally, when making deps for packages like ghc stage2, we have
128 # some include paths for packages registered in the in-tree package
129 # database. These include paths are full (i.e. not relative) paths,
130 # which means that the "cpp -MM" output uses full paths in some cases.
131 # This causes 2 problems:
132 # * they don't match up with the rules to rebuild the files, where
133 # appropriate.
134 # * on Windows, make interprets the colon in c:/foo/bar.h as make
135 # syntax.
136 # So we sed off $(TOP). Unfortunately, on Windows, the case for the
137 # drive letter is sometimes different in what $(TOP) starts with, and
138 # what the path in the package database starts with. We therefore
139 # need to do the substitution case-insensitively on Windows. But
140 # the s///i modifier isn't portable, so we set CASE_INSENSITIVE_SED
141 # to "i" on Windows and "" on any other platform.
142
143 # We use this not only for .c files, but also for .S and .cmm files.
144 # As gcc doesn't know what a .cmm file is, it treats it as a linker
145 # input and ignores it. We therefore tell gcc that all files are C
146 # files with "-x c" so that it actually processes them all.
147
148 define addCFileDeps
149
150 $(CPP) $($1_$2_MKDEPENDC_OPTS) $($1_$2_$(firstword $($1_$2_WAYS))_ALL_CC_OPTS) $($(basename $4)_CC_OPTS) -MM -x c $4 -MF $3.bit
151 $(foreach w,$5,sed -e 's|\\|/|g' -e 's| /$$| \\|' -e "1s|\.o|\.$($w_osuf)|" -e "1s|^|$(dir $4)|" -e "1s|$1/|$1/$2/build/|" -e "1s|$2/build/$2/build|$2/build|g" -e "s|$(TOP)/||g$(CASE_INSENSITIVE_SED)" $3.bit >> $3.tmp &&) true
152 endef
153
154 ifeq "$(Windows_Host)" "YES"
155 CASE_INSENSITIVE_SED = i
156 else
157 CASE_INSENSITIVE_SED =
158 endif
159