Add utils function to format current time as a string
[lttng-tools.git] / src / bin / lttng-sessiond / consumer.h
1 /*
2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 *
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.
7 *
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
11 * more details.
12 *
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.
16 */
17
18 #ifndef _CONSUMER_H
19 #define _CONSUMER_H
20
21 #include <common/consumer.h>
22 #include <common/hashtable/hashtable.h>
23 #include <lttng/lttng.h>
24
25 #include "snapshot.h"
26
27 struct snapshot;
28 struct snapshot_output;
29
30 enum consumer_dst_type {
31 CONSUMER_DST_LOCAL,
32 CONSUMER_DST_NET,
33 };
34
35 struct consumer_socket {
36 /* File descriptor */
37 int fd;
38 /*
39 * To use this socket (send/recv), this lock MUST be acquired.
40 */
41 pthread_mutex_t *lock;
42
43 /*
44 * Indicates if the socket was registered by a third part
45 * (REGISTER_CONSUMER) or is the spawn consumer of the session daemon.
46 * During the destroy phase of a consumer output, we close the socket if
47 * this flag is set to 1 since we don't need the fd anymore.
48 */
49 unsigned int registered;
50
51 /* Flag if network sockets were sent to the consumer. */
52 unsigned int control_sock_sent;
53 unsigned int data_sock_sent;
54
55 struct lttng_ht_node_ulong node;
56
57 enum lttng_consumer_type type;
58 };
59
60 struct consumer_data {
61 enum lttng_consumer_type type;
62
63 pthread_t thread; /* Worker thread interacting with the consumer */
64
65 /* Conditions used by the consumer thread to indicate readiness. */
66 pthread_cond_t cond;
67 pthread_condattr_t condattr;
68 pthread_mutex_t cond_mutex;
69
70 /*
71 * This is a flag condition indicating that the consumer thread is ready
72 * and connected to the lttng-consumerd daemon. This flag MUST only be
73 * updated by locking the condition mutex above or before spawning a
74 * consumer thread.
75 *
76 * A value of 0 means that the thread is NOT ready. A value of 1 means that
77 * the thread consumer did connect successfully to the lttng-consumerd
78 * daemon. A negative value indicates that there is been an error and the
79 * thread has likely quit.
80 */
81 int consumer_thread_is_ready;
82
83 /* Mutex to control consumerd pid assignation */
84 pthread_mutex_t pid_mutex;
85 pid_t pid;
86
87 int err_sock;
88 /* These two sockets uses the cmd_unix_sock_path. */
89 int cmd_sock;
90 struct consumer_socket metadata_sock;
91
92 /* consumer error and command Unix socket path */
93 char err_unix_sock_path[PATH_MAX];
94 char cmd_unix_sock_path[PATH_MAX];
95
96 /* communication lock */
97 pthread_mutex_t lock;
98 };
99
100 /*
101 * Network URIs
102 */
103 struct consumer_net {
104 /*
105 * Indicate if URI type is set. Those flags should only be set when the
106 * created URI is done AND valid.
107 */
108 int control_isset;
109 int data_isset;
110
111 /*
112 * The following two URIs MUST have the same destination address for
113 * network streaming to work. Network hop are not yet supported.
114 */
115
116 /* Control path for network streaming. */
117 struct lttng_uri control;
118
119 /* Data path for network streaming. */
120 struct lttng_uri data;
121 };
122
123 /*
124 * Consumer output object describing where and how to send data.
125 */
126 struct consumer_output {
127 /* If the consumer is enabled meaning that should be used */
128 unsigned int enabled;
129 enum consumer_dst_type type;
130
131 /*
132 * The net_seq_index is the index of the network stream on the consumer
133 * side. It tells the consumer which streams goes to which relayd with this
134 * index. The relayd sockets are index with it on the consumer side.
135 */
136 uint64_t net_seq_index;
137
138 /*
139 * Subdirectory path name used for both local and network consumer.
140 */
141 char subdir[PATH_MAX];
142
143 /*
144 * Hashtable of consumer_socket index by the file descriptor value. For
145 * multiarch consumer support, we can have more than one consumer (ex: 32
146 * and 64 bit).
147 */
148 struct lttng_ht *socks;
149
150 union {
151 char trace_path[PATH_MAX];
152 struct consumer_net net;
153 } dst;
154 };
155
156 struct consumer_socket *consumer_find_socket(int key,
157 struct consumer_output *consumer);
158 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
159 struct consumer_output *consumer);
160 struct consumer_socket *consumer_allocate_socket(int fd);
161 void consumer_add_socket(struct consumer_socket *sock,
162 struct consumer_output *consumer);
163 void consumer_del_socket(struct consumer_socket *sock,
164 struct consumer_output *consumer);
165 void consumer_destroy_socket(struct consumer_socket *sock);
166 int consumer_copy_sockets(struct consumer_output *dst,
167 struct consumer_output *src);
168
169 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
170 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
171 void consumer_destroy_output(struct consumer_output *obj);
172 int consumer_set_network_uri(struct consumer_output *obj,
173 struct lttng_uri *uri);
174 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
175 int consumer_send_msg(struct consumer_socket *sock,
176 struct lttcomm_consumer_msg *msg);
177 int consumer_send_stream(struct consumer_socket *sock,
178 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
179 int *fds, size_t nb_fd);
180 int consumer_send_channel(struct consumer_socket *sock,
181 struct lttcomm_consumer_msg *msg);
182 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
183 struct lttcomm_relayd_sock *rsock, struct consumer_output *consumer,
184 enum lttng_stream_type type, uint64_t session_id);
185 int consumer_send_destroy_relayd(struct consumer_socket *sock,
186 struct consumer_output *consumer);
187 int consumer_recv_status_reply(struct consumer_socket *sock);
188 int consumer_recv_status_channel(struct consumer_socket *sock,
189 uint64_t *key, unsigned int *stream_count);
190 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
191 int consumer_create_socket(struct consumer_data *data,
192 struct consumer_output *output);
193 int consumer_set_subdir(struct consumer_output *consumer,
194 const char *session_name);
195
196 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
197 uint64_t subbuf_size,
198 uint64_t num_subbuf,
199 int overwrite,
200 unsigned int switch_timer_interval,
201 unsigned int read_timer_interval,
202 int output,
203 int type,
204 uint64_t session_id,
205 const char *pathname,
206 const char *name,
207 uid_t uid,
208 gid_t gid,
209 uint64_t relayd_id,
210 uint64_t key,
211 unsigned char *uuid,
212 uint32_t chan_id,
213 uint64_t tracefile_size,
214 uint64_t tracefile_count,
215 unsigned int monitor);
216 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
217 enum lttng_consumer_command cmd,
218 uint64_t channel_key,
219 uint64_t stream_key,
220 int cpu);
221 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
222 enum lttng_consumer_command cmd,
223 uint64_t channel_key,
224 uint64_t session_id,
225 const char *pathname,
226 uid_t uid,
227 gid_t gid,
228 uint64_t relayd_id,
229 const char *name,
230 unsigned int nb_init_streams,
231 enum lttng_event_output output,
232 int type,
233 uint64_t tracefile_size,
234 uint64_t tracefile_count,
235 unsigned int monitor);
236 int consumer_is_data_pending(uint64_t session_id,
237 struct consumer_output *consumer);
238 int consumer_close_metadata(struct consumer_socket *socket,
239 uint64_t metadata_key);
240 int consumer_setup_metadata(struct consumer_socket *socket,
241 uint64_t metadata_key);
242 int consumer_push_metadata(struct consumer_socket *socket,
243 uint64_t metadata_key, char *metadata_str, size_t len,
244 size_t target_offset);
245 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
246
247 /* Snapshot command. */
248 int consumer_snapshot_channel(struct consumer_socket *socket, uint64_t key,
249 struct snapshot_output *output, int metadata, uid_t uid, gid_t gid,
250 int wait);
251
252 #endif /* _CONSUMER_H */
This page took 0.03658 seconds and 5 git commands to generate.