Commit | Line | Data |
---|---|---|
5b74c7b1 | 1 | /* |
21cf9b6b | 2 | * Copyright (C) 2011 EfficiOS Inc. |
5b74c7b1 | 3 | * |
ab5be9fa | 4 | * SPDX-License-Identifier: GPL-2.0-only |
91d76f53 | 5 | * |
5b74c7b1 DG |
6 | */ |
7 | ||
6c1c0768 | 8 | #define _LGPL_SOURCE |
28ab034a JG |
9 | #include "cmd.hpp" |
10 | #include "kernel.hpp" | |
11 | #include "lttng-sessiond.hpp" | |
12 | #include "session.hpp" | |
13 | #include "timer.hpp" | |
14 | #include "trace-ust.hpp" | |
15 | #include "utils.hpp" | |
16 | ||
17 | #include <common/common.hpp> | |
18 | #include <common/sessiond-comm/sessiond-comm.hpp> | |
19 | #include <common/trace-chunk.hpp> | |
20 | #include <common/urcu.hpp> | |
21 | #include <common/utils.hpp> | |
22 | ||
23 | #include <lttng/location-internal.hpp> | |
24 | ||
e99e3664 | 25 | #include <dirent.h> |
d022620a | 26 | #include <inttypes.h> |
e99e3664 JG |
27 | #include <limits.h> |
28 | #include <pthread.h> | |
5b74c7b1 DG |
29 | #include <stdio.h> |
30 | #include <stdlib.h> | |
31 | #include <string.h> | |
a304c14c | 32 | #include <sys/stat.h> |
3d071855 | 33 | #include <sys/types.h> |
e99e3664 | 34 | #include <urcu.h> |
5b74c7b1 | 35 | |
f1494934 | 36 | namespace { |
3e3665b8 JG |
37 | struct ltt_session_destroy_notifier_element { |
38 | ltt_session_destroy_notifier notifier; | |
39 | void *user_data; | |
40 | }; | |
41 | ||
ccbdaca4 MD |
42 | struct ltt_session_clear_notifier_element { |
43 | ltt_session_clear_notifier notifier; | |
44 | void *user_data; | |
45 | }; | |
46 | ||
e99e3664 JG |
47 | namespace ls = lttng::sessiond; |
48 | ||
8c0faa1d | 49 | /* |
b5541356 | 50 | * NOTES: |
8c0faa1d | 51 | * |
b5541356 | 52 | * No ltt_session.lock is taken here because those data structure are widely |
e1bbf989 | 53 | * spread across the lttng-tools code base so before calling functions below |
b5541356 | 54 | * that can read/write a session, the caller MUST acquire the session lock |
54d01ffb | 55 | * using session_lock() and session_unlock(). |
8c0faa1d | 56 | */ |
8c0faa1d | 57 | |
f1494934 JG |
58 | /* These characters are forbidden in a session name. Used by validate_name. */ |
59 | const char *forbidden_name_chars = "/"; | |
60 | ||
61 | /* Global hash table to keep the sessions, indexed by id. */ | |
cd9adb8b | 62 | struct lttng_ht *ltt_sessions_ht_by_id = nullptr; |
f1494934 | 63 | /* Global hash table to keep the sessions, indexed by name. */ |
cd9adb8b | 64 | struct lttng_ht *ltt_sessions_ht_by_name = nullptr; |
f1494934 | 65 | |
5b74c7b1 | 66 | /* |
b5541356 | 67 | * Init tracing session list. |
5b74c7b1 | 68 | * |
b5541356 | 69 | * Please see session.h for more explanation and correct usage of the list. |
5b74c7b1 | 70 | */ |
f1494934 | 71 | struct ltt_session_list the_session_list = { |
b5541356 | 72 | .lock = PTHREAD_MUTEX_INITIALIZER, |
99d688f2 | 73 | .removal_cond = PTHREAD_COND_INITIALIZER, |
a24f7994 | 74 | .next_uuid = 0, |
f1494934 | 75 | .head = CDS_LIST_HEAD_INIT(the_session_list.head), |
b5541356 | 76 | }; |
f1494934 | 77 | } /* namespace */ |
23324029 | 78 | |
1c1c3634 DG |
79 | /* |
80 | * Validate the session name for forbidden characters. | |
81 | * | |
82 | * Return 0 on success else -1 meaning a forbidden char. has been found. | |
83 | */ | |
84 | static int validate_name(const char *name) | |
85 | { | |
86 | int ret; | |
87 | char *tok, *tmp_name; | |
88 | ||
a0377dfe | 89 | LTTNG_ASSERT(name); |
1c1c3634 DG |
90 | |
91 | tmp_name = strdup(name); | |
92 | if (!tmp_name) { | |
93 | /* ENOMEM here. */ | |
94 | ret = -1; | |
95 | goto error; | |
96 | } | |
97 | ||
98 | tok = strpbrk(tmp_name, forbidden_name_chars); | |
99 | if (tok) { | |
100 | DBG("Session name %s contains a forbidden character", name); | |
101 | /* Forbidden character has been found. */ | |
102 | ret = -1; | |
103 | goto error; | |
104 | } | |
105 | ret = 0; | |
106 | ||
107 | error: | |
108 | free(tmp_name); | |
109 | return ret; | |
110 | } | |
111 | ||
5b74c7b1 | 112 | /* |
050349bb | 113 | * Add a ltt_session structure to the global list. |
5b74c7b1 | 114 | * |
050349bb | 115 | * The caller MUST acquire the session list lock before. |
44e96653 | 116 | * Returns the unique identifier for the session. |
5b74c7b1 | 117 | */ |
d022620a | 118 | static uint64_t add_session_list(struct ltt_session *ls) |
5b74c7b1 | 119 | { |
a0377dfe | 120 | LTTNG_ASSERT(ls); |
0525e9ae | 121 | |
f1494934 JG |
122 | cds_list_add(&ls->list, &the_session_list.head); |
123 | return the_session_list.next_uuid++; | |
5b74c7b1 DG |
124 | } |
125 | ||
126 | /* | |
050349bb | 127 | * Delete a ltt_session structure to the global list. |
b5541356 | 128 | * |
050349bb | 129 | * The caller MUST acquire the session list lock before. |
5b74c7b1 DG |
130 | */ |
131 | static void del_session_list(struct ltt_session *ls) | |
132 | { | |
a0377dfe | 133 | LTTNG_ASSERT(ls); |
0525e9ae | 134 | |
5b74c7b1 | 135 | cds_list_del(&ls->list); |
5b74c7b1 DG |
136 | } |
137 | ||
b5541356 | 138 | /* |
050349bb | 139 | * Return a pointer to the session list. |
b5541356 | 140 | */ |
cd9adb8b | 141 | struct ltt_session_list *session_get_list() |
b5541356 | 142 | { |
f1494934 | 143 | return &the_session_list; |
b5541356 DG |
144 | } |
145 | ||
99d688f2 JG |
146 | /* |
147 | * Returns once the session list is empty. | |
148 | */ | |
cd9adb8b | 149 | void session_list_wait_empty() |
99d688f2 | 150 | { |
f1494934 JG |
151 | pthread_mutex_lock(&the_session_list.lock); |
152 | while (!cds_list_empty(&the_session_list.head)) { | |
28ab034a | 153 | pthread_cond_wait(&the_session_list.removal_cond, &the_session_list.lock); |
99d688f2 | 154 | } |
f1494934 | 155 | pthread_mutex_unlock(&the_session_list.lock); |
99d688f2 JG |
156 | } |
157 | ||
b5541356 | 158 | /* |
6c9cc2ab | 159 | * Acquire session list lock |
b5541356 | 160 | */ |
cd9adb8b | 161 | void session_lock_list() |
b5541356 | 162 | { |
f1494934 | 163 | pthread_mutex_lock(&the_session_list.lock); |
b5541356 DG |
164 | } |
165 | ||
71e0a100 JG |
166 | /* |
167 | * Try to acquire session list lock | |
168 | */ | |
cd9adb8b | 169 | int session_trylock_list() |
71e0a100 | 170 | { |
f1494934 | 171 | return pthread_mutex_trylock(&the_session_list.lock); |
71e0a100 JG |
172 | } |
173 | ||
b5541356 | 174 | /* |
6c9cc2ab | 175 | * Release session list lock |
b5541356 | 176 | */ |
cd9adb8b | 177 | void session_unlock_list() |
b5541356 | 178 | { |
f1494934 | 179 | pthread_mutex_unlock(&the_session_list.lock); |
b5541356 DG |
180 | } |
181 | ||
dd73d57b JG |
182 | /* |
183 | * Get the session's consumer destination type. | |
184 | * | |
185 | * The caller must hold the session lock. | |
186 | */ | |
28ab034a | 187 | enum consumer_dst_type session_get_consumer_destination_type(const struct ltt_session *session) |
dd73d57b JG |
188 | { |
189 | /* | |
190 | * The output information is duplicated in both of those session types. | |
191 | * Hence, it doesn't matter from which it is retrieved. However, it is | |
192 | * possible for only one of them to be set. | |
193 | */ | |
28ab034a JG |
194 | return session->kernel_session ? session->kernel_session->consumer->type : |
195 | session->ust_session->consumer->type; | |
dd73d57b JG |
196 | } |
197 | ||
198 | /* | |
199 | * Get the session's consumer network hostname. | |
200 | * The caller must ensure that the destination is of type "net". | |
201 | * | |
202 | * The caller must hold the session lock. | |
203 | */ | |
204 | const char *session_get_net_consumer_hostname(const struct ltt_session *session) | |
205 | { | |
cd9adb8b | 206 | const char *hostname = nullptr; |
dd73d57b JG |
207 | const struct consumer_output *output; |
208 | ||
28ab034a JG |
209 | output = session->kernel_session ? session->kernel_session->consumer : |
210 | session->ust_session->consumer; | |
dd73d57b JG |
211 | |
212 | /* | |
213 | * hostname is assumed to be the same for both control and data | |
214 | * connections. | |
215 | */ | |
216 | switch (output->dst.net.control.dtype) { | |
217 | case LTTNG_DST_IPV4: | |
218 | hostname = output->dst.net.control.dst.ipv4; | |
219 | break; | |
220 | case LTTNG_DST_IPV6: | |
221 | hostname = output->dst.net.control.dst.ipv6; | |
222 | break; | |
223 | default: | |
224 | abort(); | |
225 | } | |
226 | return hostname; | |
227 | } | |
228 | ||
229 | /* | |
230 | * Get the session's consumer network control and data ports. | |
231 | * The caller must ensure that the destination is of type "net". | |
232 | * | |
233 | * The caller must hold the session lock. | |
234 | */ | |
235 | void session_get_net_consumer_ports(const struct ltt_session *session, | |
28ab034a JG |
236 | uint16_t *control_port, |
237 | uint16_t *data_port) | |
dd73d57b JG |
238 | { |
239 | const struct consumer_output *output; | |
240 | ||
28ab034a JG |
241 | output = session->kernel_session ? session->kernel_session->consumer : |
242 | session->ust_session->consumer; | |
dd73d57b JG |
243 | *control_port = output->dst.net.control.port; |
244 | *data_port = output->dst.net.data.port; | |
245 | } | |
246 | ||
5d65beab JG |
247 | /* |
248 | * Get the location of the latest trace archive produced by a rotation. | |
249 | * | |
250 | * The caller must hold the session lock. | |
251 | */ | |
28ab034a JG |
252 | struct lttng_trace_archive_location * |
253 | session_get_trace_archive_location(const struct ltt_session *session) | |
5d65beab | 254 | { |
d2956687 | 255 | int ret; |
cd9adb8b JG |
256 | struct lttng_trace_archive_location *location = nullptr; |
257 | char *chunk_path = nullptr; | |
d2956687 JG |
258 | |
259 | if (session->rotation_state != LTTNG_ROTATION_STATE_COMPLETED || | |
28ab034a | 260 | !session->last_archived_chunk_name) { |
d2956687 JG |
261 | goto end; |
262 | } | |
5d65beab | 263 | |
5d65beab JG |
264 | switch (session_get_consumer_destination_type(session)) { |
265 | case CONSUMER_DST_LOCAL: | |
ecd1a12f | 266 | ret = asprintf(&chunk_path, |
28ab034a JG |
267 | "%s/" DEFAULT_ARCHIVED_TRACE_CHUNKS_DIRECTORY "/%s", |
268 | session_get_base_path(session), | |
269 | session->last_archived_chunk_name); | |
ecd1a12f MD |
270 | if (ret == -1) { |
271 | goto end; | |
272 | } | |
28ab034a | 273 | location = lttng_trace_archive_location_local_create(chunk_path); |
5d65beab JG |
274 | break; |
275 | case CONSUMER_DST_NET: | |
276 | { | |
277 | const char *hostname; | |
278 | uint16_t control_port, data_port; | |
279 | ||
280 | hostname = session_get_net_consumer_hostname(session); | |
28ab034a | 281 | session_get_net_consumer_ports(session, &control_port, &data_port); |
5d65beab | 282 | location = lttng_trace_archive_location_relay_create( |
28ab034a JG |
283 | hostname, |
284 | LTTNG_TRACE_ARCHIVE_LOCATION_RELAY_PROTOCOL_TYPE_TCP, | |
285 | control_port, | |
286 | data_port, | |
287 | session->last_chunk_path); | |
5d65beab JG |
288 | break; |
289 | } | |
290 | default: | |
291 | abort(); | |
292 | } | |
293 | end: | |
d2956687 | 294 | free(chunk_path); |
5d65beab JG |
295 | return location; |
296 | } | |
297 | ||
23324029 | 298 | /* |
e1bbf989 | 299 | * Allocate the ltt_sessions_ht_by_id and ltt_sessions_ht_by_name HT. |
9c6518bc JG |
300 | * |
301 | * The session list lock must be held. | |
23324029 | 302 | */ |
cd9adb8b | 303 | static int ltt_sessions_ht_alloc() |
23324029 JD |
304 | { |
305 | int ret = 0; | |
306 | ||
307 | DBG("Allocating ltt_sessions_ht_by_id"); | |
308 | ltt_sessions_ht_by_id = lttng_ht_new(0, LTTNG_HT_TYPE_U64); | |
309 | if (!ltt_sessions_ht_by_id) { | |
310 | ret = -1; | |
311 | ERR("Failed to allocate ltt_sessions_ht_by_id"); | |
312 | goto end; | |
313 | } | |
e1bbf989 JR |
314 | |
315 | DBG("Allocating ltt_sessions_ht_by_name"); | |
316 | ltt_sessions_ht_by_name = lttng_ht_new(0, LTTNG_HT_TYPE_STRING); | |
317 | if (!ltt_sessions_ht_by_name) { | |
318 | ret = -1; | |
319 | ERR("Failed to allocate ltt_sessions_ht_by_name"); | |
320 | goto end; | |
321 | } | |
322 | ||
23324029 JD |
323 | end: |
324 | return ret; | |
325 | } | |
326 | ||
327 | /* | |
328 | * Destroy the ltt_sessions_ht_by_id HT. | |
9c6518bc JG |
329 | * |
330 | * The session list lock must be held. | |
23324029 | 331 | */ |
cd9adb8b | 332 | static void ltt_sessions_ht_destroy() |
23324029 | 333 | { |
e1bbf989 | 334 | if (ltt_sessions_ht_by_id) { |
3c339053 | 335 | lttng_ht_destroy(ltt_sessions_ht_by_id); |
cd9adb8b | 336 | ltt_sessions_ht_by_id = nullptr; |
e1bbf989 JR |
337 | } |
338 | ||
339 | if (ltt_sessions_ht_by_name) { | |
3c339053 | 340 | lttng_ht_destroy(ltt_sessions_ht_by_name); |
cd9adb8b | 341 | ltt_sessions_ht_by_name = nullptr; |
23324029 | 342 | } |
e1bbf989 JR |
343 | |
344 | return; | |
23324029 JD |
345 | } |
346 | ||
347 | /* | |
e1bbf989 JR |
348 | * Add a ltt_session to the ltt_sessions_ht_by_id and ltt_sessions_ht_by_name. |
349 | * If unallocated, the ltt_sessions_ht_by_id and ltt_sessions_ht_by_name. HTs | |
350 | * are allocated. The session list lock must be held. | |
23324029 JD |
351 | */ |
352 | static void add_session_ht(struct ltt_session *ls) | |
353 | { | |
354 | int ret; | |
355 | ||
a0377dfe | 356 | LTTNG_ASSERT(ls); |
23324029 JD |
357 | |
358 | if (!ltt_sessions_ht_by_id) { | |
359 | ret = ltt_sessions_ht_alloc(); | |
360 | if (ret) { | |
361 | ERR("Error allocating the sessions HT"); | |
362 | goto end; | |
363 | } | |
364 | } | |
e1bbf989 JR |
365 | |
366 | /* Should always be present with ltt_sessions_ht_by_id. */ | |
a0377dfe | 367 | LTTNG_ASSERT(ltt_sessions_ht_by_name); |
e1bbf989 | 368 | |
23324029 JD |
369 | lttng_ht_node_init_u64(&ls->node, ls->id); |
370 | lttng_ht_add_unique_u64(ltt_sessions_ht_by_id, &ls->node); | |
371 | ||
e1bbf989 JR |
372 | lttng_ht_node_init_str(&ls->node_by_name, ls->name); |
373 | lttng_ht_add_unique_str(ltt_sessions_ht_by_name, &ls->node_by_name); | |
374 | ||
23324029 JD |
375 | end: |
376 | return; | |
377 | } | |
378 | ||
379 | /* | |
e1bbf989 | 380 | * Test if ltt_sessions_ht_by_id/name are empty. |
2a6ebf6b | 381 | * Return `false` if hash table objects are null. |
23324029 JD |
382 | * The session list lock must be held. |
383 | */ | |
cd9adb8b | 384 | static bool ltt_sessions_ht_empty() |
23324029 | 385 | { |
2a6ebf6b | 386 | bool empty = false; |
23324029 JD |
387 | |
388 | if (!ltt_sessions_ht_by_id) { | |
2a6ebf6b | 389 | /* The hash tables do not exist yet. */ |
23324029 JD |
390 | goto end; |
391 | } | |
392 | ||
a0377dfe | 393 | LTTNG_ASSERT(ltt_sessions_ht_by_name); |
e1bbf989 | 394 | |
6f729565 | 395 | if (lttng_ht_get_count(ltt_sessions_ht_by_id) != 0) { |
2a6ebf6b JR |
396 | /* Not empty.*/ |
397 | goto end; | |
398 | } | |
399 | ||
400 | /* | |
401 | * At this point it is expected that the `ltt_sessions_ht_by_name` ht is | |
402 | * empty. | |
403 | * | |
404 | * The removal from both hash tables is done in two different | |
405 | * places: | |
406 | * - removal from `ltt_sessions_ht_by_name` is done during | |
407 | * `session_destroy()` | |
408 | * - removal from `ltt_sessions_ht_by_id` is done later | |
409 | * in `session_release()` on the last reference put. | |
410 | * | |
411 | * This means that it is possible for `ltt_sessions_ht_by_name` to be | |
412 | * empty but for `ltt_sessions_ht_by_id` to still contain objects when | |
413 | * multiple sessions exists. The reverse is false, hence this sanity | |
414 | * check. | |
415 | */ | |
416 | LTTNG_ASSERT(lttng_ht_get_count(ltt_sessions_ht_by_name) == 0); | |
417 | empty = true; | |
23324029 | 418 | end: |
2a6ebf6b | 419 | return empty; |
23324029 JD |
420 | } |
421 | ||
422 | /* | |
ed41e570 | 423 | * Remove a ltt_session from the ltt_sessions_ht_by_id. |
e1bbf989 | 424 | * If empty, the ltt_sessions_ht_by_id/name HTs are freed. |
23324029 JD |
425 | * The session list lock must be held. |
426 | */ | |
427 | static void del_session_ht(struct ltt_session *ls) | |
428 | { | |
429 | struct lttng_ht_iter iter; | |
430 | int ret; | |
431 | ||
a0377dfe FD |
432 | LTTNG_ASSERT(ls); |
433 | LTTNG_ASSERT(ltt_sessions_ht_by_id); | |
434 | LTTNG_ASSERT(ltt_sessions_ht_by_name); | |
23324029 JD |
435 | |
436 | iter.iter.node = &ls->node.node; | |
437 | ret = lttng_ht_del(ltt_sessions_ht_by_id, &iter); | |
a0377dfe | 438 | LTTNG_ASSERT(!ret); |
23324029 JD |
439 | |
440 | if (ltt_sessions_ht_empty()) { | |
e1bbf989 | 441 | DBG("Empty ltt_sessions_ht_by_id/name, destroying hast tables"); |
23324029 JD |
442 | ltt_sessions_ht_destroy(); |
443 | } | |
444 | } | |
445 | ||
b5541356 | 446 | /* |
6c9cc2ab | 447 | * Acquire session lock |
b5541356 | 448 | */ |
54d01ffb | 449 | void session_lock(struct ltt_session *session) |
b5541356 | 450 | { |
a0377dfe | 451 | LTTNG_ASSERT(session); |
0525e9ae | 452 | |
6c9cc2ab DG |
453 | pthread_mutex_lock(&session->lock); |
454 | } | |
b5541356 | 455 | |
6c9cc2ab DG |
456 | /* |
457 | * Release session lock | |
458 | */ | |
54d01ffb | 459 | void session_unlock(struct ltt_session *session) |
6c9cc2ab | 460 | { |
a0377dfe | 461 | LTTNG_ASSERT(session); |
0525e9ae | 462 | |
6c9cc2ab | 463 | pthread_mutex_unlock(&session->lock); |
b5541356 DG |
464 | } |
465 | ||
28ab034a JG |
466 | static int _session_set_trace_chunk_no_lock_check(struct ltt_session *session, |
467 | struct lttng_trace_chunk *new_trace_chunk, | |
468 | struct lttng_trace_chunk **_current_trace_chunk) | |
82b69413 | 469 | { |
78fc586b | 470 | int ret = 0; |
82b69413 | 471 | unsigned int i, refs_to_acquire = 0, refs_acquired = 0, refs_to_release = 0; |
82b69413 JG |
472 | struct cds_lfht_iter iter; |
473 | struct consumer_socket *socket; | |
d2956687 JG |
474 | struct lttng_trace_chunk *current_trace_chunk; |
475 | uint64_t chunk_id; | |
476 | enum lttng_trace_chunk_status chunk_status; | |
82b69413 | 477 | |
d2956687 | 478 | rcu_read_lock(); |
82b69413 | 479 | /* |
d2956687 JG |
480 | * Ownership of current trace chunk is transferred to |
481 | * `current_trace_chunk`. | |
82b69413 | 482 | */ |
d2956687 | 483 | current_trace_chunk = session->current_trace_chunk; |
cd9adb8b | 484 | session->current_trace_chunk = nullptr; |
82b69413 | 485 | if (session->ust_session) { |
28ab034a | 486 | lttng_trace_chunk_put(session->ust_session->current_trace_chunk); |
cd9adb8b | 487 | session->ust_session->current_trace_chunk = nullptr; |
82b69413 JG |
488 | } |
489 | if (session->kernel_session) { | |
28ab034a | 490 | lttng_trace_chunk_put(session->kernel_session->current_trace_chunk); |
cd9adb8b | 491 | session->kernel_session->current_trace_chunk = nullptr; |
82b69413 | 492 | } |
d2956687 JG |
493 | if (!new_trace_chunk) { |
494 | ret = 0; | |
495 | goto end; | |
82b69413 | 496 | } |
d2956687 | 497 | chunk_status = lttng_trace_chunk_get_id(new_trace_chunk, &chunk_id); |
a0377dfe | 498 | LTTNG_ASSERT(chunk_status == LTTNG_TRACE_CHUNK_STATUS_OK); |
82b69413 | 499 | |
d2956687 JG |
500 | refs_to_acquire = 1; |
501 | refs_to_acquire += !!session->ust_session; | |
502 | refs_to_acquire += !!session->kernel_session; | |
503 | ||
28ab034a | 504 | for (refs_acquired = 0; refs_acquired < refs_to_acquire; refs_acquired++) { |
d2956687 JG |
505 | if (!lttng_trace_chunk_get(new_trace_chunk)) { |
506 | ERR("Failed to acquire reference to new trace chunk of session \"%s\"", | |
28ab034a | 507 | session->name); |
d2956687 | 508 | goto error; |
82b69413 JG |
509 | } |
510 | } | |
511 | ||
d2956687 | 512 | if (session->ust_session) { |
28ab034a JG |
513 | const uint64_t relayd_id = session->ust_session->consumer->net_seq_index; |
514 | const bool is_local_trace = session->ust_session->consumer->type == | |
515 | CONSUMER_DST_LOCAL; | |
e5add6d0 | 516 | |
d2956687 | 517 | session->ust_session->current_trace_chunk = new_trace_chunk; |
f8a37411 | 518 | if (is_local_trace) { |
d2956687 | 519 | enum lttng_error_code ret_error_code; |
82b69413 | 520 | |
28ab034a JG |
521 | ret_error_code = |
522 | ust_app_create_channel_subdirectories(session->ust_session); | |
d2956687 | 523 | if (ret_error_code != LTTNG_OK) { |
82b69413 JG |
524 | goto error; |
525 | } | |
f8a37411 | 526 | } |
28ab034a JG |
527 | cds_lfht_for_each_entry ( |
528 | session->ust_session->consumer->socks->ht, &iter, socket, node.node) { | |
d2956687 JG |
529 | pthread_mutex_lock(socket->lock); |
530 | ret = consumer_create_trace_chunk(socket, | |
28ab034a JG |
531 | relayd_id, |
532 | session->id, | |
533 | new_trace_chunk, | |
534 | DEFAULT_UST_TRACE_DIR); | |
d2956687 | 535 | pthread_mutex_unlock(socket->lock); |
f8a37411 | 536 | if (ret) { |
d2956687 | 537 | goto error; |
f8a37411 JG |
538 | } |
539 | } | |
540 | } | |
82b69413 | 541 | if (session->kernel_session) { |
28ab034a JG |
542 | const uint64_t relayd_id = session->kernel_session->consumer->net_seq_index; |
543 | const bool is_local_trace = session->kernel_session->consumer->type == | |
544 | CONSUMER_DST_LOCAL; | |
e5add6d0 | 545 | |
d2956687 JG |
546 | session->kernel_session->current_trace_chunk = new_trace_chunk; |
547 | if (is_local_trace) { | |
548 | enum lttng_error_code ret_error_code; | |
549 | ||
28ab034a JG |
550 | ret_error_code = |
551 | kernel_create_channel_subdirectories(session->kernel_session); | |
d2956687 | 552 | if (ret_error_code != LTTNG_OK) { |
d2956687 JG |
553 | goto error; |
554 | } | |
f8a37411 | 555 | } |
28ab034a JG |
556 | cds_lfht_for_each_entry ( |
557 | session->kernel_session->consumer->socks->ht, &iter, socket, node.node) { | |
d2956687 JG |
558 | pthread_mutex_lock(socket->lock); |
559 | ret = consumer_create_trace_chunk(socket, | |
28ab034a JG |
560 | relayd_id, |
561 | session->id, | |
562 | new_trace_chunk, | |
563 | DEFAULT_KERNEL_TRACE_DIR); | |
d2956687 | 564 | pthread_mutex_unlock(socket->lock); |
f8a37411 | 565 | if (ret) { |
d2956687 | 566 | goto error; |
f8a37411 JG |
567 | } |
568 | } | |
569 | } | |
82b69413 JG |
570 | |
571 | /* | |
572 | * Update local current trace chunk state last, only if all remote | |
d2956687 | 573 | * creations succeeded. |
82b69413 JG |
574 | */ |
575 | session->current_trace_chunk = new_trace_chunk; | |
d2956687 JG |
576 | LTTNG_OPTIONAL_SET(&session->most_recent_chunk_id, chunk_id); |
577 | end: | |
578 | if (_current_trace_chunk) { | |
579 | *_current_trace_chunk = current_trace_chunk; | |
cd9adb8b | 580 | current_trace_chunk = nullptr; |
d2956687 JG |
581 | } |
582 | end_no_move: | |
583 | rcu_read_unlock(); | |
584 | lttng_trace_chunk_put(current_trace_chunk); | |
585 | return ret; | |
586 | error: | |
82b69413 | 587 | if (session->ust_session) { |
cd9adb8b | 588 | session->ust_session->current_trace_chunk = nullptr; |
82b69413 JG |
589 | } |
590 | if (session->kernel_session) { | |
cd9adb8b | 591 | session->kernel_session->current_trace_chunk = nullptr; |
82b69413 | 592 | } |
f8a37411 | 593 | /* |
82b69413 JG |
594 | * Release references taken in the case where all references could not |
595 | * be acquired. | |
596 | */ | |
597 | refs_to_release = refs_to_acquire - refs_acquired; | |
598 | for (i = 0; i < refs_to_release; i++) { | |
599 | lttng_trace_chunk_put(new_trace_chunk); | |
600 | } | |
d2956687 JG |
601 | ret = -1; |
602 | goto end_no_move; | |
82b69413 JG |
603 | } |
604 | ||
28ab034a JG |
605 | struct lttng_trace_chunk * |
606 | session_create_new_trace_chunk(const struct ltt_session *session, | |
607 | const struct consumer_output *consumer_output_override, | |
608 | const char *session_base_path_override, | |
609 | const char *chunk_name_override) | |
82b69413 JG |
610 | { |
611 | int ret; | |
cd9adb8b | 612 | struct lttng_trace_chunk *trace_chunk = nullptr; |
82b69413 | 613 | enum lttng_trace_chunk_status chunk_status; |
cd9adb8b | 614 | const time_t chunk_creation_ts = time(nullptr); |
348a81dc JG |
615 | bool is_local_trace; |
616 | const char *base_path; | |
cd9adb8b | 617 | struct lttng_directory_handle *session_output_directory = nullptr; |
82b69413 | 618 | const struct lttng_credentials session_credentials = { |
ff588497 JR |
619 | .uid = LTTNG_OPTIONAL_INIT_VALUE(session->uid), |
620 | .gid = LTTNG_OPTIONAL_INIT_VALUE(session->gid), | |
82b69413 JG |
621 | }; |
622 | uint64_t next_chunk_id; | |
348a81dc | 623 | const struct consumer_output *output; |
a7ceb342 | 624 | const char *new_path; |
348a81dc JG |
625 | |
626 | if (consumer_output_override) { | |
627 | output = consumer_output_override; | |
628 | } else { | |
a0377dfe | 629 | LTTNG_ASSERT(session->ust_session || session->kernel_session); |
28ab034a JG |
630 | output = session->ust_session ? session->ust_session->consumer : |
631 | session->kernel_session->consumer; | |
348a81dc JG |
632 | } |
633 | ||
634 | is_local_trace = output->type == CONSUMER_DST_LOCAL; | |
28ab034a | 635 | base_path = session_base_path_override ?: consumer_output_get_base_path(output); |
82b69413 | 636 | |
d2956687 JG |
637 | if (chunk_creation_ts == (time_t) -1) { |
638 | PERROR("Failed to sample time while creation session \"%s\" trace chunk", | |
28ab034a | 639 | session->name); |
82b69413 JG |
640 | goto error; |
641 | } | |
82b69413 | 642 | |
28ab034a JG |
643 | next_chunk_id = |
644 | session->most_recent_chunk_id.is_set ? session->most_recent_chunk_id.value + 1 : 0; | |
82b69413 | 645 | |
a7ceb342 | 646 | if (session->current_trace_chunk && |
28ab034a | 647 | !lttng_trace_chunk_get_name_overridden(session->current_trace_chunk)) { |
a7ceb342 | 648 | chunk_status = lttng_trace_chunk_rename_path(session->current_trace_chunk, |
28ab034a | 649 | DEFAULT_CHUNK_TMP_OLD_DIRECTORY); |
a7ceb342 MD |
650 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
651 | goto error; | |
652 | } | |
653 | } | |
654 | if (!session->current_trace_chunk) { | |
655 | if (!session->rotated) { | |
656 | new_path = ""; | |
657 | } else { | |
cd9adb8b | 658 | new_path = nullptr; |
a7ceb342 MD |
659 | } |
660 | } else { | |
661 | new_path = DEFAULT_CHUNK_TMP_NEW_DIRECTORY; | |
662 | } | |
663 | ||
28ab034a | 664 | trace_chunk = lttng_trace_chunk_create(next_chunk_id, chunk_creation_ts, new_path); |
82b69413 | 665 | if (!trace_chunk) { |
82b69413 JG |
666 | goto error; |
667 | } | |
668 | ||
669 | if (chunk_name_override) { | |
28ab034a | 670 | chunk_status = lttng_trace_chunk_override_name(trace_chunk, chunk_name_override); |
d2956687 | 671 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
82b69413 JG |
672 | goto error; |
673 | } | |
674 | } | |
675 | ||
676 | if (!is_local_trace) { | |
677 | /* | |
678 | * No need to set crendentials and output directory | |
679 | * for remote trace chunks. | |
680 | */ | |
d2956687 | 681 | goto end; |
82b69413 JG |
682 | } |
683 | ||
28ab034a | 684 | chunk_status = lttng_trace_chunk_set_credentials(trace_chunk, &session_credentials); |
82b69413 | 685 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
82b69413 JG |
686 | goto error; |
687 | } | |
688 | ||
28ab034a JG |
689 | DBG("Creating base output directory of session \"%s\" at %s", session->name, base_path); |
690 | ret = utils_mkdir_recursive(base_path, S_IRWXU | S_IRWXG, session->uid, session->gid); | |
82b69413 | 691 | if (ret) { |
82b69413 JG |
692 | goto error; |
693 | } | |
cbf53d23 JG |
694 | session_output_directory = lttng_directory_handle_create(base_path); |
695 | if (!session_output_directory) { | |
82b69413 JG |
696 | goto error; |
697 | } | |
28ab034a | 698 | chunk_status = lttng_trace_chunk_set_as_owner(trace_chunk, session_output_directory); |
cbf53d23 | 699 | lttng_directory_handle_put(session_output_directory); |
cd9adb8b | 700 | session_output_directory = nullptr; |
82b69413 | 701 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
82b69413 JG |
702 | goto error; |
703 | } | |
d2956687 JG |
704 | end: |
705 | return trace_chunk; | |
82b69413 | 706 | error: |
cbf53d23 | 707 | lttng_directory_handle_put(session_output_directory); |
82b69413 | 708 | lttng_trace_chunk_put(trace_chunk); |
cd9adb8b | 709 | trace_chunk = nullptr; |
d2956687 JG |
710 | goto end; |
711 | } | |
712 | ||
343defc2 | 713 | int session_close_trace_chunk(struct ltt_session *session, |
28ab034a JG |
714 | struct lttng_trace_chunk *trace_chunk, |
715 | enum lttng_trace_chunk_command_type close_command, | |
716 | char *closed_trace_chunk_path) | |
d2956687 JG |
717 | { |
718 | int ret = 0; | |
719 | bool error_occurred = false; | |
720 | struct cds_lfht_iter iter; | |
721 | struct consumer_socket *socket; | |
722 | enum lttng_trace_chunk_status chunk_status; | |
cd9adb8b | 723 | const time_t chunk_close_timestamp = time(nullptr); |
a7ceb342 | 724 | const char *new_path; |
d2956687 | 725 | |
28ab034a | 726 | chunk_status = lttng_trace_chunk_set_close_command(trace_chunk, close_command); |
343defc2 MD |
727 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
728 | ret = -1; | |
729 | goto end; | |
bbc4768c JG |
730 | } |
731 | ||
d2956687 JG |
732 | if (chunk_close_timestamp == (time_t) -1) { |
733 | ERR("Failed to sample the close timestamp of the current trace chunk of session \"%s\"", | |
28ab034a | 734 | session->name); |
d2956687 JG |
735 | ret = -1; |
736 | goto end; | |
737 | } | |
a7ceb342 MD |
738 | |
739 | if (close_command == LTTNG_TRACE_CHUNK_COMMAND_TYPE_DELETE && !session->rotated) { | |
740 | /* New chunk stays in session output directory. */ | |
741 | new_path = ""; | |
742 | } else { | |
743 | /* Use chunk name for new chunk. */ | |
cd9adb8b | 744 | new_path = nullptr; |
a7ceb342 MD |
745 | } |
746 | if (session->current_trace_chunk && | |
28ab034a | 747 | !lttng_trace_chunk_get_name_overridden(session->current_trace_chunk)) { |
a7ceb342 | 748 | /* Rename new chunk path. */ |
28ab034a JG |
749 | chunk_status = |
750 | lttng_trace_chunk_rename_path(session->current_trace_chunk, new_path); | |
a7ceb342 MD |
751 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
752 | ret = -1; | |
753 | goto end; | |
754 | } | |
755 | } | |
756 | if (!lttng_trace_chunk_get_name_overridden(trace_chunk) && | |
28ab034a | 757 | close_command == LTTNG_TRACE_CHUNK_COMMAND_TYPE_NO_OPERATION) { |
a7ceb342 MD |
758 | const char *old_path; |
759 | ||
760 | if (!session->rotated) { | |
761 | old_path = ""; | |
762 | } else { | |
cd9adb8b | 763 | old_path = nullptr; |
a7ceb342 MD |
764 | } |
765 | /* We need to move back the .tmp_old_chunk to its rightful place. */ | |
28ab034a | 766 | chunk_status = lttng_trace_chunk_rename_path(trace_chunk, old_path); |
a7ceb342 MD |
767 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
768 | ret = -1; | |
769 | goto end; | |
770 | } | |
771 | } | |
772 | if (close_command == LTTNG_TRACE_CHUNK_COMMAND_TYPE_MOVE_TO_COMPLETED) { | |
773 | session->rotated = true; | |
774 | } | |
28ab034a | 775 | chunk_status = lttng_trace_chunk_set_close_timestamp(trace_chunk, chunk_close_timestamp); |
d2956687 JG |
776 | if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { |
777 | ERR("Failed to set the close timestamp of the current trace chunk of session \"%s\"", | |
28ab034a | 778 | session->name); |
d2956687 JG |
779 | ret = -1; |
780 | goto end; | |
781 | } | |
782 | ||
783 | if (session->ust_session) { | |
28ab034a | 784 | const uint64_t relayd_id = session->ust_session->consumer->net_seq_index; |
0a184d4e | 785 | |
28ab034a JG |
786 | cds_lfht_for_each_entry ( |
787 | session->ust_session->consumer->socks->ht, &iter, socket, node.node) { | |
d2956687 JG |
788 | pthread_mutex_lock(socket->lock); |
789 | ret = consumer_close_trace_chunk(socket, | |
28ab034a JG |
790 | relayd_id, |
791 | session->id, | |
792 | trace_chunk, | |
793 | closed_trace_chunk_path); | |
d2956687 JG |
794 | pthread_mutex_unlock(socket->lock); |
795 | if (ret) { | |
796 | ERR("Failed to close trace chunk on user space consumer"); | |
797 | error_occurred = true; | |
798 | } | |
799 | } | |
800 | } | |
801 | if (session->kernel_session) { | |
28ab034a | 802 | const uint64_t relayd_id = session->kernel_session->consumer->net_seq_index; |
0a184d4e | 803 | |
28ab034a JG |
804 | cds_lfht_for_each_entry ( |
805 | session->kernel_session->consumer->socks->ht, &iter, socket, node.node) { | |
d2956687 JG |
806 | pthread_mutex_lock(socket->lock); |
807 | ret = consumer_close_trace_chunk(socket, | |
28ab034a JG |
808 | relayd_id, |
809 | session->id, | |
810 | trace_chunk, | |
811 | closed_trace_chunk_path); | |
d2956687 JG |
812 | pthread_mutex_unlock(socket->lock); |
813 | if (ret) { | |
814 | ERR("Failed to close trace chunk on kernel consumer"); | |
815 | error_occurred = true; | |
816 | } | |
817 | } | |
818 | } | |
819 | ret = error_occurred ? -1 : 0; | |
82b69413 | 820 | end: |
d2956687 | 821 | return ret; |
82b69413 JG |
822 | } |
823 | ||
04ed9e10 JG |
824 | /* |
825 | * This function skips the metadata channel as the begin/end timestamps of a | |
826 | * metadata packet are useless. | |
827 | * | |
828 | * Moreover, opening a packet after a "clear" will cause problems for live | |
829 | * sessions as it will introduce padding that was not part of the first trace | |
830 | * chunk. The relay daemon expects the content of the metadata stream of | |
831 | * successive metadata trace chunks to be strict supersets of one another. | |
832 | * | |
833 | * For example, flushing a packet at the beginning of the metadata stream of | |
834 | * a trace chunk resulting from a "clear" session command will cause the | |
835 | * size of the metadata stream of the new trace chunk to not match the size of | |
836 | * the metadata stream of the original chunk. This will confuse the relay | |
837 | * daemon as the same "offset" in a metadata stream will no longer point | |
838 | * to the same content. | |
839 | */ | |
28ab034a | 840 | static enum lttng_error_code session_kernel_open_packets(struct ltt_session *session) |
04ed9e10 JG |
841 | { |
842 | enum lttng_error_code ret = LTTNG_OK; | |
843 | struct consumer_socket *socket; | |
844 | struct lttng_ht_iter iter; | |
845 | struct cds_lfht_node *node; | |
846 | struct ltt_kernel_channel *chan; | |
847 | ||
848 | rcu_read_lock(); | |
849 | ||
850 | cds_lfht_first(session->kernel_session->consumer->socks->ht, &iter.iter); | |
851 | node = cds_lfht_iter_get_node(&iter.iter); | |
0114db0e | 852 | socket = caa_container_of(node, typeof(*socket), node.node); |
04ed9e10 | 853 | |
28ab034a | 854 | cds_list_for_each_entry (chan, &session->kernel_session->channel_list.head, list) { |
04ed9e10 JG |
855 | int open_ret; |
856 | ||
857 | DBG("Open packet of kernel channel: channel key = %" PRIu64 | |
28ab034a JG |
858 | ", session name = %s, session_id = %" PRIu64, |
859 | chan->key, | |
860 | session->name, | |
861 | session->id); | |
04ed9e10 JG |
862 | |
863 | open_ret = consumer_open_channel_packets(socket, chan->key); | |
864 | if (open_ret < 0) { | |
865 | /* General error (no known error expected). */ | |
866 | ret = LTTNG_ERR_UNK; | |
867 | goto end; | |
868 | } | |
869 | } | |
870 | ||
871 | end: | |
872 | rcu_read_unlock(); | |
873 | return ret; | |
874 | } | |
875 | ||
876 | enum lttng_error_code session_open_packets(struct ltt_session *session) | |
877 | { | |
878 | enum lttng_error_code ret = LTTNG_OK; | |
879 | ||
880 | DBG("Opening packets of session channels: session name = %s, session id = %" PRIu64, | |
28ab034a JG |
881 | session->name, |
882 | session->id); | |
04ed9e10 JG |
883 | |
884 | if (session->ust_session) { | |
885 | ret = ust_app_open_packets(session); | |
886 | if (ret != LTTNG_OK) { | |
887 | goto end; | |
888 | } | |
889 | } | |
890 | ||
891 | if (session->kernel_session) { | |
892 | ret = session_kernel_open_packets(session); | |
893 | if (ret != LTTNG_OK) { | |
894 | goto end; | |
895 | } | |
896 | } | |
897 | ||
898 | end: | |
899 | return ret; | |
900 | } | |
901 | ||
82b69413 JG |
902 | /* |
903 | * Set a session's current trace chunk. | |
904 | * | |
905 | * Must be called with the session lock held. | |
906 | */ | |
907 | int session_set_trace_chunk(struct ltt_session *session, | |
28ab034a JG |
908 | struct lttng_trace_chunk *new_trace_chunk, |
909 | struct lttng_trace_chunk **current_trace_chunk) | |
82b69413 JG |
910 | { |
911 | ASSERT_LOCKED(session->lock); | |
28ab034a JG |
912 | return _session_set_trace_chunk_no_lock_check( |
913 | session, new_trace_chunk, current_trace_chunk); | |
82b69413 JG |
914 | } |
915 | ||
28ab034a | 916 | static void session_notify_destruction(const struct ltt_session *session) |
3e3665b8 JG |
917 | { |
918 | size_t i; | |
28ab034a | 919 | const size_t count = lttng_dynamic_array_get_count(&session->destroy_notifiers); |
3e3665b8 JG |
920 | |
921 | for (i = 0; i < count; i++) { | |
922 | const struct ltt_session_destroy_notifier_element *element = | |
7966af57 | 923 | (ltt_session_destroy_notifier_element *) lttng_dynamic_array_get_element( |
28ab034a | 924 | &session->destroy_notifiers, i); |
3e3665b8 JG |
925 | |
926 | element->notifier(session, element->user_data); | |
927 | } | |
928 | } | |
929 | ||
ccbdaca4 MD |
930 | /* |
931 | * Fire each clear notifier once, and remove them from the array. | |
932 | */ | |
933 | void session_notify_clear(struct ltt_session *session) | |
934 | { | |
935 | size_t i; | |
28ab034a | 936 | const size_t count = lttng_dynamic_array_get_count(&session->clear_notifiers); |
ccbdaca4 MD |
937 | |
938 | for (i = 0; i < count; i++) { | |
939 | const struct ltt_session_clear_notifier_element *element = | |
7966af57 | 940 | (ltt_session_clear_notifier_element *) lttng_dynamic_array_get_element( |
28ab034a | 941 | &session->clear_notifiers, i); |
ccbdaca4 MD |
942 | |
943 | element->notifier(session, element->user_data); | |
944 | } | |
945 | lttng_dynamic_array_clear(&session->clear_notifiers); | |
946 | } | |
947 | ||
28ab034a | 948 | static void session_release(struct urcu_ref *ref) |
e32d7f27 JG |
949 | { |
950 | int ret; | |
951 | struct ltt_ust_session *usess; | |
952 | struct ltt_kernel_session *ksess; | |
0114db0e | 953 | struct ltt_session *session = lttng::utils::container_of(ref, <t_session::ref); |
7fdbed1c | 954 | const bool session_published = session->published; |
e32d7f27 | 955 | |
a0377dfe | 956 | LTTNG_ASSERT(!session->chunk_being_archived); |
d2956687 | 957 | |
e32d7f27 JG |
958 | usess = session->ust_session; |
959 | ksess = session->kernel_session; | |
3e3665b8 | 960 | |
f8a37411 | 961 | /* Clean kernel session teardown, keeping data for destroy notifier. */ |
e32d7f27 JG |
962 | kernel_destroy_session(ksess); |
963 | ||
d070c424 | 964 | /* UST session teardown, keeping data for destroy notifier. */ |
e32d7f27 JG |
965 | if (usess) { |
966 | /* Close any relayd session */ | |
967 | consumer_output_send_destroy_relayd(usess->consumer); | |
968 | ||
969 | /* Destroy every UST application related to this session. */ | |
970 | ret = ust_app_destroy_trace_all(usess); | |
971 | if (ret) { | |
972 | ERR("Error in ust_app_destroy_trace_all"); | |
973 | } | |
974 | ||
d070c424 | 975 | /* Clean up the rest, keeping destroy notifier data. */ |
e32d7f27 JG |
976 | trace_ust_destroy_session(usess); |
977 | } | |
978 | ||
979 | /* | |
980 | * Must notify the kernel thread here to update it's poll set in order to | |
981 | * remove the channel(s)' fd just destroyed. | |
982 | */ | |
412d7227 | 983 | ret = notify_thread_pipe(the_kernel_poll_pipe[1]); |
e32d7f27 JG |
984 | if (ret < 0) { |
985 | PERROR("write kernel poll pipe"); | |
986 | } | |
987 | ||
988 | DBG("Destroying session %s (id %" PRIu64 ")", session->name, session->id); | |
e32d7f27 | 989 | |
e32d7f27 | 990 | snapshot_destroy(&session->snapshot); |
99d688f2 | 991 | |
82b69413 JG |
992 | pthread_mutex_destroy(&session->lock); |
993 | ||
7fdbed1c | 994 | if (session_published) { |
f1494934 | 995 | ASSERT_LOCKED(the_session_list.lock); |
f4cc5e83 JG |
996 | del_session_list(session); |
997 | del_session_ht(session); | |
f4cc5e83 | 998 | } |
7fdbed1c | 999 | session_notify_destruction(session); |
d070c424 | 1000 | |
1ac9cb73 | 1001 | consumer_output_put(session->consumer); |
d070c424 | 1002 | kernel_free_session(ksess); |
cd9adb8b | 1003 | session->kernel_session = nullptr; |
d070c424 MD |
1004 | if (usess) { |
1005 | trace_ust_free_session(usess); | |
cd9adb8b | 1006 | session->ust_session = nullptr; |
d070c424 | 1007 | } |
7fdbed1c | 1008 | lttng_dynamic_array_reset(&session->destroy_notifiers); |
ccbdaca4 | 1009 | lttng_dynamic_array_reset(&session->clear_notifiers); |
d2956687 | 1010 | free(session->last_archived_chunk_name); |
6fa5fe7c | 1011 | free(session->base_path); |
c08136a3 | 1012 | lttng_trigger_put(session->rotate_trigger); |
e32d7f27 | 1013 | free(session); |
7fdbed1c JG |
1014 | if (session_published) { |
1015 | /* | |
1016 | * Broadcast after free-ing to ensure the memory is | |
1017 | * reclaimed before the main thread exits. | |
1018 | */ | |
f1494934 JG |
1019 | ASSERT_LOCKED(the_session_list.lock); |
1020 | pthread_cond_broadcast(&the_session_list.removal_cond); | |
7fdbed1c | 1021 | } |
e32d7f27 JG |
1022 | } |
1023 | ||
1024 | /* | |
1025 | * Acquire a reference to a session. | |
1026 | * This function may fail (return false); its return value must be checked. | |
1027 | */ | |
1028 | bool session_get(struct ltt_session *session) | |
1029 | { | |
1030 | return urcu_ref_get_unless_zero(&session->ref); | |
1031 | } | |
1032 | ||
1033 | /* | |
1034 | * Release a reference to a session. | |
1035 | */ | |
1036 | void session_put(struct ltt_session *session) | |
1037 | { | |
b178f53e JG |
1038 | if (!session) { |
1039 | return; | |
1040 | } | |
e32d7f27 JG |
1041 | /* |
1042 | * The session list lock must be held as any session_put() | |
1043 | * may cause the removal of the session from the session_list. | |
1044 | */ | |
f1494934 | 1045 | ASSERT_LOCKED(the_session_list.lock); |
a0377dfe | 1046 | LTTNG_ASSERT(session->ref.refcount); |
e32d7f27 JG |
1047 | urcu_ref_put(&session->ref, session_release); |
1048 | } | |
1049 | ||
1050 | /* | |
1051 | * Destroy a session. | |
1052 | * | |
1053 | * This method does not immediately release/free the session as other | |
1054 | * components may still hold a reference to the session. However, | |
1055 | * the session should no longer be presented to the user. | |
1056 | * | |
1057 | * Releases the session list's reference to the session | |
1058 | * and marks it as destroyed. Iterations on the session list should be | |
1059 | * mindful of the "destroyed" flag. | |
1060 | */ | |
1061 | void session_destroy(struct ltt_session *session) | |
1062 | { | |
ed41e570 JR |
1063 | int ret; |
1064 | struct lttng_ht_iter iter; | |
1065 | ||
a0377dfe | 1066 | LTTNG_ASSERT(!session->destroyed); |
e32d7f27 | 1067 | session->destroyed = true; |
ed41e570 JR |
1068 | |
1069 | /* | |
1070 | * Remove immediately from the "session by name" hash table. Only one | |
1071 | * session is expected to exist with a given name for at any given time. | |
1072 | * | |
1073 | * Even if a session still technically exists for a little while longer, | |
1074 | * there is no point in performing action on a "destroyed" session. | |
1075 | */ | |
1076 | iter.iter.node = &session->node_by_name.node; | |
1077 | ret = lttng_ht_del(ltt_sessions_ht_by_name, &iter); | |
1078 | LTTNG_ASSERT(!ret); | |
1079 | ||
e32d7f27 JG |
1080 | session_put(session); |
1081 | } | |
1082 | ||
3e3665b8 | 1083 | int session_add_destroy_notifier(struct ltt_session *session, |
28ab034a JG |
1084 | ltt_session_destroy_notifier notifier, |
1085 | void *user_data) | |
3e3665b8 | 1086 | { |
28ab034a JG |
1087 | const struct ltt_session_destroy_notifier_element element = { .notifier = notifier, |
1088 | .user_data = user_data }; | |
3e3665b8 | 1089 | |
28ab034a | 1090 | return lttng_dynamic_array_add_element(&session->destroy_notifiers, &element); |
3e3665b8 JG |
1091 | } |
1092 | ||
ccbdaca4 | 1093 | int session_add_clear_notifier(struct ltt_session *session, |
28ab034a JG |
1094 | ltt_session_clear_notifier notifier, |
1095 | void *user_data) | |
ccbdaca4 | 1096 | { |
28ab034a JG |
1097 | const struct ltt_session_clear_notifier_element element = { .notifier = notifier, |
1098 | .user_data = user_data }; | |
ccbdaca4 | 1099 | |
28ab034a | 1100 | return lttng_dynamic_array_add_element(&session->clear_notifiers, &element); |
ccbdaca4 MD |
1101 | } |
1102 | ||
5b74c7b1 | 1103 | /* |
74babd95 | 1104 | * Return a ltt_session structure ptr that matches name. If no session found, |
23324029 | 1105 | * NULL is returned. This must be called with the session list lock held using |
74babd95 | 1106 | * session_lock_list and session_unlock_list. |
e32d7f27 | 1107 | * A reference to the session is implicitly acquired by this function. |
5b74c7b1 | 1108 | */ |
58a1a227 | 1109 | struct ltt_session *session_find_by_name(const char *name) |
5b74c7b1 | 1110 | { |
5b74c7b1 DG |
1111 | struct ltt_session *iter; |
1112 | ||
a0377dfe | 1113 | LTTNG_ASSERT(name); |
f1494934 | 1114 | ASSERT_LOCKED(the_session_list.lock); |
0525e9ae | 1115 | |
5f822d0a DG |
1116 | DBG2("Trying to find session by name %s", name); |
1117 | ||
28ab034a JG |
1118 | cds_list_for_each_entry (iter, &the_session_list.head, list) { |
1119 | if (!strncmp(iter->name, name, NAME_MAX) && !iter->destroyed) { | |
74babd95 | 1120 | goto found; |
5b74c7b1 DG |
1121 | } |
1122 | } | |
1123 | ||
cd9adb8b | 1124 | return nullptr; |
74babd95 | 1125 | found: |
cd9adb8b | 1126 | return session_get(iter) ? iter : nullptr; |
5b74c7b1 DG |
1127 | } |
1128 | ||
23324029 JD |
1129 | /* |
1130 | * Return an ltt_session that matches the id. If no session is found, | |
1131 | * NULL is returned. This must be called with rcu_read_lock and | |
1132 | * session list lock held (to guarantee the lifetime of the session). | |
1133 | */ | |
1134 | struct ltt_session *session_find_by_id(uint64_t id) | |
1135 | { | |
1136 | struct lttng_ht_node_u64 *node; | |
1137 | struct lttng_ht_iter iter; | |
1138 | struct ltt_session *ls; | |
1139 | ||
48b7cdc2 | 1140 | ASSERT_RCU_READ_LOCKED(); |
f1494934 | 1141 | ASSERT_LOCKED(the_session_list.lock); |
e32d7f27 | 1142 | |
d68ec974 JG |
1143 | if (!ltt_sessions_ht_by_id) { |
1144 | goto end; | |
1145 | } | |
1146 | ||
23324029 JD |
1147 | lttng_ht_lookup(ltt_sessions_ht_by_id, &id, &iter); |
1148 | node = lttng_ht_iter_get_node_u64(&iter); | |
cd9adb8b | 1149 | if (node == nullptr) { |
d68ec974 | 1150 | goto end; |
23324029 | 1151 | } |
0114db0e | 1152 | ls = lttng::utils::container_of(node, <t_session::node); |
23324029 JD |
1153 | |
1154 | DBG3("Session %" PRIu64 " found by id.", id); | |
cd9adb8b | 1155 | return session_get(ls) ? ls : nullptr; |
23324029 | 1156 | |
d68ec974 | 1157 | end: |
23324029 | 1158 | DBG3("Session %" PRIu64 " NOT found by id", id); |
cd9adb8b | 1159 | return nullptr; |
23324029 JD |
1160 | } |
1161 | ||
5b74c7b1 | 1162 | /* |
b178f53e JG |
1163 | * Create a new session and add it to the session list. |
1164 | * Session list lock must be held by the caller. | |
5b74c7b1 | 1165 | */ |
28ab034a JG |
1166 | enum lttng_error_code |
1167 | session_create(const char *name, uid_t uid, gid_t gid, struct ltt_session **out_session) | |
5b74c7b1 | 1168 | { |
f3ed775e | 1169 | int ret; |
b178f53e | 1170 | enum lttng_error_code ret_code; |
cd9adb8b | 1171 | struct ltt_session *new_session = nullptr; |
e07ae692 | 1172 | |
f1494934 | 1173 | ASSERT_LOCKED(the_session_list.lock); |
b178f53e JG |
1174 | if (name) { |
1175 | struct ltt_session *clashing_session; | |
1176 | ||
1177 | clashing_session = session_find_by_name(name); | |
1178 | if (clashing_session) { | |
1179 | session_put(clashing_session); | |
1180 | ret_code = LTTNG_ERR_EXIST_SESS; | |
1181 | goto error; | |
1182 | } | |
1183 | } | |
64803277 | 1184 | new_session = zmalloc<ltt_session>(); |
b178f53e JG |
1185 | if (!new_session) { |
1186 | PERROR("Failed to allocate an ltt_session structure"); | |
1187 | ret_code = LTTNG_ERR_NOMEM; | |
1188 | goto error; | |
5b74c7b1 DG |
1189 | } |
1190 | ||
3e3665b8 | 1191 | lttng_dynamic_array_init(&new_session->destroy_notifiers, |
28ab034a | 1192 | sizeof(struct ltt_session_destroy_notifier_element), |
cd9adb8b | 1193 | nullptr); |
ccbdaca4 | 1194 | lttng_dynamic_array_init(&new_session->clear_notifiers, |
28ab034a | 1195 | sizeof(struct ltt_session_clear_notifier_element), |
cd9adb8b | 1196 | nullptr); |
e32d7f27 | 1197 | urcu_ref_init(&new_session->ref); |
cd9adb8b | 1198 | pthread_mutex_init(&new_session->lock, nullptr); |
e32d7f27 | 1199 | |
cd9adb8b | 1200 | new_session->creation_time = time(nullptr); |
b178f53e JG |
1201 | if (new_session->creation_time == (time_t) -1) { |
1202 | PERROR("Failed to sample session creation time"); | |
1203 | ret_code = LTTNG_ERR_SESSION_FAIL; | |
f3ed775e DG |
1204 | goto error; |
1205 | } | |
1206 | ||
b178f53e JG |
1207 | /* Create default consumer output. */ |
1208 | new_session->consumer = consumer_create_output(CONSUMER_DST_LOCAL); | |
cd9adb8b | 1209 | if (new_session->consumer == nullptr) { |
b178f53e | 1210 | ret_code = LTTNG_ERR_NOMEM; |
1c1c3634 DG |
1211 | goto error; |
1212 | } | |
1213 | ||
b178f53e JG |
1214 | if (name) { |
1215 | ret = lttng_strncpy(new_session->name, name, sizeof(new_session->name)); | |
1216 | if (ret) { | |
1217 | ret_code = LTTNG_ERR_SESSION_INVALID_CHAR; | |
1218 | goto error; | |
1219 | } | |
1220 | ret = validate_name(name); | |
1221 | if (ret < 0) { | |
1222 | ret_code = LTTNG_ERR_SESSION_INVALID_CHAR; | |
1223 | goto error; | |
1224 | } | |
1225 | } else { | |
1226 | int i = 0; | |
1227 | bool found_name = false; | |
1228 | char datetime[16]; | |
1229 | struct tm *timeinfo; | |
1230 | ||
1231 | timeinfo = localtime(&new_session->creation_time); | |
1232 | if (!timeinfo) { | |
1233 | ret_code = LTTNG_ERR_SESSION_FAIL; | |
1234 | goto error; | |
1235 | } | |
1236 | strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo); | |
1237 | for (i = 0; i < INT_MAX; i++) { | |
1238 | struct ltt_session *clashing_session; | |
1239 | ||
1240 | if (i == 0) { | |
1241 | ret = snprintf(new_session->name, | |
28ab034a JG |
1242 | sizeof(new_session->name), |
1243 | "%s-%s", | |
1244 | DEFAULT_SESSION_NAME, | |
1245 | datetime); | |
b178f53e JG |
1246 | } else { |
1247 | ret = snprintf(new_session->name, | |
28ab034a JG |
1248 | sizeof(new_session->name), |
1249 | "%s%d-%s", | |
1250 | DEFAULT_SESSION_NAME, | |
1251 | i, | |
1252 | datetime); | |
b178f53e | 1253 | } |
46ef2188 | 1254 | new_session->name_contains_creation_time = true; |
b178f53e JG |
1255 | if (ret == -1 || ret >= sizeof(new_session->name)) { |
1256 | /* | |
1257 | * Null-terminate in case the name is used | |
1258 | * in logging statements. | |
1259 | */ | |
1260 | new_session->name[sizeof(new_session->name) - 1] = '\0'; | |
1261 | ret_code = LTTNG_ERR_SESSION_FAIL; | |
1262 | goto error; | |
1263 | } | |
1264 | ||
28ab034a | 1265 | clashing_session = session_find_by_name(new_session->name); |
b178f53e JG |
1266 | session_put(clashing_session); |
1267 | if (!clashing_session) { | |
1268 | found_name = true; | |
1269 | break; | |
1270 | } | |
1271 | } | |
1272 | if (found_name) { | |
1273 | DBG("Generated session name \"%s\"", new_session->name); | |
1274 | new_session->has_auto_generated_name = true; | |
1275 | } else { | |
1276 | ERR("Failed to auto-generate a session name"); | |
1277 | ret_code = LTTNG_ERR_SESSION_FAIL; | |
1278 | goto error; | |
1279 | } | |
1280 | } | |
1281 | ||
d3e2ba59 | 1282 | ret = gethostname(new_session->hostname, sizeof(new_session->hostname)); |
73184835 DG |
1283 | if (ret < 0) { |
1284 | if (errno == ENAMETOOLONG) { | |
1285 | new_session->hostname[sizeof(new_session->hostname) - 1] = '\0'; | |
b178f53e | 1286 | ERR("Hostname exceeds the maximal permitted length and has been truncated to %s", |
28ab034a | 1287 | new_session->hostname); |
73184835 | 1288 | } else { |
b178f53e | 1289 | ret_code = LTTNG_ERR_SESSION_FAIL; |
73184835 DG |
1290 | goto error; |
1291 | } | |
d3e2ba59 JD |
1292 | } |
1293 | ||
6df2e2c9 MD |
1294 | new_session->uid = uid; |
1295 | new_session->gid = gid; | |
1296 | ||
6dc3064a DG |
1297 | ret = snapshot_init(&new_session->snapshot); |
1298 | if (ret < 0) { | |
b178f53e | 1299 | ret_code = LTTNG_ERR_NOMEM; |
6dc3064a DG |
1300 | goto error; |
1301 | } | |
1302 | ||
4f23c583 | 1303 | new_session->rotation_state = LTTNG_ROTATION_STATE_NO_ROTATION; |
92816cc3 | 1304 | |
b178f53e | 1305 | /* Add new session to the session list. */ |
a991f516 | 1306 | new_session->id = add_session_list(new_session); |
b178f53e | 1307 | |
23324029 JD |
1308 | /* |
1309 | * Add the new session to the ltt_sessions_ht_by_id. | |
1310 | * No ownership is taken by the hash table; it is merely | |
1311 | * a wrapper around the session list used for faster access | |
1312 | * by session id. | |
1313 | */ | |
1314 | add_session_ht(new_session); | |
f4cc5e83 | 1315 | new_session->published = true; |
b5541356 | 1316 | |
a4b92340 | 1317 | /* |
b178f53e JG |
1318 | * Consumer is left to NULL since the create_session_uri command will |
1319 | * set it up and, if valid, assign it to the session. | |
a4b92340 | 1320 | */ |
b178f53e | 1321 | DBG("Tracing session %s created with ID %" PRIu64 " by uid = %d, gid = %d", |
28ab034a JG |
1322 | new_session->name, |
1323 | new_session->id, | |
1324 | new_session->uid, | |
1325 | new_session->gid); | |
b178f53e JG |
1326 | ret_code = LTTNG_OK; |
1327 | end: | |
1328 | if (new_session) { | |
1329 | (void) session_get(new_session); | |
1330 | *out_session = new_session; | |
1331 | } | |
1332 | return ret_code; | |
5b74c7b1 | 1333 | error: |
f4cc5e83 | 1334 | session_put(new_session); |
cd9adb8b | 1335 | new_session = nullptr; |
b178f53e | 1336 | goto end; |
5b74c7b1 | 1337 | } |
2f77fc4b DG |
1338 | |
1339 | /* | |
d7b377ed | 1340 | * Check if the UID matches the session. Root user has access to all |
2f77fc4b DG |
1341 | * sessions. |
1342 | */ | |
d7b377ed | 1343 | bool session_access_ok(struct ltt_session *session, uid_t uid) |
2f77fc4b | 1344 | { |
a0377dfe | 1345 | LTTNG_ASSERT(session); |
d7b377ed | 1346 | return (uid == session->uid) || uid == 0; |
2f77fc4b | 1347 | } |
2961f09e JG |
1348 | |
1349 | /* | |
1350 | * Set a session's rotation state and reset all associated state. | |
1351 | * | |
1352 | * This function resets the rotation state (check timers, pending | |
1353 | * flags, etc.) and sets the result of the last rotation. The result | |
1354 | * can be queries by a liblttng-ctl client. | |
1355 | * | |
1356 | * Be careful of the result passed to this function. For instance, | |
1357 | * on failure to launch a rotation, a client will expect the rotation | |
83ed9e90 | 1358 | * state to be set to "NO_ROTATION". If an error occurred while the |
2961f09e JG |
1359 | * rotation was "ONGOING", result should be set to "ERROR", which will |
1360 | * allow a client to report it. | |
1361 | * | |
1362 | * Must be called with the session and session_list locks held. | |
1363 | */ | |
28ab034a | 1364 | int session_reset_rotation_state(struct ltt_session *session, enum lttng_rotation_state result) |
2961f09e JG |
1365 | { |
1366 | int ret = 0; | |
1367 | ||
f1494934 | 1368 | ASSERT_LOCKED(the_session_list.lock); |
2961f09e JG |
1369 | ASSERT_LOCKED(session->lock); |
1370 | ||
2961f09e JG |
1371 | session->rotation_state = result; |
1372 | if (session->rotation_pending_check_timer_enabled) { | |
1373 | ret = timer_session_rotation_pending_check_stop(session); | |
1374 | } | |
d2956687 JG |
1375 | if (session->chunk_being_archived) { |
1376 | uint64_t chunk_id; | |
1377 | enum lttng_trace_chunk_status chunk_status; | |
1378 | ||
28ab034a | 1379 | chunk_status = lttng_trace_chunk_get_id(session->chunk_being_archived, &chunk_id); |
a0377dfe | 1380 | LTTNG_ASSERT(chunk_status == LTTNG_TRACE_CHUNK_STATUS_OK); |
28ab034a | 1381 | LTTNG_OPTIONAL_SET(&session->last_archived_chunk_id, chunk_id); |
d2956687 | 1382 | lttng_trace_chunk_put(session->chunk_being_archived); |
cd9adb8b | 1383 | session->chunk_being_archived = nullptr; |
ccbdaca4 MD |
1384 | /* |
1385 | * Fire the clear reply notifiers if we are completing a clear | |
1386 | * rotation. | |
1387 | */ | |
1388 | session_notify_clear(session); | |
d2956687 | 1389 | } |
2961f09e JG |
1390 | return ret; |
1391 | } | |
e1bbf989 JR |
1392 | |
1393 | /* | |
1394 | * Sample the id of a session looked up via its name. | |
1395 | * Here the term "sampling" hint the caller that this return the id at a given | |
1396 | * point in time with no guarantee that the session for which the id was | |
1397 | * sampled still exist at that point. | |
1398 | * | |
1399 | * Return 0 when the session is not found, | |
1400 | * Return 1 when the session is found and set `id`. | |
1401 | */ | |
1402 | bool sample_session_id_by_name(const char *name, uint64_t *id) | |
1403 | { | |
1404 | bool found = false; | |
1405 | struct lttng_ht_node_str *node; | |
1406 | struct lttng_ht_iter iter; | |
1407 | struct ltt_session *ls; | |
1408 | ||
1409 | rcu_read_lock(); | |
1410 | ||
1411 | if (!ltt_sessions_ht_by_name) { | |
1412 | found = false; | |
1413 | goto end; | |
1414 | } | |
1415 | ||
1416 | lttng_ht_lookup(ltt_sessions_ht_by_name, name, &iter); | |
1417 | node = lttng_ht_iter_get_node_str(&iter); | |
cd9adb8b | 1418 | if (node == nullptr) { |
e1bbf989 JR |
1419 | found = false; |
1420 | goto end; | |
1421 | } | |
1422 | ||
0114db0e | 1423 | ls = lttng::utils::container_of(node, <t_session::node_by_name); |
e1bbf989 JR |
1424 | *id = ls->id; |
1425 | found = true; | |
1426 | ||
1427 | DBG3("Session id `%" PRIu64 "` sampled for session `%s", *id, name); | |
1428 | end: | |
1429 | rcu_read_unlock(); | |
1430 | return found; | |
1431 | } | |
e99e3664 JG |
1432 | |
1433 | void ls::details::locked_session_release(ltt_session *session) | |
1434 | { | |
1435 | session_unlock(session); | |
1436 | session_put(session); | |
1437 | } | |
1438 | ||
1439 | ltt_session::locked_ptr ls::find_locked_session_by_id(ltt_session::id_t id) | |
1440 | { | |
1441 | lttng::urcu::read_lock_guard rcu_lock; | |
1442 | auto session = session_find_by_id(id); | |
1443 | ||
1444 | if (!session) { | |
1445 | return nullptr; | |
1446 | } | |
1447 | ||
1448 | /* | |
1449 | * The pointer falling out of scope will unlock and release the reference to the | |
1450 | * session. | |
1451 | */ | |
1452 | session_lock(session); | |
1453 | return ltt_session::locked_ptr(session); | |
1454 | } | |
1455 | ||
1456 | ltt_session::sptr ls::find_session_by_id(ltt_session::id_t id) | |
1457 | { | |
1458 | lttng::urcu::read_lock_guard rcu_lock; | |
1459 | auto session = session_find_by_id(id); | |
1460 | ||
1461 | if (!session) { | |
1462 | return nullptr; | |
1463 | } | |
1464 | ||
28ab034a | 1465 | return { session, session_put }; |
e99e3664 | 1466 | } |