Bind newly registered triggers to session or channel objects
[lttng-tools.git] / src / bin / lttng-sessiond / notification-thread.h
index 2169b2efb69968b2e82ff83434abf45ec904050b..eb8beb0d800588c58293aeb1471c18a040d3f9a8 100644 (file)
@@ -67,12 +67,22 @@ struct notification_thread_handle {
  *   - channel_triggers_ht:
  *             associates a channel key to a list of
  *             struct lttng_trigger_list_nodes. The triggers in this list are
- *             those that have conditions that apply to this channel.
+ *             those that have conditions that apply to a particular channel.
  *             A channel entry is only created when a channel is added; the
  *             list of triggers applying to such a channel is built at that
  *             moment.
  *             This hash table owns the list, but not the triggers themselves.
  *
+ *   - session_triggers_ht:
+ *             associates a session name to a list of
+ *             struct lttng_trigger_list_nodes. The triggers in this list are
+ *             those that have conditions that apply to a particular session.
+ *             A session entry is only created when a session is created; the
+ *             list of triggers applying to this new session is built at that
+ *             moment. This happens at the time of creation of a session_info.
+ *             Likewise, the list is destroyed at the time of the session_info's
+ *             destruction.
+ *
  *   - channel_state_ht:
  *             associates a pair (channel key, channel domain) to its last
  *             sampled state received from the consumer daemon
@@ -110,12 +120,14 @@ struct notification_thread_handle {
  *   3) registration of a trigger,
  *   4) unregistration of a trigger,
  *   5) reception of a channel monitor sample from the consumer daemon.
+ *   6) Session rotation ongoing
+ *   7) Session rotation completed
  *
  * Events specific to notification-emitting triggers:
- *   6) connection of a notification client,
- *   7) disconnection of a notification client,
- *   8) subscription of a client to a conditions' notifications,
- *   9) unsubscription of a client from a conditions' notifications,
+ *   8) connection of a notification client,
+ *   9) disconnection of a notification client,
+ *   10) subscription of a client to a conditions' notifications,
+ *   11) unsubscription of a client from a conditions' notifications,
  *
  *
  * 1) Creation of a tracing channel
@@ -123,12 +135,18 @@ struct notification_thread_handle {
  *      triggers which apply to this new channel,
  *      - triggers identified are added to the channel_triggers_ht.
  *    - add channel to channels_ht
+ *    - if it is the first channel of a session, a session_info is created and
+ *      added to the sessions_ht. A list of the triggers associated with that
+ *      session is built, and it is added to session_triggers_ht.
  *
  * 2) Destruction of a tracing channel
  *    - remove entry from channel_triggers_ht, releasing the list wrapper and
  *      elements,
  *    - remove entry from the channel_state_ht.
  *    - remove channel from channels_ht
+ *    - if it was the last known channel of a session, the session_info
+ *      structure is torndown, which in return destroys the list of triggers
+ *      applying to that session.
  *
  * 3) Registration of a trigger
  *    - if the trigger's action is of type "notify",
@@ -137,6 +155,7 @@ struct notification_thread_handle {
  *        - add list of clients (even if it is empty) to the
  *          notification_trigger_clients_ht,
  *    - add trigger to channel_triggers_ht (if applicable),
+ *    - add trigger to session_triggers_ht (if applicable),
  *    - add trigger to triggers_ht
  *    - evaluate the trigger's condition right away to react if that condition
  *      is true from the beginning.
@@ -145,6 +164,7 @@ struct notification_thread_handle {
  *    - if the trigger's action is of type "notify",
  *      - remove the trigger from the notification_trigger_clients_ht,
  *    - remove trigger from channel_triggers_ht (if applicable),
+ *    - remove trigger from session_triggers_ht (if applicable),
  *    - remove trigger from triggers_ht
  *
  * 5) Reception of a channel monitor sample from the consumer daemon
@@ -154,22 +174,26 @@ struct notification_thread_handle {
  *        "notify", query the notification_trigger_clients_ht and send
  *        a notification to the clients.
  *
- * 6) Connection of a client
+ * 6) Session rotation ongoing
+ *
+ * 7) Session rotation completed
+ *
+ * 8) Connection of a client
  *    - add client socket to the client_socket_ht.
  *
- * 7) Disconnection of a client
+ * 9) Disconnection of a client
  *    - remove client socket from the client_socket_ht,
  *    - traverse all conditions to which the client is subscribed and remove
  *      the client from the notification_trigger_clients_ht.
  *
- * 8) Subscription of a client to a condition's notifications
+ * 10) Subscription of a client to a condition's notifications
  *    - Add the condition to the client's list of subscribed conditions,
  *    - Look-up notification_trigger_clients_ht and add the client to
  *      list of clients.
  *    - Evaluate the condition for the client that subscribed if the trigger
  *      was already registered.
  *
- * 9) Unsubscription of a client to a condition's notifications
+ * 11) Unsubscription of a client to a condition's notifications
  *    - Remove the condition from the client's list of subscribed conditions,
  *    - Look-up notification_trigger_clients_ht and remove the client
  *      from the list of clients.
@@ -179,6 +203,7 @@ struct notification_thread_state {
        struct lttng_poll_event events;
        struct cds_lfht *client_socket_ht;
        struct cds_lfht *channel_triggers_ht;
+       struct cds_lfht *session_triggers_ht;
        struct cds_lfht *channel_state_ht;
        struct cds_lfht *notification_trigger_clients_ht;
        struct cds_lfht *channels_ht;
This page took 0.025539 seconds and 5 git commands to generate.