1 #ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
2 #define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H
5 * BabelTrace - CTF Writer: Stream internal
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Author: Jérémie Galarneau <jeremie.galarneau@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/ctf-ir/stream.h>
31 #include <babeltrace/object-internal.h>
32 #include <babeltrace/ctf-writer/clock.h>
33 #include <babeltrace/ctf-writer/event-fields.h>
34 #include <babeltrace/ctf-writer/event-types.h>
35 #include <babeltrace/babeltrace-internal.h>
36 #include <babeltrace/ctf/types.h>
39 struct bt_ctf_stream
{
40 struct bt_object base
;
42 struct bt_ctf_stream_class
*stream_class
;
43 /* Array of pointers to bt_ctf_event for the current packet */
45 struct ctf_stream_pos pos
;
46 unsigned int flushed_packet_count
;
48 struct bt_ctf_field
*packet_header
;
49 struct bt_ctf_field
*packet_context
;
50 GHashTable
*clock_values
; /* Maps clock addresses to (uint64_t *) */
54 int bt_ctf_stream_set_fd(struct bt_ctf_stream
*stream
, int fd
);
57 void bt_ctf_stream_update_clock_value(struct bt_ctf_stream
*stream
,
58 struct bt_ctf_field
*value_field
);
61 const char *bt_ctf_stream_get_name(struct bt_ctf_stream
*stream
);
64 struct bt_ctf_stream
*bt_ctf_stream_create(
65 struct bt_ctf_stream_class
*stream_class
,
69 * bt_ctf_stream_get_discarded_events_count: get the number of discarded
70 * events associated with this stream.
72 * Note that discarded events are not stored if the stream's packet
73 * context has no "events_discarded" field. An error will be returned
76 * @param stream Stream instance.
78 * Returns the number of discarded events, a negative value on error.
81 int bt_ctf_stream_get_discarded_events_count(
82 struct bt_ctf_stream
*stream
, uint64_t *count
);
85 * bt_ctf_stream_get_stream_class: get a stream's class.
87 * @param stream Stream instance.
89 * Returns the stream's class, NULL on error.
92 struct bt_ctf_stream_class
*bt_ctf_stream_get_class(
93 struct bt_ctf_stream
*stream
);
96 * bt_ctf_stream_get_packet_header: get a stream's packet header.
98 * @param stream Stream instance.
100 * Returns a field instance on success, NULL on error.
103 struct bt_ctf_field
*bt_ctf_stream_get_packet_header(
104 struct bt_ctf_stream
*stream
);
107 * bt_ctf_stream_set_packet_header: set a stream's packet header.
109 * The packet header's type must match the trace's packet header
112 * @param stream Stream instance.
113 * @param packet_header Packet header instance.
115 * Returns a field instance on success, NULL on error.
118 int bt_ctf_stream_set_packet_header(struct bt_ctf_stream
*stream
,
119 struct bt_ctf_field
*packet_header
);
122 * bt_ctf_stream_set_packet_context: set a stream's packet context.
124 * The packet context's type must match the stream class' packet
127 * @param stream Stream instance.
128 * @param packet_context Packet context field instance.
130 * Returns a field instance on success, NULL on error.
133 int bt_ctf_stream_set_packet_context(struct bt_ctf_stream
*stream
,
134 struct bt_ctf_field
*packet_context
);
137 #endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */
This page took 0.035522 seconds and 5 git commands to generate.