include/babeltrace/trace-handle-internal.h

   1 #ifndef _BABELTRACE_TRACE_HANDLE_INTERNAL_H
   2 #define _BABELTRACE_TRACE_HANDLE_INTERNAL_H
   3
   4 /*
   5  * BabelTrace
   6  *
   7  * Internal trace handle header
   8  *
   9  * Copyright 2012 EfficiOS Inc. and Linux Foundation
  10  *
  11  * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  12  *         Julien Desfossez <julien.desfossez@efficios.com>
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a copy
  15  * of this software and associated documentation files (the "Software"), to deal
  16  * in the Software without restriction, including without limitation the rights
  17  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  18  * copies of the Software, and to permit persons to whom the Software is
  19  * furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice shall be included in
  22  * all copies or substantial portions of the Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  27  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  29  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #include <stdint.h>
  34 #include <stdlib.h>
  35 #include <babeltrace/context.h>
  36 #include <babeltrace/format.h>
  37
  38 /*
  39  * trace_handle : unique identifier of a trace
  40  *
  41  * The trace_handle allows the user to manipulate a trace file directly.
  42  * It is a unique identifier representing a trace file.
  43  */
  44 struct bt_trace_handle {
  45         int id;
  46         struct bt_trace_descriptor *td;
  47         struct format *format;
  48         char path[PATH_MAX];
  49         uint64_t real_timestamp_begin;
  50         uint64_t real_timestamp_end;
  51         uint64_t cycles_timestamp_begin;
  52         uint64_t cycles_timestamp_end;
  53 };
  54
  55 /*
  56  * bt_trace_handle_create : allocates a trace_handle
  57  *
  58  * Returns a newly allocated trace_handle or NULL on error
  59  */
  60 struct bt_trace_handle *bt_trace_handle_create(struct bt_context *ctx);
  61
  62 /*
  63  * bt_trace_handle_destroy : free a trace_handle
  64  */
  65 void bt_trace_handle_destroy(struct bt_trace_handle *bt);
  66
  67 #endif /* _BABELTRACE_TRACE_HANDLE_INTERNAL_H */