lib/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/packet.h>
  29 #include <babeltrace/ctf-ir/packet-internal.h>
  30 #include <babeltrace/ctf-ir/trace.h>
  31 #include <babeltrace/ctf-ir/stream-class-internal.h>
  32 #include <babeltrace/ctf-ir/stream-class.h>
  33 #include <babeltrace/ctf-ir/stream.h>
  34 #include <babeltrace/ctf-ir/stream-internal.h>
  35 #include <babeltrace/ctf-ir/trace-internal.h>
  36 #include <babeltrace/object-internal.h>
  37 #include <babeltrace/ref.h>
  38
  39 struct bt_ctf_stream *bt_ctf_packet_get_stream(struct bt_ctf_packet *packet)
  40 {
  41         return packet ? bt_get(packet->stream) : NULL;
  42 }
  43
  44 struct bt_ctf_field *bt_ctf_packet_get_header(
  45                 struct bt_ctf_packet *packet)
  46 {
  47         return packet ? bt_get(packet->header) : NULL;
  48 }
  49
  50 int bt_ctf_packet_set_header(struct bt_ctf_packet *packet,
  51                 struct bt_ctf_field *header)
  52 {
  53         int ret = 0;
  54         struct bt_ctf_trace *trace = NULL;
  55         struct bt_ctf_stream_class *stream_class = NULL;
  56         struct bt_ctf_field_type *header_field_type = NULL;
  57         struct bt_ctf_field_type *expected_header_field_type = NULL;
  58
  59         if (!packet || packet->frozen) {
  60                 ret = -1;
  61                 goto end;
  62         }
  63
  64         if (!header) {
  65                 goto skip_validation;
  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 skip_validation:
  83         bt_put(packet->header);
  84         packet->header = bt_get(header);
  85
  86 end:
  87         BT_PUT(trace);
  88         BT_PUT(stream_class);
  89         BT_PUT(header_field_type);
  90         BT_PUT(expected_header_field_type);
  91
  92         return ret;
  93 }
  94
  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 int bt_ctf_packet_set_context(struct bt_ctf_packet *packet,
 102                 struct bt_ctf_field *context)
 103 {
 104         int ret = 0;
 105         struct bt_ctf_stream_class *stream_class = NULL;
 106         struct bt_ctf_field_type *context_field_type = NULL;
 107         struct bt_ctf_field_type *expected_context_field_type = NULL;
 108
 109         if (!packet || packet->frozen) {
 110                 ret = -1;
 111                 goto end;
 112         }
 113
 114         if (!context) {
 115                 goto skip_validation;
 116         }
 117
 118         stream_class = bt_ctf_stream_get_class(packet->stream);
 119         assert(stream_class);
 120         context_field_type = bt_ctf_field_get_type(context);
 121         assert(context_field_type);
 122         expected_context_field_type =
 123                 bt_ctf_stream_class_get_packet_context_type(stream_class);
 124
 125         if (bt_ctf_field_type_compare(context_field_type,
 126                         expected_context_field_type)) {
 127                 ret = -1;
 128                 goto end;
 129         }
 130
 131 skip_validation:
 132         bt_put(packet->context);
 133         packet->context = bt_get(context);
 134
 135 end:
 136         BT_PUT(stream_class);
 137         BT_PUT(context_field_type);
 138         BT_PUT(expected_context_field_type);
 139
 140         return ret;
 141 }
 142
 143 BT_HIDDEN
 144 void bt_ctf_packet_freeze(struct bt_ctf_packet *packet)
 145 {
 146         if (!packet) {
 147                 return;
 148         }
 149
 150         bt_ctf_field_freeze(packet->header);
 151         bt_ctf_field_freeze(packet->context);
 152         packet->frozen = 1;
 153 }
 154
 155 static
 156 void bt_ctf_packet_destroy(struct bt_object *obj)
 157 {
 158         struct bt_ctf_packet *packet;
 159
 160         packet = container_of(obj, struct bt_ctf_packet, base);
 161         bt_put(packet->header);
 162         bt_put(packet->context);
 163         bt_put(packet->stream);
 164         g_free(packet);
 165 }
 166
 167 struct bt_ctf_packet *bt_ctf_packet_create(
 168                 struct bt_ctf_stream *stream)
 169 {
 170         struct bt_ctf_packet *packet = NULL;
 171         struct bt_ctf_stream_class *stream_class = NULL;
 172         struct bt_ctf_trace *trace = NULL;
 173
 174         if (!stream || stream->pos.fd >= 0) {
 175                 goto end;
 176         }
 177
 178         stream_class = bt_ctf_stream_get_class(stream);
 179         assert(stream_class);
 180         trace = bt_ctf_stream_class_get_trace(stream_class);
 181         assert(trace);
 182         packet = g_new0(struct bt_ctf_packet, 1);
 183         if (!packet) {
 184                 goto end;
 185         }
 186
 187         bt_object_init(packet, bt_ctf_packet_destroy);
 188         packet->stream = bt_get(stream);
 189         packet->header = bt_ctf_field_create(trace->packet_header_type);
 190         if (!packet->header && trace->packet_header_type) {
 191                 BT_PUT(packet);
 192                 goto end;
 193         }
 194
 195         packet->context = bt_ctf_field_create(
 196                 stream->stream_class->packet_context_type);
 197         if (!packet->context && stream->stream_class->packet_context_type) {
 198                 BT_PUT(packet);
 199                 goto end;
 200         }
 201
 202 end:
 203         BT_PUT(trace);
 204         BT_PUT(stream_class);
 205
 206         return packet;
 207 }