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 int64_t timestamp_begin
;
49 int64_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 */
61 /* CTF_INDEX 1.0 limit */
62 uint64_t stream_instance_id
; /* ID of the channel instance */
63 uint64_t packet_seq_num
; /* packet sequence number */
67 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
69 struct ctf_stream_pos
{
70 struct bt_stream_pos parent
;
71 int fd
; /* backing file fd. -1 if unset. */
72 FILE *index_fp
; /* backing index file fp. NULL if unset. */
73 GArray
*packet_index
; /* contains struct packet_index */
74 int prot
; /* mmap protection */
75 int flags
; /* mmap flags */
77 /* Current position */
78 off_t mmap_offset
; /* mmap offset in the file, in bytes */
79 off_t mmap_base_offset
; /* offset of start of packet in mmap, in bytes */
80 uint64_t packet_size
; /* current packet size, in bits */
81 uint64_t content_size
; /* current content size, in bits */
82 uint64_t *content_size_loc
; /* pointer to current content size */
83 struct mmap_align
*base_mma
;/* mmap base address */
84 int64_t offset
; /* offset from base, in bits. EOF for end of file. */
85 int64_t last_offset
; /* offset before the last read_event */
86 int64_t data_offset
; /* offset of data in current packet */
87 uint64_t cur_index
; /* current index in packet index */
88 uint64_t last_events_discarded
; /* last known amount of event discarded */
89 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
90 int whence
); /* function called to switch packet */
92 int dummy
; /* dummy position, for length calculation */
93 struct bt_stream_callbacks
*cb
; /* Callbacks registered for iterator. */
98 struct ctf_stream_pos
*ctf_pos(struct bt_stream_pos
*pos
)
100 return container_of(pos
, struct ctf_stream_pos
, parent
);
104 int ctf_integer_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
106 int ctf_integer_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
108 int ctf_float_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
110 int ctf_float_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
112 int ctf_string_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
114 int ctf_string_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
116 int ctf_enum_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
118 int ctf_enum_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
120 int ctf_struct_rw(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
122 int ctf_variant_rw(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
124 int ctf_array_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
126 int ctf_array_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
128 int ctf_sequence_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
130 int ctf_sequence_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
132 void ctf_packet_seek(struct bt_stream_pos
*pos
, size_t index
, int whence
);
134 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
135 int fd
, int open_flags
);
136 int ctf_fini_pos(struct ctf_stream_pos
*pos
);
139 int ctf_pos_access_ok(struct ctf_stream_pos
*pos
, uint64_t bit_len
)
143 if (unlikely(pos
->offset
== EOF
))
145 if (pos
->prot
== PROT_READ
) {
147 * Reads may only reach up to the "content_size",
148 * regardless of the packet_size.
150 max_len
= pos
->content_size
;
152 /* Writes may take place up to the end of the packet. */
153 max_len
= pos
->packet_size
;
155 if (unlikely(pos
->offset
+ bit_len
> max_len
))
161 * move_pos - move position of a relative bit offset
163 * Return 1 if OK, 0 if out-of-bound.
165 * TODO: allow larger files by updating base too.
168 int ctf_move_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
172 printf_debug("ctf_move_pos test EOF: %" PRId64
"\n", pos
->offset
);
173 ret
= ctf_pos_access_ok(pos
, bit_offset
);
177 pos
->offset
+= bit_offset
;
178 printf_debug("ctf_move_pos after increment: %" PRId64
"\n", pos
->offset
);
184 * align_pos - align position on a bit offset (> 0)
186 * Return 1 if OK, 0 if out-of-bound.
188 * TODO: allow larger files by updating base too.
191 int ctf_align_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
193 return ctf_move_pos(pos
, offset_align(pos
->offset
, bit_offset
));
197 char *ctf_get_pos_addr(struct ctf_stream_pos
*pos
)
199 /* Only makes sense to get the address after aligning on CHAR_BIT */
200 assert(!(pos
->offset
% CHAR_BIT
));
201 return mmap_align_addr(pos
->base_mma
) +
202 pos
->mmap_base_offset
+ (pos
->offset
/ CHAR_BIT
);
206 void ctf_dummy_pos(struct ctf_stream_pos
*pos
, struct ctf_stream_pos
*dummy
)
208 memcpy(dummy
, pos
, sizeof(struct ctf_stream_pos
));
214 * Check if current packet can hold data.
215 * Returns 0 for success, negative error otherwise.
218 int ctf_pos_packet(struct ctf_stream_pos
*dummy
)
220 if (unlikely(dummy
->offset
> dummy
->packet_size
))
226 void ctf_pos_pad_packet(struct ctf_stream_pos
*pos
)
228 ctf_packet_seek(&pos
->parent
, 0, SEEK_CUR
);
232 * Update the stream position to the current event. This moves to
233 * the next packet if we are located at the end of the current packet.
236 void ctf_pos_get_event(struct ctf_stream_pos
*pos
)
238 assert(pos
->offset
<= pos
->content_size
);
239 if (pos
->offset
== pos
->content_size
) {
240 printf_debug("ctf_packet_seek (before call): %" PRId64
"\n",
242 pos
->packet_seek(&pos
->parent
, 0, SEEK_CUR
);
243 printf_debug("ctf_packet_seek (after call): %" PRId64
"\n",
248 void ctf_print_timestamp(FILE *fp
, struct ctf_stream_definition
*stream
,
250 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
253 #endif /* _BABELTRACE_CTF_TYPES_H */