Tests: Fix nprocesses applications shutdown
[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 enum consumer_dst_type {
26 CONSUMER_DST_LOCAL,
27 CONSUMER_DST_NET,
28 };
29
30 struct consumer_socket {
31 /* File descriptor */
32 int fd;
33 /*
34 * To use this socket (send/recv), this lock MUST be acquired.
35 */
36 pthread_mutex_t *lock;
37
38 /*
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.
43 */
44 unsigned int registered;
45
46 /* Flag if network sockets were sent to the consumer. */
47 unsigned int control_sock_sent;
48 unsigned int data_sock_sent;
49
50 struct lttng_ht_node_ulong node;
51 };
52
53 struct consumer_data {
54 enum lttng_consumer_type type;
55
56 pthread_t thread; /* Worker thread interacting with the consumer */
57
58 /* Conditions used by the consumer thread to indicate readiness. */
59 pthread_cond_t cond;
60 pthread_condattr_t condattr;
61 pthread_mutex_t cond_mutex;
62
63 /*
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
67 * consumer thread.
68 *
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.
73 */
74 int consumer_thread_is_ready;
75
76 /* Mutex to control consumerd pid assignation */
77 pthread_mutex_t pid_mutex;
78 pid_t pid;
79
80 int err_sock;
81 int cmd_sock;
82
83 /* consumer error and command Unix socket path */
84 char err_unix_sock_path[PATH_MAX];
85 char cmd_unix_sock_path[PATH_MAX];
86
87 /* communication lock */
88 pthread_mutex_t lock;
89 };
90
91 /*
92 * Network URIs
93 */
94 struct consumer_net {
95 /*
96 * Indicate if URI type is set. Those flags should only be set when the
97 * created URI is done AND valid.
98 */
99 int control_isset;
100 int data_isset;
101
102 /*
103 * The following two URIs MUST have the same destination address for
104 * network streaming to work. Network hop are not yet supported.
105 */
106
107 /* Control path for network streaming. */
108 struct lttng_uri control;
109
110 /* Data path for network streaming. */
111 struct lttng_uri data;
112 };
113
114 /*
115 * Consumer output object describing where and how to send data.
116 */
117 struct consumer_output {
118 /* If the consumer is enabled meaning that should be used */
119 unsigned int enabled;
120 enum consumer_dst_type type;
121
122 /*
123 * The net_seq_index is the index of the network stream on the consumer
124 * side. It tells the consumer which streams goes to which relayd with this
125 * index. The relayd sockets are index with it on the consumer side.
126 */
127 uint64_t net_seq_index;
128
129 /*
130 * Subdirectory path name used for both local and network consumer.
131 */
132 char subdir[PATH_MAX];
133
134 /*
135 * Hashtable of consumer_socket index by the file descriptor value. For
136 * multiarch consumer support, we can have more than one consumer (ex: 32
137 * and 64 bit).
138 */
139 struct lttng_ht *socks;
140
141 union {
142 char trace_path[PATH_MAX];
143 struct consumer_net net;
144 } dst;
145 };
146
147 struct consumer_socket *consumer_find_socket(int key,
148 struct consumer_output *consumer);
149 struct consumer_socket *consumer_find_socket_by_bitness(int bits,
150 struct consumer_output *consumer);
151 struct consumer_socket *consumer_allocate_socket(int fd);
152 void consumer_add_socket(struct consumer_socket *sock,
153 struct consumer_output *consumer);
154 void consumer_del_socket(struct consumer_socket *sock,
155 struct consumer_output *consumer);
156 void consumer_destroy_socket(struct consumer_socket *sock);
157
158 struct consumer_output *consumer_create_output(enum consumer_dst_type type);
159 struct consumer_output *consumer_copy_output(struct consumer_output *obj);
160 void consumer_destroy_output(struct consumer_output *obj);
161 int consumer_set_network_uri(struct consumer_output *obj,
162 struct lttng_uri *uri);
163 int consumer_send_fds(struct consumer_socket *sock, int *fds, size_t nb_fd);
164 int consumer_send_msg(struct consumer_socket *sock,
165 struct lttcomm_consumer_msg *msg);
166 int consumer_send_stream(struct consumer_socket *sock,
167 struct consumer_output *dst, struct lttcomm_consumer_msg *msg,
168 int *fds, size_t nb_fd);
169 int consumer_send_channel(struct consumer_socket *sock,
170 struct lttcomm_consumer_msg *msg);
171 int consumer_send_relayd_socket(struct consumer_socket *consumer_sock,
172 struct lttcomm_sock *sock, struct consumer_output *consumer,
173 enum lttng_stream_type type, uint64_t session_id);
174 int consumer_send_destroy_relayd(struct consumer_socket *sock,
175 struct consumer_output *consumer);
176 int consumer_recv_status_reply(struct consumer_socket *sock);
177 int consumer_recv_status_channel(struct consumer_socket *sock,
178 uint64_t *key, unsigned int *stream_count);
179 void consumer_output_send_destroy_relayd(struct consumer_output *consumer);
180 int consumer_create_socket(struct consumer_data *data,
181 struct consumer_output *output);
182 int consumer_set_subdir(struct consumer_output *consumer,
183 const char *session_name);
184
185 void consumer_init_ask_channel_comm_msg(struct lttcomm_consumer_msg *msg,
186 uint64_t subbuf_size,
187 uint64_t num_subbuf,
188 int overwrite,
189 unsigned int switch_timer_interval,
190 unsigned int read_timer_interval,
191 int output,
192 int type,
193 uint64_t session_id,
194 const char *pathname,
195 const char *name,
196 uid_t uid,
197 gid_t gid,
198 uint64_t relayd_id,
199 uint64_t key,
200 unsigned char *uuid,
201 uint32_t chan_id);
202 void consumer_init_stream_comm_msg(struct lttcomm_consumer_msg *msg,
203 enum lttng_consumer_command cmd,
204 uint64_t channel_key,
205 uint64_t stream_key,
206 int cpu);
207 void consumer_init_channel_comm_msg(struct lttcomm_consumer_msg *msg,
208 enum lttng_consumer_command cmd,
209 uint64_t channel_key,
210 uint64_t session_id,
211 const char *pathname,
212 uid_t uid,
213 gid_t gid,
214 uint64_t relayd_id,
215 const char *name,
216 unsigned int nb_init_streams,
217 enum lttng_event_output output,
218 int type);
219 int consumer_is_data_pending(uint64_t session_id,
220 struct consumer_output *consumer);
221 int consumer_close_metadata(struct consumer_socket *socket,
222 uint64_t metadata_key);
223 int consumer_setup_metadata(struct consumer_socket *socket,
224 uint64_t metadata_key);
225 int consumer_push_metadata(struct consumer_socket *socket,
226 uint64_t metadata_key, char *metadata_str, size_t len,
227 size_t target_offset);
228 int consumer_flush_channel(struct consumer_socket *socket, uint64_t key);
229
230 #endif /* _CONSUMER_H */
This page took 0.034774 seconds and 4 git commands to generate.