HIDL

A linguagem de definição de interface HAL ou HIDL é uma linguagem de descrição de interface (IDL) para especificar a interface entre um HAL e seus usuários. HIDL permite especificar tipos e chamadas de métodos, coletados em interfaces e pacotes. De forma mais ampla, HIDL é um sistema de comunicação entre bases de código que podem ser compiladas de forma independente. A partir do Android 10, o HIDL está obsoleto e o Android está migrando para usar o AIDL em todos os lugares.

O HIDL deve ser usado para comunicação entre processos (IPC). HALs criados com HDL são chamados de HALs binderizados porque podem se comunicar com outras camadas de arquitetura usando chamadas de comunicação entre processos (IPC) de binder. HALs binderizados são executados em um processo separado do cliente que os utiliza. Para bibliotecas que devem estar vinculadas a um processo, também está disponível um modo passthrough (não suportado em Java).

HIDL especifica estruturas de dados e assinaturas de métodos, organizadas em interfaces (semelhantes a uma classe) que são coletadas em pacotes. A sintaxe do HIDL parece familiar aos programadores C++ e Java, mas com um conjunto diferente de palavras-chave. HIDL também usa anotações no estilo Java.

Terminologia

Esta seção usa os seguintes termos relacionados ao HIDL:

encadernado Indica que o HIDL está sendo usado para chamadas de procedimentos remotos entre processos, implementados em um mecanismo semelhante ao Binder. Consulte também passagem .
retorno de chamada, assíncrono Interface servida por um usuário HAL, passada para o HAL (usando um método HIDL) e chamada pelo HAL para retornar dados a qualquer momento.
retorno de chamada, síncrono Retorna dados da implementação do método HIDL de um servidor para o cliente. Não utilizado para métodos que retornam void ou um único valor primitivo.
cliente Processo que chama métodos de uma interface específica. Um processo de estrutura HAL ou Android pode ser cliente de uma interface e servidor de outra. Consulte também passagem .
estende Indica uma interface que adiciona métodos e/ou tipos a outra interface. Uma interface pode estender apenas uma outra interface. Pode ser usado para um incremento de versão secundária no mesmo nome de pacote ou para um novo pacote (por exemplo, uma extensão de fornecedor) para construir sobre um pacote mais antigo.
gera Indica um método de interface que retorna valores ao cliente. Para retornar um valor não primitivo ou mais de um valor, uma função de retorno de chamada síncrona é gerada.
interface Coleção de métodos e tipos. Traduzido em uma classe em C++ ou Java. Todos os métodos em uma interface são chamados na mesma direção: um processo cliente invoca métodos implementados por um processo servidor.
Mão Única Quando aplicado a um método HIDL, indica que o método não retorna valores e não bloqueia.
pacote Coleção de interfaces e tipos de dados que compartilham uma versão.
atravessar Modo de HIDL em que o servidor é uma biblioteca compartilhada, dlopen pelo cliente. No modo de passagem, cliente e servidor são o mesmo processo, mas bases de código separadas. Usado apenas para trazer bases de código legadas para o modelo HIDL. Veja também Binderizado .
servidor Processo que implementa métodos de uma interface. Consulte também passagem .
transporte Infraestrutura HIDL que move dados entre o servidor e o cliente.
versão Versão de um pacote. Consiste em dois números inteiros, maiores e menores. Incrementos de versão secundária podem adicionar (mas não alterar) tipos e métodos.

Projeto HIDL

O objetivo do HIDL é que a estrutura do Android possa ser substituída sem a necessidade de reconstruir HALs. Os HALs serão construídos por fornecedores ou fabricantes de SOC e colocados em uma partição /vendor no dispositivo, permitindo que a estrutura Android, em sua própria partição, seja substituída por um OTA sem recompilar os HALs.

O design HIDL equilibra as seguintes preocupações:

  • Interoperabilidade . Crie interfaces interoperáveis ​​de forma confiável entre processos que podem ser compilados com várias arquiteturas, conjuntos de ferramentas e configurações de construção. As interfaces HIDL têm versão e não podem ser alteradas após serem publicadas.
  • Eficiência . HIDL tenta minimizar o número de operações de cópia. Os dados definidos por HIDL são entregues ao código C++ em estruturas de dados de layout padrão C++ que podem ser usadas sem descompactação. O HIDL também fornece interfaces de memória compartilhada e, como os RPCs são inerentemente um tanto lentos, o HIDL oferece suporte a duas maneiras de transferir dados sem usar uma chamada RPC: memória compartilhada e Fast Message Queue (FMQ).
  • Intuitivo . O HIDL evita problemas espinhosos de propriedade de memória usando apenas in para RPC (consulte Android Interface Definition Language (AIDL) ); valores que não podem ser retornados com eficiência pelos métodos são retornados por meio de funções de retorno de chamada. Nem passar dados para HIDL para transferência nem receber dados de HIDL altera a propriedade dos dados – a propriedade sempre permanece com a função de chamada. Os dados precisam persistir apenas durante a função chamada e podem ser destruídos imediatamente após o retorno da função chamada.

Usando o modo de passagem

Para atualizar dispositivos que executam versões anteriores do Android para Android O, você pode agrupar HALs convencionais (e legados) em uma nova interface HIDL que atende o HAL nos modos binderizado e de mesmo processo (passagem). Esse empacotamento é transparente tanto para o HAL quanto para a estrutura do Android.

O modo de passagem está disponível apenas para clientes e implementações C++. Os dispositivos que executam versões anteriores do Android não possuem HALs escritos em Java, portanto, os HALs Java são inerentemente vinculados.

Quando um arquivo .hal é compilado, hidl-gen produz um arquivo de cabeçalho de passagem extra BsFoo.h além dos cabeçalhos usados ​​para comunicação do binder; este cabeçalho define funções a serem dlopen . Como os HALs de passagem são executados no mesmo processo em que são chamados, na maioria dos casos os métodos de passagem são invocados por chamada direta de função (mesmo thread). métodos oneway são executados em seu próprio thread, pois não se destinam a esperar que o HAL os processe (isso significa que qualquer HAL que use métodos oneway no modo de passagem deve ser thread-safe).

Dado um IFoo.hal , BsFoo.h agrupa os métodos gerados por HIDL para fornecer recursos adicionais (como fazer transações oneway serem executadas em outro thread). Este arquivo é semelhante a BpFoo.h , porém em vez de repassar chamadas IPC usando binder, as funções desejadas são invocadas diretamente. Implementações futuras de HALs podem fornecer múltiplas implementações, como FooFast HAL e FooAccurate HAL. Nesses casos, seria criado um arquivo para cada implementação adicional (por exemplo, PTFooFast.cpp e PTFooAccurate.cpp ).

Encadernação de HALs de passagem

Você pode vincular implementações HAL que suportam o modo de passagem. Dada uma interface HAL abcd@MN::IFoo , dois pacotes são criados:

  • abcd@MN::IFoo-impl . Contém a implementação do HAL e expõe a função IFoo* HIDL_FETCH_IFoo(const char* name) . Em dispositivos legados, este pacote é dlopen e a implementação é instanciada usando HIDL_FETCH_IFoo . Você pode gerar o código base usando hidl-gen e -Lc++-impl e -Landroidbp-impl .
  • abcd@MN::IFoo-service . Abre o HAL de passagem e registra-se como um serviço vinculado, permitindo que a mesma implementação HAL seja usada como passagem e vinculado.

Dado o tipo IFoo , você pode chamar sp<IFoo> IFoo::getService(string name, bool getStub) para obter acesso a uma instância de IFoo . Se getStub for verdadeiro, getService tentará abrir o HAL somente no modo de passagem. Se getStub for falso, getService tentará localizar um serviço vinculado; se isso falhar, ele tentará encontrar o serviço de passagem. O parâmetro getStub nunca deve ser usado, exceto em defaultPassthroughServiceImplementation . (Os dispositivos iniciados com Android O são dispositivos totalmente vinculados, portanto, a abertura de um serviço no modo de passagem não é permitida.)

Gramática HIDL

Por design, a linguagem HIDL é semelhante a C (mas não usa o pré-processador C). Toda pontuação não descrita abaixo (além do uso óbvio de = e | ) faz parte da gramática.

Nota: Para obter detalhes sobre o estilo de código HIDL, consulte o Code Style Guide .

  • /** */ indica um comentário de documentação. Eles podem ser aplicados apenas a declarações de tipo, método, campo e valor enum.
  • /* */ indica um comentário de múltiplas linhas.
  • // indica um comentário no final da linha. Além de // , as novas linhas são iguais a qualquer outro espaço em branco.
  • No exemplo de gramática abaixo, o texto de // até o final da linha não faz parte da gramática, mas é um comentário sobre a gramática.
  • [empty] significa que o termo pode estar vazio.
  • ? seguir um literal ou termo significa que é opcional.
  • ... indica sequência contendo zero ou mais itens com pontuação de separação conforme indicado. Não há argumentos variados no HIDL.
  • As vírgulas separam os elementos da sequência.
  • Ponto e vírgula terminam cada elemento, incluindo o último elemento.
  • MAIÚSCULAS é um não-terminal.
  • italics é uma família de tokens, como integer ou identifier (regras de análise C padrão).
  • constexpr é uma expressão constante de estilo C (como 1 + 1 e 1L << 3 ).
  • import_name é um nome de pacote ou interface, qualificado conforme descrito em Versionamento HIDL .
  • words minúsculas são tokens literais.

Exemplo:

ROOT =
    PACKAGE IMPORTS PREAMBLE { ITEM ITEM ... }  // not for types.hal
  | PACKAGE IMPORTS ITEM ITEM...  // only for types.hal; no method definitions

ITEM =
    ANNOTATIONS? oneway? identifier(FIELD, FIELD ...) GENERATES?;
  |  safe_union identifier { UFIELD; UFIELD; ...};
  |  struct identifier { SFIELD; SFIELD; ...};  // Note - no forward declarations
  |  union identifier { UFIELD; UFIELD; ...};
  |  enum identifier: TYPE { ENUM_ENTRY, ENUM_ENTRY ... }; // TYPE = enum or scalar
  |  typedef TYPE identifier;

VERSION = integer.integer;

PACKAGE = package android.hardware.identifier[.identifier[...]]@VERSION;

PREAMBLE = interface identifier EXTENDS

EXTENDS = <empty> | extends import_name  // must be interface, not package

GENERATES = generates (FIELD, FIELD ...)

// allows the Binder interface to be used as a type
// (similar to typedef'ing the final identifier)
IMPORTS =
   [empty]
  |  IMPORTS import import_name;

TYPE =
  uint8_t | int8_t | uint16_t | int16_t | uint32_t | int32_t | uint64_t | int64_t |
 float | double | bool | string
|  identifier  // must be defined as a typedef, struct, union, enum or import
               // including those defined later in the file
|  memory
|  pointer
|  vec<TYPE>
|  bitfield<TYPE>  // TYPE is user-defined enum
|  fmq_sync<TYPE>
|  fmq_unsync<TYPE>
|  TYPE[SIZE]

FIELD =
   TYPE identifier

UFIELD =
   TYPE identifier
  |  safe_union identifier { FIELD; FIELD; ...} identifier;
  |  struct identifier { FIELD; FIELD; ...} identifier;
  |  union identifier { FIELD; FIELD; ...} identifier;

SFIELD =
   TYPE identifier
  |  safe_union identifier { FIELD; FIELD; ...};
  |  struct identifier { FIELD; FIELD; ...};
  |  union identifier { FIELD; FIELD; ...};
  |  safe_union identifier { FIELD; FIELD; ...} identifier;
  |  struct identifier { FIELD; FIELD; ...} identifier;
  |  union identifier { FIELD; FIELD; ...} identifier;

SIZE =  // Must be greater than zero
     constexpr

ANNOTATIONS =
     [empty]
  |  ANNOTATIONS ANNOTATION

ANNOTATION =
  |  @identifier
  |  @identifier(VALUE)
  |  @identifier(ANNO_ENTRY, ANNO_ENTRY  ...)

ANNO_ENTRY =
     identifier=VALUE

VALUE =
     "any text including \" and other escapes"
  |  constexpr
  |  {VALUE, VALUE ...}  // only in annotations

ENUM_ENTRY =
     identifier
  |  identifier = constexpr