version_defaults.mk revision 08a11a771c7a4a2f8c04a382f2192da243023bd8
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#     BUILD_DATETIME
28#     PLATFORM_SECURITY_PATCH
29#     PLATFORM_VNDK_VERSION
30#     PLATFORM_SYSTEMSDK_VERSIONS
31#
32
33# Look for an optional file containing overrides of the defaults,
34# but don't cry if we don't find it.  We could just use -include, but
35# the build.prop target also wants INTERNAL_BUILD_ID_MAKEFILE to be set
36# if the file exists.
37#
38INTERNAL_BUILD_ID_MAKEFILE := $(wildcard $(BUILD_SYSTEM)/build_id.mk)
39ifdef INTERNAL_BUILD_ID_MAKEFILE
40  include $(INTERNAL_BUILD_ID_MAKEFILE)
41endif
42
43DEFAULT_PLATFORM_VERSION := PPR1
44MIN_PLATFORM_VERSION := PPR1
45MAX_PLATFORM_VERSION := PPR1
46
47ALLOWED_VERSIONS := $(call allowed-platform-versions,\
48  $(MIN_PLATFORM_VERSION),\
49  $(MAX_PLATFORM_VERSION),\
50  $(DEFAULT_PLATFORM_VERSION))
51
52ifndef TARGET_PLATFORM_VERSION
53  TARGET_PLATFORM_VERSION := $(DEFAULT_PLATFORM_VERSION)
54endif
55
56ifeq (,$(filter $(ALLOWED_VERSIONS), $(TARGET_PLATFORM_VERSION)))
57  $(warning Invalid TARGET_PLATFORM_VERSION '$(TARGET_PLATFORM_VERSION)', must be one of)
58  $(error $(ALLOWED_VERSIONS))
59endif
60
61# Default versions for each TARGET_PLATFORM_VERSION
62# TODO: PLATFORM_VERSION, PLATFORM_SDK_VERSION, etc. should be conditional
63# on this
64
65# This is the canonical definition of the platform version,
66# which is the version that we reveal to the end user.
67# Update this value when the platform version changes (rather
68# than overriding it somewhere else).  Can be an arbitrary string.
69
70# When you add a new PLATFORM_VERSION which will result in a new
71# PLATFORM_SDK_VERSION please ensure you add a corresponding isAtLeast*
72# method in the following java file:
73# frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java
74
75# When you change PLATFORM_VERSION for a given PLATFORM_SDK_VERSION
76# please add that PLATFORM_VERSION as well as clean up obsolete PLATFORM_VERSION's
77# in the following text file:
78# cts/tests/tests/os/assets/platform_versions.txt
79PLATFORM_VERSION.PPR1 := P
80
81# These are the current development codenames, if the build is not a final
82# release build.  If this is a final release build, it is simply "REL".
83PLATFORM_VERSION_CODENAME.PPR1 := P
84
85ifndef PLATFORM_VERSION
86  PLATFORM_VERSION := $(PLATFORM_VERSION.$(TARGET_PLATFORM_VERSION))
87  ifndef PLATFORM_VERSION
88    # PLATFORM_VERSION falls back to TARGET_PLATFORM_VERSION
89    PLATFORM_VERSION := $(TARGET_PLATFORM_VERSION)
90  endif
91endif
92
93ifndef PLATFORM_SDK_VERSION
94  # This is the canonical definition of the SDK version, which defines
95  # the set of APIs and functionality available in the platform.  It
96  # is a single integer that increases monotonically as updates to
97  # the SDK are released.  It should only be incremented when the APIs for
98  # the new release are frozen (so that developers don't write apps against
99  # intermediate builds).  During development, this number remains at the
100  # SDK version the branch is based on and PLATFORM_VERSION_CODENAME holds
101  # the code-name of the new development work.
102
103  # When you change PLATFORM_SDK_VERSION please ensure you also update the
104  # corresponding methods for isAtLeast* in the following java file:
105  # frameworks/support/compat/gingerbread/android/support/v4/os/BuildCompat.java
106
107  # When you increment the PLATFORM_SDK_VERSION please ensure you also
108  # clear out the following text file of all older PLATFORM_VERSION's:
109  # cts/tests/tests/os/assets/platform_versions.txt
110  PLATFORM_SDK_VERSION := 27
111endif
112
113ifndef PLATFORM_VERSION_CODENAME
114  PLATFORM_VERSION_CODENAME := $(PLATFORM_VERSION_CODENAME.$(TARGET_PLATFORM_VERSION))
115  ifndef PLATFORM_VERSION_CODENAME
116    # PLATFORM_VERSION_CODENAME falls back to TARGET_PLATFORM_VERSION
117    PLATFORM_VERSION_CODENAME := $(TARGET_PLATFORM_VERSION)
118  endif
119
120  # This is all of the *active* development codenames. There are future
121  # codenames not included in this list. This confusing name is needed because
122  # all_codenames has been baked into build.prop for ages.
123  #
124  # Should be either the same as PLATFORM_VERSION_CODENAME or a comma-separated
125  # list of additional codenames after PLATFORM_VERSION_CODENAME.
126  PLATFORM_VERSION_ALL_CODENAMES :=
127
128  # Build a list of all active code names. Avoid duplicates, and stop when we
129  # reach a codename that matches PLATFORM_VERSION_CODENAME (anything beyond
130  # that is not included in our build).
131  _versions_in_target := \
132    $(call find_and_earlier,$(ALL_VERSIONS),$(TARGET_PLATFORM_VERSION))
133  $(foreach version,$(_versions_in_target),\
134    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
135    $(if $(filter $(_codename),$(PLATFORM_VERSION_ALL_CODENAMES)),,\
136      $(eval PLATFORM_VERSION_ALL_CODENAMES += $(_codename))))
137
138  # This is all of the inactive development codenames. Available to be targeted
139  # in this branch but in the future relative to our current target.
140  PLATFORM_VERSION_FUTURE_CODENAMES :=
141
142  # Build a list of all untargeted code names. Avoid duplicates.
143  _versions_not_in_target := \
144    $(filter-out $(PLATFORM_VERSION_ALL_CODENAMES),$(ALL_VERSIONS))
145  $(foreach version,$(_versions_not_in_target),\
146    $(eval _codename := $(PLATFORM_VERSION_CODENAME.$(version)))\
147    $(if $(filter $(_codename),$(PLATFORM_VERSION_FUTURE_CODENAMES)),,\
148      $(eval PLATFORM_VERSION_FUTURE_CODENAMES += $(_codename))))
149
150  # And convert from space separated to comma separated.
151  PLATFORM_VERSION_ALL_CODENAMES := \
152    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_ALL_CODENAMES)))
153  PLATFORM_VERSION_FUTURE_CODENAMES := \
154    $(subst $(space),$(comma),$(strip $(PLATFORM_VERSION_FUTURE_CODENAMES)))
155
156endif
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 0 for release builds.
171    PLATFORM_PREVIEW_SDK_VERSION := 1
172  endif
173endif
174
175ifndef DEFAULT_APP_TARGET_SDK
176  # This is the default minSdkVersion and targetSdkVersion to use for
177  # all .apks created by the build system.  It can be overridden by explicitly
178  # setting these in the .apk's AndroidManifest.xml.  It is either the code
179  # name of the development build or, if this is a release build, the official
180  # SDK version of this release.
181  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
182    DEFAULT_APP_TARGET_SDK := $(PLATFORM_SDK_VERSION)
183  else
184    DEFAULT_APP_TARGET_SDK := $(PLATFORM_VERSION_CODENAME)
185  endif
186endif
187
188ifndef PLATFORM_VNDK_VERSION
189  # This is the definition of the VNDK version for the current VNDK libraries.
190  # The version is only available when PLATFORM_VERSION_CODENAME == REL.
191  # Otherwise, it will be set to a CODENAME version. The ABI is allowed to be
192  # changed only before the Android version is released. Once
193  # PLATFORM_VNDK_VERSION is set to actual version, the ABI for this version
194  # will be frozon and emit build errors if any ABI for the VNDK libs are
195  # changed.
196  # After that the snapshot of the VNDK with this version will be generated.
197  #
198  # The VNDK version follows PLATFORM_SDK_VERSION.
199  ifeq (REL,$(PLATFORM_VERSION_CODENAME))
200    PLATFORM_VNDK_VERSION := $(PLATFORM_SDK_VERSION)
201  else
202    PLATFORM_VNDK_VERSION := $(PLATFORM_VERSION_CODENAME)
203  endif
204endif
205
206ifndef PLATFORM_SYSTEMSDK_MIN_VERSION
207  # This is the oldest version of system SDK that the platform supports. Contrary
208  # to the public SDK where platform essentially supports all previous SDK versions,
209  # platform supports only a few number of recent system SDK versions as some of
210  # old system APIs are gradually deprecated, removed and then deleted.
211  # However, currently in P, we only support the single latest version since there
212  # is no old system SDK versions. Therefore, this is set to empty for now. This
213  # should later (in post P) be set to a number, like 28.
214  PLATFORM_SYSTEMSDK_MIN_VERSION :=
215endif
216
217# This is the list of system SDK versions that the current platform supports.
218PLATFORM_SYSTEMSDK_VERSIONS :=
219ifneq (,$(PLATFORM_SYSTEMSDK_MIN_VERSION))
220  $(if $(call math_is_number,$(PLATFORM_SYSTEMSDK_MIN_VERSION)),,\
221    $(error PLATFORM_SYSTEMSDK_MIN_VERSION must be a number, but was $(PLATFORM_SYSTEMSDK_MIN_VERSION)))
222  PLATFORM_SYSTEMSDK_VERSIONS := $(call int_range_list,$(PLATFORM_SYSTEMSDK_MIN_VERSION),$(PLATFORM_SDK_VERSION))
223endif
224# Platform always supports the current version
225ifeq (REL,$(PLATFORM_VERSION_CODENAME))
226  PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_SDK_VERSION)
227else
228  PLATFORM_SYSTEMSDK_VERSIONS += $(PLATFORM_VERSION_CODENAME)
229endif
230PLATFORM_SYSTEMSDK_VERSIONS := $(strip $(sort $(PLATFORM_SYSTEMSDK_VERSIONS)))
231
232ifndef PLATFORM_SECURITY_PATCH
233    #  Used to indicate the security patch that has been applied to the device.
234    #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
235    #  It must be of the form "YYYY-MM-DD" on production devices.
236    #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
237    #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
238      PLATFORM_SECURITY_PATCH := 2018-02-05
239endif
240
241ifndef PLATFORM_BASE_OS
242  # Used to indicate the base os applied to the device.
243  # Can be an arbitrary string, but must be a single word.
244  #
245  # If there is no $PLATFORM_BASE_OS set, keep it empty.
246  PLATFORM_BASE_OS :=
247endif
248
249ifndef BUILD_ID
250  # Used to signify special builds.  E.g., branches and/or releases,
251  # like "M5-RC7".  Can be an arbitrary string, but must be a single
252  # word and a valid file name.
253  #
254  # If there is no BUILD_ID set, make it obvious.
255  BUILD_ID := UNKNOWN
256endif
257
258ifndef BUILD_DATETIME
259  # Used to reproduce builds by setting the same time. Must be the number
260  # of seconds since the Epoch.
261  BUILD_DATETIME := $(shell date +%s)
262endif
263
264ifneq (,$(findstring Darwin,$(UNAME)))
265DATE := date -r $(BUILD_DATETIME)
266else
267DATE := date -d @$(BUILD_DATETIME)
268endif
269
270ifndef BUILD_NUMBER
271  # BUILD_NUMBER should be set to the source control value that
272  # represents the current state of the source code.  E.g., a
273  # perforce changelist number or a git hash.  Can be an arbitrary string
274  # (to allow for source control that uses something other than numbers),
275  # but must be a single word and a valid file name.
276  #
277  # If no BUILD_NUMBER is set, create a useful "I am an engineering build
278  # from this date/time" value.  Make it start with a non-digit so that
279  # anyone trying to parse it as an integer will probably get "0".
280  BUILD_NUMBER := eng.$(shell echo $${USER:0:6}).$(shell $(DATE) +%Y%m%d.%H%M%S)
281endif
282
283ifndef PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION
284  # Used to set minimum supported target sdk version. Apps targeting sdk
285  # version lower than the set value will fail to install and run on android
286  # device.
287  PLATFORM_MIN_SUPPORTED_TARGET_SDK_VERSION := 17
288endif
289