[lttv.git] / ltt / branches / poly / ltt / event.h

#ifndef _LTT_EVENT_H
#define _LTT_EVENT_H

#include <ltt/time.h>
#include <glib.h>
#include <stdint.h>
#include <sys/types.h>
#include <ltt/ltt.h>
#include <endian.h>

/*
 * Structure LttEvent and LttEventPosition must begin with the _exact_ same
 * fields in the exact same order. LttEventPosition is a parent of LttEvent.
 */
struct LttEvent {
	/* Begin of LttEventPosition fields */
	LttTracefile *tracefile;
	unsigned int block;
	unsigned int offset;

	/* Timekeeping */
	uint64_t tsc;		/* Current timestamp counter */
	
	/* End of LttEventPosition fields */
	guint32	timestamp;	/* truncated timestamp */

	guint16 event_id;

	LttTime event_time;

	void *data;		/* event data */
	guint data_size;
	guint event_size;	/* event_size field of the header :
				   used to verify data_size from facility. */
	uint32_t compact_data;

	int count;		/* the number of overflow of cycle count */
	gint64 overflow_nsec;	/* precalculated nsec for overflows */
};

struct LttEventPosition {
	LttTracefile *tracefile;
	unsigned int block;
	unsigned int offset;
	
	/* Timekeeping */
	uint64_t tsc;		 /* Current timestamp counter */
};

static inline guint16 ltt_event_id(struct LttEvent *event)
{
	return event->event_id;
}

static inline LttTime ltt_event_time(struct LttEvent *event)
{
	return event->event_time;
}

/* Obtain the position of the event within the tracefile. This
   is used to seek back to this position later or to seek to another
   position, computed relative to this position. The event position
   structure is opaque and contains several fields, only two
   of which are user accessible: block number and event index
   within the block. */

void ltt_event_position(LttEvent *e, LttEventPosition *ep);

LttEventPosition * ltt_event_position_new();

void ltt_event_position_get(LttEventPosition *ep, LttTracefile **tf,
        guint *block, guint *offset, guint64 *tsc);

void ltt_event_position_set(LttEventPosition *ep, LttTracefile *tf,
        guint block, guint offset, guint64 tsc);

gint ltt_event_position_compare(const LttEventPosition *ep1,
                                const LttEventPosition *ep2);

void ltt_event_position_copy(LttEventPosition *dest,
                             const LttEventPosition *src);

LttTracefile *ltt_event_position_tracefile(LttEventPosition *ep);

#endif //_LTT_EVENT_H
Commit	Line	Data
	1	#ifndef _LTT_EVENT_H
	2	#define _LTT_EVENT_H
	3
	4	#include <ltt/time.h>
	5	#include <glib.h>
	6	#include <stdint.h>
	7	#include <sys/types.h>
	8	#include <ltt/ltt.h>
	9	#include <endian.h>
	10
	11	/*
	12	* Structure LttEvent and LttEventPosition must begin with the _exact_ same
	13	* fields in the exact same order. LttEventPosition is a parent of LttEvent.
	14	*/
	15	struct LttEvent {
	16	/* Begin of LttEventPosition fields */
	17	LttTracefile *tracefile;
	18	unsigned int block;
	19	unsigned int offset;
	20
	21	/* Timekeeping */
	22	uint64_t tsc; /* Current timestamp counter */
	23
	24	/* End of LttEventPosition fields */
	25	guint32 timestamp; /* truncated timestamp */
	26
	27	guint16 event_id;
	28
	29	LttTime event_time;
	30
	31	void data; / event data */
	32	guint data_size;
	33	guint event_size; /* event_size field of the header :
	34	used to verify data_size from facility. */
	35	uint32_t compact_data;
	36
	37	int count; /* the number of overflow of cycle count */
	38	gint64 overflow_nsec; /* precalculated nsec for overflows */
	39	};
	40
	41	struct LttEventPosition {
	42	LttTracefile *tracefile;
	43	unsigned int block;
	44	unsigned int offset;
	45
	46	/* Timekeeping */
	47	uint64_t tsc; /* Current timestamp counter */
	48	};
	49
	50	static inline guint16 ltt_event_id(struct LttEvent *event)
	51	{
	52	return event->event_id;
	53	}
	54
	55	static inline LttTime ltt_event_time(struct LttEvent *event)
	56	{
	57	return event->event_time;
	58	}
	59
	60	/* Obtain the position of the event within the tracefile. This
	61	is used to seek back to this position later or to seek to another
	62	position, computed relative to this position. The event position
	63	structure is opaque and contains several fields, only two
	64	of which are user accessible: block number and event index
	65	within the block. */
	66
	67	void ltt_event_position(LttEvent e, LttEventPosition ep);
	68
	69	LttEventPosition * ltt_event_position_new();
	70
	71	void ltt_event_position_get(LttEventPosition ep, LttTracefile *tf,
	72	guint block, guint offset, guint64 *tsc);
	73
	74	void ltt_event_position_set(LttEventPosition ep, LttTracefile tf,
	75	guint block, guint offset, guint64 tsc);
	76
	77	gint ltt_event_position_compare(const LttEventPosition *ep1,
	78	const LttEventPosition *ep2);
	79
	80	void ltt_event_position_copy(LttEventPosition *dest,
	81	const LttEventPosition *src);
	82
	83	LttTracefile ltt_event_position_tracefile(LttEventPosition ep);
	84
	85	#endif //_LTT_EVENT_H