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>
25 enum consumer_dst_type
{
30 struct consumer_socket
{
34 * To use this socket (send/recv), this lock MUST be acquired.
36 pthread_mutex_t
*lock
;
39 * Indicates if the socket was registered by a third part
40 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
41 * During the destroy phase of a consumer output, we close the socket if
42 * this flag is set to 1 since we don't need the fd anymore.
44 unsigned int registered
;
46 /* Flag if network sockets were sent to the consumer. */
47 unsigned int control_sock_sent
;
48 unsigned int data_sock_sent
;
50 struct lttng_ht_node_ulong node
;
53 struct consumer_data
{
54 enum lttng_consumer_type type
;
56 pthread_t thread
; /* Worker thread interacting with the consumer */
58 /* Conditions used by the consumer thread to indicate readiness. */
60 pthread_condattr_t condattr
;
61 pthread_mutex_t cond_mutex
;
64 * This is a flag condition indicating that the consumer thread is ready
65 * and connected to the lttng-consumerd daemon. This flag MUST only be
66 * updated by locking the condition mutex above or before spawning a
69 * A value of 0 means that the thread is NOT ready. A value of 1 means that
70 * the thread consumer did connect successfully to the lttng-consumerd
71 * daemon. A negative value indicates that there is been an error and the
72 * thread has likely quit.
74 int consumer_thread_is_ready
;
76 /* Mutex to control consumerd pid assignation */
77 pthread_mutex_t pid_mutex
;
81 /* These two sockets uses the cmd_unix_sock_path. */
83 struct consumer_socket metadata_sock
;
85 /* consumer error and command Unix socket path */
86 char err_unix_sock_path
[PATH_MAX
];
87 char cmd_unix_sock_path
[PATH_MAX
];
89 /* communication lock */
98 * Indicate if URI type is set. Those flags should only be set when the
99 * created URI is done AND valid.
105 * The following two URIs MUST have the same destination address for
106 * network streaming to work. Network hop are not yet supported.
109 /* Control path for network streaming. */
110 struct lttng_uri control
;
112 /* Data path for network streaming. */
113 struct lttng_uri data
;
117 * Consumer output object describing where and how to send data.
119 struct consumer_output
{
120 /* If the consumer is enabled meaning that should be used */
121 unsigned int enabled
;
122 enum consumer_dst_type type
;
125 * The net_seq_index is the index of the network stream on the consumer
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.
129 uint64_t net_seq_index
;
132 * Subdirectory path name used for both local and network consumer.
134 char subdir
[PATH_MAX
];
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
141 struct lttng_ht
*socks
;
144 char trace_path
[PATH_MAX
];
145 struct consumer_net net
;
149 struct consumer_socket
*consumer_find_socket(int key
,
150 struct consumer_output
*consumer
);
151 struct consumer_socket
*consumer_find_socket_by_bitness(int bits
,
152 struct consumer_output
*consumer
);
153 struct consumer_socket
*consumer_allocate_socket(int fd
);
154 void consumer_add_socket(struct consumer_socket
*sock
,
155 struct consumer_output
*consumer
);
156 void consumer_del_socket(struct consumer_socket
*sock
,
157 struct consumer_output
*consumer
);
158 void consumer_destroy_socket(struct consumer_socket
*sock
);
160 struct consumer_output
*consumer_create_output(enum consumer_dst_type type
);
161 struct consumer_output
*consumer_copy_output(struct consumer_output
*obj
);
162 void consumer_destroy_output(struct consumer_output
*obj
);
163 int consumer_set_network_uri(struct consumer_output
*obj
,
164 struct lttng_uri
*uri
);
165 int consumer_send_fds(struct consumer_socket
*sock
, int *fds
, size_t nb_fd
);
166 int consumer_send_msg(struct consumer_socket
*sock
,
167 struct lttcomm_consumer_msg
*msg
);
168 int consumer_send_stream(struct consumer_socket
*sock
,
169 struct consumer_output
*dst
, struct lttcomm_consumer_msg
*msg
,
170 int *fds
, size_t nb_fd
);
171 int consumer_send_channel(struct consumer_socket
*sock
,
172 struct lttcomm_consumer_msg
*msg
);
173 int consumer_send_relayd_socket(struct consumer_socket
*consumer_sock
,
174 struct lttcomm_relayd_sock
*rsock
, struct consumer_output
*consumer
,
175 enum lttng_stream_type type
, uint64_t session_id
);
176 int consumer_send_destroy_relayd(struct consumer_socket
*sock
,
177 struct consumer_output
*consumer
);
178 int consumer_recv_status_reply(struct consumer_socket
*sock
);
179 int consumer_recv_status_channel(struct consumer_socket
*sock
,
180 uint64_t *key
, unsigned int *stream_count
);
181 void consumer_output_send_destroy_relayd(struct consumer_output
*consumer
);
182 int consumer_create_socket(struct consumer_data
*data
,
183 struct consumer_output
*output
);
184 int consumer_set_subdir(struct consumer_output
*consumer
,
185 const char *session_name
);
187 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
188 uint64_t subbuf_size
,
191 unsigned int switch_timer_interval
,
192 unsigned int read_timer_interval
,
196 const char *pathname
,
204 uint64_t tracefile_size
,
205 uint64_t tracefile_count
);
206 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg
*msg
,
207 enum lttng_consumer_command cmd
,
208 uint64_t channel_key
,
211 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg
*msg
,
212 enum lttng_consumer_command cmd
,
213 uint64_t channel_key
,
215 const char *pathname
,
220 unsigned int nb_init_streams
,
221 enum lttng_event_output output
,
223 uint64_t tracefile_size
,
224 uint64_t tracefile_count
);
225 int consumer_is_data_pending(uint64_t session_id
,
226 struct consumer_output
*consumer
);
227 int consumer_close_metadata(struct consumer_socket
*socket
,
228 uint64_t metadata_key
);
229 int consumer_setup_metadata(struct consumer_socket
*socket
,
230 uint64_t metadata_key
);
231 int consumer_push_metadata(struct consumer_socket
*socket
,
232 uint64_t metadata_key
, char *metadata_str
, size_t len
,
233 size_t target_offset
);
234 int consumer_flush_channel(struct consumer_socket
*socket
, uint64_t key
);
236 #endif /* _CONSUMER_H */