[lttng-tools.git] / src / bin / lttng-sessiond / 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	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 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 */
};

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