Add tags from ctags to gitignore
[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",
d4a1283e
JD
57 [ LTTCOMM_ERR_INDEX(KCONSUMERD_COMMAND_SOCK_READY) ] = "Kconsumerd command socket ready",
58 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SUCCESS_RECV_FD) ] = "Kconsumerd success on receiving fds",
59 [ LTTCOMM_ERR_INDEX(KCONSUMERD_ERROR_RECV_FD) ] = "Kconsumerd error on receiving fds",
60 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_ERROR) ] = "Kconsumerd error in polling thread",
61 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_NVAL) ] = "Kconsumerd polling on closed fd",
62 [ LTTCOMM_ERR_INDEX(KCONSUMERD_POLL_HUP) ] = "Kconsumerd all fd hung up",
63 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_SUCCESS) ] = "Kconsumerd exiting normally",
64 [ LTTCOMM_ERR_INDEX(KCONSUMERD_EXIT_FAILURE) ] = "Kconsumerd exiting on error",
65 [ LTTCOMM_ERR_INDEX(KCONSUMERD_OUTFD_ERROR) ] = "Kconsumerd error opening the tracefile",
0632499a
JD
66 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EBADF) ] = "Kconsumerd splice EBADF",
67 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_EINVAL) ] = "Kconsumerd splice EINVAL",
68 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ENOMEM) ] = "Kconsumerd splice ENOMEM",
69 [ LTTCOMM_ERR_INDEX(KCONSUMERD_SPLICE_ESPIPE) ] = "Kconsumerd splice ESPIPE",
894be886 70 [ LTTCOMM_ERR_INDEX(LTTCOMM_NO_EVENT) ] = "No event found",
fac6795d
DG
71};
72
73/*
74 * lttcom_get_readable_code
75 *
76 * Return ptr to string representing a human readable
77 * error code from the lttcomm_return_code enum.
78 *
79 * These code MUST be negative in other to treat that
80 * as an error value.
81 */
82const char *lttcomm_get_readable_code(enum lttcomm_return_code code)
83{
84 int tmp_code = -code;
85
86 if (tmp_code >= LTTCOMM_OK && tmp_code < LTTCOMM_NR) {
87 return lttcomm_readable_code[LTTCOMM_ERR_INDEX(tmp_code)];
88 }
89
90 return "Unknown error code";
91}
92
93/*
94 * lttcomm_connect_unix_sock
95 *
96 * Connect to unix socket using the path name.
97 */
98int lttcomm_connect_unix_sock(const char *pathname)
99{
686204ab
MD
100 struct sockaddr_un sun;
101 int fd;
fac6795d
DG
102 int ret = 1;
103
686204ab 104 fd = socket(PF_UNIX, SOCK_STREAM, 0);
fac6795d
DG
105 if (fd < 0) {
106 perror("socket");
107 goto error;
108 }
109
686204ab
MD
110 memset(&sun, 0, sizeof(sun));
111 sun.sun_family = AF_UNIX;
112 strncpy(sun.sun_path, pathname, sizeof(sun.sun_path));
fac6795d 113
686204ab
MD
114 ret = connect(fd, (struct sockaddr *) &sun, sizeof(sun));
115 if (ret < 0) {
116 perror("connect");
fac6795d 117 goto error;
686204ab 118 }
fac6795d 119
686204ab 120 return fd;
fac6795d
DG
121
122error:
123 return -1;
124}
125
126/*
127 * lttcomm_accept_unix_sock
128 *
129 * Do an accept(2) on the sock and return the
130 * new file descriptor. The socket MUST be bind(2) before.
131 */
132int lttcomm_accept_unix_sock(int sock)
133{
134 int new_fd;
135 struct sockaddr_un sun;
136 socklen_t len = 0;
137
138 /* Blocking call */
139 new_fd = accept(sock, (struct sockaddr *) &sun, &len);
140 if (new_fd < 0) {
141 perror("accept");
142 goto error;
143 }
144
145 return new_fd;
146
147error:
148 return -1;
149}
150
151/*
152 * lttcomm_create_unix_sock
153 *
154 * Creates a AF_UNIX local socket using pathname
155 * bind the socket upon creation and return the fd.
156 */
157int lttcomm_create_unix_sock(const char *pathname)
158{
159 struct sockaddr_un sun;
160 int fd;
161 int ret = -1;
162
163 /* Create server socket */
164 if ((fd = socket(PF_UNIX, SOCK_STREAM, 0)) < 0) {
165 perror("socket");
166 goto error;
167 }
168
169 memset(&sun, 0, sizeof(sun));
170 sun.sun_family = AF_UNIX;
171 strncpy(sun.sun_path, pathname, strlen(pathname));
172
173 ret = bind(fd, (struct sockaddr *) &sun, sizeof(sun));
174 if (ret < 0) {
175 perror("bind");
176 goto error;
177 }
178
179 return fd;
180
181error:
182 return ret;
183}
184
185/*
186 * lttcomm_listen_unix_sock
187 *
188 * Make the socket listen using MAX_LISTEN.
189 */
190int lttcomm_listen_unix_sock(int sock)
191{
192 int ret;
193
194 ret = listen(sock, MAX_LISTEN);
195 if (ret < 0) {
196 perror("listen");
197 }
198
199 return ret;
200}
201
202/*
203 * lttcomm_recv_unix_sock
204 *
205 * Receive data of size len in put that data into
206 * the buf param. Using recvmsg API.
207 * Return the size of received data.
208 */
209ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len)
210{
211 struct msghdr msg;
212 struct iovec iov[1];
213 ssize_t ret = -1;
214
215 memset(&msg, 0, sizeof(msg));
216
217 iov[0].iov_base = buf;
218 iov[0].iov_len = len;
219 msg.msg_iov = iov;
220 msg.msg_iovlen = 1;
221
222 ret = recvmsg(sock, &msg, 0);
223 if (ret < 0) {
224 perror("recvmsg");
225 }
226
227 return ret;
228}
229
230/*
231 * lttcomm_send_unix_sock
232 *
233 * Send buf data of size len. Using sendmsg API.
234 * Return the size of sent data.
235 */
236ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len)
237{
238 struct msghdr msg;
239 struct iovec iov[1];
240 ssize_t ret = -1;
241
242 memset(&msg, 0, sizeof(msg));
243
244 iov[0].iov_base = buf;
245 iov[0].iov_len = len;
246 msg.msg_iov = iov;
247 msg.msg_iovlen = 1;
248
249 ret = sendmsg(sock, &msg, 0);
250 if (ret < 0) {
251 perror("sendmsg");
252 }
253
254 return ret;
255}
87378cf5
DG
256
257/*
258 * lttcomm_close_unix_sock
259 *
260 * Shutdown cleanly a unix socket.
261 */
262int lttcomm_close_unix_sock(int sock)
263{
264 int ret;
265
266 /* Shutdown receptions and transmissions */
267 ret = shutdown(sock, SHUT_RDWR);
268 if (ret < 0) {
269 perror("shutdown");
270 }
271
272 return ret;
273}
This page took 0.04997 seconds and 4 git commands to generate.