Commit | Line | Data |
---|---|---|
273b65be JG |
1 | #ifndef BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H |
2 | #define BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H | |
3 | ||
4 | /* | |
5 | * BabelTrace - CTF Writer: Stream internal | |
6 | * | |
de9dd397 | 7 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
273b65be JG |
8 | * |
9 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
10 | * | |
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: | |
17 | * | |
18 | * The above copyright notice and this permission notice shall be included in | |
19 | * all copies or substantial portions of the Software. | |
20 | * | |
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 | |
27 | * SOFTWARE. | |
28 | */ | |
29 | ||
bc37ae52 | 30 | #include <babeltrace/ctf-ir/stream.h> |
83509119 | 31 | #include <babeltrace/object-internal.h> |
273b65be JG |
32 | #include <babeltrace/ctf-writer/clock.h> |
33 | #include <babeltrace/ctf-writer/event-fields.h> | |
34 | #include <babeltrace/ctf-writer/event-types.h> | |
dc3fffef | 35 | #include <babeltrace/ctf-writer/serialize-internal.h> |
273b65be | 36 | #include <babeltrace/babeltrace-internal.h> |
f6ccaed9 | 37 | #include <babeltrace/assert-internal.h> |
273b65be JG |
38 | #include <glib.h> |
39 | ||
3230ee6b PP |
40 | struct bt_port; |
41 | struct bt_component; | |
42 | ||
50842bdc PP |
43 | typedef void (*bt_stream_destroy_listener_func)( |
44 | struct bt_stream *stream, void *data); | |
3230ee6b | 45 | |
50842bdc PP |
46 | struct bt_stream_destroy_listener { |
47 | bt_stream_destroy_listener_func func; | |
3230ee6b PP |
48 | void *data; |
49 | }; | |
50 | ||
50842bdc | 51 | struct bt_stream { |
83509119 | 52 | struct bt_object base; |
cfe11c58 | 53 | int64_t id; |
50842bdc | 54 | struct bt_stream_class *stream_class; |
0686ef94 | 55 | GString *name; |
50842bdc PP |
56 | struct bt_field *packet_header; |
57 | struct bt_field *packet_context; | |
0686ef94 | 58 | |
3230ee6b PP |
59 | /* |
60 | * When a notification which contains a reference to a stream | |
61 | * object (event notification, for example) is returned by the | |
62 | * "next" method of a sink or filter component's notification | |
63 | * iterator, it must NOT be returned by the "next" method of a | |
64 | * notification iterator which iterates on the notifications of | |
65 | * another output port of the same component. | |
66 | * | |
67 | * To ensure this, the stream object keeps a hash table which | |
68 | * indicates which port, for a given component, is currently | |
69 | * allowed to emit notifications which contain a reference to | |
70 | * this stream. | |
71 | * | |
72 | * This is a `struct bt_component *` to `struct bt_port *` hash | |
73 | * table. Both pointers are weak references because there's no | |
74 | * need to keep one or the other alive as far as this stream is | |
75 | * concerned. | |
76 | */ | |
77 | GHashTable *comp_cur_port; | |
78 | ||
0686ef94 | 79 | /* Writer-specific members. */ |
50842bdc | 80 | /* Array of pointers to bt_event for the current packet */ |
273b65be | 81 | GPtrArray *events; |
50842bdc | 82 | struct bt_stream_pos pos; |
273b65be | 83 | unsigned int flushed_packet_count; |
b3376dd9 | 84 | uint64_t discarded_events; |
0686ef94 | 85 | uint64_t size; |
2a03740b | 86 | uint64_t last_ts_end; |
3230ee6b | 87 | |
50842bdc | 88 | /* Array of struct bt_stream_destroy_listener */ |
3230ee6b | 89 | GArray *destroy_listeners; |
273b65be JG |
90 | }; |
91 | ||
273b65be | 92 | BT_HIDDEN |
50842bdc | 93 | int bt_stream_set_fd(struct bt_stream *stream, int fd); |
273b65be | 94 | |
3230ee6b | 95 | BT_HIDDEN |
50842bdc | 96 | void bt_stream_map_component_to_port(struct bt_stream *stream, |
3230ee6b PP |
97 | struct bt_component *comp, |
98 | struct bt_port *port); | |
99 | ||
100 | BT_HIDDEN | |
50842bdc | 101 | struct bt_port *bt_stream_port_for_component(struct bt_stream *stream, |
3230ee6b PP |
102 | struct bt_component *comp); |
103 | ||
104 | BT_HIDDEN | |
50842bdc PP |
105 | void bt_stream_add_destroy_listener(struct bt_stream *stream, |
106 | bt_stream_destroy_listener_func func, void *data); | |
3230ee6b PP |
107 | |
108 | BT_HIDDEN | |
50842bdc PP |
109 | void bt_stream_remove_destroy_listener(struct bt_stream *stream, |
110 | bt_stream_destroy_listener_func func, void *data); | |
3230ee6b | 111 | |
03be3bcd | 112 | static inline |
50842bdc PP |
113 | struct bt_stream_class *bt_stream_borrow_stream_class( |
114 | struct bt_stream *stream) | |
03be3bcd | 115 | { |
f6ccaed9 | 116 | BT_ASSERT(stream); |
03be3bcd PP |
117 | return stream->stream_class; |
118 | } | |
119 | ||
273b65be | 120 | #endif /* BABELTRACE_CTF_WRITER_STREAM_INTERNAL_H */ |