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