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
  25 #include <stdint.h>
  26 #include <stdlib.h>
  27 #include <babeltrace/context.h>
  28 #include <babeltrace/format.h>
  29
  30 /*
  31  * trace_handle : unique identifier of a trace
  32  *
  33  * The trace_handle allows the user to manipulate a trace file directly.
  34  * It is a unique identifier representing a trace file.
  35  */
  36 struct bt_trace_handle {
  37         int id;
  38         struct trace_descriptor *td;
  39         struct format *format;
  40         char path[PATH_MAX];
  41         uint64_t real_timestamp_begin;
  42         uint64_t real_timestamp_end;
  43         uint64_t cycles_timestamp_begin;
  44         uint64_t cycles_timestamp_end;
  45 };
  46
  47 /*
  48  * bt_trace_handle_create : allocates a trace_handle
  49  *
  50  * Returns a newly allocated trace_handle or NULL on error
  51  */
  52 struct bt_trace_handle *bt_trace_handle_create(struct bt_context *ctx);
  53
  54 /*
  55  * bt_trace_handle_destroy : free a trace_handle
  56  */
  57 void bt_trace_handle_destroy(struct bt_trace_handle *bt);
  58
  59 #endif /* _BABELTRACE_TRACE_HANDLE_INTERNAL_H */