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 check for a possible invalid value.
43 * To use this socket (send/recv), this lock MUST be acquired.
45 pthread_mutex_t
*lock
;
48 * Indicates if the socket was registered by a third part
49 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
50 * During the destroy phase of a consumer output, we close the socket if
51 * this flag is set to 1 since we don't need the fd anymore.
53 unsigned int registered
;
55 /* Flag if network sockets were sent to the consumer. */
56 unsigned int control_sock_sent
;
57 unsigned int data_sock_sent
;
59 struct lttng_ht_node_ulong node
;
61 enum lttng_consumer_type type
;
64 struct consumer_data
{
65 enum lttng_consumer_type type
;
67 pthread_t thread
; /* Worker thread interacting with the consumer */
69 /* Conditions used by the consumer thread to indicate readiness. */
71 pthread_condattr_t condattr
;
72 pthread_mutex_t cond_mutex
;
75 * This is a flag condition indicating that the consumer thread is ready
76 * and connected to the lttng-consumerd daemon. This flag MUST only be
77 * updated by locking the condition mutex above or before spawning a
80 * A value of 0 means that the thread is NOT ready. A value of 1 means that
81 * the thread consumer did connect successfully to the lttng-consumerd
82 * daemon. A negative value indicates that there is been an error and the
83 * thread has likely quit.
85 int consumer_thread_is_ready
;
87 /* Mutex to control consumerd pid assignation */
88 pthread_mutex_t pid_mutex
;
92 /* These two sockets uses the cmd_unix_sock_path. */
95 * The metadata socket object is handled differently and only created
96 * locally in this object thus it's the only reference available in the
97 * session daemon. For that reason, a static variable for the fd is
98 * required and the metadata socket fd points to it.
101 struct consumer_socket metadata_sock
;
103 /* consumer error and command Unix socket path */
104 char err_unix_sock_path
[PATH_MAX
];
105 char cmd_unix_sock_path
[PATH_MAX
];
107 /* communication lock */
108 pthread_mutex_t lock
;
114 struct consumer_net
{
116 * Indicate if URI type is set. Those flags should only be set when the
117 * created URI is done AND valid.
123 * The following two URIs MUST have the same destination address for
124 * network streaming to work. Network hop are not yet supported.
127 /* Control path for network streaming. */
128 struct lttng_uri control
;
130 /* Data path for network streaming. */
131 struct lttng_uri data
;
135 * Consumer output object describing where and how to send data.
137 struct consumer_output
{
138 /* If the consumer is enabled meaning that should be used */
139 unsigned int enabled
;
140 enum consumer_dst_type type
;
143 * The net_seq_index is the index of the network stream on the consumer
144 * side. It tells the consumer which streams goes to which relayd with this
145 * index. The relayd sockets are index with it on the consumer side.
147 uint64_t net_seq_index
;
150 * Subdirectory path name used for both local and network consumer.
152 char subdir
[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
;
162 char trace_path
[PATH_MAX
];
163 struct consumer_net net
;
167 struct consumer_socket
*consumer_find_socket(int key
,
168 struct consumer_output
*consumer
);
169 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
170 struct consumer_output
*consumer
);
171 struct consumer_socket
*consumer_allocate_socket(int *fd
);
172 void consumer_add_socket(struct consumer_socket
*sock
,
173 struct consumer_output
*consumer
);
174 void consumer_del_socket(struct consumer_socket
*sock
,
175 struct consumer_output
*consumer
);
176 void consumer_destroy_socket(struct consumer_socket
*sock
);
177 int consumer_copy_sockets(struct consumer_output
*dst
,
178 struct consumer_output
*src
);
179 void consumer_destroy_output_sockets(struct consumer_output
*obj
);
181 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
);
182 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
);
183 void consumer_destroy_output(struct consumer_output
*obj
);
184 int consumer_set_network_uri(struct consumer_output
*obj
,
185 struct lttng_uri
*uri
);
186 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
);
187 int consumer_send_msg(struct consumer_socket
*sock
,
188 struct lttcomm_consumer_msg
*msg
);
189 int consumer_send_stream(struct consumer_socket
*sock
,
190 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
191 int *fds
, size_t nb_fd
);
192 int consumer_send_channel(struct consumer_socket
*sock
,
193 struct lttcomm_consumer_msg
*msg
);
194 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
195 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
196 enum lttng_stream_type type
, uint64_t session_id
);
197 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
198 struct consumer_output
*consumer
);
199 int consumer_recv_status_reply(struct consumer_socket
*sock
);
200 int consumer_recv_status_channel(struct consumer_socket
*sock
,
201 uint64_t *key
, unsigned int *stream_count
);
202 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
);
203 int consumer_create_socket(struct consumer_data
*data
,
204 struct consumer_output
*output
);
205 int consumer_set_subdir(struct consumer_output
*consumer
,
206 const char *session_name
);
208 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
209 uint64_t subbuf_size
,
212 unsigned int switch_timer_interval
,
213 unsigned int read_timer_interval
,
217 const char *pathname
,
225 uint64_t tracefile_size
,
226 uint64_t tracefile_count
,
227 uint64_t session_id_per_pid
,
228 unsigned int monitor
,
229 uint32_t ust_app_uid
);
230 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
231 enum lttng_consumer_command cmd
,
232 uint64_t channel_key
,
235 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
236 enum lttng_consumer_command cmd
,
237 uint64_t channel_key
,
239 const char *pathname
,
244 unsigned int nb_init_streams
,
245 enum lttng_event_output output
,
247 uint64_t tracefile_size
,
248 uint64_t tracefile_count
,
249 unsigned int monitor
);
250 int consumer_is_data_pending(uint64_t session_id
,
251 struct consumer_output
*consumer
);
252 int consumer_close_metadata(struct consumer_socket
*socket
,
253 uint64_t metadata_key
);
254 int consumer_setup_metadata(struct consumer_socket
*socket
,
255 uint64_t metadata_key
);
256 int consumer_push_metadata(struct consumer_socket
*socket
,
257 uint64_t metadata_key
, char *metadata_str
, size_t len
,
258 size_t target_offset
);
259 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
);
261 /* Snapshot command. */
262 int consumer_snapshot_channel(struct consumer_socket
*socket
, uint64_t key
,
263 struct snapshot_output
*output
, int metadata
, uid_t uid
, gid_t gid
,
264 const char *session_path
, int wait
, int max_size_per_stream
);
266 #endif /* _CONSUMER_H */