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

/*
 * Copyright (C) 2005,2006,2008 Mathieu Desnoyers (mathieu.desnoyers@polymtl.ca)
 *
 * This contains the definitions for the Linux Trace Toolkit tracer.
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#ifndef _LTT_TRACER_H
#define _LTT_TRACER_H

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