2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
8 #include <common/credentials.hpp>
9 #include <common/error.hpp>
10 #include <common/hashtable/hashtable.hpp>
11 #include <common/hashtable/utils.hpp>
12 #include <common/macros.hpp>
13 #include <common/mi-lttng.hpp>
14 #include <common/optional.hpp>
15 #include <common/payload-view.hpp>
16 #include <common/payload.hpp>
17 #include <common/runas.hpp>
18 #include <common/string-utils/string-utils.hpp>
20 #include <lttng/event-rule/event-rule-internal.hpp>
21 #include <lttng/event-rule/kernel-tracepoint-internal.hpp>
22 #include <lttng/event.h>
24 #define IS_KERNEL_TRACEPOINT_EVENT_RULE(rule) \
25 (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT)
27 static void lttng_event_rule_kernel_tracepoint_destroy(struct lttng_event_rule
*rule
)
29 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
31 if (rule
== nullptr) {
35 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
37 free(tracepoint
->pattern
);
38 free(tracepoint
->filter_expression
);
39 free(tracepoint
->internal_filter
.filter
);
40 free(tracepoint
->internal_filter
.bytecode
);
44 static bool lttng_event_rule_kernel_tracepoint_validate(const struct lttng_event_rule
*rule
)
47 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
53 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
56 if (!tracepoint
->pattern
) {
57 ERR("Invalid kernel tracepoint event rule: a pattern must be set.");
66 static int lttng_event_rule_kernel_tracepoint_serialize(const struct lttng_event_rule
*rule
,
67 struct lttng_payload
*payload
)
70 size_t pattern_len
, filter_expression_len
;
71 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
72 struct lttng_event_rule_kernel_tracepoint_comm tracepoint_comm
;
74 if (!rule
|| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule
)) {
79 DBG("Serializing kernel tracepoint event rule.");
80 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
82 pattern_len
= strlen(tracepoint
->pattern
) + 1;
84 if (tracepoint
->filter_expression
!= nullptr) {
85 filter_expression_len
= strlen(tracepoint
->filter_expression
) + 1;
87 filter_expression_len
= 0;
90 tracepoint_comm
.pattern_len
= pattern_len
;
91 tracepoint_comm
.filter_expression_len
= filter_expression_len
;
93 ret
= lttng_dynamic_buffer_append(
94 &payload
->buffer
, &tracepoint_comm
, sizeof(tracepoint_comm
));
99 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, tracepoint
->pattern
, pattern_len
);
104 ret
= lttng_dynamic_buffer_append(
105 &payload
->buffer
, tracepoint
->filter_expression
, filter_expression_len
);
114 static bool lttng_event_rule_kernel_tracepoint_is_equal(const struct lttng_event_rule
*_a
,
115 const struct lttng_event_rule
*_b
)
117 bool is_equal
= false;
118 struct lttng_event_rule_kernel_tracepoint
*a
, *b
;
120 a
= lttng::utils::container_of(_a
, <tng_event_rule_kernel_tracepoint::parent
);
121 b
= lttng::utils::container_of(_b
, <tng_event_rule_kernel_tracepoint::parent
);
123 if (!!a
->filter_expression
!= !!b
->filter_expression
) {
128 LTTNG_ASSERT(a
->pattern
);
129 LTTNG_ASSERT(b
->pattern
);
130 if (strcmp(a
->pattern
, b
->pattern
) != 0) {
134 if (a
->filter_expression
&& b
->filter_expression
) {
135 if (strcmp(a
->filter_expression
, b
->filter_expression
) != 0) {
138 } else if (!!a
->filter_expression
!= !!b
->filter_expression
) {
139 /* One is set; not the other. */
148 static enum lttng_error_code
149 lttng_event_rule_kernel_tracepoint_generate_filter_bytecode(struct lttng_event_rule
*rule
,
150 const struct lttng_credentials
*creds
)
153 enum lttng_error_code ret_code
;
154 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
155 enum lttng_event_rule_status status
;
157 struct lttng_bytecode
*bytecode
= nullptr;
161 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
163 status
= lttng_event_rule_kernel_tracepoint_get_filter(rule
, &filter
);
164 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
166 } else if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
167 ret_code
= LTTNG_ERR_FILTER_INVAL
;
171 if (filter
&& filter
[0] == '\0') {
172 ret_code
= LTTNG_ERR_FILTER_INVAL
;
177 tracepoint
->internal_filter
.filter
= strdup(filter
);
178 if (tracepoint
->internal_filter
.filter
== nullptr) {
179 ret_code
= LTTNG_ERR_NOMEM
;
183 tracepoint
->internal_filter
.filter
= nullptr;
186 if (tracepoint
->internal_filter
.filter
== nullptr) {
191 ret
= run_as_generate_filter_bytecode(tracepoint
->internal_filter
.filter
, creds
, &bytecode
);
193 ret_code
= LTTNG_ERR_FILTER_INVAL
;
197 tracepoint
->internal_filter
.bytecode
= bytecode
;
208 lttng_event_rule_kernel_tracepoint_get_internal_filter(const struct lttng_event_rule
*rule
)
210 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
213 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
214 return tracepoint
->internal_filter
.filter
;
217 static const struct lttng_bytecode
*
218 lttng_event_rule_kernel_tracepoint_get_internal_filter_bytecode(const struct lttng_event_rule
*rule
)
220 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
223 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
224 return tracepoint
->internal_filter
.bytecode
;
227 static enum lttng_event_rule_generate_exclusions_status
228 lttng_event_rule_kernel_tracepoint_generate_exclusions(const struct lttng_event_rule
*rule
229 __attribute__((unused
)),
230 struct lttng_event_exclusion
**_exclusions
)
233 *_exclusions
= nullptr;
234 return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
;
237 static unsigned long lttng_event_rule_kernel_tracepoint_hash(const struct lttng_event_rule
*rule
)
240 struct lttng_event_rule_kernel_tracepoint
*tp_rule
=
241 lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
243 hash
= hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
, lttng_ht_seed
);
244 hash
^= hash_key_str(tp_rule
->pattern
, lttng_ht_seed
);
246 if (tp_rule
->filter_expression
) {
247 hash
^= hash_key_str(tp_rule
->filter_expression
, lttng_ht_seed
);
253 static enum lttng_error_code
254 lttng_event_rule_kernel_tracepoint_mi_serialize(const struct lttng_event_rule
*rule
,
255 struct mi_writer
*writer
)
258 enum lttng_error_code ret_code
;
259 enum lttng_event_rule_status status
;
260 const char *filter
= nullptr;
261 const char *name_pattern
= nullptr;
264 LTTNG_ASSERT(writer
);
265 LTTNG_ASSERT(IS_KERNEL_TRACEPOINT_EVENT_RULE(rule
));
267 status
= lttng_event_rule_kernel_tracepoint_get_name_pattern(rule
, &name_pattern
);
268 LTTNG_ASSERT(status
== LTTNG_EVENT_RULE_STATUS_OK
);
269 LTTNG_ASSERT(name_pattern
);
271 status
= lttng_event_rule_kernel_tracepoint_get_filter(rule
, &filter
);
272 LTTNG_ASSERT(status
== LTTNG_EVENT_RULE_STATUS_OK
||
273 status
== LTTNG_EVENT_RULE_STATUS_UNSET
);
275 /* Open event rule kernel tracepoint element. */
276 ret
= mi_lttng_writer_open_element(writer
, mi_lttng_element_event_rule_kernel_tracepoint
);
282 ret
= mi_lttng_writer_write_element_string(
283 writer
, mi_lttng_element_event_rule_name_pattern
, name_pattern
);
289 if (filter
!= nullptr) {
290 ret
= mi_lttng_writer_write_element_string(
291 writer
, mi_lttng_element_event_rule_filter_expression
, filter
);
297 /* Close event rule kernel tracepoint element. */
298 ret
= mi_lttng_writer_close_element(writer
);
307 ret_code
= LTTNG_ERR_MI_IO_FAIL
;
312 struct lttng_event_rule
*lttng_event_rule_kernel_tracepoint_create(void)
314 struct lttng_event_rule
*rule
= nullptr;
315 struct lttng_event_rule_kernel_tracepoint
*tp_rule
;
316 enum lttng_event_rule_status status
;
318 tp_rule
= zmalloc
<lttng_event_rule_kernel_tracepoint
>();
323 rule
= &tp_rule
->parent
;
324 lttng_event_rule_init(&tp_rule
->parent
, LTTNG_EVENT_RULE_TYPE_KERNEL_TRACEPOINT
);
325 tp_rule
->parent
.validate
= lttng_event_rule_kernel_tracepoint_validate
;
326 tp_rule
->parent
.serialize
= lttng_event_rule_kernel_tracepoint_serialize
;
327 tp_rule
->parent
.equal
= lttng_event_rule_kernel_tracepoint_is_equal
;
328 tp_rule
->parent
.destroy
= lttng_event_rule_kernel_tracepoint_destroy
;
329 tp_rule
->parent
.generate_filter_bytecode
=
330 lttng_event_rule_kernel_tracepoint_generate_filter_bytecode
;
331 tp_rule
->parent
.get_filter
= lttng_event_rule_kernel_tracepoint_get_internal_filter
;
332 tp_rule
->parent
.get_filter_bytecode
=
333 lttng_event_rule_kernel_tracepoint_get_internal_filter_bytecode
;
334 tp_rule
->parent
.generate_exclusions
=
335 lttng_event_rule_kernel_tracepoint_generate_exclusions
;
336 tp_rule
->parent
.hash
= lttng_event_rule_kernel_tracepoint_hash
;
337 tp_rule
->parent
.mi_serialize
= lttng_event_rule_kernel_tracepoint_mi_serialize
;
339 /* Not necessary for now. */
340 tp_rule
->parent
.generate_lttng_event
= nullptr;
342 /* Default pattern is '*'. */
343 status
= lttng_event_rule_kernel_tracepoint_set_name_pattern(rule
, "*");
344 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
345 lttng_event_rule_destroy(rule
);
354 lttng_event_rule_kernel_tracepoint_create_from_payload(struct lttng_payload_view
*view
,
355 struct lttng_event_rule
**_event_rule
)
357 ssize_t ret
, offset
= 0;
358 enum lttng_event_rule_status status
;
359 const struct lttng_event_rule_kernel_tracepoint_comm
*tracepoint_comm
;
361 const char *filter_expression
= nullptr;
362 struct lttng_buffer_view current_buffer_view
;
363 struct lttng_event_rule
*rule
= nullptr;
370 current_buffer_view
=
371 lttng_buffer_view_from_view(&view
->buffer
, offset
, sizeof(*tracepoint_comm
));
372 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
373 ERR("Failed to initialize from malformed event rule kernel tracepoint: buffer too short to contain header.");
378 tracepoint_comm
= (typeof(tracepoint_comm
)) current_buffer_view
.data
;
380 /* Skip to payload. */
381 offset
+= current_buffer_view
.size
;
383 /* Map the pattern. */
384 current_buffer_view
=
385 lttng_buffer_view_from_view(&view
->buffer
, offset
, tracepoint_comm
->pattern_len
);
387 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
392 pattern
= current_buffer_view
.data
;
393 if (!lttng_buffer_view_contains_string(
394 ¤t_buffer_view
, pattern
, tracepoint_comm
->pattern_len
)) {
399 /* Skip after the pattern. */
400 offset
+= tracepoint_comm
->pattern_len
;
402 if (!tracepoint_comm
->filter_expression_len
) {
403 goto skip_filter_expression
;
406 /* Map the filter_expression. */
407 current_buffer_view
= lttng_buffer_view_from_view(
408 &view
->buffer
, offset
, tracepoint_comm
->filter_expression_len
);
409 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
414 filter_expression
= current_buffer_view
.data
;
415 if (!lttng_buffer_view_contains_string(¤t_buffer_view
,
417 tracepoint_comm
->filter_expression_len
)) {
422 /* Skip after the pattern. */
423 offset
+= tracepoint_comm
->filter_expression_len
;
425 skip_filter_expression
:
427 rule
= lttng_event_rule_kernel_tracepoint_create();
429 ERR("Failed to create event rule kernel tracepoint.");
434 status
= lttng_event_rule_kernel_tracepoint_set_name_pattern(rule
, pattern
);
435 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
436 ERR("Failed to set event rule kernel tracepoint pattern.");
441 if (filter_expression
) {
442 status
= lttng_event_rule_kernel_tracepoint_set_filter(rule
, filter_expression
);
443 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
444 ERR("Failed to set event rule kernel tracepoint pattern.");
454 lttng_event_rule_destroy(rule
);
458 enum lttng_event_rule_status
459 lttng_event_rule_kernel_tracepoint_set_name_pattern(struct lttng_event_rule
*rule
,
462 char *pattern_copy
= nullptr;
463 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
464 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
466 if (!rule
|| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule
) || !pattern
|| strlen(pattern
) == 0) {
467 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
471 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
472 pattern_copy
= strdup(pattern
);
474 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
478 /* Normalize the pattern. */
479 strutils_normalize_star_glob_pattern(pattern_copy
);
481 free(tracepoint
->pattern
);
483 tracepoint
->pattern
= pattern_copy
;
484 pattern_copy
= nullptr;
489 enum lttng_event_rule_status
490 lttng_event_rule_kernel_tracepoint_get_name_pattern(const struct lttng_event_rule
*rule
,
491 const char **pattern
)
493 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
494 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
496 if (!rule
|| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule
) || !pattern
) {
497 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
501 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
502 if (!tracepoint
->pattern
) {
503 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
507 *pattern
= tracepoint
->pattern
;
512 enum lttng_event_rule_status
513 lttng_event_rule_kernel_tracepoint_set_filter(struct lttng_event_rule
*rule
, const char *expression
)
515 char *expression_copy
= nullptr;
516 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
517 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
519 if (!rule
|| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule
) || !expression
||
520 strlen(expression
) == 0) {
521 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
525 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
526 expression_copy
= strdup(expression
);
527 if (!expression_copy
) {
528 PERROR("Failed to copy filter expression");
529 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
533 if (tracepoint
->filter_expression
) {
534 free(tracepoint
->filter_expression
);
537 tracepoint
->filter_expression
= expression_copy
;
538 expression_copy
= nullptr;
543 enum lttng_event_rule_status
544 lttng_event_rule_kernel_tracepoint_get_filter(const struct lttng_event_rule
*rule
,
545 const char **expression
)
547 struct lttng_event_rule_kernel_tracepoint
*tracepoint
;
548 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
550 if (!rule
|| !IS_KERNEL_TRACEPOINT_EVENT_RULE(rule
) || !expression
) {
551 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
555 tracepoint
= lttng::utils::container_of(rule
, <tng_event_rule_kernel_tracepoint::parent
);
556 if (!tracepoint
->filter_expression
) {
557 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
561 *expression
= tracepoint
->filter_expression
;