1###########################################################
2## Track NOTICE files
3###########################################################
4$(call record-module-type,NOTICE_FILE)
5
6ifneq ($(LOCAL_NOTICE_FILE),)
7notice_file:=$(strip $(LOCAL_NOTICE_FILE))
8else
9notice_file:=$(strip $(wildcard $(LOCAL_PATH)/LICENSE $(LOCAL_PATH)/LICENCE $(LOCAL_PATH)/NOTICE))
10endif
11
12ifeq ($(LOCAL_MODULE_CLASS),GYP)
13  # We ignore NOTICE files for modules of type GYP.
14  notice_file :=
15endif
16
17ifeq ($(LOCAL_MODULE_CLASS),FAKE)
18  # We ignore NOTICE files for modules of type FAKE.
19  notice_file :=
20endif
21
22# Soong generates stub libraries that don't need NOTICE files
23ifdef LOCAL_NO_NOTICE_FILE
24  ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
25    $(call pretty-error,LOCAL_NO_NOTICE_FILE should not be used by Android.mk files)
26  endif
27  notice_file :=
28endif
29
30ifeq ($(LOCAL_MODULE_CLASS),NOTICE_FILES)
31# If this is a NOTICE-only module, we don't include base_rule.mk,
32# so my_prefix is not set at this point.
33ifeq ($(LOCAL_IS_HOST_MODULE),true)
34  my_prefix := HOST_
35  LOCAL_HOST_PREFIX :=
36else
37  my_prefix := TARGET_
38endif
39endif
40
41installed_notice_file :=
42
43ifdef notice_file
44
45ifdef my_register_name
46ALL_MODULES.$(my_register_name).NOTICES := $(ALL_MODULES.$(my_register_name).NOTICES) $(notice_file)
47endif
48
49# This relies on the name of the directory in PRODUCT_OUT matching where
50# it's installed on the target - i.e. system, data, etc.  This does
51# not work for root and isn't exact, but it's probably good enough for
52# compliance.
53# Includes the leading slash
54ifdef LOCAL_INSTALLED_MODULE
55  module_installed_filename := $(patsubst $(PRODUCT_OUT)/%,%,$(LOCAL_INSTALLED_MODULE))
56else
57  # This module isn't installable
58  ifneq ($(filter  STATIC_LIBRARIES RLIB_LIBRARIES PROC_MACRO_LIBRARIES HEADER_LIBRARIES,$(LOCAL_MODULE_CLASS)),)
59    # Stick the static libraries with the dynamic libraries.
60    # We can't use xxx_OUT_STATIC_LIBRARIES because it points into
61    # device-obj or host-obj.
62    module_installed_filename := \
63        $(patsubst $(PRODUCT_OUT)/%,%,$($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT_SHARED_LIBRARIES))/$(notdir $(LOCAL_BUILT_MODULE))
64  else ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
65    # Shared modules may be uninstallable(e.g. TARGET_SKIP_CURRENT_VNDK=true)
66    module_installed_filename :=
67  else
68    ifeq ($(LOCAL_MODULE_CLASS),JAVA_LIBRARIES)
69      # Stick the static java libraries with the regular java libraries.
70      module_leaf := $(notdir $(LOCAL_BUILT_MODULE))
71      # javalib.jar is the default name for the build module (and isn't meaningful)
72      # If that's what we have, substitute the module name instead.  These files
73      # aren't included on the device, so this name is synthetic anyway.
74      # Extra path "static" is added to try to avoid name conflict between the notice file of
75      # this 'uninstallable' Java module and the notice file for another 'installable' Java module
76      # whose stem is the same as this module's name.
77      ifneq ($(filter javalib.jar,$(module_leaf)),)
78        module_leaf := static/$(LOCAL_MODULE).jar
79      endif
80      module_installed_filename := \
81          $(patsubst $(PRODUCT_OUT)/%,%,$($(my_prefix)OUT_JAVA_LIBRARIES))/$(module_leaf)
82    else ifeq ($(LOCAL_MODULE_CLASS),ETC)
83      # ETC modules may be uninstallable, yet still have a NOTICE file. e.g. apex components
84      module_installed_filename :=
85    else ifneq (,$(and $(filter %.sdk,$(LOCAL_MODULE)),$(filter $(patsubst %.sdk,%,$(LOCAL_MODULE)),$(SOONG_SDK_VARIANT_MODULES))))
86      # Soong produces uninstallable *.sdk shared libraries for embedding in APKs.
87      module_installed_filename := \
88          $(patsubst $(PRODUCT_OUT)/%,%,$($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT_SHARED_LIBRARIES))/$(notdir $(LOCAL_BUILT_MODULE))
89    else
90      $(error Cannot determine where to install NOTICE file for $(LOCAL_MODULE))
91    endif # JAVA_LIBRARIES
92  endif # STATIC_LIBRARIES
93endif
94
95ifdef module_installed_filename
96
97# In case it's actually a host file
98module_installed_filename := $(patsubst $(HOST_OUT)/%,%,$(module_installed_filename))
99module_installed_filename := $(patsubst $(HOST_CROSS_OUT)/%,%,$(module_installed_filename))
100
101installed_notice_file := $($(my_prefix)OUT_NOTICE_FILES)/src/$(module_installed_filename).txt
102
103$(installed_notice_file): PRIVATE_INSTALLED_MODULE := $(module_installed_filename)
104
105$(installed_notice_file): $(notice_file)
106	@echo Notice file: $< -- $@
107	$(hide) mkdir -p $(dir $@)
108	$(hide) awk 'FNR==1 && NR > 1 {print "\n"} {print}' $^ > $@
109
110ifdef LOCAL_INSTALLED_MODULE
111# Make LOCAL_INSTALLED_MODULE depend on NOTICE files if they exist
112# libraries so they get installed along with it.  Make it an order-only
113# dependency so we don't re-install a module when the NOTICE changes.
114$(LOCAL_INSTALLED_MODULE): | $(installed_notice_file)
115endif
116
117# To facilitate collecting NOTICE files for apps_only build,
118# we install the NOTICE file even if a module gets built but not installed,
119# because shared jni libraries won't be installed to the system image.
120ifdef TARGET_BUILD_APPS
121# for static Java libraries, we don't need to even build LOCAL_BUILT_MODULE,
122# but just javalib.jar in the common intermediate dir.
123ifeq ($(LOCAL_MODULE_CLASS),JAVA_LIBRARIES)
124$(intermediates.COMMON)/javalib.jar : | $(installed_notice_file)
125else
126$(LOCAL_BUILT_MODULE): | $(installed_notice_file)
127endif  # JAVA_LIBRARIES
128endif  # TARGET_BUILD_APPS
129
130endif  # module_installed_filename
131endif  # notice_file
132
133# Create a predictable, phony target to build this notice file.
134# Define it even if the notice file doesn't exist so that other
135# modules can depend on it.
136notice_target := NOTICE-$(if \
137    $(LOCAL_IS_HOST_MODULE),HOST$(if $(my_host_cross),_CROSS,),TARGET)-$(LOCAL_MODULE_CLASS)-$(LOCAL_MODULE)
138.PHONY: $(notice_target)
139$(notice_target): $(installed_notice_file)
140