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
;
35 * The unique token passed to the tracer to identify an event-rule
38 LTTNG_OPTIONAL(uint64_t) tracer_token
;
41 struct lttng_triggers
{
42 struct lttng_dynamic_pointer_array array
;
45 struct lttng_trigger_comm
{
47 * Credentials, only the uid portion is used for now.
48 * Used as an override when desired by the root user.
52 * Length of the variable length payload (name, condition, and
56 /* Includes '\0' terminator. */
58 /* A null-terminated name, a condition, and an action follow. */
62 struct lttng_triggers_comm
{
65 /* Count * lttng_trigger_comm structure */
70 ssize_t
lttng_trigger_create_from_payload(struct lttng_payload_view
*view
,
71 struct lttng_trigger
**trigger
);
74 int lttng_trigger_serialize(const struct lttng_trigger
*trigger
,
75 struct lttng_payload
*payload
);
78 bool lttng_trigger_validate(const struct lttng_trigger
*trigger
);
81 int lttng_trigger_assign_name(
82 struct lttng_trigger
*dst
, const struct lttng_trigger
*src
);
85 void lttng_trigger_set_tracer_token(
86 struct lttng_trigger
*trigger
, uint64_t token
);
89 uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger
*trigger
);
92 int lttng_trigger_generate_name(struct lttng_trigger
*trigger
,
96 bool lttng_trigger_is_equal(
97 const struct lttng_trigger
*a
, const struct lttng_trigger
*b
);
100 void lttng_trigger_get(struct lttng_trigger
*trigger
);
103 void lttng_trigger_put(struct lttng_trigger
*trigger
);
106 * Allocate a new set of triggers.
107 * The returned object must be freed via lttng_triggers_destroy.
110 struct lttng_triggers
*lttng_triggers_create(void);
113 * Return the a pointer to a mutable element at index "index" of an
114 * lttng_triggers set.
116 * This differs from the public `lttng_triggers_get_at_index` in that
117 * the returned pointer to a mutable trigger.
119 * The ownership of the trigger set element is NOT transfered.
120 * The returned object can NOT be freed via lttng_trigger_destroy.
123 struct lttng_trigger
*lttng_triggers_borrow_mutable_at_index(
124 const struct lttng_triggers
*triggers
, unsigned int index
);
127 * Add a trigger to the triggers set.
129 * A reference to the added trigger is acquired on behalf of the trigger set
133 int lttng_triggers_add(
134 struct lttng_triggers
*triggers
, struct lttng_trigger
*trigger
);
137 * Serialize a trigger set to an lttng_payload object.
138 * Return LTTNG_OK on success, negative lttng error code on error.
141 int lttng_triggers_serialize(const struct lttng_triggers
*triggers
,
142 struct lttng_payload
*payload
);
145 ssize_t
lttng_triggers_create_from_payload(struct lttng_payload_view
*view
,
146 struct lttng_triggers
**triggers
);
149 const struct lttng_credentials
*lttng_trigger_get_credentials(
150 const struct lttng_trigger
*trigger
);
153 void lttng_trigger_set_credentials(struct lttng_trigger
*trigger
,
154 const struct lttng_credentials
*creds
);
157 * Return the type of any underlying domain restriction. If no particular
158 * requirement is present, returns LTTNG_DOMAIN_NONE.
161 enum lttng_domain_type
lttng_trigger_get_underlying_domain_type_restriction(
162 const struct lttng_trigger
*trigger
);
165 * Generate any bytecode related to the trigger.
166 * On success LTTNG_OK. On error, returns lttng_error code.
169 enum lttng_error_code
lttng_trigger_generate_bytecode(
170 struct lttng_trigger
*trigger
,
171 const struct lttng_credentials
*creds
);
174 struct lttng_trigger
*lttng_trigger_copy(const struct lttng_trigger
*trigger
);
177 * A given trigger needs a tracer notifier if
178 * it has an event-rule condition,
180 * it has one or more sessiond-execution action.
183 bool lttng_trigger_needs_tracer_notifier(const struct lttng_trigger
*trigger
);
185 #endif /* LTTNG_TRIGGER_INTERNAL_H */