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