2 # Copyright (C) 2008 The Android Open Source Project
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 # Users can define base-rules-hook in their buildspec.mk to perform
18 # arbitrary operations as each module is included.
20 $(if $(base-rules-hook),)
23 ###########################################################
24 ## Common instructions for a generic module.
25 ###########################################################
27 LOCAL_MODULE := $(strip $(LOCAL_MODULE))
28 ifeq ($(LOCAL_MODULE),)
29 $(error $(LOCAL_PATH): LOCAL_MODULE is not defined)
32 LOCAL_IS_HOST_MODULE := $(strip $(LOCAL_IS_HOST_MODULE))
33 ifdef 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)")
44 ###########################################################
45 ## Validate and define fallbacks for input LOCAL_* variables.
46 ###########################################################
48 ## Dump a .csv file of all modules and their tags
49 #ifneq ($(tag-list-first-time),false)
50 #$(shell rm -f tag-list.csv)
51 #tag-list-first-time := false
55 #space := $(empty) $(empty)
56 #$(shell echo $(lastword $(filter-out config/% out/%,$(MAKEFILE_LIST))),$(LOCAL_MODULE),$(strip $(LOCAL_MODULE_CLASS)),$(subst $(space),$(comma),$(sort $(LOCAL_MODULE_TAGS))) >> tag-list.csv)
58 LOCAL_MODULE_TAGS := $(sort $(LOCAL_MODULE_TAGS))
59 ifeq (,$(LOCAL_MODULE_TAGS))
60 # Modules without tags fall back to user (which is changed to user eng below)
61 LOCAL_MODULE_TAGS := user
62 #$(warning default tags: $(lastword $(filter-out config/% out/%,$(MAKEFILE_LIST))))
67 # If the local directory or one of its parents contains a MODULE_LICENSE_GPL
68 # file, tag the module as "gnu". Search for "*_GNU*" so that we can also
69 # find files like MODULE_LICENSE_GPL_AND_AFL but exclude files like
70 # MODULE_LICENSE_LGPL.
72 ifneq ($(call find-parent-file,$(LOCAL_PATH),MODULE_LICENSE*_GPL*),)
73 LOCAL_MODULE_TAGS += gnu
77 # If this module is listed on CUSTOM_MODULES, promote it to "user"
78 # so that it will be installed in $(TARGET_OUT).
80 ifneq (,$(filter $(LOCAL_MODULE),$(CUSTOM_MODULES)))
81 LOCAL_MODULE_TAGS := $(sort $(LOCAL_MODULE_TAGS) user)
84 # The definition of should-install-to-system will be different depending
85 # on which goal (e.g., sdk or just droid) is being built.
86 ifdef LOCAL_IS_HOST_MODULE
89 use_data := $(if $(call should-install-to-system,$(LOCAL_MODULE_TAGS)),,_DATA)
92 LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
93 ifneq ($(words $(LOCAL_MODULE_CLASS)),1)
94 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS must contain exactly one word, not "$(LOCAL_MODULE_CLASS)")
97 # Add a tag like "_class@APPS" to this module so that we can filter
99 LOCAL_MODULE_TAGS += _class@$(LOCAL_MODULE_CLASS)
101 LOCAL_MODULE_PATH := $(strip $(LOCAL_MODULE_PATH))
102 ifeq ($(LOCAL_MODULE_PATH),)
103 LOCAL_MODULE_PATH := $($(my_prefix)OUT$(use_data)_$(LOCAL_MODULE_CLASS))
104 ifeq ($(strip $(LOCAL_MODULE_PATH)),)
105 $(error $(LOCAL_PATH): unhandled LOCAL_MODULE_CLASS "$(LOCAL_MODULE_CLASS)")
109 ifneq ($(strip $(LOCAL_BUILT_MODULE)$(LOCAL_INSTALLED_MODULE)),)
110 $(error $(LOCAL_PATH): LOCAL_BUILT_MODULE and LOCAL_INSTALLED_MODULE must not be defined by component makefiles)
113 # Make sure that this IS_HOST/CLASS/MODULE combination is unique.
114 module_id := MODULE.$(if \
115 $(LOCAL_IS_HOST_MODULE),HOST,TARGET).$(LOCAL_MODULE_CLASS).$(LOCAL_MODULE)
117 $(error $(LOCAL_PATH): $(module_id) already defined by $($(module_id)))
119 $(module_id) := $(LOCAL_PATH)
121 intermediates := $(call local-intermediates-dir)
122 intermediates.COMMON := $(call local-intermediates-dir,COMMON)
124 ###########################################################
125 # Pick a name for the intermediate and final targets
126 ###########################################################
127 LOCAL_MODULE_STEM := $(strip $(LOCAL_MODULE_STEM))
128 ifeq ($(LOCAL_MODULE_STEM),)
129 LOCAL_MODULE_STEM := $(LOCAL_MODULE)
131 LOCAL_INSTALLED_MODULE_STEM := $(LOCAL_MODULE_STEM)$(LOCAL_MODULE_SUFFIX)
133 LOCAL_BUILT_MODULE_STEM := $(strip $(LOCAL_BUILT_MODULE_STEM))
134 ifeq ($(LOCAL_BUILT_MODULE_STEM),)
135 LOCAL_BUILT_MODULE_STEM := $(LOCAL_INSTALLED_MODULE_STEM)
138 # OVERRIDE_BUILT_MODULE_PATH is only allowed to be used by the
139 # internal SHARED_LIBRARIES build files.
140 OVERRIDE_BUILT_MODULE_PATH := $(strip $(OVERRIDE_BUILT_MODULE_PATH))
141 ifdef OVERRIDE_BUILT_MODULE_PATH
142 ifneq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
143 $(error $(LOCAL_PATH): Illegal use of OVERRIDE_BUILT_MODULE_PATH)
145 built_module_path := $(OVERRIDE_BUILT_MODULE_PATH)
147 built_module_path := $(intermediates)
149 LOCAL_BUILT_MODULE := $(built_module_path)/$(LOCAL_BUILT_MODULE_STEM)
152 # LOCAL_UNINSTALLABLE_MODULE is only allowed to be used by the
153 # internal STATIC_LIBRARIES build files.
154 LOCAL_UNINSTALLABLE_MODULE := $(strip $(LOCAL_UNINSTALLABLE_MODULE))
155 ifdef LOCAL_UNINSTALLABLE_MODULE
156 ifeq (,$(filter $(LOCAL_MODULE_CLASS),JAVA_LIBRARIES STATIC_LIBRARIES))
157 $(error $(LOCAL_PATH): Illegal use of LOCAL_UNINSTALLABLE_MODULE)
160 LOCAL_INSTALLED_MODULE := $(LOCAL_MODULE_PATH)/$(LOCAL_MODULE_SUBDIR)$(LOCAL_INSTALLED_MODULE_STEM)
163 # Assemble the list of targets to create PRIVATE_ variables for.
164 LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE)
167 ###########################################################
168 ## AIDL: Compile .aidl files to .java
169 ###########################################################
171 aidl_sources := $(filter %.aidl,$(LOCAL_SRC_FILES))
173 ifneq ($(strip $(aidl_sources)),)
175 aidl_java_sources := $(patsubst %.aidl,%.java,$(addprefix $(intermediates.COMMON)/src/, $(aidl_sources)))
176 aidl_sources := $(addprefix $(TOP_DIR)$(LOCAL_PATH)/, $(aidl_sources))
178 $(aidl_java_sources): PRIVATE_AIDL_FLAGS := -b -I$(LOCAL_PATH) -I$(LOCAL_PATH)/src $(addprefix -I,$(LOCAL_AIDL_INCLUDES))
180 $(aidl_java_sources): $(intermediates.COMMON)/src/%.java: $(TOPDIR)$(LOCAL_PATH)/%.aidl $(PRIVATE_ADDITIONAL_DEPENDENCIES) $(AIDL)
181 $(transform-aidl-to-java)
182 -include $(aidl_java_sources:%.java=%.P)
188 ###########################################################
189 ## logtags: Add .logtags files to global list, emit java source
190 ###########################################################
192 logtags_sources := $(filter %.logtags,$(LOCAL_SRC_FILES))
194 ifneq ($(strip $(logtags_sources)),)
196 event_log_tags := $(addprefix $(LOCAL_PATH)/,$(logtags_sources))
198 # Emit a java source file with constants for the tags, if
199 # LOCAL_MODULE_CLASS is "APPS" or "JAVA_LIBRARIES".
200 ifneq ($(strip $(filter $(LOCAL_MODULE_CLASS),APPS JAVA_LIBRARIES)),)
202 logtags_java_sources := $(patsubst %.logtags,%.java,$(addprefix $(intermediates.COMMON)/src/, $(logtags_sources)))
203 logtags_sources := $(addprefix $(TOP_DIR)$(LOCAL_PATH)/, $(logtags_sources))
205 $(logtags_java_sources): $(intermediates.COMMON)/src/%.java: $(TOPDIR)$(LOCAL_PATH)/%.logtags
206 $(transform-logtags-to-java)
211 logtags_java_sources :=
215 ###########################################################
216 ## Java: Compile .java files to .class
217 ###########################################################
218 #TODO: pull this into java.make once host and target are combined
220 java_sources := $(addprefix $(TOP_DIR)$(LOCAL_PATH)/, $(filter %.java,$(LOCAL_SRC_FILES))) $(aidl_java_sources) $(logtags_java_sources)
221 all_java_sources := $(java_sources) $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
223 ## Java resources #########################################
225 # Look for resource files in any specified directories.
226 # Non-java and non-doc files will be picked up as resources
227 # and included in the output jar file.
228 java_resource_file_groups :=
230 LOCAL_JAVA_RESOURCE_DIRS := $(strip $(LOCAL_JAVA_RESOURCE_DIRS))
231 ifneq ($(LOCAL_JAVA_RESOURCE_DIRS),)
232 # This makes a list of words like
233 # <dir1>::<file1>:<file2> <dir2>::<file1> <dir3>:
234 # where each of the files is relative to the directory it's grouped with.
235 # Directories that don't contain any resource files will result in groups
236 # that end with a colon, and they are stripped out in the next step.
237 java_resource_file_groups += \
238 $(foreach dir,$(LOCAL_JAVA_RESOURCE_DIRS), \
239 $(subst $(space),:,$(strip \
240 $(TOP_DIR)$(LOCAL_PATH)/$(dir): \
241 $(patsubst ./%,%,$(shell cd $(TOP_DIR)$(LOCAL_PATH)/$(dir) && \
243 -type d -a -name ".svn" -prune -o \
245 -a \! -name "*.java" \
246 -a \! -name "package.html" \
247 -a \! -name "overview.html" \
248 -a \! -name ".*.swp" \
249 -a \! -name ".DS_Store" \
255 java_resource_file_groups := $(filter-out %:,$(java_resource_file_groups))
256 endif # LOCAL_JAVA_RESOURCE_DIRS
258 LOCAL_JAVA_RESOURCE_FILES := $(strip $(LOCAL_JAVA_RESOURCE_FILES))
259 ifneq ($(LOCAL_JAVA_RESOURCE_FILES),)
260 java_resource_file_groups += \
261 $(foreach f,$(LOCAL_JAVA_RESOURCE_FILES), \
262 $(patsubst %/,%,$(dir $(f)))::$(notdir $(f)) \
264 endif # LOCAL_JAVA_RESOURCE_FILES
266 ifdef java_resource_file_groups
267 # The full paths to all resources, used for dependencies.
268 java_resource_sources := \
269 $(foreach group,$(java_resource_file_groups), \
270 $(addprefix $(word 1,$(subst :,$(space),$(group)))/, \
271 $(wordlist 2,9999,$(subst :,$(space),$(group))) \
274 # The arguments to jar that will include these files in a jar file.
276 $(foreach group,$(java_resource_file_groups), \
277 $(addprefix -C $(word 1,$(subst :,$(space),$(group))) , \
278 $(wordlist 2,9999,$(subst :,$(space),$(group))) \
281 java_resource_file_groups :=
283 java_resource_sources :=
285 endif # java_resource_file_groups
287 ## PRIVATE java vars ######################################
289 ifneq ($(strip $(all_java_sources)$(all_res_assets)),)
291 full_static_java_libs := \
292 $(foreach lib,$(LOCAL_STATIC_JAVA_LIBRARIES), \
293 $(call intermediates-dir-for, \
294 JAVA_LIBRARIES,$(lib),$(LOCAL_IS_HOST_MODULE))/javalib.jar)
296 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_INSTALL_DIR := $(dir $(LOCAL_INSTALLED_MODULE))
297 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_CLASS_INTERMEDIATES_DIR := $(intermediates)/classes
298 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates)/src
299 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_JAVA_SOURCES := $(all_java_sources)
300 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_JAVA_OBJECTS := $(patsubst %.java,%.class,$(LOCAL_SRC_FILES))
301 ifeq ($(my_prefix),TARGET_)
302 ifeq ($(LOCAL_SDK_VERSION),)
303 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_BOOTCLASSPATH := -bootclasspath $(call java-lib-files,core)
306 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_RESOURCE_DIR := $(LOCAL_RESOURCE_DIR)
307 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_EXTRA_JAR_ARGS := $(extra_jar_args)
308 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_ASSET_DIR := $(LOCAL_ASSET_DIR)
309 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_STATIC_JAVA_LIBRARIES := $(full_static_java_libs)
311 # full_java_libs: The list of files that should be used as the classpath.
312 # Using this list as a dependency list WILL NOT WORK.
313 # full_java_lib_deps: Should be specified as a prerequisite of this module
314 # to guarantee that the files in full_java_libs will
316 ifdef LOCAL_IS_HOST_MODULE
317 # TODO: make prebuilt java libraries use the same
318 # intermediates path pattern as target java libraries.
319 full_java_libs := $(addprefix $(HOST_OUT_JAVA_LIBRARIES)/,$(addsuffix $(COMMON_JAVA_PACKAGE_SUFFIX),$(LOCAL_JAVA_LIBRARIES)))
320 full_java_lib_deps := $(full_java_libs)
322 full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE))
323 full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE))
325 full_java_libs += $(full_static_java_libs) $(LOCAL_CLASSPATH)
326 full_java_lib_deps += $(full_static_java_libs) $(LOCAL_CLASSPATH)
328 # This is set by packages that contain instrumentation, allowing them to
329 # link against the package they are instrumenting. Currently only one such
330 # package is allowed.
331 LOCAL_INSTRUMENTATION_FOR := $(strip $(LOCAL_INSTRUMENTATION_FOR))
332 ifdef LOCAL_INSTRUMENTATION_FOR
333 ifneq ($(words $(LOCAL_INSTRUMENTATION_FOR)),1)
335 $(LOCAL_PATH): Multiple LOCAL_INSTRUMENTATION_FOR members defined)
338 link_instr_intermediates_dir := $(call intermediates-dir-for, \
339 APPS,$(LOCAL_INSTRUMENTATION_FOR))
340 link_instr_intermediates_dir.COMMON := $(call intermediates-dir-for, \
341 APPS,$(LOCAL_INSTRUMENTATION_FOR),,COMMON)
343 full_java_libs += $(link_instr_intermediates_dir.COMMON)/classes.jar
345 # We can't depend on the .jar file, so we depend on something that
346 # depends on the jar file; the final built package file.
347 full_java_lib_deps += $(link_instr_intermediates_dir)/package.apk
350 ifneq ($(strip $(LOCAL_JAR_MANIFEST)),)
351 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_JAR_MANIFEST := $(LOCAL_PATH)/$(LOCAL_JAR_MANIFEST)
353 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_JAR_MANIFEST :=
359 ###########################################################
360 ## make clean- targets
361 ###########################################################
362 cleantarget := clean-$(LOCAL_MODULE)
363 $(cleantarget) : PRIVATE_MODULE := $(LOCAL_MODULE)
364 $(cleantarget) : PRIVATE_CLEAN_FILES := \
365 $(PRIVATE_CLEAN_FILES) \
366 $(LOCAL_BUILT_MODULE) \
367 $(LOCAL_INSTALLED_MODULE) \
370 @echo "Clean: $(PRIVATE_MODULE)"
371 $(hide) rm -rf $(PRIVATE_CLEAN_FILES)
373 ###########################################################
374 ## Common definitions for module.
375 ###########################################################
377 # Propagate local configuration options to this target.
378 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PATH:=$(LOCAL_PATH)
379 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_POST_PROCESS_COMMAND:= $(LOCAL_POST_PROCESS_COMMAND)
380 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_AAPT_FLAGS:= $(LOCAL_AAPT_FLAGS)
381 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_JAVA_LIBRARIES:= $(LOCAL_JAVA_LIBRARIES)
383 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_ALL_JAVA_LIBRARIES:= $(full_java_libs)
384 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_IS_HOST_MODULE := $(LOCAL_IS_HOST_MODULE)
385 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_HOST:= $(my_host)
387 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_INTERMEDIATES_DIR:= $(intermediates)
389 # Tell the module and all of its sub-modules who it is.
390 $(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_MODULE:= $(LOCAL_MODULE)
392 # Provide a short-hand for building this module.
393 # We name both BUILT and INSTALLED in case
394 # LOCAL_UNINSTALLABLE_MODULE is set.
395 .PHONY: $(LOCAL_MODULE)
396 $(LOCAL_MODULE): $(LOCAL_BUILT_MODULE) $(LOCAL_INSTALLED_MODULE)
398 ###########################################################
399 ## Module installation rule
400 ###########################################################
402 # Some hosts do not have ACP; override the LOCAL version if that's the case.
403 ifneq ($(strip $(HOST_ACP_UNAVAILABLE)),)
404 LOCAL_ACP_UNAVAILABLE := $(strip $(HOST_ACP_UNAVAILABLE))
407 ifndef LOCAL_UNINSTALLABLE_MODULE
408 # Define a copy rule to install the module.
409 # acp and libraries that it uses can't use acp for
410 # installation; hence, LOCAL_ACP_UNAVAILABLE.
411 ifneq ($(LOCAL_ACP_UNAVAILABLE),true)
412 $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE) | $(ACP)
414 $(copy-file-to-target)
416 $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
418 $(copy-file-to-target-with-cp)
421 endif # !LOCAL_UNINSTALLABLE_MODULE
424 ###########################################################
426 ###########################################################
428 # If nobody has defined a more specific module for the
429 # checked modules, use LOCAL_BUILT_MODULE. This was old
430 # behavior, so it should be a safe default.
431 ifndef LOCAL_CHECKED_MODULE
432 LOCAL_CHECKED_MODULE := $(LOCAL_BUILT_MODULE)
435 # If they request that this module not be checked, then don't.
436 # PLEASE DON'T SET THIS. ANY PLACES THAT SET THIS WITHOUT
437 # GOOD REASON WILL HAVE IT REMOVED.
438 ifdef LOCAL_DONT_CHECK_MODULE
439 LOCAL_CHECKED_MODULE :=
442 ###########################################################
443 ## Register with ALL_MODULES
444 ###########################################################
446 ALL_MODULES += $(LOCAL_MODULE)
448 # Don't use += on subvars, or else they'll end up being
449 # recursively expanded.
450 ALL_MODULES.$(LOCAL_MODULE).PATH := \
451 $(ALL_MODULES.$(LOCAL_MODULE).PATH) $(LOCAL_PATH)
452 ALL_MODULES.$(LOCAL_MODULE).TAGS := \
453 $(ALL_MODULES.$(LOCAL_MODULE).TAGS) $(LOCAL_MODULE_TAGS)
454 ALL_MODULES.$(LOCAL_MODULE).CHECKED := \
455 $(ALL_MODULES.$(LOCAL_MODULE).CHECKED) $(LOCAL_CHECKED_MODULE)
456 ALL_MODULES.$(LOCAL_MODULE).BUILT := \
457 $(ALL_MODULES.$(LOCAL_MODULE).BUILT) $(LOCAL_BUILT_MODULE)
458 ALL_MODULES.$(LOCAL_MODULE).INSTALLED := \
459 $(ALL_MODULES.$(LOCAL_MODULE).INSTALLED) $(LOCAL_INSTALLED_MODULE)
460 ALL_MODULES.$(LOCAL_MODULE).REQUIRED := \
461 $(ALL_MODULES.$(LOCAL_MODULE).REQUIRED) $(LOCAL_REQUIRED_MODULES)
462 ALL_MODULES.$(LOCAL_MODULE).EVENT_LOG_TAGS := \
463 $(ALL_MODULES.$(LOCAL_MODULE).EVENT_LOG_TAGS) $(event_log_tags)
465 ###########################################################
466 ## Take care of LOCAL_MODULE_TAGS
467 ###########################################################
469 # Keep track of all the tags we've seen.
470 ALL_MODULE_TAGS := $(sort $(ALL_MODULE_TAGS) $(LOCAL_MODULE_TAGS))
472 # Add this module to the tag list of each specified tag.
473 # Don't use "+=". If the variable hasn't been set with ":=",
474 # it will default to recursive expansion.
475 $(foreach tag,$(LOCAL_MODULE_TAGS),\
476 $(eval ALL_MODULE_TAGS.$(tag) := \
477 $(ALL_MODULE_TAGS.$(tag)) \
478 $(LOCAL_INSTALLED_MODULE)))
480 # Add this module name to the tag list of each specified tag.
481 $(foreach tag,$(LOCAL_MODULE_TAGS),\
482 $(eval ALL_MODULE_NAME_TAGS.$(tag) += $(LOCAL_MODULE)))
484 ###########################################################
486 ###########################################################
488 include $(BUILD_SYSTEM)/notice_files.mk