X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng-relayd%2Fsession.c;h=9f690d3af68d5eaf0a319b2c8439534587249101;hp=605931d5bd82ed449143de9b6f9c6b870bb59a2b;hb=9642d9bf3d80d6a45ecdd107ff12c676b5ef0870;hpb=46ef21888c975515837d5dab104c938c424792ed diff --git a/src/bin/lttng-relayd/session.c b/src/bin/lttng-relayd/session.c index 605931d5b..9f690d3af 100644 --- a/src/bin/lttng-relayd/session.c +++ b/src/bin/lttng-relayd/session.c @@ -1,59 +1,217 @@ /* - * Copyright (C) 2013 - Julien Desfossez - * David Goulet - * 2015 - Mathieu Desnoyers + * Copyright (C) 2013 Julien Desfossez + * Copyright (C) 2013 David Goulet + * Copyright (C) 2015 Mathieu Desnoyers * - * 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. */ #define _LGPL_SOURCE #include +#include +#include +#include #include -#include +#include #include +#include + #include "ctf-trace.h" #include "lttng-relayd.h" #include "session.h" #include "sessiond-trace-chunks.h" #include "stream.h" +#include +#include "utils.h" /* Global session id used in the session creation. */ static uint64_t last_relay_session_id; static pthread_mutex_t last_relay_session_id_lock = PTHREAD_MUTEX_INITIALIZER; -static int session_set_anonymous_chunk(struct relay_session *session) +static int init_session_output_path_group_by_host(struct relay_session *session) { + /* + * session_directory: + * + * if base_path is \0' + * hostname/session_name + * else + * hostname/base_path + */ + char *session_directory = NULL; int ret = 0; - struct lttng_trace_chunk *chunk = NULL; - enum lttng_trace_chunk_status status; - struct lttng_directory_handle output_directory; - const char *base_path = opt_output_path; - - if (base_path == NULL) { - /* No output path defined */ - base_path = utils_get_home_dir(); - if (base_path == NULL) { - ERR("Home path not found.\n \ - Please specify an output path using -o, --output PATH"); + + if (session->output_path[0] != '\0') { + goto end; + } + /* + * If base path is set, it overrides the session name for the + * session relative base path. No timestamp is appended if the + * base path is overridden. + * + * If the session name already contains the creation time (e.g. + * auto-, don't append yet another timestamp after + * the session name in the generated path. + * + * Otherwise, generate the path with session_name-. + */ + if (session->base_path[0] != '\0') { + ret = asprintf(&session_directory, "%s/%s", session->hostname, + session->base_path); + } else if (session->session_name_contains_creation_time) { + ret = asprintf(&session_directory, "%s/%s", session->hostname, + session->session_name); + } else { + char session_creation_datetime[DATETIME_STR_LEN]; + + ret = time_to_datetime_str( + LTTNG_OPTIONAL_GET(session->creation_time), + session_creation_datetime, + sizeof(session_creation_datetime)); + if (ret) { + ERR("Failed to format session creation timestamp while initializing session output directory handle"); ret = -1; goto end; } + + ret = asprintf(&session_directory, "%s/%s-%s", + session->hostname, session->session_name, + session_creation_datetime); + } + if (ret < 0) { + PERROR("Failed to format session directory name"); + goto end; + } + + if (strlen(session_directory) >= LTTNG_PATH_MAX) { + ERR("Session output directory exceeds maximal length"); + ret = -1; + goto end; + } + strcpy(session->output_path, session_directory); + ret = 0; + +end: + free(session_directory); + return ret; +} + +static int init_session_output_path_group_by_session( + struct relay_session *session) +{ + /* + * session_directory: + * + * session_name/hostname-creation_time/base_path + * + * For session name including the datetime, use it as the complete name + * since. Do not perform modification on it since the datetime is an + * integral part of the name and how a user identify a session. + */ + int ret = 0; + char *session_directory = NULL; + char creation_datetime[DATETIME_STR_LEN]; + + if (session->output_path[0] != '\0') { + /* output_path as been generated already */ + goto end; + } + + ret = time_to_datetime_str(LTTNG_OPTIONAL_GET(session->creation_time), + creation_datetime, sizeof(creation_datetime)); + if (ret) { + ERR("Failed to format session creation timestamp while initializing session output directory handle"); + ret = -1; + goto end; + } + + ret = asprintf(&session_directory, "%s/%s-%s%s%s", + session->session_name, session->hostname, + creation_datetime, + session->base_path[0] != '\0' ? "/" : "", + session->base_path); + if (ret < 0) { + PERROR("Failed to format session directory name"); + goto end; + } + + if (strlen(session_directory) >= LTTNG_PATH_MAX) { + ERR("Session output directory exceeds maximal length"); + ret = -1; + goto end; + } + + strcpy(session->output_path, session_directory); + ret = 0; + +end: + free(session_directory); + return ret; +} + +static int init_session_output_path(struct relay_session *session) +{ + int ret; + + switch (opt_group_output_by) { + case RELAYD_GROUP_OUTPUT_BY_HOST: + ret = init_session_output_path_group_by_host(session); + break; + case RELAYD_GROUP_OUTPUT_BY_SESSION: + ret = init_session_output_path_group_by_session(session); + break; + case RELAYD_GROUP_OUTPUT_BY_UNKNOWN: + default: + abort(); + break; + } + + return ret; +} + +static struct lttng_directory_handle *session_create_output_directory_handle( + struct relay_session *session) +{ + int ret; + /* + * relayd_output_path/session_directory + * e.g. /home/user/lttng-traces/hostname/session_name + */ + char *full_session_path = NULL; + struct lttng_directory_handle *handle = NULL; + + pthread_mutex_lock(&session->lock); + full_session_path = create_output_path(session->output_path); + if (!full_session_path) { + goto end; } - ret = lttng_directory_handle_init(&output_directory, base_path); + ret = utils_mkdir_recursive( + full_session_path, S_IRWXU | S_IRWXG, -1, -1); if (ret) { + ERR("Failed to create session output path \"%s\"", + full_session_path); + goto end; + } + + handle = fd_tracker_create_directory_handle(the_fd_tracker, full_session_path); +end: + pthread_mutex_unlock(&session->lock); + free(full_session_path); + return handle; +} + +static int session_set_anonymous_chunk(struct relay_session *session) +{ + int ret = 0; + struct lttng_trace_chunk *chunk = NULL; + enum lttng_trace_chunk_status status; + struct lttng_directory_handle *output_directory; + + output_directory = session_create_output_directory_handle(session); + if (!output_directory) { goto end; } @@ -62,25 +220,58 @@ static int session_set_anonymous_chunk(struct relay_session *session) goto end; } + lttng_trace_chunk_set_fd_tracker(chunk, the_fd_tracker); status = lttng_trace_chunk_set_credentials_current_user(chunk); if (status != LTTNG_TRACE_CHUNK_STATUS_OK) { ret = -1; goto end; } - status = lttng_trace_chunk_set_as_owner(chunk, &output_directory); + status = lttng_trace_chunk_set_as_owner(chunk, output_directory); if (status != LTTNG_TRACE_CHUNK_STATUS_OK) { ret = -1; goto end; } + session->current_trace_chunk = chunk; chunk = NULL; end: lttng_trace_chunk_put(chunk); - lttng_directory_handle_fini(&output_directory); + lttng_directory_handle_put(output_directory); return ret; } +/* + * Check if a name is safe to use in a path. + * + * A name that is deemed "path-safe": + * - Does not contains a path separator (/ or \, platform dependant), + * - Does not start with a '.' (hidden file/folder), + * - Is not empty. + */ +static bool is_name_path_safe(const char *name) +{ + const size_t name_len = strlen(name); + + /* Not empty. */ + if (name_len == 0) { + WARN("An empty name is not allowed to be used in a path"); + return false; + } + /* Does not start with '.'. */ + if (name[0] == '.') { + WARN("Name \"%s\" is not allowed to be used in a path since it starts with '.'", name); + return false; + } + /* Does not contain a path-separator. */ + if (strchr(name, LTTNG_PATH_SEPARATOR)) { + WARN("Name \"%s\" is not allowed to be used in a path since it contains a path separator", name); + return false; + } + + return true; +} + /* * Create a new session by assigning a new session ID. * @@ -101,19 +292,21 @@ struct relay_session *session_create(const char *session_name, int ret; struct relay_session *session = NULL; - if (session_name && strstr(session_name, ".")) { - ERR("Illegal character in session name: \"%s\"", - session_name); + assert(session_name); + assert(hostname); + assert(base_path); + + if (!is_name_path_safe(session_name)) { + ERR("Refusing to create session as the provided session name is not path-safe"); goto error; } - if (base_path && strstr(base_path, "../")) { - ERR("Invalid session base path walks up the path hierarchy: \"%s\"", - base_path); + if (!is_name_path_safe(hostname)) { + ERR("Refusing to create session as the provided hostname is not path-safe"); goto error; } - if (hostname && strstr(hostname, ".")) { - ERR("Invalid character in hostname: \"%s\"", - hostname); + if (strstr(base_path, "../")) { + ERR("Invalid session base path walks up the path hierarchy: \"%s\"", + base_path); goto error; } @@ -122,6 +315,17 @@ struct relay_session *session_create(const char *session_name, PERROR("Failed to allocate session"); goto error; } + + pthread_mutex_lock(&last_relay_session_id_lock); + session->id = ++last_relay_session_id; + pthread_mutex_unlock(&last_relay_session_id_lock); + + lttng_ht_node_init_u64(&session->session_n, session->id); + urcu_ref_init(&session->ref); + CDS_INIT_LIST_HEAD(&session->recv_list); + pthread_mutex_init(&session->lock, NULL); + pthread_mutex_init(&session->recv_list_lock, NULL); + if (lttng_strncpy(session->session_name, session_name, sizeof(session->session_name))) { WARN("Session name exceeds maximal allowed length"); @@ -148,17 +352,8 @@ struct relay_session *session_create(const char *session_name, goto error; } - pthread_mutex_lock(&last_relay_session_id_lock); - session->id = ++last_relay_session_id; - pthread_mutex_unlock(&last_relay_session_id_lock); - session->major = major; session->minor = minor; - lttng_ht_node_init_u64(&session->session_n, session->id); - urcu_ref_init(&session->ref); - CDS_INIT_LIST_HEAD(&session->recv_list); - pthread_mutex_init(&session->lock, NULL); - pthread_mutex_init(&session->recv_list_lock, NULL); session->live_timer = live_timer; session->snapshot = snapshot; @@ -168,6 +363,14 @@ struct relay_session *session_create(const char *session_name, LTTNG_OPTIONAL_SET(&session->id_sessiond, *id_sessiond); } + if (major == 2 && minor >= 11) { + /* Only applies for 2.11+ peers using trace chunks. */ + ret = init_session_output_path(session); + if (ret) { + goto error; + } + } + ret = sessiond_trace_chunk_registry_session_created( sessiond_trace_chunk_registry, sessiond_uuid); if (ret) { @@ -175,6 +378,9 @@ struct relay_session *session_create(const char *session_name, } if (id_sessiond && current_chunk_id) { + enum lttng_trace_chunk_status chunk_status; + struct lttng_directory_handle *session_output_directory; + session->current_trace_chunk = sessiond_trace_chunk_registry_get_chunk( sessiond_trace_chunk_registry, @@ -182,13 +388,24 @@ struct relay_session *session_create(const char *session_name, session->id_sessiond.value, *current_chunk_id); if (!session->current_trace_chunk) { - char uuid_str[UUID_STR_LEN]; + char uuid_str[LTTNG_UUID_STR_LEN]; lttng_uuid_to_str(sessiond_uuid, uuid_str); ERR("Could not find trace chunk: sessiond = {%s}, sessiond session id = %" PRIu64 ", trace chunk id = %" PRIu64, uuid_str, *id_sessiond, *current_chunk_id); + goto error; } + + chunk_status = lttng_trace_chunk_get_session_output_directory_handle( + session->current_trace_chunk, + &session_output_directory); + if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) { + goto error; + } + + assert(session_output_directory); + session->output_directory = session_output_directory; } else if (!id_sessiond) { /* * Pre-2.11 peers will not announce trace chunks. An @@ -199,6 +416,12 @@ struct relay_session *session_create(const char *session_name, if (ret) { goto error; } + } else { + session->output_directory = + session_create_output_directory_handle(session); + if (!session->output_directory) { + goto error; + } } lttng_ht_add_unique_u64(sessions_ht, &session->session_n); @@ -288,10 +511,12 @@ static void destroy_session(struct relay_session *session) ret = sessiond_trace_chunk_registry_session_destroyed( sessiond_trace_chunk_registry, session->sessiond_uuid); assert(!ret); + lttng_directory_handle_put(session->output_directory); + session->output_directory = NULL; call_rcu(&session->rcu_node, rcu_destroy_session); } -void session_release(struct urcu_ref *ref) +static void session_release(struct urcu_ref *ref) { struct relay_session *session = caa_container_of(ref, struct relay_session, ref); @@ -301,6 +526,9 @@ void session_release(struct urcu_ref *ref) void session_put(struct relay_session *session) { + if (!session) { + return; + } rcu_read_lock(); urcu_ref_put(&session->ref, session_release); rcu_read_unlock();