Fix two bugs in stg_ap_0_fast in profiling runtime
[ghc.git] / Makefile
index 726801d..8046e36 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,3 +1,41 @@
+# -----------------------------------------------------------------------------
+#
+# (c) 2009 The University of Glasgow
+#
+# This file is part of the GHC build system.
+#
+# To understand how the build system works and how to modify it, see
+#      http://ghc.haskell.org/trac/ghc/wiki/Building/Architecture
+#      http://ghc.haskell.org/trac/ghc/wiki/Building/Modifying
+#
+# -----------------------------------------------------------------------------
+
+# Eliminate use of the built-in implicit rules, and clear out the default list
+# of suffixes for suffix rules. Speeds up make quite a bit. Both are needed
+# for the shortest `make -d` output.
+# Don't set --no-builtin-variables; some rules might stop working if you do
+# (e.g. 'make clean' in testsuite/ currently relies on an implicit $RM).
+MAKEFLAGS += --no-builtin-rules
+.SUFFIXES:
+
+
+# -----------------------------------------------------------------------------
+# Sanitize environment
+
+# See Trac #11530
+export GREP_OPTIONS :=
+
+ifneq "$(filter maintainer-clean distclean clean clean_% help,$(MAKECMDGOALS))" ""
+-include mk/config.mk
+else
+include mk/config.mk
+ifeq "$(ProjectVersion)" ""
+$(error Please run ./configure first)
+endif
+endif
+
+include mk/custom-settings.mk
+
 
 ifeq "$(wildcard distrib/)" ""
 
@@ -8,132 +46,142 @@ default:
        @echo 'Run "make install" to install'
        @false
 
-.PHONY: install
-install:
-       $(MAKE) -r --no-print-directory -f ghc.mk install BINDIST=YES NO_INCLUDE_DEPS=YES
-
-.PHONY: show
-show:
-       $(MAKE) -r --no-print-directory -f ghc.mk $@
+.PHONY: install show
+install show:
+       $(MAKE) --no-print-directory -f ghc.mk $@ BINDIST=YES NO_INCLUDE_DEPS=YES
 
-else
-
-# The problem we need to solve is as follows.  
-#
-# GNU make supports included Makefiles, and it is clever enough to try
-# to update those Makefiles when they are out-of-date or missing.  It
-# first reads all the Makefiles, and then tries to build each one if
-# it is out-of-date, using the rules in the Makefiles themselves.
-# When it has brought all the Makefiles up-to-date, it restarts itself
-# to read the newly-generated Makefiles.
+# Note [install-strip]
 #
-# This works fine, unless there are dependencies *between* the
-# Makefiles.  For example in the GHC build, for each package we have a
-# package-data.mk file which is generated by the ghc-cabal program,
-# and we have a .depend file.  The .depend file cannot be generated
-# until package-data.mk has been generated and make has been restarted
-# to read in its contents, because it is the package-data.mk file that
-# tells us which modules are in the package.  But make always makes
-# all the Makefiles before restarting - it doesn't take into account a
-# dependency between Makefiles and restart itself earlier.
-
-# Consider the following makefile:
-
-# --------------------
-# all :
+# install-strip is like install, but it strips the executable files while
+# installing them.
 #
-# include inc1.mk
-# 
-# inc1.mk : Makefile
-#      echo "X = C" >$@
-# 
-# include inc2.mk
-# 
-# inc2.mk : inc1.mk
-#      echo "Y = $(X)" >$@
-# --------------------
-
-# Now try it:
-# 
-# $ make -f fail.mk
-# fail.mk:3: inc1.mk: No such file or directory
-# fail.mk:8: inc2.mk: No such file or directory
-# echo "X = C" >inc1.mk
-# echo "Y = " >inc2.mk
-# make: Nothing to be done for `all'.
-
-# make built both inc1.mk and inc2.mk without restarting itself
-# between the two (even though we added a dependency on inc1.mk from
-# inc2.mk).
+# From http://www.gnu.org/prep/standards/html_node/Standard-Targets.html:
 #
-# The solution we adopt in the GHC build system is essentially this:
-
-# --------------------
-# PHASE = 0
-# 
-# ifeq "$(PHASE)" "0"
-# all :
-#      $(MAKE) PHASE=1
-# else
-# all :
-# endif
-# 
-# -include inc1.mk
-# 
-# inc1.mk : Makefile
-#      echo "X = C" >$@
-# 
-# ifneq "$(PHASE)" "0"
-# include inc2.mk
-# 
-# inc2.mk : inc1.mk
-#      echo "Y = $(X)" >$@
-# endif
-# 
-# clean :
-#      rm -f inc1.mk inc2.mk
-# --------------------
-
-# That is, every time make is invoked, we force it to update inc1.mk
-# and then restart.  In the GHC build system we need to divide the
-# build into 4 phases in fact, with a restart between each phase.  See
-# ghc.mk for the details on what happens in each phase and why.
+#   "install-strip should not strip the executables in the build directory
+#   which are being copied for installation. It should only strip the copies
+#   that are installed. "
 
+.PHONY: install-strip
+install-strip:
+       # See Note [install-strip].
+       $(MAKE) --no-print-directory -f ghc.mk INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' install BINDIST=YES NO_INCLUDE_DEPS=YES
+
+else
+
+.PHONY: default
 default : all
        @:
 
+# For help, type 'make help'
+.PHONY: help
+help:
+       @cat MAKEHELP.md
+
 # No need to update makefiles for these targets:
-REALGOALS=$(filter-out clean clean_% distclean maintainer-clean show,$(MAKECMDGOALS))
+# (the ones we're filtering out)
+REALGOALS=$(filter-out \
+    binary-dist \
+    binary-dist-prep \
+    install-strip \
+    sdist sdist-ghc \
+    sdist-ghc-prep \
+    sdist-windows-tarballs \
+    sdist-windows-tarballs-prep \
+    sdist-testsuite \
+    sdist-testsuite-prep \
+    bootstrapping-files \
+    framework-pkg \
+    clean \
+    clean_% \
+    distclean \
+    maintainer-clean \
+    show \
+    show! \
+    echo \
+    help \
+    test \
+    fulltest \
+    slowtest \
+    fasttest \
+  ,$(MAKECMDGOALS))
+
+# configure touches certain files even if they haven't changed.  This
+# can mean a lot of unnecessary recompilation after a re-configure, so
+# here we cache the old versions of these files so we can restore the
+# timestamps.
+%.old:  %
+       @set -x && test -f $@ && cmp -s $< $@ || cp -p $< $@
+       touch -r $@ $<
+
 
 # NB. not the same as saying '%: ...', which doesn't do the right thing:
 # it does nothing if we specify a target that already exists.
-.PHONY: $(REALGOALS)
-$(REALGOALS) all:
-       @echo "===--- updating makefiles phase 0"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=0 just-makefiles
-       @echo "===--- updating makefiles phase 1"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=1 just-makefiles
-       @echo "===--- updating makefiles phase 2"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=2 just-makefiles
-       @echo "===--- updating makefiles phase 3"
-       $(MAKE) -r --no-print-directory -f ghc.mk phase=3 just-makefiles
-       @echo "===--- finished updating makefiles"
-       $(MAKE) -r --no-print-directory -f ghc.mk $@
-
-binary-dist:
+.PHONY: $(REALGOALS) all
+$(REALGOALS) all: mk/config.mk.old mk/project.mk.old compiler/ghc.cabal.old
+ifneq "$(OMIT_PHASE_0)" "YES"
+       @echo "===--- building phase 0"
+       $(MAKE) --no-print-directory -f ghc.mk phase=0 phase_0_builds
+endif
+ifneq "$(OMIT_PHASE_1)" "YES"
+       @echo "===--- building phase 1"
+       $(MAKE) --no-print-directory -f ghc.mk phase=1 phase_1_builds
+endif
+       @echo "===--- building final phase"
+       $(MAKE) --no-print-directory -f ghc.mk phase=final $@
+
+# if BINARY_DIST_DIR is not set, assume we want the old
+# behaviour of placing the binary dist into the current
+# directory. Provide BINARY_DIST_DIR to put the final
+# binary distribution elsewhere.
+BINARY_DIST_DIR ?= .
+
+.PHONY: binary-dist
+binary-dist: binary-dist-prep
+       mv bindistprep/*.tar.$(TAR_COMP_EXT) "$(BINARY_DIST_DIR)"
+
+.PHONY: binary-dist-prep
+binary-dist-prep:
+ifeq "$(mingw32_TARGET_OS)" "1"
+       $(MAKE) --no-print-directory -f ghc.mk windows-binary-dist-prep
+else
        rm -f bindist-list
-       $(MAKE) -r --no-print-directory -f ghc.mk bindist BINDIST=YES
-       $(MAKE) -r --no-print-directory -f ghc.mk binary-dist
+       $(MAKE) --no-print-directory -f ghc.mk bindist-list BINDIST=YES
+       $(MAKE) --no-print-directory -f ghc.mk unix-binary-dist-prep
+endif
+
+.PHONY: install-strip
+install-strip:
+       # See Note [install-strip].
+       $(MAKE) --no-print-directory -f ghc.mk INSTALL_PROGRAM='$(INSTALL_PROGRAM) -s' install
+
+.PHONY: sdist sdist-ghc sdist-ghc-prep sdist-windows-tarballs sdist-windows-tarballs-prep sdist-testsuite sdist-testsuite-prep
+# Just running `./boot && ./configure && make sdist` should work, so skip
+# phase 0 and 1 and don't build any dependency files.
+sdist sdist-ghc sdist-ghc-prep sdist-windows-tarballs sdist-windows-tarballs-prep sdist-testsuite sdist-testsuite-prep :
+       $(MAKE) --no-print-directory -f ghc.mk $@ NO_INCLUDE_DEPS=YES NO_INCLUDE_PKGDATA=YES
 
+.PHONY: clean distclean maintainer-clean
 clean distclean maintainer-clean:
-       $(MAKE) -r --no-print-directory -f ghc.mk $@
+       $(MAKE) --no-print-directory -f ghc.mk $@ CLEANING=YES
        test ! -d testsuite || $(MAKE) -C testsuite $@
 
+.PHONY: $(filter clean_%,$(MAKECMDGOALS))
 $(filter clean_%, $(MAKECMDGOALS)) : clean_% :
-       $(MAKE) -r --no-print-directory -f ghc.mk $@
+       $(MAKE) --no-print-directory -f ghc.mk $@ CLEANING=YES
 
-show:
-       $(MAKE) -r --no-print-directory -f ghc.mk $@
+.PHONY: bootstrapping-files show echo
+bootstrapping-files show echo:
+       $(MAKE) --no-print-directory -f ghc.mk $@
+
+.PHONY: show!
+show!:
+       $(MAKE) --no-print-directory -f ghc.mk show NO_INCLUDE_PKGDATA=YES
+
+ifeq "$(darwin_TARGET_OS)" "1"
+.PHONY: framework-pkg
+framework-pkg:
+       $(MAKE) -C distrib/MacOS $@
+endif
 
 # If the user says 'make A B', then we don't want to invoke two
 # instances of the rule above in parallel:
@@ -141,3 +189,39 @@ show:
 
 endif
 
+# Note [validate and testsuite speed]
+#
+# There are 3 different validate and testsuite speed settings:
+# fast, normal and slow.
+#
+#                              how    how   used
+#           cd tests  config.  many   many  by
+# validate  && make   speed=   tests  ways  whom
+# =============================================================================
+# --fast    fast      2        some   1+exs Travis (to stay within time limit)
+# --normal  test      1        all    1+exs Phabricator (slow takes too long?)
+# --slow    slow      0        all    all   Nightly (slow is ok)
+#
+#           accept    1        all    1
+#
+# `--fast` and `--normal` run one default way, as well as any other ways which
+# are explicitly requested by the test using extra_ways().
+#
+# `make accept` should run all tests exactly once. There is no point in
+# accepting a test for multiple ways, since it should produce the same output
+# for all ways.
+#
+# To make sure all .stderr and .stdout files in the testsuite are never
+# out-of-date, it is useful if Phabricator, via a normal `./validate` and `make
+# test`, runs each test at least once.
+.PHONY: fasttest
+fasttest:
+       $(MAKE) -C testsuite/tests CLEANUP=1 SUMMARY_FILE=../../testsuite_summary.txt fast
+
+.PHONY: test
+test:
+       $(MAKE) -C testsuite/tests CLEANUP=1 SUMMARY_FILE=../../testsuite_summary.txt
+
+.PHONY: slowtest fulltest
+slowtest fulltest:
+       $(MAKE) -C testsuite/tests CLEANUP=1 SUMMARY_FILE=../../testsuite_summary.txt slow