449cb9d7 |
1 | /* This file is part of the Linux Trace Toolkit viewer |
2 | * Copyright (C) 2003-2004 Xiangxiu Yang |
1b44b0b5 |
3 | * 2006 Mathieu Desnoyers |
449cb9d7 |
4 | * |
1b44b0b5 |
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. |
449cb9d7 |
8 | * |
1b44b0b5 |
9 | * This library is distributed in the hope that it will be useful, |
449cb9d7 |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
1b44b0b5 |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
12 | * Lesser General Public License for more details. |
449cb9d7 |
13 | * |
1b44b0b5 |
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. |
449cb9d7 |
18 | */ |
19 | |
fcdf0ec2 |
20 | #ifndef LTT_PRIVATE_H |
21 | #define LTT_PRIVATE_H |
22 | |
858bd80a |
23 | #include <glib.h> |
cbd41522 |
24 | #include <sys/types.h> |
fcdf0ec2 |
25 | #include <ltt/ltt.h> |
3b10b765 |
26 | #include <endian.h> |
29af7cfd |
27 | #include <ltt/event.h> |
e3247aa5 |
28 | |
eed2ef37 |
29 | #ifndef max |
30 | #define max(a,b) ((a)>(b)?(a):(b)) |
31 | #endif |
32 | |
2312de30 |
33 | #ifndef min |
34 | #define min(a,b) ((a)<(b)?(a):(b)) |
35 | #endif |
36 | |
37 | |
eed2ef37 |
38 | |
3aee1200 |
39 | #define LTT_MAGIC_NUMBER 0x00D6B7ED |
40 | #define LTT_REV_MAGIC_NUMBER 0xEDB7D600 |
41 | |
42 | #define NSEC_PER_USEC 1000 |
43 | |
3b10b765 |
44 | /* Byte ordering */ |
45 | #define LTT_GET_BO(t) ((t)->reverse_bo) |
46 | |
64dd41a5 |
47 | #define LTT_HAS_FLOAT(t) ((t)->float_word_order ! =0) |
3b10b765 |
48 | #define LTT_GET_FLOAT_BO(t) \ |
64dd41a5 |
49 | (((t)->float_word_order == __BYTE_ORDER) ? 0 : 1) |
3b10b765 |
50 | |
f104d082 |
51 | #define SEQUENCE_AVG_ELEMENTS 1000 |
1550fba6 |
52 | |
53 | /* |
54 | * offsetof taken from Linux kernel. |
55 | */ |
56 | #undef offsetof |
57 | #ifdef __compiler_offsetof |
58 | #define offsetof(TYPE,MEMBER) __compiler_offsetof(TYPE,MEMBER) |
59 | #else |
60 | #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) |
61 | #endif |
62 | |
3aee1200 |
63 | typedef guint8 uint8_t; |
64 | typedef guint16 uint16_t; |
65 | typedef guint32 uint32_t; |
66 | typedef guint64 uint64_t; |
67 | |
64dd41a5 |
68 | /* Subbuffer header */ |
1550fba6 |
69 | struct ltt_subbuffer_header_2_1 { |
64dd41a5 |
70 | uint64_t cycle_count_begin; /* Cycle count at subbuffer start */ |
71 | uint64_t cycle_count_end; /* Cycle count at subbuffer end */ |
1550fba6 |
72 | uint32_t magic_number; /* |
73 | * Trace magic number. |
64dd41a5 |
74 | * contains endianness information. |
75 | */ |
76 | uint8_t major_version; |
77 | uint8_t minor_version; |
78 | uint8_t arch_size; /* Architecture pointer size */ |
79 | uint8_t alignment; /* LTT data alignment */ |
80 | uint64_t start_time_sec; /* NTP-corrected start time */ |
81 | uint64_t start_time_usec; |
82 | uint64_t start_freq; /* |
83 | * Frequency at trace start, |
84 | * used all along the trace. |
85 | */ |
86 | uint32_t freq_scale; /* Frequency scaling */ |
87 | uint32_t lost_size; /* Size unused at end of subbuffer */ |
88 | uint32_t buf_size; /* Size of this subbuffer */ |
1550fba6 |
89 | char header_end[0]; /* End of header */ |
64dd41a5 |
90 | }; |
91 | |
1550fba6 |
92 | typedef struct ltt_subbuffer_header_2_1 ltt_subbuffer_header_t; |
93 | |
94 | /* |
95 | * Return header size without padding after the structure. Don't use packed |
96 | * structure because gcc generates inefficient code on some architectures |
97 | * (powerpc, mips..) |
98 | */ |
99 | static inline size_t ltt_subbuffer_header_size(void) |
100 | { |
101 | return offsetof(ltt_subbuffer_header_t, header_end); |
102 | } |
e3247aa5 |
103 | |
3aee1200 |
104 | enum field_status { FIELD_UNKNOWN, FIELD_VARIABLE, FIELD_FIXED }; |
105 | |
3aee1200 |
106 | typedef struct _LttBuffer { |
107 | void * head; |
108 | unsigned int index; |
109 | |
110 | struct { |
111 | LttTime timestamp; |
112 | uint64_t cycle_count; |
986e2a7c |
113 | uint64_t freq; /* Frequency in khz */ |
3aee1200 |
114 | } begin; |
115 | struct { |
116 | LttTime timestamp; |
117 | uint64_t cycle_count; |
986e2a7c |
118 | uint64_t freq; /* Frequency in khz */ |
3aee1200 |
119 | } end; |
120 | uint32_t lost_size; /* Size unused at the end of the buffer */ |
121 | |
122 | /* Timekeeping */ |
123 | uint64_t tsc; /* Current timestamp counter */ |
986e2a7c |
124 | uint64_t freq; /* Frequency in khz */ |
791dffa6 |
125 | guint32 cyc2ns_scale; |
3aee1200 |
126 | } LttBuffer; |
127 | |
29af7cfd |
128 | struct LttTracefile { |
3aee1200 |
129 | gboolean cpu_online; //is the cpu online ? |
d3d34f49 |
130 | GQuark long_name; //tracefile complete filename |
3aee1200 |
131 | GQuark name; //tracefile name |
132 | guint cpu_num; //cpu number of the tracefile |
c88ddec5 |
133 | guint tid; //Usertrace tid, else 0 |
134 | guint pgid; //Usertrace pgid, else 0 |
135 | guint64 creation; //Usertrace creation, else 0 |
e3247aa5 |
136 | LttTrace * trace; //trace containing the tracefile |
137 | int fd; //file descriptor |
138 | off_t file_size; //file size |
f628823c |
139 | //unsigned block_size; //block_size |
f104d082 |
140 | guint num_blocks; //number of blocks in the file |
3aee1200 |
141 | gboolean reverse_bo; //must we reverse byte order ? |
3b10b765 |
142 | gboolean float_word_order; //what is the byte order of floats ? |
256a5b3a |
143 | size_t alignment; //alignment of events in the tracefile. |
c88ddec5 |
144 | // 0 or the architecture size in bytes. |
3aee1200 |
145 | |
823820eb |
146 | size_t buffer_header_size; |
d1bb700c |
147 | uint8_t tscbits; |
2fc874ab |
148 | uint8_t eventbits; |
d1bb700c |
149 | uint64_t tsc_mask; |
150 | uint64_t tsc_mask_next_bit; //next MSB after the mask |
823820eb |
151 | |
c88ddec5 |
152 | /* Current event */ |
3aee1200 |
153 | LttEvent event; //Event currently accessible in the trace |
154 | |
c88ddec5 |
155 | /* Current block */ |
3aee1200 |
156 | LttBuffer buffer; //current buffer |
157 | guint32 buf_size; /* The size of blocks */ |
e3247aa5 |
158 | }; |
7c6b3cd7 |
159 | |
a5dcde2f |
160 | /* The characteristics of the system on which the trace was obtained |
161 | is described in a LttSystemDescription structure. */ |
162 | |
29af7cfd |
163 | struct LttSystemDescription { |
45e14832 |
164 | gchar *description; |
165 | gchar *node_name; |
166 | gchar *domain_name; |
a5dcde2f |
167 | unsigned nb_cpu; |
168 | LttArchSize size; |
169 | LttArchEndian endian; |
45e14832 |
170 | gchar *kernel_name; |
171 | gchar *kernel_release; |
172 | gchar *kernel_version; |
173 | gchar *machine; |
174 | gchar *processor; |
175 | gchar *hardware_platform; |
176 | gchar *operating_system; |
a5dcde2f |
177 | LttTime trace_start; |
178 | LttTime trace_end; |
179 | }; |
180 | |
f104d082 |
181 | /* Calculate the offset needed to align the type. |
256a5b3a |
182 | * If alignment is 0, alignment is disactivated. |
f104d082 |
183 | * else, the function returns the offset needed to |
256a5b3a |
184 | * align align_drift on the alignment value (should be |
f104d082 |
185 | * the size of the architecture). */ |
186 | static inline unsigned int ltt_align(size_t align_drift, |
83e160f2 |
187 | size_t size_of_type, |
256a5b3a |
188 | size_t alignment) |
f104d082 |
189 | { |
256a5b3a |
190 | size_t align_offset = min(alignment, size_of_type); |
c88ddec5 |
191 | |
256a5b3a |
192 | if(!alignment) |
193 | return 0; |
c88ddec5 |
194 | |
195 | g_assert(size_of_type != 0); |
256a5b3a |
196 | return ((align_offset - align_drift) & (align_offset-1)); |
f104d082 |
197 | } |
198 | |
f104d082 |
199 | |
fcdf0ec2 |
200 | #endif /* LTT_PRIVATE_H */ |