Дополнительные ресурсы

Ниже приведены ресурсы, на которых можно найти информацию о местоположении кода, инструментах, тестировании и лицензировании.

Местоположение кода, по которому можно выполнять поиск

Код объекта интерфейса поставщика, к которому можно обращаться с запросами, находится в разделе system/libvintf.

Инструменты

Создавать файлы манифеста и матрицы совместимости вручную может быть сложно. Чтобы создать шаблон манифеста или матрицы совместимости, воспользуйтесь следующими инструментами:

LSHAL

LSHAL – это инструмент на стороне устройства, который перечисляет все зарегистрированные HAL-интерфейсы в hwservicemanager и все доступные реализации сквозной передачи (например, android.hardware.foo@1.0-impl.so) на устройстве. Также на основе списка можно создать файл манифеста устройства:

adb shell su 0 /system/bin/lshal --init-vintf

объявлений.

1. Если пакет зарегистрирован в hwservicemanager и найден как сквозной HAL, для <transport> задается значение hwbinder.
2. В манифесте не указана версия SELinux. Рекомендуется внедрять элемент через assemble_vintf, как описано ниже.
3. Сгенерированный файл манифеста HAL может быть неточным. Чтобы устранить несоответствия между манифестом устройства и тем, что на самом деле предоставляет vendor.img, требуется вмешательство человека.

ASSEMBLE_VINTF

assemble_vintf – это инструмент на стороне хоста, который:

1. Проверяет, действительна ли матрица совместимости или файл манифеста.
2. Вставляет переменные в манифесты и матрицы совместимости, доступные во время сборки, и генерирует новый файл, который должен быть установлен на устройство.
3. Проверяет совместимость сгенерированного файла и его двойника.
4. Если указан файл манифеста, можно сгенерировать стандартную матрицу совместимости, которая будет совместима с этим файлом.

Пример: создание матрицы совместимости устройств на основе файла манифеста фреймворка

assemble_vintf -m --hals-only \
    -i system/libhidl/manifest.xml \
    -o device/manufacturer/device_name/compatibility_matrix.xml

Обратите внимание, что для всех HAL задано значение optional="true".

Пример. Как создать матрицу совместимости фреймворка на основе файла манифеста устройства

assemble_vintf -m --hals-only \
    -i device/foo/bar/manifest.xml \
    -o path/to/place/output/compatibility_matrix.xml

Обратите внимание, что для всех HAL задано значение optional="true".

Пример: создание XML-файлов манифеста устройства на основе переменных

Если во время сборки в файле device/manufacturer/device_name/BoardConfig.mk определены следующие переменные:

# Vendor manifest is named DEVICE_MANIFEST_FILE for legacy reasons.
DEVICE_MANIFEST_FILE := \
    device/manufacturer/device_name/vendor_manifest.xml
ODM_MANIFEST_FILES := \
    device/manufacturer/device_name/odm_manifest.xml
ODM_MANIFEST_SKUS := sku1 sku2
ODM_MANIFEST_SKU1_FILES := \
    device/manufacturer/device_name/odm_manifest_sku1.xml
ODM_MANIFEST_SKU2_FILES := \
    device/manufacturer/device_name/odm_manifest_sku2.xml

Затем выполняются следующие команды (в системе сборки, измененные для исключения деталей реализации), чтобы сгенерировать XML-файлы манифеста устройства:

# vendor manifest; only when DEVICE_MANIFEST_FILE is set
BOARD_SEPOLICY_VERS=$(BOARD_SEPOLICY_VERS) assemble_vintf \
    $(addprefix,-i ,$(DEVICE_MANIFEST_FILE)) \
    -o $(TARGET_OUT_VENDOR)/etc/vintf/manifest.xml

# ODM manifests
assemble_vintf \
    $(addprefix,-i ,$(ODM_MANIFEST_FILES)) \
    -o $(TARGET_OUT_ODM)/etc/vintf/manifest.xml

# ODM manifests for each sku
assemble_vintf \
    $(addprefix,-i ,$(ODM_MANIFEST_SKU1_FILES)) \
    -o $(TARGET_OUT_ODM)/etc/vintf/manifest_sku1.xml
assemble_vintf \
    $(addprefix,-i ,$(ODM_MANIFEST_SKU2_FILES)) \
    -o $(TARGET_OUT_ODM)/etc/vintf/manifest_sku2.xml

Во время выполнения объект VINTF объединяет манифесты поставщика и ODM в манифест устройства. Подробнее о манифесте устройства…

Пример: создание XML-файлов матрицы совместимости устройств на основе переменных

Если во время сборки в файле device/manufacturer/device_name/BoardConfig.mk определены следующие переменные:

# vendor compatibility matrix is named DEVICE_MATRIX_FILE for legacy reasons.
DEVICE_MATRIX_FILE := \
    device/manufacturer/device_name/vendor_compatibility_matrix.xml \
    device/manufacturer/device_name/vendor_compatibility_matrix_additional.xml

Затем выполняются следующие команды (в системе сборки, измененные для исключения деталей реализации) для создания XML-файлов матрицы совместимости устройств:

# vendor compatibility matrix; only when DEVICE_MATRIX_FILE is set
assemble_vintf \
    $(addprefix,-i ,$(DEVICE_MATRIX_FILE)) \
    -o $(TARGET_OUT_VENDOR)/etc/vintf/compatibility_matrix.xml

Во время выполнения объект VINTF использует матрицу совместимости поставщика в качестве матрицы совместимости устройства. Подробнее о совместимости устройств…

Пример. Создание XML-файлов манифеста фреймворка из переменных

В правиле device/manufacturer/device_name/BoardConfig.mk можно задать следующие переменные:

# Device-specific system manifest is named DEVICE_FRAMEWORK_MANIFEST_FILE for legacy reasons
DEVICE_FRAMEWORK_MANIFEST_FILE := \
    device/manufacturer/device_name/device_system_manifest.xml

# Product manifest
PRODUCT_MANIFEST_FILES := \
    device/manufacturer/device_name/product_manifest.xml

Чтобы создать XML-файлы манифеста фреймворка, выполняются следующие команды (в системе сборки, измененные для удаления деталей реализации):

# system manifest
assemble_vintf \
    -i system/libhidl/vintfdata/manifest.xml \
    $(addprefix,-i ,$(DEVICE_FRAMEWORK_MANIFEST_FILE)) \
    -o $(TARGET_OUT)/etc/vintf/manifest.xml

# product manifest
assemble_vintf \
    $(addprefix,-i ,$(PRODUCT_MANIFEST_FILES)) \
    -o $(TARGET_OUT_PRODUCT)/etc/vintf/manifest.xml

Во время выполнения объект VINTF объединяет системный манифест, фрагменты системного манифеста, манифест продукта и фрагменты манифеста продукта в манифест фреймворка. Подробнее о манифесте фреймворка…

Пример: создание XML-файлов матрицы совместимости фреймворков на основе переменных

В файле device/manufacturer/device_name/BoardConfig.mk можно задать следующие переменные, чтобы определить FCM для товаров и системные FCM для устройств:

DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE := \
    device/manufacturer/device_name/product_compatibility_matrix.xml
# Device-specific system compatibility matrix is named
# DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE for legacy reasons.
DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE := \
    device/manufacturer/device_name/device_system_compatibility_matrix.xml

FCM system_ext должен быть установлен с модулями Soong. Продукт FCM также может быть установлен с помощью модулей Soong. Не определяйте DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE, если используется этот метод. Кроме того, с модулями Soong можно установить несколько версий FCM для продукта и system_ext. Укажите следующие данные:

• Определите модуль в device/manufacturer/device_name/Android.bp. Например (замените system_ext на product для FCM продукта):

  vintf_compatibility_matrix {
      name: "system_ext_compatibility_matrix.xml",
      stem: "compatibility_matrix.xml",
      system_ext_specific: true,
      // product_specific: true, // for product FCM
      srcs: [
          "system_ext_compatibility_matrix.xml",
      ],
  }

• Установите модуль в device/manufacturer/device_name/device.mk. Пример:

  PRODUCT_PACKAGES += system_ext_compatibility_matrix.xml

Чтобы создать XML-файлы матрицы совместимости фреймворка, выполняются следующие команды (в системе сборки, измененные для удаления деталей реализации):

# common system compatibility matrix for each FCM version
BOARD_SEPOLICY_VERS=$(BOARD_SEPOLICY_VERS) \
POLICYVERS=$(POLICYVERS) \
BOARD_AVB_VBMETA_VERSION=$(BOARD_AVB_VBMETA_VERSION)
assemble_vintf \
    -i hardware/interfaces/compatibility_matrices/compatibility_matrix.empty.xml
    $(addprefix,-i ,$(DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE)) \
    -o $(TARGET_OUT)/etc/vintf/compatibility_matrix.device.xml

# framework compatibility matrixes at each FCM version
assemble_vintf
    -i hardware/interfaces/compatibility_matrices/compatibility_matrix.{level}.xml \
    -o $(TARGET_OUT)/etc/vintf/compatibility_matrix.{level}.xml \
    --kernel=...

# product framework compatibility matrix; only when
# DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE is set or when the Soong module for
# product FCM is defined
assemble_vintf
    -i $(DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE)
    -o $(TARGET_OUT_PRODUCT)/etc/vintf/compatibility_matrix.xml

# system_ext framework compatibility matrix; only when the Soong module for
# system_ext FCM is defined
assemble_vintf
    -i <srcs for the soong module>
    -o $(TARGET_OUT_SYSTEM_EXT)/etc/vintf/compatibility_matrix.xml

Во время выполнения объект VINTF объединяет подмножество матриц совместимости системы и матриц совместимости продукта в матрицу совместимости фреймворка. Подробнее о совместимости спецификаций…

Пример. Создание манифеста поставщика из фрагментов

При сборке можно объединить несколько фрагментов манифеста поставщика. Пример:

<!-- device/manufacturer/device_name/manifest_common.xml -->
<manifest version="1.0" type="device">
    <!-- common HALs here -->
</manifest>

<!-- device/manufacturer/device_name/ir.xml -->
<manifest version="1.0" type="device">
    <hal>
        <name>android.hardware.ir</name>
        <version>1.0</version>
        <!-- other fields -->
    </hal>
</manifest>

# device/manufacturer/device_name/BoardConfig.mk
DEVICE_MANIFEST_FILE := device/manufacturer/device_name/manifest_common.xml
ifdef BOARD_ENABLE_IR
    DEVICE_MANIFEST_FILE += device/manufacturer/device_name/ir.xml
endif

Затем assemble_vintf добавляет IR HAL в манифест поставщика, если определено свойство BOARD_ENABLE_IR, и пропускает его, если BOARD_ENABLE_IR не определено. Чтобы создать манифест поставщика, выполняются следующие команды (измененные, чтобы опустить детали реализации):

# if BOARD_ENABLE_IR is defined
BOARD_SEPOLICY_VERS=10000.0 assemble_vintf \
    -i device/manufacturer/device_name/manifest_common.xml:device/manufacturer/device_name/ir.xml \
    -o $(TARGET_OUT_VENDOR)/manifest.xml

# if BOARD_ENABLE_IR is not defined
BOARD_SEPOLICY_VERS=10000.0 assemble_vintf \
    -i device/manufacturer/device_name/manifest_common.xml \
    -o $(TARGET_OUT_VENDOR)/manifest.xml

Дополнительную информацию по этой теме можно найти в следующих разделах:

assemble_vintf --help

Тестирование

В проекте platform/system/libvintf для сериализации, десериализации и проверки совместимости используется GTest.

Лицензирование

• tinyxml2 (external/tinyxml2) для сериализации/десериализации объекта в XML и обратно. лицензию, похожую на BSD.
• libselinux (external/selinux/libselinux) для получения версии policydb. Общественное достояние.
• libz (внешний/zlib) для декомпрессии /proc/config.gz. лицензию, похожую на BSD.
• В проекте libvintf используется лицензия Apache 2.0 (с соответствующими файлами MODULE_LICENSE_APACHE2 и NOTICE).