src/lib/trace-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 "LIB/PACKET-CONTEXT-FIELD"
  24 #include "lib/logging.h"
  25
  26 #include "lib/assert-pre.h"
  27 #include <babeltrace2/trace-ir/packet-context-field.h>
  28 #include <glib.h>
  29
  30 #include "stream-class.h"
  31 #include "field.h"
  32 #include "field-wrapper.h"
  33
  34 struct bt_field *bt_packet_context_field_borrow_field(
  35                 struct bt_packet_context_field *context_field)
  36 {
  37         struct bt_field_wrapper *field_wrapper = (void *) context_field;
  38
  39         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Packet context field");
  40         return (void *) field_wrapper->field;
  41 }
  42
  43 void bt_packet_context_field_release(
  44                 struct bt_packet_context_field *context_field)
  45 {
  46         struct bt_field_wrapper *field_wrapper = (void *) context_field;
  47
  48         BT_ASSERT_PRE_NON_NULL(field_wrapper, "Packet context field");
  49
  50         /*
  51          * Do not recycle because the pool could be destroyed at this
  52          * point. This function is only called when there's an error
  53          * anyway because the goal of a packet context field wrapper is
  54          * to eventually move it to a packet with
  55          * bt_packet_move_context() after creating it.
  56          */
  57         bt_field_wrapper_destroy(field_wrapper);
  58 }
  59
  60 struct bt_packet_context_field *bt_packet_context_field_create(
  61                 struct bt_stream_class *stream_class)
  62 {
  63         struct bt_field_wrapper *field_wrapper;
  64
  65         BT_ASSERT_PRE_NON_NULL(stream_class, "Stream class");
  66         BT_ASSERT_PRE(stream_class->supports_packets,
  67                 "Stream class does not support packets: %![sc-]+S",
  68                 stream_class);
  69         BT_ASSERT_PRE(stream_class->packet_context_fc,
  70                 "Stream class has no packet context field class: %!+S",
  71                 stream_class);
  72         field_wrapper = bt_field_wrapper_create(
  73                 &stream_class->packet_context_field_pool,
  74                 (void *) stream_class->packet_context_fc);
  75         if (!field_wrapper) {
  76                 BT_LIB_LOGE_APPEND_CAUSE(
  77                         "Cannot allocate one packet context field from stream class: "
  78                         "%![sc-]+S", stream_class);
  79                 goto error;
  80         }
  81
  82         BT_ASSERT(field_wrapper->field);
  83         bt_stream_class_freeze(stream_class);
  84         goto end;
  85
  86 error:
  87         if (field_wrapper) {
  88                 bt_field_wrapper_destroy(field_wrapper);
  89                 field_wrapper = NULL;
  90         }
  91
  92 end:
  93         return (void *) field_wrapper;
  94 }