[lttng-tools.git] / ltt-sessiond / session.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 _LTT_SESSION_H
#define _LTT_SESSION_H

//#include <lttng/lttng.h>
#include <urcu/list.h>

/*
 * Tracing session list
 *
 * Statically declared in session.c and can be accessed by using
 * get_session_list() function that returns the pointer to the list.
 */
struct ltt_session_list {
	/*
	 * This lock protects any read/write access to the list and count (which is
	 * basically the list size). All public functions in session.c acquire this
	 * lock and release it before returning. If none of those functions are
	 * used, the lock MUST be acquired in order to iterate or/and do any
	 * actions on that list.
	 */
	pthread_mutex_t lock;

	/*
	 * Number of element in the list. The session list lock MUST be acquired if
	 * this counter is used when iterating over the session list.
	 */
	unsigned int count;

	/* Linked list head */
	struct cds_list_head head;
};

/*
 * This data structure contains information needed to identify a tracing
 * session for both LTTng and UST.
 */
struct ltt_session {
	char *name;
	char *path;
	struct ltt_kernel_session *kernel_session;
	struct cds_list_head ust_traces;
	unsigned int ust_trace_count;
	/*
	 * Protect any read/write on this session data structure. This lock must be
	 * acquired *before* using any public functions declared below. Use
	 * lock_session() and unlock_session() for that.
	 */
	pthread_mutex_t lock;
	struct cds_list_head list;
};

/* Prototypes */
int create_session(char *name, char *path);
int destroy_session(char *name);

void lock_session(struct ltt_session *session);
void lock_session_list(void);
void unlock_session(struct ltt_session *session);
void unlock_session_list(void);

struct ltt_session *find_session_by_name(char *name);
struct ltt_session_list *get_session_list(void);

#endif /* _LTT_SESSION_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 _LTT_SESSION_H
	20	#define _LTT_SESSION_H
	21
	22	//#include <lttng/lttng.h>
	23	#include <urcu/list.h>
	24
	25	/*
	26	* Tracing session list
	27	*
	28	* Statically declared in session.c and can be accessed by using
	29	* get_session_list() function that returns the pointer to the list.
	30	*/
	31	struct ltt_session_list {
	32	/*
	33	* This lock protects any read/write access to the list and count (which is
	34	* basically the list size). All public functions in session.c acquire this
	35	* lock and release it before returning. If none of those functions are
	36	* used, the lock MUST be acquired in order to iterate or/and do any
	37	* actions on that list.
	38	*/
	39	pthread_mutex_t lock;
	40
	41	/*
	42	* Number of element in the list. The session list lock MUST be acquired if
	43	* this counter is used when iterating over the session list.
	44	*/
	45	unsigned int count;
	46
	47	/* Linked list head */
	48	struct cds_list_head head;
	49	};
	50
	51	/*
	52	* This data structure contains information needed to identify a tracing
	53	* session for both LTTng and UST.
	54	*/
	55	struct ltt_session {
	56	char *name;
	57	char *path;
	58	struct ltt_kernel_session *kernel_session;
	59	struct cds_list_head ust_traces;
	60	unsigned int ust_trace_count;
	61	/*
	62	* Protect any read/write on this session data structure. This lock must be
	63	* acquired before using any public functions declared below. Use
	64	* lock_session() and unlock_session() for that.
	65	*/
	66	pthread_mutex_t lock;
	67	struct cds_list_head list;
	68	};
	69
	70	/* Prototypes */
	71	int create_session(char name, char path);
	72	int destroy_session(char *name);
	73
	74	void lock_session(struct ltt_session *session);
	75	void lock_session_list(void);
	76	void unlock_session(struct ltt_session *session);
	77	void unlock_session_list(void);
	78
	79	struct ltt_session find_session_by_name(char name);
	80	struct ltt_session_list *get_session_list(void);
	81
	82	#endif /* _LTT_SESSION_H */