Igienizzante per indirizzi HW

Nota: questo documento riguarda l'esecuzione di applicazioni Android create con l'NDK sotto HWAddress Sanitizer. Per informazioni sull'utilizzo di HWAddress Sanitizer sui componenti della piattaforma Android, consulta la documentazione AOSP.

Android NDK supporta HWAddress Sanitizer, noto anche come HWASan, a partire da NDK r21 e Android 10 (livello API 29). HWASan è disponibile solo su dispositivi Arm a 64 bit.

Importante: HWAsan è uno dei tanti strumenti disponibili per il debugging e la mitigazione della memoria. Consulta Debug e mitigazione degli errori di memoria per una panoramica di tutti gli strumenti.

HWASan è uno strumento di rilevamento degli errori di memoria simile ad ASan. Rispetto ad ASan classico, HWASan offre:

• Carico della CPU simile (~2 volte)
• Overhead simile per le dimensioni del codice (40-50%)
• Overhead della RAM molto inferiore (10-35%)

HWASan rileva lo stesso insieme di bug di ASan:

• Overflow o underflow del buffer dello stack e dell'heap
• Utilizzo dell'heap dopo il rilascio
• Utilizzo dell'elenco di controllo al di fuori dell'ambito
• Doppio senza costi aggiuntivi o senza costi aggiuntivi per i bambini

Inoltre, HWASan rileva anche:

• Utilizzo della pila dopo il reso

App di esempio

Un'app di esempio mostra come configurare una variante di compilazione per hwasan.

Crea

Importante: assicurati di utilizzare un NDK aggiornato per compilare il codice.

Per compilare il codice nativo (JNI) della tua app con HWAddress Sanitizer, segui questi passaggi:

ndk-build

Nel file Application.mk:

APP_STL := c++_shared # Or system, or none, but not c++_static.
APP_CFLAGS := -fsanitize=hwaddress -fno-omit-frame-pointer
APP_LDFLAGS := -fsanitize=hwaddress

CMake

Nel file build.gradle del modulo:

android {
    defaultConfig {
        externalNativeBuild {
            cmake {
                # Can also use system or none as ANDROID_STL, but not c++_static.
                arguments "-DANDROID_STL=c++_shared"
            }
        }
    }
}

Per ogni target in CMakeLists.txt:

target_compile_options(${TARGET} PUBLIC -fsanitize=hwaddress -fno-omit-frame-pointer)
target_link_options(${TARGET} PUBLIC -fsanitize=hwaddress)

Con NDK 27 o versioni successive, puoi anche utilizzare quanto segue in build.gradle e non devi modificare CMakeLists.txt:

android {
    defaultConfig {
        externalNativeBuild {
            cmake {
                arguments "-DANDROID_SANITIZE=hwaddress"
            }
        }
    }
}

Questa operazione non funziona se utilizzi ANDROID_USE_LEGACY_TOOLCHAIN_FILE=false.

Nota: è necessaria una libreria STL condivisa perché le implementazioni degli operatori new e delete nell'STL vengono in genere create senza puntatori frame. HWASan offre la propria implementazione, ma non può essere utilizzato se l'STL è collegato staticamente all'applicazione.

Android 14 o versioni successive: aggiungi wrap.sh

Se utilizzi Android 14 o versioni successive, puoi utilizzare uno script wrap.sh per eseguire l'app disponibile per il debug su qualsiasi dispositivo Android. Puoi saltare questo passaggio se hai scelto di seguire i passaggi riportati nelle istruzioni di configurazione.

Segui le istruzioni per impacchettare uno script wrap.sh per aggiungere il seguente script wrap.sh per arm64-v8a.

#!/system/bin/sh
LD_HWASAN=1 exec "$@"

Esegui

Se utilizzi una versione di Android precedente alla 14 o non hai aggiunto uno script wrap.sh, segui le istruzioni di configurazione prima di eseguire l'app.

Esegui l'app come di consueto. Quando viene rilevato un errore di memoria, un'app si arresta in modo anomalo con SIGABRT e stampa un messaggio dettagliato in logcat. Una copia del messaggio può essere trovata in un file in /data/tombstones e ha il seguente aspetto:

ERROR: HWAddressSanitizer: tag-mismatch on address 0x0042a0826510 at pc 0x007b24d90a0c
WRITE of size 1 at 0x0042a0826510 tags: 32/3d (ptr/mem) in thread T0
    #0 0x7b24d90a08  (/data/app/com.example.hellohwasan-eRpO2UhYylZaW0P_E0z7vA==/lib/arm64/libnative-lib.so+0x2a08)
    #1 0x7b8f1e4ccc  (/apex/com.android.art/lib64/libart.so+0x198ccc)
    #2 0x7b8f1db364  (/apex/com.android.art/lib64/libart.so+0x18f364)
    #3 0x7b8f2ad8d4  (/apex/com.android.art/lib64/libart.so+0x2618d4)

0x0042a0826510 is located 0 bytes to the right of 16-byte region [0x0042a0826500,0x0042a0826510)
allocated here:
    #0 0x7b92a322bc  (/apex/com.android.runtime/lib64/bionic/libclang_rt.hwasan-aarch64-android.so+0x212bc)
    #1 0x7b24d909e0  (/data/app/com.example.hellohwasan-eRpO2UhYylZaW0P_E0z7vA==/lib/arm64/libnative-lib.so+0x29e0)
    #2 0x7b8f1e4ccc  (/apex/com.android.art/lib64/libart.so+0x198ccc)

Il messaggio può essere seguito da ulteriori informazioni di debug, tra cui l'elenco dei thread attivi nell'applicazione, i tag delle allocazioni di memoria nelle vicinanze e i valori dei registri della CPU.

Per ulteriori informazioni sui messaggi di errore HWASan, consulta Informazioni sui report HWASan.

Creazione di file eseguibili a riga di comando

Importante: assicurati di utilizzare la versione più recente di NDK. L'operazione non andrà a buon fine per NDK prima della versione r26b.

Puoi compilare ed eseguire file eseguibili instrumentati con HWASan su Android 14 e versioni successive. Puoi utilizzare la stessa configurazione descritta in Compilazione per ndk-build o CMake per i tuoi eseguibili. Sposta gli eseguibili su un dispositivo con Android 14 o versioni successive ed eseguili normalmente utilizzando la shell.

Se utilizzi libc++, assicurati di utilizzare la libreria STL condivisa, caricala sul dispositivo e imposta LD_LIBRARY_PATH sulla directory che la contiene quando esegui il file binario.

Se non utilizzi Gradle, consulta la documentazione NDK per scoprire come eseguire la compilazione dalla riga di comando con CMake e ndk-build.

Android 13 o versioni precedenti: configurazione

Se il tuo dispositivo è con Android 14 o versioni successive, puoi saltare questo passaggio e seguire le istruzioni per l'utilizzo di wrap.sh nella sezione Compilazione. Puoi anche scegliere di seguire questa sezione e saltare le istruzioni per l'utilizzo di wrap.sh.

Prima di Android 14, le applicazioni HWASan richiedono una build HWASan di Android per poter funzionare. Puoi eseguire il flashing di immagini HWASan precompilate sui dispositivi Pixel supportati. Le build sono disponibili su ci.android.com, dove puoi fare clic sul riquadro della build esatta che vuoi per ottenere un link a Flash Build. Per farlo, devi conoscere il nome in codice del tuo smartphone.

Potrebbe essere più semplice andare direttamente su flash.android.com, perché lì il flusso inizia con il rilevamento del dispositivo e mostra solo le build che puoi utilizzare. Le seguenti immagini illustrano il flusso di configurazione in questo strumento.

Attiva la modalità sviluppatore sul dispositivo e collegalo al computer con un cavo USB. Fai clic su Aggiungi nuovo dispositivo, seleziona il dispositivo dalla finestra di dialogo e fai clic su Connetti.

Una volta connesso il dispositivo, fai clic su di esso per configurare la compilazione. Nella casella Seleziona un ID build, seleziona il ramo aosp-master-with-phones-throttled per scegliere automaticamente l'immagine corretta per il dispositivo collegato.

Fai clic su Installa per eseguire il flashing del dispositivo.

Puoi trovare ulteriori dettagli sulla configurazione necessaria nella documentazione di Android Flash Tool. In alternativa, puoi consultare la documentazione AOSP per istruzioni su come creare un'immagine HWASan dal codice sorgente.