Add disable kernel channel support
[lttng-tools.git] / liblttsessiondcomm / liblttsessiondcomm.c
CommitLineData
826d496d
MD
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
fac6795d
DG
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; either version 2
7 * of the License, or (at your option) any later version.
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 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
fac6795d
DG
17 */
18
19#define _GNU_SOURCE
20#include <limits.h>
21#include <stdio.h>
22#include <stdlib.h>
23#include <string.h>
24#include <sys/socket.h>
25#include <sys/stat.h>
26#include <sys/types.h>
27#include <sys/un.h>
28#include <unistd.h>
29
30#include "liblttsessiondcomm.h"
31
32/*
33 * Human readable error message.
34 */
35static const char *lttcomm_readable_code[] = {
36 [ LTTCOMM_ERR_INDEX(LTTCOMM_OK) ] = "Success",
37 [ LTTCOMM_ERR_INDEX(LTTCOMM_ERR) ] = "Unknown error",
38 [ LTTCOMM_ERR_INDEX(LTTCOMM_UND) ] = "Undefined command",
39 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESSION) ] = "No session found",
40 [ LTTCOMM_ERR_INDEX(LTTCOMM_LIST_FAIL) ] = "Unable to list traceable apps",
e065084a 41 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_APPS) ] = "No traceable apps found",
f3ed775e 42 [ LTTCOMM_ERR_INDEX(LTTCOMM_SESS_NOT_FOUND) ] = "Session name not found",
ce3d728c 43 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACE) ] = "No trace found",
ca95a216 44 [ LTTCOMM_ERR_INDEX(LTTCOMM_FATAL) ] = "Fatal error of the session daemon",
df0da139 45 [ LTTCOMM_ERR_INDEX(LTTCOMM_CREATE_FAIL) ] = "Create trace failed",
379473d2 46 [ LTTCOMM_ERR_INDEX(LTTCOMM_START_FAIL) ] = "Start trace failed",
520ff687 47 [ LTTCOMM_ERR_INDEX(LTTCOMM_STOP_FAIL) ] = "Stop trace failed",
379473d2
DG
48 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_TRACEABLE) ] = "App is not traceable",
49 [ LTTCOMM_ERR_INDEX(LTTCOMM_SELECT_SESS) ] = "A session MUST be selected",
27673bb6 50 [ LTTCOMM_ERR_INDEX(LTTCOMM_EXIST_SESS) ] = "Session name already exist",
20fe2104
DG
51 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NA) ] = "Kernel tracer not available",
52 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_SESS_FAIL) ] = "Kernel create session failed",
53 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_FAIL) ] = "Kernel create channel failed",
f3ed775e 54 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_NOT_FOUND) ] = "Kernel channel not found",
26cc6b4e 55 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_DISABLE_FAIL) ] = "Disable kernel channel failed",
d36b8583 56 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CHAN_ENABLE_FAIL) ] = "Enable kernel channel failed",
f34daff7
DG
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL) ] = "Enable kernel event failed",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL) ] = "Disable kernel event failed",
aaf26714 59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL) ] = "Opening metadata failed",
8c0faa1d
DG
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL) ] = "Starting kernel trace failed",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL) ] = "Stoping kernel trace failed",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed",
63 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL) ] = "Kernel create stream failed",
64 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL) ] = "Kernel trace directory creation failed",
65 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST) ] = "Kernel trace directory already exist",
84291629 66 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_NO_SESSION) ] = "No kernel session found",
2ef84c95 67 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_LIST_FAIL) ] = "Listing kernel events failed",
d4a1283e
JD
68 [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY) ] = "Kconsumerd command socket ready",
69 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD) ] = "Kconsumerd success on receiving fds",
70 [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD) ] = "Kconsumerd error on receiving fds",
71 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR) ] = "Kconsumerd error in polling thread",
72 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL) ] = "Kconsumerd polling on closed fd",
73 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP) ] = "Kconsumerd all fd hung up",
74 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS) ] = "Kconsumerd exiting normally",
75 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE) ] = "Kconsumerd exiting on error",
76 [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR) ] = "Kconsumerd error opening the tracefile",
0632499a
JD
77 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF) ] = "Kconsumerd splice EBADF",
78 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL) ] = "Kconsumerd splice EINVAL",
79 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM) ] = "Kconsumerd splice ENOMEM",
80 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE) ] = "Kconsumerd splice ESPIPE",
894be886 81 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "No event found",
fac6795d
DG
82};
83
84/*
85 * lttcom_get_readable_code
86 *
87 * Return ptr to string representing a human readable
88 * error code from the lttcomm_return_code enum.
89 *
90 * These code MUST be negative in other to treat that
91 * as an error value.
92 */
93const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
94{
95 int tmp_code = -code;
96
97 if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) {
98 return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)];
99 }
100
101 return "Unknown error code";
102}
103
104/*
105 * lttcomm_connect_unix_sock
106 *
107 * Connect to unix socket using the path name.
108 */
109int lttcomm_connect_unix_sock(const char *pathname)
110{
686204ab
MD
111 struct sockaddr_un sun;
112 int fd;
fac6795d
DG
113 int ret = 1;
114
686204ab 115 fd = socket(PF_UNIX, SOCK_STREAM, 0);
fac6795d
DG
116 if (fd < 0) {
117 perror("socket");
118 goto error;
119 }
120
686204ab
MD
121 memset(&sun, 0, sizeof(sun));
122 sun.sun_family = AF_UNIX;
123 strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
fac6795d 124
686204ab
MD
125 ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun));
126 if (ret < 0) {
127 perror("connect");
fac6795d 128 goto error;
686204ab 129 }
fac6795d 130
686204ab 131 return fd;
fac6795d
DG
132
133error:
134 return -1;
135}
136
137/*
138 * lttcomm_accept_unix_sock
139 *
140 * Do an accept(2) on the sock and return the
141 * new file descriptor. The socket MUST be bind(2) before.
142 */
143int lttcomm_accept_unix_sock(int sock)
144{
145 int new_fd;
146 struct sockaddr_un sun;
147 socklen_t len = 0;
148
149 /* Blocking call */
150 new_fd = accept(sock, (struct sockaddr *) &sun, &len);
151 if (new_fd < 0) {
152 perror("accept");
153 goto error;
154 }
155
156 return new_fd;
157
158error:
159 return -1;
160}
161
162/*
163 * lttcomm_create_unix_sock
164 *
165 * Creates a AF_UNIX local socket using pathname
166 * bind the socket upon creation and return the fd.
167 */
168int lttcomm_create_unix_sock(const char *pathname)
169{
170 struct sockaddr_un sun;
171 int fd;
172 int ret = -1;
173
174 /* Create server socket */
175 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
176 perror("socket");
177 goto error;
178 }
179
180 memset(&sun, 0, sizeof(sun));
181 sun.sun_family = AF_UNIX;
182 strncpy(sun.sun_path, pathname, strlen(pathname));
183
184 ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
185 if (ret < 0) {
186 perror("bind");
187 goto error;
188 }
189
190 return fd;
191
192error:
193 return ret;
194}
195
196/*
197 * lttcomm_listen_unix_sock
198 *
199 * Make the socket listen using MAX_LISTEN.
200 */
201int lttcomm_listen_unix_sock(int sock)
202{
203 int ret;
204
205 ret = listen(sock, MAX_LISTEN);
206 if (ret < 0) {
207 perror("listen");
208 }
209
210 return ret;
211}
212
213/*
214 * lttcomm_recv_unix_sock
215 *
216 * Receive data of size len in put that data into
217 * the buf param. Using recvmsg API.
218 * Return the size of received data.
219 */
220ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len)
221{
222 struct msghdr msg;
223 struct iovec iov[1];
224 ssize_t ret = -1;
225
226 memset(&msg, 0, sizeof(msg));
227
228 iov[0].iov_base = buf;
229 iov[0].iov_len = len;
230 msg.msg_iov = iov;
231 msg.msg_iovlen = 1;
232
233 ret = recvmsg(sock, &msg, 0);
234 if (ret < 0) {
235 perror("recvmsg");
236 }
237
238 return ret;
239}
240
241/*
242 * lttcomm_send_unix_sock
243 *
244 * Send buf data of size len. Using sendmsg API.
245 * Return the size of sent data.
246 */
247ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len)
248{
249 struct msghdr msg;
250 struct iovec iov[1];
251 ssize_t ret = -1;
252
253 memset(&msg, 0, sizeof(msg));
254
255 iov[0].iov_base = buf;
256 iov[0].iov_len = len;
257 msg.msg_iov = iov;
258 msg.msg_iovlen = 1;
259
260 ret = sendmsg(sock, &msg, 0);
261 if (ret < 0) {
262 perror("sendmsg");
263 }
264
265 return ret;
266}
87378cf5
DG
267
268/*
269 * lttcomm_close_unix_sock
270 *
271 * Shutdown cleanly a unix socket.
272 */
273int lttcomm_close_unix_sock(int sock)
274{
275 int ret;
276
277 /* Shutdown receptions and transmissions */
278 ret = shutdown(sock, SHUT_RDWR);
279 if (ret < 0) {
280 perror("shutdown");
281 }
282
283 return ret;
284}
8c0faa1d
DG
285
286/*
287 * lttcomm_send_fds_unix_sock
288 *
289 * Send multiple fds on a unix socket.
290 */
291ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, size_t len)
292{
293 struct msghdr msg;
294 struct cmsghdr *cmptr;
295 struct iovec iov[1];
296 ssize_t ret = -1;
297 unsigned int sizeof_fds = nb_fd * sizeof(int);
298 char tmp[CMSG_SPACE(sizeof_fds)];
299
300 memset(&msg, 0, sizeof(msg));
301
302 msg.msg_control = (caddr_t)tmp;
303 msg.msg_controllen = CMSG_LEN(sizeof_fds);
304
305 cmptr = CMSG_FIRSTHDR(&msg);
306 cmptr->cmsg_len = CMSG_LEN(sizeof_fds);
307 cmptr->cmsg_level = SOL_SOCKET;
308 cmptr->cmsg_type = SCM_RIGHTS;
309 memcpy(CMSG_DATA(cmptr), fds, sizeof_fds);
310
311 iov[0].iov_base = buf;
312 iov[0].iov_len = len;
313 msg.msg_iov = iov;
314 msg.msg_iovlen = 1;
315
316 ret = sendmsg(sock, &msg, 0);
317 if (ret < 0) {
318 perror("sendmsg");
319 }
320
321 return ret;
322}
This page took 0.03533 seconds and 4 git commands to generate.