[lttng-ust.git] / include / ust / 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	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 */
};

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

struct lttng_ust_context {
	enum lttng_ust_context_type ctx;
	union {
	} 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)

/* 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)

/* Event, Channel and Session commands */
#define LTTNG_UST_ENABLE			_UST_CMD(0x80)
#define LTTNG_UST_DISABLE			_UST_CMD(0x81)

#define LTTNG_UST_ROOT_HANDLE	0

struct obj;

struct 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 objd_ops *objd_ops(int id);
int objd_unref(int id);

void lttng_ust_abi_exit(void);
void ltt_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	/*
	5	* lttng-ust-abi.h
	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
0a42beb6 MD	14	#include <stdint.h>
0a42beb6 MD	15
9f3fdbc6 MD	16	#define LTTNG_UST_SYM_NAME_LEN 128
9f3fdbc6 MD	17
b35d179d MD	18	#define LTTNG_UST_COMM_VERSION_MAJOR 0
	19	#define LTTNG_UST_COMM_VERSION_MINOR 1
	20
9f3fdbc6 MD	21	enum lttng_ust_instrumentation {
9f3fdbc6 MD	22	LTTNG_UST_TRACEPOINT = 0,
b35d179d MD	23	LTTNG_UST_PROBE = 1,
b35d179d MD	24	LTTNG_UST_FUNCTION = 2,
9f3fdbc6 MD	25	};
9f3fdbc6 MD	26
9f3fdbc6	27	enum lttng_ust_output {
b35d179d	28	LTTNG_UST_MMAP = 0,
9f3fdbc6 MD	29	};
9f3fdbc6 MD	30
b35d179d MD	31	struct lttng_ust_tracer_version {
	32	uint32_t version;
	33	uint32_t patchlevel;
	34	uint32_t sublevel;
	35	};
9f3fdbc6 MD	36
	37	struct lttng_ust_channel {
	38	int overwrite; /* 1: overwrite, 0: discard */
	39	uint64_t subbuf_size; /* in bytes */
	40	uint64_t num_subbuf;
	41	unsigned int switch_timer_interval; /* usecs */
	42	unsigned int read_timer_interval; /* usecs */
b35d179d	43	enum lttng_ust_output output; /* output mode */
9f3fdbc6 MD	44	};
	45
	46	struct lttng_ust_event {
	47	char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */
	48	enum lttng_ust_instrumentation instrumentation;
	49	/* Per instrumentation type configuration */
	50	union {
	51	} u;
	52	};
	53
9f3fdbc6 MD	54	enum lttng_ust_context_type {
	55	LTTNG_UST_CONTEXT_VTID = 0,
	56	};
	57
	58	struct lttng_ust_context {
	59	enum lttng_ust_context_type ctx;
	60	union {
	61	} u;
	62	};
	63
	64	#define _UST_CMD(minor) (minor)
	65	#define _UST_CMDR(minor, type) (minor)
	66	#define _UST_CMDW(minor, type) (minor)
	67
46050b1a MD	68	/* Handled by object descriptor */
	69	#define LTTNG_UST_RELEASE _UST_CMD(0x1)
	70
	71	/* Handled by object cmd */
	72
9f3fdbc6 MD	73	/* LTTng-UST commands */
	74	#define LTTNG_UST_SESSION _UST_CMD(0x40)
	75	#define LTTNG_UST_TRACER_VERSION \
	76	_UST_CMDR(0x41, struct lttng_ust_tracer_version)
	77	#define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42)
	78	#define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43)
11ff9c7d	79	#define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44)
9f3fdbc6	80
46050b1a	81	/* Session FD commands */
9f3fdbc6 MD	82	#define LTTNG_UST_METADATA \
	83	_UST_CMDW(0x50, struct lttng_ust_channel)
	84	#define LTTNG_UST_CHANNEL \
	85	_UST_CMDW(0x51, struct lttng_ust_channel)
	86	#define LTTNG_UST_SESSION_START _UST_CMD(0x52)
	87	#define LTTNG_UST_SESSION_STOP _UST_CMD(0x53)
	88
46050b1a	89	/* Channel FD commands */
9f3fdbc6 MD	90	#define LTTNG_UST_STREAM _UST_CMD(0x60)
	91	#define LTTNG_UST_EVENT \
	92	_UST_CMDW(0x61, struct lttng_ust_event)
	93
46050b1a	94	/* Event and Channel FD commands */
9f3fdbc6 MD	95	#define LTTNG_UST_CONTEXT \
	96	_UST_CMDW(0x70, struct lttng_ust_context)
	97
46050b1a	98	/* Event, Channel and Session commands */
9f3fdbc6 MD	99	#define LTTNG_UST_ENABLE _UST_CMD(0x80)
	100	#define LTTNG_UST_DISABLE _UST_CMD(0x81)
	101
46050b1a MD	102	#define LTTNG_UST_ROOT_HANDLE 0
	103
	104	struct obj;
	105
	106	struct objd_ops {
	107	long (*cmd)(int objd, unsigned int cmd, unsigned long arg);
	108	int (*release)(int objd);
	109	};
	110
	111	/* Create root handle. Always ID 0. */
	112	int lttng_abi_create_root_handle(void);
	113
	114	const struct objd_ops *objd_ops(int id);
1ea11eab	115	int objd_unref(int id);
46050b1a MD	116
46050b1a MD	117	void lttng_ust_abi_exit(void);
1ea11eab	118	void ltt_events_exit(void);
b35d179d	119
9f3fdbc6	120	#endif /* _LTTNG_UST_ABI_H */