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_PACKAGES \
  74     PRODUCT_PACKAGES_DEBUG \
  75     PRODUCT_PACKAGES_ENG \
  76     PRODUCT_PACKAGES_TESTS \
  77     PRODUCT_DEVICE \
  78     PRODUCT_MANUFACTURER \
  79     PRODUCT_BRAND \
  80     PRODUCT_PROPERTY_OVERRIDES \
  81     PRODUCT_DEFAULT_PROPERTY_OVERRIDES \
  82     PRODUCT_CHARACTERISTICS \
  83     PRODUCT_COPY_FILES \
  84     PRODUCT_OTA_PUBLIC_KEYS \
  85     PRODUCT_EXTRA_RECOVERY_KEYS \
  86     PRODUCT_PACKAGE_OVERLAYS \
  87     DEVICE_PACKAGE_OVERLAYS \
  88     PRODUCT_TAGS \
  89     PRODUCT_SDK_ATREE_FILES \
  90     PRODUCT_SDK_ADDON_NAME \
  91     PRODUCT_SDK_ADDON_COPY_FILES \
  92     PRODUCT_SDK_ADDON_COPY_MODULES \
  93     PRODUCT_SDK_ADDON_DOC_MODULES \
  94     PRODUCT_SDK_ADDON_SYS_IMG_SOURCE_PROP \
  95     PRODUCT_DEFAULT_WIFI_CHANNELS \
  96     PRODUCT_DEFAULT_DEV_CERTIFICATE \
  97     PRODUCT_RESTRICT_VENDOR_FILES \
  98     PRODUCT_VENDOR_KERNEL_HEADERS \
  99     PRODUCT_FACTORY_RAMDISK_MODULES \
 100     PRODUCT_FACTORY_BUNDLE_MODULES \
 101     PRODUCT_RUNTIMES \
 102     PRODUCT_BOOT_JARS \
 103     PRODUCT_DEX_PREOPT_IMAGE_IN_DATA \
 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
 112 define dump-product
 113 $(info ==== $(1) ====)\
 114 $(foreach v,$(_product_var_list),\
 115 $(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
 116 $(info --------)
 117 endef
 118
 119 define dump-products
 120 $(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
 121 endef
 122
 123 #
 124 # $(1): product to inherit
 125 #
 126 # Does three things:
 127 #  1. Inherits all of the variables from $1.
 128 #  2. Records the inheritance in the .INHERITS_FROM variable
 129 #  3. Records that we've visited this node, in ALL_PRODUCTS
 130 #
 131 define inherit-product
 132   $(foreach v,$(_product_var_list), \
 133       $(eval $(v) := $($(v)) $(INHERIT_TAG)$(strip $(1)))) \
 134   $(eval inherit_var := \
 135       PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
 136   $(eval $(inherit_var) := $(sort $($(inherit_var)) $(strip $(1)))) \
 137   $(eval inherit_var:=) \
 138   $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
 139 endef
 140
 141
 142 #
 143 # Do inherit-product only if $(1) exists
 144 #
 145 define inherit-product-if-exists
 146   $(if $(wildcard $(1)),$(call inherit-product,$(1)),)
 147 endef
 148
 149 #
 150 # $(1): product makefile list
 151 #
 152 #TODO: check to make sure that products have all the necessary vars defined
 153 define import-products
 154 $(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
 155 endef
 156
 157
 158 #
 159 # Does various consistency checks on all of the known products.
 160 # Takes no parameters, so $(call ) is not necessary.
 161 #
 162 define check-all-products
 163 $(if ,, \
 164   $(eval _cap_names :=) \
 165   $(foreach p,$(PRODUCTS), \
 166     $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
 167     $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
 168     $(if $(filter $(pn),$(_cap_names)), \
 169       $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
 170           $(foreach \
 171             pp,$(PRODUCTS),
 172               $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
 173                 $(pp) \
 174                ))) \
 175        ) \
 176      ) \
 177     $(eval _cap_names += $(pn)) \
 178     $(if $(call is-c-identifier,$(pn)),, \
 179       $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
 180      ) \
 181     $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
 182     $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
 183     $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
 184       $(if $(filter 2 3,$(words $(subst :,$(space),$(cf)))),, \
 185         $(error $(p): malformed COPY_FILE "$(cf)") \
 186        ) \
 187      ) \
 188    ) \
 189 )
 190 endef
 191
 192
 193 #
 194 # Returns the product makefile path for the product with the provided name
 195 #
 196 # $(1): short product name like "generic"
 197 #
 198 define _resolve-short-product-name
 199   $(eval pn := $(strip $(1)))
 200   $(eval p := \
 201       $(foreach p,$(PRODUCTS), \
 202           $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
 203             $(p) \
 204        )) \
 205    )
 206   $(eval p := $(sort $(p)))
 207   $(if $(filter 1,$(words $(p))), \
 208     $(p), \
 209     $(if $(filter 0,$(words $(p))), \
 210       $(error No matches for product "$(pn)"), \
 211       $(error Product "$(pn)" ambiguous: matches $(p)) \
 212     ) \
 213   )
 214 endef
 215 define resolve-short-product-name
 216 $(strip $(call _resolve-short-product-name,$(1)))
 217 endef
 218
 219
 220 _product_stash_var_list := $(_product_var_list) \
 221         PRODUCT_BOOTCLASSPATH \
 222         PRODUCT_SYSTEM_SERVER_CLASSPATH \
 223         TARGET_ARCH \
 224         TARGET_ARCH_VARIANT \
 225         TARGET_CPU_VARIANT \
 226         TARGET_BOARD_PLATFORM \
 227         TARGET_BOARD_PLATFORM_GPU \
 228         TARGET_BOARD_KERNEL_HEADERS \
 229         TARGET_DEVICE_KERNEL_HEADERS \
 230         TARGET_PRODUCT_KERNEL_HEADERS \
 231         TARGET_BOOTLOADER_BOARD_NAME \
 232         TARGET_COMPRESS_MODULE_SYMBOLS \
 233         TARGET_NO_BOOTLOADER \
 234         TARGET_NO_KERNEL \
 235         TARGET_NO_RECOVERY \
 236         TARGET_NO_RADIOIMAGE \
 237         TARGET_HARDWARE_3D \
 238         TARGET_PROVIDES_INIT_RC \
 239         TARGET_CPU_ABI \
 240         TARGET_CPU_ABI2 \
 241         TARGET_CPU_SMP \
 242
 243
 244 _product_stash_var_list += \
 245         BOARD_WPA_SUPPLICANT_DRIVER \
 246         BOARD_WLAN_DEVICE \
 247         BOARD_USES_GENERIC_AUDIO \
 248         BOARD_KERNEL_CMDLINE \
 249         BOARD_KERNEL_BASE \
 250         BOARD_HAVE_BLUETOOTH \
 251         BOARD_VENDOR_USE_AKMD \
 252         BOARD_EGL_CFG \
 253         BOARD_BOOTIMAGE_PARTITION_SIZE \
 254         BOARD_RECOVERYIMAGE_PARTITION_SIZE \
 255         BOARD_SYSTEMIMAGE_PARTITION_SIZE \
 256         BOARD_USERDATAIMAGE_FILE_SYSTEM_TYPE \
 257         BOARD_USERDATAIMAGE_PARTITION_SIZE \
 258         BOARD_CACHEIMAGE_FILE_SYSTEM_TYPE \
 259         BOARD_CACHEIMAGE_PARTITION_SIZE \
 260         BOARD_FLASH_BLOCK_SIZE \
 261         BOARD_VENDORIMAGE_PARTITION_SIZE \
 262         BOARD_VENDORIMAGE_FILE_SYSTEM_TYPE \
 263         BOARD_INSTALLER_CMDLINE \
 264
 265
 266 _product_stash_var_list += \
 267         DEFAULT_SYSTEM_DEV_CERTIFICATE \
 268         WITH_DEXPREOPT \
 269         WITH_DEXPREOPT_BOOT_IMG_ONLY
 270
 271 #
 272 # Stash values of the variables in _product_stash_var_list.
 273 # $(1): Renamed prefix
 274 #
 275 define stash-product-vars
 276 $(foreach v,$(_product_stash_var_list), \
 277         $(eval $(strip $(1))_$(call rot13,$(v)):=$$($$(v))) \
 278  )
 279 endef
 280
 281 #
 282 # Assert that the the variable stashed by stash-product-vars remains untouched.
 283 # $(1): The prefix as supplied to stash-product-vars
 284 #
 285 define assert-product-vars
 286 $(strip \
 287   $(eval changed_variables:=)
 288   $(foreach v,$(_product_stash_var_list), \
 289     $(if $(call streq,$($(v)),$($(strip $(1))_$(call rot13,$(v)))),, \
 290         $(eval $(warning $(v) has been modified: $($(v)))) \
 291         $(eval $(warning previous value: $($(strip $(1))_$(call rot13,$(v))))) \
 292         $(eval changed_variables := $(changed_variables) $(v))) \
 293    ) \
 294   $(if $(changed_variables),\
 295     $(eval $(error The following variables have been changed: $(changed_variables))),)
 296 )
 297 endef
 298
 299 define add-to-product-copy-files-if-exists
 300 $(if $(wildcard $(word 1,$(subst :, ,$(1)))),$(1))
 301 endef