core/product_config.mk

   1 #
   2 # Copyright (C) 2008 The Android Open Source Project
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #      http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 #
  16
  17 # ---------------------------------------------------------------
  18 # Generic functions
  19 # TODO: Move these to definitions.make once we're able to include
  20 # definitions.make before config.make.
  21
  22 ###########################################################
  23 ## Return non-empty if $(1) is a C identifier; i.e., if it
  24 ## matches /^[a-zA-Z_][a-zA-Z0-9_]*$/.  We do this by first
  25 ## making sure that it isn't empty and doesn't start with
  26 ## a digit, then by removing each valid character.  If the
  27 ## final result is empty, then it was a valid C identifier.
  28 ##
  29 ## $(1): word to check
  30 ###########################################################
  31
  32 _ici_digits := 0 1 2 3 4 5 6 7 8 9
  33 _ici_alphaunderscore := \
  34     a b c d e f g h i j k l m n o p q r s t u v w x y z \
  35     A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _
  36 define is-c-identifier
  37 $(strip \
  38   $(if $(1), \
  39     $(if $(filter $(addsuffix %,$(_ici_digits)),$(1)), \
  40      , \
  41       $(eval w := $(1)) \
  42       $(foreach c,$(_ici_digits) $(_ici_alphaunderscore), \
  43         $(eval w := $(subst $(c),,$(w))) \
  44        ) \
  45       $(if $(w),,TRUE) \
  46       $(eval w :=) \
  47      ) \
  48    ) \
  49  )
  50 endef
  51
  52 # TODO: push this into the combo files; unfortunately, we don't even
  53 # know HOST_OS at this point.
  54 trysed := $(shell echo a | sed -E -e 's/a/b/' 2>/dev/null)
  55 ifeq ($(trysed),b)
  56   SED_EXTENDED := sed -E
  57 else
  58   trysed := $(shell echo c | sed -r -e 's/c/d/' 2>/dev/null)
  59   ifeq ($(trysed),d)
  60     SED_EXTENDED := sed -r
  61   else
  62     $(error Unknown sed version)
  63   endif
  64 endif
  65
  66 ###########################################################
  67 ## List all of the files in a subdirectory in a format
  68 ## suitable for PRODUCT_COPY_FILES and
  69 ## PRODUCT_SDK_ADDON_COPY_FILES
  70 ##
  71 ## $(1): Glob to match file name
  72 ## $(2): Source directory
  73 ## $(3): Target base directory
  74 ###########################################################
  75
  76 define find-copy-subdir-files
  77 $(shell find $(2) -name "$(1)" | $(SED_EXTENDED) "s:($(2)/?(.*)):\\1\\:$(3)/\\2:" | sed "s://:/:g")
  78 endef
  79
  80 # ---------------------------------------------------------------
  81
  82 # These are the valid values of TARGET_BUILD_VARIANT.  Also, if anything else is passed
  83 # as the variant in the PRODUCT-$TARGET_BUILD_PRODUCT-$TARGET_BUILD_VARIANT form,
  84 # it will be treated as a goal, and the eng variant will be used.
  85 INTERNAL_VALID_VARIANTS := user userdebug eng tests
  86
  87 # ---------------------------------------------------------------
  88 # Provide "PRODUCT-<prodname>-<goal>" targets, which lets you build
  89 # a particular configuration without needing to set up the environment.
  90 #
  91 product_goals := $(strip $(filter PRODUCT-%,$(MAKECMDGOALS)))
  92 ifdef product_goals
  93   # Scrape the product and build names out of the goal,
  94   # which should be of the form PRODUCT-<productname>-<buildname>.
  95   #
  96   ifneq ($(words $(product_goals)),1)
  97     $(error Only one PRODUCT-* goal may be specified; saw "$(product_goals)")
  98   endif
  99   goal_name := $(product_goals)
 100   product_goals := $(patsubst PRODUCT-%,%,$(product_goals))
 101   product_goals := $(subst -, ,$(product_goals))
 102   ifneq ($(words $(product_goals)),2)
 103     $(error Bad PRODUCT-* goal "$(goal_name)")
 104   endif
 105
 106   # The product they want
 107   TARGET_PRODUCT := $(word 1,$(product_goals))
 108
 109   # The variant they want
 110   TARGET_BUILD_VARIANT := $(word 2,$(product_goals))
 111
 112   # The build server wants to do make PRODUCT-dream-installclean
 113   # which really means TARGET_PRODUCT=dream make installclean.
 114   ifneq ($(filter-out $(INTERNAL_VALID_VARIANTS),$(TARGET_BUILD_VARIANT)),)
 115         MAKECMDGOALS := $(MAKECMDGOALS) $(TARGET_BUILD_VARIANT)
 116         TARGET_BUILD_VARIANT := eng
 117     default_goal_substitution :=
 118   else
 119     default_goal_substitution := $(DEFAULT_GOAL)
 120   endif
 121
 122   # Hack to make the linux build servers use dexpreopt.
 123   # OSX is still a little flaky.  Most engineers don't use this
 124   # type of target ("make PRODUCT-blah-user"), so this should
 125   # only tend to happen when using buildbot.
 126   # TODO: remove this and fix the matching lines in build/core/main.mk
 127   # once dexpreopt works better on OSX.
 128   ifeq ($(TARGET_BUILD_VARIANT),user)
 129     WITH_DEXPREOPT_buildbot := true
 130   endif
 131
 132   # Replace the PRODUCT-* goal with the build goal that it refers to.
 133   # Note that this will ensure that it appears in the same relative
 134   # position, in case it matters.
 135   #
 136   # Note that modifying this will not affect the goals that make will
 137   # attempt to build, but it's important because we inspect this value
 138   # in certain situations (like for "make sdk").
 139   #
 140   MAKECMDGOALS := $(patsubst $(goal_name),$(default_goal_substitution),$(MAKECMDGOALS))
 141
 142   # Define a rule for the PRODUCT-* goal, and make it depend on the
 143   # patched-up command-line goals as well as any other goals that we
 144   # want to force.
 145   #
 146 .PHONY: $(goal_name)
 147 $(goal_name): $(MAKECMDGOALS)
 148 endif
 149 # else: Use the value set in the environment or buildspec.mk.
 150
 151 # ---------------------------------------------------------------
 152 # Include the product definitions.
 153 # We need to do this to translate TARGET_PRODUCT into its
 154 # underlying TARGET_DEVICE before we start defining any rules.
 155 #
 156 include $(BUILD_SYSTEM)/node_fns.mk
 157 include $(BUILD_SYSTEM)/product.mk
 158 include $(BUILD_SYSTEM)/device.mk
 159
 160 # Read in all of the product definitions specified by the AndroidProducts.mk
 161 # files in the tree.
 162 #
 163 #TODO: when we start allowing direct pointers to product files,
 164 #    guarantee that they're in this list.
 165 $(call import-products, $(get-all-product-makefiles))
 166 $(check-all-products)
 167 #$(dump-products)
 168 #$(error done)
 169
 170 # Convert a short name like "sooner" into the path to the product
 171 # file defining that product.
 172 #
 173 INTERNAL_PRODUCT := $(call resolve-short-product-name, $(TARGET_PRODUCT))
 174 #$(error TARGET_PRODUCT $(TARGET_PRODUCT) --> $(INTERNAL_PRODUCT))
 175
 176 # Find the device that this product maps to.
 177 TARGET_DEVICE := $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_DEVICE)
 178
 179 # Figure out which resoure configuration options to use for this
 180 # product.
 181 PRODUCT_LOCALES := $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_LOCALES))
 182 # TODO: also keep track of things like "port", "land" in product files.
 183
 184 # If CUSTOM_LOCALES contains any locales not already included
 185 # in PRODUCT_LOCALES, add them to PRODUCT_LOCALES.
 186 extra_locales := $(filter-out $(PRODUCT_LOCALES),$(CUSTOM_LOCALES))
 187 ifneq (,$(extra_locales))
 188   ifneq ($(CALLED_FROM_SETUP),true)
 189     # Don't spam stdout, because envsetup.sh may be scraping values from it.
 190     $(info Adding CUSTOM_LOCALES [$(extra_locales)] to PRODUCT_LOCALES [$(PRODUCT_LOCALES)])
 191   endif
 192   PRODUCT_LOCALES += $(extra_locales)
 193   extra_locales :=
 194 endif
 195
 196 # Default to medium-density assets.
 197 # (Can be overridden in the device config, e.g.: PRODUCT_LOCALES += hdpi)
 198 PRODUCT_LOCALES := $(strip \
 199         $(PRODUCT_LOCALES) \
 200         $(if $(filter %dpi,$(PRODUCT_LOCALES)),,mdpi))
 201
 202 # Assemble the list of options.
 203 PRODUCT_AAPT_CONFIG := $(PRODUCT_LOCALES)
 204
 205 # Convert spaces to commas.
 206 comma := ,
 207 PRODUCT_AAPT_CONFIG := \
 208         $(subst $(space),$(comma),$(strip $(PRODUCT_AAPT_CONFIG)))
 209
 210 PRODUCT_BRAND := $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_BRAND))
 211
 212 PRODUCT_MODEL := $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_MODEL))
 213 ifndef PRODUCT_MODEL
 214   PRODUCT_MODEL := $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_NAME))
 215 endif
 216
 217 PRODUCT_MANUFACTURER := \
 218         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_MANUFACTURER))
 219 ifndef PRODUCT_MANUFACTURER
 220   PRODUCT_MANUFACTURER := unknown
 221 endif
 222
 223 PRODUCT_DEFAULT_WIFI_CHANNELS := \
 224         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_DEFAULT_WIFI_CHANNELS))
 225
 226 # Which policy should this product use
 227 PRODUCT_POLICY := $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_POLICY))
 228
 229 # A list of words like <source path>:<destination path>.  The file at
 230 # the source path should be copied to the destination path when building
 231 # this product.  <destination path> is relative to $(PRODUCT_OUT), so
 232 # it should look like, e.g., "system/etc/file.xml".  The rules
 233 # for these copy steps are defined in config/Makefile.
 234 PRODUCT_COPY_FILES := \
 235         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_COPY_FILES))
 236
 237 # The HTML file containing the contributors to the project.
 238 PRODUCT_CONTRIBUTORS_FILE := \
 239         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_CONTRIBUTORS_FILE))
 240
 241 # A list of property assignments, like "key = value", with zero or more
 242 # whitespace characters on either side of the '='.
 243 PRODUCT_PROPERTY_OVERRIDES := \
 244         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_PROPERTY_OVERRIDES))
 245
 246 # Should we use the default resources or add any product specific overlays
 247 PRODUCT_PACKAGE_OVERLAYS := \
 248         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_PACKAGE_OVERLAYS))
 249 DEVICE_PACKAGE_OVERLAYS := \
 250         $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).DEVICE_PACKAGE_OVERLAYS))
 251
 252 # An list of whitespace-separated words.
 253 PRODUCT_TAGS := $(strip $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_TAGS))
 254
 255 # Add the product-defined properties to the build properties.
 256 ADDITIONAL_BUILD_PROPERTIES := \
 257         $(ADDITIONAL_BUILD_PROPERTIES) \
 258         $(PRODUCT_PROPERTY_OVERRIDES)
 259
 260 # The OTA key(s) specified by the product config, if any.  The names
 261 # of these keys are stored in the target-files zip so that post-build
 262 # signing tools can substitute them for the test key embedded by
 263 # default.
 264 PRODUCT_OTA_PUBLIC_KEYS := $(sort \
 265     $(PRODUCTS.$(INTERNAL_PRODUCT).PRODUCT_OTA_PUBLIC_KEYS))
 266
 267 # ---------------------------------------------------------------
 268 # Simulator overrides
 269 ifeq ($(TARGET_PRODUCT),sim)
 270   # Tell the build system to turn on some special cases
 271   # to deal with the simulator product.
 272   TARGET_SIMULATOR := true
 273   # dexpreopt doesn't work when building the simulator
 274   DISABLE_DEXPREOPT := true
 275 endif