[lttng-ust.git] / include / lttng / ust-abi.h

#ifndef _LTTNG_UST_ABI_H
#define _LTTNG_UST_ABI_H

/*
 * lttng/ust-abi.h
 *
 * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * LTTng-UST ABI header
 *
 * Dual LGPL v2.1/GPL v2 license.
 */

#include <stdint.h>

#define LTTNG_UST_SYM_NAME_LEN	128

#define LTTNG_UST_COMM_VERSION_MAJOR		0
#define LTTNG_UST_COMM_VERSION_MINOR		1

enum lttng_ust_instrumentation {
	LTTNG_UST_TRACEPOINT	= 0,
	LTTNG_UST_PROBE		= 1,
	LTTNG_UST_FUNCTION	= 2,
};

enum lttng_ust_output {
	LTTNG_UST_MMAP		= 0,
};

struct lttng_ust_tracer_version {
	uint32_t version;
	uint32_t patchlevel;
	uint32_t sublevel;
};

struct lttng_ust_channel {
	int overwrite;				/* 1: overwrite, 0: discard */
	uint64_t subbuf_size;			/* in bytes */
	uint64_t num_subbuf;
	unsigned int switch_timer_interval;	/* usecs */
	unsigned int read_timer_interval;	/* usecs */
	enum lttng_ust_output output;		/* output mode */
	/* The following fields are used internally within UST. */
	int shm_fd;
	int wait_fd;
	uint64_t memory_map_size;
};

/*
 * This structure is only used internally within UST. It is not per-se
 * part of the communication between sessiond and UST.
 */
struct lttng_ust_stream {
	int shm_fd;
	int wait_fd;
	uint64_t memory_map_size;
};

struct lttng_ust_event {
	char name[LTTNG_UST_SYM_NAME_LEN];	/* event name */
	enum lttng_ust_instrumentation instrumentation;
	/* Per instrumentation type configuration */
	union {
	} u;
};

enum lttng_ust_context_type {
	LTTNG_UST_CONTEXT_VTID			= 0,
	LTTNG_UST_CONTEXT_VPID			= 1,
	LTTNG_UST_CONTEXT_PTHREAD_ID		= 2,
	LTTNG_UST_CONTEXT_PROCNAME		= 3,
};

struct lttng_ust_context {
	enum lttng_ust_context_type ctx;
	union {
	} u;
};

/*
 * Tracer channel attributes.
 */
struct lttng_ust_channel_attr {
	int overwrite;				/* 1: overwrite, 0: discard */
	uint64_t subbuf_size;			/* bytes */
	uint64_t num_subbuf;			/* power of 2 */
	unsigned int switch_timer_interval;	/* usec */
	unsigned int read_timer_interval;	/* usec */
	enum lttng_ust_output output;		/* splice, mmap */
};

struct lttng_ust_object_data {
	int handle;
	int shm_fd;
	int wait_fd;
	uint64_t memory_map_size;
};

#define _UST_CMD(minor)				(minor)
#define _UST_CMDR(minor, type)			(minor)
#define _UST_CMDW(minor, type)			(minor)

/* Handled by object descriptor */
#define LTTNG_UST_RELEASE			_UST_CMD(0x1)

/* Handled by object cmd */

/* LTTng-UST commands */
#define LTTNG_UST_SESSION			_UST_CMD(0x40)
#define LTTNG_UST_TRACER_VERSION		\
	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
#define LTTNG_UST_TRACEPOINT_LIST		_UST_CMD(0x42)
#define LTTNG_UST_WAIT_QUIESCENT		_UST_CMD(0x43)
#define LTTNG_UST_REGISTER_DONE			_UST_CMD(0x44)

/* Session FD commands */
#define LTTNG_UST_METADATA			\
	_UST_CMDW(0x50, struct lttng_ust_channel)
#define LTTNG_UST_CHANNEL			\
	_UST_CMDW(0x51, struct lttng_ust_channel)
#define LTTNG_UST_SESSION_START			_UST_CMD(0x52)
#define LTTNG_UST_SESSION_STOP			_UST_CMD(0x53)

/* Channel FD commands */
#define LTTNG_UST_STREAM			_UST_CMD(0x60)
#define LTTNG_UST_EVENT			\
	_UST_CMDW(0x61, struct lttng_ust_event)

/* Event and Channel FD commands */
#define LTTNG_UST_CONTEXT			\
	_UST_CMDW(0x70, struct lttng_ust_context)
#define LTTNG_UST_FLUSH_BUFFER			\
	_UST_CMD(0x71)

/* Event, Channel and Session commands */
#define LTTNG_UST_ENABLE			_UST_CMD(0x80)
#define LTTNG_UST_DISABLE			_UST_CMD(0x81)

/* Tracepoint list commands */
#define LTTNG_UST_TRACEPOINT_LIST_GET		_UST_CMD(0x90)

#define LTTNG_UST_ROOT_HANDLE	0

struct lttng_ust_obj;

struct lttng_ust_objd_ops {
	long (*cmd)(int objd, unsigned int cmd, unsigned long arg);
	int (*release)(int objd);
};

/* Create root handle. Always ID 0. */
int lttng_abi_create_root_handle(void);

const struct lttng_ust_objd_ops *objd_ops(int id);
int lttng_ust_objd_unref(int id);

void lttng_ust_abi_exit(void);
void lttng_ust_events_exit(void);

#endif /* _LTTNG_UST_ABI_H */
Commit	Line	Data
9f3fdbc6 MD	1	#ifndef _LTTNG_UST_ABI_H
	2	#define _LTTNG_UST_ABI_H
	3
	4	/*
4318ae1b	5	* lttng/ust-abi.h
9f3fdbc6 MD	6	*
	7	* Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	8	*
	9	* LTTng-UST ABI header
	10	*
	11	* Dual LGPL v2.1/GPL v2 license.
	12	*/
	13
0a42beb6 MD	14	#include <stdint.h>
0a42beb6 MD	15
9f3fdbc6 MD	16	#define LTTNG_UST_SYM_NAME_LEN 128
9f3fdbc6 MD	17
b35d179d MD	18	#define LTTNG_UST_COMM_VERSION_MAJOR 0
	19	#define LTTNG_UST_COMM_VERSION_MINOR 1
	20
9f3fdbc6 MD	21	enum lttng_ust_instrumentation {
9f3fdbc6 MD	22	LTTNG_UST_TRACEPOINT = 0,
b35d179d MD	23	LTTNG_UST_PROBE = 1,
b35d179d MD	24	LTTNG_UST_FUNCTION = 2,
9f3fdbc6 MD	25	};
9f3fdbc6 MD	26
9f3fdbc6	27	enum lttng_ust_output {
b35d179d	28	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	29	};
9f3fdbc6 MD	30
b35d179d MD	31	struct lttng_ust_tracer_version {
	32	uint32_t version;
	33	uint32_t patchlevel;
	34	uint32_t sublevel;
	35	};
9f3fdbc6 MD	36
	37	struct lttng_ust_channel {
	38	int overwrite; /* 1: overwrite, 0: discard */
	39	uint64_t subbuf_size; /* in bytes */
	40	uint64_t num_subbuf;
	41	unsigned int switch_timer_interval; /* usecs */
	42	unsigned int read_timer_interval; /* usecs */
b35d179d	43	enum lttng_ust_output output; /* output mode */
193183fb MD	44	/* The following fields are used internally within UST. */
	45	int shm_fd;
	46	int wait_fd;
	47	uint64_t memory_map_size;
9f3fdbc6 MD	48	};
9f3fdbc6 MD	49
381c0f1e MD	50	/*
	51	* This structure is only used internally within UST. It is not per-se
	52	* part of the communication between sessiond and UST.
	53	*/
	54	struct lttng_ust_stream {
	55	int shm_fd;
	56	int wait_fd;
	57	uint64_t memory_map_size;
	58	};
	59
9f3fdbc6 MD	60	struct lttng_ust_event {
	61	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	62	enum lttng_ust_instrumentation instrumentation;
	63	/* Per instrumentation type configuration */
	64	union {
	65	} u;
	66	};
	67
9f3fdbc6	68	enum lttng_ust_context_type {
3b402b40	69	LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0 MD	70	LTTNG_UST_CONTEXT_VPID = 1,
c1ef86f0 MD	71	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb	72	LTTNG_UST_CONTEXT_PROCNAME = 3,
9f3fdbc6 MD	73	};
	74
	75	struct lttng_ust_context {
	76	enum lttng_ust_context_type ctx;
	77	union {
	78	} u;
	79	};
	80
92462b01 MD	81	/*
	82	* Tracer channel attributes.
	83	*/
	84	struct lttng_ust_channel_attr {
	85	int overwrite; /* 1: overwrite, 0: discard */
	86	uint64_t subbuf_size; /* bytes */
	87	uint64_t num_subbuf; /* power of 2 */
	88	unsigned int switch_timer_interval; /* usec */
	89	unsigned int read_timer_interval; /* usec */
	90	enum lttng_ust_output output; /* splice, mmap */
	91	};
	92
	93	struct lttng_ust_object_data {
	94	int handle;
	95	int shm_fd;
	96	int wait_fd;
	97	uint64_t memory_map_size;
	98	};
	99
9f3fdbc6 MD	100	#define _UST_CMD(minor) (minor)
	101	#define _UST_CMDR(minor, type) (minor)
	102	#define _UST_CMDW(minor, type) (minor)
	103
46050b1a MD	104	/* Handled by object descriptor */
	105	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	106
	107	/* Handled by object cmd */
	108
9f3fdbc6 MD	109	/* LTTng-UST commands */
	110	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	111	#define LTTNG_UST_TRACER_VERSION \
	112	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	113	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	114	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	115	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
9f3fdbc6	116
46050b1a	117	/* Session FD commands */
9f3fdbc6 MD	118	#define LTTNG_UST_METADATA \
	119	_UST_CMDW(0x50, struct lttng_ust_channel)
	120	#define LTTNG_UST_CHANNEL \
	121	_UST_CMDW(0x51, struct lttng_ust_channel)
	122	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	123	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
	124
46050b1a	125	/* Channel FD commands */
9f3fdbc6 MD	126	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	127	#define LTTNG_UST_EVENT \
	128	_UST_CMDW(0x61, struct lttng_ust_event)
	129
46050b1a	130	/* Event and Channel FD commands */
9f3fdbc6 MD	131	#define LTTNG_UST_CONTEXT \
9f3fdbc6 MD	132	_UST_CMDW(0x70, struct lttng_ust_context)
43d330a4	133	#define LTTNG_UST_FLUSH_BUFFER \
43861eab	134	_UST_CMD(0x71)
9f3fdbc6	135
46050b1a	136	/* Event, Channel and Session commands */
9f3fdbc6 MD	137	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	138	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	139
51489cad MD	140	/* Tracepoint list commands */
	141	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
	142
46050b1a MD	143	#define LTTNG_UST_ROOT_HANDLE 0
46050b1a MD	144
b61ce3b2	145	struct lttng_ust_obj;
46050b1a	146
b61ce3b2	147	struct lttng_ust_objd_ops {
46050b1a MD	148	long (*cmd)(int objd, unsigned int cmd, unsigned long arg);
	149	int (*release)(int objd);
	150	};
	151
	152	/* Create root handle. Always ID 0. */
	153	int lttng_abi_create_root_handle(void);
	154
b61ce3b2	155	const struct lttng_ust_objd_ops *objd_ops(int id);
d4419b81	156	int lttng_ust_objd_unref(int id);
46050b1a MD	157
46050b1a MD	158	void lttng_ust_abi_exit(void);
003fedf4	159	void lttng_ust_events_exit(void);
b35d179d	160
9f3fdbc6	161	#endif /* _LTTNG_UST_ABI_H */