Fix: lttng: uninitialized pointer free'd when no sessiond is present
[lttng-tools.git] / src / bin / lttng / utils.c
CommitLineData
f3ed775e 1/*
ab5be9fa 2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
f3ed775e 3 *
ab5be9fa 4 * SPDX-License-Identifier: GPL-2.0-only
f3ed775e 5 *
f3ed775e
DG
6 */
7
6c1c0768 8#define _LGPL_SOURCE
b9dfb167 9#include <assert.h>
f3ed775e 10#include <stdlib.h>
679b4943 11#include <ctype.h>
3badf2bf 12#include <limits.h>
8960e9cd
DG
13#include <sys/types.h>
14#include <sys/socket.h>
15#include <signal.h>
16#include <netinet/in.h>
17#include <arpa/inet.h>
20fb9e02 18#include <inttypes.h>
4ba92f18 19#include <unistd.h>
f3ed775e 20
db758600 21#include <common/error.h>
feb0f3e5 22#include <common/utils.h>
4ba92f18 23#include <common/defaults.h>
f3ed775e 24
beb8c75a 25#include "conf.h"
679b4943 26#include "utils.h"
3c9bd23c 27#include "command.h"
f3ed775e 28
b9dfb167
DG
29static const char *str_kernel = "Kernel";
30static const char *str_ust = "UST";
31static const char *str_jul = "JUL";
5cdb6027 32static const char *str_log4j = "LOG4J";
0e115563 33static const char *str_python = "Python";
4fd2697f
FD
34static const char *str_all = "ALL";
35static const char *str_tracepoint = "Tracepoint";
36static const char *str_syscall = "Syscall";
37static const char *str_probe = "Probe";
38static const char *str_userspace_probe = "Userspace Probe";
39static const char *str_function = "Function";
b9dfb167 40
1dac0189
PPM
41static
42char *_get_session_name(int quiet)
f3ed775e 43{
4f00620d
JG
44 const char *path;
45 char *session_name = NULL;
f3ed775e
DG
46
47 /* Get path to config file */
feb0f3e5 48 path = utils_get_home_dir();
f3ed775e
DG
49 if (path == NULL) {
50 goto error;
51 }
52
53 /* Get session name from config */
1dac0189
PPM
54 session_name = quiet ? config_read_session_name_quiet(path) :
55 config_read_session_name(path);
f3ed775e 56 if (session_name == NULL) {
58a97671 57 goto error;
f3ed775e
DG
58 }
59
3183dbb0 60 DBG2("Config file path found: %s", path);
cd80958d 61 DBG("Session name found: %s", session_name);
f3ed775e 62 return session_name;
3183dbb0
DG
63
64error:
65 return NULL;
f3ed775e 66}
679b4943 67
1dac0189
PPM
68/*
69 * get_session_name
70 *
71 * Return allocated string with the session name found in the config
72 * directory.
73 */
74char *get_session_name(void)
75{
76 return _get_session_name(0);
77}
78
79/*
80 * get_session_name_quiet (no warnings/errors emitted)
81 *
82 * Return allocated string with the session name found in the config
83 * directory.
84 */
85char *get_session_name_quiet(void)
86{
87 return _get_session_name(1);
88}
89
3c9bd23c
SM
90/*
91 * list_commands
92 *
93 * List commands line by line. This is mostly for bash auto completion and to
94 * avoid difficult parsing.
95 */
96void list_commands(struct cmd_struct *commands, FILE *ofp)
97{
98 int i = 0;
99 struct cmd_struct *cmd = NULL;
100
101 cmd = &commands[i];
102 while (cmd->name != NULL) {
103 fprintf(ofp, "%s\n", cmd->name);
104 i++;
105 cmd = &commands[i];
106 }
107}
679b4943
SM
108
109/*
110 * list_cmd_options
111 *
112 * Prints a simple list of the options available to a command. This is intended
113 * to be easily parsed for bash completion.
114 */
115void list_cmd_options(FILE *ofp, struct poptOption *options)
116{
117 int i;
118 struct poptOption *option = NULL;
119
120 for (i = 0; options[i].longName != NULL; i++) {
121 option = &options[i];
122
123 fprintf(ofp, "--%s\n", option->longName);
124
125 if (isprint(option->shortName)) {
126 fprintf(ofp, "-%c\n", option->shortName);
127 }
128 }
129}
8ce58bad
MD
130
131/*
132 * fls: returns the position of the most significant bit.
133 * Returns 0 if no bit is set, else returns the position of the most
134 * significant bit (from 1 to 32 on 32-bit, from 1 to 64 on 64-bit).
135 */
136#if defined(__i386) || defined(__x86_64)
137static inline
138unsigned int fls_u32(uint32_t x)
139{
140 int r;
141
142 asm("bsrl %1,%0\n\t"
143 "jnz 1f\n\t"
144 "movl $-1,%0\n\t"
145 "1:\n\t"
146 : "=r" (r) : "rm" (x));
147 return r + 1;
148}
149#define HAS_FLS_U32
150#endif
151
a1e4ab8b 152#if defined(__x86_64) && defined(__LP64__)
8ce58bad
MD
153static inline
154unsigned int fls_u64(uint64_t x)
155{
156 long r;
157
158 asm("bsrq %1,%0\n\t"
159 "jnz 1f\n\t"
160 "movq $-1,%0\n\t"
161 "1:\n\t"
162 : "=r" (r) : "rm" (x));
163 return r + 1;
164}
165#define HAS_FLS_U64
166#endif
167
168#ifndef HAS_FLS_U64
169static __attribute__((unused))
170unsigned int fls_u64(uint64_t x)
171{
172 unsigned int r = 64;
173
174 if (!x)
175 return 0;
176
177 if (!(x & 0xFFFFFFFF00000000ULL)) {
178 x <<= 32;
179 r -= 32;
180 }
181 if (!(x & 0xFFFF000000000000ULL)) {
182 x <<= 16;
183 r -= 16;
184 }
185 if (!(x & 0xFF00000000000000ULL)) {
186 x <<= 8;
187 r -= 8;
188 }
189 if (!(x & 0xF000000000000000ULL)) {
190 x <<= 4;
191 r -= 4;
192 }
193 if (!(x & 0xC000000000000000ULL)) {
194 x <<= 2;
195 r -= 2;
196 }
197 if (!(x & 0x8000000000000000ULL)) {
198 x <<= 1;
199 r -= 1;
200 }
201 return r;
202}
203#endif
204
205#ifndef HAS_FLS_U32
206static __attribute__((unused))
207unsigned int fls_u32(uint32_t x)
208{
209 unsigned int r = 32;
210
211 if (!x)
212 return 0;
213 if (!(x & 0xFFFF0000U)) {
214 x <<= 16;
215 r -= 16;
216 }
217 if (!(x & 0xFF000000U)) {
218 x <<= 8;
219 r -= 8;
220 }
221 if (!(x & 0xF0000000U)) {
222 x <<= 4;
223 r -= 4;
224 }
225 if (!(x & 0xC0000000U)) {
226 x <<= 2;
227 r -= 2;
228 }
229 if (!(x & 0x80000000U)) {
230 x <<= 1;
231 r -= 1;
232 }
233 return r;
234}
235#endif
236
237static
238unsigned int fls_ulong(unsigned long x)
239{
240#if (CAA_BITS_PER_LONG == 32)
241 return fls_u32(x);
242#else
243 return fls_u64(x);
244#endif
245}
246
247/*
248 * Return the minimum order for which x <= (1UL << order).
249 * Return -1 if x is 0.
250 */
251int get_count_order_u32(uint32_t x)
252{
253 if (!x)
254 return -1;
255
256 return fls_u32(x - 1);
257}
258
259/*
260 * Return the minimum order for which x <= (1UL << order).
261 * Return -1 if x is 0.
262 */
263int get_count_order_u64(uint64_t x)
264{
265 if (!x)
266 return -1;
267
268 return fls_u64(x - 1);
269}
270
271/*
272 * Return the minimum order for which x <= (1UL << order).
273 * Return -1 if x is 0.
274 */
275int get_count_order_ulong(unsigned long x)
276{
277 if (!x)
278 return -1;
279
280 return fls_ulong(x - 1);
281}
b9dfb167
DG
282
283const char *get_domain_str(enum lttng_domain_type domain)
284{
285 const char *str_dom;
286
287 switch (domain) {
288 case LTTNG_DOMAIN_KERNEL:
289 str_dom = str_kernel;
290 break;
291 case LTTNG_DOMAIN_UST:
292 str_dom = str_ust;
293 break;
294 case LTTNG_DOMAIN_JUL:
295 str_dom = str_jul;
296 break;
5cdb6027
DG
297 case LTTNG_DOMAIN_LOG4J:
298 str_dom = str_log4j;
299 break;
0e115563
DG
300 case LTTNG_DOMAIN_PYTHON:
301 str_dom = str_python;
302 break;
b9dfb167
DG
303 default:
304 /* Should not have an unknown domain or else define it. */
305 assert(0);
306 }
307
308 return str_dom;
309}
8960e9cd 310
4fd2697f
FD
311const char *get_event_type_str(enum lttng_event_type type)
312{
313 const char *str_event_type;
314
315 switch (type) {
316 case LTTNG_EVENT_ALL:
317 str_event_type = str_all;
318 break;
319 case LTTNG_EVENT_TRACEPOINT:
320 str_event_type = str_tracepoint;
321 break;
322 case LTTNG_EVENT_SYSCALL:
323 str_event_type = str_syscall;
324 break;
325 case LTTNG_EVENT_PROBE:
326 str_event_type = str_probe;
327 break;
328 case LTTNG_EVENT_USERSPACE_PROBE:
329 str_event_type = str_userspace_probe;
330 break;
331 case LTTNG_EVENT_FUNCTION:
332 str_event_type = str_function;
333 break;
334 default:
335 /* Should not have an unknown event type or else define it. */
336 assert(0);
337 }
338
339 return str_event_type;
340}
341
8960e9cd
DG
342/*
343 * Spawn a lttng relayd daemon by forking and execv.
344 */
345int spawn_relayd(const char *pathname, int port)
346{
347 int ret = 0;
348 pid_t pid;
349 char url[255];
350
351 if (!port) {
352 port = DEFAULT_NETWORK_VIEWER_PORT;
353 }
354
355 ret = snprintf(url, sizeof(url), "tcp://localhost:%d", port);
356 if (ret < 0) {
357 goto end;
358 }
359
360 MSG("Spawning a relayd daemon");
361 pid = fork();
362 if (pid == 0) {
363 /*
364 * Spawn session daemon and tell
365 * it to signal us when ready.
366 */
367 execlp(pathname, "lttng-relayd", "-L", url, NULL);
368 /* execlp only returns if error happened */
369 if (errno == ENOENT) {
370 ERR("No relayd found. Use --relayd-path.");
371 } else {
6f04ed72 372 PERROR("execlp");
8960e9cd
DG
373 }
374 kill(getppid(), SIGTERM); /* wake parent */
375 exit(EXIT_FAILURE);
376 } else if (pid > 0) {
377 goto end;
378 } else {
6f04ed72 379 PERROR("fork");
8960e9cd
DG
380 ret = -1;
381 goto end;
382 }
383
384end:
385 return ret;
386}
387
388/*
389 * Check if relayd is alive.
390 *
391 * Return 1 if found else 0 if NOT found. Negative value on error.
392 */
393int check_relayd(void)
394{
395 int ret, fd;
396 struct sockaddr_in sin;
397
398 fd = socket(AF_INET, SOCK_STREAM, 0);
399 if (fd < 0) {
6f04ed72 400 PERROR("socket check relayd");
dd02a4c1
DG
401 ret = -1;
402 goto error_socket;
8960e9cd
DG
403 }
404
405 sin.sin_family = AF_INET;
406 sin.sin_port = htons(DEFAULT_NETWORK_VIEWER_PORT);
407 ret = inet_pton(sin.sin_family, "127.0.0.1", &sin.sin_addr);
408 if (ret < 1) {
6f04ed72 409 PERROR("inet_pton check relayd");
dd02a4c1 410 ret = -1;
8960e9cd
DG
411 goto error;
412 }
413
414 /*
415 * A successful connect means the relayd exists thus returning 0 else a
416 * negative value means it does NOT exists.
417 */
56efeab3 418 ret = connect(fd, (struct sockaddr *) &sin, sizeof(sin));
8960e9cd
DG
419 if (ret < 0) {
420 /* Not found. */
421 ret = 0;
422 } else {
423 /* Already spawned. */
424 ret = 1;
425 }
426
8960e9cd 427error:
dd02a4c1 428 if (close(fd) < 0) {
6f04ed72 429 PERROR("close relayd fd");
dd02a4c1
DG
430 }
431error_socket:
432 return ret;
8960e9cd 433}
3ecec76a
PP
434
435int print_missing_or_multiple_domains(unsigned int sum)
436{
437 int ret = 0;
438
439 if (sum == 0) {
440 ERR("Please specify a domain (-k/-u/-j).");
441 ret = -1;
442 } else if (sum > 1) {
443 ERR("Multiple domains specified.");
444 ret = -1;
445 }
446
447 return ret;
448}
20fb9e02
JD
449
450/*
451 * Get the discarded events and lost packet counts.
452 */
453void print_session_stats(const char *session_name)
454{
3e8f2238 455 int count, nb_domains, domain_idx, channel_idx, session_idx;
20fb9e02
JD
456 struct lttng_domain *domains;
457 struct lttng_channel *channels;
3e8f2238
JG
458 uint64_t discarded_events_total = 0, lost_packets_total = 0;
459 struct lttng_session *sessions = NULL;
460 const struct lttng_session *selected_session = NULL;
461
462 count = lttng_list_sessions(&sessions);
463 if (count < 1) {
464 ERR("Failed to retrieve session descriptions while printing session statistics.");
465 goto end;
466 }
467
468 /* Identify the currently-selected sessions. */
469 for (session_idx = 0; session_idx < count; session_idx++) {
470 if (!strcmp(session_name, sessions[session_idx].name)) {
471 selected_session = &sessions[session_idx];
472 break;
473 }
474 }
475 if (!selected_session) {
476 ERR("Failed to retrieve session \"%s\" description while printing session statistics.", session_name);
477 goto end;
478 }
20fb9e02
JD
479
480 nb_domains = lttng_list_domains(session_name, &domains);
481 if (nb_domains < 0) {
482 goto end;
483 }
484 for (domain_idx = 0; domain_idx < nb_domains; domain_idx++) {
485 struct lttng_handle *handle = lttng_create_handle(session_name,
486 &domains[domain_idx]);
487
488 if (!handle) {
3e8f2238 489 ERR("Failed to create session handle while printing session statistics.");
20fb9e02
JD
490 goto end;
491 }
492
493 count = lttng_list_channels(handle, &channels);
494 for (channel_idx = 0; channel_idx < count; channel_idx++) {
495 int ret;
3e8f2238 496 uint64_t discarded_events = 0, lost_packets = 0;
20fb9e02
JD
497 struct lttng_channel *channel = &channels[channel_idx];
498
499 ret = lttng_channel_get_discarded_event_count(channel,
3e8f2238 500 &discarded_events);
20fb9e02
JD
501 if (ret) {
502 ERR("Failed to retrieve discarded event count from channel %s",
503 channel->name);
504 }
505
506 ret = lttng_channel_get_lost_packet_count(channel,
3e8f2238 507 &lost_packets);
20fb9e02
JD
508 if (ret) {
509 ERR("Failed to retrieve lost packet count from channel %s",
510 channel->name);
511 }
512
3e8f2238
JG
513 discarded_events_total += discarded_events;
514 lost_packets_total += lost_packets;
20fb9e02
JD
515 }
516 lttng_destroy_handle(handle);
517 }
3e8f2238 518 if (discarded_events_total > 0 && !selected_session->snapshot_mode) {
20fb9e02
JD
519 MSG("[warning] %" PRIu64 " events discarded, please refer to "
520 "the documentation on channel configuration.",
3e8f2238 521 discarded_events_total);
20fb9e02 522 }
3e8f2238 523 if (lost_packets_total > 0 && !selected_session->snapshot_mode) {
20fb9e02
JD
524 MSG("[warning] %" PRIu64 " packets lost, please refer to "
525 "the documentation on channel configuration.",
3e8f2238 526 lost_packets_total);
20fb9e02
JD
527 }
528
529end:
3e8f2238 530 free(sessions);
20fb9e02 531}
4ba92f18 532
4fc83d94 533int show_cmd_help(const char *cmd_name, const char *help_msg)
4ba92f18
PP
534{
535 int ret;
536 char page_name[32];
537
538 ret = sprintf(page_name, "lttng-%s", cmd_name);
539 assert(ret > 0 && ret < 32);
4fc83d94
PP
540 ret = utils_show_help(1, page_name, help_msg);
541 if (ret && !help_msg) {
542 ERR("Cannot view man page `lttng-%s(1)`", cmd_name);
543 perror("exec");
544 }
4ba92f18 545
4fc83d94 546 return ret;
4ba92f18 547}
bbbfd849
JG
548
549int print_trace_archive_location(
550 const struct lttng_trace_archive_location *location,
551 const char *session_name)
552{
553 int ret = 0;
554 enum lttng_trace_archive_location_type location_type;
555 enum lttng_trace_archive_location_status status;
556 bool printed_location = false;
557
558 location_type = lttng_trace_archive_location_get_type(location);
559
560 _MSG("Trace chunk archive for session %s is now readable",
561 session_name);
562 switch (location_type) {
563 case LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL:
564 {
565 const char *absolute_path;
566
567 status = lttng_trace_archive_location_local_get_absolute_path(
568 location, &absolute_path);
569 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
570 ret = -1;
571 goto end;
572 }
573 MSG(" at %s", absolute_path);
574 printed_location = true;
575 break;
576 }
577 case LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY:
578 {
579 uint16_t control_port, data_port;
580 const char *host, *relative_path, *protocol_str;
581 enum lttng_trace_archive_location_relay_protocol_type protocol;
582
583 /* Fetch all relay location parameters. */
584 status = lttng_trace_archive_location_relay_get_protocol_type(
585 location, &protocol);
586 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
587 ret = -1;
588 goto end;
589 }
590
591 status = lttng_trace_archive_location_relay_get_host(
592 location, &host);
593 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
594 ret = -1;
595 goto end;
596 }
597
598 status = lttng_trace_archive_location_relay_get_control_port(
599 location, &control_port);
600 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
601 ret = -1;
602 goto end;
603 }
604
605 status = lttng_trace_archive_location_relay_get_data_port(
606 location, &data_port);
607 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
608 ret = -1;
609 goto end;
610 }
611
612 status = lttng_trace_archive_location_relay_get_relative_path(
613 location, &relative_path);
614 if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
615 ret = -1;
616 goto end;
617 }
618
619 switch (protocol) {
620 case LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP:
621 protocol_str = "tcp";
622 break;
623 default:
624 protocol_str = "unknown";
625 break;
626 }
627
628 MSG(" on relay %s://%s/%s [control port %" PRIu16 ", data port %"
629 PRIu16 "]", protocol_str, host,
630 relative_path, control_port, data_port);
631 printed_location = true;
632 break;
633 }
634 default:
635 break;
636 }
637end:
638 if (!printed_location) {
639 MSG(" at an unknown location");
640 }
641 return ret;
642}
This page took 0.154795 seconds and 5 git commands to generate.