Initial work for kernel tracing 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",
57167058 42 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_SESS) ] = "No session 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",
f34daff7
DG
54 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_ENABLE_FAIL) ] = "Enable kernel event failed",
55 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DISABLE_FAIL) ] = "Disable kernel event failed",
aaf26714 56 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_META_FAIL) ] = "Opening metadata failed",
8c0faa1d
DG
57 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_START_FAIL) ] = "Starting kernel trace failed",
58 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STOP_FAIL) ] = "Stoping kernel trace failed",
59 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_CONSUMER_FAIL) ] = "Kernel consumer start failed",
60 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_STREAM_FAIL) ] = "Kernel create stream failed",
61 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_FAIL) ] = "Kernel trace directory creation failed",
62 [ LTTCOMM_ERR_INDEX(LTTCOMM_KERN_DIR_EXIST) ] = "Kernel trace directory already exist",
d4a1283e
JD
63 [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY) ] = "Kconsumerd command socket ready",
64 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD) ] = "Kconsumerd success on receiving fds",
65 [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD) ] = "Kconsumerd error on receiving fds",
66 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR) ] = "Kconsumerd error in polling thread",
67 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL) ] = "Kconsumerd polling on closed fd",
68 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP) ] = "Kconsumerd all fd hung up",
69 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS) ] = "Kconsumerd exiting normally",
70 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE) ] = "Kconsumerd exiting on error",
71 [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR) ] = "Kconsumerd error opening the tracefile",
0632499a
JD
72 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF) ] = "Kconsumerd splice EBADF",
73 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL) ] = "Kconsumerd splice EINVAL",
74 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM) ] = "Kconsumerd splice ENOMEM",
75 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE) ] = "Kconsumerd splice ESPIPE",
894be886 76 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "No event found",
fac6795d
DG
77};
78
79/*
80 * lttcom_get_readable_code
81 *
82 * Return ptr to string representing a human readable
83 * error code from the lttcomm_return_code enum.
84 *
85 * These code MUST be negative in other to treat that
86 * as an error value.
87 */
88const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
89{
90 int tmp_code = -code;
91
92 if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) {
93 return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)];
94 }
95
96 return "Unknown error code";
97}
98
99/*
100 * lttcomm_connect_unix_sock
101 *
102 * Connect to unix socket using the path name.
103 */
104int lttcomm_connect_unix_sock(const char *pathname)
105{
686204ab
MD
106 struct sockaddr_un sun;
107 int fd;
fac6795d
DG
108 int ret = 1;
109
686204ab 110 fd = socket(PF_UNIX, SOCK_STREAM, 0);
fac6795d
DG
111 if (fd < 0) {
112 perror("socket");
113 goto error;
114 }
115
686204ab
MD
116 memset(&sun, 0, sizeof(sun));
117 sun.sun_family = AF_UNIX;
118 strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
fac6795d 119
686204ab
MD
120 ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun));
121 if (ret < 0) {
122 perror("connect");
fac6795d 123 goto error;
686204ab 124 }
fac6795d 125
686204ab 126 return fd;
fac6795d
DG
127
128error:
129 return -1;
130}
131
132/*
133 * lttcomm_accept_unix_sock
134 *
135 * Do an accept(2) on the sock and return the
136 * new file descriptor. The socket MUST be bind(2) before.
137 */
138int lttcomm_accept_unix_sock(int sock)
139{
140 int new_fd;
141 struct sockaddr_un sun;
142 socklen_t len = 0;
143
144 /* Blocking call */
145 new_fd = accept(sock, (struct sockaddr *) &sun, &len);
146 if (new_fd < 0) {
147 perror("accept");
148 goto error;
149 }
150
151 return new_fd;
152
153error:
154 return -1;
155}
156
157/*
158 * lttcomm_create_unix_sock
159 *
160 * Creates a AF_UNIX local socket using pathname
161 * bind the socket upon creation and return the fd.
162 */
163int lttcomm_create_unix_sock(const char *pathname)
164{
165 struct sockaddr_un sun;
166 int fd;
167 int ret = -1;
168
169 /* Create server socket */
170 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
171 perror("socket");
172 goto error;
173 }
174
175 memset(&sun, 0, sizeof(sun));
176 sun.sun_family = AF_UNIX;
177 strncpy(sun.sun_path, pathname, strlen(pathname));
178
179 ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
180 if (ret < 0) {
181 perror("bind");
182 goto error;
183 }
184
185 return fd;
186
187error:
188 return ret;
189}
190
191/*
192 * lttcomm_listen_unix_sock
193 *
194 * Make the socket listen using MAX_LISTEN.
195 */
196int lttcomm_listen_unix_sock(int sock)
197{
198 int ret;
199
200 ret = listen(sock, MAX_LISTEN);
201 if (ret < 0) {
202 perror("listen");
203 }
204
205 return ret;
206}
207
208/*
209 * lttcomm_recv_unix_sock
210 *
211 * Receive data of size len in put that data into
212 * the buf param. Using recvmsg API.
213 * Return the size of received data.
214 */
215ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len)
216{
217 struct msghdr msg;
218 struct iovec iov[1];
219 ssize_t ret = -1;
220
221 memset(&msg, 0, sizeof(msg));
222
223 iov[0].iov_base = buf;
224 iov[0].iov_len = len;
225 msg.msg_iov = iov;
226 msg.msg_iovlen = 1;
227
228 ret = recvmsg(sock, &msg, 0);
229 if (ret < 0) {
230 perror("recvmsg");
231 }
232
233 return ret;
234}
235
236/*
237 * lttcomm_send_unix_sock
238 *
239 * Send buf data of size len. Using sendmsg API.
240 * Return the size of sent data.
241 */
242ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len)
243{
244 struct msghdr msg;
245 struct iovec iov[1];
246 ssize_t ret = -1;
247
248 memset(&msg, 0, sizeof(msg));
249
250 iov[0].iov_base = buf;
251 iov[0].iov_len = len;
252 msg.msg_iov = iov;
253 msg.msg_iovlen = 1;
254
255 ret = sendmsg(sock, &msg, 0);
256 if (ret < 0) {
257 perror("sendmsg");
258 }
259
260 return ret;
261}
87378cf5
DG
262
263/*
264 * lttcomm_close_unix_sock
265 *
266 * Shutdown cleanly a unix socket.
267 */
268int lttcomm_close_unix_sock(int sock)
269{
270 int ret;
271
272 /* Shutdown receptions and transmissions */
273 ret = shutdown(sock, SHUT_RDWR);
274 if (ret < 0) {
275 perror("shutdown");
276 }
277
278 return ret;
279}
8c0faa1d
DG
280
281/*
282 * lttcomm_send_fds_unix_sock
283 *
284 * Send multiple fds on a unix socket.
285 */
286ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, size_t len)
287{
288 struct msghdr msg;
289 struct cmsghdr *cmptr;
290 struct iovec iov[1];
291 ssize_t ret = -1;
292 unsigned int sizeof_fds = nb_fd * sizeof(int);
293 char tmp[CMSG_SPACE(sizeof_fds)];
294
295 memset(&msg, 0, sizeof(msg));
296
297 msg.msg_control = (caddr_t)tmp;
298 msg.msg_controllen = CMSG_LEN(sizeof_fds);
299
300 cmptr = CMSG_FIRSTHDR(&msg);
301 cmptr->cmsg_len = CMSG_LEN(sizeof_fds);
302 cmptr->cmsg_level = SOL_SOCKET;
303 cmptr->cmsg_type = SCM_RIGHTS;
304 memcpy(CMSG_DATA(cmptr), fds, sizeof_fds);
305
306 iov[0].iov_base = buf;
307 iov[0].iov_len = len;
308 msg.msg_iov = iov;
309 msg.msg_iovlen = 1;
310
311 ret = sendmsg(sock, &msg, 0);
312 if (ret < 0) {
313 perror("sendmsg");
314 }
315
316 return ret;
317}
This page took 0.037925 seconds and 4 git commands to generate.