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.
22 #include <babeltrace/types.h>
23 #include <babeltrace/babeltrace-internal.h>
24 #include <sys/types.h>
33 #include <babeltrace/mmap-align.h>
35 #define LAST_OFFSET_POISON ((int64_t) ~0ULL)
37 struct bt_stream_callbacks
;
40 off_t offset
; /* offset of the packet in the file, in bytes */
41 int64_t data_offset
; /* offset of data within the packet, in bits */
42 uint64_t packet_size
; /* packet size, in bits */
43 uint64_t content_size
; /* content size, in bits */
44 uint64_t timestamp_begin
;
45 uint64_t timestamp_end
;
46 uint64_t events_discarded
;
47 uint64_t events_discarded_len
; /* length of the field, in bits */
51 * Always update ctf_stream_pos with ctf_move_pos and ctf_init_pos.
53 struct ctf_stream_pos
{
54 struct stream_pos parent
;
55 int fd
; /* backing file fd. -1 if unset. */
56 GArray
*packet_cycles_index
; /* contains struct packet_index in cycles */
57 GArray
*packet_real_index
; /* contains struct packet_index in ns */
58 int prot
; /* mmap protection */
59 int flags
; /* mmap flags */
61 /* Current position */
62 off_t mmap_offset
; /* mmap offset in the file, in bytes */
63 off_t mmap_base_offset
; /* offset of start of packet in mmap, in bytes */
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 */
67 struct mmap_align
*base_mma
;/* mmap base address */
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 */
71 uint64_t last_events_discarded
; /* last known amount of event discarded */
72 void (*packet_seek
)(struct stream_pos
*pos
, size_t index
,
73 int whence
); /* function called to switch packet */
75 int dummy
; /* dummy position, for length calculation */
76 struct bt_stream_callbacks
*cb
; /* Callbacks registered for iterator. */
80 struct ctf_stream_pos
*ctf_pos(struct stream_pos
*pos
)
82 return container_of(pos
, struct ctf_stream_pos
, parent
);
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
);
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
);
100 void ctf_packet_seek(struct stream_pos
*pos
, size_t index
, int whence
);
102 void ctf_init_pos(struct ctf_stream_pos
*pos
, int fd
, int open_flags
);
103 void ctf_fini_pos(struct ctf_stream_pos
*pos
);
106 * move_pos - move position of a relative bit offset
108 * TODO: allow larger files by updating base too.
111 void ctf_move_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
113 printf_debug("ctf_move_pos test EOF: %" PRId64
"\n", pos
->offset
);
114 if (unlikely(pos
->offset
== EOF
))
119 * PROT_READ ctf_packet_seek is called from within
120 * ctf_pos_get_event so end of packet does not change
121 * the packet context on for the last event of the
124 if ((pos
->prot
== PROT_WRITE
)
125 && (unlikely(pos
->offset
+ bit_offset
>= pos
->packet_size
))) {
126 printf_debug("ctf_packet_seek (before call): %" PRId64
"\n",
128 ctf_packet_seek(&pos
->parent
, 0, SEEK_CUR
);
129 printf_debug("ctf_packet_seek (after call): %" PRId64
"\n",
134 pos
->offset
+= bit_offset
;
135 printf_debug("ctf_move_pos after increment: %" PRId64
"\n", pos
->offset
);
139 * align_pos - align position on a bit offset (> 0)
141 * TODO: allow larger files by updating base too.
144 void ctf_align_pos(struct ctf_stream_pos
*pos
, uint64_t bit_offset
)
146 ctf_move_pos(pos
, offset_align(pos
->offset
, bit_offset
));
150 char *ctf_get_pos_addr(struct ctf_stream_pos
*pos
)
152 /* Only makes sense to get the address after aligning on CHAR_BIT */
153 assert(!(pos
->offset
% CHAR_BIT
));
154 return mmap_align_addr(pos
->base_mma
) +
155 pos
->mmap_base_offset
+ (pos
->offset
/ CHAR_BIT
);
159 void ctf_dummy_pos(struct ctf_stream_pos
*pos
, struct ctf_stream_pos
*dummy
)
161 memcpy(dummy
, pos
, sizeof(struct ctf_stream_pos
));
167 * Check if current packet can hold data.
168 * Returns 0 for success, negative error otherwise.
171 int ctf_pos_packet(struct ctf_stream_pos
*dummy
)
173 if (unlikely(dummy
->offset
> dummy
->packet_size
))
179 void ctf_pos_pad_packet(struct ctf_stream_pos
*pos
)
181 ctf_move_pos(pos
, pos
->packet_size
- pos
->offset
);
185 int ctf_pos_access_ok(struct ctf_stream_pos
*pos
, uint64_t bit_len
)
187 if (unlikely(pos
->offset
== EOF
))
189 if (unlikely(pos
->offset
+ bit_len
> pos
->packet_size
))
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.
199 void ctf_pos_get_event(struct ctf_stream_pos
*pos
)
201 assert(pos
->offset
<= pos
->content_size
);
202 if (pos
->offset
== pos
->content_size
) {
203 printf_debug("ctf_packet_seek (before call): %" PRId64
"\n",
205 pos
->packet_seek(&pos
->parent
, 0, SEEK_CUR
);
206 printf_debug("ctf_packet_seek (after call): %" PRId64
"\n",
211 void ctf_print_timestamp(FILE *fp
, struct ctf_stream_definition
*stream
,
214 #endif /* _BABELTRACE_CTF_TYPES_H */
This page took 0.039165 seconds and 5 git commands to generate.