llvm pass 调试

llvm为开发者提供了2种常用的新开发pass调试方法：statistic class和debug counter。

statistic class

statistic class是一个计数器，通常用于统计Transform Pass对代码进行Transform的次数。使用如下代码可以定义一个新的计数器NumXForms。

#define DEBUG_TYPE "mypassname"   // This goes after any #includes.
STATISTIC(NumXForms, "The # of times I did stuff");

接下来就可以在需要的地方对计数器进行自增/减：

++NumXForms;   // I did stuff!

最终可以使用命令行让opt输出对应的计数器值：

$ opt -stats -mypassname < program.bc > /dev/null
... statistics output ...

debug counter

debug counter通常用于灵活控制代码中的控制流，比如在一个复杂的测试用例中，控制Transform Pass自定义代码区间的跳过/执行次数，从而缩小问题代码区间，帮助问题定位。使用如下代码就可以定义一个新的debug counter DeleteAnInstruction。

DEBUG_COUNTER(DeleteAnInstruction, "passname-delete-instruction",
              "Controls which instructions get delete");

接下来就可以使用DeleteAnInstruction对需要debug的代码区间执行与否进行控制(I->eraseFromParent())：

if (DebugCounter::shouldExecute(DeleteAnInstruction))
  I->eraseFromParent();

最终可以使用命令行让opt控制代码区间的跳过/执行次数，如下示例表示执行到I->eraseFromParent()时，会先跳过1次(passname-delete-instruction-skip=1)，再执行2次(passname-delete-instruction-count=2)，接着永远跳过。

$ opt --debug-counter=passname-delete-instruction-skip=1,passname-delete-instruction-count=2 -passname

参考材料

LLVM Programmer’s Manual — LLVM 15.0.0git documentation