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/consumer.h>
22 #include <common/hashtable/hashtable.h>
23 #include <lttng/lttng.h>
29 struct snapshot_output
;
31 enum consumer_dst_type
{
36 struct consumer_socket
{
38 * File descriptor. This is just a reference to the consumer data meaning
39 * that every access must be locked and checked for a possible invalid
45 * To use this socket (send/recv), this lock MUST be acquired.
47 pthread_mutex_t
*lock
;
50 * Indicates if the socket was registered by a third part
51 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
52 * During the destroy phase of a consumer output, we close the socket if
53 * this flag is set to 1 since we don't need the fd anymore.
55 unsigned int registered
;
57 /* Flag if network sockets were sent to the consumer. */
58 unsigned int control_sock_sent
;
59 unsigned int data_sock_sent
;
61 struct lttng_ht_node_ulong node
;
63 enum lttng_consumer_type type
;
66 struct consumer_data
{
67 enum lttng_consumer_type type
;
69 /* Mutex to control consumerd pid assignation */
70 pthread_mutex_t pid_mutex
;
74 /* These two sockets uses the cmd_unix_sock_path. */
77 * Write-end of the channel monitoring pipe to be passed to the
80 int channel_monitor_pipe
;
82 * The metadata socket object is handled differently and only created
83 * locally in this object thus it's the only reference available in the
84 * session daemon. For that reason, a variable for the fd is required and
85 * the metadata socket fd points to it.
88 struct consumer_socket metadata_sock
;
90 /* consumer error and command Unix socket path */
91 const char *err_unix_sock_path
;
92 const char *cmd_unix_sock_path
;
95 * This lock has two purposes. It protects any change to the consumer
96 * socket and make sure only one thread uses this object for read/write
105 struct consumer_net
{
107 * Indicate if URI type is set. Those flags should only be set when the
108 * created URI is done AND valid.
114 * The following two URIs MUST have the same destination address for
115 * network streaming to work. Network hop are not yet supported.
118 /* Control path for network streaming. */
119 struct lttng_uri control
;
121 /* Data path for network streaming. */
122 struct lttng_uri data
;
124 /* <hostname>/<session-name> */
125 char base_dir
[PATH_MAX
];
129 * Consumer output object describing where and how to send data.
131 struct consumer_output
{
132 struct urcu_ref ref
; /* Refcount */
134 /* If the consumer is enabled meaning that should be used */
135 unsigned int enabled
;
136 enum consumer_dst_type type
;
139 * The net_seq_index is the index of the network stream on the consumer
140 * side. It tells the consumer which streams goes to which relayd with this
141 * index. The relayd sockets are index with it on the consumer side.
143 uint64_t net_seq_index
;
144 /* Store the relay protocol in use if the session is remote. */
145 uint32_t relay_major_version
;
146 uint32_t relay_minor_version
;
149 * Subdirectory path name used for both local and network
150 * consumer (/kernel or /ust).
152 char subdir
[LTTNG_PATH_MAX
];
155 * Hashtable of consumer_socket index by the file descriptor value. For
156 * multiarch consumer support, we can have more than one consumer (ex: 32
159 struct lttng_ht
*socks
;
161 /* Tell if this output is used for snapshot. */
162 unsigned int snapshot
:1;
165 char session_root_path
[LTTNG_PATH_MAX
];
166 struct consumer_net net
;
170 * Sub-directory below the session_root_path where the next chunk of
171 * trace will be stored (\0 before the first session rotation).
173 char chunk_path
[LTTNG_PATH_MAX
];
176 struct consumer_socket
*consumer_find_socket(int key
,
177 struct consumer_output
*consumer
);
178 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
179 struct consumer_output
*consumer
);
180 struct consumer_socket
*consumer_allocate_socket(int *fd
);
181 void consumer_add_socket(struct consumer_socket
*sock
,
182 struct consumer_output
*consumer
);
183 void consumer_del_socket(struct consumer_socket
*sock
,
184 struct consumer_output
*consumer
);
185 void consumer_destroy_socket(struct consumer_socket
*sock
);
186 int consumer_copy_sockets(struct consumer_output
*dst
,
187 struct consumer_output
*src
);
188 void consumer_destroy_output_sockets(struct consumer_output
*obj
);
189 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
,
191 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
,
194 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
);
195 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
);
196 void consumer_output_get(struct consumer_output
*obj
);
197 void consumer_output_put(struct consumer_output
*obj
);
198 int consumer_set_network_uri(struct consumer_output
*obj
,
199 struct lttng_uri
*uri
);
200 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
202 int consumer_send_msg(struct consumer_socket
*sock
,
203 struct lttcomm_consumer_msg
*msg
);
204 int consumer_send_stream(struct consumer_socket
*sock
,
205 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
206 const int *fds
, size_t nb_fd
);
207 int consumer_send_channel(struct consumer_socket
*sock
,
208 struct lttcomm_consumer_msg
*msg
);
209 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
210 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
211 enum lttng_stream_type type
, uint64_t session_id
,
212 char *session_name
, char *hostname
, int session_live_timer
);
213 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
215 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
216 struct consumer_output
*consumer
);
217 int consumer_recv_status_reply(struct consumer_socket
*sock
);
218 int consumer_recv_status_channel(struct consumer_socket
*sock
,
219 uint64_t *key
, unsigned int *stream_count
);
220 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
);
221 int consumer_create_socket(struct consumer_data
*data
,
222 struct consumer_output
*output
);
223 int consumer_set_subdir(struct consumer_output
*consumer
,
224 const char *session_name
);
226 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
227 uint64_t subbuf_size
,
230 unsigned int switch_timer_interval
,
231 unsigned int read_timer_interval
,
232 unsigned int live_timer_interval
,
233 unsigned int monitor_timer_interval
,
237 const char *pathname
,
245 uint64_t tracefile_size
,
246 uint64_t tracefile_count
,
247 uint64_t session_id_per_pid
,
248 unsigned int monitor
,
249 uint32_t ust_app_uid
,
250 int64_t blocking_timeout
,
251 const char *root_shm_path
,
252 const char *shm_path
,
253 uint64_t trace_archive_id
);
254 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
255 uint64_t channel_key
,
258 uint64_t trace_archive_id
);
259 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
260 enum lttng_consumer_command cmd
,
261 uint64_t channel_key
, uint64_t net_seq_idx
);
262 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
263 uint64_t channel_key
,
265 const char *pathname
,
270 unsigned int nb_init_streams
,
271 enum lttng_event_output output
,
273 uint64_t tracefile_size
,
274 uint64_t tracefile_count
,
275 unsigned int monitor
,
276 unsigned int live_timer_interval
,
277 unsigned int monitor_timer_interval
);
278 int consumer_is_data_pending(uint64_t session_id
,
279 struct consumer_output
*consumer
);
280 int consumer_close_metadata(struct consumer_socket
*socket
,
281 uint64_t metadata_key
);
282 int consumer_setup_metadata(struct consumer_socket
*socket
,
283 uint64_t metadata_key
);
284 int consumer_push_metadata(struct consumer_socket
*socket
,
285 uint64_t metadata_key
, char *metadata_str
, size_t len
,
286 size_t target_offset
, uint64_t version
);
287 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
);
288 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
);
289 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
290 struct consumer_output
*consumer
, uint64_t *discarded
);
291 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
292 struct consumer_output
*consumer
, uint64_t *lost
);
294 /* Snapshot command. */
295 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
296 uint64_t key
, struct snapshot_output
*output
, int metadata
,
297 uid_t uid
, gid_t gid
, const char *session_path
, int wait
,
298 uint64_t nb_packets_per_stream
, uint64_t trace_archive_id
);
300 /* Rotation commands. */
301 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
302 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
303 char *domain_path
, bool is_metadata_channel
, uint64_t new_chunk_id
);
304 int consumer_rotate_rename(struct consumer_socket
*socket
, uint64_t session_id
,
305 const struct consumer_output
*output
, const char *old_path
,
306 const char *new_path
, uid_t uid
, gid_t gid
);
307 int consumer_check_rotation_pending_local(struct consumer_socket
*socket
,
308 uint64_t session_id
, uint64_t chunk_id
);
309 int consumer_check_rotation_pending_relay(struct consumer_socket
*socket
,
310 const struct consumer_output
*output
, uint64_t session_id
,
312 int consumer_mkdir(struct consumer_socket
*socket
, uint64_t session_id
,
313 const struct consumer_output
*output
, const char *path
,
314 uid_t uid
, gid_t gid
);
316 #endif /* _CONSUMER_H */