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
  22 ALL_RTS_LIBS = $(foreach way,$(rts_WAYS),rts/dist/build/libHSrts$($(way)_libsuf)) \
  23                rts/dist/build/libHSrtsmain.a
  24 all_rts : $(ALL_RTS_LIBS)
  25
  26 # The per-dir options
  27 $(eval $(call distdir-opts,rts,dist))
  28
  29 # -----------------------------------------------------------------------------
  30 # Defining the sources
  31
  32 ALL_DIRS = hooks parallel sm eventlog
  33
  34 ifeq "$(HOSTPLATFORM)" "i386-unknown-mingw32"
  35 ALL_DIRS += win32
  36 else
  37 ALL_DIRS += posix
  38 endif
  39
  40 EXCLUDED_SRCS += rts/Main.c
  41 EXCLUDED_SRCS += rts/parallel/SysMan.c
  42 EXCLUDED_SRCS += rts/dyn-wrapper.c
  43 EXCLUDED_SRCS += $(wildcard rts/Vis*.c)
  44
  45 rts_C_SRCS = $(filter-out $(EXCLUDED_SRCS),$(wildcard rts/*.c $(foreach dir,$(ALL_DIRS),rts/$(dir)/*.c)))
  46 rts_CMM_SRCS = $(wildcard rts/*.cmm)
  47
  48 # Don't compile .S files when bootstrapping a new arch
  49 ifeq "$(TARGETPLATFORM)" "$(HOSTPLATFORM)"
  50 ifneq "$(findstring $(TargetArch_CPP), powerpc powerpc64)" ""
  51 rts_S_SRCS += rts/AdjustorAsm.S
  52 else
  53 ifneq "$(findstring $(TargetOS_CPP), darwin)" ""
  54 rts_S_SRCS += rts/AdjustorAsm.S
  55 endif
  56 endif
  57 endif
  58
  59 ifeq "$(GhcUnregisterised)" "YES"
  60 GENAPPLY_OPTS = -u
  61 endif
  62
  63 rts_AUTO_APPLY_CMM = rts/dist/build/AutoApply.cmm
  64
  65 $(rts_AUTO_APPLY_CMM): $(GENAPPLY_INPLACE)
  66         "$(GENAPPLY_INPLACE)" >$@
  67
  68 rts/dist/build/sm/Evac_thr.c : rts/sm/Evac.c
  69         "$(MKDIRHIER)" $(dir $@)
  70         cp $< $@
  71 rts/dist/build/sm/Scav_thr.c : rts/sm/Scav.c
  72         "$(MKDIRHIER)" $(dir $@)
  73         cp $< $@
  74
  75 rts_H_FILES = $(wildcard includes/*.h) $(wildcard rts/*.h)
  76
  77 # collect the -l flags that we need to link the rts dyn lib.
  78 rts/libs.depend : $(GHC_PKG_INPLACE)
  79         "$(GHC_PKG_INPLACE)" field rts extra-libraries \
  80           | sed -e 's/^extra-libraries: //' -e 's/\([a-z]*\)/-l\1/g' > $@
  81
  82 #-----------------------------------------------------------------------------
  83 # Building one way
  84
  85 define build-rts-way # args: $1 = way
  86
  87 # The per-way CC_OPTS
  88 ifneq "$$(findstring debug, $1)" ""
  89 rts_dist_$1_HC_OPTS =
  90 rts_dist_$1_CC_OPTS = -g -O0
  91 else
  92 rts_dist_$1_HC_OPTS = $$(GhcRtsHcOpts)
  93 rts_dist_$1_CC_OPTS = $$(GhcRtsCcOpts)
  94 endif
  95
  96 ifneq "$$(findstring thr, $1)" ""
  97 rts_$1_EXTRA_C_SRCS  =  rts/dist/build/sm/Evac_thr.c rts/dist/build/sm/Scav_thr.c
  98 endif
  99
 100 $(call distdir-way-opts,rts,dist,$1)
 101 $(call c-suffix-rules,rts,dist,$1,YES)
 102 $(call cmm-suffix-rules,rts,dist,$1)
 103
 104 rts_$1_LIB = rts/dist/build/libHSrts$$($1_libsuf)
 105
 106 rts_$1_C_OBJS   = $$(patsubst rts/%.c,rts/dist/build/%.$$($1_osuf),$$(rts_C_SRCS)) $$(patsubst %.c,%.$$($1_osuf),$$(rts_$1_EXTRA_C_SRCS))
 107 rts_$1_S_OBJS   = $$(patsubst rts/%.S,rts/dist/build/%.$$($1_osuf),$$(rts_S_SRCS))
 108 rts_$1_CMM_OBJS = $$(patsubst rts/%.cmm,rts/dist/build/%.$$($1_osuf),$$(rts_CMM_SRCS)) $$(patsubst %.cmm,%.$$($1_osuf),$$(rts_AUTO_APPLY_CMM))
 109
 110 rts_$1_OBJS = $$(rts_$1_C_OBJS) $$(rts_$1_S_OBJS) $$(rts_$1_CMM_OBJS)
 111
 112 rts_dist_$1_CC_OPTS += -DRtsWay=$$(DQ)rts_$1$$(DQ)
 113
 114 ifneq "$$(findstring dyn, $1)" ""
 115 $$(rts_$1_LIB) : $$(rts_$1_OBJS) rts/libs.depend
 116         "$$(RM)" $$(RM_OPTS) $$@
 117         "$$(rts_dist_HC)" -shared -dynamic -dynload deploy \
 118           -no-auto-link-packages `cat rts/libs.depend` $$(rts_$1_OBJS) -o $$@
 119 else
 120 $$(rts_$1_LIB) : $$(rts_$1_OBJS)
 121         "$$(RM)" $$(RM_OPTS) $$@
 122         echo $$(rts_$1_OBJS) | $$(XARGS) $$(AR) $$(EXTRA_AR_ARGS) $$@
 123 endif
 124
 125 endef
 126
 127 # And expand the above for each way:
 128 $(foreach way,$(rts_WAYS),$(eval $(call build-rts-way,$(way))))
 129
 130 #-----------------------------------------------------------------------------
 131 # Flags for compiling every file
 132
 133 # We like plenty of warnings.
 134 WARNING_OPTS += -Wall
 135 ifeq "$(GccLT34)" "YES"
 136 WARNING_OPTS += -W
 137 else
 138 WARNING_OPTS += -Wextra
 139 endif
 140 WARNING_OPTS += -Wstrict-prototypes
 141 WARNING_OPTS += -Wmissing-prototypes
 142 WARNING_OPTS += -Wmissing-declarations
 143 WARNING_OPTS += -Winline
 144 WARNING_OPTS += -Waggregate-return
 145 WARNING_OPTS += -Wpointer-arith
 146 WARNING_OPTS += -Wmissing-noreturn
 147 WARNING_OPTS += -Wcast-align
 148 WARNING_OPTS += -Wnested-externs
 149 WARNING_OPTS += -Wredundant-decls
 150
 151 # These ones are hard to avoid:
 152 #WARNING_OPTS += -Wconversion
 153 #WARNING_OPTS += -Wbad-function-cast
 154 #WARNING_OPTS += -Wshadow
 155 #WARNING_OPTS += -Wcast-qual
 156
 157 STANDARD_OPTS += -Iincludes -Irts
 158 # COMPILING_RTS is only used when building Win32 DLL support.
 159 STANDARD_OPTS += -DCOMPILING_RTS
 160
 161 # HC_OPTS is included in both .c and .cmm compilations, whereas CC_OPTS is
 162 # only included in .c compilations.  HC_OPTS included the WAY_* opts, which
 163 # must be included in both types of compilations.
 164
 165 rts_CC_OPTS += $(WARNING_OPTS)
 166 rts_CC_OPTS += $(STANDARD_OPTS)
 167
 168 rts_HC_OPTS += $(STANDARD_OPTS) -package-name rts
 169
 170 ifneq "$(GhcWithSMP)" "YES"
 171 rts_CC_OPTS += -DNOSMP
 172 rts_HC_OPTS += -optc-DNOSMP
 173 endif
 174
 175 ifeq "$(UseLibFFIForAdjustors)" "YES"
 176 rts_CC_OPTS += -DUSE_LIBFFI_FOR_ADJUSTORS
 177 endif
 178
 179 ifeq "$(Windows)" "YES"
 180 # SDM: when compiled with -fasm the RTS currently has bogus references to
 181 # __imp_base_ things, so working around for now:
 182 rts_HC_OPTS += -fvia-C
 183 endif
 184
 185 ifneq "$(DYNAMIC_RTS)" "YES"
 186 rts_HC_OPTS += -static
 187 else
 188 $(error ToDo: DYNAMIC_RTS)
 189 endif
 190
 191 # Mac OS X: make sure we compile for the right OS version
 192 rts_CC_OPTS += $(MACOSX_DEPLOYMENT_CC_OPTS)
 193 rts_HC_OPTS += $(addprefix -optc, $(MACOSX_DEPLOYMENT_CC_OPTS))
 194 rts_LD_OPTS += $(addprefix -optl, $(MACOSX_DEPLOYMENT_LD_OPTS))
 195
 196 # Otherwise the stack-smash handler gets triggered.
 197 ifeq "$(TargetOS_CPP)" "openbsd"
 198 rts_HC_OPTS += -optc-fno-stack-protector
 199 endif
 200
 201 # We *want* type-checking of hand-written cmm.
 202 rts_HC_OPTS += -dcmm-lint
 203
 204 # -fno-strict-aliasing is required for the runtime, because we often
 205 # use a variety of types to represent closure pointers (StgPtr,
 206 # StgClosure, StgMVar, etc.), and without -fno-strict-aliasing gcc is
 207 # allowed to assume that these pointers do not alias.  eg. without
 208 # this flag we get problems in sm/Evac.c:copy() with gcc 3.4.3, the
 209 # upd_evacee() assigments get moved before the object copy.
 210 rts_CC_OPTS += -fno-strict-aliasing
 211
 212 rts_CC_OPTS += -fno-common
 213
 214 ifeq "$(BeConservative)" "YES"
 215 rts_CC_OPTS += -DBE_CONSERVATIVE
 216 endif
 217
 218 #-----------------------------------------------------------------------------
 219 # Flags for compiling specific files
 220
 221 # XXX DQ is now the same on all platforms, so get rid of it
 222 DQ = \"
 223
 224 # If RtsMain.c is built with optimisation then the SEH exception stuff on
 225 # Windows gets confused.
 226 # This has to be in HC rather than CC opts, as otherwise there's a
 227 # -optc-O2 that comes after it.
 228 RtsMain_HC_OPTS += -optc-O0
 229
 230 RtsMessages_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
 231 RtsUtils_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
 232 #
 233 RtsUtils_CC_OPTS += -DHostPlatform=$(DQ)$(HOSTPLATFORM)$(DQ)
 234 RtsUtils_CC_OPTS += -DHostArch=$(DQ)$(HostArch_CPP)$(DQ)
 235 RtsUtils_CC_OPTS += -DHostOS=$(DQ)$(HostOS_CPP)$(DQ)
 236 RtsUtils_CC_OPTS += -DHostVendor=$(DQ)$(HostVendor_CPP)$(DQ)
 237 #
 238 RtsUtils_CC_OPTS += -DBuildPlatform=$(DQ)$(BUILDPLATFORM)$(DQ)
 239 RtsUtils_CC_OPTS += -DBuildArch=$(DQ)$(BuildArch_CPP)$(DQ)
 240 RtsUtils_CC_OPTS += -DBuildOS=$(DQ)$(BuildOS_CPP)$(DQ)
 241 RtsUtils_CC_OPTS += -DBuildVendor=$(DQ)$(BuildVendor_CPP)$(DQ)
 242 #
 243 RtsUtils_CC_OPTS += -DTargetPlatform=$(DQ)$(TARGETPLATFORM)$(DQ)
 244 RtsUtils_CC_OPTS += -DTargetArch=$(DQ)$(TargetArch_CPP)$(DQ)
 245 RtsUtils_CC_OPTS += -DTargetOS=$(DQ)$(TargetOS_CPP)$(DQ)
 246 RtsUtils_CC_OPTS += -DTargetVendor=$(DQ)$(TargetVendor_CPP)$(DQ)
 247 #
 248 RtsUtils_CC_OPTS += -DGhcUnregisterised=$(DQ)$(GhcUnregisterised)$(DQ)
 249 RtsUtils_CC_OPTS += -DGhcEnableTablesNextToCode=$(DQ)$(GhcEnableTablesNextToCode)$(DQ)
 250
 251 # ffi.h triggers prototype warnings, so disable them here:
 252 Interpreter_CC_OPTS += -Wno-strict-prototypes
 253 Adjustor_CC_OPTS    += -Wno-strict-prototypes
 254 sm/Storage_CC_OPTS  += -Wno-strict-prototypes
 255
 256 # inlining warnings happen in Compact
 257 sm/Compact_CC_OPTS += -Wno-inline
 258
 259 # emits warnings about call-clobbered registers on x86_64
 260 StgCRun_CC_OPTS += -w
 261
 262 RetainerProfile_CC_OPTS += -w
 263 RetainerSet_CC_OPTS += -Wno-format
 264 # On Windows:
 265 win32/ConsoleHandler_CC_OPTS += -w
 266 win32/ThrIOManager_CC_OPTS += -w
 267 win32/Ticker_CC_OPTS += -w
 268 # The above warning supression flags are a temporary kludge.
 269 # While working on this module you are encouraged to remove it and fix
 270 # any warnings in the module. See
 271 #     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
 272 # for details
 273
 274 # Without this, thread_obj will not be inlined (at least on x86 with GCC 4.1.0)
 275 sm/Compact_CC_OPTS += -finline-limit=2500
 276
 277 # -O3 helps unroll some loops (especially in copy() with a constant argument).
 278 sm/Evac_CC_OPTS += -funroll-loops
 279 sm/Evac_thr_HC_OPTS += -optc-funroll-loops
 280
 281 # These files are just copies of sm/Evac.c and sm/Scav.c respectively,
 282 # but compiled with -DPARALLEL_GC.
 283 sm/Evac_thr_HC_OPTS += -optc-DPARALLEL_GC -Irts/sm
 284 sm/Scav_thr_HC_OPTS += -optc-DPARALLEL_GC -Irts/sm
 285
 286 #-----------------------------------------------------------------------------
 287 # Add PAPI library if needed
 288
 289 ifeq "$(GhcRtsWithPapi)" "YES"
 290
 291 rts_CC_OPTS             += -DUSE_PAPI
 292
 293 rts_PACKAGE_CPP_OPTS    += -DUSE_PAPI
 294 rts_PACKAGE_CPP_OPTS    += -DPAPI_INCLUDE_DIR=$(PapiIncludeDir)
 295 rts_PACKAGE_CPP_OPTS    += -DPAPI_LIB_DIR=$(PapiLibDir)
 296
 297 ifneq "$(PapiIncludeDir)" ""
 298 rts_HC_OPTS     += -I$(PapiIncludeDir)
 299 rts_CC_OPTS     += -I$(PapiIncludeDir)
 300 rts_HSC2HS_OPTS += -I$(PapiIncludeDir)
 301 endif
 302 ifneq "$(PapiLibDirs)" ""
 303 rts_LD_OPTS     += -L$(PapiLibDirs)
 304 endif
 305
 306 else # GhcRtsWithPapi==YES
 307
 308 rts_PACKAGE_CPP_OPTS += -DPAPI_INCLUDE_DIR=""
 309 rts_PACKAGE_CPP_OPTS += -DPAPI_LIB_DIR=""
 310
 311 endif
 312
 313 # -----------------------------------------------------------------------------
 314 # dependencies
 315
 316 # Hack: we define every way-related option here, so that we get (hopefully)
 317 # a superset of the dependencies.  To do this properly, we should generate
 318 # a different set of dependencies for each way.  Further hack: PROFILING and
 319 # TICKY_TICKY can't be used together, so we omit TICKY_TICKY for now.
 320 rts_MKDEPENDC_OPTS += -DPROFILING -DTHREADED_RTS -DDEBUG
 321
 322 rts_WAYS_DASHED = $(subst $(space),,$(patsubst %,-%,$(strip $(rts_WAYS))))
 323 rts_dist_depfile = rts/dist/build/.depend$(rts_WAYS_DASHED)
 324
 325 rts_dist_C_SRCS  = $(rts_C_SRCS)
 326 rts_dist_S_SRCS =  $(rts_S_SRCS)
 327 rts_dist_C_FILES = $(rts_C_SRCS) $(rts_S_SRCS)
 328
 329 $(eval $(call build-dependencies,rts,dist))
 330
 331 $(rts_dist_depfile) : libffi/ffi.h
 332
 333 #-----------------------------------------------------------------------------
 334 # libffi stuff
 335
 336 rts_CC_OPTS     += -Ilibffi/build/include
 337 rts_HC_OPTS     += -Ilibffi/build/include
 338 rts_HSC2HS_OPTS += -Ilibffi/build/include
 339 rts_LD_OPTS     += -Llibffi/build/include
 340
 341 # -----------------------------------------------------------------------------
 342 # compile generic patchable dyn-wrapper
 343
 344 DYNWRAPPER_SRC = rts/dyn-wrapper.c
 345 DYNWRAPPER_PROG = rts/dyn-wrapper$(exeext)
 346 $(DYNWRAPPER_PROG): $(DYNWRAPPER_SRC)
 347         "$(HC)" -cpp -optc-include -optcdyn-wrapper-patchable-behaviour.h $(INPLACE_EXTRA_FLAGS) $< -o $@
 348
 349 # -----------------------------------------------------------------------------
 350 # build the static lib containing the C main symbol
 351
 352 rts/dist/build/libHSrtsmain.a : rts/dist/build/Main.o
 353         $(AR) $(EXTRA_AR_ARGS) $@ $<
 354
 355 # -----------------------------------------------------------------------------
 356 # The RTS package config
 357
 358 # If -DDEBUG is in effect, adjust package conf accordingly..
 359 ifneq "$(strip $(filter -optc-DDEBUG,$(GhcRtsHcOpts)))" ""
 360 rts_PACKAGE_CPP_OPTS += -DDEBUG
 361 endif
 362
 363 ifeq "$(HaveLibMingwEx)" "YES"
 364 rts_PACKAGE_CPP_OPTS += -DHAVE_LIBMINGWEX
 365 endif
 366
 367 $(eval $(call manual-package-config,rts))
 368
 369 ifneq "$(BootingFromHc)" "YES"
 370 rts/package.conf.inplace : $(includes_H_CONFIG) $(includes_H_PLATFORM)
 371 endif
 372
 373 # -----------------------------------------------------------------------------
 374 # installing
 375
 376 install : install_rts
 377
 378 .PHONY: install_rts
 379 install_rts:
 380         $(INSTALL_DIR) $(DESTDIR)$(ghclibdir)
 381         $(INSTALL_DIR) $(DESTDIR)$(ghclibdir)/include
 382         "$(CP)" $(ALL_RTS_LIBS) $(DESTDIR)$(ghclibdir)
 383
 384 # -----------------------------------------------------------------------------
 385 # cleaning
 386
 387 $(eval $(call clean-target,rts,dist,rts/dist))
 388
 389 BINDIST_EXTRAS += rts/package.conf.in
 390 BINDIST_EXTRAS += $(ALL_RTS_LIBS)
 391