plugins/lttng-utils/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         case BT_NOTIFICATION_TYPE_INACTIVITY:
 213         {
 214                 new_notification = bt_get(notification);
 215                 break;
 216         }
 217         default:
 218                 puts("Unhandled notification type");
 219         }
 220
 221 end:
 222         return new_notification;
 223 }
 224
 225 static
 226 struct bt_notification_iterator_next_return debug_info_iterator_next(
 227                 struct bt_private_notification_iterator *iterator)
 228 {
 229         struct debug_info_iterator *debug_it = NULL;
 230         struct bt_private_component *component = NULL;
 231         struct debug_info_component *debug_info = NULL;
 232         struct bt_notification_iterator *source_it = NULL;
 233         struct bt_notification *notification;
 234         struct bt_notification_iterator_next_return ret = {
 235                 .status = BT_NOTIFICATION_ITERATOR_STATUS_OK,
 236                 .notification = NULL,
 237         };
 238
 239         debug_it = bt_private_notification_iterator_get_user_data(iterator);
 240         assert(debug_it);
 241
 242         component = bt_private_notification_iterator_get_private_component(iterator);
 243         assert(component);
 244         debug_info = bt_private_component_get_user_data(component);
 245         assert(debug_info);
 246
 247         source_it = debug_it->input_iterator;
 248
 249         ret.status = bt_notification_iterator_next(source_it);
 250         if (ret.status != BT_NOTIFICATION_ITERATOR_STATUS_OK) {
 251                 goto end;
 252         }
 253
 254         notification = bt_notification_iterator_get_notification(
 255                         source_it);
 256         if (!notification) {
 257                 ret.status = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 258                 goto end;
 259         }
 260
 261         ret.notification = handle_notification(debug_info->err, debug_it,
 262                         notification);
 263         assert(ret.notification);
 264         bt_put(notification);
 265
 266 end:
 267         bt_put(component);
 268         return ret;
 269 }
 270
 271 static
 272 enum bt_notification_iterator_status debug_info_iterator_init(
 273                 struct bt_private_notification_iterator *iterator,
 274                 struct bt_private_port *port)
 275 {
 276         enum bt_notification_iterator_status ret =
 277                 BT_NOTIFICATION_ITERATOR_STATUS_OK;
 278         enum bt_notification_iterator_status it_ret;
 279         struct bt_private_connection *connection = NULL;
 280         struct bt_private_component *component =
 281                 bt_private_notification_iterator_get_private_component(iterator);
 282         struct debug_info_iterator *it_data = g_new0(struct debug_info_iterator, 1);
 283         struct bt_private_port *input_port;
 284         static const enum bt_notification_type notif_types[] = {
 285                 BT_NOTIFICATION_TYPE_EVENT,
 286                 BT_NOTIFICATION_TYPE_STREAM_END,
 287                 BT_NOTIFICATION_TYPE_PACKET_BEGIN,
 288                 BT_NOTIFICATION_TYPE_PACKET_END,
 289                 BT_NOTIFICATION_TYPE_SENTINEL,
 290         };
 291
 292         if (!it_data) {
 293                 ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 294                 goto end;
 295         }
 296
 297         input_port = bt_private_component_filter_get_input_private_port_by_name(
 298                         component, "in");
 299         if (!input_port) {
 300                 ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 301                 goto end;
 302         }
 303
 304         connection = bt_private_port_get_private_connection(input_port);
 305         bt_put(input_port);
 306         if (!connection) {
 307                 ret = BT_NOTIFICATION_ITERATOR_STATUS_ERROR;
 308                 goto end;
 309         }
 310
 311         it_data->input_iterator = bt_private_connection_create_notification_iterator(
 312                         connection, notif_types);
 313         if (!it_data->input_iterator) {
 314                 ret = BT_NOTIFICATION_ITERATOR_STATUS_NOMEM;
 315                 goto end;
 316         }
 317
 318         it_data->debug_info_component = (struct debug_info_component *)
 319                 bt_private_component_get_user_data(component);
 320         it_data->err = it_data->debug_info_component->err;
 321         it_data->trace_map = g_hash_table_new_full(g_direct_hash,
 322                         g_direct_equal, NULL, (GDestroyNotify) unref_trace);
 323         it_data->stream_map = g_hash_table_new_full(g_direct_hash,
 324                         g_direct_equal, NULL, (GDestroyNotify) unref_stream);
 325         it_data->stream_class_map = g_hash_table_new_full(g_direct_hash,
 326                         g_direct_equal, NULL, (GDestroyNotify) unref_stream_class);
 327         it_data->packet_map = g_hash_table_new_full(g_direct_hash,
 328                         g_direct_equal, NULL, (GDestroyNotify) unref_packet);
 329         it_data->trace_debug_map = g_hash_table_new_full(g_direct_hash,
 330                         g_direct_equal, NULL, (GDestroyNotify) unref_debug_info);
 331
 332         it_ret = bt_private_notification_iterator_set_user_data(iterator, it_data);
 333         if (it_ret) {
 334                 goto end;
 335         }
 336
 337 end:
 338         bt_put(connection);
 339         bt_put(component);
 340         return ret;
 341 }
 342
 343 static
 344 enum bt_component_status init_from_params(
 345                 struct debug_info_component *debug_info_component,
 346                 struct bt_value *params)
 347 {
 348         struct bt_value *value = NULL;
 349         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 350
 351         assert(params);
 352
 353         value = bt_value_map_get(params, "debug-info-field-name");
 354         if (value) {
 355                 enum bt_value_status value_ret;
 356                 const char *tmp;
 357
 358                 value_ret = bt_value_string_get(value, &tmp);
 359                 if (value_ret) {
 360                         ret = BT_COMPONENT_STATUS_INVALID;
 361                         printf_error("Failed to retrieve debug-info-field-name value. "
 362                                         "Expecting a string");
 363                 }
 364                 strcpy(debug_info_component->arg_debug_info_field_name, tmp);
 365                 bt_put(value);
 366         } else {
 367                 debug_info_component->arg_debug_info_field_name =
 368                         malloc(strlen("debug_info") + 1);
 369                 if (!debug_info_component->arg_debug_info_field_name) {
 370                         ret = BT_COMPONENT_STATUS_NOMEM;
 371                         printf_error();
 372                 }
 373                 sprintf(debug_info_component->arg_debug_info_field_name,
 374                                 "debug_info");
 375         }
 376         if (ret != BT_COMPONENT_STATUS_OK) {
 377                 goto end;
 378         }
 379
 380         value = bt_value_map_get(params, "debug-dir");
 381         if (value) {
 382                 enum bt_value_status value_ret;
 383
 384                 value_ret = bt_value_string_get(value,
 385                                 &debug_info_component->arg_debug_dir);
 386                 if (value_ret) {
 387                         ret = BT_COMPONENT_STATUS_INVALID;
 388                         printf_error("Failed to retrieve debug-dir value. "
 389                                         "Expecting a string");
 390                 }
 391         }
 392         bt_put(value);
 393         if (ret != BT_COMPONENT_STATUS_OK) {
 394                 goto end;
 395         }
 396
 397         value = bt_value_map_get(params, "target-prefix");
 398         if (value) {
 399                 enum bt_value_status value_ret;
 400
 401                 value_ret = bt_value_string_get(value,
 402                                 &debug_info_component->arg_target_prefix);
 403                 if (value_ret) {
 404                         ret = BT_COMPONENT_STATUS_INVALID;
 405                         printf_error("Failed to retrieve target-prefix value. "
 406                                         "Expecting a string");
 407                 }
 408         }
 409         bt_put(value);
 410         if (ret != BT_COMPONENT_STATUS_OK) {
 411                 goto end;
 412         }
 413
 414         value = bt_value_map_get(params, "full-path");
 415         if (value) {
 416                 enum bt_value_status value_ret;
 417                 bt_bool bool_val;
 418
 419                 value_ret = bt_value_bool_get(value,
 420                                 &bool_val);
 421                 if (value_ret) {
 422                         ret = BT_COMPONENT_STATUS_INVALID;
 423                         printf_error("Failed to retrieve full-path value. "
 424                                         "Expecting a boolean");
 425                 }
 426
 427                 debug_info_component->arg_full_path = bool_val;
 428         }
 429         bt_put(value);
 430         if (ret != BT_COMPONENT_STATUS_OK) {
 431                 goto end;
 432         }
 433
 434 end:
 435         return ret;
 436 }
 437
 438 enum bt_component_status debug_info_component_init(
 439         struct bt_private_component *component, struct bt_value *params,
 440         UNUSED_VAR void *init_method_data)
 441 {
 442         enum bt_component_status ret;
 443         struct debug_info_component *debug_info = create_debug_info_component_data();
 444         struct bt_private_port *priv_port = NULL;
 445
 446         if (!debug_info) {
 447                 ret = BT_COMPONENT_STATUS_NOMEM;
 448                 goto end;
 449         }
 450
 451         ret = bt_private_component_set_user_data(component, debug_info);
 452         if (ret != BT_COMPONENT_STATUS_OK) {
 453                 goto error;
 454         }
 455
 456         priv_port = bt_private_component_filter_add_input_private_port(
 457                 component, "in", NULL);
 458         if (!priv_port) {
 459                 ret = BT_COMPONENT_STATUS_ERROR;
 460                 goto end;
 461         }
 462         BT_PUT(priv_port);
 463
 464         priv_port = bt_private_component_filter_add_output_private_port(
 465                 component, "out", NULL);
 466         if (!priv_port) {
 467                 ret = BT_COMPONENT_STATUS_ERROR;
 468                 goto end;
 469         }
 470         BT_PUT(priv_port);
 471
 472         ret = init_from_params(debug_info, params);
 473 end:
 474         return ret;
 475 error:
 476         destroy_debug_info_data(debug_info);
 477         return ret;
 478 }
 479
 480 /* Initialize plug-in entry points. */
 481 BT_PLUGIN_WITH_ID(lttng_utils, "lttng-utils");
 482 BT_PLUGIN_DESCRIPTION_WITH_ID(lttng_utils, "LTTng utilities");
 483 BT_PLUGIN_AUTHOR_WITH_ID(lttng_utils, "Julien Desfossez");
 484 BT_PLUGIN_LICENSE_WITH_ID(lttng_utils, "MIT");
 485
 486 BT_PLUGIN_FILTER_COMPONENT_CLASS_WITH_ID(lttng_utils, debug_info, "debug-info",
 487         debug_info_iterator_next);
 488 BT_PLUGIN_FILTER_COMPONENT_CLASS_DESCRIPTION_WITH_ID(lttng_utils, debug_info,
 489         "Augment compatible events with debugging information.");
 490 BT_PLUGIN_FILTER_COMPONENT_CLASS_INIT_METHOD_WITH_ID(lttng_utils,
 491         debug_info, debug_info_component_init);
 492 BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD_WITH_ID(lttng_utils,
 493         debug_info, destroy_debug_info_component);
 494 BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_INIT_METHOD_WITH_ID(
 495         lttng_utils, debug_info, debug_info_iterator_init);
 496 BT_PLUGIN_FILTER_COMPONENT_CLASS_NOTIFICATION_ITERATOR_FINALIZE_METHOD_WITH_ID(
 497         lttng_utils, debug_info, debug_info_iterator_destroy);