| 1 | /* This file is part of the Linux Trace Toolkit viewer |
| 2 | * Copyright (C) 2003-2004 Xiangxiu Yang |
| 3 | * 2006 Mathieu Desnoyers |
| 4 | * |
| 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. |
| 8 | * |
| 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. |
| 13 | * |
| 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. |
| 18 | */ |
| 19 | |
| 20 | #ifndef LTT_PRIVATE_H |
| 21 | #define LTT_PRIVATE_H |
| 22 | |
| 23 | #include <glib.h> |
| 24 | #include <sys/types.h> |
| 25 | #include <ltt/ltt.h> |
| 26 | #include <endian.h> |
| 27 | #include <ltt/event.h> |
| 28 | |
| 29 | #ifndef max |
| 30 | #define max(a,b) ((a)>(b)?(a):(b)) |
| 31 | #endif |
| 32 | |
| 33 | #ifndef min |
| 34 | #define min(a,b) ((a)<(b)?(a):(b)) |
| 35 | #endif |
| 36 | |
| 37 | |
| 38 | |
| 39 | #define LTT_MAGIC_NUMBER 0x00D6B7ED |
| 40 | #define LTT_REV_MAGIC_NUMBER 0xEDB7D600 |
| 41 | |
| 42 | #define NSEC_PER_USEC 1000 |
| 43 | |
| 44 | /* Byte ordering */ |
| 45 | #define LTT_GET_BO(t) ((t)->reverse_bo) |
| 46 | |
| 47 | #define LTT_HAS_FLOAT(t) ((t)->float_word_order ! =0) |
| 48 | #define LTT_GET_FLOAT_BO(t) \ |
| 49 | (((t)->float_word_order == __BYTE_ORDER) ? 0 : 1) |
| 50 | |
| 51 | #define SEQUENCE_AVG_ELEMENTS 1000 |
| 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 | |
| 63 | typedef guint8 uint8_t; |
| 64 | typedef guint16 uint16_t; |
| 65 | typedef guint32 uint32_t; |
| 66 | typedef guint64 uint64_t; |
| 67 | |
| 68 | /* Subbuffer header */ |
| 69 | struct ltt_subbuffer_header_2_2 { |
| 70 | uint64_t cycle_count_begin; /* Cycle count at subbuffer start */ |
| 71 | uint64_t cycle_count_end; /* Cycle count at subbuffer end */ |
| 72 | uint32_t magic_number; /* |
| 73 | * Trace magic number. |
| 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 */ |
| 89 | uint32_t events_lost; /* |
| 90 | * Events lost in this subbuffer since |
| 91 | * the beginning of the trace. |
| 92 | * (may overflow) |
| 93 | */ |
| 94 | uint32_t subbuf_corrupt; /* |
| 95 | * Corrupted (lost) subbuffers since |
| 96 | * the begginig of the trace. |
| 97 | * (may overflow) |
| 98 | */ |
| 99 | char header_end[0]; /* End of header */ |
| 100 | }; |
| 101 | |
| 102 | typedef struct ltt_subbuffer_header_2_2 ltt_subbuffer_header_t; |
| 103 | |
| 104 | /* |
| 105 | * Return header size without padding after the structure. Don't use packed |
| 106 | * structure because gcc generates inefficient code on some architectures |
| 107 | * (powerpc, mips..) |
| 108 | */ |
| 109 | static inline size_t ltt_subbuffer_header_size(void) |
| 110 | { |
| 111 | return offsetof(ltt_subbuffer_header_t, header_end); |
| 112 | } |
| 113 | |
| 114 | enum field_status { FIELD_UNKNOWN, FIELD_VARIABLE, FIELD_FIXED }; |
| 115 | |
| 116 | typedef struct _LttBuffer { |
| 117 | void * head; |
| 118 | unsigned int index; |
| 119 | |
| 120 | struct { |
| 121 | LttTime timestamp; |
| 122 | uint64_t cycle_count; |
| 123 | uint64_t freq; /* Frequency in khz */ |
| 124 | } begin; |
| 125 | struct { |
| 126 | LttTime timestamp; |
| 127 | uint64_t cycle_count; |
| 128 | uint64_t freq; /* Frequency in khz */ |
| 129 | } end; |
| 130 | uint32_t lost_size; /* Size unused at the end of the buffer */ |
| 131 | |
| 132 | /* Timekeeping */ |
| 133 | uint64_t tsc; /* Current timestamp counter */ |
| 134 | uint64_t freq; /* Frequency in khz */ |
| 135 | guint32 cyc2ns_scale; |
| 136 | } LttBuffer; |
| 137 | |
| 138 | struct LttTracefile { |
| 139 | gboolean cpu_online; //is the cpu online ? |
| 140 | GQuark long_name; //tracefile complete filename |
| 141 | GQuark name; //tracefile name |
| 142 | guint cpu_num; //cpu number of the tracefile |
| 143 | guint tid; //Usertrace tid, else 0 |
| 144 | guint pgid; //Usertrace pgid, else 0 |
| 145 | guint64 creation; //Usertrace creation, else 0 |
| 146 | LttTrace * trace; //trace containing the tracefile |
| 147 | int fd; //file descriptor |
| 148 | off_t file_size; //file size |
| 149 | //unsigned block_size; //block_size |
| 150 | guint num_blocks; //number of blocks in the file |
| 151 | gboolean reverse_bo; //must we reverse byte order ? |
| 152 | gboolean float_word_order; //what is the byte order of floats ? |
| 153 | size_t alignment; //alignment of events in the tracefile. |
| 154 | // 0 or the architecture size in bytes. |
| 155 | |
| 156 | size_t buffer_header_size; |
| 157 | uint8_t tscbits; |
| 158 | uint8_t eventbits; |
| 159 | uint64_t tsc_mask; |
| 160 | uint64_t tsc_mask_next_bit; //next MSB after the mask< |
| 161 | uint32_t events_lost; |
| 162 | uint32_t subbuf_corrupt; |
| 163 | |
| 164 | /* Current event */ |
| 165 | LttEvent event; //Event currently accessible in the trace |
| 166 | |
| 167 | /* Current block */ |
| 168 | LttBuffer buffer; //current buffer |
| 169 | guint32 buf_size; /* The size of blocks */ |
| 170 | }; |
| 171 | |
| 172 | /* The characteristics of the system on which the trace was obtained |
| 173 | is described in a LttSystemDescription structure. */ |
| 174 | |
| 175 | struct LttSystemDescription { |
| 176 | gchar *description; |
| 177 | gchar *node_name; |
| 178 | gchar *domain_name; |
| 179 | unsigned nb_cpu; |
| 180 | LttArchSize size; |
| 181 | LttArchEndian endian; |
| 182 | gchar *kernel_name; |
| 183 | gchar *kernel_release; |
| 184 | gchar *kernel_version; |
| 185 | gchar *machine; |
| 186 | gchar *processor; |
| 187 | gchar *hardware_platform; |
| 188 | gchar *operating_system; |
| 189 | LttTime trace_start; |
| 190 | LttTime trace_end; |
| 191 | }; |
| 192 | |
| 193 | /* Calculate the offset needed to align the type. |
| 194 | * If alignment is 0, alignment is disactivated. |
| 195 | * else, the function returns the offset needed to |
| 196 | * align align_drift on the alignment value (should be |
| 197 | * the size of the architecture). */ |
| 198 | static inline unsigned int ltt_align(size_t align_drift, |
| 199 | size_t size_of_type, |
| 200 | size_t alignment) |
| 201 | { |
| 202 | size_t align_offset = min(alignment, size_of_type); |
| 203 | |
| 204 | if(!alignment) |
| 205 | return 0; |
| 206 | |
| 207 | g_assert(size_of_type != 0); |
| 208 | return ((align_offset - align_drift) & (align_offset-1)); |
| 209 | } |
| 210 | |
| 211 | |
| 212 | #endif /* LTT_PRIVATE_H */ |