Commit | Line | Data |
---|---|---|
d79865b9 MD |
1 | #ifndef _BABELTRACE_CTF_TYPES_H |
2 | #define _BABELTRACE_CTF_TYPES_H | |
6dc2ca62 MD |
3 | |
4 | /* | |
5 | * Common Trace Format | |
6 | * | |
7 | * Type header | |
8 | * | |
ccd7e1c8 | 9 | * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
6dc2ca62 | 10 | * |
ccd7e1c8 MD |
11 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
12 | * of this software and associated documentation files (the "Software"), to deal | |
13 | * in the Software without restriction, including without limitation the rights | |
14 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
15 | * copies of the Software, and to permit persons to whom the Software is | |
16 | * furnished to do so, subject to the following conditions: | |
de0ba614 | 17 | * |
ccd7e1c8 MD |
18 | * The above copyright notice and this permission notice shall be included in |
19 | * all copies or substantial portions of the Software. | |
6dc2ca62 MD |
20 | */ |
21 | ||
4c8bfb7e | 22 | #include <babeltrace/types.h> |
70bd0a12 | 23 | #include <babeltrace/babeltrace-internal.h> |
8563e754 MD |
24 | #include <sys/types.h> |
25 | #include <sys/stat.h> | |
26 | #include <fcntl.h> | |
8c572eba | 27 | #include <errno.h> |
6dc2ca62 | 28 | #include <stdint.h> |
0f980a35 | 29 | #include <unistd.h> |
6dc2ca62 | 30 | #include <glib.h> |
c5e74408 | 31 | #include <stdio.h> |
fef3bf22 | 32 | #include <inttypes.h> |
aee35fcc | 33 | #include <babeltrace/mmap-align.h> |
847bf71a | 34 | |
fef3bf22 | 35 | #define LAST_OFFSET_POISON ((int64_t) ~0ULL) |
3a25e036 | 36 | |
c34ccddd MD |
37 | struct bt_stream_callbacks; |
38 | ||
0f980a35 MD |
39 | struct packet_index { |
40 | off_t offset; /* offset of the packet in the file, in bytes */ | |
fef3bf22 | 41 | int64_t data_offset; /* offset of data within the packet, in bits */ |
7e18eedf JN |
42 | uint64_t packet_size; /* packet size, in bits */ |
43 | uint64_t content_size; /* content size, in bits */ | |
75cc2c35 MD |
44 | uint64_t timestamp_begin; |
45 | uint64_t timestamp_end; | |
4c4ba021 | 46 | uint64_t events_discarded; |
fef3bf22 | 47 | uint64_t events_discarded_len; /* length of the field, in bits */ |
dd2544fd MD |
48 | }; |
49 | ||
dd2544fd | 50 | /* |
46322b33 | 51 | * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos. |
dd2544fd | 52 | */ |
46322b33 MD |
53 | struct ctf_stream_pos { |
54 | struct stream_pos parent; | |
0f980a35 | 55 | int fd; /* backing file fd. -1 if unset. */ |
03798a93 JD |
56 | GArray *packet_cycles_index; /* contains struct packet_index in cycles */ |
57 | GArray *packet_real_index; /* contains struct packet_index in ns */ | |
8c572eba MD |
58 | int prot; /* mmap protection */ |
59 | int flags; /* mmap flags */ | |
dd2544fd | 60 | |
0f980a35 MD |
61 | /* Current position */ |
62 | off_t mmap_offset; /* mmap offset in the file, in bytes */ | |
47415068 | 63 | off_t mmap_base_offset; /* offset of start of packet in mmap, in bytes */ |
fef3bf22 MD |
64 | uint64_t packet_size; /* current packet size, in bits */ |
65 | uint64_t content_size; /* current content size, in bits */ | |
66 | uint64_t *content_size_loc; /* pointer to current content size */ | |
aee35fcc | 67 | struct mmap_align *base_mma;/* mmap base address */ |
fef3bf22 MD |
68 | int64_t offset; /* offset from base, in bits. EOF for end of file. */ |
69 | int64_t last_offset; /* offset before the last read_event */ | |
70 | uint64_t cur_index; /* current index in packet index */ | |
f60efc0e | 71 | uint64_t last_events_discarded; /* last known amount of event discarded */ |
20d0dcf9 | 72 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
b086c01a | 73 | int whence); /* function called to switch packet */ |
dd2544fd | 74 | |
0f980a35 | 75 | int dummy; /* dummy position, for length calculation */ |
c34ccddd | 76 | struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */ |
0f980a35 | 77 | }; |
dd2544fd | 78 | |
46322b33 MD |
79 | static inline |
80 | struct ctf_stream_pos *ctf_pos(struct stream_pos *pos) | |
81 | { | |
82 | return container_of(pos, struct ctf_stream_pos, parent); | |
83 | } | |
84 | ||
c5e74408 MD |
85 | int ctf_integer_read(struct stream_pos *pos, struct definition *definition); |
86 | int ctf_integer_write(struct stream_pos *pos, struct definition *definition); | |
87 | int ctf_float_read(struct stream_pos *pos, struct definition *definition); | |
88 | int ctf_float_write(struct stream_pos *pos, struct definition *definition); | |
89 | int ctf_string_read(struct stream_pos *pos, struct definition *definition); | |
90 | int ctf_string_write(struct stream_pos *pos, struct definition *definition); | |
91 | int ctf_enum_read(struct stream_pos *pos, struct definition *definition); | |
92 | int ctf_enum_write(struct stream_pos *pos, struct definition *definition); | |
93 | int ctf_struct_rw(struct stream_pos *pos, struct definition *definition); | |
94 | int ctf_variant_rw(struct stream_pos *pos, struct definition *definition); | |
81dee1bb MD |
95 | int ctf_array_read(struct stream_pos *pos, struct definition *definition); |
96 | int ctf_array_write(struct stream_pos *pos, struct definition *definition); | |
97 | int ctf_sequence_read(struct stream_pos *pos, struct definition *definition); | |
98 | int ctf_sequence_write(struct stream_pos *pos, struct definition *definition); | |
6dc2ca62 | 99 | |
20d0dcf9 | 100 | void ctf_packet_seek(struct stream_pos *pos, size_t index, int whence); |
0f980a35 | 101 | |
f824ae04 MD |
102 | int ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags); |
103 | int ctf_fini_pos(struct ctf_stream_pos *pos); | |
0f980a35 MD |
104 | |
105 | /* | |
106 | * move_pos - move position of a relative bit offset | |
107 | * | |
108 | * TODO: allow larger files by updating base too. | |
109 | */ | |
110 | static inline | |
fef3bf22 | 111 | void ctf_move_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 112 | { |
fef3bf22 | 113 | printf_debug("ctf_move_pos test EOF: %" PRId64 "\n", pos->offset); |
90bf3cef | 114 | if (unlikely(pos->offset == EOF)) |
c5e74408 MD |
115 | return; |
116 | ||
8c572eba | 117 | if (pos->fd >= 0) { |
5f643ed7 | 118 | /* |
06789ffd | 119 | * PROT_READ ctf_packet_seek is called from within |
5f643ed7 MD |
120 | * ctf_pos_get_event so end of packet does not change |
121 | * the packet context on for the last event of the | |
122 | * packet. | |
123 | */ | |
124 | if ((pos->prot == PROT_WRITE) | |
90bf3cef | 125 | && (unlikely(pos->offset + bit_offset >= pos->packet_size))) { |
fef3bf22 | 126 | printf_debug("ctf_packet_seek (before call): %" PRId64 "\n", |
670977d3 | 127 | pos->offset); |
20d0dcf9 | 128 | ctf_packet_seek(&pos->parent, 0, SEEK_CUR); |
fef3bf22 | 129 | printf_debug("ctf_packet_seek (after call): %" PRId64 "\n", |
670977d3 | 130 | pos->offset); |
8c572eba MD |
131 | return; |
132 | } | |
133 | } | |
134 | pos->offset += bit_offset; | |
fef3bf22 | 135 | printf_debug("ctf_move_pos after increment: %" PRId64 "\n", pos->offset); |
0f980a35 MD |
136 | } |
137 | ||
138 | /* | |
139 | * align_pos - align position on a bit offset (> 0) | |
140 | * | |
141 | * TODO: allow larger files by updating base too. | |
142 | */ | |
143 | static inline | |
fef3bf22 | 144 | void ctf_align_pos(struct ctf_stream_pos *pos, uint64_t bit_offset) |
0f980a35 | 145 | { |
46322b33 | 146 | ctf_move_pos(pos, offset_align(pos->offset, bit_offset)); |
0f980a35 MD |
147 | } |
148 | ||
149 | static inline | |
46322b33 | 150 | char *ctf_get_pos_addr(struct ctf_stream_pos *pos) |
0f980a35 MD |
151 | { |
152 | /* Only makes sense to get the address after aligning on CHAR_BIT */ | |
153 | assert(!(pos->offset % CHAR_BIT)); | |
47415068 JD |
154 | return mmap_align_addr(pos->base_mma) + |
155 | pos->mmap_base_offset + (pos->offset / CHAR_BIT); | |
0f980a35 MD |
156 | } |
157 | ||
8c572eba | 158 | static inline |
46322b33 | 159 | void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy) |
8c572eba | 160 | { |
46322b33 | 161 | memcpy(dummy, pos, sizeof(struct ctf_stream_pos)); |
8c572eba MD |
162 | dummy->dummy = 1; |
163 | dummy->fd = -1; | |
164 | } | |
165 | ||
166 | /* | |
167 | * Check if current packet can hold data. | |
168 | * Returns 0 for success, negative error otherwise. | |
169 | */ | |
170 | static inline | |
46322b33 | 171 | int ctf_pos_packet(struct ctf_stream_pos *dummy) |
8c572eba | 172 | { |
90bf3cef | 173 | if (unlikely(dummy->offset > dummy->packet_size)) |
8c572eba MD |
174 | return -ENOSPC; |
175 | return 0; | |
176 | } | |
177 | ||
178 | static inline | |
46322b33 | 179 | void ctf_pos_pad_packet(struct ctf_stream_pos *pos) |
8c572eba | 180 | { |
46322b33 | 181 | ctf_move_pos(pos, pos->packet_size - pos->offset); |
8c572eba MD |
182 | } |
183 | ||
c5e74408 | 184 | static inline |
fef3bf22 | 185 | int ctf_pos_access_ok(struct ctf_stream_pos *pos, uint64_t bit_len) |
c5e74408 | 186 | { |
90bf3cef | 187 | if (unlikely(pos->offset == EOF)) |
c5e74408 | 188 | return 0; |
90bf3cef | 189 | if (unlikely(pos->offset + bit_len > pos->packet_size)) |
c5e74408 MD |
190 | return 0; |
191 | return 1; | |
192 | } | |
193 | ||
5f643ed7 MD |
194 | /* |
195 | * Update the stream position for to the current event. This moves to | |
196 | * the next packet if we are located at the end of the current packet. | |
197 | */ | |
198 | static inline | |
199 | void ctf_pos_get_event(struct ctf_stream_pos *pos) | |
200 | { | |
201 | assert(pos->offset <= pos->content_size); | |
202 | if (pos->offset == pos->content_size) { | |
fef3bf22 | 203 | printf_debug("ctf_packet_seek (before call): %" PRId64 "\n", |
5f643ed7 | 204 | pos->offset); |
06789ffd | 205 | pos->packet_seek(&pos->parent, 0, SEEK_CUR); |
fef3bf22 | 206 | printf_debug("ctf_packet_seek (after call): %" PRId64 "\n", |
5f643ed7 MD |
207 | pos->offset); |
208 | } | |
209 | } | |
210 | ||
9e88d150 | 211 | void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream, |
7d97fad9 MD |
212 | uint64_t timestamp); |
213 | ||
d79865b9 | 214 | #endif /* _BABELTRACE_CTF_TYPES_H */ |