sessiond: document effect of rotated_after_last_stop on clear
[lttng-tools.git] / src / bin / lttng-sessiond / session.h
index 3ace323bab4a9ac18fd0a6d654498b7117f1bc14..883a265545e6965e2a82286cbcb6592d9781168c 100644 (file)
 #include <urcu/list.h>
 
 #include <common/hashtable/hashtable.h>
+#include <common/dynamic-array.h>
 #include <lttng/rotation.h>
+#include <lttng/location.h>
+#include <lttng/lttng-error.h>
 
 #include "snapshot.h"
 #include "trace-kernel.h"
 
 struct ltt_ust_session;
 
+typedef void (*ltt_session_destroy_notifier)(const struct ltt_session *session,
+               void *user_data);
+typedef void (*ltt_session_clear_notifier)(const struct ltt_session *session,
+               void *user_data);
+
 /*
  * Tracing session list
  *
@@ -46,6 +54,11 @@ struct ltt_session_list {
         * iterate or/and do any actions on that list.
         */
        pthread_mutex_t lock;
+       /*
+        * This condition variable is signaled on every removal from
+        * the session list.
+        */
+       pthread_cond_t removal_cond;
 
        /*
         * Session unique ID generator. The session list lock MUST be
@@ -63,9 +76,15 @@ struct ltt_session_list {
  */
 struct ltt_session {
        char name[NAME_MAX];
+       bool has_auto_generated_name;
+       bool name_contains_creation_time;
        char hostname[HOST_NAME_MAX]; /* Local hostname. */
+       /* Path of the last closed chunk. */
+       char last_chunk_path[LTTNG_PATH_MAX];
+       time_t creation_time;
        struct ltt_kernel_session *kernel_session;
        struct ltt_ust_session *ust_session;
+       struct urcu_ref ref;
        /*
         * Protect any read/write on this session data structure. This lock must be
         * acquired *before* using any public functions declared below. Use
@@ -74,6 +93,10 @@ struct ltt_session {
        pthread_mutex_t lock;
        struct cds_list_head list;
        uint64_t id;            /* session unique identifier */
+       /* Indicates if the session has been added to the session list and ht.*/
+       bool published;
+       /* Indicates if a destroy command has been applied to this session. */
+       bool destroyed;
        /* UID/GID of the user owning the session */
        uid_t uid;
        gid_t gid;
@@ -89,7 +112,11 @@ struct ltt_session {
         * copied into those sessions.
         */
        struct consumer_output *consumer;
-
+       /*
+        * Indicates whether or not the user has specified an output directory
+        * or if it was configured using the default configuration.
+        */
+       bool has_user_specified_directory;
        /* Did at least ONE start command has been triggered?. */
        unsigned int has_been_started:1;
        /*
@@ -103,11 +130,19 @@ struct ltt_session {
        /* Indicate if the session has to output the traces or not. */
        unsigned int output_traces;
        /*
-        * This session is in snapshot mode. This means that every channel enabled
-        * will be set in overwrite mode and mmap. It is considered exclusively for
-        * snapshot purposes.
+        * This session is in snapshot mode. This means that channels enabled
+        * will be set in overwrite mode by default and must be in mmap
+        * output mode. Note that snapshots can be taken on a session that
+        * is not in "snapshot_mode". This parameter only affects channel
+        * creation defaults.
         */
        unsigned int snapshot_mode;
+       /*
+        * A session that has channels that don't use 'mmap' output can't be
+        * used to capture snapshots. This is set to true whenever a
+        * 'splice' kernel channel is enabled.
+        */
+       bool has_non_mmap_channel;
        /*
         * Timer set when the session is created for live reading.
         */
@@ -121,100 +156,75 @@ struct ltt_session {
         */
        struct lttng_ht_node_u64 node;
        /*
-        * The current archive id corresponds to the number of session rotations
-        * that have occured for this session. The archive id
-        * is used to tag the "generation" of a stream. This tag allows the
-        * consumer and relay daemons to track when a given stream was created
-        * during the lifetime of a session.
-        *
-        * For instance, if a stream is created after a session rotation was
-        * launched, the consumer and relay daemons must not check its position
-        * to determine if that specific session rotation was completed. It is
-        * implicitly "completed" since the stream appeared _after_ the session
-        * rotation was initiated.
-        */
-       uint64_t current_archive_id;
-       /*
-        * Rotation is pending between the time it starts until the consumer has
-        * finished extracting the data. If the session uses a relay, data related
-        * to a rotation can still be in flight after that, see
-        * rotate_pending_relay.
+        * Timer to check periodically if a relay and/or consumer has completed
+        * the last rotation.
         */
-       bool rotate_pending;
-       /*
-        * True until the relay has finished the rotation of all the streams.
-        */
-       bool rotate_pending_relay;
-       /* Current state of a rotation. */
-       enum lttng_rotation_state rotation_state;
-       /*
-        * Number of channels waiting for a rotation.
-        * When this number reaches 0, we can handle the rename of the chunk
-        * folder and inform the client that the rotate is finished.
-        */
-       unsigned int nr_chan_rotate_pending;
-       struct {
-               /*
-                * When the rotation is in progress, the temporary path name is
-                * stored here. When the rotation is complete, the final path name
-                * is here and can be queried with the rotate_pending call.
-                */
-               char current_rotate_path[LTTNG_PATH_MAX];
-               /*
-                * The path where the consumer is currently writing after the first
-                * session rotation.
-                */
-               char active_tracing_path[LTTNG_PATH_MAX];
-       } rotation_chunk;
-       /*
-        * The timestamp of the beginning of the previous chunk. For the
-        * first chunk, this is the "lttng start" timestamp. For the
-        * subsequent ones, this copies the current_chunk_start_ts value when
-        * a new rotation starts. This value is used to set the name of a
-        * complete chunk directory, ex: "last_chunk_start_ts-now()".
-        */
-       time_t last_chunk_start_ts;
-       /*
-        * This is the timestamp when a new chunk starts. When a new rotation
-        * starts, we copy this value to last_chunk_start_ts and replace it
-        * with the current timestamp.
-        */
-       time_t current_chunk_start_ts;
-       /*
-        * Timer to check periodically if a relay has completed the last
-        * rotation.
-        */
-       bool rotate_relay_pending_timer_enabled;
-       timer_t rotate_relay_pending_timer;
+       bool rotation_pending_check_timer_enabled;
+       timer_t rotation_pending_check_timer;
        /* Timer to periodically rotate a session. */
-       bool rotate_timer_enabled;
-       timer_t rotate_timer;
+       bool rotation_schedule_timer_enabled;
+       timer_t rotation_schedule_timer;
+       /* Value for periodic rotations, 0 if disabled. */
        uint64_t rotate_timer_period;
-       /* Value for size-based rotation, 0 if disabled. */
+       /* Value for size-based rotations, 0 if disabled. */
        uint64_t rotate_size;
        /*
         * Keep a state if this session was rotated after the last stop command.
         * We only allow one rotation after a stop. At destroy, we also need to
-        * know if a rotation occured since the last stop to rename the current
-        * chunk.
+        * know if a rotation occurred since the last stop to rename the current
+        * chunk. After a stop followed by rotate, all subsequent clear
+        * (without prior start) will succeed, but will be effect-less.
         */
        bool rotated_after_last_stop;
+       /*
+        * Track whether the session was cleared after last stop. All subsequent
+        * clear (without prior start) will succeed, but will be effect-less. A
+        * subsequent rotate (without prior start) will return an error.
+        */
+       bool cleared_after_last_stop;
+       /*
+        * True if the session has had an explicit non-quiet rotation.
+        */
+       bool rotated;
        /*
         * Condition and trigger for size-based rotations.
         */
        struct lttng_condition *rotate_condition;
        struct lttng_trigger *rotate_trigger;
+       LTTNG_OPTIONAL(uint64_t) most_recent_chunk_id;
+       struct lttng_trace_chunk *current_trace_chunk;
+       struct lttng_trace_chunk *chunk_being_archived;
+       /* Current state of a rotation. */
+       enum lttng_rotation_state rotation_state;
+       bool quiet_rotation;
+       char *last_archived_chunk_name;
+       LTTNG_OPTIONAL(uint64_t) last_archived_chunk_id;
+       struct lttng_dynamic_array destroy_notifiers;
+       struct lttng_dynamic_array clear_notifiers;
+       /* Session base path override. Set non-null. */
+       char *base_path;
 };
 
 /* Prototypes */
-int session_create(char *name, uid_t uid, gid_t gid);
-int session_destroy(struct ltt_session *session);
-
+enum lttng_error_code session_create(const char *name, uid_t uid, gid_t gid,
+               struct ltt_session **out_session);
 void session_lock(struct ltt_session *session);
 void session_lock_list(void);
+int session_trylock_list(void);
 void session_unlock(struct ltt_session *session);
 void session_unlock_list(void);
 
+void session_destroy(struct ltt_session *session);
+int session_add_destroy_notifier(struct ltt_session *session,
+               ltt_session_destroy_notifier notifier, void *user_data);
+
+int session_add_clear_notifier(struct ltt_session *session,
+               ltt_session_clear_notifier notifier, void *user_data);
+void session_notify_clear(struct ltt_session *session);
+
+bool session_get(struct ltt_session *session);
+void session_put(struct ltt_session *session);
+
 enum consumer_dst_type session_get_consumer_destination_type(
                const struct ltt_session *session);
 const char *session_get_net_consumer_hostname(
@@ -222,11 +232,48 @@ const char *session_get_net_consumer_hostname(
 void session_get_net_consumer_ports(
                const struct ltt_session *session,
                uint16_t *control_port, uint16_t *data_port);
+struct lttng_trace_archive_location *session_get_trace_archive_location(
+               const struct ltt_session *session);
 
 struct ltt_session *session_find_by_name(const char *name);
 struct ltt_session *session_find_by_id(uint64_t id);
+
 struct ltt_session_list *session_get_list(void);
+void session_list_wait_empty(void);
 
 int session_access_ok(struct ltt_session *session, uid_t uid, gid_t gid);
 
+int session_reset_rotation_state(struct ltt_session *session,
+               enum lttng_rotation_state result);
+
+/* Create a new trace chunk object from the session's configuration. */
+struct lttng_trace_chunk *session_create_new_trace_chunk(
+               const struct ltt_session *session,
+               const struct consumer_output *consumer_output_override,
+               const char *session_base_path_override,
+               const char *chunk_name_override);
+
+/*
+ * Set `new_trace_chunk` as the session's current trace chunk. A reference
+ * to `new_trace_chunk` is acquired by the session. The chunk is created
+ * on remote peers (consumer and relay daemons).
+ *
+ * A reference to the session's current trace chunk is returned through
+ * `current_session_trace_chunk` on success.
+ */
+int session_set_trace_chunk(struct ltt_session *session,
+               struct lttng_trace_chunk *new_trace_chunk,
+               struct lttng_trace_chunk **current_session_trace_chunk);
+
+/*
+ * Close a chunk on the remote peers of a session. Has no effect on the
+ * ltt_session itself.
+ */
+int session_close_trace_chunk(struct ltt_session *session,
+               struct lttng_trace_chunk *trace_chunk,
+               enum lttng_trace_chunk_command_type close_command,
+               char *path);
+
+bool session_output_supports_trace_chunks(const struct ltt_session *session);
+
 #endif /* _LTT_SESSION_H */
This page took 0.033226 seconds and 5 git commands to generate.