+#ifndef _SESSION_H
+#define _SESSION_H
+
/*
- * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
- * David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
+ * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License, version 2 only, as
- * published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
*
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef _SESSION_H
-#define _SESSION_H
-
#include <limits.h>
#include <inttypes.h>
#include <pthread.h>
+#include <urcu/list.h>
+#include <urcu/ref.h>
+#include <lttng/constant.h>
#include <common/hashtable/hashtable.h>
+#include <common/uuid.h>
+#include <common/trace-chunk.h>
+#include <common/optional.h>
/*
* Represents a session for the relay point of view
*/
struct relay_session {
/*
- * This session id is used to identify a set of stream to a tracing session
- * but also make sure we have a unique session id associated with a session
- * daemon which can provide multiple data source.
+ * This session id is generated by the relay daemon to guarantee
+ * its uniqueness even when serving multiple session daemons.
+ * It is used to match a set of streams to their session.
*/
uint64_t id;
- struct lttcomm_sock *sock;
- char session_name[NAME_MAX];
- char hostname[HOST_NAME_MAX];
+ /*
+ * ID of the session in the session daemon's domain.
+ * This information is only provided by 2.11+ peers.
+ */
+ LTTNG_OPTIONAL(uint64_t) id_sessiond;
+ /*
+ * Only provided by 2.11+ peers. However, the UUID is set to 'nil' in
+ * the other cases.
+ */
+ lttng_uuid sessiond_uuid;
+ /*
+ * Contains the creation time on the session daemon's end for 2.11+
+ * peers. Otherwise, this contains the session creation time on the
+ * relay daemon's end.
+ */
+ LTTNG_OPTIONAL(time_t) creation_time;
+ /* Must _not_ be empty for 2.4+ peers. */
+ char session_name[LTTNG_NAME_MAX];
+ char hostname[LTTNG_HOST_NAME_MAX];
+ char base_path[LTTNG_PATH_MAX];
+ /*
+ * Session output path relative to relayd's output path.
+ * Will be empty when interacting with peers < 2.11 since their
+ * streams' path are expressed relative to the relay daemon's
+ * output path.
+ */
+ char output_path[LTTNG_PATH_MAX];
uint32_t live_timer;
- struct lttng_ht_node_ulong session_n;
- struct rcu_head rcu_node;
- uint32_t viewer_attached;
- uint32_t stream_count;
- /* Tell if this session is for a snapshot or not. */
- unsigned int snapshot:1;
+
+ /* Session in snapshot mode. */
+ bool snapshot;
/*
- * Indicate version protocol for this session. This is especially useful
- * for the data thread that has no idea which version it operates on since
- * linking control/data sockets is non trivial.
+ * Session has no back reference to its connection because it
+ * has a life-time that can be longer than the consumer connection's
+ * life-time; a reference can still be held by the viewer
+ * connection through the viewer streams.
*/
- uint64_t minor;
- uint64_t major;
+
+ struct urcu_ref ref;
+
+ pthread_mutex_t lock;
+
+ /* major/minor version used for this session. */
+ uint32_t major;
+ uint32_t minor;
+
+ bool viewer_attached;
+ /* Tell if the session connection has been closed on the streaming side. */
+ bool connection_closed;
+
+ /*
+ * Tell if the session is currently living in a exiting relayd and
+ * should be cleaned forcefully without waiting for pending data or
+ * pending ctrl data.
+ */
+ bool aborted;
+
+ bool session_name_contains_creation_time;
+ /* Whether session has performed an explicit rotation. */
+ bool has_rotated;
+
+ /* Contains ctf_trace object of that session indexed by path name. */
+ struct lttng_ht *ctf_traces_ht;
+
+ /*
+ * This contains streams that are received on that connection.
+ * It's used to store them until we get the streams sent
+ * command. When this is received, we remove those streams from
+ * the list and publish them.
+ *
+ * Updates are protected by the recv_list_lock.
+ * Traversals are protected by RCU.
+ * recv_list_lock also protects stream_count.
+ */
+ struct cds_list_head recv_list; /* RCU list. */
+ uint32_t stream_count;
+ pthread_mutex_t recv_list_lock;
+
/*
* Flag checked and exchanged with uatomic_cmpxchg to tell the
* viewer-side if new streams got added since the last check.
unsigned long new_streams;
/*
- * Used to synchronize the process where we flag every streams readiness
- * for the viewer when the streams_sent message is received and the viewer
- * process of sending those streams.
+ * Node in the global session hash table.
+ */
+ struct lttng_ht_node_u64 session_n;
+ /*
+ * Member of the session list in struct relay_viewer_session.
+ * Updates are protected by the relay_viewer_session
+ * session_list_lock. Traversals are protected by RCU.
*/
- pthread_mutex_t viewer_ready_lock;
+ struct cds_list_head viewer_session_node;
+ struct lttng_trace_chunk *current_trace_chunk;
+ struct lttng_trace_chunk *pending_closure_trace_chunk;
+ /*
+ * Prevent live viewers from taking of copy of the chunk
+ * while new chunk has a temporary directory name.
+ */
+ bool ongoing_rotation;
+ struct lttng_directory_handle *output_directory;
+ struct rcu_head rcu_node; /* For call_rcu teardown. */
};
-struct relay_session *session_find_by_id(struct lttng_ht *ht, uint64_t id);
+struct relay_session *session_create(const char *session_name,
+ const char *hostname, const char *base_path,
+ uint32_t live_timer,
+ bool snapshot,
+ const lttng_uuid sessiond_uuid,
+ const uint64_t *id_sessiond,
+ const uint64_t *current_chunk_id,
+ const time_t *creation_time,
+ uint32_t major,
+ uint32_t minor,
+ bool session_name_contains_creation_timestamp);
+struct relay_session *session_get_by_id(uint64_t id);
+bool session_get(struct relay_session *session);
+void session_put(struct relay_session *session);
+
+int session_close(struct relay_session *session);
+int session_abort(struct relay_session *session);
+
+void print_sessions(void);
#endif /* _SESSION_H */