[lttng-tools.git] / src / bin / lttng-sessiond / consumer.h

/*
 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License, version 2 only, as
 * published by the Free Software Foundation.
 *
 * 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., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _CONSUMER_H
#define _CONSUMER_H

#include <common/consumer.h>
#include <common/hashtable/hashtable.h>
#include <lttng/lttng.h>

#include "health.h"

enum consumer_dst_type {
	CONSUMER_DST_LOCAL,
	CONSUMER_DST_NET,
};

struct consumer_socket {
	/* File descriptor */
	int fd;
	/*
	 * To use this socket (send/recv), this lock MUST be acquired.
	 */
	pthread_mutex_t *lock;

	/*
	 * Indicates if the socket was registered by a third part
	 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
	 * During the destroy phase of a consumer output, we close the socket if
	 * this flag is set to 1 since we don't need the fd anymore.
	 */
	unsigned int registered;

	struct lttng_ht_node_ulong node;
};

struct consumer_data {
	enum lttng_consumer_type type;

	pthread_t thread;	/* Worker thread interacting with the consumer */

	/* Conditions used by the consumer thread to indicate readiness. */
	pthread_cond_t cond;
	pthread_condattr_t condattr;
	pthread_mutex_t cond_mutex;

	/*
	 * This is a flag condition indicating that the consumer thread is ready
	 * and connected to the lttng-consumerd daemon. This flag MUST only be
	 * updated by locking the condition mutex above or before spawning a
	 * consumer thread.
	 *
	 * A value of 0 means that the thread is NOT ready. A value of 1 means that
	 * the thread consumer did connect successfully to the lttng-consumerd
	 * daemon. A negative value indicates that there is been an error and the
	 * thread has likely quit.
	 */
	int consumer_thread_is_ready;

	/* Mutex to control consumerd pid assignation */
	pthread_mutex_t pid_mutex;
	pid_t pid;

	int err_sock;
	int cmd_sock;

	/* consumer error and command Unix socket path */
	char err_unix_sock_path[PATH_MAX];
	char cmd_unix_sock_path[PATH_MAX];

	/* Health check of the thread */
	struct health_state health;

	/* communication lock */
	pthread_mutex_t lock;
};

/*
 * Network URIs
 */
struct consumer_net {
	/*
	 * Indicate if URI type is set. Those flags should only be set when the
	 * created URI is done AND valid.
	 */
	int control_isset;
	int data_isset;

	/*
	 * The following two URIs MUST have the same destination address for
	 * network streaming to work. Network hop are not yet supported.
	 */

	/* Control path for network streaming. */
	struct lttng_uri control;

	/* Data path for network streaming. */
	struct lttng_uri data;

	/* Flag if network sockets were sent to the consumer. */
	unsigned int control_sock_sent;
	unsigned int data_sock_sent;
};

/*
 * Consumer output object describing where and how to send data.
 */
struct consumer_output {
	/* If the consumer is enabled meaning that should be used */
	unsigned int enabled;
	enum consumer_dst_type type;

	/*
	 * The net_seq_index is the index of the network stream on the consumer
	 * side. It tells the consumer which streams goes to which relayd with this
	 * index. The relayd sockets are index with it on the consumer side.
	 */
	int net_seq_index;

	/*
	 * Subdirectory path name used for both local and network consumer.
	 */
	char subdir[PATH_MAX];

	/*
	 * Hashtable of consumer_socket index by the file descriptor value. For
	 * multiarch consumer support, we can have more than one consumer (ex: 32
	 * and 64 bit).
	 */
	struct lttng_ht *socks;

	union {
		char trace_path[PATH_MAX];
		struct consumer_net net;
	} dst;
};

struct consumer_socket *consumer_find_socket(int key,
		struct consumer_output *consumer);
struct consumer_socket *consumer_allocate_socket(int fd);
void consumer_add_socket(struct consumer_socket *sock,
		struct consumer_output *consumer);
void consumer_del_socket(struct consumer_socket *sock,
		struct consumer_output *consumer);
void consumer_destroy_socket(struct consumer_socket *sock);

struct consumer_output *consumer_create_output(enum consumer_dst_type type);
struct consumer_output *consumer_copy_output(struct consumer_output *obj);
void consumer_destroy_output(struct consumer_output *obj);
int consumer_set_network_uri(struct consumer_output *obj,
		struct lttng_uri *uri);
int consumer_send_fds(int sock, int *fds, size_t nb_fd);
int consumer_send_stream(int sock, struct consumer_output *dst,
		struct lttcomm_consumer_msg *msg, int *fds, size_t nb_fd);
int consumer_send_channel(int sock, struct lttcomm_consumer_msg *msg);
int consumer_send_relayd_socket(int consumer_sock,
		struct lttcomm_sock *sock, struct consumer_output *consumer,
		enum lttng_stream_type type);
int consumer_send_destroy_relayd(struct consumer_socket *sock,
		struct consumer_output *consumer);
void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
int consumer_create_socket(struct consumer_data *data,
		struct consumer_output *output);
int consumer_set_subdir(struct consumer_output *consumer,
		const char *session_name);

void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
		enum lttng_consumer_command cmd,
		int channel_key,
		int stream_key,
		uint32_t state,
		enum lttng_event_output output,
		uint64_t mmap_len,
		uid_t uid,
		gid_t gid,
		int net_index,
		unsigned int metadata_flag,
		const char *name,
		const char *pathname,
		unsigned int session_id);
void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
		enum lttng_consumer_command cmd,
		int channel_key,
		uint64_t max_sb_size,
		uint64_t mmap_len,
		const char *name,
		unsigned int nb_init_streams);
int consumer_is_data_pending(unsigned int id,
		struct consumer_output *consumer);

#endif /* _CONSUMER_H */
Commit	Line	Data
f1e16794 DG	1	/*
	2	* Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
	3	*
	4	* This program is free software; you can redistribute it and/or modify it
	5	* under the terms of the GNU General Public License, version 2 only, as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful, but WITHOUT
	9	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	10	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	11	* more details.
	12	*
	13	* You should have received a copy of the GNU General Public License along with
	14	* this program; if not, write to the Free Software Foundation, Inc., 51
	15	* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	16	*/
	17
	18	#ifndef _CONSUMER_H
	19	#define _CONSUMER_H
	20
f1e16794	21	#include <common/consumer.h>
173af62f	22	#include <common/hashtable/hashtable.h>
00e2e675 DG	23	#include <lttng/lttng.h>
00e2e675 DG	24
44a5e5eb DG	25	#include "health.h"
44a5e5eb DG	26
00e2e675 DG	27	enum consumer_dst_type {
	28	CONSUMER_DST_LOCAL,
	29	CONSUMER_DST_NET,
	30	};
f1e16794	31
173af62f DG	32	struct consumer_socket {
	33	/* File descriptor */
	34	int fd;
	35	/*
	36	* To use this socket (send/recv), this lock MUST be acquired.
	37	*/
	38	pthread_mutex_t *lock;
2f77fc4b DG	39
	40	/*
	41	* Indicates if the socket was registered by a third part
	42	* (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
	43	* During the destroy phase of a consumer output, we close the socket if
	44	* this flag is set to 1 since we don't need the fd anymore.
	45	*/
	46	unsigned int registered;
	47
173af62f DG	48	struct lttng_ht_node_ulong node;
	49	};
	50
f1e16794 DG	51	struct consumer_data {
	52	enum lttng_consumer_type type;
	53
	54	pthread_t thread; /* Worker thread interacting with the consumer */
a23ec3a7 DG	55
	56	/* Conditions used by the consumer thread to indicate readiness. */
	57	pthread_cond_t cond;
	58	pthread_condattr_t condattr;
	59	pthread_mutex_t cond_mutex;
	60
	61	/*
	62	* This is a flag condition indicating that the consumer thread is ready
	63	* and connected to the lttng-consumerd daemon. This flag MUST only be
	64	* updated by locking the condition mutex above or before spawning a
	65	* consumer thread.
	66	*
	67	* A value of 0 means that the thread is NOT ready. A value of 1 means that
	68	* the thread consumer did connect successfully to the lttng-consumerd
	69	* daemon. A negative value indicates that there is been an error and the
	70	* thread has likely quit.
	71	*/
	72	int consumer_thread_is_ready;
f1e16794 DG	73
	74	/* Mutex to control consumerd pid assignation */
	75	pthread_mutex_t pid_mutex;
	76	pid_t pid;
	77
	78	int err_sock;
	79	int cmd_sock;
	80
	81	/* consumer error and command Unix socket path */
	82	char err_unix_sock_path[PATH_MAX];
	83	char cmd_unix_sock_path[PATH_MAX];
44a5e5eb DG	84
	85	/* Health check of the thread */
	86	struct health_state health;
173af62f DG	87
	88	/* communication lock */
	89	pthread_mutex_t lock;
f1e16794 DG	90	};
f1e16794 DG	91
00e2e675 DG	92	/*
	93	* Network URIs
	94	*/
	95	struct consumer_net {
	96	/*
	97	* Indicate if URI type is set. Those flags should only be set when the
	98	* created URI is done AND valid.
	99	*/
	100	int control_isset;
	101	int data_isset;
	102
	103	/*
	104	* The following two URIs MUST have the same destination address for
	105	* network streaming to work. Network hop are not yet supported.
	106	*/
	107
	108	/* Control path for network streaming. */
	109	struct lttng_uri control;
	110
	111	/* Data path for network streaming. */
	112	struct lttng_uri data;
3f8e211f DG	113
3f8e211f DG	114	/* Flag if network sockets were sent to the consumer. */
c890b720 DG	115	unsigned int control_sock_sent;
c890b720 DG	116	unsigned int data_sock_sent;
00e2e675 DG	117	};
	118
	119	/*
	120	* Consumer output object describing where and how to send data.
	121	*/
	122	struct consumer_output {
00e2e675 DG	123	/* If the consumer is enabled meaning that should be used */
	124	unsigned int enabled;
	125	enum consumer_dst_type type;
173af62f	126
00e2e675 DG	127	/*
00e2e675 DG	128	* The net_seq_index is the index of the network stream on the consumer
3f8e211f DG	129	* side. It tells the consumer which streams goes to which relayd with this
3f8e211f DG	130	* index. The relayd sockets are index with it on the consumer side.
00e2e675 DG	131	*/
00e2e675 DG	132	int net_seq_index;
173af62f	133
00e2e675 DG	134	/*
	135	* Subdirectory path name used for both local and network consumer.
	136	*/
	137	char subdir[PATH_MAX];
173af62f DG	138
	139	/*
	140	* Hashtable of consumer_socket index by the file descriptor value. For
	141	* multiarch consumer support, we can have more than one consumer (ex: 32
	142	* and 64 bit).
	143	*/
	144	struct lttng_ht *socks;
	145
00e2e675 DG	146	union {
	147	char trace_path[PATH_MAX];
	148	struct consumer_net net;
	149	} dst;
	150	};
	151
173af62f DG	152	struct consumer_socket *consumer_find_socket(int key,
	153	struct consumer_output *consumer);
	154	struct consumer_socket *consumer_allocate_socket(int fd);
	155	void consumer_add_socket(struct consumer_socket *sock,
	156	struct consumer_output *consumer);
	157	void consumer_del_socket(struct consumer_socket *sock,
	158	struct consumer_output *consumer);
	159	void consumer_destroy_socket(struct consumer_socket *sock);
	160
00e2e675 DG	161	struct consumer_output *consumer_create_output(enum consumer_dst_type type);
	162	struct consumer_output consumer_copy_output(struct consumer_output obj);
	163	void consumer_destroy_output(struct consumer_output *obj);
	164	int consumer_set_network_uri(struct consumer_output *obj,
	165	struct lttng_uri *uri);
	166	int consumer_send_fds(int sock, int *fds, size_t nb_fd);
	167	int consumer_send_stream(int sock, struct consumer_output *dst,
	168	struct lttcomm_consumer_msg msg, int fds, size_t nb_fd);
	169	int consumer_send_channel(int sock, struct lttcomm_consumer_msg *msg);
37278a1e DG	170	int consumer_send_relayd_socket(int consumer_sock,
	171	struct lttcomm_sock sock, struct consumer_output consumer,
	172	enum lttng_stream_type type);
173af62f DG	173	int consumer_send_destroy_relayd(struct consumer_socket *sock,
173af62f DG	174	struct consumer_output *consumer);
2f77fc4b	175	void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
a4b92340 DG	176	int consumer_create_socket(struct consumer_data *data,
a4b92340 DG	177	struct consumer_output *output);
2f77fc4b DG	178	int consumer_set_subdir(struct consumer_output *consumer,
2f77fc4b DG	179	const char *session_name);
37278a1e	180
00e2e675 DG	181	void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
	182	enum lttng_consumer_command cmd,
	183	int channel_key,
	184	int stream_key,
	185	uint32_t state,
	186	enum lttng_event_output output,
	187	uint64_t mmap_len,
	188	uid_t uid,
	189	gid_t gid,
	190	int net_index,
	191	unsigned int metadata_flag,
	192	const char *name,
ca22feea DG	193	const char *pathname,
ca22feea DG	194	unsigned int session_id);
00e2e675 DG	195	void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
	196	enum lttng_consumer_command cmd,
	197	int channel_key,
	198	uint64_t max_sb_size,
	199	uint64_t mmap_len,
c30aaa51 MD	200	const char *name,
c30aaa51 MD	201	unsigned int nb_init_streams);
6d805429	202	int consumer_is_data_pending(unsigned int id,
806e2684	203	struct consumer_output *consumer);
00e2e675	204
f1e16794	205	#endif /* _CONSUMER_H */