types/sequence.c

   1 /*
   2  * sequence.c
   3  *
   4  * BabelTrace - Sequence Type Converter
   5  *
   6  * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
   7  *
   8  * Author: Mathieu Desnoyers <mathieu.desnoyers@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
  21 #include <babeltrace/compiler.h>
  22 #include <babeltrace/format.h>
  23 #include <inttypes.h>
  24
  25 static
  26 struct definition *_sequence_definition_new(struct declaration *declaration,
  27                                         struct definition_scope *parent_scope,
  28                                         GQuark field_name, int index,
  29                                         const char *root_name);
  30 static
  31 void _sequence_definition_free(struct definition *definition);
  32
  33 int sequence_rw(struct stream_pos *pos, struct definition *definition)
  34 {
  35         struct definition_sequence *sequence_definition =
  36                 container_of(definition, struct definition_sequence, p);
  37         const struct declaration_sequence *sequence_declaration =
  38                 sequence_definition->declaration;
  39         uint64_t len, oldlen, i;
  40         int ret;
  41
  42         len = sequence_definition->length->value._unsigned;
  43         /*
  44          * Yes, large sequences could be _painfully slow_ to parse due
  45          * to memory allocation for each event read. At least, never
  46          * shrink the sequence. Note: the sequence GArray len should
  47          * never be used as indicator of the current sequence length.
  48          * One should always look at the sequence->len->value._unsigned
  49          * value for that.
  50          */
  51         oldlen = sequence_definition->elems->len;
  52         if (oldlen < len)
  53                 g_ptr_array_set_size(sequence_definition->elems, len);
  54
  55         for (i = oldlen; i < len; i++) {
  56                 struct definition **field;
  57                 GString *str;
  58                 GQuark name;
  59
  60                 str = g_string_new("");
  61                 g_string_printf(str, "[%" PRIu64 "]", i);
  62                 name = g_quark_from_string(str->str);
  63                 (void) g_string_free(str, TRUE);
  64
  65                 field = (struct definition **) &g_ptr_array_index(sequence_definition->elems, i);
  66                 *field = sequence_declaration->elem->definition_new(sequence_declaration->elem,
  67                                           sequence_definition->p.scope,
  68                                           name, i, NULL);
  69         }
  70         for (i = 0; i < len; i++) {
  71                 struct definition **field;
  72
  73                 field = (struct definition **) &g_ptr_array_index(sequence_definition->elems, i);
  74                 ret = generic_rw(pos, *field);
  75                 if (ret)
  76                         return ret;
  77         }
  78         return 0;
  79 }
  80
  81 static
  82 void _sequence_declaration_free(struct declaration *declaration)
  83 {
  84         struct declaration_sequence *sequence_declaration =
  85                 container_of(declaration, struct declaration_sequence, p);
  86
  87         free_declaration_scope(sequence_declaration->scope);
  88         g_array_free(sequence_declaration->length_name, TRUE);
  89         declaration_unref(sequence_declaration->elem);
  90         g_free(sequence_declaration);
  91 }
  92
  93 struct declaration_sequence *
  94         sequence_declaration_new(const char *length,
  95                           struct declaration *elem_declaration,
  96                           struct declaration_scope *parent_scope)
  97 {
  98         struct declaration_sequence *sequence_declaration;
  99         struct declaration *declaration;
 100
 101         sequence_declaration = g_new(struct declaration_sequence, 1);
 102         declaration = &sequence_declaration->p;
 103
 104         sequence_declaration->length_name = g_array_new(FALSE, TRUE, sizeof(GQuark));
 105         append_scope_path(length, sequence_declaration->length_name);
 106
 107         declaration_ref(elem_declaration);
 108         sequence_declaration->elem = elem_declaration;
 109         sequence_declaration->scope = new_declaration_scope(parent_scope);
 110         declaration->id = CTF_TYPE_SEQUENCE;
 111         declaration->alignment = elem_declaration->alignment;
 112         declaration->declaration_free = _sequence_declaration_free;
 113         declaration->definition_new = _sequence_definition_new;
 114         declaration->definition_free = _sequence_definition_free;
 115         declaration->ref = 1;
 116         return sequence_declaration;
 117 }
 118
 119 static
 120 struct definition *_sequence_definition_new(struct declaration *declaration,
 121                                 struct definition_scope *parent_scope,
 122                                 GQuark field_name, int index,
 123                                 const char *root_name)
 124 {
 125         struct declaration_sequence *sequence_declaration =
 126                 container_of(declaration, struct declaration_sequence, p);
 127         struct definition_sequence *sequence;
 128         struct definition *len_parent;
 129         int ret;
 130
 131         sequence = g_new(struct definition_sequence, 1);
 132         declaration_ref(&sequence_declaration->p);
 133         sequence->p.declaration = declaration;
 134         sequence->declaration = sequence_declaration;
 135         sequence->p.ref = 1;
 136         /*
 137          * Use INT_MAX order to ensure that all fields of the parent
 138          * scope are seen as being prior to this scope.
 139          */
 140         sequence->p.index = root_name ? INT_MAX : index;
 141         sequence->p.name = field_name;
 142         sequence->p.path = new_definition_path(parent_scope, field_name, root_name);
 143         sequence->p.scope = new_definition_scope(parent_scope, field_name, root_name);
 144         ret = register_field_definition(field_name, &sequence->p,
 145                                         parent_scope);
 146         assert(!ret);
 147         len_parent = lookup_path_definition(sequence->p.scope->scope_path,
 148                                             sequence_declaration->length_name,
 149                                             parent_scope);
 150         if (!len_parent) {
 151                 printf("[error] Lookup for sequence length field failed.\n");
 152                 goto error;
 153         }
 154         sequence->length =
 155                 container_of(len_parent, struct definition_integer, p);
 156         if (sequence->length->declaration->signedness) {
 157                 printf("[error] Sequence length field should be unsigned.\n");
 158                 goto error;
 159         }
 160         definition_ref(len_parent);
 161
 162         sequence->string = NULL;
 163         sequence->elems = NULL;
 164
 165         if (sequence_declaration->elem->id == CTF_TYPE_INTEGER) {
 166                 struct declaration_integer *integer_declaration =
 167                         container_of(sequence_declaration->elem, struct declaration_integer, p);
 168
 169                 if (integer_declaration->encoding == CTF_STRING_UTF8
 170                       || integer_declaration->encoding == CTF_STRING_ASCII) {
 171
 172                         sequence->string = g_string_new("");
 173
 174                         if (integer_declaration->len == CHAR_BIT
 175                             && integer_declaration->p.alignment == CHAR_BIT) {
 176                                 return &sequence->p;
 177                         }
 178                 }
 179         }
 180
 181         sequence->elems = g_ptr_array_new();
 182         return &sequence->p;
 183
 184 error:
 185         free_definition_scope(sequence->p.scope);
 186         declaration_unref(&sequence_declaration->p);
 187         g_free(sequence);
 188         return NULL;
 189 }
 190
 191 static
 192 void _sequence_definition_free(struct definition *definition)
 193 {
 194         struct definition_sequence *sequence =
 195                 container_of(definition, struct definition_sequence, p);
 196         struct definition *len_definition = &sequence->length->p;
 197         uint64_t i;
 198
 199         if (sequence->string)
 200                 (void) g_string_free(sequence->string, TRUE);
 201         if (sequence->elems) {
 202                 for (i = 0; i < sequence->elems->len; i++) {
 203                         struct definition *field;
 204
 205                         field = g_ptr_array_index(sequence->elems, i);
 206                         field->declaration->definition_free(field);
 207                 }
 208         }
 209         (void) g_ptr_array_free(sequence->elems, TRUE);
 210         definition_unref(len_definition);
 211         free_definition_scope(sequence->p.scope);
 212         declaration_unref(sequence->p.declaration);
 213         g_free(sequence);
 214 }
 215
 216 uint64_t sequence_len(struct definition_sequence *sequence)
 217 {
 218         return sequence->length->value._unsigned;
 219 }
 220
 221 struct definition *sequence_index(struct definition_sequence *sequence, uint64_t i)
 222 {
 223         if (!sequence->elems)
 224                 return NULL;
 225         if (i >= sequence->length->value._unsigned)
 226                 return NULL;
 227         assert(i < sequence->elems->len);
 228         return g_ptr_array_index(sequence->elems, i);
 229 }