Update ABI to select the output method

[lttng-modules.git] / ltt-debugfs-abi.h

diff --git a/ltt-debugfs-abi.h b/ltt-debugfs-abi.h
index 3a2af561294582caf1c00872744b11ebddd37551..e5ddcfa0965ded2110b8c2bfa12aa04c6c763272 100644 (file)
--- a/ltt-debugfs-abi.h
+++ b/ltt-debugfs-abi.h
@@ -7,37 +7,123 @@
  * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  *
  * LTTng debugfs ABI header
+ *
+ * Dual LGPL v2.1/GPL v2 license.
  */
 
 #include <linux/fs.h>
 
-enum instrum_type {
-       INSTRUM_TRACEPOINTS,
+#define LTTNG_SYM_NAME_LEN     128
+
+enum lttng_kernel_instrumentation {
+       LTTNG_KERNEL_TRACEPOINT = 0,
+       LTTNG_KERNEL_KPROBE     = 1,
+       LTTNG_KERNEL_FUNCTION   = 2,
+};
+
+/*
+ * LTTng consumer mode
+ */
+enum lttng_kernel_output {
+       LTTNG_KERNEL_SPLICE     = 0,
+       LTTNG_KERNEL_MMAP       = 1,
 };
 
 /*
  * LTTng DebugFS ABI structures.
  */
 
-struct lttng_channel {
-       int overwrite;                  /* 1: overwrite, 0: discard */
-       u64 subbuf_size;
-       u64 num_subbuf;
-       unsigned int switch_timer_interval;
-       unsigned int read_timer_interval;
+struct lttng_kernel_channel {
+       int overwrite;                          /* 1: overwrite, 0: discard */
+       uint64_t subbuf_size;                   /* in bytes */
+       uint64_t num_subbuf;
+       unsigned int switch_timer_interval;     /* usecs */
+       unsigned int read_timer_interval;       /* usecs */
+       enum lttng_kernel_output output;        /* splice, mmap */
+};
+
+/*
+ * Either addr is used, or symbol_name and offset.
+ */
+struct lttng_kernel_kprobe {
+       uint64_t addr;
+
+       uint64_t offset;
+       char symbol_name[LTTNG_SYM_NAME_LEN];
+};
+
+struct lttng_kernel_function_tracer {
+       char symbol_name[LTTNG_SYM_NAME_LEN];
 };
 
-struct lttng_event {
-       enum instrum_type itype;
-       char name[];
+struct lttng_kernel_event {
+       char name[LTTNG_SYM_NAME_LEN];  /* event name */
+       enum lttng_kernel_instrumentation instrumentation;
+       /* Per instrumentation type configuration */
+       union {
+               struct lttng_kernel_kprobe kprobe;
+               struct lttng_kernel_function_tracer ftrace;
+       } u;
 };
 
-#define LTTNG_SESSION          _IO(0xF6, 0x40)
-#define LTTNG_SESSION_START    _IO(0xF6, 0x41)
-#define LTTNG_SESSION_STOP     _IO(0xF6, 0x42)
-#define LTTNG_CHANNEL          _IOW(0xF6, 0x43, struct lttng_channel)
-#define LTTNG_STREAM           _IO(0xF6, 0x44)
-#define LTTNG_EVENT            _IOW(0xF6, 0x45, struct lttng_event)
-#define LTTNG_METADATA         _IOW(0xF6, 0x46, struct lttng_channel)
+struct lttng_kernel_tracer_version {
+       uint32_t version;
+       uint32_t patchlevel;
+       uint32_t sublevel;
+};
+
+enum lttng_kernel_context_type {
+       LTTNG_KERNEL_CONTEXT_PID                = 0,
+       LTTNG_KERNEL_CONTEXT_PERF_COUNTER       = 1,
+       LTTNG_KERNEL_CONTEXT_COMM               = 2,
+       LTTNG_KERNEL_CONTEXT_PRIO               = 3,
+       LTTNG_KERNEL_CONTEXT_NICE               = 4,
+       LTTNG_KERNEL_CONTEXT_VPID               = 5,
+       LTTNG_KERNEL_CONTEXT_TID                = 6,
+       LTTNG_KERNEL_CONTEXT_VTID               = 7,
+       LTTNG_KERNEL_CONTEXT_PPID               = 8,
+       LTTNG_KERNEL_CONTEXT_VPPID              = 9,
+};
+
+struct lttng_kernel_perf_counter_ctx {
+       uint32_t type;
+       uint64_t config;
+       char name[LTTNG_SYM_NAME_LEN];
+};
+
+struct lttng_kernel_context {
+       enum lttng_kernel_context_type ctx;
+       union {
+               struct lttng_kernel_perf_counter_ctx perf_counter;
+       } u;
+};
+
+/* LTTng file descriptor ioctl */
+#define LTTNG_KERNEL_SESSION                   _IO(0xF6, 0x40)
+#define LTTNG_KERNEL_TRACER_VERSION            \
+       _IOR(0xF6, 0x41, struct lttng_kernel_tracer_version)
+#define LTTNG_KERNEL_TRACEPOINT_LIST           _IO(0xF6, 0x42)
+#define LTTNG_KERNEL_WAIT_QUIESCENT            _IO(0xF6, 0x43)
+
+/* Session FD ioctl */
+#define LTTNG_KERNEL_METADATA                  \
+       _IOW(0xF6, 0x50, struct lttng_kernel_channel)
+#define LTTNG_KERNEL_CHANNEL                   \
+       _IOW(0xF6, 0x51, struct lttng_kernel_channel)
+#define LTTNG_KERNEL_SESSION_START             _IO(0xF6, 0x52)
+#define LTTNG_KERNEL_SESSION_STOP              _IO(0xF6, 0x53)
+
+/* Channel FD ioctl */
+#define LTTNG_KERNEL_STREAM                    _IO(0xF6, 0x60)
+#define LTTNG_KERNEL_EVENT                     \
+       _IOW(0xF6, 0x61, struct lttng_kernel_event)
+
+/* Event and Channel FD ioctl */
+#define LTTNG_KERNEL_CONTEXT                   \
+       _IOW(0xF6, 0x70, struct lttng_kernel_context)
+
+/* Event, Channel and Session ioctl */
+#define LTTNG_KERNEL_ENABLE                    _IO(0xF6, 0x80)
+#define LTTNG_KERNEL_DISABLE                   _IO(0xF6, 0x81)
 
 #endif /* _LTT_DEBUGFS_ABI_H */