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

#ifndef BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H
#define BABELTRACE_CTF_IR_CLOCK_CLASS_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-ir/clock-class.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-internal.h>

struct bt_ctf_clock_class {
	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 */
	uuid_t uuid;
	int uuid_set;
	int absolute;

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

struct bt_ctf_clock_value {
	struct bt_object base;
	struct bt_ctf_clock_class *clock_class;
	uint64_t value;
};

BT_HIDDEN
void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class *clock_class);

BT_HIDDEN
void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class *clock_class,
		struct metadata_context *context);

BT_HIDDEN
bool bt_ctf_clock_class_is_valid(struct bt_ctf_clock_class *clock_class);

#endif /* BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H */
Commit	Line	Data
ac0c6bdd PP	1	#ifndef BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H
ac0c6bdd PP	2	#define BABELTRACE_CTF_IR_CLOCK_CLASS_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
ac0c6bdd	30	#include <babeltrace/ctf-ir/clock-class.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>
3d9990ac	35	#include <babeltrace/compat/uuid-internal.h>
273b65be	36
ac0c6bdd	37	struct bt_ctf_clock_class {
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 */
273b65be	45	uuid_t uuid;
be018f15	46	int uuid_set;
273b65be	47	int absolute;
cfeb617e	48
273b65be JG	49	/*
	50	* A clock's properties can't be modified once it is added to a stream
	51	* class.
	52	*/
	53	int frozen;
	54	};
	55
61ec14e6 JG	56	struct bt_ctf_clock_value {
61ec14e6 JG	57	struct bt_object base;
ac0c6bdd	58	struct bt_ctf_clock_class *clock_class;
61ec14e6 JG	59	uint64_t value;
	60	};
	61
273b65be	62	BT_HIDDEN
ac0c6bdd	63	void bt_ctf_clock_class_freeze(struct bt_ctf_clock_class *clock_class);
273b65be JG	64
273b65be JG	65	BT_HIDDEN
ac0c6bdd	66	void bt_ctf_clock_class_serialize(struct bt_ctf_clock_class *clock_class,
273b65be JG	67	struct metadata_context *context);
273b65be JG	68
c06116f3	69	BT_HIDDEN
ac0c6bdd	70	bool bt_ctf_clock_class_is_valid(struct bt_ctf_clock_class *clock_class);
24626e8b	71
ac0c6bdd	72	#endif /* BABELTRACE_CTF_IR_CLOCK_CLASS_INTERNAL_H */