1 /* This file is part of the Linux Trace Toolkit trace reading library
2 * Copyright (C) 2003-2004 Michel Dagenais
3 * 2006 Mathieu Desnoyers
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License Version 2.1 as published by the Free Software Foundation.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
25 #include <sys/types.h>
27 LttEvent
*ltt_event_new();
29 void ltt_event_destroy(LttEvent
*event
);
31 /* Events and their content, including the raw data, are only valid
32 until reading another event from the same tracefile.
33 Indeed, since event reading is critical to the performance,
34 the memory associated with an event may be reused at each read. */
36 /* Obtain the trace unique integer id associated with the type of
39 unsigned ltt_event_eventtype_id(const LttEvent
*e
);
41 unsigned ltt_event_facility_id(const LttEvent
*e
);
43 /* Facility and type for the event */
45 LttFacility
*ltt_event_facility(const LttEvent
*e
);
47 LttEventType
*ltt_event_eventtype(const LttEvent
*e
);
51 /* Time and cycle count for the event */
53 LttTime
ltt_event_time(const LttEvent
*e
);
55 LttCycleCount
ltt_event_cycle_count(const LttEvent
*e
);
58 /* Obtain the position of the event within the tracefile. This
59 is used to seek back to this position later or to seek to another
60 position, computed relative to this position. The event position
61 structure is opaque and contains several fields, only two
62 of which are user accessible: block number and event index
65 void ltt_event_position(LttEvent
*e
, LttEventPosition
*ep
);
67 LttEventPosition
* ltt_event_position_new();
69 void ltt_event_position_get(LttEventPosition
*ep
, LttTracefile
**tf
,
70 guint
*block
, guint
*offset
, guint64
*tsc
);
72 gint
ltt_event_position_compare(const LttEventPosition
*ep1
,
73 const LttEventPosition
*ep2
);
75 void ltt_event_position_copy(LttEventPosition
*dest
,
76 const LttEventPosition
*src
);
78 LttTracefile
*ltt_event_position_tracefile(LttEventPosition
*ep
);
80 /* CPU id of the event */
82 unsigned ltt_event_cpu_id(LttEvent
*e
);
85 /* Pointer to the raw data for the event. This should not be used directly
86 unless prepared to do all the architecture specific conversions. */
88 void *ltt_event_data(LttEvent
*e
);
91 /* The number of elements in a sequence field is specific to each event
92 instance. This function returns the number of elements for an array or
93 sequence field in an event. */
95 guint64
ltt_event_field_element_number(LttEvent
*e
, LttField
*f
);
98 /* Set the currently selected element for a sequence or array field. */
100 LttField
*ltt_event_field_element_select(LttEvent
*e
, LttField
*f
, gulong i
);
102 off_t
ltt_event_field_offset(LttEvent
*e
, LttField
*f
);
104 /* A union is like a structure except that only a single member at a time
105 is present depending on the specific event instance. This function tells
106 the active member for a union field in an event. */
108 unsigned ltt_event_field_union_member(LttEvent
*e
, LttField
*f
);
111 /* These functions extract data from an event after architecture specific
114 guint32
ltt_event_get_unsigned(LttEvent
*e
, LttField
*f
);
116 gint32
ltt_event_get_int(LttEvent
*e
, LttField
*f
);
118 guint64
ltt_event_get_long_unsigned(LttEvent
*e
, LttField
*f
);
120 gint64
ltt_event_get_long_int(LttEvent
*e
, LttField
*f
);
122 float ltt_event_get_float(LttEvent
*e
, LttField
*f
);
124 double ltt_event_get_double(LttEvent
*e
, LttField
*f
);
127 /* The string obtained is only valid until the next read from
128 the same tracefile. */
130 gchar
*ltt_event_get_string(LttEvent
*e
, LttField
*f
);
132 void compute_offsets(LttTracefile
*tf
, LttFacility
*fac
,
133 LttEventType
*event
, off_t
*offset
, void *root
);
This page took 0.030703 seconds and 4 git commands to generate.