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

#ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H
#define BABELTRACE_CTF_IR_EVENT_INTERNAL_H

/*
 * Babeltrace - CTF IR: Event 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/event-types.h>
#include <babeltrace/ctf-writer/event-fields.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/values.h>
#include <babeltrace/ctf/types.h>
#include <babeltrace/ctf-ir/stream-class.h>
#include <babeltrace/ctf-ir/stream.h>
#include <babeltrace/ctf-ir/packet.h>
#include <babeltrace/object-internal.h>
#include <glib.h>

struct bt_ctf_event {
	struct bt_object base;
	struct bt_ctf_event_class *event_class;
	struct bt_ctf_packet *packet;
	struct bt_ctf_field *event_header;
	struct bt_ctf_field *stream_event_context;
	struct bt_ctf_field *context_payload;
	struct bt_ctf_field *fields_payload;
	/* Maps clock classes to bt_ctf_clock_value. */
	GHashTable *clock_values;
	int frozen;
};

BT_HIDDEN
int bt_ctf_event_validate(struct bt_ctf_event *event);

BT_HIDDEN
int bt_ctf_event_serialize(struct bt_ctf_event *event,
		struct ctf_stream_pos *pos);

/*
 * Attempt to populate the "id" and "timestamp" fields of the event header if
 * they are present, unset and their types are integers.
 *
 * Not finding these fields or encountering unexpected types is not an error
 * since the user may have defined a different event header layout. In this
 * case, it is expected that the fields be manually populated before appending
 * an event to a stream.
 */
BT_HIDDEN
int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);

BT_HIDDEN
void bt_ctf_event_freeze(struct bt_ctf_event *event);

#endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_CTF_IR_EVENT_INTERNAL_H
	2	#define BABELTRACE_CTF_IR_EVENT_INTERNAL_H
	3
	4	/*
	5	* Babeltrace - CTF IR: Event internal
	6	*
	7	* Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	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
	30	#include <babeltrace/ctf-writer/event-types.h>
	31	#include <babeltrace/ctf-writer/event-fields.h>
	32	#include <babeltrace/babeltrace-internal.h>
	33	#include <babeltrace/values.h>
	34	#include <babeltrace/ctf/types.h>
	35	#include <babeltrace/ctf-ir/stream-class.h>
	36	#include <babeltrace/ctf-ir/stream.h>
	37	#include <babeltrace/ctf-ir/packet.h>
	38	#include <babeltrace/object-internal.h>
	39	#include <glib.h>
	40
	41	struct bt_ctf_event {
	42	struct bt_object base;
	43	struct bt_ctf_event_class *event_class;
	44	struct bt_ctf_packet *packet;
	45	struct bt_ctf_field *event_header;
	46	struct bt_ctf_field *stream_event_context;
	47	struct bt_ctf_field *context_payload;
	48	struct bt_ctf_field *fields_payload;
	49	/* Maps clock classes to bt_ctf_clock_value. */
	50	GHashTable *clock_values;
	51	int frozen;
	52	};
	53
	54	BT_HIDDEN
	55	int bt_ctf_event_validate(struct bt_ctf_event *event);
	56
	57	BT_HIDDEN
	58	int bt_ctf_event_serialize(struct bt_ctf_event *event,
	59	struct ctf_stream_pos *pos);
	60
	61	/*
	62	* Attempt to populate the "id" and "timestamp" fields of the event header if
	63	* they are present, unset and their types are integers.
	64	*
	65	* Not finding these fields or encountering unexpected types is not an error
	66	* since the user may have defined a different event header layout. In this
	67	* case, it is expected that the fields be manually populated before appending
	68	* an event to a stream.
	69	*/
	70	BT_HIDDEN
	71	int bt_ctf_event_populate_event_header(struct bt_ctf_event *event);
	72
	73	BT_HIDDEN
	74	void bt_ctf_event_freeze(struct bt_ctf_event *event);
	75
	76	#endif /* BABELTRACE_CTF_IR_EVENT_INTERNAL_H */