C 语言的范围卫士

Question

我想在 C 中使用范围保护来进行分析。

我想知道我在某个函数上花费了多少时间。这就是我所做的：

int function() {

  tic();

  ... do stuff ...
  if (something)
  {
    toc();
    return 0;
   }

  toc();
  return 1;
}

每次退出函数时我都需要放置一个 toc 语句。我想这样做，而不必到处复制粘贴目录。有没有通用的方法来做到这一点，使用宏或其他东西？ 另外，我不想更改函数的调用方式，因为我必须分析许多函数。

谢谢

Answer 1

这不会改变函数的调用方式。不过，如果您希望能够分析每个函数，那么可能没有多大用处。

static inline int real_function() {
    // previous contents of function(), with no tic or toc
}

int function() {
    tic();
    int r = real_function();
    toc();
    return r;
}

正如其他人所说：使用分析器，从长远来看，它会为您节省很多精力。正如他们没有说的：如果您的平台有的话。

如果没有，那么最简单的可能是（作为编码规则）函数必须只有一个退出点，并且该退出点必须通过宏。然后，您可以在入口和出口处使用代码手动检测所有函数。具有多个返回值的遗留函数可以像上面那样进行包装。

另外，请记住，当您执行此类操作时，编译器可能会把您搞砸。您可以这样写：

tic();
do_something();
int i = something_else();
toc();
return i;

如果编译器确定 Something_else 没有副作用，那么即使 Something_else 花费大量时间，它也可能将代码变成这样：

tic();
do_something();
toc();
return something_else();

并且您的配置文件数据将低估函数中花费的时间。拥有一个真正的分析器如此好的另一个原因是它可以与编译器合作。

Answer 2

您可以定义一个宏，例如：

#define TOC_RETURN(x) \
    do { \
    toc(); \
    return x; \
    } while(0)

它应该在您放置的任何地方都可以工作。然后，您可以自动将 return *; 替换为 TOC_RETURN(*)。

Answer 3

为什么不使用实际的分析工具，例如 gprof？

Answer 4

您可以通过宏“重新定义”返回：（请参阅免责声明）

#include <stdio.h>

void tic() { printf("tic\n"); }
void toc() { printf("toc\n"; }

#define return toc(); return
int foo() {
    tic();

    return 0;
}
#undef return

int main() {
    foo();
    return 0;
}

免责声明：这可以被认为是丑陋和黑客的，因为：

• 它不适用于 void 函数，除非您使用return;-语句。
• 尽管它可以在 MSVC8 上运行，但它可能不是便携式/标准的。
• 人们不应该定义关键字。

Answer 5

我来晚了，但是还有另一种方法可以使用 GCC 扩展在 C 中进行范围保护 cleanup 属性。 cleanup 属性将一个函数附加到变量声明上，该函数在变量超出范围时运行。最初旨在为动态分配的类型执行内存释放，但它也可以被滥用作为范围保护。

void cleanup_toc(int *ignored __attribute__((__unused__))) { toc(); }

int function(void) {
    tic();
    int atexit __attribute__((__cleanup__(cleanup_toc))) = 0;

    //... do stuff ...
    if (something) {
        return 0;
    }

    return 1;
}

该解决方案不使用宏，但您当然可以将其包装到宏中。例如：

#define CONCATENATE_IMPL(x, y) x ## y
#define CONCATENATE(x, y) CONCATENATE_IMPL(x, y)
#define ATEXIT(f) int CONCATENATE(atexit, __LINE__) __attribute__((__cleanup__(f))) = 0

int function(void) {
    ATEXIT(cleanup1); // These are executed in reverse order, i.e.
    ATEXIT(cleanup2); // cleanup2 will run before cleanup1.
}

Answer 6

我不会推荐为此使用宏。您偶尔会分析一下代码，并且为此目的用一些特殊的宏替换“return”会降低代码的可读性。

这样做不是更好吗？

tic();
call_function();
toc();

这会自动处理函数的“所有退出点”。

PS 为什么不使用分析器？

Answer 7

真正的分析器不需要您修改代码，只需在启用分析的情况下编译它即可。

Answer 8

嗯，也许将函数调用包装在宏中（实际上是宏系列）？下面是一个不带参数并返回 Retval 的方法：

// define the wrapper for name
#define DEFTIMECALL0(Retval,name) \
    Retval timed##name() \
    { \
        Retval ret;
        tic(); \
        ret = name(); \
        toc(); \
        return ret; \
    }

您进行的每个函数调用都需要宏，并具有 Retval 和 void 返回版本。

编辑也许定义包装函数甚至没有意义，最好只使用一系列宏（同样，对于每个元数和返回类型/void版本）来包装函数调用直接在调用点处显示 tic/toc

不要害怕检测分析器，它本质上会为您完成此操作。