1 #ifndef BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_STREAM_H
2 #define BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_STREAM_H
5 * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #include "common/macros.h"
27 #include <babeltrace2/babeltrace.h>
28 #include "ctfser/ctfser.h"
33 #include "fs-sink-ctf-meta.h"
37 struct fs_sink_stream
{
38 bt_logging_level log_level
;
39 struct fs_sink_trace
*trace
;
40 struct bt_ctfser ctfser
;
42 /* Stream's file name */
46 const bt_stream
*ir_stream
;
48 struct fs_sink_ctf_stream_class
*sc
;
50 /* Current packet's state */
53 * True if we're, for this stream, within an opened
54 * packet (got a packet beginning message, but no
55 * packet end message yet).
60 * Current beginning default clock snapshot for the
61 * current packet (`UINT64_C(-1)` if not set).
63 uint64_t beginning_cs
;
66 * Current end default clock snapshot for the current
67 * packet (`UINT64_C(-1)` if not set).
72 * Current packet's content size (bits) for the current
75 uint64_t content_size
;
78 * Current packet's total size (bits) for the current
84 * Discarded events (free running) counter for the
87 uint64_t discarded_events_counter
;
89 /* Sequence number (free running) of the current packet */
93 * Offset of the packet context structure within the
94 * current packet (bits).
96 uint64_t context_offset_bits
;
99 * Owned by this; `NULL` if the current packet is closed
100 * or if the trace IR stream does not support packets.
102 const bt_packet
*packet
;
105 /* Previous packet's state */
107 /* End default clock snapshot (`UINT64_C(-1)` if not set) */
110 /* Discarded events (free running) counter */
111 uint64_t discarded_events_counter
;
113 /* Sequence number (free running) */
117 /* State to handle discarded events */
120 * True if we're in the time range given by a previously
121 * received discarded events message. In this case,
122 * `beginning_cs` and `end_cs` below contain the
123 * beginning and end clock snapshots for this range.
125 * This is used to validate that, when receiving a
126 * packet end message, the current discarded events time
127 * range matches what's expected for CTF 1.8, that is:
129 * * Its beginning time is the previous packet's end
130 * time (or the current packet's beginning time if
131 * this is the first packet).
133 * * Its end time is the current packet's end time.
138 * Beginning and end times of the time range given by a
139 * previously received discarded events message.
141 uint64_t beginning_cs
;
143 } discarded_events_state
;
145 /* State to handle discarded packets */
148 * True if we're in the time range given by a previously
149 * received discarded packets message. In this case,
150 * `beginning_cs` and `end_cs` below contain the
151 * beginning and end clock snapshots for this range.
153 * This is used to validate that, when receiving a
154 * packet beginning message, the current discarded
155 * packets time range matches what's expected for CTF
158 * * Its beginning time is the previous packet's end
161 * * Its end time is the current packet's beginning
167 * Beginning and end times of the time range given by a
168 * previously received discarded packets message.
170 uint64_t beginning_cs
;
172 } discarded_packets_state
;
176 struct fs_sink_stream
*fs_sink_stream_create(struct fs_sink_trace
*trace
,
177 const bt_stream
*ir_stream
);
180 void fs_sink_stream_destroy(struct fs_sink_stream
*stream
);
183 int fs_sink_stream_write_event(struct fs_sink_stream
*stream
,
184 const bt_clock_snapshot
*cs
, const bt_event
*event
,
185 struct fs_sink_ctf_event_class
*ec
);
188 int fs_sink_stream_open_packet(struct fs_sink_stream
*stream
,
189 const bt_clock_snapshot
*cs
, const bt_packet
*packet
);
192 int fs_sink_stream_close_packet(struct fs_sink_stream
*stream
,
193 const bt_clock_snapshot
*cs
);
195 #endif /* BABELTRACE_PLUGIN_CTF_FS_SINK_FS_SINK_STREAM_H */