2 * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
4 * SPDX-License-Identifier: LGPL-2.1-only
9 #include <common/credentials.h>
10 #include <common/error.h>
11 #include <common/macros.h>
12 #include <common/payload.h>
13 #include <common/payload-view.h>
14 #include <common/runas.h>
15 #include <common/hashtable/hashtable.h>
16 #include <common/hashtable/utils.h>
18 #include <lttng/constant.h>
19 #include <lttng/event-rule/event-rule.h>
20 #include <lttng/event-rule/event-rule-internal.h>
21 #include <lttng/event-rule/kernel-probe-internal.h>
22 #include <lttng/kernel-probe.h>
23 #include <lttng/kernel-probe-internal.h>
26 #define IS_KPROBE_EVENT_RULE(rule) \
27 (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE)
29 #if (LTTNG_SYMBOL_NAME_LEN == 256)
30 #define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "255"
33 static void lttng_event_rule_kernel_probe_destroy(struct lttng_event_rule
*rule
)
35 struct lttng_event_rule_kernel_probe
*kprobe
;
37 kprobe
= container_of(rule
, struct lttng_event_rule_kernel_probe
, parent
);
39 lttng_kernel_probe_location_destroy(kprobe
->location
);
44 static bool lttng_event_rule_kernel_probe_validate(
45 const struct lttng_event_rule
*rule
)
48 struct lttng_event_rule_kernel_probe
*kprobe
;
54 kprobe
= container_of(rule
, struct lttng_event_rule_kernel_probe
, parent
);
58 ERR("Invalid name event rule: a name must be set.");
63 if(!kprobe
->location
) {
64 ERR("Invalid name event rule: a location must be set.");
73 static int lttng_event_rule_kernel_probe_serialize(
74 const struct lttng_event_rule
*rule
,
75 struct lttng_payload
*payload
)
78 size_t name_len
, header_offset
, size_before_location
;
79 struct lttng_event_rule_kernel_probe
*kprobe
;
80 struct lttng_event_rule_kernel_probe_comm kprobe_comm
;
81 struct lttng_event_rule_kernel_probe_comm
*header
;
83 if (!rule
|| !IS_KPROBE_EVENT_RULE(rule
)) {
88 header_offset
= payload
->buffer
.size
;
90 DBG("Serializing kprobe event rule.");
91 kprobe
= container_of(rule
, struct lttng_event_rule_kernel_probe
, parent
);
93 name_len
= strlen(kprobe
->name
) + 1;
94 kprobe_comm
.name_len
= name_len
;
96 ret
= lttng_dynamic_buffer_append(
97 &payload
->buffer
, &kprobe_comm
, sizeof(kprobe_comm
));
102 ret
= lttng_dynamic_buffer_append(&payload
->buffer
, kprobe
->name
, name_len
);
107 size_before_location
= payload
->buffer
.size
;
109 ret
= lttng_kernel_probe_location_serialize(kprobe
->location
, payload
);
114 /* Update the header regarding the probe size. */
115 header
= (struct lttng_event_rule_kernel_probe_comm
*) (
116 (char *) payload
->buffer
.data
+ header_offset
);
117 header
->location_len
= payload
->buffer
.size
- size_before_location
;
125 static bool lttng_event_rule_kernel_probe_is_equal(const struct lttng_event_rule
*_a
,
126 const struct lttng_event_rule
*_b
)
128 bool is_equal
= false;
129 struct lttng_event_rule_kernel_probe
*a
, *b
;
131 a
= container_of(_a
, struct lttng_event_rule_kernel_probe
, parent
);
132 b
= container_of(_b
, struct lttng_event_rule_kernel_probe
, parent
);
135 if (!!a
->name
!= !!b
->name
) {
142 if (strcmp(a
->name
, b
->name
)) {
146 is_equal
= lttng_kernel_probe_location_is_equal(
147 a
->location
, b
->location
);
152 static enum lttng_error_code
lttng_event_rule_kernel_probe_generate_filter_bytecode(
153 struct lttng_event_rule
*rule
,
154 const struct lttng_credentials
*creds
)
160 static const char *lttng_event_rule_kernel_probe_get_filter(
161 const struct lttng_event_rule
*rule
)
167 static const struct lttng_bytecode
*
168 lttng_event_rule_kernel_probe_get_filter_bytecode(const struct lttng_event_rule
*rule
)
174 static enum lttng_event_rule_generate_exclusions_status
175 lttng_event_rule_kernel_probe_generate_exclusions(const struct lttng_event_rule
*rule
,
176 struct lttng_event_exclusion
**exclusions
)
180 return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
;
184 lttng_event_rule_kernel_probe_hash(
185 const struct lttng_event_rule
*rule
)
188 struct lttng_event_rule_kernel_probe
*krule
=
189 container_of(rule
, typeof(*krule
), parent
);
191 hash
= hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
,
193 hash
^= hash_key_str(krule
->name
, lttng_ht_seed
);
194 hash
^= lttng_kernel_probe_location_hash(krule
->location
);
200 int kernel_probe_set_location(
201 struct lttng_event_rule_kernel_probe
*kprobe
,
202 const struct lttng_kernel_probe_location
*location
)
205 struct lttng_kernel_probe_location
*location_copy
= NULL
;
207 if (!kprobe
|| !location
|| kprobe
->location
) {
212 location_copy
= lttng_kernel_probe_location_copy(location
);
213 if (!location_copy
) {
218 kprobe
->location
= location_copy
;
219 location_copy
= NULL
;
222 lttng_kernel_probe_location_destroy(location_copy
);
226 struct lttng_event_rule
*lttng_event_rule_kernel_probe_create(
227 const struct lttng_kernel_probe_location
*location
)
229 struct lttng_event_rule
*rule
= NULL
;
230 struct lttng_event_rule_kernel_probe
*krule
;
232 krule
= zmalloc(sizeof(struct lttng_event_rule_kernel_probe
));
237 rule
= &krule
->parent
;
238 lttng_event_rule_init(&krule
->parent
, LTTNG_EVENT_RULE_TYPE_KERNEL_PROBE
);
239 krule
->parent
.validate
= lttng_event_rule_kernel_probe_validate
;
240 krule
->parent
.serialize
= lttng_event_rule_kernel_probe_serialize
;
241 krule
->parent
.equal
= lttng_event_rule_kernel_probe_is_equal
;
242 krule
->parent
.destroy
= lttng_event_rule_kernel_probe_destroy
;
243 krule
->parent
.generate_filter_bytecode
=
244 lttng_event_rule_kernel_probe_generate_filter_bytecode
;
245 krule
->parent
.get_filter
= lttng_event_rule_kernel_probe_get_filter
;
246 krule
->parent
.get_filter_bytecode
=
247 lttng_event_rule_kernel_probe_get_filter_bytecode
;
248 krule
->parent
.generate_exclusions
=
249 lttng_event_rule_kernel_probe_generate_exclusions
;
250 krule
->parent
.hash
= lttng_event_rule_kernel_probe_hash
;
252 if (kernel_probe_set_location(krule
, location
)) {
253 lttng_event_rule_destroy(rule
);
262 ssize_t
lttng_event_rule_kernel_probe_create_from_payload(
263 struct lttng_payload_view
*view
,
264 struct lttng_event_rule
**_event_rule
)
266 ssize_t ret
, offset
= 0;
267 enum lttng_event_rule_status status
;
268 const struct lttng_event_rule_kernel_probe_comm
*kprobe_comm
;
270 struct lttng_buffer_view current_buffer_view
;
271 struct lttng_event_rule
*rule
= NULL
;
272 struct lttng_kernel_probe_location
*location
= NULL
;
279 current_buffer_view
= lttng_buffer_view_from_view(
280 &view
->buffer
, offset
, sizeof(*kprobe_comm
));
281 if (!lttng_buffer_view_is_valid(¤t_buffer_view
)) {
282 ERR("Failed to initialize from malformed event rule kprobe: buffer too short to contain header.");
287 kprobe_comm
= (typeof(kprobe_comm
)) current_buffer_view
.data
;
289 /* Skip to payload */
290 offset
+= current_buffer_view
.size
;
294 struct lttng_payload_view current_payload_view
=
295 lttng_payload_view_from_view(view
, offset
,
296 kprobe_comm
->name_len
);
298 if (!lttng_payload_view_is_valid(¤t_payload_view
)) {
303 name
= current_payload_view
.buffer
.data
;
304 if (!lttng_buffer_view_contains_string(
305 ¤t_payload_view
.buffer
, name
,
306 kprobe_comm
->name_len
)) {
312 /* Skip after the name. */
313 offset
+= kprobe_comm
->name_len
;
315 /* Map the kernel probe location. */
317 struct lttng_payload_view current_payload_view
=
318 lttng_payload_view_from_view(view
, offset
,
319 kprobe_comm
->location_len
);
321 if (!lttng_payload_view_is_valid(¤t_payload_view
)) {
326 ret
= lttng_kernel_probe_location_create_from_payload(
327 ¤t_payload_view
, &location
);
334 if (ret
!= kprobe_comm
->location_len
) {
339 /* Skip after the location */
340 offset
+= kprobe_comm
->location_len
;
342 rule
= lttng_event_rule_kernel_probe_create(location
);
344 ERR("Failed to create event rule kprobe.");
349 status
= lttng_event_rule_kernel_probe_set_event_name(rule
, name
);
350 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
351 ERR("Failed to set event rule kprobe name.");
360 lttng_kernel_probe_location_destroy(location
);
361 lttng_event_rule_destroy(rule
);
365 enum lttng_event_rule_status
lttng_event_rule_kernel_probe_get_location(
366 const struct lttng_event_rule
*rule
,
367 const struct lttng_kernel_probe_location
**location
)
369 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
370 struct lttng_event_rule_kernel_probe
*kprobe
;
372 if (!rule
|| !IS_KPROBE_EVENT_RULE(rule
) || !location
) {
373 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
377 kprobe
= container_of(rule
, struct lttng_event_rule_kernel_probe
, parent
);
378 *location
= kprobe
->location
;
381 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
389 enum lttng_event_rule_status
lttng_event_rule_kernel_probe_set_event_name(
390 struct lttng_event_rule
*rule
, const char *name
)
392 char *name_copy
= NULL
;
393 struct lttng_event_rule_kernel_probe
*kprobe
;
394 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
396 if (!rule
|| !IS_KPROBE_EVENT_RULE(rule
) || !name
||
398 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
402 kprobe
= container_of(rule
, struct lttng_event_rule_kernel_probe
, parent
);
403 name_copy
= strdup(name
);
405 status
= LTTNG_EVENT_RULE_STATUS_ERROR
;
411 kprobe
->name
= name_copy
;
417 enum lttng_event_rule_status
lttng_event_rule_kernel_probe_get_event_name(
418 const struct lttng_event_rule
*rule
, const char **name
)
420 struct lttng_event_rule_kernel_probe
*kprobe
;
421 enum lttng_event_rule_status status
= LTTNG_EVENT_RULE_STATUS_OK
;
423 if (!rule
|| !IS_KPROBE_EVENT_RULE(rule
) || !name
) {
424 status
= LTTNG_EVENT_RULE_STATUS_INVALID
;
428 kprobe
= container_of(rule
, struct lttng_event_rule_kernel_probe
, parent
);
430 status
= LTTNG_EVENT_RULE_STATUS_UNSET
;
434 *name
= kprobe
->name
;