CTF IR -> Trace IR
[babeltrace.git] / include / babeltrace / ctf-ir / trace.h
index 1be85cfdeb4d197246ce6fe7324c56b20fa0f2ab..84b9b7a92258027db94db571b2891a5aab0d9bb5 100644 (file)
@@ -1,145 +1,2 @@
-#ifndef BABELTRACE_CTF_IR_TRACE_H
-#define BABELTRACE_CTF_IR_TRACE_H
-
-/*
- * BabelTrace - CTF IR: Trace
- *
- * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- * The Common Trace Format (CTF) Specification is available at
- * http://www.efficios.com/ctf
- */
-
-#include <babeltrace/ctf-ir/event-types.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-struct bt_ctf_trace;
-struct bt_ctf_stream;
-struct bt_ctf_stream_class;
-struct bt_ctf_clock;
-
-/*
- * bt_ctf_trace_create: create a trace instance.
- *
- * Allocate a new trace
- *
- * Returns a new trace on success, NULL on error.
- */
-extern struct bt_ctf_trace *bt_ctf_trace_create(void);
-
-/*
- * bt_ctf_trace_create_stream: create a stream instance.
- *
- * Allocate a new stream instance and register it to the trace. The creation of
- * a stream sets its reference count to 1.
- *
- * @param trace Trace instance.
- * @param stream_class Stream class to instantiate.
- *
- * Returns a new stream on success, NULL on error.
- */
-extern struct bt_ctf_stream *bt_ctf_trace_create_stream(
-               struct bt_ctf_trace *trace,
-               struct bt_ctf_stream_class *stream_class);
-
-/*
- * bt_ctf_trace_add_environment_field: add an environment field to the trace.
- *
- * Add an environment field to the trace. The name and value parameters are
- * copied.
- *
- * @param trace Trace instance.
- * @param name Name of the environment field (will be copied).
- * @param value Value of the environment field (will be copied).
- *
- * Returns 0 on success, a negative value on error.
- */
-extern int bt_ctf_trace_add_environment_field(struct bt_ctf_trace *trace,
-               const char *name,
-               const char *value);
-
-/*
- * bt_ctf_trace_add_clock: add a clock to the trace.
- *
- * Add a clock to the trace. Clocks assigned to stream classes must be
- * added to the trace beforehand.
- *
- * @param trace Trace instance.
- * @param clock Clock to add to the trace.
- *
- * Returns 0 on success, a negative value on error.
- */
-extern int bt_ctf_trace_add_clock(struct bt_ctf_trace *trace,
-               struct bt_ctf_clock *clock);
-
-/*
- * bt_ctf_trace_get_metadata_string: get metadata string.
- *
- * Get the trace's TSDL metadata. The caller assumes the ownership of the
- * returned string.
- *
- * @param trace Trace instance.
- *
- * Returns the metadata string on success, NULL on error.
- */
-extern char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace *trace);
-
-/*
- * bt_ctf_trace_set_byte_order: set a field type's byte order.
- *
- * Set the trace's byte order. Defaults to BT_CTF_BYTE_ORDER_NATIVE,
- * the host machine's endianness.
- *
- * @param trace Trace instance.
- * @param byte_order Trace's byte order.
- *
- * Returns 0 on success, a negative value on error.
- */
-extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace,
-               enum bt_ctf_byte_order byte_order);
-
-/*
- * bt_ctf_trace_get and bt_ctf_trace_put: increment and decrement the
- * trace's reference count.
- *
- * These functions ensure that the trace won't be destroyed while it
- * is in use. The same number of get and put (plus one extra put to
- * release the initial reference done at creation) have to be done to
- * destroy a trace.
- *
- * When the trace's reference count is decremented to 0 by a
- * bt_ctf_trace_put, the trace is freed.
- *
- * @param trace Trace instance.
- */
-extern void bt_ctf_trace_get(struct bt_ctf_trace *trace);
-extern void bt_ctf_trace_put(struct bt_ctf_trace *trace);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* BABELTRACE_CTF_IR_TRACE_H */
+/* Pre-2.0 CTF writer backward compatibility */
+#include <babeltrace/ctf-writer/trace.h>
This page took 0.025812 seconds and 4 git commands to generate.