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