Limpador de endereços

O Android NDK é compatível com o Limpador de endereços a partir do nível 27 da API (Android O MR 1).

O Limpador de endereços (ASan) é uma ferramenta rápida baseada em compilador para detectar bugs de memória no código nativo. O ASan detecta:

  • Overflow/underflow do buffer de heap e pilha
  • Uso de heap depois de Free
  • Uso de pilha fora do escopo
  • Double free/wild free

O ASan é executado em ARM de 32 e de 64 bits, além de x86 e x86-64. A sobrecarga de CPU do ASan é aproximadamente duas vezes, a sobrecarga de tamanho do código está entre 50% e duas vezes, e a sobrecarga de memória é grande (dependendo dos padrões de alocação, mas cerca de duas vezes).

Para o ARM de 64 bits, o HWASan pode ser uma opção melhor.

Criar

Para criar o código nativo do app (JNI) com o Limpador de endereços, faça o seguinte:

ndk-build

No Application.mk:

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

Para cada módulo do Android.mk:

LOCAL_ARM_MODE := arm

CMake

No build.gradle do seu módulo:

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

Para cada destino no CMakeLists.txt:

target_compile_options(${TARGET} PUBLIC -fsanitize=address -fno-omit-frame-pointer)
set_target_properties(${TARGET} PROPERTIES LINK_FLAGS -fsanitize=address)

Executar

A partir do Android O MR1 (API de nível 27), um app pode fornecer um script wrap.sh que pode ajustar ou substituir o processo do app. Isso permite que um app depurável personalize a inicialização do app, o que permite o uso do limpador em dispositivos de produção.

  1. Adicione android:debuggable ao manifesto do aplicativo.
  2. Adicione a biblioteca do limpador no tempo de execução ao jniLibs do módulo do app.
  3. Adicione arquivos wrap.sh com os seguintes conteúdos a cada um dos mesmos diretórios.

    #!/system/bin/sh
    HERE="$(cd "$(dirname "$0")" && pwd)"
    export ASAN_OPTIONS=log_to_syslog=false,allow_user_segv_handler=1
    ASAN_LIB=$(ls $HERE/libclang_rt.asan-*-android.so)
    if [ -f "$HERE/libc++_shared.so" ]; then
        # Workaround for https://github.com/android-ndk/ndk/issues/988.
        export LD_PRELOAD="$ASAN_LIB $HERE/libc++_shared.so"
    else
        export LD_PRELOAD="$ASAN_LIB"
    fi
    "$@"
    

Se o módulo do app do seu projeto for nomeado app, sua estrutura de diretórios final precisará incluir o seguinte:

<project root>
└── app
    └── src
        └── main
            ├── jniLibs
            │   ├── arm64-v8a
            │   │   └── libclang_rt.asan-aarch64-android.so
            │   ├── armeabi-v7a
            │   │   └── libclang_rt.asan-arm-android.so
            │   ├── x86
            │   │   └── libclang_rt.asan-i686-android.so
            │   └── x86_64
            │       └── libclang_rt.asan-x86_64-android.so
            └── resources
                └── lib
                    ├── arm64-v8a
                    │   └── wrap.sh
                    ├── armeabi-v7a
                    │   └── wrap.sh
                    ├── x86
                    │   └── wrap.sh
                    └── x86_64
                        └── wrap.sh

Stack traces

O Limpador de endereços precisa desvincular a pilha em cada chamada malloc/realloc/free. Há duas opções aqui:

  1. Um desbobinador de frame baseado em ponteiro “rápido”. É o que é usado de acordo com as instruções na seção de compilação.

  2. Desbobinador de CFI "lento". Nesse modo, o limpador usa _Unwind_Backtrace. Ele requer apenas -funwind-tables, que normalmente é ativado por padrão.

O desbobinador rápido é o padrão para malloc/realloc/free. O desbobinador lento é o padrão para stack traces fatais. O desbobinador lento pode ser ativado para todos os stack traces adicionando fast_unwind_on_malloc=0 à variável ASAN_OPTIONS no seu wrap.sh.