2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
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.
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
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.
21 #include <common/consumer.h>
22 #include <common/hashtable/hashtable.h>
23 #include <lttng/lttng.h>
28 struct snapshot_output
;
30 enum consumer_dst_type
{
35 struct consumer_socket
{
37 * File descriptor. This is just a reference to the consumer data meaning
38 * that every access must be locked and checked for a possible invalid
44 * To use this socket (send/recv), this lock MUST be acquired.
46 pthread_mutex_t
*lock
;
49 * Indicates if the socket was registered by a third part
50 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
51 * During the destroy phase of a consumer output, we close the socket if
52 * this flag is set to 1 since we don't need the fd anymore.
54 unsigned int registered
;
56 /* Flag if network sockets were sent to the consumer. */
57 unsigned int control_sock_sent
;
58 unsigned int data_sock_sent
;
60 struct lttng_ht_node_ulong node
;
62 enum lttng_consumer_type type
;
65 struct consumer_data
{
66 enum lttng_consumer_type type
;
68 pthread_t thread
; /* Worker thread interacting with the consumer */
70 /* Conditions used by the consumer thread to indicate readiness. */
72 pthread_condattr_t condattr
;
73 pthread_mutex_t cond_mutex
;
76 * This is a flag condition indicating that the consumer thread is ready
77 * and connected to the lttng-consumerd daemon. This flag MUST only be
78 * updated by locking the condition mutex above or before spawning a
81 * A value of 0 means that the thread is NOT ready. A value of 1 means that
82 * the thread consumer did connect successfully to the lttng-consumerd
83 * daemon. A negative value indicates that there is been an error and the
84 * thread has likely quit.
86 int consumer_thread_is_ready
;
88 /* Mutex to control consumerd pid assignation */
89 pthread_mutex_t pid_mutex
;
93 /* These two sockets uses the cmd_unix_sock_path. */
96 * The metadata socket object is handled differently and only created
97 * locally in this object thus it's the only reference available in the
98 * session daemon. For that reason, a variable for the fd is required and
99 * the metadata socket fd points to it.
102 struct consumer_socket metadata_sock
;
104 /* consumer error and command Unix socket path */
105 char err_unix_sock_path
[PATH_MAX
];
106 char cmd_unix_sock_path
[PATH_MAX
];
109 * This lock has two purposes. It protects any change to the consumer
110 * socket and make sure only one thread uses this object for read/write
113 pthread_mutex_t lock
;
119 struct consumer_net
{
121 * Indicate if URI type is set. Those flags should only be set when the
122 * created URI is done AND valid.
128 * The following two URIs MUST have the same destination address for
129 * network streaming to work. Network hop are not yet supported.
132 /* Control path for network streaming. */
133 struct lttng_uri control
;
135 /* Data path for network streaming. */
136 struct lttng_uri data
;
140 * Consumer output object describing where and how to send data.
142 struct consumer_output
{
143 /* If the consumer is enabled meaning that should be used */
144 unsigned int enabled
;
145 enum consumer_dst_type type
;
148 * The net_seq_index is the index of the network stream on the consumer
149 * side. It tells the consumer which streams goes to which relayd with this
150 * index. The relayd sockets are index with it on the consumer side.
152 uint64_t net_seq_index
;
155 * Subdirectory path name used for both local and network consumer.
157 char subdir
[PATH_MAX
];
160 * Hashtable of consumer_socket index by the file descriptor value. For
161 * multiarch consumer support, we can have more than one consumer (ex: 32
164 struct lttng_ht
*socks
;
166 /* Tell if this output is used for snapshot. */
167 unsigned int snapshot
:1;
170 char trace_path
[PATH_MAX
];
171 struct consumer_net net
;
175 struct consumer_socket
*consumer_find_socket(int key
,
176 struct consumer_output
*consumer
);
177 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
178 struct consumer_output
*consumer
);
179 struct consumer_socket
*consumer_allocate_socket(int *fd
);
180 void consumer_add_socket(struct consumer_socket
*sock
,
181 struct consumer_output
*consumer
);
182 void consumer_del_socket(struct consumer_socket
*sock
,
183 struct consumer_output
*consumer
);
184 void consumer_destroy_socket(struct consumer_socket
*sock
);
185 int consumer_copy_sockets(struct consumer_output
*dst
,
186 struct consumer_output
*src
);
187 void consumer_destroy_output_sockets(struct consumer_output
*obj
);
188 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
,
190 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
,
193 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
);
194 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
);
195 void consumer_destroy_output(struct consumer_output
*obj
);
196 int consumer_set_network_uri(struct consumer_output
*obj
,
197 struct lttng_uri
*uri
);
198 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
);
199 int consumer_send_msg(struct consumer_socket
*sock
,
200 struct lttcomm_consumer_msg
*msg
);
201 int consumer_send_stream(struct consumer_socket
*sock
,
202 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
203 int *fds
, size_t nb_fd
);
204 int consumer_send_channel(struct consumer_socket
*sock
,
205 struct lttcomm_consumer_msg
*msg
);
206 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
207 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
208 enum lttng_stream_type type
, uint64_t session_id
,
209 char *session_name
, char *hostname
, int session_live_timer
);
210 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
211 struct consumer_output
*consumer
);
212 int consumer_recv_status_reply(struct consumer_socket
*sock
);
213 int consumer_recv_status_channel(struct consumer_socket
*sock
,
214 uint64_t *key
, unsigned int *stream_count
);
215 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
);
216 int consumer_create_socket(struct consumer_data
*data
,
217 struct consumer_output
*output
);
218 int consumer_set_subdir(struct consumer_output
*consumer
,
219 const char *session_name
);
221 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
222 uint64_t subbuf_size
,
225 unsigned int switch_timer_interval
,
226 unsigned int read_timer_interval
,
227 unsigned int live_timer_interval
,
231 const char *pathname
,
239 uint64_t tracefile_size
,
240 uint64_t tracefile_count
,
241 uint64_t session_id_per_pid
,
242 unsigned int monitor
,
243 uint32_t ust_app_uid
);
244 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
245 enum lttng_consumer_command cmd
,
246 uint64_t channel_key
,
249 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
250 enum lttng_consumer_command cmd
,
251 uint64_t channel_key
,
253 const char *pathname
,
258 unsigned int nb_init_streams
,
259 enum lttng_event_output output
,
261 uint64_t tracefile_size
,
262 uint64_t tracefile_count
,
263 unsigned int monitor
,
264 unsigned int live_timer_interval
);
265 int consumer_is_data_pending(uint64_t session_id
,
266 struct consumer_output
*consumer
);
267 int consumer_close_metadata(struct consumer_socket
*socket
,
268 uint64_t metadata_key
);
269 int consumer_setup_metadata(struct consumer_socket
*socket
,
270 uint64_t metadata_key
);
271 int consumer_push_metadata(struct consumer_socket
*socket
,
272 uint64_t metadata_key
, char *metadata_str
, size_t len
,
273 size_t target_offset
);
274 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
);
276 /* Snapshot command. */
277 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
278 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
279 const char *session_path
, int wait
, int max_size_per_stream
);
281 #endif /* _CONSUMER_H */