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#
18# Handle various build version information.
19#
20# Guarantees that the following are defined:
21#     PLATFORM_VERSION
22#     PLATFORM_SDK_VERSION
23#     PLATFORM_VERSION_CODENAME
24#     DEFAULT_APP_TARGET_SDK
25#     BUILD_ID
26#     BUILD_NUMBER
27#     PLATFORM_SECURITY_PATCH
28#     PLATFORM_VNDK_VERSION
29#     PLATFORM_SYSTEMSDK_VERSIONS
30#
31
32# Look for an optional file containing overrides of the defaults,
33# but don't cry if we don't find it.  We could just use -include, but
34# the build.prop target also wants INTERNAL_BUILD_ID_MAKEFILE to be set
35# if the file exists.
36#
37INTERNAL_BUILD_ID_MAKEFILE := $(wildcard $(BUILD_SYSTEM)/build_id.mk)
38ifdef INTERNAL_BUILD_ID_MAKEFILE
39  include $(INTERNAL_BUILD_ID_MAKEFILE)
40endif
41
42DEFAULT_PLATFORM_VERSION := RP1A
43MIN_PLATFORM_VERSION := RP1A
44MAX_PLATFORM_VERSION := RP1A
45
46ALLOWED_VERSIONS := $(call allowed-platform-versions,\
47  $(MIN_PLATFORM_VERSION),\
48  $(MAX_PLATFORM_VERSION),\
49  $(DEFAULT_PLATFORM_VERSION))
50
51ifndef TARGET_PLATFORM_VERSION
52  TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION)
53endif
54
55ifeq (,$(filter $(ALLOWED_VERSIONS), $(TARGET_PLATFORM_VERSION)))
56  $(warning Invalid TARGET_PLATFORM_VERSION '$(TARGET_PLATFORM_VERSION)', must be one of)
57  $(error $(ALLOWED_VERSIONS))
58endif
59ALLOWED_VERSIONS :=
60MIN_PLATFORM_VERSION :=
61MAX_PLATFORM_VERSION :=
62
63.KATI_READONLY := \
64  DEFAULT_PLATFORM_VERSION \
65  TARGET_PLATFORM_VERSION
66
67# Default versions for each TARGET_PLATFORM_VERSION
68# TODO: PLATFORM_VERSION, PLATFORM_SDK_VERSION, etc. should be conditional
69# on this
70
71# This is the canonical definition of the platform version,
72# which is the version that we reveal to the end user.
73# Update this value when the platform version changes (rather
74# than overriding it somewhere else).  Can be an arbitrary string.
75
76# When you change PLATFORM_VERSION for a given PLATFORM_SDK_VERSION
77# please add that PLATFORM_VERSION as well as clean up obsolete PLATFORM_VERSION's
78# in the following text file:
79# cts/tests/tests/os/assets/platform_versions.txt
80
81# Note that there should be one PLATFORM_VERSION and PLATFORM_VERSION_CODENAME
82# entry for each unreleased API level, regardless of
83# MIN_PLATFORM_VERSION/MAX_PLATFORM_VERSION. PLATFORM_VERSION is used to
84# generate the range of allowed SDK versions, so it must have an entry for every
85# unreleased API level targetable by this branch, not just those that are valid
86# lunch targets for this branch.
87
88# The last stable version name of the platform that was released.  During
89# development, this stays at that previous version, while the codename indicates
90# further work based on the previous version.
91PLATFORM_VERSION_LAST_STABLE := 11
92.KATI_READONLY := PLATFORM_VERSION_LAST_STABLE
93
94# These are the current development codenames, if the build is not a final
95# release build.  If this is a final release build, it is simply "REL".
96PLATFORM_VERSION_CODENAME.RP1A := REL
97
98ifndef PLATFORM_VERSION_CODENAME
99  PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
100  ifndef PLATFORM_VERSION_CODENAME
101    # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
102    PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
103  endif
104
105  # This is all of the *active* development codenames.
106  # This confusing name is needed because
107  # all_codenames has been baked into build.prop for ages.
108  #
109  # Should be either the same as PLATFORM_VERSION_CODENAME or a comma-separated
110  # list of additional codenames after PLATFORM_VERSION_CODENAME.
111  PLATFORM_VERSION_ALL_CODENAMES :=
112
113  # Build a list of all active code names. Avoid duplicates, and stop when we
114  # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
115  # that is not included in our build).
116  _versions_in_target := \
117    $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
118  $(foreach version,$(_versions_in_target),\
119    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
120    $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
121      $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
122
123  # And convert from space separated to comma separated.
124  PLATFORM_VERSION_ALL_CODENAMES := \
125    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES)))
126
127endif
128.KATI_READONLY := \
129  PLATFORM_VERSION_CODENAME \
130  PLATFORM_VERSION_ALL_CODENAMES
131
132ifndef PLATFORM_VERSION
133  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
134      PLATFORM_VERSION := $(PLATFORM_VERSION_LAST_STABLE)
135  else
136      PLATFORM_VERSION := $(PLATFORM_VERSION_CODENAME)
137  endif
138endif
139.KATI_READONLY := PLATFORM_VERSION
140
141ifndef PLATFORM_SDK_VERSION
142  # This is the canonical definition of the SDK version, which defines
143  # the set of APIs and functionality available in the platform.  It
144  # is a single integer that increases monotonically as updates to
145  # the SDK are released.  It should only be incremented when the APIs for
146  # the new release are frozen (so that developers don't write apps against
147  # intermediate builds).  During development, this number remains at the
148  # SDK version the branch is based on and PLATFORM_VERSION_CODENAME holds
149  # the code-name of the new development work.
150
151  # When you increment the PLATFORM_SDK_VERSION please ensure you also
152  # clear out the following text file of all older PLATFORM_VERSION's:
153  # cts/tests/tests/os/assets/platform_versions.txt
154  PLATFORM_SDK_VERSION := 30
155endif
156.KATI_READONLY := PLATFORM_SDK_VERSION
157
158ifeq (REL,$(PLATFORM_VERSION_CODENAME))
159  PLATFORM_PREVIEW_SDK_VERSION := 0
160else
161  ifndef PLATFORM_PREVIEW_SDK_VERSION
162    # This is the definition of a preview SDK version over and above the current
163    # platform SDK version. Unlike the platform SDK version, a higher value
164    # for preview SDK version does NOT mean that all prior preview APIs are
165    # included. Packages reading this value to determine compatibility with
166    # known APIs should check that this value is precisely equal to the preview
167    # SDK version the package was built for, otherwise it should fall back to
168    # assuming the device can only support APIs as of the previous official
169    # public release.
170    # This value will always be forced to 0 for release builds by the logic
171    # in the "ifeq" block above, so the value below will be used on any
172    # non-release builds, and it should always be at least 1, to indicate that
173    # APIs may have changed since the claimed PLATFORM_SDK_VERSION.
174    PLATFORM_PREVIEW_SDK_VERSION := 1
175  endif
176endif
177.KATI_READONLY := PLATFORM_PREVIEW_SDK_VERSION
178
179ifndef DEFAULT_APP_TARGET_SDK
180  # This is the default minSdkVersion and targetSdkVersion to use for
181  # all .apks created by the build system.  It can be overridden by explicitly
182  # setting these in the .apk's AndroidManifest.xml.  It is either the code
183  # name of the development build or, if this is a release build, the official
184  # SDK version of this release.
185  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
186    DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
187  else
188    DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
189  endif
190endif
191.KATI_READONLY := DEFAULT_APP_TARGET_SDK
192
193ifndef PLATFORM_VNDK_VERSION
194  # This is the definition of the VNDK version for the current VNDK libraries.
195  # The version is only available when PLATFORM_VERSION_CODENAME == REL.
196  # Otherwise, it will be set to a CODENAME version. The ABI is allowed to be
197  # changed only before the Android version is released. Once
198  # PLATFORM_VNDK_VERSION is set to actual version, the ABI for this version
199  # will be frozon and emit build errors if any ABI for the VNDK libs are
200  # changed.
201  # After that the snapshot of the VNDK with this version will be generated.
202  #
203  # The VNDK version follows PLATFORM_SDK_VERSION.
204  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
205    PLATFORM_VNDK_VERSION := $(PLATFORM_SDK_VERSION)
206  else
207    PLATFORM_VNDK_VERSION := $(PLATFORM_VERSION_CODENAME)
208  endif
209endif
210.KATI_READONLY := PLATFORM_VNDK_VERSION
211
212ifndef PLATFORM_SYSTEMSDK_MIN_VERSION
213  # This is the oldest version of system SDK that the platform supports. Contrary
214  # to the public SDK where platform essentially supports all previous SDK versions,
215  # platform supports only a few number of recent system SDK versions as some of
216  # old system APIs are gradually deprecated, removed and then deleted.
217  PLATFORM_SYSTEMSDK_MIN_VERSION := 28
218endif
219.KATI_READONLY := PLATFORM_SYSTEMSDK_MIN_VERSION
220
221# This is the list of system SDK versions that the current platform supports.
222PLATFORM_SYSTEMSDK_VERSIONS :=
223ifneq (,$(PLATFORM_SYSTEMSDK_MIN_VERSION))
224  $(if $(call math_is_number,$(PLATFORM_SYSTEMSDK_MIN_VERSION)),,\
225    $(error PLATFORM_SYSTEMSDK_MIN_VERSION must be a number, but was $(PLATFORM_SYSTEMSDK_MIN_VERSION)))
226  PLATFORM_SYSTEMSDK_VERSIONS := $(call int_range_list,$(PLATFORM_SYSTEMSDK_MIN_VERSION),$(PLATFORM_SDK_VERSION))
227endif
228# Platform always supports the current version
229ifeq (REL,$(PLATFORM_VERSION_CODENAME))
230  PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_SDK_VERSION)
231else
232  PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_VERSION_CODENAME)
233endif
234PLATFORM_SYSTEMSDK_VERSIONS := $(strip $(sort $(PLATFORM_SYSTEMSDK_VERSIONS)))
235.KATI_READONLY := PLATFORM_SYSTEMSDK_VERSIONS
236
237ifndef PLATFORM_SECURITY_PATCH
238    #  Used to indicate the security patch that has been applied to the device.
239    #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
240    #  It must be of the form "YYYY-MM-DD" on production devices.
241    #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
242    #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
243      PLATFORM_SECURITY_PATCH := 2020-09-05
244endif
245.KATI_READONLY := PLATFORM_SECURITY_PATCH
246
247ifndef PLATFORM_SECURITY_PATCH_TIMESTAMP
248  # Used to indicate the matching timestamp for the security patch string in PLATFORM_SECURITY_PATCH.
249  PLATFORM_SECURITY_PATCH_TIMESTAMP := $(shell date -d 'TZ="GMT" $(PLATFORM_SECURITY_PATCH)' +%s)
250endif
251.KATI_READONLY := PLATFORM_SECURITY_PATCH_TIMESTAMP
252
253ifndef PLATFORM_BASE_OS
254  # Used to indicate the base os applied to the device.
255  # Can be an arbitrary string, but must be a single word.
256  #
257  # If there is no $PLATFORM_BASE_OS set, keep it empty.
258  PLATFORM_BASE_OS :=
259endif
260.KATI_READONLY := PLATFORM_BASE_OS
261
262ifndef BUILD_ID
263  # Used to signify special builds.  E.g., branches and/or releases,
264  # like "M5-RC7".  Can be an arbitrary string, but must be a single
265  # word and a valid file name.
266  #
267  # If there is no BUILD_ID set, make it obvious.
268  BUILD_ID := UNKNOWN
269endif
270.KATI_READONLY := BUILD_ID
271
272ifndef BUILD_DATETIME
273  # Used to reproduce builds by setting the same time. Must be the number
274  # of seconds since the Epoch.
275  BUILD_DATETIME := $(shell date +%s)
276endif
277
278DATE := date -d @$(BUILD_DATETIME)
279.KATI_READONLY := DATE
280
281# Everything should be using BUILD_DATETIME_FROM_FILE instead.
282# BUILD_DATETIME and DATE can be removed once BUILD_NUMBER moves
283# to soong_ui.
284$(KATI_obsolete_var BUILD_DATETIME,Use BUILD_DATETIME_FROM_FILE)
285
286HAS_BUILD_NUMBER := true
287ifndef BUILD_NUMBER
288  # BUILD_NUMBER should be set to the source control value that
289  # represents the current state of the source code.  E.g., a
290  # perforce changelist number or a git hash.  Can be an arbitrary string
291  # (to allow for source control that uses something other than numbers),
292  # but must be a single word and a valid file name.
293  #
294  # If no BUILD_NUMBER is set, create a useful "I am an engineering build
295  # from this date/time" value.  Make it start with a non-digit so that
296  # anyone trying to parse it as an integer will probably get "0".
297  BUILD_NUMBER := eng.$(shell echo $${BUILD_USERNAME:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
298  HAS_BUILD_NUMBER := false
299endif
300.KATI_READONLY := BUILD_NUMBER HAS_BUILD_NUMBER
301
302ifndef PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION
303  # Used to set minimum supported target sdk version. Apps targeting sdk
304  # version lower than the set value will result in a warning being shown
305  # when any activity from the app is started.
306  PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION := 23
307endif
308.KATI_READONLY := PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION
309