Cette page explique comment créer des représentations ABI du kernel Android et exécuter la surveillance ABI. Elle s'applique à Android 14 ou version ultérieure. Pour les versions antérieures, consultez la section Versions antérieures du kernel.
Consultez également la documentation de référence de Kleaf : Prise en charge de la surveillance des ABI (GKI) et Prise en charge de la surveillance des ABI (appareil).
Créer le noyau et sa représentation ABI
Après avoir téléchargé les sources GKI, exécutez la commande suivante pour créer le noyau GKI et les artefacts ABI:
tools/bazel run //common:kernel_aarch64_abi_distCette commande crée la représentation de l'ABI actuelle et la copie dans out_abi/kernel_aarch64/dist/abi.stg avec le noyau et les modules générés.
Vous pouvez spécifier des arguments supplémentaires pour les outils d'ABI à la fin de la commande, après --. Par exemple, pour modifier la destination de l'ABI et des artefacts de compilation, vous pouvez utiliser l'option --dist_dir:
tools/bazel run //common:kernel_aarch64_abi_dist -- --dist_dir=out/distAnalyser les différences d'ABI entre la compilation et une représentation de référence
La cible //common:kernel_aarch64_abi_dist, exécutée dans la commande ci-dessus, analyse et signale les différences d'ABI trouvées entre la compilation et la représentation de référence dans common/android/abi_gki_aarch64.stg (définie dans BUILD.bazel). Ces différences sont affichées à la fin de la compilation, comme illustré dans l'exemple suivant:
INFO: From [stg] Comparing Kernel ABI @//common:kernel_aarch64_abi_diff:
INFO: ABI DIFFERENCES HAVE BEEN DETECTED!
Le rapport imprimé provient de l'artefact de compilation situé dans out_abi/kernel_aarch64/dist/abi_stgdiff/abi.report.short, ainsi que des rapports dans d'autres formats.
L'automatisation doit utiliser le code de sortie de la commande de compilation, qui est différent de zéro si des différences sont détectées.
Notez que les branches de la phase de développement, y compris android-mainline, n'ont aucune représentation ABI de référence.
Sans cela, //common:kernel_aarch64_abi_dist ne détectera aucune différence.
Mettre à jour la représentation de l'ABI de référence
Toute modification qui affecte l'ABI du noyau, telle qu'une mise à jour de la liste de symboles, doit être reflétée dans la représentation de l'ABI de référence (common/android/abi_gki_aarch64.stg, définie dans Build.bazel).
Pour ce faire, vous devez exécuter la commande suivante:
tools/bazel run //common:kernel_aarch64_abi_updateCette commande effectue tout ce qui est décrit dans l'étape Analyser les différences ABI et met également à jour la représentation de référence dans les sources. L'ABI mis à jour peut ensuite être importé dans le même commit que le changement. Incluez les différences ABI du rapport dans $DIST_DIR/abi.report.short dans le message de commit.
Surveillance de l'ABI et cibles d'appareils
La surveillance de l'ABI ne doit être configurée que pour les cibles de compilation du noyau. Les configurations de compilation mixtes (celles qui définissent base_kernel) qui compilent directement avec le noyau GKI ne doivent ajouter la prise en charge du suivi de la liste des symboles de l'appareil que.
La définition de l'ABI doit être mise à jour à l'aide du build GKI.
Consultez également la documentation de référence de Kleaf : Prendre en charge la surveillance de l'ABI (appareil).
Anciennes versions du noyau
Android 13
Les instructions de compilation sont essentiellement les mêmes qu'Android 14, sauf que le format ABI est XML et que la représentation ABI de référence est common/android/abi_gki_aarch64.xml.
Android 13 ou version antérieure
Comme dans Android 13, le format ABI est XML.
Les anciens noyaux utilisent build.sh au lieu de Kleaf. Pour la surveillance de l'ABI, vous devez utiliser build_abi.sh, qui accepte les mêmes variables d'environnement pour personnaliser le build que build.sh. Exemple :
BUILD_CONFIG=common/build.config.gki.aarch64 build/build_abi.shCette opération crée le noyau et extrait la représentation de l'ABI dans le sous-répertoire OUT_DIR (out_abi par défaut) et équivaut à la cible //common:kernel_aarch64_abi_dist de Kleaf (consultez Compiler des artefacts de noyau et d'ABI).
La représentation ABI de référence est stockée dans android/abi_gki_aarch64.xml, comme défini par la variable ABI_DEFINITION dans common/build.config.gki.aarch64.
Si vous devez mettre à jour la représentation de l'ABI du kernel, le moyen le plus pratique consiste à utiliser les options --update et --print-report:
BUILD_CONFIG=common/build.config.gki.aarch64 build/build_abi.sh --update --print-report--print-report affiche les différences d'ABI entre le fichier tel qu'il existe et un ABI nouvellement généré.
L'option --update écrase la représentation ABI de référence. Il effectue également la mise à jour de la liste des symboles lorsque vous utilisez BUILD_CONFIG pour un appareil avec KMI_SYMBOL_LIST configuré.