event-rule: Normalize pattern for syscall and tracepoint
[lttng-tools.git] / src / common / trigger.c
CommitLineData
a58c490f 1/*
ab5be9fa 2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
a58c490f 3 *
ab5be9fa 4 * SPDX-License-Identifier: LGPL-2.1-only
a58c490f 5 *
a58c490f
JG
6 */
7
8#include <lttng/trigger/trigger-internal.h>
9#include <lttng/condition/condition-internal.h>
e393070a
JR
10#include <lttng/condition/on-event-internal.h>
11#include <lttng/condition/on-event.h>
12#include <lttng/condition/on-event-internal.h>
91c96f62
JR
13#include <lttng/condition/buffer-usage.h>
14#include <lttng/event-rule/event-rule-internal.h>
f2e97f59 15#include <lttng/event-expr-internal.h>
a58c490f 16#include <lttng/action/action-internal.h>
3da864a9 17#include <common/credentials.h>
9e620ea7
JG
18#include <common/payload.h>
19#include <common/payload-view.h>
91c96f62 20#include <lttng/domain.h>
a58c490f 21#include <common/error.h>
a02903c0 22#include <common/dynamic-array.h>
3da864a9 23#include <common/optional.h>
a58c490f 24#include <assert.h>
242388e4 25#include <inttypes.h>
a58c490f
JG
26
27LTTNG_HIDDEN
b61776fb 28bool lttng_trigger_validate(const struct lttng_trigger *trigger)
a58c490f
JG
29{
30 bool valid;
31
32 if (!trigger) {
33 valid = false;
34 goto end;
35 }
36
64eafdf6
JR
37 if (!trigger->creds.uid.is_set) {
38 valid = false;
39 goto end;
40 }
41
a58c490f
JG
42 valid = lttng_condition_validate(trigger->condition) &&
43 lttng_action_validate(trigger->action);
44end:
45 return valid;
46}
47
48struct lttng_trigger *lttng_trigger_create(
49 struct lttng_condition *condition,
50 struct lttng_action *action)
51{
52 struct lttng_trigger *trigger = NULL;
53
54 if (!condition || !action) {
55 goto end;
56 }
57
58 trigger = zmalloc(sizeof(struct lttng_trigger));
59 if (!trigger) {
60 goto end;
61 }
62
f01d28b4
JR
63 urcu_ref_init(&trigger->ref);
64
5c504c41
JR
65 trigger->firing_policy.type = LTTNG_TRIGGER_FIRING_POLICY_EVERY_N;
66 trigger->firing_policy.threshold = 1;
67
7ca172c1 68 lttng_condition_get(condition);
a58c490f 69 trigger->condition = condition;
7ca172c1
JR
70
71 lttng_action_get(action);
a58c490f 72 trigger->action = action;
3da864a9 73
a58c490f
JG
74end:
75 return trigger;
76}
77
7ca172c1
JR
78/*
79 * Note: the lack of reference counting 'get' on the condition object is normal.
80 * This API was exposed as such in 2.11. The client is not expected to call
81 * lttng_condition_destroy on the returned object.
82 */
a58c490f
JG
83struct lttng_condition *lttng_trigger_get_condition(
84 struct lttng_trigger *trigger)
85{
86 return trigger ? trigger->condition : NULL;
87}
88
9b63a4aa
JG
89const struct lttng_condition *lttng_trigger_get_const_condition(
90 const struct lttng_trigger *trigger)
91{
0de2479d 92 return trigger ? trigger->condition : NULL;
9b63a4aa
JG
93}
94
7ca172c1
JR
95/*
96 * Note: the lack of reference counting 'get' on the action object is normal.
97 * This API was exposed as such in 2.11. The client is not expected to call
98 * lttng_action_destroy on the returned object.
99 */
e2ba1c78 100struct lttng_action *lttng_trigger_get_action(
a58c490f
JG
101 struct lttng_trigger *trigger)
102{
103 return trigger ? trigger->action : NULL;
104}
105
9b63a4aa
JG
106const struct lttng_action *lttng_trigger_get_const_action(
107 const struct lttng_trigger *trigger)
108{
0de2479d 109 return trigger ? trigger->action : NULL;
9b63a4aa
JG
110}
111
f01d28b4 112static void trigger_destroy_ref(struct urcu_ref *ref)
a58c490f 113{
f01d28b4
JR
114 struct lttng_trigger *trigger =
115 container_of(ref, struct lttng_trigger, ref);
7ca172c1
JR
116 struct lttng_action *action = lttng_trigger_get_action(trigger);
117 struct lttng_condition *condition =
118 lttng_trigger_get_condition(trigger);
119
7ca172c1
JR
120 assert(action);
121 assert(condition);
122
123 /* Release ownership. */
124 lttng_action_put(action);
125 lttng_condition_put(condition);
126
242388e4 127 free(trigger->name);
a58c490f
JG
128 free(trigger);
129}
130
f01d28b4
JR
131void lttng_trigger_destroy(struct lttng_trigger *trigger)
132{
133 lttng_trigger_put(trigger);
134}
135
5c504c41
JR
136static bool is_firing_policy_valid(enum lttng_trigger_firing_policy policy)
137{
138 bool valid = false;
139
140 switch (policy) {
141 case LTTNG_TRIGGER_FIRING_POLICY_EVERY_N:
142 case LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N:
143 valid = true;
144 break;
145 default:
146 valid = false;
147 break;
148 }
149
150 return valid;
151}
152
a58c490f 153LTTNG_HIDDEN
c0a66c84
JG
154ssize_t lttng_trigger_create_from_payload(
155 struct lttng_payload_view *src_view,
6808ef55 156 struct lttng_trigger **_trigger)
a58c490f 157{
242388e4 158 ssize_t ret, offset = 0, condition_size, action_size, name_size = 0;
a58c490f
JG
159 struct lttng_condition *condition = NULL;
160 struct lttng_action *action = NULL;
161 const struct lttng_trigger_comm *trigger_comm;
242388e4 162 const char *name = NULL;
5c504c41
JR
163 uint64_t firing_policy_threshold;
164 enum lttng_trigger_firing_policy firing_policy;
64eafdf6
JR
165 struct lttng_credentials creds = {
166 .uid = LTTNG_OPTIONAL_INIT_UNSET,
167 .gid = LTTNG_OPTIONAL_INIT_UNSET,
168 };
6808ef55 169 struct lttng_trigger *trigger = NULL;
3e6e0df2
JG
170 const struct lttng_payload_view trigger_comm_view =
171 lttng_payload_view_from_view(
172 src_view, 0, sizeof(*trigger_comm));
a58c490f 173
6808ef55 174 if (!src_view || !_trigger) {
a58c490f
JG
175 ret = -1;
176 goto end;
177 }
178
3e6e0df2
JG
179 if (!lttng_payload_view_is_valid(&trigger_comm_view)) {
180 /* Payload not large enough to contain the header. */
181 ret = -1;
182 goto end;
183 }
184
a58c490f 185 /* lttng_trigger_comm header */
3e6e0df2 186 trigger_comm = (typeof(trigger_comm)) trigger_comm_view.buffer.data;
64eafdf6
JR
187
188 /* Set the trigger's creds. */
189 if (trigger_comm->uid > (uint64_t) ((uid_t) -1)) {
190 /* UID out of range for this platform. */
191 ret = -1;
192 goto end;
193 }
194
195 LTTNG_OPTIONAL_SET(&creds.uid, trigger_comm->uid);
196
a58c490f 197 offset += sizeof(*trigger_comm);
242388e4 198
5c504c41
JR
199 firing_policy = trigger_comm->firing_policy_type;
200 if (!is_firing_policy_valid(firing_policy)) {
201 ret =-1;
202 goto end;
203 }
204
205 firing_policy_threshold = trigger_comm->firing_policy_threshold;
242388e4
JR
206 if (trigger_comm->name_length != 0) {
207 /* Name. */
208 const struct lttng_payload_view name_view =
209 lttng_payload_view_from_view(
3e6e0df2
JG
210 src_view, offset,
211 trigger_comm->name_length);
212
213 if (!lttng_payload_view_is_valid(&name_view)) {
214 ret = -1;
215 goto end;
216 }
242388e4
JR
217
218 name = name_view.buffer.data;
219 if (!lttng_buffer_view_contains_string(&name_view.buffer, name,
220 trigger_comm->name_length)) {
221 ret = -1;
222 goto end;
223 }
224
225 offset += trigger_comm->name_length;
226 name_size = trigger_comm->name_length;
227 }
228
c0a66c84
JG
229 {
230 /* struct lttng_condition */
231 struct lttng_payload_view condition_view =
232 lttng_payload_view_from_view(
233 src_view, offset, -1);
234
235 condition_size = lttng_condition_create_from_payload(&condition_view,
236 &condition);
237 }
a58c490f 238
a58c490f
JG
239 if (condition_size < 0) {
240 ret = condition_size;
241 goto end;
242 }
c0a66c84 243
a58c490f 244 offset += condition_size;
c0a66c84
JG
245 {
246 /* struct lttng_action */
247 struct lttng_payload_view action_view =
248 lttng_payload_view_from_view(
249 src_view, offset, -1);
250
251 action_size = lttng_action_create_from_payload(&action_view, &action);
252 }
a58c490f 253
a58c490f
JG
254 if (action_size < 0) {
255 ret = action_size;
256 goto end;
257 }
258 offset += action_size;
259
260 /* Unexpected size of inner-elements; the buffer is corrupted. */
242388e4 261 if ((ssize_t) trigger_comm->length != condition_size + action_size + name_size) {
a58c490f
JG
262 ret = -1;
263 goto error;
264 }
265
6808ef55
JG
266 trigger = lttng_trigger_create(condition, action);
267 if (!trigger) {
a58c490f
JG
268 ret = -1;
269 goto error;
270 }
c0a66c84 271
6808ef55 272 lttng_trigger_set_credentials(trigger, &creds);
64eafdf6 273
7ca172c1
JR
274 /*
275 * The trigger object owns references to the action and condition
276 * objects.
277 */
278 lttng_condition_put(condition);
279 condition = NULL;
280
281 lttng_action_put(action);
282 action = NULL;
283
242388e4
JR
284 if (name) {
285 const enum lttng_trigger_status status =
6808ef55 286 lttng_trigger_set_name(trigger, name);
242388e4
JR
287
288 if (status != LTTNG_TRIGGER_STATUS_OK) {
289 ret = -1;
290 goto end;
291 }
292 }
293
5c504c41
JR
294 /* Set the policy. */
295 {
296 const enum lttng_trigger_status status =
297 lttng_trigger_set_firing_policy(trigger,
298 firing_policy,
299 firing_policy_threshold);
300
301 if (status != LTTNG_TRIGGER_STATUS_OK) {
302 ret = -1;
303 goto end;
304 }
305 }
306
a58c490f 307 ret = offset;
7ca172c1 308
a58c490f 309error:
1065801b
JG
310 lttng_condition_put(condition);
311 lttng_action_put(action);
7ca172c1 312end:
f5d98ed9 313 if (ret >= 0) {
6808ef55
JG
314 *_trigger = trigger;
315 } else {
316 lttng_trigger_put(trigger);
317 }
318
a58c490f
JG
319 return ret;
320}
321
322/*
a58c490f
JG
323 * Both elements are stored contiguously, see their "*_comm" structure
324 * for the detailed format.
325 */
326LTTNG_HIDDEN
a02903c0 327int lttng_trigger_serialize(const struct lttng_trigger *trigger,
c0a66c84 328 struct lttng_payload *payload)
a58c490f 329{
3647288f 330 int ret;
242388e4 331 size_t header_offset, size_before_payload, size_name;
c0a66c84 332 struct lttng_trigger_comm trigger_comm = {};
3647288f 333 struct lttng_trigger_comm *header;
64eafdf6
JR
334 const struct lttng_credentials *creds = NULL;
335
336 creds = lttng_trigger_get_credentials(trigger);
337 assert(creds);
338
339 trigger_comm.uid = LTTNG_OPTIONAL_GET(creds->uid);
a58c490f 340
242388e4
JR
341 if (trigger->name != NULL) {
342 size_name = strlen(trigger->name) + 1;
343 } else {
344 size_name = 0;
345 }
346
347 trigger_comm.name_length = size_name;
5c504c41
JR
348 trigger_comm.firing_policy_type = (uint8_t) trigger->firing_policy.type;
349 trigger_comm.firing_policy_threshold = (uint64_t) trigger->firing_policy.threshold;
242388e4 350
c0a66c84
JG
351 header_offset = payload->buffer.size;
352 ret = lttng_dynamic_buffer_append(&payload->buffer, &trigger_comm,
3647288f
JG
353 sizeof(trigger_comm));
354 if (ret) {
a58c490f
JG
355 goto end;
356 }
357
c0a66c84 358 size_before_payload = payload->buffer.size;
242388e4
JR
359
360 /* Trigger name. */
361 ret = lttng_dynamic_buffer_append(
362 &payload->buffer, trigger->name, size_name);
363 if (ret) {
364 goto end;
365 }
366
c0a66c84 367 ret = lttng_condition_serialize(trigger->condition, payload);
3647288f 368 if (ret) {
a58c490f
JG
369 goto end;
370 }
a58c490f 371
c0a66c84 372 ret = lttng_action_serialize(trigger->action, payload);
3647288f 373 if (ret) {
a58c490f
JG
374 goto end;
375 }
a58c490f 376
3647288f 377 /* Update payload size. */
c0a66c84
JG
378 header = (typeof(header)) (payload->buffer.data + header_offset);
379 header->length = payload->buffer.size - size_before_payload;
a58c490f
JG
380end:
381 return ret;
382}
3da864a9 383
85c06c44
JR
384LTTNG_HIDDEN
385bool lttng_trigger_is_equal(
386 const struct lttng_trigger *a, const struct lttng_trigger *b)
387{
5c504c41
JR
388 if (a->firing_policy.type != b->firing_policy.type) {
389 return false;
390 }
391
392 if (a->firing_policy.threshold != b->firing_policy.threshold) {
393 return false;
394 }
395
1ca78886
FD
396 if (strcmp(a->name, b->name) != 0) {
397 return false;
398 }
399
85c06c44
JR
400 if (!lttng_condition_is_equal(a->condition, b->condition)) {
401 return false;
402 }
403
404 if (!lttng_action_is_equal(a->action, b->action)) {
405 return false;
406 }
407
408 if (!lttng_credentials_is_equal(lttng_trigger_get_credentials(a),
409 lttng_trigger_get_credentials(b))) {
410 return false;
411 }
412
413 return true;
414}
415
242388e4
JR
416enum lttng_trigger_status lttng_trigger_set_name(struct lttng_trigger *trigger,
417 const char* name)
418{
419 char *name_copy = NULL;
420 enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
421
422 if (!trigger || !name ||
423 strlen(name) == 0) {
424 status = LTTNG_TRIGGER_STATUS_INVALID;
425 goto end;
426 }
427
428 name_copy = strdup(name);
429 if (!name_copy) {
430 status = LTTNG_TRIGGER_STATUS_ERROR;
431 goto end;
432 }
433
434 free(trigger->name);
435
436 trigger->name = name_copy;
437 name_copy = NULL;
438end:
439 return status;
440}
441
442enum lttng_trigger_status lttng_trigger_get_name(
443 const struct lttng_trigger *trigger, const char **name)
444{
445 enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
446
447 if (!trigger || !name) {
448 status = LTTNG_TRIGGER_STATUS_INVALID;
449 goto end;
450 }
451
452 if (!trigger->name) {
453 status = LTTNG_TRIGGER_STATUS_UNSET;
454 }
455
456 *name = trigger->name;
457end:
458 return status;
459}
460
461LTTNG_HIDDEN
462int lttng_trigger_assign_name(struct lttng_trigger *dst,
463 const struct lttng_trigger *src)
464{
465 int ret = 0;
466 enum lttng_trigger_status status;
467
468 status = lttng_trigger_set_name(dst, src->name);
469 if (status != LTTNG_TRIGGER_STATUS_OK) {
470 ret = -1;
471 ERR("Failed to set name for trigger");
472 goto end;
473 }
474end:
475 return ret;
476}
477
e6887944
JR
478LTTNG_HIDDEN
479void lttng_trigger_set_tracer_token(struct lttng_trigger *trigger,
480 uint64_t token)
481{
482 assert(trigger);
483 LTTNG_OPTIONAL_SET(&trigger->tracer_token, token);
484}
485
486LTTNG_HIDDEN
487uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger *trigger)
488{
489 assert(trigger);
490
491 return LTTNG_OPTIONAL_GET(trigger->tracer_token);
492}
493
242388e4
JR
494LTTNG_HIDDEN
495int lttng_trigger_generate_name(struct lttng_trigger *trigger,
496 uint64_t unique_id)
497{
498 int ret = 0;
499 char *generated_name = NULL;
500
501 ret = asprintf(&generated_name, "T%" PRIu64 "", unique_id);
502 if (ret < 0) {
503 ERR("Failed to generate trigger name");
504 ret = -1;
505 goto end;
506 }
507
508 ret = 0;
509 free(trigger->name);
510 trigger->name = generated_name;
511end:
512 return ret;
513}
514
f01d28b4
JR
515LTTNG_HIDDEN
516void lttng_trigger_get(struct lttng_trigger *trigger)
517{
518 urcu_ref_get(&trigger->ref);
519}
520
521LTTNG_HIDDEN
522void lttng_trigger_put(struct lttng_trigger *trigger)
523{
524 if (!trigger) {
525 return;
526 }
527
528 urcu_ref_put(&trigger->ref , trigger_destroy_ref);
529}
530
a02903c0
JR
531static void delete_trigger_array_element(void *ptr)
532{
533 struct lttng_trigger *trigger = ptr;
534
535 lttng_trigger_put(trigger);
536}
537
538LTTNG_HIDDEN
539struct lttng_triggers *lttng_triggers_create(void)
540{
541 struct lttng_triggers *triggers = NULL;
542
543 triggers = zmalloc(sizeof(*triggers));
544 if (!triggers) {
545 goto end;
546 }
547
548 lttng_dynamic_pointer_array_init(&triggers->array, delete_trigger_array_element);
549
550end:
551 return triggers;
552}
553
554LTTNG_HIDDEN
555struct lttng_trigger *lttng_triggers_borrow_mutable_at_index(
556 const struct lttng_triggers *triggers, unsigned int index)
557{
558 struct lttng_trigger *trigger = NULL;
559
560 assert(triggers);
561 if (index >= lttng_dynamic_pointer_array_get_count(&triggers->array)) {
562 goto end;
563 }
564
565 trigger = (struct lttng_trigger *)
566 lttng_dynamic_pointer_array_get_pointer(
567 &triggers->array, index);
568end:
569 return trigger;
570}
571
572LTTNG_HIDDEN
573int lttng_triggers_add(
574 struct lttng_triggers *triggers, struct lttng_trigger *trigger)
575{
576 int ret;
577
578 assert(triggers);
579 assert(trigger);
580
581 lttng_trigger_get(trigger);
582
583 ret = lttng_dynamic_pointer_array_add_pointer(&triggers->array, trigger);
584 if (ret) {
585 lttng_trigger_put(trigger);
586 }
587
588 return ret;
589}
590
591const struct lttng_trigger *lttng_triggers_get_at_index(
592 const struct lttng_triggers *triggers, unsigned int index)
593{
594 return lttng_triggers_borrow_mutable_at_index(triggers, index);
595}
596
597enum lttng_trigger_status lttng_triggers_get_count(const struct lttng_triggers *triggers, unsigned int *count)
598{
599 enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
600
601 if (!triggers || !count) {
602 status = LTTNG_TRIGGER_STATUS_INVALID;
603 goto end;
604 }
605
606 *count = lttng_dynamic_pointer_array_get_count(&triggers->array);
607end:
608 return status;
609}
610
611void lttng_triggers_destroy(struct lttng_triggers *triggers)
612{
613 if (!triggers) {
614 return;
615 }
616
617 lttng_dynamic_pointer_array_reset(&triggers->array);
618 free(triggers);
619}
620
621int lttng_triggers_serialize(const struct lttng_triggers *triggers,
622 struct lttng_payload *payload)
623{
624 int ret;
625 unsigned int i, count;
626 size_t size_before_payload;
627 struct lttng_triggers_comm triggers_comm = {};
628 struct lttng_triggers_comm *header;
629 enum lttng_trigger_status status;
630 const size_t header_offset = payload->buffer.size;
631
632 status = lttng_triggers_get_count(triggers, &count);
633 if (status != LTTNG_TRIGGER_STATUS_OK) {
634 ret = LTTNG_ERR_INVALID;
635 goto end;
636 }
637
638 triggers_comm.count = count;
639
640 /* Placeholder header; updated at the end. */
641 ret = lttng_dynamic_buffer_append(&payload->buffer, &triggers_comm,
642 sizeof(triggers_comm));
643 if (ret) {
644 goto end;
645 }
646
647 size_before_payload = payload->buffer.size;
648
649 for (i = 0; i < count; i++) {
650 const struct lttng_trigger *trigger =
651 lttng_triggers_get_at_index(triggers, i);
652
653 assert(trigger);
654
655 ret = lttng_trigger_serialize(trigger, payload);
656 if (ret) {
657 goto end;
658 }
659 }
660
661 /* Update payload size. */
662 header = (struct lttng_triggers_comm *) ((char *) payload->buffer.data + header_offset);
663 header->length = payload->buffer.size - size_before_payload;
664end:
665 return ret;
666}
667
668LTTNG_HIDDEN
669ssize_t lttng_triggers_create_from_payload(
670 struct lttng_payload_view *src_view,
671 struct lttng_triggers **triggers)
672{
673 ssize_t ret, offset = 0, triggers_size = 0;
674 unsigned int i;
675 const struct lttng_triggers_comm *triggers_comm;
676 struct lttng_triggers *local_triggers = NULL;
677
678 if (!src_view || !triggers) {
679 ret = -1;
680 goto error;
681 }
682
683 /* lttng_trigger_comms header */
684 triggers_comm = (const struct lttng_triggers_comm *) src_view->buffer.data;
685 offset += sizeof(*triggers_comm);
686
687 local_triggers = lttng_triggers_create();
688 if (!local_triggers) {
689 ret = -1;
690 goto error;
691 }
692
693 for (i = 0; i < triggers_comm->count; i++) {
694 struct lttng_trigger *trigger = NULL;
695 struct lttng_payload_view trigger_view =
696 lttng_payload_view_from_view(src_view, offset, -1);
697 ssize_t trigger_size;
698
699 trigger_size = lttng_trigger_create_from_payload(
700 &trigger_view, &trigger);
701 if (trigger_size < 0) {
702 ret = trigger_size;
703 goto error;
704 }
705
706 /* Transfer ownership of the trigger to the collection. */
707 ret = lttng_triggers_add(local_triggers, trigger);
708 lttng_trigger_put(trigger);
709 if (ret < 0) {
710 ret = -1;
711 goto error;
712 }
713
714 offset += trigger_size;
715 triggers_size += trigger_size;
716 }
717
718 /* Unexpected size of inner-elements; the buffer is corrupted. */
719 if ((ssize_t) triggers_comm->length != triggers_size) {
720 ret = -1;
721 goto error;
722 }
723
724 /* Pass ownership to caller. */
725 *triggers = local_triggers;
726 local_triggers = NULL;
727
728 ret = offset;
729error:
730
731 lttng_triggers_destroy(local_triggers);
732 return ret;
733}
734
3da864a9
JR
735LTTNG_HIDDEN
736const struct lttng_credentials *lttng_trigger_get_credentials(
737 const struct lttng_trigger *trigger)
738{
64eafdf6 739 return &trigger->creds;
3da864a9
JR
740}
741
742LTTNG_HIDDEN
64eafdf6 743void lttng_trigger_set_credentials(struct lttng_trigger *trigger,
3da864a9
JR
744 const struct lttng_credentials *creds)
745{
746 assert(creds);
64eafdf6
JR
747 trigger->creds = *creds;
748}
749
750enum lttng_trigger_status lttng_trigger_set_owner_uid(
751 struct lttng_trigger *trigger, uid_t uid)
752{
753 enum lttng_trigger_status ret = LTTNG_TRIGGER_STATUS_OK;
754 const struct lttng_credentials creds = {
755 .uid = LTTNG_OPTIONAL_INIT_VALUE(uid),
756 .gid = LTTNG_OPTIONAL_INIT_UNSET,
757 };
758
759 if (!trigger) {
760 ret = LTTNG_TRIGGER_STATUS_INVALID;
761 goto end;
762 }
763
764 /* Client-side validation only to report a clearer error. */
765 if (geteuid() != 0) {
766 ret = LTTNG_TRIGGER_STATUS_PERMISSION_DENIED;
767 goto end;
768 }
769
770 lttng_trigger_set_credentials(trigger, &creds);
771
772end:
773 return ret;
774}
775
776enum lttng_trigger_status lttng_trigger_get_owner_uid(
777 const struct lttng_trigger *trigger, uid_t *uid)
778{
779 enum lttng_trigger_status ret = LTTNG_TRIGGER_STATUS_OK;
780 const struct lttng_credentials *creds = NULL;
781
782 if (!trigger || !uid ) {
783 ret = LTTNG_TRIGGER_STATUS_INVALID;
784 goto end;
785 }
786
787 if (!trigger->creds.uid.is_set ) {
788 ret = LTTNG_TRIGGER_STATUS_UNSET;
789 goto end;
790 }
791
792 creds = lttng_trigger_get_credentials(trigger);
793 *uid = lttng_credentials_get_uid(creds);
794
795end:
796 return ret;
3da864a9 797}
5c504c41
JR
798
799enum lttng_trigger_status lttng_trigger_set_firing_policy(
800 struct lttng_trigger *trigger,
801 enum lttng_trigger_firing_policy policy_type,
802 uint64_t threshold)
803{
804 enum lttng_trigger_status ret = LTTNG_TRIGGER_STATUS_OK;
805 assert(trigger);
806
807 if (threshold < 1) {
808 ret = LTTNG_TRIGGER_STATUS_INVALID;
809 goto end;
810 }
811
812 trigger->firing_policy.type = policy_type;
813 trigger->firing_policy.threshold = threshold;
814
815end:
816 return ret;
817}
818
819enum lttng_trigger_status lttng_trigger_get_firing_policy(
820 const struct lttng_trigger *trigger,
821 enum lttng_trigger_firing_policy *policy_type,
822 uint64_t *threshold)
823{
824 enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
825
826 if (!trigger || !policy_type || !threshold) {
827 status = LTTNG_TRIGGER_STATUS_INVALID;
828 goto end;
829 }
830
831 *policy_type = trigger->firing_policy.type;
832 *threshold = trigger->firing_policy.threshold;
833
834end:
835 return status;
836}
837
838LTTNG_HIDDEN
839bool lttng_trigger_should_fire(const struct lttng_trigger *trigger)
840{
841 bool ready_to_fire = false;
842
843 assert(trigger);
844
845 switch (trigger->firing_policy.type) {
846 case LTTNG_TRIGGER_FIRING_POLICY_EVERY_N:
847 if (trigger->firing_policy.current_count < trigger->firing_policy.threshold) {
848 ready_to_fire = true;
849 }
850 break;
851 case LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N:
852 if (trigger->firing_policy.current_count < trigger->firing_policy.threshold) {
853 ready_to_fire = true;
854 }
855 break;
856 default:
857 abort();
858 };
859
860 return ready_to_fire;
861}
862
863LTTNG_HIDDEN
864void lttng_trigger_fire(struct lttng_trigger *trigger)
865{
866 assert(trigger);
867
868 trigger->firing_policy.current_count++;
869
870 switch (trigger->firing_policy.type) {
871 case LTTNG_TRIGGER_FIRING_POLICY_EVERY_N:
872 if (trigger->firing_policy.current_count == trigger->firing_policy.threshold) {
873 trigger->firing_policy.current_count = 0;
874 }
875
876 break;
877 case LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N:
878 /*
879 * TODO:
880 * As an optimisation, deactivate the trigger condition and
881 * remove any checks in the traced application or kernel since
882 * the trigger will never fire again.
883 */
884 break;
885 default:
886 abort();
887 };
888}
91c96f62
JR
889
890LTTNG_HIDDEN
891enum lttng_domain_type lttng_trigger_get_underlying_domain_type_restriction(
892 const struct lttng_trigger *trigger)
893{
894 enum lttng_domain_type type = LTTNG_DOMAIN_NONE;
895 const struct lttng_event_rule *event_rule;
896 enum lttng_condition_status c_status;
897 enum lttng_condition_type c_type;
898
899 assert(trigger);
900 assert(trigger->condition);
901
902 c_type = lttng_condition_get_type(trigger->condition);
903 assert (c_type != LTTNG_CONDITION_TYPE_UNKNOWN);
904
905 switch (c_type) {
906 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
907 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
908 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
909 /* Apply to any domain. */
910 type = LTTNG_DOMAIN_NONE;
911 break;
d602bd6a 912 case LTTNG_CONDITION_TYPE_ON_EVENT:
91c96f62 913 /* Return the domain of the event rule. */
d602bd6a 914 c_status = lttng_condition_on_event_get_rule(
91c96f62
JR
915 trigger->condition, &event_rule);
916 assert(c_status == LTTNG_CONDITION_STATUS_OK);
917 type = lttng_event_rule_get_domain_type(event_rule);
918 break;
919 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
920 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
921 /* Return the domain of the channel being monitored. */
922 c_status = lttng_condition_buffer_usage_get_domain_type(
923 trigger->condition, &type);
924 assert(c_status == LTTNG_CONDITION_STATUS_OK);
925 break;
926 default:
927 abort();
928 }
929
930 return type;
931}
58daac01
JR
932
933/*
934 * Generate bytecode related to the trigger.
935 * On success LTTNG_OK. On error, returns lttng_error code.
936 */
937LTTNG_HIDDEN
938enum lttng_error_code lttng_trigger_generate_bytecode(
939 struct lttng_trigger *trigger,
940 const struct lttng_credentials *creds)
941{
942 enum lttng_error_code ret;
943 struct lttng_condition *condition = NULL;
944
945 condition = lttng_trigger_get_condition(trigger);
946 if (!condition) {
947 ret = LTTNG_ERR_INVALID_TRIGGER;
948 goto end;
949 }
950
951 switch (lttng_condition_get_type(condition)) {
d602bd6a 952 case LTTNG_CONDITION_TYPE_ON_EVENT:
58daac01
JR
953 {
954 struct lttng_event_rule *event_rule;
955 const enum lttng_condition_status condition_status =
d602bd6a 956 lttng_condition_on_event_borrow_rule_mutable(
58daac01
JR
957 condition, &event_rule);
958
959 assert(condition_status == LTTNG_CONDITION_STATUS_OK);
f2e97f59
JR
960
961 /* Generate the filter bytecode. */
58daac01
JR
962 ret = lttng_event_rule_generate_filter_bytecode(
963 event_rule, creds);
964 if (ret != LTTNG_OK) {
965 goto end;
966 }
967
f2e97f59 968 /* Generate the capture bytecode. */
d602bd6a 969 ret = lttng_condition_on_event_generate_capture_descriptor_bytecode(
f2e97f59
JR
970 condition);
971 if (ret != LTTNG_OK) {
972 goto end;
973 }
974
58daac01
JR
975 ret = LTTNG_OK;
976 break;
977 }
978 default:
979 ret = LTTNG_OK;
980 break;
981 }
982end:
983 return ret;
984}
b61776fb
SM
985
986LTTNG_HIDDEN
987struct lttng_trigger *lttng_trigger_copy(const struct lttng_trigger *trigger)
988{
989 int ret;
990 struct lttng_payload copy_buffer;
991 struct lttng_trigger *copy = NULL;
992
993 lttng_payload_init(&copy_buffer);
994
995 ret = lttng_trigger_serialize(trigger, &copy_buffer);
996 if (ret < 0) {
997 goto end;
998 }
999
1000 {
1001 struct lttng_payload_view view =
1002 lttng_payload_view_from_payload(
1003 &copy_buffer, 0, -1);
1004 ret = lttng_trigger_create_from_payload(
1005 &view, &copy);
1006 if (ret < 0) {
1007 copy = NULL;
1008 goto end;
1009 }
1010 }
1011
1012end:
1013 lttng_payload_reset(&copy_buffer);
1014 return copy;
1015}
c738df17
FD
1016
1017LTTNG_HIDDEN
1018bool lttng_trigger_needs_tracer_notifier(const struct lttng_trigger *trigger)
1019{
1020 bool needs_tracer_notifier = false;
1021 const struct lttng_condition *condition =
1022 lttng_trigger_get_const_condition(trigger);
1023
1024 switch (lttng_condition_get_type(condition)) {
1025 case LTTNG_CONDITION_TYPE_ON_EVENT:
1026 needs_tracer_notifier = true;
1027 goto end;
1028 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
1029 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
1030 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
1031 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
1032 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
1033 goto end;
1034 case LTTNG_CONDITION_TYPE_UNKNOWN:
1035 default:
1036 abort();
1037 }
1038end:
1039 return needs_tracer_notifier;
1040}
This page took 0.080286 seconds and 4 git commands to generate.