src/lib/trace-ir/packet.h

   1 #ifndef BABELTRACE_TRACE_IR_PACKET_INTERNAL_H
   2 #define BABELTRACE_TRACE_IR_PACKET_INTERNAL_H
   3
   4 /*
   5  * Copyright 2016-2018 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
  26 #include <stdbool.h>
  27 #include "common/assert.h"
  28 #include <babeltrace2/trace-ir/clock-snapshot.h>
  29 #include <babeltrace2/trace-ir/packet.h>
  30 #include <babeltrace2/trace-ir/field.h>
  31 #include <babeltrace2/trace-ir/stream.h>
  32 #include "lib/object.h"
  33 #include "common/macros.h"
  34 #include "lib/property.h"
  35
  36 #include "field-wrapper.h"
  37
  38 struct bt_packet {
  39         struct bt_object base;
  40         struct bt_field_wrapper *context_field;
  41         struct bt_stream *stream;
  42         bool frozen;
  43 };
  44
  45 BT_HIDDEN
  46 void _bt_packet_set_is_frozen(const struct bt_packet *packet, bool is_frozen);
  47
  48 #ifdef BT_DEV_MODE
  49 # define bt_packet_set_is_frozen        _bt_packet_set_is_frozen
  50 #else
  51 # define bt_packet_set_is_frozen(_packet, _is_frozen)
  52 #endif /* BT_DEV_MODE */
  53
  54 BT_HIDDEN
  55 struct bt_packet *bt_packet_new(struct bt_stream *stream);
  56
  57 BT_HIDDEN
  58 void bt_packet_recycle(struct bt_packet *packet);
  59
  60 BT_HIDDEN
  61 void bt_packet_destroy(struct bt_packet *packet);
  62
  63 #endif /* BABELTRACE_TRACE_IR_PACKET_INTERNAL_H */