2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
8 #ifndef NOTIFICATION_THREAD_COMMANDS_H
9 #define NOTIFICATION_THREAD_COMMANDS_H
11 #include <lttng/domain.h>
12 #include <lttng/lttng-error.h>
13 #include <urcu/rculfhash.h>
14 #include "notification-thread.h"
15 #include "notification-thread-internal.h"
16 #include "notification-thread-events.h"
17 #include <common/waiter.h>
20 struct notification_thread_data
;
23 enum notification_thread_command_type
{
24 NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER
,
25 NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER
,
26 NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL
,
27 NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL
,
28 NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
,
29 NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
,
30 NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE
,
31 NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE
,
32 NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS
,
33 NOTIFICATION_COMMAND_TYPE_QUIT
,
34 NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE
,
35 NOTIFICATION_COMMAND_TYPE_GET_TRIGGER
,
38 struct notification_thread_command
{
39 struct cds_list_head cmd_list_node
;
41 enum notification_thread_command_type type
;
43 /* Register trigger. */
45 struct lttng_trigger
*trigger
;
47 /* Unregister trigger. */
49 const struct lttng_trigger
*trigger
;
60 enum lttng_domain_type domain
;
68 enum lttng_domain_type domain
;
71 const char *session_name
;
74 uint64_t trace_archive_chunk_id
;
75 struct lttng_trace_archive_location
*location
;
77 /* Add/Remove tracer event source fd. */
79 int tracer_event_source_fd
;
80 enum lttng_domain_type domain
;
81 } tracer_event_source
;
84 /* Credentials of the requesting user. */
87 /* Client communication update. */
89 notification_client_id id
;
90 enum client_transmission_status status
;
91 } client_communication_update
;
94 const struct lttng_trigger
*trigger
;
101 struct lttng_triggers
*triggers
;
104 struct lttng_trigger
*trigger
;
107 /* lttng_waiter on which to wait for command reply (optional). */
108 struct lttng_waiter reply_waiter
;
109 enum lttng_error_code reply_code
;
113 enum lttng_error_code
notification_thread_command_register_trigger(
114 struct notification_thread_handle
*handle
,
115 struct lttng_trigger
*trigger
);
117 enum lttng_error_code
notification_thread_command_unregister_trigger(
118 struct notification_thread_handle
*handle
,
119 const struct lttng_trigger
*trigger
);
121 enum lttng_error_code
notification_thread_command_add_channel(
122 struct notification_thread_handle
*handle
,
123 char *session_name
, uid_t session_uid
, gid_t session_gid
,
124 char *channel_name
, uint64_t key
,
125 enum lttng_domain_type domain
, uint64_t capacity
);
127 enum lttng_error_code
notification_thread_command_remove_channel(
128 struct notification_thread_handle
*handle
,
129 uint64_t key
, enum lttng_domain_type domain
);
131 enum lttng_error_code
notification_thread_command_session_rotation_ongoing(
132 struct notification_thread_handle
*handle
,
133 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
134 uint64_t trace_archive_chunk_id
);
136 /* Ownership of location is transferred. */
137 enum lttng_error_code
notification_thread_command_session_rotation_completed(
138 struct notification_thread_handle
*handle
,
139 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
140 uint64_t trace_archive_chunk_id
,
141 struct lttng_trace_archive_location
*location
);
144 * Return the set of triggers visible to a given client.
146 * The trigger objects contained in the set are the actual trigger instances
147 * used by the notification subsystem (i.e. not a copy). Given that the command
148 * is only used to serialize the triggers, this is fine: the properties that
149 * are serialized are immutable over the lifetime of the triggers.
151 * Moreover, the lifetime of the trigger instances is protected through
152 * reference counting (references are held by the trigger set).
154 * The caller has the exclusive ownership of the returned trigger set.
156 enum lttng_error_code
notification_thread_command_list_triggers(
157 struct notification_thread_handle
*handle
,
159 struct lttng_triggers
**triggers
);
162 * The ownership of trigger_event_application_pipe is _not_ transferred to
163 * the notification thread.
165 enum lttng_error_code
notification_thread_command_add_tracer_event_source(
166 struct notification_thread_handle
*handle
,
167 int tracer_event_source_fd
,
168 enum lttng_domain_type domain
);
170 enum lttng_error_code
notification_thread_command_remove_tracer_event_source(
171 struct notification_thread_handle
*handle
,
172 int tracer_event_source_fd
);
174 void notification_thread_command_quit(
175 struct notification_thread_handle
*handle
);
177 enum lttng_error_code
notification_thread_command_get_trigger(
178 struct notification_thread_handle
*handle
,
179 const struct lttng_trigger
*trigger
,
180 struct lttng_trigger
**real_trigger
);
182 #endif /* NOTIFICATION_THREAD_COMMANDS_H */