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