Clean-up relayd: session_release can be marked as static
[lttng-tools.git] / src / bin / lttng-relayd / session.c
index fa211fe02bf6633bb60ffbacebdb4b2c95352408..241a3c23fea88fbb8f953c0316187a5ba8b631fd 100644 (file)
 #define _LGPL_SOURCE
 #include <common/common.h>
 #include <common/compat/uuid.h>
+#include <common/time.h>
+#include <common/utils.h>
 #include <urcu/rculist.h>
 
-#include "lttng-relayd.h"
+#include <sys/stat.h>
+
 #include "ctf-trace.h"
+#include "lttng-relayd.h"
 #include "session.h"
-#include "stream.h"
 #include "sessiond-trace-chunks.h"
+#include "stream.h"
+#include <common/defaults.h>
+#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 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;
+
+       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-<timestamp>, don't append yet another timestamp after
+        * the session name in the generated path.
+        *
+        * Otherwise, generate the path with session_name-<timestamp>.
+        */
+       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 int session_set_anonymous_chunk(struct relay_session *session)
 {
        int ret = 0;
@@ -39,7 +186,7 @@ static int session_set_anonymous_chunk(struct relay_session *session)
        enum lttng_trace_chunk_status status;
        struct lttng_directory_handle output_directory;
 
-       ret = lttng_directory_handle_init(&output_directory, opt_output_path);
+       ret = session_init_output_directory_handle(session, &output_directory);
        if (ret) {
                goto end;
        }
@@ -74,7 +221,7 @@ end:
  * Return allocated session or else NULL.
  */
 struct relay_session *session_create(const char *session_name,
-               const char *hostname,
+               const char *hostname, const char *base_path,
                uint32_t live_timer,
                bool snapshot,
                const lttng_uuid sessiond_uuid,
@@ -82,10 +229,31 @@ struct relay_session *session_create(const char *session_name,
                const uint64_t *current_chunk_id,
                const time_t *creation_time,
                uint32_t major,
-               uint32_t minor)
+               uint32_t minor,
+               bool session_name_contains_creation_time)
 {
        int ret;
-       struct relay_session *session;
+       struct relay_session *session = NULL;
+
+       assert(session_name);
+       assert(hostname);
+       assert(base_path);
+
+       if (strstr(session_name, ".")) {
+               ERR("Illegal character in session name: \"%s\"",
+                               session_name);
+               goto error;
+       }
+       if (strstr(base_path, "../")) {
+               ERR("Invalid session base path walks up the path hierarchy: \"%s\"",
+                               base_path);
+               goto error;
+       }
+       if (strstr(hostname, ".")) {
+               ERR("Invalid character in hostname: \"%s\"",
+                               hostname);
+               goto error;
+       }
 
        session = zmalloc(sizeof(*session));
        if (!session) {
@@ -102,6 +270,17 @@ struct relay_session *session_create(const char *session_name,
                WARN("Hostname exceeds maximal allowed length");
                goto error;
        }
+       if (lttng_strncpy(session->base_path, base_path,
+                       sizeof(session->base_path))) {
+               WARN("Base path exceeds maximal allowed length");
+               goto error;
+       }
+       if (creation_time) {
+               LTTNG_OPTIONAL_SET(&session->creation_time, *creation_time);
+       }
+       session->session_name_contains_creation_time =
+                       session_name_contains_creation_time;
+
        session->ctf_traces_ht = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
        if (!session->ctf_traces_ht) {
                goto error;
@@ -127,6 +306,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) {
@@ -161,9 +348,6 @@ struct relay_session *session_create(const char *session_name,
        }
 
        lttng_ht_add_unique_u64(sessions_ht, &session->session_n);
-       if (creation_time) {
-               LTTNG_OPTIONAL_SET(&session->creation_time, *creation_time);
-       }
        return session;
 
 error:
@@ -244,15 +428,16 @@ static void destroy_session(struct relay_session *session)
        ret = session_delete(session);
        assert(!ret);
        lttng_trace_chunk_put(session->current_trace_chunk);
+       session->current_trace_chunk = NULL;
+       lttng_trace_chunk_put(session->pending_closure_trace_chunk);
+       session->pending_closure_trace_chunk = NULL;
        ret = sessiond_trace_chunk_registry_session_destroyed(
                        sessiond_trace_chunk_registry, session->sessiond_uuid);
        assert(!ret);
-       lttng_trace_chunk_put(session->current_trace_chunk);
-       session->current_trace_chunk = 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);
@@ -262,6 +447,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();
@@ -341,3 +529,38 @@ void print_sessions(void)
        }
        rcu_read_unlock();
 }
+
+int session_init_output_directory_handle(struct relay_session *session,
+               struct lttng_directory_handle *handle)
+{
+       int ret;
+       /*
+        * relayd_output_path/session_directory
+        * e.g. /home/user/lttng-traces/hostname/session_name
+        */
+       char *full_session_path = NULL;
+
+       pthread_mutex_lock(&session->lock);
+       full_session_path = create_output_path(session->output_path);
+       if (!full_session_path) {
+               ret = -1;
+               goto end;
+       }
+
+       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;
+       }
+
+       ret = lttng_directory_handle_init(handle, full_session_path);
+       if (ret) {
+               goto end;
+       }
+end:
+       pthread_mutex_unlock(&session->lock);
+       free(full_session_path);
+       return ret;
+}
This page took 0.033786 seconds and 4 git commands to generate.