kernel: event notifier: kernel-ctl interface
[lttng-tools.git] / src / common / kernel-ctl / kernel-ioctl.h
1 /*
2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * SPDX-License-Identifier: GPL-2.0-only
6 *
7 */
8
9 #ifndef _LTT_KERNEL_IOCTL_H
10 #define _LTT_KERNEL_IOCTL_H
11
12 #define LTTNG_MODULES_ABI_MAJOR_VERSION 2
13 #define LTTNG_MODULES_ABI_MINOR_VERSION 5
14
15 /* Get a snapshot of the current ring buffer producer and consumer positions */
16 #define RING_BUFFER_SNAPSHOT _IO(0xF6, 0x00)
17 /* Get the consumer position (iteration start) */
18 #define RING_BUFFER_SNAPSHOT_GET_CONSUMED _IOR(0xF6, 0x01, unsigned long)
19 /* Get the producer position (iteration end) */
20 #define RING_BUFFER_SNAPSHOT_GET_PRODUCED _IOR(0xF6, 0x02, unsigned long)
21 /* Get exclusive read access to the specified sub-buffer position */
22 #define RING_BUFFER_GET_SUBBUF _IOW(0xF6, 0x03, unsigned long)
23 /* Release exclusive sub-buffer access */
24 #define RING_BUFFER_PUT_SUBBUF _IO(0xF6, 0x04)
25
26 /* Get exclusive read access to the next sub-buffer that can be read. */
27 #define RING_BUFFER_GET_NEXT_SUBBUF _IO(0xF6, 0x05)
28 /* Release exclusive sub-buffer access, move consumer forward. */
29 #define RING_BUFFER_PUT_NEXT_SUBBUF _IO(0xF6, 0x06)
30 /* returns the size of the current sub-buffer, without padding (for mmap). */
31 #define RING_BUFFER_GET_SUBBUF_SIZE _IOR(0xF6, 0x07, unsigned long)
32 /* returns the size of the current sub-buffer, with padding (for splice). */
33 #define RING_BUFFER_GET_PADDED_SUBBUF_SIZE _IOR(0xF6, 0x08, unsigned long)
34 /* returns the maximum size for sub-buffers. */
35 #define RING_BUFFER_GET_MAX_SUBBUF_SIZE _IOR(0xF6, 0x09, unsigned long)
36 /* returns the length to mmap. */
37 #define RING_BUFFER_GET_MMAP_LEN _IOR(0xF6, 0x0A, unsigned long)
38 /* returns the offset of the subbuffer belonging to the mmap reader. */
39 #define RING_BUFFER_GET_MMAP_READ_OFFSET _IOR(0xF6, 0x0B, unsigned long)
40 /* Flush the current sub-buffer, if non-empty. */
41 #define RING_BUFFER_FLUSH _IO(0xF6, 0x0C)
42 /* Get the current version of the metadata cache (after a get_next). */
43 #define RING_BUFFER_GET_METADATA_VERSION _IOR(0xF6, 0x0D, uint64_t)
44 /*
45 * Get a snapshot of the current ring buffer producer and consumer positions,
46 * regardless of whether or not the two positions are contained within the same
47 * sub-buffer.
48 */
49 #define RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS _IO(0xF6, 0x0E)
50 /* Flush the current sub-buffer, even if empty. */
51 #define RING_BUFFER_FLUSH_EMPTY _IO(0xF6, 0x0F)
52 /*
53 * Reset the position of what has been consumed from the metadata cache to 0
54 * so it can be read again.
55 */
56 #define RING_BUFFER_METADATA_CACHE_DUMP _IO(0xF6, 0x10)
57 /* Clear ring buffer content */
58 #define RING_BUFFER_CLEAR _IO(0xF6, 0x11)
59 #define RING_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK _IOR(0xF6, 0x12, uint32_t)
60
61 /* returns the timestamp begin of the current sub-buffer */
62 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
63 /* returns the timestamp end of the current sub-buffer */
64 #define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
65 /* returns the number of events discarded */
66 #define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
67 /* returns the packet payload size */
68 #define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
69 /* returns the actual packet size */
70 #define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
71 /* returns the stream id */
72 #define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
73 /* returns the current timestamp */
74 #define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
75 /* returns the packet sequence number */
76 #define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
77 /* returns the stream instance id */
78 #define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
79
80 /* Old ABI (without support for 32/64 bits compat) */
81 /* LTTng file descriptor ioctl */
82 #define LTTNG_KERNEL_OLD_SESSION _IO(0xF6, 0x40)
83 #define LTTNG_KERNEL_OLD_TRACER_VERSION \
84 _IOR(0xF6, 0x41, struct lttng_kernel_old_tracer_version)
85 #define LTTNG_KERNEL_OLD_TRACEPOINT_LIST _IO(0xF6, 0x42)
86 #define LTTNG_KERNEL_OLD_WAIT_QUIESCENT _IO(0xF6, 0x43)
87
88 /* Session FD ioctl */
89 #define LTTNG_KERNEL_OLD_METADATA \
90 _IOW(0xF6, 0x50, struct lttng_kernel_old_channel)
91 #define LTTNG_KERNEL_OLD_CHANNEL \
92 _IOW(0xF6, 0x51, struct lttng_kernel_old_channel)
93 #define LTTNG_KERNEL_OLD_SESSION_START _IO(0xF6, 0x52)
94 #define LTTNG_KERNEL_OLD_SESSION_STOP _IO(0xF6, 0x53)
95
96 /* Channel FD ioctl */
97 #define LTTNG_KERNEL_OLD_STREAM _IO(0xF6, 0x60)
98 #define LTTNG_KERNEL_OLD_EVENT \
99 _IOW(0xF6, 0x61, struct lttng_kernel_old_event)
100
101 /* Event and Channel FD ioctl */
102 #define LTTNG_KERNEL_OLD_CONTEXT \
103 _IOW(0xF6, 0x70, struct lttng_kernel_old_context)
104
105 /* Event, Channel and Session ioctl */
106 #define LTTNG_KERNEL_OLD_ENABLE _IO(0xF6, 0x80)
107 #define LTTNG_KERNEL_OLD_DISABLE _IO(0xF6, 0x81)
108
109
110 /* Current ABI (with suport for 32/64 bits compat) */
111 /* LTTng file descriptor ioctl */
112 #define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
113 #define LTTNG_KERNEL_TRACER_VERSION \
114 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
115 #define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
116 #define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
117 #define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
118 #define LTTNG_KERNEL_TRACER_ABI_VERSION \
119 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
120 #define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_CREATE \
121 _IO(0xF6, 0x4C)
122
123 /* Session FD ioctl */
124 #define LTTNG_KERNEL_METADATA \
125 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
126 #define LTTNG_KERNEL_CHANNEL \
127 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
128 #define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
129 #define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
130 #define LTTNG_KERNEL_SESSION_TRACK_PID \
131 _IOR(0xF6, 0x58, int32_t)
132 #define LTTNG_KERNEL_SESSION_UNTRACK_PID \
133 _IOR(0xF6, 0x59, int32_t)
134 /*
135 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
136 * are generating two different ioctl numbers, but this was not done on
137 * purpose. We should generally try to avoid those duplications.
138 */
139 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
140 #define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
141 /* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
142 #define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
143 #define LTTNG_KERNEL_SESSION_SET_NAME \
144 _IOR(0xF6, 0x5D, struct lttng_kernel_session_name)
145 #define LTTNG_KERNEL_SESSION_SET_CREATION_TIME \
146 _IOR(0xF6, 0x5E, struct lttng_kernel_session_creation_time)
147
148 /* Channel FD ioctl */
149 #define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
150 #define LTTNG_KERNEL_EVENT \
151 _IOW(0xF6, 0x63, struct lttng_kernel_event)
152 #define LTTNG_KERNEL_SYSCALL_MASK \
153 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
154
155 /* Event and Channel FD ioctl */
156 #define LTTNG_KERNEL_CONTEXT \
157 _IOW(0xF6, 0x71, struct lttng_kernel_context)
158
159 /* Event, event notifier, Channel and Session ioctl */
160 #define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
161 #define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
162
163 /* Event and event notifier FD ioctl */
164 #define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
165 #define LTTNG_KERNEL_ADD_CALLSITE _IO(0xF6, 0x91)
166
167 /* Session FD ioctl (continued) */
168 #define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
169 _IOR(0xF6, 0xA0, struct lttng_kernel_tracker_args)
170 #define LTTNG_KERNEL_SESSION_TRACK_ID \
171 _IOR(0xF6, 0xA1, struct lttng_kernel_tracker_args)
172 #define LTTNG_KERNEL_SESSION_UNTRACK_ID \
173 _IOR(0xF6, 0xA2, struct lttng_kernel_tracker_args)
174
175 /* Event notifier group file descriptor ioctl */
176 #define LTTNG_KERNEL_EVENT_NOTIFIER_CREATE \
177 _IOW(0xF6, 0xB0, struct lttng_kernel_event_notifier)
178 #define LTTNG_KERNEL_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD \
179 _IO(0xF6, 0xB1)
180
181 #endif /* _LTT_KERNEL_IOCTL_H */
This page took 0.045599 seconds and 4 git commands to generate.