[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 <semaphore.h>

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

#include "health.h"

enum consumer_dst_type {
	CONSUMER_DST_LOCAL,
	CONSUMER_DST_NET,
};

struct consumer_data {
	enum lttng_consumer_type type;

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

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

/*
 * 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 {
	/* Consumer socket file descriptor */
	int sock;
	/* 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's basically the relayd socket file descriptor value so the
	 * consumer can identify which streams goes with which socket.
	 */
	int net_seq_index;
	/*
	 * Subdirectory path name used for both local and network consumer.
	 */
	char subdir[PATH_MAX];
	union {
		char trace_path[PATH_MAX];
		struct consumer_net net;
	} dst;
};

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

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

#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
	21	#include <semaphore.h>
	22
	23	#include <common/consumer.h>
00e2e675 DG	24	#include <lttng/lttng.h>
00e2e675 DG	25
44a5e5eb DG	26	#include "health.h"
44a5e5eb DG	27
00e2e675 DG	28	enum consumer_dst_type {
	29	CONSUMER_DST_LOCAL,
	30	CONSUMER_DST_NET,
	31	};
f1e16794 DG	32
	33	struct consumer_data {
	34	enum lttng_consumer_type type;
	35
	36	pthread_t thread; /* Worker thread interacting with the consumer */
	37	sem_t sem;
	38
	39	/* Mutex to control consumerd pid assignation */
	40	pthread_mutex_t pid_mutex;
	41	pid_t pid;
	42
	43	int err_sock;
	44	int cmd_sock;
	45
	46	/* consumer error and command Unix socket path */
	47	char err_unix_sock_path[PATH_MAX];
	48	char cmd_unix_sock_path[PATH_MAX];
44a5e5eb DG	49
	50	/* Health check of the thread */
	51	struct health_state health;
f1e16794 DG	52	};
f1e16794 DG	53
00e2e675 DG	54	/*
	55	* Network URIs
	56	*/
	57	struct consumer_net {
	58	/*
	59	* Indicate if URI type is set. Those flags should only be set when the
	60	* created URI is done AND valid.
	61	*/
	62	int control_isset;
	63	int data_isset;
	64
	65	/*
	66	* The following two URIs MUST have the same destination address for
	67	* network streaming to work. Network hop are not yet supported.
	68	*/
	69
	70	/* Control path for network streaming. */
	71	struct lttng_uri control;
	72
	73	/* Data path for network streaming. */
	74	struct lttng_uri data;
	75	};
	76
	77	/*
	78	* Consumer output object describing where and how to send data.
	79	*/
	80	struct consumer_output {
	81	/* Consumer socket file descriptor */
	82	int sock;
	83	/* If the consumer is enabled meaning that should be used */
	84	unsigned int enabled;
	85	enum consumer_dst_type type;
	86	/*
	87	* The net_seq_index is the index of the network stream on the consumer
	88	* side. It's basically the relayd socket file descriptor value so the
	89	* consumer can identify which streams goes with which socket.
	90	*/
	91	int net_seq_index;
	92	/*
	93	* Subdirectory path name used for both local and network consumer.
	94	*/
	95	char subdir[PATH_MAX];
	96	union {
	97	char trace_path[PATH_MAX];
	98	struct consumer_net net;
	99	} dst;
	100	};
	101
	102	struct consumer_output *consumer_create_output(enum consumer_dst_type type);
	103	struct consumer_output consumer_copy_output(struct consumer_output obj);
	104	void consumer_destroy_output(struct consumer_output *obj);
	105	int consumer_set_network_uri(struct consumer_output *obj,
	106	struct lttng_uri *uri);
	107	int consumer_send_fds(int sock, int *fds, size_t nb_fd);
	108	int consumer_send_stream(int sock, struct consumer_output *dst,
	109	struct lttcomm_consumer_msg msg, int fds, size_t nb_fd);
	110	int consumer_send_channel(int sock, struct lttcomm_consumer_msg *msg);
37278a1e DG	111	int consumer_send_relayd_socket(int consumer_sock,
	112	struct lttcomm_sock sock, struct consumer_output consumer,
	113	enum lttng_stream_type type);
	114
00e2e675 DG	115	void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
	116	enum lttng_consumer_command cmd,
	117	int channel_key,
	118	int stream_key,
	119	uint32_t state,
	120	enum lttng_event_output output,
	121	uint64_t mmap_len,
	122	uid_t uid,
	123	gid_t gid,
	124	int net_index,
	125	unsigned int metadata_flag,
	126	const char *name,
	127	const char *pathname);
	128	void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
	129	enum lttng_consumer_command cmd,
	130	int channel_key,
	131	uint64_t max_sb_size,
	132	uint64_t mmap_len,
	133	const char *name);
	134
f1e16794	135	#endif /* _CONSUMER_H */