Comments and cleanup review Mathieu & David

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