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

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

	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];

	/* 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;
};

/*
 * 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.
	 */
	uint64_t 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(struct consumer_socket *sock, int *fds, size_t nb_fd);
int consumer_send_msg(struct consumer_socket *sock,
		struct lttcomm_consumer_msg *msg);
int consumer_send_stream(struct consumer_socket *sock,
		struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
		int *fds, size_t nb_fd);
int consumer_send_channel(struct consumer_socket *sock,
		struct lttcomm_consumer_msg *msg);
int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
		struct lttcomm_sock *sock, struct consumer_output *consumer,
		enum lttng_stream_type type, uint64_t session_id);
int consumer_send_destroy_relayd(struct consumer_socket *sock,
		struct consumer_output *consumer);
int consumer_recv_status_reply(struct consumer_socket *sock);
int consumer_recv_status_channel(struct consumer_socket *sock,
		uint64_t *key, unsigned int *stream_count);
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_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
		uint64_t subbuf_size,
		uint64_t num_subbuf,
		int overwrite,
		unsigned int switch_timer_interval,
		unsigned int read_timer_interval,
		int output,
		int type,
		uint64_t session_id,
		const char *pathname,
		const char *name,
		uid_t uid,
		gid_t gid,
		uint64_t relayd_id,
		uint64_t key,
		unsigned char *uuid);
void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
		enum lttng_consumer_command cmd,
		uint64_t channel_key,
		uint64_t stream_key,
		int cpu);
void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
		enum lttng_consumer_command cmd,
		uint64_t channel_key,
		uint64_t session_id,
		const char *pathname,
		uid_t uid,
		gid_t gid,
		uint64_t relayd_id,
		const char *name,
		unsigned int nb_init_streams,
		enum lttng_event_output output,
		int type);
int consumer_is_data_pending(uint64_t session_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
ffe60014 DG	48	/* Flag if network sockets were sent to the consumer. */
	49	unsigned int control_sock_sent;
	50	unsigned int data_sock_sent;
	51
173af62f DG	52	struct lttng_ht_node_ulong node;
	53	};
	54
f1e16794 DG	55	struct consumer_data {
	56	enum lttng_consumer_type type;
	57
	58	pthread_t thread; /* Worker thread interacting with the consumer */
a23ec3a7 DG	59
	60	/* Conditions used by the consumer thread to indicate readiness. */
	61	pthread_cond_t cond;
	62	pthread_condattr_t condattr;
	63	pthread_mutex_t cond_mutex;
	64
	65	/*
	66	* This is a flag condition indicating that the consumer thread is ready
	67	* and connected to the lttng-consumerd daemon. This flag MUST only be
	68	* updated by locking the condition mutex above or before spawning a
	69	* consumer thread.
	70	*
	71	* A value of 0 means that the thread is NOT ready. A value of 1 means that
	72	* the thread consumer did connect successfully to the lttng-consumerd
	73	* daemon. A negative value indicates that there is been an error and the
	74	* thread has likely quit.
	75	*/
	76	int consumer_thread_is_ready;
f1e16794 DG	77
	78	/* Mutex to control consumerd pid assignation */
	79	pthread_mutex_t pid_mutex;
	80	pid_t pid;
	81
	82	int err_sock;
	83	int cmd_sock;
	84
	85	/* consumer error and command Unix socket path */
	86	char err_unix_sock_path[PATH_MAX];
	87	char cmd_unix_sock_path[PATH_MAX];
44a5e5eb	88
173af62f DG	89	/* communication lock */
173af62f DG	90	pthread_mutex_t lock;
f1e16794 DG	91	};
f1e16794 DG	92
00e2e675 DG	93	/*
	94	* Network URIs
	95	*/
	96	struct consumer_net {
	97	/*
	98	* Indicate if URI type is set. Those flags should only be set when the
	99	* created URI is done AND valid.
	100	*/
	101	int control_isset;
	102	int data_isset;
	103
	104	/*
	105	* The following two URIs MUST have the same destination address for
	106	* network streaming to work. Network hop are not yet supported.
	107	*/
	108
	109	/* Control path for network streaming. */
	110	struct lttng_uri control;
	111
	112	/* Data path for network streaming. */
	113	struct lttng_uri data;
	114	};
	115
	116	/*
	117	* Consumer output object describing where and how to send data.
	118	*/
	119	struct consumer_output {
00e2e675 DG	120	/* If the consumer is enabled meaning that should be used */
	121	unsigned int enabled;
	122	enum consumer_dst_type type;
173af62f	123
00e2e675 DG	124	/*
00e2e675 DG	125	* The net_seq_index is the index of the network stream on the consumer
3f8e211f DG	126	* side. It tells the consumer which streams goes to which relayd with this
3f8e211f DG	127	* index. The relayd sockets are index with it on the consumer side.
00e2e675	128	*/
d88aee68	129	uint64_t net_seq_index;
173af62f	130
00e2e675 DG	131	/*
	132	* Subdirectory path name used for both local and network consumer.
	133	*/
	134	char subdir[PATH_MAX];
173af62f DG	135
	136	/*
	137	* Hashtable of consumer_socket index by the file descriptor value. For
	138	* multiarch consumer support, we can have more than one consumer (ex: 32
	139	* and 64 bit).
	140	*/
	141	struct lttng_ht *socks;
	142
00e2e675 DG	143	union {
	144	char trace_path[PATH_MAX];
	145	struct consumer_net net;
	146	} dst;
	147	};
	148
173af62f DG	149	struct consumer_socket *consumer_find_socket(int key,
	150	struct consumer_output *consumer);
	151	struct consumer_socket *consumer_allocate_socket(int fd);
	152	void consumer_add_socket(struct consumer_socket *sock,
	153	struct consumer_output *consumer);
	154	void consumer_del_socket(struct consumer_socket *sock,
	155	struct consumer_output *consumer);
	156	void consumer_destroy_socket(struct consumer_socket *sock);
	157
00e2e675 DG	158	struct consumer_output *consumer_create_output(enum consumer_dst_type type);
	159	struct consumer_output consumer_copy_output(struct consumer_output obj);
	160	void consumer_destroy_output(struct consumer_output *obj);
	161	int consumer_set_network_uri(struct consumer_output *obj,
	162	struct lttng_uri *uri);
f50f23d9	163	int consumer_send_fds(struct consumer_socket sock, int fds, size_t nb_fd);
ffe60014 DG	164	int consumer_send_msg(struct consumer_socket *sock,
ffe60014 DG	165	struct lttcomm_consumer_msg *msg);
f50f23d9 DG	166	int consumer_send_stream(struct consumer_socket *sock,
	167	struct consumer_output dst, struct lttcomm_consumer_msg msg,
	168	int *fds, size_t nb_fd);
	169	int consumer_send_channel(struct consumer_socket *sock,
	170	struct lttcomm_consumer_msg *msg);
	171	int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
37278a1e	172	struct lttcomm_sock sock, struct consumer_output consumer,
d88aee68	173	enum lttng_stream_type type, uint64_t session_id);
173af62f DG	174	int consumer_send_destroy_relayd(struct consumer_socket *sock,
173af62f DG	175	struct consumer_output *consumer);
f50f23d9	176	int consumer_recv_status_reply(struct consumer_socket *sock);
ffe60014	177	int consumer_recv_status_channel(struct consumer_socket *sock,
d88aee68	178	uint64_t key, unsigned int stream_count);
2f77fc4b	179	void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
a4b92340 DG	180	int consumer_create_socket(struct consumer_data *data,
a4b92340 DG	181	struct consumer_output *output);
2f77fc4b DG	182	int consumer_set_subdir(struct consumer_output *consumer,
2f77fc4b DG	183	const char *session_name);
37278a1e	184
ffe60014 DG	185	void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
	186	uint64_t subbuf_size,
	187	uint64_t num_subbuf,
	188	int overwrite,
	189	unsigned int switch_timer_interval,
	190	unsigned int read_timer_interval,
	191	int output,
	192	int type,
	193	uint64_t session_id,
	194	const char *pathname,
	195	const char *name,
	196	uid_t uid,
	197	gid_t gid,
d88aee68 DG	198	uint64_t relayd_id,
d88aee68 DG	199	uint64_t key,
ffe60014	200	unsigned char *uuid);
00e2e675 DG	201	void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
00e2e675 DG	202	enum lttng_consumer_command cmd,
d88aee68 DG	203	uint64_t channel_key,
d88aee68 DG	204	uint64_t stream_key,
ffe60014	205	int cpu);
00e2e675 DG	206	void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
00e2e675 DG	207	enum lttng_consumer_command cmd,
d88aee68	208	uint64_t channel_key,
ffe60014 DG	209	uint64_t session_id,
	210	const char *pathname,
	211	uid_t uid,
	212	gid_t gid,
d88aee68	213	uint64_t relayd_id,
c30aaa51	214	const char *name,
ffe60014 DG	215	unsigned int nb_init_streams,
	216	enum lttng_event_output output,
	217	int type);
d88aee68	218	int consumer_is_data_pending(uint64_t session_id,
806e2684	219	struct consumer_output *consumer);
00e2e675	220
f1e16794	221	#endif /* _CONSUMER_H */