src/bin/lttng-sessiond/session.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License, version 2 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  16  */
  17
  18 #ifndef _LTT_SESSION_H
  19 #define _LTT_SESSION_H
  20
  21 #include <limits.h>
  22 #include <stdbool.h>
  23 #include <urcu/list.h>
  24
  25 #include <common/hashtable/hashtable.h>
  26 #include <common/dynamic-array.h>
  27 #include <lttng/rotation.h>
  28 #include <lttng/location.h>
  29 #include <lttng/lttng-error.h>
  30
  31 #include "snapshot.h"
  32 #include "trace-kernel.h"
  33 #include "consumer.h"
  34
  35 struct ltt_ust_session;
  36
  37 typedef void (*ltt_session_destroy_notifier)(const struct ltt_session *session,
  38                 void *user_data);
  39
  40 /*
  41  * Tracing session list
  42  *
  43  * Statically declared in session.c and can be accessed by using
  44  * session_get_list() function that returns the pointer to the list.
  45  */
  46 struct ltt_session_list {
  47         /*
  48          * This lock protects any read/write access to the list and
  49          * next_uuid. All public functions in session.c acquire this
  50          * lock and release it before returning. If none of those
  51          * functions are used, the lock MUST be acquired in order to
  52          * iterate or/and do any actions on that list.
  53          */
  54         pthread_mutex_t lock;
  55         /*
  56          * This condition variable is signaled on every removal from
  57          * the session list.
  58          */
  59         pthread_cond_t removal_cond;
  60
  61         /*
  62          * Session unique ID generator. The session list lock MUST be
  63          * upon update and read of this counter.
  64          */
  65         uint64_t next_uuid;
  66
  67         /* Linked list head */
  68         struct cds_list_head head;
  69 };
  70
  71 /*
  72  * This data structure contains information needed to identify a tracing
  73  * session for both LTTng and UST.
  74  */
  75 struct ltt_session {
  76         char name[NAME_MAX];
  77         bool has_auto_generated_name;
  78         bool name_contains_creation_time;
  79         char hostname[HOST_NAME_MAX]; /* Local hostname. */
  80         /* Path of the last closed chunk. */
  81         char last_chunk_path[LTTNG_PATH_MAX];
  82         time_t creation_time;
  83         struct ltt_kernel_session *kernel_session;
  84         struct ltt_ust_session *ust_session;
  85         struct urcu_ref ref;
  86         /*
  87          * Protect any read/write on this session data structure. This lock must be
  88          * acquired *before* using any public functions declared below. Use
  89          * session_lock() and session_unlock() for that.
  90          */
  91         pthread_mutex_t lock;
  92         struct cds_list_head list;
  93         uint64_t id;            /* session unique identifier */
  94         /* Indicates if the session has been added to the session list and ht.*/
  95         bool published;
  96         /* Indicates if a destroy command has been applied to this session. */
  97         bool destroyed;
  98         /* UID/GID of the user owning the session */
  99         uid_t uid;
 100         gid_t gid;
 101         /*
 102          * Network session handle. A value of 0 means that there is no remote
 103          * session established.
 104          */
 105         uint64_t net_handle;
 106         /*
 107          * This consumer is only set when the create_session_uri call is made.
 108          * This contains the temporary information for a consumer output. Upon
 109          * creation of the UST or kernel session, this consumer, if available, is
 110          * copied into those sessions.
 111          */
 112         struct consumer_output *consumer;
 113         /*
 114          * Indicates whether or not the user has specified an output directory
 115          * or if it was configured using the default configuration.
 116          */
 117         bool has_user_specified_directory;
 118         /* Did at least ONE start command has been triggered?. */
 119         unsigned int has_been_started:1;
 120         /*
 121          * Is the session active? Start trace command sets this to 1 and the stop
 122          * command reset it to 0.
 123          */
 124         unsigned int active:1;
 125
 126         /* Snapshot representation in a session. */
 127         struct snapshot snapshot;
 128         /* Indicate if the session has to output the traces or not. */
 129         unsigned int output_traces;
 130         /*
 131          * This session is in snapshot mode. This means that channels enabled
 132          * will be set in overwrite mode by default and must be in mmap
 133          * output mode. Note that snapshots can be taken on a session that
 134          * is not in "snapshot_mode". This parameter only affects channel
 135          * creation defaults.
 136          */
 137         unsigned int snapshot_mode;
 138         /*
 139          * A session that has channels that don't use 'mmap' output can't be
 140          * used to capture snapshots. This is set to true whenever a
 141          * 'splice' kernel channel is enabled.
 142          */
 143         bool has_non_mmap_channel;
 144         /*
 145          * Timer set when the session is created for live reading.
 146          */
 147         unsigned int live_timer;
 148         /*
 149          * Path where to keep the shared memory files.
 150          */
 151         char shm_path[PATH_MAX];
 152         /*
 153          * Node in ltt_sessions_ht_by_id.
 154          */
 155         struct lttng_ht_node_u64 node;
 156         /*
 157          * Timer to check periodically if a relay and/or consumer has completed
 158          * the last rotation.
 159          */
 160         bool rotation_pending_check_timer_enabled;
 161         timer_t rotation_pending_check_timer;
 162         /* Timer to periodically rotate a session. */
 163         bool rotation_schedule_timer_enabled;
 164         timer_t rotation_schedule_timer;
 165         /* Value for periodic rotations, 0 if disabled. */
 166         uint64_t rotate_timer_period;
 167         /* Value for size-based rotations, 0 if disabled. */
 168         uint64_t rotate_size;
 169         /*
 170          * Keep a state if this session was rotated after the last stop command.
 171          * We only allow one rotation after a stop. At destroy, we also need to
 172          * know if a rotation occurred since the last stop to rename the current
 173          * chunk.
 174          */
 175         bool rotated_after_last_stop;
 176         /*
 177          * Condition and trigger for size-based rotations.
 178          */
 179         struct lttng_condition *rotate_condition;
 180         struct lttng_trigger *rotate_trigger;
 181         LTTNG_OPTIONAL(uint64_t) most_recent_chunk_id;
 182         struct lttng_trace_chunk *current_trace_chunk;
 183         struct lttng_trace_chunk *chunk_being_archived;
 184         /* Current state of a rotation. */
 185         enum lttng_rotation_state rotation_state;
 186         bool quiet_rotation;
 187         char *last_archived_chunk_name;
 188         LTTNG_OPTIONAL(uint64_t) last_archived_chunk_id;
 189         struct lttng_dynamic_array destroy_notifiers;
 190         /* Session base path override. Set non-null. */
 191         char *base_path;
 192 };
 193
 194 /* Prototypes */
 195 enum lttng_error_code session_create(const char *name, uid_t uid, gid_t gid,
 196                 const char *base_path, struct ltt_session **out_session);
 197 void session_lock(struct ltt_session *session);
 198 void session_lock_list(void);
 199 int session_trylock_list(void);
 200 void session_unlock(struct ltt_session *session);
 201 void session_unlock_list(void);
 202
 203 void session_destroy(struct ltt_session *session);
 204 int session_add_destroy_notifier(struct ltt_session *session,
 205                 ltt_session_destroy_notifier notifier, void *user_data);
 206
 207 bool session_get(struct ltt_session *session);
 208 void session_put(struct ltt_session *session);
 209
 210 enum consumer_dst_type session_get_consumer_destination_type(
 211                 const struct ltt_session *session);
 212 const char *session_get_net_consumer_hostname(
 213                 const struct ltt_session *session);
 214 void session_get_net_consumer_ports(
 215                 const struct ltt_session *session,
 216                 uint16_t *control_port, uint16_t *data_port);
 217 struct lttng_trace_archive_location *session_get_trace_archive_location(
 218                 const struct ltt_session *session);
 219
 220 struct ltt_session *session_find_by_name(const char *name);
 221 struct ltt_session *session_find_by_id(uint64_t id);
 222
 223 struct ltt_session_list *session_get_list(void);
 224 void session_list_wait_empty(void);
 225
 226 int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid);
 227
 228 int session_reset_rotation_state(struct ltt_session *session,
 229                 enum lttng_rotation_state result);
 230
 231 /* Create a new trace chunk object from the session's configuration. */
 232 struct lttng_trace_chunk *session_create_new_trace_chunk(
 233                 const struct ltt_session *session,
 234                 const struct consumer_output *consumer_output_override,
 235                 const char *session_base_path_override,
 236                 const char *chunk_name_override);
 237
 238 /*
 239  * Set `new_trace_chunk` as the session's current trace chunk. A reference
 240  * to `new_trace_chunk` is acquired by the session. The chunk is created
 241  * on remote peers (consumer and relay daemons).
 242  *
 243  * A reference to the session's current trace chunk is returned through
 244  * `current_session_trace_chunk` on success.
 245  */
 246 int session_set_trace_chunk(struct ltt_session *session,
 247                 struct lttng_trace_chunk *new_trace_chunk,
 248                 struct lttng_trace_chunk **current_session_trace_chunk);
 249
 250 /*
 251  * Close a chunk on the remote peers of a session. Has no effect on the
 252  * ltt_session itself.
 253  */
 254 int session_close_trace_chunk(const struct ltt_session *session,
 255                 struct lttng_trace_chunk *trace_chunk,
 256                 const enum lttng_trace_chunk_command_type *close_command,
 257                 char *path);
 258
 259 bool session_output_supports_trace_chunks(const struct ltt_session *session);
 260
 261 #endif /* _LTT_SESSION_H */