Déboguer le code de plate-forme

Android Studio for Platform (ASfP) fournit un débogueur puissant qui vous permet d'effectuer les opérations suivantes :

  • Sélectionnez un appareil sur lequel effectuer le débogage.
  • Définir des points d'arrêt dans votre code Java, Kotlin, C/C++ et Rust
  • Examiner les variables et évaluer les expressions lors de l'exécution

Avant d'utiliser le débogueur, vous devez flasher votre build sur un appareil ou un émulateur.

Débogage du processus d'application (Java/Kotlin)

Pour déboguer un processus d'application Java ou Kotlin :

  1. Définissez des points d'arrêt dans votre code Java ou Kotlin dans ASfP.

  2. Sélectionnez Exécuter > Associer le débogueur à un processus Android dans le menu.

  3. Dans la boîte de dialogue Choose Process (Sélectionner un processus), assurez-vous que Debug type (Type de débogage) est défini sur Java Only (Java uniquement).

  4. Sélectionnez votre appareil dans la liste.

  5. Choisissez le processus d'application spécifique que vous souhaitez déboguer.

  6. Cliquez sur OK.

  7. Interagissez avec l'application sur votre appareil pour atteindre les points d'arrêt.

Débogage des processus système (C/C++)

Pour déboguer un processus système écrit en C ou C++ :

  1. Vérifiez que vous n'avez qu'un seul appareil ou émulateur en cours d'exécution.

  2. Ouvrez un terminal et exécutez adb root à partir de la racine de votre extraction AOSP : bash adb root

  1. Définissez des points d'arrêt dans votre code C/C++ dans ASfP.

  2. Sélectionnez Exécuter > Associer le débogueur à un processus Android dans le menu.

  3. Dans la boîte de dialogue Choose Process (Sélectionner un processus), définissez Debug type (Type de débogage) sur Native Only (Natif uniquement) ou Dual (Java + Native) (Double [Java et Natif]).

  4. Cochez la case Afficher tous les processus pour afficher les processus système.

  5. Sélectionnez votre appareil dans la liste.

  6. Choisissez le processus système spécifique que vous souhaitez déboguer (par exemple, surfaceflinger ou system_server).

  7. Cliquez sur OK.

  8. Interagissez avec l'appareil pour atteindre vos points d'arrêt.

Débogage Rust

ASfP est compatible avec le débogage Rust à l'aide du protocole Debug Adapter (DAP) avec LLDB. Cette section explique comment configurer CodeLLDB en tant que serveur d'adaptateur de débogage et comment déboguer du code Rust sur l'hôte et sur un appareil Android.

Configurer CodeLLDB en tant que serveur d'adaptateur de débogage

  1. Créez une configuration d'exécution/de débogage Debug Adapter Protocol :

    1. Sélectionnez Run > Edit Configurations (Exécuter > Modifier les configurations) dans le menu.
    2. Cliquez sur le bouton +.
    3. Sélectionnez Debug Adapter Protocol (Protocole de l'adaptateur de débogage).

  2. Dans l'onglet "Serveur", cliquez sur Créer un serveur.

  3. Dans la boîte de dialogue qui s'ouvre, cliquez sur Choisir un modèle, puis sélectionnez CodeLLDB dans la liste.

  4. Après avoir sélectionné le modèle CodeLLDB, le nouveau serveur est ajouté avec une configuration prédéfinie.

    1. Activez le traçage détaillé en sélectionnant Détaillé dans le menu déroulant Tracer.
    2. Ajoutez une variable d'environnement qui spécifie le chemin d'accès à lldb-server dans vos précompilés sources Android :
        LLDB_DEBUGSERVER_PATH=REPO_ROOT/prebuilts/clang/host/linux-x86/CLANG_VERSION/runtimes_ndk_cxx/x86_64/lldb-server
    ```

Replace `REPO_ROOT` with the absolute path to your Android source checkout.
To find `CLANG_VERSION`, run the `get_clang_version.py` script from the root of
your Android source tree:

```bash
    ./build/soong/scripts/get_clang_version.py
    1. Ne modifiez pas la section <<insert base directory>>.

Déboguer les binaires Rust sur l'hôte

  1. Ouvrez l'onglet Configuration dans votre configuration d'exécution/de débogage du protocole de l'adaptateur de débogage.
  2. Sélectionnez Launch (Lancer) comme mode de débogage.
  3. Mettez à jour le répertoire de travail et sélectionnez le fichier binaire que vous souhaitez déboguer.
  4. Cliquez sur OK pour enregistrer la configuration.
  5. Démarrez la session de débogage en cliquant sur l'icône Déboguer à côté de la configuration.

La première fois que vous exécutez cette commande, CodeLLDB est téléchargé. Des traces DAP devraient s'afficher dans la console. Les points d'arrêt définis dans votre code Rust devraient être atteints comme prévu.

Déboguer des binaires Rust sur un appareil Android (mode "Attacher")

  1. Recherchez le PID : identifiez l'identifiant de processus (PID) de l'application que vous souhaitez déboguer sur l'appareil Android.

  2. Démarrez lldb-server sur l'appareil : à partir de la racine de votre extraction de l'arborescence source Android, exécutez le script lldbclient.py en remplaçant <PID> par l'ID du processus :

    lldbclient.py --setup-forwarding vscode-lldb -p <PID>

    Ce script envoie le bon lldb-server à l'appareil, le démarre, configure le transfert de port (port hôte 5039 vers l'appareil) et génère la configuration JSON DAP nécessaire pour les étapes suivantes. Gardez ce terminal ouvert.

  3. Démarrez l'adaptateur de débogage CodeLLDB sur l'hôte :

    • Accédez au répertoire de l'extension CodeLLDB (par défaut : ~/.lsp4ij/dap/codelldb/extension/adapter).
    • Définissez les variables d'environnement requises et démarrez le serveur de l'adaptateur, en remplaçant REPO_ROOT et CLANG_VERSION comme indiqué dans la configuration du serveur :
        # Sets PYTHONHOME env variable
    export PYTHONHOME=REPO_ROOT/prebuilts/clang/host/linux-x86/CLANG_VERSION/python3

    # Tell the dynamic linker where to find python libs
    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:REPO_ROOT/prebuilts/clang/host/linux-x86/CLANG_VERSION/python3/lib

    # Starts the CodeLLDB Debugger Adapter server on port 1234
    ./codelldb --liblldb REPO_ROOT/prebuilts/clang/host/linux-x86/CLANG_VERSION/lib/liblldb.so --port 1234

  4. Configurez le client DAP ASfP :

    1. Revenez à la configuration d'exécution/de débogage du protocole de l'adaptateur de débogage dans ASfP.
    2. Sélectionnez l'onglet Configuration.
    3. Définissez Mode débogage sur Attacher.
    4. Définissez Adresse sur localhost.
    5. Définissez le paramètre Port sur 1234.
    6. Collez le résultat JSON de la commande lldbclient.py (étape 2) dans le champ Paramètres DAP (JSON).

  5. Cliquez sur Debug (Déboguer) pour démarrer la session de débogage.

Dépannage

  • Si l'erreur error: Connection shut down by remote side while waiting for reply to initial handshake packet s'affiche, mettez fin à la session de débogage en cours, puis redémarrez lldb-server sur l'appareil et l'adaptateur CodeLLDB sur l'hôte.