9c312311 |
1 | /* This file is part of the Linux Trace Toolkit trace reading library |
2 | * Copyright (C) 2003-2004 Michel Dagenais |
3 | * |
4 | * This library is free software; you can redistribute it and/or |
5 | * modify it under the terms of the GNU Lesser General Public |
6 | * License Version 2.1 as published by the Free Software Foundation. |
7 | * |
8 | * This library is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. |
12 | * |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the |
15 | * Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
16 | * Boston, MA 02111-1307, USA. |
17 | */ |
18 | |
7c6b3cd7 |
19 | #ifndef EVENT_H |
20 | #define EVENT_H |
21 | |
22 | #include <ltt/ltt.h> |
975e44c7 |
23 | |
24 | /* Events and their content, including the raw data, are only valid |
25 | until reading another event from the same tracefile. |
26 | Indeed, since event reading is critical to the performance, |
27 | the memory associated with an event may be reused at each read. */ |
28 | |
29 | |
1b82f325 |
30 | /* Obtain the trace unique integer id associated with the type of |
975e44c7 |
31 | this event */ |
32 | |
290dfc8c |
33 | unsigned ltt_event_eventtype_id(LttEvent *e); |
975e44c7 |
34 | |
35 | |
36 | /* Facility and type for the event */ |
37 | |
290dfc8c |
38 | LttFacility *ltt_event_facility(LttEvent *e); |
975e44c7 |
39 | |
290dfc8c |
40 | LttEventType *ltt_event_eventtype(LttEvent *e); |
975e44c7 |
41 | |
1b82f325 |
42 | |
43 | /* Root field for the event */ |
44 | |
290dfc8c |
45 | LttField *ltt_event_field(LttEvent *e); |
975e44c7 |
46 | |
1b82f325 |
47 | |
975e44c7 |
48 | /* Time and cycle count for the event */ |
49 | |
290dfc8c |
50 | LttTime ltt_event_time(LttEvent *e); |
975e44c7 |
51 | |
290dfc8c |
52 | LttCycleCount ltt_event_cycle_count(LttEvent *e); |
975e44c7 |
53 | |
54 | |
80da81ad |
55 | /* Obtain the position of the event within the tracefile. This |
56 | is used to seek back to this position later or to seek to another |
57 | position, computed relative to this position. The event position |
58 | structure is opaque and contains several fields, only two |
59 | of which are user accessible: block number and event index |
60 | within the block. */ |
61 | |
62 | void ltt_event_position(LttEvent *e, LttEventPosition *ep); |
63 | |
a5dcde2f |
64 | LttEventPosition * ltt_event_position_new(); |
65 | |
80da81ad |
66 | void ltt_event_position_get(LttEventPosition *ep, |
fb1a869e |
67 | unsigned *block_number, unsigned *index_in_block, LttTracefile ** tf); |
80da81ad |
68 | |
69 | void ltt_event_position_set(LttEventPosition *ep, |
70 | unsigned block_number, unsigned index_in_block); |
71 | |
72 | |
290dfc8c |
73 | /* CPU id of the event */ |
975e44c7 |
74 | |
290dfc8c |
75 | unsigned ltt_event_cpu_id(LttEvent *e); |
975e44c7 |
76 | |
77 | |
78 | /* Pointer to the raw data for the event. This should not be used directly |
79 | unless prepared to do all the architecture specific conversions. */ |
80 | |
290dfc8c |
81 | void *ltt_event_data(LttEvent *e); |
975e44c7 |
82 | |
83 | |
a6bf5e74 |
84 | /* The number of elements in a sequence field is specific to each event |
85 | instance. This function returns the number of elements for an array or |
86 | sequence field in an event. */ |
975e44c7 |
87 | |
290dfc8c |
88 | unsigned ltt_event_field_element_number(LttEvent *e, LttField *f); |
975e44c7 |
89 | |
90 | |
91 | /* Set the currently selected element for a sequence or array field. */ |
92 | |
290dfc8c |
93 | void ltt_event_field_element_select(LttEvent *e, LttField *f, unsigned i); |
975e44c7 |
94 | |
95 | |
a6bf5e74 |
96 | /* A union is like a structure except that only a single member at a time |
97 | is present depending on the specific event instance. This function tells |
98 | the active member for a union field in an event. */ |
99 | |
100 | unsigned ltt_event_field_union_member(LttEvent *e, LttField *f); |
101 | |
102 | |
975e44c7 |
103 | /* These functions extract data from an event after architecture specific |
104 | conversions. */ |
105 | |
290dfc8c |
106 | unsigned ltt_event_get_unsigned(LttEvent *e, LttField *f); |
975e44c7 |
107 | |
290dfc8c |
108 | int ltt_event_get_int(LttEvent *e, LttField *f); |
975e44c7 |
109 | |
290dfc8c |
110 | unsigned long ltt_event_get_long_unsigned(LttEvent *e, LttField *f); |
975e44c7 |
111 | |
290dfc8c |
112 | long int ltt_event_get_long_int(LttEvent *e, LttField *f); |
975e44c7 |
113 | |
290dfc8c |
114 | float ltt_event_get_float(LttEvent *e, LttField *f); |
975e44c7 |
115 | |
290dfc8c |
116 | double ltt_event_get_double(LttEvent *e, LttField *f); |
975e44c7 |
117 | |
118 | |
119 | /* The string obtained is only valid until the next read from |
120 | the same tracefile. */ |
121 | |
290dfc8c |
122 | char *ltt_event_get_string(LttEvent *e, LttField *f); |
7c6b3cd7 |
123 | |
124 | #endif // EVENT_H |