Handle negative time and offset from Epoch

[babeltrace.git] / include / babeltrace / trace-handle.h

#ifndef _BABELTRACE_TRACE_HANDLE_H
#define _BABELTRACE_TRACE_HANDLE_H

/*
 * BabelTrace
 *
 * trace_handle header
 *
 * Copyright 2012 EfficiOS Inc. and Linux Foundation
 *
 * Author: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *         Julien Desfossez <julien.desfossez@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.
 */

#include <stdint.h>
#include <babeltrace/clock-types.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * trace_handle : unique identifier of a trace
 *
 * The trace_handle allows the user to manipulate a trace file directly.
 * It is a unique identifier representing a trace file.
 */
struct bt_trace_handle;
struct bt_ctf_event;

/*
 * bt_trace_handle_get_path : returns the path of a trace_handle or NULL
 * on error.
 */
const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);

/*
 * bt_trace_handle_get_timestamp_begin : get the creation time (in
 * nanoseconds or cycles depending on type) of the buffers of a trace.
 *
 * Returns 0 on success, -1 on error.
 */
int bt_trace_handle_get_timestamp_begin(struct bt_context *ctx,
		int handle_id, enum bt_clock_type type,
		int64_t *timestamp);

/*
 * bt_trace_handle_get_timestamp_end : get the destruction time
 * (in nanoseconds or cycles depending on type) of the buffers of a
 * trace.
 *
 * Returns 0 on success, -1 on error.
 */
int bt_trace_handle_get_timestamp_end(struct bt_context *ctx,
		int handle_id, enum bt_clock_type type,
		int64_t *timestamp);

/*
 * bt_ctf_event_get_handle_id : get the handle id associated with an event
 *
 * Returns -1 on error
 */
int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);

#ifdef __cplusplus
}
#endif

#endif /* _BABELTRACE_TRACE_HANDLE_H */