[babeltrace.git] / include / babeltrace / ctf-ir / clock-internal.h

#ifndef BABELTRACE_CTF_IR_CLOCK_INTERNAL_H
#define BABELTRACE_CTF_IR_CLOCK_INTERNAL_H

/*
 * BabelTrace - CTF IR: Clock internal
 *
 * Copyright 2013, 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.
 */

#include <babeltrace/ctf-writer/clock.h>
#include <babeltrace/ctf-ir/trace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/babeltrace-internal.h>
#include <glib.h>
#include <babeltrace/compat/uuid.h>

struct bt_ctf_clock {
	struct bt_object base;
	GString *name;
	GString *description;
	uint64_t frequency;
	uint64_t precision;
	int64_t offset_s;	/* Offset in seconds */
	int64_t offset;		/* Offset in ticks */
	uint64_t value;		/* Current clock value */
	uuid_t uuid;
	int uuid_set;
	int absolute;

	/*
	 * This field is set once a clock is added to a trace. If the
	 * trace was created by a CTF writer, then the clock's value
	 * can be set and returned. Otherwise both functions fail
	 * because, in non-writer mode, clocks do not have global
	 * values: values are per-stream.
	 */
	int has_value;

	/*
	 * A clock's properties can't be modified once it is added to a stream
	 * class.
	 */
	int frozen;
};

/*
 * This is not part of the public API to prevent users from creating clocks
 * in an invalid state (being nameless, in this case).
 *
 * The only legitimate use-case for this function is to allocate a clock
 * while the TSDL metadata is being parsed.
 */
BT_HIDDEN
struct bt_ctf_clock *_bt_ctf_clock_create(void);

/*
 * Not exposed as part of the public API since the only usecase
 * for this is when we are creating clocks from the TSDL metadata.
 */
BT_HIDDEN
int bt_ctf_clock_set_name(struct bt_ctf_clock *clock,
		const char *name);

BT_HIDDEN
void bt_ctf_clock_freeze(struct bt_ctf_clock *clock);

BT_HIDDEN
void bt_ctf_clock_serialize(struct bt_ctf_clock *clock,
		struct metadata_context *context);

#endif /* BABELTRACE_CTF_IR_CLOCK_INTERNAL_H */
Commit	Line	Data
adc315b8 JG	1	#ifndef BABELTRACE_CTF_IR_CLOCK_INTERNAL_H
adc315b8 JG	2	#define BABELTRACE_CTF_IR_CLOCK_INTERNAL_H
273b65be JG	3
273b65be JG	4	/*
adc315b8	5	* BabelTrace - CTF IR: Clock internal
273b65be	6	*
de9dd397	7	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
273b65be JG	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@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	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
273b65be	30	#include <babeltrace/ctf-writer/clock.h>
bc37ae52	31	#include <babeltrace/ctf-ir/trace-internal.h>
83509119	32	#include <babeltrace/object-internal.h>
273b65be JG	33	#include <babeltrace/babeltrace-internal.h>
273b65be JG	34	#include <glib.h>
be018f15	35	#include <babeltrace/compat/uuid.h>
273b65be JG	36
273b65be JG	37	struct bt_ctf_clock {
83509119	38	struct bt_object base;
273b65be JG	39	GString *name;
	40	GString *description;
	41	uint64_t frequency;
	42	uint64_t precision;
61cf588b MD	43	int64_t offset_s; /* Offset in seconds */
61cf588b MD	44	int64_t offset; /* Offset in ticks */
e1e30a8c	45	uint64_t value; /* Current clock value */
273b65be	46	uuid_t uuid;
be018f15	47	int uuid_set;
273b65be	48	int absolute;
cfeb617e PP	49
	50	/*
	51	* This field is set once a clock is added to a trace. If the
	52	* trace was created by a CTF writer, then the clock's value
	53	* can be set and returned. Otherwise both functions fail
	54	* because, in non-writer mode, clocks do not have global
	55	* values: values are per-stream.
	56	*/
	57	int has_value;
	58
273b65be JG	59	/*
	60	* A clock's properties can't be modified once it is added to a stream
	61	* class.
	62	*/
	63	int frozen;
	64	};
	65
4c426c17 JG	66	/*
	67	* This is not part of the public API to prevent users from creating clocks
	68	* in an invalid state (being nameless, in this case).
	69	*
	70	* The only legitimate use-case for this function is to allocate a clock
	71	* while the TSDL metadata is being parsed.
	72	*/
	73	BT_HIDDEN
	74	struct bt_ctf_clock *_bt_ctf_clock_create(void);
	75
	76	/*
	77	* Not exposed as part of the public API since the only usecase
	78	* for this is when we are creating clocks from the TSDL metadata.
	79	*/
	80	BT_HIDDEN
	81	int bt_ctf_clock_set_name(struct bt_ctf_clock *clock,
	82	const char *name);
	83
273b65be JG	84	BT_HIDDEN
	85	void bt_ctf_clock_freeze(struct bt_ctf_clock *clock);
	86
	87	BT_HIDDEN
	88	void bt_ctf_clock_serialize(struct bt_ctf_clock *clock,
	89	struct metadata_context *context);
	90
adc315b8	91	#endif /* BABELTRACE_CTF_IR_CLOCK_INTERNAL_H */