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#
30define _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
34endef
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#
41define 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 )
52endef
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#
59define get-all-product-makefiles
60$(call get-product-makefiles,$(_find-android-products-files))
61endef
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_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_BOOT_JARS \
100    PRODUCT_SUPPORTS_BOOT_SIGNER \
101    PRODUCT_SUPPORTS_VBOOT \
102    PRODUCT_SUPPORTS_VERITY \
103    PRODUCT_OEM_PROPERTIES \
104    PRODUCT_SYSTEM_PROPERTY_BLACKLIST \
105    PRODUCT_SYSTEM_SERVER_JARS \
106    PRODUCT_VBOOT_SIGNING_KEY \
107    PRODUCT_VERITY_SIGNING_KEY \
108    PRODUCT_SYSTEM_VERITY_PARTITION \
109    PRODUCT_VENDOR_VERITY_PARTITION \
110    PRODUCT_DEX_PREOPT_MODULE_CONFIGS \
111    PRODUCT_DEX_PREOPT_DEFAULT_FLAGS \
112    PRODUCT_DEX_PREOPT_BOOT_FLAGS \
113
114
115define dump-product
116$(info ==== $(1) ====)\
117$(foreach v,$(_product_var_list),\
118$(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
119$(info --------)
120endef
121
122define dump-products
123$(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
124endef
125
126#
127# $(1): product to inherit
128#
129# Does three things:
130#  1. Inherits all of the variables from $1.
131#  2. Records the inheritance in the .INHERITS_FROM variable
132#  3. Records that we've visited this node, in ALL_PRODUCTS
133#
134define inherit-product
135  $(foreach v,$(_product_var_list), \
136      $(eval $(v) := $($(v)) $(INHERIT_TAG)$(strip $(1)))) \
137  $(eval inherit_var := \
138      PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
139  $(eval $(inherit_var) := $(sort $($(inherit_var)) $(strip $(1)))) \
140  $(eval inherit_var:=) \
141  $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
142endef
143
144
145#
146# Do inherit-product only if $(1) exists
147#
148define inherit-product-if-exists
149  $(if $(wildcard $(1)),$(call inherit-product,$(1)),)
150endef
151
152#
153# $(1): product makefile list
154#
155#TODO: check to make sure that products have all the necessary vars defined
156define import-products
157$(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
158endef
159
160
161#
162# Does various consistency checks on all of the known products.
163# Takes no parameters, so $(call ) is not necessary.
164#
165define check-all-products
166$(if ,, \
167  $(eval _cap_names :=) \
168  $(foreach p,$(PRODUCTS), \
169    $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
170    $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
171    $(if $(filter $(pn),$(_cap_names)), \
172      $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
173          $(foreach \
174            pp,$(PRODUCTS),
175              $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
176                $(pp) \
177               ))) \
178       ) \
179     ) \
180    $(eval _cap_names += $(pn)) \
181    $(if $(call is-c-identifier,$(pn)),, \
182      $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
183     ) \
184    $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
185    $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
186    $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
187      $(if $(filter 2 3,$(words $(subst :,$(space),$(cf)))),, \
188        $(error $(p): malformed COPY_FILE "$(cf)") \
189       ) \
190     ) \
191   ) \
192)
193endef
194
195
196#
197# Returns the product makefile path for the product with the provided name
198#
199# $(1): short product name like "generic"
200#
201define _resolve-short-product-name
202  $(eval pn := $(strip $(1)))
203  $(eval p := \
204      $(foreach p,$(PRODUCTS), \
205          $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
206            $(p) \
207       )) \
208   )
209  $(eval p := $(sort $(p)))
210  $(if $(filter 1,$(words $(p))), \
211    $(p), \
212    $(if $(filter 0,$(words $(p))), \
213      $(error No matches for product "$(pn)"), \
214      $(error Product "$(pn)" ambiguous: matches $(p)) \
215    ) \
216  )
217endef
218define resolve-short-product-name
219$(strip $(call _resolve-short-product-name,$(1)))
220endef
221
222
223_product_stash_var_list := $(_product_var_list) \
224	PRODUCT_BOOTCLASSPATH \
225	PRODUCT_SYSTEM_SERVER_CLASSPATH \
226	TARGET_ARCH \
227	TARGET_ARCH_VARIANT \
228	TARGET_CPU_VARIANT \
229	TARGET_BOARD_PLATFORM \
230	TARGET_BOARD_PLATFORM_GPU \
231	TARGET_BOARD_KERNEL_HEADERS \
232	TARGET_DEVICE_KERNEL_HEADERS \
233	TARGET_PRODUCT_KERNEL_HEADERS \
234	TARGET_BOOTLOADER_BOARD_NAME \
235	TARGET_NO_BOOTLOADER \
236	TARGET_NO_KERNEL \
237	TARGET_NO_RECOVERY \
238	TARGET_NO_RADIOIMAGE \
239	TARGET_HARDWARE_3D \
240	TARGET_PROVIDES_INIT_RC \
241	TARGET_CPU_ABI \
242	TARGET_CPU_ABI2 \
243
244
245_product_stash_var_list += \
246	BOARD_WPA_SUPPLICANT_DRIVER \
247	BOARD_WLAN_DEVICE \
248	BOARD_USES_GENERIC_AUDIO \
249	BOARD_KERNEL_CMDLINE \
250	BOARD_KERNEL_BASE \
251	BOARD_HAVE_BLUETOOTH \
252	BOARD_VENDOR_USE_AKMD \
253	BOARD_EGL_CFG \
254	BOARD_BOOTIMAGE_PARTITION_SIZE \
255	BOARD_RECOVERYIMAGE_PARTITION_SIZE \
256	BOARD_SYSTEMIMAGE_PARTITION_SIZE \
257	BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE \
258	BOARD_USERDATAIMAGE_FILE_SYSTEM_TYPE \
259	BOARD_USERDATAIMAGE_PARTITION_SIZE \
260	BOARD_CACHEIMAGE_FILE_SYSTEM_TYPE \
261	BOARD_CACHEIMAGE_PARTITION_SIZE \
262	BOARD_FLASH_BLOCK_SIZE \
263	BOARD_VENDORIMAGE_PARTITION_SIZE \
264	BOARD_VENDORIMAGE_FILE_SYSTEM_TYPE \
265	BOARD_INSTALLER_CMDLINE \
266
267
268_product_stash_var_list += \
269	DEFAULT_SYSTEM_DEV_CERTIFICATE \
270	WITH_DEXPREOPT \
271	WITH_DEXPREOPT_BOOT_IMG_ONLY
272
273_product_stash_var_list += \
274	GLOBAL_CFLAGS_NO_OVERRIDE \
275	GLOBAL_CPPFLAGS_NO_OVERRIDE \
276
277#
278# Stash values of the variables in _product_stash_var_list.
279# $(1): Renamed prefix
280#
281define stash-product-vars
282$(foreach v,$(_product_stash_var_list), \
283        $(eval $(strip $(1))_$(call rot13,$(v)):=$$($$(v))) \
284 )
285endef
286
287#
288# Assert that the the variable stashed by stash-product-vars remains untouched.
289# $(1): The prefix as supplied to stash-product-vars
290#
291define assert-product-vars
292$(strip \
293  $(eval changed_variables:=)
294  $(foreach v,$(_product_stash_var_list), \
295    $(if $(call streq,$($(v)),$($(strip $(1))_$(call rot13,$(v)))),, \
296        $(eval $(warning $(v) has been modified: $($(v)))) \
297        $(eval $(warning previous value: $($(strip $(1))_$(call rot13,$(v))))) \
298        $(eval changed_variables := $(changed_variables) $(v))) \
299   ) \
300  $(if $(changed_variables),\
301    $(eval $(error The following variables have been changed: $(changed_variables))),)
302)
303endef
304
305define add-to-product-copy-files-if-exists
306$(if $(wildcard $(word 1,$(subst :, ,$(1)))),$(1))
307endef
308
309# whitespace placeholder when we record module's dex-preopt config.
310_PDPMC_SP_PLACE_HOLDER := |@SP@|
311# Set up dex-preopt config for a module.
312# $(1) list of module names
313# $(2) the modules' dex-preopt config
314define add-product-dex-preopt-module-config
315$(eval _c := $(subst $(space),$(_PDPMC_SP_PLACE_HOLDER),$(strip $(2))))\
316$(eval PRODUCT_DEX_PREOPT_MODULE_CONFIGS += \
317  $(foreach m,$(1),$(m)=$(_c)))
318endef
319