[linux-block.git] / include / linux / trace.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_TRACE_H
#define _LINUX_TRACE_H

#define TRACE_EXPORT_FUNCTION	BIT(0)
#define TRACE_EXPORT_EVENT	BIT(1)
#define TRACE_EXPORT_MARKER	BIT(2)

/*
 * The trace export - an export of Ftrace output. The trace_export
 * can process traces and export them to a registered destination as
 * an addition to the current only output of Ftrace - i.e. ring buffer.
 *
 * If you want traces to be sent to some other place rather than ring
 * buffer only, just need to register a new trace_export and implement
 * its own .write() function for writing traces to the storage.
 *
 * next		- pointer to the next trace_export
 * write	- copy traces which have been delt with ->commit() to
 *		  the destination
 * flags	- which ftrace to be exported
 */
struct trace_export {
	struct trace_export __rcu	*next;
	void (*write)(struct trace_export *, const void *, unsigned int);
	int flags;
};

struct trace_array;

#ifdef CONFIG_TRACING

int register_ftrace_export(struct trace_export *export);
int unregister_ftrace_export(struct trace_export *export);

void trace_printk_init_buffers(void);
__printf(3, 4)
int trace_array_printk(struct trace_array *tr, unsigned long ip,
		       const char *fmt, ...);
int trace_array_init_printk(struct trace_array *tr);
void trace_array_put(struct trace_array *tr);
struct trace_array *trace_array_get_by_name(const char *name);
int trace_array_destroy(struct trace_array *tr);

/* For osnoise tracer */
int osnoise_arch_register(void);
void osnoise_arch_unregister(void);
void osnoise_trace_irq_entry(int id);
void osnoise_trace_irq_exit(int id, const char *desc);

#else /* CONFIG_TRACING */
static inline int register_ftrace_export(struct trace_export *export)
{
	return -EINVAL;
}
static inline int unregister_ftrace_export(struct trace_export *export)
{
	return 0;
}
static inline void trace_printk_init_buffers(void)
{
}
static inline int trace_array_printk(struct trace_array *tr, unsigned long ip,
				     const char *fmt, ...)
{
	return 0;
}
static inline int trace_array_init_printk(struct trace_array *tr)
{
	return -EINVAL;
}
static inline void trace_array_put(struct trace_array *tr)
{
}
static inline struct trace_array *trace_array_get_by_name(const char *name)
{
	return NULL;
}
static inline int trace_array_destroy(struct trace_array *tr)
{
	return 0;
}
#endif	/* CONFIG_TRACING */

#endif	/* _LINUX_TRACE_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
478409dd CZ	2	#ifndef _LINUX_TRACE_H
	3	#define _LINUX_TRACE_H
	4
8438f521	5	#define TRACE_EXPORT_FUNCTION BIT(0)
8ab7a2b7	6	#define TRACE_EXPORT_EVENT BIT(1)
458999c6	7	#define TRACE_EXPORT_MARKER BIT(2)
8438f521	8
478409dd CZ	9	/*
	10	* The trace export - an export of Ftrace output. The trace_export
	11	* can process traces and export them to a registered destination as
	12	* an addition to the current only output of Ftrace - i.e. ring buffer.
	13	*
	14	* If you want traces to be sent to some other place rather than ring
	15	* buffer only, just need to register a new trace_export and implement
	16	* its own .write() function for writing traces to the storage.
	17	*
	18	* next - pointer to the next trace_export
	19	* write - copy traces which have been delt with ->commit() to
	20	* the destination
8438f521	21	* flags - which ftrace to be exported
478409dd CZ	22	*/
	23	struct trace_export {
	24	struct trace_export __rcu *next;
a773d419	25	void (write)(struct trace_export , const void *, unsigned int);
8438f521	26	int flags;
478409dd CZ	27	};
478409dd CZ	28
bedf0683 AS	29	struct trace_array;
bedf0683 AS	30
1a77dd1c AE	31	#ifdef CONFIG_TRACING
1a77dd1c AE	32
478409dd CZ	33	int register_ftrace_export(struct trace_export *export);
	34	int unregister_ftrace_export(struct trace_export *export);
	35
2d6425af	36	void trace_printk_init_buffers(void);
bd0c9706	37	__printf(3, 4)
2d6425af	38	int trace_array_printk(struct trace_array *tr, unsigned long ip,
bd0c9706	39	const char *fmt, ...);
38ce2a9e	40	int trace_array_init_printk(struct trace_array *tr);
28879787 DI	41	void trace_array_put(struct trace_array *tr);
28879787 DI	42	struct trace_array trace_array_get_by_name(const char name);
2d6425af	43	int trace_array_destroy(struct trace_array *tr);
bce29ac9 DBO	44
	45	/* For osnoise tracer */
	46	int osnoise_arch_register(void);
	47	void osnoise_arch_unregister(void);
f7d9f637 DBO	48	void osnoise_trace_irq_entry(int id);
f7d9f637 DBO	49	void osnoise_trace_irq_exit(int id, const char *desc);
bce29ac9	50
1a77dd1c AE	51	#else /* CONFIG_TRACING */
	52	static inline int register_ftrace_export(struct trace_export *export)
	53	{
	54	return -EINVAL;
	55	}
	56	static inline int unregister_ftrace_export(struct trace_export *export)
	57	{
	58	return 0;
	59	}
	60	static inline void trace_printk_init_buffers(void)
	61	{
	62	}
	63	static inline int trace_array_printk(struct trace_array *tr, unsigned long ip,
	64	const char *fmt, ...)
	65	{
	66	return 0;
	67	}
	68	static inline int trace_array_init_printk(struct trace_array *tr)
	69	{
	70	return -EINVAL;
	71	}
	72	static inline void trace_array_put(struct trace_array *tr)
	73	{
	74	}
	75	static inline struct trace_array trace_array_get_by_name(const char name)
	76	{
	77	return NULL;
	78	}
	79	static inline int trace_array_destroy(struct trace_array *tr)
	80	{
	81	return 0;
	82	}
478409dd CZ	83	#endif /* CONFIG_TRACING */
	84
	85	#endif /* _LINUX_TRACE_H */