product.mk revision 455f6f458df5814e841e176eef51df112df3bc23 
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$(sort $(shell test -d device && find device -maxdepth 6 -name AndroidProducts.mk)) \
32  $(sort $(shell test -d vendor && find vendor -maxdepth 6 -name AndroidProducts.mk)) \
33  $(sort $(shell test -d product && find product -maxdepth 6 -name AndroidProducts.mk)) \
34  $(SRC_TARGET_DIR)/product/AndroidProducts.mk
35endef
36
37#
38# Returns the sorted concatenation of PRODUCT_MAKEFILES
39# variables set in the given AndroidProducts.mk files.
40# $(1): the list of AndroidProducts.mk files.
41#
42define get-product-makefiles
43$(sort \
44  $(foreach f,$(1), \
45    $(eval PRODUCT_MAKEFILES :=) \
46    $(eval LOCAL_DIR := $(patsubst %/,%,$(dir $(f)))) \
47    $(eval include $(f)) \
48    $(PRODUCT_MAKEFILES) \
49   ) \
50  $(eval PRODUCT_MAKEFILES :=) \
51  $(eval LOCAL_DIR :=) \
52 )
53endef
54
55#
56# Returns the sorted concatenation of all PRODUCT_MAKEFILES
57# variables set in all AndroidProducts.mk files.
58# $(call ) isn't necessary.
59#
60define get-all-product-makefiles
61$(call get-product-makefiles,$(_find-android-products-files))
62endef
63
64#
65# Functions for including product makefiles
66#
67
68_product_var_list := \
69    PRODUCT_NAME \
70    PRODUCT_MODEL \
71    PRODUCT_LOCALES \
72    PRODUCT_AAPT_CONFIG \
73    PRODUCT_AAPT_PREF_CONFIG \
74    PRODUCT_AAPT_PREBUILT_DPI \
75    PRODUCT_PACKAGES \
76    PRODUCT_PACKAGES_DEBUG \
77    PRODUCT_PACKAGES_ENG \
78    PRODUCT_PACKAGES_TESTS \
79    PRODUCT_DEVICE \
80    PRODUCT_MANUFACTURER \
81    PRODUCT_BRAND \
82    PRODUCT_PROPERTY_OVERRIDES \
83    PRODUCT_DEFAULT_PROPERTY_OVERRIDES \
84    PRODUCT_CHARACTERISTICS \
85    PRODUCT_COPY_FILES \
86    PRODUCT_OTA_PUBLIC_KEYS \
87    PRODUCT_EXTRA_RECOVERY_KEYS \
88    PRODUCT_PACKAGE_OVERLAYS \
89    DEVICE_PACKAGE_OVERLAYS \
90    PRODUCT_SDK_ATREE_FILES \
91    PRODUCT_SDK_ADDON_NAME \
92    PRODUCT_SDK_ADDON_COPY_FILES \
93    PRODUCT_SDK_ADDON_COPY_MODULES \
94    PRODUCT_SDK_ADDON_DOC_MODULES \
95    PRODUCT_SDK_ADDON_SYS_IMG_SOURCE_PROP \
96    PRODUCT_DEFAULT_WIFI_CHANNELS \
97    PRODUCT_DEFAULT_DEV_CERTIFICATE \
98    PRODUCT_RESTRICT_VENDOR_FILES \
99    PRODUCT_VENDOR_KERNEL_HEADERS \
100    PRODUCT_BOOT_JARS \
101    PRODUCT_SUPPORTS_BOOT_SIGNER \
102    PRODUCT_SUPPORTS_VBOOT \
103    PRODUCT_SUPPORTS_VERITY \
104    PRODUCT_SUPPORTS_VERITY_FEC \
105    PRODUCT_OEM_PROPERTIES \
106    PRODUCT_SYSTEM_PROPERTY_BLACKLIST \
107    PRODUCT_SYSTEM_SERVER_JARS \
108    PRODUCT_VBOOT_SIGNING_KEY \
109    PRODUCT_VERITY_SIGNING_KEY \
110    PRODUCT_SYSTEM_VERITY_PARTITION \
111    PRODUCT_VENDOR_VERITY_PARTITION \
112    PRODUCT_DEX_PREOPT_MODULE_CONFIGS \
113    PRODUCT_DEX_PREOPT_DEFAULT_FLAGS \
114    PRODUCT_DEX_PREOPT_BOOT_FLAGS \
115
116
117define dump-product
118$(info ==== $(1) ====)\
119$(foreach v,$(_product_var_list),\
120$(info PRODUCTS.$(1).$(v) := $(PRODUCTS.$(1).$(v))))\
121$(info --------)
122endef
123
124define dump-products
125$(foreach p,$(PRODUCTS),$(call dump-product,$(p)))
126endef
127
128#
129# $(1): product to inherit
130#
131# Does three things:
132#  1. Inherits all of the variables from $1.
133#  2. Records the inheritance in the .INHERITS_FROM variable
134#  3. Records that we've visited this node, in ALL_PRODUCTS
135#
136define inherit-product
137  $(if $(findstring ../,$(1)),\
138    $(eval np := $(call normalize-paths,$(1))),\
139    $(eval np := $(strip $(1))))\
140  $(foreach v,$(_product_var_list), \
141      $(eval $(v) := $($(v)) $(INHERIT_TAG)$(np))) \
142  $(eval inherit_var := \
143      PRODUCTS.$(strip $(word 1,$(_include_stack))).INHERITS_FROM) \
144  $(eval $(inherit_var) := $(sort $($(inherit_var)) $(np))) \
145  $(eval inherit_var:=) \
146  $(eval ALL_PRODUCTS := $(sort $(ALL_PRODUCTS) $(word 1,$(_include_stack))))
147endef
148
149
150#
151# Do inherit-product only if $(1) exists
152#
153define inherit-product-if-exists
154  $(if $(wildcard $(1)),$(call inherit-product,$(1)),)
155endef
156
157#
158# $(1): product makefile list
159#
160#TODO: check to make sure that products have all the necessary vars defined
161define import-products
162$(call import-nodes,PRODUCTS,$(1),$(_product_var_list))
163endef
164
165
166#
167# Does various consistency checks on all of the known products.
168# Takes no parameters, so $(call ) is not necessary.
169#
170define check-all-products
171$(if ,, \
172  $(eval _cap_names :=) \
173  $(foreach p,$(PRODUCTS), \
174    $(eval pn := $(strip $(PRODUCTS.$(p).PRODUCT_NAME))) \
175    $(if $(pn),,$(error $(p): PRODUCT_NAME must be defined.)) \
176    $(if $(filter $(pn),$(_cap_names)), \
177      $(error $(p): PRODUCT_NAME must be unique; "$(pn)" already used by $(strip \
178          $(foreach \
179            pp,$(PRODUCTS),
180              $(if $(filter $(pn),$(PRODUCTS.$(pp).PRODUCT_NAME)), \
181                $(pp) \
182               ))) \
183       ) \
184     ) \
185    $(eval _cap_names += $(pn)) \
186    $(if $(call is-c-identifier,$(pn)),, \
187      $(error $(p): PRODUCT_NAME must be a valid C identifier, not "$(pn)") \
188     ) \
189    $(eval pb := $(strip $(PRODUCTS.$(p).PRODUCT_BRAND))) \
190    $(if $(pb),,$(error $(p): PRODUCT_BRAND must be defined.)) \
191    $(foreach cf,$(strip $(PRODUCTS.$(p).PRODUCT_COPY_FILES)), \
192      $(if $(filter 2 3,$(words $(subst :,$(space),$(cf)))),, \
193        $(error $(p): malformed COPY_FILE "$(cf)") \
194       ) \
195     ) \
196   ) \
197)
198endef
199
200
201#
202# Returns the product makefile path for the product with the provided name
203#
204# $(1): short product name like "generic"
205#
206define _resolve-short-product-name
207  $(eval pn := $(strip $(1)))
208  $(eval p := \
209      $(foreach p,$(PRODUCTS), \
210          $(if $(filter $(pn),$(PRODUCTS.$(p).PRODUCT_NAME)), \
211            $(p) \
212       )) \
213   )
214  $(eval p := $(sort $(p)))
215  $(if $(filter 1,$(words $(p))), \
216    $(p), \
217    $(if $(filter 0,$(words $(p))), \
218      $(error No matches for product "$(pn)"), \
219      $(error Product "$(pn)" ambiguous: matches $(p)) \
220    ) \
221  )
222endef
223define resolve-short-product-name
224$(strip $(call _resolve-short-product-name,$(1)))
225endef
226
227
228_product_stash_var_list := $(_product_var_list) \
229	PRODUCT_BOOTCLASSPATH \
230	PRODUCT_SYSTEM_SERVER_CLASSPATH \
231	TARGET_ARCH \
232	TARGET_ARCH_VARIANT \
233	TARGET_CPU_VARIANT \
234	TARGET_BOARD_PLATFORM \
235	TARGET_BOARD_PLATFORM_GPU \
236	TARGET_BOARD_KERNEL_HEADERS \
237	TARGET_DEVICE_KERNEL_HEADERS \
238	TARGET_PRODUCT_KERNEL_HEADERS \
239	TARGET_BOOTLOADER_BOARD_NAME \
240	TARGET_NO_BOOTLOADER \
241	TARGET_NO_KERNEL \
242	TARGET_NO_RECOVERY \
243	TARGET_NO_RADIOIMAGE \
244	TARGET_HARDWARE_3D \
245	TARGET_CPU_ABI \
246	TARGET_CPU_ABI2 \
247
248
249_product_stash_var_list += \
250	BOARD_WPA_SUPPLICANT_DRIVER \
251	BOARD_WLAN_DEVICE \
252	BOARD_USES_GENERIC_AUDIO \
253	BOARD_KERNEL_CMDLINE \
254	BOARD_KERNEL_BASE \
255	BOARD_HAVE_BLUETOOTH \
256	BOARD_VENDOR_USE_AKMD \
257	BOARD_EGL_CFG \
258	BOARD_BOOTIMAGE_PARTITION_SIZE \
259	BOARD_RECOVERYIMAGE_PARTITION_SIZE \
260	BOARD_SYSTEMIMAGE_PARTITION_SIZE \
261	BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE \
262	BOARD_USERDATAIMAGE_FILE_SYSTEM_TYPE \
263	BOARD_USERDATAIMAGE_PARTITION_SIZE \
264	BOARD_CACHEIMAGE_FILE_SYSTEM_TYPE \
265	BOARD_CACHEIMAGE_PARTITION_SIZE \
266	BOARD_FLASH_BLOCK_SIZE \
267	BOARD_VENDORIMAGE_PARTITION_SIZE \
268	BOARD_VENDORIMAGE_FILE_SYSTEM_TYPE \
269	BOARD_INSTALLER_CMDLINE \
270
271
272_product_stash_var_list += \
273	DEFAULT_SYSTEM_DEV_CERTIFICATE \
274	WITH_DEXPREOPT \
275	WITH_DEXPREOPT_BOOT_IMG_ONLY
276
277_product_stash_var_list += \
278	GLOBAL_CFLAGS_NO_OVERRIDE \
279	GLOBAL_CPPFLAGS_NO_OVERRIDE \
280	GLOBAL_CLANG_CFLAGS_NO_OVERRIDE \
281
282#
283# Stash values of the variables in _product_stash_var_list.
284# $(1): Renamed prefix
285#
286define stash-product-vars
287$(foreach v,$(_product_stash_var_list), \
288        $(eval $(strip $(1))_$(call rot13,$(v)):=$$($$(v))) \
289 )
290endef
291
292#
293# Assert that the the variable stashed by stash-product-vars remains untouched.
294# $(1): The prefix as supplied to stash-product-vars
295#
296define assert-product-vars
297$(strip \
298  $(eval changed_variables:=)
299  $(foreach v,$(_product_stash_var_list), \
300    $(if $(call streq,$($(v)),$($(strip $(1))_$(call rot13,$(v)))),, \
301        $(eval $(warning $(v) has been modified: $($(v)))) \
302        $(eval $(warning previous value: $($(strip $(1))_$(call rot13,$(v))))) \
303        $(eval changed_variables := $(changed_variables) $(v))) \
304   ) \
305  $(if $(changed_variables),\
306    $(eval $(error The following variables have been changed: $(changed_variables))),)
307)
308endef
309
310define add-to-product-copy-files-if-exists
311$(if $(wildcard $(word 1,$(subst :, ,$(1)))),$(1))
312endef
313
314# whitespace placeholder when we record module's dex-preopt config.
315_PDPMC_SP_PLACE_HOLDER := |@SP@|
316# Set up dex-preopt config for a module.
317# $(1) list of module names
318# $(2) the modules' dex-preopt config
319define add-product-dex-preopt-module-config
320$(eval _c := $(subst $(space),$(_PDPMC_SP_PLACE_HOLDER),$(strip $(2))))\
321$(eval PRODUCT_DEX_PREOPT_MODULE_CONFIGS += \
322  $(foreach m,$(1),$(m)=$(_c)))
323endef
324