[lttv.git] / ltt / branches / poly / include / ltt / trace.h

#ifndef TRACE_H
#define TRACE_H

#include <ltt/ltt.h>

/* A trace is specified as a pathname to the directory containing all the
   associated data (control tracefiles, per cpu tracefiles, event 
   descriptions...).

   When a trace is closed, all the associated facilities, types and fields
   are released as well. */

LttTrace *ltt_trace_open(char *pathname);

void ltt_trace_close(LttTrace *t); 


/* The characteristics of the system on which the trace was obtained
   is described in a LttSystemDescription structure. */

struct _LttSystemDescription {
  char *description;
  char *node_name;
  char *domain_name;
  unsigned nb_cpu;
  LttArchSize size;
  LttArchEndian endian;
  char *kernel_name;
  char *kernel_release;
  char *kernel_version;
  char *machine;
  char *processor;
  char *hardware_platform;
  char *operating_system;
  unsigned ltt_major_version;
  unsigned ltt_minor_version;
  unsigned ltt_block_size;
  LttTime trace_start;
  LttTime trace_end;
};

LttSystemDescription *ltt_trace_system_description(LttTrace *t);


/* Functions to discover the facilities in the trace. Once the number
   of facilities is known, they may be accessed by position. Multiple
   versions of a facility (same name, different checksum) have consecutive
   positions. */

unsigned ltt_trace_facility_number(LttTrace *t);

LttFacility *ltt_trace_facility_get(LttTrace *t, unsigned i);


/* Look for a facility by name. It returns the number of facilities found
   and sets the position argument to the first found. Returning 0, the named
   facility is unknown, returning 1, the named facility is at the specified
   position, returning n, the facilities are from position to 
   position + n - 1. */

unsigned ltt_trace_facility_find(LttTrace *t, char *name, unsigned *position);


/* Functions to discover all the event types in the trace */

unsigned ltt_trace_eventtype_number(LttTrace *t);

LttEventType *ltt_trace_eventtype_get(LttTrace *t, unsigned i);


/* There is one "per cpu" tracefile for each CPU, numbered from 0 to
   the maximum number of CPU in the system. When the number of CPU installed
   is less than the maximum, some positions are unused. There are also a
   number of "control" tracefiles (facilities, interrupts...). */

unsigned ltt_trace_control_tracefile_number(LttTrace *t);

unsigned ltt_trace_per_cpu_tracefile_number(LttTrace *t);


/* It is possible to search for the tracefiles by name or by CPU position.
   The index within the tracefiles of the same type is returned if found
   and a negative value otherwise. */

int ltt_trace_control_tracefile_find(LttTrace *t, char *name);

int ltt_trace_per_cpu_tracefile_find(LttTrace *t, unsigned i);


/* Get a specific tracefile */

LttTracefile *ltt_trace_control_tracefile_get(LttTrace *t, unsigned i);

LttTracefile *ltt_trace_per_cpu_tracefile_get(LttTrace *t, unsigned i);


/* Get the start time and end time of the trace */

void ltt_trace_time_span_get(LttTrace *t, LttTime *start, LttTime *end);


/* Get the name of a tracefile */

char *ltt_tracefile_name(LttTracefile *tf);


/* Get the number of blocks in the tracefile */

unsigned ltt_tracefile_block_number(LttTracefile *tf);


/* Seek to the first event of the trace with time larger or equal to time */

void ltt_tracefile_seek_time(LttTracefile *t, LttTime time);

/* Seek to the first event with position equal or larger to ep */

void ltt_tracefile_seek_position(LttTracefile *t,
    LttEventPosition *ep);

/* Read the next event */

LttEvent *ltt_tracefile_read(LttTracefile *t);

#endif // TRACE_H
Commit	Line	Data
	1	#ifndef TRACE_H
	2	#define TRACE_H
	3
	4	#include <ltt/ltt.h>
	5
	6	/* A trace is specified as a pathname to the directory containing all the
	7	associated data (control tracefiles, per cpu tracefiles, event
	8	descriptions...).
	9
	10	When a trace is closed, all the associated facilities, types and fields
	11	are released as well. */
	12
	13	LttTrace ltt_trace_open(char pathname);
	14
	15	void ltt_trace_close(LttTrace *t);
	16
	17
	18	/* The characteristics of the system on which the trace was obtained
	19	is described in a LttSystemDescription structure. */
	20
	21	struct _LttSystemDescription {
	22	char *description;
	23	char *node_name;
	24	char *domain_name;
	25	unsigned nb_cpu;
	26	LttArchSize size;
	27	LttArchEndian endian;
	28	char *kernel_name;
	29	char *kernel_release;
	30	char *kernel_version;
	31	char *machine;
	32	char *processor;
	33	char *hardware_platform;
	34	char *operating_system;
	35	unsigned ltt_major_version;
	36	unsigned ltt_minor_version;
	37	unsigned ltt_block_size;
	38	LttTime trace_start;
	39	LttTime trace_end;
	40	};
	41
	42	LttSystemDescription ltt_trace_system_description(LttTrace t);
	43
	44
	45	/* Functions to discover the facilities in the trace. Once the number
	46	of facilities is known, they may be accessed by position. Multiple
	47	versions of a facility (same name, different checksum) have consecutive
	48	positions. */
	49
	50	unsigned ltt_trace_facility_number(LttTrace *t);
	51
	52	LttFacility ltt_trace_facility_get(LttTrace t, unsigned i);
	53
	54
	55	/* Look for a facility by name. It returns the number of facilities found
	56	and sets the position argument to the first found. Returning 0, the named
	57	facility is unknown, returning 1, the named facility is at the specified
	58	position, returning n, the facilities are from position to
	59	position + n - 1. */
	60
	61	unsigned ltt_trace_facility_find(LttTrace t, char name, unsigned *position);
	62
	63
	64	/* Functions to discover all the event types in the trace */
	65
	66	unsigned ltt_trace_eventtype_number(LttTrace *t);
	67
	68	LttEventType ltt_trace_eventtype_get(LttTrace t, unsigned i);
	69
	70
	71	/* There is one "per cpu" tracefile for each CPU, numbered from 0 to
	72	the maximum number of CPU in the system. When the number of CPU installed
	73	is less than the maximum, some positions are unused. There are also a
	74	number of "control" tracefiles (facilities, interrupts...). */
	75
	76	unsigned ltt_trace_control_tracefile_number(LttTrace *t);
	77
	78	unsigned ltt_trace_per_cpu_tracefile_number(LttTrace *t);
	79
	80
	81	/* It is possible to search for the tracefiles by name or by CPU position.
	82	The index within the tracefiles of the same type is returned if found
	83	and a negative value otherwise. */
	84
	85	int ltt_trace_control_tracefile_find(LttTrace t, char name);
	86
	87	int ltt_trace_per_cpu_tracefile_find(LttTrace *t, unsigned i);
	88
	89
	90	/* Get a specific tracefile */
	91
	92	LttTracefile ltt_trace_control_tracefile_get(LttTrace t, unsigned i);
	93
	94	LttTracefile ltt_trace_per_cpu_tracefile_get(LttTrace t, unsigned i);
	95
	96
	97	/* Get the start time and end time of the trace */
	98
	99	void ltt_trace_time_span_get(LttTrace t, LttTime start, LttTime *end);
	100
	101
	102	/* Get the name of a tracefile */
	103
	104	char ltt_tracefile_name(LttTracefile tf);
	105
	106
	107	/* Get the number of blocks in the tracefile */
	108
	109	unsigned ltt_tracefile_block_number(LttTracefile *tf);
	110
	111
	112	/* Seek to the first event of the trace with time larger or equal to time */
	113
	114	void ltt_tracefile_seek_time(LttTracefile *t, LttTime time);
	115
	116	/* Seek to the first event with position equal or larger to ep */
	117
	118	void ltt_tracefile_seek_position(LttTracefile *t,
	119	LttEventPosition *ep);
	120
	121	/* Read the next event */
	122
	123	LttEvent ltt_tracefile_read(LttTracefile t);
	124
	125	#endif // TRACE_H