如何在 C++ 中优雅的计时

· · 科技·工程

在日常生活中,我们常常需要给代码的某个部分单独计时,如统计十个函数中每一个函数的总运行时间。如果我们给每个函数的开头和结尾都加上计时器,再给每个函数定义一个变量,这样虽然可以,但是就显得有点麻烦了,还容易不小心把计时器停止的代码放在 return 后而导致出错。为了避免这些问题发生,我写了一个高效、稳定、方便的计时器。

基础版:

这个是之前我测 FFT 速度时候写的,感觉还不错,就放上来了。原理很简单,这里就不过多介绍了,相信大家都会用。

#define timer(func,args...) do{auto st=clock();func(args);std::clog<<#func<<":"<<double(clock()-st)/CLOCKS_PER_SEC*1000<<"ms\n";}while(0)
#define timerL(name) auto st_##name=clock();
#define timerR(name) std::clog<<#name<<":"<<double(clock()-st_##name)/CLOCKS_PER_SEC*1000<<"ms\n";
#define timerF(f...) do{auto st=clock();f;std::clog<<#f<<":"<<double(clock()-st)/CLOCKS_PER_SEC*1000<<"ms\n";}while(0)

进阶版:

先放代码(注:immintrin.h 仅用于导入 _rdtsc() 函数以获取当前的 cpu 周期数):

#include<chrono>
#include<iostream>
#include<immintrin.h>
#include<unordered_map>
struct FuncStat{uint64_t cnt,t,f;void output(){std::clog<<cnt<<" "<<t/1e9<<" "<<f;}};
struct FuncTester{
    FuncStat &s;
    int &dep;
    FuncTester(FuncStat &s,int &dep):s(s),dep(dep){
        s.cnt++;
        if ((dep++)==0){s.t-=std::chrono::steady_clock::now().time_since_epoch().count();s.f-=_rdtsc();}
    }
    ~FuncTester(){
        if ((--dep)==0){s.t+=std::chrono::steady_clock::now().time_since_epoch().count();s.f+=_rdtsc();}
    }
    FuncTester(const FuncTester&)=delete;
    FuncTester& operator=(const FuncTester&)=delete;
};
struct Recorder{
    std::unordered_map<std::string,FuncStat*> m;
    ~Recorder(){
        std::clog<<"Time:\n";
        for (const auto &[x,y]:m){
            std::clog<<x<<": ";
            y->output();
            std::clog<<"\n";
        }
    }
};
inline Recorder &reg_func(){static Recorder r;return r;}
#define CONCAT_(a,b) a##b
#define CONCAT(a,b) CONCAT_(a,b)
#define TESTFUNC_IMPL(id)\
static FuncStat CONCAT(_stat_,id);\
static int CONCAT(_dep_,id)=0;\
[[maybe_unused]] static const bool CONCAT(_reg_,id)=((reg_func().m.emplace(__PRETTY_FUNCTION__,&CONCAT(_stat_,id))),true);\
FuncTester CONCAT(_test_,id)(CONCAT(_stat_,id),CONCAT(_dep_,id))
#define TESTFUNC() TESTFUNC_IMPL(__COUNTER__)

用法:

在要计时的函数的内部的第一行加上 TESTFUNC(); 即可,十分方便,如:

int add(int x,int y){
    TESTFUNC();
    return x+y;
}

默认情况下程序会在结束时自动向标准错误流中输出各个函数的调用次数,运行时间和 cpu 周期数(可以理解为运行时间乘 cpu 主频)。若整个代码中没有 TESTFUNC 的调用,那么就没有任何额外开销。

原理:

代码使用 C++ 中的 RAII 机制自动控制计时器的开始和停止,无论是运行到函数末尾退出,提前 return,还是中途抛出异常,计时器都可以正常终止。

__COUNTER__ 宏用来生成互不相同的变量名,防止重复定义,__PRETTY_FUNCTION__ 宏用来获取调用的函数的详细名称(包括参数类型,返回值类型等,如果嫌输出太长,可以改成 __FUNCTION__,但是这样可能出现相同名称的函数的统计数据都被放在一起的情况)。dep 变量用于记录递归深度,防止出现一个函数的总时间比整个代码的运行时间都长的奇观。unordered_map 中存储 static 变量的指针存储函数名和计时信息的对应关系,保证每个函数最多访问一次哈希表,尽可能减小了运行时开销。

大家也可以按照自己的需求修改 FuncStat 和 FuncTester 中的内容,如只测量 cpu 周期或计算用时的方差等,下面是一份只测量调用次数和 cpu 周期的示例:

struct FuncStat{uint64_t cnt,f;void output(){std::clog<<cnt<<" "<<f;}};
struct FuncTester{
    FuncStat &s;
    int &dep;
    FuncTester(FuncStat &s,int &dep):s(s),dep(dep){
        s.cnt++;
        if ((dep++)==0){s.f-=_rdtsc();}
    }
    ~FuncTester(){
        if ((--dep)==0){s.f+=_rdtsc();}
    }
    FuncTester(const FuncTester&)=delete;
    FuncTester& operator=(const FuncTester&)=delete;
};

提示:可以在 main 函数开头加上计时器来测量整个程序的用时。

性能测试:

给运行 10^7 次的空函数计时,总耗时约 0.7s,平均每次调用耗时 0.07\mu s,210 个 cpu 周期。若去掉 chrono 计时,只统计调用次数和 cpu 周期数,那么总用时减小到了约 0.14s,平均每次调用耗时 0.014\mu s,42 个 cpu 周期,可见计时器的开销并不大,在运行次数较少时通常可以忽略。但这相对于一些较小的函数来讲开销还是比较大的,可能出现计时器占了大部分时间的现象。

注意:这份代码没有保证线程安全性,可能会有多个线程互相竞争,若需要在多线程场景下使用,请把操作都改为原子操作。