a1fbb9e826efc903009e777a70dc0fd7522004c4
[babeltrace.git] / formats / lttng-live / lttng-live-plugin.c
1 /*
2 * BabelTrace - LTTng live Output
3 *
4 * Copyright 2013 Julien Desfossez <jdesfossez@efficios.com>
5 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #include <babeltrace/ctf-text/types.h>
27 #include <babeltrace/format.h>
28 #include <babeltrace/babeltrace-internal.h>
29 #include <inttypes.h>
30 #include <sys/mman.h>
31 #include <errno.h>
32 #include <sys/types.h>
33 #include <sys/stat.h>
34 #include <fcntl.h>
35 #include <dirent.h>
36 #include <glib.h>
37 #include <unistd.h>
38 #include <stdlib.h>
39 #include <signal.h>
40 #include "lttng-live.h"
41
42 static volatile int should_quit;
43
44 int lttng_live_should_quit(void)
45 {
46 return should_quit;
47 }
48
49 static
50 void sighandler(int sig)
51 {
52 switch (sig) {
53 case SIGTERM:
54 case SIGINT:
55 should_quit = 1;
56 break;
57 default:
58 break;
59 }
60 }
61
62 /*
63 * TODO: Eventually, this signal handler setup should be done at the
64 * plugin manager level, rather than within this plugin. Beware, we are
65 * not cleaning up the signal handler after plugin execution.
66 */
67 static
68 int setup_sighandler(void)
69 {
70 struct sigaction sa;
71 sigset_t sigset;
72 int ret;
73
74 if ((ret = sigemptyset(&sigset)) < 0) {
75 perror("sigemptyset");
76 return ret;
77 }
78 sa.sa_handler = sighandler;
79 sa.sa_mask = sigset;
80 sa.sa_flags = 0;
81 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
82 perror("sigaction");
83 return ret;
84 }
85 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
86 perror("sigaction");
87 return ret;
88 }
89 return 0;
90 }
91
92 /*
93 * hostname parameter needs to hold MAXNAMLEN chars.
94 */
95 static
96 int parse_url(const char *path, struct lttng_live_ctx *ctx)
97 {
98 char remain[3][MAXNAMLEN];
99 int ret = -1, proto, proto_offset = 0;
100 size_t path_len = strlen(path); /* not accounting \0 */
101
102 /*
103 * Since sscanf API does not allow easily checking string length
104 * against a size defined by a macro. Test it beforehand on the
105 * input. We know the output is always <= than the input length.
106 */
107 if (path_len >= MAXNAMLEN) {
108 goto end;
109 }
110 ret = sscanf(path, "net%d://", &proto);
111 if (ret < 1) {
112 proto = 4;
113 /* net:// */
114 proto_offset = strlen("net://");
115 } else {
116 /* net4:// or net6:// */
117 proto_offset = strlen("netX://");
118 }
119 if (proto_offset > path_len) {
120 goto end;
121 }
122 if (proto == 6) {
123 fprintf(stderr, "[error] IPv6 is currently unsupported by lttng-live\n");
124 goto end;
125 }
126 /* TODO : parse for IPv6 as well */
127 /* Parse the hostname or IP */
128 ret = sscanf(&path[proto_offset], "%[a-zA-Z.0-9%-]%s",
129 ctx->relay_hostname, remain[0]);
130 if (ret == 2) {
131 /* Optional port number */
132 switch (remain[0][0]) {
133 case ':':
134 ret = sscanf(remain[0], ":%d%s", &ctx->port, remain[1]);
135 /* Optional session ID with port number */
136 if (ret == 2) {
137 ret = sscanf(remain[1], "/%s", remain[2]);
138 /* Accept 0 or 1 (optional) */
139 if (ret < 0) {
140 goto end;
141 }
142 } else if (ret == 0) {
143 fprintf(stderr, "[error] Missing port number after delimitor ':'\n");
144 ret = -1;
145 goto end;
146 }
147 break;
148 case '/':
149 /* Optional session ID */
150 ret = sscanf(remain[0], "/%s", remain[2]);
151 /* Accept 0 or 1 (optional) */
152 if (ret < 0) {
153 goto end;
154 }
155 break;
156 default:
157 fprintf(stderr, "[error] wrong delimitor : %c\n",
158 remain[0][0]);
159 ret = -1;
160 goto end;
161 }
162 }
163
164 if (ctx->port < 0) {
165 ctx->port = LTTNG_DEFAULT_NETWORK_VIEWER_PORT;
166 }
167
168 if (strlen(remain[2]) == 0) {
169 printf_verbose("Connecting to hostname : %s, port : %d, "
170 "proto : IPv%d\n",
171 ctx->relay_hostname, ctx->port, proto);
172 ret = 0;
173 goto end;
174 }
175 ret = sscanf(remain[2], "host/%[a-zA-Z.0-9%-]/%s",
176 ctx->traced_hostname, ctx->session_name);
177 if (ret != 2) {
178 fprintf(stderr, "[error] Format : "
179 "net://<hostname>/host/<traced_hostname>/<session_name>\n");
180 goto end;
181 }
182
183 printf_verbose("Connecting to hostname : %s, port : %d, "
184 "traced hostname : %s, session name : %s, "
185 "proto : IPv%d\n",
186 ctx->relay_hostname, ctx->port, ctx->traced_hostname,
187 ctx->session_name, proto);
188 ret = 0;
189
190 end:
191 return ret;
192 }
193
194 static
195 guint g_uint64p_hash(gconstpointer key)
196 {
197 uint64_t v = *(uint64_t *) key;
198
199 if (sizeof(gconstpointer) == sizeof(uint64_t)) {
200 return g_direct_hash((gconstpointer) (unsigned long) v);
201 } else {
202 return g_direct_hash((gconstpointer) (unsigned long) (v >> 32))
203 ^ g_direct_hash((gconstpointer) (unsigned long) v);
204 }
205 }
206
207 static
208 gboolean g_uint64p_equal(gconstpointer a, gconstpointer b)
209 {
210 uint64_t va = *(uint64_t *) a;
211 uint64_t vb = *(uint64_t *) b;
212
213 if (va != vb)
214 return FALSE;
215 return TRUE;
216 }
217
218 static int lttng_live_open_trace_read(const char *path)
219 {
220 int ret = 0;
221 struct lttng_live_ctx *ctx;
222
223 ctx = g_new0(struct lttng_live_ctx, 1);
224 ctx->session = g_new0(struct lttng_live_session, 1);
225
226 /* We need a pointer to the context from the packet_seek function. */
227 ctx->session->ctx = ctx;
228
229 /* HT to store the CTF traces. */
230 ctx->session->ctf_traces = g_hash_table_new(g_uint64p_hash,
231 g_uint64p_equal);
232 ctx->port = -1;
233 ctx->session_ids = g_array_new(FALSE, TRUE, sizeof(uint64_t));
234
235 ret = parse_url(path, ctx);
236 if (ret < 0) {
237 goto end_free;
238 }
239 ret = setup_sighandler();
240 if (ret < 0) {
241 goto end_free;
242 }
243 ret = lttng_live_connect_viewer(ctx);
244 if (ret < 0) {
245 goto end_free;
246 }
247 printf_verbose("LTTng-live connected to relayd\n");
248
249 ret = lttng_live_establish_connection(ctx);
250 if (ret < 0) {
251 goto end_free;
252 }
253
254 printf_verbose("Listing sessions\n");
255 ret = lttng_live_list_sessions(ctx, path);
256 if (ret < 0) {
257 goto end_free;
258 }
259
260 if (ctx->session_ids->len > 0) {
261 ret = lttng_live_read(ctx);
262 }
263
264 end_free:
265 g_hash_table_destroy(ctx->session->ctf_traces);
266 g_free(ctx->session);
267 g_free(ctx->session->streams);
268 g_free(ctx);
269
270 if (lttng_live_should_quit()) {
271 ret = 0;
272 }
273 return ret;
274 }
275
276 static
277 struct bt_trace_descriptor *lttng_live_open_trace(const char *path, int flags,
278 void (*packet_seek)(struct bt_stream_pos *pos, size_t index,
279 int whence), FILE *metadata_fp)
280 {
281 struct ctf_text_stream_pos *pos;
282
283 switch (flags & O_ACCMODE) {
284 case O_RDONLY:
285 /* OK */
286 break;
287 case O_RDWR:
288 fprintf(stderr, "[error] lttng live plugin cannot be used as output plugin.\n");
289 goto error;
290 default:
291 fprintf(stderr, "[error] Incorrect open flags.\n");
292 goto error;
293 }
294
295 pos = g_new0(struct ctf_text_stream_pos, 1);
296 pos->parent.rw_table = NULL;
297 pos->parent.event_cb = NULL;
298 pos->parent.trace = &pos->trace_descriptor;
299 /*
300 * Since we do *everything* in this function, we are skipping
301 * the output plugin handling that is part of Babeltrace 1.x.
302 * Therefore, don't expect the --output cmd line option to work.
303 * This limits the output of lttng-live to stderr and stdout.
304 */
305 if (lttng_live_open_trace_read(path) < 0) {
306 goto error;
307 }
308 return &pos->trace_descriptor;
309
310 error:
311 return NULL;
312 }
313
314 static
315 int lttng_live_close_trace(struct bt_trace_descriptor *td)
316 {
317 struct ctf_text_stream_pos *pos =
318 container_of(td, struct ctf_text_stream_pos,
319 trace_descriptor);
320 g_free(pos);
321 return 0;
322 }
323
324 static
325 struct bt_format lttng_live_format = {
326 .open_trace = lttng_live_open_trace,
327 .close_trace = lttng_live_close_trace,
328 };
329
330 static
331 void __attribute__((constructor)) lttng_live_init(void)
332 {
333 int ret;
334
335 lttng_live_format.name = g_quark_from_static_string("lttng-live");
336 ret = bt_register_format(&lttng_live_format);
337 assert(!ret);
338 }
339
340 static
341 void __attribute__((destructor)) lttng_live_exit(void)
342 {
343 bt_unregister_format(&lttng_live_format);
344 }
This page took 0.054135 seconds and 3 git commands to generate.