Commit | Line | Data |
---|---|---|
e6a39346 JR |
1 | /* |
2 | * Copyright (C) 2019 Jonathan Rajotte <jonathan.rajotte-julien@efficios.com> | |
3 | * | |
4 | * SPDX-License-Identifier: LGPL-2.1-only | |
5 | * | |
6 | */ | |
7 | ||
8 | #include <assert.h> | |
58daac01 | 9 | #include <common/credentials.h> |
e6a39346 JR |
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> | |
959e3c66 JR |
15 | #include <common/hashtable/hashtable.h> |
16 | #include <common/hashtable/utils.h> | |
e6a39346 JR |
17 | #include <lttng/event-rule/event-rule-internal.h> |
18 | #include <lttng/event-rule/syscall-internal.h> | |
19 | ||
20 | #define IS_SYSCALL_EVENT_RULE(rule) \ | |
21 | (lttng_event_rule_get_type(rule) == LTTNG_EVENT_RULE_TYPE_SYSCALL) | |
22 | ||
23 | static void lttng_event_rule_syscall_destroy(struct lttng_event_rule *rule) | |
24 | { | |
25 | struct lttng_event_rule_syscall *syscall; | |
26 | ||
27 | if (rule == NULL) { | |
28 | return; | |
29 | } | |
30 | ||
31 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
32 | ||
33 | free(syscall->pattern); | |
34 | free(syscall->filter_expression); | |
35 | free(syscall->internal_filter.filter); | |
36 | free(syscall->internal_filter.bytecode); | |
37 | free(syscall); | |
38 | } | |
39 | ||
40 | static bool lttng_event_rule_syscall_validate( | |
41 | const struct lttng_event_rule *rule) | |
42 | { | |
43 | bool valid = false; | |
44 | struct lttng_event_rule_syscall *syscall; | |
45 | ||
46 | if (!rule) { | |
47 | goto end; | |
48 | } | |
49 | ||
50 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
51 | ||
52 | /* Required field. */ | |
53 | if (!syscall->pattern) { | |
54 | ERR("Invalid syscall event rule: a pattern must be set."); | |
55 | goto end; | |
56 | } | |
57 | ||
58 | valid = true; | |
59 | end: | |
60 | return valid; | |
61 | } | |
62 | ||
63 | static int lttng_event_rule_syscall_serialize( | |
64 | const struct lttng_event_rule *rule, | |
65 | struct lttng_payload *payload) | |
66 | { | |
67 | int ret; | |
68 | size_t pattern_len, filter_expression_len; | |
69 | struct lttng_event_rule_syscall *syscall; | |
70 | struct lttng_event_rule_syscall_comm syscall_comm; | |
71 | ||
72 | if (!rule || !IS_SYSCALL_EVENT_RULE(rule)) { | |
73 | ret = -1; | |
74 | goto end; | |
75 | } | |
76 | ||
77 | DBG("Serializing syscall event rule"); | |
78 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
79 | ||
80 | pattern_len = strlen(syscall->pattern) + 1; | |
81 | ||
82 | if (syscall->filter_expression != NULL) { | |
83 | filter_expression_len = strlen(syscall->filter_expression) + 1; | |
84 | } else { | |
85 | filter_expression_len = 0; | |
86 | } | |
87 | ||
88 | syscall_comm.pattern_len = pattern_len; | |
89 | syscall_comm.filter_expression_len = filter_expression_len; | |
90 | ||
91 | ret = lttng_dynamic_buffer_append( | |
92 | &payload->buffer, &syscall_comm, sizeof(syscall_comm)); | |
93 | if (ret) { | |
94 | goto end; | |
95 | } | |
96 | ||
97 | ret = lttng_dynamic_buffer_append( | |
98 | &payload->buffer, syscall->pattern, pattern_len); | |
99 | if (ret) { | |
100 | goto end; | |
101 | } | |
102 | ||
103 | ret = lttng_dynamic_buffer_append(&payload->buffer, | |
104 | syscall->filter_expression, filter_expression_len); | |
105 | end: | |
106 | return ret; | |
107 | } | |
108 | ||
109 | static bool lttng_event_rule_syscall_is_equal(const struct lttng_event_rule *_a, | |
110 | const struct lttng_event_rule *_b) | |
111 | { | |
112 | bool is_equal = false; | |
113 | struct lttng_event_rule_syscall *a, *b; | |
114 | ||
115 | a = container_of(_a, struct lttng_event_rule_syscall, parent); | |
116 | b = container_of(_b, struct lttng_event_rule_syscall, parent); | |
117 | ||
118 | if (!!a->filter_expression != !!b->filter_expression) { | |
119 | goto end; | |
120 | } | |
121 | ||
122 | assert(a->pattern); | |
123 | assert(b->pattern); | |
124 | if (strcmp(a->pattern, b->pattern)) { | |
125 | goto end; | |
126 | } | |
127 | ||
128 | if (a->filter_expression && b->filter_expression) { | |
129 | if (strcmp(a->filter_expression, b->filter_expression)) { | |
130 | goto end; | |
131 | } | |
132 | } else if (!!a->filter_expression != !!b->filter_expression) { | |
133 | /* One is set and not the other. */ | |
134 | goto end; | |
135 | } | |
136 | ||
137 | is_equal = true; | |
138 | end: | |
139 | return is_equal; | |
140 | } | |
141 | ||
142 | static enum lttng_error_code lttng_event_rule_syscall_generate_filter_bytecode( | |
58daac01 JR |
143 | struct lttng_event_rule *rule, |
144 | const struct lttng_credentials *creds) | |
e6a39346 JR |
145 | { |
146 | int ret; | |
147 | enum lttng_error_code ret_code = LTTNG_OK; | |
148 | struct lttng_event_rule_syscall *syscall; | |
149 | enum lttng_event_rule_status status; | |
150 | const char *filter; | |
2b00d462 | 151 | struct lttng_bytecode *bytecode = NULL; |
e6a39346 JR |
152 | |
153 | assert(rule); | |
154 | ||
155 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
156 | ||
157 | /* Generate the filter bytecode. */ | |
158 | status = lttng_event_rule_syscall_get_filter(rule, &filter); | |
159 | if (status == LTTNG_EVENT_RULE_STATUS_UNSET) { | |
160 | filter = NULL; | |
161 | } else if (status != LTTNG_EVENT_RULE_STATUS_OK) { | |
162 | ret_code = LTTNG_ERR_FILTER_INVAL; | |
163 | goto end; | |
164 | } | |
165 | ||
166 | if (filter && filter[0] == '\0') { | |
167 | ret_code = LTTNG_ERR_FILTER_INVAL; | |
168 | goto end; | |
169 | } | |
170 | ||
171 | if (filter == NULL) { | |
172 | /* Nothing to do. */ | |
173 | ret = LTTNG_OK; | |
174 | goto end; | |
175 | } | |
176 | ||
177 | syscall->internal_filter.filter = strdup(filter); | |
178 | if (syscall->internal_filter.filter == NULL) { | |
179 | ret_code = LTTNG_ERR_NOMEM; | |
180 | goto end; | |
181 | } | |
182 | ||
183 | ret = run_as_generate_filter_bytecode( | |
58daac01 | 184 | syscall->internal_filter.filter, creds, &bytecode); |
e6a39346 JR |
185 | if (ret) { |
186 | ret_code = LTTNG_ERR_FILTER_INVAL; | |
187 | } | |
188 | ||
189 | syscall->internal_filter.bytecode = bytecode; | |
190 | bytecode = NULL; | |
191 | ||
192 | end: | |
193 | free(bytecode); | |
194 | return ret_code; | |
195 | } | |
196 | ||
197 | static const char *lttng_event_rule_syscall_get_internal_filter( | |
198 | const struct lttng_event_rule *rule) | |
199 | { | |
200 | struct lttng_event_rule_syscall *syscall; | |
201 | ||
202 | assert(rule); | |
203 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
204 | ||
205 | return syscall->internal_filter.filter; | |
206 | } | |
207 | ||
2b00d462 | 208 | static const struct lttng_bytecode * |
e6a39346 JR |
209 | lttng_event_rule_syscall_get_internal_filter_bytecode( |
210 | const struct lttng_event_rule *rule) | |
211 | { | |
212 | struct lttng_event_rule_syscall *syscall; | |
213 | ||
214 | assert(rule); | |
215 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
216 | ||
217 | return syscall->internal_filter.bytecode; | |
218 | } | |
219 | ||
993578ff JR |
220 | static enum lttng_event_rule_generate_exclusions_status |
221 | lttng_event_rule_syscall_generate_exclusions(const struct lttng_event_rule *rule, | |
222 | struct lttng_event_exclusion **exclusions) | |
e6a39346 | 223 | { |
993578ff JR |
224 | /* Unsupported. */ |
225 | *exclusions = NULL; | |
226 | return LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE; | |
e6a39346 JR |
227 | } |
228 | ||
959e3c66 JR |
229 | static unsigned long |
230 | lttng_event_rule_syscall_hash( | |
231 | const struct lttng_event_rule *rule) | |
232 | { | |
233 | unsigned long hash; | |
234 | struct lttng_event_rule_syscall *syscall_rule = | |
235 | container_of(rule, typeof(*syscall_rule), parent); | |
236 | ||
237 | hash = hash_key_ulong((void *) LTTNG_EVENT_RULE_TYPE_SYSCALL, | |
238 | lttng_ht_seed); | |
239 | hash ^= hash_key_str(syscall_rule->pattern, lttng_ht_seed); | |
240 | if (syscall_rule->filter_expression) { | |
241 | hash ^= hash_key_str(syscall_rule->filter_expression, | |
242 | lttng_ht_seed); | |
243 | } | |
244 | ||
245 | return hash; | |
246 | } | |
247 | ||
a3ecaea8 | 248 | struct lttng_event_rule *lttng_event_rule_syscall_create(void) |
e6a39346 JR |
249 | { |
250 | struct lttng_event_rule *rule = NULL; | |
251 | struct lttng_event_rule_syscall *syscall_rule; | |
67d38b93 | 252 | enum lttng_event_rule_status status; |
e6a39346 JR |
253 | |
254 | syscall_rule = zmalloc(sizeof(struct lttng_event_rule_syscall)); | |
255 | if (!syscall_rule) { | |
256 | goto end; | |
257 | } | |
258 | ||
259 | rule = &syscall_rule->parent; | |
260 | lttng_event_rule_init( | |
261 | &syscall_rule->parent, LTTNG_EVENT_RULE_TYPE_SYSCALL); | |
262 | syscall_rule->parent.validate = lttng_event_rule_syscall_validate; | |
263 | syscall_rule->parent.serialize = lttng_event_rule_syscall_serialize; | |
264 | syscall_rule->parent.equal = lttng_event_rule_syscall_is_equal; | |
265 | syscall_rule->parent.destroy = lttng_event_rule_syscall_destroy; | |
266 | syscall_rule->parent.generate_filter_bytecode = | |
267 | lttng_event_rule_syscall_generate_filter_bytecode; | |
268 | syscall_rule->parent.get_filter = | |
269 | lttng_event_rule_syscall_get_internal_filter; | |
270 | syscall_rule->parent.get_filter_bytecode = | |
271 | lttng_event_rule_syscall_get_internal_filter_bytecode; | |
272 | syscall_rule->parent.generate_exclusions = | |
273 | lttng_event_rule_syscall_generate_exclusions; | |
959e3c66 | 274 | syscall_rule->parent.hash = lttng_event_rule_syscall_hash; |
67d38b93 JR |
275 | |
276 | /* Default pattern is '*'. */ | |
277 | status = lttng_event_rule_syscall_set_pattern(rule, "*"); | |
278 | if (status != LTTNG_EVENT_RULE_STATUS_OK) { | |
279 | lttng_event_rule_destroy(rule); | |
280 | rule = NULL; | |
281 | } | |
282 | ||
e6a39346 JR |
283 | end: |
284 | return rule; | |
285 | } | |
286 | ||
287 | LTTNG_HIDDEN | |
288 | ssize_t lttng_event_rule_syscall_create_from_payload( | |
289 | struct lttng_payload_view *view, | |
290 | struct lttng_event_rule **_event_rule) | |
291 | { | |
292 | ssize_t ret, offset = 0; | |
293 | enum lttng_event_rule_status status; | |
294 | const struct lttng_event_rule_syscall_comm *syscall_comm; | |
295 | const char *pattern; | |
296 | const char *filter_expression = NULL; | |
297 | struct lttng_buffer_view current_buffer_view; | |
298 | struct lttng_event_rule *rule = NULL; | |
299 | ||
300 | if (!_event_rule) { | |
301 | ret = -1; | |
302 | goto end; | |
303 | } | |
304 | ||
305 | if (view->buffer.size < sizeof(*syscall_comm)) { | |
306 | ERR("Failed to initialize from malformed event rule syscall: buffer too short to contain header"); | |
307 | ret = -1; | |
308 | goto end; | |
309 | } | |
310 | ||
311 | current_buffer_view = lttng_buffer_view_from_view( | |
312 | &view->buffer, offset, sizeof(*syscall_comm)); | |
3e6e0df2 | 313 | if (!lttng_buffer_view_is_valid(¤t_buffer_view)) { |
e6a39346 JR |
314 | ret = -1; |
315 | goto end; | |
316 | } | |
317 | ||
3e6e0df2 | 318 | syscall_comm = (typeof(syscall_comm)) current_buffer_view.data; |
e6a39346 JR |
319 | rule = lttng_event_rule_syscall_create(); |
320 | if (!rule) { | |
321 | ERR("Failed to create event rule syscall"); | |
322 | ret = -1; | |
323 | goto end; | |
324 | } | |
325 | ||
326 | /* Skip to payload. */ | |
327 | offset += current_buffer_view.size; | |
328 | ||
329 | /* Map the pattern. */ | |
330 | current_buffer_view = lttng_buffer_view_from_view( | |
331 | &view->buffer, offset, syscall_comm->pattern_len); | |
3e6e0df2 | 332 | if (!lttng_buffer_view_is_valid(¤t_buffer_view)) { |
e6a39346 JR |
333 | ret = -1; |
334 | goto end; | |
335 | } | |
336 | ||
3e6e0df2 | 337 | pattern = current_buffer_view.data; |
e6a39346 JR |
338 | if (!lttng_buffer_view_contains_string(¤t_buffer_view, pattern, |
339 | syscall_comm->pattern_len)) { | |
340 | ret = -1; | |
341 | goto end; | |
342 | } | |
343 | ||
344 | /* Skip after the pattern. */ | |
345 | offset += syscall_comm->pattern_len; | |
346 | ||
347 | if (!syscall_comm->filter_expression_len) { | |
348 | goto skip_filter_expression; | |
349 | } | |
350 | ||
351 | /* Map the filter_expression. */ | |
352 | current_buffer_view = lttng_buffer_view_from_view(&view->buffer, offset, | |
353 | syscall_comm->filter_expression_len); | |
3e6e0df2 | 354 | if (!lttng_buffer_view_is_valid(¤t_buffer_view)) { |
e6a39346 JR |
355 | ret = -1; |
356 | goto end; | |
357 | } | |
358 | ||
3e6e0df2 | 359 | filter_expression = current_buffer_view.data; |
e6a39346 JR |
360 | if (!lttng_buffer_view_contains_string(¤t_buffer_view, |
361 | filter_expression, | |
362 | syscall_comm->filter_expression_len)) { | |
363 | ret = -1; | |
364 | goto end; | |
365 | } | |
366 | ||
367 | /* Skip after the pattern. */ | |
368 | offset += syscall_comm->filter_expression_len; | |
369 | ||
370 | skip_filter_expression: | |
371 | ||
372 | status = lttng_event_rule_syscall_set_pattern(rule, pattern); | |
373 | if (status != LTTNG_EVENT_RULE_STATUS_OK) { | |
374 | ERR("Failed to set event rule syscall pattern"); | |
375 | ret = -1; | |
376 | goto end; | |
377 | } | |
378 | ||
379 | if (filter_expression) { | |
380 | status = lttng_event_rule_syscall_set_filter( | |
381 | rule, filter_expression); | |
382 | if (status != LTTNG_EVENT_RULE_STATUS_OK) { | |
383 | ERR("Failed to set event rule syscall pattern"); | |
384 | ret = -1; | |
385 | goto end; | |
386 | } | |
387 | } | |
388 | ||
389 | *_event_rule = rule; | |
390 | rule = NULL; | |
391 | ret = offset; | |
392 | end: | |
393 | lttng_event_rule_destroy(rule); | |
394 | return ret; | |
395 | } | |
396 | ||
397 | enum lttng_event_rule_status lttng_event_rule_syscall_set_pattern( | |
398 | struct lttng_event_rule *rule, const char *pattern) | |
399 | { | |
400 | char *pattern_copy = NULL; | |
401 | struct lttng_event_rule_syscall *syscall; | |
402 | enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK; | |
403 | ||
404 | if (!rule || !IS_SYSCALL_EVENT_RULE(rule) || !pattern || | |
405 | strlen(pattern) == 0) { | |
406 | status = LTTNG_EVENT_RULE_STATUS_INVALID; | |
407 | goto end; | |
408 | } | |
409 | ||
410 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
411 | pattern_copy = strdup(pattern); | |
412 | if (!pattern_copy) { | |
413 | status = LTTNG_EVENT_RULE_STATUS_ERROR; | |
414 | goto end; | |
415 | } | |
416 | ||
417 | if (syscall->pattern) { | |
418 | free(syscall->pattern); | |
419 | } | |
420 | ||
421 | syscall->pattern = pattern_copy; | |
422 | pattern_copy = NULL; | |
423 | end: | |
424 | return status; | |
425 | } | |
426 | ||
427 | enum lttng_event_rule_status lttng_event_rule_syscall_get_pattern( | |
428 | const struct lttng_event_rule *rule, const char **pattern) | |
429 | { | |
430 | struct lttng_event_rule_syscall *syscall; | |
431 | enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK; | |
432 | ||
433 | if (!rule || !IS_SYSCALL_EVENT_RULE(rule) || !pattern) { | |
434 | status = LTTNG_EVENT_RULE_STATUS_INVALID; | |
435 | goto end; | |
436 | } | |
437 | ||
438 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
439 | if (!syscall->pattern) { | |
440 | status = LTTNG_EVENT_RULE_STATUS_UNSET; | |
441 | goto end; | |
442 | } | |
443 | ||
444 | *pattern = syscall->pattern; | |
445 | end: | |
446 | return status; | |
447 | } | |
448 | ||
449 | enum lttng_event_rule_status lttng_event_rule_syscall_set_filter( | |
450 | struct lttng_event_rule *rule, const char *expression) | |
451 | { | |
452 | char *expression_copy = NULL; | |
453 | struct lttng_event_rule_syscall *syscall; | |
454 | enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK; | |
455 | ||
456 | /* TODO: validate that the passed expression is valid. */ | |
457 | ||
458 | if (!rule || !IS_SYSCALL_EVENT_RULE(rule) || !expression || | |
459 | strlen(expression) == 0) { | |
460 | status = LTTNG_EVENT_RULE_STATUS_INVALID; | |
461 | goto end; | |
462 | } | |
463 | ||
464 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
465 | expression_copy = strdup(expression); | |
466 | if (!expression_copy) { | |
467 | status = LTTNG_EVENT_RULE_STATUS_ERROR; | |
468 | goto end; | |
469 | } | |
470 | ||
471 | if (syscall->filter_expression) { | |
472 | free(syscall->filter_expression); | |
473 | } | |
474 | ||
475 | syscall->filter_expression = expression_copy; | |
476 | expression_copy = NULL; | |
477 | end: | |
478 | return status; | |
479 | } | |
480 | ||
481 | enum lttng_event_rule_status lttng_event_rule_syscall_get_filter( | |
482 | const struct lttng_event_rule *rule, const char **expression) | |
483 | { | |
484 | struct lttng_event_rule_syscall *syscall; | |
485 | enum lttng_event_rule_status status = LTTNG_EVENT_RULE_STATUS_OK; | |
486 | ||
487 | if (!rule || !IS_SYSCALL_EVENT_RULE(rule) || !expression) { | |
488 | status = LTTNG_EVENT_RULE_STATUS_INVALID; | |
489 | goto end; | |
490 | } | |
491 | ||
492 | syscall = container_of(rule, struct lttng_event_rule_syscall, parent); | |
493 | if (!syscall->filter_expression) { | |
494 | status = LTTNG_EVENT_RULE_STATUS_UNSET; | |
495 | goto end; | |
496 | } | |
497 | ||
498 | *expression = syscall->filter_expression; | |
499 | end: | |
500 | return status; | |
501 | } |