【LTTng】lttng-gen-tp — Generate LTTng-UST tracepoint provider code

SYNOPSIS

lttng-gen-tp [--verbose] [--output=FILE.c]
             [--output=FILE.h] [--output=FILE.o] TEMPLATE

描述

LTTng-gen-tp 工具简化了 LTTng-UST 跟踪点提供程序文件的生成。它需要一个简单的模板文件 TEMPLATE，并生成必要的 C 代码，以便在应用程序中使用定义的跟踪点。有关模板格式的详细信息，请参阅下面的模板文件格式部分。
就是帮助你添加文件前后的宏，不用自己新建一堆文件了。

目前，lttng-gen-tp 可以生成与跟踪点提供程序关联的 .h、.c 和 .o 文件。生成的 .h 文件可以直接包含在应用程序中。您可以让 lttng-gen-tp 生成 .o 文件或自己编译 .c 文件。有关编译 LTTng-UST 跟踪点提供程序的更多信息，请参阅 lttng-ust（3）。
编译也帮你弄好，是不是很棒

默认情况下，生成 .h、.c 和 .o 文件，它们的基名是模板的基名。您可以使用 --output 选项生成一个或多个特定文件类型，如果需要，可以重复该选项。

模板文件格式

模板文件通常具有 .tp 扩展名，包含 LTTNG_UST_TRACEPOINT_EVENT（） 定义和其他可选定义条目（如 LTTNG_UST_TRACEPOINT_LOGLEVEL（））的列表。参见 lttng-ust（3） 获取可用定义的完整列表。
我感觉就是写观测点的定义部分

LTTNG_UST_TRACEPOINT_EVENT（） 定义的编写方式与在 LTTng-UST 模板提供程序头文件中编写它们的方式相同。支持 C 注释（/* */ 和 //），以及以 # 开头的行。

注意：provider name（LTTNG_UST_TRACEPOINT_EVENT（）的第一个参数）在 TEMPLATE 的所有 LTTNG_UST_TRACEPOINT_EVENT（） 宏中必须相同。
一个文件写给一个provider吧，那么所有的provider应该是相同的

Here’s an example:

LTTNG_UST_TRACEPOINT_EVENT(
    // Tracepoint provider name
    my_provider,

    // Tracepoint/event name
    my_event,

    // Tracepoint arguments (input)
    LTTNG_UST_TP_ARGS(char *, text),

    // Tracepoint/event fields (output)
    LTTNG_UST_TP_FIELDS(
        lttng_ust_field_string(message, text)
    )
)

OPTIONS

-o, --output=FILE

Do not generate default files: generate FILE.

The extension of FILE determines what is generated, amongst .h, .c, and .o. This option can be used more than one time to generate different file types.

-v, --verbose

Increase verbosity.

-h, --help

Show command help.

环境变量

CC

要使用的 C 编译器。默认值：cc，如果未找到cc，则为 gcc。此选项仅在生成 .o 文件时才相关。

CFLAGS

直接传递给编译器的标志和选项（$CC）。此选项仅在生成 .o 文件时才相关。