kerner-ctl: add RING_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK
[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
8940e62c 23#define LTTNG_MODULES_ABI_MINOR_VERSION 2
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)
612b8ed8 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)
612b8ed8
MD
54/* Flush the current sub-buffer, even if empty. */
55#define RING_BUFFER_FLUSH_EMPTY _IO(0xF6, 0x0F)
9e782f9a 56#define RING_RING_BUFFER_GET_NEXT_SUBBUF_METADATA_CHECK _IOR(0xF6, 0x12, uint32_t)
00e2e675 57
309167d2
JD
58/* returns the timestamp begin of the current sub-buffer */
59#define LTTNG_RING_BUFFER_GET_TIMESTAMP_BEGIN _IOR(0xF6, 0x20, uint64_t)
60/* returns the timestamp end of the current sub-buffer */
61#define LTTNG_RING_BUFFER_GET_TIMESTAMP_END _IOR(0xF6, 0x21, uint64_t)
62/* returns the number of events discarded */
63#define LTTNG_RING_BUFFER_GET_EVENTS_DISCARDED _IOR(0xF6, 0x22, uint64_t)
64/* returns the packet payload size */
65#define LTTNG_RING_BUFFER_GET_CONTENT_SIZE _IOR(0xF6, 0x23, uint64_t)
66/* returns the actual packet size */
67#define LTTNG_RING_BUFFER_GET_PACKET_SIZE _IOR(0xF6, 0x24, uint64_t)
68/* returns the stream id */
69#define LTTNG_RING_BUFFER_GET_STREAM_ID _IOR(0xF6, 0x25, uint64_t)
d3e2ba59
JD
70/* returns the current timestamp */
71#define LTTNG_RING_BUFFER_GET_CURRENT_TIMESTAMP _IOR(0xF6, 0x26, uint64_t)
fb83fe64
JD
72/* returns the packet sequence number */
73#define LTTNG_RING_BUFFER_GET_SEQ_NUM _IOR(0xF6, 0x27, uint64_t)
000fa86f
JD
74/* returns the stream instance id */
75#define LTTNG_RING_BUFFER_INSTANCE_ID _IOR(0xF6, 0x28, uint64_t)
309167d2 76
4dbc372b
JD
77/* Old ABI (without support for 32/64 bits compat) */
78/* LTTng file descriptor ioctl */
79#define LTTNG_KERNEL_OLD_SESSION _IO(0xF6, 0x40)
80#define LTTNG_KERNEL_OLD_TRACER_VERSION \
81 _IOR(0xF6, 0x41, struct lttng_kernel_old_tracer_version)
82#define LTTNG_KERNEL_OLD_TRACEPOINT_LIST _IO(0xF6, 0x42)
83#define LTTNG_KERNEL_OLD_WAIT_QUIESCENT _IO(0xF6, 0x43)
4dbc372b
JD
84
85/* Session FD ioctl */
86#define LTTNG_KERNEL_OLD_METADATA \
87 _IOW(0xF6, 0x50, struct lttng_kernel_old_channel)
88#define LTTNG_KERNEL_OLD_CHANNEL \
89 _IOW(0xF6, 0x51, struct lttng_kernel_old_channel)
90#define LTTNG_KERNEL_OLD_SESSION_START _IO(0xF6, 0x52)
91#define LTTNG_KERNEL_OLD_SESSION_STOP _IO(0xF6, 0x53)
92
93/* Channel FD ioctl */
94#define LTTNG_KERNEL_OLD_STREAM _IO(0xF6, 0x60)
95#define LTTNG_KERNEL_OLD_EVENT \
96 _IOW(0xF6, 0x61, struct lttng_kernel_old_event)
f3ed775e 97
4dbc372b
JD
98/* Event and Channel FD ioctl */
99#define LTTNG_KERNEL_OLD_CONTEXT \
100 _IOW(0xF6, 0x70, struct lttng_kernel_old_context)
101
102/* Event, Channel and Session ioctl */
103#define LTTNG_KERNEL_OLD_ENABLE _IO(0xF6, 0x80)
104#define LTTNG_KERNEL_OLD_DISABLE _IO(0xF6, 0x81)
105
106
107/* Current ABI (with suport for 32/64 bits compat) */
857aa172 108/* LTTng file descriptor ioctl */
4dbc372b
JD
109#define LTTNG_KERNEL_SESSION _IO(0xF6, 0x45)
110#define LTTNG_KERNEL_TRACER_VERSION \
111 _IOR(0xF6, 0x46, struct lttng_kernel_tracer_version)
d02666a9 112#define LTTNG_KERNEL_TRACEPOINT_LIST _IO(0xF6, 0x47)
4dbc372b 113#define LTTNG_KERNEL_WAIT_QUIESCENT _IO(0xF6, 0x48)
90d13b3d 114#define LTTNG_KERNEL_SYSCALL_LIST _IO(0xF6, 0x4A)
c052142c
MD
115#define LTTNG_KERNEL_TRACER_ABI_VERSION \
116 _IOR(0xF6, 0x4B, struct lttng_kernel_tracer_abi_version)
8d609afd
JD
117
118/* Session FD ioctl */
4dbc372b
JD
119#define LTTNG_KERNEL_METADATA \
120 _IOW(0xF6, 0x54, struct lttng_kernel_channel)
121#define LTTNG_KERNEL_CHANNEL \
122 _IOW(0xF6, 0x55, struct lttng_kernel_channel)
123#define LTTNG_KERNEL_SESSION_START _IO(0xF6, 0x56)
124#define LTTNG_KERNEL_SESSION_STOP _IO(0xF6, 0x57)
ccf10263
MD
125#define LTTNG_KERNEL_SESSION_TRACK_PID \
126 _IOR(0xF6, 0x58, int32_t)
127#define LTTNG_KERNEL_SESSION_UNTRACK_PID \
128 _IOR(0xF6, 0x59, int32_t)
d2b102df
JG
129/*
130 * ioctl 0x58 and 0x59 are duplicated here. It works, since _IOR vs _IO
131 * are generating two different ioctl numbers, but this was not done on
132 * purpose. We should generally try to avoid those duplications.
133 */
a5dfbb9d 134#define LTTNG_KERNEL_SESSION_LIST_TRACKER_PIDS _IO(0xF6, 0x58)
93ec662e 135#define LTTNG_KERNEL_SESSION_METADATA_REGEN _IO(0xF6, 0x59)
1eceaef1
MD
136/* 0x5A and 0x5B are reserved for a future ABI-breaking cleanup. */
137#define LTTNG_KERNEL_SESSION_STATEDUMP _IO(0xF6, 0x5C)
a64e63e8
MD
138#define LTTNG_KERNEL_SESSION_LIST_TRACKER_IDS \
139 _IOR(0xF6, 0x5D, struct lttng_kernel_tracker_args)
140#define LTTNG_KERNEL_SESSION_TRACK_ID \
141 _IOR(0xF6, 0x5E, struct lttng_kernel_tracker_args)
142#define LTTNG_KERNEL_SESSION_UNTRACK_ID \
143 _IOR(0xF6, 0x5F, struct lttng_kernel_tracker_args)
8d609afd
JD
144
145/* Channel FD ioctl */
4dbc372b
JD
146#define LTTNG_KERNEL_STREAM _IO(0xF6, 0x62)
147#define LTTNG_KERNEL_EVENT \
148 _IOW(0xF6, 0x63, struct lttng_kernel_event)
e80c3634
MD
149#define LTTNG_KERNEL_SYSCALL_MASK \
150 _IOWR(0xF6, 0x64, struct lttng_kernel_syscall_mask)
f3ed775e 151
857aa172 152/* Event and Channel FD ioctl */
4dbc372b
JD
153#define LTTNG_KERNEL_CONTEXT \
154 _IOW(0xF6, 0x71, struct lttng_kernel_context)
857aa172 155
f3ed775e 156/* Event, Channel and Session ioctl */
4dbc372b
JD
157#define LTTNG_KERNEL_ENABLE _IO(0xF6, 0x82)
158#define LTTNG_KERNEL_DISABLE _IO(0xF6, 0x83)
16421f6e 159
00a62084
MD
160/* Event FD ioctl */
161#define LTTNG_KERNEL_FILTER _IO(0xF6, 0x90)
162
16421f6e 163#endif /* _LTT_KERNEL_IOCTL_H */
This page took 0.06903 seconds and 5 git commands to generate.