Executar o monitoramento de ABI

Esta página descreve como criar representações de ABI do kernel do Android e executar o monitoramento de ABI. Ela é aplicável ao Android 14 e versões mais recentes. Para versões anteriores, consulte Versões mais antigas do kernel.

Consulte também a documentação de referência do Kleaf: Suporte ao monitoramento de ABI (GKI) e Suporte ao monitoramento de ABI (dispositivo).

Criar o kernel e a representação da ABI

Depois de fazer o download das origens do GKI, execute o comando abaixo para criar o kernel e os artefatos ABI do GKI:

tools/bazel run //common:kernel_aarch64_abi_dist

Esse comando cria a representação da ABI atual e a copia para out_abi/kernel_aarch64/dist/abi.stg junto com o kernel e os módulos criados.

É possível especificar argumentos extras para a ferramenta ABI no final do comando após --. Por exemplo, para mudar o destino da ABI e criar artefatos, use a opção --dist_dir:

tools/bazel run //common:kernel_aarch64_abi_dist -- --dist_dir=out/dist

Analisar as diferenças de ABI entre o build e uma representação de referência

O destino //common:kernel_aarch64_abi_dist, executado no comando acima, analisa e informa todas as diferenças de ABI encontradas entre o build e a representação de referência localizada em common/android/abi_gki_aarch64.stg (definida em BUILD.bazel). Essas diferenças são mostradas no final do build, conforme mostrado no exemplo abaixo:

INFO: From [stg] Comparing Kernel ABI @//common:kernel_aarch64_abi_diff:
INFO: ABI DIFFERENCES HAVE BEEN DETECTED!

O relatório impresso vem do artefato de build localizado em out_abi/kernel_aarch64/dist/abi_stgdiff/abi.report.short, junto com relatórios em outros formatos.

A automação precisa usar o código de saída do comando de build, que não é zero se forem encontradas diferenças.

As ramas da fase de desenvolvimento, incluindo android-mainline, não têm representação de ABI de referência. Sem ele, a //common:kernel_aarch64_abi_dist não detectará diferenças.

Atualizar a representação de ABI de referência

Qualquer mudança que afete a ABI do kernel, como uma atualização da lista de símbolos, precisa ser refletida na representação de ABI de referência (common/android/abi_gki_aarch64.stg, definido em BUILD.bazel). Para isso, execute o seguinte comando:

​​tools/bazel run //common:kernel_aarch64_abi_update

Esse comando executa tudo na etapa Analisar as diferenças de ABI e atualiza a representação de referência nas origens. A ABI atualizada pode ser enviada no mesmo commit da mudança. Inclua as diferenças de ABI do relatório em $DIST_DIR/abi.report.short na mensagem de confirmação.

Monitoramento da ABI e dispositivos de destino

O monitoramento de ABI só precisa ser configurado para destinos de build do kernel principal. Configurações de build mistas (aquelas que definem base_kernel) que são compiladas diretamente com o kernel do GKI precisam apenas adicionar suporte para rastrear a lista de símbolos do dispositivo. A definição da ABI precisa ser atualizada usando o build do GKI.

Consulte também a documentação de referência do Kleaf: Suporte ao monitoramento de ABI (dispositivo).

Versões mais antigas do kernel

Android 13

As instruções de build são quase as mesmas do Android 14, exceto que o formato da ABI é XML e a representação de referência da ABI é common/android/abi_gki_aarch64.xml.

Android 13 e versões anteriores

Assim como no Android 13, o formato ABI é XML.

Os kernels mais antigos usam build.sh em vez do Kleaf. Para monitoramento de ABI, use build_abi.sh, que aceita as mesmas variáveis de ambiente para personalizar o build como build.sh. Exemplo:

BUILD_CONFIG=common/build.config.gki.aarch64 build/build_abi.sh

Isso cria o kernel e extrai a representação da ABI no subdiretório OUT_DIR (que é out_abi por padrão) e é equivalente ao destino //common:kernel_aarch64_abi_dist do Kleaf. Consulte Build kernel e artefatos ABI.

A representação ABI de referência é armazenada em android/abi_gki_aarch64.xml, conforme definido pela variável ABI_DEFINITION em common/build.config.gki.aarch64.

Se você precisar atualizar a representação da ABI do kernel, a maneira mais conveniente é usar as opções --update e --print-report:

BUILD_CONFIG=common/build.config.gki.aarch64 build/build_abi.sh --update --print-report

O --print-report mostra as diferenças de ABI entre o arquivo atual e uma ABI recém-gerada.

A opção --update substitui a representação da ABI de referência. Ele também faz a atualização da lista de símbolos ao usar BUILD_CONFIG para um dispositivo com KMI_SYMBOL_LIST configurado.