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> |
aee35fcc | 32 | #include <babeltrace/mmap-align.h> |
847bf71a | 33 | |
3a25e036 MD |
34 | #define LAST_OFFSET_POISON ((ssize_t) -1L) |
35 | ||
c34ccddd MD |
36 | struct bt_stream_callbacks; |
37 | ||
0f980a35 MD |
38 | struct packet_index { |
39 | off_t offset; /* offset of the packet in the file, in bytes */ | |
2b9a764d | 40 | off_t data_offset; /* offset of data within the packet, in bits */ |
7e18eedf JN |
41 | uint64_t packet_size; /* packet size, in bits */ |
42 | uint64_t content_size; /* content size, in bits */ | |
75cc2c35 MD |
43 | uint64_t timestamp_begin; |
44 | uint64_t timestamp_end; | |
4c4ba021 MD |
45 | uint64_t events_discarded; |
46 | size_t events_discarded_len; /* length of the field, in bits */ | |
dd2544fd MD |
47 | }; |
48 | ||
dd2544fd | 49 | /* |
46322b33 | 50 | * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos. |
dd2544fd | 51 | */ |
46322b33 MD |
52 | struct ctf_stream_pos { |
53 | struct stream_pos parent; | |
0f980a35 MD |
54 | int fd; /* backing file fd. -1 if unset. */ |
55 | GArray *packet_index; /* contains struct packet_index */ | |
8c572eba MD |
56 | int prot; /* mmap protection */ |
57 | int flags; /* mmap flags */ | |
dd2544fd | 58 | |
0f980a35 MD |
59 | /* Current position */ |
60 | off_t mmap_offset; /* mmap offset in the file, in bytes */ | |
61 | size_t packet_size; /* current packet size, in bits */ | |
62 | size_t content_size; /* current content size, in bits */ | |
8c572eba | 63 | uint32_t *content_size_loc; /* pointer to current content size */ |
aee35fcc | 64 | struct mmap_align *base_mma;/* mmap base address */ |
670977d3 | 65 | ssize_t offset; /* offset from base, in bits. EOF for end of file. */ |
90fcbacc | 66 | ssize_t last_offset; /* offset before the last read_event */ |
8c572eba | 67 | size_t cur_index; /* current index in packet index */ |
20d0dcf9 | 68 | void (*packet_seek)(struct stream_pos *pos, size_t index, |
b086c01a | 69 | int whence); /* function called to switch packet */ |
dd2544fd | 70 | |
0f980a35 | 71 | int dummy; /* dummy position, for length calculation */ |
c34ccddd | 72 | struct bt_stream_callbacks *cb; /* Callbacks registered for iterator. */ |
0f980a35 | 73 | }; |
dd2544fd | 74 | |
46322b33 MD |
75 | static inline |
76 | struct ctf_stream_pos *ctf_pos(struct stream_pos *pos) | |
77 | { | |
78 | return container_of(pos, struct ctf_stream_pos, parent); | |
79 | } | |
80 | ||
c5e74408 MD |
81 | int ctf_integer_read(struct stream_pos *pos, struct definition *definition); |
82 | int ctf_integer_write(struct stream_pos *pos, struct definition *definition); | |
83 | int ctf_float_read(struct stream_pos *pos, struct definition *definition); | |
84 | int ctf_float_write(struct stream_pos *pos, struct definition *definition); | |
85 | int ctf_string_read(struct stream_pos *pos, struct definition *definition); | |
86 | int ctf_string_write(struct stream_pos *pos, struct definition *definition); | |
87 | int ctf_enum_read(struct stream_pos *pos, struct definition *definition); | |
88 | int ctf_enum_write(struct stream_pos *pos, struct definition *definition); | |
89 | int ctf_struct_rw(struct stream_pos *pos, struct definition *definition); | |
90 | int ctf_variant_rw(struct stream_pos *pos, struct definition *definition); | |
81dee1bb MD |
91 | int ctf_array_read(struct stream_pos *pos, struct definition *definition); |
92 | int ctf_array_write(struct stream_pos *pos, struct definition *definition); | |
93 | int ctf_sequence_read(struct stream_pos *pos, struct definition *definition); | |
94 | int ctf_sequence_write(struct stream_pos *pos, struct definition *definition); | |
6dc2ca62 | 95 | |
20d0dcf9 | 96 | void ctf_packet_seek(struct stream_pos *pos, size_t index, int whence); |
0f980a35 | 97 | |
8563e754 | 98 | void ctf_init_pos(struct ctf_stream_pos *pos, int fd, int open_flags); |
46322b33 | 99 | void ctf_fini_pos(struct ctf_stream_pos *pos); |
0f980a35 MD |
100 | |
101 | /* | |
102 | * move_pos - move position of a relative bit offset | |
103 | * | |
104 | * TODO: allow larger files by updating base too. | |
105 | */ | |
106 | static inline | |
46322b33 | 107 | void ctf_move_pos(struct ctf_stream_pos *pos, size_t bit_offset) |
0f980a35 | 108 | { |
670977d3 | 109 | printf_debug("ctf_move_pos test EOF: %zd\n", pos->offset); |
90bf3cef | 110 | if (unlikely(pos->offset == EOF)) |
c5e74408 MD |
111 | return; |
112 | ||
8c572eba | 113 | if (pos->fd >= 0) { |
5f643ed7 | 114 | /* |
06789ffd | 115 | * PROT_READ ctf_packet_seek is called from within |
5f643ed7 MD |
116 | * ctf_pos_get_event so end of packet does not change |
117 | * the packet context on for the last event of the | |
118 | * packet. | |
119 | */ | |
120 | if ((pos->prot == PROT_WRITE) | |
90bf3cef | 121 | && (unlikely(pos->offset + bit_offset >= pos->packet_size))) { |
06789ffd | 122 | printf_debug("ctf_packet_seek (before call): %zd\n", |
670977d3 | 123 | pos->offset); |
20d0dcf9 | 124 | ctf_packet_seek(&pos->parent, 0, SEEK_CUR); |
06789ffd | 125 | printf_debug("ctf_packet_seek (after call): %zd\n", |
670977d3 | 126 | pos->offset); |
8c572eba MD |
127 | return; |
128 | } | |
129 | } | |
130 | pos->offset += bit_offset; | |
670977d3 | 131 | printf_debug("ctf_move_pos after increment: %zd\n", pos->offset); |
0f980a35 MD |
132 | } |
133 | ||
134 | /* | |
135 | * align_pos - align position on a bit offset (> 0) | |
136 | * | |
137 | * TODO: allow larger files by updating base too. | |
138 | */ | |
139 | static inline | |
46322b33 | 140 | void ctf_align_pos(struct ctf_stream_pos *pos, size_t bit_offset) |
0f980a35 | 141 | { |
46322b33 | 142 | ctf_move_pos(pos, offset_align(pos->offset, bit_offset)); |
0f980a35 MD |
143 | } |
144 | ||
145 | static inline | |
46322b33 | 146 | char *ctf_get_pos_addr(struct ctf_stream_pos *pos) |
0f980a35 MD |
147 | { |
148 | /* Only makes sense to get the address after aligning on CHAR_BIT */ | |
149 | assert(!(pos->offset % CHAR_BIT)); | |
aee35fcc | 150 | return mmap_align_addr(pos->base_mma) + (pos->offset / CHAR_BIT); |
0f980a35 MD |
151 | } |
152 | ||
8c572eba | 153 | static inline |
46322b33 | 154 | void ctf_dummy_pos(struct ctf_stream_pos *pos, struct ctf_stream_pos *dummy) |
8c572eba | 155 | { |
46322b33 | 156 | memcpy(dummy, pos, sizeof(struct ctf_stream_pos)); |
8c572eba MD |
157 | dummy->dummy = 1; |
158 | dummy->fd = -1; | |
159 | } | |
160 | ||
161 | /* | |
162 | * Check if current packet can hold data. | |
163 | * Returns 0 for success, negative error otherwise. | |
164 | */ | |
165 | static inline | |
46322b33 | 166 | int ctf_pos_packet(struct ctf_stream_pos *dummy) |
8c572eba | 167 | { |
90bf3cef | 168 | if (unlikely(dummy->offset > dummy->packet_size)) |
8c572eba MD |
169 | return -ENOSPC; |
170 | return 0; | |
171 | } | |
172 | ||
173 | static inline | |
46322b33 | 174 | void ctf_pos_pad_packet(struct ctf_stream_pos *pos) |
8c572eba | 175 | { |
46322b33 | 176 | ctf_move_pos(pos, pos->packet_size - pos->offset); |
8c572eba MD |
177 | } |
178 | ||
c5e74408 MD |
179 | static inline |
180 | int ctf_pos_access_ok(struct ctf_stream_pos *pos, size_t bit_len) | |
181 | { | |
90bf3cef | 182 | if (unlikely(pos->offset == EOF)) |
c5e74408 | 183 | return 0; |
90bf3cef | 184 | if (unlikely(pos->offset + bit_len > pos->packet_size)) |
c5e74408 MD |
185 | return 0; |
186 | return 1; | |
187 | } | |
188 | ||
5f643ed7 MD |
189 | /* |
190 | * Update the stream position for to the current event. This moves to | |
191 | * the next packet if we are located at the end of the current packet. | |
192 | */ | |
193 | static inline | |
194 | void ctf_pos_get_event(struct ctf_stream_pos *pos) | |
195 | { | |
196 | assert(pos->offset <= pos->content_size); | |
197 | if (pos->offset == pos->content_size) { | |
06789ffd | 198 | printf_debug("ctf_packet_seek (before call): %zd\n", |
5f643ed7 | 199 | pos->offset); |
06789ffd MD |
200 | pos->packet_seek(&pos->parent, 0, SEEK_CUR); |
201 | printf_debug("ctf_packet_seek (after call): %zd\n", | |
5f643ed7 MD |
202 | pos->offset); |
203 | } | |
204 | } | |
205 | ||
9e88d150 | 206 | void ctf_print_timestamp(FILE *fp, struct ctf_stream_definition *stream, |
7d97fad9 MD |
207 | uint64_t timestamp); |
208 | ||
d79865b9 | 209 | #endif /* _BABELTRACE_CTF_TYPES_H */ |