X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=include%2Fbabeltrace%2Ftypes.h;h=ea60d88ab951633c71eca1a1640cfb38d8563885;hp=3dea99e54b012d7fffc68640af8705f28249b1b8;hb=8eab883c99f13a74c3a30b288070f0038357103e;hpb=448d3cc7640830015850cc6287532d4c194fe690 diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index 3dea99e5..ea60d88a 100644 --- a/include/babeltrace/types.h +++ b/include/babeltrace/types.h @@ -6,37 +6,104 @@ * * Type Header * - * Copyright (c) 2010 Mathieu Desnoyers + * Copyright 2010 - Mathieu Desnoyers * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + */ + +#include +#include +#include +#include +#include +#include +#include + +/* Preallocate this many fields for structures */ +#define DEFAULT_NR_STRUCT_FIELDS 8 + +/* + * Always update stream_pos with move_pos and init_pos. + */ +struct stream_pos { + unsigned char *base; /* Base address */ + size_t offset; /* Offset from base, in bits */ + int dummy; /* Dummy position, for length calculation */ +}; + +static inline +void init_pos(struct stream_pos *pos, unsigned char *base) +{ + pos->base = base; /* initial base, page-aligned */ + pos->offset = 0; + pos->dummy = false; +} + +/* + * move_pos - move position of a relative bit offset * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + * TODO: allow larger files by updating base too. */ +static inline +void move_pos(struct stream_pos *pos, size_t offset) +{ + pos->offset = pos->offset + offset; +} -#include +/* + * align_pos - align position on a bit offset (> 0) + * + * TODO: allow larger files by updating base too. + */ +static inline +void align_pos(struct stream_pos *pos, size_t offset) +{ + pos->offset += offset_align(pos->offset, offset); +} + +static inline +void copy_pos(struct stream_pos *dest, struct stream_pos *src) +{ + memcpy(dest, src, sizeof(struct stream_pos)); +} + +static inline +unsigned char *get_pos_addr(struct stream_pos *pos) +{ + /* Only makes sense to get the address after aligning on CHAR_BIT */ + assert(!(pos->offset % CHAR_BIT)); + return pos->base + (pos->offset / CHAR_BIT); +} + +struct format; struct type_class { GQuark name; /* type name */ size_t alignment; /* type alignment, in bits */ + int ref; /* number of references to the type */ /* * Type copy function. Knows how to find the child type_class from the * parent type_class. */ - size_t (*copy)(unsigned char *dest, const struct format *fdest, - const unsigned char *src, const struct format *fsrc, - const struct type_class *type_class); + void (*copy)(struct stream_pos *dest, const struct format *fdest, + struct stream_pos *src, const struct format *fsrc, + const struct type_class *type_class); + void (*free)(struct type_class *type_class); }; +/* + * Because we address in bits, bitfields end up being exactly the same as + * integers, except that their read/write functions must be able to deal with + * read/write non aligned on CHAR_BIT. + */ struct type_class_integer { struct type_class p; size_t len; /* length, in bits. */ @@ -44,15 +111,11 @@ struct type_class_integer { int signedness; }; -struct type_class_bitfield { - struct type_class_integer p; - size_t start_offset; /* offset from base address, in bits */ -}; - struct type_class_float { struct type_class p; - size_t mantissa_len; - size_t exp_len; + struct type_class_integer *sign; + struct type_class_integer *mantissa; + struct type_class_integer *exp; int byte_order; /* TODO: we might want to express more info about NaN, +inf and -inf */ }; @@ -63,32 +126,55 @@ struct enum_table { }; struct type_class_enum { - struct type_class_bitfield p; /* inherit from bitfield */ + struct type_class_integer p; /* inherit from integer */ struct enum_table table; }; +struct type_class_string { + struct type_class p; +}; + +struct field { + GQuark name; + struct type_class *type_class; +}; + struct type_class_struct { struct type_class p; - /* TODO */ + GHashTable *fields_by_name; /* Tuples (field name, field index) */ + GArray *fields; /* Array of fields */ }; -struct type_class *ctf_lookup_type(GQuark qname); -int ctf_register_type(struct type_class *type_class); +struct type_class_array { + struct type_class p; + size_t len; + struct type_class *elem; +}; + +struct type_class_sequence { + struct type_class p; + struct type_class_integer *len_class; + struct type_class *elem; +}; + +struct type_class *lookup_type(GQuark qname); +int register_type(struct type_class *type_class); + +void type_ref(struct type_class *type_class); +void type_unref(struct type_class *type_class); /* Nameless types can be created by passing a NULL name */ struct type_class_integer *integer_type_new(const char *name, - size_t start_offset, size_t len, int byte_order, - int signedness); + int signedness, + size_t alignment); void integer_type_free(struct type_class_integer *int_class); -struct type_class_bitfield *bitfield_type_new(const char *name, - size_t start_offset, - size_t len, int byte_order, - int signedness); -void bitfield_type_free(struct type_class_bitfield *bitfield_class); - +/* + * mantissa_len is the length of the number of bytes represented by the mantissa + * (e.g. result of DBL_MANT_DIG). It includes the leading 1. + */ struct type_class_float *float_type_new(const char *name, size_t mantissa_len, size_t exp_len, int byte_order, @@ -102,19 +188,54 @@ void float_type_free(struct type_class_float *float_class); GQuark enum_uint_to_quark(const struct type_class_enum *enum_class, uint64_t v); GQuark enum_int_to_quark(const struct type_class_enum *enum_class, uint64_t v); uint64_t enum_quark_to_uint(const struct type_class_enum *enum_class, - size_t len, int byte_order, GQuark q); + GQuark q); int64_t enum_quark_to_int(const struct type_class_enum *enum_class, - size_t len, int byte_order, GQuark q); + GQuark q); void enum_signed_insert(struct type_class_enum *enum_class, int64_t v, GQuark q); void enum_unsigned_insert(struct type_class_enum *enum_class, uint64_t v, GQuark q); struct type_class_enum *enum_type_new(const char *name, - size_t start_offset, size_t len, int byte_order, int signedness, size_t alignment); void enum_type_free(struct type_class_enum *enum_class); +struct type_class_struct *struct_type_new(const char *name); +void struct_type_free(struct type_class_struct *struct_class); +void struct_type_add_field(struct type_class_struct *struct_class, + const char *field_name, + struct type_class *type_class); +/* + * Returns the index of a field within a structure. + */ +unsigned long +struct_type_lookup_field_index(struct type_class_struct *struct_class, + GQuark field_name); +/* + * field returned only valid as long as the field structure is not appended to. + */ +struct field * +struct_type_get_field_from_index(struct type_class_struct *struct_class, + unsigned long index); + +/* + * elem_class passed as parameter now belongs to the array. No need to free it + * explicitely. + */ +struct type_class_array *array_type_new(const char *name, + size_t len, + struct type_class *elem_class); +void array_type_free(struct type_class_array *array_class); + +/* + * int_class and elem_class passed as parameter now belongs to the sequence. No + * need to free them explicitely. + */ +struct type_class_sequence *sequence_type_new(const char *name, + struct type_class_integer *len_class, + struct type_class *elem_class); +void sequence_type_free(struct type_class_sequence *sequence_class); + #endif /* _BABELTRACE_TYPES_H */