工程师必备：C/C++单元测试万能插桩工具

优化研发效能的动态插桩工具

研发效能是一个广泛讨论的话题，它涉及软件交付的整个生命周期，包括产品、架构、开发、测试和运维等环节，每个环节都对持续有效的高质量交付产生影响。在腾讯安全平台部的研发与测试工作中，我们发现代码插桩隔离是单元测试工作中的一个迫切需求。然而，当前业界存在的C/C++插桩工具使用上存在局限性，运行效率和体验方面仍有很大改进空间。因此，本文介绍了我们团队基于研发效能优化实践而自主研发的动态插桩工具，旨在实现轻量化运行的单元测试，提高代码覆盖率，进而助力研发团队提升效能。

问题与思路

目前现有的C/C++插桩工具基本上都存在各种使用上的限制。例如，广受欢迎的gmock只能对C++的虚函数进行插桩替换，对于非虚函数则需要对被测代码进行修改。同时，对于系统接口和C风格的第三方库代码，现有工具也无能为力。

如果能够绕过编译器，从底层入手，例如对机器指令进行修改，就可以摆脱语法和编译器的限制，直接达到目的。这样的话，在使用中几乎不受限制。

原理

将C/C++语言编译后生成的可执行代码实际上就是一个个函数的实现，每个函数的开头就是它的入口。当一个函数A调用另一个函数B时，控制流就从函数A某处跳转到函数B的开头。因此，如果想要用一个新的函数C取代函数B的执行，可以在函数B的开头以机器码的形式写入如下等价逻辑：

MOVQ ADDRESS_OF_C %RAX //将函数C的地址存入寄存器RAX
JMPQ *RAX           //无条件跳转到RAX所指向的位置

这样，当控制流从函数A进入函数B的开始位置时，会执行上述代码，直接跳转到函数C的开头。这样的效果就是，所有对函数B的调用都变为了对函数C的调用。

基于上述原理，被插桩的代码不仅包括第三方库（如MySql、其他同事未完成的模块），还包括操作系统的API接口（如read、select等）。

同时，插桩函数不仅能够模拟原函数的返回值，实际上作为一个普通的C函数，还对原函数具有完全的操作能力。例如，它可以访问传递给原函数的真实参数、C++成员变量（用于模拟成员函数），可以返回任意给定的值，可以访问全局变量，也可以对函数调用进行计数等操作。

在实际实现中，为了确保不同测试用例之间的互不干扰，除了能够进行函数替换外，还需要在执行完一个测试用例后恢复现场。具体细节可以参考相关代码。

使用

对全局函数插桩

原始函数：

int global(int a, int b) {
    return a + b;
}

对应的桩函数：

int fake_global(int a, int b) {
    //校验参数正确性，确定被测代码传入了正确的值
    assert(a == 3);
    assert(b == 2);
    //给一个返回值，配合被测代码走特定分支
    return a - b;
}

插桩示例：

assert(global(3, 2) == 5);

//通过mock调用，完成函数动态替换
assert(0 == mock(&global, &fake_global));

//调用mock后的函数，可以看到返回值变了
assert(global(3, 2) == 1);

//结束mock
reset();

//函数行为恢复
assert(global(3, 2) == 5);

对普通成员函数插桩

被测代码：

class A {
public:
    int member(int a) {return ++a;}
    static int static_member(int a) {return 200;}
    virtual int virtual_member() {return 400;}
};

桩函数：

int fake_member(A *pTihs, int a) {
  //由于是对成员函数插桩,这里需要这个this指针参数
    return --a;
}

插桩示例：

A a;
assert(a.member(100) == 101);

mock(&A::member, fake_member);
assert(a.member(100) == 99);

reset();

assert(a.member(100) == 101);

对静态成员函数插桩

桩函数：

int fake_static_member() {
  //静态函数不需要this指针
    return 300;
}

插桩示例：

assert(A::static_member(200) == 200);

mock(&A::static_member, fake_static_member);
assert(A::static_member(100) == 300);

reset();

assert(A::static_member(200) == 200);

对虚函数插桩

桩函数：

int fake_virtual_member(A *pThis) {
    //虚函数同普通的成员函数由于,同样需要this指针
    return 500;
}

插桩示例：

A a;
assert(a.virtual_member() == 400);

//虚函数mock需要多传一个相关类的对象，任意一个对象即可，跟实际代码中的对象没有关系
A a_obj;
mock(&A::virtual_member, fake_virtual_member, &a_obj);
assert(a.virtual_member() == 500);

reset();
assert(a.virtual_member() == 400);

对系统及第三方库函数插桩

桩函数：

int fake_write(int, char*, int) {
    return 100;
}

插桩示例：

//直接写入一个无效的文件描述符，会失败
assert(write(5, "hello", 5) == -1);

//来一个假的wirte
mock(write, fake_write);
//模拟调用成功
assert(write(5, "hello", 5) == 100);

reset();

assert(write(5, "hello", 5) == -1);

可以看到，对系统函数的 mock,其实跟普通的全局函数并无两样，第三方库函数也是同理。

使用限制&注意事项

• 目前支持 X86_64 平台上的 Linux、MacOS 系统，如有需求，Windows 和其它硬件平台，如 X86_32、ARM，也可在短期内支持。
• MacOS 下，需要在执行前对单测可执行文件做以下修改：

printf '\x07' | dd of= bs=1 seek=160 count=1 conv=notrunc

• 显然，这种方法对内联函数无效，不过对于单元测试来说，可以关闭内联，同时也建议关闭其它编译器优化。
• 可以使用-fno-access-control 编译你的测试代码，可以使 g++关闭 c++成员的访问控制（即 protected 及 private 不再生效）。

项目地址

https://github.com/wangyongfeng5/lmock

结语

持续改进是研效工具平台发展的必经之路，欢迎感兴趣的同学与我们交流探讨，共同助力测试效能的优化。

以上就是良许教程网为各位朋友分享的Linu系统相关内容。想要了解更多Linux相关知识记得关注公众号“良许Linux”，或扫描下方二维码进行关注，更多干货等着你 ！