[lttv.git] / ltt / marker-field.h

#ifndef _LTT_MARKERS_FIELD_H
#define _LTT_MARKERS_FIELD_H

/*
 * Marker field support header.
 *
 * Mathieu Desnoyers, August 2007
 * License: LGPL.
 */

#include <glib.h>

enum ltt_type {
	LTT_TYPE_SIGNED_INT,
	LTT_TYPE_UNSIGNED_INT,
	LTT_TYPE_POINTER,
	LTT_TYPE_STRING,
	LTT_TYPE_COMPACT,
	LTT_TYPE_NONE,
};

/*
 * Fields "offset" and "size" below are only valid while the event is being
 * read. They are also being shared with events of the same type coming from
 * other per-cpu tracefiles. Therefore, the "LttEvent" fields_offsets offset and
 * size should be used rather than these.
 */
struct marker_field {
  GQuark name;
  enum ltt_type type;
  unsigned int index;	/* Field index within the event */
  unsigned long _offset; /* offset in the event data, USED ONLY INTERNALLY BY LIB */
  unsigned long _size;	/* size of field. USED ONLY INTERNALLY BY LIB */
  unsigned long alignment;
  unsigned long attributes;
  int static_offset;	/* boolean - private - is the field offset statically
  			 * known with the preceding types ? */
  GString *fmt;
};

static inline GQuark marker_field_get_name(struct marker_field *field)
{
	return field->name;
}

static inline enum ltt_type marker_field_get_type(struct marker_field *field)
{
	return field->type;
}

/*
 * Returns 0 if size is not known statically.
 */
static inline long marker_field_get_size(struct marker_field *field)
{
	return field->_size;
}

static inline unsigned int marker_field_get_index(struct marker_field *field)
{
	return field->index;
}

#endif //_LTT_MARKERS_FIELD_H
Commit	Line	Data
14b1ac27	1	#ifndef _LTT_MARKERS_FIELD_H
	2	#define _LTT_MARKERS_FIELD_H
	3
	4	/*
	5	* Marker field support header.
	6	*
	7	* Mathieu Desnoyers, August 2007
	8	* License: LGPL.
	9	*/
	10
	11	#include <glib.h>
	12
	13	enum ltt_type {
	14	LTT_TYPE_SIGNED_INT,
	15	LTT_TYPE_UNSIGNED_INT,
91346f59	16	LTT_TYPE_POINTER,
14b1ac27	17	LTT_TYPE_STRING,
	18	LTT_TYPE_COMPACT,
	19	LTT_TYPE_NONE,
	20	};
	21
1184dc37 MD	22	/*
	23	* Fields "offset" and "size" below are only valid while the event is being
	24	* read. They are also being shared with events of the same type coming from
	25	* other per-cpu tracefiles. Therefore, the "LttEvent" fields_offsets offset and
	26	* size should be used rather than these.
	27	*/
14b1ac27	28	struct marker_field {
	29	GQuark name;
	30	enum ltt_type type;
1184dc37 MD	31	unsigned int index; /* Field index within the event */
	32	unsigned long _offset; /* offset in the event data, USED ONLY INTERNALLY BY LIB */
	33	unsigned long _size; /* size of field. USED ONLY INTERNALLY BY LIB */
14b1ac27	34	unsigned long alignment;
14b1ac27	35	unsigned long attributes;
5d9896fd	36	int static_offset; /* boolean - private - is the field offset statically
5d9896fd	37	* known with the preceding types ? */
4d683428	38	GString *fmt;
14b1ac27	39	};
	40
	41	static inline GQuark marker_field_get_name(struct marker_field *field)
	42	{
	43	return field->name;
	44	}
	45
	46	static inline enum ltt_type marker_field_get_type(struct marker_field *field)
	47	{
	48	return field->type;
	49	}
	50
1184dc37 MD	51	/*
	52	* Returns 0 if size is not known statically.
	53	*/
	54	static inline long marker_field_get_size(struct marker_field *field)
	55	{
	56	return field->_size;
	57	}
	58
	59	static inline unsigned int marker_field_get_index(struct marker_field *field)
14b1ac27	60	{
1184dc37	61	return field->index;
14b1ac27	62	}
	63
	64	#endif //_LTT_MARKERS_FIELD_H