Fix RCU-related hangs: incorrect lttng_ht_destroy use
[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.c
index 4001ec87bdd8359f6224a1915e84c62f9c22486a..7592d774177a43abb8782424084c711e371bcc5c 100644 (file)
 #include <common/common.h>
 #include <common/defaults.h>
 
+#include "buffer-registry.h"
 #include "trace-ust.h"
 
 /*
- * Find the channel in the hashtable.
+ * Match function for the events hash table lookup.
+ *
+ * Matches by name only. Used by the disable command.
+ */
+int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
+               const void *_key)
+{
+       struct ltt_ust_event *event;
+       const char *name;
+
+       assert(node);
+       assert(_key);
+
+       event = caa_container_of(node, struct ltt_ust_event, node.node);
+       name = _key;
+
+       /* Event name */
+       if (strncmp(event->attr.name, name, sizeof(event->attr.name)) != 0) {
+               goto no_match;
+       }
+
+       /* Match */
+       return 1;
+
+no_match:
+       return 0;
+}
+
+/*
+ * Match function for the hash table lookup.
+ *
+ * It matches an ust event based on three attributes which are the event name,
+ * the filter bytecode and the loglevel.
+ */
+int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key)
+{
+       struct ltt_ust_event *event;
+       const struct ltt_ust_ht_key *key;
+
+       assert(node);
+       assert(_key);
+
+       event = caa_container_of(node, struct ltt_ust_event, node.node);
+       key = _key;
+
+       /* Match the 3 elements of the key: name, filter and loglevel. */
+
+       /* Event name */
+       if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
+               goto no_match;
+       }
+
+       /* Event loglevel. */
+       if (event->attr.loglevel != key->loglevel) {
+               if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
+                               && key->loglevel == 0 && event->attr.loglevel == -1) {
+                       /*
+                        * Match is accepted. This is because on event creation, the
+                        * loglevel is set to -1 if the event loglevel type is ALL so 0 and
+                        * -1 are accepted for this loglevel type since 0 is the one set by
+                        * the API when receiving an enable event.
+                        */
+               } else {
+                       goto no_match;
+               }
+       }
+
+       /* Only one of the filters is NULL, fail. */
+       if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
+               goto no_match;
+       }
+
+       if (key->filter && event->filter) {
+               /* Both filters exists, check length followed by the bytecode. */
+               if (event->filter->len != key->filter->len ||
+                               memcmp(event->filter->data, key->filter->data,
+                                       event->filter->len) != 0) {
+                       goto no_match;
+               }
+       }
+
+       /* Match. */
+       return 1;
+
+no_match:
+       return 0;
+}
+
+/*
+ * Find the channel in the hashtable and return channel pointer. RCU read side
+ * lock MUST be acquired before calling this.
  */
 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
                char *name)
@@ -35,14 +126,11 @@ struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
        struct lttng_ht_node_str *node;
        struct lttng_ht_iter iter;
 
-       rcu_read_lock();
        lttng_ht_lookup(ht, (void *)name, &iter);
        node = lttng_ht_iter_get_node_str(&iter);
        if (node == NULL) {
-               rcu_read_unlock();
                goto error;
        }
-       rcu_read_unlock();
 
        DBG2("Trace UST channel %s found by name", name);
 
@@ -54,29 +142,36 @@ error:
 }
 
 /*
- * Find the event in the hashtable.
+ * Find the event in the hashtable and return event pointer. RCU read side lock
+ * MUST be acquired before calling this.
  */
-struct ltt_ust_event *trace_ust_find_event_by_name(struct lttng_ht *ht,
-               char *name)
+struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
+               char *name, struct lttng_filter_bytecode *filter, int loglevel)
 {
        struct lttng_ht_node_str *node;
        struct lttng_ht_iter iter;
+       struct ltt_ust_ht_key key;
 
-       rcu_read_lock();
-       lttng_ht_lookup(ht, (void *) name, &iter);
+       assert(name);
+       assert(ht);
+
+       key.name = name;
+       key.filter = filter;
+       key.loglevel = loglevel;
+
+       cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
+                       trace_ust_ht_match_event, &key, &iter.iter);
        node = lttng_ht_iter_get_node_str(&iter);
        if (node == NULL) {
-               rcu_read_unlock();
                goto error;
        }
-       rcu_read_unlock();
 
-       DBG2("Trace UST event found by name %s", name);
+       DBG2("Trace UST event %s found", key.name);
 
        return caa_container_of(node, struct ltt_ust_event, node);
 
 error:
-       DBG2("Trace UST event NOT found by name %s", name);
+       DBG2("Trace UST event %s NOT found", key.name);
        return NULL;
 }
 
@@ -85,10 +180,8 @@ error:
  *
  * Return pointer to structure or NULL.
  */
-struct ltt_ust_session *trace_ust_create_session(char *path,
-               unsigned int session_id, struct lttng_domain *domain)
+struct ltt_ust_session *trace_ust_create_session(unsigned int session_id)
 {
-       int ret;
        struct ltt_ust_session *lus;
 
        /* Allocate a new ltt ust session */
@@ -102,16 +195,24 @@ struct ltt_ust_session *trace_ust_create_session(char *path,
        lus->id = session_id;
        lus->start_trace = 0;
 
-       /* Alloc UST domain hash tables */
-       lus->domain_pid = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
-       lus->domain_exec = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
+       /*
+        * Default buffer type. This can be changed through an enable channel
+        * requesting a different type. Note that this can only be changed once
+        * during the session lifetime which is at the first enable channel and
+        * only before start. The flag buffer_type_changed indicates the status.
+        */
+       lus->buffer_type = LTTNG_BUFFER_PER_PID;
+       /* Once set to 1, the buffer_type is immutable for the session. */
+       lus->buffer_type_changed = 0;
+       /* Init it in case it get used after allocation. */
+       CDS_INIT_LIST_HEAD(&lus->buffer_reg_uid_list);
 
        /* Alloc UST global domain channels' HT */
        lus->domain_global.channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
 
        lus->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
        if (lus->consumer == NULL) {
-               goto error;
+               goto error_consumer;
        }
 
        /*
@@ -122,28 +223,12 @@ struct ltt_ust_session *trace_ust_create_session(char *path,
         */
        lus->tmp_consumer = NULL;
 
-       /* Use the default consumer output which is the tracing session path. */
-       ret = snprintf(lus->consumer->dst.trace_path, PATH_MAX, "%s/ust", path);
-       if (ret < 0) {
-               PERROR("snprintf UST consumer trace path");
-               goto error;
-       }
-
-       /* Set session path */
-       ret = snprintf(lus->pathname, PATH_MAX, "%s/ust", path);
-       if (ret < 0) {
-               PERROR("snprintf kernel traces path");
-               goto error_free_session;
-       }
-
        DBG2("UST trace session create successful");
 
        return lus;
 
-error_free_session:
+error_consumer:
        lttng_ht_destroy(lus->domain_global.channels);
-       lttng_ht_destroy(lus->domain_exec);
-       lttng_ht_destroy(lus->domain_pid);
        free(lus);
 error:
        return NULL;
@@ -154,12 +239,12 @@ error:
  *
  * Return pointer to structure or NULL.
  */
-struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan,
-               char *path)
+struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan)
 {
-       int ret;
        struct ltt_ust_channel *luc;
 
+       assert(chan);
+
        luc = zmalloc(sizeof(struct ltt_ust_channel));
        if (luc == NULL) {
                PERROR("ltt_ust_channel zmalloc");
@@ -191,23 +276,14 @@ struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan,
        luc->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
        luc->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
 
-       /* Set trace output path */
-       ret = snprintf(luc->pathname, PATH_MAX, "%s", path);
-       if (ret < 0) {
-               PERROR("asprintf ust create channel");
-               goto error_free_channel;
-       }
+       /* On-disk circular buffer parameters */
+       luc->tracefile_size = chan->attr.tracefile_size;
+       luc->tracefile_count = chan->attr.tracefile_count;
 
        DBG2("Trace UST channel %s created", luc->name);
 
-       return luc;
-
-error_free_channel:
-       lttng_ht_destroy(luc->ctx);
-       lttng_ht_destroy(luc->events);
-       free(luc);
 error:
-       return NULL;
+       return luc;
 }
 
 /*
@@ -215,10 +291,13 @@ error:
  *
  * Return pointer to structure or NULL.
  */
-struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev)
+struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
+               struct lttng_filter_bytecode *filter)
 {
        struct ltt_ust_event *lue;
 
+       assert(ev);
+
        lue = zmalloc(sizeof(struct ltt_ust_event));
        if (lue == NULL) {
                PERROR("ust event zmalloc");
@@ -265,15 +344,11 @@ struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev)
                goto error_free_event;
        }
 
+       /* Same layout. */
+       lue->filter = (struct lttng_ust_filter_bytecode *) filter;
 
        /* Init node */
        lttng_ht_node_init_str(&lue->node, lue->attr.name);
-       /* Alloc context hash tables */
-       lue->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
-       if (lue->ctx == NULL) {
-               ERR("Unable to create context hash table for event %s", ev->name);
-               goto error_free_event;
-       }
 
        DBG2("Trace UST event %s, loglevel (%d,%d) created",
                lue->attr.name, lue->attr.loglevel_type,
@@ -297,6 +372,8 @@ struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
        int ret;
        struct ltt_ust_metadata *lum;
 
+       assert(path);
+
        lum = zmalloc(sizeof(struct ltt_ust_metadata));
        if (lum == NULL) {
                PERROR("ust metadata zmalloc");
@@ -305,15 +382,15 @@ struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
 
        /* Set default attributes */
        lum->attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
-       lum->attr.subbuf_size = DEFAULT_METADATA_SUBBUF_SIZE;
+       lum->attr.subbuf_size = default_get_metadata_subbuf_size();
        lum->attr.num_subbuf = DEFAULT_METADATA_SUBBUF_NUM;
-       lum->attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER;
-       lum->attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER;
+       lum->attr.switch_timer_interval = DEFAULT_UST_CHANNEL_SWITCH_TIMER;
+       lum->attr.read_timer_interval = DEFAULT_UST_CHANNEL_READ_TIMER;
        lum->attr.output = LTTNG_UST_MMAP;
 
        lum->handle = -1;
        /* Set metadata trace path */
-       ret = snprintf(lum->pathname, PATH_MAX, "%s/metadata", path);
+       ret = snprintf(lum->pathname, PATH_MAX, "%s/" DEFAULT_METADATA_NAME, path);
        if (ret < 0) {
                PERROR("asprintf ust metadata");
                goto error_free_metadata;
@@ -338,6 +415,8 @@ struct ltt_ust_context *trace_ust_create_context(
        struct ltt_ust_context *uctx;
        enum lttng_ust_context_type utype;
 
+       assert(ctx);
+
        switch (ctx->ctx) {
        case LTTNG_EVENT_CONTEXT_VTID:
                utype = LTTNG_UST_CONTEXT_VTID;
@@ -393,12 +472,16 @@ static void destroy_contexts(struct lttng_ht *ht)
        struct lttng_ht_node_ulong *node;
        struct lttng_ht_iter iter;
 
+       assert(ht);
+
+       rcu_read_lock();
        cds_lfht_for_each_entry(ht->ht, &iter.iter, node, node) {
                ret = lttng_ht_del(ht, &iter);
                if (!ret) {
                        call_rcu(&node->head, destroy_context_rcu);
                }
        }
+       rcu_read_unlock();
 
        lttng_ht_destroy(ht);
 }
@@ -408,8 +491,9 @@ static void destroy_contexts(struct lttng_ht *ht)
  */
 void trace_ust_destroy_event(struct ltt_ust_event *event)
 {
+       assert(event);
+
        DBG2("Trace destroy UST event %s", event->attr.name);
-       destroy_contexts(event->ctx);
        free(event->filter);
        free(event);
 }
@@ -436,23 +520,29 @@ static void destroy_events(struct lttng_ht *events)
        struct lttng_ht_node_str *node;
        struct lttng_ht_iter iter;
 
+       assert(events);
+
+       rcu_read_lock();
        cds_lfht_for_each_entry(events->ht, &iter.iter, node, node) {
                ret = lttng_ht_del(events, &iter);
                assert(!ret);
                call_rcu(&node->head, destroy_event_rcu);
        }
+       rcu_read_unlock();
 
        lttng_ht_destroy(events);
 }
 
 /*
  * Cleanup ust channel structure.
+ *
+ * Should _NOT_ be called with RCU read lock held.
  */
-void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
+static void _trace_ust_destroy_channel(struct ltt_ust_channel *channel)
 {
-       DBG2("Trace destroy UST channel %s", channel->name);
+       assert(channel);
 
-       rcu_read_lock();
+       DBG2("Trace destroy UST channel %s", channel->name);
 
        /* Destroying all events of the channel */
        destroy_events(channel->events);
@@ -460,8 +550,6 @@ void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
        destroy_contexts(channel->ctx);
 
        free(channel);
-
-       rcu_read_unlock();
 }
 
 /*
@@ -474,7 +562,12 @@ static void destroy_channel_rcu(struct rcu_head *head)
        struct ltt_ust_channel *channel =
                caa_container_of(node, struct ltt_ust_channel, node);
 
-       trace_ust_destroy_channel(channel);
+       _trace_ust_destroy_channel(channel);
+}
+
+void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
+{
+       call_rcu(&channel->node.head, destroy_channel_rcu);
 }
 
 /*
@@ -482,6 +575,8 @@ static void destroy_channel_rcu(struct rcu_head *head)
  */
 void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
 {
+       assert(metadata);
+
        if (!metadata->handle) {
                return;
        }
@@ -498,6 +593,8 @@ static void destroy_channels(struct lttng_ht *channels)
        struct lttng_ht_node_str *node;
        struct lttng_ht_iter iter;
 
+       assert(channels);
+
        rcu_read_lock();
 
        cds_lfht_for_each_entry(channels->ht, &iter.iter, node, node) {
@@ -505,46 +602,9 @@ static void destroy_channels(struct lttng_ht *channels)
                assert(!ret);
                call_rcu(&node->head, destroy_channel_rcu);
        }
-
-       lttng_ht_destroy(channels);
-
        rcu_read_unlock();
-}
-
-/*
- * Cleanup UST pid domain.
- */
-static void destroy_domain_pid(struct lttng_ht *ht)
-{
-       int ret;
-       struct lttng_ht_iter iter;
-       struct ltt_ust_domain_pid *dpid;
-
-       cds_lfht_for_each_entry(ht->ht, &iter.iter, dpid, node.node) {
-               ret = lttng_ht_del(ht , &iter);
-               assert(!ret);
-               destroy_channels(dpid->channels);
-       }
-
-       lttng_ht_destroy(ht);
-}
-
-/*
- * Cleanup UST exec name domain.
- */
-static void destroy_domain_exec(struct lttng_ht *ht)
-{
-       int ret;
-       struct lttng_ht_iter iter;
-       struct ltt_ust_domain_exec *dexec;
 
-       cds_lfht_for_each_entry(ht->ht, &iter.iter, dexec, node.node) {
-               ret = lttng_ht_del(ht , &iter);
-               assert(!ret);
-               destroy_channels(dexec->channels);
-       }
-
-       lttng_ht_destroy(ht);
+       lttng_ht_destroy(channels);
 }
 
 /*
@@ -552,29 +612,37 @@ static void destroy_domain_exec(struct lttng_ht *ht)
  */
 static void destroy_domain_global(struct ltt_ust_domain_global *dom)
 {
+       assert(dom);
+
        destroy_channels(dom->channels);
 }
 
 /*
  * Cleanup ust session structure
+ *
+ * Should *NOT* be called with RCU read-side lock held.
  */
 void trace_ust_destroy_session(struct ltt_ust_session *session)
 {
-       /* Extra protection */
-       if (session == NULL) {
-               return;
-       }
+       struct buffer_reg_uid *reg, *sreg;
 
-       rcu_read_lock();
+       assert(session);
 
        DBG2("Trace UST destroy session %u", session->id);
 
        /* Cleaning up UST domain */
        destroy_domain_global(&session->domain_global);
-       destroy_domain_pid(session->domain_pid);
-       destroy_domain_exec(session->domain_exec);
 
-       free(session);
+       /* Cleanup UID buffer registry object(s). */
+       cds_list_for_each_entry_safe(reg, sreg, &session->buffer_reg_uid_list,
+                       lnode) {
+               cds_list_del(&reg->lnode);
+               buffer_reg_uid_remove(reg);
+               buffer_reg_uid_destroy(reg, session->consumer);
+       }
 
-       rcu_read_unlock();
+       consumer_destroy_output(session->consumer);
+       consumer_destroy_output(session->tmp_consumer);
+
+       free(session);
 }
This page took 0.029788 seconds and 4 git commands to generate.