SoW-2020-0002: Trace Hit Counters: trigger error reporting integration
[lttng-tools.git] / src / bin / lttng / utils.c
index d52d4622a9c3f3b1dfa34decf94d20bceaa8ecfa..d9fd99ad55e11d8a51a52cb9c2cc4eafea861990 100644 (file)
@@ -1,21 +1,10 @@
 /*
- * Copyright (c)  2011 David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License, version 2 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License along
- * with this program; if not, write to the Free Software Foundation, Inc.,
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-#define _GNU_SOURCE
 #define _LGPL_SOURCE
 #include <assert.h>
 #include <stdlib.h>
 #include <signal.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
+#include <inttypes.h>
+#include <unistd.h>
 
 #include <common/error.h>
 #include <common/utils.h>
+#include <common/defaults.h>
 
 #include "conf.h"
 #include "utils.h"
@@ -39,11 +31,18 @@ static const char *str_ust = "UST";
 static const char *str_jul = "JUL";
 static const char *str_log4j = "LOG4J";
 static const char *str_python = "Python";
+static const char *str_all = "ALL";
+static const char *str_tracepoint = "Tracepoint";
+static const char *str_syscall = "Syscall";
+static const char *str_probe = "Probe";
+static const char *str_userspace_probe = "Userspace Probe";
+static const char *str_function = "Function";
 
 static
 char *_get_session_name(int quiet)
 {
-       char *path, *session_name = NULL;
+       const char *path;
+       char *session_name = NULL;
 
        /* Get path to config file */
        path = utils_get_home_dir();
@@ -129,6 +128,25 @@ void list_cmd_options(FILE *ofp, struct poptOption *options)
        }
 }
 
+/*
+ * Same as list_cmd_options, but for options specified for argpar.
+ */
+void list_cmd_options_argpar(FILE *ofp, const struct argpar_opt_descr *options)
+{
+       int i;
+       const struct argpar_opt_descr *option = NULL;
+
+       for (i = 0; options[i].long_name != NULL; i++) {
+               option = &options[i];
+
+               fprintf(ofp, "--%s\n", option->long_name);
+
+               if (isprint(option->short_name)) {
+                       fprintf(ofp, "-%c\n", option->short_name);
+               }
+       }
+}
+
 /*
  * fls: returns the position of the most significant bit.
  * Returns 0 if no bit is set, else returns the position of the most
@@ -150,7 +168,7 @@ unsigned int fls_u32(uint32_t x)
 #define HAS_FLS_U32
 #endif
 
-#if defined(__x86_64)
+#if defined(__x86_64) && defined(__LP64__)
 static inline
 unsigned int fls_u64(uint64_t x)
 {
@@ -309,6 +327,37 @@ const char *get_domain_str(enum lttng_domain_type domain)
        return str_dom;
 }
 
+const char *get_event_type_str(enum lttng_event_type type)
+{
+       const char *str_event_type;
+
+       switch (type) {
+       case LTTNG_EVENT_ALL:
+               str_event_type = str_all;
+               break;
+       case LTTNG_EVENT_TRACEPOINT:
+               str_event_type = str_tracepoint;
+               break;
+       case LTTNG_EVENT_SYSCALL:
+               str_event_type = str_syscall;
+               break;
+       case LTTNG_EVENT_PROBE:
+               str_event_type = str_probe;
+               break;
+       case LTTNG_EVENT_USERSPACE_PROBE:
+               str_event_type = str_userspace_probe;
+               break;
+       case LTTNG_EVENT_FUNCTION:
+               str_event_type = str_function;
+               break;
+       default:
+               /* Should not have an unknown event type or else define it. */
+               assert(0);
+       }
+
+       return str_event_type;
+}
+
 /*
  * Spawn a lttng relayd daemon by forking and execv.
  */
@@ -385,7 +434,7 @@ int check_relayd(void)
         * A successful connect means the relayd exists thus returning 0 else a
         * negative value means it does NOT exists.
         */
-       ret = connect(fd, &sin, sizeof(sin));
+       ret = connect(fd, (struct sockaddr *) &sin, sizeof(sin));
        if (ret < 0) {
                /* Not found. */
                ret = 0;
@@ -401,3 +450,257 @@ error:
 error_socket:
        return ret;
 }
+
+int print_missing_or_multiple_domains(unsigned int domain_count,
+               bool include_agent_domains)
+{
+       int ret = 0;
+
+       if (domain_count == 0) {
+               ERR("Please specify a domain (--kernel/--userspace%s).",
+                               include_agent_domains ?
+                                               "/--jul/--log4j/--python" :
+                                               "");
+               ret = -1;
+       } else if (domain_count > 1) {
+               ERR("Only one domain must be specified.");
+               ret = -1;
+       }
+
+       return ret;
+}
+
+/*
+ * Get the discarded events and lost packet counts.
+ */
+void print_session_stats(const char *session_name)
+{
+       char *str;
+       const int ret = get_session_stats_str(session_name, &str);
+
+       if (ret >= 0 && str) {
+               MSG("%s", str);
+               free(str);
+       }
+}
+
+int get_session_stats_str(const char *session_name, char **out_str)
+{
+       int count, nb_domains, domain_idx, channel_idx, session_idx, ret;
+       struct lttng_domain *domains;
+       struct lttng_channel *channels;
+       uint64_t discarded_events_total = 0, lost_packets_total = 0;
+       struct lttng_session *sessions = NULL;
+       const struct lttng_session *selected_session = NULL;
+       char *stats_str = NULL;
+       bool print_discarded_events = false, print_lost_packets = false;
+
+       count = lttng_list_sessions(&sessions);
+       if (count < 1) {
+               ERR("Failed to retrieve session descriptions while printing session statistics.");
+               ret = -1;
+               goto end;
+       }
+
+       /* Identify the currently-selected sessions. */
+       for (session_idx = 0; session_idx < count; session_idx++) {
+               if (!strcmp(session_name, sessions[session_idx].name)) {
+                       selected_session = &sessions[session_idx];
+                       break;
+               }
+       }
+       if (!selected_session) {
+               ERR("Failed to retrieve session \"%s\" description while printing session statistics.", session_name);
+               ret = -1;
+               goto end;
+       }
+
+       nb_domains = lttng_list_domains(session_name, &domains);
+       if (nb_domains < 0) {
+               ret = -1;
+               goto end;
+       }
+       for (domain_idx = 0; domain_idx < nb_domains; domain_idx++) {
+               struct lttng_handle *handle = lttng_create_handle(session_name,
+                               &domains[domain_idx]);
+
+               if (!handle) {
+                       ERR("Failed to create session handle while printing session statistics.");
+                       ret = -1;
+                       goto end;
+               }
+
+               count = lttng_list_channels(handle, &channels);
+               for (channel_idx = 0; channel_idx < count; channel_idx++) {
+                       uint64_t discarded_events = 0, lost_packets = 0;
+                       struct lttng_channel *channel = &channels[channel_idx];
+
+                       ret = lttng_channel_get_discarded_event_count(channel,
+                                       &discarded_events);
+                       if (ret) {
+                               ERR("Failed to retrieve discarded event count from channel %s",
+                                               channel->name);
+                       }
+
+                       ret = lttng_channel_get_lost_packet_count(channel,
+                                       &lost_packets);
+                       if (ret) {
+                               ERR("Failed to retrieve lost packet count from channel %s",
+                                               channel->name);
+                       }
+
+                       discarded_events_total += discarded_events;
+                       lost_packets_total += lost_packets;
+               }
+               lttng_destroy_handle(handle);
+       }
+
+       print_discarded_events = discarded_events_total > 0 &&
+                                !selected_session->snapshot_mode;
+       print_lost_packets = lost_packets_total > 0 &&
+                            !selected_session->snapshot_mode;
+
+       if (print_discarded_events && print_lost_packets) {
+               ret = asprintf(&stats_str,
+                               "Warning: %" PRIu64
+                               " events were discarded and %" PRIu64
+                               " packets were lost, please refer to "
+                               "the documentation on channel configuration.",
+                               discarded_events_total, lost_packets_total);
+       } else if (print_discarded_events) {
+               ret = asprintf(&stats_str,
+                               "Warning: %" PRIu64
+                               " events were discarded, please refer to "
+                               "the documentation on channel configuration.",
+                               discarded_events_total);
+       } else if (print_lost_packets) {
+               ret = asprintf(&stats_str,
+                               "Warning: %" PRIu64
+                               " packets were lost, please refer to "
+                               "the documentation on channel configuration.",
+                               lost_packets_total);
+       } else {
+               ret = 0;
+       }
+
+       if (ret < 0) {
+               ERR("Failed to format lost packet and discarded events statistics");
+       } else {
+               *out_str = stats_str;
+               ret = 0;
+       }
+end:
+       free(sessions);
+       return ret;
+}
+
+int show_cmd_help(const char *cmd_name, const char *help_msg)
+{
+       int ret;
+       char page_name[32];
+
+       ret = sprintf(page_name, "lttng-%s", cmd_name);
+       assert(ret > 0 && ret < 32);
+       ret = utils_show_help(1, page_name, help_msg);
+       if (ret && !help_msg) {
+               ERR("Cannot view man page `lttng-%s(1)`", cmd_name);
+               perror("exec");
+       }
+
+       return ret;
+}
+
+int print_trace_archive_location(
+               const struct lttng_trace_archive_location *location,
+               const char *session_name)
+{
+       int ret = 0;
+       enum lttng_trace_archive_location_type location_type;
+       enum lttng_trace_archive_location_status status;
+       bool printed_location = false;
+
+       location_type = lttng_trace_archive_location_get_type(location);
+
+       _MSG("Trace chunk archive for session %s is now readable",
+                       session_name);
+       switch (location_type) {
+       case LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_LOCAL:
+       {
+               const char *absolute_path;
+
+               status = lttng_trace_archive_location_local_get_absolute_path(
+                               location, &absolute_path);
+               if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+               MSG(" at %s", absolute_path);
+               printed_location = true;
+               break;
+       }
+       case LTTNG_TRACE_ARCHIVE_LOCATION_TYPE_RELAY:
+       {
+               uint16_t control_port, data_port;
+               const char *host, *relative_path, *protocol_str;
+               enum lttng_trace_archive_location_relay_protocol_type protocol;
+
+               /* Fetch all relay location parameters. */
+               status = lttng_trace_archive_location_relay_get_protocol_type(
+                               location, &protocol);
+               if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+
+               status = lttng_trace_archive_location_relay_get_host(
+                               location, &host);
+               if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+
+               status = lttng_trace_archive_location_relay_get_control_port(
+                               location, &control_port);
+               if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+
+               status = lttng_trace_archive_location_relay_get_data_port(
+                               location, &data_port);
+               if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+
+               status = lttng_trace_archive_location_relay_get_relative_path(
+                               location, &relative_path);
+               if (status != LTTNG_TRACE_ARCHIVE_LOCATION_STATUS_OK) {
+                       ret = -1;
+                       goto end;
+               }
+
+               switch (protocol) {
+               case LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP:
+                       protocol_str = "tcp";
+                       break;
+               default:
+                       protocol_str = "unknown";
+                       break;
+               }
+
+               MSG(" on relay %s://%s/%s [control port %" PRIu16 ", data port %"
+                               PRIu16 "]", protocol_str, host,
+                               relative_path, control_port, data_port);
+               printed_location = true;
+               break;
+       }
+       default:
+               break;
+       }
+end:
+       if (!printed_location) {
+               MSG(" at an unknown location");
+       }
+       return ret;
+}
This page took 0.029438 seconds and 5 git commands to generate.