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