base_rules.mk revision 0e7587a9ea58b69c9daa43cd682a4657d23b9b23 
1#
2# Copyright (C) 2008 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# Users can define base-rules-hook in their buildspec.mk to perform
18# arbitrary operations as each module is included.
19ifdef base-rules-hook
20$(if $(base-rules-hook),)
21endif
22
23###########################################################
24## Common instructions for a generic module.
25###########################################################
26
27LOCAL_MODULE := $(strip $(LOCAL_MODULE))
28ifeq ($(LOCAL_MODULE),)
29  $(error $(LOCAL_PATH): LOCAL_MODULE is not defined)
30endif
31
32LOCAL_IS_HOST_MODULE := $(strip $(LOCAL_IS_HOST_MODULE))
33ifdef LOCAL_IS_HOST_MODULE
34  ifneq ($(LOCAL_IS_HOST_MODULE),true)
35    $(error $(LOCAL_PATH): LOCAL_IS_HOST_MODULE must be "true" or empty, not "$(LOCAL_IS_HOST_MODULE)")
36  endif
37  ifeq ($(LOCAL_HOST_PREFIX),)
38    my_prefix := HOST_
39  else
40    my_prefix := $(LOCAL_HOST_PREFIX)
41  endif
42  my_host := host-
43else
44  my_prefix := TARGET_
45  my_host :=
46endif
47
48ifeq ($(my_prefix),HOST_CROSS_)
49  my_host_cross := true
50else
51  my_host_cross :=
52endif
53
54my_module_tags := $(LOCAL_MODULE_TAGS)
55ifeq ($(my_host_cross),true)
56  my_module_tags :=
57endif
58
59ifdef BUILDING_WITH_NINJA
60# Ninja has an implicit dependency on the command being run, and kati will
61# regenerate the ninja manifest if any read makefile changes, so there is no
62# need to have dependencies on makefiles.
63# This won't catch all the cases where LOCAL_ADDITIONAL_DEPENDENCIES contains
64# a .mk file, because a few users of LOCAL_ADDITIONAL_DEPENDENCIES don't include
65# base_rules.mk, but it will fix the most common ones.
66LOCAL_ADDITIONAL_DEPENDENCIES := $(filter-out %.mk,$(LOCAL_ADDITIONAL_DEPENDENCIES))
67endif
68
69###########################################################
70## Validate and define fallbacks for input LOCAL_* variables.
71###########################################################
72
73## Dump a .csv file of all modules and their tags
74#ifneq ($(tag-list-first-time),false)
75#$(shell rm -f tag-list.csv)
76#tag-list-first-time := false
77#endif
78#$(shell echo $(lastword $(filter-out config/% out/%,$(MAKEFILE_LIST))),$(LOCAL_MODULE),$(strip $(LOCAL_MODULE_CLASS)),$(subst $(space),$(comma),$(sort $(my_module_tags))) >> tag-list.csv)
79
80LOCAL_UNINSTALLABLE_MODULE := $(strip $(LOCAL_UNINSTALLABLE_MODULE))
81my_module_tags := $(sort $(my_module_tags))
82ifeq (,$(my_module_tags))
83  my_module_tags := optional
84endif
85
86# User tags are not allowed anymore.  Fail early because it will not be installed
87# like it used to be.
88ifneq ($(filter $(my_module_tags),user),)
89  $(warning *** Module name: $(LOCAL_MODULE))
90  $(warning *** Makefile location: $(LOCAL_MODULE_MAKEFILE))
91  $(warning * )
92  $(warning * Module is attempting to use the 'user' tag.  This)
93  $(warning * used to cause the module to be installed automatically.)
94  $(warning * Now, the module must be listed in the PRODUCT_PACKAGES)
95  $(warning * section of a product makefile to have it installed.)
96  $(warning * )
97  $(error user tag detected on module.)
98endif
99
100# Only the tags mentioned in this test are expected to be set by module
101# makefiles. Anything else is either a typo or a source of unexpected
102# behaviors.
103ifneq ($(filter-out debug eng tests optional samples,$(my_module_tags)),)
104$(warning unusual tags $(my_module_tags) on $(LOCAL_MODULE) at $(LOCAL_PATH))
105endif
106
107# Add implicit tags.
108#
109# If the local directory or one of its parents contains a MODULE_LICENSE_GPL
110# file, tag the module as "gnu".  Search for "*_GPL*", "*_LGPL*" and "*_MPL*"
111# so that we can also find files like MODULE_LICENSE_GPL_AND_AFL
112#
113license_files := $(call find-parent-file,$(LOCAL_PATH),MODULE_LICENSE*)
114gpl_license_file := $(call find-parent-file,$(LOCAL_PATH),MODULE_LICENSE*_GPL* MODULE_LICENSE*_MPL* MODULE_LICENSE*_LGPL*)
115ifneq ($(gpl_license_file),)
116  my_module_tags += gnu
117  ALL_GPL_MODULE_LICENSE_FILES := $(sort $(ALL_GPL_MODULE_LICENSE_FILES) $(gpl_license_file))
118endif
119
120LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
121ifneq ($(words $(LOCAL_MODULE_CLASS)),1)
122  $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS must contain exactly one word, not "$(LOCAL_MODULE_CLASS)")
123endif
124
125my_32_64_bit_suffix := $(if $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)IS_64_BIT),64,32)
126
127ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
128my_multilib_module_path := $(strip $(LOCAL_MODULE_PATH_$(my_32_64_bit_suffix)))
129ifdef my_multilib_module_path
130my_module_path := $(my_multilib_module_path)
131else
132my_module_path := $(strip $(LOCAL_MODULE_PATH))
133endif
134my_module_relative_path := $(strip $(LOCAL_MODULE_RELATIVE_PATH))
135ifeq ($(my_module_path),)
136  ifdef LOCAL_IS_HOST_MODULE
137    partition_tag :=
138  else
139  ifeq (true,$(LOCAL_PROPRIETARY_MODULE))
140    partition_tag := _VENDOR
141  else ifeq (true,$(LOCAL_OEM_MODULE))
142    partition_tag := _OEM
143  else ifeq (true,$(LOCAL_ODM_MODULE))
144    partition_tag := _ODM
145  else
146    # The definition of should-install-to-system will be different depending
147    # on which goal (e.g., sdk or just droid) is being built.
148    partition_tag := $(if $(call should-install-to-system,$(my_module_tags)),,_DATA)
149  endif
150  endif
151  install_path_var := $(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT$(partition_tag)_$(LOCAL_MODULE_CLASS)
152  ifeq (true,$(LOCAL_PRIVILEGED_MODULE))
153    install_path_var := $(install_path_var)_PRIVILEGED
154  endif
155
156  my_module_path := $($(install_path_var))
157  ifeq ($(strip $(my_module_path)),)
158    $(error $(LOCAL_PATH): unhandled install path "$(install_path_var) for $(LOCAL_MODULE)")
159  endif
160endif
161ifneq ($(my_module_relative_path),)
162  my_module_path := $(my_module_path)/$(my_module_relative_path)
163endif
164endif # not LOCAL_UNINSTALLABLE_MODULE
165
166ifneq ($(strip $(LOCAL_BUILT_MODULE)$(LOCAL_INSTALLED_MODULE)),)
167  $(error $(LOCAL_PATH): LOCAL_BUILT_MODULE and LOCAL_INSTALLED_MODULE must not be defined by component makefiles)
168endif
169
170my_register_name := $(LOCAL_MODULE)
171ifdef LOCAL_2ND_ARCH_VAR_PREFIX
172ifndef LOCAL_NO_2ND_ARCH_MODULE_SUFFIX
173my_register_name := $(LOCAL_MODULE)$($(my_prefix)2ND_ARCH_MODULE_SUFFIX)
174endif
175endif
176ifeq ($(my_host_cross),true)
177  my_register_name := host_cross_$(LOCAL_MODULE)
178endif
179# Make sure that this IS_HOST/CLASS/MODULE combination is unique.
180module_id := MODULE.$(if \
181    $(LOCAL_IS_HOST_MODULE),$($(my_prefix)OS),TARGET).$(LOCAL_MODULE_CLASS).$(my_register_name)
182ifdef $(module_id)
183$(error $(LOCAL_PATH): $(module_id) already defined by $($(module_id)))
184endif
185$(module_id) := $(LOCAL_PATH)
186
187intermediates := $(call local-intermediates-dir,,$(LOCAL_2ND_ARCH_VAR_PREFIX),$(my_host_cross))
188intermediates.COMMON := $(call local-intermediates-dir,COMMON)
189generated_sources_dir := $(call local-generated-sources-dir)
190
191###########################################################
192# Pick a name for the intermediate and final targets
193###########################################################
194include $(BUILD_SYSTEM)/configure_module_stem.mk
195
196# OVERRIDE_BUILT_MODULE_PATH is only allowed to be used by the
197# internal SHARED_LIBRARIES build files.
198OVERRIDE_BUILT_MODULE_PATH := $(strip $(OVERRIDE_BUILT_MODULE_PATH))
199ifdef OVERRIDE_BUILT_MODULE_PATH
200  ifneq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
201    $(error $(LOCAL_PATH): Illegal use of OVERRIDE_BUILT_MODULE_PATH)
202  endif
203  built_module_path := $(OVERRIDE_BUILT_MODULE_PATH)
204else
205  built_module_path := $(intermediates)
206endif
207LOCAL_BUILT_MODULE := $(built_module_path)/$(my_built_module_stem)
208
209ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
210  # Apk and its attachments reside in its own subdir.
211  ifeq ($(LOCAL_MODULE_CLASS),APPS)
212  # framework-res.apk doesn't like the additional layer.
213  ifneq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
214    my_module_path := $(my_module_path)/$(LOCAL_MODULE)
215  endif
216  endif
217  LOCAL_INSTALLED_MODULE := $(my_module_path)/$(my_installed_module_stem)
218endif
219
220# Assemble the list of targets to create PRIVATE_ variables for.
221LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE)
222
223###########################################################
224## Create .toc files from shared objects to reduce unnecessary rebuild
225# .toc files have the list of external dynamic symbols without their addresses.
226# For ninja build, .toc files will be updated only when the content of .toc
227# files are changed. As .KATI_RESTAT is specified to .toc files, dependent
228# binaries of a .toc file will be rebuilt only when the content of
229# the .toc file is changed.
230###########################################################
231ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
232LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE).toc
233$(LOCAL_BUILT_MODULE).toc: $(LOCAL_BUILT_MODULE)
234ifeq ($(BUILDING_WITH_NINJA),true)
235	$(call $(PRIVATE_2ND_ARCH_VAR_PREFIX)$(PRIVATE_PREFIX)transform-shared-lib-to-toc,$<,$@.tmp)
236	$(hide) if cmp -s $@.tmp $@ ; then \
237		  rm $@.tmp ; \
238		else \
239		  mv $@.tmp $@ ; \
240		fi
241else
242	@# make doesn't support restat. We always update .toc files so the dependents will always be updated too.
243	$(call $(PRIVATE_2ND_ARCH_VAR_PREFIX)$(PRIVATE_PREFIX)transform-shared-lib-to-toc,$<,$@)
244endif
245
246# Kati adds restat=1 to ninja. GNU make does nothing for this.
247.KATI_RESTAT: $(LOCAL_BUILT_MODULE).toc
248endif
249
250###########################################################
251## logtags: Add .logtags files to global list
252###########################################################
253
254logtags_sources := $(filter %.logtags,$(LOCAL_SRC_FILES))
255
256ifneq ($(strip $(logtags_sources)),)
257event_log_tags := $(addprefix $(LOCAL_PATH)/,$(logtags_sources))
258else
259event_log_tags :=
260endif
261
262###########################################################
263## make clean- targets
264###########################################################
265cleantarget := clean-$(my_register_name)
266$(cleantarget) : PRIVATE_MODULE := $(my_register_name)
267$(cleantarget) : PRIVATE_CLEAN_FILES := \
268    $(LOCAL_BUILT_MODULE) \
269    $(LOCAL_INSTALLED_MODULE) \
270    $(intermediates)
271$(cleantarget)::
272	@echo "Clean: $(PRIVATE_MODULE)"
273	$(hide) rm -rf $(PRIVATE_CLEAN_FILES)
274
275###########################################################
276## Common definitions for module.
277###########################################################
278$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PATH:=$(LOCAL_PATH)
279$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_IS_HOST_MODULE := $(LOCAL_IS_HOST_MODULE)
280$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_HOST:= $(my_host)
281$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PREFIX := $(my_prefix)
282
283$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_INTERMEDIATES_DIR:= $(intermediates)
284$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_2ND_ARCH_VAR_PREFIX := $(LOCAL_2ND_ARCH_VAR_PREFIX)
285
286# Tell the module and all of its sub-modules who it is.
287$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_MODULE:= $(my_register_name)
288
289# Provide a short-hand for building this module.
290# We name both BUILT and INSTALLED in case
291# LOCAL_UNINSTALLABLE_MODULE is set.
292.PHONY: $(my_register_name)
293$(my_register_name): $(LOCAL_BUILT_MODULE) $(LOCAL_INSTALLED_MODULE)
294
295# Set up phony targets that covers all modules under the given paths.
296# This allows us to build everything in given paths by running mmma/mma.
297my_path_components := $(subst /,$(space),$(LOCAL_PATH))
298my_path_prefix := MODULES-IN
299$(foreach c, $(my_path_components),\
300  $(eval my_path_prefix := $(my_path_prefix)-$(c))\
301  $(eval .PHONY : $(my_path_prefix))\
302  $(eval $(my_path_prefix) : $(my_register_name)))
303
304###########################################################
305## Module installation rule
306###########################################################
307
308# Some hosts do not have ACP; override the LOCAL version if that's the case.
309ifneq ($(strip $(HOST_ACP_UNAVAILABLE)),)
310  LOCAL_ACP_UNAVAILABLE := $(strip $(HOST_ACP_UNAVAILABLE))
311endif
312
313ifndef LOCAL_UNINSTALLABLE_MODULE
314  # Define a copy rule to install the module.
315  # acp and libraries that it uses can't use acp for
316  # installation;  hence, LOCAL_ACP_UNAVAILABLE.
317$(LOCAL_INSTALLED_MODULE): PRIVATE_POST_INSTALL_CMD := $(LOCAL_POST_INSTALL_CMD)
318ifneq ($(LOCAL_ACP_UNAVAILABLE),true)
319$(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE) | $(ACP)
320	@echo "Install: $@"
321	$(copy-file-to-new-target)
322	$(PRIVATE_POST_INSTALL_CMD)
323else
324$(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
325	@echo "Install: $@"
326	$(copy-file-to-target-with-cp)
327endif
328
329# Rule to install the module's companion init.rc.
330my_init_rc := $(LOCAL_INIT_RC_$(my_32_64_bit_suffix))
331my_init_rc_src :=
332my_init_rc_installed :=
333ifndef my_init_rc
334my_init_rc := $(LOCAL_INIT_RC)
335# Make sure we don't define the rule twice in multilib module.
336LOCAL_INIT_RC :=
337endif
338ifdef my_init_rc
339my_init_rc_src := $(LOCAL_PATH)/$(my_init_rc)
340my_init_rc_installed := $(TARGET_OUT$(partition_tag)_ETC)/init/$(notdir $(my_init_rc_src))
341$(my_init_rc_installed) : $(my_init_rc_src) | $(ACP)
342	@echo "Install: $@"
343	$(copy-file-to-new-target)
344
345$(my_register_name) : $(my_init_rc_installed)
346endif # my_init_rc
347endif # !LOCAL_UNINSTALLABLE_MODULE
348
349###########################################################
350## CHECK_BUILD goals
351###########################################################
352my_checked_module :=
353# If nobody has defined a more specific module for the
354# checked modules, use LOCAL_BUILT_MODULE.
355ifdef LOCAL_CHECKED_MODULE
356  my_checked_module := $(LOCAL_CHECKED_MODULE)
357else
358  my_checked_module := $(LOCAL_BUILT_MODULE)
359endif
360
361# If they request that this module not be checked, then don't.
362# PLEASE DON'T SET THIS.  ANY PLACES THAT SET THIS WITHOUT
363# GOOD REASON WILL HAVE IT REMOVED.
364ifdef LOCAL_DONT_CHECK_MODULE
365  my_checked_module :=
366endif
367# Don't check build target module defined for the 2nd arch
368ifndef LOCAL_IS_HOST_MODULE
369ifdef LOCAL_2ND_ARCH_VAR_PREFIX
370  my_checked_module :=
371endif
372endif
373
374###########################################################
375## Register with ALL_MODULES
376###########################################################
377
378ALL_MODULES += $(my_register_name)
379
380# Don't use += on subvars, or else they'll end up being
381# recursively expanded.
382ALL_MODULES.$(my_register_name).CLASS := \
383    $(ALL_MODULES.$(my_register_name).CLASS) $(LOCAL_MODULE_CLASS)
384ALL_MODULES.$(my_register_name).PATH := \
385    $(ALL_MODULES.$(my_register_name).PATH) $(LOCAL_PATH)
386ALL_MODULES.$(my_register_name).TAGS := \
387    $(ALL_MODULES.$(my_register_name).TAGS) $(my_module_tags)
388ALL_MODULES.$(my_register_name).CHECKED := \
389    $(ALL_MODULES.$(my_register_name).CHECKED) $(my_checked_module)
390ALL_MODULES.$(my_register_name).BUILT := \
391    $(ALL_MODULES.$(my_register_name).BUILT) $(LOCAL_BUILT_MODULE)
392ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
393ALL_MODULES.$(my_register_name).INSTALLED := \
394    $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
395    $(LOCAL_INSTALLED_MODULE) $(my_init_rc_installed))
396ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
397    $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
398    $(LOCAL_BUILT_MODULE):$(LOCAL_INSTALLED_MODULE) \
399    $(addprefix $(my_init_rc_src):,$(my_init_rc_installed)))
400endif
401ifdef LOCAL_PICKUP_FILES
402# Files or directories ready to pick up by the build system
403# when $(LOCAL_BUILT_MODULE) is done.
404ALL_MODULES.$(my_register_name).PICKUP_FILES := \
405    $(ALL_MODULES.$(my_register_name).PICKUP_FILES) $(LOCAL_PICKUP_FILES)
406endif
407my_required_modules := $(LOCAL_REQUIRED_MODULES) \
408    $(LOCAL_REQUIRED_MODULES_$(TARGET_$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH))
409ifdef LOCAL_IS_HOST_MODULE
410my_required_modules += $(LOCAL_REQUIRED_MODULES_$($(my_prefix)OS))
411endif
412ALL_MODULES.$(my_register_name).REQUIRED := \
413    $(strip $(ALL_MODULES.$(my_register_name).REQUIRED) $(my_required_modules))
414ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS := \
415    $(ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS) $(event_log_tags)
416ALL_MODULES.$(my_register_name).MAKEFILE := \
417    $(ALL_MODULES.$(my_register_name).MAKEFILE) $(LOCAL_MODULE_MAKEFILE)
418ifdef LOCAL_MODULE_OWNER
419ALL_MODULES.$(my_register_name).OWNER := \
420    $(sort $(ALL_MODULES.$(my_register_name).OWNER) $(LOCAL_MODULE_OWNER))
421endif
422ifdef LOCAL_2ND_ARCH_VAR_PREFIX
423ALL_MODULES.$(my_register_name).FOR_2ND_ARCH := true
424endif
425ALL_MODULES.$(my_register_name).FOR_HOST_CROSS := $(my_host_cross)
426
427INSTALLABLE_FILES.$(LOCAL_INSTALLED_MODULE).MODULE := $(my_register_name)
428
429##########################################################
430# Track module-level dependencies.
431# Use $(LOCAL_MODULE) instead of $(my_register_name) to ignore module's bitness.
432ALL_DEPS.MODULES := $(sort $(ALL_DEPS.MODULES) $(LOCAL_MODULE))
433ALL_DEPS.$(LOCAL_MODULE).ALL_DEPS := $(sort \
434  $(ALL_MODULES.$(LOCAL_MODULE).ALL_DEPS) \
435  $(LOCAL_STATIC_LIBRARIES) \
436  $(LOCAL_WHOLE_STATIC_LIBRARIES) \
437  $(LOCAL_SHARED_LIBRARIES) \
438  $(LOCAL_STATIC_JAVA_LIBRARIES) \
439  $(LOCAL_JAVA_LIBRARIES)\
440  $(LOCAL_JNI_SHARED_LIBRARIES))
441
442ALL_DEPS.$(LOCAL_MODULE).LICENSE := $(sort $(ALL_DEPS.$(LOCAL_MODULE).LICENSE) $(license_files))
443
444###########################################################
445## Take care of my_module_tags
446###########################################################
447
448# Keep track of all the tags we've seen.
449ALL_MODULE_TAGS := $(sort $(ALL_MODULE_TAGS) $(my_module_tags))
450
451# Add this module name to the tag list of each specified tag.
452$(foreach tag,$(my_module_tags),\
453    $(eval ALL_MODULE_NAME_TAGS.$(tag) += $(my_register_name)))
454
455###########################################################
456## umbrella targets used to verify builds
457###########################################################
458j_or_n :=
459ifneq (,$(filter EXECUTABLES SHARED_LIBRARIES STATIC_LIBRARIES,$(LOCAL_MODULE_CLASS)))
460j_or_n := native
461else
462ifneq (,$(filter JAVA_LIBRARIES APPS,$(LOCAL_MODULE_CLASS)))
463j_or_n := java
464endif
465endif
466ifdef LOCAL_IS_HOST_MODULE
467h_or_t := host
468else
469h_or_t := target
470endif
471
472ifdef j_or_n
473$(j_or_n) $(h_or_t) $(j_or_n)-$(h_or_t) : $(my_checked_module)
474ifneq (,$(filter $(my_module_tags),tests))
475$(j_or_n)-$(h_or_t)-tests $(j_or_n)-tests $(h_or_t)-tests : $(my_checked_module)
476endif
477endif
478
479###########################################################
480## NOTICE files
481###########################################################
482
483include $(BUILD_NOTICE_FILE)
484