[babeltrace.git] / include / babeltrace / ctf-text / types.h

#ifndef _BABELTRACE_CTF_TEXT_TYPES_H
#define _BABELTRACE_CTF_TEXT_TYPES_H

/*
 * Common Trace Format (Text Output)
 *
 * Type header
 *
 * Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@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 <sys/mman.h>
#include <errno.h>
#include <stdint.h>
#include <unistd.h>
#include <glib.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/types.h>
#include <babeltrace/format.h>

/*
 * Inherit from both struct stream_pos and struct trace_descriptor.
 */
struct ctf_text_stream_pos {
	struct stream_pos parent;
	struct trace_descriptor trace_descriptor;
	FILE *fp;		/* File pointer. NULL if unset. */
	int depth;
	int dummy;		/* disable output */
	int print_names;	/* print field names */
	int field_nr;
	uint64_t last_real_timestamp;	/* to print delta */
	uint64_t last_cycles_timestamp;	/* to print delta */
	GString *string;	/* Current string */
};

static inline
struct ctf_text_stream_pos *ctf_text_pos(struct stream_pos *pos)
{
	return container_of(pos, struct ctf_text_stream_pos, parent);
}

/*
 * Write only is supported for now.
 */
BT_HIDDEN
int ctf_text_integer_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_float_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_string_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_enum_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_struct_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_variant_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_array_write(struct stream_pos *pos, struct definition *definition);
BT_HIDDEN
int ctf_text_sequence_write(struct stream_pos *pos, struct definition *definition);

static inline
void print_pos_tabs(struct ctf_text_stream_pos *pos)
{
	int i;

	for (i = 0; i < pos->depth; i++)
		fprintf(pos->fp, "\t");
}

/*
 * Check if the field must be printed.
 */
BT_HIDDEN
int print_field(struct definition *definition);

#endif /* _BABELTRACE_CTF_TEXT_TYPES_H */
Commit	Line	Data
46322b33 MD	1	#ifndef _BABELTRACE_CTF_TEXT_TYPES_H
	2	#define _BABELTRACE_CTF_TEXT_TYPES_H
	3
	4	/*
	5	* Common Trace Format (Text Output)
	6	*
	7	* Type header
	8	*
	9	* Copyright 2010 - Mathieu Desnoyers <mathieu.desnoyers@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.
c462e188 MD	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.
46322b33 MD	28	*/
	29
	30	#include <sys/mman.h>
	31	#include <errno.h>
	32	#include <stdint.h>
	33	#include <unistd.h>
	34	#include <glib.h>
70bd0a12	35	#include <babeltrace/babeltrace-internal.h>
46322b33	36	#include <babeltrace/types.h>
1ae19169	37	#include <babeltrace/format.h>
46322b33	38
1ae19169 MD	39	/*
	40	* Inherit from both struct stream_pos and struct trace_descriptor.
	41	*/
46322b33	42	struct ctf_text_stream_pos {
1ae19169 MD	43	struct stream_pos parent;
1ae19169 MD	44	struct trace_descriptor trace_descriptor;
46322b33	45	FILE fp; / File pointer. NULL if unset. */
1ae19169 MD	46	int depth;
1ae19169 MD	47	int dummy; /* disable output */
31262354	48	int print_names; /* print field names */
fd3382e8	49	int field_nr;
03798a93 JD	50	uint64_t last_real_timestamp; /* to print delta */
03798a93 JD	51	uint64_t last_cycles_timestamp; /* to print delta */
81dee1bb	52	GString string; / Current string */
46322b33 MD	53	};
46322b33 MD	54
1ae19169 MD	55	static inline
	56	struct ctf_text_stream_pos ctf_text_pos(struct stream_pos pos)
	57	{
	58	return container_of(pos, struct ctf_text_stream_pos, parent);
	59	}
	60
46322b33	61	/*
1ae19169	62	* Write only is supported for now.
46322b33	63	*/
90b55a97	64	BT_HIDDEN
c5e74408	65	int ctf_text_integer_write(struct stream_pos pos, struct definition definition);
90b55a97	66	BT_HIDDEN
c5e74408	67	int ctf_text_float_write(struct stream_pos pos, struct definition definition);
90b55a97	68	BT_HIDDEN
c5e74408	69	int ctf_text_string_write(struct stream_pos pos, struct definition definition);
90b55a97	70	BT_HIDDEN
c5e74408	71	int ctf_text_enum_write(struct stream_pos pos, struct definition definition);
90b55a97	72	BT_HIDDEN
c5e74408	73	int ctf_text_struct_write(struct stream_pos pos, struct definition definition);
90b55a97	74	BT_HIDDEN
c5e74408	75	int ctf_text_variant_write(struct stream_pos pos, struct definition definition);
90b55a97	76	BT_HIDDEN
c5e74408	77	int ctf_text_array_write(struct stream_pos pos, struct definition definition);
90b55a97	78	BT_HIDDEN
c5e74408	79	int ctf_text_sequence_write(struct stream_pos pos, struct definition definition);
46322b33	80
1ae19169 MD	81	static inline
	82	void print_pos_tabs(struct ctf_text_stream_pos *pos)
	83	{
	84	int i;
46322b33	85
1ae19169 MD	86	for (i = 0; i < pos->depth; i++)
	87	fprintf(pos->fp, "\t");
	88	}
46322b33	89
d335f0f7 MD	90	/*
	91	* Check if the field must be printed.
	92	*/
90b55a97	93	BT_HIDDEN
d335f0f7 MD	94	int print_field(struct definition *definition);
d335f0f7 MD	95
46322b33	96	#endif /* _BABELTRACE_CTF_TEXT_TYPES_H */