rts/ghc.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 # Building the RTS
  15
  16 # We build the RTS with stage 1
  17 rts_dist_HC = $(GHC_STAGE1)
  18
  19 # merge GhcLibWays and GhcRTSWays but strip out duplicates
  20 rts_WAYS = $(GhcLibWays) $(filter-out $(GhcLibWays),$(GhcRTSWays))
  21 rts_dist_WAYS = $(rts_WAYS)
  22
  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)
  26
  27 # -----------------------------------------------------------------------------
  28 # Defining the sources
  29
  30 ALL_DIRS = hooks parallel sm eventlog
  31
  32 ifeq "$(HOSTPLATFORM)" "i386-unknown-mingw32"
  33 ALL_DIRS += win32
  34 else
  35 ALL_DIRS += posix
  36 endif
  37
  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)
  42
  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)
  45
  46 # Don't compile .S files when bootstrapping a new arch
  47 ifeq "$(TARGETPLATFORM)" "$(HOSTPLATFORM)"
  48 ifneq "$(findstring $(TargetArch_CPP), powerpc powerpc64)" ""
  49 rts_S_SRCS += rts/AdjustorAsm.S
  50 else
  51 ifneq "$(findstring $(TargetOS_CPP), darwin)" ""
  52 rts_S_SRCS += rts/AdjustorAsm.S
  53 endif
  54 endif
  55 endif
  56
  57 ifeq "$(GhcUnregisterised)" "YES"
  58 GENAPPLY_OPTS = -u
  59 endif
  60
  61 rts_AUTO_APPLY_CMM = rts/dist/build/AutoApply.cmm
  62
  63 $(rts_AUTO_APPLY_CMM): $(GENAPPLY_INPLACE)
  64         "$(GENAPPLY_INPLACE)" >$@
  65
  66 rts/dist/build/sm/Evac_thr.c : rts/sm/Evac.c | $$(dir $$@)/.
  67         cp $< $@
  68 rts/dist/build/sm/Scav_thr.c : rts/sm/Scav.c | $$(dir $$@)/.
  69         cp $< $@
  70
  71 rts_H_FILES = $(wildcard includes/*.h) $(wildcard rts/*.h)
  72
  73 ifeq "$(HaveDtrace)" "YES"
  74 DTRACEPROBES_H = rts/dist/build/RtsProbes.h
  75 rts_H_FILES += $(DTRACEPROBES_H)
  76 endif
  77
  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' > $@
  82
  83
  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.
  89 #
  90 ifneq "$$(findstring dyn, $1)" ""
  91 ifeq  "$(HOSTPLATFORM)" "i386-unknown-mingw32"
  92
  93 ALL_RTS_DEF_LIBNAMES    = base ghc-prim
  94 ALL_RTS_DEF_LIBS        = \
  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
  98
  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
 106
 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
 110 endef
 111 $(foreach lib,$(ALL_RTS_DEF_LIBNAMES),$(eval $(call make-importlib-def,$(lib))))
 112
 113
 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
 119
 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
 123 endif
 124 endif
 125
 126
 127 #-----------------------------------------------------------------------------
 128 # Building one way
 129 define build-rts-way # args: $1 = way
 130
 131 ifneq "$$(BINDIST)" "YES"
 132
 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
 137 else
 138 rts_dist_$1_HC_OPTS = $$(GhcRtsHcOpts)
 139 rts_dist_$1_CC_OPTS = $$(GhcRtsCcOpts)
 140 endif
 141
 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
 144 endif
 145
 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
 151
 152 rts_$1_LIB_NAME = libHSrts$$($1_libsuf)
 153 rts_$1_LIB = rts/dist/build/$$(rts_$1_LIB_NAME)
 154
 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))
 158
 159 rts_$1_OBJS = $$(rts_$1_C_OBJS) $$(rts_$1_S_OBJS) $$(rts_$1_CMM_OBJS)
 160
 161 rts_dist_$1_CC_OPTS += -DRtsWay=$$(DQ)rts_$1$$(DQ)
 162
 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)" -shared -dynamic -dynload deploy \
 169           -no-auto-link-packages `cat rts/libs.depend` $$(rts_$1_OBJS) $$(ALL_RTS_DEF_LIBS) -o $$@
 170 ifeq "$$(darwin_TARGET_OS)" "1"
 171         # Ensure library's install name is correct before anyone links with it.
 172         install_name_tool -id $(ghclibdir)/$$(rts_$1_LIB_NAME) $$@
 173 endif
 174 else
 175 $$(rts_$1_LIB) : $$(rts_$1_OBJS) rts/libs.depend
 176         "$$(RM)" $$(RM_OPTS) $$@
 177         "$$(rts_dist_HC)" -shared -dynamic -dynload deploy \
 178           -no-auto-link-packages `cat rts/libs.depend` $$(rts_$1_OBJS) -o $$@
 179 endif
 180 else
 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) $$@
 184 endif
 185
 186 endif
 187
 188 endef
 189
 190 # And expand the above for each way:
 191 $(foreach way,$(rts_WAYS),$(eval $(call build-rts-way,$(way))))
 192
 193 #-----------------------------------------------------------------------------
 194 # Flags for compiling every file
 195
 196 # We like plenty of warnings.
 197 WARNING_OPTS += -Wall
 198 ifeq "$(GccLT34)" "YES"
 199 WARNING_OPTS += -W
 200 else
 201 WARNING_OPTS += -Wextra
 202 endif
 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 += -Wcast-align
 211 WARNING_OPTS += -Wnested-externs
 212 WARNING_OPTS += -Wredundant-decls
 213
 214 # These ones are hard to avoid:
 215 #WARNING_OPTS += -Wconversion
 216 #WARNING_OPTS += -Wbad-function-cast
 217 #WARNING_OPTS += -Wshadow
 218 #WARNING_OPTS += -Wcast-qual
 219
 220 STANDARD_OPTS += -Iincludes -Irts
 221 # COMPILING_RTS is only used when building Win32 DLL support.
 222 STANDARD_OPTS += -DCOMPILING_RTS
 223
 224 # HC_OPTS is included in both .c and .cmm compilations, whereas CC_OPTS is
 225 # only included in .c compilations.  HC_OPTS included the WAY_* opts, which
 226 # must be included in both types of compilations.
 227
 228 rts_CC_OPTS += $(WARNING_OPTS)
 229 rts_CC_OPTS += $(STANDARD_OPTS)
 230
 231 rts_HC_OPTS += $(STANDARD_OPTS) -package-name rts
 232
 233 ifneq "$(GhcWithSMP)" "YES"
 234 rts_CC_OPTS += -DNOSMP
 235 rts_HC_OPTS += -optc-DNOSMP
 236 endif
 237
 238 ifeq "$(UseLibFFIForAdjustors)" "YES"
 239 rts_CC_OPTS += -DUSE_LIBFFI_FOR_ADJUSTORS
 240 endif
 241
 242 # Mac OS X: make sure we compile for the right OS version
 243 rts_CC_OPTS += $(MACOSX_DEPLOYMENT_CC_OPTS)
 244 rts_HC_OPTS += $(addprefix -optc, $(MACOSX_DEPLOYMENT_CC_OPTS))
 245 rts_LD_OPTS += $(addprefix -optl, $(MACOSX_DEPLOYMENT_LD_OPTS))
 246
 247 # Otherwise the stack-smash handler gets triggered.
 248 ifneq "$(findstring $(TargetOS_CPP), darwin openbsd)" ""
 249 rts_HC_OPTS += -optc-fno-stack-protector
 250 endif
 251
 252 # We *want* type-checking of hand-written cmm.
 253 rts_HC_OPTS += -dcmm-lint
 254
 255 # -fno-strict-aliasing is required for the runtime, because we often
 256 # use a variety of types to represent closure pointers (StgPtr,
 257 # StgClosure, StgMVar, etc.), and without -fno-strict-aliasing gcc is
 258 # allowed to assume that these pointers do not alias.  eg. without
 259 # this flag we get problems in sm/Evac.c:copy() with gcc 3.4.3, the
 260 # upd_evacee() assigments get moved before the object copy.
 261 rts_CC_OPTS += -fno-strict-aliasing
 262
 263 rts_CC_OPTS += -fno-common
 264
 265 ifeq "$(BeConservative)" "YES"
 266 rts_CC_OPTS += -DBE_CONSERVATIVE
 267 endif
 268
 269 #-----------------------------------------------------------------------------
 270 # Flags for compiling specific files
 271
 272 # XXX DQ is now the same on all platforms, so get rid of it
 273 DQ = \"
 274
 275 # If RtsMain.c is built with optimisation then the SEH exception stuff on
 276 # Windows gets confused.
 277 # This has to be in HC rather than CC opts, as otherwise there's a
 278 # -optc-O2 that comes after it.
 279 rts/RtsMain_HC_OPTS += -optc-O0
 280
 281 rts/RtsMessages_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
 282 rts/RtsUtils_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
 283 #
 284 rts/RtsUtils_CC_OPTS += -DHostPlatform=$(DQ)$(HOSTPLATFORM)$(DQ)
 285 rts/RtsUtils_CC_OPTS += -DHostArch=$(DQ)$(HostArch_CPP)$(DQ)
 286 rts/RtsUtils_CC_OPTS += -DHostOS=$(DQ)$(HostOS_CPP)$(DQ)
 287 rts/RtsUtils_CC_OPTS += -DHostVendor=$(DQ)$(HostVendor_CPP)$(DQ)
 288 #
 289 rts/RtsUtils_CC_OPTS += -DBuildPlatform=$(DQ)$(BUILDPLATFORM)$(DQ)
 290 rts/RtsUtils_CC_OPTS += -DBuildArch=$(DQ)$(BuildArch_CPP)$(DQ)
 291 rts/RtsUtils_CC_OPTS += -DBuildOS=$(DQ)$(BuildOS_CPP)$(DQ)
 292 rts/RtsUtils_CC_OPTS += -DBuildVendor=$(DQ)$(BuildVendor_CPP)$(DQ)
 293 #
 294 rts/RtsUtils_CC_OPTS += -DTargetPlatform=$(DQ)$(TARGETPLATFORM)$(DQ)
 295 rts/RtsUtils_CC_OPTS += -DTargetArch=$(DQ)$(TargetArch_CPP)$(DQ)
 296 rts/RtsUtils_CC_OPTS += -DTargetOS=$(DQ)$(TargetOS_CPP)$(DQ)
 297 rts/RtsUtils_CC_OPTS += -DTargetVendor=$(DQ)$(TargetVendor_CPP)$(DQ)
 298 #
 299 rts/RtsUtils_CC_OPTS += -DGhcUnregisterised=$(DQ)$(GhcUnregisterised)$(DQ)
 300 rts/RtsUtils_CC_OPTS += -DGhcEnableTablesNextToCode=$(DQ)$(GhcEnableTablesNextToCode)$(DQ)
 301
 302 # ffi.h triggers prototype warnings, so disable them here:
 303 rts/Interpreter_CC_OPTS += -Wno-strict-prototypes
 304 rts/Adjustor_CC_OPTS    += -Wno-strict-prototypes
 305 rts/sm/Storage_CC_OPTS  += -Wno-strict-prototypes
 306
 307 # inlining warnings happen in Compact
 308 rts/sm/Compact_CC_OPTS += -Wno-inline
 309
 310 # emits warnings about call-clobbered registers on x86_64
 311 rts/StgCRun_CC_OPTS += -w
 312
 313 rts/RetainerProfile_CC_OPTS += -w
 314 rts/RetainerSet_CC_OPTS += -Wno-format
 315 # On Windows:
 316 rts/win32/ConsoleHandler_CC_OPTS += -w
 317 rts/win32/ThrIOManager_CC_OPTS += -w
 318 rts/win32/Ticker_CC_OPTS += -w
 319 # The above warning supression flags are a temporary kludge.
 320 # While working on this module you are encouraged to remove it and fix
 321 # any warnings in the module. See
 322 #     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
 323 # for details
 324
 325 # Without this, thread_obj will not be inlined (at least on x86 with GCC 4.1.0)
 326 rts/sm/Compact_CC_OPTS += -finline-limit=2500
 327
 328 # -O3 helps unroll some loops (especially in copy() with a constant argument).
 329 rts/sm/Evac_CC_OPTS += -funroll-loops
 330 rts/dist/build/sm/Evac_thr_HC_OPTS += -optc-funroll-loops
 331
 332 # These files are just copies of sm/Evac.c and sm/Scav.c respectively,
 333 # but compiled with -DPARALLEL_GC.
 334 rts/dist/build/sm/Evac_thr_CC_OPTS += -DPARALLEL_GC -Irts/sm
 335 rts/dist/build/sm/Scav_thr_CC_OPTS += -DPARALLEL_GC -Irts/sm
 336
 337 #-----------------------------------------------------------------------------
 338 # Add PAPI library if needed
 339
 340 ifeq "$(GhcRtsWithPapi)" "YES"
 341
 342 rts_CC_OPTS             += -DUSE_PAPI
 343
 344 rts_PACKAGE_CPP_OPTS    += -DUSE_PAPI
 345 rts_PACKAGE_CPP_OPTS    += -DPAPI_INCLUDE_DIR=$(PapiIncludeDir)
 346 rts_PACKAGE_CPP_OPTS    += -DPAPI_LIB_DIR=$(PapiLibDir)
 347
 348 ifneq "$(PapiIncludeDir)" ""
 349 rts_HC_OPTS     += -I$(PapiIncludeDir)
 350 rts_CC_OPTS     += -I$(PapiIncludeDir)
 351 rts_HSC2HS_OPTS += -I$(PapiIncludeDir)
 352 endif
 353 ifneq "$(PapiLibDirs)" ""
 354 rts_LD_OPTS     += -L$(PapiLibDirs)
 355 endif
 356
 357 else # GhcRtsWithPapi==YES
 358
 359 rts_PACKAGE_CPP_OPTS += -DPAPI_INCLUDE_DIR=""
 360 rts_PACKAGE_CPP_OPTS += -DPAPI_LIB_DIR=""
 361
 362 endif
 363
 364 # -----------------------------------------------------------------------------
 365 # dependencies
 366
 367 rts_WAYS_DASHED = $(subst $(space),,$(patsubst %,-%,$(strip $(rts_WAYS))))
 368 rts_dist_depfile_base = rts/dist/build/.depend$(rts_WAYS_DASHED)
 369
 370 rts_dist_C_SRCS  = $(rts_C_SRCS) $(rts_thr_EXTRA_C_SRCS)
 371 rts_dist_S_SRCS =  $(rts_S_SRCS)
 372 rts_dist_C_FILES = $(rts_C_SRCS) $(rts_thr_EXTRA_C_SRCS) $(rts_S_SRCS)
 373
 374 # Hack: we define every way-related option here, so that we get (hopefully)
 375 # a superset of the dependencies.  To do this properly, we should generate
 376 # a different set of dependencies for each way.  Further hack: PROFILING an
 377
 378 # TICKY_TICKY can't be used together, so we omit TICKY_TICKY for now.
 379 rts_dist_MKDEPENDC_OPTS += -DPROFILING -DTHREADED_RTS -DDEBUG
 380
 381 ifeq "$(HaveDtrace)" "YES"
 382
 383 rts_dist_MKDEPENDC_OPTS += -Irts/dist/build
 384
 385 endif
 386
 387 $(eval $(call build-dependencies,rts,dist))
 388
 389 $(rts_dist_depfile_c_asm) : libffi/dist-install/build/ffi.h $(DTRACEPROBES_H)
 390
 391 #-----------------------------------------------------------------------------
 392 # libffi stuff
 393
 394 rts_CC_OPTS     += -Ilibffi/build/include
 395 rts_HC_OPTS     += -Ilibffi/build/include
 396 rts_HSC2HS_OPTS += -Ilibffi/build/include
 397 rts_LD_OPTS     += -Llibffi/build/include
 398
 399 # -----------------------------------------------------------------------------
 400 # compile generic patchable dyn-wrapper
 401
 402 DYNWRAPPER_SRC = rts/dyn-wrapper.c
 403 DYNWRAPPER_PROG = rts/dyn-wrapper$(exeext)
 404 $(DYNWRAPPER_PROG): $(DYNWRAPPER_SRC)
 405         "$(HC)" -cpp -optc-include -optcdyn-wrapper-patchable-behaviour.h $(INPLACE_EXTRA_FLAGS) $< -o $@
 406
 407 # -----------------------------------------------------------------------------
 408 # compile dtrace probes if dtrace is supported
 409
 410 ifeq "$(HaveDtrace)" "YES"
 411
 412 rts_CC_OPTS             += -DDTRACE
 413 rts_HC_OPTS             += -DDTRACE
 414
 415 DTRACEPROBES_SRC = rts/RtsProbes.d
 416 $(DTRACEPROBES_H): $(DTRACEPROBES_SRC) | $(dir $@)/.
 417         "$(DTRACE)" $(filter -I%,$(rts_CC_OPTS)) -C -h -o $@ -s $<
 418
 419 endif
 420
 421 # -----------------------------------------------------------------------------
 422 # build the static lib containing the C main symbol
 423
 424 ifneq "$(BINDIST)" "YES"
 425 rts/dist/build/libHSrtsmain.a : rts/dist/build/Main.o
 426         "$(AR)" $(AR_OPTS) $(EXTRA_AR_ARGS) $@ $<
 427 endif
 428
 429 # -----------------------------------------------------------------------------
 430 # The RTS package config
 431
 432 # If -DDEBUG is in effect, adjust package conf accordingly..
 433 ifneq "$(strip $(filter -optc-DDEBUG,$(GhcRtsHcOpts)))" ""
 434 rts_PACKAGE_CPP_OPTS += -DDEBUG
 435 endif
 436
 437 ifeq "$(HaveLibMingwEx)" "YES"
 438 rts_PACKAGE_CPP_OPTS += -DHAVE_LIBMINGWEX
 439 endif
 440
 441 $(eval $(call manual-package-config,rts))
 442
 443 ifneq "$(BootingFromHc)" "YES"
 444 rts/package.conf.inplace : $(includes_H_CONFIG) $(includes_H_PLATFORM)
 445 endif
 446
 447 # -----------------------------------------------------------------------------
 448 # installing
 449
 450 INSTALL_LIBS += $(ALL_RTS_LIBS)
 451
 452 # -----------------------------------------------------------------------------
 453 # cleaning
 454
 455 $(eval $(call clean-target,rts,dist,rts/dist))
 456
 457 BINDIST_EXTRAS += rts/package.conf.in
 458 BINDIST_EXTRAS += $(ALL_RTS_LIBS)
 459