Для описания всех флагов сборки, используемых для условной компиляции фреймворка, необходимо использовать HIDL. Соответствующие флаги сборки должны быть сгруппированы и включены в один файл .hal
. Использование HIDL для указания элементов конфигурации даёт следующие преимущества:
- Версионность (чтобы добавить новые элементы конфигурации, поставщики/OEM-производители должны явно расширить HAL)
- Хорошо документировано
- Контроль доступа с помощью SELinux
- Проверка корректности элементов конфигурации с помощью набора тестов поставщика (проверка диапазона, проверка взаимозависимости между элементами и т. д.)
- Автоматически сгенерированные API на C++ и Java
Определите флаги сборки, используемые фреймворком
Начните с определения конфигураций сборки, используемых для условной компиляции фреймворка, а затем откажитесь от устаревших конфигураций, чтобы сократить набор. Например, для surfaceflinger
определён следующий набор флагов сборки:
-
TARGET_USES_HWC2
-
TARGET_BOARD_PLATFORM
-
TARGET_DISABLE_TRIPLE_BUFFERING
-
TARGET_FORCE_HWC_FOR_VIRTUAL_DISPLAYS
-
NUM_FRAMEBUFFER_SURFACE_BUFFERS
-
TARGET_RUNNING_WITHOUT_SYNC_FRAMEWORK
-
VSYNC_EVENT_PHASE_OFFSET_NS
-
SF_VSYNC_EVENT_PHASE_OFFSET_NS
-
PRESENT_TIME_OFFSET_FROM_VSYNC_NS
-
MAX_VIRTUAL_DISPLAY_DIMENSION
Создать интерфейс HAL
Доступ к конфигурациям сборки подсистемы осуществляется через интерфейс HAL, а интерфейсы для задания значений конфигурации сгруппированы в пакете HAL android.hardware.configstore
(текущая версия 1.0). Например, чтобы создать файл интерфейса HAL для surfaceflinger
, найдите его в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
package android.hardware.configstore@1.0; interface ISurfaceFlingerConfigs { // TO-BE-FILLED-BELOW };
После создания файла .hal
запустите hardware/interfaces/update-makefiles.sh
чтобы добавить новый файл .hal
к файлам Android.bp
и Android.mk
.
Добавить функции для флагов сборки
Для каждого флага сборки добавьте новую функцию в интерфейс. Например, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { disableTripleBuffering() generates(OptionalBool ret); forceHwcForVirtualDisplays() generates(OptionalBool ret); enum NumBuffers: uint8_t { USE_DEFAULT = 0, TWO = 2, THREE = 3, }; numFramebufferSurfaceBuffers() generates(NumBuffers ret); runWithoutSyncFramework() generates(OptionalBool ret); vsyncEventPhaseOffsetNs generates (OptionalUInt64 ret); presentTimeOffsetFromSyncNs generates (OptionalUInt64 ret); maxVirtualDisplayDimension() generates(OptionalInt32 ret); };
При добавлении функции:
- Будьте лаконичны в названиях. Избегайте преобразования имён переменных make-файла в имена функций и помните, что префиксы
TARGET_
иBOARD_
больше не нужны. - Добавляйте комментарии. Помогите разработчикам понять назначение элемента конфигурации, как он влияет на поведение фреймворка, допустимые значения и другую важную информацию.
Типы возвращаемых функций могут быть Optional[Bool|String|Int32|UInt32|Int64|UInt64]
. Типы определяются в types.hal
в том же каталоге и заключают примитивные значения в поле, которое указывает, задано ли значение HAL; если нет, используется значение по умолчанию.
struct OptionalString { bool specified; string value; };
При необходимости определите перечисление, наилучшим образом представляющее тип элемента конфигурации, и используйте его в качестве возвращаемого типа. В приведённом выше примере перечисление NumBuffers
определено для ограничения количества допустимых значений. При определении таких пользовательских типов данных добавьте поле или значение перечисления (например, USE_DEFAULT
) для обозначения того, определено ли значение в HAL.
В HIDL не обязательно, чтобы один флаг сборки был отдельной функцией. Владельцы модулей могут также объединить тесно связанные флаги сборки в структуру и создать функцию, возвращающую эту структуру (это может сократить количество вызовов функций).
Например, вариант объединения двух флагов сборки в одну структуру в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
выглядит так:
interface ISurfaceFlingerConfigs { // other functions here struct SyncConfigs { OptionalInt64 vsyncEventPhaseoffsetNs; OptionalInt64 presentTimeoffsetFromSyncNs; }; getSyncConfigs() generates (SyncConfigs ret); // other functions here };
Альтернативы одной функции HAL
В качестве альтернативы использованию одной функции HAL для всех флагов сборки, интерфейс HAL также предоставляет простые функции, такие как getBoolean(string key)
и getInteger(string key)
. Сами пары key=value
хранятся в отдельных файлах, и служба HAL предоставляет значения, считывая/анализируя эти файлы.
Хотя этот подход легко определить, он не включает в себя преимущества, предоставляемые HIDL (принудительное управление версиями, простота документирования, контроль доступа), и поэтому не рекомендуется.
Одиночные и множественные интерфейсы
Конструкция интерфейса HAL для элементов конфигурации предлагает два варианта:
- Единый интерфейс, охватывающий все элементы конфигурации
- Несколько интерфейсов, каждый из которых охватывает набор связанных элементов конфигурации
Единый интерфейс проще, но его поддержка может стать невозможной по мере добавления новых элементов конфигурации в один файл. Кроме того, управление доступом не является детальным, поэтому процесс, которому предоставлен доступ к интерфейсу, может читать все элементы конфигурации (доступ к частичному набору элементов конфигурации не предоставляется). В противном случае, если доступ не предоставлен, элементы конфигурации не могут быть прочитаны.
Из-за этих проблем Android использует несколько интерфейсов с одним интерфейсом HAL для группы связанных элементов конфигурации. Например, ISurfaceflingerConfigs
для элементов конфигурации, связанных с surfaceflinger
, и IBluetoothConfigs
для элементов конфигурации, связанных с Bluetooth.