platform_build_soong/scripts/uffd_gc_utils_test.py
Jiakai Zhang 7d292228c1 Determine GC type based on BUILT_KERNEL_VERSION_FILE.
How it works:
1. build/make/core/Makefile generates a txt file with the kernel
   version, which is taken from an explicit BOARD_KERNEL_VERSION value,
   or extracted from the kernel image on the source tree, or extracted
   from the kernel image extracted from the prebuilt boot.img.
   The file is saved at
   $ANDROID_PRODUCT_OUT/obj/PACKAGING/check_vintf_all_intermediates/kernel_version.txt.
2. If PRODUCT_ENABLE_UFFD_GC is "default", meaning the GC type needs to
   be determined by the kernel version, build/make/core/Makefile copies
   kernel_version.txt to
   out/soong/dexpreopt/kernel_version_for_uffd_gc.txt.
3. build/soong/dexpreopt/config.go writes the the UFFD GC flag to
   out/soong/dexpreopt/uffd_gc_flag.txt. The flag is determined by an
   explicit PRODUCT_ENABLE_UFFD_GC value or by contruct_uffd_gc_flag.py,
   which reads kernel_version_for_uffd_gc.txt and determines the flag
   accordingly.
4. dex2oat takes the UFFD GC flag from uffd_gc_flag.txt.
5. post_process_props.py mangles ro.dalvik.vm.enable_uffd_gc based on
   the same logic.

Bug: 321751629
Bug: 319554951
Bug: 318763448
Bug: 319648491
Test: m --no-skip-soong-tests nothing
Test: atest uffd_gc_utils_test
Test: Build with `OVERRIDE_ENABLE_UFFD_GC=default m` for device with no
  UFFD support -
  1. Check the existence of `-Xgc:CMC` in
     out/soong/dexpreopt_arm64/dex_bootjars/android/system/framework/arm64/boot.invocation
     (dex2oat invocation for a boot image)
  2. Check the existence of `-Xgc:CMC` in
     out/soong/.intermediates/packages/apps/Settings/Settings/android_common/dexpreopt/Settings/oat/arm64/package.invocation
     (dex2oat invocation for an app defined in .bp)
  3. Check the existence of `-Xgc:CMC` in
     $ANDROID_PRODUCT_OUT/obj/APPS/Dialer_intermediates/oat/arm64/package.invocation
     (dex2oat invocation for an app defined in .mk)
  4. Check the value of ro.dalvik.vm.enable_uffd_gc in
     $ANDROID_PRODUCT_OUT/product/etc/build.prop
Test: Build with `OVERRIDE_ENABLE_UFFD_GC=default m` for device with
  UFFD support, and do the steps above.
Test: Build with `OVERRIDE_ENABLE_UFFD_GC=true m`, and do the steps
  above.
Test: Build with `OVERRIDE_ENABLE_UFFD_GC=false m`, and do the steps
  above.

Change-Id: I035ad32233e49e2a30ce11f6c7c318a648511ef8
2024-02-02 09:23:37 +08:00

61 lines
2.1 KiB
Python

#!/usr/bin/env python
#
# Copyright (C) 2024 The Android Open Source Project
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
"""Unit tests for uffd_gc_utils.py."""
import unittest
from uffd_gc_utils import should_enable_uffd_gc_impl
class UffdGcUtilsTest(unittest.TestCase):
def test_should_enable_uffd_gc_impl(self):
# GKI kernels in new format.
self.assertTrue(should_enable_uffd_gc_impl(
"6.1.25-android14-11-g34fde9ec08a3-ab10675345"))
self.assertTrue(should_enable_uffd_gc_impl(
"5.4.42-android12-0-something"))
self.assertFalse(should_enable_uffd_gc_impl(
"5.4.42-android11-0-something"))
# GKI kernels in old format.
self.assertFalse(should_enable_uffd_gc_impl(
"4.19.282-g4b749a433956-ab10893502"))
# Non GKI kernels.
self.assertTrue(should_enable_uffd_gc_impl(
"6.1.25-foo"))
self.assertTrue(should_enable_uffd_gc_impl(
"6.1.25"))
self.assertTrue(should_enable_uffd_gc_impl(
"5.10.19-foo"))
self.assertTrue(should_enable_uffd_gc_impl(
"5.10.19"))
with self.assertRaises(SystemExit):
should_enable_uffd_gc_impl("5.4.42-foo")
with self.assertRaises(SystemExit):
should_enable_uffd_gc_impl("5.4.42")
self.assertFalse(should_enable_uffd_gc_impl(
"4.19.282-foo"))
self.assertFalse(should_enable_uffd_gc_impl(
"4.19.282"))
with self.assertRaises(SystemExit):
should_enable_uffd_gc_impl("foo")
# No kernel.
self.assertTrue(should_enable_uffd_gc_impl(
"<unknown-kernel>"))
if __name__ == '__main__':
unittest.main(verbosity=2)