plugins/component.c

   1 /*
   2  * component.c
   3  *
   4  * Babeltrace Plugin Component
   5  *
   6  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <babeltrace/plugin/component.h>
  30 #include <babeltrace/plugin/component-internal.h>
  31 #include <babeltrace/babeltrace-internal.h>
  32 #include <babeltrace/compiler.h>
  33
  34 static void bt_component_destroy(struct bt_ref *ref);
  35
  36 const char *bt_component_get_name(struct bt_component *component)
  37 {
  38         const char *ret = NULL;
  39
  40         if (!component) {
  41                 goto end;
  42         }
  43
  44         ret = component->name->str;
  45 end:
  46         return ret;
  47 }
  48
  49 enum bt_component_status bt_component_set_name(struct bt_component *component,
  50                 const char *name)
  51 {
  52         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  53
  54         if (!component || !name || name[0] == '\0') {
  55                 ret = BT_COMPONENT_STATUS_INVAL;
  56                 goto end;
  57         }
  58
  59         g_string_assign(component->name, name);
  60 end:
  61         return ret;
  62 }
  63
  64 enum bt_component_type bt_component_get_type(struct bt_component *component)
  65 {
  66         enum bt_component_type type = BT_COMPONENT_TYPE_UNKNOWN;
  67
  68         if (!component) {
  69                 goto end;
  70         }
  71
  72         type = component->class->type;
  73 end:
  74         return type;
  75 }
  76
  77 enum bt_component_status bt_component_set_error_stream(
  78                 struct bt_component *component, FILE *stream)
  79 {
  80         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
  81
  82         if (!component) {
  83                 ret = BT_COMPONENT_STATUS_INVAL;
  84                 goto end;
  85         }
  86
  87         component->error_stream = stream;
  88 end:
  89         return ret;
  90 }
  91
  92 void bt_component_get(struct bt_component *component)
  93 {
  94         if (!component) {
  95                 return;
  96         }
  97
  98         bt_ref_get(&component->ref);
  99 }
 100
 101 void bt_component_put(struct bt_component *component)
 102 {
 103         if (!component) {
 104                 return;
 105         }
 106
 107         bt_ref_put(&component->ref);
 108 }
 109
 110 BT_HIDDEN
 111 enum bt_component_status bt_component_init(struct bt_component *component,
 112                 struct bt_component_class *class, const char *name,
 113                 bt_component_destroy_cb destroy)
 114 {
 115         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 116
 117         if (!component || !class || !name || name[0] == '\0' || destroy) {
 118                 ret = BT_COMPONENT_STATUS_INVAL;
 119                 goto end;
 120         }
 121
 122         bt_ref_init(&component->ref, bt_component_destroy);
 123         bt_component_class_get(class);
 124         component->class = class;
 125         component->name = g_string_new(name);
 126         if (!component->name) {
 127                 ret = BT_COMPONENT_STATUS_NOMEM;
 128                 goto end;
 129         }
 130         component->destroy = destroy;
 131 end:
 132         return ret;
 133 }
 134
 135 void *bt_component_get_private_data(struct bt_component *component)
 136 {
 137         void *ret = NULL;
 138
 139         if (!component) {
 140                 goto end;
 141         }
 142
 143         ret = component->user_data;
 144 end:
 145         return ret;
 146 }
 147
 148 enum bt_component_status
 149 bt_component_set_private_data(struct bt_component *component,
 150                 void *data)
 151 {
 152         enum bt_component_status ret = BT_COMPONENT_STATUS_OK;
 153
 154         if (!component) {
 155                 ret = BT_COMPONENT_STATUS_INVAL;
 156                 goto end;
 157         }
 158
 159         component->user_data = data;
 160 end:
 161         return ret;
 162 }
 163
 164 static
 165 void bt_component_destroy(struct bt_ref *ref)
 166 {
 167         struct bt_component *component = NULL;
 168
 169         if (!ref) {
 170                 return;
 171         }
 172
 173         component = container_of(ref, struct bt_component, ref);
 174
 175         /**
 176          * User data is destroyed first, followed by the concrete component
 177          * instance.
 178          */
 179         assert(!component->user_data || component->user_destroy);
 180         component->user_destroy(component->user_data);
 181
 182         g_string_free(component->name, TRUE);
 183
 184         assert(component->destroy);
 185         component->destroy(component);
 186         bt_component_class_put(component->class);
 187 }