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
;
32 enum consumer_dst_type
{
37 struct consumer_socket
{
39 * File descriptor. This is just a reference to the consumer data meaning
40 * that every access must be locked and checked for a possible invalid
46 * To use this socket (send/recv), this lock MUST be acquired.
48 pthread_mutex_t
*lock
;
51 * Indicates if the socket was registered by a third part
52 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
53 * During the destroy phase of a consumer output, we close the socket if
54 * this flag is set to 1 since we don't need the fd anymore.
56 unsigned int registered
;
58 /* Flag if network sockets were sent to the consumer. */
59 unsigned int control_sock_sent
;
60 unsigned int data_sock_sent
;
62 struct lttng_ht_node_ulong node
;
64 enum lttng_consumer_type type
;
67 struct consumer_data
{
68 enum lttng_consumer_type type
;
70 /* Mutex to control consumerd pid assignation */
71 pthread_mutex_t pid_mutex
;
75 /* These two sockets uses the cmd_unix_sock_path. */
78 * Write-end of the channel monitoring pipe to be passed to the
81 int channel_monitor_pipe
;
83 * The metadata socket object is handled differently and only created
84 * locally in this object thus it's the only reference available in the
85 * session daemon. For that reason, a variable for the fd is required and
86 * the metadata socket fd points to it.
89 struct consumer_socket metadata_sock
;
91 /* consumer error and command Unix socket path */
92 const char *err_unix_sock_path
;
93 const char *cmd_unix_sock_path
;
96 * This lock has two purposes. It protects any change to the consumer
97 * socket and make sure only one thread uses this object for read/write
100 pthread_mutex_t lock
;
106 struct consumer_net
{
108 * Indicate if URI type is set. Those flags should only be set when the
109 * created URI is done AND valid.
115 * The following two URIs MUST have the same destination address for
116 * network streaming to work. Network hop are not yet supported.
119 /* Control path for network streaming. */
120 struct lttng_uri control
;
122 /* Data path for network streaming. */
123 struct lttng_uri data
;
125 /* <hostname>/<session-name> */
126 char base_dir
[PATH_MAX
];
130 * Consumer output object describing where and how to send data.
132 struct consumer_output
{
133 struct urcu_ref ref
; /* Refcount */
135 /* If the consumer is enabled meaning that should be used */
136 unsigned int enabled
;
137 enum consumer_dst_type type
;
140 * The net_seq_index is the index of the network stream on the consumer
141 * side. It tells the consumer which streams goes to which relayd with this
142 * index. The relayd sockets are index with it on the consumer side.
144 uint64_t net_seq_index
;
145 /* Store the relay protocol in use if the session is remote. */
146 uint32_t relay_major_version
;
147 uint32_t relay_minor_version
;
150 * Subdirectory path name used for both local and network
151 * consumer ("/kernel", "/ust", or empty).
153 char domain_subdir
[max(sizeof(DEFAULT_KERNEL_TRACE_DIR
),
154 sizeof(DEFAULT_UST_TRACE_DIR
))];
157 * Hashtable of consumer_socket index by the file descriptor value. For
158 * multiarch consumer support, we can have more than one consumer (ex:
161 struct lttng_ht
*socks
;
163 /* Tell if this output is used for snapshot. */
164 unsigned int snapshot
:1;
167 char session_root_path
[LTTNG_PATH_MAX
];
168 struct consumer_net net
;
172 * Sub-directory below the session_root_path where the next chunk of
173 * trace will be stored (\0 before the first session rotation).
175 char chunk_path
[LTTNG_PATH_MAX
];
178 struct consumer_socket
*consumer_find_socket(int key
,
179 struct consumer_output
*consumer
);
180 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
181 struct consumer_output
*consumer
);
182 struct consumer_socket
*consumer_allocate_socket(int *fd
);
183 void consumer_add_socket(struct consumer_socket
*sock
,
184 struct consumer_output
*consumer
);
185 void consumer_del_socket(struct consumer_socket
*sock
,
186 struct consumer_output
*consumer
);
187 void consumer_destroy_socket(struct consumer_socket
*sock
);
188 int consumer_copy_sockets(struct consumer_output
*dst
,
189 struct consumer_output
*src
);
190 void consumer_destroy_output_sockets(struct consumer_output
*obj
);
191 int consumer_socket_send(struct consumer_socket
*socket
, void *msg
,
193 int consumer_socket_recv(struct consumer_socket
*socket
, void *msg
,
196 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
);
197 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
);
198 void consumer_output_get(struct consumer_output
*obj
);
199 void consumer_output_put(struct consumer_output
*obj
);
200 int consumer_set_network_uri(const struct ltt_session
*session
,
201 struct consumer_output
*obj
,
202 struct lttng_uri
*uri
);
203 int consumer_send_fds(struct consumer_socket
*sock
, const int *fds
,
205 int consumer_send_msg(struct consumer_socket
*sock
,
206 struct lttcomm_consumer_msg
*msg
);
207 int consumer_send_stream(struct consumer_socket
*sock
,
208 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
209 const int *fds
, size_t nb_fd
);
210 int consumer_send_channel(struct consumer_socket
*sock
,
211 struct lttcomm_consumer_msg
*msg
);
212 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
213 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
214 enum lttng_stream_type type
, uint64_t session_id
,
215 const char *session_name
, const char *hostname
,
216 int session_live_timer
);
217 int consumer_send_channel_monitor_pipe(struct consumer_socket
*consumer_sock
,
219 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
220 struct consumer_output
*consumer
);
221 int consumer_recv_status_reply(struct consumer_socket
*sock
);
222 int consumer_recv_status_channel(struct consumer_socket
*sock
,
223 uint64_t *key
, unsigned int *stream_count
);
224 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
);
225 int consumer_create_socket(struct consumer_data
*data
,
226 struct consumer_output
*output
);
228 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
229 uint64_t subbuf_size
,
232 unsigned int switch_timer_interval
,
233 unsigned int read_timer_interval
,
234 unsigned int live_timer_interval
,
235 unsigned int monitor_timer_interval
,
239 const char *pathname
,
247 uint64_t tracefile_size
,
248 uint64_t tracefile_count
,
249 uint64_t session_id_per_pid
,
250 unsigned int monitor
,
251 uint32_t ust_app_uid
,
252 int64_t blocking_timeout
,
253 const char *root_shm_path
,
254 const char *shm_path
,
255 uint64_t trace_archive_id
);
256 void consumer_init_add_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
257 uint64_t channel_key
,
260 uint64_t trace_archive_id
);
261 void consumer_init_streams_sent_comm_msg(struct lttcomm_consumer_msg
*msg
,
262 enum lttng_consumer_command cmd
,
263 uint64_t channel_key
, uint64_t net_seq_idx
);
264 void consumer_init_add_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
265 uint64_t channel_key
,
267 const char *pathname
,
272 unsigned int nb_init_streams
,
273 enum lttng_event_output output
,
275 uint64_t tracefile_size
,
276 uint64_t tracefile_count
,
277 unsigned int monitor
,
278 unsigned int live_timer_interval
,
279 unsigned int monitor_timer_interval
);
280 int consumer_is_data_pending(uint64_t session_id
,
281 struct consumer_output
*consumer
);
282 int consumer_close_metadata(struct consumer_socket
*socket
,
283 uint64_t metadata_key
);
284 int consumer_setup_metadata(struct consumer_socket
*socket
,
285 uint64_t metadata_key
);
286 int consumer_push_metadata(struct consumer_socket
*socket
,
287 uint64_t metadata_key
, char *metadata_str
, size_t len
,
288 size_t target_offset
, uint64_t version
);
289 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
);
290 int consumer_clear_quiescent_channel(struct consumer_socket
*socket
, uint64_t key
);
291 int consumer_get_discarded_events(uint64_t session_id
, uint64_t channel_key
,
292 struct consumer_output
*consumer
, uint64_t *discarded
);
293 int consumer_get_lost_packets(uint64_t session_id
, uint64_t channel_key
,
294 struct consumer_output
*consumer
, uint64_t *lost
);
296 /* Snapshot command. */
297 enum lttng_error_code
consumer_snapshot_channel(struct consumer_socket
*socket
,
298 uint64_t key
, const struct snapshot_output
*output
, int metadata
,
299 uid_t uid
, gid_t gid
, const char *session_path
, int wait
,
300 uint64_t nb_packets_per_stream
, uint64_t trace_archive_id
);
302 /* Rotation commands. */
303 int consumer_rotate_channel(struct consumer_socket
*socket
, uint64_t key
,
304 uid_t uid
, gid_t gid
, struct consumer_output
*output
,
305 const char *domain_path
, bool is_metadata_channel
,
306 uint64_t new_chunk_id
);
307 int consumer_rotate_rename(struct consumer_socket
*socket
, uint64_t session_id
,
308 const struct consumer_output
*output
, const char *old_path
,
309 const char *new_path
, uid_t uid
, gid_t gid
);
310 int consumer_check_rotation_pending_local(struct consumer_socket
*socket
,
311 uint64_t session_id
, uint64_t chunk_id
);
312 int consumer_check_rotation_pending_relay(struct consumer_socket
*socket
,
313 const struct consumer_output
*output
, uint64_t session_id
,
315 int consumer_mkdir(struct consumer_socket
*socket
, uint64_t session_id
,
316 const struct consumer_output
*output
, const char *path
,
317 uid_t uid
, gid_t gid
);
318 int consumer_init(struct consumer_socket
*socket
,
319 const lttng_uuid sessiond_uuid
);
321 #endif /* _CONSUMER_H */