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 <lttng/trigger/trigger.h>
12 #include <common/credentials.h>
13 #include <common/dynamic-array.h>
14 #include <common/macros.h>
15 #include <common/optional.h>
18 #include <sys/types.h>
22 struct lttng_payload_view
;
24 struct lttng_trigger
{
25 /* Reference counting is only exposed to internal users. */
28 struct lttng_condition
*condition
;
29 struct lttng_action
*action
;
31 /* For now only the uid portion of the credentials is used. */
32 struct lttng_credentials creds
;
34 enum lttng_trigger_firing_policy type
;
36 uint64_t current_count
;
40 * The unique token passed to the tracer to identify an event-rule
43 LTTNG_OPTIONAL(uint64_t) tracer_token
;
46 struct lttng_triggers
{
47 struct lttng_dynamic_pointer_array array
;
50 struct lttng_trigger_comm
{
52 * Credentials, only the uid portion is used for now.
53 * Used as an override when desired by the root user.
57 * Length of the variable length payload (name, condition, and
61 /* Includes '\0' terminator. */
64 /* Maps to enum lttng_trigger_firing_policy. */
65 uint8_t firing_policy_type
;
66 uint64_t firing_policy_threshold
;
67 /* A null-terminated name, a condition, and an action follow. */
71 struct lttng_triggers_comm
{
74 /* Count * lttng_trigger_comm structure */
79 ssize_t
lttng_trigger_create_from_payload(struct lttng_payload_view
*view
,
80 struct lttng_trigger
**trigger
);
83 int lttng_trigger_serialize(const struct lttng_trigger
*trigger
,
84 struct lttng_payload
*payload
);
87 bool lttng_trigger_validate(const struct lttng_trigger
*trigger
);
90 int lttng_trigger_assign_name(
91 struct lttng_trigger
*dst
, const struct lttng_trigger
*src
);
94 void lttng_trigger_set_tracer_token(
95 struct lttng_trigger
*trigger
, uint64_t token
);
98 uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger
*trigger
);
101 int lttng_trigger_generate_name(struct lttng_trigger
*trigger
,
105 bool lttng_trigger_is_equal(
106 const struct lttng_trigger
*a
, const struct lttng_trigger
*b
);
109 void lttng_trigger_get(struct lttng_trigger
*trigger
);
112 void lttng_trigger_put(struct lttng_trigger
*trigger
);
115 * Allocate a new set of triggers.
116 * The returned object must be freed via lttng_triggers_destroy.
119 struct lttng_triggers
*lttng_triggers_create(void);
122 * Return the a pointer to a mutable element at index "index" of an
123 * lttng_triggers set.
125 * This differs from the public `lttng_triggers_get_at_index` in that
126 * the returned pointer to a mutable trigger.
128 * The ownership of the trigger set element is NOT transfered.
129 * The returned object can NOT be freed via lttng_trigger_destroy.
132 struct lttng_trigger
*lttng_triggers_borrow_mutable_at_index(
133 const struct lttng_triggers
*triggers
, unsigned int index
);
136 * Add a trigger to the triggers set.
138 * A reference to the added trigger is acquired on behalf of the trigger set
142 int lttng_triggers_add(
143 struct lttng_triggers
*triggers
, struct lttng_trigger
*trigger
);
146 * Serialize a trigger set to an lttng_payload object.
147 * Return LTTNG_OK on success, negative lttng error code on error.
150 int lttng_triggers_serialize(const struct lttng_triggers
*triggers
,
151 struct lttng_payload
*payload
);
154 ssize_t
lttng_triggers_create_from_payload(struct lttng_payload_view
*view
,
155 struct lttng_triggers
**triggers
);
158 const struct lttng_credentials
*lttng_trigger_get_credentials(
159 const struct lttng_trigger
*trigger
);
162 void lttng_trigger_set_credentials(struct lttng_trigger
*trigger
,
163 const struct lttng_credentials
*creds
);
168 * Increments the occurrence count.
171 void lttng_trigger_fire(struct lttng_trigger
*trigger
);
174 * Check if the trigger would fire.
177 bool lttng_trigger_should_fire(const struct lttng_trigger
*trigger
);
180 * Return the type of any underlying domain restriction. If no particular
181 * requirement is present, returns LTTNG_DOMAIN_NONE.
184 enum lttng_domain_type
lttng_trigger_get_underlying_domain_type_restriction(
185 const struct lttng_trigger
*trigger
);
188 * Generate any bytecode related to the trigger.
189 * On success LTTNG_OK. On error, returns lttng_error code.
192 enum lttng_error_code
lttng_trigger_generate_bytecode(
193 struct lttng_trigger
*trigger
,
194 const struct lttng_credentials
*creds
);
197 struct lttng_trigger
*lttng_trigger_copy(const struct lttng_trigger
*trigger
);
200 * A given trigger needs a tracer notifier if
201 * it has an event-rule condition,
203 * it has one or more sessiond-execution action.
206 bool lttng_trigger_needs_tracer_notifier(const struct lttng_trigger
*trigger
);
208 #endif /* LTTNG_TRIGGER_INTERNAL_H */