core/product.mk

   1 #
   2 # Copyright (C) 2007 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 # Functions for including AndroidProducts.mk files
  19 # PRODUCT_MAKEFILES is set up in AndroidProducts.mks.
  20 # Format of PRODUCT_MAKEFILES:
  21 # <product_name>:<path_to_the_product_makefile>
  22 # If the <product_name> is the same as the base file name (without dir
  23 # and the .mk suffix) of the product makefile, "<product_name>:" can be
  24 # omitted.
  25
  26 # Search for AndroidProducts.mks in the given dir.
  27 # $(1): the path to the dir
  28 define _search-android-products-files-in-dir
  29 $(sort $(shell test -d $(1) && find -L $(1) \
  30   -maxdepth 6 \
  31   -name .git -prune \
  32   -o -name AndroidProducts.mk -print))
  33 endef
  34
  35 #
  36 # Returns the list of all AndroidProducts.mk files.
  37 # $(call ) isn't necessary.
  38 #
  39 define _find-android-products-files
  40 $(foreach d, device vendor product,$(call _search-android-products-files-in-dir,$(d))) \
  41   $(SRC_TARGET_DIR)/product/AndroidProducts.mk
  42 endef
  43
  44 #
  45 # Returns the sorted concatenation of PRODUCT_MAKEFILES
  46 # variables set in the given AndroidProducts.mk files.
  47 # $(1): the list of AndroidProducts.mk files.
  48 #
  49 define get-product-makefiles
  50 $(sort \
  51   $(foreach f,$(1), \
  52     $(eval PRODUCT_MAKEFILES :=) \
  53     $(eval LOCAL_DIR := $(patsubst %/,%,$(dir $(f)))) \
  54     $(eval include $(f)) \
  55     $(PRODUCT_MAKEFILES) \
  56    ) \
  57   $(eval PRODUCT_MAKEFILES :=) \
  58   $(eval LOCAL_DIR :=) \
  59  )
  60 endef
  61
  62 #
  63 # Returns the sorted concatenation of all PRODUCT_MAKEFILES
  64 # variables set in all AndroidProducts.mk files.
  65 # $(call ) isn't necessary.
  66 #
  67 define get-all-product-makefiles
  68 $(call get-product-makefiles,$(_find-android-products-files))
  69 endef
  70
  71 #
  72 # Functions for including product makefiles
  73 #
  74
  75 _product_var_list := \
  76     PRODUCT_NAME \
  77     PRODUCT_MODEL \
  78     PRODUCT_LOCALES \
  79     PRODUCT_AAPT_CONFIG \
  80     PRODUCT_AAPT_PREF_CONFIG \
  81     PRODUCT_AAPT_PREBUILT_DPI \
  82     PRODUCT_PACKAGES \
  83     PRODUCT_PACKAGES_DEBUG \
  84     PRODUCT_PACKAGES_ENG \
  85     PRODUCT_PACKAGES_TESTS \
  86     PRODUCT_DEVICE \
  87     PRODUCT_MANUFACTURER \
  88     PRODUCT_BRAND \
  89     PRODUCT_PROPERTY_OVERRIDES \
  90     PRODUCT_DEFAULT_PROPERTY_OVERRIDES \
  91     PRODUCT_CHARACTERISTICS \
  92     PRODUCT_COPY_FILES \
  93     PRODUCT_OTA_PUBLIC_KEYS \
  94     PRODUCT_EXTRA_RECOVERY_KEYS \
  95     PRODUCT_PACKAGE_OVERLAYS \
  96     DEVICE_PACKAGE_OVERLAYS \
  97     PRODUCT_SDK_ATREE_FILES \
  98     PRODUCT_SDK_ADDON_NAME \
  99     PRODUCT_SDK_ADDON_COPY_FILES \
 100     PRODUCT_SDK_ADDON_COPY_MODULES \
 101     PRODUCT_SDK_ADDON_DOC_MODULES \
 102     PRODUCT_SDK_ADDON_SYS_IMG_SOURCE_PROP \
 103     PRODUCT_DEFAULT_WIFI_CHANNELS \
 104     PRODUCT_DEFAULT_DEV_CERTIFICATE \
 105     PRODUCT_RESTRICT_VENDOR_FILES \
 106     PRODUCT_VENDOR_KERNEL_HEADERS \
 107     PRODUCT_BOOT_JARS \
 108     PRODUCT_SUPPORTS_BOOT_SIGNER \
 109     PRODUCT_SUPPORTS_VBOOT \
 110     PRODUCT_SUPPORTS_VERITY \
 111     PRODUCT_SUPPORTS_VERITY_FEC \
 112     PRODUCT_OEM_PROPERTIES \
 113     PRODUCT_SYSTEM_PROPERTY_BLACKLIST \
 114     PRODUCT_SYSTEM_SERVER_JARS \
 115     PRODUCT_VBOOT_SIGNING_KEY \
 116     PRODUCT_VBOOT_SIGNING_SUBKEY \
 117     PRODUCT_VERITY_SIGNING_KEY \
 118     PRODUCT_SYSTEM_VERITY_PARTITION \
 119     PRODUCT_VENDOR_VERITY_PARTITION \
 120     PRODUCT_DEX_PREOPT_MODULE_CONFIGS \
 121     PRODUCT_DEX_PREOPT_DEFAULT_FLAGS \
 122     PRODUCT_DEX_PREOPT_BOOT_FLAGS \
 123     PRODUCT_SANITIZER_MODULE_CONFIGS \
 124     PRODUCT_SYSTEM_BASE_FS_PATH \
 125     PRODUCT_VENDOR_BASE_FS_PATH \
 126     PRODUCT_SHIPPING_API_LEVEL \
 127
 128
 129
 130 define dump-product
 131 $(info ==== $(1) ====)\
 132 $(foreach v,$(_product_var_list),\
 133 $(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
 134 $(info --------)
 135 endef
 136
 137 define dump-products
 138 $(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
 139 endef
 140
 141 #
 142 # $(1): product to inherit
 143 #
 144 # Does three things:
 145 #  1. Inherits all of the variables from $1.
 146 #  2. Records the inheritance in the .INHERITS_FROM variable
 147 #  3. Records that we've visited this node, in ALL_PRODUCTS
 148 #
 149 define inherit-product
 150   $(if $(findstring ../,$(1)),\
 151     $(eval np := $(call normalize-paths,$(1))),\
 152     $(eval np := $(strip $(1))))\
 153   $(foreach v,$(_product_var_list), \
 154       $(eval $(v) := $($(v)) $(INHERIT_TAG)$(np))) \
 155   $(eval inherit_var := \
 156       PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
 157   $(eval $(inherit_var) := $(sort $($(inherit_var)) $(np))) \
 158   $(eval inherit_var:=) \
 159   $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
 160 endef
 161
 162
 163 #
 164 # Do inherit-product only if $(1) exists
 165 #
 166 define inherit-product-if-exists
 167   $(if $(wildcard $(1)),$(call inherit-product,$(1)),)
 168 endef
 169
 170 #
 171 # $(1): product makefile list
 172 #
 173 #TODO: check to make sure that products have all the necessary vars defined
 174 define import-products
 175 $(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
 176 endef
 177
 178
 179 #
 180 # Does various consistency checks on all of the known products.
 181 # Takes no parameters, so $(call ) is not necessary.
 182 #
 183 define check-all-products
 184 $(if ,, \
 185   $(eval _cap_names :=) \
 186   $(foreach p,$(PRODUCTS), \
 187     $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
 188     $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
 189     $(if $(filter $(pn),$(_cap_names)), \
 190       $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
 191           $(foreach \
 192             pp,$(PRODUCTS),
 193               $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
 194                 $(pp) \
 195                ))) \
 196        ) \
 197      ) \
 198     $(eval _cap_names += $(pn)) \
 199     $(if $(call is-c-identifier,$(pn)),, \
 200       $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
 201      ) \
 202     $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
 203     $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
 204     $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
 205       $(if $(filter 2 3,$(words $(subst :,$(space),$(cf)))),, \
 206         $(error $(p): malformed COPY_FILE "$(cf)") \
 207        ) \
 208      ) \
 209    ) \
 210 )
 211 endef
 212
 213
 214 #
 215 # Returns the product makefile path for the product with the provided name
 216 #
 217 # $(1): short product name like "generic"
 218 #
 219 define _resolve-short-product-name
 220   $(eval pn := $(strip $(1)))
 221   $(eval p := \
 222       $(foreach p,$(PRODUCTS), \
 223           $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
 224             $(p) \
 225        )) \
 226    )
 227   $(eval p := $(sort $(p)))
 228   $(if $(filter 1,$(words $(p))), \
 229     $(p), \
 230     $(if $(filter 0,$(words $(p))), \
 231       $(error No matches for product "$(pn)"), \
 232       $(error Product "$(pn)" ambiguous: matches $(p)) \
 233     ) \
 234   )
 235 endef
 236 define resolve-short-product-name
 237 $(strip $(call _resolve-short-product-name,$(1)))
 238 endef
 239
 240
 241 _product_stash_var_list := $(_product_var_list) \
 242         PRODUCT_BOOTCLASSPATH \
 243         PRODUCT_SYSTEM_SERVER_CLASSPATH \
 244         TARGET_ARCH \
 245         TARGET_ARCH_VARIANT \
 246         TARGET_CPU_VARIANT \
 247         TARGET_BOARD_PLATFORM \
 248         TARGET_BOARD_PLATFORM_GPU \
 249         TARGET_BOARD_KERNEL_HEADERS \
 250         TARGET_DEVICE_KERNEL_HEADERS \
 251         TARGET_PRODUCT_KERNEL_HEADERS \
 252         TARGET_BOOTLOADER_BOARD_NAME \
 253         TARGET_NO_BOOTLOADER \
 254         TARGET_NO_KERNEL \
 255         TARGET_NO_RECOVERY \
 256         TARGET_NO_RADIOIMAGE \
 257         TARGET_HARDWARE_3D \
 258         TARGET_CPU_ABI \
 259         TARGET_CPU_ABI2 \
 260
 261
 262 _product_stash_var_list += \
 263         BOARD_WPA_SUPPLICANT_DRIVER \
 264         BOARD_WLAN_DEVICE \
 265         BOARD_USES_GENERIC_AUDIO \
 266         BOARD_KERNEL_CMDLINE \
 267         BOARD_KERNEL_BASE \
 268         BOARD_HAVE_BLUETOOTH \
 269         BOARD_VENDOR_USE_AKMD \
 270         BOARD_EGL_CFG \
 271         BOARD_BOOTIMAGE_PARTITION_SIZE \
 272         BOARD_RECOVERYIMAGE_PARTITION_SIZE \
 273         BOARD_SYSTEMIMAGE_PARTITION_SIZE \
 274         BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE \
 275         BOARD_USERDATAIMAGE_FILE_SYSTEM_TYPE \
 276         BOARD_USERDATAIMAGE_PARTITION_SIZE \
 277         BOARD_CACHEIMAGE_FILE_SYSTEM_TYPE \
 278         BOARD_CACHEIMAGE_PARTITION_SIZE \
 279         BOARD_FLASH_BLOCK_SIZE \
 280         BOARD_VENDORIMAGE_PARTITION_SIZE \
 281         BOARD_VENDORIMAGE_FILE_SYSTEM_TYPE \
 282         BOARD_INSTALLER_CMDLINE \
 283
 284
 285 _product_stash_var_list += \
 286         DEFAULT_SYSTEM_DEV_CERTIFICATE \
 287         WITH_DEXPREOPT \
 288         WITH_DEXPREOPT_BOOT_IMG_ONLY
 289
 290 _product_stash_var_list += \
 291         GLOBAL_CFLAGS_NO_OVERRIDE \
 292         GLOBAL_CPPFLAGS_NO_OVERRIDE \
 293         GLOBAL_CLANG_CFLAGS_NO_OVERRIDE \
 294
 295 #
 296 # Stash values of the variables in _product_stash_var_list.
 297 # $(1): Renamed prefix
 298 #
 299 define stash-product-vars
 300 $(foreach v,$(_product_stash_var_list), \
 301         $(eval $(strip $(1))_$(call rot13,$(v)):=$$($$(v))) \
 302  )
 303 endef
 304
 305 #
 306 # Assert that the the variable stashed by stash-product-vars remains untouched.
 307 # $(1): The prefix as supplied to stash-product-vars
 308 #
 309 define assert-product-vars
 310 $(strip \
 311   $(eval changed_variables:=)
 312   $(foreach v,$(_product_stash_var_list), \
 313     $(if $(call streq,$($(v)),$($(strip $(1))_$(call rot13,$(v)))),, \
 314         $(eval $(warning $(v) has been modified: $($(v)))) \
 315         $(eval $(warning previous value: $($(strip $(1))_$(call rot13,$(v))))) \
 316         $(eval changed_variables := $(changed_variables) $(v))) \
 317    ) \
 318   $(if $(changed_variables),\
 319     $(eval $(error The following variables have been changed: $(changed_variables))),)
 320 )
 321 endef
 322
 323 define add-to-product-copy-files-if-exists
 324 $(if $(wildcard $(word 1,$(subst :, ,$(1)))),$(1))
 325 endef
 326
 327 # whitespace placeholder when we record module's dex-preopt config.
 328 _PDPMC_SP_PLACE_HOLDER := |@SP@|
 329 # Set up dex-preopt config for a module.
 330 # $(1) list of module names
 331 # $(2) the modules' dex-preopt config
 332 define add-product-dex-preopt-module-config
 333 $(eval _c := $(subst $(space),$(_PDPMC_SP_PLACE_HOLDER),$(strip $(2))))\
 334 $(eval PRODUCT_DEX_PREOPT_MODULE_CONFIGS += \
 335   $(foreach m,$(1),$(m)=$(_c)))
 336 endef
 337
 338 # whitespace placeholder when we record module's sanitizer config.
 339 _PSMC_SP_PLACE_HOLDER := |@SP@|
 340 # Set up sanitizer config for a module.
 341 # $(1) list of module names
 342 # $(2) the modules' sanitizer config
 343 define add-product-sanitizer-module-config
 344 $(eval _c := $(subst $(space),$(_PSMC_SP_PLACE_HOLDER),$(strip $(2))))\
 345 $(eval PRODUCT_SANITIZER_MODULE_CONFIGS += \
 346   $(foreach m,$(1),$(m)=$(_c)))
 347 endef