Dedup *fragments information common to apex and sdk

Previously, both the sdk and apex had to specify the same *fragments
property to ensure that building a system image from a prebuilt
version of the module (both APEX and sdk snapshots) would work.

This change avoids the duplication by adding the apex to the sdk which
allows the sdk to automatically export any APIs and related information
provided by the APEX. At the moment that just includes information from
*fragments properties but may expand in future.

Bug: 232401814
Test: # Build snapshots with a fixed build number
      BUILD_NUMBER=fixed packages/modules/common/build/mainline_modules_sdks.sh
      # Remove api diff files as they contain file stamps of generated files so
      # differ every time they are generated.
      find out/dist/mainline-sdks -name \*txt | xargs rm
      # Save the snapshots away.
      mv out/dist/mainline-sdks before-changes
      # Apply this change.
      # Repeat the first two steps above and then run the following to verify
      # that this change had no effect on the generated snapshot contents.
      meld before-changes out/dist/mainline-sdks
Change-Id: Ia5eeb3c1efc3ab0e94fae39f56276cbbf45ef9df
1 file changed
tree: 932e3a5e8d0b672d60695d8dfc670bb7f5fbb5d5
  1. derive_classpath/
  2. derive_sdk/
  3. gen_sdk/
  4. java/
  5. javatests/
  6. Android.bp
  7. com.android.sdkext.avbpubkey
  8. com.android.sdkext.pem
  9. com.android.sdkext.pk8
  10. com.android.sdkext.x509.pem
  11. manifest.json
  12. OWNERS
  13. PREUPLOAD.cfg
  14. README.md
  15. TEST_MAPPING
README.md

SdkExtensions module

SdkExtensions module is responsible for:

  • deciding the extension SDK level of the device;
  • providing APIs for applications to query the extension SDK level;
  • determining the values for the BOOTCLASSPATH, DEX2OATBOOTCLASSPATH, and SYSTEMSERVERCLASSPATH environment variables.

General information

Structure

The module is packaged in an apex, com.android.sdkext, and has several components:

  • bin/derive_classpath: a native binary that runs early in the device boot process. It reads individual classpath configs files from the system and other modules, merges them, and defines the definition of *CLASSPATH environ variables.
  • bin/derive_sdk: native binary that runs early in the device boot process and reads metadata of other modules, to set system properties relating to the extension SDK (for instance build.version.extensions.r).
  • javalib/framework-sdkextension.jar: this is a jar on the bootclasspath that exposes APIs to applications to query the extension SDK level.

Deriving extension SDK level

derive_sdk is a program that reads metadata stored in other apex modules, in the form of binary protobuf files in subpath etc/sdkinfo.pb inside each apex. The structure of this protobuf can be seen here. The exact steps for converting a set of metadata files to actual extension versions is likely to change over time, and should not be depended upon.

Reading extension SDK level

The module exposes a java class SdkExtensions in the package android.os.ext. The method getExtensionVersion(int) can be used to read the version of a particular sdk extension, e.g. getExtensionVersion(Build.VERSION_CODES.R).

Deriving classpaths

derive_classpath service reads and merges individual config files in the /system/etc/classpaths/ and /apex/*/etc/classpaths. Each config stores protobuf message from classpaths.proto in a proto binary format. Exact merging algorithm that determines the order of the classpath entries is described in derive_classpath.cpp and may change over time.

Developer information

Adding a new extension

An extension is a way to group a set of modules so that they are versioned together. We currently define a new extension for every Android SDK level that introduces new modules. Every module shipped in previous versions are also part of the new extension. For example, all the R modules are part of both the R extensions and the S extensions.

The steps to define a new extension are:

  • Add any new modules to the SdkModule enum in sdk.proto.
  • Add the binary “current sdk version” proto to the apexes of the new modules.
  • Update derive_sdk.cpp by:
  • mapping the modules' package names to the new enum values
  • creating a new set with the new enum values of the modules relevant for this extension.
  • set a new sysprop to the value of GetSdkLevel with the new enum set
  • add a unit test to derive_sdk_test.cpp verifying the new extensions work
  • Make the SdkExtensions.getExtensionVersion API support the new extensions.
  • Extend the CTS test to verify the above two behaviors.