plugins/debug-info/plugin.c

   1 /*
   2  * plugin.c
   3  *
   4  * Babeltrace Debug Info Plug-in
   5  *
   6  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/graph/notification-iterator.h>
  30 #include <babeltrace/graph/private-notification-iterator.h>
  31 #include <babeltrace/graph/notification.h>
  32 #include <babeltrace/graph/notification-event.h>
  33 #include <babeltrace/graph/notification-stream.h>
  34 #include <babeltrace/graph/notification-packet.h>
  35 #include <babeltrace/graph/component-filter.h>
  36 #include <babeltrace/graph/private-component-filter.h>
  37 #include <babeltrace/graph/private-port.h>
  38 #include <babeltrace/graph/private-connection.h>
  39 #include <babeltrace/graph/private-component.h>
  40 #include <babeltrace/plugin/plugin-dev.h>
  41 #include <plugins-common.h>
  42 #include <assert.h>
  43 #include "debug-info.h"
  44 #include "copy.h"
  45
  46 static
  47 void destroy_debug_info_data(struct debug_info_component *debug_info)
  48 {
  49         free(debug_info->arg_debug_info_field_name);
  50         g_free(debug_info);
  51 }
  52
  53 static
  54 void destroy_debug_info_component(struct bt_private_component *component)
  55 {
  56         void *data = bt_private_component_get_user_data(component);
  57         destroy_debug_info_data(data);
  58 }
  59
  60 static
  61 struct debug_info_component *create_debug_info_component_data(void)
  62 {
  63         struct debug_info_component *debug_info;
  64
  65         debug_info = g_new0(struct debug_info_component, 1);
  66         if (!debug_info) {
  67                 goto end;
  68         }
  69         debug_info->err = stderr;
  70
  71 end:
  72         return debug_info;
  73 }
  74
  75 static
  76 void unref_debug_info(struct debug_info *debug_info)
  77 {
  78         debug_info_destroy(debug_info);
  79 }
  80
  81 static
  82 void unref_trace(struct bt_ctf_trace *trace)
  83 {
  84         bt_put(trace);
  85 }
  86
  87 static
  88 void unref_stream(struct bt_ctf_stream *stream)
  89 {
  90         bt_put(stream);
  91 }
  92
  93 static
  94 void unref_packet(struct bt_ctf_packet *packet)
  95 {
  96         bt_put(packet);
  97 }
  98
  99 static
 100 void unref_stream_class(struct bt_ctf_stream_class *stream_class)
 101 {
 102         bt_put(stream_class);
 103 }
 104
 105 static
 106 void debug_info_iterator_destroy(struct bt_private_notification_iterator *it)
 107 {
 108         struct debug_info_iterator *it_data;
 109
 110         it_data = bt_private_notification_iterator_get_user_data(it);
 111         assert(it_data);
 112
 113         if (it_data->input_iterator_group) {
 114                 g_ptr_array_free(it_data->input_iterator_group, TRUE);
 115         }
 116         bt_put(it_data->current_notification);
 117         bt_put(it_data->input_iterator);
 118         g_hash_table_destroy(it_data->trace_map);
 119         g_hash_table_destroy(it_data->stream_map);
 120         g_hash_table_destroy(it_data->stream_class_map);
 121         g_hash_table_destroy(it_data->packet_map);
 122         g_hash_table_destroy(it_data->trace_debug_map);
 123         g_free(it_data);
 124 }
 125
 126 static
 127 struct bt_notification *handle_notification(FILE *err,
 128                 struct debug_info_iterator *debug_it,
 129                 struct bt_notification *notification)
 130 {
 131         struct bt_notification *new_notification = NULL;
 132
 133         switch (bt_notification_get_type(notification)) {
 134         case BT_NOTIFICATION_TYPE_PACKET_BEGIN:
 135         {
 136                 struct bt_ctf_packet *packet =
 137                         bt_notification_packet_begin_get_packet(notification);
 138                 struct bt_ctf_packet *writer_packet;
 139
 140                 if (!packet) {
 141                         goto end;
 142                 }
 143
 144                 writer_packet = debug_info_new_packet(debug_it, packet);
 145                 assert(writer_packet);
 146                 new_notification = bt_notification_packet_begin_create(
 147                                 writer_packet);
 148                 assert(new_notification);
 149                 bt_put(packet);
 150                 break;
 151         }
 152         case BT_NOTIFICATION_TYPE_PACKET_END:
 153         {
 154                 struct bt_ctf_packet *packet =
 155                         bt_notification_packet_end_get_packet(notification);
 156                 struct bt_ctf_packet *writer_packet;
 157
 158                 if (!packet) {
 159                         goto end;
 160                 }
 161
 162                 writer_packet = debug_info_close_packet(debug_it, packet);
 163                 assert(writer_packet);
 164                 new_notification = bt_notification_packet_end_create(
 165                                 writer_packet);
 166                 assert(new_notification);
 167                 bt_put(packet);
 168                 bt_put(writer_packet);
 169                 break;
 170         }
 171         case BT_NOTIFICATION_TYPE_EVENT:
 172         {
 173                 struct bt_ctf_event *event = bt_notification_event_get_event(
 174                                 notification);
 175                 struct bt_ctf_event *writer_event;
 176                 struct bt_clock_class_priority_map *cc_prio_map =
 177                         bt_notification_event_get_clock_class_priority_map(
 178                                         notification);
 179
 180                 if (!event) {
 181                         goto end;
 182                 }
 183                 writer_event = debug_info_output_event(debug_it, event);
 184                 assert(writer_event);
 185                 new_notification = bt_notification_event_create(writer_event,
 186                                 cc_prio_map);
 187                 bt_put(cc_prio_map);
 188                 assert(new_notification);
 189                 bt_put(event);
 190                 bt_put(writer_event);
 191                 break;
 192         }
 193         case BT_NOTIFICATION_TYPE_STREAM_END:
 194         {
 195                 struct bt_ctf_stream *stream =
 196                         bt_notification_stream_end_get_stream(notification);
 197                 struct bt_ctf_stream *writer_stream;
 198
 199                 if (!stream) {
 200                         goto end;
 201                 }
 202
 203                 writer_stream = debug_info_stream_end(debug_it, stream);
 204                 assert(writer_stream);
 205                 new_notification = bt_notification_stream_end_create(
 206                                 writer_stream);
 207                 assert(new_notification);
 208                 bt_put(stream);
 209                 bt_put(writer_stream);
 210                 break;
 211         }
 212         default:
 213                 puts("Unhandled notification type");
 214         }
 215
 216 end:
 217         return new_notification;
 218 }
 219
 220 static
 221 struct bt_notification_iterator_next_return debug_info_iterator_next(
 222                 struct bt_private_notification_iterator *iterator)
 223 {
 224         struct debug_info_iterator *debug_it = NULL;
 225         struct bt_private_component *component = NULL;
 226         struct debug_info_component *debug_info = NULL;
 227         struct bt_notification_iterator *source_it = NULL;
 228         struct bt_notification *notification;
 229         struct bt_notification_iterator_next_return ret = {
 230                 .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
 231                 .notification = NULL,
 232         };
 233
 234         debug_it = bt_private_notification_iterator_get_user_data(iterator);
 235         assert(debug_it);
 236
 237         component = bt_private_notification_iterator_get_private_component(iterator);
 238         assert(component);
 239         debug_info = bt_private_component_get_user_data(component);
 240         assert(debug_info);
 241
 242         source_it = debug_it->input_iterator;
 243
 244         ret.status = bt_notification_iterator_next(source_it);
 245         if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 246                 goto end;
 247         }
 248
 249         notification = bt_notification_iterator_get_notification(
 250                         source_it);
 251         if (!notification) {
 252                 ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 253                 goto end;
 254         }
 255
 256         ret.notification = handle_notification(debug_info->err, debug_it,
 257                         notification);
 258         assert(ret.notification);
 259         bt_put(notification);
 260
 261 end:
 262         bt_put(component);
 263         return ret;
 264 }
 265
 266 /*
 267 static
 268 struct bt_notification *debug_info_iterator_get(
 269                 struct bt_private_notification_iterator *iterator)
 270 {
 271         struct debug_info_iterator *debug_it;
 272
 273         debug_it = bt_private_notification_iterator_get_user_data(iterator);
 274         assert(debug_it);
 275
 276         if (!debug_it->current_notification) {
 277                 enum bt_notification_iterator_status it_ret;
 278
 279                 it_ret = debug_info_iterator_next(iterator);
 280                 if (it_ret) {
 281                         goto end;
 282                 }
 283         }
 284
 285 end:
 286         return bt_get(debug_it->current_notification);
 287 }
 288 */
 289
 290 static
 291 enum bt_notification_iterator_status debug_info_iterator_seek_time(
 292                 struct bt_private_notification_iterator *iterator, int64_t time)
 293 {
 294         enum bt_notification_iterator_status ret;
 295
 296         ret = BT_NOTIFICATION_ITERATOR_STATUS_OK;
 297
 298         return ret;
 299 }
 300
 301 static
 302 enum bt_notification_iterator_status debug_info_iterator_init(
 303                 struct bt_private_notification_iterator *iterator,
 304                 struct bt_private_port *port)
 305 {
 306         enum bt_notification_iterator_status ret =
 307                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 308         enum bt_notification_iterator_status it_ret;
 309         struct bt_private_port *input_port = NULL;
 310         struct bt_private_connection *connection = NULL;
 311         struct bt_private_component *component =
 312                 bt_private_notification_iterator_get_private_component(iterator);
 313         struct debug_info_iterator *it_data = g_new0(struct debug_info_iterator, 1);
 314
 315         if (!it_data) {
 316                 ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 317                 goto end;
 318         }
 319
 320         /* Create a new iterator on the upstream component. */
 321         input_port = bt_private_component_filter_get_input_private_port_by_name(
 322                 component, "in");
 323         assert(input_port);
 324         connection = bt_private_port_get_private_connection(input_port);
 325         assert(connection);
 326
 327         it_data->input_iterator = bt_private_connection_create_notification_iterator(
 328                         connection);
 329         if (!it_data->input_iterator) {
 330                 ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 331                 goto end;
 332         }
 333         it_data->debug_info_component = (struct debug_info_component *)
 334                 bt_private_component_get_user_data(component);
 335
 336         it_data->err = it_data->debug_info_component->err;
 337         it_data->trace_map = g_hash_table_new_full(g_direct_hash,
 338                         g_direct_equal, NULL, (GDestroyNotify) unref_trace);
 339         it_data->stream_map = g_hash_table_new_full(g_direct_hash,
 340                         g_direct_equal, NULL, (GDestroyNotify) unref_stream);
 341         it_data->stream_class_map = g_hash_table_new_full(g_direct_hash,
 342                         g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
 343         it_data->packet_map = g_hash_table_new_full(g_direct_hash,
 344                         g_direct_equal, NULL, (GDestroyNotify) unref_packet);
 345         it_data->trace_debug_map = g_hash_table_new_full(g_direct_hash,
 346                         g_direct_equal, NULL, (GDestroyNotify) unref_debug_info);
 347
 348         it_ret = bt_private_notification_iterator_set_user_data(iterator, it_data);
 349         if (it_ret) {
 350                 goto end;
 351         }
 352
 353 end:
 354         bt_put(connection);
 355         bt_put(input_port);
 356         return ret;
 357 }
 358
 359 static
 360 enum bt_component_status init_from_params(
 361                 struct debug_info_component *debug_info_component,
 362                 struct bt_value *params)
 363 {
 364         struct bt_value *value = NULL;
 365         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 366
 367         assert(params);
 368
 369         value = bt_value_map_get(params, "debug-info-field-name");
 370         if (value) {
 371                 enum bt_value_status value_ret;
 372                 const char *tmp;
 373
 374                 value_ret = bt_value_string_get(value, &tmp);
 375                 if (value_ret) {
 376                         ret = BT_COMPONENT_STATUS_INVALID;
 377                         printf_error("Failed to retrieve debug-info-field-name value. "
 378                                         "Expecting a string");
 379                 }
 380                 strcpy(debug_info_component->arg_debug_info_field_name, tmp);
 381                 bt_put(value);
 382         } else {
 383                 debug_info_component->arg_debug_info_field_name =
 384                         malloc(strlen("debug_info") + 1);
 385                 if (!debug_info_component->arg_debug_info_field_name) {
 386                         ret = BT_COMPONENT_STATUS_NOMEM;
 387                         printf_error();
 388                 }
 389                 sprintf(debug_info_component->arg_debug_info_field_name,
 390                                 "debug_info");
 391         }
 392         if (ret != BT_COMPONENT_STATUS_OK) {
 393                 goto end;
 394         }
 395
 396         value = bt_value_map_get(params, "debug-dir");
 397         if (value) {
 398                 enum bt_value_status value_ret;
 399
 400                 value_ret = bt_value_string_get(value,
 401                                 &debug_info_component->arg_debug_dir);
 402                 if (value_ret) {
 403                         ret = BT_COMPONENT_STATUS_INVALID;
 404                         printf_error("Failed to retrieve debug-dir value. "
 405                                         "Expecting a string");
 406                 }
 407         }
 408         bt_put(value);
 409         if (ret != BT_COMPONENT_STATUS_OK) {
 410                 goto end;
 411         }
 412
 413         value = bt_value_map_get(params, "target-prefix");
 414         if (value) {
 415                 enum bt_value_status value_ret;
 416
 417                 value_ret = bt_value_string_get(value,
 418                                 &debug_info_component->arg_target_prefix);
 419                 if (value_ret) {
 420                         ret = BT_COMPONENT_STATUS_INVALID;
 421                         printf_error("Failed to retrieve target-prefix value. "
 422                                         "Expecting a string");
 423                 }
 424         }
 425         bt_put(value);
 426         if (ret != BT_COMPONENT_STATUS_OK) {
 427                 goto end;
 428         }
 429
 430         value = bt_value_map_get(params, "full-path");
 431         if (value) {
 432                 enum bt_value_status value_ret;
 433
 434                 value_ret = bt_value_bool_get(value,
 435                                 &debug_info_component->arg_full_path);
 436                 if (value_ret) {
 437                         ret = BT_COMPONENT_STATUS_INVALID;
 438                         printf_error("Failed to retrieve full-path value. "
 439                                         "Expecting a boolean");
 440                 }
 441         }
 442         bt_put(value);
 443         if (ret != BT_COMPONENT_STATUS_OK) {
 444                 goto end;
 445         }
 446
 447 end:
 448         return ret;
 449 }
 450
 451 enum bt_component_status debug_info_component_init(
 452         struct bt_private_component *component, struct bt_value *params,
 453         UNUSED_VAR void *init_method_data)
 454 {
 455         enum bt_component_status ret;
 456         struct debug_info_component *debug_info = create_debug_info_component_data();
 457
 458         if (!debug_info) {
 459                 ret = BT_COMPONENT_STATUS_NOMEM;
 460                 goto end;
 461         }
 462
 463         ret = bt_private_component_set_user_data(component, debug_info);
 464         if (ret != BT_COMPONENT_STATUS_OK) {
 465                 goto error;
 466         }
 467
 468         ret = init_from_params(debug_info, params);
 469 end:
 470         return ret;
 471 error:
 472         destroy_debug_info_data(debug_info);
 473         return ret;
 474 }
 475
 476 /* Initialize plug-in entry points. */
 477 BT_PLUGIN(debug_info);
 478 BT_PLUGIN_DESCRIPTION("Babeltrace Debug Informations Plug-In.");
 479 BT_PLUGIN_AUTHOR("Jérémie Galarneau");
 480 BT_PLUGIN_LICENSE("MIT");
 481
 482 BT_PLUGIN_FILTER_COMPONENT_CLASS(debug_info, debug_info_iterator_next);
 483 BT_PLUGIN_FILTER_COMPONENT_CLASS_DESCRIPTION(debug_info,
 484         "Add the debug information to events if possible.");
 485 BT_PLUGIN_FILTER_COMPONENT_CLASS_INIT_METHOD(debug_info, debug_info_component_init);
 486 BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD(debug_info, destroy_debug_info_component);
 487 BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_INIT_METHOD(debug_info,
 488         debug_info_iterator_init);
 489 BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_FINALIZE_METHOD(debug_info,
 490         debug_info_iterator_destroy);
 491 BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_SEEK_TIME_METHOD(debug_info,
 492         debug_info_iterator_seek_time);