[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
 *
 * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
 * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 */

#include <stdint.h>

#define LTTNG_UST_SYM_NAME_LEN	256

#define LTTNG_UST_COMM_VERSION_MAJOR		2
#define LTTNG_UST_COMM_VERSION_MINOR		0

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

enum lttng_ust_loglevel_type {
	LTTNG_UST_LOGLEVEL_ALL		= 0,
	LTTNG_UST_LOGLEVEL_RANGE	= 1,
	LTTNG_UST_LOGLEVEL_SINGLE	= 2,
};

enum lttng_ust_output {
	LTTNG_UST_MMAP		= 0,
};

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

#define LTTNG_UST_CHANNEL_PADDING	LTTNG_UST_SYM_NAME_LEN + 32
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 */
	char padding[LTTNG_UST_CHANNEL_PADDING];
};

#define LTTNG_UST_STREAM_PADDING1	16
#define LTTNG_UST_STREAM_PADDING2	LTTNG_UST_SYM_NAME_LEN + 32
struct lttng_ust_stream {
	char padding[LTTNG_UST_STREAM_PADDING1];

	union {
		char padding[LTTNG_UST_STREAM_PADDING2];
	} u;
};

#define LTTNG_UST_EVENT_PADDING1	16
#define LTTNG_UST_EVENT_PADDING2	LTTNG_UST_SYM_NAME_LEN + 32
struct lttng_ust_event {
	enum lttng_ust_instrumentation instrumentation;
	char name[LTTNG_UST_SYM_NAME_LEN];	/* event name */

	enum lttng_ust_loglevel_type loglevel_type;
	int loglevel;	/* value, -1: all */
	char padding[LTTNG_UST_EVENT_PADDING1];

	/* Per instrumentation type configuration */
	union {
		char padding[LTTNG_UST_EVENT_PADDING2];
	} u;
};

enum lttng_ust_field_type {
	LTTNG_UST_FIELD_OTHER			= 0,
	LTTNG_UST_FIELD_INTEGER			= 1,
	LTTNG_UST_FIELD_ENUM			= 2,
	LTTNG_UST_FIELD_FLOAT			= 3,
	LTTNG_UST_FIELD_STRING			= 4,
};

#define LTTNG_UST_FIELD_ITER_PADDING		LTTNG_UST_SYM_NAME_LEN + 32
struct lttng_ust_field_iter {
	char event_name[LTTNG_UST_SYM_NAME_LEN];
	char field_name[LTTNG_UST_SYM_NAME_LEN];
	enum lttng_ust_field_type type;
	int loglevel;				/* event loglevel */
	char padding[LTTNG_UST_FIELD_ITER_PADDING];
};

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,
};

#define LTTNG_UST_CONTEXT_PADDING1	16
#define LTTNG_UST_CONTEXT_PADDING2	LTTNG_UST_SYM_NAME_LEN + 32
struct lttng_ust_context {
	enum lttng_ust_context_type ctx;
	char padding[LTTNG_UST_CONTEXT_PADDING1];

	union {
		char padding[LTTNG_UST_CONTEXT_PADDING2];
	} u;
};

/*
 * Tracer channel attributes.
 */
#define LTTNG_UST_CHANNEL_ATTR_PADDING	LTTNG_UST_SYM_NAME_LEN + 32
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 */
	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
};

#define LTTNG_UST_TRACEPOINT_ITER_PADDING	16
struct lttng_ust_tracepoint_iter {
	char name[LTTNG_UST_SYM_NAME_LEN];	/* provider:name */
	int loglevel;
	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
};

#define LTTNG_UST_OBJECT_DATA_PADDING		LTTNG_UST_SYM_NAME_LEN + 32
struct lttng_ust_object_data {
	int handle;
	int shm_fd;
	int wait_fd;
	uint64_t memory_map_size;
	char padding[LTTNG_UST_OBJECT_DATA_PADDING];
};

enum lttng_ust_calibrate_type {
	LTTNG_UST_CALIBRATE_TRACEPOINT,
};

#define LTTNG_UST_CALIBRATE_PADDING1	16
#define LTTNG_UST_CALIBRATE_PADDING2	LTTNG_UST_SYM_NAME_LEN + 32
struct lttng_ust_calibrate {
	enum lttng_ust_calibrate_type type;	/* type (input) */
	char padding[LTTNG_UST_CALIBRATE_PADDING1];

	union {
		char padding[LTTNG_UST_CALIBRATE_PADDING2];
	} u;
};

#define FILTER_BYTECODE_MAX_LEN		65535
struct lttng_ust_filter_bytecode {
	uint16_t len;
	uint16_t reloc_offset;
	char data[0];
};

#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)
#define LTTNG_UST_TRACEPOINT_FIELD_LIST		_UST_CMD(0x45)

/* 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_TRACEPOINT_FIELD_LIST_GET	_UST_CMD(0x91)

#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 {
		struct lttng_ust_field_iter entry;
	} field_list;
};

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	*
3f3c65dc MD	11	* THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
	12	* OR IMPLIED. ANY USE IS AT YOUR OWN RISK.
	13	*
bf74a86d AM	14	* Permission is hereby granted, free of charge, to any person obtaining a copy
	15	* of this software and associated documentation files (the "Software"), to deal
	16	* in the Software without restriction, including without limitation the rights
	17	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	18	* copies of the Software, and to permit persons to whom the Software is
	19	* furnished to do so, subject to the following conditions:
	20	*
	21	* The above copyright notice and this permission notice shall be included in
	22	* all copies or substantial portions of the Software.
3bd1e081 MD	23	*/
	24
	25	#include <stdint.h>
	26
57ab7638	27	#define LTTNG_UST_SYM_NAME_LEN 256
3bd1e081	28
3f3c65dc MD	29	#define LTTNG_UST_COMM_VERSION_MAJOR 2
3f3c65dc MD	30	#define LTTNG_UST_COMM_VERSION_MINOR 0
3bd1e081 MD	31
3bd1e081 MD	32	enum lttng_ust_instrumentation {
177f8533 MD	33	LTTNG_UST_TRACEPOINT = 0,
	34	LTTNG_UST_PROBE = 1,
	35	LTTNG_UST_FUNCTION = 2,
0cda4f28 MD	36	};
	37
	38	enum lttng_ust_loglevel_type {
8005f29a MD	39	LTTNG_UST_LOGLEVEL_ALL = 0,
	40	LTTNG_UST_LOGLEVEL_RANGE = 1,
	41	LTTNG_UST_LOGLEVEL_SINGLE = 2,
3bd1e081 MD	42	};
	43
	44	enum lttng_ust_output {
	45	LTTNG_UST_MMAP = 0,
	46	};
	47
	48	struct lttng_ust_tracer_version {
3f3c65dc MD	49	uint32_t major;
3f3c65dc MD	50	uint32_t minor;
3bd1e081	51	uint32_t patchlevel;
3bd1e081 MD	52	};
3bd1e081 MD	53
3f3c65dc	54	#define LTTNG_UST_CHANNEL_PADDING LTTNG_UST_SYM_NAME_LEN + 32
3bd1e081 MD	55	struct lttng_ust_channel {
	56	int overwrite; /* 1: overwrite, 0: discard */
	57	uint64_t subbuf_size; /* in bytes */
	58	uint64_t num_subbuf;
	59	unsigned int switch_timer_interval; /* usecs */
	60	unsigned int read_timer_interval; /* usecs */
	61	enum lttng_ust_output output; /* output mode */
3f3c65dc MD	62	char padding[LTTNG_UST_CHANNEL_PADDING];
	63	};
	64
	65	#define LTTNG_UST_STREAM_PADDING1 16
	66	#define LTTNG_UST_STREAM_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
	67	struct lttng_ust_stream {
	68	char padding[LTTNG_UST_STREAM_PADDING1];
	69
	70	union {
	71	char padding[LTTNG_UST_STREAM_PADDING2];
	72	} u;
3bd1e081 MD	73	};
3bd1e081 MD	74
3f3c65dc MD	75	#define LTTNG_UST_EVENT_PADDING1 16
3f3c65dc MD	76	#define LTTNG_UST_EVENT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
3bd1e081	77	struct lttng_ust_event {
69892bbb	78	enum lttng_ust_instrumentation instrumentation;
0cda4f28 MD	79	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	80
	81	enum lttng_ust_loglevel_type loglevel_type;
8005f29a	82	int loglevel; /* value, -1: all */
3f3c65dc	83	char padding[LTTNG_UST_EVENT_PADDING1];
0cda4f28	84
3bd1e081 MD	85	/* Per instrumentation type configuration */
3bd1e081 MD	86	union {
3f3c65dc	87	char padding[LTTNG_UST_EVENT_PADDING2];
3bd1e081 MD	88	} u;
	89	};
	90
f214d69a MD	91	enum lttng_ust_field_type {
	92	LTTNG_UST_FIELD_OTHER = 0,
	93	LTTNG_UST_FIELD_INTEGER = 1,
	94	LTTNG_UST_FIELD_ENUM = 2,
	95	LTTNG_UST_FIELD_FLOAT = 3,
	96	LTTNG_UST_FIELD_STRING = 4,
	97	};
	98
	99	#define LTTNG_UST_FIELD_ITER_PADDING LTTNG_UST_SYM_NAME_LEN + 32
	100	struct lttng_ust_field_iter {
	101	char event_name[LTTNG_UST_SYM_NAME_LEN];
	102	char field_name[LTTNG_UST_SYM_NAME_LEN];
	103	enum lttng_ust_field_type type;
	104	int loglevel; /* event loglevel */
	105	char padding[LTTNG_UST_FIELD_ITER_PADDING];
	106	};
	107
3bd1e081 MD	108	enum lttng_ust_context_type {
	109	LTTNG_UST_CONTEXT_VTID = 0,
	110	LTTNG_UST_CONTEXT_VPID = 1,
	111	LTTNG_UST_CONTEXT_PTHREAD_ID = 2,
	112	LTTNG_UST_CONTEXT_PROCNAME = 3,
	113	};
	114
3f3c65dc MD	115	#define LTTNG_UST_CONTEXT_PADDING1 16
3f3c65dc MD	116	#define LTTNG_UST_CONTEXT_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
3bd1e081 MD	117	struct lttng_ust_context {
3bd1e081 MD	118	enum lttng_ust_context_type ctx;
3f3c65dc MD	119	char padding[LTTNG_UST_CONTEXT_PADDING1];
3f3c65dc MD	120
3bd1e081	121	union {
3f3c65dc	122	char padding[LTTNG_UST_CONTEXT_PADDING2];
3bd1e081 MD	123	} u;
	124	};
	125
13161846 DG	126	/*
	127	* Tracer channel attributes.
	128	*/
3f3c65dc	129	#define LTTNG_UST_CHANNEL_ATTR_PADDING LTTNG_UST_SYM_NAME_LEN + 32
13161846 DG	130	struct lttng_ust_channel_attr {
	131	int overwrite; /* 1: overwrite, 0: discard */
	132	uint64_t subbuf_size; /* bytes */
	133	uint64_t num_subbuf; /* power of 2 */
	134	unsigned int switch_timer_interval; /* usec */
	135	unsigned int read_timer_interval; /* usec */
	136	enum lttng_ust_output output; /* splice, mmap */
3f3c65dc	137	char padding[LTTNG_UST_CHANNEL_ATTR_PADDING];
13161846 DG	138	};
13161846 DG	139
3f3c65dc	140	#define LTTNG_UST_TRACEPOINT_ITER_PADDING 16
177f8533 MD	141	struct lttng_ust_tracepoint_iter {
177f8533 MD	142	char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */
8005f29a	143	int loglevel;
3f3c65dc	144	char padding[LTTNG_UST_TRACEPOINT_ITER_PADDING];
177f8533 MD	145	};
177f8533 MD	146
3f3c65dc	147	#define LTTNG_UST_OBJECT_DATA_PADDING LTTNG_UST_SYM_NAME_LEN + 32
13161846 DG	148	struct lttng_ust_object_data {
	149	int handle;
	150	int shm_fd;
	151	int wait_fd;
	152	uint64_t memory_map_size;
3f3c65dc	153	char padding[LTTNG_UST_OBJECT_DATA_PADDING];
13161846 DG	154	};
13161846 DG	155
f7e1a950 DG	156	enum lttng_ust_calibrate_type {
	157	LTTNG_UST_CALIBRATE_TRACEPOINT,
	158	};
	159
3f3c65dc MD	160	#define LTTNG_UST_CALIBRATE_PADDING1 16
3f3c65dc MD	161	#define LTTNG_UST_CALIBRATE_PADDING2 LTTNG_UST_SYM_NAME_LEN + 32
f7e1a950	162	struct lttng_ust_calibrate {
3f3c65dc MD	163	enum lttng_ust_calibrate_type type; /* type (input) */
	164	char padding[LTTNG_UST_CALIBRATE_PADDING1];
	165
	166	union {
	167	char padding[LTTNG_UST_CALIBRATE_PADDING2];
	168	} u;
f7e1a950 DG	169	};
f7e1a950 DG	170
53a80697 MD	171	#define FILTER_BYTECODE_MAX_LEN 65535
	172	struct lttng_ust_filter_bytecode {
	173	uint16_t len;
	174	uint16_t reloc_offset;
	175	char data[0];
	176	};
	177
3bd1e081 MD	178	#define _UST_CMD(minor) (minor)
	179	#define _UST_CMDR(minor, type) (minor)
	180	#define _UST_CMDW(minor, type) (minor)
	181
	182	/* Handled by object descriptor */
	183	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	184
	185	/* Handled by object cmd */
	186
	187	/* LTTng-UST commands */
	188	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	189	#define LTTNG_UST_TRACER_VERSION \
	190	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	191	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	192	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
	193	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
f214d69a	194	#define LTTNG_UST_TRACEPOINT_FIELD_LIST _UST_CMD(0x45)
3bd1e081 MD	195
	196	/* Session FD commands */
	197	#define LTTNG_UST_METADATA \
	198	_UST_CMDW(0x50, struct lttng_ust_channel)
	199	#define LTTNG_UST_CHANNEL \
	200	_UST_CMDW(0x51, struct lttng_ust_channel)
	201	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	202	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
	203
	204	/* Channel FD commands */
	205	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	206	#define LTTNG_UST_EVENT \
	207	_UST_CMDW(0x61, struct lttng_ust_event)
	208
	209	/* Event and Channel FD commands */
	210	#define LTTNG_UST_CONTEXT \
	211	_UST_CMDW(0x70, struct lttng_ust_context)
2bdd86d4 MD	212	#define LTTNG_UST_FLUSH_BUFFER \
2bdd86d4 MD	213	_UST_CMD(0x71)
3bd1e081 MD	214
	215	/* Event, Channel and Session commands */
	216	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	217	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	218
8ec2d32a MD	219	/* Tracepoint list commands */
8ec2d32a MD	220	#define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90)
f214d69a	221	#define LTTNG_UST_TRACEPOINT_FIELD_LIST_GET _UST_CMD(0x91)
8ec2d32a	222
3bd1e081 MD	223	#define LTTNG_UST_ROOT_HANDLE 0
3bd1e081 MD	224
9df8df5e	225	struct lttng_ust_obj;
3bd1e081	226
18cef803 MD	227	union ust_args {
	228	struct {
	229	int *shm_fd;
	230	int *wait_fd;
	231	uint64_t *memory_map_size;
	232	} channel;
	233	struct {
	234	int *shm_fd;
	235	int *wait_fd;
	236	uint64_t *memory_map_size;
	237	} stream;
da0bdb87 MD	238	struct {
	239	struct lttng_ust_field_iter entry;
	240	} field_list;
18cef803 MD	241	};
18cef803 MD	242
9df8df5e	243	struct lttng_ust_objd_ops {
18cef803 MD	244	long (*cmd)(int objd, unsigned int cmd, unsigned long arg,
18cef803 MD	245	union ust_args *args);
3bd1e081 MD	246	int (*release)(int objd);
	247	};
	248
	249	/* Create root handle. Always ID 0. */
	250	int lttng_abi_create_root_handle(void);
	251
9df8df5e DG	252	const struct lttng_ust_objd_ops *objd_ops(int id);
9df8df5e DG	253	int lttng_ust_objd_unref(int id);
3bd1e081 MD	254
3bd1e081 MD	255	void lttng_ust_abi_exit(void);
9df8df5e	256	void lttng_ust_events_exit(void);
3bd1e081 MD	257
3bd1e081 MD	258	#endif /* _LTTNG_UST_ABI_H */