静态代码插桩

最新推荐文章于 2024-05-29 14:41:42 发布
最新推荐文章于 2024-05-29 14:41:42 发布
阅读量2.6k 收藏 6
点赞数 3
分类专栏： iOS 开发
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WangErice/article/details/113204871
版权

静态代码插桩


代码插桩是指根据一定的策略在代码中插入桩点来统计代码覆盖的技术手段.一般可以分为三个粒度：

  • 函数(function): 按照函数为单位进行插桩；
  • 基本块(basic block): 按照代码执行单元进行分组的执行单元，单元内部的代码执行次数一定是相同的；
  • 边界(Edge): 按照代码执行路径进行插桩。

针对iOS来说，clang支持以上粒度的插桩方式。这里先介绍一些函数粒度的插桩实现.

函数覆盖

Clang 是一个高度模块化开发的轻量级编译器。可以通过设置Clang的编译参数实现静态插桩.

  • 在Xcode->Build Settings中搜索"Other C Flags",然后在其中添加
// 基本块覆盖可以使用参数:  -fsanitize-coverage=bb,trace-pc-guard
// 边缘覆盖可以使用参数:  -fsanitize-coverage=edge,trace-pc-guard
-fsanitize-coverage=func,trace-pc-guard

同时在任意实现文件中添加一下两个函数：

// 哨兵初始化函数，其中[*start,*end)表示了哨兵的标志,这里可以理解为每个哨兵guard是一个指针，保存了一个uint32_t的整形数据来作为自己的标记
void __sanitizer_cov_trace_pc_guard_init(uint32_t *start, uint32_t *stop) {
  static uint32_t N;  // Counter for the guards.
  if (start == stop || *start) return;  // Initialize only once.
    for (uint32_t *x = start; x < stop; x++) {
        *x = ++N;  // Guards should start from 1.
    }
}

// 当每个函数开始调用时会被插入该回调，所以在方法调用开始就会执行该回调。函数中guard就是__sanitizer_cov_trace_pc_guard_init中[start, end)区间中一个
void __sanitizer_cov_trace_pc_guard(uint32_t *guard) {
	printf("guard = %p, *guard=%d", guard, *guard);
// 在这里可以尝试获取到执行函数的信息
}

然后运行项目会发现，回调正常执行.那么问题来了，如何在回调函数中获取到当前执行函数的信息呢？

获取当前执行函数的信息

在汇编语言中，如果函数包含了子函数，则方法执行过程中会在进行bl跳转指令之前将下一条指令的地址保存在特定的寄存器中(x30寄存器)，而clang中封装了这样的获取方法：

// 返回当前函数或其调用者的返回地址，LEVEL表示调用层级：
// 0: 表示当前函数的返回地址；
// 1:表示当前函数调用者的返回地址，依次类推
void *__builtin_return_address(int LEVEL);

拿到改地址之后如何获取该方法的信息呢？系统同样提供了开放的方法。在 dlfcn.h 中有一个方法如下 :

typedef struct dl_info {
        const char      *dli_fname;     /* 所在文件 */
        void            *dli_fbase;     /* 文件地址 */
        const char      *dli_sname;     /* 符号名称 */
        void            *dli_saddr;     /* 函数起始地址 */
} Dl_info;

//这个函数能通过函数内部地址找到函数符号
int dladdr(const void *, Dl_info *);

这样就可以通过函数内部的地址获取到函数的符号信息：

void __sanitizer_cov_trace_pc_guard(uint32_t *guard) {
    // 获取寄存器中下一条指令的地址
    void *PC = __builtin_return_address(0);
    Dl_info info;
    // 通过函数内部地址获取当前函数的符号信息
    dladdr(PC, &info);
    printf("fname=%s \nfbase=%p \nsname=%s\nsaddr=%p \n",info.dli_fname,info.dli_fbase,info.dli_sname,info.dli_saddr);
}

再次启动工程就可以发现，已经获取到了项目中执行方法的符号信息.

fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=main
saddr=0x1008257d4 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[AppDelegate application:didFinishLaunchingWithOptions:]
saddr=0x100825520 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate window]
saddr=0x100825d08 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate setWindow:]
saddr=0x100825d60 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate window]
saddr=0x100825d08 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate window]
saddr=0x100825d08 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate scene:willConnectToSession:options:]
saddr=0x1008259f4 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate window]
saddr=0x100825d08 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate window]
saddr=0x100825d08 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate window]
saddr=0x100825d08 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[ViewController setImageView:]
saddr=0x10082541c 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[ViewController viewDidLoad]
saddr=0x100824538 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate sceneWillEnterForeground:]
saddr=0x100825c20 
fname=/private/var/containers/Bundle/Application/9B098A1A-27A2-48C4-8402-B528A872C362/Demo001.app/Demo001 
fbase=0x100820000 
sname=-[SceneDelegate sceneDidBecomeActive:]
saddr=0x100825b38

保存符号

既然获得了符号，就需要对符号进行保存，以留作后续使用.这里尝试保存在第一个界面正式出现之前的所有符号。
为了方便操作将上述两个方法从main中移动到第一个控制器中.

  • 由于回调函数可能出在多个线程中，为了线程安全，同时减少频繁加锁开锁的系统开销使用原子队列来进行数据存储.
    需要注意的是，原子队列只能添加结构体节点，不能直接添加oc对象节点。
#import <libkern/OSAtomic.h>
// 向队列中添加节点
void  OSAtomicEnqueue( OSQueueHead *__list, void *__new, size_t __offset);

// 可以使用循环从院子队列中取出元素
void* OSAtomicDequeue( OSQueueHead *__list, size_t __offset);
  • 初始化原子队列,并定义结构体节点：
static OSQueueHead queueHead = OS_ATOMIC_QUEUE_INIT;
// 定义节点
struct SYNode {
    char *symbol; // 记录符号
    struct SYNode *next; // 记录符号的写一个地址
};
  • 向节点中写入数据：
void __sanitizer_cov_trace_pc_guard(uint32_t *guard) {
    if (!*guard) return;  // Duplicate the guard check.

    void *PC = __builtin_return_address(0);
    Dl_info info;
    dladdr(PC, &info);
    
//
//    printf("fname=%s \nfbase=%p \nsname=%s\nsaddr=%p \n",info.dli_fname,info.dli_fbase,info.dli_sname,info.dli_saddr);
    
    
    char *symbol = malloc(sizeof(char) * strlen(info.dli_sname));
    strcpy(symbol, info.dli_sname);
    struct SYNode *node = malloc(sizeof(struct SYNode));
    *node = (struct SYNode){symbol, NULL};
    // 向节点中写入数据
    OSAtomicEnqueue(&queueHead, node, offsetof(struct SYNode, next));
}
  • 在控制器的viewDidAppear方法中，获取院子队列中的符号信息，并进行本地保存：
- (void)viewDidAppear:(BOOL)animated {
    [super viewDidAppear:animated];
    
    NSMutableArray<NSString *> *allSymbols = [NSMutableArray array];
    
    struct SYNode *node = OSAtomicDequeue(&queueHead, offsetof(struct SYNode, next));
    while (node) {
        NSLog(@"--->%s", node->symbol);
        
        [allSymbols addObject:[NSString stringWithUTF8String:node->symbol]];
        free(node);
        node = OSAtomicDequeue(&queueHead, offsetof(struct SYNode, next));
    }
    
    NSString *cacheRootPath = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, true).firstObject;
    NSString *path = [cacheRootPath stringByAppendingPathComponent:@"symbols.txt"];

    
    dispatch_async(dispatch_get_global_queue(0, 0), ^{
        BOOL success = [allSymbols writeToFile:path atomically:true];
         NSLog(@"写入%@", success ? @"成功" : @"失败");
    });
}
  • 使用Xcode连接真机，启动应用直至第一个控制器界面家在完成.使用快捷键cmd+shift+2进入Devices and Simulators界面，选择对应应用并点击Download Containers选择保存路径下载文件。
    在这里插入图片描述
  • 在下载的.xcappd中右键显示包内容，在AppData->Library->Caches路径下即可保存的.txt文件.
    由于队列的特性，这里的符号与实际调用顺序是相反的。
    在这里插入图片描述

这样就可查看到在应用首个控制器显示之前系统调用的所有符号，从而为应用启动优化奠定基础.

静态插桩作用

通过静态插桩，可以查看项目中的代码执行情况，进而为项目优化提供依据.

  • 重排二进制文件：可以根据启动时调用的方法，存储在.order文件中，认为干预二进制文件的生成，优化启动速度；
  • 删除无用代码：可以根据项目中方法的执行情况，查看方法的覆盖率，将没有使用到的方法进行删除，减少二进制文件的大小；
  • 跟踪方法调用顺序：可以将调用的符号进行保存来查看应用中方法的调用顺序，跟踪异常。
朗清风
关注
专栏目录
linux静态插桩工具PEBIL
搓雪小怪兽的工作室
04-06 2937
PEBIL是San Diego Supercomputer Center某实验室研发的工具，用来对ELF文件进行静态插桩。主要参考资料为IEEE论文：PEBIL: Efficient Static Binary Instrumentation for Linux和Github项目。本文为学习笔记。
Android 插桩入门，kotlin静态方法
m0_64603776的博客
12-14 325
完成简单的插件模块 增加两个类SimplePlugin类和SimpleTransform类 SimplePlugin.kt class SimplePlugin : Plugin { override fun apply(p0: Project) { val appExtension = p0.extensions.getByType( AppExtension::class.java ) appExtension.registerTransform(SimpleTransform(p0)) } } Sim
源代码插桩是什么意思？如何执行这一操作？
zy1992As的博客
07-26 1131
程序插桩测试方法有效地提高了代码测试覆盖率，但是插桩测试方法会带来代码膨胀、执行效率低下和HeisenBugs，在一般情况下插桩后的代码膨胀率在20%~40%，甚至能达到100%导致插桩测试失败。实际开发软件测试中，这种缺陷也比较常见，例如，测试人员测试到一个缺陷提交给开发人员后，开发人员执行缺陷重现步骤却得不到报告的缺陷，因为缺陷已经消失或者出现了其他缺陷。源代码插桩是指对源文件进行完整的词法、语法分析后，确认插桩的位置，植入探针代相比于目标代码插桩，源代码插桩具有针对性和精确性。
PEBIL静态插桩工具
10-24
PEBIL，一款静态插桩工具，工具实现了三个基本功能，具体情况可以在网上找到相关论文，可以在github上找到，不能上github的可以下载这个！
代码插桩技术
qq_41854911的博客
11-13 1712
程序插桩，最早是由J.C. Huang 教授提出的，它是在保证被测程序原有逻辑完整性的基础上在程序中插入一些（又称为“探测仪”，本质上就是进行信息采集的，可以是或采集覆盖信息的），通过的执行并抛出程序运行的数据，通过对这些数据的，可以获得程序的和数据流信息，进而得到等动态信息，从而实现测试目的的方法。中文名程序插桩外文名提出者J.C. Huang分 类插桩和插桩解 释在中插入一些。
代码插桩【转载】
adocn
06-21 5299
【转载】http://wiki.dzsc.com/info/5081.html 　　代码插桩是实现覆盖测试的关键技术之一，而高效的插桩技术对于嵌入式软件的测试来说又是至关重要的。在对CodeTeST 中插桩技术研究的基础上，以GCC 作为开发平台，应用并实现了新的插装器，采用增加一个词法语法分析器的方法，提高了插桩的效率。经过
SkyWalking8.7源码解析（三）：静态方法插桩、构造器和实例方法插桩、插件拦截器加载流程、JDK类库插件工作原理
hxt的博客
01-02 3430
10、静态方法插桩 Transform的transform()方法中调用每个插件的define()方法去做字节码增强，AbstractClassEnhancePluginDefine的define()方法中再调用自己的enhance()方法做字节码增强，enhance()方法源码如下： public abstract class AbstractClassEnhancePluginDefine { /** * Begin to define how to enhance class. A
“ 字节码插桩 “ 技术简介
MayMatrix 的博客
02-03 1510
性能优化 ,插件化 ,热修复 ,等技术都需要用到" 字节码插桩 "相关技术;OOP 面向对象编程, 主要针对业务逻辑进行开发 ,大特点封装继承多态;大特点 封装 , 继承 , 多态;大特点封装继承多态;AOP 面向切面编程, 主要针对某个动作进行开发;如 : 给 Android 中所有的 Activity 添加安全策略 , 如果每个页面逐个手动添加 , 可能存在遗漏 , 并且会造成代码冗余;通过 AOP 面向切面编程 , 完成上述操作;
ASM插桩在Android项目中的应用
07-16
ASM是一个Java字节码操控和分析框架，它允许动态生成类或修改已有的类，尤其适用于运行时代码增强和静态代码插桩。本文将深入探讨ASM如何在Android项目中发挥作用，以及如何通过ASMInjectTest进行实践。 首先，了解...
【Java.lang Instrumentation与Python的代码插桩】：性能监控与代码分析的结合
![【Java.lang Instrumentation与Python的代码插桩】：性能监控与代码分析的结合]...代码插桩是一种动态分析技术，通过修改程序代码，插入额外的指令或函数调用来收集运行时信息。这种技术广泛应用于性能
覆盖测试中高效代码插桩技术的研究
10-25
代码插桩是实现覆盖测试的关键技术之一，而高效的插桩技术对于嵌入式软件的测试来说又是至关重要的。文章在对CodeTeST 中插桩技术研究的基础上，以GCC 作为开发平台，应用并实现了新的插装器，采用增加一个词法语法分析器的方法，提高了插桩的效率。经过实验证明新的插装器具有代码膨胀率小，插桩速度块的优点，在一定程度上做到了高效插桩。 此内容为AET网站原创，未经授权禁止转载。
Java 进阶 ——代码插桩必知必会之Java字节指令码和Java文件概述
最美不过，心中有梦，身旁有你！
01-20 2238
Java跨平台的本质就是中间产物.class，Java文件经过javac编译后生成字节码文件（.class），再由JVM通过对字节码指令的解释执行，从而屏蔽对操作系统的依赖
Android函数插桩,Android 代码插桩 ~ Misaki’s Blog
weixin_35057850的博客
05-26 460
8种机械键盘轴体对比本人程序员，要买一个写代码的键盘，请问红轴和茶轴怎么选？何为代码插桩​ 最早是由J.C. Huang 教授提出的，它是在保证被测程序原有逻辑完整性的基础上在程序中插入一些探针(又称为“探测仪”，本质上就是进行信息采集的代码段，可以是赋值语或采集覆盖信息的函数调用，通过探针的执行并抛出程序运行的特征数据，通过对这些数据的分析，可以获得程序的控制流和数据流信息，进而得到逻辑...
语法树的Java代码自动化插桩
CCqwas的博客
03-05 2744
代码插桩是测试和定位问题的常用手段，通过在代码对应位置插入相应的代码（“桩”），来打印或收集我们所需要的数据。 自动化插桩，也就是在代码的特定位置，自动的插入我们需要的一行或几行代码。通常我们会在编译后的代码上进行插桩，这样做好处就是避免了对源码的侵入，一定程度上屏蔽了开发者不同的代码风格。这里，我们主要介绍另一种在源码上插桩的方式，如果不考虑对代码的侵入性，那么在源码上直接插桩会更加直观，也就更加容易把控和调试，具有更高的灵活性，而且本文将要介绍的这种方法也无须考虑不同的代码风格。 插桩需求 以
c语言自动插桩,静态插桩的方式来实现Hook Method
weixin_35851508的博客
05-24 930
通过fishhook拦截方法的局限性我之前写了一个开源库TimeProfiler，监控所有的OC方法耗时。可以在开发App阶段，很方便的看到主线程所有OC方法的耗时。但是由于TimeProfiler是通过fishhook基于运行时hook，所以从原理上，它就有局限性：不能选择hook部分类的OC方法。这造成2个很难解决的问题：不能选择hook一部分类的OC方法，全部hook会有性能问题，所以也不能...
程序插桩
alu_xd的博客
07-27 8159
程序插桩技术是在被测程序中插入探针，然后通过探针的执行来获得程序的控制流和数据流信息，以此来实现测试的目的。因此，根据探针插入的时间可以分为目标代码插桩和源代码插桩。目标代码插桩
最通俗易懂的字节码插桩实战（Gradle + ASM）—— 自动埋点
chuyouyinghe的专栏
03-01 1110
字节码插桩，看起来挺牛皮，实际上是真的很牛皮。但是牛皮不代表难学，只需要一点前置知识就能轻松掌握。
最通俗易懂的字节码插桩实战（Gradle + ASM）
2401_83703893的博客
05-10 805
所以在取值的时候要方法参数的数量。2.
彻底搞明白Android字节码插桩
最新发布
Dream It Possible
05-29 325
1、继承DefaultTask。2、声明task执行方法，方法名随意，必须加上@TaskAction注解。3、创建自定义task的时候 指定task类名。4、Gradle 自带的有 Delete、Copy、Zip 等等。/*** 自定义task*///方法名随意 只要加上TaskAction注解println("自定义task 执行")
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值