使用 build.gradle 的 android studio 地址清理器

Question

我正在尝试使用此处描述的地址清理程序（https://github.com/google/sanitizers/wiki/AddressSanitizer，更准确地说是：https://github.com/google/sanitizers/wiki/AddressSanitizerOnAndroid）构建（使用 clang）我的应用程序，但我无法理解整个过程，尤其是使用 gradle。

看起来至少有 3 种方法可以启用它：

1°) 在第一个链接之后，t 表示您所要做的就是这样做：

• 将-fsanitize=address 添加到cppFlags + 可选-fno-omit-frame-pointer

• 将-fsanitize=address 添加到链接器标志（有必要吗？）

2°) 在第二个链接之后，您似乎必须这样做：

• 和第一个一样
• root 设备，然后通过 adb 在其上运行 asan_device_setup
• 在某处添加LD_PRELOAD=libclang_rt.asan-arm-android.so？我想它应该放在 gradle externalNativeBuild 的“参数”部分？但是应用程序在哪里可以找到这个库？我必须自己链接吗？还是它已经在设备上的某个地方？

3°）我还找到了一种“新”的方法，它不需要 root 访问权限（确实可以，但它是一个错误，需要在某个时候纠正）：

https://virtualrealitypop.com/oreo-ndk-secrets-7d075a9b084

这个方法实际上做了第一点和第二点所做的事情，并且通过启动一个导出一些值的 shell 脚本来运行应用程序，以便 asan 工作。

---

就我的调查而言，我对在我的根模拟器上运行完全清理的应用程序（带有静态链接库）的正确方法有点困惑。

我走的更远是实际构建和启动应用程序（使用 2°），但没有指定 LD_PRELOAD 标志），但应用程序在某些 eglMakeCurrent 函数中崩溃，容器溢出甚至不是我的一部分代码，我没有得到任何堆栈：

02-19 16:26:21.553 28771-28789/com.mycompany.myapp I/zygote: Background concurrent copying GC freed 10159(1175KB) AllocSpace objects, 12(304KB) LOS objects, 50% free, 2MB/4MB, paused 144.861ms total 1.252s
[ 02-19 16:26:21.554 28771:28956 I/         ]
=================================================================
[ 02-19 16:26:21.554 28771:28956 I/         ]
[ 02-19 16:26:21.557 28771:28956 I/         ]
[ 02-19 16:26:21.563 28771:28956 I/         ]
==28771==ERROR: AddressSanitizer: container-overflow on address 0xa136e990 at pc 0xa49849e2 bp 0x82e60558 sp 0x82e60128
[ 02-19 16:26:21.563 28771:28956 I/         ]
[ 02-19 16:26:21.565 28771:28956 I/         ]
[ 02-19 16:26:21.566 28771:28956 I/         ]
WRITE of size 2 at 0xa136e990 thread T334 (GLThread 337)
[ 02-19 16:26:21.566 28771:28956 I/         ]

我不确定这是否是真正的溢出，因为我不确定我的所有应用程序都是用消毒剂构建的（我已经用它构建了我的 so+ 我所有的静态数据，但够了吗？），https://github.com/google/sanitizers/wiki/AddressSanitizerContainerOverflow 说如果你的整个应用没有使用消毒剂构建，您可能会得到误报。

所以我的问题是：

A°) 有人真的设法使用 android studio 构建了一个经过清理的应用程序吗？

B°) 如果是，那么正确的方法是什么（意味着将被支持的方法）？

Answer 1

所以经过一番挣扎，我使用了中描述的方法 https://virtualrealitypop.com/oreo-ndk-secrets-7d075a9b084。我在 build.gradle 中添加了一个新的 sanitize_debug 目标，其中包含以下内容：

tasks.whenTaskAdded { task ->
    if (task.name == 'generateSanitize_debugBuildConfig') {
        task.dependsOn createWrapScriptAddDir
    }
}

task deleteASAN(type: Delete) {
    delete 'jni/sanitizer/'
}

static def writeWrapScriptToFullyCompileJavaApp(wrapFile, abi) {
    if(abi == "armeabi" || abi == "armeabi-v7a")
        abi = "arm"
    if(abi == "arm64-v8a")
        abi = "aarch64"
    if (abi == "x86")
        abi = "i686"
    wrapFile.withWriter { writer ->
        writer.write('#!/system/bin/sh\n')
        writer.write('HERE="$(cd "$(dirname "$0")" && pwd)"\n')
        writer.write('export ASAN_OPTIONS=log_to_syslog=false,allow_user_segv_handler=1\n')
        writer.write('export ASAN_ACTIVATION_OPTIONS=include_if_exists=/data/local/tmp/asan.options.b\n')
        writer.write("export LD_PRELOAD=\$HERE/libclang_rt.asan-${abi}-android.so\n")
        writer.write('\$@\n')
    }
}


task copyASANLibs {
    def libDirs = android.ndkDirectory.absolutePath + "/toolchains/llvm/prebuilt/"

    for (String abi : rootProject.ext.abiFilters) {
        def destDir = new File("wizards/src/sanitize_debug/jniLibs/" + abi)
        destDir.mkdirs()

        def renamedAbi = abi
        if(abi == "armeabi-v7a" || abi == "armeabi")
            renamedAbi = "arm"
        if(abi == "arm64-v8a")
            renamedAbi = "aarch64"
        if (abi == "x86")
            renamedAbi = "i686"


        FileTree tree = fileTree(dir: libDirs).include("**/*asan*${renamedAbi}*.so")
        tree.each { File file ->
            copy {
                from file
                into destDir.absolutePath
            }
        }
    }
}
task createWrapScriptAddDir(dependsOn: copyASANLibs) {
    for (String abi : rootProject.ext.abiFilters) {
        def dir = new File("wizards/src/sanitize_debug/resources/lib/" + abi)
        dir.mkdirs()
        def wrapFile = new File(dir, "wrap.sh")
        wrapFile.setExecutable(true, false)
        writeWrapScriptToFullyCompileJavaApp(wrapFile, abi)
    }
}

需要改进的地方是

1°) 切换到未经清理的构建时的清理阶段必须手动调用，

2°) 为所有 arm 架构构建和打包包装脚本，这是一种解决方法，即您无法轻松地为 wrap.sh 脚本指定目标架构（请参阅错误https://issuetracker.google.com/issues/74058603）

Answer 2

我花了几个小时弄清楚如何仅在调试版本中启用 sanitizer。这是我的完整解决方案（基于downstroy 和JE42 - 谢谢）：

Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())

project.ext {
    ndkDir = properties.getProperty('ndk.dir')
}

task deleteASAN(type: Delete) {
    delete 'app\\src\\sanitizer'
}

clean.dependsOn(deleteASAN)

static def writeWrapScriptToFullyCompileJavaApp(wrapFile, arch) {
    wrapFile.withWriter { writer ->
        writer.write('#!/system/bin/sh\n')
        writer.write('HERE="$(cd "$(dirname "$0")" && pwd)"\n')
        writer.write('export ASAN_OPTIONS=log_to_syslog=false,allow_user_segv_handler=1\n')
        writer.write('export ASAN_ACTIVATION_OPTIONS=include_if_exists=/data/local/tmp/asan.options.b\n')
        writer.write("export LD_PRELOAD=\$HERE/libclang_rt.asan-${arch}-android.so\n")
        writer.write('cmd=$1\n')
        writer.write('shift\n')
        writer.write('os_version=$(getprop ro.build.version.sdk)\n')
        writer.write('if [ "$os_version" -eq "27" ]; then\n')
        writer.write('cmd="$cmd -Xrunjdwp:transport=dt_android_adb,suspend=n,server=y -Xcompiler-option --debuggable $@"\n')
        writer.write('elif [ "$os_version" -eq "28" ]; then\n')
        writer.write('cmd="$cmd -XjdwpProvider:adbconnection -XjdwpOptions:suspend=n,server=y -Xcompiler-option --debuggable $@"\n')
        writer.write('else\n')
        writer.write('cmd="$cmd -XjdwpProvider:adbconnection $@"\n')
        writer.write('fi\n')
        writer.write('exec $cmd\n')
    }
}

def copySanitizerLibAndWrapScript(ndkdir) {
    def sanitizerLibDir = new File(ndkdir).absolutePath + "\\toolchains\\llvm\\prebuilt\\"

    for (String abi in ['armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64']) {
        def arch = abi
        if (abi == "armeabi-v7a") {
            arch = "arm"
        } else if (abi == 'arm64-v8a') {
            arch = "aarch64"
        } else if (abi == "x86") {
            arch = "i686"
        } else if (abi == "x86_64") {
            arch = "x86_64"
        }

        def sanitizerLibAbiDir = new File("app\\src\\sanitizer\\jniLibs\\" + abi)
        sanitizerLibAbiDir.mkdirs()
        FileTree sanitizerLibAbiFileTree = fileTree(dir: sanitizerLibDir).include("**\\*asan*${arch}*.so")

        sanitizerLibAbiFileTree.each { File file ->
            copy {
                from file
                into sanitizerLibAbiDir.absolutePath
            }
        }

        def wrapScriptAbiDir = new File("app\\src\\sanitizer\\resources\\lib\\" + abi)
        wrapScriptAbiDir.mkdirs()
        def wrapFile = new File(wrapScriptAbiDir, "wrap.sh")
        wrapFile.setExecutable(true, false)
        writeWrapScriptToFullyCompileJavaApp(wrapFile, arch)
    }
}

gradle.taskGraph.whenReady { if (it.hasTask(generateDebugBuildConfig)) {
    copySanitizerLibAndWrapScript(rootProject.ext.ndkDir)
} }

Answer 3

为了也进行调试，您可以调整来自downstroy 的答案并调整 wrap.sh 脚本，因为 wrap.sh 的简单版本会阻止调试（来自https://developer.android.com/ndk/guides/wrap-script）：

        writer.write('#!/system/bin/sh\n')
        writer.write('HERE="$(cd "$(dirname "$0")" && pwd)"\n')
        writer.write('export ASAN_OPTIONS=log_to_syslog=false,allow_user_segv_handler=1\n')
        writer.write('export ASAN_ACTIVATION_OPTIONS=include_if_exists=/data/local/tmp/asan.options.b\n')
        writer.write("export LD_PRELOAD=\$HERE/libclang_rt.asan-${abi}-android.so\n")
        writer.write('cmd=$1\n')
        writer.write('shift\n')
        writer.write('os_version=$(getprop ro.build.version.sdk)\n')
        writer.write('if [ "$os_version" -eq "27" ]; then\n')
        writer.write('cmd="$cmd -Xrunjdwp:transport=dt_android_adb,suspend=n,server=y -Xcompiler-option --debuggable $@"\n')
        writer.write('elif [ "$os_version" -eq "28" ]; then\n')
        writer.write('cmd="$cmd -XjdwpProvider:adbconnection -XjdwpOptions:suspend=n,server=y -Xcompiler-option --debuggable $@"\n')
        writer.write('else\n')
        writer.write('cmd="$cmd -XjdwpProvider:adbconnection $@"\n')
        writer.write('fi\n')
        writer.write('exec $cmd\n')