[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
 *
 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
 * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
 *
 * Permission is hereby granted to use or copy this program
 * for any purpose,  provided the above notices are retained on all copies.
 * Permission to modify the code and to distribute modified code is granted,
 * provided the above notices are retained, and a notice that the code was
 * modified is included with the above copyright notice.
 */

#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	*
a60d70e6 MD	11	* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
	12	* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
	13	*
	14	* Permission is hereby granted to use or copy this program
	15	* for any purpose, provided the above notices are retained on all copies.
	16	* Permission to modify the code and to distribute modified code is granted,
	17	* provided the above notices are retained, and a notice that the code was
	18	* modified is included with the above copyright notice.
9f3fdbc6 MD	19	*/
9f3fdbc6 MD	20
0a42beb6 MD	21	#include <stdint.h>
0a42beb6 MD	22
9f3fdbc6 MD	23	#define LTTNG_UST_SYM_NAME_LEN 128
9f3fdbc6 MD	24
b35d179d MD	25	#define LTTNG_UST_COMM_VERSION_MAJOR 0
	26	#define LTTNG_UST_COMM_VERSION_MINOR 1
	27
9f3fdbc6 MD	28	enum lttng_ust_instrumentation {
9f3fdbc6 MD	29	LTTNG_UST_TRACEPOINT = 0,
b35d179d MD	30	LTTNG_UST_PROBE = 1,
b35d179d MD	31	LTTNG_UST_FUNCTION = 2,
9f3fdbc6 MD	32	};
9f3fdbc6 MD	33
9f3fdbc6	34	enum lttng_ust_output {
b35d179d	35	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	36	};
9f3fdbc6 MD	37
b35d179d MD	38	struct lttng_ust_tracer_version {
	39	uint32_t version;
	40	uint32_t patchlevel;
	41	uint32_t sublevel;
	42	};
9f3fdbc6 MD	43
	44	struct lttng_ust_channel {
	45	int overwrite; /* 1: overwrite, 0: discard */
	46	uint64_t subbuf_size; /* in bytes */
	47	uint64_t num_subbuf;
	48	unsigned int switch_timer_interval; /* usecs */
	49	unsigned int read_timer_interval; /* usecs */
b35d179d	50	enum lttng_ust_output output; /* output mode */
193183fb MD	51	/* The following fields are used internally within UST. */
	52	int shm_fd;
	53	int wait_fd;
	54	uint64_t memory_map_size;
9f3fdbc6 MD	55	};
9f3fdbc6 MD	56
381c0f1e MD	57	/*
	58	* This structure is only used internally within UST. It is not per-se
	59	* part of the communication between sessiond and UST.
	60	*/
	61	struct lttng_ust_stream {
	62	int shm_fd;
	63	int wait_fd;
	64	uint64_t memory_map_size;
	65	};
	66
9f3fdbc6 MD	67	struct lttng_ust_event {
	68	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	69	enum lttng_ust_instrumentation instrumentation;
	70	/* Per instrumentation type configuration */
	71	union {
	72	} u;
	73	};
	74
9f3fdbc6	75	enum lttng_ust_context_type {
3b402b40	76	LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0 MD	77	LTTNG_UST_CONTEXT_VPID = 1,
c1ef86f0 MD	78	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb	79	LTTNG_UST_CONTEXT_PROCNAME = 3,
9f3fdbc6 MD	80	};
	81
	82	struct lttng_ust_context {
	83	enum lttng_ust_context_type ctx;
	84	union {
	85	} u;
	86	};
	87
92462b01 MD	88	/*
	89	* Tracer channel attributes.
	90	*/
	91	struct lttng_ust_channel_attr {
	92	int overwrite; /* 1: overwrite, 0: discard */
	93	uint64_t subbuf_size; /* bytes */
	94	uint64_t num_subbuf; /* power of 2 */
	95	unsigned int switch_timer_interval; /* usec */
	96	unsigned int read_timer_interval; /* usec */
	97	enum lttng_ust_output output; /* splice, mmap */
	98	};
	99
	100	struct lttng_ust_object_data {
	101	int handle;
	102	int shm_fd;
	103	int wait_fd;
	104	uint64_t memory_map_size;
	105	};
	106
9f3fdbc6 MD	107	#define _UST_CMD(minor) (minor)
	108	#define _UST_CMDR(minor, type) (minor)
	109	#define _UST_CMDW(minor, type) (minor)
	110
46050b1a MD	111	/* Handled by object descriptor */
	112	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	113
	114	/* Handled by object cmd */
	115
9f3fdbc6 MD	116	/* LTTng-UST commands */
	117	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	118	#define LTTNG_UST_TRACER_VERSION \
	119	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	120	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	121	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	122	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
9f3fdbc6	123
46050b1a	124	/* Session FD commands */
9f3fdbc6 MD	125	#define LTTNG_UST_METADATA \
	126	_UST_CMDW(0x50, struct lttng_ust_channel)
	127	#define LTTNG_UST_CHANNEL \
	128	_UST_CMDW(0x51, struct lttng_ust_channel)
	129	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	130	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
	131
46050b1a	132	/* Channel FD commands */
9f3fdbc6 MD	133	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	134	#define LTTNG_UST_EVENT \
	135	_UST_CMDW(0x61, struct lttng_ust_event)
	136
46050b1a	137	/* Event and Channel FD commands */
9f3fdbc6 MD	138	#define LTTNG_UST_CONTEXT \
9f3fdbc6 MD	139	_UST_CMDW(0x70, struct lttng_ust_context)
43d330a4	140	#define LTTNG_UST_FLUSH_BUFFER \
43861eab	141	_UST_CMD(0x71)
9f3fdbc6	142
46050b1a	143	/* Event, Channel and Session commands */
9f3fdbc6 MD	144	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	145	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	146
51489cad MD	147	/* Tracepoint list commands */
	148	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
	149
46050b1a MD	150	#define LTTNG_UST_ROOT_HANDLE 0
46050b1a MD	151
b61ce3b2	152	struct lttng_ust_obj;
46050b1a	153
b61ce3b2	154	struct lttng_ust_objd_ops {
46050b1a MD	155	long (*cmd)(int objd, unsigned int cmd, unsigned long arg);
	156	int (*release)(int objd);
	157	};
	158
	159	/* Create root handle. Always ID 0. */
	160	int lttng_abi_create_root_handle(void);
	161
b61ce3b2	162	const struct lttng_ust_objd_ops *objd_ops(int id);
d4419b81	163	int lttng_ust_objd_unref(int id);
46050b1a MD	164
46050b1a MD	165	void lttng_ust_abi_exit(void);
003fedf4	166	void lttng_ust_events_exit(void);
b35d179d	167
9f3fdbc6	168	#endif /* _LTTNG_UST_ABI_H */