rules/build-package.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 # Build a package with the stage-1 compiler, multiple ways.  A typical
  15 # libraries/foo/ghc.mk will look like this:
  16 #
  17 # $(eval $(call build-package,libraries/base,dist-install))
  18 #
  19 # The package metadata is generated from the .cabal file and placed in
  20 # package-data.mk.  It will look something like this:
  21 #
  22 # libraries/base_dist_MODULES = GHC.Base Data.Tuple ...
  23 # libraries/base_dist_PACKAGE = base
  24 # libraries/base_dist_VERSION = 4.0.0.0
  25 # libraries/base_dist_HC_OPTS = -package ghc-prim-0.1.0.0 -XRank2Types ...
  26 # libraries/base_dist_C_SRCS  = cbits/PrelIOUtils.c ...
  27 # libraries/base_dist_S_SRCS  = cbits/foo.S ...
  28 # libraries/base_dist_CC_OPTS = -Iinclude ...
  29 # libraries/base_dist_LD_OPTS = -package ghc-prim-0.1.0.0
  30
  31 define build-package
  32 # $1 = dir
  33 # $2 = distdir
  34 # $3 = GHC stage to use (0 == bootstrapping compiler)
  35
  36 ifeq "$$(findstring $3,0 1 2)" ""
  37 $$(error $1/$2: stage argument to build-package should be 0, 1, or 2)
  38 endif
  39
  40 # We don't install things compiled by stage 0, so no need to put them
  41 # in the bindist.
  42 ifneq "$(BINDIST) $3" "YES 0"
  43
  44 $(call all-target,$1,all_$1_$2)
  45 # This give us things like
  46 #     all_libraries: all_libraries/base_dist-install
  47 ifneq "$$($1_$2_GROUP)" ""
  48 all_$$($1_$2_GROUP): all_$1_$2
  49 endif
  50
  51 $(call clean-target,$1,$2,$1/$2)
  52
  53 distclean : clean_$1_$2_config
  54
  55 .PHONY: clean_$1_$2_config
  56 clean_$1_$2_config:
  57         $(RM) $1/config.log $1/config.status $1/include/Hs*Config.h
  58         $(RM) -r $1/autom4te.cache
  59
  60 # --- CONFIGURATION
  61
  62 $1_$2_USE_BOOT_LIBS = YES
  63 $(call package-config,$1,$2,$3)
  64
  65 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
  66 include $1/$2/package-data.mk
  67 endif
  68
  69 ifeq "$$($1_$2_DISABLE)" "YES"
  70
  71 ifeq "$$(DEBUG)" "YES"
  72 $$(warning $1/$2 disabled)
  73 endif
  74
  75 # A package is disabled when we want to bring its package-data.mk file
  76 # up-to-date first, or due to other build dependencies.
  77
  78 $(call all-target,$1_$2,$1/$2/package-data.mk)
  79
  80 ifneq "$(BINDIST)" "YES"
  81 # We have a rule for package-data.mk only when the package is
  82 # disabled, because we want the build to fail if we haven't run phase 0.
  83 $(call build-package-data,$1,$2)
  84 endif
  85
  86 else
  87
  88 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
  89 ifeq "$$($1_$2_VERSION)" ""
  90 $$(error phase ordering error: $1/$2 is enabled, but $1/$2/package-data.mk does not exist)
  91 endif
  92 endif
  93
  94 # Sometimes we need to modify the automatically-generated package-data.mk
  95 # bindings in a special way for the GHC build system, so allow that here:
  96 $($1_PACKAGE_MAGIC)
  97
  98 # Bootstrapping libs are only built one way
  99 ifeq "$3" "0"
 100 $1_$2_WAYS = v
 101 else
 102 $1_$2_WAYS = $$(GhcLibWays)
 103 endif
 104
 105 $(call hs-sources,$1,$2)
 106 $(call c-sources,$1,$2)
 107 $(call includes-sources,$1,$2)
 108
 109 # --- DEPENDENCIES
 110
 111 # We must use a different dependency file if $(GhcLibWays) changes, so
 112 # encode the ways into the name of the file.
 113 $1_$2_WAYS_DASHED = $$(subst $$(space),,$$(patsubst %,-%,$$(strip $$($1_$2_WAYS))))
 114 $1_$2_depfile = $1/$2/build/.depend$$($1_$2_WAYS_DASHED)
 115
 116 $(call build-dependencies,$1,$2)
 117
 118 # --- BUILDING
 119
 120 # We don't bother splitting the bootstrap packages (built with stage 0)
 121 ifeq "$$($1_$2_SplitObjs)" ""
 122 ifeq "$$(SplitObjs) $3" "YES 1"
 123 $1_$2_SplitObjs = YES
 124 else
 125 $1_$2_SplitObjs = NO
 126 endif
 127 endif
 128
 129 # C and S files are built the "v" vanlilla way and possibly also the "dyn" way.
 130 $(call c-objs,$1,$2,v)
 131 $(call distdir-opts,$1,$2,$3)
 132 $(call c-suffix-rules,$1,$2,v,YES)
 133 ifeq "$(BuildSharedLibs)" "YES"
 134 $(call c-objs,$1,$2,dyn)
 135 $(call c-suffix-rules,$1,$2,dyn,YES)
 136 endif
 137
 138 # Now generate all the build rules for each way in this directory:
 139 $$(foreach way,$$($1_$2_WAYS),$$(eval $$(call build-package-way,$1,$2,$$(way),$3)))
 140
 141 $(call haddock,$1,$2)
 142
 143 endif # package-data.mk exists
 144
 145 # Don't put bootstrapping packages in the bindist
 146 ifeq "$3" "1"
 147 BINDIST_EXTRAS += $1/*.cabal $1/$2/setup-config $1/LICENSE
 148 BINDIST_EXTRAS += $$($1_$2_INSTALL_INCLUDES_SRCS)
 149 endif
 150
 151 endif
 152
 153 endef
 154