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 $(call clean-target,$1,$2,$1/$2)
  46 # This give us things like
  47 #     all_libraries: all_libraries/base_dist-install
  48 #     clean_libraries: clean_libraries/base_dist-install
  49 ifneq "$$($1_$2_GROUP)" ""
  50 all_$$($1_$2_GROUP): all_$1_$2
  51 clean_$$($1_$2_GROUP): clean_$1_$2
  52 endif
  53
  54 distclean : clean_$1_$2_config
  55
  56 maintainer-clean : distclean
  57
  58 .PHONY: clean_$1_$2_config
  59 clean_$1_$2_config:
  60         $(RM) $1/config.log $1/config.status $1/include/Hs*Config.h
  61         $(RM) -r $1/autom4te.cache
  62
  63 # --- CONFIGURATION
  64
  65 $1_$2_USE_BOOT_LIBS = YES
  66 $(call package-config,$1,$2,$3)
  67
  68 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
  69 include $1/$2/package-data.mk
  70 endif
  71
  72 ifeq "$$($1_$2_DISABLE)" "YES"
  73
  74 ifeq "$$(DEBUG)" "YES"
  75 $$(warning $1/$2 disabled)
  76 endif
  77
  78 # A package is disabled when we want to bring its package-data.mk file
  79 # up-to-date first, or due to other build dependencies.
  80
  81 $(call all-target,$1_$2,$1/$2/package-data.mk)
  82
  83 ifneq "$(BINDIST)" "YES"
  84 # We have a rule for package-data.mk only when the package is
  85 # disabled, because we want the build to fail if we haven't run phase 0.
  86 $(call build-package-data,$1,$2)
  87 endif
  88
  89 else
  90
  91 ifneq "$$(NO_INCLUDE_PKGDATA)" "YES"
  92 ifeq "$$($1_$2_VERSION)" ""
  93 $$(error phase ordering error: $1/$2 is enabled, but $1/$2/package-data.mk does not exist)
  94 endif
  95 endif
  96
  97 # Sometimes we need to modify the automatically-generated package-data.mk
  98 # bindings in a special way for the GHC build system, so allow that here:
  99 $($1_PACKAGE_MAGIC)
 100
 101 # Bootstrapping libs are only built one way
 102 ifeq "$3" "0"
 103 $1_$2_WAYS = v
 104 else
 105 $1_$2_WAYS = $$(GhcLibWays)
 106 endif
 107
 108 $(call hs-sources,$1,$2)
 109 $(call c-sources,$1,$2)
 110 $(call includes-sources,$1,$2)
 111
 112 # --- DEPENDENCIES
 113
 114 # We must use a different dependency file if $(GhcLibWays) changes, so
 115 # encode the ways into the name of the file.
 116 $1_$2_WAYS_DASHED = $$(subst $$(space),,$$(patsubst %,-%,$$(strip $$($1_$2_WAYS))))
 117 $1_$2_depfile = $1/$2/build/.depend$$($1_$2_WAYS_DASHED)
 118
 119 $(call build-dependencies,$1,$2)
 120
 121 # --- BUILDING
 122
 123 # We don't bother splitting the bootstrap packages (built with stage 0)
 124 ifeq "$$($1_$2_SplitObjs)" ""
 125 ifeq "$$(SplitObjs) $3" "YES 1"
 126 $1_$2_SplitObjs = YES
 127 else
 128 $1_$2_SplitObjs = NO
 129 endif
 130 endif
 131
 132 # C and S files are built the "v" vanlilla way and possibly also the "dyn" way.
 133 $(call c-objs,$1,$2,v)
 134 $(call distdir-opts,$1,$2,$3)
 135 $(call c-suffix-rules,$1,$2,v,YES)
 136 ifeq "$(BuildSharedLibs)" "YES"
 137 $(call c-objs,$1,$2,dyn)
 138 $(call c-suffix-rules,$1,$2,dyn,YES)
 139 endif
 140
 141 # Now generate all the build rules for each way in this directory:
 142 $$(foreach way,$$($1_$2_WAYS),$$(eval $$(call build-package-way,$1,$2,$$(way),$3)))
 143
 144 $(call haddock,$1,$2)
 145
 146 endif # package-data.mk exists
 147
 148 # Don't put bootstrapping packages in the bindist
 149 ifneq "$3" "0"
 150 BINDIST_EXTRAS += $1/*.cabal $1/$2/setup-config $1/LICENSE
 151 BINDIST_EXTRAS += $$($1_$2_INSTALL_INCLUDES_SRCS)
 152 endif
 153
 154 endif
 155
 156 endef
 157