Skip internal events when saving a session configuration
[lttng-tools.git] / src / bin / lttng-sessiond / save.c
index d2bf09208e05b3c4a472657d31ea366b4c22ddba..0a43eefa66df4e1d9efd53182b2fd7394d5ec8f2 100644 (file)
@@ -16,6 +16,7 @@
  */
 
 #define _GNU_SOURCE
+#define _LGPL_SOURCE
 #include <assert.h>
 #include <inttypes.h>
 #include <string.h>
 #include <common/defaults.h>
 #include <common/error.h>
 #include <common/config/config.h>
-#include <common/config/config-session-internal.h>
 #include <common/utils.h>
 #include <common/runas.h>
 #include <lttng/save-internal.h>
 
+#include "kernel.h"
 #include "save.h"
 #include "session.h"
+#include "syscall.h"
 #include "trace-ust.h"
 
 static
@@ -259,8 +261,14 @@ const char *get_ust_context_type_string(
        case LTTNG_UST_CONTEXT_PTHREAD_ID:
                context_type_string = config_event_context_pthread_id;
                break;
+       case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
+               /*
+                * Error, should not be stored in the XML, perf contexts
+                * are stored as a node of type event_perf_context_type.
+                */
        default:
                context_type_string = NULL;
+               break;
        }
 
        return context_type_string;
@@ -367,6 +375,7 @@ int save_kernel_event(struct config_writer *writer,
                }
 
                switch (event->event->instrumentation) {
+               case LTTNG_KERNEL_SYSCALL:
                case LTTNG_KERNEL_FUNCTION:
                        ret = config_writer_open_element(writer,
                                config_element_function_attributes);
@@ -480,9 +489,60 @@ end:
        return ret;
 }
 
+static
+int save_kernel_syscall(struct config_writer *writer,
+               struct ltt_kernel_channel *kchan)
+{
+       int ret, i;
+       ssize_t count;
+       struct lttng_event *events = NULL;
+
+       assert(writer);
+       assert(kchan);
+
+       count = syscall_list_channel(kchan, &events, 0);
+       if (!count) {
+               /* No syscalls, just gracefully return. */
+               ret = 0;
+               goto end;
+       }
+
+       for (i = 0; i < count; i++) {
+               struct ltt_kernel_event *kevent;
+
+               /* Create a temporary kevent in order to save it. */
+               /*
+                * TODO: struct lttng_event does not really work for a filter,
+                * but unfortunately, it is exposed as external API (and used as
+                * internal representation. Using NULL meanwhile.
+                */
+               kevent = trace_kernel_create_event(&events[i],
+                       NULL, NULL);
+               if (!kevent) {
+                       ret = -ENOMEM;
+                       goto end;
+               }
+               /* Init list in order so the destroy call can del the node. */
+               CDS_INIT_LIST_HEAD(&kevent->list);
+
+               ret = save_kernel_event(writer, kevent);
+               trace_kernel_destroy_event(kevent);
+               if (ret) {
+                       goto end;
+               }
+       }
+
+       /* Everything went well */
+       ret = 0;
+
+end:
+       free(events);
+       return ret;
+}
+
 static
 int save_kernel_events(struct config_writer *writer,
-       struct ltt_kernel_event_list *event_list)
+       struct ltt_kernel_channel *kchan)
 {
        int ret;
        struct ltt_kernel_event *event;
@@ -493,13 +553,19 @@ int save_kernel_events(struct config_writer *writer,
                goto end;
        }
 
-       cds_list_for_each_entry(event, &event_list->head, list) {
+       cds_list_for_each_entry(event, &kchan->events_list.head, list) {
                ret = save_kernel_event(writer, event);
                if (ret) {
                        goto end;
                }
        }
 
+       /* Save syscalls if any. */
+       ret = save_kernel_syscall(writer, kchan);
+       if (ret) {
+               goto end;
+       }
+
        /* /events */
        ret = config_writer_close_element(writer);
        if (ret) {
@@ -639,6 +705,10 @@ int save_ust_events(struct config_writer *writer,
        cds_lfht_for_each_entry(events->ht, &iter.iter, node, node) {
                event = caa_container_of(node, struct ltt_ust_event, node);
 
+               if (event->internal) {
+                       /* Internal events must not be exposed to clients */
+                       continue;
+               }
                ret = save_ust_event(writer, event);
                if (ret) {
                        rcu_read_unlock();
@@ -667,19 +737,13 @@ int save_kernel_context(struct config_writer *writer,
                goto end;
        }
 
-       ret = config_writer_open_element(writer, config_element_contexts);
-       if (ret) {
-               ret = LTTNG_ERR_SAVE_IO_FAIL;
-               goto end;
-       }
-
        ret = config_writer_open_element(writer, config_element_context);
        if (ret) {
                ret = LTTNG_ERR_SAVE_IO_FAIL;
                goto end;
        }
 
-       if (ctx->ctx == LTTNG_KERNEL_CONTEXT_PERF_COUNTER) {
+       if (ctx->ctx == LTTNG_KERNEL_CONTEXT_PERF_CPU_COUNTER) {
                ret = config_writer_open_element(writer, config_element_perf);
                if (ret) {
                        ret = LTTNG_ERR_SAVE_IO_FAIL;
@@ -738,6 +802,35 @@ int save_kernel_context(struct config_writer *writer,
                goto end;
        }
 
+end:
+       return ret;
+}
+
+static
+int save_kernel_contexts(struct config_writer *writer,
+               struct ltt_kernel_channel *kchan)
+{
+       int ret;
+       struct ltt_kernel_context *ctx;
+
+       if (cds_list_empty(&kchan->ctx_list)) {
+               ret = 0;
+               goto end;
+       }
+
+       ret = config_writer_open_element(writer, config_element_contexts);
+       if (ret) {
+               ret = LTTNG_ERR_SAVE_IO_FAIL;
+               goto end;
+       }
+
+       cds_list_for_each_entry(ctx, &kchan->ctx_list, list) {
+               ret = save_kernel_context(writer, &ctx->ctx);
+               if (ret) {
+                       goto end;
+               }
+       }
+
        /* /contexts */
        ret = config_writer_close_element(writer);
        if (ret) {
@@ -767,12 +860,6 @@ int save_ust_context(struct config_writer *writer,
        cds_list_for_each_entry(ctx, ctx_list, list) {
                const char *context_type_string;
 
-               context_type_string = get_ust_context_type_string(ctx->ctx.ctx);
-               if (!context_type_string) {
-                       ERR("Unsupported UST context type.")
-                       ret = LTTNG_ERR_INVALID;
-                       goto end;
-               }
 
                ret = config_writer_open_element(writer,
                        config_element_context);
@@ -781,11 +868,61 @@ int save_ust_context(struct config_writer *writer,
                        goto end;
                }
 
-               ret = config_writer_write_element_string(writer,
-                       config_element_type, context_type_string);
-               if (ret) {
-                       ret = LTTNG_ERR_SAVE_IO_FAIL;
-                       goto end;
+               if (ctx->ctx.ctx == LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER) {
+                       /* Perf contexts are saved as event_perf_context_type */
+                       ret = config_writer_open_element(writer,
+                               config_element_perf);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       ret = config_writer_write_element_unsigned_int(writer,
+                               config_element_type,
+                               ctx->ctx.u.perf_counter.type);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       ret = config_writer_write_element_unsigned_int(writer,
+                               config_element_config,
+                               ctx->ctx.u.perf_counter.config);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       ret = config_writer_write_element_string(writer,
+                               config_element_name,
+                               ctx->ctx.u.perf_counter.name);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       /* /perf */
+                       ret = config_writer_close_element(writer);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+               } else {
+                       /* Save context as event_context_type_type */
+                       context_type_string = get_ust_context_type_string(
+                               ctx->ctx.ctx);
+                       if (!context_type_string) {
+                               ERR("Unsupported UST context type.")
+                                       ret = LTTNG_ERR_INVALID;
+                               goto end;
+                       }
+
+                       ret = config_writer_write_element_string(writer,
+                               config_element_type, context_type_string);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
                }
 
                /* /context */
@@ -840,12 +977,12 @@ int save_kernel_channel(struct config_writer *writer,
                goto end;
        }
 
-       ret = save_kernel_events(writer, &kchan->events_list);
+       ret = save_kernel_events(writer, kchan);
        if (ret) {
                goto end;
        }
 
-       ret = save_kernel_context(writer, kchan->ctx);
+       ret = save_kernel_contexts(writer, kchan);
        if (ret) {
                goto end;
        }
@@ -990,7 +1127,7 @@ end:
 
 static
 int save_ust_session(struct config_writer *writer,
-       struct ltt_session *session, int save_jul)
+       struct ltt_session *session, int save_agent)
 {
        int ret;
        struct ltt_ust_channel *ust_chan;
@@ -1002,7 +1139,7 @@ int save_ust_session(struct config_writer *writer,
        assert(session);
 
        ret = config_writer_write_element_string(writer, config_element_type,
-                       save_jul ? config_domain_type_jul : config_domain_type_ust);
+                       save_agent ? config_domain_type_jul : config_domain_type_ust);
        if (ret) {
                ret = LTTNG_ERR_SAVE_IO_FAIL;
                goto end;
@@ -1032,11 +1169,13 @@ int save_ust_session(struct config_writer *writer,
        rcu_read_lock();
        cds_lfht_for_each_entry(session->ust_session->domain_global.channels->ht,
                        &iter.iter, node, node) {
-               int jul_channel;
+               int agent_channel;
 
                ust_chan = caa_container_of(node, struct ltt_ust_channel, node);
-               jul_channel = !strcmp(DEFAULT_JUL_CHANNEL_NAME, ust_chan->name);
-               if (!(save_jul ^ jul_channel)) {
+               agent_channel = !strcmp(DEFAULT_JUL_CHANNEL_NAME, ust_chan->name) ||
+                       !strcmp(DEFAULT_LOG4J_CHANNEL_NAME, ust_chan->name) ||
+                       !strcmp(DEFAULT_PYTHON_CHANNEL_NAME, ust_chan->name);
+               if (!(save_agent ^ agent_channel)) {
                        ret = save_ust_channel(writer, ust_chan, session->ust_session);
                        if (ret) {
                                rcu_read_unlock();
@@ -1056,6 +1195,99 @@ end:
        return ret;
 }
 
+static
+int save_pid_tracker(struct config_writer *writer,
+       struct ltt_session *sess, int domain)
+{
+       int ret = 0;
+       ssize_t nr_pids = 0, i;
+       int32_t *pids = NULL;
+
+       switch (domain) {
+       case LTTNG_DOMAIN_KERNEL:
+       {
+               nr_pids = kernel_list_tracker_pids(sess->kernel_session, &pids);
+               if (nr_pids < 0) {
+                       ret = LTTNG_ERR_KERN_LIST_FAIL;
+                       goto end;
+               }
+               break;
+       }
+       case LTTNG_DOMAIN_UST:
+       {
+               nr_pids = trace_ust_list_tracker_pids(sess->ust_session, &pids);
+               if (nr_pids < 0) {
+                       ret = LTTNG_ERR_UST_LIST_FAIL;
+                       goto end;
+               }
+               break;
+       }
+       case LTTNG_DOMAIN_JUL:
+       case LTTNG_DOMAIN_LOG4J:
+       case LTTNG_DOMAIN_PYTHON:
+       default:
+               ret = LTTNG_ERR_UNKNOWN_DOMAIN;
+               goto end;
+       }
+
+       /* Only create a pid_tracker if enabled or untrack all */
+       if (nr_pids != 1 || (nr_pids == 1 && pids[0] != -1)) {
+               ret = config_writer_open_element(writer,
+                               config_element_pid_tracker);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
+
+               ret = config_writer_open_element(writer,
+                               config_element_targets);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
+
+               for (i = 0; i < nr_pids; i++) {
+                       ret = config_writer_open_element(writer,
+                                       config_element_target_pid);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       ret = config_writer_write_element_unsigned_int(writer,
+                                       config_element_pid, pids[i]);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       /* /pid_target */
+                       ret = config_writer_close_element(writer);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+               }
+
+               /* /targets */
+               ret = config_writer_close_element(writer);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
+
+               /* /pid_tracker */
+               ret = config_writer_close_element(writer);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
+       }
+end:
+       free(pids);
+       return ret;
+}
+
 static
 int save_domains(struct config_writer *writer, struct ltt_session *session)
 {
@@ -1088,6 +1320,24 @@ int save_domains(struct config_writer *writer, struct ltt_session *session)
                        goto end;
                }
 
+               ret = config_writer_open_element(writer,
+                       config_element_trackers);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
+
+               ret = save_pid_tracker(writer, session, LTTNG_DOMAIN_KERNEL);
+               if (ret) {
+                       goto end;
+               }
+
+               /* /trackers */
+               ret = config_writer_close_element(writer);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
                /* /domain */
                ret = config_writer_close_element(writer);
                if (ret) {
@@ -1097,6 +1347,8 @@ int save_domains(struct config_writer *writer, struct ltt_session *session)
        }
 
        if (session->ust_session) {
+               unsigned long agent_count;
+
                ret = config_writer_open_element(writer,
                        config_element_domain);
                if (ret) {
@@ -1109,34 +1361,56 @@ int save_domains(struct config_writer *writer, struct ltt_session *session)
                        goto end;
                }
 
-               /* /domain */
-               ret = config_writer_close_element(writer);
+               ret = config_writer_open_element(writer,
+                       config_element_trackers);
                if (ret) {
                        ret = LTTNG_ERR_SAVE_IO_FAIL;
                        goto end;
                }
-       }
 
-       if (session->ust_session &&
-               session->ust_session->domain_jul.being_used) {
-               ret = config_writer_open_element(writer,
-                       config_element_domain);
+               ret = save_pid_tracker(writer, session, LTTNG_DOMAIN_UST);
                if (ret) {
-                       ret = LTTNG_ERR_SAVE_IO_FAIL;
                        goto end;
                }
 
-               ret = save_ust_session(writer, session, 1);
+               /* /trackers */
+               ret = config_writer_close_element(writer);
                if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
                        goto end;
                }
-
                /* /domain */
                ret = config_writer_close_element(writer);
                if (ret) {
                        ret = LTTNG_ERR_SAVE_IO_FAIL;
                        goto end;
                }
+
+               rcu_read_lock();
+               agent_count =
+                       lttng_ht_get_count(session->ust_session->agents);
+               rcu_read_unlock();
+
+               if (agent_count > 0) {
+                       ret = config_writer_open_element(writer,
+                               config_element_domain);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+
+                       ret = save_ust_session(writer, session, 1);
+                       if (ret) {
+                               goto end;
+                       }
+
+                       /* /domain */
+                       ret = config_writer_close_element(writer);
+                       if (ret) {
+                               ret = LTTNG_ERR_SAVE_IO_FAIL;
+                               goto end;
+                       }
+               }
        }
 
        /* /domains */
@@ -1398,6 +1672,7 @@ int save_session(struct ltt_session *session,
        struct lttng_save_session_attr *attr, lttng_sock_cred *creds)
 {
        int ret, fd;
+       unsigned int file_opened = 0;   /* Indicate if the file has been opened */
        char config_file_path[PATH_MAX];
        size_t len;
        struct config_writer *writer = NULL;
@@ -1409,6 +1684,7 @@ int save_session(struct ltt_session *session,
        assert(creds);
 
        session_name_len = strlen(session->name);
+       memset(config_file_path, 0, sizeof(config_file_path));
 
        if (!session_access_ok(session,
                LTTNG_SOCK_GET_UID_CRED(creds),
@@ -1419,6 +1695,7 @@ int save_session(struct ltt_session *session,
 
        provided_path = lttng_save_session_attr_get_output_url(attr);
        if (provided_path) {
+               DBG3("Save session in provided path %s", provided_path);
                len = strlen(provided_path);
                if (len >= sizeof(config_file_path)) {
                        ret = LTTNG_ERR_SET_URL;
@@ -1471,9 +1748,12 @@ int save_session(struct ltt_session *session,
        strncpy(config_file_path + len, session->name, session_name_len);
        len += session_name_len;
        strcpy(config_file_path + len, DEFAULT_SESSION_CONFIG_FILE_EXTENSION);
+       len += sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION);
+       config_file_path[len] = '\0';
 
        if (!access(config_file_path, F_OK) && !attr->overwrite) {
-               /* A file with the same name already exists, skip */
+               /* File exists, notify the user since the overwrite flag is off. */
+               ret = LTTNG_ERR_SAVE_FILE_EXIST;
                goto end;
        }
 
@@ -1485,8 +1765,9 @@ int save_session(struct ltt_session *session,
                ret = LTTNG_ERR_SAVE_IO_FAIL;
                goto end;
        }
+       file_opened = 1;
 
-       writer = config_writer_create(fd);
+       writer = config_writer_create(fd, 1);
        if (!writer) {
                ret = LTTNG_ERR_NOMEM;
                goto end;
@@ -1511,13 +1792,23 @@ int save_session(struct ltt_session *session,
                goto end;
        }
 
+       if(session->shm_path[0] != '\0') {
+               ret = config_writer_write_element_string(writer,
+                               config_element_shared_memory_path,
+                               session->shm_path);
+               if (ret) {
+                       ret = LTTNG_ERR_SAVE_IO_FAIL;
+                       goto end;
+               }
+       }
+
        ret = save_domains(writer, session);
        if (ret) {
                goto end;
        }
 
        ret = config_writer_write_element_bool(writer, config_element_started,
-                       session->enabled);
+                       session->active);
        if (ret) {
                ret = LTTNG_ERR_SAVE_IO_FAIL;
                goto end;
@@ -1538,7 +1829,7 @@ int save_session(struct ltt_session *session,
                                goto end;
                        }
                } else {
-                       ret = config_writer_write_element_signed_int(writer,
+                       ret = config_writer_write_element_unsigned_int(writer,
                                        config_element_live_timer_interval, session->live_timer);
                        if (ret) {
                                ret = LTTNG_ERR_SAVE_IO_FAIL;
@@ -1579,7 +1870,7 @@ end:
        }
        if (ret) {
                /* Delete file in case of error */
-               if (unlink(config_file_path)) {
+               if (file_opened && unlink(config_file_path)) {
                        PERROR("Unlinking XML session configuration.");
                }
        }
This page took 0.030322 seconds and 4 git commands to generate.