[lttng-tools.git] / include / lttng / lttng.h

/*
 * lttng.h
 *
 * Linux Trace Toolkit Control Library Header File
 *
 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef _LTTNG_H
#define _LTTNG_H

#include <asm/types.h>
#include <stdint.h>
#include <limits.h>

/* Default unix group name for tracing. */
#define LTTNG_DEFAULT_TRACING_GROUP "tracing"

/* Environment variable to set session daemon binary path. */
#define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"

/* Default trace output directory name */
#define LTTNG_DEFAULT_TRACE_DIR_NAME "lttng-traces"

/*
 * Event symbol length.
 */
#define LTTNG_SYMBOL_NAME_LEN 128

enum lttng_event_type {
	LTTNG_EVENT_TRACEPOINTS,
	LTTNG_EVENT_KPROBES,
	LTTNG_EVENT_FUNCTION,
};

/* Kernel context possible type */
enum lttng_kernel_context_type {
	LTTNG_KERNEL_CONTEXT_PID                = 0,
	LTTNG_KERNEL_CONTEXT_PERF_COUNTER       = 1,
	LTTNG_KERNEL_CONTEXT_COMM               = 2,
	LTTNG_KERNEL_CONTEXT_PRIO               = 3,
	LTTNG_KERNEL_CONTEXT_NICE               = 4,
	LTTNG_KERNEL_CONTEXT_VPID               = 5,
	LTTNG_KERNEL_CONTEXT_TID                = 6,
	LTTNG_KERNEL_CONTEXT_VTID               = 7,
	LTTNG_KERNEL_CONTEXT_PPID               = 8,
	LTTNG_KERNEL_CONTEXT_VPPID              = 9,
};

/* Perf counter attributes */
struct lttng_kernel_perf_counter_ctx {
	uint32_t type;
	uint64_t config;
	char name[LTTNG_SYMBOL_NAME_LEN];
};

/* Event/Channel context */
struct lttng_kernel_context {
	enum lttng_kernel_context_type ctx;
	union {
		struct lttng_kernel_perf_counter_ctx perf_counter;
	} u;
};

/*
 * LTTng consumer mode
 */
enum lttng_kernel_output {
	LTTNG_KERNEL_SPLICE       = 0,
	LTTNG_KERNEL_MMAP         = 1,
};

/*
 * Either addr is used or symbol_name and offset.
 */
struct lttng_event_kprobe_attr {
	uint64_t addr;

	uint64_t offset;
	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
};

/*
 * Function tracer
 */
struct lttng_event_function_attr {
	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
};

/*
 * Generic lttng event
 */
struct lttng_event {
	char name[LTTNG_SYMBOL_NAME_LEN];
	enum lttng_event_type type;
	/* Per event type configuration */
	union {
		struct lttng_event_kprobe_attr kprobe;
		struct lttng_event_function_attr ftrace;
	} attr;
};

/* Tracer channel attributes */
struct lttng_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_kernel_output output;    /* splice, mmap */
};

/*
 * Basic session information.
 */
struct lttng_session {
	char name[NAME_MAX];
	char path[PATH_MAX];
};

/* Channel information structure */
struct lttng_channel {
	char name[NAME_MAX];
	struct lttng_channel_attr attr;
};

/*
 * Session daemon control
 */
extern int lttng_connect_sessiond(void);

extern int lttng_create_session(char *name, char *path);

extern int lttng_destroy_session(char *name);

extern int lttng_disconnect_sessiond(void);

/* Return an allocated array of lttng_session */
extern int lttng_list_sessions(struct lttng_session **sessions);

extern int lttng_session_daemon_alive(void);

/* Set tracing group for the current execution */
extern int lttng_set_tracing_group(const char *name);

extern void lttng_set_session_name(char *name);

extern const char *lttng_get_readable_code(int code);

extern int lttng_start_tracing(char *session_name);

extern int lttng_stop_tracing(char *session_name);

//extern int lttng_ust_list_traceable_apps(pid_t **pids);

/*
 * LTTng Kernel tracer control
 */
extern int lttng_kernel_add_context(struct lttng_kernel_context *ctx,
		char *event_name, char *channel_name);

extern int lttng_kernel_create_channel(struct lttng_channel *chan);

extern int lttng_kernel_enable_event(struct lttng_event *ev, char *channel_name);

extern int lttng_kernel_enable_channel(char *name);

extern int lttng_kernel_disable_event(char *name, char *channel_name);

extern int lttng_kernel_disable_channel(char *name);

extern int lttng_kernel_list_events(char **event_list);

/*
 * LTTng User-space tracer control
 */

#endif /* _LTTNG_H */
Commit	Line	Data
	1	/*
	2	* lttng.h
	3	*
	4	* Linux Trace Toolkit Control Library Header File
	5	*
	6	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License
	10	* as published by the Free Software Foundation; either version 2
	11	* of the License, or (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	21	*/
	22
	23	#ifndef _LTTNG_H
	24	#define _LTTNG_H
	25
	26	#include <asm/types.h>
	27	#include <stdint.h>
	28	#include <limits.h>
	29
	30	/* Default unix group name for tracing. */
	31	#define LTTNG_DEFAULT_TRACING_GROUP "tracing"
	32
	33	/* Environment variable to set session daemon binary path. */
	34	#define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
	35
	36	/* Default trace output directory name */
	37	#define LTTNG_DEFAULT_TRACE_DIR_NAME "lttng-traces"
	38
	39	/*
	40	* Event symbol length.
	41	*/
	42	#define LTTNG_SYMBOL_NAME_LEN 128
	43
	44	enum lttng_event_type {
	45	LTTNG_EVENT_TRACEPOINTS,
	46	LTTNG_EVENT_KPROBES,
	47	LTTNG_EVENT_FUNCTION,
	48	};
	49
	50	/* Kernel context possible type */
	51	enum lttng_kernel_context_type {
	52	LTTNG_KERNEL_CONTEXT_PID = 0,
	53	LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
	54	LTTNG_KERNEL_CONTEXT_COMM = 2,
	55	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	56	LTTNG_KERNEL_CONTEXT_NICE = 4,
	57	LTTNG_KERNEL_CONTEXT_VPID = 5,
	58	LTTNG_KERNEL_CONTEXT_TID = 6,
	59	LTTNG_KERNEL_CONTEXT_VTID = 7,
	60	LTTNG_KERNEL_CONTEXT_PPID = 8,
	61	LTTNG_KERNEL_CONTEXT_VPPID = 9,
	62	};
	63
	64	/* Perf counter attributes */
	65	struct lttng_kernel_perf_counter_ctx {
	66	uint32_t type;
	67	uint64_t config;
	68	char name[LTTNG_SYMBOL_NAME_LEN];
	69	};
	70
	71	/* Event/Channel context */
	72	struct lttng_kernel_context {
	73	enum lttng_kernel_context_type ctx;
	74	union {
	75	struct lttng_kernel_perf_counter_ctx perf_counter;
	76	} u;
	77	};
	78
	79	/*
	80	* LTTng consumer mode
	81	*/
	82	enum lttng_kernel_output {
	83	LTTNG_KERNEL_SPLICE = 0,
	84	LTTNG_KERNEL_MMAP = 1,
	85	};
	86
	87	/*
	88	* Either addr is used or symbol_name and offset.
	89	*/
	90	struct lttng_event_kprobe_attr {
	91	uint64_t addr;
	92
	93	uint64_t offset;
	94	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	95	};
	96
	97	/*
	98	* Function tracer
	99	*/
	100	struct lttng_event_function_attr {
	101	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	102	};
	103
	104	/*
	105	* Generic lttng event
	106	*/
	107	struct lttng_event {
	108	char name[LTTNG_SYMBOL_NAME_LEN];
	109	enum lttng_event_type type;
	110	/* Per event type configuration */
	111	union {
	112	struct lttng_event_kprobe_attr kprobe;
	113	struct lttng_event_function_attr ftrace;
	114	} attr;
	115	};
	116
	117	/* Tracer channel attributes */
	118	struct lttng_channel_attr {
	119	int overwrite; /* 1: overwrite, 0: discard */
	120	uint64_t subbuf_size; /* bytes */
	121	uint64_t num_subbuf; /* power of 2 */
	122	unsigned int switch_timer_interval; /* usec */
	123	unsigned int read_timer_interval; /* usec */
	124	enum lttng_kernel_output output; /* splice, mmap */
	125	};
	126
	127	/*
	128	* Basic session information.
	129	*/
	130	struct lttng_session {
	131	char name[NAME_MAX];
	132	char path[PATH_MAX];
	133	};
	134
	135	/* Channel information structure */
	136	struct lttng_channel {
	137	char name[NAME_MAX];
	138	struct lttng_channel_attr attr;
	139	};
	140
	141	/*
	142	* Session daemon control
	143	*/
	144	extern int lttng_connect_sessiond(void);
	145
	146	extern int lttng_create_session(char name, char path);
	147
	148	extern int lttng_destroy_session(char *name);
	149
	150	extern int lttng_disconnect_sessiond(void);
	151
	152	/* Return an allocated array of lttng_session */
	153	extern int lttng_list_sessions(struct lttng_session **sessions);
	154
	155	extern int lttng_session_daemon_alive(void);
	156
	157	/* Set tracing group for the current execution */
	158	extern int lttng_set_tracing_group(const char *name);
	159
	160	extern void lttng_set_session_name(char *name);
	161
	162	extern const char *lttng_get_readable_code(int code);
	163
	164	extern int lttng_start_tracing(char *session_name);
	165
	166	extern int lttng_stop_tracing(char *session_name);
	167
	168	//extern int lttng_ust_list_traceable_apps(pid_t **pids);
	169
	170	/*
	171	* LTTng Kernel tracer control
	172	*/
	173	extern int lttng_kernel_add_context(struct lttng_kernel_context *ctx,
	174	char event_name, char channel_name);
	175
	176	extern int lttng_kernel_create_channel(struct lttng_channel *chan);
	177
	178	extern int lttng_kernel_enable_event(struct lttng_event ev, char channel_name);
	179
	180	extern int lttng_kernel_enable_channel(char *name);
	181
	182	extern int lttng_kernel_disable_event(char name, char channel_name);
	183
	184	extern int lttng_kernel_disable_channel(char *name);
	185
	186	extern int lttng_kernel_list_events(char **event_list);
	187
	188	/*
	189	* LTTng User-space tracer control
	190	*/
	191
	192	#endif /* _LTTNG_H */