src/plugins/text/details/details.c

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
   5  */
   6
   7 #define BT_COMP_LOG_SELF_COMP (details_comp->self_comp)
   8 #define BT_LOG_OUTPUT_LEVEL (details_comp->log_level)
   9 #define BT_LOG_TAG "PLUGIN/SINK.TEXT.DETAILS"
  10 #include "logging/comp-logging.h"
  11
  12 #include <stdbool.h>
  13
  14 #include <babeltrace2/babeltrace.h>
  15
  16 #include "common/common.h"
  17 #include "common/assert.h"
  18 #include "details.h"
  19 #include "write.h"
  20 #include "plugins/common/param-validation/param-validation.h"
  21
  22 #define IN_PORT_NAME "in"
  23 #define COLOR_PARAM_NAME "color"
  24 #define WITH_METADATA_PARAM_NAME "with-metadata"
  25 #define WITH_DATA_PARAM_NAME "with-data"
  26 #define WITH_TIME_PARAM_NAME "with-time"
  27 #define WITH_TRACE_NAME_PARAM_NAME "with-trace-name"
  28 #define WITH_STREAM_CLASS_NAME_PARAM_NAME "with-stream-class-name"
  29 #define WITH_STREAM_NAME_PARAM_NAME "with-stream-name"
  30 #define WITH_UUID_PARAM_NAME "with-uuid"
  31 #define COMPACT_PARAM_NAME "compact"
  32
  33 void details_destroy_details_trace_class_meta(
  34                 struct details_trace_class_meta *details_tc_meta)
  35 {
  36         if (!details_tc_meta) {
  37                 goto end;
  38         }
  39
  40         if (details_tc_meta->objects) {
  41                 g_hash_table_destroy(details_tc_meta->objects);
  42                 details_tc_meta->objects = NULL;
  43         }
  44
  45         g_free(details_tc_meta);
  46
  47 end:
  48         return;
  49 }
  50
  51 struct details_trace_class_meta *details_create_details_trace_class_meta(void)
  52 {
  53         struct details_trace_class_meta *details_tc_meta =
  54                 g_new0(struct details_trace_class_meta, 1);
  55
  56         if (!details_tc_meta) {
  57                 goto end;
  58         }
  59
  60         details_tc_meta->objects = g_hash_table_new(
  61                 g_direct_hash, g_direct_equal);
  62         if (!details_tc_meta->objects) {
  63                 details_destroy_details_trace_class_meta(details_tc_meta);
  64                 details_tc_meta = NULL;
  65                 goto end;
  66         }
  67
  68         details_tc_meta->tc_destruction_listener_id = UINT64_C(-1);
  69
  70 end:
  71         return details_tc_meta;
  72 }
  73
  74 static
  75 void destroy_details_comp(struct details_comp *details_comp)
  76 {
  77         GHashTableIter iter;
  78         gpointer key, value;
  79
  80         if (!details_comp) {
  81                 goto end;
  82         }
  83
  84         if (details_comp->meta) {
  85                 /*
  86                  * Remove trace class destruction listeners, because
  87                  * otherwise, when they are called, `details_comp`
  88                  * (their user data) won't exist anymore (we're
  89                  * destroying it here).
  90                  */
  91                 g_hash_table_iter_init(&iter, details_comp->meta);
  92
  93                 while (g_hash_table_iter_next(&iter, &key, &value)) {
  94                         struct details_trace_class_meta *details_tc_meta =
  95                                 value;
  96
  97                         if (details_tc_meta->tc_destruction_listener_id !=
  98                                         UINT64_C(-1)) {
  99                                 if (bt_trace_class_remove_destruction_listener(
 100                                                 (const void *) key,
 101                                                 details_tc_meta->tc_destruction_listener_id)) {
 102                                         bt_current_thread_clear_error();
 103                                 }
 104                         }
 105                 }
 106
 107                 g_hash_table_destroy(details_comp->meta);
 108                 details_comp->meta = NULL;
 109         }
 110
 111         if (details_comp->traces) {
 112                 /*
 113                  * Remove trace destruction listeners, because
 114                  * otherwise, when they are called, `details_comp` won't
 115                  * exist anymore (we're destroying it here).
 116                  */
 117                 g_hash_table_iter_init(&iter, details_comp->traces);
 118
 119                 while (g_hash_table_iter_next(&iter, &key, &value)) {
 120                         struct details_trace *details_trace = value;
 121
 122                         if (bt_trace_remove_destruction_listener(
 123                                         (const void *) key,
 124                                         details_trace->trace_destruction_listener_id)) {
 125                                 bt_current_thread_clear_error();
 126                         }
 127                 }
 128
 129                 g_hash_table_destroy(details_comp->traces);
 130                 details_comp->traces = NULL;
 131         }
 132
 133         if (details_comp->str) {
 134                 g_string_free(details_comp->str, TRUE);
 135                 details_comp->str = NULL;
 136         }
 137
 138         BT_MESSAGE_ITERATOR_PUT_REF_AND_RESET(
 139                 details_comp->msg_iter);
 140         g_free(details_comp);
 141
 142 end:
 143         return;
 144 }
 145
 146 static
 147 struct details_comp *create_details_comp(
 148                 bt_self_component_sink *self_comp_sink)
 149 {
 150         struct details_comp *details_comp = g_new0(struct details_comp, 1);
 151         bt_self_component *self_comp =
 152                 bt_self_component_sink_as_self_component(self_comp_sink);
 153
 154         if (!details_comp) {
 155                 goto error;
 156         }
 157
 158         details_comp->log_level = bt_component_get_logging_level(
 159                 bt_self_component_as_component(self_comp));
 160         details_comp->self_comp = self_comp;
 161         details_comp->meta = g_hash_table_new_full(g_direct_hash,
 162                 g_direct_equal, NULL,
 163                 (GDestroyNotify) details_destroy_details_trace_class_meta);
 164         if (!details_comp->meta) {
 165                 goto error;
 166         }
 167
 168         details_comp->traces = g_hash_table_new_full(g_direct_hash,
 169                 g_direct_equal, NULL, g_free);
 170         if (!details_comp->traces) {
 171                 goto error;
 172         }
 173
 174         details_comp->str = g_string_new(NULL);
 175         if (!details_comp->str) {
 176                 goto error;
 177         }
 178
 179         goto end;
 180
 181 error:
 182         destroy_details_comp(details_comp);
 183         details_comp = NULL;
 184
 185 end:
 186         return details_comp;
 187 }
 188
 189 void details_finalize(bt_self_component_sink *comp)
 190 {
 191         struct details_comp *details_comp;
 192
 193         BT_ASSERT(comp);
 194         details_comp = bt_self_component_get_data(
 195                 bt_self_component_sink_as_self_component(comp));
 196         BT_ASSERT(details_comp);
 197         destroy_details_comp(details_comp);
 198 }
 199
 200 static
 201 void configure_bool_opt(struct details_comp *details_comp,
 202                 const bt_value *params, const char *param_name,
 203                 bool default_value, bool *opt_value)
 204 {
 205         const bt_value *value;
 206
 207         *opt_value = default_value;
 208         value = bt_value_map_borrow_entry_value_const(params, param_name);
 209         if (value) {
 210                 *opt_value = (bool) bt_value_bool_get(value);
 211         }
 212 }
 213
 214 static const char *color_choices[] = { "never", "auto", "always", NULL };
 215
 216 static const struct bt_param_validation_map_value_entry_descr details_params[] = {
 217         { COLOR_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = {
 218                 .choices = color_choices,
 219         } } },
 220         { WITH_METADATA_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 221         { WITH_DATA_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 222         { COMPACT_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 223         { WITH_TIME_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 224         { WITH_TRACE_NAME_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 225         { WITH_STREAM_CLASS_NAME_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 226         { WITH_STREAM_NAME_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 227         { WITH_UUID_PARAM_NAME, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { .type = BT_VALUE_TYPE_BOOL } },
 228         BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
 229 };
 230
 231 static
 232 bt_component_class_initialize_method_status configure_details_comp(
 233                 struct details_comp *details_comp,
 234                 const bt_value *params)
 235 {
 236         bt_component_class_initialize_method_status status;
 237         const bt_value *value;
 238         const char *str;
 239         enum bt_param_validation_status validation_status;
 240         gchar *validate_error = NULL;
 241
 242         validation_status = bt_param_validation_validate(params,
 243                 details_params, &validate_error);
 244         if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
 245                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
 246                 goto end;
 247         } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
 248                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
 249                 BT_COMP_LOGE_APPEND_CAUSE(details_comp->self_comp,
 250                         "%s", validate_error);
 251                 goto end;
 252         }
 253
 254         /* Colorize output? */
 255         details_comp->cfg.with_color = bt_common_colors_supported();
 256         value = bt_value_map_borrow_entry_value_const(params, COLOR_PARAM_NAME);
 257         if (value) {
 258                 str = bt_value_string_get(value);
 259
 260                 if (strcmp(str, "never") == 0) {
 261                         details_comp->cfg.with_color = false;
 262                 } else if (strcmp(str, "auto") == 0) {
 263                         details_comp->cfg.with_color =
 264                                 bt_common_colors_supported();
 265                 } else {
 266                         BT_ASSERT(strcmp(str, "always") == 0);
 267
 268                         details_comp->cfg.with_color = true;
 269                 }
 270         }
 271
 272         /* With metadata objects? */
 273         configure_bool_opt(details_comp, params, WITH_METADATA_PARAM_NAME,
 274                 true, &details_comp->cfg.with_meta);
 275
 276         /* With data objects? */
 277         configure_bool_opt(details_comp, params, WITH_DATA_PARAM_NAME,
 278                 true, &details_comp->cfg.with_data);
 279
 280         /* Compact? */
 281         configure_bool_opt(details_comp, params, COMPACT_PARAM_NAME,
 282                 false, &details_comp->cfg.compact);
 283
 284         /* With time? */
 285         configure_bool_opt(details_comp, params, WITH_TIME_PARAM_NAME,
 286                 true, &details_comp->cfg.with_time);
 287
 288         /* With trace name? */
 289         configure_bool_opt(details_comp, params,
 290                 WITH_TRACE_NAME_PARAM_NAME,
 291                 true, &details_comp->cfg.with_trace_name);
 292
 293         /* With stream class name? */
 294         configure_bool_opt(details_comp, params,
 295                 WITH_STREAM_CLASS_NAME_PARAM_NAME,
 296                 true, &details_comp->cfg.with_stream_class_name);
 297
 298         /* With stream name? */
 299         configure_bool_opt(details_comp, params,
 300                 WITH_STREAM_NAME_PARAM_NAME,
 301                 true, &details_comp->cfg.with_stream_name);
 302
 303         /* With UUID? */
 304         configure_bool_opt(details_comp, params,
 305                 WITH_UUID_PARAM_NAME, true, &details_comp->cfg.with_uuid);
 306
 307         status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
 308         goto end;
 309
 310 end:
 311         g_free(validate_error);
 312
 313         return status;
 314 }
 315
 316 static
 317 void log_configuration(bt_self_component_sink *comp,
 318                 struct details_comp *details_comp)
 319 {
 320         BT_COMP_LOGI("Configuration for `sink.text.details` component `%s`:",
 321                 bt_component_get_name(bt_self_component_as_component(
 322                         bt_self_component_sink_as_self_component(comp))));
 323         BT_COMP_LOGI("  Colorize output: %d", details_comp->cfg.with_color);
 324         BT_COMP_LOGI("  Compact: %d", details_comp->cfg.compact);
 325         BT_COMP_LOGI("  With metadata: %d", details_comp->cfg.with_meta);
 326         BT_COMP_LOGI("  With time: %d", details_comp->cfg.with_time);
 327         BT_COMP_LOGI("  With trace name: %d", details_comp->cfg.with_trace_name);
 328         BT_COMP_LOGI("  With stream class name: %d",
 329                 details_comp->cfg.with_stream_class_name);
 330         BT_COMP_LOGI("  With stream name: %d", details_comp->cfg.with_stream_name);
 331         BT_COMP_LOGI("  With UUID: %d", details_comp->cfg.with_uuid);
 332 }
 333
 334 bt_component_class_initialize_method_status details_init(
 335                 bt_self_component_sink *comp,
 336                 bt_self_component_sink_configuration *config,
 337                 const bt_value *params,
 338                 __attribute__((unused)) void *init_method_data)
 339 {
 340         bt_component_class_initialize_method_status status;
 341         bt_self_component_add_port_status add_port_status;
 342         struct details_comp *details_comp;
 343         bt_self_component *self_comp =
 344                 bt_self_component_sink_as_self_component(comp);
 345         bt_logging_level log_level =
 346                 bt_component_get_logging_level(
 347                         bt_self_component_as_component(self_comp));
 348
 349         details_comp = create_details_comp(comp);
 350         if (!details_comp) {
 351                 /*
 352                  * Don't use BT_COMP_LOGE_APPEND_CAUSE, as `details_comp` is not
 353                  * initialized yet.
 354                  */
 355                 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR, log_level, self_comp,
 356                                 "Failed to allocate component.");
 357                 BT_CURRENT_THREAD_ERROR_APPEND_CAUSE_FROM_COMPONENT(
 358                         self_comp, "Failed to allocate component.");
 359                 status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
 360                 goto error;
 361         }
 362
 363         add_port_status = bt_self_component_sink_add_input_port(comp,
 364                 IN_PORT_NAME, NULL, NULL);
 365         if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
 366                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to add input port.");
 367                 status = (int) add_port_status;
 368                 goto error;
 369         }
 370
 371         status = configure_details_comp(details_comp, params);
 372         if (status != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
 373                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to configure component.");
 374                 goto error;
 375         }
 376
 377         log_configuration(comp, details_comp);
 378         bt_self_component_set_data(
 379                 bt_self_component_sink_as_self_component(comp), details_comp);
 380         goto end;
 381
 382 error:
 383         destroy_details_comp(details_comp);
 384
 385 end:
 386         return status;
 387 }
 388
 389 bt_component_class_sink_graph_is_configured_method_status
 390 details_graph_is_configured(bt_self_component_sink *comp)
 391 {
 392         bt_component_class_sink_graph_is_configured_method_status status;
 393         bt_message_iterator_create_from_sink_component_status
 394                 msg_iter_status;
 395         bt_message_iterator *iterator;
 396         bt_self_component_port_input *in_port;
 397         bt_self_component *self_comp =
 398                 bt_self_component_sink_as_self_component(comp);
 399         struct details_comp *details_comp = bt_self_component_get_data(self_comp);
 400
 401         BT_ASSERT(details_comp);
 402
 403         in_port = bt_self_component_sink_borrow_input_port_by_name(comp,
 404                 IN_PORT_NAME);
 405         if (!bt_port_is_connected(bt_port_input_as_port_const(
 406                         bt_self_component_port_input_as_port_input(in_port)))) {
 407                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Single input port is not connected: "
 408                         "port-name=\"%s\"", IN_PORT_NAME);
 409                 status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_ERROR;
 410                 goto end;
 411         }
 412
 413         msg_iter_status = bt_message_iterator_create_from_sink_component(
 414                 comp, in_port, &iterator);
 415         if (msg_iter_status != BT_MESSAGE_ITERATOR_CREATE_FROM_SINK_COMPONENT_STATUS_OK) {
 416                 BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to create message iterator: "
 417                         "port-name=\"%s\"", IN_PORT_NAME);
 418                 status = (int) msg_iter_status;
 419                 goto end;
 420         }
 421
 422         BT_MESSAGE_ITERATOR_MOVE_REF(
 423                 details_comp->msg_iter, iterator);
 424
 425         status = BT_COMPONENT_CLASS_SINK_GRAPH_IS_CONFIGURED_METHOD_STATUS_OK;
 426
 427 end:
 428         return status;
 429 }
 430
 431 bt_component_class_sink_consume_method_status
 432 details_consume(bt_self_component_sink *comp)
 433 {
 434         bt_component_class_sink_consume_method_status status;
 435         bt_message_array_const msgs;
 436         uint64_t count;
 437         bt_message_iterator_next_status next_status;
 438         uint64_t i;
 439         bt_self_component *self_comp = bt_self_component_sink_as_self_component(comp);
 440         struct details_comp *details_comp = bt_self_component_get_data(self_comp);
 441
 442         BT_ASSERT_DBG(details_comp);
 443         BT_ASSERT_DBG(details_comp->msg_iter);
 444
 445         /* Consume messages */
 446         next_status = bt_message_iterator_next(
 447                 details_comp->msg_iter, &msgs, &count);
 448         if (next_status != BT_MESSAGE_ITERATOR_NEXT_STATUS_OK) {
 449                 status = (int) next_status;
 450                 goto end;
 451         }
 452
 453         for (i = 0; i < count; i++) {
 454                 int print_ret = details_write_message(details_comp,
 455                         msgs[i]);
 456
 457                 if (print_ret) {
 458                         for (; i < count; i++) {
 459                                 /* Put all remaining messages */
 460                                 bt_message_put_ref(msgs[i]);
 461                         }
 462
 463                         BT_COMP_LOGE_APPEND_CAUSE(self_comp, "Failed to write message.");
 464                         status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_ERROR;
 465                         goto end;
 466                 }
 467
 468                 /* Print output buffer to standard output and flush */
 469                 if (details_comp->str->len > 0) {
 470                         printf("%s", details_comp->str->str);
 471                         fflush(stdout);
 472                         details_comp->printed_something = true;
 473                 }
 474
 475                 /* Put this message */
 476                 bt_message_put_ref(msgs[i]);
 477         }
 478
 479         status = BT_COMPONENT_CLASS_SINK_CONSUME_METHOD_STATUS_OK;
 480
 481 end:
 482         return status;
 483 }