plugins/utils/trimmer/copy.c

   1 /*
   2  * copy.c
   3  *
   4  * Babeltrace Copy Trace Structure
   5  *
   6  * Copyright 2017 Julien Desfossez <jdesfossez@efficios.com>
   7  *
   8  * Author: Julien Desfossez <jdesfossez@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/ctf-ir/event.h>
  30 #include <babeltrace/ctf-ir/packet.h>
  31 #include <babeltrace/ctf-ir/event-class.h>
  32 #include <babeltrace/ctf-ir/stream.h>
  33 #include <babeltrace/ctf-ir/stream-class.h>
  34 #include <babeltrace/ctf-ir/clock-class.h>
  35 #include <babeltrace/ctf-ir/fields.h>
  36 #include <babeltrace/ctf-writer/stream-class.h>
  37 #include <babeltrace/ctf-writer/stream.h>
  38
  39 #include <ctfcopytrace.h>
  40 #include "iterator.h"
  41
  42 static
  43 struct bt_ctf_packet *lookup_packet(struct trimmer_iterator *trim_it,
  44                 struct bt_ctf_packet *packet)
  45 {
  46         return (struct bt_ctf_packet *) g_hash_table_lookup(
  47                         trim_it->packet_map,
  48                         (gpointer) packet);
  49 }
  50
  51 static
  52 struct bt_ctf_packet *insert_new_packet(struct trimmer_iterator *trim_it,
  53                 struct bt_ctf_packet *packet,
  54                 struct bt_ctf_stream *stream)
  55 {
  56         struct bt_ctf_packet *writer_packet = NULL;
  57         int ret;
  58
  59         writer_packet = bt_ctf_packet_create(stream);
  60         if (!writer_packet) {
  61                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
  62                                 __FILE__, __LINE__);
  63                 goto error;
  64         }
  65
  66         ret = ctf_packet_copy_header(trim_it->err, packet, writer_packet);
  67         if (ret) {
  68                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
  69                                 __FILE__, __LINE__);
  70                 goto error;
  71         }
  72
  73         g_hash_table_insert(trim_it->packet_map, (gpointer) packet,
  74                         writer_packet);
  75         goto end;
  76
  77 error:
  78         BT_PUT(writer_packet);
  79 end:
  80         return writer_packet;
  81 }
  82
  83 BT_HIDDEN
  84 enum bt_component_status update_packet_context_field(FILE *err,
  85                 struct bt_ctf_packet *writer_packet,
  86                 const char *name, int64_t value)
  87 {
  88         enum bt_component_status ret;
  89         struct bt_ctf_field *packet_context = NULL, *writer_packet_context = NULL;
  90         struct bt_ctf_field_type *struct_type = NULL, *field_type = NULL;
  91         struct bt_ctf_field *field = NULL, *writer_field = NULL;
  92         int nr_fields, i, int_ret;
  93
  94         packet_context = bt_ctf_packet_get_context(writer_packet);
  95         if (!packet_context) {
  96                 fprintf(err, "[error] %s in %s:%d\n", __func__, __FILE__,
  97                                 __LINE__);
  98                 goto error;
  99         }
 100
 101         struct_type = bt_ctf_field_get_type(packet_context);
 102         if (!struct_type) {
 103                 fprintf(err, "[error] %s in %s:%d\n", __func__, __FILE__,
 104                                 __LINE__);
 105                 goto error;
 106         }
 107
 108         writer_packet_context = bt_ctf_packet_get_context(writer_packet);
 109         if (!writer_packet_context) {
 110                 fprintf(err, "[error] %s in %s:%d\n", __func__, __FILE__,
 111                                 __LINE__);
 112                 goto error;
 113         }
 114
 115         nr_fields = bt_ctf_field_type_structure_get_field_count(struct_type);
 116         for (i = 0; i < nr_fields; i++) {
 117                 const char *field_name;
 118
 119                 field = bt_ctf_field_structure_get_field_by_index(
 120                                 packet_context, i);
 121                 if (!field) {
 122                         fprintf(err, "[error] %s in %s:%d\n", __func__,
 123                                         __FILE__, __LINE__);
 124                         goto error;
 125                 }
 126                 if (bt_ctf_field_type_structure_get_field(struct_type,
 127                                         &field_name, &field_type, i) < 0) {
 128                         fprintf(err, "[error] %s in %s:%d\n", __func__,
 129                                         __FILE__, __LINE__);
 130                         goto error;
 131                 }
 132                 if (strcmp(field_name, name)) {
 133                         BT_PUT(field_type);
 134                         BT_PUT(field);
 135                         continue;
 136                 }
 137                 if (bt_ctf_field_type_get_type_id(field_type) != BT_CTF_FIELD_TYPE_ID_INTEGER) {
 138                         fprintf(err, "[error] Unexpected packet context field type\n");
 139                         goto error;
 140                 }
 141                 writer_field = bt_ctf_field_structure_get_field(writer_packet_context,
 142                                 field_name);
 143                 if (!writer_field) {
 144                         fprintf(err, "[error] %s in %s:%d\n", __func__, __FILE__,
 145                                         __LINE__);
 146                         goto error;
 147                 }
 148
 149                 int_ret = bt_ctf_field_unsigned_integer_set_value(writer_field, value);
 150                 if (int_ret < 0) {
 151                         fprintf(err, "[error] %s in %s:%d\n", __func__, __FILE__,
 152                                         __LINE__);
 153                         goto error;
 154                 }
 155                 BT_PUT(writer_field);
 156                 BT_PUT(field_type);
 157                 BT_PUT(field);
 158         }
 159
 160         ret = BT_COMPONENT_STATUS_OK;
 161         goto end;
 162
 163 error:
 164         bt_put(writer_field);
 165         bt_put(field_type);
 166         bt_put(field);
 167         ret = BT_COMPONENT_STATUS_ERROR;
 168 end:
 169         bt_put(struct_type);
 170         bt_put(packet_context);
 171         return ret;
 172 }
 173
 174 BT_HIDDEN
 175 struct bt_ctf_packet *trimmer_new_packet(
 176                 struct trimmer_iterator *trim_it,
 177                 struct bt_ctf_packet *packet)
 178 {
 179         struct bt_ctf_stream *stream = NULL;
 180         struct bt_ctf_packet *writer_packet = NULL;
 181         int int_ret;
 182
 183         stream = bt_ctf_packet_get_stream(packet);
 184         if (!stream) {
 185                 fprintf(trim_it->err, "[error] %s in %s:%d\n",
 186                                 __func__, __FILE__, __LINE__);
 187                 goto error;
 188         }
 189
 190         /*
 191          * If a packet was already opened, close it and remove it from
 192          * the HT.
 193          */
 194         writer_packet = lookup_packet(trim_it, packet);
 195         if (writer_packet) {
 196                 g_hash_table_remove(trim_it->packet_map, packet);
 197                 BT_PUT(writer_packet);
 198         }
 199
 200         writer_packet = insert_new_packet(trim_it, packet, stream);
 201         if (!writer_packet) {
 202                 fprintf(trim_it->err, "[error] %s in %s:%d\n",
 203                                 __func__, __FILE__, __LINE__);
 204                 goto error;
 205         }
 206         bt_get(writer_packet);
 207
 208         int_ret = ctf_packet_copy_context(trim_it->err, packet,
 209                         stream, writer_packet);
 210         if (int_ret < 0) {
 211                 fprintf(trim_it->err, "[error] %s in %s:%d\n",
 212                                 __func__, __FILE__, __LINE__);
 213                 goto error;
 214         }
 215
 216         goto end;
 217
 218 error:
 219         BT_PUT(writer_packet);
 220 end:
 221         bt_put(stream);
 222         return writer_packet;
 223 }
 224
 225 BT_HIDDEN
 226 struct bt_ctf_packet *trimmer_close_packet(
 227                 struct trimmer_iterator *trim_it,
 228                 struct bt_ctf_packet *packet)
 229 {
 230         struct bt_ctf_packet *writer_packet = NULL;
 231
 232         writer_packet = lookup_packet(trim_it, packet);
 233         if (!writer_packet) {
 234                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 235                                 __FILE__, __LINE__);
 236                 goto end;
 237         }
 238
 239         g_hash_table_remove(trim_it->packet_map, packet);
 240
 241 end:
 242         return writer_packet;
 243 }
 244
 245 BT_HIDDEN
 246 struct bt_ctf_event *trimmer_output_event(
 247                 struct trimmer_iterator *trim_it,
 248                 struct bt_ctf_event *event)
 249 {
 250         struct bt_ctf_event_class *event_class = NULL;
 251         struct bt_ctf_event *writer_event = NULL;
 252         struct bt_ctf_packet *packet = NULL, *writer_packet = NULL;
 253         const char *event_name;
 254         int int_ret;
 255
 256         event_class = bt_ctf_event_get_class(event);
 257         if (!event_class) {
 258                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 259                                 __FILE__, __LINE__);
 260                 goto error;
 261         }
 262
 263         event_name = bt_ctf_event_class_get_name(event_class);
 264         if (!event_name) {
 265                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 266                                 __FILE__, __LINE__);
 267                 goto error;
 268         }
 269
 270         writer_event = ctf_copy_event(trim_it->err, event, event_class, false);
 271         if (!writer_event) {
 272                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 273                                 __FILE__, __LINE__);
 274                 fprintf(trim_it->err, "[error] Failed to copy event %s\n",
 275                                 bt_ctf_event_class_get_name(event_class));
 276                 goto error;
 277         }
 278
 279         packet = bt_ctf_event_get_packet(event);
 280         if (!packet) {
 281                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 282                                 __FILE__, __LINE__);
 283                 goto error;
 284         }
 285
 286         writer_packet = lookup_packet(trim_it, packet);
 287         if (!writer_packet) {
 288                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 289                                 __FILE__, __LINE__);
 290                 goto error;
 291         }
 292         bt_get(writer_packet);
 293
 294         int_ret = bt_ctf_event_set_packet(writer_event, writer_packet);
 295         if (int_ret < 0) {
 296                 fprintf(trim_it->err, "[error] %s in %s:%d\n", __func__,
 297                                 __FILE__, __LINE__);
 298                 fprintf(trim_it->err, "[error] Failed to append event %s\n",
 299                                 bt_ctf_event_class_get_name(event_class));
 300                 goto error;
 301         }
 302
 303         /* We keep the reference on the writer_event to create a notification. */
 304         goto end;
 305
 306 error:
 307         BT_PUT(writer_event);
 308 end:
 309         bt_put(writer_packet);
 310         bt_put(packet);
 311         bt_put(event_class);
 312         return writer_event;
 313 }