blob: 00befa4be6c29e53fd9505b9b33653dfca085bda [file] [log] [blame]
The Android Open Source Project88b60792009-03-03 19:28:42 -08001#
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
Dianne Hackborn9bd54042009-05-15 18:01:20 -070023# PLATFORM_VERSION_CODENAME
24# DEFAULT_APP_TARGET_SDK
The Android Open Source Project88b60792009-03-03 19:28:42 -080025# BUILD_ID
26# BUILD_NUMBER
Adam Seaton8d4fac72016-07-29 11:52:35 -070027# PLATFORM_SECURITY_PATCH
Justin Yun2a233b32017-12-07 17:08:19 +090028# PLATFORM_VNDK_VERSION
Jiyong Park641b6cc2018-01-15 14:48:40 +090029# PLATFORM_SYSTEMSDK_VERSIONS
The Android Open Source Project88b60792009-03-03 19:28:42 -080030#
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)
Colin Cross63fe36a2017-02-21 17:23:02 -080038ifdef INTERNAL_BUILD_ID_MAKEFILE
The Android Open Source Project88b60792009-03-03 19:28:42 -080039 include $(INTERNAL_BUILD_ID_MAKEFILE)
40endif
41
Dan Willemsende005e82020-04-06 14:37:20 -070042DEFAULT_PLATFORM_VERSION := SP1A
43MIN_PLATFORM_VERSION := SP1A
44MAX_PLATFORM_VERSION := SP1A
Colin Cross88737132017-03-21 17:41:03 -070045
Colin Crossc9016592017-03-28 13:07:56 -070046ALLOWED_VERSIONS := $(call allowed-platform-versions,\
47 $(MIN_PLATFORM_VERSION),\
48 $(MAX_PLATFORM_VERSION),\
49 $(DEFAULT_PLATFORM_VERSION))
Colin Crossd8bc1902017-03-21 12:45:29 -070050
Colin Crossc9016592017-03-28 13:07:56 -070051ifndef TARGET_PLATFORM_VERSION
Colin Cross88737132017-03-21 17:41:03 -070052 TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION)
Colin Crossd3183bd2017-02-16 16:41:26 -080053endif
54
Colin Crossc9016592017-03-28 13:07:56 -070055ifeq (,$(filter $(ALLOWED_VERSIONS), $(TARGET_PLATFORM_VERSION)))
56 $(warning Invalid TARGET_PLATFORM_VERSION '$(TARGET_PLATFORM_VERSION)', must be one of)
57 $(error $(ALLOWED_VERSIONS))
Colin Crossd3183bd2017-02-16 16:41:26 -080058endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -070059ALLOWED_VERSIONS :=
60MIN_PLATFORM_VERSION :=
61MAX_PLATFORM_VERSION :=
62
63.KATI_READONLY := \
64 DEFAULT_PLATFORM_VERSION \
65 TARGET_PLATFORM_VERSION
Colin Crossd3183bd2017-02-16 16:41:26 -080066
Colin Crossca0afa32017-02-17 16:28:16 -080067# Default versions for each TARGET_PLATFORM_VERSION
Colin Crossc9016592017-03-28 13:07:56 -070068# TODO: PLATFORM_VERSION, PLATFORM_SDK_VERSION, etc. should be conditional
69# on this
Colin Crossca0afa32017-02-17 16:28:16 -080070
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
Colin Crossca0afa32017-02-17 16:28:16 -080076# When you change PLATFORM_VERSION for a given PLATFORM_SDK_VERSION
Ian Pedowitzf28bf722017-08-03 17:38:26 -070077# please add that PLATFORM_VERSION as well as clean up obsolete PLATFORM_VERSION's
78# in the following text file:
Colin Crossca0afa32017-02-17 16:28:16 -080079# cts/tests/tests/os/assets/platform_versions.txt
Dan Albertf6a5afa2018-03-06 14:35:06 -080080
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.
Dianne Hackborn25648e62019-10-22 15:58:17 -070087
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 := 10
92.KATI_READONLY := PLATFORM_VERSION_LAST_STABLE
Colin Crossca0afa32017-02-17 16:28:16 -080093
Ian Pedowitz0a06d8b2017-04-18 23:25:01 +000094# 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".
Bill Rassieura30a28f2019-04-10 09:53:02 -070096PLATFORM_VERSION_CODENAME.RP1A := R
Dan Willemsende005e82020-04-06 14:37:20 -070097PLATFORM_VERSION_CODENAME.SP1A := S
Colin Crossca0afa32017-02-17 16:28:16 -080098
Colin Cross63fe36a2017-02-21 17:23:02 -080099ifndef PLATFORM_VERSION_CODENAME
Colin Crossca0afa32017-02-17 16:28:16 -0800100 PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
101 ifndef PLATFORM_VERSION_CODENAME
102 # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
103 PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
104 endif
Dianne Hackborn6ee3c432014-04-24 16:19:14 -0700105
Dan Albertcd38b862017-07-28 12:34:08 -0700106 # This is all of the *active* development codenames. There are future
107 # codenames not included in this list. This confusing name is needed because
108 # all_codenames has been baked into build.prop for ages.
109 #
110 # Should be either the same as PLATFORM_VERSION_CODENAME or a comma-separated
111 # list of additional codenames after PLATFORM_VERSION_CODENAME.
Dan Albert839db812017-03-28 12:41:18 -0700112 PLATFORM_VERSION_ALL_CODENAMES :=
113
Dan Albertcd38b862017-07-28 12:34:08 -0700114 # Build a list of all active code names. Avoid duplicates, and stop when we
Dan Albert839db812017-03-28 12:41:18 -0700115 # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
Dan Albertcd38b862017-07-28 12:34:08 -0700116 # that is not included in our build).
Dan Albert839db812017-03-28 12:41:18 -0700117 _versions_in_target := \
118 $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
119 $(foreach version,$(_versions_in_target),\
120 $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
121 $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
122 $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
123
Dan Albertcd38b862017-07-28 12:34:08 -0700124 # This is all of the inactive development codenames. Available to be targeted
125 # in this branch but in the future relative to our current target.
126 PLATFORM_VERSION_FUTURE_CODENAMES :=
127
128 # Build a list of all untargeted code names. Avoid duplicates.
129 _versions_not_in_target := \
130 $(filter-out $(PLATFORM_VERSION_ALL_CODENAMES),$(ALL_VERSIONS))
131 $(foreach version,$(_versions_not_in_target),\
132 $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
133 $(if $(filter $(_codename),$(PLATFORM_VERSION_FUTURE_CODENAMES)),,\
134 $(eval PLATFORM_VERSION_FUTURE_CODENAMES += $(_codename))))
135
Dan Albert839db812017-03-28 12:41:18 -0700136 # And convert from space separated to comma separated.
137 PLATFORM_VERSION_ALL_CODENAMES := \
138 $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES)))
Dan Albertcd38b862017-07-28 12:34:08 -0700139 PLATFORM_VERSION_FUTURE_CODENAMES := \
140 $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_FUTURE_CODENAMES)))
Dan Albert839db812017-03-28 12:41:18 -0700141
Dianne Hackborn95378842009-05-08 12:06:17 -0700142endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700143.KATI_READONLY := \
144 PLATFORM_VERSION_CODENAME \
145 PLATFORM_VERSION_ALL_CODENAMES \
146 PLATFORM_VERSION_FUTURE_CODENAMES
Dianne Hackborn95378842009-05-08 12:06:17 -0700147
Dianne Hackborn25648e62019-10-22 15:58:17 -0700148ifndef PLATFORM_VERSION
149 ifeq (REL,$(PLATFORM_VERSION_CODENAME))
150 PLATFORM_VERSION := $(PLATFORM_VERSION_LAST_STABLE)
151 else
152 PLATFORM_VERSION := $(PLATFORM_VERSION_CODENAME)
153 endif
154endif
155.KATI_READONLY := PLATFORM_VERSION
156
157ifndef PLATFORM_SDK_VERSION
158 # This is the canonical definition of the SDK version, which defines
159 # the set of APIs and functionality available in the platform. It
160 # is a single integer that increases monotonically as updates to
161 # the SDK are released. It should only be incremented when the APIs for
162 # the new release are frozen (so that developers don't write apps against
163 # intermediate builds). During development, this number remains at the
164 # SDK version the branch is based on and PLATFORM_VERSION_CODENAME holds
165 # the code-name of the new development work.
166
167 # When you increment the PLATFORM_SDK_VERSION please ensure you also
168 # clear out the following text file of all older PLATFORM_VERSION's:
169 # cts/tests/tests/os/assets/platform_versions.txt
170 PLATFORM_SDK_VERSION := 29
171endif
172.KATI_READONLY := PLATFORM_SDK_VERSION
173
Colin Cross63fe36a2017-02-21 17:23:02 -0800174ifeq (REL,$(PLATFORM_VERSION_CODENAME))
Adam Powellbdd5e8e2015-05-21 13:49:05 -0700175 PLATFORM_PREVIEW_SDK_VERSION := 0
176else
Colin Cross63fe36a2017-02-21 17:23:02 -0800177 ifndef PLATFORM_PREVIEW_SDK_VERSION
Adam Powellbdd5e8e2015-05-21 13:49:05 -0700178 # This is the definition of a preview SDK version over and above the current
179 # platform SDK version. Unlike the platform SDK version, a higher value
180 # for preview SDK version does NOT mean that all prior preview APIs are
181 # included. Packages reading this value to determine compatibility with
182 # known APIs should check that this value is precisely equal to the preview
183 # SDK version the package was built for, otherwise it should fall back to
184 # assuming the device can only support APIs as of the previous official
185 # public release.
Jeff Sharkeyf7d482b2018-12-10 16:26:15 -0700186 # This value will always be forced to 0 for release builds by the logic
187 # in the "ifeq" block above, so the value below will be used on any
188 # non-release builds, and it should always be at least 1, to indicate that
189 # APIs may have changed since the claimed PLATFORM_SDK_VERSION.
190 PLATFORM_PREVIEW_SDK_VERSION := 1
Adam Powellbdd5e8e2015-05-21 13:49:05 -0700191 endif
192endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700193.KATI_READONLY := PLATFORM_PREVIEW_SDK_VERSION
Adam Powellbdd5e8e2015-05-21 13:49:05 -0700194
Colin Cross63fe36a2017-02-21 17:23:02 -0800195ifndef DEFAULT_APP_TARGET_SDK
Dianne Hackborn9bd54042009-05-15 18:01:20 -0700196 # This is the default minSdkVersion and targetSdkVersion to use for
197 # all .apks created by the build system. It can be overridden by explicitly
198 # setting these in the .apk's AndroidManifest.xml. It is either the code
199 # name of the development build or, if this is a release build, the official
200 # SDK version of this release.
Colin Cross63fe36a2017-02-21 17:23:02 -0800201 ifeq (REL,$(PLATFORM_VERSION_CODENAME))
Dianne Hackborn9bd54042009-05-15 18:01:20 -0700202 DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
203 else
204 DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
205 endif
206endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700207.KATI_READONLY := DEFAULT_APP_TARGET_SDK
Dianne Hackborn9bd54042009-05-15 18:01:20 -0700208
Justin Yun2a233b32017-12-07 17:08:19 +0900209ifndef PLATFORM_VNDK_VERSION
210 # This is the definition of the VNDK version for the current VNDK libraries.
211 # The version is only available when PLATFORM_VERSION_CODENAME == REL.
Justin Yun729856a2017-12-13 15:30:32 +0900212 # Otherwise, it will be set to a CODENAME version. The ABI is allowed to be
213 # changed only before the Android version is released. Once
214 # PLATFORM_VNDK_VERSION is set to actual version, the ABI for this version
215 # will be frozon and emit build errors if any ABI for the VNDK libs are
216 # changed.
Justin Yun2a233b32017-12-07 17:08:19 +0900217 # After that the snapshot of the VNDK with this version will be generated.
218 #
Justin Yun729856a2017-12-13 15:30:32 +0900219 # The VNDK version follows PLATFORM_SDK_VERSION.
Justin Yun2a233b32017-12-07 17:08:19 +0900220 ifeq (REL,$(PLATFORM_VERSION_CODENAME))
221 PLATFORM_VNDK_VERSION := $(PLATFORM_SDK_VERSION)
222 else
Justin Yun729856a2017-12-13 15:30:32 +0900223 PLATFORM_VNDK_VERSION := $(PLATFORM_VERSION_CODENAME)
Justin Yun2a233b32017-12-07 17:08:19 +0900224 endif
225endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700226.KATI_READONLY := PLATFORM_VNDK_VERSION
Justin Yun2a233b32017-12-07 17:08:19 +0900227
Jiyong Park641b6cc2018-01-15 14:48:40 +0900228ifndef PLATFORM_SYSTEMSDK_MIN_VERSION
229 # This is the oldest version of system SDK that the platform supports. Contrary
230 # to the public SDK where platform essentially supports all previous SDK versions,
231 # platform supports only a few number of recent system SDK versions as some of
232 # old system APIs are gradually deprecated, removed and then deleted.
Colin Cross88f39462018-04-26 11:30:58 -0700233 PLATFORM_SYSTEMSDK_MIN_VERSION := 28
Jiyong Park641b6cc2018-01-15 14:48:40 +0900234endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700235.KATI_READONLY := PLATFORM_SYSTEMSDK_MIN_VERSION
Jiyong Park641b6cc2018-01-15 14:48:40 +0900236
237# This is the list of system SDK versions that the current platform supports.
238PLATFORM_SYSTEMSDK_VERSIONS :=
239ifneq (,$(PLATFORM_SYSTEMSDK_MIN_VERSION))
240 $(if $(call math_is_number,$(PLATFORM_SYSTEMSDK_MIN_VERSION)),,\
241 $(error PLATFORM_SYSTEMSDK_MIN_VERSION must be a number, but was $(PLATFORM_SYSTEMSDK_MIN_VERSION)))
242 PLATFORM_SYSTEMSDK_VERSIONS := $(call int_range_list,$(PLATFORM_SYSTEMSDK_MIN_VERSION),$(PLATFORM_SDK_VERSION))
243endif
244# Platform always supports the current version
245ifeq (REL,$(PLATFORM_VERSION_CODENAME))
246 PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_SDK_VERSION)
247else
248 PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_VERSION_CODENAME)
249endif
250PLATFORM_SYSTEMSDK_VERSIONS := $(strip $(sort $(PLATFORM_SYSTEMSDK_VERSIONS)))
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700251.KATI_READONLY := PLATFORM_SYSTEMSDK_VERSIONS
Jiyong Park641b6cc2018-01-15 14:48:40 +0900252
Colin Cross63fe36a2017-02-21 17:23:02 -0800253ifndef PLATFORM_SECURITY_PATCH
Adam Seatonc63e4292016-08-25 19:46:06 -0700254 # Used to indicate the security patch that has been applied to the device.
255 # It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
256 # It must be of the form "YYYY-MM-DD" on production devices.
257 # It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
258 # If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
Paul Scovanner776c7292020-03-19 04:40:14 +0000259 PLATFORM_SECURITY_PATCH := 2020-05-05
Dianne Hackborne593e5c2015-08-12 16:11:20 -0700260endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700261.KATI_READONLY := PLATFORM_SECURITY_PATCH
Dianne Hackborne593e5c2015-08-12 16:11:20 -0700262
Tao Bao717d9d32018-05-29 11:18:02 -0700263ifndef PLATFORM_SECURITY_PATCH_TIMESTAMP
264 # Used to indicate the matching timestamp for the security patch string in PLATFORM_SECURITY_PATCH.
Elliott Hughes648017c2019-09-12 15:04:16 -0700265 PLATFORM_SECURITY_PATCH_TIMESTAMP := $(shell date -d 'TZ="GMT" $(PLATFORM_SECURITY_PATCH)' +%s)
Tao Bao717d9d32018-05-29 11:18:02 -0700266endif
267.KATI_READONLY := PLATFORM_SECURITY_PATCH_TIMESTAMP
268
Colin Cross63fe36a2017-02-21 17:23:02 -0800269ifndef PLATFORM_BASE_OS
Dianne Hackborne593e5c2015-08-12 16:11:20 -0700270 # Used to indicate the base os applied to the device.
271 # Can be an arbitrary string, but must be a single word.
272 #
273 # If there is no $PLATFORM_BASE_OS set, keep it empty.
274 PLATFORM_BASE_OS :=
275endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700276.KATI_READONLY := PLATFORM_BASE_OS
Dianne Hackborne593e5c2015-08-12 16:11:20 -0700277
Colin Cross63fe36a2017-02-21 17:23:02 -0800278ifndef BUILD_ID
The Android Open Source Project88b60792009-03-03 19:28:42 -0800279 # Used to signify special builds. E.g., branches and/or releases,
280 # like "M5-RC7". Can be an arbitrary string, but must be a single
281 # word and a valid file name.
282 #
283 # If there is no BUILD_ID set, make it obvious.
284 BUILD_ID := UNKNOWN
285endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700286.KATI_READONLY := BUILD_ID
The Android Open Source Project88b60792009-03-03 19:28:42 -0800287
Colin Crossce8c0512018-02-16 09:14:01 -0800288ifndef BUILD_DATETIME
289 # Used to reproduce builds by setting the same time. Must be the number
290 # of seconds since the Epoch.
291 BUILD_DATETIME := $(shell date +%s)
Dan Willemsenccc933e2015-08-11 15:25:12 -0700292endif
293
Colin Crossce8c0512018-02-16 09:14:01 -0800294DATE := date -d @$(BUILD_DATETIME)
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700295.KATI_READONLY := DATE
Colin Crossce8c0512018-02-16 09:14:01 -0800296
297# Everything should be using BUILD_DATETIME_FROM_FILE instead.
298# BUILD_DATETIME and DATE can be removed once BUILD_NUMBER moves
299# to soong_ui.
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700300$(KATI_obsolete_var BUILD_DATETIME,Use BUILD_DATETIME_FROM_FILE)
Colin Crossce8c0512018-02-16 09:14:01 -0800301
Nan Zhang0abdb582018-02-20 17:00:39 -0800302HAS_BUILD_NUMBER := true
Colin Cross63fe36a2017-02-21 17:23:02 -0800303ifndef BUILD_NUMBER
The Android Open Source Project88b60792009-03-03 19:28:42 -0800304 # BUILD_NUMBER should be set to the source control value that
305 # represents the current state of the source code. E.g., a
306 # perforce changelist number or a git hash. Can be an arbitrary string
307 # (to allow for source control that uses something other than numbers),
308 # but must be a single word and a valid file name.
309 #
310 # If no BUILD_NUMBER is set, create a useful "I am an engineering build
311 # from this date/time" value. Make it start with a non-digit so that
312 # anyone trying to parse it as an integer will probably get "0".
Dan Willemsen63e48db2019-01-02 12:27:43 -0800313 BUILD_NUMBER := eng.$(shell echo $${BUILD_USERNAME:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
Nan Zhang0abdb582018-02-20 17:00:39 -0800314 HAS_BUILD_NUMBER := false
The Android Open Source Project88b60792009-03-03 19:28:42 -0800315endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700316.KATI_READONLY := BUILD_NUMBER HAS_BUILD_NUMBER
Przemyslaw Szczepaniake5540152017-12-05 10:27:52 +0000317
318ifndef PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION
319 # Used to set minimum supported target sdk version. Apps targeting sdk
Narayan Kamathe7d93422018-08-24 15:02:58 +0100320 # version lower than the set value will result in a warning being shown
321 # when any activity from the app is started.
Narayan Kamathe4f41462018-08-24 15:07:50 +0100322 PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION := 23
Przemyslaw Szczepaniake5540152017-12-05 10:27:52 +0000323endif
Dan Willemsen693c7fb2018-04-11 10:40:38 -0700324.KATI_READONLY := PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION