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

#ifndef _LTTNG_UST_ABI_H
#define _LTTNG_UST_ABI_H

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