2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License, version 2 only, as
8 * published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <common/common.h>
22 #include <common/utils.h>
23 #include <common/compat/uuid.h>
24 #include <urcu/rculist.h>
26 #include "ctf-trace.h"
27 #include "lttng-relayd.h"
29 #include "sessiond-trace-chunks.h"
32 /* Global session id used in the session creation. */
33 static uint64_t last_relay_session_id
;
34 static pthread_mutex_t last_relay_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
36 static int session_set_anonymous_chunk(struct relay_session
*session
)
39 struct lttng_trace_chunk
*chunk
= NULL
;
40 enum lttng_trace_chunk_status status
;
41 struct lttng_directory_handle output_directory
;
42 const char *base_path
= opt_output_path
;
44 if (base_path
== NULL
) {
45 /* No output path defined */
46 base_path
= utils_get_home_dir();
47 if (base_path
== NULL
) {
48 ERR("Home path not found.\n \
49 Please specify an output path using -o, --output PATH");
55 ret
= lttng_directory_handle_init(&output_directory
, base_path
);
60 chunk
= lttng_trace_chunk_create_anonymous();
65 status
= lttng_trace_chunk_set_credentials_current_user(chunk
);
66 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
71 status
= lttng_trace_chunk_set_as_owner(chunk
, &output_directory
);
72 if (status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
76 session
->current_trace_chunk
= chunk
;
79 lttng_trace_chunk_put(chunk
);
80 lttng_directory_handle_fini(&output_directory
);
85 * Create a new session by assigning a new session ID.
87 * Return allocated session or else NULL.
89 struct relay_session
*session_create(const char *session_name
,
90 const char *hostname
, const char *base_path
,
93 const lttng_uuid sessiond_uuid
,
94 const uint64_t *id_sessiond
,
95 const uint64_t *current_chunk_id
,
96 const time_t *creation_time
,
101 struct relay_session
*session
= NULL
;
103 if (session_name
&& strstr(session_name
, ".")) {
104 ERR("Illegal character in session name: \"%s\"",
108 if (base_path
&& strstr(base_path
, "../")) {
109 ERR("Invalid session base path walks up the path hierarchy: \"%s\"",
113 if (hostname
&& strstr(hostname
, ".")) {
114 ERR("Invalid character in hostname: \"%s\"",
119 session
= zmalloc(sizeof(*session
));
121 PERROR("Failed to allocate session");
124 if (lttng_strncpy(session
->session_name
, session_name
,
125 sizeof(session
->session_name
))) {
126 WARN("Session name exceeds maximal allowed length");
129 if (lttng_strncpy(session
->hostname
, hostname
,
130 sizeof(session
->hostname
))) {
131 WARN("Hostname exceeds maximal allowed length");
134 if (lttng_strncpy(session
->base_path
, base_path
,
135 sizeof(session
->base_path
))) {
136 WARN("Base path exceeds maximal allowed length");
140 session
->ctf_traces_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
141 if (!session
->ctf_traces_ht
) {
145 pthread_mutex_lock(&last_relay_session_id_lock
);
146 session
->id
= ++last_relay_session_id
;
147 pthread_mutex_unlock(&last_relay_session_id_lock
);
149 session
->major
= major
;
150 session
->minor
= minor
;
151 lttng_ht_node_init_u64(&session
->session_n
, session
->id
);
152 urcu_ref_init(&session
->ref
);
153 CDS_INIT_LIST_HEAD(&session
->recv_list
);
154 pthread_mutex_init(&session
->lock
, NULL
);
155 pthread_mutex_init(&session
->recv_list_lock
, NULL
);
157 session
->live_timer
= live_timer
;
158 session
->snapshot
= snapshot
;
159 lttng_uuid_copy(session
->sessiond_uuid
, sessiond_uuid
);
162 LTTNG_OPTIONAL_SET(&session
->id_sessiond
, *id_sessiond
);
165 ret
= sessiond_trace_chunk_registry_session_created(
166 sessiond_trace_chunk_registry
, sessiond_uuid
);
171 if (id_sessiond
&& current_chunk_id
) {
172 session
->current_trace_chunk
=
173 sessiond_trace_chunk_registry_get_chunk(
174 sessiond_trace_chunk_registry
,
175 session
->sessiond_uuid
,
176 session
->id_sessiond
.value
,
178 if (!session
->current_trace_chunk
) {
179 char uuid_str
[UUID_STR_LEN
];
181 lttng_uuid_to_str(sessiond_uuid
, uuid_str
);
182 ERR("Could not find trace chunk: sessiond = {%s}, sessiond session id = %" PRIu64
", trace chunk id = %" PRIu64
,
183 uuid_str
, *id_sessiond
,
186 } else if (!id_sessiond
) {
188 * Pre-2.11 peers will not announce trace chunks. An
189 * anonymous trace chunk which will remain set for the
190 * duration of the session is created.
192 ret
= session_set_anonymous_chunk(session
);
198 lttng_ht_add_unique_u64(sessions_ht
, &session
->session_n
);
200 LTTNG_OPTIONAL_SET(&session
->creation_time
, *creation_time
);
205 session_put(session
);
209 /* Should be called with RCU read-side lock held. */
210 bool session_get(struct relay_session
*session
)
212 return urcu_ref_get_unless_zero(&session
->ref
);
216 * Lookup a session within the session hash table using the session id
217 * as key. A session reference is taken when a session is returned.
218 * session_put() must be called on that session.
220 * Return session or NULL if not found.
222 struct relay_session
*session_get_by_id(uint64_t id
)
224 struct relay_session
*session
= NULL
;
225 struct lttng_ht_node_u64
*node
;
226 struct lttng_ht_iter iter
;
229 lttng_ht_lookup(sessions_ht
, &id
, &iter
);
230 node
= lttng_ht_iter_get_node_u64(&iter
);
232 DBG("Session find by ID %" PRIu64
" id NOT found", id
);
235 session
= caa_container_of(node
, struct relay_session
, session_n
);
236 DBG("Session find by ID %" PRIu64
" id found", id
);
237 if (!session_get(session
)) {
245 static void rcu_destroy_session(struct rcu_head
*rcu_head
)
247 struct relay_session
*session
=
248 caa_container_of(rcu_head
, struct relay_session
,
251 * Since each trace has a reference on the session, it means
252 * that if we are at the point where we teardown the session, no
253 * trace belonging to that session exist at this point.
254 * Calling lttng_ht_destroy in call_rcu worker thread so we
255 * don't hold the RCU read-side lock while calling it.
257 lttng_ht_destroy(session
->ctf_traces_ht
);
262 * Delete session from the given hash table.
264 * Return lttng ht del error code being 0 on success and 1 on failure.
266 static int session_delete(struct relay_session
*session
)
268 struct lttng_ht_iter iter
;
270 iter
.iter
.node
= &session
->session_n
.node
;
271 return lttng_ht_del(sessions_ht
, &iter
);
275 static void destroy_session(struct relay_session
*session
)
279 ret
= session_delete(session
);
281 lttng_trace_chunk_put(session
->current_trace_chunk
);
282 session
->current_trace_chunk
= NULL
;
283 lttng_trace_chunk_put(session
->pending_closure_trace_chunk
);
284 session
->pending_closure_trace_chunk
= NULL
;
285 ret
= sessiond_trace_chunk_registry_session_destroyed(
286 sessiond_trace_chunk_registry
, session
->sessiond_uuid
);
288 call_rcu(&session
->rcu_node
, rcu_destroy_session
);
291 void session_release(struct urcu_ref
*ref
)
293 struct relay_session
*session
=
294 caa_container_of(ref
, struct relay_session
, ref
);
296 destroy_session(session
);
299 void session_put(struct relay_session
*session
)
302 urcu_ref_put(&session
->ref
, session_release
);
306 int session_close(struct relay_session
*session
)
309 struct ctf_trace
*trace
;
310 struct lttng_ht_iter iter
;
311 struct relay_stream
*stream
;
313 pthread_mutex_lock(&session
->lock
);
314 DBG("closing session %" PRIu64
": is conn already closed %d",
315 session
->id
, session
->connection_closed
);
316 session
->connection_closed
= true;
317 pthread_mutex_unlock(&session
->lock
);
320 cds_lfht_for_each_entry(session
->ctf_traces_ht
->ht
,
321 &iter
.iter
, trace
, node
.node
) {
322 ret
= ctf_trace_close(trace
);
327 cds_list_for_each_entry_rcu(stream
, &session
->recv_list
,
329 /* Close streams which have not been published yet. */
330 try_stream_close(stream
);
337 /* Put self-reference from create. */
338 session_put(session
);
342 int session_abort(struct relay_session
*session
)
350 pthread_mutex_lock(&session
->lock
);
351 DBG("aborting session %" PRIu64
, session
->id
);
352 session
->aborted
= true;
353 pthread_mutex_unlock(&session
->lock
);
357 void print_sessions(void)
359 struct lttng_ht_iter iter
;
360 struct relay_session
*session
;
367 cds_lfht_for_each_entry(sessions_ht
->ht
, &iter
.iter
, session
,
369 if (!session_get(session
)) {
372 DBG("session %p refcount %ld session %" PRIu64
,
374 session
->ref
.refcount
,
376 session_put(session
);