[babeltrace.git] / include / babeltrace / types.h

#ifndef _BABELTRACE_TYPES_H
#define _BABELTRACE_TYPES_H

/*
 * BabelTrace
 *
 * Type Header
 *
 * Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * 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.
 *
 * 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.
 *
 * 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
 */

#include <babeltrace/format.h>

struct type_class {
	GQuark name;		/* type name */
	size_t alignment;	/* type alignment, in bits */
	/*
	 * 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);
};

struct type_class_integer {
	struct type_class p;
	size_t len;		/* length, in bits. */
	int byte_order;		/* byte order */
	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;
	int byte_order;
	/* TODO: we might want to express more info about NaN, +inf and -inf */
};

struct type_class_enum {
	struct type_class_bitfield;	/* inherit from bitfield */
	struct enum_table *table;
};

struct type_class_struct {
	struct type_class p;
	/* TODO */
};

struct type_class *ctf_lookup_type(GQuark qname);
int ctf_register_type(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);
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);

struct type_class_float *float_type_new(const char *name,
					size_t mantissa_len,
					size_t exp_len, int byte_order,
					size_t alignment);
void float_type_free(struct type_class_float *float_class);

#endif /* _BABELTRACE_TYPES_H */
Commit	Line	Data
	1	#ifndef _BABELTRACE_TYPES_H
	2	#define _BABELTRACE_TYPES_H
	3
	4	/*
	5	* BabelTrace
	6	*
	7	* Type Header
	8	*
	9	* Copyright (c) 2010 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	10	*
	11	* This library is free software; you can redistribute it and/or
	12	* modify it under the terms of the GNU Lesser General Public
	13	* License as published by the Free Software Foundation; either
	14	* version 2.1 of the License, or (at your option) any later version.
	15	*
	16	* This library is distributed in the hope that it will be useful,
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	19	* Lesser General Public License for more details.
	20	*
	21	* You should have received a copy of the GNU Lesser General Public
	22	* License along with this library; if not, write to the Free Software
	23	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
	24	*/
	25
	26	#include <babeltrace/format.h>
	27
	28	struct type_class {
	29	GQuark name; /* type name */
	30	size_t alignment; /* type alignment, in bits */
	31	/*
	32	* Type copy function. Knows how to find the child type_class from the
	33	* parent type_class.
	34	*/
	35	size_t (copy)(unsigned char dest, const struct format *fdest,
	36	const unsigned char src, const struct format fsrc,
	37	const struct type_class *type_class);
	38	};
	39
	40	struct type_class_integer {
	41	struct type_class p;
	42	size_t len; /* length, in bits. */
	43	int byte_order; /* byte order */
	44	int signedness;
	45	};
	46
	47	struct type_class_bitfield {
	48	struct type_class_integer p;
	49	size_t start_offset; /* offset from base address, in bits */
	50	};
	51
	52	struct type_class_float {
	53	struct type_class p;
	54	size_t mantissa_len;
	55	size_t exp_len;
	56	int byte_order;
	57	/* TODO: we might want to express more info about NaN, +inf and -inf */
	58	};
	59
	60	struct type_class_enum {
	61	struct type_class_bitfield; /* inherit from bitfield */
	62	struct enum_table *table;
	63	};
	64
	65	struct type_class_struct {
	66	struct type_class p;
	67	/* TODO */
	68	};
	69
	70	struct type_class *ctf_lookup_type(GQuark qname);
	71	int ctf_register_type(struct type_class *type_class);
	72
	73	/* Nameless types can be created by passing a NULL name */
	74
	75	struct type_class_integer integer_type_new(const char name,
	76	size_t start_offset,
	77	size_t len, int byte_order,
	78	int signedness);
	79	void integer_type_free(struct type_class_integer *int_class);
	80
	81	struct type_class_bitfield bitfield_type_new(const char name,
	82	size_t start_offset,
	83	size_t len, int byte_order,
	84	int signedness);
	85	void bitfield_type_free(struct type_class_bitfield *bitfield_class);
	86
	87	struct type_class_float float_type_new(const char name,
	88	size_t mantissa_len,
	89	size_t exp_len, int byte_order,
	90	size_t alignment);
	91	void float_type_free(struct type_class_float *float_class);
	92
	93	#endif /* _BABELTRACE_TYPES_H */