Fix: enable event with different loglevel error
[lttng-tools.git] / src / common / sessiond-comm / sessiond-comm.h
CommitLineData
6e3805e2
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
773168b7 4 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d 5 *
d14d33bf
AM
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
fac6795d 9 *
990570ed
DG
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d14d33bf 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
990570ed 13 * more details.
fac6795d 14 *
d14d33bf
AM
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
fac6795d
DG
18 */
19
773168b7 20/*
990570ed
DG
21 * This header is meant for liblttng and libust internal use ONLY. These
22 * declarations should NOT be considered stable API.
773168b7 23 */
fac6795d 24
990570ed
DG
25#ifndef _LTTNG_SESSIOND_COMM_H
26#define _LTTNG_SESSIOND_COMM_H
27
d19d9ada 28#define _GNU_SOURCE
fac6795d 29#include <limits.h>
f3ed775e 30#include <lttng/lttng.h>
b17231c6 31#include <common/compat/socket.h>
5e16da05 32
0d37f2bc
DG
33#include "unix.h"
34
fac6795d 35/* Queue size of listen(2) */
f158a754 36#define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
fac6795d 37
990570ed
DG
38/* Maximum number of FDs that can be sent over a Unix socket */
39#define LTTCOMM_MAX_SEND_FDS 4
40
3817e7df
DG
41/*
42 * Get the error code index from 0 since LTTCOMM_OK start at 1000
fac6795d 43 */
686204ab 44#define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
fac6795d 45
6abb15de 46enum lttcomm_sessiond_command {
0d0c377a 47 /* Tracer command */
b579acd9 48 LTTNG_ADD_CONTEXT,
f4688807 49 LTTNG_CALIBRATE,
0b97ec54 50 LTTNG_DISABLE_CHANNEL,
f5177a38
DG
51 LTTNG_DISABLE_EVENT,
52 LTTNG_DISABLE_ALL_EVENT,
0d0c377a
DG
53 LTTNG_ENABLE_CHANNEL,
54 LTTNG_ENABLE_EVENT,
55 LTTNG_ENABLE_ALL_EVENT,
56 /* Session daemon command */
fac6795d
DG
57 LTTNG_CREATE_SESSION,
58 LTTNG_DESTROY_SESSION,
9f19cc17
DG
59 LTTNG_LIST_CHANNELS,
60 LTTNG_LIST_DOMAINS,
f3ed775e 61 LTTNG_LIST_EVENTS,
9f19cc17 62 LTTNG_LIST_SESSIONS,
052da939 63 LTTNG_LIST_TRACEPOINTS,
d9800920 64 LTTNG_REGISTER_CONSUMER,
f3ed775e
DG
65 LTTNG_START_TRACE,
66 LTTNG_STOP_TRACE,
f37d259d 67 LTTNG_LIST_TRACEPOINT_FIELDS,
fac6795d
DG
68};
69
70/*
71 * lttcomm error code.
72 */
73enum lttcomm_return_code {
42224349 74 LTTCOMM_OK = 10, /* Ok */
20fe2104
DG
75 LTTCOMM_ERR, /* Unknown Error */
76 LTTCOMM_UND, /* Undefine command */
7d29a247
DG
77 LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */
78 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
20fe2104
DG
79 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
80 LTTCOMM_NO_SESSION, /* No session found */
ae856491 81 LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */
20fe2104
DG
82 LTTCOMM_SESSION_FAIL, /* Create session fail */
83 LTTCOMM_START_FAIL, /* Start tracing fail */
84 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
85 LTTCOMM_LIST_FAIL, /* Listing apps fail */
86 LTTCOMM_NO_APPS, /* No traceable application */
f3ed775e 87 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
20fe2104
DG
88 LTTCOMM_NO_TRACE, /* No trace exist */
89 LTTCOMM_FATAL, /* Session daemon had a fatal error */
90 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
91 LTTCOMM_SELECT_SESS, /* Must select a session */
92 LTTCOMM_EXIST_SESS, /* Session name already exist */
93 LTTCOMM_NO_EVENT, /* No event found */
d9800920 94 LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */
2b0bf864 95 LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */
8e0af1b4 96 LTTCOMM_EPERM, /* Permission denied */
20fe2104 97 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
394016d1 98 LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */
7d29a247 99 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
20fe2104 100 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
42224349 101 LTTCOMM_KERN_CHAN_EXIST, /* Kernel channel already exists */
20fe2104 102 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
f3ed775e 103 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
26cc6b4e 104 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
d36b8583 105 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
d65106b1 106 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
f34daff7
DG
107 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
108 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
aaf26714 109 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
8c0faa1d
DG
110 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
111 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
112 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
113 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
114 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
84291629
DG
115 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
116 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
2ef84c95 117 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
4466912f 118 LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */
e0c7ec2b 119 LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */
0177d773 120 LTTCOMM_UST_SESS_FAIL, /* UST create session failed */
f6a9efaa 121 LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */
2bdd86d4 122 LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */
2b0bf864 123 LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */
2bdd86d4
MD
124 LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
125 LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */
126 LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */
127 LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */
128 LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */
129 LTTCOMM_UST_META_FAIL, /* UST open metadata failed */
130 LTTCOMM_UST_START_FAIL, /* UST start trace failed */
131 LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */
7753dea8
MD
132 LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */
133 LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */
2bdd86d4
MD
134 LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */
135 LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */
136 LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */
137 LTTCOMM_UST_NO_SESSION, /* No UST session found */
138 LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */
3b25d04d 139 LTTCOMM_UST_EVENT_EXIST, /* UST event exist */
be4f0921 140 LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */
ae357384 141 LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */
ae856491 142 LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */
80e327fa
DG
143 LTTCOMM_NEED_ROOT_SESSIOND, /* root sessiond is needed */
144 LTTCOMM_TRACE_ALREADY_STARTED, /* Tracing already started */
145 LTTCOMM_TRACE_ALREADY_STOPPED, /* Tracing already stopped */
bd29c13d 146 LTTCOMM_KERN_EVENT_ENOSYS, /* Kernel event type not supported */
2bdd86d4 147
3bd1e081
MD
148 CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */
149 CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
150 CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
f2fc6720 151 CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */
3bd1e081
MD
152 CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
153 CONSUMERD_POLL_NVAL, /* Poll on closed fd */
154 CONSUMERD_POLL_HUP, /* All fds have hungup */
155 CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
156 CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
157 CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
158 CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
159 CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
160 CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
161 CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
b024d072 162 LTTCOMM_INVALID, /* Invalid parameter */
5c827ce0
DG
163 LTTCOMM_NO_USTCONSUMERD, /* No UST consumer detected */
164 LTTCOMM_NO_KERNCONSUMERD, /* No Kernel consumer detected */
a027b2d2 165 LTTCOMM_EVENT_EXIST_LOGLEVEL, /* Event already enabled with different loglevel */
80e327fa 166
20fe2104
DG
167 /* MUST be last element */
168 LTTCOMM_NR, /* Last element */
fac6795d
DG
169};
170
171/*
9bda164d 172 * Data structure received from lttng client to session daemon.
fac6795d
DG
173 */
174struct lttcomm_session_msg {
773168b7 175 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
42abccdb 176 struct lttng_session session;
9f19cc17 177 struct lttng_domain domain;
fac6795d
DG
178 union {
179 struct {
f3ed775e
DG
180 char channel_name[NAME_MAX];
181 char name[NAME_MAX];
182 } disable;
183 /* Event data */
fac6795d 184 struct {
f3ed775e
DG
185 char channel_name[NAME_MAX];
186 struct lttng_event event;
187 } enable;
188 /* Create channel */
189 struct {
190 struct lttng_channel chan;
191 } channel;
d65106b1
DG
192 /* Context */
193 struct {
194 char channel_name[NAME_MAX];
195 char event_name[NAME_MAX];
7d29a247 196 struct lttng_event_context ctx;
d65106b1 197 } context;
d9800920
DG
198 /* Use by register_consumer */
199 struct {
200 char path[PATH_MAX];
201 } reg;
9f19cc17
DG
202 /* List */
203 struct {
204 char channel_name[NAME_MAX];
205 } list;
d0254c7c 206 struct lttng_calibrate calibrate;
fac6795d
DG
207 } u;
208};
209
210/*
5e16da05 211 * Data structure for the response from sessiond to the lttng client.
fac6795d 212 */
5461b305 213struct lttcomm_lttng_msg {
773168b7
MD
214 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
215 uint32_t ret_code; /* enum lttcomm_return_code */
216 uint32_t pid; /* pid_t */
217 uint32_t data_size;
5461b305
DG
218 /* Contains: trace_name + data */
219 char payload[];
fac6795d
DG
220};
221
6e3805e2 222/*
3bd1e081
MD
223 * lttcomm_consumer_msg is the message sent from sessiond to consumerd
224 * to either add a channel, add a stream, update a stream, or stop
225 * operation.
6e3805e2 226 */
3bd1e081
MD
227struct lttcomm_consumer_msg {
228 uint32_t cmd_type; /* enum consumerd_command */
229 union {
230 struct {
231 int channel_key;
232 uint64_t max_sb_size; /* the subbuffer size for this channel */
233 /* shm_fd and wait_fd are sent as ancillary data */
234 uint64_t mmap_len;
235 } channel;
236 struct {
237 int channel_key;
238 int stream_key;
239 /* shm_fd and wait_fd are sent as ancillary data */
240 uint32_t state; /* enum lttcomm_consumer_fd_state */
241 enum lttng_event_output output; /* use splice or mmap to consume this fd */
242 uint64_t mmap_len;
6df2e2c9
MD
243 uid_t uid; /* User ID owning the session */
244 gid_t gid; /* Group ID owning the session */
3bd1e081
MD
245 char path_name[PATH_MAX];
246 } stream;
247 } u;
6e3805e2
DG
248};
249
74d0b642 250#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 251
9df8df5e 252#include <lttng/ust-abi.h>
6e3805e2 253
3817e7df
DG
254/*
255 * Data structure for the commands sent from sessiond to UST.
256 */
257struct lttcomm_ust_msg {
3817e7df
DG
258 uint32_t handle;
259 uint32_t cmd;
260 union {
3817e7df 261 struct lttng_ust_channel channel;
00a17c97 262 struct lttng_ust_stream stream;
3817e7df
DG
263 struct lttng_ust_event event;
264 struct lttng_ust_context context;
00a17c97 265 struct lttng_ust_tracer_version version;
3817e7df
DG
266 } u;
267};
268
269/*
270 * Data structure for the response from UST to the session daemon.
271 * cmd_type is sent back in the reply for validation.
272 */
273struct lttcomm_ust_reply {
274 uint32_t handle;
275 uint32_t cmd;
276 uint32_t ret_code; /* enum lttcomm_return_code */
277 uint32_t ret_val; /* return value */
278 union {
2b0bf864
DG
279 struct {
280 uint64_t memory_map_size;
281 } channel;
282 struct {
283 uint64_t memory_map_size;
284 } stream;
00a17c97 285 struct lttng_ust_tracer_version version;
3817e7df
DG
286 } u;
287};
288
74d0b642 289#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 290
fac6795d
DG
291extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
292
773168b7 293#endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.067502 seconds and 4 git commands to generate.