formats/ctf/events.c

   1 /*
   2  * ctf/events.c
   3  *
   4  * Babeltrace Library
   5  *
   6  * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
   7  *
   8  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   9  *         Julien Desfossez <julien.desfossez@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  */
  21
  22 #include <babeltrace/babeltrace.h>
  23 #include <babeltrace/format.h>
  24 #include <babeltrace/ctf/events.h>
  25 #include <babeltrace/ctf-ir/metadata.h>
  26 #include <babeltrace/prio_heap.h>
  27 #include <babeltrace/iterator-internal.h>
  28 #include <babeltrace/ctf/events-internal.h>
  29 #include <babeltrace/ctf/metadata.h>
  30 #include <glib.h>
  31
  32 #include "events-private.h"
  33
  34 /*
  35  * thread local storage to store the last error that occured
  36  * while reading a field, this variable must be accessed by
  37  * bt_ctf_field_get_error only
  38  */
  39 __thread int bt_ctf_last_field_error = 0;
  40
  41 const struct definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
  42                 enum bt_ctf_scope scope)
  43 {
  44         struct definition *tmp = NULL;
  45         struct ctf_event_definition *event;
  46
  47         if (!ctf_event)
  48                 return NULL;
  49
  50         event = ctf_event->parent;
  51         switch (scope) {
  52         case BT_TRACE_PACKET_HEADER:
  53                 if (!event->stream)
  54                         goto error;
  55                 if (event->stream->trace_packet_header)
  56                         tmp = &event->stream->trace_packet_header->p;
  57                 break;
  58         case BT_STREAM_PACKET_CONTEXT:
  59                 if (!event->stream)
  60                         goto error;
  61                 if (event->stream->stream_packet_context)
  62                         tmp = &event->stream->stream_packet_context->p;
  63                 break;
  64         case BT_STREAM_EVENT_HEADER:
  65                 if (!event->stream)
  66                         goto error;
  67                 if (event->stream->stream_event_header)
  68                         tmp = &event->stream->stream_event_header->p;
  69                 break;
  70         case BT_STREAM_EVENT_CONTEXT:
  71                 if (!event->stream)
  72                         goto error;
  73                 if (event->stream->stream_event_context)
  74                         tmp = &event->stream->stream_event_context->p;
  75                 break;
  76         case BT_EVENT_CONTEXT:
  77                 if (event->event_context)
  78                         tmp = &event->event_context->p;
  79                 break;
  80         case BT_EVENT_FIELDS:
  81                 if (event->event_fields)
  82                         tmp = &event->event_fields->p;
  83                 break;
  84         }
  85         return tmp;
  86
  87 error:
  88         return NULL;
  89 }
  90
  91 const struct definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
  92                 const struct definition *scope,
  93                 const char *field)
  94 {
  95         struct definition *def;
  96         char *field_underscore;
  97
  98         if (!ctf_event || !scope || !field)
  99                 return NULL;
 100
 101         def = lookup_definition(scope, field);
 102         /*
 103          * optionally a field can have an underscore prefix, try
 104          * to lookup the field with this prefix if it failed
 105          */
 106         if (!def) {
 107                 field_underscore = g_new(char, strlen(field) + 2);
 108                 field_underscore[0] = '_';
 109                 strcpy(&field_underscore[1], field);
 110                 def = lookup_definition(scope, field_underscore);
 111                 g_free(field_underscore);
 112         }
 113         if (bt_ctf_field_type(def) == CTF_TYPE_VARIANT) {
 114                 struct definition_variant *variant_definition;
 115                 variant_definition = container_of(def,
 116                                 struct definition_variant, p);
 117                 return variant_definition->current_field;
 118         }
 119         return def;
 120 }
 121
 122 const struct definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
 123                 const struct definition *field,
 124                 unsigned int index)
 125 {
 126         struct definition *ret = NULL;
 127
 128         if (!ctf_event || !field)
 129                 return NULL;
 130
 131         if (bt_ctf_field_type(field) == CTF_TYPE_ARRAY) {
 132                 struct definition_array *array_definition;
 133                 array_definition = container_of(field,
 134                                 struct definition_array, p);
 135                 ret = array_index(array_definition, index);
 136         } else if (bt_ctf_field_type(field) == CTF_TYPE_SEQUENCE) {
 137                 struct definition_sequence *sequence_definition;
 138                 sequence_definition = container_of(field,
 139                                 struct definition_sequence, p);
 140                 ret = sequence_index(sequence_definition, index);
 141         }
 142         return ret;
 143 }
 144
 145 const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event)
 146 {
 147         struct ctf_event_declaration *event_class;
 148         struct ctf_stream_declaration *stream_class;
 149         struct ctf_event_definition *event;
 150
 151         if (!ctf_event)
 152                 return NULL;
 153
 154         event = ctf_event->parent;
 155         stream_class = event->stream->stream_class;
 156         event_class = g_ptr_array_index(stream_class->events_by_id,
 157                         event->stream->event_id);
 158         return g_quark_to_string(event_class->name);
 159 }
 160
 161 const char *bt_ctf_field_name(const struct definition *def)
 162 {
 163         if (!def)
 164                 return NULL;
 165
 166         return rem_(g_quark_to_string(def->name));
 167 }
 168
 169 enum ctf_type_id bt_ctf_field_type(const struct definition *def)
 170 {
 171         if (!def)
 172                 return CTF_TYPE_UNKNOWN;
 173
 174         return def->declaration->id;
 175 }
 176
 177 int bt_ctf_get_field_list(const struct bt_ctf_event *ctf_event,
 178                 const struct definition *scope,
 179                 struct definition const * const **list,
 180                 unsigned int *count)
 181 {
 182         if (!ctf_event || !scope || !list || !count)
 183                 return -EINVAL;
 184
 185         switch (bt_ctf_field_type(scope)) {
 186         case CTF_TYPE_INTEGER:
 187         case CTF_TYPE_FLOAT:
 188         case CTF_TYPE_STRING:
 189         case CTF_TYPE_ENUM:
 190                 goto error;
 191         case CTF_TYPE_STRUCT:
 192         {
 193                 const struct definition_struct *def_struct;
 194
 195                 def_struct = container_of(scope, const struct definition_struct, p);
 196                 if (!def_struct)
 197                         goto error;
 198                 if (def_struct->fields->pdata) {
 199                         *list = (struct definition const* const*) def_struct->fields->pdata;
 200                         *count = def_struct->fields->len;
 201                         goto end;
 202                 } else {
 203                         goto error;
 204                 }
 205                 break;
 206         }
 207         case CTF_TYPE_UNTAGGED_VARIANT:
 208                 goto error;
 209         case CTF_TYPE_VARIANT:
 210         {
 211                 const struct definition_variant *def_variant;
 212
 213                 def_variant = container_of(scope, const struct definition_variant, p);
 214                 if (!def_variant)
 215                         goto error;
 216                 if (def_variant->fields->pdata) {
 217                         *list = (struct definition const* const*) def_variant->fields->pdata;
 218                         *count = def_variant->fields->len;
 219                         goto end;
 220                 } else {
 221                         goto error;
 222                 }
 223                 break;
 224         }
 225         case CTF_TYPE_ARRAY:
 226         {
 227                 const struct definition_array *def_array;
 228
 229                 def_array = container_of(scope, const struct definition_array, p);
 230                 if (!def_array)
 231                         goto error;
 232                 if (def_array->elems->pdata) {
 233                         *list = (struct definition const* const*) def_array->elems->pdata;
 234                         *count = def_array->elems->len;
 235                         goto end;
 236                 } else {
 237                         goto error;
 238                 }
 239                 break;
 240         }
 241         case CTF_TYPE_SEQUENCE:
 242         {
 243                 const struct definition_sequence *def_sequence;
 244
 245                 def_sequence = container_of(scope, const struct definition_sequence, p);
 246                 if (!def_sequence)
 247                         goto error;
 248                 if (def_sequence->elems->pdata) {
 249                         *list = (struct definition const* const*) def_sequence->elems->pdata;
 250                         *count = def_sequence->elems->len;
 251                         goto end;
 252                 } else {
 253                         goto error;
 254                 }
 255                 break;
 256         }
 257         default:
 258                 break;
 259         }
 260
 261 end:
 262         return 0;
 263
 264 error:
 265         *list = NULL;
 266         *count = 0;
 267         return -1;
 268 }
 269
 270 struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *ctf_event)
 271 {
 272         struct bt_context *ret = NULL;
 273         struct ctf_file_stream *cfs;
 274         struct ctf_trace *trace;
 275         struct ctf_event_definition *event;
 276
 277         if (!ctf_event)
 278                 return NULL;
 279
 280         event = ctf_event->parent;
 281         cfs = container_of(event->stream, struct ctf_file_stream,
 282                         parent);
 283         trace = cfs->parent.stream_class->trace;
 284         if (trace->ctx)
 285                 ret = trace->ctx;
 286
 287         return ret;
 288 }
 289
 290 int bt_ctf_event_get_handle_id(const struct bt_ctf_event *ctf_event)
 291 {
 292         int ret = -1;
 293         struct ctf_file_stream *cfs;
 294         struct ctf_trace *trace;
 295         struct ctf_event_definition *event;
 296
 297         if (!ctf_event)
 298                 return -EINVAL;
 299
 300         event = ctf_event->parent;
 301         cfs = container_of(event->stream, struct ctf_file_stream,
 302                         parent);
 303         trace = cfs->parent.stream_class->trace;
 304         if (trace->handle)
 305                 ret = trace->handle->id;
 306
 307         return ret;
 308 }
 309
 310 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event)
 311 {
 312         struct ctf_event_definition *event;
 313
 314         if (!ctf_event)
 315                 return -1ULL;
 316
 317         event = ctf_event->parent;
 318         if (event && event->stream->has_timestamp)
 319                 return event->stream->real_timestamp;
 320         else
 321                 return -1ULL;
 322 }
 323
 324 uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event)
 325 {
 326         struct ctf_event_definition *event;
 327
 328         if (!ctf_event)
 329                 return -1ULL;
 330
 331         event = ctf_event->parent;
 332         if (event && event->stream->has_timestamp)
 333                 return event->stream->cycles_timestamp;
 334         else
 335                 return -1ULL;
 336 }
 337
 338 static void bt_ctf_field_set_error(int error)
 339 {
 340         bt_ctf_last_field_error = error;
 341 }
 342
 343 int bt_ctf_field_get_error(void)
 344 {
 345         int ret;
 346         ret = bt_ctf_last_field_error;
 347         bt_ctf_last_field_error = 0;
 348
 349         return ret;
 350 }
 351
 352 int bt_ctf_get_int_signedness(const struct definition *field)
 353 {
 354         int ret;
 355
 356         if (field && bt_ctf_field_type(field) == CTF_TYPE_INTEGER) {
 357                 ret = get_int_signedness(field);
 358         } else {
 359                 ret = -EINVAL;
 360                 bt_ctf_field_set_error(-EINVAL);
 361         }
 362
 363         return ret;
 364 }
 365
 366 int bt_ctf_get_int_base(const struct definition *field)
 367 {
 368         int ret;
 369
 370         if (field && bt_ctf_field_type(field) == CTF_TYPE_INTEGER) {
 371                 ret = get_int_base(field);
 372         } else {
 373                 ret = -EINVAL;
 374                 bt_ctf_field_set_error(-EINVAL);
 375         }
 376
 377         return ret;
 378 }
 379
 380 int bt_ctf_get_int_byte_order(const struct definition *field)
 381 {
 382         int ret;
 383
 384         if (field && bt_ctf_field_type(field) == CTF_TYPE_INTEGER) {
 385                 ret = get_int_byte_order(field);
 386         } else {
 387                 ret = -EINVAL;
 388                 bt_ctf_field_set_error(-EINVAL);
 389         }
 390
 391         return ret;
 392 }
 393
 394 ssize_t bt_ctf_get_int_len(const struct definition *field)
 395 {
 396         ssize_t ret;
 397
 398         if (field && bt_ctf_field_type(field) == CTF_TYPE_INTEGER) {
 399                 ret = (ssize_t) get_int_len(field);
 400         } else {
 401                 ret = -EINVAL;
 402                 bt_ctf_field_set_error(-EINVAL);
 403         }
 404
 405         return ret;
 406 }
 407
 408 const struct definition *bt_ctf_get_enum_int(const struct definition *field)
 409 {
 410         struct definition_enum *def_enum;
 411
 412         if (!field || bt_ctf_field_type(field) != CTF_TYPE_ENUM) {
 413                 bt_ctf_field_set_error(-EINVAL);
 414                 return NULL;
 415         }
 416         def_enum = container_of(field, struct definition_enum, p);
 417         return &def_enum->integer->p;
 418 }
 419
 420 const char *bt_ctf_get_enum_str(const struct definition *field)
 421 {
 422         struct definition_enum *def_enum;
 423         struct declaration_enum *decl_enum;
 424         GArray *array;
 425         const char *ret;
 426
 427         if (!field || bt_ctf_field_type(field) != CTF_TYPE_ENUM) {
 428                 bt_ctf_field_set_error(-EINVAL);
 429                 return NULL;
 430         }
 431         def_enum = container_of(field, struct definition_enum, p);
 432         decl_enum = def_enum->declaration;
 433         if (get_int_signedness(&def_enum->integer->p)) {
 434                 array = enum_int_to_quark_set(decl_enum,
 435                         get_signed_int(&def_enum->integer->p));
 436         } else {
 437                 array = enum_uint_to_quark_set(decl_enum,
 438                         get_unsigned_int(&def_enum->integer->p));
 439         }
 440         if (!array) {
 441                 bt_ctf_field_set_error(-ENOENT);
 442                 return NULL;
 443         }
 444
 445         if (array->len == 0) {
 446                 g_array_unref(array);
 447                 bt_ctf_field_set_error(-ENOENT);
 448                 return NULL;
 449         }
 450         /* Return first string. Arbitrary choice. */
 451         ret = g_quark_to_string(g_array_index(array, GQuark, 0));
 452         g_array_unref(array);
 453         return ret;
 454 }
 455
 456 enum ctf_string_encoding bt_ctf_get_encoding(const struct definition *field)
 457 {
 458         enum ctf_string_encoding ret = 0;
 459
 460         if (!field)
 461                 goto error;
 462
 463         if (bt_ctf_field_type(field) == CTF_TYPE_INTEGER)
 464                 ret = get_int_encoding(field);
 465         else if (bt_ctf_field_type(field) == CTF_TYPE_STRING)
 466                 ret = get_string_encoding(field);
 467         else
 468                 goto error;
 469         return ret;
 470
 471 error:
 472         bt_ctf_field_set_error(-EINVAL);
 473         return -1;
 474 }
 475
 476 int bt_ctf_get_array_len(const struct definition *field)
 477 {
 478         int ret;
 479
 480         if (field && bt_ctf_field_type(field) == CTF_TYPE_ARRAY) {
 481                 ret = get_array_len(field);
 482         } else {
 483                 ret = -1;
 484                 bt_ctf_field_set_error(-EINVAL);
 485         }
 486
 487         return ret;
 488 }
 489
 490 uint64_t bt_ctf_get_uint64(const struct definition *field)
 491 {
 492         uint64_t ret = 0;
 493
 494         if (field && bt_ctf_field_type(field) == CTF_TYPE_INTEGER)
 495                 ret = get_unsigned_int(field);
 496         else
 497                 bt_ctf_field_set_error(-EINVAL);
 498
 499         return ret;
 500 }
 501
 502 int64_t bt_ctf_get_int64(const struct definition *field)
 503 {
 504         int64_t ret = 0;
 505
 506         if (field && bt_ctf_field_type(field) == CTF_TYPE_INTEGER)
 507                 ret = get_signed_int(field);
 508         else
 509                 bt_ctf_field_set_error(-EINVAL);
 510
 511         return ret;
 512
 513 }
 514
 515 char *bt_ctf_get_char_array(const struct definition *field)
 516 {
 517         char *ret = NULL;
 518
 519         if (field && bt_ctf_field_type(field) == CTF_TYPE_ARRAY)
 520                 ret = get_char_array(field)->str;
 521         else
 522                 bt_ctf_field_set_error(-EINVAL);
 523
 524         return ret;
 525 }
 526
 527 char *bt_ctf_get_string(const struct definition *field)
 528 {
 529         char *ret = NULL;
 530
 531         if (field && bt_ctf_field_type(field) == CTF_TYPE_STRING)
 532                 ret = get_string(field);
 533         else
 534                 bt_ctf_field_set_error(-EINVAL);
 535
 536         return ret;
 537 }
 538
 539 int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx,
 540                 struct bt_ctf_event_decl * const **list,
 541                 unsigned int *count)
 542 {
 543         struct bt_trace_handle *handle;
 544         struct trace_descriptor *td;
 545         struct ctf_trace *tin;
 546
 547         if (!ctx || !list || !count)
 548                 goto error;
 549
 550         handle = g_hash_table_lookup(ctx->trace_handles,
 551                         (gpointer) (unsigned long) handle_id);
 552         if (!handle)
 553                 goto error;
 554
 555         td = handle->td;
 556         tin = container_of(td, struct ctf_trace, parent);
 557
 558         *list = (struct bt_ctf_event_decl * const*) tin->event_declarations->pdata;
 559         *count = tin->event_declarations->len;
 560         return 0;
 561
 562 error:
 563         return -1;
 564 }
 565
 566 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event)
 567 {
 568         if (!event)
 569                 return NULL;
 570
 571         return g_quark_to_string(event->parent.name);
 572 }
 573
 574 int bt_ctf_get_decl_fields(struct bt_ctf_event_decl *event_decl,
 575                 enum bt_ctf_scope scope,
 576                 struct bt_ctf_field_decl const * const **list,
 577                 unsigned int *count)
 578 {
 579         int i;
 580         GArray *fields = NULL;
 581         gpointer *ret_list = NULL;
 582         GPtrArray *fields_array = NULL;
 583         int ret = 0;
 584         *count = 0;
 585
 586         if (!event_decl || !list || !count)
 587                 return -EINVAL;
 588
 589         switch (scope) {
 590         case BT_EVENT_CONTEXT:
 591                 if (event_decl->context_decl) {
 592                         ret_list = event_decl->context_decl->pdata;
 593                         *count = event_decl->context_decl->len;
 594                         goto end;
 595                 }
 596                 event_decl->context_decl = g_ptr_array_new();
 597                 if (!event_decl->parent.context_decl) {
 598                         ret = -1;
 599                         goto end;
 600                 }
 601                 fields = event_decl->parent.context_decl->fields;
 602                 fields_array = event_decl->context_decl;
 603                 break;
 604         case BT_EVENT_FIELDS:
 605                 if (event_decl->fields_decl) {
 606                         ret_list = event_decl->fields_decl->pdata;
 607                         *count = event_decl->fields_decl->len;
 608                         goto end;
 609                 }
 610                 event_decl->fields_decl = g_ptr_array_new();
 611                 if (!event_decl->parent.fields_decl) {
 612                         ret = -1;
 613                         goto end;
 614                 }
 615                 fields = event_decl->parent.fields_decl->fields;
 616                 fields_array = event_decl->fields_decl;
 617                 break;
 618         case BT_STREAM_PACKET_CONTEXT:
 619                 if (event_decl->packet_context_decl) {
 620                         ret_list = event_decl->packet_context_decl->pdata;
 621                         *count = event_decl->packet_context_decl->len;
 622                         goto end;
 623                 }
 624                 event_decl->packet_context_decl = g_ptr_array_new();
 625                 if (!event_decl->parent.stream->packet_context_decl) {
 626                         ret = -1;
 627                         goto end;
 628                 }
 629                 fields = event_decl->parent.stream->packet_context_decl->fields;
 630                 fields_array = event_decl->packet_context_decl;
 631                 break;
 632         case BT_STREAM_EVENT_CONTEXT:
 633                 if (event_decl->event_context_decl) {
 634                         ret_list = event_decl->event_context_decl->pdata;
 635                         *count = event_decl->event_context_decl->len;
 636                         goto end;
 637                 }
 638                 event_decl->event_context_decl = g_ptr_array_new();
 639                 if (!event_decl->parent.stream->event_context_decl) {
 640                         ret = -1;
 641                         goto end;
 642                 }
 643                 fields = event_decl->parent.stream->event_context_decl->fields;
 644                 fields_array = event_decl->event_context_decl;
 645                 break;
 646         case BT_STREAM_EVENT_HEADER:
 647                 if (event_decl->event_header_decl) {
 648                         ret_list = event_decl->event_header_decl->pdata;
 649                         *count = event_decl->event_header_decl->len;
 650                         goto end;
 651                 }
 652                 event_decl->event_header_decl = g_ptr_array_new();
 653                 if (!event_decl->parent.stream->event_header_decl) {
 654                         ret = -1;
 655                         goto end;
 656                 }
 657                 fields = event_decl->parent.stream->event_header_decl->fields;
 658                 fields_array = event_decl->event_header_decl;
 659                 break;
 660         case BT_TRACE_PACKET_HEADER:
 661                 if (event_decl->packet_header_decl) {
 662                         ret_list = event_decl->packet_header_decl->pdata;
 663                         *count = event_decl->packet_header_decl->len;
 664                         goto end;
 665                 }
 666                 event_decl->packet_header_decl = g_ptr_array_new();
 667                 if (!event_decl->parent.stream->trace->packet_header_decl) {
 668                         ret = -1;
 669                         goto end;
 670                 }
 671                 fields = event_decl->parent.stream->trace->packet_header_decl->fields;
 672                 fields_array = event_decl->packet_header_decl;
 673                 break;
 674         }
 675
 676         for (i = 0; i < fields->len; i++) {
 677                 g_ptr_array_add(fields_array,
 678                                 &g_array_index(fields,
 679                                         struct declaration_field, i));
 680         }
 681         ret_list = fields_array->pdata;
 682         *count = fields->len;
 683
 684 end:
 685         *list = (struct bt_ctf_field_decl const* const*) ret_list;
 686
 687         return ret;
 688 }
 689
 690 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field)
 691 {
 692         if (!field)
 693                 return NULL;
 694
 695         return rem_(g_quark_to_string(((struct declaration_field *) field)->name));
 696 }