lib: add aliases for Babeltrace structure types
[babeltrace.git] / include / babeltrace / trace-ir / packet-const.h
CommitLineData
40f4ba76
PP
1#ifndef BABELTRACE_TRACE_IR_PACKET_CONST_H
2#define BABELTRACE_TRACE_IR_PACKET_CONST_H
3
4/*
e2f7325d 5 * Copyright 2016-2018 Philippe Proulx <pproulx@efficios.com>
40f4ba76
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
31/* For enum bt_property_availability */
32#include <babeltrace/property.h>
33
34/* For enum bt_clock_value_status */
35#include <babeltrace/trace-ir/clock-value-const.h>
36
b19ff26f
PP
37/*
38 * For bt_packet, bt_packet_header_field, bt_packet_context_field,
39 * bt_stream, bt_clock_value
40 */
41#include <babeltrace/types.h>
42
40f4ba76
PP
43#ifdef __cplusplus
44extern "C" {
45#endif
46
b19ff26f
PP
47extern const bt_stream *bt_packet_borrow_stream_const(
48 const bt_packet *packet);
40f4ba76
PP
49
50extern
b19ff26f
PP
51const bt_field *bt_packet_borrow_header_field_const(
52 const bt_packet *packet);
40f4ba76
PP
53
54extern
b19ff26f
PP
55const bt_field *bt_packet_borrow_context_field_const(
56 const bt_packet *packet);
40f4ba76
PP
57
58extern
59enum bt_clock_value_status bt_packet_borrow_default_beginning_clock_value_const(
b19ff26f
PP
60 const bt_packet *packet,
61 const bt_clock_value **clock_value);
40f4ba76
PP
62
63extern
64enum bt_clock_value_status bt_packet_borrow_default_end_clock_valeu_const(
b19ff26f
PP
65 const bt_packet *packet,
66 const bt_clock_value **clock_value);
40f4ba76
PP
67
68extern
69enum bt_property_availability bt_packet_get_discarded_event_counter_snapshot(
b19ff26f 70 const bt_packet *packet, uint64_t *value);
40f4ba76
PP
71
72extern
73enum bt_property_availability bt_packet_get_packet_counter_snapshot(
b19ff26f 74 const bt_packet *packet, uint64_t *value);
40f4ba76 75
b19ff26f 76extern void bt_packet_get_ref(const bt_packet *packet);
c5b9b441 77
b19ff26f 78extern void bt_packet_put_ref(const bt_packet *packet);
c5b9b441
PP
79
80#define BT_PACKET_PUT_REF_AND_RESET(_var) \
81 do { \
82 bt_packet_put_ref(_var); \
83 (_var) = NULL; \
84 } while (0)
85
86#define BT_PACKET_MOVE_REF(_var_dst, _var_src) \
87 do { \
88 bt_packet_put_ref(_var_dst); \
89 (_var_dst) = (_var_src); \
90 (_var_src) = NULL; \
91 } while (0)
92
40f4ba76
PP
93#ifdef __cplusplus
94}
95#endif
96
97#endif /* BABELTRACE_TRACE_IR_PACKET_CONST_H */
This page took 0.02833 seconds and 4 git commands to generate.