formats/ctf/ir/packet.c

   1 /*
   2  * packet.c
   3  *
   4  * Babeltrace CTF IR - Stream packet
   5  *
   6  * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  */
  26
  27 #include <babeltrace/ctf-ir/fields-internal.h>
  28 #include <babeltrace/ctf-ir/field-types-internal.h>
  29 #include <babeltrace/ctf-ir/packet.h>
  30 #include <babeltrace/ctf-ir/packet-internal.h>
  31 #include <babeltrace/ctf-ir/trace.h>
  32 #include <babeltrace/ctf-ir/stream-class-internal.h>
  33 #include <babeltrace/ctf-ir/stream-class.h>
  34 #include <babeltrace/ctf-ir/stream.h>
  35 #include <babeltrace/ctf-ir/stream-internal.h>
  36 #include <babeltrace/ctf-ir/trace-internal.h>
  37 #include <babeltrace/object-internal.h>
  38 #include <babeltrace/ref.h>
  39
  40 BT_HIDDEN
  41 struct bt_ctf_stream *bt_ctf_packet_get_stream(struct bt_ctf_packet *packet)
  42 {
  43         return packet ? bt_get(packet->stream) : NULL;
  44 }
  45
  46 BT_HIDDEN
  47 struct bt_ctf_field *bt_ctf_packet_get_header(
  48                 struct bt_ctf_packet *packet)
  49 {
  50         return packet ? bt_get(packet->header) : NULL;
  51 }
  52
  53 BT_HIDDEN
  54 int bt_ctf_packet_set_header(struct bt_ctf_packet *packet,
  55                 struct bt_ctf_field *header)
  56 {
  57         int ret = 0;
  58         struct bt_ctf_trace *trace = NULL;
  59         struct bt_ctf_stream_class *stream_class = NULL;
  60         struct bt_ctf_field_type *header_field_type = NULL;
  61         struct bt_ctf_field_type *expected_header_field_type = NULL;
  62
  63         if (!packet || !header || packet->frozen) {
  64                 ret = -1;
  65                 goto end;
  66         }
  67
  68         stream_class = bt_ctf_stream_get_class(packet->stream);
  69         assert(stream_class);
  70         trace = bt_ctf_stream_class_get_trace(stream_class);
  71         assert(trace);
  72         header_field_type = bt_ctf_field_get_type(header);
  73         assert(header_field_type);
  74         expected_header_field_type = bt_ctf_trace_get_packet_header_type(trace);
  75
  76         if (bt_ctf_field_type_compare(header_field_type,
  77                         expected_header_field_type)) {
  78                 ret = -1;
  79                 goto end;
  80         }
  81
  82         bt_put(packet->header);
  83         packet->header = bt_get(header);
  84
  85 end:
  86         BT_PUT(trace);
  87         BT_PUT(stream_class);
  88         BT_PUT(header_field_type);
  89         BT_PUT(expected_header_field_type);
  90
  91         return ret;
  92 }
  93
  94 BT_HIDDEN
  95 struct bt_ctf_field *bt_ctf_packet_get_context(
  96                 struct bt_ctf_packet *packet)
  97 {
  98         return packet ? bt_get(packet->context) : NULL;
  99 }
 100
 101 BT_HIDDEN
 102 int bt_ctf_packet_set_context(struct bt_ctf_packet *packet,
 103                 struct bt_ctf_field *context)
 104 {
 105         int ret = 0;
 106         struct bt_ctf_stream_class *stream_class = NULL;
 107         struct bt_ctf_field_type *context_field_type = NULL;
 108         struct bt_ctf_field_type *expected_context_field_type = NULL;
 109
 110         if (!packet || !context || packet->frozen) {
 111                 ret = -1;
 112                 goto end;
 113         }
 114
 115         stream_class = bt_ctf_stream_get_class(packet->stream);
 116         assert(stream_class);
 117         context_field_type = bt_ctf_field_get_type(context);
 118         assert(context_field_type);
 119         expected_context_field_type =
 120                 bt_ctf_stream_class_get_packet_context_type(stream_class);
 121
 122         if (bt_ctf_field_type_compare(context_field_type,
 123                         expected_context_field_type)) {
 124                 ret = -1;
 125                 goto end;
 126         }
 127
 128         bt_put(packet->context);
 129         packet->context = bt_get(context);
 130
 131 end:
 132         BT_PUT(stream_class);
 133         BT_PUT(context_field_type);
 134         BT_PUT(expected_context_field_type);
 135
 136         return ret;
 137 }
 138
 139 BT_HIDDEN
 140 void bt_ctf_packet_freeze(struct bt_ctf_packet *packet)
 141 {
 142         if (!packet) {
 143                 return;
 144         }
 145
 146         bt_ctf_field_freeze(packet->header);
 147         bt_ctf_field_freeze(packet->context);
 148         packet->frozen = 1;
 149 }
 150
 151 static
 152 void bt_ctf_packet_destroy(struct bt_object *obj)
 153 {
 154         struct bt_ctf_packet *packet;
 155
 156         packet = container_of(obj, struct bt_ctf_packet, base);
 157         bt_put(packet->header);
 158         bt_put(packet->context);
 159         bt_put(packet->stream);
 160         g_free(packet);
 161 }
 162
 163 BT_HIDDEN
 164 struct bt_ctf_packet *bt_ctf_packet_create(
 165                 struct bt_ctf_stream *stream)
 166 {
 167         struct bt_ctf_packet *packet = NULL;
 168         struct bt_ctf_stream_class *stream_class = NULL;
 169         struct bt_ctf_trace *trace = NULL;
 170
 171         if (!stream || stream->pos.fd >= 0) {
 172                 goto end;
 173         }
 174
 175         stream_class = bt_ctf_stream_get_class(stream);
 176         assert(stream_class);
 177         trace = bt_ctf_stream_class_get_trace(stream_class);
 178         assert(trace);
 179         packet = g_new0(struct bt_ctf_packet, 1);
 180         if (!packet) {
 181                 goto end;
 182         }
 183
 184         bt_object_init(packet, bt_ctf_packet_destroy);
 185         packet->stream = bt_get(stream);
 186         packet->header = bt_ctf_field_create(trace->packet_header_type);
 187         if (!packet->header) {
 188                 BT_PUT(packet);
 189                 goto end;
 190         }
 191
 192         packet->context = bt_ctf_field_create(
 193                 stream->stream_class->packet_context_type);
 194         if (!packet->context) {
 195                 BT_PUT(packet);
 196                 goto end;
 197         }
 198
 199 end:
 200         BT_PUT(trace);
 201         BT_PUT(stream_class);
 202
 203         return packet;
 204 }