types/struct.c

   1 /*
   2  * struct.c
   3  *
   4  * BabelTrace - Structure Type Converter
   5  *
   6  * Copyright 2010, 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  */
  18
  19 #include <babeltrace/compiler.h>
  20 #include <babeltrace/format.h>
  21
  22 #ifndef max
  23 #define max(a, b)       ((a) < (b) ? (b) : (a))
  24 #endif
  25
  26 static
  27 struct definition *_struct_definition_new(struct declaration *declaration,
  28                                 struct definition_scope *parent_scope);
  29 static
  30 void _struct_definition_free(struct definition *definition);
  31
  32 void struct_copy(struct stream_pos *dest, const struct format *fdest,
  33                  struct stream_pos *src, const struct format *fsrc,
  34                  struct definition *definition)
  35 {
  36         struct definition_struct *_struct =
  37                 container_of(definition, struct definition_struct, p);
  38         struct declaration_struct *struct_declaration = _struct->declaration;
  39         unsigned long i;
  40
  41         fsrc->struct_begin(src, struct_declaration);
  42         fdest->struct_begin(dest, struct_declaration);
  43
  44         for (i = 0; i < _struct->fields->len; i++) {
  45                 struct field *field = &g_array_index(_struct->fields,
  46                                                      struct field, i);
  47                 struct declaration *field_declaration = field->definition->declaration;
  48
  49                 field_declaration->copy(dest, fdest, src, fsrc, field->definition);
  50
  51         }
  52         fsrc->struct_end(src, struct_declaration);
  53         fdest->struct_end(dest, struct_declaration);
  54 }
  55
  56 static
  57 void _struct_declaration_free(struct declaration *declaration)
  58 {
  59         struct declaration_struct *struct_declaration =
  60                 container_of(declaration, struct declaration_struct, p);
  61         unsigned long i;
  62
  63         free_declaration_scope(struct_declaration->scope);
  64         g_hash_table_destroy(struct_declaration->fields_by_name);
  65
  66         for (i = 0; i < struct_declaration->fields->len; i++) {
  67                 struct declaration_field *declaration_field =
  68                         &g_array_index(struct_declaration->fields,
  69                                        struct declaration_field, i);
  70                 declaration_unref(declaration_field->declaration);
  71         }
  72         g_array_free(struct_declaration->fields, true);
  73         g_free(struct_declaration);
  74 }
  75
  76 struct declaration_struct *struct_declaration_new(const char *name,
  77                                     struct declaration_scope *parent_scope)
  78 {
  79         struct declaration_struct *struct_declaration;
  80         struct declaration *declaration;
  81
  82         struct_declaration = g_new(struct declaration_struct, 1);
  83         declaration = &struct_declaration->p;
  84         struct_declaration->fields_by_name = g_hash_table_new(g_direct_hash,
  85                                                        g_direct_equal);
  86         struct_declaration->fields = g_array_sized_new(FALSE, TRUE,
  87                                                 sizeof(struct declaration_field),
  88                                                 DEFAULT_NR_STRUCT_FIELDS);
  89         struct_declaration->scope = new_declaration_scope(parent_scope);
  90         declaration->id = CTF_TYPE_STRUCT;
  91         declaration->name = g_quark_from_string(name);
  92         declaration->alignment = 1;
  93         declaration->copy = struct_copy;
  94         declaration->declaration_free = _struct_declaration_free;
  95         declaration->definition_new = _struct_definition_new;
  96         declaration->definition_free = _struct_definition_free;
  97         declaration->ref = 1;
  98         return struct_declaration;
  99 }
 100
 101 static
 102 struct definition *
 103         _struct_definition_new(struct declaration *declaration,
 104                                struct definition_scope *parent_scope)
 105 {
 106         struct declaration_struct *struct_declaration =
 107                 container_of(declaration, struct declaration_struct, p);
 108         struct definition_struct *_struct;
 109         unsigned long i;
 110         int ret;
 111
 112         _struct = g_new(struct definition_struct, 1);
 113         declaration_ref(&struct_declaration->p);
 114         _struct->p.declaration = declaration;
 115         _struct->declaration = struct_declaration;
 116         _struct->p.ref = 1;
 117         _struct->scope = new_definition_scope(parent_scope);
 118         _struct->fields = g_array_sized_new(FALSE, TRUE,
 119                                             sizeof(struct field),
 120                                             DEFAULT_NR_STRUCT_FIELDS);
 121         g_array_set_size(_struct->fields, struct_declaration->fields->len);
 122         for (i = 0; i < struct_declaration->fields->len; i++) {
 123                 struct declaration_field *declaration_field =
 124                         &g_array_index(struct_declaration->fields,
 125                                        struct declaration_field, i);
 126                 struct field *field = &g_array_index(_struct->fields,
 127                                                      struct field, i);
 128
 129                 field->name = declaration_field->name;
 130                 field->definition =
 131                         declaration_field->declaration->definition_new(declaration_field->declaration,
 132                                                           _struct->scope);
 133                 ret = register_field_definition(field->name,
 134                                                 field->definition,
 135                                                 _struct->scope);
 136                 assert(!ret);
 137         }
 138         return &_struct->p;
 139 }
 140
 141 static
 142 void _struct_definition_free(struct definition *definition)
 143 {
 144         struct definition_struct *_struct =
 145                 container_of(definition, struct definition_struct, p);
 146         unsigned long i;
 147
 148         assert(_struct->fields->len == _struct->declaration->fields->len);
 149         for (i = 0; i < _struct->fields->len; i++) {
 150                 struct field *field = &g_array_index(_struct->fields,
 151                                                      struct field, i);
 152                 definition_unref(field->definition);
 153         }
 154         free_definition_scope(_struct->scope);
 155         declaration_unref(_struct->p.declaration);
 156         g_free(_struct);
 157 }
 158
 159 void struct_declaration_add_field(struct declaration_struct *struct_declaration,
 160                            const char *field_name,
 161                            struct declaration *field_declaration)
 162 {
 163         struct declaration_field *field;
 164         unsigned long index;
 165
 166         g_array_set_size(struct_declaration->fields, struct_declaration->fields->len + 1);
 167         index = struct_declaration->fields->len - 1;    /* last field (new) */
 168         field = &g_array_index(struct_declaration->fields, struct declaration_field, index);
 169         field->name = g_quark_from_string(field_name);
 170         declaration_ref(field_declaration);
 171         field->declaration = field_declaration;
 172         /* Keep index in hash rather than pointer, because array can relocate */
 173         g_hash_table_insert(struct_declaration->fields_by_name,
 174                             (gpointer) (unsigned long) field->name,
 175                             (gpointer) index);
 176         /*
 177          * Alignment of structure is the max alignment of declarations contained
 178          * therein.
 179          */
 180         struct_declaration->p.alignment = max(struct_declaration->p.alignment,
 181                                        field_declaration->alignment);
 182 }
 183
 184 unsigned long
 185         struct_declaration_lookup_field_index(struct declaration_struct *struct_declaration,
 186                                        GQuark field_name)
 187 {
 188         unsigned long index;
 189
 190         index = (unsigned long) g_hash_table_lookup(struct_declaration->fields_by_name,
 191                                                     (gconstpointer) (unsigned long) field_name);
 192         return index;
 193 }
 194
 195 /*
 196  * field returned only valid as long as the field structure is not appended to.
 197  */
 198 struct declaration_field *
 199         struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration,
 200                                          unsigned long index)
 201 {
 202         return &g_array_index(struct_declaration->fields, struct declaration_field, index);
 203 }
 204
 205 /*
 206  * field returned only valid as long as the field structure is not appended to.
 207  */
 208 struct field *
 209 struct_definition_get_field_from_index(struct definition_struct *_struct,
 210                                         unsigned long index)
 211 {
 212         return &g_array_index(_struct->fields, struct field, index);
 213 }