Fix: Conditionally disable test requiring shared libs
[lttng-tools.git] / src / bin / lttng-sessiond / consumer.h
CommitLineData
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>
24
44a5e5eb
DG
25#include "health.h"
26
00e2e675
DG
27enum consumer_dst_type {
28 CONSUMER_DST_LOCAL,
29 CONSUMER_DST_NET,
30};
f1e16794 31
173af62f
DG
32struct 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
51struct 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 84
173af62f
DG
85 /* communication lock */
86 pthread_mutex_t lock;
f1e16794
DG
87};
88
00e2e675
DG
89/*
90 * Network URIs
91 */
92struct consumer_net {
93 /*
94 * Indicate if URI type is set. Those flags should only be set when the
95 * created URI is done AND valid.
96 */
97 int control_isset;
98 int data_isset;
99
100 /*
101 * The following two URIs MUST have the same destination address for
102 * network streaming to work. Network hop are not yet supported.
103 */
104
105 /* Control path for network streaming. */
106 struct lttng_uri control;
107
108 /* Data path for network streaming. */
109 struct lttng_uri data;
3f8e211f
DG
110
111 /* Flag if network sockets were sent to the consumer. */
c890b720
DG
112 unsigned int control_sock_sent;
113 unsigned int data_sock_sent;
00e2e675
DG
114};
115
116/*
117 * Consumer output object describing where and how to send data.
118 */
119struct 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 /*
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
127 * index. The relayd sockets are index with it on the consumer side.
00e2e675
DG
128 */
129 int 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
149struct consumer_socket *consumer_find_socket(int key,
150 struct consumer_output *consumer);
151struct consumer_socket *consumer_allocate_socket(int fd);
152void consumer_add_socket(struct consumer_socket *sock,
153 struct consumer_output *consumer);
154void consumer_del_socket(struct consumer_socket *sock,
155 struct consumer_output *consumer);
156void consumer_destroy_socket(struct consumer_socket *sock);
157
00e2e675
DG
158struct consumer_output *consumer_create_output(enum consumer_dst_type type);
159struct consumer_output *consumer_copy_output(struct consumer_output *obj);
160void consumer_destroy_output(struct consumer_output *obj);
161int consumer_set_network_uri(struct consumer_output *obj,
162 struct lttng_uri *uri);
f50f23d9
DG
163int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
164int consumer_send_stream(struct consumer_socket *sock,
165 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
166 int *fds, size_t nb_fd);
167int consumer_send_channel(struct consumer_socket *sock,
168 struct lttcomm_consumer_msg *msg);
169int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
37278a1e 170 struct lttcomm_sock *sock, struct consumer_output *consumer,
46e6455f 171 enum lttng_stream_type type, unsigned int session_id);
173af62f
DG
172int consumer_send_destroy_relayd(struct consumer_socket *sock,
173 struct consumer_output *consumer);
f50f23d9 174int consumer_recv_status_reply(struct consumer_socket *sock);
2f77fc4b 175void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
a4b92340
DG
176int consumer_create_socket(struct consumer_data *data,
177 struct consumer_output *output);
2f77fc4b
DG
178int consumer_set_subdir(struct consumer_output *consumer,
179 const char *session_name);
37278a1e 180
00e2e675
DG
181void 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,
194 unsigned int session_id);
00e2e675
DG
195void 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,
201 unsigned int nb_init_streams);
6d805429 202int consumer_is_data_pending(unsigned int id,
806e2684 203 struct consumer_output *consumer);
00e2e675 204
f1e16794 205#endif /* _CONSUMER_H */
This page took 0.049945 seconds and 4 git commands to generate.