1 # -----------------------------------------------------------------------------
3 # (c) 2009 The University of Glasgow
5 # This file is part of the GHC build system.
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
11 # -----------------------------------------------------------------------------
13 # -----------------------------------------------------------------------------
16 # We build the RTS with stage 1
17 rts_dist_HC = $(GHC_STAGE1)
19 # merge GhcLibWays and GhcRTSWays but strip out duplicates
20 rts_WAYS = $(GhcLibWays) $(filter-out $(GhcLibWays),$(GhcRTSWays))
21 rts_dist_WAYS = $(rts_WAYS)
23 ALL_RTS_LIBS = rts/dist/build/libHSrtsmain.a \
24 $(foreach way,$(rts_WAYS),rts/dist/build/libHSrts$($(way)_libsuf))
25 all_rts : $(ALL_RTS_LIBS)
27 # -----------------------------------------------------------------------------
28 # Defining the sources
30 ALL_DIRS = hooks parallel sm eventlog
32 ifeq "$(HOSTPLATFORM)" "i386-unknown-mingw32"
38 EXCLUDED_SRCS += rts/Main.c
39 EXCLUDED_SRCS += rts/parallel/SysMan.c
40 EXCLUDED_SRCS += rts/dyn-wrapper.c
41 EXCLUDED_SRCS += $(wildcard rts/Vis*.c)
43 rts_C_SRCS = $(filter-out $(EXCLUDED_SRCS),$(wildcard rts/*.c $(foreach dir,$(ALL_DIRS),rts/$(dir)/*.c)))
44 rts_CMM_SRCS = $(wildcard rts/*.cmm)
46 # Don't compile .S files when bootstrapping a new arch
47 ifneq "$(PORTING_HOST)" "YES"
48 ifneq "$(findstring $(TargetArch_CPP), powerpc powerpc64)" ""
49 rts_S_SRCS += rts/AdjustorAsm.S
51 ifneq "$(findstring $(TargetOS_CPP), darwin)" ""
52 rts_S_SRCS += rts/AdjustorAsm.S
57 ifeq "$(GhcUnregisterised)" "YES"
61 rts_AUTO_APPLY_CMM = rts/dist/build/AutoApply.cmm
63 $(rts_AUTO_APPLY_CMM): $(GENAPPLY_INPLACE)
64 "$(GENAPPLY_INPLACE)" >$@
66 rts/dist/build/sm/Evac_thr.c : rts/sm/Evac.c | $$(dir $$@)/.
68 rts/dist/build/sm/Scav_thr.c : rts/sm/Scav.c | $$(dir $$@)/.
71 rts_H_FILES = $(wildcard includes/*.h) $(wildcard rts/*.h)
73 ifeq "$(HaveDtrace)" "YES"
74 DTRACEPROBES_H = rts/dist/build/RtsProbes.h
75 rts_H_FILES += $(DTRACEPROBES_H)
78 # collect the -l flags that we need to link the rts dyn lib.
79 rts/libs.depend : $(GHC_PKG_INPLACE)
80 "$(GHC_PKG_INPLACE)" field rts extra-libraries \
81 | sed -e 's/^extra-libraries: //' -e 's/\([a-z0-9]*\)[ ]*/-l\1 /g' > $@
84 # ----------------------------------------------------------------------------
85 # On Windows, as the RTS and base libraries have recursive imports,
86 # we have to break the loop with "import libraries".
87 # These are made from rts/win32/libHS*.def which contain lists of
88 # all the symbols in those libraries used by the RTS.
90 ifneq "$$(findstring dyn, $1)" ""
91 ifeq "$(HOSTPLATFORM)" "i386-unknown-mingw32"
93 ALL_RTS_DEF_LIBNAMES = base ghc-prim
95 rts/dist/build/win32/libHSbase.dll.a \
96 rts/dist/build/win32/libHSghc-prim.dll.a \
97 rts/dist/build/win32/libHSffi.dll.a
99 # -- import libs for the regular Haskell libraries
100 define make-importlib-def # args $1 = lib name
101 rts/dist/build/win32/libHS$1.def : rts/win32/libHS$1.def
102 cat rts/win32/libHS$1.def \
103 | sed "s/@LibVersion@/$$(libraries/$1_dist-install_VERSION)/" \
104 | sed "s/@ProjectVersion@/$(ProjectVersion)/" \
105 > rts/dist/build/win32/libHS$1.def
107 rts/dist/build/win32/libHS$1.dll.a : rts/dist/build/win32/libHS$1.def
108 "$$(DLLTOOL)" -d rts/dist/build/win32/libHS$1.def \
109 -l rts/dist/build/win32/libHS$1.dll.a
111 $(foreach lib,$(ALL_RTS_DEF_LIBNAMES),$(eval $(call make-importlib-def,$(lib))))
114 # -- import libs for libffi
115 rts/dist/build/win32/libHSffi.def : rts/win32/libHSffi.def
116 cat rts/win32/libHSffi.def \
117 | sed "s/@ProjectVersion@/$(ProjectVersion)/" \
118 > rts/dist/build/win32/libHSffi.def
120 rts/dist/build/win32/libHSffi.dll.a : rts/dist/build/win32/libHSffi.def
121 "$(DLLTOOL)" -d rts/dist/build/win32/libHSffi.def \
122 -l rts/dist/build/win32/libHSffi.dll.a
127 #-----------------------------------------------------------------------------
129 define build-rts-way # args: $1 = way
131 ifneq "$$(BINDIST)" "YES"
133 # The per-way CC_OPTS
134 ifneq "$$(findstring debug, $1)" ""
135 rts_dist_$1_HC_OPTS =
136 rts_dist_$1_CC_OPTS = -g -O0
138 rts_dist_$1_HC_OPTS = $$(GhcRtsHcOpts)
139 rts_dist_$1_CC_OPTS = $$(GhcRtsCcOpts)
142 ifneq "$$(findstring thr, $1)" ""
143 rts_$1_EXTRA_C_SRCS = rts/dist/build/sm/Evac_thr.c rts/dist/build/sm/Scav_thr.c
146 $(call distdir-way-opts,rts,dist,$1)
147 $(call c-suffix-rules,rts,dist,$1,YES)
148 $(call cmm-suffix-rules,rts,dist,$1)
149 $(call hs-suffix-rules-srcdir,rts,dist,$1,$$(dir))
150 # hs-suffix-rules-srcdir is needed when BootingFromHc to get the .hc rules
152 rts_$1_LIB_NAME = libHSrts$$($1_libsuf)
153 rts_$1_LIB = rts/dist/build/$$(rts_$1_LIB_NAME)
155 rts_$1_C_OBJS = $$(patsubst rts/%.c,rts/dist/build/%.$$($1_osuf),$$(rts_C_SRCS)) $$(patsubst %.c,%.$$($1_osuf),$$(rts_$1_EXTRA_C_SRCS))
156 rts_$1_S_OBJS = $$(patsubst rts/%.S,rts/dist/build/%.$$($1_osuf),$$(rts_S_SRCS))
157 rts_$1_CMM_OBJS = $$(patsubst rts/%.cmm,rts/dist/build/%.$$($1_osuf),$$(rts_CMM_SRCS)) $$(patsubst %.cmm,%.$$($1_osuf),$$(rts_AUTO_APPLY_CMM))
159 rts_$1_OBJS = $$(rts_$1_C_OBJS) $$(rts_$1_S_OBJS) $$(rts_$1_CMM_OBJS)
161 rts_dist_$1_CC_OPTS += -DRtsWay=$$(DQ)rts_$1$$(DQ)
163 # Making a shared library for the RTS.
164 ifneq "$$(findstring dyn, $1)" ""
165 ifeq "$$(HOSTPLATFORM)" "i386-unknown-mingw32"
166 $$(rts_$1_LIB) : $$(rts_$1_OBJS) $$(ALL_RTS_DEF_LIBS) rts/libs.depend
167 "$$(RM)" $$(RM_OPTS) $$@
168 "$$(rts_dist_HC)" -package-name rts -shared -dynamic -dynload deploy \
169 -no-auto-link-packages `cat rts/libs.depend` $$(rts_$1_OBJS) $$(ALL_RTS_DEF_LIBS) -o $$@
171 $$(rts_$1_LIB) : $$(rts_$1_OBJS) rts/libs.depend
172 "$$(RM)" $$(RM_OPTS) $$@
173 "$$(rts_dist_HC)" -package-name rts -shared -dynamic -dynload deploy \
174 -no-auto-link-packages `cat rts/libs.depend` $$(rts_$1_OBJS) -o $$@
175 ifeq "$$(darwin_HOST_OS)" "1"
176 # Ensure library's install name is correct before anyone links with it.
177 install_name_tool -id $(ghclibdir)/$$(rts_$1_LIB_NAME) $$@
181 $$(rts_$1_LIB) : $$(rts_$1_OBJS)
182 "$$(RM)" $$(RM_OPTS) $$@
183 echo $$(rts_$1_OBJS) | "$$(XARGS)" $$(XARGS_OPTS) "$$(AR)" $$(AR_OPTS) $$(EXTRA_AR_ARGS) $$@
190 # And expand the above for each way:
191 $(foreach way,$(rts_WAYS),$(eval $(call build-rts-way,$(way))))
193 #-----------------------------------------------------------------------------
194 # Flags for compiling every file
196 # We like plenty of warnings.
197 WARNING_OPTS += -Wall
198 ifeq "$(GccLT34)" "YES"
201 WARNING_OPTS += -Wextra
203 WARNING_OPTS += -Wstrict-prototypes
204 WARNING_OPTS += -Wmissing-prototypes
205 WARNING_OPTS += -Wmissing-declarations
206 WARNING_OPTS += -Winline
207 WARNING_OPTS += -Waggregate-return
208 WARNING_OPTS += -Wpointer-arith
209 WARNING_OPTS += -Wmissing-noreturn
210 WARNING_OPTS += -Wnested-externs
211 WARNING_OPTS += -Wredundant-decls
213 # These ones are hard to avoid:
214 #WARNING_OPTS += -Wconversion
215 #WARNING_OPTS += -Wbad-function-cast
216 #WARNING_OPTS += -Wshadow
217 #WARNING_OPTS += -Wcast-qual
219 # This one seems buggy on GCC 4.1.2, which is the only GCC version we
220 # have that can bootstrap the SPARC build. We end up with lots of supurious
221 # warnings of the form "cast increases required alignment of target type".
222 # Some legitimate warnings can be fixed by adding an intermediate cast to
223 # (void*), but we get others in rts/sm/GCUtils.c concerning the gct var
224 # that look innocuous to me. We could enable this again once we deprecate
225 # support for registerised builds on this arch. -- BL 2010/02/03
226 # WARNING_OPTS += -Wcast-align
228 STANDARD_OPTS += -Iincludes -Irts
229 # COMPILING_RTS is only used when building Win32 DLL support.
230 STANDARD_OPTS += -DCOMPILING_RTS
232 # HC_OPTS is included in both .c and .cmm compilations, whereas CC_OPTS is
233 # only included in .c compilations. HC_OPTS included the WAY_* opts, which
234 # must be included in both types of compilations.
236 rts_CC_OPTS += $(WARNING_OPTS)
237 rts_CC_OPTS += $(STANDARD_OPTS)
239 rts_HC_OPTS += $(STANDARD_OPTS) -package-name rts
241 ifneq "$(GhcWithSMP)" "YES"
242 rts_CC_OPTS += -DNOSMP
243 rts_HC_OPTS += -optc-DNOSMP
246 ifeq "$(UseLibFFIForAdjustors)" "YES"
247 rts_CC_OPTS += -DUSE_LIBFFI_FOR_ADJUSTORS
250 # Mac OS X: make sure we compile for the right OS version
251 rts_CC_OPTS += $(MACOSX_DEPLOYMENT_CC_OPTS)
252 rts_HC_OPTS += $(addprefix -optc, $(MACOSX_DEPLOYMENT_CC_OPTS))
253 rts_LD_OPTS += $(addprefix -optl, $(MACOSX_DEPLOYMENT_LD_OPTS))
255 # We *want* type-checking of hand-written cmm.
256 rts_HC_OPTS += -dcmm-lint
258 # -fno-strict-aliasing is required for the runtime, because we often
259 # use a variety of types to represent closure pointers (StgPtr,
260 # StgClosure, StgMVar, etc.), and without -fno-strict-aliasing gcc is
261 # allowed to assume that these pointers do not alias. eg. without
262 # this flag we get problems in sm/Evac.c:copy() with gcc 3.4.3, the
263 # upd_evacee() assigments get moved before the object copy.
264 rts_CC_OPTS += -fno-strict-aliasing
266 rts_CC_OPTS += -fno-common
268 ifeq "$(BeConservative)" "YES"
269 rts_CC_OPTS += -DBE_CONSERVATIVE
272 #-----------------------------------------------------------------------------
273 # Flags for compiling specific files
275 # XXX DQ is now the same on all platforms, so get rid of it
278 # If RtsMain.c is built with optimisation then the SEH exception stuff on
279 # Windows gets confused.
280 # This has to be in HC rather than CC opts, as otherwise there's a
281 # -optc-O2 that comes after it.
282 rts/RtsMain_HC_OPTS += -optc-O0
284 rts/RtsMessages_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
285 rts/RtsUtils_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
287 rts/RtsUtils_CC_OPTS += -DHostPlatform=$(DQ)$(HOSTPLATFORM)$(DQ)
288 rts/RtsUtils_CC_OPTS += -DHostArch=$(DQ)$(HostArch_CPP)$(DQ)
289 rts/RtsUtils_CC_OPTS += -DHostOS=$(DQ)$(HostOS_CPP)$(DQ)
290 rts/RtsUtils_CC_OPTS += -DHostVendor=$(DQ)$(HostVendor_CPP)$(DQ)
292 rts/RtsUtils_CC_OPTS += -DBuildPlatform=$(DQ)$(BUILDPLATFORM)$(DQ)
293 rts/RtsUtils_CC_OPTS += -DBuildArch=$(DQ)$(BuildArch_CPP)$(DQ)
294 rts/RtsUtils_CC_OPTS += -DBuildOS=$(DQ)$(BuildOS_CPP)$(DQ)
295 rts/RtsUtils_CC_OPTS += -DBuildVendor=$(DQ)$(BuildVendor_CPP)$(DQ)
297 rts/RtsUtils_CC_OPTS += -DTargetPlatform=$(DQ)$(TARGETPLATFORM)$(DQ)
298 rts/RtsUtils_CC_OPTS += -DTargetArch=$(DQ)$(TargetArch_CPP)$(DQ)
299 rts/RtsUtils_CC_OPTS += -DTargetOS=$(DQ)$(TargetOS_CPP)$(DQ)
300 rts/RtsUtils_CC_OPTS += -DTargetVendor=$(DQ)$(TargetVendor_CPP)$(DQ)
302 rts/RtsUtils_CC_OPTS += -DGhcUnregisterised=$(DQ)$(GhcUnregisterised)$(DQ)
303 rts/RtsUtils_CC_OPTS += -DGhcEnableTablesNextToCode=$(DQ)$(GhcEnableTablesNextToCode)$(DQ)
305 # Compile various performance-critical pieces *without* -fPIC -dynamic
306 # even when building a shared library. If we don't do this, then the
307 # GC runs about 50% slower on x86 due to the overheads of PIC. The
308 # cost of doing this is a little runtime linking and less sharing, but
311 # On x86_64 this doesn't work, because all objects in a shared library
312 # must be compiled with -fPIC (since the 32-bit relocations generated
313 # by the default small memory can't be resolved at runtime). So we
314 # only do this on i386.
316 # This apparently doesn't work on OS X (Darwin) where we get errors of
319 # ld: absolute addressing (perhaps -mdynamic-no-pic) used in _stg_ap_0_fast from rts/dist/build/Apply.dyn_o not allowed in slidable image
321 # and lots of these warnings:
323 # ld: warning codegen in _stg_ap_pppv_fast (offset 0x0000005E) prevents image from loading in dyld shared cache
325 ifeq "$(TargetArch_CPP)" "i386"
326 ifneq "$(TargetOS_CPP)" "darwin"
327 rts/sm/Evac_HC_OPTS += -fno-PIC
328 rts/sm/Evac_thr_HC_OPTS += -fno-PIC
329 rts/sm/Scav_HC_OPTS += -fno-PIC
330 rts/sm/Scav_thr_HC_OPTS += -fno-PIC
331 rts/sm/Compact_HC_OPTS += -fno-PIC
332 rts/sm/GC_HC_OPTS += -fno-PIC
334 # -static is also necessary for these bits, otherwise the NCG
335 # -generates dynamic references:
336 rts/Updates_HC_OPTS += -fno-PIC -static
337 rts/StgMiscClosures_HC_OPTS += -fno-PIC -static
338 rts/PrimOps_HC_OPTS += -fno-PIC -static
339 rts/Apply_HC_OPTS += -fno-PIC -static
340 rts/dist/build/AutoApply_HC_OPTS += -fno-PIC -static
344 # ffi.h triggers prototype warnings, so disable them here:
345 rts/Interpreter_CC_OPTS += -Wno-strict-prototypes
346 rts/Adjustor_CC_OPTS += -Wno-strict-prototypes
347 rts/sm/Storage_CC_OPTS += -Wno-strict-prototypes
349 # inlining warnings happen in Compact
350 rts/sm/Compact_CC_OPTS += -Wno-inline
352 # emits warnings about call-clobbered registers on x86_64
353 rts/StgCRun_CC_OPTS += -w
355 rts/RetainerProfile_CC_OPTS += -w
356 rts/RetainerSet_CC_OPTS += -Wno-format
358 rts/win32/ConsoleHandler_CC_OPTS += -w
359 rts/win32/ThrIOManager_CC_OPTS += -w
360 # The above warning supression flags are a temporary kludge.
361 # While working on this module you are encouraged to remove it and fix
362 # any warnings in the module. See
363 # http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
366 # Without this, thread_obj will not be inlined (at least on x86 with GCC 4.1.0)
367 rts/sm/Compact_CC_OPTS += -finline-limit=2500
369 # -O3 helps unroll some loops (especially in copy() with a constant argument).
370 rts/sm/Evac_CC_OPTS += -funroll-loops
371 rts/dist/build/sm/Evac_thr_HC_OPTS += -optc-funroll-loops
373 # These files are just copies of sm/Evac.c and sm/Scav.c respectively,
374 # but compiled with -DPARALLEL_GC.
375 rts/dist/build/sm/Evac_thr_CC_OPTS += -DPARALLEL_GC -Irts/sm
376 rts/dist/build/sm/Scav_thr_CC_OPTS += -DPARALLEL_GC -Irts/sm
378 #-----------------------------------------------------------------------------
379 # Add PAPI library if needed
381 ifeq "$(GhcRtsWithPapi)" "YES"
383 rts_CC_OPTS += -DUSE_PAPI
385 rts_PACKAGE_CPP_OPTS += -DUSE_PAPI
386 rts_PACKAGE_CPP_OPTS += -DPAPI_INCLUDE_DIR=$(PapiIncludeDir)
387 rts_PACKAGE_CPP_OPTS += -DPAPI_LIB_DIR=$(PapiLibDir)
389 ifneq "$(PapiIncludeDir)" ""
390 rts_HC_OPTS += -I$(PapiIncludeDir)
391 rts_CC_OPTS += -I$(PapiIncludeDir)
392 rts_HSC2HS_OPTS += -I$(PapiIncludeDir)
394 ifneq "$(PapiLibDirs)" ""
395 rts_LD_OPTS += -L$(PapiLibDirs)
398 else # GhcRtsWithPapi==YES
400 rts_PACKAGE_CPP_OPTS += -DPAPI_INCLUDE_DIR=""
401 rts_PACKAGE_CPP_OPTS += -DPAPI_LIB_DIR=""
405 # -----------------------------------------------------------------------------
408 rts_WAYS_DASHED = $(subst $(space),,$(patsubst %,-%,$(strip $(rts_WAYS))))
409 rts_dist_depfile_base = rts/dist/build/.depend$(rts_WAYS_DASHED)
411 rts_dist_C_SRCS = $(rts_C_SRCS) $(rts_thr_EXTRA_C_SRCS)
412 rts_dist_S_SRCS = $(rts_S_SRCS)
413 rts_dist_C_FILES = $(rts_C_SRCS) $(rts_thr_EXTRA_C_SRCS) $(rts_S_SRCS)
415 # Hack: we define every way-related option here, so that we get (hopefully)
416 # a superset of the dependencies. To do this properly, we should generate
417 # a different set of dependencies for each way. Further hack: PROFILING an
419 # TICKY_TICKY can't be used together, so we omit TICKY_TICKY for now.
420 rts_dist_MKDEPENDC_OPTS += -DPROFILING -DTHREADED_RTS -DDEBUG
422 ifeq "$(HaveDtrace)" "YES"
424 rts_dist_MKDEPENDC_OPTS += -Irts/dist/build
428 $(eval $(call build-dependencies,rts,dist,1))
430 $(rts_dist_depfile_c_asm) : libffi/dist-install/build/ffi.h $(DTRACEPROBES_H)
432 #-----------------------------------------------------------------------------
435 rts_CC_OPTS += -Ilibffi/build/include
436 rts_HC_OPTS += -Ilibffi/build/include
437 rts_HSC2HS_OPTS += -Ilibffi/build/include
438 rts_LD_OPTS += -Llibffi/build/include
440 # -----------------------------------------------------------------------------
441 # compile generic patchable dyn-wrapper
443 DYNWRAPPER_SRC = rts/dyn-wrapper.c
444 DYNWRAPPER_PROG = rts/dyn-wrapper$(exeext)
445 $(DYNWRAPPER_PROG): $(DYNWRAPPER_SRC)
446 "$(HC)" -cpp -optc-include -optcdyn-wrapper-patchable-behaviour.h $(INPLACE_EXTRA_FLAGS) $< -o $@
448 # -----------------------------------------------------------------------------
449 # compile dtrace probes if dtrace is supported
451 ifeq "$(HaveDtrace)" "YES"
453 rts_CC_OPTS += -DDTRACE
454 rts_HC_OPTS += -DDTRACE
456 DTRACEPROBES_SRC = rts/RtsProbes.d
457 $(DTRACEPROBES_H): $(DTRACEPROBES_SRC) | $(dir $@)/.
458 "$(DTRACE)" $(filter -I%,$(rts_CC_OPTS)) -C -h -o $@ -s $<
462 # -----------------------------------------------------------------------------
463 # build the static lib containing the C main symbol
465 ifneq "$(BINDIST)" "YES"
466 rts/dist/build/libHSrtsmain.a : rts/dist/build/Main.o
467 "$(RM)" $(RM_OPTS) $@
468 "$(AR)" $(AR_OPTS) $(EXTRA_AR_ARGS) $@ $<
471 # -----------------------------------------------------------------------------
472 # The RTS package config
474 # If -DDEBUG is in effect, adjust package conf accordingly..
475 ifneq "$(strip $(filter -optc-DDEBUG,$(GhcRtsHcOpts)))" ""
476 rts_PACKAGE_CPP_OPTS += -DDEBUG
479 ifeq "$(HaveLibMingwEx)" "YES"
480 rts_PACKAGE_CPP_OPTS += -DHAVE_LIBMINGWEX
483 $(eval $(call manual-package-config,rts))
485 ifneq "$(BootingFromHc)" "YES"
486 rts/package.conf.inplace : $(includes_H_CONFIG) $(includes_H_PLATFORM)
489 # -----------------------------------------------------------------------------
492 INSTALL_LIBS += $(ALL_RTS_LIBS)
494 # -----------------------------------------------------------------------------
497 $(eval $(call clean-target,rts,dist,rts/dist))
499 BINDIST_EXTRAS += rts/package.conf.in
500 BINDIST_EXTRAS += $(ALL_RTS_LIBS)