add Outputable instance for OccIfaceEq
[ghc-hetmet.git] / rts / Makefile
1 #-----------------------------------------------------------------------------
2 #
3 #  This is the Makefile for the runtime-system stuff.
4 #  This stuff is written in C (and cannot be written in Haskell).
5 #
6 #  .c  files are vanilla C,
7 #  .hc files are "Haskellized-C", compiled using the C compiler and
8 #      (possibly) the assembly-mangler.  The GHC driver script
9 #      knows how to compile this stuff.
10
11 #-----------------------------------------------------------------------------
12 # Preamble
13
14 TOP=..
15
16 # Set UseGhcForCc: this causes the fptools build system to use a different
17 # set of suffix rules for compiling C code, using $(HC) rather than $(CC)
18 # and prepending "-optc" to $(CC_OPTS).  NB. must be done before including
19 # boilerplate.mk below.
20 UseGhcForCc = YES
21
22 include $(TOP)/mk/boilerplate.mk
23
24 PACKAGE = rts
25
26 HC=$(GHC_INPLACE)
27
28
29 # Setting _way here is a nasty hack to make sure we get libHSrts*.a etc
30 # rather than just libHSrts.a when we are making and installing
31 # bindists.
32 ifeq "$(DOING_BIN_DIST)" "YES"
33 _way = *
34 endif
35
36 # -----------------------------------------------------------------------------
37 # RTS ways
38
39 WAYS=$(GhcLibWays) $(GhcRTSWays)
40
41 ifneq "$(findstring debug, $(way))" ""
42 GhcRtsHcOpts=
43 GhcRtsCcOpts=-g -O0
44 endif
45
46 ifeq "$(BeConservative)" "YES"
47 GhcRtsCcOpts += -DBE_CONSERVATIVE
48 endif
49
50 # -----------------------------------------------------------------------------
51
52 # There's nothing for Haddock here...
53 override HADDOCK_DOCS = NO
54
55 # -----------------------------------------------------------------------------
56
57 # Tells the build system not to add various Haskellish options to $(SRC_HC_OPTS)
58 NON_HS_PACKAGE = YES
59
60 # grab sources from these subdirectories
61 ALL_DIRS = hooks parallel sm
62
63 ifeq "$(HOSTPLATFORM)" "i386-unknown-mingw32"
64 ALL_DIRS += win32
65 else
66 ALL_DIRS += posix
67 endif
68
69 ifneq "$(findstring dyn, $(way))" ""
70 DYNAMIC_RTS=YES
71 else
72 DYNAMIC_RTS=NO
73 endif
74
75 ifeq "$(DYNAMIC_RTS) $(HOSTPLATFORM)" "YES i386-unknown-mingw32"
76 EXCLUDED_SRCS += Main.c
77 # It's not included in the DLL, but we need to compile it up separately.
78
79 all :: Main.$(way_)o
80 INSTALL_LIBS += Main.$(way_)o
81 else
82 EXCLUDED_SRCS += RtsDllMain.c
83 endif
84
85 # This file ends up being empty unless we're building for a powerpc
86 # or darwin system, and it is reported that Solaris ld chokes on it when
87 # building HSrts.o.
88 ifeq "$(findstring $(TargetArch_CPP), powerpc powerpc64)" ""
89 ifeq "$(findstring $(TargetOS_CPP), darwin)" ""
90 EXCLUDED_SRCS += AdjustorAsm.S
91 endif
92 endif
93
94 EXCLUDED_SRCS += parallel/SysMan.c
95
96 # The build system doesn't give us these
97 CMM_SRCS = $(filter-out AutoApply%.cmm, $(wildcard *.cmm)) $(EXTRA_CMM_SRCS)
98 CMM_OBJS = $(patsubst %.cmm,%.$(way_)o, $(CMM_SRCS))
99
100 CLEAN_FILES += $(CMM_OBJS)
101
102 # Override the default $(LIBOBJS) (defaults to $(HS_OBJS))
103 LIBOBJS = $(C_OBJS) $(CMM_OBJS)
104
105 SplitObjs=NO
106
107 H_FILES = $(wildcard ../includes/*.h) $(wildcard *.h)
108
109 #-----------------------------------------------------------------------------
110 # Flags for compiling RTS .c and .hc files
111
112 # gcc provides lots of useful warnings if you ask it.
113 # This is a pretty good list to start with - use a # to comment out
114 # any you don't like.
115 WARNING_OPTS += -Wall
116 WARNING_OPTS += -W
117 WARNING_OPTS += -Wstrict-prototypes 
118 WARNING_OPTS += -Wmissing-prototypes 
119 WARNING_OPTS += -Wmissing-declarations
120 WARNING_OPTS += -Winline
121 WARNING_OPTS += -Waggregate-return
122 #WARNING_OPTS += -Wpointer-arith
123 #WARNING_OPTS += -Wbad-function-cast
124 #WARNING_OPTS += -Wcast-align
125 #WARNING_OPTS += -Wnested-externs
126 #WARNING_OPTS += -Wshadow
127 #WARNING_OPTS += -Wcast-qual
128 #WARNING_OPTS += -Wno-unused 
129 #WARNING_OPTS += -Wredundant-decls 
130 #WARNING_OPTS += -Wconversion
131
132 STANDARD_OPTS += -I../includes -I. -Iparallel -Ism
133 # COMPILING_RTS is only used when building Win32 DLL support.
134 STANDARD_OPTS += -DCOMPILING_RTS
135
136 # HC_OPTS is included in both .c and .cmm compilations, whereas CC_OPTS is
137 # only included in .c compilations.  HC_OPTS included the WAY_* opts, which
138 # must be included in both types of compilations.
139
140 SRC_CC_OPTS += $(WARNING_OPTS)
141 SRC_CC_OPTS += $(STANDARD_OPTS)
142
143 SRC_CC_OPTS += $(GhcRtsCcOpts)
144 SRC_HC_OPTS += $(GhcRtsHcOpts) $(STANDARD_OPTS) -package-name rts
145
146 ifneq "$(GhcWithSMP)" "YES"
147 SRC_CC_OPTS += -DNOSMP
148 SRC_HC_OPTS += -optc-DNOSMP
149 endif
150
151 ifneq "$(DYNAMIC_RTS)" "YES"
152 SRC_HC_OPTS += -static
153 else
154 LIB_LD_OPTS += -ignore-package base -ignore-package rts
155 ifeq "$(DYNAMIC_RTS) $(HOSTPLATFORM)" "YES i386-unknown-mingw32"
156 BASE_VERSION=$(strip $(shell grep version: $(TOP)/libraries/base/base.cabal | cut -f2 -d:))
157 BASE_NAME=HSbase-$(BASE_VERSION)-ghc$(ProjectVersion)$(soext)
158 BASE_DIST_LIB=$(TOP)/libraries/base/dist/build
159 BASE_IMPORT_LIBRARY=$(BASE_DIST_LIB)/lib$(BASE_NAME).a
160 LIB_DEPS=$(BASE_IMPORT_LIBRARY)
161 LIB_LD_OPTS += -L$(BASE_DIST_LIB) -l$(BASE_NAME)
162 # We extract a good bit of information out of the rts package.conf by going via ghc-pkg
163 LIB_LD_OPTS += $(foreach lib,$(shell $(GHC_PKG_INPLACE) field rts extra-libraries | sed -e s/extra-libraries://),"-l$(lib)")
164 LIB_LD_OPTS += $(foreach libdir,$(shell $(GHC_PKG_INPLACE) field rts library-dirs | sed -e s/library-dirs://),"-L$(libdir)")
165 endif
166 endif
167
168 ifeq "$(Windows)" "YES"
169 # On Windows GHC does its own commandline parsing, so we need extra
170 # doublequote protection. Sigh.
171 DQ = \\\"
172 else
173 DQ = \"
174 endif
175
176 # If Main.c is built with optimisation then the SEH exception stuff on
177 # Windows gets confused.
178 # This has to be in HC rather than CC opts, as otherwise there's a
179 # -optc-O2 that comes after it.
180 Main_HC_OPTS += -optc-O0
181
182 RtsMessages_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
183 RtsUtils_CC_OPTS += -DProjectVersion=$(DQ)$(ProjectVersion)$(DQ)
184 RtsUtils_CC_OPTS += -DRtsWay=$(DQ)rts$(_way)$(DQ)
185 RtsUtils_CC_OPTS += -DHostPlatform=$(DQ)$(HOSTPLATFORM)$(DQ)
186 RtsUtils_CC_OPTS += -DBuildPlatform=$(DQ)$(BUILDPLATFORM)$(DQ)
187 RtsUtils_CC_OPTS += -DTargetPlatform=$(DQ)$(TARGETPLATFORM)$(DQ)
188 RtsUtils_CC_OPTS += -DGhcUnregisterised=$(DQ)$(GhcUnregisterised)$(DQ)
189 RtsUtils_CC_OPTS += -DGhcEnableTablesNextToCode=$(DQ)$(GhcEnableTablesNextToCode)$(DQ)
190
191 StgCRun_CC_OPTS += -w
192 Typeable_CC_OPTS += -w
193 RetainerProfile_CC_OPTS += -w
194 sm/Compact_CC_OPTS += -w
195 # On Windows:
196 win32/ConsoleHandler_CC_OPTS += -w
197 win32/ThrIOManager_CC_OPTS += -w
198 win32/Ticker_CC_OPTS += -w
199 Threads_CC_OPTS += -w
200 Capability_CC_OPTS += -w
201 Schedule_CC_OPTS += -w
202 # The above warning supression flags are a temporary kludge.
203 # While working on this module you are encouraged to remove it and fix
204 # any warnings in the module. See
205 #     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
206 # for details
207
208 ifeq "$(way)" "mp"
209 SRC_HC_OPTS += -I$$PVM_ROOT/include
210 endif
211
212 # If -DDEBUG is in effect, adjust package conf accordingly..
213 ifneq "$(strip $(filter -optc-DDEBUG,$(GhcRtsHcOpts)))" ""
214 PACKAGE_CPP_OPTS += -DDEBUG
215 endif
216
217 ifeq "$(HaveLibMingwEx)" "YES"
218 PACKAGE_CPP_OPTS += -DHAVE_LIBMINGWEX
219 endif
220
221 ifeq "$(GhciWithDebugger)" "YES"
222 STANDARD_OPTS += -DDEBUGGER
223 endif
224
225 ifeq "$(DotnetSupport)" "YES"
226
227
228 # Would like to just use SUBDIRS here, but need to
229 # descend into dotnet/ earlier than that.
230 #
231 all ::
232         $(MAKE) -C dotnet all
233
234 # But use SUBDIRS for other recursive targets.
235 SUBDIRS += dotnet
236
237 LIBOBJS += dotnet/Invoke.o
238 endif
239
240 # Suppress uninitialized variable warnings for GC.c
241 GC_CC_OPTS      += -Wno-uninitialized
242
243 #-----------------------------------------------------------------------------
244 # Include the Front panel code?
245
246 # we need GTK+ for the front panel
247 ifneq "$(GTK_CONFIG)" ""
248 ifeq "$(GhcRtsWithFrontPanel)" "YES"
249 SRC_HC_OPTS             += `$(GTK_CONFIG) --cflags` -optc-DRTS_GTK_FRONTPANEL
250 VisCallbacks_CC_OPTS    += -Wno-unused
251 SRC_MKDEPENDC_OPTS      += `$(GTK_CONFIG) --cflags`
252 else # GhcRtsWithFrontPanel
253 EXCLUDED_SRCS           += $(wildcard Vis*.c)
254 endif
255 else # GTK_CONFIG
256 EXCLUDED_SRCS           += $(wildcard Vis*.c)
257 endif
258
259 #-----------------------------------------------------------------------------
260 # Add PAPI library if needed
261
262 ifeq "$(GhcRtsWithPapi)" "YES"
263 SRC_HC_OPTS             += -optc-DUSE_PAPI
264 PACKAGE_CPP_OPTS        += -DUSE_PAPI
265 endif
266
267 #-----------------------------------------------------------------------------
268 # make depend setup
269
270 SRC_MKDEPENDC_OPTS += -I. -I../includes
271
272 # Hack: we define every way-related option here, so that we get (hopefully)
273 # a superset of the dependencies.  To do this properly, we should generate
274 # a different set of dependencies for each way.  Further hack: PROFILING and
275 # TICKY_TICKY can't be used together, so we omit TICKY_TICKY for now.
276 SRC_MKDEPENDC_OPTS += -DPROFILING -DTHREADED_RTS -DDEBUG
277
278 # -----------------------------------------------------------------------------
279 # The auto-generated apply code
280
281 # We want a slightly different version for the unregisterised way, so we make
282 # AutoApply on a per-way basis (eg. AutoApply_p.cmm).
283
284 ifneq "$(DOING_BIN_DIST)" "YES"
285
286 AUTO_APPLY_CMM = AutoApply$(_way).cmm
287
288 ifneq "$(BootingFromHc)" "YES"
289 $(AUTO_APPLY_CMM): $(GHC_GENAPPLY)
290         @$(RM) $@
291         $(GENAPPLY) $(if $(filter $(way), u debug_u), -u) >$@
292 endif
293
294 EXTRA_CMM_SRCS += $(AUTO_APPLY_CMM)
295
296 CLEAN_FILES += $(AUTO_APPLY_CMM)
297
298 endif
299
300 # -----------------------------------------------------------------------------
301 # Compile GMP only if we don't have it already
302 #
303 # We use GMP's own configuration stuff, because it's all rather hairy
304 # and not worth re-implementing in our Makefile framework.
305
306 CLEAN_FILES += gmp/libgmp.a
307
308 # Need to get the GMP vars in through CPP to package.conf.in, and put
309 # quotes around each element.
310
311 empty =
312 space = $(empty) $(empty)
313 comma = ,
314 PACKAGE_CPP_OPTS += -DGMP_INCLUDE_DIRS='$(subst $(space),$(comma),$(patsubst %,"%",$(strip $(GMP_INCLUDE_DIRS))))'
315 PACKAGE_CPP_OPTS += -DGMP_LIB_DIRS='$(subst $(space),$(comma),$(patsubst %,"%",$(strip $(GMP_LIB_DIRS))))'
316
317 ifneq "$(GMP_INCLUDE_DIRS)" ""
318 SRC_HC_OPTS += -I$(GMP_INCLUDE_DIRS)
319 SRC_CC_OPTS += -I$(GMP_INCLUDE_DIRS)
320 SRC_HSC2HS_OPTS += -I$(GMP_INCLUDE_DIRS)
321 endif
322 ifneq "$(GMP_LIB_DIRS)" ""
323 SRC_LD_OPTS += -L$(GMP_LIB_DIRS)
324 endif
325
326 SRC_CC_OPTS += -I../gmp/gmpbuild
327 SRC_HC_OPTS += -I../gmp/gmpbuild
328 SRC_HSC2HS_OPTS += -I../gmp/gmpbuild
329 SRC_LD_OPTS += -L../gmp/gmpbuild
330
331 #-----------------------------------------------------------------------------
332 #
333 # Building the GUM SysMan
334 #
335
336 ifeq "$(way)" "mp"
337 all :: parallel/SysMan
338
339 ifdef solaris2_TARGET_OS
340 __socket_libs = -lsocket -lnsl
341 else
342 __socket_libs =
343 endif
344
345 parallel/SysMan : parallel/SysMan.mp_o parallel/LLComms.mp_o RtsUtils.mp_o RtsFlags.mp_o
346         $(RM) $@
347         gcc -o $@ parallel/SysMan.mp_o parallel/LLComms.mp_o -L$$PVM_ROOT/lib/$$PVM_ARCH -lgpvm3 -lpvm3 $(__socket_libs)
348
349 CLEAN_FILES  += parallel/SysMan.mp_o parallel/SysMan
350 INSTALL_LIBEXECS += parallel/SysMan
351 endif
352
353 #-----------------------------------------------------------------------------
354 # Compiling the cmm files
355
356 # ToDo: should we really include Rts.h here?  Required for GNU_ATTRIBUTE().
357 SRC_HC_OPTS += -I. -\#include HCIncludes.h
358
359 ifeq "$(Windows)" "YES"
360 PrimOps_HC_OPTS += -\#include '<windows.h>' -\#include win32/AsyncIO.h
361 else
362 PrimOps_HC_OPTS += -\#include posix/Itimer.h
363 endif
364
365 # Otherwise the stack-smash handler gets triggered.
366 ifeq "$(TargetOS_CPP)" "openbsd"
367 SRC_HC_OPTS += -optc-fno-stack-protector
368 endif
369
370 # -O3 helps unroll some loops (especially in copy() with a constant argument).
371 sm/Evac_HC_OPTS += -optc-funroll-loops
372
373 # Without this, thread_obj will not be inlined (at least on x86 with GCC 4.1.0)
374 sm/Compact_HC_OPTS += -optc-finline-limit=2500
375
376 # -fno-strict-aliasing is required for the runtime, because we often
377 # use a variety of types to represent closure pointers (StgPtr,
378 # StgClosure, StgMVar, etc.), and without -fno-strict-aliasing gcc is
379 # allowed to assume that these pointers do not alias.  eg. without
380 # this flag we get problems in GC.c:copy() with gcc 3.4.3, the
381 # upd_evacee() assigments get moved before the object copy.
382 SRC_CC_OPTS += -fno-strict-aliasing
383
384 # We *want* type-checking of hand-written cmm.
385 SRC_HC_OPTS += -dcmm-lint 
386
387 ifneq "$(BootingFromHc)" "YES"
388 # .cmm files depend on all the .h files, to a first approximation.
389 %.$(way_)o : %.cmm $(H_FILES)
390         $(HC_PRE_OPTS)
391         $(HC) $(HC_OPTS) -c $< -o $@
392         $(HC_POST_OPTS)
393
394 %.$(way_)hc : %.cmm $(H_FILES)
395         $(HC) $(HC_OPTS) -C $< -o $@
396
397 %.$(way_)s : %.cmm $(H_FILES)
398         $(HC) $(HC_OPTS) -S $< -o $@
399 endif
400
401 #-----------------------------------------------------------------------------
402 #
403 # Files to install
404 #
405 # Just libHSrts is installed uniformly across ways
406 #
407
408 include $(TOP)/mk/target.mk
409
410 ifeq "$(DYNAMIC_RTS) $(HOSTPLATFORM)" "YES i386-unknown-mingw32"
411 $(BASE_IMPORT_LIBRARY): $(LIBRARY).a
412         $(MAKE) -C ../libraries/ make.library.base
413 # just for the timestamps
414         touch $(BASE_IMPORT_LIBRARY)
415 endif
416
417 #-----------------------------------------------------------------------------
418 #
419 # binary-dist
420
421 binary-dist:
422         $(INSTALL_DIR)                         $(BIN_DIST_DIR)/rts
423         $(INSTALL_DIR)                         $(BIN_DIST_DIR)/rts/gmp
424         $(INSTALL_DATA)    Makefile            $(BIN_DIST_DIR)/rts/
425         $(INSTALL_DATA)    package.conf.in     $(BIN_DIST_DIR)/rts/
426 ifneq "$(INSTALL_LIBS)" ""
427         $(INSTALL_DATA)    $(INSTALL_LIBS)     $(BIN_DIST_DIR)/rts/
428 endif
429 ifneq "$(INSTALL_LIBEXECS)" ""
430         $(INSTALL_PROGRAM) $(INSTALL_LIBEXECS) $(BIN_DIST_DIR)/rts/
431 endif