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

#ifndef _LTT_EVENTS_H
#define _LTT_EVENTS_H

/*
 * ltt-events.h
 *
 * Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * Holds LTTng per-session event registry.
 */

#include <linux/list.h>
#include "ltt-debugfs-abi.h"

struct ltt_channel;
struct ltt_session;
struct lib_ring_buffer_ctx;

/*
 * ltt_event structure is referred to by the tracing fast path. It must be
 * kept small.
 */
struct ltt_event {
	unsigned int id;
	struct ltt_channel *chan;
	void *probe;
	void *filter;
	char *name;
	enum instrum_type itype;
	struct list_head list;		/* Event list */
};

struct ltt_channel_ops {
	struct channel *(*channel_create)(const char *name,
				struct ltt_session *session,
				void *buf_addr,
				size_t subbuf_size, size_t num_subbuf,
				unsigned int switch_timer_interval,
				unsigned int read_timer_interval);
	void (*channel_destroy)(struct channel *chan);
	struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
	void (*buffer_read_close)(struct lib_ring_buffer *buf);
	int (*event_reserve)(struct lib_ring_buffer_ctx *ctx);
	void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
	void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
			    size_t len);
};

struct ltt_channel {
	struct channel *chan;		/* Channel buffers */
	/* Event ID management */
	struct ltt_session *session;
	struct file *file;		/* File associated to channel */
	unsigned int free_event_id;	/* Next event ID to allocate */
	struct list_head list;		/* Channel list */
	wait_queue_head_t notify_wait;	/* Channel addition notif. waitqueue */
	struct ltt_channel_ops *ops;
};

struct ltt_session {
	int active;			/* Is trace session active ? */
	struct file *file;		/* File associated to session */
	struct list_head chan;		/* Channel list head */
	struct list_head events;	/* Event list head */
	struct list_head list;		/* Session list */
};

struct ltt_transport {
	char *name;
	struct module *owner;
	struct list_head node;
	struct ltt_channel_ops ops;
};

struct ltt_session *ltt_session_create(void);
int ltt_session_start(struct ltt_session *session);
int ltt_session_stop(struct ltt_session *session);
void ltt_session_destroy(struct ltt_session *session);

struct ltt_channel *ltt_channel_create(struct ltt_session *session,
				       int overwrite, void *buf_addr,
				       size_t subbuf_size, size_t num_subbuf,
				       unsigned int switch_timer_interval,
				       unsigned int read_timer_interval);
void _ltt_channel_destroy(struct ltt_channel *chan);

struct ltt_event *ltt_event_create(struct ltt_channel *chan,
				   char *name,
				   enum instrum_type itype,
				   void *probe, void *filter);
int _ltt_event_unregister(struct ltt_event *event);
void _ltt_event_destroy(struct ltt_event *event);

void ltt_transport_register(struct ltt_transport *transport);
void ltt_transport_unregister(struct ltt_transport *transport);

int ltt_debugfs_abi_init(void);
void ltt_debugfs_abi_exit(void);

int ltt_probe_register(const char *name, void *cb);
void ltt_probe_unregister(const char *name);
void *ltt_probe_get(const char *name);
void ltt_probe_put(void *cb);
int ltt_probes_init(void);
void ltt_probes_exit(void);

#endif /* _LTT_EVENTS_H */
Commit	Line	Data
11b5a3c2 MD	1	#ifndef _LTT_EVENTS_H
	2	#define _LTT_EVENTS_H
	3
4e3c1b9b MD	4	/*
	5	* ltt-events.h
	6	*
	7	* Copyright 2010 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* Holds LTTng per-session event registry.
	10	*/
	11
	12	#include <linux/list.h>
11b5a3c2	13	#include "ltt-debugfs-abi.h"
4e3c1b9b MD	14
	15	struct ltt_channel;
	16	struct ltt_session;
1c25284c	17	struct lib_ring_buffer_ctx;
4e3c1b9b MD	18
	19	/*
	20	* ltt_event structure is referred to by the tracing fast path. It must be
	21	* kept small.
	22	*/
	23	struct ltt_event {
	24	unsigned int id;
	25	struct ltt_channel *chan;
baf20995	26	void *probe;
4e3c1b9b MD	27	void *filter;
4e3c1b9b MD	28	char *name;
baf20995	29	enum instrum_type itype;
4e3c1b9b MD	30	struct list_head list; /* Event list */
	31	};
	32
11b5a3c2 MD	33	struct ltt_channel_ops {
	34	struct channel (channel_create)(const char *name,
	35	struct ltt_session *session,
	36	void *buf_addr,
	37	size_t subbuf_size, size_t num_subbuf,
	38	unsigned int switch_timer_interval,
	39	unsigned int read_timer_interval);
	40	void (channel_destroy)(struct channel chan);
	41	struct lib_ring_buffer (buffer_read_open)(struct channel *chan);
1c25284c MD	42	void (buffer_read_close)(struct lib_ring_buffer buf);
	43	int (event_reserve)(struct lib_ring_buffer_ctx ctx);
	44	void (event_commit)(struct lib_ring_buffer_ctx ctx);
e763dbf5 MD	45	void (event_write)(struct lib_ring_buffer_ctx ctx, const void *src,
e763dbf5 MD	46	size_t len);
11b5a3c2 MD	47	};
11b5a3c2 MD	48
4e3c1b9b MD	49	struct ltt_channel {
	50	struct channel chan; / Channel buffers */
	51	/* Event ID management */
	52	struct ltt_session *session;
d4e1a740	53	struct file file; / File associated to channel */
e5382b6d	54	unsigned int free_event_id; /* Next event ID to allocate */
4e3c1b9b	55	struct list_head list; /* Channel list */
653fe716	56	wait_queue_head_t notify_wait; /* Channel addition notif. waitqueue */
11b5a3c2	57	struct ltt_channel_ops *ops;
4e3c1b9b MD	58	};
	59
	60	struct ltt_session {
e5382b6d	61	int active; /* Is trace session active ? */
d4e1a740	62	struct file file; / File associated to session */
4e3c1b9b MD	63	struct list_head chan; /* Channel list head */
	64	struct list_head events; /* Event list head */
	65	struct list_head list; /* Session list */
4e3c1b9b MD	66	};
4e3c1b9b MD	67
c0e31d2e MD	68	struct ltt_transport {
	69	char *name;
	70	struct module *owner;
	71	struct list_head node;
11b5a3c2	72	struct ltt_channel_ops ops;
c0e31d2e MD	73	};
c0e31d2e MD	74
baf20995	75	struct ltt_session *ltt_session_create(void);
c0e31d2e MD	76	int ltt_session_start(struct ltt_session *session);
c0e31d2e MD	77	int ltt_session_stop(struct ltt_session *session);
11b5a3c2	78	void ltt_session_destroy(struct ltt_session *session);
4e3c1b9b	79
baf20995	80	struct ltt_channel ltt_channel_create(struct ltt_session session,
4e3c1b9b MD	81	int overwrite, void *buf_addr,
	82	size_t subbuf_size, size_t num_subbuf,
	83	unsigned int switch_timer_interval,
	84	unsigned int read_timer_interval);
11b5a3c2	85	void _ltt_channel_destroy(struct ltt_channel *chan);
4e3c1b9b	86
653fe716	87	struct ltt_event ltt_event_create(struct ltt_channel chan,
653fe716	88	char *name,
11b5a3c2 MD	89	enum instrum_type itype,
11b5a3c2 MD	90	void probe, void filter);
dda6a249 MD	91	int _ltt_event_unregister(struct ltt_event *event);
dda6a249 MD	92	void _ltt_event_destroy(struct ltt_event *event);
c0e31d2e MD	93
	94	void ltt_transport_register(struct ltt_transport *transport);
	95	void ltt_transport_unregister(struct ltt_transport *transport);
11b5a3c2	96
1c25284c MD	97	int ltt_debugfs_abi_init(void);
	98	void ltt_debugfs_abi_exit(void);
	99
02119ee5 MD	100	int ltt_probe_register(const char name, void cb);
	101	void ltt_probe_unregister(const char *name);
	102	void ltt_probe_get(const char name);
	103	void ltt_probe_put(void *cb);
	104	int ltt_probes_init(void);
	105	void ltt_probes_exit(void);
	106
11b5a3c2	107	#endif /* _LTT_EVENTS_H */