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

/*
 * 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 _LIBLTTNGCTL_H
#define _LIBLTTNGCTL_H

#include <limits.h>
#include <stdint.h>
#include <uuid/uuid.h>

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

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

/* UUID string length (including \0) */
#define UUID_STR_LEN 37
/* UUID short string version length (including \0) */
#define UUID_SHORT_STR_LEN 9

typedef uint64_t u64;

/* Trace type for lttng_trace.
 */
enum lttng_trace_type {
	KERNEL, USERSPACE,
};

/* Simple structure representing a session.
 */
struct lttng_session {
	char name[NAME_MAX];
	uuid_t uuid;
};

/* Simple trace representation.
 */
struct lttng_trace {
	char name[NAME_MAX];
	pid_t pid;
	enum lttng_trace_type type;
};

/* TODO: don't export these into system-installed headers. */
/*
 * LTTng DebugFS ABI structures.
 */
enum lttng_instrum_type {
	INSTRUM_TRACEPOINTS,
};

struct lttng_channel {
	int overwrite;         /* 1: overwrite, 0: discard */
	u64 subbuf_size;
	u64 num_subbuf;
	unsigned int switch_timer_interval;
	unsigned int read_timer_interval;
};

struct lttng_event {
	enum lttng_instrum_type itype;
	char name[];
};

extern int lttng_create_session(char *name, uuid_t *session_id);
extern int lttng_destroy_session(uuid_t *uuid);
extern int lttng_connect_sessiond(void);
extern int lttng_disconnect_sessiond(void);
extern int lttng_set_tracing_group(const char *name);
extern int lttng_check_session_daemon(void);
extern const char *lttng_get_readable_code(int code);
extern int lttng_ust_list_apps(pid_t **pids);
extern int lttng_list_sessions(struct lttng_session **sessions);
extern int lttng_list_traces(uuid_t *uuid, struct lttng_trace **traces);
extern void lttng_set_current_session_uuid(uuid_t *uuid);
extern int lttng_ust_create_trace(pid_t pid);
extern int lttng_ust_start_trace(pid_t pid);
extern int lttng_ust_stop_trace(pid_t pid);

#endif /* _LIBLTTNGCTL_H */
Commit	Line	Data
	1	/*
	2	* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
	3	*
	4	* This program is free software; you can redistribute it and/or
	5	* modify it under the terms of the GNU General Public License
	6	* as published by the Free Software Foundation; either version 2
	7	* of the License, or (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	17	*/
	18
	19	#ifndef _LIBLTTNGCTL_H
	20	#define _LIBLTTNGCTL_H
	21
	22	#include <limits.h>
	23	#include <stdint.h>
	24	#include <uuid/uuid.h>
	25
	26	/* Default unix group name for tracing.
	27	*/
	28	#define DEFAULT_TRACING_GROUP "tracing"
	29
	30	/* Environment variable to set session daemon
	31	* binary path.
	32	*/
	33	#define LTTNG_SESSIOND_PATH_ENV "LTTNG_SESSIOND_PATH"
	34
	35	/* UUID string length (including \0) */
	36	#define UUID_STR_LEN 37
	37	/* UUID short string version length (including \0) */
	38	#define UUID_SHORT_STR_LEN 9
	39
	40	typedef uint64_t u64;
	41
	42	/* Trace type for lttng_trace.
	43	*/
	44	enum lttng_trace_type {
	45	KERNEL, USERSPACE,
	46	};
	47
	48	/* Simple structure representing a session.
	49	*/
	50	struct lttng_session {
	51	char name[NAME_MAX];
	52	uuid_t uuid;
	53	};
	54
	55	/* Simple trace representation.
	56	*/
	57	struct lttng_trace {
	58	char name[NAME_MAX];
	59	pid_t pid;
	60	enum lttng_trace_type type;
	61	};
	62
	63	/* TODO: don't export these into system-installed headers. */
	64	/*
	65	* LTTng DebugFS ABI structures.
	66	*/
	67	enum lttng_instrum_type {
	68	INSTRUM_TRACEPOINTS,
	69	};
	70
	71	struct lttng_channel {
	72	int overwrite; /* 1: overwrite, 0: discard */
	73	u64 subbuf_size;
	74	u64 num_subbuf;
	75	unsigned int switch_timer_interval;
	76	unsigned int read_timer_interval;
	77	};
	78
	79	struct lttng_event {
	80	enum lttng_instrum_type itype;
	81	char name[];
	82	};
	83
	84	extern int lttng_create_session(char name, uuid_t session_id);
	85	extern int lttng_destroy_session(uuid_t *uuid);
	86	extern int lttng_connect_sessiond(void);
	87	extern int lttng_disconnect_sessiond(void);
	88	extern int lttng_set_tracing_group(const char *name);
	89	extern int lttng_check_session_daemon(void);
	90	extern const char *lttng_get_readable_code(int code);
	91	extern int lttng_ust_list_apps(pid_t **pids);
	92	extern int lttng_list_sessions(struct lttng_session **sessions);
	93	extern int lttng_list_traces(uuid_t uuid, struct lttng_trace *traces);
	94	extern void lttng_set_current_session_uuid(uuid_t *uuid);
	95	extern int lttng_ust_create_trace(pid_t pid);
	96	extern int lttng_ust_start_trace(pid_t pid);
	97	extern int lttng_ust_stop_trace(pid_t pid);
	98
	99	#endif /* _LIBLTTNGCTL_H */