src/bin/lttng-sessiond/session.hpp

   1 /*
   2  * Copyright (C) 2011 EfficiOS Inc.
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #ifndef _LTT_SESSION_H
   9 #define _LTT_SESSION_H
  10
  11 #include "consumer.hpp"
  12 #include "snapshot.hpp"
  13 #include "trace-kernel.hpp"
  14
  15 #include <common/dynamic-array.hpp>
  16 #include <common/hashtable/hashtable.hpp>
  17 #include <common/make-unique-wrapper.hpp>
  18 #include <common/pthread-lock.hpp>
  19
  20 #include <lttng/location.h>
  21 #include <lttng/lttng-error.h>
  22 #include <lttng/rotation.h>
  23
  24 #include <limits.h>
  25 #include <stdbool.h>
  26 #include <urcu/list.h>
  27
  28 #define ASSERT_SESSION_LIST_LOCKED() LTTNG_ASSERT(session_trylock_list())
  29
  30 struct ltt_ust_session;
  31
  32 using ltt_session_destroy_notifier = void (*)(const struct ltt_session *, void *);
  33 using ltt_session_clear_notifier = void (*)(const struct ltt_session *, void *);
  34
  35 namespace lttng {
  36 namespace sessiond {
  37 namespace details {
  38 void locked_session_release(ltt_session *session);
  39 } /* namespace details */
  40 } /* namespace sessiond */
  41 } /* namespace lttng */
  42
  43 /*
  44  * Tracing session list
  45  *
  46  * Statically declared in session.c and can be accessed by using
  47  * session_get_list() function that returns the pointer to the list.
  48  */
  49 struct ltt_session_list {
  50         /*
  51          * This lock protects any read/write access to the list and
  52          * next_uuid. All public functions in session.c acquire this
  53          * lock and release it before returning. If none of those
  54          * functions are used, the lock MUST be acquired in order to
  55          * iterate or/and do any actions on that list.
  56          */
  57         pthread_mutex_t lock;
  58         /*
  59          * This condition variable is signaled on every removal from
  60          * the session list.
  61          */
  62         pthread_cond_t removal_cond;
  63
  64         /*
  65          * Session unique ID generator. The session list lock MUST be
  66          * upon update and read of this counter.
  67          */
  68         uint64_t next_uuid;
  69
  70         /* Linked list head */
  71         struct cds_list_head head;
  72 };
  73
  74 /*
  75  * This data structure contains information needed to identify a tracing
  76  * session for both LTTng and UST.
  77  */
  78 struct ltt_session {
  79         using id_t = uint64_t;
  80         using locked_ptr =
  81                 std::unique_ptr<ltt_session,
  82                                 lttng::memory::create_deleter_class<
  83                                         ltt_session,
  84                                         lttng::sessiond::details::locked_session_release>::deleter>;
  85         using sptr = std::shared_ptr<ltt_session>;
  86
  87         char name[NAME_MAX];
  88         bool has_auto_generated_name;
  89         bool name_contains_creation_time;
  90         char hostname[LTTNG_HOST_NAME_MAX]; /* Local hostname. */
  91         /* Path of the last closed chunk. */
  92         char last_chunk_path[LTTNG_PATH_MAX];
  93         time_t creation_time;
  94         struct ltt_kernel_session *kernel_session;
  95         struct ltt_ust_session *ust_session;
  96         struct urcu_ref ref;
  97         /*
  98          * Protect any read/write on this session data structure. This lock must be
  99          * acquired *before* using any public functions declared below. Use
 100          * session_lock() and session_unlock() for that.
 101          */
 102         pthread_mutex_t lock;
 103         struct cds_list_head list;
 104         /* session unique identifier */
 105         id_t id;
 106         /* Indicates if the session has been added to the session list and ht.*/
 107         bool published;
 108         /* Indicates if a destroy command has been applied to this session. */
 109         bool destroyed;
 110         /* UID/GID of the user owning the session */
 111         uid_t uid;
 112         gid_t gid;
 113         /*
 114          * Network session handle. A value of 0 means that there is no remote
 115          * session established.
 116          */
 117         uint64_t net_handle;
 118         /*
 119          * This consumer is only set when the create_session_uri call is made.
 120          * This contains the temporary information for a consumer output. Upon
 121          * creation of the UST or kernel session, this consumer, if available, is
 122          * copied into those sessions.
 123          */
 124         struct consumer_output *consumer;
 125         /*
 126          * Indicates whether or not the user has specified an output directory
 127          * or if it was configured using the default configuration.
 128          */
 129         bool has_user_specified_directory;
 130         /* Did at least ONE start command has been triggered?. */
 131         bool has_been_started;
 132         /* Is the session active? */
 133         bool active;
 134
 135         /* Snapshot representation in a session. */
 136         struct snapshot snapshot;
 137         /* Indicate if the session has to output the traces or not. */
 138         unsigned int output_traces;
 139         /*
 140          * This session is in snapshot mode. This means that channels enabled
 141          * will be set in overwrite mode by default and must be in mmap
 142          * output mode. Note that snapshots can be taken on a session that
 143          * is not in "snapshot_mode". This parameter only affects channel
 144          * creation defaults.
 145          */
 146         unsigned int snapshot_mode;
 147         /*
 148          * A session that has channels that don't use 'mmap' output can't be
 149          * used to capture snapshots. This is set to true whenever a
 150          * 'splice' kernel channel is enabled.
 151          */
 152         bool has_non_mmap_channel;
 153         /*
 154          * Timer set when the session is created for live reading.
 155          */
 156         unsigned int live_timer;
 157         /*
 158          * Path where to keep the shared memory files.
 159          */
 160         char shm_path[PATH_MAX];
 161         /*
 162          * Node in ltt_sessions_ht_by_id.
 163          */
 164         struct lttng_ht_node_u64 node;
 165         /*
 166          * Node in ltt_sessions_ht_by_name.
 167          */
 168         struct lttng_ht_node_str node_by_name;
 169         /*
 170          * Timer to check periodically if a relay and/or consumer has completed
 171          * the last rotation.
 172          */
 173         bool rotation_pending_check_timer_enabled;
 174         timer_t rotation_pending_check_timer;
 175         /* Timer to periodically rotate a session. */
 176         bool rotation_schedule_timer_enabled;
 177         timer_t rotation_schedule_timer;
 178         /* Value for periodic rotations, 0 if disabled. */
 179         uint64_t rotate_timer_period;
 180         /* Value for size-based rotations, 0 if disabled. */
 181         uint64_t rotate_size;
 182         /*
 183          * Keep a state if this session was rotated after the last stop command.
 184          * We only allow one rotation after a stop. At destroy, we also need to
 185          * know if a rotation occurred since the last stop to rename the current
 186          * chunk. After a stop followed by rotate, all subsequent clear
 187          * (without prior start) will succeed, but will be effect-less.
 188          */
 189         bool rotated_after_last_stop;
 190         /*
 191          * Track whether the session was cleared after last stop. All subsequent
 192          * clear (without prior start) will succeed, but will be effect-less. A
 193          * subsequent rotate (without prior start) will return an error.
 194          */
 195         bool cleared_after_last_stop;
 196         /*
 197          * True if the session has had an explicit non-quiet rotation.
 198          */
 199         bool rotated;
 200         /*
 201          * Trigger for size-based rotations.
 202          */
 203         struct lttng_trigger *rotate_trigger;
 204         LTTNG_OPTIONAL(uint64_t) most_recent_chunk_id;
 205         struct lttng_trace_chunk *current_trace_chunk;
 206         struct lttng_trace_chunk *chunk_being_archived;
 207         /* Current state of a rotation. */
 208         enum lttng_rotation_state rotation_state;
 209         bool quiet_rotation;
 210         char *last_archived_chunk_name;
 211         LTTNG_OPTIONAL(uint64_t) last_archived_chunk_id;
 212         struct lttng_dynamic_array destroy_notifiers;
 213         struct lttng_dynamic_array clear_notifiers;
 214         /* Session base path override. Set non-null. */
 215         char *base_path;
 216 };
 217
 218 enum lttng_error_code
 219 session_create(const char *name, uid_t uid, gid_t gid, struct ltt_session **out_session);
 220 void session_lock(struct ltt_session *session);
 221 void session_unlock(struct ltt_session *session);
 222
 223 /*
 224  * The session list lock covers more ground than its name implies. While
 225  * it does protect against concurent mutations of the session list, it is
 226  * also used as a multi-session lock when synchronizing newly-registered
 227  * 'user space tracer' and 'agent' applications.
 228  *
 229  * In other words, it prevents tracer configurations from changing while they
 230  * are being transmitted to the various applications.
 231  */
 232 void session_lock_list() noexcept;
 233 int session_trylock_list() noexcept;
 234 void session_unlock_list() noexcept;
 235
 236 void session_destroy(struct ltt_session *session);
 237 int session_add_destroy_notifier(struct ltt_session *session,
 238                                  ltt_session_destroy_notifier notifier,
 239                                  void *user_data);
 240
 241 int session_add_clear_notifier(struct ltt_session *session,
 242                                ltt_session_clear_notifier notifier,
 243                                void *user_data);
 244 void session_notify_clear(ltt_session& session);
 245
 246 bool session_get(struct ltt_session *session);
 247 void session_put(struct ltt_session *session);
 248
 249 enum consumer_dst_type session_get_consumer_destination_type(const struct ltt_session *session);
 250 const char *session_get_net_consumer_hostname(const struct ltt_session *session);
 251 void session_get_net_consumer_ports(const struct ltt_session *session,
 252                                     uint16_t *control_port,
 253                                     uint16_t *data_port);
 254 struct lttng_trace_archive_location *
 255 session_get_trace_archive_location(const struct ltt_session *session);
 256
 257 struct ltt_session *session_find_by_name(const char *name);
 258 struct ltt_session *session_find_by_id(ltt_session::id_t id);
 259
 260 struct ltt_session_list *session_get_list();
 261 void session_list_wait_empty();
 262
 263 bool session_access_ok(struct ltt_session *session, uid_t uid);
 264
 265 int session_reset_rotation_state(ltt_session& session, enum lttng_rotation_state result);
 266
 267 /* Create a new trace chunk object from the session's configuration. */
 268 struct lttng_trace_chunk *
 269 session_create_new_trace_chunk(const struct ltt_session *session,
 270                                const struct consumer_output *consumer_output_override,
 271                                const char *session_base_path_override,
 272                                const char *chunk_name_override);
 273
 274 /*
 275  * Set `new_trace_chunk` as the session's current trace chunk. A reference
 276  * to `new_trace_chunk` is acquired by the session. The chunk is created
 277  * on remote peers (consumer and relay daemons).
 278  *
 279  * A reference to the session's current trace chunk is returned through
 280  * `current_session_trace_chunk` on success.
 281  */
 282 int session_set_trace_chunk(struct ltt_session *session,
 283                             struct lttng_trace_chunk *new_trace_chunk,
 284                             struct lttng_trace_chunk **current_session_trace_chunk);
 285
 286 /*
 287  * Close a chunk on the remote peers of a session. Has no effect on the
 288  * ltt_session itself.
 289  */
 290 int session_close_trace_chunk(struct ltt_session *session,
 291                               struct lttng_trace_chunk *trace_chunk,
 292                               enum lttng_trace_chunk_command_type close_command,
 293                               char *path);
 294
 295 /* Open a packet in all channels of a given session. */
 296 enum lttng_error_code session_open_packets(struct ltt_session *session);
 297
 298 bool session_output_supports_trace_chunks(const struct ltt_session *session);
 299
 300 /*
 301  * Sample the id of a session looked up via its name.
 302  * Here the term "sampling" hint the caller that this return the id at a given
 303  * point in time with no guarantee that the session for which the id was
 304  * sampled still exist at that point.
 305  *
 306  * Return 0 when the session is not found,
 307  * Return 1 when the session is found and set `id`.
 308  */
 309 bool sample_session_id_by_name(const char *name, uint64_t *id);
 310
 311 namespace lttng {
 312 namespace sessiond {
 313
 314 /*
 315  * Session list lock must be acquired by the caller.
 316  * The caller must not keep the ownership of the returned locked session
 317  * for longer than strictly necessary. If your intention is to acquire
 318  * a reference to an ltt_session, see `find_session_by_id()`.
 319  */
 320 ltt_session::locked_ptr find_locked_session_by_id(ltt_session::id_t id);
 321
 322 /*
 323  * Session list lock must be acquired by the caller.
 324  * The caller must not keep the ownership of the returned locked session
 325  * for longer than strictly necessary. If your intention is to acquire
 326  * a reference to an ltt_session, see `find_session_by_id()`.
 327  */
 328 ltt_session::sptr find_session_by_id(ltt_session::id_t id);
 329
 330 } /* namespace sessiond */
 331 } /* namespace lttng */
 332
 333 #endif /* _LTT_SESSION_H */