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