Separate session info from channel info in notification thread
[lttng-tools.git] / src / bin / lttng-sessiond / notification-thread-events.c
index bfdbb2085e5e36366ae505ec59a71dde7adcdde6..254aa5396e5d30c102e771545773645ad766311c 100644 (file)
@@ -168,6 +168,23 @@ int send_evaluation_to_clients(struct lttng_trigger *trigger,
                struct notification_thread_state *state,
                uid_t channel_uid, gid_t channel_gid);
 
+
+static
+void session_info_destroy(void *_data);
+static
+void session_info_get(struct session_info *session_info);
+static
+void session_info_put(struct session_info *session_info);
+static
+struct session_info *session_info_create(const char *name,
+               uid_t uid, gid_t gid);
+static
+void session_info_add_channel(struct session_info *session_info,
+               struct channel_info *channel_info);
+static
+void session_info_remove_channel(struct session_info *session_info,
+               struct channel_info *channel_info);
+
 static
 int match_client(struct cds_lfht_node *node, const void *key)
 {
@@ -295,7 +312,7 @@ unsigned long lttng_condition_buffer_usage_hash(
 
                val = condition->threshold_ratio.value * (double) UINT32_MAX;
                hash ^= hash_key_u64(&val, lttng_ht_seed);
-       } else if (condition->threshold_ratio.set) {
+       } else if (condition->threshold_bytes.set) {
                uint64_t val;
 
                val = condition->threshold_bytes.value;
@@ -339,45 +356,136 @@ void channel_info_destroy(struct channel_info *channel_info)
                return;
        }
 
-       if (channel_info->session_name) {
-               free(channel_info->session_name);
+       if (channel_info->session_info) {
+               session_info_remove_channel(channel_info->session_info,
+                               channel_info);
+               session_info_put(channel_info->session_info);
        }
-       if (channel_info->channel_name) {
-               free(channel_info->channel_name);
+       if (channel_info->name) {
+               free(channel_info->name);
        }
        free(channel_info);
 }
 
+/* Don't call directly, use the ref-counting mechanism. */
 static
-struct channel_info *channel_info_copy(struct channel_info *channel_info)
+void session_info_destroy(void *_data)
 {
-       struct channel_info *copy = zmalloc(sizeof(*channel_info));
+       struct session_info *session_info = _data;
 
-       assert(channel_info);
-       assert(channel_info->session_name);
-       assert(channel_info->channel_name);
+       assert(session_info);
+       if (session_info->channel_infos_ht) {
+               cds_lfht_destroy(session_info->channel_infos_ht, NULL);
+       }
+       free(session_info->name);
+       free(session_info);
+}
 
-       if (!copy) {
-               goto end;
+static
+void session_info_get(struct session_info *session_info)
+{
+       if (!session_info) {
+               return;
        }
+       lttng_ref_get(&session_info->ref);
+}
 
-       memcpy(copy, channel_info, sizeof(*channel_info));
-       copy->session_name = NULL;
-       copy->channel_name = NULL;
+static
+void session_info_put(struct session_info *session_info)
+{
+       if (!session_info) {
+               return;
+       }
+       lttng_ref_put(&session_info->ref);
+}
+
+static
+struct session_info *session_info_create(const char *name, uid_t uid, gid_t gid)
+{
+       struct session_info *session_info;
+
+       assert(name);
 
-       copy->session_name = strdup(channel_info->session_name);
-       if (!copy->session_name) {
+       session_info = zmalloc(sizeof(*session_info));
+       if (!session_info) {
+               goto end;
+       }
+       lttng_ref_init(&session_info->ref, session_info_destroy);
+
+       session_info->channel_infos_ht = cds_lfht_new(DEFAULT_HT_SIZE,
+                       1, 0, CDS_LFHT_AUTO_RESIZE | CDS_LFHT_ACCOUNTING, NULL);
+       if (!session_info->channel_infos_ht) {
                goto error;
        }
-       copy->channel_name = strdup(channel_info->channel_name);
-       if (!copy->channel_name) {
+
+       cds_lfht_node_init(&session_info->sessions_ht_node);
+       session_info->name = strdup(name);
+       if (!session_info->name) {
                goto error;
        }
+       session_info->uid = uid;
+       session_info->gid = gid;
+end:
+       return session_info;
+error:
+       session_info_put(session_info);
+       return NULL;
+}
+
+static
+void session_info_add_channel(struct session_info *session_info,
+               struct channel_info *channel_info)
+{
+       rcu_read_lock();
+       cds_lfht_add(session_info->channel_infos_ht,
+                       hash_channel_key(&channel_info->key),
+                       &channel_info->session_info_channels_ht_node);
+       rcu_read_unlock();
+}
+
+static
+void session_info_remove_channel(struct session_info *session_info,
+               struct channel_info *channel_info)
+{
+       rcu_read_lock();
+       cds_lfht_del(session_info->channel_infos_ht,
+                       &channel_info->session_info_channels_ht_node);
+       rcu_read_unlock();
+}
+
+static
+struct channel_info *channel_info_create(const char *channel_name,
+               struct channel_key *channel_key, uint64_t channel_capacity,
+               struct session_info *session_info)
+{
+       struct channel_info *channel_info = zmalloc(sizeof(*channel_info));
+
+       if (!channel_info) {
+               goto end;
+       }
+
        cds_lfht_node_init(&channel_info->channels_ht_node);
+       cds_lfht_node_init(&channel_info->session_info_channels_ht_node);
+       memcpy(&channel_info->key, channel_key, sizeof(*channel_key));
+       channel_info->capacity = channel_capacity;
+
+       channel_info->name = strdup(channel_name);
+       if (!channel_info->name) {
+               goto error;
+       }
+
+       /*
+        * Set the references between session and channel infos:
+        *   - channel_info holds a strong reference to session_info
+        *   - session_info holds a weak reference to channel_info
+        */
+       session_info_get(session_info);
+       session_info_add_channel(session_info, channel_info);
+       channel_info->session_info = session_info;
 end:
-       return copy;
+       return channel_info;
 error:
-       channel_info_destroy(copy);
+       channel_info_destroy(channel_info);
        return NULL;
 }
 
@@ -416,7 +524,7 @@ int evaluate_condition_for_client(struct lttng_trigger *trigger,
 
                        assert(current_condition);
                        if (!lttng_condition_is_equal(condition,
-                                               current_condition)) {
+                                       current_condition)) {
                                continue;
                        }
 
@@ -469,7 +577,7 @@ int evaluate_condition_for_client(struct lttng_trigger *trigger,
        ret = evaluate_condition(condition, &evaluation, state, NULL,
                        last_sample, channel_info->capacity);
        if (ret) {
-               WARN("[notification-thread] Fatal error occured while evaluating a newly subscribed-to condition");
+               WARN("[notification-thread] Fatal error occurred while evaluating a newly subscribed-to condition");
                goto end;
        }
 
@@ -495,7 +603,8 @@ int evaluate_condition_for_client(struct lttng_trigger *trigger,
        /* Send evaluation result to the newly-subscribed client. */
        DBG("[notification-thread] Newly subscribed-to condition evaluated to true, notifying client");
        ret = send_evaluation_to_clients(trigger, evaluation, &client_list,
-                       state, channel_info->uid, channel_info->gid);
+                       state, channel_info->session_info->uid,
+                       channel_info->session_info->gid);
 
 end:
        return ret;
@@ -555,12 +664,22 @@ int notification_thread_client_subscribe(struct notification_client *client,
                        &iter);
        node = cds_lfht_iter_get_node(&iter);
        if (!node) {
+               /*
+                * No notification-emiting trigger registered with this
+                * condition. We don't evaluate the condition right away
+                * since this trigger is not registered yet.
+                */
                free(client_list_element);
                goto end_unlock;
        }
 
        client_list = caa_container_of(node, struct notification_client_list,
                        notification_trigger_ht_node);
+       /*
+        * The condition to which the client just subscribed is evaluated
+        * at this point so that conditions that are already TRUE result
+        * in a notification being sent out.
+        */
        if (evaluate_condition_for_client(client_list->trigger, condition,
                        client, state)) {
                WARN("[notification-thread] Evaluation of a condition on client subscription failed, aborting.");
@@ -726,7 +845,7 @@ end:
 
 static
 bool trigger_applies_to_channel(struct lttng_trigger *trigger,
-               struct channel_info *info)
+               struct channel_info *channel_info)
 {
        enum lttng_condition_status status;
        struct lttng_condition *condition;
@@ -750,7 +869,7 @@ bool trigger_applies_to_channel(struct lttng_trigger *trigger,
        status = lttng_condition_buffer_usage_get_domain_type(condition,
                        &trigger_domain);
        assert(status == LTTNG_CONDITION_STATUS_OK);
-       if (info->key.domain != trigger_domain) {
+       if (channel_info->key.domain != trigger_domain) {
                goto fail;
        }
 
@@ -762,10 +881,10 @@ bool trigger_applies_to_channel(struct lttng_trigger *trigger,
                        condition, &trigger_channel_name);
        assert((status == LTTNG_CONDITION_STATUS_OK) && trigger_channel_name);
 
-       if (strcmp(info->session_name, trigger_session_name)) {
+       if (strcmp(channel_info->session_info->name, trigger_session_name)) {
                goto fail;
        }
-       if (strcmp(info->channel_name, trigger_channel_name)) {
+       if (strcmp(channel_info->name, trigger_channel_name)) {
                goto fail;
        }
 
@@ -793,32 +912,91 @@ bool trigger_applies_to_client(struct lttng_trigger *trigger,
        return applies;
 }
 
+static
+int match_session(struct cds_lfht_node *node, const void *key)
+{
+       const char *name = key;
+       struct session_info *session_info = caa_container_of(
+               node, struct session_info, sessions_ht_node);
+
+       return !strcmp(session_info->name, name);
+}
+
+static
+struct session_info *find_or_create_session_info(
+               struct notification_thread_state *state,
+               const char *name, uid_t uid, gid_t gid)
+{
+       struct session_info *session = NULL;
+       struct cds_lfht_node *node;
+       struct cds_lfht_iter iter;
+
+       rcu_read_lock();
+       cds_lfht_lookup(state->sessions_ht,
+                       hash_key_str(name, lttng_ht_seed),
+                       match_session,
+                       name,
+                       &iter);
+       node = cds_lfht_iter_get_node(&iter);
+       if (node) {
+               DBG("[notification-thread] Found session info of session \"%s\" (uid = %i, gid = %i)",
+                               name, uid, gid);
+               session = caa_container_of(node, struct session_info,
+                               sessions_ht_node);
+               assert(session->uid == uid);
+               assert(session->gid == gid);
+               goto end;
+       }
+
+       session = session_info_create(name, uid, gid);
+       if (!session) {
+               ERR("[notification-thread] Failed to allocation session info for session \"%s\" (uid = %i, gid = %i)",
+                               name, uid, gid);
+               goto end;
+       }
+end:
+       rcu_read_unlock();
+       return session;
+}
+
 static
 int handle_notification_thread_command_add_channel(
-       struct notification_thread_state *state,
-       struct channel_info *channel_info,
-       enum lttng_error_code *cmd_result)
+               struct notification_thread_state *state,
+               const char *session_name, uid_t session_uid, gid_t session_gid,
+               const char *channel_name, enum lttng_domain_type channel_domain,
+               uint64_t channel_key_int, uint64_t channel_capacity,
+               enum lttng_error_code *cmd_result)
 {
        struct cds_list_head trigger_list;
-       struct channel_info *new_channel_info;
-       struct channel_key *channel_key;
+       struct channel_info *new_channel_info = NULL;
+       struct channel_key channel_key = {
+               .key = channel_key_int,
+               .domain = channel_domain,
+       };
        struct lttng_channel_trigger_list *channel_trigger_list = NULL;
        struct lttng_trigger_ht_element *trigger_ht_element = NULL;
        int trigger_count = 0;
        struct cds_lfht_iter iter;
+       struct session_info *session_info = NULL;
 
        DBG("[notification-thread] Adding channel %s from session %s, channel key = %" PRIu64 " in %s domain",
-                       channel_info->channel_name, channel_info->session_name,
-                       channel_info->key.key, channel_info->key.domain == LTTNG_DOMAIN_KERNEL ? "kernel" : "user space");
+                       channel_name, session_name, channel_key_int,
+                       channel_domain == LTTNG_DOMAIN_KERNEL ? "kernel" : "user space");
 
        CDS_INIT_LIST_HEAD(&trigger_list);
 
-       new_channel_info = channel_info_copy(channel_info);
-       if (!new_channel_info) {
+       session_info = find_or_create_session_info(state, session_name,
+                       session_uid, session_gid);
+       if (!session_info) {
+               /* Allocation error or an internal error occured. */
                goto error;
        }
 
-       channel_key = &new_channel_info->key;
+       new_channel_info = channel_info_create(channel_name, &channel_key,
+                       channel_capacity, session_info);
+       if (!new_channel_info) {
+               goto error;
+       }
 
        /* Build a list of all triggers applying to the new channel. */
        cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
@@ -826,7 +1004,7 @@ int handle_notification_thread_command_add_channel(
                struct lttng_trigger_list_element *new_element;
 
                if (!trigger_applies_to_channel(trigger_ht_element->trigger,
-                               channel_info)) {
+                               new_channel_info)) {
                        continue;
                }
 
@@ -846,7 +1024,7 @@ int handle_notification_thread_command_add_channel(
        if (!channel_trigger_list) {
                goto error;
        }
-       channel_trigger_list->channel_key = *channel_key;
+       channel_trigger_list->channel_key = new_channel_info->key;
        CDS_INIT_LIST_HEAD(&channel_trigger_list->list);
        cds_lfht_node_init(&channel_trigger_list->channel_triggers_ht_node);
        cds_list_splice(&trigger_list, &channel_trigger_list->list);
@@ -854,21 +1032,21 @@ int handle_notification_thread_command_add_channel(
        rcu_read_lock();
        /* Add channel to the channel_ht which owns the channel_infos. */
        cds_lfht_add(state->channels_ht,
-                       hash_channel_key(channel_key),
+                       hash_channel_key(&new_channel_info->key),
                        &new_channel_info->channels_ht_node);
        /*
         * Add the list of triggers associated with this channel to the
         * channel_triggers_ht.
         */
        cds_lfht_add(state->channel_triggers_ht,
-                       hash_channel_key(channel_key),
+                       hash_channel_key(&new_channel_info->key),
                        &channel_trigger_list->channel_triggers_ht_node);
        rcu_read_unlock();
        *cmd_result = LTTNG_OK;
        return 0;
 error:
-       /* Empty trigger list */
        channel_info_destroy(new_channel_info);
+       session_info_put(session_info);
        return 1;
 }
 
@@ -1004,16 +1182,16 @@ end:
  *       are checked against the channel at that moment.
  *
  * If this function returns a non-zero value, it means something is
- * fundamentally and the whole subsystem/thread will be torn down.
+ * fundamentally broken and the whole subsystem/thread will be torn down.
  *
  * If a non-fatal error occurs, just set the cmd_result to the appropriate
  * error code.
  */
 static
 int handle_notification_thread_command_register_trigger(
-       struct notification_thread_state *state,
-       struct lttng_trigger *trigger,
-       enum lttng_error_code *cmd_result)
+               struct notification_thread_state *state,
+               struct lttng_trigger *trigger,
+               enum lttng_error_code *cmd_result)
 {
        int ret = 0;
        struct lttng_condition *condition;
@@ -1104,11 +1282,6 @@ int handle_notification_thread_command_register_trigger(
        cds_lfht_add(state->notification_trigger_clients_ht,
                        lttng_condition_hash(condition),
                        &client_list->notification_trigger_ht_node);
-       /*
-        * Client list ownership transferred to the
-        * notification_trigger_clients_ht.
-        */
-       client_list = NULL;
 
        /*
         * Add the trigger to list of triggers bound to the channels currently
@@ -1147,6 +1320,47 @@ int handle_notification_thread_command_register_trigger(
                break;
        }
 
+       /*
+        * Since there is nothing preventing clients from subscribing to a
+        * condition before the corresponding trigger is registered, we have
+        * to evaluate this new condition right away.
+        *
+        * At some point, we were waiting for the next "evaluation" (e.g. on
+        * reception of a channel sample) to evaluate this new condition, but
+        * that was broken.
+        *
+        * The reason it was broken is that waiting for the next sample
+        * does not allow us to properly handle transitions for edge-triggered
+        * conditions.
+        *
+        * Consider this example: when we handle a new channel sample, we
+        * evaluate each conditions twice: once with the previous state, and
+        * again with the newest state. We then use those two results to
+        * determine whether a state change happened: a condition was false and
+        * became true. If a state change happened, we have to notify clients.
+        *
+        * Now, if a client subscribes to a given notification and registers
+        * a trigger *after* that subscription, we have to make sure the
+        * condition is evaluated at this point while considering only the
+        * current state. Otherwise, the next evaluation cycle may only see
+        * that the evaluations remain the same (true for samples n-1 and n) and
+        * the client will never know that the condition has been met.
+        */
+       cds_list_for_each_entry_safe(client_list_element, tmp,
+                       &client_list->list, node) {
+               ret = evaluate_condition_for_client(trigger, condition,
+                               client_list_element->client, state);
+               if (ret) {
+                       goto error_free_client_list;
+               }
+       }
+
+       /*
+        * Client list ownership transferred to the
+        * notification_trigger_clients_ht.
+        */
+       client_list = NULL;
+
        *cmd_result = LTTNG_OK;
 error_free_client_list:
        if (client_list) {
@@ -1274,8 +1488,9 @@ int handle_notification_thread_command(
        uint64_t counter;
        struct notification_thread_command *cmd;
 
-       /* Read event_fd to put it back into a quiescent state. */
-       ret = read(handle->cmd_queue.event_fd, &counter, sizeof(counter));
+       /* Read the event pipe to put it back into a quiescent state. */
+       ret = read(lttng_pipe_get_readfd(handle->cmd_queue.event_pipe), &counter,
+                       sizeof(counter));
        if (ret == -1) {
                goto error;
        }
@@ -1299,7 +1514,14 @@ int handle_notification_thread_command(
        case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL:
                DBG("[notification-thread] Received add channel command");
                ret = handle_notification_thread_command_add_channel(
-                               state, &cmd->parameters.add_channel,
+                               state,
+                               cmd->parameters.add_channel.session.name,
+                               cmd->parameters.add_channel.session.uid,
+                               cmd->parameters.add_channel.session.gid,
+                               cmd->parameters.add_channel.channel.name,
+                               cmd->parameters.add_channel.channel.domain,
+                               cmd->parameters.add_channel.channel.key,
+                               cmd->parameters.add_channel.channel.capacity,
                                &cmd->reply_code);
                break;
        case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL:
@@ -1797,10 +2019,6 @@ int client_dispatch_message(struct notification_client *client,
 
                if (client->communication.inbound.msg_type ==
                                LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE) {
-                       /*
-                        * FIXME The current state should be evaluated on
-                        * subscription.
-                        */
                        ret = notification_thread_client_subscribe(client,
                                        condition, state, &status);
                } else {
@@ -2202,9 +2420,9 @@ int handle_notification_thread_channel_sample(
        channel_info = caa_container_of(node, struct channel_info,
                        channels_ht_node);
        DBG("[notification-thread] Handling channel sample for channel %s (key = %" PRIu64 ") in session %s (highest usage = %" PRIu64 ", lowest usage = %" PRIu64")",
-                       channel_info->channel_name,
+                       channel_info->name,
                        latest_sample.key.key,
-                       channel_info->session_name,
+                       channel_info->session_info->name,
                        latest_sample.highest_usage,
                        latest_sample.lowest_usage);
 
@@ -2314,7 +2532,9 @@ int handle_notification_thread_channel_sample(
                /* Dispatch evaluation result to all clients. */
                ret = send_evaluation_to_clients(trigger_list_element->trigger,
                                evaluation, client_list, state,
-                               channel_info->uid, channel_info->gid);
+                               channel_info->session_info->uid,
+                               channel_info->session_info->gid);
+               lttng_evaluation_destroy(evaluation);
                if (ret) {
                        goto end_unlock;
                }
This page took 0.032699 seconds and 5 git commands to generate.