Docs: clarify the meaning of the snapshot_mode flag in ltt_session
[lttng-tools.git] / src / bin / lttng-sessiond / session.h
index 1b40373e925a8336ebc3359f914ab10204beedb1..82e409521c440c621f06d5d46a86d8cc380e6d6c 100644 (file)
 #ifndef _LTT_SESSION_H
 #define _LTT_SESSION_H
 
+#include <limits.h>
+#include <stdbool.h>
 #include <urcu/list.h>
 
+#include <common/hashtable/hashtable.h>
+#include <lttng/rotation.h>
+#include <lttng/location.h>
+
+#include "snapshot.h"
 #include "trace-kernel.h"
-#include "trace-ust.h"
+#include "consumer.h"
+
+struct ltt_ust_session;
 
 /*
  * Tracing session list
@@ -38,12 +47,17 @@ 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
         * upon update and read of this counter.
         */
-       unsigned int next_uuid;
+       uint64_t next_uuid;
 
        /* Linked list head */
        struct cds_list_head head;
@@ -55,9 +69,10 @@ struct ltt_session_list {
  */
 struct ltt_session {
        char name[NAME_MAX];
-       char path[PATH_MAX];
+       char hostname[HOST_NAME_MAX]; /* Local hostname. */
        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
@@ -65,8 +80,11 @@ struct ltt_session {
         */
        pthread_mutex_t lock;
        struct cds_list_head list;
-       int enabled;    /* enabled/started flag */
-       unsigned int id;                /* session unique identifier */
+       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;
@@ -83,22 +101,153 @@ struct ltt_session {
         */
        struct consumer_output *consumer;
 
-       /* Indicates whether or not we have to spawn consumer(s) */
-       unsigned int start_consumer;
+       /* Did at least ONE start command has been triggered?. */
+       unsigned int has_been_started:1;
+       /*
+        * Is the session active? Start trace command sets this to 1 and the stop
+        * command reset it to 0.
+        */
+       unsigned int active:1;
+
+       /* Snapshot representation in a session. */
+       struct snapshot snapshot;
+       /* Indicate if the session has to output the traces or not. */
+       unsigned int output_traces;
+       /*
+        * 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;
+       /*
+        * Timer set when the session is created for live reading.
+        */
+       unsigned int live_timer;
+       /*
+        * Path where to keep the shared memory files.
+        */
+       char shm_path[PATH_MAX];
+       /*
+        * Node in ltt_sessions_ht_by_id.
+        */
+       struct lttng_ht_node_u64 node;
+       /*
+        * The current archive id corresponds to the number of session rotations
+        * that have occurred 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 considered pending between the time it is launched up
+        * until the moment when the data has been writen at the destination
+        * and the trace archive has been renamed.
+        *
+        * When tracing locally, only 'rotation_pending_local' is used since
+        * no remote checks are needed. However, when tracing to a relay daemon,
+        * a second check is needed to ensure that the data has been
+        * commited at the remote destination.
+        */
+       bool rotation_pending_local;
+       bool rotation_pending_relay;
+       /* Current state of a rotation. */
+       enum lttng_rotation_state rotation_state;
+       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 and/or consumer has completed
+        * the last rotation.
+        */
+       bool rotation_pending_check_timer_enabled;
+       timer_t rotation_pending_check_timer;
+       /* Timer to periodically rotate a session. */
+       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 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 occurred since the last stop to rename the current
+        * chunk.
+        */
+       bool rotated_after_last_stop;
+       /*
+        * Condition and trigger for size-based rotations.
+        */
+       struct lttng_condition *rotate_condition;
+       struct lttng_trigger *rotate_trigger;
 };
 
 /* Prototypes */
-int session_create(char *name, char *path, uid_t uid, gid_t gid);
-int session_destroy(struct ltt_session *session);
+int session_create(char *name, uid_t uid, gid_t gid);
 
 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);
 
-struct ltt_session *session_find_by_name(char *name);
+void session_destroy(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(
+               const struct ltt_session *session);
+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(
+               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);
+
 #endif /* _LTT_SESSION_H */
This page took 0.025169 seconds and 4 git commands to generate.