Backends de AIDL

Un backend de AIDL es un destino para la generación de código de stub. Cuando usas archivos AIDL, siempre los usas en un lenguaje en particular con un entorno de ejecución específico. Según el contexto, debes usar diferentes backends de AIDL.

En la siguiente tabla, la estabilidad de la plataforma de la API hace referencia a la capacidad de compilar código en esta plataforma de la API de manera que el código se pueda entregar de forma independiente del objeto binario libbinder.so de system.img.

AIDL tiene los siguientes backends:

Backend	Idioma	Plataforma de la API	Sistemas de compilación
Java	Java	SDK/SystemApi (estable*)	todos
NDK	C++	libbinder_ndk (estable*)	aidl_interface
CPP	C++	libbinder (inestable)	todos
Rust	Rust	libbinder_rs (estable*)	aidl_interface

• Estas plataformas de API son estables, pero muchas de ellas, como las de administración de servicios, están reservadas para el uso interno de la plataforma y no están disponibles para las apps. Para obtener más información sobre cómo usar AIDL en apps, consulta la documentación para desarrolladores.
• El backend de Rust se introdujo en Android 12. El backend de VNDK está disponible desde Android 10.
• El paquete de Rust se compila sobre libbinder_ndk, lo que le permite ser estable y portátil. Los APEX usan el paquete de Binder de la misma manera que cualquier otra persona del sistema. La parte de Rust se agrupa en un APEX y se envía dentro de él. Depende del libbinder_ndk.so en la partición del sistema.

Sistemas de compilación

Según el backend, hay dos maneras de compilar AIDL en código de stub. Para obtener más detalles sobre los sistemas de compilación, consulta la Referencia del módulo de Soong.

Sistema de compilación principal

En cualquier módulo Android.bp cc_ o java_ (o en sus equivalentes Android.mk), se pueden especificar archivos .aidl como archivos de origen. En este caso, se usan los backend de Java/CPP de AIDL (no el backend de NDK), y las clases para usar los archivos AIDL correspondientes se agregan al módulo automáticamente. En estos módulos, se pueden especificar opciones como local_include_dirs, que le indica al sistema de compilación la ruta de acceso raíz a los archivos AIDL en ese módulo, en un grupo aidl:. Ten en cuenta que el backend de Rust solo se puede usar con Rust. Los módulos rust_ se manejan de manera diferente, ya que los archivos AIDL no se especifican como archivos de origen. En su lugar, el módulo aidl_interface produce un rustlib llamado <aidl_interface name>-rust con el que se puede establecer una vinculación. Para obtener más detalles, consulta el ejemplo de AIDL de Rust.

Advertencia: En 13 y versiones anteriores, el backend del NDK solo se compila con símbolos débiles y requiere que se configure __ANDROID_UNAVAILABLE_SYMBOLS_ARE_WEAK__. En el sistema de compilación de la plataforma de Android, esta definición se establece de forma predeterminada.

Advertencia: libbinder_ndk tiene dos conjuntos de encabezados. Para los desarrolladores de plataformas, se envían juntos, pero si eres desarrollador de aplicaciones, debes incluirlos (por lo general, con -I para compiladores de C++, como clang) desde diferentes lugares. Los encabezados principales de las APIs que se proporcionan en el dispositivo (como android/binder_ibinder.h, definido en el árbol de Android en frameworks/native/libs/binder/ndk/include_ndk) se envían con el NDK. Sin embargo, otros archivos de ayuda (como android/binder_interface_utils.h, definido en el árbol de Android frameworks/native/libs/binder/ndk/include_cpp) proporcionan utilidades de C++ que se deben usar con el compilador de AIDL y se envían con él en el SDK en platforms/$PLATFORM_NAME/optional/libbinder_ndk_cpp/.

aidl_interface

Los tipos que se usan con este sistema de compilación deben estar estructurados. Para estar estructurados, los elementos parcelables deben contener campos directamente y no ser declaraciones de tipos definidos directamente en los idiomas de destino. Para saber cómo se ajusta el AIDL estructurado al AIDL estable, consulta AIDL estructurado versus estable.

Tipos

Puedes considerar el compilador aidl como una implementación de referencia para los tipos. Cuando crees una interfaz, invoca aidl --lang=<backend> ... para ver el archivo de interfaz resultante. Cuando usas el módulo aidl_interface, puedes ver el resultado en out/soong/.intermediates/<path to module>/.

Tipo de Java/AIDL	Tipo de C++	Tipo de NDK	Tipo de óxido
boolean	bool	bool	bool
byte^8	int8_t	int8_t	i8
char	char16_t	char16_t	u16
int	int32_t	int32_t	i32
long	int64_t	int64_t	i64
float	float	float	f32
double	double	double	f64
String	android::String16	std::string	Entrada: &str Salida: Cadena
android.os.Parcelable	android::Parcelable	N/A	N/A
IBinder	android::IBinder	ndk::SpAIBinder	binder::SpIBinder
T[]	std::vector<T>	std::vector<T>	Entrada: &[T] Salida: Vec<T>
byte[]	std::vector<uint8_t>	std::vector<int8_t>^1	Entrada: &[u8] Salida: Vec<u8>
Lista<T>	std::vector<T>^2	std::vector<T>^3	Entrada: &[T]^4 Salida: Vec<T>
FileDescriptor	android::base::unique_fd	N/A	binder::parcel::ParcelFileDescriptor
ParcelFileDescriptor	android::os::ParcelFileDescriptor	ndk::ScopedFileDescriptor	binder::parcel::ParcelFileDescriptor
tipo de interfaz (T)	android::sp<T>	std::shared_ptr<T>^7	binder::Strong
tipo parcelable (T)	T	T	T
tipo de unión (T)^5	T	T	T
T[N] ^6	std::array<T, N>	std::array<T, N>	[T; N]

^{1. En Android 12 o versiones posteriores, los arrays de bytes usan uint8_t en lugar de int8_t por motivos de compatibilidad.}

^{2. El backend de C++ admite List<T>, en el que T es uno de String, IBinder, ParcelFileDescriptor o parcelable. En Android 13 o versiones posteriores, T puede ser cualquier tipo no primitivo (incluidos los tipos de interfaz), excepto los arrays. AOSP recomienda que uses tipos de array como T[], ya que funcionan en todos los backends.}

^{3. El backend del NDK admite List<T>, en el que T es uno de String, ParcelFileDescriptor o parcelable. En Android 13 o versiones posteriores, T puede ser cualquier tipo no primitivo, excepto los arrays.}

^{4. Los tipos se pasan de manera diferente para el código de Rust según si son entradas (un argumento) o salidas (un valor que se muestra).}

^{5. Los tipos de unión son compatibles con Android 12 y versiones posteriores.}

^{6. En Android 13 o versiones posteriores, se admiten آرا array de tamaño fijo. Los arrays de tamaño fijo pueden tener varias dimensiones (p.ej., int[3][4]). En el backend de Java, los arrays de tamaño fijo se representan como tipos de array.}

^{7. Para crear una instancia de un objeto SharedRefBase de Binder, usa SharedRefBase::make\<My\>(... args ...). Esta función crea un objeto std::shared_ptr\<T\> que también se administra de forma interna, en caso de que el vinculador sea propiedad de otro proceso. Si creas el objeto de otras maneras, se producirá una doble propiedad.}

^{8. Consulta también el tipo byte[] de Java/AIDL.}

Direccionalidad (in/out/inout)

Cuando especifiques los tipos de argumentos de las funciones, puedes especificarlos como in, out o inout. De esta manera, se controla en qué dirección se pasa la información para una llamada de IPC. in es la dirección predeterminada y, además, indica que los datos se pasan del llamador al llamado. out significa que los datos se pasan del llamado al llamador. inout es la combinación de ambos. Sin embargo, el equipo de Android recomienda que evites usar el especificador de argumentos inout. Si usas inout con una interfaz con control de versiones y un llamador anterior, los campos adicionales que solo están presentes en el llamador se restablecen a sus valores predeterminados. En el caso de Rust, un tipo inout normal recibe &mut Vec<T> y un tipo inout de lista recibe &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);
}

UTF8/UTF16

Con el backend de CPP, puedes elegir si las cadenas son utf-8 o utf-16. Declara cadenas como @utf8InCpp String en AIDL para convertirlas automáticamente a UTF-8. Los backends de NDK y Rust siempre usan cadenas UTF-8. Para obtener más información sobre la anotación utf8InCpp, consulta Anotaciones en AIDL.

Nulabilidad

Puedes anotar los tipos que pueden ser nulos con @nullable. Para obtener más información sobre la anotación de nullable, consulta Anotaciones en AIDL.

Advertencia: Protege contra valores inesperados. Incluso si tu cliente o servidor siempre pasa un valor no nulo, se debe verificar la entrada en caso de un cliente malicioso o, en algunos casos, para valores que se vuelven nulos. Por ejemplo, en el backend de NDK, un tipo de interfaz puede aparecer como nulo si su proceso de host se cierra durante una transacción.

Objetos parcelables personalizados

Un parcelable personalizado es un elemento parcelable que se implementa de forma manual en un backend de destino. Usa elementos parcelables personalizados solo cuando intentes agregar compatibilidad con otros idiomas para un elemento parcelable personalizado existente que no se pueda cambiar.

Advertencia: Los objetos Parcelable personalizados son propensos a errores. Cuando crees un elemento parcelable nuevo, debes usar elementos parcelables de AIDL estructurados. Los elementos Parcelable personalizados deben implementarse en cada backend por separado y pueden estar desincronizados o tener otros problemas. Si tienes dudas, usa un elemento parcelable de AIDL estructurado.

Para declarar un objeto parcelable personalizado de modo que AIDL lo conozca, la declaración de objeto parcelable de AIDL se ve de la siguiente manera:

    package my.pack.age;
    parcelable Foo;

De forma predeterminada, esto declara un elemento parcelable de Java en el que my.pack.age.Foo es una clase de Java que implementa la interfaz Parcelable.

Para declarar un backend de CPP parcelable personalizado en AIDL, usa cpp_header:

    package my.pack.age;
    parcelable Foo cpp_header "my/pack/age/Foo.h";

La implementación de C++ en my/pack/age/Foo.h se ve de la siguiente manera:

    #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);
    };

Para declarar un objeto parcelable del NDK personalizado en AIDL, usa ndk_header:

    package my.pack.age;
    parcelable Foo ndk_header "android/pack/age/Foo.h";

La implementación del NDK en android/pack/age/Foo.h se ve de la siguiente manera:

    #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);
    };

En Android 15, para declarar un objeto parcelable personalizado de Rust en AIDL, usa rust_type:

package my.pack.age;
@RustOnlyStableParcelable parcelable Foo rust_type "rust_crate::Foo";

La implementación de Rust en rust_crate/src/lib.rs se ve de la siguiente manera:

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);

Luego, puedes usar este elemento parcelable como un tipo en los archivos AIDL, pero AIDL no lo generará. Proporciona operadores < y == para los objetos parcelables personalizados del backend de CPP/NDK para usarlos en union.

Advertencia: Los elementos Parcelable personalizados deben ser finales. Los objetos parcelables personalizados en Java y C++ deben ser finales. Si se envía una subclase de un elemento parcelable como una superclase, el formato subyacente no coincide. Un elemento parcelable de clase superior debería codificar cómo se escriben las subclases en un paquete. La solución más fácil es evitar crear subclase de elementos parcelables. En su lugar, usa la composición.

Valores predeterminados

Los elementos parcelables estructurados pueden declarar valores predeterminados por campo para primitivos, String y arrays de estos tipos.

    parcelable Foo {
      int numField = 42;
      String stringField = "string value";
      char charValue = 'a';
      ...
    }

En el backend de Java, cuando faltan valores predeterminados, los campos se inicializan como valores cero para tipos primitivos y null para tipos no primitivos.

En otros backends, los campos se inicializan con valores predeterminados cuando no se definen valores predeterminados. Por ejemplo, en el backend de C++, los campos String se inicializan como una cadena vacía y los campos List<T> se inicializan como un vector<T> vacío. Los campos @nullable se inicializan como campos de valor nulo.

Sindicatos

Las uniones de AIDL están etiquetadas y sus funciones son similares en todos los backends. Se construyen de forma predeterminada con el valor predeterminado del primer campo y tienen una forma de interactuar con ellos específica del idioma.

    union Foo {
      int intField;
      long longField;
      String stringField;
      MyParcelable parcelableField;
      ...
    }

Ejemplo de Java

    Foo u = Foo.intField(42);              // construct

    if (u.getTag() == Foo.intField) {      // tag query
      // use u.getIntField()               // getter
    }

    u.setSringField("abc");                // setter

Ejemplo de C++ y NDK

    Foo u;                                            // default constructor

    assert (u.getTag() == Foo::intField);             // tag query
    assert (u.get<Foo::intField>() == 0);             // getter

    u.set<Foo::stringField>("abc");                   // setter

    assert (u == Foo::make<Foo::stringField>("abc")); // make<tag>(value)

Ejemplo de Rust

En Rust, las uniones se implementan como enums y no tienen métodos get ni set explícitos.

    let mut u = Foo::Default();              // default constructor
    match u {                                // tag match + get
      Foo::IntField(x) => assert!(x == 0);
      Foo::LongField(x) => panic!("Default constructed to first field");
      Foo::StringField(x) => panic!("Default constructed to first field");
      Foo::ParcelableField(x) => panic!("Default constructed to first field");
      ...
    }
    u = Foo::StringField("abc".to_string()); // set

Manejo de errores

El SO Android proporciona tipos de errores integrados para que los servicios los usen cuando informen errores. Binder los usa y cualquier servicio que implemente una interfaz de Binder puede usarlos. Su uso está bien documentado en la definición de AIDL y no requieren ningún estado ni tipo de devolución definidos por el usuario.

Parámetros de salida con errores

Cuando una función de AIDL informa un error, es posible que no inicialice ni modifíque los parámetros de salida. Específicamente, los parámetros de salida se pueden modificar si el error ocurre durante el desempaquetado, en lugar de hacerlo durante el procesamiento de la transacción. En general, cuando se recibe un error de una función AIDL, se debe considerar que todos los parámetros inout y out, así como el valor que se muestra (que actúa como un parámetro out en algunos backends), se encuentran en un estado indefinido.

Qué valores de error usar

Muchos de los valores de error integrados se pueden usar en cualquier interfaz de AIDL, pero algunos se tratan de una manera especial. Por ejemplo, EX_UNSUPPORTED_OPERATION y EX_ILLEGAL_ARGUMENT se pueden usar cuando describen la condición de error, pero no se debe usar EX_TRANSACTION_FAILED porque la infraestructura subyacente lo trata de forma especial. Consulta las definiciones específicas del backend para obtener más información sobre estos valores integrados.

Si la interfaz AIDL requiere valores de error adicionales que no están cubiertos por los tipos de error integrados, puede usar el error integrado especial específico del servicio que permite la inclusión de un valor de error específico del servicio que define el usuario. Por lo general, estos errores específicos del servicio se definen en la interfaz AIDL como un enum respaldado por const int o int, y Binder no los analiza.

En Java, los errores se asignan a excepciones, como android.os.RemoteException. Para las excepciones específicas del servicio, Java usa android.os.ServiceSpecificException junto con el error definido por el usuario.

El código nativo de Android no usa excepciones. El backend de CPP usa android::binder::Status. El backend del NDK usa ndk::ScopedAStatus. Cada método que genera AIDL muestra uno de estos, que representa el estado del método. El backend de Rust usa los mismos valores de código de excepción que el NDK, pero los convierte en errores nativos de Rust (StatusCode, ExceptionCode) antes de entregarlos al usuario. En el caso de los errores específicos del servicio, el Status o ScopedAStatus que se muestra usa EX_SERVICE_SPECIFIC junto con el error definido por el usuario.

Los tipos de errores integrados se pueden encontrar en los siguientes archivos:

Backend	Definición
Java	android/os/Parcel.java
CPP	binder/Status.h
NDK	android/binder_status.h
Rust	android/binder_status.h

Usa varios backends

Estas instrucciones son específicas del código de la plataforma de Android. En estos ejemplos, se usa un tipo definido, my.package.IFoo. Para obtener instrucciones sobre cómo usar el backend de Rust, consulta el ejemplo de AIDL de Rust en la página Patrones de Rust en Android.

Tipos de importación

Ya sea que el tipo definido sea una interfaz, un elemento parcelable o una unión, puedes importarlo en Java:

import my.package.IFoo;

O en el backend de CPP:

#include <my/package/IFoo.h>

O en el backend de NDK (observa el espacio de nombres aidl adicional):

#include <aidl/my/package/IFoo.h>

O en el backend de Rust:

use my_package::aidl::my::package::IFoo;

Aunque puedes importar un tipo anidado en Java, en los backends de CPP/NDK, debes incluir el encabezado de su tipo raíz. Por ejemplo, cuando importas un tipo anidado Bar definido en my/package/IFoo.aidl (IFoo es el tipo raíz del archivo), debes incluir <my/package/IFoo.h> para el backend de CPP (o <aidl/my/package/IFoo.h> para el backend de NDK).

Implementa servicios

Para implementar un servicio, debes heredar de la clase de stub nativa. Esta clase lee comandos del controlador de Binder y ejecuta los métodos que implementas. Imagina que tienes un archivo AIDL como el siguiente:

    package my.package;
    interface IFoo {
        int doFoo();
    }

En Java, debes extender esta clase:

    import my.package.IFoo;
    public class MyFoo extends IFoo.Stub {
        @Override
        int doFoo() { ... }
    }

En el backend de CPP, haz lo siguiente:

    #include <my/package/BnFoo.h>
    class MyFoo : public my::package::BnFoo {
        android::binder::Status doFoo(int32_t* out) override;
    }

En el backend de NDK (observa el espacio de nombres aidl adicional):

    #include <aidl/my/package/BnFoo.h>
    class MyFoo : public aidl::my::package::BnFoo {
        ndk::ScopedAStatus doFoo(int32_t* out) override;
    }

En el backend de Rust, haz lo siguiente:

    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(())
        }
    }

O con Rust asíncrono:

    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(())
        }
    }

Regístrate y obtén servicios

Los servicios en la plataforma Android suelen registrarse con el proceso servicemanager. Además de las APIs que se indican a continuación, algunas APIs verifican el servicio (es decir, se muestran de inmediato si el servicio no está disponible). Consulta la interfaz servicemanager correspondiente para obtener los detalles exactos. Estas operaciones solo se pueden realizar cuando se compila para la plataforma de Android.

Advertencia: AIDL/Binder no inicia un grupo de subprocesos de forma predeterminada. Si waitForService está bloqueado, es posible que debas iniciar el grupo de subprocesos de Binder.

Advertencia: El método getService puede recuperar servicios en Android. En el backend de CPP/NDK/Rust y en algunas partes del backend de Java, este método sondea durante 5 segundos y muestra el servicio solo si se inicia dentro de ese período. Debido a que getService realiza sondeos y puede generar interbloqueos, se recomienda evitar este método.

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"));

En el backend de CPP, haz lo siguiente:

    #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"));

En el backend de NDK (observa el espacio de nombres aidl adicional):

    #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")));

En el backend de Rust, haz lo siguiente:

Nota: myfoo aquí es el nombre del paquete de la biblioteca que contiene la interfaz definida anteriormente.

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()
}

En el backend asíncrono de Rust, con un entorno de ejecución de un solo subproceso:

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
}

Una diferencia importante con las otras opciones es que no llamamos a join_thread_pool cuando usamos Rust asíncrono y un entorno de ejecución de un solo subproceso. Esto se debe a que debes darle a Tokio un subproceso en el que pueda ejecutar tareas generadas. En este ejemplo, el subproceso principal cumplirá ese propósito. Todas las tareas creadas con tokio::spawn se ejecutarán en el subproceso principal.

En el backend asíncrono de Rust, con un entorno de ejecución de varios subprocesos:

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();
    });
}

Con el entorno de ejecución de Tokio multiproceso, las tareas generadas no se ejecutan en el subproceso principal. Por lo tanto, tiene más sentido llamar a join_thread_pool en el subproceso principal para que no esté inactivo. Debes unir la llamada en block_in_place para salir del contexto asíncrono.

Vínculo a la muerte

Puedes solicitar recibir una notificación cuando un servicio que aloja un Binder falle. Esto puede ayudar a evitar fugas de proxies de devolución de llamada o ayudar en la recuperación de errores. Realiza estas llamadas en objetos de proxy de Binder.

• En Java, usa android.os.IBinder::linkToDeath.
• En el backend de CPP, usa android::IBinder::linkToDeath.
• En el backend del NDK, usa AIBinder_linkToDeath.
• En el backend de Rust, crea un objeto DeathRecipient y, luego, llama a my_binder.link_to_death(&mut my_death_recipient). Ten en cuenta que, como DeathRecipient es el propietario de la devolución de llamada, debes mantener ese objeto activo mientras quieras recibir notificaciones.

Información del emisor

Cuando se recibe una llamada de Binder del kernel, la información del emisor está disponible en varias APIs. El PID (o ID de proceso) hace referencia al ID de proceso de Linux del proceso que envía una transacción. El UID (o ID de usuario) hace referencia al ID de usuario de Linux. Cuando se recibe una llamada unidireccional, el PID de llamada es 0. Cuando están fuera de un contexto de transacción de Binder, estas funciones muestran el PID y el UID del proceso actual.

Advertencia: El PID está sujeto a interbloqueos. En cuanto obtienes un PID, es posible que el proceso que lo contiene se cancele y otro proceso lo vuelva a usar. Nunca des por sentado que un PID representa un proceso activo o particular. Por lo general, los PID solo son útiles para depurar.

En el backend de Java, haz lo siguiente:

    ... = Binder.getCallingPid();
    ... = Binder.getCallingUid();

En el backend de CPP, haz lo siguiente:

    ... = IPCThreadState::self()->getCallingPid();
    ... = IPCThreadState::self()->getCallingUid();

En el backend del NDK, haz lo siguiente:

    ... = AIBinder_getCallingPid();
    ... = AIBinder_getCallingUid();

En el backend de Rust, cuando implementes la interfaz, especifica lo siguiente (en lugar de permitir que se establezca de forma predeterminada):

    ... = ThreadState::get_calling_pid();
    ... = ThreadState::get_calling_uid();

Informes de errores y API de depuración para servicios

Cuando se ejecutan los informes de errores (por ejemplo, con adb bugreport), recopilan información de todo el sistema para ayudar a depurar varios problemas. En el caso de los servicios AIDL, los informes de errores usan el objeto dumpsys binario en todos los servicios registrados con el administrador de servicios para volcar su información en el informe de errores. También puedes usar dumpsys en la línea de comandos para obtener información de un servicio con dumpsys SERVICE [ARGS]. En los backends de C++ y Java, puedes controlar el orden en que se vuelcan los servicios con argumentos adicionales a addService. También puedes usar dumpsys --pid SERVICE para obtener el PID de un servicio mientras depuras.

Para agregar un resultado personalizado a tu servicio, puedes anular el método dump en tu objeto de servidor como si estuvieras implementando cualquier otro método de IPC definido en un archivo AIDL. Cuando lo hagas, debes restringir el volcado al permiso de la app android.permission.DUMP o restringir el volcado a UIDs específicos.

En el backend de Java, haz lo siguiente:

    @Override
    protected void dump(@NonNull FileDescriptor fd, @NonNull PrintWriter fout,
        @Nullable String[] args) {...}

En el backend de CPP, haz lo siguiente:

    status_t dump(int, const android::android::Vector<android::String16>&) override;

En el backend del NDK, haz lo siguiente:

    binder_status_t dump(int fd, const char** args, uint32_t numArgs) override;

En el backend de Rust, cuando implementes la interfaz, especifica lo siguiente (en lugar de permitir que se establezca de forma predeterminada):

    fn dump(&self, mut file: &File, args: &[&CStr]) -> binder::Result<()>

Usa punteros débiles

Puedes mantener una referencia débil a un objeto de Binder.

Advertencia: En Binder de Android, solo puedes promocionar una referencia débil si ya hay una referencia fuerte en el mismo proceso. Si solo tienes una referencia débil a un vinculador remoto, no puedes promocionarlo.

Si bien Java admite WeakReference, no admite referencias de Binder débiles en la capa nativa.

En el backend de CPP, el tipo débil es wp<IFoo>.

En el backend del NDK, usa ScopedAIBinder_Weak:

#include <android/binder_auto_utils.h>

AIBinder* binder = ...;
ScopedAIBinder_Weak myWeakReference = ScopedAIBinder_Weak(AIBinder_Weak_new(binder));

En el backend de Rust, puedes usar WpIBinder o Weak<IFoo>:

let weak_interface = myIface.downgrade();
let weak_binder = myIface.as_binder().downgrade();

Cómo obtener el descriptor de interfaz de forma dinámica

El descriptor de interfaz identifica el tipo de interfaz. Esto es útil cuando se depura o cuando se tiene un Binder desconocido.

En Java, puedes obtener el descriptor de interfaz con código como el siguiente:

    service = /* get ahold of service object */
    ... = service.asBinder().getInterfaceDescriptor();

En el backend de CPP, haz lo siguiente:

    service = /* get ahold of service object */
    ... = IInterface::asBinder(service)->getInterfaceDescriptor();

Los backends de NDK y Rust no admiten esta función.

Cómo obtener el descriptor de interfaz de forma estática

A veces (como cuando se registran servicios de @VintfStability), debes saber cuál es el descriptor de interfaz de forma estática. En Java, puedes obtener el descriptor agregando código como el siguiente:

    import my.package.IFoo;
    ... IFoo.DESCRIPTOR

En el backend de CPP, haz lo siguiente:

    #include <my/package/BnFoo.h>
    ... my::package::BnFoo::descriptor

En el backend de NDK (observa el espacio de nombres aidl adicional):

    #include <aidl/my/package/BnFoo.h>
    ... aidl::my::package::BnFoo::descriptor

En el backend de Rust, haz lo siguiente:

    aidl::my::package::BnFoo::get_descriptor()

Rango de enum

En los backends nativos, puedes iterar sobre los valores posibles que puede asumir una enumeración. Debido a consideraciones de tamaño de código, esto no es compatible con Java.

Para una enum MyEnum definida en AIDL, la iteración se proporciona de la siguiente manera.

En el backend de CPP, haz lo siguiente:

    ::android::enum_range<MyEnum>()

En el backend del NDK, haz lo siguiente:

   ::ndk::enum_range<MyEnum>()

En el backend de Rust, haz lo siguiente:

    MyEnum::enum_values()

Administración de subprocesos

Cada instancia de libbinder en un proceso mantiene un grupo de subprocesos. Para la mayoría de los casos de uso, debe ser exactamente un grupo de subprocesos, compartido en todos los backends. La única excepción es cuando el código del proveedor puede cargar otra copia de libbinder para comunicarse con /dev/vndbinder. Como se encuentra en un nodo de Binder independiente, el grupo de subprocesos no se comparte.

En el backend de Java, el grupo de subprocesos solo puede aumentar de tamaño (ya que ya se inició):

    BinderInternal.setMaxThreads(<new larger value>);

Para el backend de CPP, están disponibles las siguientes operaciones:

    // 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();

Del mismo modo, en el backend del NDK:

    bool success = ABinderProcess_setThreadPoolMaxThreadCount(numThreads);
    ABinderProcess_startThreadPool();
    ABinderProcess_joinThreadPool();

En el backend de Rust, haz lo siguiente:

    binder::ProcessState::start_thread_pool();
    binder::add_service("myservice", my_service_binder).expect("Failed to register service?");
    binder::ProcessState::join_thread_pool();

Con el backend de Rust asíncrono, necesitas dos grupos de subprocesos: Binder y Tokio. Esto significa que las apps que usan Rust asíncrono necesitan consideraciones especiales, sobre todo cuando se trata del uso de join_thread_pool. Consulta la sección sobre el registro de servicios para obtener más información.

Nombres reservados

C++, Java y Rust reservan algunos nombres como palabras clave o para uso específico del lenguaje. Si bien AIDL no aplica restricciones basadas en reglas de lenguaje, el uso de nombres de campo o tipo que coincidan con un nombre reservado puede provocar un error de compilación en C++ o Java. En Rust, se cambia el nombre del campo o tipo con la sintaxis de “identificador sin procesar”, a la que se puede acceder con el prefijo r#.

Te recomendamos que evites usar nombres reservados en tus definiciones de AIDL siempre que sea posible para evitar vinculaciones poco ergonómicas o fallas de compilación.

Si ya tienes nombres reservados en tus definiciones de AIDL, puedes cambiar el nombre de los campos de forma segura y seguir siendo compatible con el protocolo. Es posible que debas actualizar el código para continuar con la compilación, pero los programas que ya se compilaron seguirán interoperando.

Nombres que debes evitar:

• Palabras clave de C++
• Palabras clave de Java
• Palabras clave de Rust