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