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