src/bin/lttng/utils.hpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #ifndef _LTTNG_UTILS_H
   9 #define _LTTNG_UTILS_H
  10
  11 #include <common/argpar/argpar.h>
  12 #include <common/container-wrapper.hpp>
  13 #include <common/dynamic-array.hpp>
  14 #include <common/make-unique-wrapper.hpp>
  15
  16 #include <lttng/lttng.h>
  17 #include <lttng/session-internal.hpp>
  18
  19 #include <iterator>
  20 #include <memory>
  21 #include <popt.h>
  22
  23 extern char *opt_relayd_path;
  24 extern int opt_no_sessiond;
  25 extern char *opt_sessiond_path;
  26 extern pid_t sessiond_pid;
  27
  28 struct cmd_struct;
  29
  30 namespace lttng {
  31 namespace cli {
  32
  33 struct session_spec {
  34         enum class type {
  35                 NAME,
  36                 GLOB_PATTERN,
  37                 ALL,
  38         };
  39
  40         explicit session_spec(type spec_type, const char *name_or_pattern = nullptr) noexcept :
  41                 type_(spec_type), value(name_or_pattern)
  42         {
  43         }
  44
  45         /* Disambiguate type enum from the member for buggy g++ versions. */
  46         type type_;
  47         const char *value;
  48 };
  49
  50 class session_list;
  51
  52 namespace details {
  53 class session_storage {
  54 public:
  55         session_storage(lttng_session *raw_sessions, std::size_t sessions_count) :
  56                 _array(raw_sessions), _count(sessions_count)
  57         {
  58         }
  59
  60         session_storage(session_storage&& original) :
  61                 _array(std::move(original._array)), _count(original._count)
  62         {
  63         }
  64
  65         session_storage(session_storage&& original, std::size_t new_count) :
  66                 _array(std::move(original._array)), _count(new_count)
  67         {
  68         }
  69
  70         lttng_session_uptr _array = nullptr;
  71         std::size_t _count = 0;
  72 };
  73
  74 class session_list_operations {
  75 public:
  76         static lttng_session& get(const lttng::cli::details::session_storage& storage,
  77                                   std::size_t index) noexcept
  78         {
  79                 return storage._array[index];
  80         }
  81
  82         static std::size_t size(const lttng::cli::details::session_storage& storage)
  83         {
  84                 return storage._count;
  85         }
  86 };
  87 } /* namespace details */
  88
  89 /*
  90  * We don't use a std::vector here because it would make a copy of the C array.
  91  */
  92 class session_list
  93         : public lttng::utils::random_access_container_wrapper<details::session_storage,
  94                                                                lttng_session&,
  95                                                                details::session_list_operations> {
  96 public:
  97         friend details::session_list_operations;
  98
  99         session_list() :
 100                 lttng::utils::random_access_container_wrapper<details::session_storage,
 101                                                               lttng_session&,
 102                                                               details::session_list_operations>(
 103                         { nullptr, 0 })
 104         {
 105         }
 106
 107         session_list(session_list&& original) :
 108                 lttng::utils::random_access_container_wrapper<details::session_storage,
 109                                                               lttng_session&,
 110                                                               details::session_list_operations>(
 111                         std::move(original._container))
 112         {
 113         }
 114
 115         session_list(session_list&& original, std::size_t new_count) :
 116                 lttng::utils::random_access_container_wrapper<details::session_storage,
 117                                                               lttng_session&,
 118                                                               details::session_list_operations>(
 119                         { std::move(original._container), new_count })
 120         {
 121         }
 122
 123         session_list(lttng_session *raw_sessions, std::size_t raw_sessions_count) :
 124                 lttng::utils::random_access_container_wrapper<details::session_storage,
 125                                                               lttng_session&,
 126                                                               details::session_list_operations>(
 127                         { raw_sessions, raw_sessions_count })
 128         {
 129         }
 130
 131         void resize(std::size_t new_size) noexcept
 132         {
 133                 _container._count = new_size;
 134         }
 135 };
 136
 137 lttng::cli::session_list list_sessions(const struct session_spec& spec);
 138 } /* namespace cli */
 139 } /* namespace lttng */
 140
 141 char *get_session_name(void);
 142 char *get_session_name_quiet(void);
 143 void list_commands(struct cmd_struct *commands, FILE *ofp);
 144 void list_cmd_options(FILE *ofp, struct poptOption *options);
 145 void list_cmd_options_argpar(FILE *ofp, const struct argpar_opt_descr *options);
 146
 147 /*
 148  * Return the minimum order for which x <= (1UL << order).
 149  * Return -1 if x is 0.
 150  */
 151 int get_count_order_u32(uint32_t x);
 152
 153 /*
 154  * Return the minimum order for which x <= (1UL << order).
 155  * Return -1 if x is 0.
 156  */
 157 int get_count_order_u64(uint64_t x);
 158
 159 /*
 160  * Return the minimum order for which x <= (1UL << order).
 161  * Return -1 if x is 0.
 162  */
 163 int get_count_order_ulong(unsigned long x);
 164
 165 const char *get_event_type_str(enum lttng_event_type event_type);
 166
 167 int print_missing_or_multiple_domains(unsigned int domain_count, bool include_agent_domains);
 168
 169 int spawn_relayd(const char *pathname, int port);
 170 int check_relayd(void);
 171 void print_session_stats(const char *session_name);
 172 int get_session_stats_str(const char *session_name, char **str);
 173 int show_cmd_help(const char *cmd_name, const char *help_msg);
 174
 175 int print_trace_archive_location(const struct lttng_trace_archive_location *location,
 176                                  const char *session_name);
 177
 178 int validate_exclusion_list(const char *event_name,
 179                             const struct lttng_dynamic_pointer_array *exclusions);
 180
 181 #endif /* _LTTNG_UTILS_H */