1 #ifndef _BABELTRACE_CTF_TYPES_H
2 #define _BABELTRACE_CTF_TYPES_H
9 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <babeltrace/types.h>
31 #include <babeltrace/babeltrace-internal.h>
32 #include <sys/types.h>
41 #include <babeltrace/mmap-align.h>
43 #define LAST_OFFSET_POISON ((int64_t) ~0ULL)
45 struct bt_stream_callbacks
;
47 struct packet_index_time
{
48 uint64_t timestamp_begin
;
49 uint64_t timestamp_end
;
53 off_t offset
; /* offset of the packet in the file, in bytes */
54 int64_t data_offset
; /* offset of data within the packet, in bits */
55 uint64_t packet_size
; /* packet size, in bits */
56 uint64_t content_size
; /* content size, in bits */
57 uint64_t events_discarded
;
58 uint64_t events_discarded_len
; /* length of the field, in bits */
59 struct packet_index_time ts_cycles
; /* timestamp in cycles */
60 struct packet_index_time ts_real
; /* realtime timestamp */
64 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
66 struct ctf_stream_pos
{
67 struct bt_stream_pos parent
;
68 int fd
; /* backing file fd. -1 if unset. */
69 FILE *index_fp
; /* backing index file fp. NULL if unset. */
70 GArray
*packet_index
; /* contains struct packet_index */
71 int prot
; /* mmap protection */
72 int flags
; /* mmap flags */
74 /* Current position */
75 off_t mmap_offset
; /* mmap offset in the file, in bytes */
76 off_t mmap_base_offset
; /* offset of start of packet in mmap, in bytes */
77 uint64_t packet_size
; /* current packet size, in bits */
78 uint64_t content_size
; /* current content size, in bits */
79 uint64_t *content_size_loc
; /* pointer to current content size */
80 struct mmap_align
*base_mma
;/* mmap base address */
81 int64_t offset
; /* offset from base, in bits. EOF for end of file. */
82 int64_t last_offset
; /* offset before the last read_event */
83 int64_t data_offset
; /* offset of data in current packet */
84 uint64_t cur_index
; /* current index in packet index */
85 uint64_t last_events_discarded
; /* last known amount of event discarded */
86 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
87 int whence
); /* function called to switch packet */
89 int dummy
; /* dummy position, for length calculation */
90 struct bt_stream_callbacks
*cb
; /* Callbacks registered for iterator. */
95 struct ctf_stream_pos
*ctf_pos(struct bt_stream_pos
*pos
)
97 return container_of(pos
, struct ctf_stream_pos
, parent
);
101 int ctf_integer_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
103 int ctf_integer_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
105 int ctf_float_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
107 int ctf_float_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
109 int ctf_string_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
111 int ctf_string_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
113 int ctf_enum_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
115 int ctf_enum_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
117 int ctf_struct_rw(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
119 int ctf_variant_rw(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
121 int ctf_array_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
123 int ctf_array_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
125 int ctf_sequence_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
127 int ctf_sequence_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
129 void ctf_packet_seek(struct bt_stream_pos
*pos
, size_t index
, int whence
);
131 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
132 int fd
, int open_flags
);
133 int ctf_fini_pos(struct ctf_stream_pos
*pos
);
136 * move_pos - move position of a relative bit offset
138 * Return 1 if OK, 0 if out-of-bound.
140 * TODO: allow larger files by updating base too.
143 int ctf_move_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
147 printf_debug("ctf_move_pos test EOF: %" PRId64
"\n", pos
->offset
);
148 if (unlikely(pos
->offset
== EOF
))
150 if (pos
->prot
== PROT_READ
)
151 max_len
= pos
->content_size
;
153 max_len
= pos
->packet_size
;
154 if (unlikely(pos
->offset
+ bit_offset
> max_len
))
157 pos
->offset
+= bit_offset
;
158 printf_debug("ctf_move_pos after increment: %" PRId64
"\n", pos
->offset
);
163 * align_pos - align position on a bit offset (> 0)
165 * Return 1 if OK, 0 if out-of-bound.
167 * TODO: allow larger files by updating base too.
170 int ctf_align_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
172 return ctf_move_pos(pos
, offset_align(pos
->offset
, bit_offset
));
176 char *ctf_get_pos_addr(struct ctf_stream_pos
*pos
)
178 /* Only makes sense to get the address after aligning on CHAR_BIT */
179 assert(!(pos
->offset
% CHAR_BIT
));
180 return mmap_align_addr(pos
->base_mma
) +
181 pos
->mmap_base_offset
+ (pos
->offset
/ CHAR_BIT
);
185 void ctf_dummy_pos(struct ctf_stream_pos
*pos
, struct ctf_stream_pos
*dummy
)
187 memcpy(dummy
, pos
, sizeof(struct ctf_stream_pos
));
193 * Check if current packet can hold data.
194 * Returns 0 for success, negative error otherwise.
197 int ctf_pos_packet(struct ctf_stream_pos
*dummy
)
199 if (unlikely(dummy
->offset
> dummy
->packet_size
))
205 void ctf_pos_pad_packet(struct ctf_stream_pos
*pos
)
207 ctf_packet_seek(&pos
->parent
, 0, SEEK_CUR
);
211 int ctf_pos_access_ok(struct ctf_stream_pos
*pos
, uint64_t bit_len
)
215 if (unlikely(pos
->offset
== EOF
))
217 if (pos
->prot
== PROT_READ
)
218 max_len
= pos
->content_size
;
220 max_len
= pos
->packet_size
;
221 if (unlikely(pos
->offset
+ bit_len
> max_len
))
227 * Update the stream position to the current event. This moves to
228 * the next packet if we are located at the end of the current packet.
231 void ctf_pos_get_event(struct ctf_stream_pos
*pos
)
233 assert(pos
->offset
<= pos
->content_size
);
234 if (pos
->offset
== pos
->content_size
) {
235 printf_debug("ctf_packet_seek (before call): %" PRId64
"\n",
237 pos
->packet_seek(&pos
->parent
, 0, SEEK_CUR
);
238 printf_debug("ctf_packet_seek (after call): %" PRId64
"\n",
243 void ctf_print_timestamp(FILE *fp
, struct ctf_stream_definition
*stream
,
246 #endif /* _BABELTRACE_CTF_TYPES_H */