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
16 #include <urcu/list.h>
19 #include <lttng/constant.h>
20 #include <common/hashtable/hashtable.h>
21 #include <common/uuid.h>
22 #include <common/trace-chunk.h>
23 #include <common/optional.h>
26 * Represents a session for the relay point of view
28 struct relay_session
{
30 * This session id is generated by the relay daemon to guarantee
31 * its uniqueness even when serving multiple session daemons.
32 * It is used to match a set of streams to their session.
36 * ID of the session in the session daemon's domain.
37 * This information is only provided by 2.11+ peers.
39 LTTNG_OPTIONAL(uint64_t) id_sessiond
;
41 * Only provided by 2.11+ peers. However, the UUID is set to 'nil' in
44 lttng_uuid sessiond_uuid
;
46 * Contains the creation time on the session daemon's end for 2.11+
47 * peers. Otherwise, this contains the session creation time on the
50 LTTNG_OPTIONAL(time_t) creation_time
;
51 /* Must _not_ be empty for 2.4+ peers. */
52 char session_name
[LTTNG_NAME_MAX
];
53 char hostname
[LTTNG_HOST_NAME_MAX
];
54 char base_path
[LTTNG_PATH_MAX
];
56 * Session output path relative to relayd's output path.
57 * Will be empty when interacting with peers < 2.11 since their
58 * streams' path are expressed relative to the relay daemon's
61 char output_path
[LTTNG_PATH_MAX
];
64 /* Session in snapshot mode. */
68 * Session has no back reference to its connection because it
69 * has a life-time that can be longer than the consumer connection's
70 * life-time; a reference can still be held by the viewer
71 * connection through the viewer streams.
78 /* major/minor version used for this session. */
83 /* Tell if the session connection has been closed on the streaming side. */
84 bool connection_closed
;
87 * Tell if the session is currently living in a exiting relayd and
88 * should be cleaned forcefully without waiting for pending data or
93 bool session_name_contains_creation_time
;
94 /* Whether session has performed an explicit rotation. */
97 /* Contains ctf_trace object of that session indexed by path name. */
98 struct lttng_ht
*ctf_traces_ht
;
101 * This contains streams that are received on that connection.
102 * It's used to store them until we get the streams sent
103 * command. When this is received, we remove those streams from
104 * the list and publish them.
106 * Updates are protected by the recv_list_lock.
107 * Traversals are protected by RCU.
108 * recv_list_lock also protects stream_count.
110 struct cds_list_head recv_list
; /* RCU list. */
111 uint32_t stream_count
;
112 pthread_mutex_t recv_list_lock
;
115 * Flag checked and exchanged with uatomic_cmpxchg to tell the
116 * viewer-side if new streams got added since the last check.
118 unsigned long new_streams
;
121 * Node in the global session hash table.
123 struct lttng_ht_node_u64 session_n
;
125 * Member of the session list in struct relay_viewer_session.
126 * Updates are protected by the relay_viewer_session
127 * session_list_lock. Traversals are protected by RCU.
129 struct cds_list_head viewer_session_node
;
130 struct lttng_trace_chunk
*current_trace_chunk
;
131 struct lttng_trace_chunk
*pending_closure_trace_chunk
;
133 * Prevent live viewers from taking of copy of the chunk
134 * while new chunk has a temporary directory name.
136 bool ongoing_rotation
;
137 struct lttng_directory_handle
*output_directory
;
138 struct rcu_head rcu_node
; /* For call_rcu teardown. */
141 struct relay_session
*session_create(const char *session_name
,
142 const char *hostname
, const char *base_path
,
145 const lttng_uuid sessiond_uuid
,
146 const uint64_t *id_sessiond
,
147 const uint64_t *current_chunk_id
,
148 const time_t *creation_time
,
151 bool session_name_contains_creation_timestamp
);
152 struct relay_session
*session_get_by_id(uint64_t id
);
153 bool session_get(struct relay_session
*session
);
154 void session_put(struct relay_session
*session
);
156 int session_close(struct relay_session
*session
);
157 int session_abort(struct relay_session
*session
);
159 void print_sessions(void);
161 #endif /* _SESSION_H */