Un backend AIDL est une cible pour la génération de code bouchon. Lorsque vous utilisez des fichiers AIDL, vous les utilisez toujours dans un langage particulier avec un environnement d'exécution spécifique. Selon le contexte, vous devez utiliser différents backends AIDL.
Dans le tableau suivant, la stabilité de la surface de l'API fait référence à la capacité de compiler du code sur cette surface d'API de manière à ce qu'il puisse être diffusé indépendamment du binaire system.img
libbinder.so
.
AIDL comporte les backends suivants:
Backend | Langue | Surface de l'API | Créer des systèmes |
---|---|---|---|
Java | Java | SDK/SystemApi (stable*) | tous |
NDK | C++ | libbinder_ndk (stable*) | interface_idl |
CPA | C++ | libbinder (instable) | tous |
Rust | Rust | libbinder_rs (stable*) | interface_idl |
- Ces surfaces d'API sont stables, mais de nombreuses API, telles que celles de gestion des services, sont réservées à une utilisation interne à la plate-forme et ne sont pas disponibles pour les applications. Pour en savoir plus sur l'utilisation d'AIDL dans les applications, consultez la documentation pour les développeurs.
- Le backend Rust a été introduit dans Android 12. Le backend du NDK est disponible à partir d'Android 10.
- La caisse Rust est construite sur
libbinder_ndk
, ce qui lui permet d'être stable et portable. Les apex utilisent la caisse de liaison de la même manière que toute autre personne du côté du système. La partie Rust est intégrée dans un APEX et expédiée à l'intérieur. Cela dépend delibbinder_ndk.so
sur la partition système.
Créer des systèmes
Selon le backend, il existe deux façons de compiler AIDL en code bouchon. Pour en savoir plus sur les systèmes de compilation, consultez la documentation de référence du module Soong.
Système de compilation principal
Dans n'importe quel module Android.bp cc_
ou java_
(ou dans leurs équivalents Android.mk
), les fichiers .aidl
peuvent être spécifiés en tant que fichiers sources. Dans ce cas, les backends Java/CPP d'AIDL sont utilisés (et non le backend NDK), et les classes permettant d'utiliser les fichiers AIDL correspondants sont automatiquement ajoutées au module. Des options telles que local_include_dirs
, qui indiquent au système de compilation le chemin d'accès racine aux fichiers AIDL de ce module peuvent être spécifiés dans ces modules sous un groupe aidl:
. Notez que le backend Rust ne doit être utilisé qu'avec Rust. Les modules rust_
sont gérés différemment dans la mesure où les fichiers AIDL ne sont pas spécifiés en tant que fichiers sources.
À la place, le module aidl_interface
génère un rustlib
appelé <aidl_interface name>-rust
qui peut être associé. Pour en savoir plus, consultez l'exemple Rust AIDL.
interface_idl
Les types utilisés avec ce système de compilation doivent être structurés. Pour être structurées, les parcelles doivent contenir des champs directement et ne doivent pas être des déclarations de types définis directement dans les langues cibles. Pour découvrir comment AIDL structuré s'intègre à AIDL stable, consultez AIDL structuré et stable.
Types
Vous pouvez considérer le compilateur aidl
comme implémentation de référence pour les types.
Lorsque vous créez une interface, appelez aidl --lang=<backend> ...
pour afficher le fichier d'interface obtenu. Lorsque vous utilisez le module aidl_interface
, vous pouvez afficher la sortie dans out/soong/.intermediates/<path to module>/
.
Type Java/AIDL | Type C++ | Type de NDK | Type de rouille |
---|---|---|---|
booléen | Booléen | Booléen | Booléen |
octet | int8_t | int8_t | i8 |
car. | car16_t | car16_t | U16 |
int | int32_t | int32_t | i32 |
long | Int64_t | Int64_t | I64 |
float | float | float | F32 |
double | double | double | F64 |
Chaîne | android::String16 | std::chaîne | Chaîne |
android.os.Parcelable (parcelable) | android::Parcelable (Parcelable) | N/A | N/A |
IBinder | android::IBinder | ndk::SpAIBinder | binder::SpIBinder |
M[] | std::vecteur<T> | std::vecteur<T> | Entrée: &[T] Sortie: Vec<T> |
byte[] | std::vecteur<uint8_t> | std::vecteur<int8_t>1 | Entrée: &[u8] Sortie: Vec<u8> |
Liste<T> | std::vecteur<T>2 | std::vecteur<T>3 | Entrée: &[T]4 Sortie: Vec<T> |
FileDescriptor | android::base::unique_fd | N/A | binder::parcel::ParcelFileDescriptor |
ParcelFileDescriptor | android::os::ParcelFileDescriptor | ndk::ScopedFileDescriptor | binder::parcel::ParcelFileDescriptor |
type d'interface (T) | android::sp<T> | std::shared_ptr<T>7 | binder::Forte |
type parcelable (T) | T | T | T |
Type d'union (T)5 | T | T | T |
V[N] 6 | std::tableau<T, N> | std::tableau<T, N> | [T; N] |
1. Sous Android 12 ou version ultérieure, les tableaux d'octets utilisent uint8_t au lieu de int8_t pour des raisons de compatibilité.
2. Le backend C++ accepte List<T>
, où T
est l'un des éléments suivants : String
, IBinder
, ParcelFileDescriptor
ou parcelable. Dans Android 13 ou version ultérieure, T
peut correspondre à n'importe quel type non primitif (y compris les types d'interface), à l'exception des tableaux. AOSP vous recommande d'utiliser des types de tableaux tels que T[]
, car ils fonctionnent dans tous les backends.
3. Le backend du NDK accepte List<T>
, où T
correspond à String
, ParcelFileDescriptor
ou parcelable. Sous Android 13 ou version ultérieure, T
peut correspondre à n'importe quel type non primitif, à l'exception des tableaux.
4. Les types sont transmis différemment pour le code Rust selon qu'il s'agit d'une entrée (un argument) ou d'une sortie (une valeur renvoyée).
5. Les types d'union sont compatibles avec Android 12 ou version ultérieure.
6. Sous Android 13 ou version ultérieure, les tableaux de taille fixe sont compatibles. Les tableaux à taille fixe peuvent avoir plusieurs dimensions (par exemple, int[3][4]
). Dans le backend Java, les tableaux de taille fixe sont représentés par des types de tableaux.
7. Pour instancier un objet de liaison SharedRefBase
, utilisez SharedRefBase::make\<My\>(... args ...)
. Cette fonction crée un objet std::shared_ptr\<T\>
qui est également géré en interne, au cas où la liaison appartient à un autre processus. Lorsque vous créez l'objet d'une autre manière, la propriété est double.
Direction (entrée/sortie/entrée)
Lorsque vous spécifiez les types d'arguments des fonctions, vous pouvez les spécifier comme in
, out
ou inout
. Cela contrôle la direction dans laquelle les informations
sont transmises pour un appel IPC. in
est l'orientation par défaut et indique que les données sont transmises de l'appelant à l'appelé. out
signifie que les données sont transmises de l'appelé à l'appelant. inout
est la combinaison des deux. Toutefois, l'équipe Android vous recommande d'éviter d'utiliser le spécificateur d'argument inout
.
Si vous utilisez inout
avec une interface avec gestion des versions et un appel plus ancien, les champs supplémentaires qui ne sont présents que dans l'appelant sont réinitialisés à leurs valeurs par défaut. En ce qui concerne Rust, un type inout
normal reçoit &mut Vec<T>
et un type de liste inout
reçoit &mut Vec<T>
.
interface IRepeatExamples {
MyParcelable RepeatParcelable(MyParcelable token); // implicitly 'in'
MyParcelable RepeatParcelableWithIn(in MyParcelable token);
void RepeatParcelableWithInAndOut(in MyParcelable param, out MyParcelable result);
void RepeatParcelableWithInOut(inout MyParcelable param);
}
UTF-8/UTF-16
Avec le backend CPP, vous pouvez choisir si les chaînes sont utf-8 ou utf-16. Déclarez les chaînes en tant que @utf8InCpp String
dans AIDL pour les convertir automatiquement en utf-8.
Les backends NDK et Rust utilisent toujours des chaînes utf-8. Pour en savoir plus sur l'annotation utf8InCpp
, consultez la section Annotations dans AIDL.
Possibilité de valeur nulle
Vous pouvez annoter des types qui peuvent être nuls dans le backend Java avec @nullable
pour exposer les valeurs nulles aux backends CPP et NDK. Dans le backend Rust, ces types @nullable
sont exposés en tant que Option<T>
. Par défaut, les serveurs natifs rejettent les valeurs nulles. Les seules exceptions à cette règle sont les types interface
et IBinder
, qui peuvent toujours être nuls pour les lectures du NDK et les écritures CPP/NDK. Pour en savoir plus sur l'annotation nullable
, consultez la section Annotations dans AIDL.
Parcelables personnalisés
Un parcelable personnalisé est un élément parcelable implémenté manuellement dans un backend cible. Utilisez des parcelables personnalisés uniquement si vous essayez d'ajouter une prise en charge dans d'autres langues pour un parcelable personnalisé existant qui ne peut pas être modifié.
Pour déclarer une parcelle personnalisée afin d'en informer AIDL, la déclaration AIDL de ce type se présente comme suit:
package my.pack.age;
parcelable Foo;
Par défaut, cela déclare un parcelable Java, où my.pack.age.Foo
est une classe Java qui implémente l'interface Parcelable
.
Pour déclarer un backend CPP personnalisé parcelable dans AIDL, utilisez cpp_header
:
package my.pack.age;
parcelable Foo cpp_header "my/pack/age/Foo.h";
L'implémentation C++ dans my/pack/age/Foo.h
se présente comme suit:
#include <binder/Parcelable.h>
class MyCustomParcelable : public android::Parcelable {
public:
status_t writeToParcel(Parcel* parcel) const override;
status_t readFromParcel(const Parcel* parcel) override;
std::string toString() const;
friend bool operator==(const MyCustomParcelable& lhs, const MyCustomParcelable& rhs);
friend bool operator!=(const MyCustomParcelable& lhs, const MyCustomParcelable& rhs);
};
Pour déclarer un NDK personnalisé parcelable dans AIDL, utilisez ndk_header
:
package my.pack.age;
parcelable Foo ndk_header "android/pack/age/Foo.h";
L'implémentation du NDK dans android/pack/age/Foo.h
se présente comme suit:
#include <android/binder_parcel.h>
class MyCustomParcelable {
public:
binder_status_t writeToParcel(AParcel* _Nonnull parcel) const;
binder_status_t readFromParcel(const AParcel* _Nonnull parcel);
std::string toString() const;
friend bool operator==(const MyCustomParcelable& lhs, const MyCustomParcelable& rhs);
friend bool operator!=(const MyCustomParcelable& lhs, const MyCustomParcelable& rhs);
};
Dans Android 15 (expérimental AOSP), pour la déclaration d'un parcelable Rust personnalisé dans AIDL, utilisez rust_type
:
package my.pack.age;
@RustOnlyStableParcelable parcelable Foo rust_type "rust_crate::Foo";
L'implémentation de Rust dans rust_crate/src/lib.rs
se présente comme suit:
use binder::{
binder_impl::{BorrowedParcel, UnstructuredParcelable},
impl_deserialize_for_unstructured_parcelable, impl_serialize_for_unstructured_parcelable,
StatusCode,
};
#[derive(Clone, Debug, Eq, PartialEq)]
struct Foo {
pub bar: String,
}
impl UnstructuredParcelable for Foo {
fn write_to_parcel(&self, parcel: &mut BorrowedParcel) -> Result<(), StatusCode> {
parcel.write(&self.bar)?;
Ok(())
}
fn from_parcel(parcel: &BorrowedParcel) -> Result<Self, StatusCode> {
let bar = parcel.read()?;
Ok(Self { bar })
}
}
impl_deserialize_for_unstructured_parcelable!(Foo);
impl_serialize_for_unstructured_parcelable!(Foo);
Vous pouvez ensuite utiliser ce fragmentable en tant que type dans les fichiers AIDL, mais il ne sera pas généré par AIDL. Indiquez les opérateurs <
et ==
pour les parcelables personnalisés de backend CPP/NDK afin de les utiliser dans union
.
Valeurs par défaut
Les parcelables structurés peuvent déclarer des valeurs par défaut par champ pour les primitives, les String
et les tableaux de ces types.
parcelable Foo {
int numField = 42;
String stringField = "string value";
char charValue = 'a';
...
}
Dans le backend Java, lorsque des valeurs par défaut sont manquantes, les champs sont initialisés sur une valeur nulle pour les types primitifs et sur null
pour les types non primitifs.
Dans d'autres backends, les champs sont initialisés avec des valeurs initialisées par défaut lorsque ces valeurs ne sont pas définies. Par exemple, dans le backend C++, les champs String
sont initialisés en tant que chaîne vide et les champs List<T>
sont initialisés en tant que vector<T>
vide. Les champs @nullable
sont initialisés en tant que champs de valeur nulle.
Gestion des exceptions
L'OS Android fournit des types d'erreurs intégrés que les services peuvent utiliser lorsqu'ils signalent des erreurs. Ceux-ci sont utilisés par la liaison et peuvent être utilisés par tout service mettant en œuvre une interface de liaison. Leur utilisation est bien documentée dans la définition AIDL et ne nécessite aucun statut ni type renvoyé défini par l'utilisateur.
Paramètres de sortie comportant des erreurs
Lorsqu'une fonction AIDL signale une erreur, elle ne peut pas initialiser ni modifier les paramètres de sortie. Plus précisément, les paramètres de sortie peuvent être modifiés si l'erreur se produit lors du décodage, et non lors du traitement de la transaction elle-même. En général, lorsqu'une fonction AIDL génère une erreur, tous les paramètres inout
et out
ainsi que la valeur renvoyée (qui agit comme un paramètre out
dans certains backends) doivent être considérés comme étant indéfinis.
Valeurs d'erreur à utiliser
La plupart des valeurs d'erreur intégrées peuvent être utilisées dans n'importe quelle interface AIDL, mais certaines sont traitées d'une manière spéciale. Par exemple, EX_UNSUPPORTED_OPERATION
et EX_ILLEGAL_ARGUMENT
peuvent être utilisés lorsqu'ils décrivent la condition d'erreur, mais EX_TRANSACTION_FAILED
ne doit pas être utilisé, car il est traité de manière particulière par l'infrastructure sous-jacente. Consultez les définitions spécifiques au backend pour en savoir plus sur ces valeurs intégrées.
Si l'interface AIDL nécessite des valeurs d'erreur supplémentaires qui ne sont pas couvertes par les types d'erreurs intégrés, vous pouvez utiliser l'erreur intégrée spécifique au service qui permet d'inclure une valeur d'erreur spécifique au service définie par l'utilisateur. Ces erreurs spécifiques au service sont généralement définies dans l'interface AIDL en tant que enum
s'appuyant sur const int
ou int
, et ne sont pas analysées par la liaison.
En Java, les erreurs sont mappées à des exceptions, telles que android.os.RemoteException
. Pour les exceptions spécifiques au service, Java utilise android.os.ServiceSpecificException
avec l'erreur définie par l'utilisateur.
Le code natif dans Android n'utilise pas d'exceptions. Le backend CPP utilise android::binder::Status
. Le backend du NDK utilise ndk::ScopedAStatus
. Chaque méthode générée par AIDL renvoie l'une de ces valeurs, représentant l'état de la méthode. Le backend Rust utilise les mêmes valeurs de code d'exception que le NDK, mais les convertit en erreurs Rust natives (StatusCode
, ExceptionCode
) avant de les transmettre à l'utilisateur. Pour les erreurs spécifiques au service, l'élément Status
ou ScopedAStatus
renvoyé utilise EX_SERVICE_SPECIFIC
en plus de l'erreur définie par l'utilisateur.
Les types d'erreurs intégrés se trouvent dans les fichiers suivants:
Backend | Définition |
---|---|
Java | android/os/Parcel.java |
CPA | binder/Status.h |
NDK | android/binder_status.h |
Rust | android/binder_status.h |
Utiliser différents backends
Ces instructions sont spécifiques au code de la plate-forme Android. Ces exemples utilisent un type défini, my.package.IFoo
. Pour savoir comment utiliser le backend Rust, consultez l'exemple Rust AIDL sur la page Android Rust Patterns.
Types d'importation
Que le type défini soit une interface, un parcelable ou une union, vous pouvez l'importer en Java:
import my.package.IFoo;
Ou dans le backend CPP:
#include <my/package/IFoo.h>
Ou dans le backend du NDK (notez l'espace de noms aidl
supplémentaire):
#include <aidl/my/package/IFoo.h>
Ou dans le backend Rust:
use my_package::aidl::my::package::IFoo;
Bien que vous puissiez importer un type imbriqué en Java, vous devez inclure l'en-tête pour son type racine dans les backends CPP/NDK. Par exemple, lorsque vous importez un type imbriqué Bar
défini dans my/package/IFoo.aidl
(IFoo
est le type racine du fichier), vous devez inclure <my/package/IFoo.h>
pour le backend CPP (ou <aidl/my/package/IFoo.h>
pour le backend NDK).
Implémenter des services
Pour implémenter un service, vous devez hériter de la classe bouchon native. Cette classe lit les commandes du pilote de liaison et exécute les méthodes que vous mettez en œuvre. Imaginez que vous avez un fichier AIDL comme celui-ci:
package my.package;
interface IFoo {
int doFoo();
}
En Java, vous devez étendre à partir de cette classe:
import my.package.IFoo;
public class MyFoo extends IFoo.Stub {
@Override
int doFoo() { ... }
}
Dans le backend CPP:
#include <my/package/BnFoo.h>
class MyFoo : public my::package::BnFoo {
android::binder::Status doFoo(int32_t* out) override;
}
Dans le backend du NDK (notez l'espace de noms aidl
supplémentaire):
#include <aidl/my/package/BnFoo.h>
class MyFoo : public aidl::my::package::BnFoo {
ndk::ScopedAStatus doFoo(int32_t* out) override;
}
Dans le backend Rust:
use aidl_interface_name::aidl::my::package::IFoo::{BnFoo, IFoo};
use binder;
/// This struct is defined to implement IRemoteService AIDL interface.
pub struct MyFoo;
impl Interface for MyFoo {}
impl IFoo for MyFoo {
fn doFoo(&self) -> binder::Result<()> {
...
Ok(())
}
}
Ou avec Async Rust:
use aidl_interface_name::aidl::my::package::IFoo::{BnFoo, IFooAsyncServer};
use binder;
/// This struct is defined to implement IRemoteService AIDL interface.
pub struct MyFoo;
impl Interface for MyFoo {}
#[async_trait]
impl IFooAsyncServer for MyFoo {
async fn doFoo(&self) -> binder::Result<()> {
...
Ok(())
}
}
S'inscrire et obtenir des services
Les services de la plate-forme Android sont généralement enregistrés avec le processus servicemanager
. En plus des API ci-dessous, certaines d'entre elles vérifient le service (c'est-à-dire qu'elles sont renvoyées immédiatement si le service n'est pas disponible).
Pour en savoir plus, consultez l'interface servicemanager
correspondante. Ces opérations ne peuvent être effectuées que lors de la compilation sur la plate-forme Android.
En Java:
import android.os.ServiceManager;
// registering
ServiceManager.addService("service-name", myService);
// return if service is started now
myService = IFoo.Stub.asInterface(ServiceManager.checkService("service-name"));
// waiting until service comes up (new in Android 11)
myService = IFoo.Stub.asInterface(ServiceManager.waitForService("service-name"));
// waiting for declared (VINTF) service to come up (new in Android 11)
myService = IFoo.Stub.asInterface(ServiceManager.waitForDeclaredService("service-name"));
Dans le backend CPP:
#include <binder/IServiceManager.h>
// registering
defaultServiceManager()->addService(String16("service-name"), myService);
// return if service is started now
status_t err = checkService<IFoo>(String16("service-name"), &myService);
// waiting until service comes up (new in Android 11)
myService = waitForService<IFoo>(String16("service-name"));
// waiting for declared (VINTF) service to come up (new in Android 11)
myService = waitForDeclaredService<IFoo>(String16("service-name"));
Dans le backend du NDK (notez l'espace de noms aidl
supplémentaire):
#include <android/binder_manager.h>
// registering
binder_exception_t err = AServiceManager_addService(myService->asBinder().get(), "service-name");
// return if service is started now
myService = IFoo::fromBinder(ndk::SpAIBinder(AServiceManager_checkService("service-name")));
// is a service declared in the VINTF manifest
// VINTF services have the type in the interface instance name.
bool isDeclared = AServiceManager_isDeclared("android.hardware.light.ILights/default");
// wait until a service is available (if isDeclared or you know it's available)
myService = IFoo::fromBinder(ndk::SpAIBinder(AServiceManager_waitForService("service-name")));
Dans le backend Rust:
use myfoo::MyFoo;
use binder;
use aidl_interface_name::aidl::my::package::IFoo::BnFoo;
fn main() {
binder::ProcessState::start_thread_pool();
// [...]
let my_service = MyFoo;
let my_service_binder = BnFoo::new_binder(
my_service,
BinderFeatures::default(),
);
binder::add_service("myservice", my_service_binder).expect("Failed to register service?");
// Does not return - spawn or perform any work you mean to do before this call.
binder::ProcessState::join_thread_pool()
}
Dans le backend Rust asynchrone, avec un environnement d'exécution à thread unique:
use myfoo::MyFoo;
use binder;
use binder_tokio::TokioRuntime;
use aidl_interface_name::aidl::my::package::IFoo::BnFoo;
#[tokio::main(flavor = "current_thread")]
async fn main() {
binder::ProcessState::start_thread_pool();
// [...]
let my_service = MyFoo;
let my_service_binder = BnFoo::new_async_binder(
my_service,
TokioRuntime(Handle::current()),
BinderFeatures::default(),
);
binder::add_service("myservice", my_service_binder).expect("Failed to register service?");
// Sleeps forever, but does not join the binder threadpool.
// Spawned tasks will run on this thread.
std::future::pending().await
}
Une différence importante par rapport aux autres options est que nous n'appelons pas join_thread_pool
lorsque vous utilisez Rust asynchrone et un environnement d'exécution à thread unique. En effet, vous devez fournir à Tokio un thread lui permettant d'exécuter les tâches générées. Dans cet exemple, le thread principal remplit cette fonction. Toutes les tâches générées à l'aide de tokio::spawn
s'exécutent sur le thread principal.
Dans le backend Rust asynchrone, avec un environnement d'exécution multithread:
use myfoo::MyFoo;
use binder;
use binder_tokio::TokioRuntime;
use aidl_interface_name::aidl::my::package::IFoo::BnFoo;
#[tokio::main(flavor = "multi_thread", worker_threads = 2)]
async fn main() {
binder::ProcessState::start_thread_pool();
// [...]
let my_service = MyFoo;
let my_service_binder = BnFoo::new_async_binder(
my_service,
TokioRuntime(Handle::current()),
BinderFeatures::default(),
);
binder::add_service("myservice", my_service_binder).expect("Failed to register service?");
// Sleep forever.
tokio::task::block_in_place(|| {
binder::ProcessState::join_thread_pool();
});
}
Avec l'environnement d'exécution multithread Tokio, les tâches générées ne s'exécutent pas sur le thread principal. Par conséquent, il est plus logique d'appeler join_thread_pool
sur le thread principal afin que celui-ci ne soit pas simplement inactif. Vous devez encapsuler l'appel dans block_in_place
pour quitter le contexte asynchrone.
Lien vers la mort
Vous pouvez demander à recevoir une notification lorsqu'un service hébergeant une liaison meurt. Cela peut permettre d'éviter les fuites de proxys de rappel ou de faciliter la récupération des erreurs. Effectuez ces appels sur des objets proxy de liaison.
- En Java, utilisez
android.os.IBinder::linkToDeath
. - Dans le backend CPP, utilisez
android::IBinder::linkToDeath
. - Dans le backend du NDK, utilisez
AIBinder_linkToDeath
. - Dans le backend Rust, créez un objet
DeathRecipient
, puis appelezmy_binder.link_to_death(&mut my_death_recipient)
. Étant donné queDeathRecipient
possède le rappel, vous devez conserver cet objet actif aussi longtemps que vous souhaitez recevoir des notifications.
Informations sur l'appelant
Lors de la réception d'un appel de liaison du noyau, les informations sur l'appelant sont disponibles dans plusieurs API. Le PID (ou ID de processus) fait référence à l'ID de processus Linux du processus qui envoie une transaction. L'UID (ou User ID) fait référence à l'ID utilisateur Linux. Lors de la réception d'un appel à sens unique, le PID d'appel est de 0. En dehors d'un contexte de transaction de liaison, ces fonctions renvoient le PID et l'UID du processus en cours.
Dans le backend Java:
... = Binder.getCallingPid();
... = Binder.getCallingUid();
Dans le backend CPP:
... = IPCThreadState::self()->getCallingPid();
... = IPCThreadState::self()->getCallingUid();
Dans le backend du NDK:
... = AIBinder_getCallingPid();
... = AIBinder_getCallingUid();
Dans le backend Rust, lors de l'implémentation de l'interface, spécifiez les éléments suivants (au lieu d'autoriser les valeurs par défaut):
... = ThreadState::get_calling_pid();
... = ThreadState::get_calling_uid();
Rapports de bugs et API de débogage pour les services
Lorsque les rapports de bug sont exécutés (par exemple, avec adb bugreport
), ils collectent des informations de l'ensemble du système pour faciliter le débogage de divers problèmes.
Pour les services AIDL, les rapports de bug utilisent le binaire dumpsys
sur tous les services enregistrés auprès du gestionnaire de services afin de vider leurs informations dans le rapport de bug. Vous pouvez également utiliser dumpsys
sur la ligne de commande pour obtenir des informations auprès d'un service à l'aide de dumpsys SERVICE [ARGS]
. Dans les backends C++ et Java, vous pouvez contrôler l'ordre dans lequel les services sont vidés en utilisant des arguments supplémentaires dans addService
. Vous pouvez également utiliser dumpsys --pid SERVICE
pour obtenir le PID d'un service lors du débogage.
Pour ajouter une sortie personnalisée à votre service, vous pouvez remplacer la méthode dump
dans votre objet serveur comme vous implémentez toute autre méthode d'IPC définie dans un fichier AIDL. Vous devez alors limiter le vidage à l'autorisation android.permission.DUMP
de l'application ou limiter le vidage à des UID spécifiques.
Dans le backend Java:
@Override
protected void dump(@NonNull FileDescriptor fd, @NonNull PrintWriter fout,
@Nullable String[] args) {...}
Dans le backend CPP:
status_t dump(int, const android::android::Vector<android::String16>&) override;
Dans le backend du NDK:
binder_status_t dump(int fd, const char** args, uint32_t numArgs) override;
Dans le backend Rust, lors de l'implémentation de l'interface, spécifiez les éléments suivants (au lieu d'autoriser les valeurs par défaut):
fn dump(&self, mut file: &File, args: &[&CStr]) -> binder::Result<()>
Obtenir dynamiquement le descripteur de l'interface
Le descripteur d'interface identifie le type d'une interface. Cela est utile lors du débogage ou en cas de liaison inconnue.
En Java, vous pouvez obtenir le descripteur d'interface avec un code tel que:
service = /* get ahold of service object */
... = service.asBinder().getInterfaceDescriptor();
Dans le backend CPP:
service = /* get ahold of service object */
... = IInterface::asBinder(service)->getInterfaceDescriptor();
Le NDK et les backends Rust ne sont pas compatibles avec cette fonctionnalité.
Obtenir le descripteur d'interface de manière statique
Parfois (par exemple, lors de l'enregistrement de services @VintfStability
), vous devez savoir ce qu'est le descripteur d'interface de manière statique. En Java, vous pouvez obtenir le descripteur en ajoutant du code tel que:
import my.package.IFoo;
... IFoo.DESCRIPTOR
Dans le backend CPP:
#include <my/package/BnFoo.h>
... my::package::BnFoo::descriptor
Dans le backend du NDK (notez l'espace de noms aidl
supplémentaire):
#include <aidl/my/package/BnFoo.h>
... aidl::my::package::BnFoo::descriptor
Dans le backend Rust:
aidl::my::package::BnFoo::get_descriptor()
Plage d'énumération
Dans les backends natifs, vous pouvez itérer les valeurs possibles d'une énumération. En raison des considérations liées à la taille du code, cela n'est pas pris en charge en Java.
Pour une énumération MyEnum
définie dans AIDL, l'itération est fournie comme suit.
Dans le backend CPP:
::android::enum_range<MyEnum>()
Dans le backend du NDK:
::ndk::enum_range<MyEnum>()
Dans le backend Rust:
MyEnum::enum_values()
Gestion des threads
Chaque instance de libbinder
dans un processus gère un pool de threads. Dans la plupart des cas d'utilisation, il doit s'agir d'un seul pool de threads, partagé entre tous les backends.
Seule exception : le code fournisseur peut charger une autre copie de libbinder
pour communiquer avec /dev/vndbinder
. Comme il s'agit d'un nœud de liaison distinct, le pool de threads n'est pas partagé.
Pour le backend Java, la taille du pool de threads ne peut qu'augmenter (car elle a déjà démarré):
BinderInternal.setMaxThreads(<new larger value>);
Pour le backend CPP, les opérations suivantes sont disponibles:
// set max threadpool count (default is 15)
status_t err = ProcessState::self()->setThreadPoolMaxThreadCount(numThreads);
// create threadpool
ProcessState::self()->startThreadPool();
// add current thread to threadpool (adds thread to max thread count)
IPCThreadState::self()->joinThreadPool();
De même, dans le backend du NDK:
bool success = ABinderProcess_setThreadPoolMaxThreadCount(numThreads);
ABinderProcess_startThreadPool();
ABinderProcess_joinThreadPool();
Dans le backend Rust:
binder::ProcessState::start_thread_pool();
binder::add_service("myservice", my_service_binder).expect("Failed to register service?");
binder::ProcessState::join_thread_pool();
Avec le backend Rust asynchrone, vous avez besoin de deux pools de threads: binder et Tokio.
Cela signifie que les applications utilisant Rust asynchrone nécessitent des considérations spéciales, en particulier lorsqu'il s'agit d'utiliser join_thread_pool
. Pour en savoir plus, consultez la section sur l'enregistrement des services.
Noms réservés
C++, Java et Rust réservent certains noms en tant que mots clés ou pour une utilisation spécifique à un langage. Bien qu'AIDL n'applique pas de restrictions basées sur les règles de langage, l'utilisation de noms de champs ou de types correspondant à un nom réservé peut entraîner un échec de compilation pour C++ ou Java. Pour Rust, le champ ou le type est renommé à l'aide de la syntaxe "identifiant brut", accessible à l'aide du préfixe r#
.
Dans la mesure du possible, nous vous recommandons d'éviter d'utiliser des noms réservés dans vos définitions AIDL afin d'éviter les liaisons non ergonomiques ou l'échec pur et simple de la compilation.
Si vous avez déjà des noms réservés dans vos définitions AIDL, vous pouvez renommer les champs en toute sécurité tout en restant compatible avec le protocole. Vous devrez peut-être mettre à jour votre code pour continuer à compiler, mais tous les programmes déjà créés continueront d'interagir.
Noms à éviter: