5 * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
6 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
7 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * SPDX-License-Identifier: GPL-2.0-only
13 #include <common/hashtable/hashtable.hpp>
14 #include <common/optional.hpp>
15 #include <common/trace-chunk.hpp>
16 #include <common/uuid.hpp>
18 #include <lttng/constant.h>
23 #include <urcu/list.h>
27 * Represents a session for the relay point of view
29 struct relay_session {
31 * This session id is generated by the relay daemon to guarantee
32 * its uniqueness even when serving multiple session daemons.
33 * It is used to match a set of streams to their session.
37 * ID of the session in the session daemon's domain.
38 * This information is only provided by 2.11+ peers.
40 LTTNG_OPTIONAL(uint64_t) id_sessiond;
42 * Only provided by 2.11+ peers. However, the UUID is set to 'nil' in
45 lttng_uuid sessiond_uuid;
47 * Contains the creation time on the session daemon's end for 2.11+
48 * peers. Otherwise, this contains the session creation time on the
51 LTTNG_OPTIONAL(time_t) creation_time;
52 /* Must _not_ be empty for 2.4+ peers. */
53 char session_name[LTTNG_NAME_MAX];
54 char hostname[LTTNG_HOST_NAME_MAX];
55 char base_path[LTTNG_PATH_MAX];
57 * Session output path relative to relayd's output path.
58 * Will be empty when interacting with peers < 2.11 since their
59 * streams' path are expressed relative to the relay daemon's
62 char output_path[LTTNG_PATH_MAX];
65 /* Session in snapshot mode. */
69 * Session has no back reference to its connection because it
70 * has a life-time that can be longer than the consumer connection's
71 * life-time; a reference can still be held by the viewer
72 * connection through the viewer streams.
77 mutable pthread_mutex_t lock;
79 /* major/minor version used for this session. */
84 /* Tell if the session connection has been closed on the streaming side. */
85 bool connection_closed;
88 * Tell if the session is currently living in a exiting relayd and
89 * should be cleaned forcefully without waiting for pending data or
94 bool session_name_contains_creation_time;
95 /* Whether session has performed an explicit rotation. */
98 /* Contains ctf_trace object of that session indexed by path name. */
99 struct lttng_ht *ctf_traces_ht;
102 * This contains streams that are received on that connection.
103 * It's used to store them until we get the streams sent
104 * command. When this is received, we remove those streams from
105 * the list and publish them.
107 * Updates are protected by the recv_list_lock.
108 * Traversals are protected by RCU.
109 * recv_list_lock also protects stream_count.
111 struct cds_list_head recv_list; /* RCU list. */
112 uint32_t stream_count;
113 pthread_mutex_t recv_list_lock;
116 * Flag checked and exchanged with uatomic_cmpxchg to tell the
117 * viewer-side if new streams got added since the last check.
119 unsigned long new_streams;
122 * Node in the global session hash table.
124 struct lttng_ht_node_u64 session_n;
126 * Member of the session list in struct relay_viewer_session.
127 * Updates are protected by the relay_viewer_session
128 * session_list_lock. Traversals are protected by RCU.
130 struct cds_list_head viewer_session_node;
131 struct lttng_trace_chunk *current_trace_chunk;
132 struct lttng_trace_chunk *pending_closure_trace_chunk;
134 * Prevent live viewers from taking of copy of the chunk
135 * while new chunk has a temporary directory name.
137 bool ongoing_rotation;
138 struct lttng_directory_handle *output_directory;
139 struct rcu_head rcu_node; /* For call_rcu teardown. */
142 struct relay_session *session_create(const char *session_name,
143 const char *hostname,
144 const char *base_path,
147 const lttng_uuid& sessiond_uuid,
148 const uint64_t *id_sessiond,
149 const uint64_t *current_chunk_id,
150 const time_t *creation_time,
153 bool session_name_contains_creation_timestamp);
154 struct relay_session *session_get_by_id(uint64_t id);
155 bool session_get(struct relay_session *session);
156 void session_put(struct relay_session *session);
158 int session_close(struct relay_session *session);
159 int session_abort(struct relay_session *session);
161 bool session_has_ongoing_rotation(const struct relay_session *session);
163 void print_sessions(void);
165 #endif /* _SESSION_H */