[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"

/*
 * 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	/*
	37	* Event symbol length.
	38	*/
	39	#define LTTNG_SYMBOL_NAME_LEN 128
	40
	41	enum lttng_event_type {
	42	LTTNG_EVENT_TRACEPOINTS,
	43	LTTNG_EVENT_KPROBES,
	44	LTTNG_EVENT_FUNCTION,
	45	};
	46
	47	/* Kernel context possible type */
	48	enum lttng_kernel_context_type {
	49	LTTNG_KERNEL_CONTEXT_PID = 0,
	50	LTTNG_KERNEL_CONTEXT_PERF_COUNTER = 1,
	51	LTTNG_KERNEL_CONTEXT_COMM = 2,
	52	LTTNG_KERNEL_CONTEXT_PRIO = 3,
	53	LTTNG_KERNEL_CONTEXT_NICE = 4,
	54	LTTNG_KERNEL_CONTEXT_VPID = 5,
	55	LTTNG_KERNEL_CONTEXT_TID = 6,
	56	LTTNG_KERNEL_CONTEXT_VTID = 7,
	57	LTTNG_KERNEL_CONTEXT_PPID = 8,
	58	LTTNG_KERNEL_CONTEXT_VPPID = 9,
	59	};
	60
	61	/* Perf counter attributes */
	62	struct lttng_kernel_perf_counter_ctx {
	63	uint32_t type;
	64	uint64_t config;
	65	char name[LTTNG_SYMBOL_NAME_LEN];
	66	};
	67
	68	/* Event/Channel context */
	69	struct lttng_kernel_context {
	70	enum lttng_kernel_context_type ctx;
	71	union {
	72	struct lttng_kernel_perf_counter_ctx perf_counter;
	73	} u;
	74	};
	75
	76	/*
	77	* LTTng consumer mode
	78	*/
	79	enum lttng_kernel_output {
	80	LTTNG_KERNEL_SPLICE = 0,
	81	LTTNG_KERNEL_MMAP = 1,
	82	};
	83
	84	/*
	85	* Either addr is used or symbol_name and offset.
	86	*/
	87	struct lttng_event_kprobe_attr {
	88	uint64_t addr;
	89
	90	uint64_t offset;
	91	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	92	};
	93
	94	/*
	95	* Function tracer
	96	*/
	97	struct lttng_event_function_attr {
	98	char symbol_name[LTTNG_SYMBOL_NAME_LEN];
	99	};
	100
	101	/*
	102	* Generic lttng event
	103	*/
	104	struct lttng_event {
	105	char name[LTTNG_SYMBOL_NAME_LEN];
	106	enum lttng_event_type type;
	107	/* Per event type configuration */
	108	union {
	109	struct lttng_event_kprobe_attr kprobe;
	110	struct lttng_event_function_attr ftrace;
	111	} attr;
	112	};
	113
	114	/* Tracer channel attributes */
	115	struct lttng_channel_attr {
	116	int overwrite; /* 1: overwrite, 0: discard */
	117	uint64_t subbuf_size; /* bytes */
	118	uint64_t num_subbuf; /* power of 2 */
	119	unsigned int switch_timer_interval; /* usec */
	120	unsigned int read_timer_interval; /* usec */
	121	enum lttng_kernel_output output; /* splice, mmap */
	122	};
	123
	124	/*
	125	* Basic session information.
	126	*/
	127	struct lttng_session {
	128	char name[NAME_MAX];
	129	char path[PATH_MAX];
	130	};
	131
	132	/* Channel information structure */
	133	struct lttng_channel {
	134	char name[NAME_MAX];
	135	struct lttng_channel_attr attr;
	136	};
	137
	138	/*
	139	* Session daemon control
	140	*/
	141	extern int lttng_connect_sessiond(void);
	142
	143	extern int lttng_create_session(char name, char path);
	144
	145	extern int lttng_destroy_session(char *name);
	146
	147	extern int lttng_disconnect_sessiond(void);
	148
	149	/* Return an allocated array of lttng_session */
	150	extern int lttng_list_sessions(struct lttng_session **sessions);
	151
	152	extern int lttng_session_daemon_alive(void);
	153
	154	/* Set tracing group for the current execution */
	155	extern int lttng_set_tracing_group(const char *name);
	156
	157	extern void lttng_set_session_name(char *name);
	158
	159	extern const char *lttng_get_readable_code(int code);
	160
	161	extern int lttng_start_tracing(char *session_name);
	162
	163	extern int lttng_stop_tracing(char *session_name);
	164
	165	//extern int lttng_ust_list_traceable_apps(pid_t **pids);
	166
	167	/*
	168	* LTTng Kernel tracer control
	169	*/
	170	extern int lttng_kernel_add_context(struct lttng_kernel_context *ctx,
	171	char event_name, char channel_name);
	172
	173	extern int lttng_kernel_create_channel(struct lttng_channel *chan);
	174
	175	extern int lttng_kernel_enable_event(struct lttng_event ev, char channel_name);
	176
	177	extern int lttng_kernel_enable_channel(char *name);
	178
	179	extern int lttng_kernel_disable_event(char name, char channel_name);
	180
	181	extern int lttng_kernel_disable_channel(char *name);
	182
	183	extern int lttng_kernel_list_events(char **event_list);
	184
	185	/*
	186	* LTTng User-space tracer control
	187	*/
	188
	189	#endif /* _LTTNG_H */