lib/context.c

   1 /*
   2  * context.c
   3  *
   4  * Babeltrace Library
   5  *
   6  * Copyright 2011-2012 EfficiOS Inc. and Linux Foundation
   7  *
   8  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   9  *         Julien Desfossez <julien.desfossez@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  */
  21
  22 #include <babeltrace/babeltrace.h>
  23 #include <babeltrace/context.h>
  24 #include <babeltrace/context-internal.h>
  25 #include <babeltrace/trace-handle.h>
  26 #include <babeltrace/trace-handle-internal.h>
  27 #include <babeltrace/trace-collection.h>
  28 #include <babeltrace/format.h>
  29 #include <babeltrace/babeltrace-internal.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32 #include <assert.h>
  33 #include <errno.h>
  34
  35 #include <fcntl.h> /* For O_RDONLY */
  36
  37 #include <glib.h>
  38
  39 struct bt_context *bt_context_create(void)
  40 {
  41         struct bt_context *ctx;
  42
  43         ctx = g_new0(struct bt_context, 1);
  44         ctx->refcount = 1;
  45         /* Negative handle id are errors. */
  46         ctx->last_trace_handle_id = 0;
  47
  48         /* Instanciate the trace handle container */
  49         ctx->trace_handles = g_hash_table_new_full(g_direct_hash,
  50                                 g_direct_equal, NULL,
  51                                 (GDestroyNotify) bt_trace_handle_destroy);
  52
  53         ctx->current_iterator = NULL;
  54         ctx->tc = g_new0(struct trace_collection, 1);
  55         init_trace_collection(ctx->tc);
  56
  57         return ctx;
  58 }
  59
  60 int bt_context_add_trace(struct bt_context *ctx, const char *path,
  61                 const char *format_name,
  62                 void (*packet_seek)(struct stream_pos *pos, size_t index,
  63                         int whence),
  64                 struct mmap_stream_list *stream_list,
  65                 FILE *metadata)
  66 {
  67         struct trace_descriptor *td;
  68         struct format *fmt;
  69         struct bt_trace_handle *handle;
  70         int ret;
  71
  72         if (!ctx || !format_name || (!path && !stream_list))
  73                 return -EINVAL;
  74
  75         fmt = bt_lookup_format(g_quark_from_string(format_name));
  76         if (!fmt) {
  77                 fprintf(stderr, "[error] [Context] Format \"%s\" unknown.\n\n",
  78                         format_name);
  79                 ret = -1;
  80                 goto end;
  81         }
  82         if (path) {
  83                 td = fmt->open_trace(path, O_RDONLY, packet_seek, NULL);
  84                 if (!td) {
  85                         fprintf(stderr, "[warning] [Context] Cannot open_trace of the format %s .\n\n",
  86                                         path);
  87                         ret = -1;
  88                         goto end;
  89                 }
  90         } else {
  91                 td = fmt->open_mmap_trace(stream_list, packet_seek, metadata);
  92                 if (!td) {
  93                         fprintf(stderr, "[error] [Context] Cannot open_trace of the format %s .\n\n",
  94                                         path);
  95                         ret = -1;
  96                         goto end;
  97                 }
  98         }
  99
 100         /* Create an handle for the trace */
 101         handle = bt_trace_handle_create(ctx);
 102         if (handle < 0) {
 103                 fprintf(stderr, "[error] [Context] Creating trace handle %s .\n\n",
 104                                 path);
 105                 ret = -1;
 106                 goto end;
 107         }
 108         handle->format = fmt;
 109         handle->td = td;
 110         if (path) {
 111                 strncpy(handle->path, path, PATH_MAX);
 112                 handle->path[PATH_MAX - 1] = '\0';
 113         }
 114
 115         if (fmt->set_handle)
 116                 fmt->set_handle(td, handle);
 117         if (fmt->set_context)
 118                 fmt->set_context(td, ctx);
 119
 120         /* Add new handle to container */
 121         g_hash_table_insert(ctx->trace_handles,
 122                 (gpointer) (unsigned long) handle->id,
 123                 handle);
 124         ret = trace_collection_add(ctx->tc, td);
 125         if (ret != 0)
 126                 goto end;
 127
 128         ret = fmt->convert_index_timestamp(td);
 129         if (ret < 0)
 130                 goto end;
 131
 132         handle->real_timestamp_begin = fmt->timestamp_begin(td, handle, BT_CLOCK_REAL);
 133         handle->real_timestamp_end = fmt->timestamp_end(td, handle, BT_CLOCK_REAL);
 134         handle->cycles_timestamp_begin = fmt->timestamp_begin(td, handle, BT_CLOCK_CYCLES);
 135         handle->cycles_timestamp_end = fmt->timestamp_end(td, handle, BT_CLOCK_CYCLES);
 136
 137         return handle->id;
 138 end:
 139         return ret;
 140 }
 141
 142 int bt_context_remove_trace(struct bt_context *ctx, int handle_id)
 143 {
 144         struct bt_trace_handle *handle;
 145
 146         if (!ctx)
 147                 return -EINVAL;
 148
 149         handle = g_hash_table_lookup(ctx->trace_handles,
 150                 (gpointer) (unsigned long) handle_id);
 151         if (!handle)
 152                 return -ENOENT;
 153
 154         /* Remove from containers */
 155         trace_collection_remove(ctx->tc, handle->td);
 156         /* Close the trace */
 157         handle->format->close_trace(handle->td);
 158
 159         /* Remove and free the handle */
 160         g_hash_table_remove(ctx->trace_handles,
 161                         (gpointer) (unsigned long) handle_id);
 162         return 0;
 163 }
 164
 165 static
 166 void bt_context_destroy(struct bt_context *ctx)
 167 {
 168         assert(ctx);
 169         finalize_trace_collection(ctx->tc);
 170
 171         /* Remote all traces. The g_hash_table_destroy will call
 172          * bt_trace_handle_destroy on each elements.
 173          */
 174         g_hash_table_destroy(ctx->trace_handles);
 175
 176         /* ctx->tc should always be valid */
 177         assert(ctx->tc != NULL);
 178         g_free(ctx->tc);
 179         g_free(ctx);
 180 }
 181
 182 void bt_context_get(struct bt_context *ctx)
 183 {
 184         assert(ctx);
 185         ctx->refcount++;
 186 }
 187
 188 void bt_context_put(struct bt_context *ctx)
 189 {
 190         assert(ctx);
 191         ctx->refcount--;
 192         if (ctx->refcount == 0)
 193                 bt_context_destroy(ctx);
 194 }