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>
42 #include <babeltrace/error.h>
44 #define LAST_OFFSET_POISON ((int64_t) ~0ULL)
46 struct bt_stream_callbacks
;
48 struct packet_index_time
{
49 uint64_t timestamp_begin
;
50 uint64_t timestamp_end
;
54 off_t offset
; /* offset of the packet in the file, in bytes */
55 int64_t data_offset
; /* offset of data within the packet, in bits */
56 uint64_t packet_size
; /* packet size, in bits */
57 uint64_t content_size
; /* content size, in bits */
58 uint64_t events_discarded
;
59 uint64_t events_discarded_len
; /* length of the field, in bits */
60 struct packet_index_time ts_cycles
; /* timestamp in cycles */
61 struct packet_index_time ts_real
; /* realtime timestamp */
62 /* CTF_INDEX 1.0 limit */
63 uint64_t stream_instance_id
; /* ID of the channel instance */
64 uint64_t packet_seq_num
; /* packet sequence number */
68 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
70 struct ctf_stream_pos
{
71 struct bt_stream_pos parent
;
72 int fd
; /* backing file fd. -1 if unset. */
73 FILE *index_fp
; /* backing index file fp. NULL if unset. */
74 GArray
*packet_index
; /* contains struct packet_index */
75 int prot
; /* mmap protection */
76 int flags
; /* mmap flags */
78 /* Current position */
79 off_t mmap_offset
; /* mmap offset in the file, in bytes */
80 off_t mmap_base_offset
; /* offset of start of packet in mmap, in bytes */
81 uint64_t packet_size
; /* current packet size, in bits */
82 uint64_t content_size
; /* current content size, in bits */
83 uint64_t *content_size_loc
; /* pointer to current content size */
84 struct mmap_align
*base_mma
;/* mmap base address */
85 int64_t offset
; /* offset from base, in bits. EOF for end of file. */
86 int64_t last_offset
; /* offset before the last read_event */
87 int64_t data_offset
; /* offset of data in current packet */
88 uint64_t cur_index
; /* current index in packet index */
89 uint64_t last_events_discarded
; /* last known amount of event discarded */
90 void (*packet_seek
)(struct bt_stream_pos
*pos
, size_t index
,
91 int whence
); /* function called to switch packet */
93 int dummy
; /* dummy position, for length calculation */
94 struct bt_stream_callbacks
*cb
; /* Callbacks registered for iterator. */
95 size_t file_length
; /* length of backing file, in bytes. */
100 struct ctf_stream_pos
*ctf_pos(struct bt_stream_pos
*pos
)
102 return container_of(pos
, struct ctf_stream_pos
, parent
);
106 int ctf_integer_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
108 int ctf_integer_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
110 int ctf_float_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
112 int ctf_float_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
114 int ctf_string_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
116 int ctf_string_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
118 int ctf_enum_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
120 int ctf_enum_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
122 int ctf_struct_rw(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
124 int ctf_variant_rw(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
126 int ctf_array_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
128 int ctf_array_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
130 int ctf_sequence_read(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
132 int ctf_sequence_write(struct bt_stream_pos
*pos
, struct bt_definition
*definition
);
134 void ctf_packet_seek(struct bt_stream_pos
*pos
, size_t index
, int whence
);
136 int ctf_init_pos(struct ctf_stream_pos
*pos
, struct bt_trace_descriptor
*trace
,
137 int fd
, int open_flags
);
138 int ctf_fini_pos(struct ctf_stream_pos
*pos
);
141 int ctf_pos_access_ok(struct ctf_stream_pos
*pos
, uint64_t bit_len
)
145 if (unlikely(pos
->offset
== EOF
))
147 if (pos
->prot
== PROT_READ
) {
149 * Reads may only reach up to the "content_size",
150 * regardless of the packet_size.
152 max_len
= pos
->content_size
;
154 /* Writes may take place up to the end of the packet. */
155 max_len
= pos
->packet_size
;
157 if (unlikely(pos
->offset
+ bit_len
> max_len
))
163 * move_pos - move position of a relative bit offset
165 * Return 1 if OK, 0 if out-of-bound.
167 * TODO: allow larger files by updating base too.
170 int ctf_move_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
174 printf_debug("ctf_move_pos test EOF: %" PRId64
"\n", pos
->offset
);
175 ret
= ctf_pos_access_ok(pos
, bit_offset
);
179 pos
->offset
+= bit_offset
;
180 printf_debug("ctf_move_pos after increment: %" PRId64
"\n", pos
->offset
);
186 * align_pos - align position on a bit offset (> 0)
188 * Return 1 if OK, 0 if out-of-bound.
190 * TODO: allow larger files by updating base too.
193 int ctf_align_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
195 return ctf_move_pos(pos
, offset_align(pos
->offset
, bit_offset
));
199 char *ctf_get_pos_addr(struct ctf_stream_pos
*pos
)
201 /* Only makes sense to get the address after aligning on CHAR_BIT */
202 assert(!(pos
->offset
% CHAR_BIT
));
203 return mmap_align_addr(pos
->base_mma
) +
204 pos
->mmap_base_offset
+ (pos
->offset
/ CHAR_BIT
);
208 void ctf_dummy_pos(struct ctf_stream_pos
*pos
, struct ctf_stream_pos
*dummy
)
210 memcpy(dummy
, pos
, sizeof(struct ctf_stream_pos
));
216 * Check if current packet can hold data.
217 * Returns 0 for success, negative error otherwise.
220 int ctf_pos_packet(struct ctf_stream_pos
*dummy
)
222 if (unlikely(dummy
->offset
> dummy
->packet_size
))
228 int ctf_pos_pad_packet(struct ctf_stream_pos
*pos
)
230 ctf_packet_seek(&pos
->parent
, 0, SEEK_CUR
);
231 return bt_packet_seek_get_error();
235 * Update the stream position to the current event. This moves to
236 * the next packet if we are located at the end of the current packet.
239 int ctf_pos_get_event(struct ctf_stream_pos
*pos
)
243 assert(pos
->offset
<= pos
->content_size
);
244 if (pos
->offset
== pos
->content_size
) {
245 printf_debug("ctf_packet_seek (before call): %" PRId64
"\n",
247 pos
->packet_seek(&pos
->parent
, 0, SEEK_CUR
);
248 printf_debug("ctf_packet_seek (after call): %" PRId64
"\n",
250 ret
= bt_packet_seek_get_error();
255 void ctf_print_timestamp(FILE *fp
, struct ctf_stream_definition
*stream
,
257 int ctf_append_trace_metadata(struct bt_trace_descriptor
*tdp
,
259 void ctf_print_discarded_lost(FILE *fp
, struct ctf_stream_definition
*stream
);
261 #endif /* _BABELTRACE_CTF_TYPES_H */