Clean-up: run format-cpp on the tree
[lttng-tools.git] / src / common / kernel-ctl / kernel-ioctl.hpp
CommitLineData
16421f6e 1/*
21cf9b6b 2 * Copyright (C) 2011 EfficiOS Inc.
ab5be9fa 3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
16421f6e 4 *
ab5be9fa 5 * SPDX-License-Identifier: GPL-2.0-only
16421f6e 6 *
16421f6e
DG
7 */
8
9#ifndef _LTT_KERNEL_IOCTL_H
10#define _LTT_KERNEL_IOCTL_H
11
28f23191
JG
12#define LTTNG_KERNEL_ABI_MAJOR_VERSION 2
13#define LTTNG_KERNEL_ABI_MINOR_VERSION 6
c052142c 14
16421f6e 15/* Get a snapshot of the current ring buffer producer and consumer positions */
28f23191 16#define LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT _IO(0xF6, 0x00)
16421f6e 17/* Get the consumer position (iteration start) */
28f23191 18#define LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_CONSUMED _IOR(0xF6, 0x01, unsigned long)
16421f6e 19/* Get the producer position (iteration end) */
28f23191 20#define LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_GET_PRODUCED _IOR(0xF6, 0x02, unsigned long)
16421f6e 21/* Get exclusive read access to the specified sub-buffer position */
28f23191 22#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF _IOW(0xF6, 0x03, unsigned long)
16421f6e 23/* Release exclusive sub-buffer access */
28f23191 24#define LTTNG_KERNEL_ABI_RING_BUFFER_PUT_SUBBUF _IO(0xF6, 0x04)
16421f6e
DG
25
26/* Get exclusive read access to the next sub-buffer that can be read. */
28f23191 27#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF _IO(0xF6, 0x05)
16421f6e 28/* Release exclusive sub-buffer access, move consumer forward. */
28f23191 29#define LTTNG_KERNEL_ABI_RING_BUFFER_PUT_NEXT_SUBBUF _IO(0xF6, 0x06)
16421f6e 30/* returns the size of the current sub-buffer, without padding (for mmap). */
28f23191 31#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_SUBBUF_SIZE _IOR(0xF6, 0x07, unsigned long)
16421f6e 32/* returns the size of the current sub-buffer, with padding (for splice). */
28f23191 33#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_PADDED_SUBBUF_SIZE _IOR(0xF6, 0x08, unsigned long)
16421f6e 34/* returns the maximum size for sub-buffers. */
28f23191 35#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_MAX_SUBBUF_SIZE _IOR(0xF6, 0x09, unsigned long)
16421f6e 36/* returns the length to mmap. */
28f23191 37#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_LEN _IOR(0xF6, 0x0A, unsigned long)
16421f6e 38/* returns the offset of the subbuffer belonging to the mmap reader. */
28f23191 39#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_MMAP_READ_OFFSET _IOR(0xF6, 0x0B, unsigned long)
f22dd891 40/* Flush the current sub-buffer, if non-empty. */
28f23191 41#define LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH _IO(0xF6, 0x0C)
93ec662e 42/* Get the current version of the metadata cache (after a get_next). */
28f23191 43#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_METADATA_VERSION _IOR(0xF6, 0x0D, uint64_t)
b007ec59
JG
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 */
28f23191 49#define LTTNG_KERNEL_ABI_RING_BUFFER_SNAPSHOT_SAMPLE_POSITIONS _IO(0xF6, 0x0E)
f22dd891 50/* Flush the current sub-buffer, even if empty. */
28f23191 51#define LTTNG_KERNEL_ABI_RING_BUFFER_FLUSH_EMPTY _IO(0xF6, 0x0F)
8024cc8c
JD
52/*
53 * Reset the position of what has been consumed from the metadata cache to 0
54 * so it can be read again.
55 */
28f23191 56#define LTTNG_KERNEL_ABI_RING_BUFFER_METADATA_CACHE_DUMP _IO(0xF6, 0x10)
99930a9d 57/* Clear ring buffer content */
28f23191 58#define LTTNG_KERNEL_ABI_RING_BUFFER_CLEAR _IO(0xF6, 0x11)
b8e2fb80 59#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK _IOR(0xF6, 0x12, uint32_t)
00e2e675 60
309167d2 61/* returns the timestamp begin of the current sub-buffer */
28f23191 62#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
309167d2 63/* returns the timestamp end of the current sub-buffer */
28f23191 64#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
309167d2 65/* returns the number of events discarded */
28f23191 66#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
309167d2 67/* returns the packet payload size */
28f23191 68#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
309167d2 69/* returns the actual packet size */
28f23191 70#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
309167d2 71/* returns the stream id */
28f23191 72#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
d3e2ba59 73/* returns the current timestamp */
28f23191 74#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
fb83fe64 75/* returns the packet sequence number */
28f23191 76#define LTTNG_KERNEL_ABI_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
000fa86f 77/* returns the stream instance id */
28f23191 78#define LTTNG_KERNEL_ABI_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
309167d2 79
4dbc372b
JD
80/* Old ABI (without support for 32/64 bits compat) */
81/* LTTng file descriptor ioctl */
28f23191
JG
82#define LTTNG_KERNEL_ABI_OLD_SESSION _IO(0xF6, 0x40)
83#define LTTNG_KERNEL_ABI_OLD_TRACER_VERSION \
84 _IOR(0xF6, 0x41, struct lttng_kernel_abi_old_tracer_version)
85#define LTTNG_KERNEL_ABI_OLD_TRACEPOINT_LIST _IO(0xF6, 0x42)
86#define LTTNG_KERNEL_ABI_OLD_WAIT_QUIESCENT _IO(0xF6, 0x43)
4dbc372b
JD
87
88/* Session FD ioctl */
28f23191
JG
89#define LTTNG_KERNEL_ABI_OLD_METADATA _IOW(0xF6, 0x50, struct lttng_kernel_abi_old_channel)
90#define LTTNG_KERNEL_ABI_OLD_CHANNEL _IOW(0xF6, 0x51, struct lttng_kernel_abi_old_channel)
91#define LTTNG_KERNEL_ABI_OLD_SESSION_START _IO(0xF6, 0x52)
92#define LTTNG_KERNEL_ABI_OLD_SESSION_STOP _IO(0xF6, 0x53)
4dbc372b
JD
93
94/* Channel FD ioctl */
28f23191
JG
95#define LTTNG_KERNEL_ABI_OLD_STREAM _IO(0xF6, 0x60)
96#define LTTNG_KERNEL_ABI_OLD_EVENT _IOW(0xF6, 0x61, struct lttng_kernel_abi_old_event)
f3ed775e 97
4dbc372b 98/* Event and Channel FD ioctl */
28f23191 99#define LTTNG_KERNEL_ABI_OLD_CONTEXT _IOW(0xF6, 0x70, struct lttng_kernel_abi_old_context)
4dbc372b
JD
100
101/* Event, Channel and Session ioctl */
28f23191
JG
102#define LTTNG_KERNEL_ABI_OLD_ENABLE _IO(0xF6, 0x80)
103#define LTTNG_KERNEL_ABI_OLD_DISABLE _IO(0xF6, 0x81)
4dbc372b
JD
104
105/* Current ABI (with suport for 32/64 bits compat) */
857aa172 106/* LTTng file descriptor ioctl */
28f23191
JG
107#define LTTNG_KERNEL_ABI_SESSION _IO(0xF6, 0x45)
108#define LTTNG_KERNEL_ABI_TRACER_VERSION _IOR(0xF6, 0x46, struct lttng_kernel_abi_tracer_version)
109#define LTTNG_KERNEL_ABI_TRACEPOINT_LIST _IO(0xF6, 0x47)
110#define LTTNG_KERNEL_ABI_WAIT_QUIESCENT _IO(0xF6, 0x48)
111#define LTTNG_KERNEL_ABI_SYSCALL_LIST _IO(0xF6, 0x4A)
112#define LTTNG_KERNEL_ABI_TRACER_ABI_VERSION \
b8e2fb80 113 _IOR(0xF6, 0x4B, struct lttng_kernel_abi_tracer_abi_version)
28f23191 114#define LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_CREATE _IO(0xF6, 0x4C)
8d609afd
JD
115
116/* Session FD ioctl */
28f23191
JG
117#define LTTNG_KERNEL_ABI_METADATA _IOW(0xF6, 0x54, struct lttng_kernel_abi_channel)
118#define LTTNG_KERNEL_ABI_CHANNEL _IOW(0xF6, 0x55, struct lttng_kernel_abi_channel)
119#define LTTNG_KERNEL_ABI_SESSION_START _IO(0xF6, 0x56)
120#define LTTNG_KERNEL_ABI_SESSION_STOP _IO(0xF6, 0x57)
121#define LTTNG_KERNEL_ABI_SESSION_TRACK_PID _IOW(0xF6, 0x58, int32_t)
122#define LTTNG_KERNEL_ABI_SESSION_UNTRACK_PID _IOW(0xF6, 0x59, int32_t)
d2b102df
JG
123/*
124 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
125 * are generating two different ioctl numbers, but this was not done on
126 * purpose. We should generally try to avoid those duplications.
127 */
28f23191
JG
128#define LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
129#define LTTNG_KERNEL_ABI_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
1eceaef1 130/* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
28f23191
JG
131#define LTTNG_KERNEL_ABI_SESSION_STATEDUMP _IO(0xF6, 0x5C)
132#define LTTNG_KERNEL_ABI_SESSION_SET_NAME _IOW(0xF6, 0x5D, struct lttng_kernel_abi_session_name)
133#define LTTNG_KERNEL_ABI_SESSION_SET_CREATION_TIME \
acbe1c12 134 _IOW(0xF6, 0x5E, struct lttng_kernel_abi_session_creation_time)
8d609afd
JD
135
136/* Channel FD ioctl */
28f23191
JG
137#define LTTNG_KERNEL_ABI_STREAM _IO(0xF6, 0x62)
138#define LTTNG_KERNEL_ABI_EVENT _IOW(0xF6, 0x63, struct lttng_kernel_abi_event)
139#define LTTNG_KERNEL_ABI_SYSCALL_MASK _IOWR(0xF6, 0x64, struct lttng_kernel_abi_syscall_mask)
f3ed775e 140
857aa172 141/* Event and Channel FD ioctl */
28f23191 142#define LTTNG_KERNEL_ABI_CONTEXT _IOW(0xF6, 0x71, struct lttng_kernel_abi_context)
857aa172 143
cfb1c9bc 144/* Event, event notifier, Channel and Session ioctl */
28f23191
JG
145#define LTTNG_KERNEL_ABI_ENABLE _IO(0xF6, 0x82)
146#define LTTNG_KERNEL_ABI_DISABLE _IO(0xF6, 0x83)
16421f6e 147
90aa04a1 148/* Event notifier group ioctl */
28f23191 149#define LTTNG_KERNEL_ABI_COUNTER _IOW(0xF6, 0x84, struct lttng_kernel_abi_counter_conf)
90aa04a1 150
cfb1c9bc 151/* Event and event notifier FD ioctl */
28f23191
JG
152#define LTTNG_KERNEL_ABI_FILTER _IO(0xF6, 0x90)
153#define LTTNG_KERNEL_ABI_ADD_CALLSITE _IO(0xF6, 0x91)
00a62084 154
d01c0e56 155/* Session FD ioctl (continued) */
28f23191 156#define LTTNG_KERNEL_ABI_SESSION_LIST_TRACKER_IDS \
acbe1c12 157 _IOW(0xF6, 0xA0, struct lttng_kernel_abi_tracker_args)
28f23191
JG
158#define LTTNG_KERNEL_ABI_SESSION_TRACK_ID _IOW(0xF6, 0xA1, struct lttng_kernel_abi_tracker_args)
159#define LTTNG_KERNEL_ABI_SESSION_UNTRACK_ID _IOW(0xF6, 0xA2, struct lttng_kernel_abi_tracker_args)
d01c0e56 160
cfb1c9bc 161/* Event notifier group file descriptor ioctl */
28f23191 162#define LTTNG_KERNEL_ABI_EVENT_NOTIFIER_CREATE \
b8e2fb80 163 _IOW(0xF6, 0xB0, struct lttng_kernel_abi_event_notifier)
28f23191 164#define LTTNG_KERNEL_ABI_EVENT_NOTIFIER_GROUP_NOTIFICATION_FD _IO(0xF6, 0xB1)
cfb1c9bc 165
90aa04a1 166/* Event notifier file descriptor ioctl */
28f23191 167#define LTTNG_KERNEL_ABI_CAPTURE _IO(0xF6, 0xB8)
bbd6675c 168
90aa04a1 169/* Counter file descriptor ioctl */
28f23191
JG
170#define LTTNG_KERNEL_ABI_COUNTER_READ IOWR(0xF6, 0xC0, struct lttng_kernel_abi_counter_read)
171#define LTTNG_KERNEL_ABI_COUNTER_AGGREGATE \
b8e2fb80 172 _IOWR(0xF6, 0xC1, struct lttng_kernel_abi_counter_aggregate)
28f23191 173#define LTTNG_KERNEL_ABI_COUNTER_CLEAR _IOW(0xF6, 0xC2, struct lttng_kernel_abi_counter_clear)
90aa04a1 174
acbe1c12 175/*
28f23191
JG
176 * Those ioctl numbers use the wrong direction, but are kept for ABI backward
177 * compatibility.
178 */
179#define LTTNG_KERNEL_ABI_OLD_SESSION_SET_NAME _IOR(0xF6, 0x5D, struct lttng_kernel_abi_session_name)
180#define LTTNG_KERNEL_ABI_OLD_SESSION_SET_CREATION_TIME \
181 _IOR(0xF6, 0x5E, struct lttng_kernel_abi_session_creation_time)
182#define LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_PID _IOW(0xF6, 0x58, int32_t)
183#define LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_PID _IOW(0xF6, 0x59, int32_t)
184#define LTTNG_KERNEL_ABI_OLD_SESSION_LIST_TRACKER_IDS \
185 _IOR(0xF6, 0xA0, struct lttng_kernel_abi_tracker_args)
186#define LTTNG_KERNEL_ABI_OLD_SESSION_TRACK_ID _IOR(0xF6, 0xA1, struct lttng_kernel_abi_tracker_args)
187#define LTTNG_KERNEL_ABI_OLD_SESSION_UNTRACK_ID \
188 _IOR(0xF6, 0xA2, struct lttng_kernel_abi_tracker_args)
90aa04a1 189
16421f6e 190#endif /* _LTT_KERNEL_IOCTL_H */
This page took 0.082774 seconds and 4 git commands to generate.