2 * Copyright (C) 2019 - Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
4 * This library is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License, version 2.1 only,
6 * as published by the Free Software Foundation.
8 * This library is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
13 * You should have received a copy of the GNU Lesser General Public License
14 * along with this library; if not, write to the Free Software Foundation,
15 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 #include <lttng/event-rule/event-rule-internal.h>
19 #include <lttng/event-rule/kprobe-internal.h>
20 #include <lttng/event-rule/kretprobe-internal.h>
21 #include <lttng/event-rule/uprobe-internal.h>
22 #include <lttng/event-rule/syscall-internal.h>
23 #include <lttng/event-rule/tracepoint-internal.h>
24 #include <common/macros.h>
25 #include <common/error.h>
26 #include <common/dynamic-buffer.h>
27 #include <common/buffer-view.h>
31 enum lttng_event_rule_type
lttng_event_rule_get_type(
32 const struct lttng_event_rule
*event_rule
)
34 return event_rule
? event_rule
->type
: LTTNG_EVENT_RULE_TYPE_UNKNOWN
;
38 enum lttng_domain_type
lttng_event_rule_get_domain_type(
39 const struct lttng_event_rule
*event_rule
)
41 enum lttng_domain_type domain_type
;
43 switch (lttng_event_rule_get_type(event_rule
)) {
44 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
45 (void) lttng_event_rule_tracepoint_get_domain_type(event_rule
, &domain_type
);
47 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
48 case LTTNG_EVENT_RULE_TYPE_KPROBE
:
49 case LTTNG_EVENT_RULE_TYPE_KRETPROBE
:
50 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
51 domain_type
= LTTNG_DOMAIN_KERNEL
;
53 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
54 domain_type
= LTTNG_DOMAIN_NONE
;
62 void lttng_event_rule_release(struct urcu_ref
*ref
)
65 struct lttng_event_rule
*event_rule
= container_of(ref
, typeof(*event_rule
),
68 assert(event_rule
->destroy
);
69 event_rule
->destroy(event_rule
);
72 void lttng_event_rule_destroy(struct lttng_event_rule
*event_rule
)
74 lttng_event_rule_put(event_rule
);
78 bool lttng_event_rule_validate(const struct lttng_event_rule
*event_rule
)
87 if (!event_rule
->validate
) {
88 /* Sub-class guarantees that it can never be invalid. */
93 valid
= event_rule
->validate(event_rule
);
99 int lttng_event_rule_serialize(const struct lttng_event_rule
*event_rule
,
100 struct lttng_dynamic_buffer
*buf
,
104 struct lttng_event_rule_comm event_rule_comm
= { 0 };
111 event_rule_comm
.event_rule_type
= (int8_t) event_rule
->type
;
113 ret
= lttng_dynamic_buffer_append(buf
, &event_rule_comm
,
114 sizeof(event_rule_comm
));
119 ret
= event_rule
->serialize(event_rule
, buf
, fd_to_send
);
128 bool lttng_event_rule_is_equal(const struct lttng_event_rule
*a
,
129 const struct lttng_event_rule
*b
)
131 bool is_equal
= false;
137 if (a
->type
!= b
->type
) {
146 is_equal
= a
->equal
? a
->equal(a
, b
) : true;
152 ssize_t
lttng_event_rule_create_from_buffer(
153 const struct lttng_buffer_view
*buffer
,
154 struct lttng_event_rule
**event_rule
)
156 ssize_t ret
, event_rule_size
= 0;
157 const struct lttng_event_rule_comm
*event_rule_comm
;
158 event_rule_create_from_buffer_cb create_from_buffer
= NULL
;
160 if (!buffer
|| !event_rule
) {
165 DBG("Deserializing event_rule from buffer");
166 event_rule_comm
= (const struct lttng_event_rule_comm
*) buffer
->data
;
167 event_rule_size
+= sizeof(*event_rule_comm
);
169 switch ((enum lttng_event_rule_type
) event_rule_comm
->event_rule_type
) {
170 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
171 create_from_buffer
= lttng_event_rule_tracepoint_create_from_buffer
;
173 case LTTNG_EVENT_RULE_TYPE_KPROBE
:
174 create_from_buffer
= lttng_event_rule_kprobe_create_from_buffer
;
176 case LTTNG_EVENT_RULE_TYPE_KRETPROBE
:
177 create_from_buffer
= lttng_event_rule_kretprobe_create_from_buffer
;
179 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
180 create_from_buffer
= lttng_event_rule_uprobe_create_from_buffer
;
182 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
183 create_from_buffer
= lttng_event_rule_syscall_create_from_buffer
;
186 ERR("Attempted to create event rule of unknown type (%i)",
187 (int) event_rule_comm
->event_rule_type
);
192 if (create_from_buffer
) {
193 const struct lttng_buffer_view view
=
194 lttng_buffer_view_from_view(buffer
,
195 sizeof(*event_rule_comm
), -1);
197 ret
= create_from_buffer(&view
, event_rule
);
201 event_rule_size
+= ret
;
207 ret
= event_rule_size
;
213 void lttng_event_rule_init(struct lttng_event_rule
*event_rule
,
214 enum lttng_event_rule_type type
)
216 urcu_ref_init(&event_rule
->ref
);
217 event_rule
->type
= type
;
221 bool lttng_event_rule_get(struct lttng_event_rule
*event_rule
)
223 return urcu_ref_get_unless_zero(&event_rule
->ref
);
227 void lttng_event_rule_put(struct lttng_event_rule
*event_rule
)
232 assert(event_rule
->ref
.refcount
);
233 urcu_ref_put(&event_rule
->ref
, lttng_event_rule_release
);
237 enum lttng_error_code
lttng_event_rule_populate(struct lttng_event_rule
*rule
, uid_t uid
, gid_t gid
)
239 assert(rule
->populate
);
240 return rule
->populate(rule
, uid
, gid
);
243 /* If not present return NULL
244 * Caller DO NOT own the returned object
247 const char *lttng_event_rule_get_filter(const struct lttng_event_rule
*rule
)
249 assert(rule
->get_filter
);
250 return rule
->get_filter(rule
);
253 /* If not present return NULL
254 * Caller DO NOT own the returned object
257 const struct lttng_filter_bytecode
*lttng_event_rule_get_filter_bytecode(
258 const struct lttng_event_rule
*rule
)
260 assert(rule
->get_filter_bytecode
);
261 return rule
->get_filter_bytecode(rule
);
265 * If not present return NULL
266 * Caller OWN the returned object
267 * TODO: should this be done another way?
270 struct lttng_event_exclusion
*lttng_event_rule_generate_exclusions(
271 struct lttng_event_rule
*rule
)
273 assert(rule
->generate_exclusions
);
274 return rule
->generate_exclusions(rule
);
278 struct lttng_event
*lttng_event_rule_generate_lttng_event(
279 const struct lttng_event_rule
*rule
)
281 assert(rule
->generate_lttng_event
);
282 return rule
->generate_lttng_event(rule
);
286 bool lttng_event_rule_is_agent(const struct lttng_event_rule
*rule
)
289 enum lttng_domain_type type
= lttng_event_rule_get_domain_type(rule
);
292 case LTTNG_DOMAIN_JUL
:
293 case LTTNG_DOMAIN_LOG4J
:
294 case LTTNG_DOMAIN_PYTHON
:
297 case LTTNG_DOMAIN_UST
:
298 case LTTNG_DOMAIN_KERNEL
:
309 const char *lttng_event_rule_type_str(enum lttng_event_rule_type type
)
312 case LTTNG_EVENT_RULE_TYPE_UNKNOWN
:
315 case LTTNG_EVENT_RULE_TYPE_TRACEPOINT
:
318 case LTTNG_EVENT_RULE_TYPE_SYSCALL
:
321 case LTTNG_EVENT_RULE_TYPE_KPROBE
:
324 case LTTNG_EVENT_RULE_TYPE_KRETPROBE
:
327 case LTTNG_EVENT_RULE_TYPE_UPROBE
:
328 return "userspace-probe";