AIDL pour les HAL

Android 11 introduit la possibilité d'utiliser AIDL pour les HAL dans Android, ce qui permet d'implémenter des parties d'Android sans HIDL. Passez aux HAL pour utiliser AIDL exclusivement lorsque cela est possible (lorsque les HAL en amont utilisent HIDL, HIDL doit être utilisé).

Les HAL qui utilisent AIDL pour communiquer entre les composants du framework, tels que ceux de system.img, et les composants matériels, tels que ceux de vendor.img, doivent utiliser AIDL stable. Toutefois, pour communiquer au sein d'une partition, par exemple d'un HAL à un autre, aucune restriction ne s'applique au mécanisme IPC à utiliser.

Motivation

AIDL existe depuis plus longtemps que HIDL et est utilisé dans de nombreux autres endroits, par exemple entre les composants du framework Android ou dans les applications. Maintenant qu'AIDL est compatible avec la stabilité, il est possible d'implémenter une pile entière avec un seul environnement d'exécution IPC. AIDL dispose également d'un meilleur système de gestion des versions que HIDL. Voici quelques avantages d'AIDL :

  • L'utilisation d'un seul langage IPC signifie qu'il n'y a qu'une seule chose à apprendre, à déboguer, à optimiser et à sécuriser.
  • AIDL est compatible avec la gestion des versions sur place pour les propriétaires d'une interface :
    • Les propriétaires peuvent ajouter des méthodes à la fin des interfaces ou des champs aux parcelables. Cela signifie qu'il est plus facile de gérer les versions du code au fil des ans, et que le coût annuel est également moins élevé (les types peuvent être modifiés sur place et il n'est pas nécessaire d'utiliser des bibliothèques supplémentaires pour chaque version d'interface).
    • Les interfaces d'extension peuvent être associées au moment de l'exécution plutôt que dans le système de types. Il n'est donc pas nécessaire de rebaser les extensions en aval sur des versions plus récentes des interfaces.
  • Une interface AIDL existante peut être utilisée directement lorsque son propriétaire choisit de la stabiliser. Auparavant, une copie complète de l'interface devait être créée dans HIDL.

Compiler par rapport à l'environnement d'exécution AIDL

AIDL comporte trois backends différents : Java, NDK et CPP. Pour utiliser AIDL stable, utilisez toujours la copie système de libbinder dans system/lib*/libbinder.so et communiquez sur /dev/binder. Pour le code de l'image vendor, cela signifie que libbinder (à partir du VNDK) ne peut pas être utilisé : cette bibliothèque possède une API C++ instable et des éléments internes instables. Au lieu de cela, le code fournisseur natif doit utiliser le backend NDK d'AIDL, établir un lien avec libbinder_ndk (qui est soutenu par le système libbinder.so) et établir un lien avec les bibliothèques NDK créées par les entrées aidl_interface. Pour connaître les noms exacts des modules, consultez Règles de nommage des modules.

Écrire une interface HAL AIDL

Pour qu'une interface AIDL soit utilisée entre le système et le fournisseur, elle doit être modifiée de deux manières :

  • Chaque définition de type doit être annotée avec @VintfStability.
  • La déclaration aidl_interface doit inclure stability: "vintf",.

Seul le propriétaire d'une interface peut apporter ces modifications.

Lorsque vous apportez ces modifications, l'interface doit se trouver dans le fichier manifeste VINTF pour fonctionner. Testez cela (et les exigences associées, telles que la vérification que les interfaces publiées sont figées) à l'aide du test de la Vendor Test Suite (VTS) vts_treble_vintf_vendor_test. Vous pouvez utiliser une interface @VintfStability sans ces exigences en appelant AIBinder_forceDowngradeToLocalStability dans le backend NDK, android::Stability::forceDowngradeToLocalStability dans le backend C++ ou android.os.Binder#forceDowngradeToSystemStability dans le backend Java sur un objet binder avant qu'il ne soit envoyé à un autre processus.

De plus, pour une portabilité maximale du code et pour éviter des problèmes potentiels tels que des bibliothèques supplémentaires inutiles, désactivez le backend CPP.

Le code montre comment désactiver le backend CPP :

    aidl_interface: {
        ...
        backend: {
            cpp: {
                enabled: false,
            },
        },
    }

Trouver des interfaces HAL AIDL

Les interfaces AIDL stables AOSP pour les HAL se trouvent dans les dossiers aidl des mêmes répertoires de base que les interfaces HIDL :

  • hardware/interfaces est destiné aux interfaces généralement fournies par le matériel.
  • frameworks/hardware/interfaces est destiné aux interfaces de haut niveau fournies au matériel.
  • system/hardware/interfaces est destiné aux interfaces de bas niveau fournies au matériel.

Placez les interfaces d'extension dans d'autres hardware/interfaces sous-répertoires dans vendor ou hardware.

Interfaces d'extension

Android propose un ensemble d'interfaces AOSP officielles à chaque version. Lorsque les partenaires Android souhaitent ajouter des fonctionnalités à ces interfaces, ils ne doivent pas les modifier directement, car cela rend leur environnement d'exécution Android incompatible avec l'environnement d'exécution Android AOSP. Évitez de modifier ces interfaces pour que l'image GSI continue de fonctionner.

Les extensions peuvent s'enregistrer de deux manières différentes :

Toutefois, quelle que soit la manière dont une extension est enregistrée, lorsque des composants spécifiques au fournisseur (c'est-à-dire ne faisant pas partie de l'AOSP en amont) utilisent l'interface, les conflits de fusion ne sont pas possibles. Toutefois, lorsque des modifications en aval sont apportées aux composants AOSP en amont, des conflits de fusion peuvent se produire. Les stratégies suivantes sont recommandées :

  • Transmettez les ajouts d'interface à AOSP dans la prochaine version.
  • Transmettez les ajouts d'interface qui offrent plus de flexibilité (sans conflits de fusion) dans la prochaine version.

Parcelables d'extension : ParcelableHolder

ParcelableHolder est une instance de l'interface Parcelable qui peut contenir une autre instance de Parcelable.

Le principal cas d'utilisation de ParcelableHolder consiste à rendre Parcelable extensible. Par exemple, imaginez que les implémenteurs d'appareils s'attendent à pouvoir étendre un défini par AOSP Parcelable, AospDefinedParcelable, pour inclure leurs fonctionnalités à valeur ajoutée.

Utilisez l'interface ParcelableHolder pour étendre Parcelable avec vos fonctionnalités à valeur ajoutée. L'interface ParcelableHolder contient une instance de Parcelable. Si vous essayez d'ajouter des champs directement à Parcelable, une erreur se produit :

parcelable AospDefinedParcelable {
  int a;
  String b;
  String x; // ERROR: added by a device implementer
  int[] y; // added by a device implementer
}

Comme vous pouvez le voir dans le code précédent, cette pratique est incorrecte, car les champs ajoutés par l'implémenteur de l'appareil peuvent entrer en conflit lorsque Parcelable est révisé dans les prochaines versions d'Android.

À l'aide de ParcelableHolder, le propriétaire d'un parcelable peut définir un point d'extension dans une instance de Parcelable :

parcelable AospDefinedParcelable {
  int a;
  String b;
  ParcelableHolder extension;
}

Les implémenteurs d'appareils peuvent ensuite définir leur propre instance Parcelable pour leur extension :

parcelable OemDefinedParcelable {
  String x;
  int[] y;
}

La nouvelle instance Parcelable peut être associée à l'original Parcelable avec le champ ParcelableHolder :


// Java
AospDefinedParcelable ap = ...;
OemDefinedParcelable op = new OemDefinedParcelable();
op.x = ...;
op.y = ...;

ap.extension.setParcelable(op);

...

OemDefinedParcelable op = ap.extension.getParcelable(OemDefinedParcelable.class);

// C++
AospDefinedParcelable ap;
OemDefinedParcelable op;
std::shared_ptr<OemDefinedParcelable> op_ptr = make_shared<OemDefinedParcelable>();

ap.extension.setParcelable(op);
ap.extension.setParcelable(op_ptr);

...

std::shared_ptr<OemDefinedParcelable> op_ptr;

ap.extension.getParcelable(&op_ptr);

// NDK
AospDefinedParcelable ap;
OemDefinedParcelable op;
ap.extension.setParcelable(op);

...

std::optional<OemDefinedParcelable> op;
ap.extension.getParcelable(&op);

// Rust
let mut ap = AospDefinedParcelable { .. };
let op = Rc::new(OemDefinedParcelable { .. });

ap.extension.set_parcelable(Rc::clone(&op));

...

let op = ap.extension.get_parcelable::<OemDefinedParcelable>();

Noms d'instances de serveur HAL AIDL

Par convention, les services HAL AIDL ont un nom d'instance au format $package.$type/$instance. Par exemple, une instance du HAL du vibreur est enregistrée en tant que android.hardware.vibrator.IVibrator/default.

Écrire un serveur HAL AIDL

Les serveurs AIDL @VintfStability doivent être déclarés dans le fichier manifeste VINTF, par exemple :

    <hal format="aidl">
        <name>android.hardware.vibrator</name>
        <version>1</version>
        <fqname>IVibrator/default</fqname>
    </hal>

Sinon, ils doivent enregistrer un service AIDL normalement. Lors de l'exécution des tests VTS, il est prévu que tous les HAL AIDL déclarés soient disponibles.

Écrire un client AIDL

Les clients AIDL doivent se déclarer dans la matrice de compatibilité, par exemple :

    <hal format="aidl" optional="true">
        <name>android.hardware.vibrator</name>
        <version>1-2</version>
        <interface>
            <name>IVibrator</name>
            <instance>default</instance>
        </interface>
    </hal>

Convertir un HAL existant de HIDL en AIDL

Utilisez l'outil hidl2aidl pour convertir une interface HIDL en AIDL.

Fonctionnalités de hidl2aidl :

  • Créez des fichiers AIDL (.aidl) basés sur les fichiers HAL (.hal) pour le package donné.
  • Créez des règles de compilation pour le package AIDL nouvellement créé avec tous les backends activés.
  • Créez des méthodes de traduction dans les backends Java, CPP et NDK pour traduire les types HIDL en types AIDL.
  • Créez des règles de compilation pour les bibliothèques de traduction avec les dépendances requises.
  • Créez des assertions statiques pour vous assurer que les énumérateurs HIDL et AIDL ont les mêmes valeurs dans les backends CPP et NDK.

Pour convertir un package de fichiers HAL en fichiers AIDL, procédez comme suit :

  1. Compilez l'outil situé dans system/tools/hidl/hidl2aidl.

    La compilation de cet outil à partir de la dernière source offre l'expérience la plus complète. Vous pouvez utiliser la dernière version pour convertir des interfaces sur des branches plus anciennes à partir de versions précédentes :

    m hidl2aidl

  2. Exécutez l'outil avec un répertoire de sortie suivi du package à convertir.

    Vous pouvez également utiliser l'argument -l pour ajouter le contenu d'un nouveau fichier de licence en haut de tous les fichiers générés. Veillez à utiliser la licence et la date correctes :

    hidl2aidl -o <output directory> -l <file with license> <package>

    Exemple :

    hidl2aidl -o . -l my_license.txt android.hardware.nfc@1.2

  3. Lisez les fichiers générés et corrigez les problèmes liés à la conversion :

    • conversion.log contient tous les problèmes non gérés à résoudre en premier.
    • Les fichiers AIDL générés peuvent contenir des avertissements et des suggestions qui nécessitent une action. Ces commentaires commencent par //.
    • Nettoyez et améliorez le package.
    • Vérifiez l'@JavaDerive annotation pour les fonctionnalités qui peuvent être nécessaires, telles que toString ou equals.

  4. Compilez uniquement les cibles dont vous avez besoin :

  5. Consultez les principales différences entre AIDL et HIDL :

    • L'utilisation des exceptions et de Status intégrés à AIDL améliore généralement l'interface et supprime le besoin d'un autre type d'état spécifique à l'interface.
    • Les arguments d'interface AIDL dans les méthodes ne sont pas @nullable par défaut comme dans HIDL.

SEPolicy pour les HAL AIDL

Un type de service AIDL visible par le code du fournisseur doit avoir l'attribut hal_service_type. Sinon, la configuration sepolicy est la même que pour tout autre service AIDL (bien qu'il existe des attributs spéciaux pour les HAL). Voici un exemple de définition d'un contexte de service HAL :

    type hal_foo_service, service_manager_type, hal_service_type;

Pour la plupart des services définis par la plate-forme, un contexte de service avec le type approprié est déjà ajouté (par exemple, android.hardware.foo.IFoo/default est déjà marqué comme hal_foo_service). Toutefois, si un client de framework est compatible avec plusieurs noms d'instance, des noms d'instance supplémentaires doivent être ajoutés dans les fichiers service_contexts spécifiques à l'appareil :

    android.hardware.foo.IFoo/custom_instance u:object_r:hal_foo_service:s0

Lorsque vous créez un nouveau type de HAL, vous devez ajouter des attributs HAL. Un attribut HAL spécifique peut être associé à plusieurs types de services (chacun pouvant avoir plusieurs instances, comme nous l'avons vu). Pour un HAL, foo, il existe hal_attribute(foo). Cette macro définit les attributs hal_foo_client et hal_foo_server. Pour un domaine donné, les macros hal_client_domain et hal_server_domain associent un domaine à un attribut HAL donné. Par exemple, le fait que le serveur système soit un client de ce HAL correspond à la règle hal_client_domain(system_server, hal_foo). Un serveur HAL inclut de la même manière hal_server_domain(my_hal_domain, hal_foo).

En règle générale, pour un attribut HAL donné, créez également un domaine tel que hal_foo_default pour les HAL de référence ou d'exemple. Toutefois, certains appareils utilisent ces domaines pour leurs propres serveurs. La distinction entre les domaines pour plusieurs serveurs n'est importante que si plusieurs serveurs desservent la même interface et ont besoin d'un ensemble d'autorisations différent dans leurs implémentations. Dans toutes ces macros, hal_foo n'est pas un objet sepolicy. Au lieu de cela, ce jeton est utilisé par ces macros pour faire référence au groupe d'attributs associés à une paire client-serveur.

Toutefois, jusqu'à présent, hal_foo_service et hal_foo (la paire d'attributs de hal_attribute(foo)) ne sont pas associés. Un attribut HAL est associé aux services HAL AIDL à l'aide de la macro hal_attribute_service (les HAL HIDL utilisent la macro hal_attribute_hwservice), par exemple, hal_attribute_service(hal_foo, hal_foo_service). Cela signifie que les processus hal_foo_client peuvent accéder au HAL, et que les processus hal_foo_server peuvent enregistrer le HAL. L'application de ces règles d'enregistrement est effectuée par le gestionnaire de contexte (servicemanager).

Les noms de service ne correspondent pas toujours aux attributs HAL, par exemple hal_attribute_service(hal_foo, hal_foo2_service). En général, comme cela implique que les services sont toujours utilisés ensemble, vous pouvez supprimer hal_foo2_service et utiliser hal_foo_service pour tous les contextes de service. Lorsque les HAL définissent plusieurs instances hal_attribute_service, c'est parce que le nom d'attribut HAL d'origine n'est pas assez général et ne peut pas être modifié.

En résumé, voici à quoi ressemble un HAL d'exemple :

    public/attributes:
    // define hal_foo, hal_foo_client, hal_foo_server
    hal_attribute(foo)

    public/service.te
    // define hal_foo_service
    type hal_foo_service, hal_service_type, protected_service, service_manager_type

    public/hal_foo.te:
    // allow binder connection from client to server
    binder_call(hal_foo_client, hal_foo_server)
    // allow client to find the service, allow server to register the service
    hal_attribute_service(hal_foo, hal_foo_service)
    // allow binder communication from server to service_manager
    binder_use(hal_foo_server)

    private/service_contexts:
    // bind an AIDL service name to the selinux type
    android.hardware.foo.IFooXxxx/default u:object_r:hal_foo_service:s0

    private/<some_domain>.te:
    // let this domain use the hal service
    binder_use(some_domain)
    hal_client_domain(some_domain, hal_foo)

    vendor/<some_hal_server_domain>.te
    // let this domain serve the hal service
    hal_server_domain(some_hal_server_domain, hal_foo)

Interfaces d'extension associées

Une extension peut être associée à n'importe quelle interface binder, qu'il s'agisse d'une interface de niveau supérieur enregistrée directement auprès du gestionnaire de services ou d'une sous-interface. Lorsque vous obtenez une extension, vous devez vérifier que son type est celui attendu. Vous ne pouvez définir des extensions qu'à partir du processus qui dessert un binder.

Utilisez des extensions associées chaque fois qu'une extension modifie la fonctionnalité d'un HAL existant. Lorsqu'une fonctionnalité entièrement nouvelle est nécessaire, ce mécanisme n'est pas nécessaire et vous pouvez enregistrer une interface d'extension directement auprès du gestionnaire de services. Les interfaces d'extension associées sont plus utiles lorsqu'elles sont associées à des sous-interfaces, car ces hiérarchies peuvent être profondes ou multi-instances. L'utilisation d'une extension globale pour refléter la hiérarchie d'interface binder d'un autre service nécessite une comptabilité étendue pour fournir des fonctionnalités équivalentes aux extensions directement associées.

Pour définir une extension sur un binder, utilisez les API suivantes :

  • Backend NDK : AIBinder_setExtension
  • Backend Java : android.os.Binder.setExtension
  • Backend CPP : android::Binder::setExtension
  • Backend Rust : binder::Binder::set_extension

Pour obtenir une extension sur un binder, utilisez les API suivantes :

  • Backend NDK : AIBinder_getExtension
  • Backend Java : android.os.IBinder.getExtension
  • Backend CPP : android::IBinder::getExtension
  • Backend Rust : binder::Binder::get_extension

Pour en savoir plus sur ces API, consultez la documentation de la fonction getExtension dans le backend correspondant. Vous trouverez un exemple d'utilisation des extensions dans hardware/interfaces/tests/extension/vibrator.

Principales différences entre AIDL et HIDL

Lorsque vous utilisez des HAL AIDL ou des interfaces HAL AIDL, tenez compte des différences par rapport à l'écriture de HAL HIDL.

  • La syntaxe du langage AIDL est plus proche de Java. La syntaxe HIDL est semblable à C++.
  • Toutes les interfaces AIDL ont des états d'erreur intégrés. Au lieu de créer des types d'état personnalisés, créez des entiers d'état constants dans les fichiers d'interface et utilisez EX_SERVICE_SPECIFIC dans les backends CPP et NDK, et ServiceSpecificException dans le backend Java. Consultez Gestion des erreurs.
  • AIDL ne démarre pas automatiquement les pools de threads lorsque des objets binder sont envoyés. Vous devez les démarrer manuellement (voir Gestion des threads).
  • AIDL n'abandonne pas les erreurs de transport non vérifiées (HIDL Return abandonne les erreurs non vérifiées).
  • AIDL ne peut déclarer qu'un seul type par fichier.
  • Les arguments AIDL peuvent être spécifiés comme in, out ou inout en plus du paramètre de sortie (il n'y a pas de rappels synchrones).
  • AIDL utilise fd comme type primitif au lieu de handle.
  • HIDL utilise des versions majeures pour les modifications incompatibles et des versions mineures pour les modifications compatibles. Dans AIDL, les modifications rétrocompatibles sont effectuées sur place. AIDL n'a pas de concept explicite de versions majeures. Au lieu de cela, il est intégré aux noms de packages. Par exemple, AIDL peut utiliser le nom de package bluetooth2.
  • AIDL n'hérite pas de la priorité en temps réel par défaut. La fonction setInheritRt doit être utilisée par binder pour activer l'héritage de la priorité en temps réel.

Tests pour les HAL

Cette section décrit les bonnes pratiques pour tester les HAL. Ces pratiques sont valides même si le test d'intégration de votre HAL ne se trouve pas dans VTS.

Android s'appuie sur VTS pour vérifier les implémentations HAL attendues. VTS permet de s'assurer qu'Android peut être rétrocompatible avec les anciennes implémentations de fournisseurs. Les implémentations qui échouent à VTS présentent des problèmes de compatibilité connus qui pourraient les empêcher de fonctionner avec les futures versions du système d'exploitation.

VTS comporte deux parties principales pour les HAL.

1. Vérifier que les HAL de l'appareil sont connus et attendus par Android

Android s'appuie sur une liste statique et précise de tous les HAL installés. Cette liste est exprimée dans le fichier manifeste VINTF. Des tests spéciaux à l'échelle de la plate-forme vérifient l'intégrité des couches HAL dans l'ensemble du système. Avant d'écrire des tests spécifiques à un HAL, vous devez également exécuter ces tests, car ils peuvent indiquer si un HAL présente des configurations VINTF incohérentes.

Cet ensemble de tests se trouve dans test/vts-testcase/hal/treble/vintf. Si vous travaillez sur une implémentation HAL de fournisseur, utilisez vts_treble_vintf_vendor_test pour la vérifier. Vous pouvez exécuter ce test avec la commande atest vts_treble_vintf_vendor_test.

Ces tests sont chargés de vérifier les points suivants :

  • Chaque interface @VintfStability déclarée dans un fichier manifeste VINTF est figée dans une version publiée connue. Cela permet de vérifier que les deux côtés de l'interface s'accordent sur la définition exacte de cette version de l'interface. Cela est nécessaire pour le fonctionnement de base.
  • Tous les HAL déclarés dans un fichier manifeste VINTF sont disponibles sur cet appareil. Tout client disposant des autorisations suffisantes pour utiliser un service HAL déclaré doit pouvoir obtenir et utiliser ces services à tout moment.
  • Tous les HAL déclarés dans un fichier manifeste VINTF desservent la version de l'interface qu'ils déclarent dans le fichier manifeste.
  • Aucun HAL obsolète n'est desservi sur un appareil. Android abandonne la compatibilité avec les versions inférieures des interfaces HAL, comme décrit dans Cycle de vie FCM.
  • Les HAL requis sont présents sur l'appareil. Certains HAL sont nécessaires au bon fonctionnement d'Android.

2. Vérifier le comportement attendu de chaque HAL

Chaque interface HAL possède ses propres tests VTS pour vérifier le comportement attendu de ses clients. Les cas de test s'exécutent sur chaque instance d'une interface HAL déclarée et appliquent un comportement spécifique en fonction de la version de l'interface implémentée.

En C++, vous pouvez obtenir la liste de tous les HAL installés sur le système avec la fonction android::getAidlHalInstanceNames dans libaidlvintf_gtest_helper. Dans Rust, utilisez binder::get_declared_instances.

Ces tests tentent de couvrir tous les aspects de l'implémentation HAL sur lesquels le framework Android s'appuie ou pourrait s'appuyer à l'avenir.

Ces tests incluent la vérification de la compatibilité des fonctionnalités, la gestion des erreurs et tout autre comportement qu'un client peut attendre du service.

Jalons VTS pour le développement HAL

Les tests VTS (ou tout autre test) doivent être tenus à jour lors de la création ou de la modification des interfaces HAL d'Android.

Les tests VTS doivent être terminés et prêts à vérifier les implémentations des fournisseurs avant d'être figés pour les versions de l'API Android Vendor. Ils doivent être prêts avant que les interfaces ne soient figées afin que les développeurs puissent créer leurs implémentations, les vérifier et fournir des commentaires aux développeurs d'interfaces HAL.

Tester sur Cuttlefish

Lorsque le matériel n'est pas disponible, Android utilise Cuttlefish comme véhicule de développement pour les interfaces HAL. Cela permet de tester l'intégration d'Android de manière évolutive.

Les tests hal_implementation_test vérifient que Cuttlefish dispose d'implémentations des dernières versions d'interface HAL pour s'assurer qu'Android est prêt à gérer les nouvelles interfaces et que les tests VTS sont prêts à tester les nouvelles implémentations de fournisseurs dès que de nouveaux matériels et appareils sont disponibles.