Wdrażanie właściwości systemowych jako interfejsów API

Właściwości systemu to wygodny sposób udostępniania informacji, zwykle konfiguracji, w całym systemie. Każda partycja może wewnętrznie korzystać z własnych właściwości systemu. Problem może wystąpić, gdy dostęp do usług jest uzyskiwany w różnych partycjach, np. gdy /vendor uzyskuje dostęp do usług zdefiniowanych przez /system. Od Androida 8.0 niektóre partycje, np. /system, można uaktualnić, a /vendor pozostaje niezmieniona. Właściwości systemowe to tylko globalny słownik par klucz-wartość typu ciąg znaków bez schematu, więc trudno je ustabilizować. Partycja /system może zmienić lub usunąć właściwości, od których zależy partycja /vendor, bez powiadomienia.

Od Androida 10 właściwości systemu dostępne w różnych partycjach są schematyzowane w plikach opisu właściwości systemu, a interfejsy API do uzyskiwania dostępu do właściwości są generowane jako konkretne funkcje dla C++ i Rusta oraz klasy dla Javy. Korzystanie z tych interfejsów API jest wygodniejsze, ponieważ nie wymagają one magicznych ciągów znaków (np. ro.build.date) do uzyskania dostępu i można je statycznie wpisywać. Stabilność interfejsu ABI jest też sprawdzana w czasie kompilacji. Jeśli wystąpią niezgodne zmiany, kompilacja zostanie przerwana. Ta kontrola działa jako wyraźnie zdefiniowane interfejsy między partycjami. Te interfejsy API mogą też zapewniać spójność między językami Rust, Java i C++.

Definiowanie właściwości systemu jako interfejsów API

Zdefiniuj właściwości systemu jako interfejsy API za pomocą plików opisu właściwości systemowych (.sysprop), które używają formatu tekstowego protokołu protobuf z tym schematem:

// File: sysprop.proto

syntax = "proto3";

package sysprop;

enum Access {
  Readonly = 0;
  Writeonce = 1;
  ReadWrite = 2;
}

enum Owner {
  Platform = 0;
  Vendor = 1;
  Odm = 2;
}

enum Scope {
  Public = 0;
  Internal = 2;
}

enum Type {
  Boolean = 0;
  Integer = 1;
  Long = 2;
  Double = 3;
  String = 4;
  Enum = 5;
  UInt = 6;
  ULong = 7;

  BooleanList = 20;
  IntegerList = 21;
  LongList = 22;
  DoubleList = 23;
  StringList = 24;
  EnumList = 25;
  UIntList = 26;
  ULongList = 27;
}

message Property {
  string api_name = 1;
  Type type = 2;
  Access access = 3;
  Scope scope = 4;
  string prop_name = 5;
  string enum_values = 6;
  bool integer_as_bool = 7;
  string legacy_prop_name = 8;
}

message Properties {
  Owner owner = 1;
  string module = 2;
  repeated Property prop = 3;
}

Jeden plik opisu właściwości systemowych zawiera jeden komunikat dotyczący właściwości, który opisuje zestaw właściwości. Znaczenie poszczególnych pól jest następujące:

Znaczenie pól wiadomości Property jest następujące:

Każdy typ właściwości jest mapowany na te typy w językach C++, Java i Rust.

Oto przykład pliku opisu Sysprop, który definiuje 3 właściwości:

# File: android/sysprop/PlatformProperties.sysprop

owner: Platform
module: "android.sysprop.PlatformProperties"
prop {
    api_name: "build_date"
    type: String
    prop_name: "ro.build.date"
    scope: Public
    access: Readonly
}
prop {
    api_name: "date_utc"
    type: Integer
    prop_name: "ro.build.date_utc"
    scope: Internal
    access: Readonly
}
prop {
    api_name: "device_status"
    type: Enum
    enum_values: "on|off|unknown"
    prop_name: "device.status"
    scope: Public
    access: ReadWrite
}

Definiowanie bibliotek właściwości systemu

Możesz teraz definiować moduły sysprop_library za pomocą plików opisu Sysprop. sysprop_library służy jako interfejs API dla języków C++, Java i Rust. System kompilacji wewnętrznie generuje 1 plik rust_library, 1 plik java_library i 1 plik cc_library dla każdej instancji sysprop_library.

// File: Android.bp
sysprop_library {
    name: "PlatformProperties",
    srcs: ["android/sysprop/PlatformProperties.sysprop"],
    property_owner: "Platform",
    vendor_available: true,
}

W źródle sprawdzania interfejsów API musisz uwzględnić pliki list interfejsów API. Aby to zrobić, utwórz pliki interfejsu API i katalog api. Umieść katalog api w tym samym katalogu co Android.bp. Nazwy plików interfejsu API to <module_name>-current.txt i <module_name>-latest.txt. <module_name>-current.txt zawiera podpisy interfejsu API bieżących kodów źródłowych, a <module_name>-latest.txt – najnowsze zamrożone podpisy interfejsu API. System kompilacji sprawdza, czy interfejsy API zostały zmienione, porównując te pliki interfejsu API z wygenerowanymi plikami interfejsu API w momencie kompilacji. Jeśli plik current.txt nie pasuje do kodów źródłowych, wyświetla komunikat o błędzie i instrukcje aktualizacji pliku current.txt. Oto przykład organizacji katalogów i plików:

├── api
│   ├── PlatformProperties-current.txt
│   └── PlatformProperties-latest.txt
└── Android.bp

Moduły klienta w językach Rust, Java i C++ mogą łączyć się z sysprop_library, aby korzystać z wygenerowanych interfejsów API. System kompilacji tworzy linki z klientów do wygenerowanych bibliotek C++, Java i Rust, dzięki czemu klienci mają dostęp do wygenerowanych interfejsów API.

java_library {
    name: "JavaClient",
    srcs: ["foo/bar.java"],
    libs: ["PlatformProperties"],
}

cc_binary {
    name: "cc_client",
    srcs: ["baz.cpp"],
    shared_libs: ["libPlatformProperties"],
}

rust_binary {
    name: "rust_client",
    srcs: ["src/main.rs"],
    rustlibs: ["libplatformproperties_rust"],
}

Nazwa biblioteki Rust jest generowana przez przekształcenie nazwy sysprop_library na małe litery, zastąpienie znaków . i - znakiem _, a następnie dodanie na początku lib i na końcu _rust.

W poprzednim przykładzie możesz uzyskać dostęp do zdefiniowanych właściwości w ten sposób:

Przykład w Rust:

use platformproperties::DeviceStatusValues;

fn foo() -> Result<(), Error> {
  // Read "ro.build.date_utc". default value is -1.
  let date_utc = platformproperties::date_utc()?.unwrap_or_else(-1);

  // set "device.status" to "unknown" if "ro.build.date" is not set.
  if platformproperties::build_date()?.is_none() {
    platformproperties::set_device_status(DeviceStatusValues::UNKNOWN);
  }

  …
}

Przykład w Javie:

import android.sysprop.PlatformProperties;

…

static void foo() {
    …
    // read "ro.build.date_utc". default value is -1
    Integer dateUtc = PlatformProperties.date_utc().orElse(-1);

    // set "device.status" to "unknown" if "ro.build.date" is not set
    if (!PlatformProperties.build_date().isPresent()) {
        PlatformProperties.device_status(
            PlatformProperties.device_status_values.UNKNOWN
        );
    }
    …
}
…

Przykład w C++:

#include <android/sysprop/PlatformProperties.sysprop.h>
using namespace android::sysprop;

…

void bar() {
    …
    // read "ro.build.date". default value is "(unknown)"
    std::string build_date = PlatformProperties::build_date().value_or("(unknown)");

    // set "device.status" to "on" if it's "unknown" or not set
    using PlatformProperties::device_status_values;
    auto status = PlatformProperties::device_status();
    if (!status.has_value() || status.value() == device_status_values::UNKNOWN) {
        PlatformProperties::device_status(device_status_values::ON);
    }
    …
}
…