Commit | Line | Data |
---|---|---|
dadf29b9 PP |
1 | #ifndef BABELTRACE_TRACE_IR_PACKET_CONST_H |
2 | #define BABELTRACE_TRACE_IR_PACKET_CONST_H | |
3 | ||
4 | /* | |
0554db57 | 5 | * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com> |
dadf29b9 PP |
6 | * |
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: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
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 | |
23 | * SOFTWARE. | |
24 | * | |
25 | * The Common Trace Format (CTF) Specification is available at | |
26 | * http://www.efficios.com/ctf | |
27 | */ | |
28 | ||
29 | #include <stdint.h> | |
30 | ||
b7c5b62e | 31 | /* For bt_property_availability */ |
dadf29b9 PP |
32 | #include <babeltrace/property.h> |
33 | ||
b7c5b62e | 34 | /* For bt_clock_snapshot_state */ |
b1824349 | 35 | #include <babeltrace/trace-ir/clock-snapshot-const.h> |
dadf29b9 | 36 | |
b9879703 PP |
37 | /* |
38 | * For bt_packet, bt_packet_header_field, bt_packet_context_field, | |
b1824349 | 39 | * bt_stream, bt_clock_snapshot |
b9879703 PP |
40 | */ |
41 | #include <babeltrace/types.h> | |
42 | ||
dadf29b9 PP |
43 | #ifdef __cplusplus |
44 | extern "C" { | |
45 | #endif | |
46 | ||
b7c5b62e | 47 | typedef enum bt_packet_status { |
486aff8c PP |
48 | BT_PACKET_STATUS_OK = 0, |
49 | BT_PACKET_STATUS_NOMEM = -12, | |
b7c5b62e | 50 | } bt_packet_status; |
486aff8c | 51 | |
b9879703 PP |
52 | extern const bt_stream *bt_packet_borrow_stream_const( |
53 | const bt_packet *packet); | |
dadf29b9 PP |
54 | |
55 | extern | |
b9879703 PP |
56 | const bt_field *bt_packet_borrow_header_field_const( |
57 | const bt_packet *packet); | |
dadf29b9 PP |
58 | |
59 | extern | |
b9879703 PP |
60 | const bt_field *bt_packet_borrow_context_field_const( |
61 | const bt_packet *packet); | |
dadf29b9 PP |
62 | |
63 | extern | |
b7c5b62e | 64 | bt_clock_snapshot_state bt_packet_borrow_default_beginning_clock_snapshot_const( |
b9879703 | 65 | const bt_packet *packet, |
b1824349 | 66 | const bt_clock_snapshot **clock_snapshot); |
dadf29b9 PP |
67 | |
68 | extern | |
b7c5b62e | 69 | bt_clock_snapshot_state bt_packet_borrow_default_end_clock_snapshot_const( |
b9879703 | 70 | const bt_packet *packet, |
b1824349 | 71 | const bt_clock_snapshot **clock_snapshot); |
dadf29b9 PP |
72 | |
73 | extern | |
b7c5b62e | 74 | bt_property_availability bt_packet_get_discarded_event_counter_snapshot( |
b9879703 | 75 | const bt_packet *packet, uint64_t *value); |
dadf29b9 PP |
76 | |
77 | extern | |
b7c5b62e | 78 | bt_property_availability bt_packet_get_packet_counter_snapshot( |
b9879703 | 79 | const bt_packet *packet, uint64_t *value); |
dadf29b9 | 80 | |
b9879703 | 81 | extern void bt_packet_get_ref(const bt_packet *packet); |
317e35ec | 82 | |
b9879703 | 83 | extern void bt_packet_put_ref(const bt_packet *packet); |
317e35ec PP |
84 | |
85 | #define BT_PACKET_PUT_REF_AND_RESET(_var) \ | |
86 | do { \ | |
87 | bt_packet_put_ref(_var); \ | |
88 | (_var) = NULL; \ | |
89 | } while (0) | |
90 | ||
91 | #define BT_PACKET_MOVE_REF(_var_dst, _var_src) \ | |
92 | do { \ | |
93 | bt_packet_put_ref(_var_dst); \ | |
94 | (_var_dst) = (_var_src); \ | |
95 | (_var_src) = NULL; \ | |
96 | } while (0) | |
97 | ||
dadf29b9 PP |
98 | #ifdef __cplusplus |
99 | } | |
100 | #endif | |
101 | ||
102 | #endif /* BABELTRACE_TRACE_IR_PACKET_CONST_H */ |