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