include/babeltrace/trace-ir/private-packet.h

   1 #ifndef BABELTRACE_TRACE_IR_PRIVATE_PACKET_H
   2 #define BABELTRACE_TRACE_IR_PRIVATE_PACKET_H
   3
   4 /*
   5  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   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 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct bt_packet;
  36 struct bt_private_packet;
  37 struct bt_private_packet_header_field;
  38 struct bt_private_packet_context_field;
  39 struct bt_private_stream;
  40
  41 static inline
  42 struct bt_packet *bt_private_packet_as_packet(
  43                 struct bt_private_packet *priv_packet)
  44 {
  45         return (void *) priv_packet;
  46 }
  47
  48 extern struct bt_private_packet *bt_private_packet_create(
  49                 struct bt_private_stream *stream);
  50
  51 extern struct bt_private_stream *bt_private_packet_borrow_stream(
  52                 struct bt_private_packet *packet);
  53
  54 extern
  55 struct bt_private_field *bt_private_packet_borrow_header_field(
  56                 struct bt_private_packet *packet);
  57
  58 extern
  59 int bt_private_packet_move_header_field(
  60                 struct bt_private_packet *packet,
  61                 struct bt_private_packet_header_field *header);
  62
  63 extern
  64 struct bt_private_field *bt_private_packet_borrow_context_field(
  65                 struct bt_private_packet *packet);
  66
  67 extern
  68 int bt_private_packet_move_context_field(
  69                 struct bt_private_packet *packet,
  70                 struct bt_private_packet_context_field *context);
  71
  72 extern
  73 void bt_private_packet_set_default_beginning_clock_value(
  74                 struct bt_private_packet *packet, uint64_t value_cycles);
  75
  76 extern
  77 void bt_private_packet_set_default_end_clock_value(
  78                 struct bt_private_packet *packet, uint64_t value_cycles);
  79
  80 extern
  81 void bt_private_packet_set_discarded_event_counter_snapshot(
  82                 struct bt_private_packet *packet, uint64_t value);
  83
  84 extern
  85 void bt_private_packet_set_packet_counter_snapshot(
  86                 struct bt_private_packet *packet, uint64_t value);
  87
  88 #ifdef __cplusplus
  89 }
  90 #endif
  91
  92 #endif /* BABELTRACE_TRACE_IR_PRIVATE_PACKET_H */