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