relayd comm: add base path to create session
[lttng-tools.git] / src / bin / lttng-relayd / session.c
CommitLineData
2f8f53af
DG
1/*
2 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
7591bab1 4 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
2f8f53af
DG
5 *
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.
9 *
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
13 * more details.
14 *
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.
18 */
19
6c1c0768 20#define _LGPL_SOURCE
2a174661 21#include <common/common.h>
a620c891 22#include <common/utils.h>
1e791a74 23#include <common/compat/uuid.h>
7591bab1 24#include <urcu/rculist.h>
2a174661
DG
25
26#include "ctf-trace.h"
a620c891 27#include "lttng-relayd.h"
2f8f53af 28#include "session.h"
23c8ff50 29#include "sessiond-trace-chunks.h"
a620c891 30#include "stream.h"
2a174661
DG
31
32/* Global session id used in the session creation. */
33static uint64_t last_relay_session_id;
7591bab1 34static pthread_mutex_t last_relay_session_id_lock = PTHREAD_MUTEX_INITIALIZER;
2a174661 35
1e791a74
JG
36static int session_set_anonymous_chunk(struct relay_session *session)
37{
38 int ret = 0;
39 struct lttng_trace_chunk *chunk = NULL;
40 enum lttng_trace_chunk_status status;
41 struct lttng_directory_handle output_directory;
4f00620d 42 const char *base_path = opt_output_path;
a620c891
JR
43
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");
50 ret = -1;
51 goto end;
52 }
53 }
1e791a74 54
a620c891 55 ret = lttng_directory_handle_init(&output_directory, base_path);
1e791a74
JG
56 if (ret) {
57 goto end;
58 }
59
60 chunk = lttng_trace_chunk_create_anonymous();
61 if (!chunk) {
62 goto end;
63 }
64
65 status = lttng_trace_chunk_set_credentials_current_user(chunk);
66 if (status != LTTNG_TRACE_CHUNK_STATUS_OK) {
67 ret = -1;
68 goto end;
69 }
70
71 status = lttng_trace_chunk_set_as_owner(chunk, &output_directory);
72 if (status != LTTNG_TRACE_CHUNK_STATUS_OK) {
73 ret = -1;
74 goto end;
75 }
76 session->current_trace_chunk = chunk;
77 chunk = NULL;
78end:
79 lttng_trace_chunk_put(chunk);
80 lttng_directory_handle_fini(&output_directory);
81 return ret;
82}
83
2a174661
DG
84/*
85 * Create a new session by assigning a new session ID.
86 *
87 * Return allocated session or else NULL.
88 */
7591bab1 89struct relay_session *session_create(const char *session_name,
6fa5fe7c 90 const char *hostname, const char *base_path,
db1da059
JG
91 uint32_t live_timer,
92 bool snapshot,
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,
97 uint32_t major,
46ef2188
MD
98 uint32_t minor,
99 bool session_name_contains_creation_time)
2a174661 100{
23c8ff50 101 int ret;
590f0324
JG
102 struct relay_session *session = NULL;
103
104 if (session_name && strstr(session_name, ".")) {
105 ERR("Illegal character in session name: \"%s\"",
106 session_name);
107 goto error;
108 }
109 if (base_path && strstr(base_path, "../")) {
110 ERR("Invalid session base path walks up the path hierarchy: \"%s\"",
111 base_path);
112 goto error;
113 }
114 if (hostname && strstr(hostname, ".")) {
115 ERR("Invalid character in hostname: \"%s\"",
116 hostname);
117 goto error;
118 }
2a174661
DG
119
120 session = zmalloc(sizeof(*session));
121 if (!session) {
1e791a74 122 PERROR("Failed to allocate session");
2a174661
DG
123 goto error;
124 }
bb5d54e7
MD
125 if (lttng_strncpy(session->session_name, session_name,
126 sizeof(session->session_name))) {
1e791a74 127 WARN("Session name exceeds maximal allowed length");
bb5d54e7
MD
128 goto error;
129 }
130 if (lttng_strncpy(session->hostname, hostname,
131 sizeof(session->hostname))) {
1e791a74 132 WARN("Hostname exceeds maximal allowed length");
bb5d54e7
MD
133 goto error;
134 }
6fa5fe7c
MD
135 if (lttng_strncpy(session->base_path, base_path,
136 sizeof(session->base_path))) {
137 WARN("Base path exceeds maximal allowed length");
138 goto error;
139 }
46ef2188
MD
140 if (creation_time) {
141 LTTNG_OPTIONAL_SET(&session->creation_time, *creation_time);
142 }
143 session->session_name_contains_creation_time =
144 session_name_contains_creation_time;
6fa5fe7c 145
2a174661
DG
146 session->ctf_traces_ht = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
147 if (!session->ctf_traces_ht) {
2a174661
DG
148 goto error;
149 }
150
7591bab1 151 pthread_mutex_lock(&last_relay_session_id_lock);
2a174661 152 session->id = ++last_relay_session_id;
7591bab1
MD
153 pthread_mutex_unlock(&last_relay_session_id_lock);
154
155 session->major = major;
156 session->minor = minor;
2a174661 157 lttng_ht_node_init_u64(&session->session_n, session->id);
7591bab1
MD
158 urcu_ref_init(&session->ref);
159 CDS_INIT_LIST_HEAD(&session->recv_list);
160 pthread_mutex_init(&session->lock, NULL);
7591bab1
MD
161 pthread_mutex_init(&session->recv_list_lock, NULL);
162
7591bab1
MD
163 session->live_timer = live_timer;
164 session->snapshot = snapshot;
23c8ff50
JG
165 lttng_uuid_copy(session->sessiond_uuid, sessiond_uuid);
166
1e791a74
JG
167 if (id_sessiond) {
168 LTTNG_OPTIONAL_SET(&session->id_sessiond, *id_sessiond);
169 }
170
23c8ff50
JG
171 ret = sessiond_trace_chunk_registry_session_created(
172 sessiond_trace_chunk_registry, sessiond_uuid);
173 if (ret) {
174 goto error;
175 }
7591bab1 176
1e791a74
JG
177 if (id_sessiond && current_chunk_id) {
178 session->current_trace_chunk =
179 sessiond_trace_chunk_registry_get_chunk(
180 sessiond_trace_chunk_registry,
181 session->sessiond_uuid,
182 session->id_sessiond.value,
183 *current_chunk_id);
184 if (!session->current_trace_chunk) {
185 char uuid_str[UUID_STR_LEN];
186
187 lttng_uuid_to_str(sessiond_uuid, uuid_str);
188 ERR("Could not find trace chunk: sessiond = {%s}, sessiond session id = %" PRIu64 ", trace chunk id = %" PRIu64,
189 uuid_str, *id_sessiond,
190 *current_chunk_id);
191 }
192 } else if (!id_sessiond) {
193 /*
194 * Pre-2.11 peers will not announce trace chunks. An
195 * anonymous trace chunk which will remain set for the
196 * duration of the session is created.
197 */
198 ret = session_set_anonymous_chunk(session);
199 if (ret) {
200 goto error;
201 }
202 }
203
7591bab1 204 lttng_ht_add_unique_u64(sessions_ht, &session->session_n);
bb5d54e7 205 return session;
2a174661
DG
206
207error:
1e791a74 208 session_put(session);
bb5d54e7 209 return NULL;
2a174661 210}
2f8f53af 211
7591bab1
MD
212/* Should be called with RCU read-side lock held. */
213bool session_get(struct relay_session *session)
214{
ce4d4083 215 return urcu_ref_get_unless_zero(&session->ref);
7591bab1
MD
216}
217
2f8f53af 218/*
7591bab1
MD
219 * Lookup a session within the session hash table using the session id
220 * as key. A session reference is taken when a session is returned.
221 * session_put() must be called on that session.
2f8f53af
DG
222 *
223 * Return session or NULL if not found.
224 */
7591bab1 225struct relay_session *session_get_by_id(uint64_t id)
2f8f53af
DG
226{
227 struct relay_session *session = NULL;
2a174661 228 struct lttng_ht_node_u64 *node;
2f8f53af
DG
229 struct lttng_ht_iter iter;
230
7591bab1
MD
231 rcu_read_lock();
232 lttng_ht_lookup(sessions_ht, &id, &iter);
2a174661 233 node = lttng_ht_iter_get_node_u64(&iter);
2f8f53af 234 if (!node) {
2a174661 235 DBG("Session find by ID %" PRIu64 " id NOT found", id);
2f8f53af
DG
236 goto end;
237 }
238 session = caa_container_of(node, struct relay_session, session_n);
2a174661 239 DBG("Session find by ID %" PRIu64 " id found", id);
7591bab1
MD
240 if (!session_get(session)) {
241 session = NULL;
242 }
2f8f53af 243end:
7591bab1 244 rcu_read_unlock();
2f8f53af
DG
245 return session;
246}
2a174661 247
7591bab1
MD
248static void rcu_destroy_session(struct rcu_head *rcu_head)
249{
250 struct relay_session *session =
251 caa_container_of(rcu_head, struct relay_session,
252 rcu_node);
49e614cb
MD
253 /*
254 * Since each trace has a reference on the session, it means
255 * that if we are at the point where we teardown the session, no
256 * trace belonging to that session exist at this point.
257 * Calling lttng_ht_destroy in call_rcu worker thread so we
258 * don't hold the RCU read-side lock while calling it.
259 */
260 lttng_ht_destroy(session->ctf_traces_ht);
7591bab1
MD
261 free(session);
262}
263
2a174661
DG
264/*
265 * Delete session from the given hash table.
266 *
267 * Return lttng ht del error code being 0 on success and 1 on failure.
268 */
7591bab1 269static int session_delete(struct relay_session *session)
2a174661
DG
270{
271 struct lttng_ht_iter iter;
272
2a174661 273 iter.iter.node = &session->session_n.node;
7591bab1 274 return lttng_ht_del(sessions_ht, &iter);
2a174661
DG
275}
276
7591bab1
MD
277
278static void destroy_session(struct relay_session *session)
279{
280 int ret;
281
282 ret = session_delete(session);
283 assert(!ret);
639ddf68 284 lttng_trace_chunk_put(session->current_trace_chunk);
c35f9726 285 session->current_trace_chunk = NULL;
62bad3bf
JG
286 lttng_trace_chunk_put(session->pending_closure_trace_chunk);
287 session->pending_closure_trace_chunk = NULL;
23c8ff50
JG
288 ret = sessiond_trace_chunk_registry_session_destroyed(
289 sessiond_trace_chunk_registry, session->sessiond_uuid);
290 assert(!ret);
7591bab1
MD
291 call_rcu(&session->rcu_node, rcu_destroy_session);
292}
293
294void session_release(struct urcu_ref *ref)
2a174661 295{
7591bab1
MD
296 struct relay_session *session =
297 caa_container_of(ref, struct relay_session, ref);
2a174661 298
7591bab1
MD
299 destroy_session(session);
300}
2a174661 301
7591bab1
MD
302void session_put(struct relay_session *session)
303{
304 rcu_read_lock();
7591bab1 305 urcu_ref_put(&session->ref, session_release);
7591bab1 306 rcu_read_unlock();
2a174661
DG
307}
308
7591bab1 309int session_close(struct relay_session *session)
2a174661
DG
310{
311 int ret = 0;
7591bab1
MD
312 struct ctf_trace *trace;
313 struct lttng_ht_iter iter;
314 struct relay_stream *stream;
315
316 pthread_mutex_lock(&session->lock);
317 DBG("closing session %" PRIu64 ": is conn already closed %d",
318 session->id, session->connection_closed);
7591bab1 319 session->connection_closed = true;
7591bab1 320 pthread_mutex_unlock(&session->lock);
2a174661 321
7591bab1
MD
322 rcu_read_lock();
323 cds_lfht_for_each_entry(session->ctf_traces_ht->ht,
324 &iter.iter, trace, node.node) {
325 ret = ctf_trace_close(trace);
326 if (ret) {
327 goto rcu_unlock;
2a174661
DG
328 }
329 }
7591bab1
MD
330 cds_list_for_each_entry_rcu(stream, &session->recv_list,
331 recv_node) {
bda7c7b9
JG
332 /* Close streams which have not been published yet. */
333 try_stream_close(stream);
7591bab1
MD
334 }
335rcu_unlock:
336 rcu_read_unlock();
337 if (ret) {
338 return ret;
339 }
340 /* Put self-reference from create. */
341 session_put(session);
342 return ret;
2a174661
DG
343}
344
98ba050e
JR
345int session_abort(struct relay_session *session)
346{
347 int ret = 0;
348
349 if (!session) {
350 return 0;
351 }
352
353 pthread_mutex_lock(&session->lock);
354 DBG("aborting session %" PRIu64, session->id);
98ba050e 355 session->aborted = true;
98ba050e
JR
356 pthread_mutex_unlock(&session->lock);
357 return ret;
358}
359
7591bab1 360void print_sessions(void)
2a174661 361{
2a174661 362 struct lttng_ht_iter iter;
7591bab1 363 struct relay_session *session;
2a174661 364
ce3f3ba3
JG
365 if (!sessions_ht) {
366 return;
367 }
368
2a174661 369 rcu_read_lock();
7591bab1
MD
370 cds_lfht_for_each_entry(sessions_ht->ht, &iter.iter, session,
371 session_n.node) {
372 if (!session_get(session)) {
373 continue;
374 }
375 DBG("session %p refcount %ld session %" PRIu64,
376 session,
377 session->ref.refcount,
378 session->id);
379 session_put(session);
2a174661 380 }
2a174661 381 rcu_read_unlock();
2a174661 382}
This page took 0.066904 seconds and 5 git commands to generate.