Linux C/C++调试之一：利用LD_PRELOAD机制监控程序IO操作

#引言
有时，我们为了分析程序的某些问题（例如性能问题），需要对程序的IO操作的频率耗时等数据进行监控。就以经常调用的read和write函数为例，如何监控程序中所有上述两种操作，同时进行计时呢？使用gdb打断点自然是个方法，这样可以很容易发现程序中所有的调用，但是这样就没办法计时了。如果在程序中所有read/write函数前后打上时间戳，就可以实现计时了，但是这会有另一个问题，我们可能调用了某些三方库的接口，可能没办法为三方库的read/write函数打时间戳计时。那么有没有办法既能监控所有read/write函数调用，同时进行计时呢？自然是有的，例如本文下面要讲的——利用LD_PRELOAD机制实现上述目标。
关于LD_PRELOAD的概述，在之前一篇博文我已经进行过描述：CSAPP第三版运行时打桩Segmentation fault。这里贴上其部分内容：

CSAPP第三版7.13.3节提到了运行时打桩机制，它可以在运行时将程序中对共享库函数的调用进行截获，替换为执行自己的代码。这个机制基于动态链接器的LD_PRELOAD环境变量。如果LD_PRELOAD环境变量被设置为一个共享路径名的列表（以空格或分号分隔），那么当加载和执行一个程序，需要解析未定义的引用时，动态链接器（ld-linux.so）会先搜索LD_PRELOAD库，然后才搜索任何其他的库。有了这个机制，当加载和执行任意可执行文件时，可以对共享库中的任何函数打桩，包括libc.so。

我们要做的就是对C标准库的read/write函数进行包装，实现计时功能。同时在运行时利用LD_PRELOAD将C标准库的read/write函数替换成我们的实现。
#包装read/write函数
直接上代码：

#ifndef _GNU_SOURCE
# define _GNU_SOURCE
#endif

#include <stdio.h>
#include <stdlib.h>
#include <dlfcn.h>
#include <unistd.h>
#include <sys/time.h>

// 计时函数，返回值是一个毫秒值
static double getMs()
{
    struct timeval tv;
    gettimeofday(&tv, NULL);
    return tv.tv_sec * 1000 + tv.tv_usec * 0.001;
}

ssize_t read(int fd, void *buf, size_t count)
{
    // 为什么要有print_times这个变量，请查看上面我贴出来的那篇博文
    static __thread int print_times = 0;
    print_times++;
    // 用于保存真正的read函数
    ssize_t (*readp)(int, void *, size_t);
    char *error;
    // 获取真正的read函数
    readp = dlsym(RTLD_NEXT, "read");
    if ((error = dlerror()) != NULL)
    {
        fputs(error, stderr);
        exit(1);
    }
    
    double start = getMs();
    // 调用真正的read函数
    ssize_t result = readp(fd, buf, count);
    double stop = getMs();

    if (print_times == 1)
    {
        // 输出调用read时的实参和耗时
        printf("read(%d, %p, %lu) %lf\n", fd, buf, count, stop - start);
    }
    print_times--;
    return result;
}

ssize_t write(int fd, const void *buf, size_t count)
{
    static __thread int print_times = 0;
    print_times++;

    ssize_t (*writep)(int, const void *, size_t);
    char *error;

    writep = dlsym(RTLD_NEXT, "write");
    if ((error = dlerror()) != NULL)
    {
        fputs(error, stderr);
        exit(1);
    }
    
    double start = getMs();
    ssize_t result = writep(fd, buf, count);
    double stop = getMs();

    if (print_times == 1)
    {
        printf("write(%d, %p, %lu) %lf\n", fd, buf, count, stop - start);
    }
    print_times--;
    return result;
}

上面的代码即能够对read/write函数进行计时，并将计时结果输出到标准输出。
将上面的代码编译成库：

$ gcc -shared -fpic -Wall -Wextra -o libwrapper.so wrapper.c -ldl

这样，我们就得到了一个libwrapper.so文件。
#替换read/write函数
用于测试的demo代码如下：

#include <stdio.h>
#include <stdlib.h>
#include <fcntl.h>
#include <unistd.h>

int main()
{
    int fd = open("test.txt", O_RDWR | O_CREAT | O_TRUNC, 0666);
    if (fd == -1)
    {
        exit(1);
    }

    write(fd, "test", 4);
    lseek(fd, 0, SEEK_SET);
    char buf[5] = {0};
    read(fd, buf, 4);
    close(fd);

    printf("%s\n", buf);
    return 0;
}

编译成可执行文件：

$ g++ main.c

那么如何使用前面生成的libwrapper.so文件呢？就像下面这样：

$ LD_PRELOAD=./libwrapper.so ./a.out

其输出为：

write(3, 0x55a5dd6c29ad, 4) 0.023926
read(3, 0x7ffcf0a92fa3, 4) 0.010010
test

这样，我们就达到了监控read/write函数的目标，对于其他IO库函数，你也可以根据需要进行包装替换。