Commit | Line | Data |
---|---|---|
48842b30 DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License, version 2 only, | |
6 | * as published by the Free Software Foundation. | |
48842b30 | 7 | * |
d14d33bf AM |
8 | * This program is distributed in the hope that it will be useful, |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
48842b30 | 12 | * |
d14d33bf AM |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
48842b30 DG |
16 | */ |
17 | ||
18 | #define _GNU_SOURCE | |
19 | #include <errno.h> | |
20 | #include <stdio.h> | |
21 | #include <stdlib.h> | |
22 | #include <string.h> | |
23 | #include <unistd.h> | |
d88aee68 | 24 | #include <inttypes.h> |
48842b30 | 25 | |
990570ed | 26 | #include <common/common.h> |
db758600 | 27 | #include <common/consumer.h> |
990570ed | 28 | #include <common/defaults.h> |
48842b30 | 29 | |
00e2e675 | 30 | #include "consumer.h" |
7972aab2 | 31 | #include "health.h" |
48842b30 | 32 | #include "ust-consumer.h" |
331744e3 JD |
33 | #include "buffer-registry.h" |
34 | #include "session.h" | |
48842b30 DG |
35 | |
36 | /* | |
ffe60014 DG |
37 | * Return allocated full pathname of the session using the consumer trace path |
38 | * and subdir if available. On a successful allocation, the directory of the | |
39 | * trace is created with the session credentials. | |
40 | * | |
41 | * The caller can safely free(3) the returned value. On error, NULL is | |
42 | * returned. | |
48842b30 | 43 | */ |
ffe60014 DG |
44 | static char *setup_trace_path(struct consumer_output *consumer, |
45 | struct ust_app_session *ua_sess) | |
48842b30 | 46 | { |
ffe60014 DG |
47 | int ret; |
48 | char *pathname; | |
37278a1e | 49 | |
ffe60014 DG |
50 | assert(consumer); |
51 | assert(ua_sess); | |
00e2e675 | 52 | |
840cb59c | 53 | health_code_update(); |
ca03de58 | 54 | |
ffe60014 DG |
55 | /* Allocate our self the string to make sure we never exceed PATH_MAX. */ |
56 | pathname = zmalloc(PATH_MAX); | |
57 | if (!pathname) { | |
48842b30 DG |
58 | goto error; |
59 | } | |
00e2e675 | 60 | |
ffe60014 DG |
61 | /* Get correct path name destination */ |
62 | if (consumer->type == CONSUMER_DST_LOCAL) { | |
63 | /* Set application path to the destination path */ | |
64 | ret = snprintf(pathname, PATH_MAX, "%s/%s/%s", | |
65 | consumer->dst.trace_path, consumer->subdir, ua_sess->path); | |
66 | if (ret < 0) { | |
67 | PERROR("snprintf channel path"); | |
68 | goto error; | |
69 | } | |
ca03de58 | 70 | |
ffe60014 | 71 | /* Create directory. Ignore if exist. */ |
7972aab2 DG |
72 | ret = run_as_mkdir_recursive(pathname, S_IRWXU | S_IRWXG, |
73 | ua_sess->euid, ua_sess->egid); | |
ffe60014 DG |
74 | if (ret < 0) { |
75 | if (ret != -EEXIST) { | |
76 | ERR("Trace directory creation error"); | |
77 | goto error; | |
78 | } | |
79 | } | |
80 | } else { | |
81 | ret = snprintf(pathname, PATH_MAX, "%s/%s", consumer->subdir, | |
82 | ua_sess->path); | |
83 | if (ret < 0) { | |
84 | PERROR("snprintf channel path"); | |
85 | goto error; | |
86 | } | |
48842b30 DG |
87 | } |
88 | ||
ffe60014 | 89 | return pathname; |
ca03de58 | 90 | |
37278a1e | 91 | error: |
ffe60014 DG |
92 | free(pathname); |
93 | return NULL; | |
37278a1e DG |
94 | } |
95 | ||
96 | /* | |
ffe60014 DG |
97 | * Send a single channel to the consumer using command ADD_CHANNEL. |
98 | * | |
7972aab2 | 99 | * Consumer socket lock MUST be acquired before calling this. |
37278a1e | 100 | */ |
ffe60014 DG |
101 | static int ask_channel_creation(struct ust_app_session *ua_sess, |
102 | struct ust_app_channel *ua_chan, struct consumer_output *consumer, | |
7972aab2 | 103 | struct consumer_socket *socket, struct ust_registry_session *registry) |
37278a1e | 104 | { |
ffe60014 | 105 | int ret; |
7972aab2 DG |
106 | uint32_t chan_id; |
107 | uint64_t key, chan_reg_key; | |
ffe60014 | 108 | char *pathname = NULL; |
37278a1e | 109 | struct lttcomm_consumer_msg msg; |
7972aab2 | 110 | struct ust_registry_channel *chan_reg; |
37278a1e | 111 | |
ffe60014 DG |
112 | assert(ua_sess); |
113 | assert(ua_chan); | |
114 | assert(socket); | |
37278a1e | 115 | assert(consumer); |
7972aab2 | 116 | assert(registry); |
ffe60014 DG |
117 | |
118 | DBG2("Asking UST consumer for channel"); | |
119 | ||
120 | /* Get and create full trace path of session. */ | |
121 | pathname = setup_trace_path(consumer, ua_sess); | |
122 | if (!pathname) { | |
123 | ret = -1; | |
124 | goto error; | |
125 | } | |
126 | ||
7972aab2 DG |
127 | /* Depending on the buffer type, a different channel key is used. */ |
128 | if (ua_sess->buffer_type == LTTNG_BUFFER_PER_UID) { | |
129 | chan_reg_key = ua_chan->tracing_channel_id; | |
130 | } else { | |
131 | chan_reg_key = ua_chan->key; | |
132 | } | |
133 | ||
134 | if (ua_chan->attr.type == LTTNG_UST_CHAN_METADATA) { | |
135 | chan_id = -1U; | |
136 | } else { | |
137 | chan_reg = ust_registry_channel_find(registry, chan_reg_key); | |
138 | assert(chan_reg); | |
139 | chan_id = chan_reg->chan_id; | |
140 | } | |
141 | ||
ffe60014 DG |
142 | consumer_init_ask_channel_comm_msg(&msg, |
143 | ua_chan->attr.subbuf_size, | |
144 | ua_chan->attr.num_subbuf, | |
145 | ua_chan->attr.overwrite, | |
146 | ua_chan->attr.switch_timer_interval, | |
147 | ua_chan->attr.read_timer_interval, | |
148 | (int) ua_chan->attr.output, | |
149 | (int) ua_chan->attr.type, | |
7972aab2 | 150 | ua_sess->tracing_id, |
ca22feea | 151 | pathname, |
ffe60014 | 152 | ua_chan->name, |
7972aab2 DG |
153 | ua_sess->euid, |
154 | ua_sess->egid, | |
ffe60014 DG |
155 | consumer->net_seq_index, |
156 | ua_chan->key, | |
7972aab2 DG |
157 | registry->uuid, |
158 | chan_id); | |
37278a1e | 159 | |
840cb59c | 160 | health_code_update(); |
ca03de58 | 161 | |
ffe60014 | 162 | ret = lttcomm_send_unix_sock(socket->fd, &msg, sizeof(msg)); |
37278a1e DG |
163 | if (ret < 0) { |
164 | goto error; | |
165 | } | |
166 | ||
ffe60014 DG |
167 | ret = consumer_recv_status_channel(socket, &key, |
168 | &ua_chan->expected_stream_count); | |
169 | if (ret < 0) { | |
170 | goto error; | |
171 | } | |
172 | /* Communication protocol error. */ | |
173 | assert(key == ua_chan->key); | |
174 | /* We need at least one where 1 stream for 1 cpu. */ | |
175 | assert(ua_chan->expected_stream_count > 0); | |
176 | ||
d88aee68 | 177 | DBG2("UST ask channel %" PRIu64 " successfully done with %u stream(s)", key, |
ffe60014 | 178 | ua_chan->expected_stream_count); |
ca03de58 | 179 | |
37278a1e | 180 | error: |
ffe60014 DG |
181 | free(pathname); |
182 | health_code_update(); | |
37278a1e DG |
183 | return ret; |
184 | } | |
185 | ||
186 | /* | |
ffe60014 DG |
187 | * Ask consumer to create a channel for a given session. |
188 | * | |
189 | * Returns 0 on success else a negative value. | |
37278a1e | 190 | */ |
ffe60014 DG |
191 | int ust_consumer_ask_channel(struct ust_app_session *ua_sess, |
192 | struct ust_app_channel *ua_chan, struct consumer_output *consumer, | |
7972aab2 | 193 | struct consumer_socket *socket, struct ust_registry_session *registry) |
37278a1e DG |
194 | { |
195 | int ret; | |
37278a1e | 196 | |
ffe60014 DG |
197 | assert(ua_sess); |
198 | assert(ua_chan); | |
199 | assert(consumer); | |
200 | assert(socket); | |
201 | assert(socket->fd >= 0); | |
7972aab2 | 202 | assert(registry); |
f50f23d9 | 203 | |
ffe60014 | 204 | pthread_mutex_lock(socket->lock); |
37278a1e | 205 | |
7972aab2 | 206 | ret = ask_channel_creation(ua_sess, ua_chan, consumer, socket, registry); |
37278a1e DG |
207 | if (ret < 0) { |
208 | goto error; | |
209 | } | |
210 | ||
48842b30 | 211 | error: |
ffe60014 | 212 | pthread_mutex_unlock(socket->lock); |
48842b30 DG |
213 | return ret; |
214 | } | |
215 | ||
216 | /* | |
ffe60014 DG |
217 | * Send a get channel command to consumer using the given channel key. The |
218 | * channel object is populated and the stream list. | |
219 | * | |
220 | * Return 0 on success else a negative value. | |
48842b30 | 221 | */ |
ffe60014 DG |
222 | int ust_consumer_get_channel(struct consumer_socket *socket, |
223 | struct ust_app_channel *ua_chan) | |
48842b30 | 224 | { |
ffe60014 | 225 | int ret; |
37278a1e | 226 | struct lttcomm_consumer_msg msg; |
48842b30 | 227 | |
ffe60014 DG |
228 | assert(ua_chan); |
229 | assert(socket); | |
230 | assert(socket->fd >= 0); | |
48842b30 | 231 | |
ffe60014 DG |
232 | msg.cmd_type = LTTNG_CONSUMER_GET_CHANNEL; |
233 | msg.u.get_channel.key = ua_chan->key; | |
37278a1e | 234 | |
ffe60014 | 235 | pthread_mutex_lock(socket->lock); |
840cb59c | 236 | health_code_update(); |
ca03de58 | 237 | |
ffe60014 DG |
238 | /* Send command and wait for OK reply. */ |
239 | ret = consumer_send_msg(socket, &msg); | |
37278a1e DG |
240 | if (ret < 0) { |
241 | goto error; | |
242 | } | |
243 | ||
ffe60014 DG |
244 | /* First, get the channel from consumer. */ |
245 | ret = ustctl_recv_channel_from_consumer(socket->fd, &ua_chan->obj); | |
37278a1e | 246 | if (ret < 0) { |
ffe60014 DG |
247 | if (ret != -EPIPE) { |
248 | ERR("Error recv channel from consumer %d with ret %d", | |
249 | socket->fd, ret); | |
250 | } else { | |
251 | DBG3("UST app recv channel from consumer. Consumer is dead."); | |
252 | } | |
37278a1e DG |
253 | goto error; |
254 | } | |
00e2e675 | 255 | |
ffe60014 DG |
256 | /* Next, get all streams. */ |
257 | while (1) { | |
258 | struct ust_app_stream *stream; | |
ca03de58 | 259 | |
ffe60014 DG |
260 | /* Create UST stream */ |
261 | stream = ust_app_alloc_stream(); | |
262 | if (stream == NULL) { | |
263 | ret = -ENOMEM; | |
48842b30 DG |
264 | goto error; |
265 | } | |
266 | ||
ffe60014 DG |
267 | /* Stream object is populated by this call if successful. */ |
268 | ret = ustctl_recv_stream_from_consumer(socket->fd, &stream->obj); | |
37278a1e | 269 | if (ret < 0) { |
ffe60014 DG |
270 | free(stream); |
271 | if (ret == -LTTNG_UST_ERR_NOENT) { | |
272 | DBG3("UST app consumer has no more stream available"); | |
273 | ret = 0; | |
274 | break; | |
275 | } | |
276 | if (ret != -EPIPE) { | |
277 | ERR("Recv stream from consumer %d with ret %d", | |
278 | socket->fd, ret); | |
279 | } else { | |
280 | DBG3("UST app recv stream from consumer. Consumer is dead."); | |
00e2e675 | 281 | } |
48842b30 DG |
282 | goto error; |
283 | } | |
37278a1e | 284 | |
ffe60014 DG |
285 | /* Order is important this is why a list is used. */ |
286 | cds_list_add_tail(&stream->list, &ua_chan->streams.head); | |
287 | ua_chan->streams.count++; | |
37278a1e | 288 | |
ffe60014 DG |
289 | DBG2("UST app stream %d received succesfully", ua_chan->streams.count); |
290 | } | |
291 | ||
292 | /* This MUST match or else we have a synchronization problem. */ | |
293 | assert(ua_chan->expected_stream_count == ua_chan->streams.count); | |
ca03de58 | 294 | |
ffe60014 DG |
295 | /* Wait for confirmation that we can proceed with the streams. */ |
296 | ret = consumer_recv_status_reply(socket); | |
37278a1e DG |
297 | if (ret < 0) { |
298 | goto error; | |
299 | } | |
300 | ||
301 | error: | |
ffe60014 DG |
302 | health_code_update(); |
303 | pthread_mutex_unlock(socket->lock); | |
37278a1e DG |
304 | return ret; |
305 | } | |
306 | ||
307 | /* | |
ffe60014 DG |
308 | * Send a destroy channel command to consumer using the given channel key. |
309 | * | |
310 | * Note that this command MUST be used prior to a successful | |
311 | * LTTNG_CONSUMER_GET_CHANNEL because once this command is done successfully, | |
312 | * the streams are dispatched to the consumer threads and MUST be teardown | |
313 | * through the hang up process. | |
314 | * | |
315 | * Return 0 on success else a negative value. | |
37278a1e | 316 | */ |
ffe60014 DG |
317 | int ust_consumer_destroy_channel(struct consumer_socket *socket, |
318 | struct ust_app_channel *ua_chan) | |
37278a1e | 319 | { |
ffe60014 DG |
320 | int ret; |
321 | struct lttcomm_consumer_msg msg; | |
a4b92340 | 322 | |
ffe60014 DG |
323 | assert(ua_chan); |
324 | assert(socket); | |
325 | assert(socket->fd >= 0); | |
37278a1e | 326 | |
ffe60014 DG |
327 | msg.cmd_type = LTTNG_CONSUMER_DESTROY_CHANNEL; |
328 | msg.u.destroy_channel.key = ua_chan->key; | |
173af62f | 329 | |
ffe60014 DG |
330 | pthread_mutex_lock(socket->lock); |
331 | health_code_update(); | |
37278a1e | 332 | |
ffe60014 | 333 | ret = consumer_send_msg(socket, &msg); |
37278a1e DG |
334 | if (ret < 0) { |
335 | goto error; | |
48842b30 DG |
336 | } |
337 | ||
ffe60014 DG |
338 | error: |
339 | health_code_update(); | |
340 | pthread_mutex_unlock(socket->lock); | |
341 | return ret; | |
342 | } | |
aeb96892 | 343 | |
ffe60014 DG |
344 | /* |
345 | * Send a given stream to UST tracer. | |
346 | * | |
347 | * On success return 0 else a negative value. | |
348 | */ | |
349 | int ust_consumer_send_stream_to_ust(struct ust_app *app, | |
350 | struct ust_app_channel *channel, struct ust_app_stream *stream) | |
351 | { | |
352 | int ret; | |
353 | ||
354 | assert(app); | |
355 | assert(stream); | |
356 | assert(channel); | |
357 | ||
358 | DBG2("UST consumer send stream to app %d", app->sock); | |
359 | ||
360 | /* Relay stream to application. */ | |
361 | ret = ustctl_send_stream_to_ust(app->sock, channel->obj, stream->obj); | |
362 | if (ret < 0) { | |
363 | if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { | |
364 | ERR("Error ustctl send stream %s to app pid: %d with ret %d", | |
365 | stream->name, app->pid, ret); | |
366 | } else { | |
367 | DBG3("UST app send stream to ust failed. Application is dead."); | |
48842b30 | 368 | } |
ffe60014 | 369 | goto error; |
48842b30 | 370 | } |
d0b96690 | 371 | channel->handle = channel->obj->handle; |
48842b30 | 372 | |
ffe60014 DG |
373 | error: |
374 | return ret; | |
375 | } | |
376 | ||
377 | /* | |
378 | * Send channel previously received from the consumer to the UST tracer. | |
379 | * | |
380 | * On success return 0 else a negative value. | |
381 | */ | |
382 | int ust_consumer_send_channel_to_ust(struct ust_app *app, | |
383 | struct ust_app_session *ua_sess, struct ust_app_channel *channel) | |
384 | { | |
385 | int ret; | |
386 | ||
387 | assert(app); | |
388 | assert(ua_sess); | |
389 | assert(channel); | |
390 | assert(channel->obj); | |
391 | ||
7972aab2 DG |
392 | DBG2("UST app send channel to sock %d pid %d (name: %s, key: %" PRIu64 ")", |
393 | app->sock, app->pid, channel->name, channel->tracing_channel_id); | |
48842b30 | 394 | |
ffe60014 DG |
395 | /* Send stream to application. */ |
396 | ret = ustctl_send_channel_to_ust(app->sock, ua_sess->handle, channel->obj); | |
397 | if (ret < 0) { | |
398 | if (ret != -EPIPE && ret != -LTTNG_UST_ERR_EXITING) { | |
399 | ERR("Error ustctl send channel %s to app pid: %d with ret %d", | |
400 | channel->name, app->pid, ret); | |
401 | } else { | |
402 | DBG3("UST app send channel to ust failed. Application is dead."); | |
403 | } | |
404 | goto error; | |
405 | } | |
48842b30 DG |
406 | |
407 | error: | |
408 | return ret; | |
409 | } | |
331744e3 JD |
410 | |
411 | /* | |
412 | * Handle the metadata requests from the UST consumer | |
413 | * | |
414 | * Return 0 on success else a negative value. | |
415 | */ | |
416 | int ust_consumer_metadata_request(struct consumer_socket *socket) | |
417 | { | |
418 | int ret; | |
419 | ssize_t ret_push; | |
420 | struct lttcomm_metadata_request_msg request; | |
421 | struct buffer_reg_uid *reg_uid; | |
422 | struct ust_registry_session *ust_reg; | |
423 | struct lttcomm_consumer_msg msg; | |
424 | ||
425 | assert(socket); | |
426 | ||
427 | rcu_read_lock(); | |
428 | pthread_mutex_lock(socket->lock); | |
429 | ||
430 | health_code_update(); | |
431 | ||
432 | /* Wait for a metadata request */ | |
433 | ret = lttcomm_recv_unix_sock(socket->fd, &request, sizeof(request)); | |
434 | if (ret <= 0) { | |
435 | ERR("Consumer closed the metadata socket"); | |
436 | ret = -1; | |
437 | goto end; | |
438 | } | |
439 | ||
440 | DBG("Metadata request received for session %u, key %" PRIu64, | |
441 | request.session_id, request.key); | |
442 | ||
443 | reg_uid = buffer_reg_uid_find(request.session_id, | |
444 | request.bits_per_long, request.uid); | |
445 | if (reg_uid) { | |
446 | ust_reg = reg_uid->registry->reg.ust; | |
447 | } else { | |
448 | struct buffer_reg_pid *reg_pid = | |
449 | buffer_reg_pid_find(request.session_id); | |
450 | if (!reg_pid) { | |
451 | DBG("PID registry not found for session id %u", | |
452 | request.session_id); | |
453 | ||
454 | msg.cmd_type = LTTNG_ERR_UND; | |
455 | (void) consumer_send_msg(socket, &msg); | |
456 | /* | |
457 | * This is possible since the session might have been destroyed | |
458 | * during a consumer metadata request. So here, return gracefully | |
459 | * because the destroy session will push the remaining metadata to | |
460 | * the consumer. | |
461 | */ | |
462 | ret = 0; | |
463 | goto end; | |
464 | } | |
465 | ust_reg = reg_pid->registry->reg.ust; | |
466 | } | |
467 | assert(ust_reg); | |
468 | ||
469 | ret_push = ust_app_push_metadata(ust_reg, socket, 1); | |
470 | if (ret_push < 0) { | |
471 | ERR("Pushing metadata"); | |
472 | ret = -1; | |
473 | goto end; | |
474 | } | |
475 | DBG("UST Consumer metadata pushed successfully"); | |
476 | ret = 0; | |
477 | ||
478 | end: | |
479 | pthread_mutex_unlock(socket->lock); | |
480 | rcu_read_unlock(); | |
481 | return ret; | |
482 | } |