在C中编写DTrace使用者

时间:2015-01-18 15:38:41

标签: c freebsd dtrace

我想在FreeBSD 10.1上编写一个使用libdtrace实现 DTrace使用者的C程序。

我知道我需要先致电dtrace_open() - 例如我找到了this旧的演示文稿,但我无法启动,因为没有安装dtrace.h(仅在系统源代码树中)。

安装了共享库,例如FreeBSD附带的/usr/sbin/dtrace工具可以充当DTrace使用者,此工具链接到/lib/libdtrace.so.2(也通过/usr/lib/libdtrace.so的符号链接指向。)

任何基本的例子,包括构建指令(FreeBSD 10.1 / clang)都会对我有所帮助。


编写自定义使用者的实际目标是创建一个基于CFFI的包装器,可以在Python和PyPy中使用。意思是:上面的C程序只是为了开始,学习然后继续。

CFFI是将PyPy与共享库连接的推荐,现代,高性能方式。

CFFI可以在ABI和API级别使用。后者需要包含头文件,前者需要声明从lib中使用的东西。


根据Adam的回答改编,这是一个适用于FreeBSD 10.1的完整示例。

Makefile

all:
        cc \
         -I /usr/src/cddl/compat/opensolaris/include \
         -I /usr/src/cddl/contrib/opensolaris/lib/libdtrace/common/ \
         -I /usr/src/sys/cddl/compat/opensolaris \
         -I /usr/src/sys/cddl/contrib/opensolaris/uts/common/ \
         hello_dtrace.c \
         -l dtrace -l proc -l ctf -l elf -l z -l rtld_db -l pthread -l util \
         -o hello_dtrace

hello_dtrace.c

#include <dtrace.h>
#include <signal.h>
#include <stdio.h>

static dtrace_hdl_t* g_dtp;

static int chewrec (const dtrace_probedata_t *data, const dtrace_recdesc_t *rec, void *arg) {
   printf("chewing dtrace record ..\n");
   // A NULL rec indicates that we've processed the last record.
   if (rec == NULL) {
      return (DTRACE_CONSUME_NEXT);
   }
   return (DTRACE_CONSUME_THIS);
}

static const char* g_prog = "BEGIN { printf(\"hello from dtrace\\n\"); }";
//static const char* g_prog = "syscall::open*:entry { printf(\"%s %s\\n\", execname, copyinstr(arg0)); }";

static int g_intr;
static int g_exited;

static void intr (int signo) {
   g_intr = 1;
}


int main (int argc, char** argv) {
   int err;

   if ((g_dtp = dtrace_open(DTRACE_VERSION, 0, &err)) == NULL) {
      fprintf(stderr, "failed to initialize dtrace: %s\n", dtrace_errmsg(NULL, err));
      return -1;
   }
   printf("Dtrace initialized\n");

   (void) dtrace_setopt(g_dtp, "bufsize", "4m");
   (void) dtrace_setopt(g_dtp, "aggsize", "4m");
   printf("dtrace options set\n");

   dtrace_prog_t* prog;
   if ((prog = dtrace_program_strcompile(g_dtp, g_prog, DTRACE_PROBESPEC_NAME, 0, 0, NULL)) == NULL) {
      fprintf(stderr, "failed to compile dtrace program\n");
      return -1;
   } else {
      printf("dtrace program compiled\n");
   }

   dtrace_proginfo_t info;
   if (dtrace_program_exec(g_dtp, prog, &info) == -1) {
      fprintf(stderr, "failed to enable dtrace probes\n");
      return -1;
   } else {
      printf("dtrace probes enabled\n");
   }

   struct sigaction act;
   (void) sigemptyset(&act.sa_mask);
   act.sa_flags = 0;
   act.sa_handler = intr;
   (void) sigaction(SIGINT, &act, NULL);
   (void) sigaction(SIGTERM, &act, NULL);

   if (dtrace_go(g_dtp) != 0) {
      fprintf(stderr, "could not start instrumentation\n");
      return -1;
   } else {
      printf("instrumentation started ..\n");
   }

   int done = 0;
   do {
      if (!g_intr && !done) {
         dtrace_sleep(g_dtp);
      }

      if (done || g_intr || g_exited) {
         done = 1;
         if (dtrace_stop(g_dtp) == -1) {
            fprintf(stderr, "could not stop tracing\n");
            return -1;
         }
      }

      switch (dtrace_work(g_dtp, stdout, NULL, chewrec, NULL)) {
         case DTRACE_WORKSTATUS_DONE:
            done = 1;
            break;
         case DTRACE_WORKSTATUS_OKAY:
            break;
         default:
            fprintf(stderr, "processing aborted");
            return -1;
      }
   } while (!done);

   printf("closing dtrace\n");
   dtrace_close(g_dtp);

   return 0;
}

运行:

[oberstet@brummer2 ~/hello_dtrace]$ make; sudo ./hello_dtrace
cc  -I /usr/src/cddl/contrib/opensolaris/lib/libdtrace/common/  -I /usr/src/sys/cddl/compat/opensolaris  -I /usr/src/sys/cddl/contrib/opensolaris/uts/common/  hello_dtrace.c  -l dtrace  -l proc  -l ctf  -l elf  -l rtld_db  -l z  -l pthread  -l util  -o hello_dtrace
Dtrace initialized
dtrace options set
dtrace program compiled
dtrace probes enabled
instrumentation started ..
chewing dtrace record ..
hello from dtrace
chewing dtrace record ..
^Cclosing dtrace

2 个答案:

答案 0 :(得分:9)

libdtrace API不一定适合稳定的消费者,但从一些现有的消费者开始学习它很容易。最简单和最现代的是plockstat,用于用户土地锁定统计的illumos实用程序。

以下是简单DTrace消费者计划的基本流程:

dtrace_open()获取dtrace_hdl_t,其他libdtrace互动的句柄
dtrace_setopt()配置选项(-x标记为dtrace(1M)
dtrace_strcompile()编译D程序的字符串
dtrace_program_exec()将该程序发送到内核
dtrace_go()来检测系统并开始记录数据
dtrace_close()最后清理

对于主数据收集循环(dtrace_go()dtrace_close()之间),请执行以下操作:

dtrace_sleep()根据DTrace选项暂停(切换和聚合)
dtrace_work()处理跟踪数据
dtrace_stop()要中止

请参阅plockstat.c中的主循环了解更多信息。

对于其他简单的DTrace使用者,请查看intrstatlockstat。对于厨房水槽,请查看dtrace(1M)命令行实用程序的代码。

答案 1 :(得分:3)

dtrace被认为是系统内部接口,编写自定义消费者不是支持的。

您可以做的最好的事情是查看FreeBSD源代码树的副本并从那里构建代码。这实际上并不十分困难。显然,dtrace(1)是规范的dtrace使用者,因此您可以查看其实现,以获取有关如何使用libdtrace的示例。此外,dtrace.h有大量的注释解释数据结构和内部结构。

在源代码树的上下文中构建文件非常简单; FreeBSD源代码树布局很简单,编写Makefile以自包含方式构建二进制文件基本上是“免费”给你的。

相关要点:

  • the dtrace(1) Makefile克隆到源树结帐中的新目录中。修改Makefile以使.PATH正确无误,并设置PROGSRCS以包含组成自定义消费者的来源。

  • dtrace.c克隆到您的源目录(无论您指向.PATH)并根据需要进行更改。尽管源代码接近2000行,但大部分都是支持代码。如果您只是想要克隆功能的一个子集,您会发现二进制文件的大多数选项都是在自包含函数中实现的,因此将dtrace.c调整为相当容易。最简单的形式。

在不知道您需要对自定义消费者做什么具体的情况下,很难告诉您还需要调用什么。我假设你可能想要compile_file以及exec_prog。当然,您的需求可能会有所不同。

dtrace.h you will be using对所提供的各种界面有很多评论。

希望这足以让你开始;不幸的是,没有办法从香草安装做你想要的。当然,您可以修改相关的Makefile以安装必要的头文件并创建自己的内部分发。但这似乎比它更值得痛苦。