2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #ifndef LTTNG_TRIGGER_INTERNAL_H
9 #define LTTNG_TRIGGER_INTERNAL_H
11 #include <common/credentials.h>
12 #include <common/dynamic-array.h>
13 #include <common/macros.h>
14 #include <common/optional.h>
15 #include <lttng/lttng.h>
19 #include <sys/types.h>
23 struct lttng_payload_view
;
25 struct mi_lttng_error_query_callbacks
;
27 struct lttng_trigger
{
28 /* Reference counting is only exposed to internal users. */
31 struct lttng_condition
*condition
;
32 struct lttng_action
*action
;
34 /* For now only the uid portion of the credentials is used. */
35 struct lttng_credentials creds
;
38 * The unique token passed to the tracer to identify an event-rule
41 LTTNG_OPTIONAL(uint64_t) tracer_token
;
44 * Is the trigger registered?
46 * This is necessary since a reference holder might be interested in the
47 * overall state of the trigger from the point of view of its owner.
49 * The main user is the action executor since we want to prevent the
50 * execution of actions related to a trigger that is unregistered.
52 * Not considered for `is_equal`.
57 * The lock is used to protect against concurrent trigger execution and
63 struct lttng_triggers
{
64 struct lttng_dynamic_pointer_array array
;
67 struct lttng_trigger_comm
{
69 * Credentials, only the uid portion is used for now.
70 * Used as an override when desired by the root user.
74 * Length of the variable length payload (name, condition, and
78 /* Includes '\0' terminator. */
80 /* A null-terminated name, a condition, and an action follow. */
84 struct lttng_triggers_comm
{
87 /* Count * lttng_trigger_comm structure */
92 ssize_t
lttng_trigger_create_from_payload(struct lttng_payload_view
*view
,
93 struct lttng_trigger
**trigger
);
96 int lttng_trigger_serialize(const struct lttng_trigger
*trigger
,
97 struct lttng_payload
*payload
);
100 bool lttng_trigger_validate(const struct lttng_trigger
*trigger
);
103 int lttng_trigger_assign_name(
104 struct lttng_trigger
*dst
, const struct lttng_trigger
*src
);
107 void lttng_trigger_set_tracer_token(
108 struct lttng_trigger
*trigger
, uint64_t token
);
111 uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger
*trigger
);
114 int lttng_trigger_generate_name(struct lttng_trigger
*trigger
,
118 bool lttng_trigger_is_equal(
119 const struct lttng_trigger
*a
, const struct lttng_trigger
*b
);
122 void lttng_trigger_get(struct lttng_trigger
*trigger
);
125 void lttng_trigger_put(struct lttng_trigger
*trigger
);
128 * Serialize a trigger to a mi_writer.
129 * Return LTTNG_OK in success, other enum lttng_error_code on error.
132 enum lttng_error_code
lttng_trigger_mi_serialize(const struct lttng_trigger
*trigger
,
133 struct mi_writer
*writer
,
134 const struct mi_lttng_error_query_callbacks
135 *error_query_callbacks
);
138 * Allocate a new set of triggers.
139 * The returned object must be freed via lttng_triggers_destroy.
142 struct lttng_triggers
*lttng_triggers_create(void);
145 * Return the a pointer to a mutable element at index "index" of an
146 * lttng_triggers set.
148 * This differs from the public `lttng_triggers_get_at_index` in that
149 * the returned pointer to a mutable trigger.
151 * The ownership of the trigger set element is NOT transfered.
152 * The returned object can NOT be freed via lttng_trigger_destroy.
155 struct lttng_trigger
*lttng_triggers_borrow_mutable_at_index(
156 const struct lttng_triggers
*triggers
, unsigned int index
);
159 * Add a trigger to the triggers set.
161 * A reference to the added trigger is acquired on behalf of the trigger set
165 int lttng_triggers_add(
166 struct lttng_triggers
*triggers
, struct lttng_trigger
*trigger
);
169 * Serialize a trigger set to an lttng_payload object.
170 * Return LTTNG_OK on success, negative lttng error code on error.
173 int lttng_triggers_serialize(const struct lttng_triggers
*triggers
,
174 struct lttng_payload
*payload
);
177 ssize_t
lttng_triggers_create_from_payload(struct lttng_payload_view
*view
,
178 struct lttng_triggers
**triggers
);
181 * Serialize a trigger set to a mi_writer.
182 * Return LTTNG_OK in success, other enum lttng_error_code on error.
185 enum lttng_error_code
lttng_triggers_mi_serialize(const struct lttng_triggers
*triggers
,
186 struct mi_writer
*writer
,
187 const struct mi_lttng_error_query_callbacks
188 *error_query_callbacks
);
191 const struct lttng_credentials
*lttng_trigger_get_credentials(
192 const struct lttng_trigger
*trigger
);
195 void lttng_trigger_set_credentials(struct lttng_trigger
*trigger
,
196 const struct lttng_credentials
*creds
);
199 * Return the type of any underlying domain restriction. If no particular
200 * requirement is present, returns LTTNG_DOMAIN_NONE.
203 enum lttng_domain_type
lttng_trigger_get_underlying_domain_type_restriction(
204 const struct lttng_trigger
*trigger
);
207 * Generate any bytecode related to the trigger.
208 * On success LTTNG_OK. On error, returns lttng_error code.
211 enum lttng_error_code
lttng_trigger_generate_bytecode(
212 struct lttng_trigger
*trigger
,
213 const struct lttng_credentials
*creds
);
216 * Note that the trigger object is not locked by "copy" as it is const and
217 * used with a number of 'const' triggers. If the trigger could be shared at
218 * the moment of the copy, it is the caller's responsability to lock it for
219 * the duration of the copy.
222 struct lttng_trigger
*lttng_trigger_copy(const struct lttng_trigger
*trigger
);
225 * A given trigger needs a tracer notifier if
226 * it has an event-rule condition,
228 * it has one or more sessiond-execution action.
231 bool lttng_trigger_needs_tracer_notifier(const struct lttng_trigger
*trigger
);
234 void lttng_trigger_set_as_registered(struct lttng_trigger
*trigger
);
237 void lttng_trigger_set_as_unregistered(struct lttng_trigger
*trigger
);
240 * The trigger must be locked before calling lttng_trigger_is_registered.
242 * The lock is necessary since a trigger can be unregistered at any time.
244 * Manipulations requiring that the trigger be registered must always acquire
245 * the trigger lock for the duration of the manipulation using
246 * `lttng_trigger_lock` and `lttng_trigger_unlock`.
249 bool lttng_trigger_is_registered(struct lttng_trigger
*trigger
);
252 void lttng_trigger_lock(struct lttng_trigger
*trigger
);
255 void lttng_trigger_unlock(struct lttng_trigger
*trigger
);
258 enum lttng_trigger_status
lttng_trigger_add_error_results(
259 const struct lttng_trigger
*trigger
,
260 struct lttng_error_query_results
*results
);
263 enum lttng_trigger_status
lttng_trigger_condition_add_error_results(
264 const struct lttng_trigger
*trigger
,
265 struct lttng_error_query_results
*results
);
268 enum lttng_trigger_status
lttng_trigger_add_action_error_query_results(
269 struct lttng_trigger
*trigger
,
270 struct lttng_error_query_results
*results
);
273 * Set the trigger name.
275 * A name is optional.
276 * A name will be assigned on trigger registration if no name is set.
278 * The name is copied.
280 * Return LTTNG_TRIGGER_STATUS_OK on success, LTTNG_TRIGGER_STATUS_INVALID
281 * if invalid parameters are passed.
284 enum lttng_trigger_status
lttng_trigger_set_name(
285 struct lttng_trigger
*trigger
, const char *name
);
287 #endif /* LTTNG_TRIGGER_INTERNAL_H */