[lttng-modules.git] / ltt-tracer.h

#ifndef _LTT_TRACER_H
#define _LTT_TRACER_H

/*
 * ltt-tracer.h
 *
 * Copyright (C) 2005-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This contains the definitions for the Linux Trace Toolkit tracer.
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#include <stdarg.h>
#include <linux/types.h>
#include <linux/limits.h>
#include <linux/list.h>
#include <linux/cache.h>
#include <linux/timex.h>
#include <linux/wait.h>
#include <asm/atomic.h>
#include <asm/local.h>

#include "wrapper/trace-clock.h"
#include "ltt-tracer-core.h"
#include "ltt-events.h"

#define LTTNG_VERSION 0
#define LTTNG_PATCHLEVEL 9
#define LTTNG_SUBLEVEL 1

#ifndef CHAR_BIT
#define CHAR_BIT 8
#endif

/* Number of bytes to log with a read/write event */
#define LTT_LOG_RW_SIZE			32L

/* Maximum number of callbacks per marker */
#define LTT_NR_CALLBACKS	10

struct ltt_serialize_closure;

/* Serialization callback */
typedef size_t (*ltt_serialize_cb)(struct lib_ring_buffer *buf,
				   size_t buf_offset,
				   struct ltt_serialize_closure *closure,
				   void *serialize_private,
				   unsigned int stack_pos_ctx,
				   int *largest_align,
				   const char *fmt, va_list *args);

struct ltt_serialize_closure {
	ltt_serialize_cb *callbacks;
	long cb_args[LTT_NR_CALLBACKS];
	unsigned int cb_idx;
};

size_t ltt_serialize_data(struct lib_ring_buffer *buf, size_t buf_offset,
			  struct ltt_serialize_closure *closure,
			  void *serialize_private, unsigned int stack_pos_ctx,
			  int *largest_align, const char *fmt, va_list *args);

enum ltt_channels {
	LTT_CHANNEL_METADATA,
	LTT_CHANNEL_FD_STATE,
	LTT_CHANNEL_GLOBAL_STATE,
	LTT_CHANNEL_IRQ_STATE,
	LTT_CHANNEL_MODULE_STATE,
	LTT_CHANNEL_NETIF_STATE,
	LTT_CHANNEL_SOFTIRQ_STATE,
	LTT_CHANNEL_SWAP_STATE,
	LTT_CHANNEL_SYSCALL_STATE,
	LTT_CHANNEL_TASK_STATE,
	LTT_CHANNEL_VM_STATE,
	LTT_CHANNEL_FS,
	LTT_CHANNEL_INPUT,
	LTT_CHANNEL_IPC,
	LTT_CHANNEL_KERNEL,
	LTT_CHANNEL_MM,
	LTT_CHANNEL_RCU,
	LTT_CHANNEL_DEFAULT,
};

/*
 * Hardcoded event headers
 *
 * event header for a trace with active heartbeat : 27 bits timestamps
 *
 * headers are 32-bits aligned. In order to insure such alignment, a dynamic per
 * trace alignment value must be done.
 *
 * Remember that the C compiler does align each member on the boundary
 * equivalent to their own size.
 *
 * As relay subbuffers are aligned on pages, we are sure that they are 4 and 8
 * bytes aligned, so the buffer header and trace header are aligned.
 *
 * Event headers are aligned depending on the trace alignment option.
 *
 * Note using C structure bitfields for cross-endianness and portability
 * concerns.
 */

#define LTT_MAX_SMALL_SIZE		0xFFFFU

#ifdef RING_BUFFER_ALIGN
#define ltt_alignof(type)	__alignof__(type)
#else
#define ltt_alignof(type)	1
#endif

/* Tracer properties */
#define CTF_MAGIC_NUMBER		0xC1FC1FC1
#define TSDL_MAGIC_NUMBER		0x75D11D57
#define CTF_VERSION_MAJOR		0
#define CTF_VERSION_MINOR		1

/*
 * Number of milliseconds to retry before failing metadata writes on buffer full
 * condition. (10 seconds)
 */
#define LTTNG_METADATA_TIMEOUT_MSEC	10000

/*
 * Size reserved for high priority events (interrupts, NMI, BH) at the end of a
 * nearly full buffer. User space won't use this last amount of space when in
 * blocking mode. This space also includes the event header that would be
 * written by this user space event.
 */
#define LTT_RESERVE_CRITICAL		4096

#define LTT_RFLAG_EXTENDED		RING_BUFFER_RFLAG_END
#define LTT_RFLAG_END			(LTT_RFLAG_EXTENDED << 1)

/* Register and unregister function pointers */

enum ltt_module_function {
	LTT_FUNCTION_RUN_FILTER,
	LTT_FUNCTION_FILTER_CONTROL,
	LTT_FUNCTION_STATEDUMP
};

extern int ltt_module_register(enum ltt_module_function name, void *function,
			       struct module *owner);
extern void ltt_module_unregister(enum ltt_module_function name);

/* Exported control function */

void ltt_core_register(int (*function)(u8, void *));

void ltt_core_unregister(void);

extern
void ltt_statedump_register_kprobes_dump(void (*callback)(void *call_data));
extern
void ltt_statedump_unregister_kprobes_dump(void (*callback)(void *call_data));

extern void ltt_dump_softirq_vec(void *call_data);

#ifdef CONFIG_HAVE_LTT_DUMP_TABLES
extern void ltt_dump_sys_call_table(void *call_data);
extern void ltt_dump_idt_table(void *call_data);
#else
static inline void ltt_dump_sys_call_table(void *call_data)
{
}

static inline void ltt_dump_idt_table(void *call_data)
{
}
#endif

#endif /* _LTT_TRACER_H */
Commit	Line	Data
17baffe2 MD	1	#ifndef _LTT_TRACER_H
	2	#define _LTT_TRACER_H
	3
1c8284eb	4	/*
17baffe2 MD	5	* ltt-tracer.h
	6	*
	7	* Copyright (C) 2005-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
1c8284eb MD	8	*
	9	* This contains the definitions for the Linux Trace Toolkit tracer.
	10	*
	11	* Dual LGPL v2.1/GPL v2 license.
	12	*/
	13
1c8284eb MD	14	#include <stdarg.h>
	15	#include <linux/types.h>
	16	#include <linux/limits.h>
	17	#include <linux/list.h>
	18	#include <linux/cache.h>
1c8284eb MD	19	#include <linux/timex.h>
1c8284eb MD	20	#include <linux/wait.h>
1c8284eb MD	21	#include <asm/atomic.h>
	22	#include <asm/local.h>
	23
f3bc08c5	24	#include "wrapper/trace-clock.h"
1c8284eb	25	#include "ltt-tracer-core.h"
1c25284c	26	#include "ltt-events.h"
1c8284eb	27
80c16bcf MD	28	#define LTTNG_VERSION 0
	29	#define LTTNG_PATCHLEVEL 9
	30	#define LTTNG_SUBLEVEL 1
	31
c099397a MD	32	#ifndef CHAR_BIT
	33	#define CHAR_BIT 8
	34	#endif
	35
1c8284eb MD	36	/* Number of bytes to log with a read/write event */
	37	#define LTT_LOG_RW_SIZE 32L
	38
1c8284eb MD	39	/* Maximum number of callbacks per marker */
	40	#define LTT_NR_CALLBACKS 10
	41
11b5a3c2 MD	42	struct ltt_serialize_closure;
	43
	44	/* Serialization callback */
	45	typedef size_t (ltt_serialize_cb)(struct lib_ring_buffer buf,
	46	size_t buf_offset,
	47	struct ltt_serialize_closure *closure,
	48	void *serialize_private,
	49	unsigned int stack_pos_ctx,
	50	int *largest_align,
	51	const char fmt, va_list args);
	52
1c8284eb MD	53	struct ltt_serialize_closure {
	54	ltt_serialize_cb *callbacks;
	55	long cb_args[LTT_NR_CALLBACKS];
	56	unsigned int cb_idx;
	57	};
	58
11b5a3c2	59	size_t ltt_serialize_data(struct lib_ring_buffer *buf, size_t buf_offset,
1c8284eb MD	60	struct ltt_serialize_closure *closure,
	61	void *serialize_private, unsigned int stack_pos_ctx,
	62	int largest_align, const char fmt, va_list *args);
	63
1c8284eb MD	64	enum ltt_channels {
	65	LTT_CHANNEL_METADATA,
	66	LTT_CHANNEL_FD_STATE,
	67	LTT_CHANNEL_GLOBAL_STATE,
	68	LTT_CHANNEL_IRQ_STATE,
	69	LTT_CHANNEL_MODULE_STATE,
	70	LTT_CHANNEL_NETIF_STATE,
	71	LTT_CHANNEL_SOFTIRQ_STATE,
	72	LTT_CHANNEL_SWAP_STATE,
	73	LTT_CHANNEL_SYSCALL_STATE,
	74	LTT_CHANNEL_TASK_STATE,
	75	LTT_CHANNEL_VM_STATE,
	76	LTT_CHANNEL_FS,
	77	LTT_CHANNEL_INPUT,
	78	LTT_CHANNEL_IPC,
	79	LTT_CHANNEL_KERNEL,
	80	LTT_CHANNEL_MM,
	81	LTT_CHANNEL_RCU,
	82	LTT_CHANNEL_DEFAULT,
	83	};
	84
7514523f MD	85	/*
7514523f MD	86	* Hardcoded event headers
1c8284eb MD	87	*
	88	* event header for a trace with active heartbeat : 27 bits timestamps
	89	*
	90	* headers are 32-bits aligned. In order to insure such alignment, a dynamic per
	91	* trace alignment value must be done.
	92	*
	93	* Remember that the C compiler does align each member on the boundary
	94	* equivalent to their own size.
	95	*
	96	* As relay subbuffers are aligned on pages, we are sure that they are 4 and 8
	97	* bytes aligned, so the buffer header and trace header are aligned.
	98	*
	99	* Event headers are aligned depending on the trace alignment option.
	100	*
	101	* Note using C structure bitfields for cross-endianness and portability
	102	* concerns.
	103	*/
	104
1c8284eb MD	105	#define LTT_MAX_SMALL_SIZE 0xFFFFU
1c8284eb MD	106
d793d5e1	107	#ifdef RING_BUFFER_ALIGN
d793d5e1	108	#define ltt_alignof(type) __alignof__(type)
c099397a	109	#else
d793d5e1 MD	110	#define ltt_alignof(type) 1
d793d5e1 MD	111	#endif
1c8284eb	112
1c8284eb	113	/* Tracer properties */
1c25284c	114	#define CTF_MAGIC_NUMBER 0xC1FC1FC1
881833e3	115	#define TSDL_MAGIC_NUMBER 0x75D11D57
d793d5e1 MD	116	#define CTF_VERSION_MAJOR 0
d793d5e1 MD	117	#define CTF_VERSION_MINOR 1
1c8284eb	118
c099397a MD	119	/*
	120	* Number of milliseconds to retry before failing metadata writes on buffer full
	121	* condition. (10 seconds)
	122	*/
	123	#define LTTNG_METADATA_TIMEOUT_MSEC 10000
	124
1c8284eb MD	125	/*
	126	* Size reserved for high priority events (interrupts, NMI, BH) at the end of a
	127	* nearly full buffer. User space won't use this last amount of space when in
	128	* blocking mode. This space also includes the event header that would be
	129	* written by this user space event.
	130	*/
	131	#define LTT_RESERVE_CRITICAL 4096
	132
64c796d8 MD	133	#define LTT_RFLAG_EXTENDED RING_BUFFER_RFLAG_END
	134	#define LTT_RFLAG_END (LTT_RFLAG_EXTENDED << 1)
	135
1c8284eb MD	136	/* Register and unregister function pointers */
	137
	138	enum ltt_module_function {
	139	LTT_FUNCTION_RUN_FILTER,
	140	LTT_FUNCTION_FILTER_CONTROL,
	141	LTT_FUNCTION_STATEDUMP
	142	};
	143
	144	extern int ltt_module_register(enum ltt_module_function name, void *function,
	145	struct module *owner);
	146	extern void ltt_module_unregister(enum ltt_module_function name);
	147
1c8284eb MD	148	/* Exported control function */
1c8284eb MD	149
1c8284eb MD	150	void ltt_core_register(int (function)(u8, void ));
	151
	152	void ltt_core_unregister(void);
	153
1c8284eb MD	154	extern
	155	void ltt_statedump_register_kprobes_dump(void (callback)(void call_data));
	156	extern
	157	void ltt_statedump_unregister_kprobes_dump(void (callback)(void call_data));
	158
	159	extern void ltt_dump_softirq_vec(void *call_data);
	160
f277b4c1	161	#ifdef CONFIG_HAVE_LTT_DUMP_TABLES
1c8284eb MD	162	extern void ltt_dump_sys_call_table(void *call_data);
1c8284eb MD	163	extern void ltt_dump_idt_table(void *call_data);
f277b4c1 MD	164	#else
	165	static inline void ltt_dump_sys_call_table(void *call_data)
	166	{
	167	}
	168
	169	static inline void ltt_dump_idt_table(void *call_data)
	170	{
	171	}
	172	#endif
1c8284eb	173
1c8284eb	174	#endif /* _LTT_TRACER_H */