| 1 | /* |
| 2 | * error-query.c |
| 3 | * |
| 4 | * Copyright (C) 2021 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 5 | * |
| 6 | * SPDX-License-Identifier: GPL-2.1-only |
| 7 | * |
| 8 | */ |
| 9 | |
| 10 | #include <common/dynamic-array.hpp> |
| 11 | #include <common/error.hpp> |
| 12 | #include <common/macros.hpp> |
| 13 | #include <common/mi-lttng.hpp> |
| 14 | #include <common/sessiond-comm/sessiond-comm.hpp> |
| 15 | |
| 16 | #include <lttng/action/action-internal.hpp> |
| 17 | #include <lttng/action/list-internal.hpp> |
| 18 | #include <lttng/action/path-internal.hpp> |
| 19 | #include <lttng/error-query-internal.hpp> |
| 20 | #include <lttng/error-query.h> |
| 21 | #include <lttng/trigger/trigger-internal.hpp> |
| 22 | |
| 23 | #include <stddef.h> |
| 24 | |
| 25 | struct lttng_error_query { |
| 26 | enum lttng_error_query_target_type target_type; |
| 27 | }; |
| 28 | |
| 29 | struct lttng_error_query_result { |
| 30 | enum lttng_error_query_result_type type; |
| 31 | char *name; |
| 32 | char *description; |
| 33 | }; |
| 34 | |
| 35 | struct lttng_error_query_results { |
| 36 | struct lttng_dynamic_pointer_array results; |
| 37 | }; |
| 38 | |
| 39 | namespace { |
| 40 | struct lttng_error_query_comm { |
| 41 | /* enum lttng_error_query_target_type */ |
| 42 | int8_t target_type; |
| 43 | /* Target-specific payload. */ |
| 44 | char payload[]; |
| 45 | }; |
| 46 | |
| 47 | struct lttng_error_query_trigger { |
| 48 | struct lttng_error_query parent; |
| 49 | /* Mutable only because of the reference count. */ |
| 50 | struct lttng_trigger *trigger; |
| 51 | }; |
| 52 | |
| 53 | struct lttng_error_query_condition { |
| 54 | struct lttng_error_query parent; |
| 55 | /* Mutable only because of the reference count. */ |
| 56 | struct lttng_trigger *trigger; |
| 57 | }; |
| 58 | |
| 59 | struct lttng_error_query_action { |
| 60 | struct lttng_error_query parent; |
| 61 | /* Mutable only because of the reference count. */ |
| 62 | struct lttng_trigger *trigger; |
| 63 | struct lttng_action_path *action_path; |
| 64 | }; |
| 65 | |
| 66 | struct lttng_error_query_result_comm { |
| 67 | /* enum lttng_error_query_result_type */ |
| 68 | uint8_t type; |
| 69 | /* Length of name (including null-terminator). */ |
| 70 | uint32_t name_len; |
| 71 | /* Length of description (including null-terminator). */ |
| 72 | uint32_t description_len; |
| 73 | /* Name, description, and type-specific payload follow. */ |
| 74 | char payload[]; |
| 75 | } LTTNG_PACKED; |
| 76 | |
| 77 | struct lttng_error_query_result_counter_comm { |
| 78 | uint64_t value; |
| 79 | } LTTNG_PACKED; |
| 80 | |
| 81 | struct lttng_error_query_result_counter { |
| 82 | struct lttng_error_query_result parent; |
| 83 | uint64_t value; |
| 84 | }; |
| 85 | |
| 86 | struct lttng_error_query_results_comm { |
| 87 | uint32_t count; |
| 88 | /* `count` instances of `struct lttng_error_query_result` follow. */ |
| 89 | char payload[]; |
| 90 | } LTTNG_PACKED; |
| 91 | } /* namespace */ |
| 92 | |
| 93 | static enum lttng_error_code |
| 94 | lttng_error_query_result_mi_serialize(const struct lttng_error_query_result *result, |
| 95 | struct mi_writer *writer); |
| 96 | |
| 97 | static enum lttng_error_code |
| 98 | lttng_error_query_result_counter_mi_serialize(const struct lttng_error_query_result *result, |
| 99 | struct mi_writer *writer); |
| 100 | |
| 101 | struct lttng_error_query *lttng_error_query_trigger_create(const struct lttng_trigger *trigger) |
| 102 | { |
| 103 | struct lttng_error_query_trigger *query = nullptr; |
| 104 | struct lttng_trigger *trigger_copy = nullptr; |
| 105 | |
| 106 | if (!trigger) { |
| 107 | goto end; |
| 108 | } |
| 109 | |
| 110 | trigger_copy = lttng_trigger_copy(trigger); |
| 111 | if (!trigger_copy) { |
| 112 | goto end; |
| 113 | } |
| 114 | |
| 115 | query = zmalloc<lttng_error_query_trigger>(); |
| 116 | if (!query) { |
| 117 | PERROR("Failed to allocate trigger error query"); |
| 118 | goto error; |
| 119 | } |
| 120 | |
| 121 | query->parent.target_type = LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER; |
| 122 | query->trigger = trigger_copy; |
| 123 | trigger_copy = nullptr; |
| 124 | |
| 125 | error: |
| 126 | lttng_trigger_put(trigger_copy); |
| 127 | end: |
| 128 | return query ? &query->parent : nullptr; |
| 129 | } |
| 130 | |
| 131 | struct lttng_error_query *lttng_error_query_condition_create(const struct lttng_trigger *trigger) |
| 132 | { |
| 133 | struct lttng_error_query_condition *query = nullptr; |
| 134 | struct lttng_trigger *trigger_copy = nullptr; |
| 135 | |
| 136 | if (!trigger) { |
| 137 | goto end; |
| 138 | } |
| 139 | |
| 140 | trigger_copy = lttng_trigger_copy(trigger); |
| 141 | if (!trigger_copy) { |
| 142 | goto end; |
| 143 | } |
| 144 | |
| 145 | query = zmalloc<lttng_error_query_condition>(); |
| 146 | if (!query) { |
| 147 | PERROR("Failed to allocate condition error query"); |
| 148 | goto error; |
| 149 | } |
| 150 | |
| 151 | query->parent.target_type = LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION; |
| 152 | query->trigger = trigger_copy; |
| 153 | trigger_copy = nullptr; |
| 154 | |
| 155 | error: |
| 156 | lttng_trigger_put(trigger_copy); |
| 157 | end: |
| 158 | return query ? &query->parent : nullptr; |
| 159 | } |
| 160 | |
| 161 | static struct lttng_action * |
| 162 | get_trigger_action_from_path(struct lttng_trigger *trigger, |
| 163 | const struct lttng_action_path *action_path) |
| 164 | { |
| 165 | size_t index_count, i; |
| 166 | enum lttng_action_path_status path_status; |
| 167 | struct lttng_action *current_action = nullptr; |
| 168 | |
| 169 | path_status = lttng_action_path_get_index_count(action_path, &index_count); |
| 170 | if (path_status != LTTNG_ACTION_PATH_STATUS_OK) { |
| 171 | goto end; |
| 172 | } |
| 173 | |
| 174 | current_action = lttng_trigger_get_action(trigger); |
| 175 | for (i = 0; i < index_count; i++) { |
| 176 | uint64_t path_index; |
| 177 | |
| 178 | path_status = lttng_action_path_get_index_at_index(action_path, i, &path_index); |
| 179 | current_action = |
| 180 | lttng_action_list_borrow_mutable_at_index(current_action, path_index); |
| 181 | if (!current_action) { |
| 182 | /* Invalid action path. */ |
| 183 | goto end; |
| 184 | } |
| 185 | } |
| 186 | |
| 187 | end: |
| 188 | return current_action; |
| 189 | } |
| 190 | |
| 191 | static bool is_valid_action_path(const struct lttng_trigger *trigger, |
| 192 | const struct lttng_action_path *action_path) |
| 193 | { |
| 194 | /* |
| 195 | * While 'trigger's constness is casted-away, the trigger and resulting |
| 196 | * action are not modified; we merely check for the action's existence. |
| 197 | */ |
| 198 | return !!get_trigger_action_from_path((struct lttng_trigger *) trigger, action_path); |
| 199 | } |
| 200 | |
| 201 | struct lttng_error_query * |
| 202 | lttng_error_query_action_create(const struct lttng_trigger *trigger, |
| 203 | const struct lttng_action_path *action_path) |
| 204 | { |
| 205 | struct lttng_error_query_action *query = nullptr; |
| 206 | struct lttng_trigger *trigger_copy = nullptr; |
| 207 | int ret_copy; |
| 208 | |
| 209 | if (!trigger || !action_path || !is_valid_action_path(trigger, action_path)) { |
| 210 | goto end; |
| 211 | } |
| 212 | |
| 213 | trigger_copy = lttng_trigger_copy(trigger); |
| 214 | if (!trigger_copy) { |
| 215 | goto end; |
| 216 | } |
| 217 | |
| 218 | query = zmalloc<lttng_error_query_action>(); |
| 219 | if (!query) { |
| 220 | PERROR("Failed to allocate action error query"); |
| 221 | goto error; |
| 222 | } |
| 223 | |
| 224 | ret_copy = lttng_action_path_copy(action_path, &query->action_path); |
| 225 | if (ret_copy) { |
| 226 | goto error; |
| 227 | } |
| 228 | |
| 229 | query->parent.target_type = LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION; |
| 230 | query->trigger = trigger_copy; |
| 231 | trigger_copy = nullptr; |
| 232 | goto end; |
| 233 | |
| 234 | error: |
| 235 | lttng_trigger_put(trigger_copy); |
| 236 | lttng_error_query_destroy(query ? &query->parent : nullptr); |
| 237 | end: |
| 238 | return query ? &query->parent : nullptr; |
| 239 | } |
| 240 | |
| 241 | void lttng_error_query_destroy(struct lttng_error_query *query) |
| 242 | { |
| 243 | if (!query) { |
| 244 | return; |
| 245 | } |
| 246 | |
| 247 | switch (query->target_type) { |
| 248 | case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER: |
| 249 | { |
| 250 | struct lttng_error_query_trigger *trigger_query = |
| 251 | lttng::utils::container_of(query, <tng_error_query_trigger::parent); |
| 252 | |
| 253 | lttng_trigger_put(trigger_query->trigger); |
| 254 | free(trigger_query); |
| 255 | break; |
| 256 | } |
| 257 | case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION: |
| 258 | { |
| 259 | struct lttng_error_query_condition *condition_query = |
| 260 | lttng::utils::container_of(query, <tng_error_query_condition::parent); |
| 261 | |
| 262 | lttng_trigger_put(condition_query->trigger); |
| 263 | free(condition_query); |
| 264 | break; |
| 265 | } |
| 266 | case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION: |
| 267 | { |
| 268 | struct lttng_error_query_action *action_query = |
| 269 | lttng::utils::container_of(query, <tng_error_query_action::parent); |
| 270 | |
| 271 | lttng_trigger_put(action_query->trigger); |
| 272 | lttng_action_path_destroy(action_query->action_path); |
| 273 | free(action_query); |
| 274 | break; |
| 275 | } |
| 276 | default: |
| 277 | abort(); |
| 278 | } |
| 279 | } |
| 280 | |
| 281 | static int lttng_error_query_result_counter_serialize(const struct lttng_error_query_result *result, |
| 282 | struct lttng_payload *payload) |
| 283 | { |
| 284 | const struct lttng_error_query_result_counter *counter_result; |
| 285 | |
| 286 | LTTNG_ASSERT(result->type == LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER); |
| 287 | counter_result = |
| 288 | lttng::utils::container_of(result, <tng_error_query_result_counter::parent); |
| 289 | |
| 290 | lttng_error_query_result_counter_comm comm = { |
| 291 | .value = counter_result->value, |
| 292 | }; |
| 293 | |
| 294 | return lttng_dynamic_buffer_append( |
| 295 | &payload->buffer, &comm, sizeof(struct lttng_error_query_result_counter_comm)); |
| 296 | } |
| 297 | |
| 298 | int lttng_error_query_result_serialize(const struct lttng_error_query_result *result, |
| 299 | struct lttng_payload *payload) |
| 300 | { |
| 301 | int ret; |
| 302 | struct lttng_error_query_result_comm header; |
| 303 | |
| 304 | header.type = (uint8_t) result->type; |
| 305 | header.name_len = (typeof(header.name_len)) strlen(result->name) + 1; |
| 306 | header.description_len = (typeof(header.name_len)) strlen(result->description) + 1; |
| 307 | |
| 308 | /* Header. */ |
| 309 | ret = lttng_dynamic_buffer_append(&payload->buffer, &header, sizeof(header)); |
| 310 | if (ret) { |
| 311 | ERR("Failed to append error query result communication header to payload"); |
| 312 | goto end; |
| 313 | } |
| 314 | |
| 315 | /* Name. */ |
| 316 | ret = lttng_dynamic_buffer_append(&payload->buffer, result->name, header.name_len); |
| 317 | if (ret) { |
| 318 | ERR("Failed to append error query result name to payload"); |
| 319 | goto end; |
| 320 | } |
| 321 | |
| 322 | /* Description. */ |
| 323 | ret = lttng_dynamic_buffer_append( |
| 324 | &payload->buffer, result->description, header.description_len); |
| 325 | if (ret) { |
| 326 | ERR("Failed to append error query result description to payload"); |
| 327 | goto end; |
| 328 | } |
| 329 | |
| 330 | /* Type-specific payload. */ |
| 331 | switch (result->type) { |
| 332 | case LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER: |
| 333 | ret = lttng_error_query_result_counter_serialize(result, payload); |
| 334 | if (ret) { |
| 335 | ERR("Failed to serialize counter error query result"); |
| 336 | goto end; |
| 337 | } |
| 338 | break; |
| 339 | default: |
| 340 | abort(); |
| 341 | } |
| 342 | |
| 343 | end: |
| 344 | return ret; |
| 345 | } |
| 346 | |
| 347 | static int lttng_error_query_result_init(struct lttng_error_query_result *result, |
| 348 | enum lttng_error_query_result_type result_type, |
| 349 | const char *name, |
| 350 | const char *description) |
| 351 | { |
| 352 | int ret; |
| 353 | |
| 354 | LTTNG_ASSERT(name); |
| 355 | LTTNG_ASSERT(description); |
| 356 | |
| 357 | result->type = result_type; |
| 358 | |
| 359 | result->name = strdup(name); |
| 360 | if (!result->name) { |
| 361 | PERROR("Failed to copy error query result name"); |
| 362 | ret = -1; |
| 363 | goto end; |
| 364 | } |
| 365 | |
| 366 | result->description = strdup(description); |
| 367 | if (!result->description) { |
| 368 | PERROR("Failed to copy error query result description"); |
| 369 | ret = -1; |
| 370 | goto end; |
| 371 | } |
| 372 | |
| 373 | ret = 0; |
| 374 | end: |
| 375 | return ret; |
| 376 | } |
| 377 | |
| 378 | void lttng_error_query_result_destroy(struct lttng_error_query_result *counter) |
| 379 | { |
| 380 | if (!counter) { |
| 381 | return; |
| 382 | } |
| 383 | |
| 384 | switch (counter->type) { |
| 385 | case LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER: |
| 386 | /* Nothing to tear down. */ |
| 387 | break; |
| 388 | default: |
| 389 | abort(); |
| 390 | } |
| 391 | |
| 392 | free(counter->name); |
| 393 | free(counter->description); |
| 394 | free(counter); |
| 395 | } |
| 396 | |
| 397 | struct lttng_error_query_result * |
| 398 | lttng_error_query_result_counter_create(const char *name, const char *description, uint64_t value) |
| 399 | { |
| 400 | int init_ret; |
| 401 | struct lttng_error_query_result_counter *counter; |
| 402 | |
| 403 | counter = zmalloc<lttng_error_query_result_counter>(); |
| 404 | if (!counter) { |
| 405 | PERROR("Failed to allocate error query counter result"); |
| 406 | goto end; |
| 407 | } |
| 408 | |
| 409 | init_ret = lttng_error_query_result_init( |
| 410 | &counter->parent, LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER, name, description); |
| 411 | if (init_ret) { |
| 412 | goto error; |
| 413 | } |
| 414 | |
| 415 | counter->value = value; |
| 416 | goto end; |
| 417 | error: |
| 418 | lttng_error_query_result_destroy(&counter->parent); |
| 419 | end: |
| 420 | return counter ? &counter->parent : nullptr; |
| 421 | } |
| 422 | |
| 423 | static void destroy_result(void *ptr) |
| 424 | { |
| 425 | struct lttng_error_query_result *result = (typeof(result)) ptr; |
| 426 | |
| 427 | lttng_error_query_result_destroy(result); |
| 428 | } |
| 429 | |
| 430 | struct lttng_error_query_results *lttng_error_query_results_create() |
| 431 | { |
| 432 | struct lttng_error_query_results *set = zmalloc<lttng_error_query_results>(); |
| 433 | |
| 434 | if (!set) { |
| 435 | PERROR("Failed to allocate an error query result set"); |
| 436 | goto end; |
| 437 | } |
| 438 | |
| 439 | lttng_dynamic_pointer_array_init(&set->results, destroy_result); |
| 440 | end: |
| 441 | return set; |
| 442 | } |
| 443 | |
| 444 | int lttng_error_query_results_add_result(struct lttng_error_query_results *results, |
| 445 | struct lttng_error_query_result *result) |
| 446 | { |
| 447 | return lttng_dynamic_pointer_array_add_pointer(&results->results, result); |
| 448 | } |
| 449 | |
| 450 | ssize_t lttng_error_query_result_create_from_payload(struct lttng_payload_view *view, |
| 451 | struct lttng_error_query_result **result) |
| 452 | { |
| 453 | ssize_t used_size = 0; |
| 454 | struct lttng_error_query_result_comm *header; |
| 455 | struct lttng_payload_view header_view = |
| 456 | lttng_payload_view_from_view(view, 0, sizeof(*header)); |
| 457 | const char *name; |
| 458 | const char *description; |
| 459 | |
| 460 | if (!lttng_payload_view_is_valid(&header_view)) { |
| 461 | used_size = -1; |
| 462 | goto end; |
| 463 | } |
| 464 | |
| 465 | header = (typeof(header)) header_view.buffer.data; |
| 466 | used_size += sizeof(*header); |
| 467 | |
| 468 | { |
| 469 | struct lttng_payload_view name_view = |
| 470 | lttng_payload_view_from_view(view, used_size, header->name_len); |
| 471 | |
| 472 | if (!lttng_payload_view_is_valid(&name_view) || |
| 473 | !lttng_buffer_view_contains_string( |
| 474 | &name_view.buffer, name_view.buffer.data, header->name_len)) { |
| 475 | used_size = -1; |
| 476 | goto end; |
| 477 | } |
| 478 | |
| 479 | name = name_view.buffer.data; |
| 480 | used_size += header->name_len; |
| 481 | } |
| 482 | |
| 483 | { |
| 484 | struct lttng_payload_view description_view = |
| 485 | lttng_payload_view_from_view(view, used_size, header->description_len); |
| 486 | |
| 487 | if (!lttng_payload_view_is_valid(&description_view) || |
| 488 | !lttng_buffer_view_contains_string(&description_view.buffer, |
| 489 | description_view.buffer.data, |
| 490 | header->description_len)) { |
| 491 | used_size = -1; |
| 492 | goto end; |
| 493 | } |
| 494 | |
| 495 | description = description_view.buffer.data; |
| 496 | used_size += header->description_len; |
| 497 | } |
| 498 | |
| 499 | switch (header->type) { |
| 500 | case LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER: |
| 501 | { |
| 502 | struct lttng_error_query_result_counter_comm *counter; |
| 503 | struct lttng_payload_view counter_payload_view = |
| 504 | lttng_payload_view_from_view(view, used_size, sizeof(*counter)); |
| 505 | |
| 506 | if (!lttng_payload_view_is_valid(&counter_payload_view)) { |
| 507 | used_size = -1; |
| 508 | goto end; |
| 509 | } |
| 510 | |
| 511 | counter = (typeof(counter)) counter_payload_view.buffer.data; |
| 512 | *result = |
| 513 | lttng_error_query_result_counter_create(name, description, counter->value); |
| 514 | if (!*result) { |
| 515 | used_size = -1; |
| 516 | goto end; |
| 517 | } |
| 518 | |
| 519 | used_size += sizeof(*counter); |
| 520 | break; |
| 521 | } |
| 522 | default: |
| 523 | used_size = -1; |
| 524 | goto end; |
| 525 | } |
| 526 | |
| 527 | end: |
| 528 | return used_size; |
| 529 | } |
| 530 | |
| 531 | int lttng_error_query_results_serialize(const struct lttng_error_query_results *results, |
| 532 | struct lttng_payload *payload) |
| 533 | { |
| 534 | int ret; |
| 535 | size_t result_index; |
| 536 | const size_t result_count = lttng_dynamic_pointer_array_get_count(&results->results); |
| 537 | struct lttng_error_query_results_comm header; |
| 538 | |
| 539 | header.count = (decltype(header.count)) result_count; |
| 540 | |
| 541 | /* Header. */ |
| 542 | ret = lttng_dynamic_buffer_append(&payload->buffer, &header, sizeof(header)); |
| 543 | if (ret) { |
| 544 | ERR("Failed to append error query result set header to payload"); |
| 545 | goto end; |
| 546 | } |
| 547 | |
| 548 | /* Results. */ |
| 549 | for (result_index = 0; result_index < result_count; result_index++) { |
| 550 | const struct lttng_error_query_result *result = |
| 551 | (typeof(result)) lttng_dynamic_pointer_array_get_pointer(&results->results, |
| 552 | result_index); |
| 553 | |
| 554 | ret = lttng_error_query_result_serialize(result, payload); |
| 555 | if (ret) { |
| 556 | ERR("Failed to append error query result to payload"); |
| 557 | goto end; |
| 558 | } |
| 559 | } |
| 560 | end: |
| 561 | return ret; |
| 562 | } |
| 563 | |
| 564 | ssize_t lttng_error_query_results_create_from_payload(struct lttng_payload_view *view, |
| 565 | struct lttng_error_query_results **_results) |
| 566 | { |
| 567 | size_t result_index; |
| 568 | ssize_t total_used_size = 0; |
| 569 | struct lttng_error_query_results_comm *header; |
| 570 | struct lttng_payload_view header_view = |
| 571 | lttng_payload_view_from_view(view, 0, sizeof(*header)); |
| 572 | struct lttng_error_query_results *results = nullptr; |
| 573 | |
| 574 | if (!lttng_payload_view_is_valid(&header_view)) { |
| 575 | ERR("Failed to map view to error query result set header"); |
| 576 | total_used_size = -1; |
| 577 | goto end; |
| 578 | } |
| 579 | |
| 580 | header = (typeof(header)) header_view.buffer.data; |
| 581 | total_used_size += sizeof(*header); |
| 582 | results = lttng_error_query_results_create(); |
| 583 | if (!results) { |
| 584 | total_used_size = -1; |
| 585 | goto end; |
| 586 | } |
| 587 | |
| 588 | for (result_index = 0; result_index < header->count; result_index++) { |
| 589 | ssize_t used_size; |
| 590 | struct lttng_error_query_result *result; |
| 591 | struct lttng_payload_view result_view = |
| 592 | lttng_payload_view_from_view(view, total_used_size, -1); |
| 593 | |
| 594 | if (!lttng_payload_view_is_valid(&result_view)) { |
| 595 | total_used_size = -1; |
| 596 | goto end; |
| 597 | } |
| 598 | |
| 599 | used_size = lttng_error_query_result_create_from_payload(&result_view, &result); |
| 600 | if (used_size < 0) { |
| 601 | total_used_size = -1; |
| 602 | goto end; |
| 603 | } |
| 604 | |
| 605 | total_used_size += used_size; |
| 606 | |
| 607 | if (lttng_dynamic_pointer_array_add_pointer(&results->results, result)) { |
| 608 | lttng_error_query_result_destroy(result); |
| 609 | total_used_size = -1; |
| 610 | goto end; |
| 611 | } |
| 612 | } |
| 613 | |
| 614 | *_results = results; |
| 615 | results = nullptr; |
| 616 | end: |
| 617 | lttng_error_query_results_destroy(results); |
| 618 | return total_used_size; |
| 619 | } |
| 620 | |
| 621 | static int lttng_error_query_trigger_serialize(const struct lttng_error_query *query, |
| 622 | struct lttng_payload *payload) |
| 623 | { |
| 624 | int ret; |
| 625 | const struct lttng_error_query_trigger *query_trigger = |
| 626 | lttng::utils::container_of(query, <tng_error_query_trigger::parent); |
| 627 | |
| 628 | if (!lttng_trigger_validate(query_trigger->trigger)) { |
| 629 | ret = -1; |
| 630 | goto end; |
| 631 | } |
| 632 | |
| 633 | ret = lttng_trigger_serialize(query_trigger->trigger, payload); |
| 634 | if (ret) { |
| 635 | goto end; |
| 636 | } |
| 637 | |
| 638 | end: |
| 639 | return ret; |
| 640 | } |
| 641 | |
| 642 | static int lttng_error_query_condition_serialize(const struct lttng_error_query *query, |
| 643 | struct lttng_payload *payload) |
| 644 | { |
| 645 | int ret; |
| 646 | const struct lttng_error_query_condition *query_trigger = |
| 647 | lttng::utils::container_of(query, <tng_error_query_condition::parent); |
| 648 | |
| 649 | if (!lttng_trigger_validate(query_trigger->trigger)) { |
| 650 | ret = -1; |
| 651 | goto end; |
| 652 | } |
| 653 | |
| 654 | ret = lttng_trigger_serialize(query_trigger->trigger, payload); |
| 655 | if (ret) { |
| 656 | goto end; |
| 657 | } |
| 658 | |
| 659 | end: |
| 660 | return ret; |
| 661 | } |
| 662 | |
| 663 | static int lttng_error_query_action_serialize(const struct lttng_error_query *query, |
| 664 | struct lttng_payload *payload) |
| 665 | { |
| 666 | int ret; |
| 667 | const struct lttng_error_query_action *query_action = |
| 668 | lttng::utils::container_of(query, <tng_error_query_action::parent); |
| 669 | |
| 670 | if (!lttng_trigger_validate(query_action->trigger)) { |
| 671 | ret = -1; |
| 672 | goto end; |
| 673 | } |
| 674 | |
| 675 | ret = lttng_trigger_serialize(query_action->trigger, payload); |
| 676 | if (ret) { |
| 677 | goto end; |
| 678 | } |
| 679 | |
| 680 | ret = lttng_action_path_serialize(query_action->action_path, payload); |
| 681 | if (ret) { |
| 682 | goto end; |
| 683 | } |
| 684 | |
| 685 | end: |
| 686 | return ret; |
| 687 | } |
| 688 | |
| 689 | enum lttng_error_query_target_type |
| 690 | lttng_error_query_get_target_type(const struct lttng_error_query *query) |
| 691 | { |
| 692 | return query->target_type; |
| 693 | } |
| 694 | |
| 695 | const struct lttng_trigger * |
| 696 | lttng_error_query_trigger_borrow_target(const struct lttng_error_query *query) |
| 697 | { |
| 698 | const struct lttng_error_query_trigger *query_trigger = |
| 699 | lttng::utils::container_of(query, <tng_error_query_trigger::parent); |
| 700 | |
| 701 | return query_trigger->trigger; |
| 702 | } |
| 703 | |
| 704 | const struct lttng_trigger * |
| 705 | lttng_error_query_condition_borrow_target(const struct lttng_error_query *query) |
| 706 | { |
| 707 | const struct lttng_error_query_condition *query_trigger = |
| 708 | lttng::utils::container_of(query, <tng_error_query_condition::parent); |
| 709 | |
| 710 | return query_trigger->trigger; |
| 711 | } |
| 712 | |
| 713 | const struct lttng_trigger * |
| 714 | lttng_error_query_action_borrow_trigger_target(const struct lttng_error_query *query) |
| 715 | { |
| 716 | const struct lttng_error_query_action *query_action = |
| 717 | lttng::utils::container_of(query, <tng_error_query_action::parent); |
| 718 | |
| 719 | return query_action->trigger; |
| 720 | } |
| 721 | |
| 722 | struct lttng_action * |
| 723 | lttng_error_query_action_borrow_action_target(const struct lttng_error_query *query, |
| 724 | struct lttng_trigger *trigger) |
| 725 | { |
| 726 | const struct lttng_error_query_action *query_action = |
| 727 | lttng::utils::container_of(query, <tng_error_query_action::parent); |
| 728 | |
| 729 | return get_trigger_action_from_path(trigger, query_action->action_path); |
| 730 | } |
| 731 | |
| 732 | int lttng_error_query_serialize(const struct lttng_error_query *query, |
| 733 | struct lttng_payload *payload) |
| 734 | { |
| 735 | int ret; |
| 736 | struct lttng_error_query_comm header; |
| 737 | |
| 738 | header.target_type = (decltype(header.target_type)) query->target_type; |
| 739 | |
| 740 | ret = lttng_dynamic_buffer_append(&payload->buffer, &header, sizeof(header)); |
| 741 | if (ret) { |
| 742 | ERR("Failed to append error query header to payload"); |
| 743 | goto end; |
| 744 | } |
| 745 | |
| 746 | switch (query->target_type) { |
| 747 | case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER: |
| 748 | ret = lttng_error_query_trigger_serialize(query, payload); |
| 749 | if (ret) { |
| 750 | goto end; |
| 751 | } |
| 752 | |
| 753 | break; |
| 754 | case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION: |
| 755 | ret = lttng_error_query_condition_serialize(query, payload); |
| 756 | if (ret) { |
| 757 | goto end; |
| 758 | } |
| 759 | |
| 760 | break; |
| 761 | case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION: |
| 762 | ret = lttng_error_query_action_serialize(query, payload); |
| 763 | if (ret) { |
| 764 | goto end; |
| 765 | } |
| 766 | |
| 767 | break; |
| 768 | default: |
| 769 | abort(); |
| 770 | } |
| 771 | end: |
| 772 | return ret; |
| 773 | } |
| 774 | |
| 775 | ssize_t lttng_error_query_create_from_payload(struct lttng_payload_view *view, |
| 776 | struct lttng_error_query **query) |
| 777 | { |
| 778 | ssize_t used_size = 0; |
| 779 | struct lttng_error_query_comm *header; |
| 780 | struct lttng_trigger *trigger = nullptr; |
| 781 | struct lttng_payload_view header_view = |
| 782 | lttng_payload_view_from_view(view, 0, sizeof(*header)); |
| 783 | |
| 784 | if (!lttng_payload_view_is_valid(&header_view)) { |
| 785 | ERR("Failed to map error query header"); |
| 786 | used_size = -1; |
| 787 | goto end; |
| 788 | } |
| 789 | |
| 790 | used_size = sizeof(*header); |
| 791 | |
| 792 | header = (typeof(header)) header_view.buffer.data; |
| 793 | switch ((enum lttng_error_query_target_type) header->target_type) { |
| 794 | case LTTNG_ERROR_QUERY_TARGET_TYPE_TRIGGER: |
| 795 | { |
| 796 | ssize_t trigger_used_size; |
| 797 | struct lttng_payload_view trigger_view = |
| 798 | lttng_payload_view_from_view(view, used_size, -1); |
| 799 | |
| 800 | if (!lttng_payload_view_is_valid(&trigger_view)) { |
| 801 | used_size = -1; |
| 802 | goto end; |
| 803 | } |
| 804 | |
| 805 | trigger_used_size = lttng_trigger_create_from_payload(&trigger_view, &trigger); |
| 806 | if (trigger_used_size < 0) { |
| 807 | used_size = -1; |
| 808 | goto end; |
| 809 | } |
| 810 | |
| 811 | used_size += trigger_used_size; |
| 812 | |
| 813 | *query = lttng_error_query_trigger_create(trigger); |
| 814 | if (!*query) { |
| 815 | used_size = -1; |
| 816 | goto end; |
| 817 | } |
| 818 | |
| 819 | break; |
| 820 | } |
| 821 | case LTTNG_ERROR_QUERY_TARGET_TYPE_CONDITION: |
| 822 | { |
| 823 | ssize_t trigger_used_size; |
| 824 | struct lttng_payload_view trigger_view = |
| 825 | lttng_payload_view_from_view(view, used_size, -1); |
| 826 | |
| 827 | if (!lttng_payload_view_is_valid(&trigger_view)) { |
| 828 | used_size = -1; |
| 829 | goto end; |
| 830 | } |
| 831 | |
| 832 | trigger_used_size = lttng_trigger_create_from_payload(&trigger_view, &trigger); |
| 833 | if (trigger_used_size < 0) { |
| 834 | used_size = -1; |
| 835 | goto end; |
| 836 | } |
| 837 | |
| 838 | used_size += trigger_used_size; |
| 839 | |
| 840 | *query = lttng_error_query_condition_create(trigger); |
| 841 | if (!*query) { |
| 842 | used_size = -1; |
| 843 | goto end; |
| 844 | } |
| 845 | |
| 846 | break; |
| 847 | } |
| 848 | case LTTNG_ERROR_QUERY_TARGET_TYPE_ACTION: |
| 849 | { |
| 850 | struct lttng_action_path *action_path = nullptr; |
| 851 | |
| 852 | { |
| 853 | ssize_t trigger_used_size; |
| 854 | struct lttng_payload_view trigger_view = |
| 855 | lttng_payload_view_from_view(view, used_size, -1); |
| 856 | |
| 857 | if (!lttng_payload_view_is_valid(&trigger_view)) { |
| 858 | used_size = -1; |
| 859 | goto end; |
| 860 | } |
| 861 | |
| 862 | trigger_used_size = |
| 863 | lttng_trigger_create_from_payload(&trigger_view, &trigger); |
| 864 | if (trigger_used_size < 0) { |
| 865 | used_size = -1; |
| 866 | goto end; |
| 867 | } |
| 868 | |
| 869 | used_size += trigger_used_size; |
| 870 | } |
| 871 | |
| 872 | { |
| 873 | ssize_t action_path_used_size; |
| 874 | struct lttng_payload_view action_path_view = |
| 875 | lttng_payload_view_from_view(view, used_size, -1); |
| 876 | |
| 877 | if (!lttng_payload_view_is_valid(&action_path_view)) { |
| 878 | used_size = -1; |
| 879 | goto end; |
| 880 | } |
| 881 | |
| 882 | action_path_used_size = lttng_action_path_create_from_payload( |
| 883 | &action_path_view, &action_path); |
| 884 | if (action_path_used_size < 0) { |
| 885 | used_size = -1; |
| 886 | goto end; |
| 887 | } |
| 888 | |
| 889 | used_size += action_path_used_size; |
| 890 | } |
| 891 | |
| 892 | *query = lttng_error_query_action_create(trigger, action_path); |
| 893 | lttng_action_path_destroy(action_path); |
| 894 | if (!*query) { |
| 895 | used_size = -1; |
| 896 | goto end; |
| 897 | } |
| 898 | |
| 899 | break; |
| 900 | } |
| 901 | default: |
| 902 | used_size = -1; |
| 903 | goto end; |
| 904 | } |
| 905 | |
| 906 | end: |
| 907 | lttng_trigger_put(trigger); |
| 908 | return used_size; |
| 909 | } |
| 910 | |
| 911 | enum lttng_error_query_results_status |
| 912 | lttng_error_query_results_get_count(const struct lttng_error_query_results *results, |
| 913 | unsigned int *count) |
| 914 | { |
| 915 | enum lttng_error_query_results_status status; |
| 916 | |
| 917 | if (!results || !count) { |
| 918 | status = LTTNG_ERROR_QUERY_RESULTS_STATUS_INVALID_PARAMETER; |
| 919 | goto end; |
| 920 | } |
| 921 | |
| 922 | *count = lttng_dynamic_pointer_array_get_count(&results->results); |
| 923 | status = LTTNG_ERROR_QUERY_RESULTS_STATUS_OK; |
| 924 | end: |
| 925 | return status; |
| 926 | } |
| 927 | |
| 928 | enum lttng_error_query_results_status |
| 929 | lttng_error_query_results_get_result(const struct lttng_error_query_results *results, |
| 930 | const struct lttng_error_query_result **result, |
| 931 | unsigned int index) |
| 932 | { |
| 933 | unsigned int result_count; |
| 934 | enum lttng_error_query_results_status status; |
| 935 | |
| 936 | if (!results || !result) { |
| 937 | status = LTTNG_ERROR_QUERY_RESULTS_STATUS_INVALID_PARAMETER; |
| 938 | goto end; |
| 939 | } |
| 940 | |
| 941 | status = lttng_error_query_results_get_count(results, &result_count); |
| 942 | if (status != LTTNG_ERROR_QUERY_RESULTS_STATUS_OK) { |
| 943 | goto end; |
| 944 | } |
| 945 | |
| 946 | if (index >= result_count) { |
| 947 | status = LTTNG_ERROR_QUERY_RESULTS_STATUS_INVALID_PARAMETER; |
| 948 | goto end; |
| 949 | } |
| 950 | |
| 951 | *result = |
| 952 | (typeof(*result)) lttng_dynamic_pointer_array_get_pointer(&results->results, index); |
| 953 | LTTNG_ASSERT(*result); |
| 954 | status = LTTNG_ERROR_QUERY_RESULTS_STATUS_OK; |
| 955 | end: |
| 956 | return status; |
| 957 | } |
| 958 | |
| 959 | void lttng_error_query_results_destroy(struct lttng_error_query_results *results) |
| 960 | { |
| 961 | if (!results) { |
| 962 | return; |
| 963 | } |
| 964 | |
| 965 | lttng_dynamic_pointer_array_reset(&results->results); |
| 966 | free(results); |
| 967 | } |
| 968 | |
| 969 | enum lttng_error_query_result_type |
| 970 | lttng_error_query_result_get_type(const struct lttng_error_query_result *result) |
| 971 | { |
| 972 | return result ? result->type : LTTNG_ERROR_QUERY_RESULT_TYPE_UNKNOWN; |
| 973 | } |
| 974 | |
| 975 | enum lttng_error_query_result_status |
| 976 | lttng_error_query_result_get_name(const struct lttng_error_query_result *result, const char **name) |
| 977 | { |
| 978 | enum lttng_error_query_result_status status; |
| 979 | |
| 980 | if (!result || !name) { |
| 981 | status = LTTNG_ERROR_QUERY_RESULT_STATUS_INVALID_PARAMETER; |
| 982 | goto end; |
| 983 | } |
| 984 | |
| 985 | *name = result->name; |
| 986 | status = LTTNG_ERROR_QUERY_RESULT_STATUS_OK; |
| 987 | end: |
| 988 | return status; |
| 989 | } |
| 990 | |
| 991 | enum lttng_error_query_result_status |
| 992 | lttng_error_query_result_get_description(const struct lttng_error_query_result *result, |
| 993 | const char **description) |
| 994 | { |
| 995 | enum lttng_error_query_result_status status; |
| 996 | |
| 997 | if (!result || !description) { |
| 998 | status = LTTNG_ERROR_QUERY_RESULT_STATUS_INVALID_PARAMETER; |
| 999 | goto end; |
| 1000 | } |
| 1001 | |
| 1002 | *description = result->description; |
| 1003 | status = LTTNG_ERROR_QUERY_RESULT_STATUS_OK; |
| 1004 | end: |
| 1005 | return status; |
| 1006 | } |
| 1007 | |
| 1008 | enum lttng_error_query_result_status |
| 1009 | lttng_error_query_result_counter_get_value(const struct lttng_error_query_result *result, |
| 1010 | uint64_t *value) |
| 1011 | { |
| 1012 | enum lttng_error_query_result_status status; |
| 1013 | const struct lttng_error_query_result_counter *counter_result; |
| 1014 | |
| 1015 | if (!result || !value || result->type != LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER) { |
| 1016 | status = LTTNG_ERROR_QUERY_RESULT_STATUS_INVALID_PARAMETER; |
| 1017 | goto end; |
| 1018 | } |
| 1019 | |
| 1020 | counter_result = |
| 1021 | lttng::utils::container_of(result, <tng_error_query_result_counter::parent); |
| 1022 | |
| 1023 | *value = counter_result->value; |
| 1024 | status = LTTNG_ERROR_QUERY_RESULT_STATUS_OK; |
| 1025 | end: |
| 1026 | return status; |
| 1027 | } |
| 1028 | |
| 1029 | static enum lttng_error_code |
| 1030 | lttng_error_query_result_counter_mi_serialize(const struct lttng_error_query_result *result, |
| 1031 | struct mi_writer *writer) |
| 1032 | { |
| 1033 | int ret; |
| 1034 | enum lttng_error_code ret_code; |
| 1035 | enum lttng_error_query_result_status status; |
| 1036 | uint64_t value; |
| 1037 | |
| 1038 | LTTNG_ASSERT(result); |
| 1039 | LTTNG_ASSERT(writer); |
| 1040 | |
| 1041 | status = lttng_error_query_result_counter_get_value(result, &value); |
| 1042 | LTTNG_ASSERT(status == LTTNG_ERROR_QUERY_RESULT_STATUS_OK); |
| 1043 | |
| 1044 | /* Open error query result counter element. */ |
| 1045 | ret = mi_lttng_writer_open_element(writer, mi_lttng_element_error_query_result_counter); |
| 1046 | if (ret) { |
| 1047 | goto mi_error; |
| 1048 | } |
| 1049 | |
| 1050 | /* Value. */ |
| 1051 | ret = mi_lttng_writer_write_element_unsigned_int( |
| 1052 | writer, mi_lttng_element_error_query_result_counter_value, value); |
| 1053 | if (ret) { |
| 1054 | goto mi_error; |
| 1055 | } |
| 1056 | |
| 1057 | /* Close error query result counter element. */ |
| 1058 | ret = mi_lttng_writer_close_element(writer); |
| 1059 | if (ret) { |
| 1060 | goto mi_error; |
| 1061 | } |
| 1062 | |
| 1063 | ret_code = LTTNG_OK; |
| 1064 | goto end; |
| 1065 | |
| 1066 | mi_error: |
| 1067 | ret_code = LTTNG_ERR_MI_IO_FAIL; |
| 1068 | end: |
| 1069 | return ret_code; |
| 1070 | } |
| 1071 | |
| 1072 | static enum lttng_error_code |
| 1073 | lttng_error_query_result_mi_serialize(const struct lttng_error_query_result *result, |
| 1074 | struct mi_writer *writer) |
| 1075 | { |
| 1076 | int ret; |
| 1077 | enum lttng_error_code ret_code; |
| 1078 | enum lttng_error_query_result_status result_status; |
| 1079 | enum lttng_error_query_result_type type; |
| 1080 | const char *name = nullptr; |
| 1081 | const char *description = nullptr; |
| 1082 | |
| 1083 | LTTNG_ASSERT(result); |
| 1084 | LTTNG_ASSERT(writer); |
| 1085 | |
| 1086 | type = lttng_error_query_result_get_type(result); |
| 1087 | |
| 1088 | result_status = lttng_error_query_result_get_name(result, &name); |
| 1089 | LTTNG_ASSERT(result_status == LTTNG_ERROR_QUERY_RESULT_STATUS_OK); |
| 1090 | |
| 1091 | result_status = lttng_error_query_result_get_description(result, &description); |
| 1092 | LTTNG_ASSERT(result_status == LTTNG_ERROR_QUERY_RESULT_STATUS_OK); |
| 1093 | |
| 1094 | /* Open error query result element. */ |
| 1095 | ret = mi_lttng_writer_open_element(writer, mi_lttng_element_error_query_result); |
| 1096 | if (ret) { |
| 1097 | goto mi_error; |
| 1098 | } |
| 1099 | |
| 1100 | /* Name. */ |
| 1101 | ret = mi_lttng_writer_write_element_string( |
| 1102 | writer, mi_lttng_element_error_query_result_name, name); |
| 1103 | if (ret) { |
| 1104 | goto mi_error; |
| 1105 | } |
| 1106 | |
| 1107 | /* Description. */ |
| 1108 | ret = mi_lttng_writer_write_element_string( |
| 1109 | writer, mi_lttng_element_error_query_result_description, description); |
| 1110 | if (ret) { |
| 1111 | goto mi_error; |
| 1112 | } |
| 1113 | |
| 1114 | /* Serialize the result according to its sub type. */ |
| 1115 | switch (type) { |
| 1116 | case LTTNG_ERROR_QUERY_RESULT_TYPE_COUNTER: |
| 1117 | ret_code = lttng_error_query_result_counter_mi_serialize(result, writer); |
| 1118 | break; |
| 1119 | default: |
| 1120 | abort(); |
| 1121 | } |
| 1122 | |
| 1123 | if (ret_code != LTTNG_OK) { |
| 1124 | goto end; |
| 1125 | } |
| 1126 | |
| 1127 | /* Close error query result element. */ |
| 1128 | ret = mi_lttng_writer_close_element(writer); |
| 1129 | if (ret) { |
| 1130 | goto mi_error; |
| 1131 | } |
| 1132 | |
| 1133 | ret_code = LTTNG_OK; |
| 1134 | goto end; |
| 1135 | |
| 1136 | mi_error: |
| 1137 | ret_code = LTTNG_ERR_MI_IO_FAIL; |
| 1138 | end: |
| 1139 | return ret_code; |
| 1140 | } |
| 1141 | |
| 1142 | enum lttng_error_code |
| 1143 | lttng_error_query_results_mi_serialize(const struct lttng_error_query_results *results, |
| 1144 | struct mi_writer *writer) |
| 1145 | { |
| 1146 | int ret; |
| 1147 | enum lttng_error_code ret_code; |
| 1148 | unsigned int i, count; |
| 1149 | enum lttng_error_query_results_status results_status; |
| 1150 | |
| 1151 | LTTNG_ASSERT(results); |
| 1152 | LTTNG_ASSERT(writer); |
| 1153 | |
| 1154 | /* Open error query results element. */ |
| 1155 | ret = mi_lttng_writer_open_element(writer, mi_lttng_element_error_query_results); |
| 1156 | if (ret) { |
| 1157 | goto mi_error; |
| 1158 | } |
| 1159 | |
| 1160 | results_status = lttng_error_query_results_get_count(results, &count); |
| 1161 | LTTNG_ASSERT(results_status == LTTNG_ERROR_QUERY_RESULTS_STATUS_OK); |
| 1162 | |
| 1163 | for (i = 0; i < count; i++) { |
| 1164 | const struct lttng_error_query_result *result; |
| 1165 | |
| 1166 | results_status = lttng_error_query_results_get_result(results, &result, i); |
| 1167 | LTTNG_ASSERT(results_status == LTTNG_ERROR_QUERY_RESULTS_STATUS_OK); |
| 1168 | |
| 1169 | /* A single error query result. */ |
| 1170 | ret_code = lttng_error_query_result_mi_serialize(result, writer); |
| 1171 | if (ret_code != LTTNG_OK) { |
| 1172 | goto end; |
| 1173 | } |
| 1174 | } |
| 1175 | |
| 1176 | /* Close error query results. */ |
| 1177 | ret = mi_lttng_writer_close_element(writer); |
| 1178 | if (ret) { |
| 1179 | goto mi_error; |
| 1180 | } |
| 1181 | |
| 1182 | ret_code = LTTNG_OK; |
| 1183 | goto end; |
| 1184 | |
| 1185 | mi_error: |
| 1186 | ret_code = LTTNG_ERR_MI_IO_FAIL; |
| 1187 | end: |
| 1188 | return ret_code; |
| 1189 | } |