lib/ctf-ir/packet-context-field.c

   1 /*
   2  * Copyright 2018 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #define BT_LOG_TAG "PACKET-CONTEXT-FIELD"
  24 #include <babeltrace/lib-logging-internal.h>
  25
  26 #include <babeltrace/assert-pre-internal.h>
  27 #include <babeltrace/ctf-ir/stream-class-internal.h>
  28 #include <babeltrace/ctf-ir/packet-context-field.h>
  29 #include <babeltrace/ctf-ir/fields-internal.h>
  30 #include <babeltrace/ctf-ir/field-wrapper-internal.h>
  31 #include <glib.h>
  32
  33 struct bt_field *bt_packet_context_field_borrow_field(
  34                 struct bt_packet_context_field *context_field)
  35 {
  36         struct bt_field_wrapper *field_wrapper = (void *) context_field;
  37
  38         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Packet context field");
  39         return field_wrapper->field;
  40 }
  41
  42 void bt_packet_context_field_release(struct bt_packet_context_field *context_field)
  43 {
  44         struct bt_field_wrapper *field_wrapper = (void *) context_field;
  45
  46         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Packet context field");
  47
  48         /*
  49          * Do not recycle because the pool could be destroyed at this
  50          * point. This function is only called when there's an error
  51          * anyway because the goal of a packet context field wrapper is
  52          * to eventually move it to a packet with
  53          * bt_packet_move_context() after creating it.
  54          */
  55         bt_field_wrapper_destroy(field_wrapper);
  56 }
  57
  58 struct bt_packet_context_field *bt_packet_context_field_create(
  59                 struct bt_stream_class *stream_class)
  60 {
  61         struct bt_field_wrapper *field_wrapper;
  62
  63         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
  64         BT_ASSERT_PRE(stream_class->frozen,
  65                 "Stream class is not part of a trace: %!+S", stream_class);
  66         BT_ASSERT_PRE(stream_class->packet_context_ft,
  67                 "Stream class has no packet context field type: %!+S",
  68                 stream_class);
  69         field_wrapper = bt_field_wrapper_create(
  70                 &stream_class->packet_context_field_pool,
  71                 (void *) stream_class->packet_context_ft);
  72         if (!field_wrapper) {
  73                 BT_LIB_LOGE("Cannot allocate one packet context field from stream class: "
  74                         "%![sc-]+S", stream_class);
  75                 goto error;
  76         }
  77
  78         BT_ASSERT(field_wrapper->field);
  79         bt_stream_class_freeze(stream_class);
  80         goto end;
  81
  82 error:
  83         if (field_wrapper) {
  84                 bt_field_wrapper_destroy(field_wrapper);
  85                 field_wrapper = NULL;
  86         }
  87
  88 end:
  89         return (void *) field_wrapper;
  90 }