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

#ifndef _BABELTRACE_TRACE_DEBUGINFO_H
#define _BABELTRACE_TRACE_DEBUGINFO_H

/*
 * Babeltrace - Debug information state tracker wrapper
 *
 * Copyright (c) 2015 EfficiOS Inc.
 * Copyright (c) 2015 Antoine Busque <abusque@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/metadata.h>

#ifdef ENABLE_DEBUGINFO

#include <babeltrace/debuginfo.h>
#include <babeltrace/ctf-text/types.h>
#include <stdbool.h>

static inline
void ctf_text_integer_write_debug_info(struct bt_stream_pos *ppos,
		struct bt_definition *definition)
{
	struct definition_integer *integer_definition =
			container_of(definition, struct definition_integer, p);
	struct ctf_text_stream_pos *pos = ctf_text_pos(ppos);
	struct debug_info_source *debug_info_src =
			integer_definition->debug_info_src;

	/* Print debug info if available */
	if (debug_info_src) {
		if (debug_info_src->func || debug_info_src->filename) {
			bool add_comma = false;

			fprintf(pos->fp, ", debug_info = { ");

			if (debug_info_src->func) {
				fprintf(pos->fp, "func = \"%s\"",
						debug_info_src->func);
				add_comma = true;
			}

			if (debug_info_src->filename) {
				if (add_comma) {
					fprintf(pos->fp, ", ");
				}

				fprintf(pos->fp, "source_loc = \"%s:%" PRIu64
						"\"",
						debug_info_src->filename,
						debug_info_src->line_no);
			}

			fprintf(pos->fp, " }");
		}
	}
}

static inline
int trace_debug_info_create(struct ctf_trace *trace)
{
	int ret = 0;

	if (strcmp(trace->env.domain, "ust") != 0) {
		goto end;
	}

	if (strcmp(trace->env.tracer_name, "lttng-ust") != 0) {
		goto end;
	}

	trace->debug_info = debug_info_create();
	if (!trace->debug_info) {
		ret = -1;
		goto end;
	}

end:
	return ret;
}

static inline
void trace_debug_info_destroy(struct ctf_trace *trace)
{
	debug_info_destroy(trace->debug_info);
}

static inline
void handle_debug_info_event(struct ctf_stream_declaration *stream_class,
		struct ctf_event_definition *event)
{
	debug_info_handle_event(stream_class->trace->debug_info, event);
}

#else  /* #ifdef ENABLE_DEBUGINFO */

static inline
void ctf_text_integer_write_debug_info(struct bt_stream_pos *ppos,
		struct bt_definition *definition)
{
	/* Do nothing. */
}

static inline
int trace_debug_info_create(struct ctf_trace *trace)
{
	return 0;
}

static inline
void trace_debug_info_destroy(struct ctf_trace *trace)
{
	/* Do nothing. */
}

static inline
void handle_debug_info_event(struct ctf_stream_declaration *stream_class,
		struct ctf_event_definition *event)
{
	/* Do nothing. */
}

#endif	/* #else #ifdef ENABLE_DEBUGINFO */

#endif /* _BABELTRACE_TRACE_DEBUGINFO_H */
Commit	Line	Data
b5a8598f AB	1	#ifndef _BABELTRACE_TRACE_DEBUGINFO_H
	2	#define _BABELTRACE_TRACE_DEBUGINFO_H
	3
	4	/*
	5	* Babeltrace - Debug information state tracker wrapper
	6	*
	7	* Copyright (c) 2015 EfficiOS Inc.
	8	* Copyright (c) 2015 Antoine Busque <abusque@efficios.com>
	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
	27	*/
	28
	29	#include <babeltrace/ctf-ir/metadata.h>
	30
	31	#ifdef ENABLE_DEBUGINFO
	32
	33	#include <babeltrace/debuginfo.h>
	34	#include <babeltrace/ctf-text/types.h>
	35	#include <stdbool.h>
	36
	37	static inline
	38	void ctf_text_integer_write_debug_info(struct bt_stream_pos *ppos,
	39	struct bt_definition *definition)
	40	{
	41	struct definition_integer *integer_definition =
	42	container_of(definition, struct definition_integer, p);
	43	struct ctf_text_stream_pos *pos = ctf_text_pos(ppos);
	44	struct debug_info_source *debug_info_src =
	45	integer_definition->debug_info_src;
	46
	47	/* Print debug info if available */
	48	if (debug_info_src) {
	49	if (debug_info_src->func \|\| debug_info_src->filename) {
	50	bool add_comma = false;
	51
	52	fprintf(pos->fp, ", debug_info = { ");
	53
	54	if (debug_info_src->func) {
	55	fprintf(pos->fp, "func = \"%s\"",
	56	debug_info_src->func);
	57	add_comma = true;
	58	}
	59
	60	if (debug_info_src->filename) {
	61	if (add_comma) {
	62	fprintf(pos->fp, ", ");
	63	}
	64
65	fprintf(pos->fp, "source_loc = \"%s:%" PRIu64
66	"\"",
67	debug_info_src->filename,
68	debug_info_src->line_no);
69	}
70
71	fprintf(pos->fp, " }");
72	}
73	}
74	}
75
76	static inline
77	int trace_debug_info_create(struct ctf_trace *trace)
78	{
79	int ret = 0;
80
81	if (strcmp(trace->env.domain, "ust") != 0) {
82	goto end;
83	}
84
85	if (strcmp(trace->env.tracer_name, "lttng-ust") != 0) {
86	goto end;
87	}
88
89	trace->debug_info = debug_info_create();
90	if (!trace->debug_info) {
91	ret = -1;
92	goto end;
93	}
94
95	end:
96	return ret;
97	}
98
99	static inline
100	void trace_debug_info_destroy(struct ctf_trace *trace)
101	{
102	debug_info_destroy(trace->debug_info);
103	}
104
105	static inline
106	void handle_debug_info_event(struct ctf_stream_declaration *stream_class,
107	struct ctf_event_definition *event)
108	{
109	debug_info_handle_event(stream_class->trace->debug_info, event);
110	}
111
112	#else /* #ifdef ENABLE_DEBUGINFO */
113
114	static inline
115	void ctf_text_integer_write_debug_info(struct bt_stream_pos *ppos,
116	struct bt_definition *definition)
117	{
118	/* Do nothing. */
119	}
120
121	static inline
122	int trace_debug_info_create(struct ctf_trace *trace)
123	{
124	return 0;
125	}
126
127	static inline
128	void trace_debug_info_destroy(struct ctf_trace *trace)
129	{
130	/* Do nothing. */
131	}
132
133	static inline
134	void handle_debug_info_event(struct ctf_stream_declaration *stream_class,
135	struct ctf_event_definition *event)
136	{
137	/* Do nothing. */
138	}
139
140	#endif /* #else #ifdef ENABLE_DEBUGINFO */
141
142	#endif /* _BABELTRACE_TRACE_DEBUGINFO_H */