include/babeltrace/types.h

   1 #ifndef _BABELTRACE_TYPES_H
   2 #define _BABELTRACE_TYPES_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * Type Header
   8  *
   9  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
  10  *
  11  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  12  *
  13  * Permission is hereby granted, free of charge, to any person obtaining a copy
  14  * of this software and associated documentation files (the "Software"), to deal
  15  * in the Software without restriction, including without limitation the rights
  16  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  17  * copies of the Software, and to permit persons to whom the Software is
  18  * furnished to do so, subject to the following conditions:
  19  *
  20  * The above copyright notice and this permission notice shall be included in
  21  * all copies or substantial portions of the Software.
  22  */
  23
  24 #include <babeltrace/align.h>
  25 #include <babeltrace/list.h>
  26 #include <stdbool.h>
  27 #include <stdint.h>
  28 #include <limits.h>
  29 #include <string.h>
  30 #include <glib.h>
  31 #include <assert.h>
  32
  33 /* Preallocate this many fields for structures */
  34 #define DEFAULT_NR_STRUCT_FIELDS 8
  35
  36 struct ctf_stream;
  37 struct stream_pos;
  38 struct format;
  39 struct definition;
  40
  41 /* type scope */
  42 struct declaration_scope {
  43         /* Hash table mapping type name GQuark to "struct declaration" */
  44         /* Used for both typedef and typealias. */
  45         GHashTable *typedef_declarations;
  46         /* Hash table mapping struct name GQuark to "struct declaration_struct" */
  47         GHashTable *struct_declarations;
  48         /* Hash table mapping variant name GQuark to "struct declaration_variant" */
  49         GHashTable *variant_declarations;
  50         /* Hash table mapping enum name GQuark to "struct type_enum" */
  51         GHashTable *enum_declarations;
  52         struct declaration_scope *parent_scope;
  53 };
  54
  55 /* definition scope */
  56 struct definition_scope {
  57         /* Hash table mapping field name GQuark to "struct definition" */
  58         GHashTable *definitions;
  59         struct definition_scope *parent_scope;
  60         /*
  61          * Complete "path" leading to this definition scope.
  62          * Includes dynamic scope name '.' field name '.' field name '.' ....
  63          * Array of GQuark elements (which are each separated by dots).
  64          * The dynamic scope name can contain dots, and is encoded into
  65          * a single GQuark. Thus, scope_path[0] returns the GQuark
  66          * identifying the dynamic scope.
  67          */
  68         GArray *scope_path;     /* array of GQuark */
  69 };
  70
  71 enum ctf_type_id {
  72         CTF_TYPE_UNKNOWN = 0,
  73         CTF_TYPE_INTEGER,
  74         CTF_TYPE_FLOAT,
  75         CTF_TYPE_ENUM,
  76         CTF_TYPE_STRING,
  77         CTF_TYPE_STRUCT,
  78         CTF_TYPE_UNTAGGED_VARIANT,
  79         CTF_TYPE_VARIANT,
  80         CTF_TYPE_ARRAY,
  81         CTF_TYPE_SEQUENCE,
  82         NR_CTF_TYPES,
  83 };
  84
  85 struct declaration {
  86         enum ctf_type_id id;
  87         size_t alignment;       /* type alignment, in bits */
  88         int ref;                /* number of references to the type */
  89         /*
  90          * declaration_free called with declaration ref is decremented to 0.
  91          */
  92         void (*declaration_free)(struct declaration *declaration);
  93         struct definition *
  94                 (*definition_new)(struct declaration *declaration,
  95                                   struct definition_scope *parent_scope,
  96                                   GQuark field_name, int index,
  97                                   const char *root_name);
  98         /*
  99          * definition_free called with definition ref is decremented to 0.
 100          */
 101         void (*definition_free)(struct definition *definition);
 102 };
 103
 104 struct definition {
 105         struct declaration *declaration;
 106         int index;              /* Position of the definition in its container */
 107         GQuark name;            /* Field name in its container (or 0 if unset) */
 108         int ref;                /* number of references to the definition */
 109         GQuark path;
 110         struct definition_scope *scope;
 111 };
 112
 113 typedef int (*rw_dispatch)(struct stream_pos *pos,
 114                            struct definition *definition);
 115
 116 /* Parent of per-plugin positions */
 117 struct stream_pos {
 118         /* read/write dispatch table. Specific to plugin used for stream. */
 119         rw_dispatch *rw_table;  /* rw dispatch table */
 120         int (*event_cb)(struct stream_pos *pos,
 121                         struct ctf_stream *stream);
 122 };
 123
 124 static inline
 125 int generic_rw(struct stream_pos *pos, struct definition *definition)
 126 {
 127         enum ctf_type_id dispatch_id = definition->declaration->id;
 128         rw_dispatch call;
 129
 130         assert(pos->rw_table[dispatch_id] != NULL);
 131         call = pos->rw_table[dispatch_id];
 132         return call(pos, definition);
 133 }
 134
 135 enum ctf_string_encoding {
 136         CTF_STRING_NONE = 0,
 137         CTF_STRING_UTF8,
 138         CTF_STRING_ASCII,
 139         CTF_STRING_UNKNOWN,
 140 };
 141
 142 /*
 143  * Because we address in bits, bitfields end up being exactly the same as
 144  * integers, except that their read/write functions must be able to deal with
 145  * read/write non aligned on CHAR_BIT.
 146  */
 147 struct declaration_integer {
 148         struct declaration p;
 149         size_t len;             /* length, in bits. */
 150         int byte_order;         /* byte order */
 151         int signedness;
 152         int base;               /* Base for pretty-printing: 2, 8, 10, 16 */
 153         enum ctf_string_encoding encoding;
 154 };
 155
 156 struct definition_integer {
 157         struct definition p;
 158         struct declaration_integer *declaration;
 159         /* Last values read */
 160         union {
 161                 uint64_t _unsigned;
 162                 int64_t _signed;
 163         } value;
 164 };
 165
 166 struct declaration_float {
 167         struct declaration p;
 168         struct declaration_integer *sign;
 169         struct declaration_integer *mantissa;
 170         struct declaration_integer *exp;
 171         int byte_order;
 172         /* TODO: we might want to express more info about NaN, +inf and -inf */
 173 };
 174
 175 struct definition_float {
 176         struct definition p;
 177         struct declaration_float *declaration;
 178         struct definition_integer *sign;
 179         struct definition_integer *mantissa;
 180         struct definition_integer *exp;
 181         /* Last values read */
 182         long double value;
 183 };
 184
 185 /*
 186  * enum_val_equal assumes that signed and unsigned memory layout overlap.
 187  */
 188 struct enum_range {
 189         union {
 190                 int64_t _signed;
 191                 uint64_t _unsigned;
 192         } start;        /* lowest range value */
 193         union {
 194                 int64_t _signed;
 195                 uint64_t _unsigned;
 196         } end;          /* highest range value */
 197 };
 198
 199 struct enum_range_to_quark {
 200         struct cds_list_head node;
 201         struct enum_range range;
 202         GQuark quark;
 203 };
 204
 205 /*
 206  * We optimize the common case (range of size 1: single value) by creating a
 207  * hash table mapping values to quark sets. We then lookup the ranges to
 208  * complete the quark set.
 209  *
 210  * TODO: The proper structure to hold the range to quark set mapping would be an
 211  * interval tree, with O(n) size, O(n*log(n)) build time and O(log(n)) query
 212  * time. Using a simple O(n) list search for now for implementation speed and
 213  * given that we can expect to have a _relatively_ small number of enumeration
 214  * ranges. This might become untrue if we are fed with symbol tables often
 215  * required to lookup function names from instruction pointer value.
 216  */
 217 struct enum_table {
 218         GHashTable *value_to_quark_set;         /* (value, GQuark GArray) */
 219         struct cds_list_head range_to_quark;    /* (range, GQuark) */
 220         GHashTable *quark_to_range_set;         /* (GQuark, range GArray) */
 221 };
 222
 223 struct declaration_enum {
 224         struct declaration p;
 225         struct declaration_integer *integer_declaration;
 226         struct enum_table table;
 227 };
 228
 229 struct definition_enum {
 230         struct definition p;
 231         struct definition_integer *integer;
 232         struct declaration_enum *declaration;
 233         /* Last GQuark values read. Keeping a reference on the GQuark array. */
 234         GArray *value;
 235 };
 236
 237 struct declaration_string {
 238         struct declaration p;
 239         enum ctf_string_encoding encoding;
 240 };
 241
 242 struct definition_string {
 243         struct definition p;
 244         struct declaration_string *declaration;
 245         char *value;    /* freed at definition_string teardown */
 246         size_t len, alloc_len;
 247 };
 248
 249 struct declaration_field {
 250         GQuark name;
 251         struct declaration *declaration;
 252 };
 253
 254 struct declaration_struct {
 255         struct declaration p;
 256         GHashTable *fields_by_name;     /* Tuples (field name, field index) */
 257         struct declaration_scope *scope;
 258         GArray *fields;                 /* Array of declaration_field */
 259 };
 260
 261 struct definition_struct {
 262         struct definition p;
 263         struct declaration_struct *declaration;
 264         GPtrArray *fields;              /* Array of pointers to struct definition */
 265 };
 266
 267 struct declaration_untagged_variant {
 268         struct declaration p;
 269         GHashTable *fields_by_tag;      /* Tuples (field tag, field index) */
 270         struct declaration_scope *scope;
 271         GArray *fields;                 /* Array of declaration_field */
 272 };
 273
 274 struct declaration_variant {
 275         struct declaration p;
 276         struct declaration_untagged_variant *untagged_variant;
 277         GArray *tag_name;               /* Array of GQuark */
 278 };
 279
 280 /* A variant needs to be tagged to be defined. */
 281 struct definition_variant {
 282         struct definition p;
 283         struct declaration_variant *declaration;
 284         struct definition *enum_tag;
 285         GPtrArray *fields;              /* Array of pointers to struct definition */
 286         struct definition *current_field;       /* Last field read */
 287 };
 288
 289 struct declaration_array {
 290         struct declaration p;
 291         size_t len;
 292         struct declaration *elem;
 293         struct declaration_scope *scope;
 294 };
 295
 296 struct definition_array {
 297         struct definition p;
 298         struct declaration_array *declaration;
 299         GPtrArray *elems;               /* Array of pointers to struct definition */
 300         GString *string;                /* String for encoded integer children */
 301 };
 302
 303 struct declaration_sequence {
 304         struct declaration p;
 305         GArray *length_name;            /* Array of GQuark */
 306         struct declaration *elem;
 307         struct declaration_scope *scope;
 308 };
 309
 310 struct definition_sequence {
 311         struct definition p;
 312         struct declaration_sequence *declaration;
 313         struct definition_integer *length;
 314         GPtrArray *elems;               /* Array of pointers to struct definition */
 315         GString *string;                /* String for encoded integer children */
 316 };
 317
 318 int register_declaration(GQuark declaration_name,
 319                          struct declaration *declaration,
 320                          struct declaration_scope *scope);
 321 struct declaration *lookup_declaration(GQuark declaration_name,
 322                                 struct declaration_scope *scope);
 323
 324 /*
 325  * Type scopes also contain a separate registry for struct, variant and
 326  * enum types. Those register types rather than type definitions, so
 327  * that a named variant can be declared without specifying its target
 328  * "choice" tag field immediately.
 329  */
 330 int register_struct_declaration(GQuark struct_name,
 331                                 struct declaration_struct *struct_declaration,
 332                                 struct declaration_scope *scope);
 333 struct declaration_struct *
 334         lookup_struct_declaration(GQuark struct_name,
 335                                   struct declaration_scope *scope);
 336 int register_variant_declaration(GQuark variant_name,
 337                           struct declaration_untagged_variant *untagged_variant_declaration,
 338                           struct declaration_scope *scope);
 339 struct declaration_untagged_variant *lookup_variant_declaration(GQuark variant_name,
 340                                          struct declaration_scope *scope);
 341 int register_enum_declaration(GQuark enum_name,
 342                               struct declaration_enum *enum_declaration,
 343                               struct declaration_scope *scope);
 344 struct declaration_enum *
 345         lookup_enum_declaration(GQuark enum_name,
 346                                 struct declaration_scope *scope);
 347
 348 struct declaration_scope *
 349         new_declaration_scope(struct declaration_scope *parent_scope);
 350 void free_declaration_scope(struct declaration_scope *scope);
 351
 352 /*
 353  * field_definition is for field definitions. They are registered into
 354  * definition scopes.
 355  */
 356 struct definition *
 357         lookup_path_definition(GArray *cur_path,        /* array of GQuark */
 358                                GArray *lookup_path,     /* array of GQuark */
 359                                struct definition_scope *scope);
 360 int register_field_definition(GQuark field_name,
 361                               struct definition *definition,
 362                               struct definition_scope *scope);
 363 struct definition_scope *
 364         new_definition_scope(struct definition_scope *parent_scope,
 365                              GQuark field_name, const char *root_name);
 366 void free_definition_scope(struct definition_scope *scope);
 367
 368 GQuark new_definition_path(struct definition_scope *parent_scope,
 369                            GQuark field_name, const char *root_name);
 370
 371 static inline
 372 int compare_definition_path(struct definition *definition, GQuark path)
 373 {
 374         return definition->path == path;
 375 }
 376
 377 void declaration_ref(struct declaration *declaration);
 378 void declaration_unref(struct declaration *declaration);
 379
 380 void definition_ref(struct definition *definition);
 381 void definition_unref(struct definition *definition);
 382
 383 struct declaration_integer *integer_declaration_new(size_t len, int byte_order,
 384                                   int signedness, size_t alignment,
 385                                   int base, enum ctf_string_encoding encoding);
 386
 387 /*
 388  * mantissa_len is the length of the number of bytes represented by the mantissa
 389  * (e.g. result of DBL_MANT_DIG). It includes the leading 1.
 390  */
 391 struct declaration_float *float_declaration_new(size_t mantissa_len,
 392                                   size_t exp_len, int byte_order,
 393                                   size_t alignment);
 394
 395 /*
 396  * A GQuark can be translated to/from strings with g_quark_from_string() and
 397  * g_quark_to_string().
 398  */
 399
 400 /*
 401  * Returns a GArray of GQuark or NULL.
 402  * Caller must release the GArray with g_array_unref().
 403  */
 404 GArray *enum_uint_to_quark_set(const struct declaration_enum *enum_declaration,
 405                                uint64_t v);
 406
 407 /*
 408  * Returns a GArray of GQuark or NULL.
 409  * Caller must release the GArray with g_array_unref().
 410  */
 411 GArray *enum_int_to_quark_set(const struct declaration_enum *enum_declaration,
 412                               int64_t v);
 413
 414 /*
 415  * Returns a GArray of struct enum_range or NULL.
 416  * Callers do _not_ own the returned GArray (and therefore _don't_ need to
 417  * release it).
 418  */
 419 GArray *enum_quark_to_range_set(const struct declaration_enum *enum_declaration,
 420                                 GQuark q);
 421 void enum_signed_insert(struct declaration_enum *enum_declaration,
 422                         int64_t start, int64_t end, GQuark q);
 423 void enum_unsigned_insert(struct declaration_enum *enum_declaration,
 424                           uint64_t start, uint64_t end, GQuark q);
 425 size_t enum_get_nr_enumerators(struct declaration_enum *enum_declaration);
 426
 427 struct declaration_enum *
 428         enum_declaration_new(struct declaration_integer *integer_declaration);
 429
 430 struct declaration_string *
 431         string_declaration_new(enum ctf_string_encoding encoding);
 432
 433 struct declaration_struct *
 434         struct_declaration_new(struct declaration_scope *parent_scope,
 435                                uint64_t min_align);
 436 void struct_declaration_add_field(struct declaration_struct *struct_declaration,
 437                                   const char *field_name,
 438                                   struct declaration *field_declaration);
 439 /*
 440  * Returns the index of a field within a structure.
 441  */
 442 int struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
 443                                                     GQuark field_name);
 444 /*
 445  * field returned only valid as long as the field structure is not appended to.
 446  */
 447 struct declaration_field *
 448 struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
 449                                         int index);
 450 struct definition *
 451 struct_definition_get_field_from_index(struct definition_struct *struct_definition,
 452                                        int index);
 453 int struct_rw(struct stream_pos *pos, struct definition *definition);
 454 uint64_t struct_declaration_len(struct declaration_struct *struct_declaration);
 455
 456 /*
 457  * The tag enumeration is validated to ensure that it contains only mappings
 458  * from numeric values to a single tag. Overlapping tag value ranges are
 459  * therefore forbidden.
 460  */
 461 struct declaration_untagged_variant *untagged_variant_declaration_new(
 462                 struct declaration_scope *parent_scope);
 463 struct declaration_variant *variant_declaration_new(struct declaration_untagged_variant *untagged_variant,
 464                 const char *tag);
 465
 466 void untagged_variant_declaration_add_field(struct declaration_untagged_variant *untagged_variant_declaration,
 467                 const char *field_name,
 468                 struct declaration *field_declaration);
 469 struct declaration_field *
 470         untagged_variant_declaration_get_field_from_tag(struct declaration_untagged_variant *untagged_variant_declaration,
 471                 GQuark tag);
 472 /*
 473  * Returns 0 on success, -EPERM on error.
 474  */
 475 int variant_definition_set_tag(struct definition_variant *variant,
 476                                struct definition *enum_tag);
 477 /*
 478  * Returns the field selected by the current tag value.
 479  * field returned only valid as long as the variant structure is not appended
 480  * to.
 481  */
 482 struct definition *variant_get_current_field(struct definition_variant *variant);
 483 int variant_rw(struct stream_pos *pos, struct definition *definition);
 484
 485 /*
 486  * elem_declaration passed as parameter now belongs to the array. No
 487  * need to free it explicitly. "len" is the number of elements in the
 488  * array.
 489  */
 490 struct declaration_array *
 491         array_declaration_new(size_t len, struct declaration *elem_declaration,
 492                 struct declaration_scope *parent_scope);
 493 uint64_t array_len(struct definition_array *array);
 494 struct definition *array_index(struct definition_array *array, uint64_t i);
 495 int array_rw(struct stream_pos *pos, struct definition *definition);
 496
 497 /*
 498  * int_declaration and elem_declaration passed as parameter now belong
 499  * to the sequence. No need to free them explicitly.
 500  */
 501 struct declaration_sequence *
 502         sequence_declaration_new(const char *length_name,
 503                 struct declaration *elem_declaration,
 504                 struct declaration_scope *parent_scope);
 505 uint64_t sequence_len(struct definition_sequence *sequence);
 506 struct definition *sequence_index(struct definition_sequence *sequence, uint64_t i);
 507 int sequence_rw(struct stream_pos *pos, struct definition *definition);
 508
 509 /*
 510  * in: path (dot separated), out: q (GArray of GQuark)
 511  */
 512 void append_scope_path(const char *path, GArray *q);
 513
 514 /*
 515  * Lookup helpers.
 516  */
 517 struct definition *lookup_definition(struct definition *definition,
 518                                      const char *field_name);
 519 struct definition_integer *lookup_integer(struct definition *definition,
 520                                           const char *field_name,
 521                                           int signedness);
 522 struct definition_enum *lookup_enum(struct definition *definition,
 523                                     const char *field_name,
 524                                     int signedness);
 525 struct definition *lookup_variant(struct definition *definition,
 526                                   const char *field_name);
 527
 528 #endif /* _BABELTRACE_TYPES_H */