2 * Copyright (C) 2019 Jonathan Rajotte
3 * <jonathan.rajotte-julien@efficios.com>
5 * SPDX-License-Identifier: LGPL-2.1-only
10 #include <common/buffer-view.h>
11 #include <common/dynamic-buffer.h>
12 #include <common/error.h>
13 #include <common/macros.h>
14 #include <lttng/event-rule/event-rule-internal.h>
15 #include <lttng/event-rule/kprobe-internal.h>
16 #include <lttng/event-rule/kretprobe-internal.h>
17 #include <lttng/event-rule/syscall-internal.h>
18 #include <lttng/event-rule/tracepoint-internal.h>
19 #include <lttng/event-rule/uprobe-internal.h>
22 enum lttng_event_rule_type
lttng_event_rule_get_type(
23 const struct lttng_event_rule
*event_rule
)
25 return event_rule
? event_rule
->type
: LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
29 enum lttng_domain_type
lttng_event_rule_get_domain_type(
30 const struct lttng_event_rule
*event_rule
)
32 enum lttng_domain_type domain_type
;
34 switch (lttng_event_rule_get_type(event_rule
)) {
35 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
36 (void) lttng_event_rule_tracepoint_get_domain_type(event_rule
, &domain_type
);
38 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
39 case LTTNG_EVENT_RULE_TYPE_KPROBE
:
40 case LTTNG_EVENT_RULE_TYPE_KRETPROBE
:
41 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
42 domain_type
= LTTNG_DOMAIN_KERNEL
;
44 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
45 domain_type
= LTTNG_DOMAIN_NONE
;
52 static void lttng_event_rule_release(struct urcu_ref
*ref
)
54 struct lttng_event_rule
*event_rule
=
55 container_of(ref
, typeof(*event_rule
), ref
);
57 assert(event_rule
->destroy
);
58 event_rule
->destroy(event_rule
);
61 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
63 lttng_event_rule_put(event_rule
);
67 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
76 if (!event_rule
->validate
) {
77 /* Sub-class guarantees that it can never be invalid. */
82 valid
= event_rule
->validate(event_rule
);
88 int lttng_event_rule_serialize(const struct lttng_event_rule
*event_rule
,
89 struct lttng_dynamic_buffer
*buf
,
93 struct lttng_event_rule_comm event_rule_comm
= {0};
100 event_rule_comm
.event_rule_type
= (int8_t) event_rule
->type
;
102 ret
= lttng_dynamic_buffer_append(
103 buf
, &event_rule_comm
, sizeof(event_rule_comm
));
108 ret
= event_rule
->serialize(event_rule
, buf
, fd_to_send
);
117 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
118 const struct lttng_event_rule
*b
)
120 bool is_equal
= false;
126 if (a
->type
!= b
->type
) {
135 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
141 ssize_t
lttng_event_rule_create_from_buffer(
142 const struct lttng_buffer_view
*buffer
,
143 struct lttng_event_rule
**event_rule
)
145 ssize_t ret
, event_rule_size
= 0;
146 const struct lttng_event_rule_comm
*event_rule_comm
;
147 event_rule_create_from_buffer_cb create_from_buffer
= NULL
;
149 if (!buffer
|| !event_rule
) {
154 DBG("Deserializing event_rule from buffer");
155 event_rule_comm
= (const struct lttng_event_rule_comm
*) buffer
->data
;
156 event_rule_size
+= sizeof(*event_rule_comm
);
158 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
159 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
161 lttng_event_rule_tracepoint_create_from_buffer
;
163 case LTTNG_EVENT_RULE_TYPE_KPROBE
:
164 create_from_buffer
= lttng_event_rule_kprobe_create_from_buffer
;
166 case LTTNG_EVENT_RULE_TYPE_KRETPROBE
:
168 lttng_event_rule_kretprobe_create_from_buffer
;
170 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
171 create_from_buffer
= lttng_event_rule_uprobe_create_from_buffer
;
173 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
175 lttng_event_rule_syscall_create_from_buffer
;
178 ERR("Attempted to create event rule of unknown type (%i)",
179 (int) event_rule_comm
->event_rule_type
);
184 if (create_from_buffer
) {
185 const struct lttng_buffer_view view
=
186 lttng_buffer_view_from_view(buffer
,
187 sizeof(*event_rule_comm
), -1);
189 ret
= create_from_buffer(&view
, event_rule
);
193 event_rule_size
+= ret
;
199 ret
= event_rule_size
;
205 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
206 enum lttng_event_rule_type type
)
208 urcu_ref_init(&event_rule
->ref
);
209 event_rule
->type
= type
;
213 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
215 return urcu_ref_get_unless_zero(&event_rule
->ref
);
219 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
224 assert(event_rule
->ref
.refcount
);
225 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
229 enum lttng_error_code
lttng_event_rule_populate(
230 struct lttng_event_rule
*rule
, uid_t uid
, gid_t gid
)
232 assert(rule
->populate
);
233 return rule
->populate(rule
, uid
, gid
);
236 /* If not present return NULL
237 * Caller DO NOT own the returned object
240 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
242 assert(rule
->get_filter
);
243 return rule
->get_filter(rule
);
246 /* If not present return NULL
247 * Caller DO NOT own the returned object
250 const struct lttng_bytecode
*lttng_event_rule_get_filter_bytecode(
251 const struct lttng_event_rule
*rule
)
253 assert(rule
->get_filter_bytecode
);
254 return rule
->get_filter_bytecode(rule
);
258 * If not present return NULL
259 * Caller OWN the returned object
260 * TODO: should this be done another way?
263 struct lttng_event_exclusion
*lttng_event_rule_generate_exclusions(
264 struct lttng_event_rule
*rule
)
266 assert(rule
->generate_exclusions
);
267 return rule
->generate_exclusions(rule
);
271 struct lttng_event
*lttng_event_rule_generate_lttng_event(
272 const struct lttng_event_rule
*rule
)
274 assert(rule
->generate_lttng_event
);
275 return rule
->generate_lttng_event(rule
);
279 bool lttng_event_rule_is_agent(const struct lttng_event_rule
*rule
)
282 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
285 case LTTNG_DOMAIN_JUL
:
286 case LTTNG_DOMAIN_LOG4J
:
287 case LTTNG_DOMAIN_PYTHON
:
290 case LTTNG_DOMAIN_UST
:
291 case LTTNG_DOMAIN_KERNEL
:
301 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
304 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
307 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
310 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
313 case LTTNG_EVENT_RULE_TYPE_KPROBE
:
316 case LTTNG_EVENT_RULE_TYPE_KRETPROBE
:
319 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
320 return "userspace-probe";