Add UST event exist error code
[lttng-tools.git] / liblttng-sessiond-comm / lttng-sessiond-comm.c
CommitLineData
826d496d 1/*
917216f6
DG
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
fac6795d 4 *
917216f6
DG
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
fac6795d 8 *
917216f6
DG
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
fac6795d 13 *
917216f6
DG
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
fac6795d
DG
17 */
18
19#define _GNU_SOURCE
1e307fab 20#include <assert.h>
fac6795d
DG
21#include <limits.h>
22#include <stdio.h>
23#include <stdlib.h>
24#include <string.h>
25#include <sys/socket.h>
26#include <sys/stat.h>
27#include <sys/types.h>
28#include <sys/un.h>
29#include <unistd.h>
3bd1e081 30#include <errno.h>
fac6795d 31
e88129fc 32#include <lttng-sessiond-comm.h>
fac6795d
DG
33
34/*
35 * Human readable error message.
36 */
37static const char *lttcomm_readable_code[] = {
38 [ LTTCOMM_ERR_INDEX(LTTCOMM_OK) ] = "Success",
39 [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR) ] = "Unknown error",
40 [ LTTCOMM_ERR_INDEX(LTTCOMM_UND) ] = "Undefined command",
7d29a247
DG
41 [ LTTCOMM_ERR_INDEX(LTTCOMM_NOT_IMPLEMENTED) ] = "Not implemented",
42 [ LTTCOMM_ERR_INDEX(LTTCOMM_UNKNOWN_DOMAIN) ] = "Unknown tracing domain",
fac6795d
DG
43 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION) ] = "No session found",
44 [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL) ] = "Unable to list traceable apps",
e065084a 45 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS) ] = "No traceable apps found",
f3ed775e 46 [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND) ] = "Session name not found",
ce3d728c 47 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE) ] = "No trace found",
ca95a216 48 [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL) ] = "Fatal error of the session daemon",
df0da139 49 [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_FAIL) ] = "Create trace failed",
379473d2 50 [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL) ] = "Start trace failed",
520ff687 51 [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL) ] = "Stop trace failed",
379473d2
DG
52 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE) ] = "App is not traceable",
53 [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS) ] = "A session MUST be selected",
27673bb6 54 [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS) ] = "Session name already exist",
d9800920 55 [ LTTCOMM_ERR_INDEX(LTTCOMM_CONNECT_FAIL) ] = "Unable to connect to Unix socket",
2b0bf864 56 [ LTTCOMM_ERR_INDEX(LTTCOMM_APP_NOT_FOUND) ] = "Application not found",
20fe2104 57 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA) ] = "Kernel tracer not available",
7d29a247 58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_EVENT_EXIST) ] = "Kernel event already exists",
20fe2104
DG
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL) ] = "Kernel create session failed",
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL) ] = "Kernel create channel failed",
f3ed775e 61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND) ] = "Kernel channel not found",
26cc6b4e 62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL) ] = "Disable kernel channel failed",
d36b8583 63 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL) ] = "Enable kernel channel failed",
d65106b1 64 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONTEXT_FAIL) ] = "Add kernel context failed",
f34daff7
DG
65 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL) ] = "Enable kernel event failed",
66 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL) ] = "Disable kernel event failed",
aaf26714 67 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL) ] = "Opening metadata failed",
8c0faa1d
DG
68 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL) ] = "Starting kernel trace failed",
69 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL) ] = "Stoping kernel trace failed",
70 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed",
71 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL) ] = "Kernel create stream failed",
72 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL) ] = "Kernel trace directory creation failed",
73 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST) ] = "Kernel trace directory already exist",
84291629 74 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION) ] = "No kernel session found",
2ef84c95 75 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL) ] = "Listing kernel events failed",
0177d773 76 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_SESS_FAIL) ] = "UST create session failed",
2b0bf864 77 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_FAIL) ] = "UST create channel failed",
f6a9efaa 78 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_EXIST) ] = "UST channel already exist",
2bdd86d4
MD
79 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_NOT_FOUND) ] = "UST channel not found",
80 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_DISABLE_FAIL) ] = "Disable UST channel failed",
81 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CHAN_ENABLE_FAIL) ] = "Enable UST channel failed",
82 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONTEXT_FAIL) ] = "Add UST context failed",
83 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_ENABLE_FAIL) ] = "Enable UST event failed",
84 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DISABLE_FAIL) ] = "Disable UST event failed",
85 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_META_FAIL) ] = "Opening metadata failed",
86 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_START_FAIL) ] = "Starting UST trace failed",
87 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STOP_FAIL) ] = "Stoping UST trace failed",
7753dea8
MD
88 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER64_FAIL) ] = "64-bit UST consumer start failed",
89 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_CONSUMER32_FAIL) ] = "32-bit UST consumer start failed",
2bdd86d4
MD
90 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_STREAM_FAIL) ] = "UST create stream failed",
91 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_FAIL) ] = "UST trace directory creation failed",
92 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_DIR_EXIST) ] = "UST trace directory already exist",
93 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_NO_SESSION) ] = "No UST session found",
94 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_LIST_FAIL) ] = "Listing UST events failed",
3b25d04d 95 [ LTTCOMM_ERR_INDEX(LTTCOMM_UST_EVENT_EXIST) ] = "UST event already exist",
3bd1e081
MD
96 [ LTTCOMM_ERR_INDEX(CONSUMERD_COMMAND_SOCK_READY) ] = "consumerd command socket ready",
97 [ LTTCOMM_ERR_INDEX(CONSUMERD_SUCCESS_RECV_FD) ] = "consumerd success on receiving fds",
98 [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_FD) ] = "consumerd error on receiving fds",
f2fc6720 99 [ LTTCOMM_ERR_INDEX(CONSUMERD_ERROR_RECV_CMD) ] = "consumerd error on receiving command",
3bd1e081
MD
100 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_ERROR) ] = "consumerd error in polling thread",
101 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_NVAL) ] = "consumerd polling on closed fd",
102 [ LTTCOMM_ERR_INDEX(CONSUMERD_POLL_HUP) ] = "consumerd all fd hung up",
103 [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_SUCCESS) ] = "consumerd exiting normally",
104 [ LTTCOMM_ERR_INDEX(CONSUMERD_EXIT_FAILURE) ] = "consumerd exiting on error",
105 [ LTTCOMM_ERR_INDEX(CONSUMERD_OUTFD_ERROR) ] = "consumerd error opening the tracefile",
106 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EBADF) ] = "consumerd splice EBADF",
107 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_EINVAL) ] = "consumerd splice EINVAL",
108 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ENOMEM) ] = "consumerd splice ENOMEM",
109 [ LTTCOMM_ERR_INDEX(CONSUMERD_SPLICE_ESPIPE) ] = "consumerd splice ESPIPE",
d65106b1 110 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "Event not found",
fac6795d
DG
111};
112
113/*
917216f6
DG
114 * Return ptr to string representing a human readable error code from the
115 * lttcomm_return_code enum.
fac6795d 116 *
917216f6 117 * These code MUST be negative in other to treat that as an error value.
fac6795d
DG
118 */
119const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
120{
121 int tmp_code = -code;
122
123 if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) {
124 return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)];
125 }
126
127 return "Unknown error code";
128}
129
130/*
917216f6 131 * Connect to unix socket using the path name.
fac6795d
DG
132 */
133int lttcomm_connect_unix_sock(const char *pathname)
134{
686204ab
MD
135 struct sockaddr_un sun;
136 int fd;
a8afeb4a 137 int ret;
fac6795d 138
686204ab 139 fd = socket(PF_UNIX, SOCK_STREAM, 0);
fac6795d
DG
140 if (fd < 0) {
141 perror("socket");
a8afeb4a 142 ret = fd;
fac6795d
DG
143 goto error;
144 }
145
686204ab
MD
146 memset(&sun, 0, sizeof(sun));
147 sun.sun_family = AF_UNIX;
148 strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
99497cd0 149 sun.sun_path[sizeof(sun.sun_path) - 1] = '\0';
fac6795d 150
686204ab
MD
151 ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun));
152 if (ret < 0) {
a8afeb4a 153 /*
917216f6
DG
154 * Don't print message on connect error, because connect is used in
155 * normal execution to detect if sessiond is alive.
a8afeb4a
MD
156 */
157 goto error_connect;
686204ab 158 }
fac6795d 159
686204ab 160 return fd;
fac6795d 161
a8afeb4a
MD
162error_connect:
163 close(fd);
fac6795d 164error:
a8afeb4a 165 return ret;
fac6795d
DG
166}
167
168/*
917216f6
DG
169 * Do an accept(2) on the sock and return the new file descriptor. The socket
170 * MUST be bind(2) before.
fac6795d
DG
171 */
172int lttcomm_accept_unix_sock(int sock)
173{
174 int new_fd;
175 struct sockaddr_un sun;
176 socklen_t len = 0;
177
178 /* Blocking call */
179 new_fd = accept(sock, (struct sockaddr *) &sun, &len);
180 if (new_fd < 0) {
181 perror("accept");
182 goto error;
183 }
184
185 return new_fd;
186
187error:
188 return -1;
189}
190
191/*
917216f6
DG
192 * Creates a AF_UNIX local socket using pathname bind the socket upon creation
193 * and return the fd.
fac6795d
DG
194 */
195int lttcomm_create_unix_sock(const char *pathname)
196{
197 struct sockaddr_un sun;
198 int fd;
199 int ret = -1;
200
201 /* Create server socket */
202 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
203 perror("socket");
204 goto error;
205 }
206
207 memset(&sun, 0, sizeof(sun));
208 sun.sun_family = AF_UNIX;
99497cd0
MD
209 strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
210 sun.sun_path[sizeof(sun.sun_path) - 1] = '\0';
fac6795d 211
7d8234d9
MD
212 /* Unlink the old file if present */
213 (void) unlink(pathname);
fac6795d
DG
214 ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
215 if (ret < 0) {
216 perror("bind");
217 goto error;
218 }
219
220 return fd;
221
222error:
223 return ret;
224}
225
226/*
f158a754 227 * Make the socket listen using LTTNG_SESSIOND_COMM_MAX_LISTEN.
fac6795d
DG
228 */
229int lttcomm_listen_unix_sock(int sock)
230{
231 int ret;
232
f158a754 233 ret = listen(sock, LTTNG_SESSIOND_COMM_MAX_LISTEN);
fac6795d
DG
234 if (ret < 0) {
235 perror("listen");
236 }
237
238 return ret;
239}
240
241/*
917216f6
DG
242 * Receive data of size len in put that data into the buf param. Using recvmsg
243 * API.
fac6795d 244 *
917216f6 245 * Return the size of received data.
fac6795d
DG
246 */
247ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len)
248{
159c7ff4 249 struct msghdr msg = { 0 };
fac6795d
DG
250 struct iovec iov[1];
251 ssize_t ret = -1;
252
fac6795d
DG
253 iov[0].iov_base = buf;
254 iov[0].iov_len = len;
255 msg.msg_iov = iov;
256 msg.msg_iovlen = 1;
257
258 ret = recvmsg(sock, &msg, 0);
259 if (ret < 0) {
260 perror("recvmsg");
261 }
262
263 return ret;
264}
265
266/*
917216f6 267 * Send buf data of size len. Using sendmsg API.
fac6795d 268 *
917216f6 269 * Return the size of sent data.
fac6795d
DG
270 */
271ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len)
272{
159c7ff4 273 struct msghdr msg = { 0 };
fac6795d
DG
274 struct iovec iov[1];
275 ssize_t ret = -1;
276
fac6795d
DG
277 iov[0].iov_base = buf;
278 iov[0].iov_len = len;
279 msg.msg_iov = iov;
280 msg.msg_iovlen = 1;
281
282 ret = sendmsg(sock, &msg, 0);
283 if (ret < 0) {
284 perror("sendmsg");
285 }
286
287 return ret;
288}
87378cf5
DG
289
290/*
917216f6 291 * Shutdown cleanly a unix socket.
87378cf5
DG
292 */
293int lttcomm_close_unix_sock(int sock)
294{
295 int ret;
296
297 /* Shutdown receptions and transmissions */
298 ret = shutdown(sock, SHUT_RDWR);
299 if (ret < 0) {
300 perror("shutdown");
301 }
302
303 return ret;
304}
8c0faa1d
DG
305
306/*
3bd1e081
MD
307 * Send a message accompanied by fd(s) over a unix socket.
308 *
309 * Returns the size of data sent, or negative error value.
8c0faa1d 310 */
3bd1e081 311ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
8c0faa1d 312{
159c7ff4 313 struct msghdr msg = { 0 };
8c0faa1d
DG
314 struct cmsghdr *cmptr;
315 struct iovec iov[1];
316 ssize_t ret = -1;
317 unsigned int sizeof_fds = nb_fd * sizeof(int);
318 char tmp[CMSG_SPACE(sizeof_fds)];
3bd1e081 319 char dummy = 0;
8c0faa1d 320
3bd1e081
MD
321 if (nb_fd > LTTCOMM_MAX_SEND_FDS)
322 return -EINVAL;
8c0faa1d
DG
323
324 msg.msg_control = (caddr_t)tmp;
325 msg.msg_controllen = CMSG_LEN(sizeof_fds);
326
327 cmptr = CMSG_FIRSTHDR(&msg);
8c0faa1d
DG
328 cmptr->cmsg_level = SOL_SOCKET;
329 cmptr->cmsg_type = SCM_RIGHTS;
159c7ff4 330 cmptr->cmsg_len = CMSG_LEN(sizeof_fds);
8c0faa1d 331 memcpy(CMSG_DATA(cmptr), fds, sizeof_fds);
159c7ff4
MD
332 /* Sum of the length of all control messages in the buffer: */
333 msg.msg_controllen = cmptr->cmsg_len;
8c0faa1d 334
3bd1e081
MD
335 iov[0].iov_base = &dummy;
336 iov[0].iov_len = 1;
8c0faa1d
DG
337 msg.msg_iov = iov;
338 msg.msg_iovlen = 1;
339
340 ret = sendmsg(sock, &msg, 0);
341 if (ret < 0) {
342 perror("sendmsg");
343 }
8c0faa1d
DG
344 return ret;
345}
09de5c68
DG
346
347/*
3bd1e081 348 * Recv a message accompanied by fd(s) from a unix socket.
09de5c68 349 *
3bd1e081
MD
350 * Returns the size of received data, or negative error value.
351 *
352 * Expect at most "nb_fd" file descriptors. Returns the number of fd
353 * actually received in nb_fd.
09de5c68 354 */
3bd1e081 355ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd)
09de5c68
DG
356{
357 struct iovec iov[1];
3bd1e081 358 ssize_t ret = 0;
09de5c68 359 struct cmsghdr *cmsg;
3bd1e081
MD
360 size_t sizeof_fds = nb_fd * sizeof(int);
361 char recv_fd[CMSG_SPACE(sizeof_fds)];
09de5c68 362 struct msghdr msg = { 0 };
3bd1e081 363 char dummy;
09de5c68
DG
364
365 /* Prepare to receive the structures */
3bd1e081
MD
366 iov[0].iov_base = &dummy;
367 iov[0].iov_len = 1;
09de5c68
DG
368 msg.msg_iov = iov;
369 msg.msg_iovlen = 1;
370 msg.msg_control = recv_fd;
371 msg.msg_controllen = sizeof(recv_fd);
372
373 ret = recvmsg(sock, &msg, 0);
374 if (ret < 0) {
375 perror("recvmsg fds");
376 goto end;
377 }
3bd1e081
MD
378 if (ret != 1) {
379 fprintf(stderr, "Error: Received %zd bytes, expected %d\n",
380 ret, 1);
381 goto end;
382 }
383 if (msg.msg_flags & MSG_CTRUNC) {
384 fprintf(stderr, "Error: Control message truncated.\n");
385 ret = -1;
09de5c68
DG
386 goto end;
387 }
09de5c68
DG
388 cmsg = CMSG_FIRSTHDR(&msg);
389 if (!cmsg) {
3bd1e081 390 fprintf(stderr, "Error: Invalid control message header\n");
09de5c68
DG
391 ret = -1;
392 goto end;
393 }
09de5c68 394 if (cmsg->cmsg_level != SOL_SOCKET || cmsg->cmsg_type != SCM_RIGHTS) {
3bd1e081 395 fprintf(stderr, "Didn't received any fd\n");
09de5c68
DG
396 ret = -1;
397 goto end;
398 }
3bd1e081
MD
399 if (cmsg->cmsg_len != CMSG_LEN(sizeof_fds)) {
400 fprintf(stderr, "Error: Received %zu bytes of ancillary data, expected %zu\n",
401 cmsg->cmsg_len, CMSG_LEN(sizeof_fds));
402 ret = -1;
403 goto end;
09de5c68 404 }
3bd1e081
MD
405 memcpy(fds, CMSG_DATA(cmsg), sizeof_fds);
406 ret = sizeof_fds;
09de5c68
DG
407end:
408 return ret;
409}
This page took 0.067747 seconds and 4 git commands to generate.