[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	256

#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,
	LTTNG_UST_TRACEPOINT_LOGLEVEL	= 3,
};

enum lttng_ust_output {
	LTTNG_UST_MMAP		= 0,
};

struct lttng_ust_tracer_version {
	uint32_t major;
	uint32_t minor;
	uint32_t patchlevel;
};

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 */
};

struct lttng_ust_stream {
};

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_tracepoint_iter {
	char name[LTTNG_UST_SYM_NAME_LEN];	/* provider:name */
	char loglevel[LTTNG_UST_SYM_NAME_LEN];	/* loglevel */
	int64_t loglevel_value;
};

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

enum lttng_ust_calibrate_type {
	LTTNG_UST_CALIBRATE_TRACEPOINT,
};

struct lttng_ust_calibrate {
	enum lttng_ust_calibrate_type type;	/* type (input) */
};

#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;

union ust_args {
	struct {
		int *shm_fd;
		int *wait_fd;
		uint64_t *memory_map_size;
	} channel;
	struct {
		int *shm_fd;
		int *wait_fd;
		uint64_t *memory_map_size;
	} stream;
};

struct lttng_ust_objd_ops {
	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
		union ust_args *args);
	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
f56cd1d5	23	#define LTTNG_UST_SYM_NAME_LEN 256
9f3fdbc6	24
b35d179d MD	25	#define LTTNG_UST_COMM_VERSION_MAJOR 0
	26	#define LTTNG_UST_COMM_VERSION_MINOR 1
	27
9f3fdbc6	28	enum lttng_ust_instrumentation {
df854e41 MD	29	LTTNG_UST_TRACEPOINT = 0,
	30	LTTNG_UST_PROBE = 1,
	31	LTTNG_UST_FUNCTION = 2,
	32	LTTNG_UST_TRACEPOINT_LOGLEVEL = 3,
9f3fdbc6 MD	33	};
9f3fdbc6 MD	34
9f3fdbc6	35	enum lttng_ust_output {
b35d179d	36	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	37	};
9f3fdbc6 MD	38
b35d179d	39	struct lttng_ust_tracer_version {
b728d87e MD	40	uint32_t major;
b728d87e MD	41	uint32_t minor;
b35d179d	42	uint32_t patchlevel;
b35d179d	43	};
9f3fdbc6 MD	44
	45	struct lttng_ust_channel {
	46	int overwrite; /* 1: overwrite, 0: discard */
	47	uint64_t subbuf_size; /* in bytes */
	48	uint64_t num_subbuf;
	49	unsigned int switch_timer_interval; /* usecs */
	50	unsigned int read_timer_interval; /* usecs */
b35d179d	51	enum lttng_ust_output output; /* output mode */
9f3fdbc6 MD	52	};
9f3fdbc6 MD	53
381c0f1e	54	struct lttng_ust_stream {
381c0f1e MD	55	};
381c0f1e MD	56
9f3fdbc6 MD	57	struct lttng_ust_event {
	58	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	59	enum lttng_ust_instrumentation instrumentation;
	60	/* Per instrumentation type configuration */
	61	union {
	62	} u;
	63	};
	64
9f3fdbc6	65	enum lttng_ust_context_type {
3b402b40	66	LTTNG_UST_CONTEXT_VTID = 0,
c1ef86f0 MD	67	LTTNG_UST_CONTEXT_VPID = 1,
c1ef86f0 MD	68	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
4847e9bb	69	LTTNG_UST_CONTEXT_PROCNAME = 3,
9f3fdbc6 MD	70	};
	71
	72	struct lttng_ust_context {
	73	enum lttng_ust_context_type ctx;
	74	union {
	75	} u;
	76	};
	77
92462b01 MD	78	/*
	79	* Tracer channel attributes.
	80	*/
	81	struct lttng_ust_channel_attr {
	82	int overwrite; /* 1: overwrite, 0: discard */
	83	uint64_t subbuf_size; /* bytes */
	84	uint64_t num_subbuf; /* power of 2 */
	85	unsigned int switch_timer_interval; /* usec */
	86	unsigned int read_timer_interval; /* usec */
	87	enum lttng_ust_output output; /* splice, mmap */
	88	};
	89
cbef6901 MD	90	struct lttng_ust_tracepoint_iter {
	91	char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
	92	char loglevel[LTTNG_UST_SYM_NAME_LEN]; /* loglevel */
	93	int64_t loglevel_value;
	94	};
	95
92462b01 MD	96	struct lttng_ust_object_data {
	97	int handle;
	98	int shm_fd;
	99	int wait_fd;
	100	uint64_t memory_map_size;
	101	};
	102
d9a9a33b MD	103	enum lttng_ust_calibrate_type {
	104	LTTNG_UST_CALIBRATE_TRACEPOINT,
	105	};
	106
	107	struct lttng_ust_calibrate {
	108	enum lttng_ust_calibrate_type type; /* type (input) */
	109	};
	110
9f3fdbc6 MD	111	#define _UST_CMD(minor) (minor)
	112	#define _UST_CMDR(minor, type) (minor)
	113	#define _UST_CMDW(minor, type) (minor)
	114
46050b1a MD	115	/* Handled by object descriptor */
	116	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	117
	118	/* Handled by object cmd */
	119
9f3fdbc6 MD	120	/* LTTng-UST commands */
	121	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	122	#define LTTNG_UST_TRACER_VERSION \
	123	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	124	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	125	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	126	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
9f3fdbc6	127
46050b1a	128	/* Session FD commands */
9f3fdbc6 MD	129	#define LTTNG_UST_METADATA \
	130	_UST_CMDW(0x50, struct lttng_ust_channel)
	131	#define LTTNG_UST_CHANNEL \
	132	_UST_CMDW(0x51, struct lttng_ust_channel)
	133	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	134	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
	135
46050b1a	136	/* Channel FD commands */
9f3fdbc6 MD	137	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	138	#define LTTNG_UST_EVENT \
	139	_UST_CMDW(0x61, struct lttng_ust_event)
	140
46050b1a	141	/* Event and Channel FD commands */
9f3fdbc6 MD	142	#define LTTNG_UST_CONTEXT \
9f3fdbc6 MD	143	_UST_CMDW(0x70, struct lttng_ust_context)
43d330a4	144	#define LTTNG_UST_FLUSH_BUFFER \
43861eab	145	_UST_CMD(0x71)
9f3fdbc6	146
46050b1a	147	/* Event, Channel and Session commands */
9f3fdbc6 MD	148	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	149	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	150
51489cad MD	151	/* Tracepoint list commands */
	152	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
	153
46050b1a MD	154	#define LTTNG_UST_ROOT_HANDLE 0
46050b1a MD	155
b61ce3b2	156	struct lttng_ust_obj;
46050b1a	157
ef9ff354 MD	158	union ust_args {
	159	struct {
	160	int *shm_fd;
	161	int *wait_fd;
	162	uint64_t *memory_map_size;
	163	} channel;
	164	struct {
	165	int *shm_fd;
	166	int *wait_fd;
	167	uint64_t *memory_map_size;
	168	} stream;
	169	};
	170
b61ce3b2	171	struct lttng_ust_objd_ops {
ef9ff354 MD	172	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
ef9ff354 MD	173	union ust_args *args);
46050b1a MD	174	int (*release)(int objd);
	175	};
	176
	177	/* Create root handle. Always ID 0. */
	178	int lttng_abi_create_root_handle(void);
	179
b61ce3b2	180	const struct lttng_ust_objd_ops *objd_ops(int id);
d4419b81	181	int lttng_ust_objd_unref(int id);
46050b1a MD	182
46050b1a MD	183	void lttng_ust_abi_exit(void);
003fedf4	184	void lttng_ust_events_exit(void);
b35d179d	185
9f3fdbc6	186	#endif /* _LTTNG_UST_ABI_H */