2 * Copyright (C) 2012 - Julien Desfossez <julien.desfossez@efficios.com>
3 * David Goulet <dgoulet@efficios.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 #include <bin/lttng-consumerd/health-consumerd.h>
25 #include <common/common.h>
26 #include <common/kernel-ctl/kernel-ctl.h>
27 #include <common/kernel-consumer/kernel-consumer.h>
28 #include <common/consumer-stream.h>
30 #include "consumer-timer.h"
31 #include "consumer-testpoint.h"
32 #include "ust-consumer/ust-consumer.h"
34 static struct timer_signal_data timer_signal
= {
38 .lock
= PTHREAD_MUTEX_INITIALIZER
,
42 * Set custom signal mask to current thread.
44 static void setmask(sigset_t
*mask
)
48 ret
= sigemptyset(mask
);
50 PERROR("sigemptyset");
52 ret
= sigaddset(mask
, LTTNG_CONSUMER_SIG_SWITCH
);
54 PERROR("sigaddset switch");
56 ret
= sigaddset(mask
, LTTNG_CONSUMER_SIG_TEARDOWN
);
58 PERROR("sigaddset teardown");
60 ret
= sigaddset(mask
, LTTNG_CONSUMER_SIG_LIVE
);
62 PERROR("sigaddset live");
67 * Execute action on a timer switch.
69 * Beware: metadata_switch_timer() should *never* take a mutex also held
70 * while consumer_timer_switch_stop() is called. It would result in
73 static void metadata_switch_timer(struct lttng_consumer_local_data
*ctx
,
74 int sig
, siginfo_t
*si
, void *uc
)
77 struct lttng_consumer_channel
*channel
;
79 channel
= si
->si_value
.sival_ptr
;
82 if (channel
->switch_timer_error
) {
86 DBG("Switch timer for channel %" PRIu64
, channel
->key
);
88 case LTTNG_CONSUMER32_UST
:
89 case LTTNG_CONSUMER64_UST
:
91 * Locks taken by lttng_ustconsumer_request_metadata():
92 * - metadata_socket_lock
93 * - Calling lttng_ustconsumer_recv_metadata():
94 * - channel->metadata_cache->lock
95 * - Calling consumer_metadata_cache_flushed():
96 * - channel->timer_lock
97 * - channel->metadata_cache->lock
99 * Ensure that neither consumer_data.lock nor
100 * channel->lock are taken within this function, since
101 * they are held while consumer_timer_switch_stop() is
104 ret
= lttng_ustconsumer_request_metadata(ctx
, channel
, 1, 1);
106 channel
->switch_timer_error
= 1;
109 case LTTNG_CONSUMER_KERNEL
:
110 case LTTNG_CONSUMER_UNKNOWN
:
116 static int send_empty_index(struct lttng_consumer_stream
*stream
, uint64_t ts
,
120 struct ctf_packet_index index
;
122 memset(&index
, 0, sizeof(index
));
123 index
.stream_id
= htobe64(stream_id
);
124 index
.timestamp_end
= htobe64(ts
);
125 ret
= consumer_stream_write_index(stream
, &index
);
134 static int check_kernel_stream(struct lttng_consumer_stream
*stream
)
136 uint64_t ts
, stream_id
;
140 * While holding the stream mutex, try to take a snapshot, if it
141 * succeeds, it means that data is ready to be sent, just let the data
142 * thread handle that. Otherwise, if the snapshot returns EAGAIN, it
143 * means that there is no data to read after the flush, so we can
144 * safely send the empty index.
146 pthread_mutex_lock(&stream
->lock
);
147 ret
= kernctl_get_current_timestamp(stream
->wait_fd
, &ts
);
149 ERR("Failed to get the current timestamp");
152 ret
= kernctl_buffer_flush(stream
->wait_fd
);
154 ERR("Failed to flush kernel stream");
157 ret
= kernctl_snapshot(stream
->wait_fd
);
159 if (errno
!= EAGAIN
&& errno
!= ENODATA
) {
160 PERROR("live timer kernel snapshot");
164 ret
= kernctl_get_stream_id(stream
->wait_fd
, &stream_id
);
166 PERROR("kernctl_get_stream_id");
169 DBG("Stream %" PRIu64
" empty, sending beacon", stream
->key
);
170 ret
= send_empty_index(stream
, ts
, stream_id
);
178 pthread_mutex_unlock(&stream
->lock
);
182 static int check_ust_stream(struct lttng_consumer_stream
*stream
)
184 uint64_t ts
, stream_id
;
188 assert(stream
->ustream
);
190 * While holding the stream mutex, try to take a snapshot, if it
191 * succeeds, it means that data is ready to be sent, just let the data
192 * thread handle that. Otherwise, if the snapshot returns EAGAIN, it
193 * means that there is no data to read after the flush, so we can
194 * safely send the empty index.
196 pthread_mutex_lock(&stream
->lock
);
197 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
202 ret
= lttng_ustconsumer_get_current_timestamp(stream
, &ts
);
204 ERR("Failed to get the current timestamp");
207 lttng_ustconsumer_flush_buffer(stream
, 1);
208 ret
= lttng_ustconsumer_take_snapshot(stream
);
210 if (ret
!= -EAGAIN
) {
211 ERR("Taking UST snapshot");
215 ret
= lttng_ustconsumer_get_stream_id(stream
, &stream_id
);
217 PERROR("ustctl_get_stream_id");
220 DBG("Stream %" PRIu64
" empty, sending beacon", stream
->key
);
221 ret
= send_empty_index(stream
, ts
, stream_id
);
229 pthread_mutex_unlock(&stream
->lock
);
234 * Execute action on a live timer
236 static void live_timer(struct lttng_consumer_local_data
*ctx
,
237 int sig
, siginfo_t
*si
, void *uc
)
240 struct lttng_consumer_channel
*channel
;
241 struct lttng_consumer_stream
*stream
;
243 struct lttng_ht_iter iter
;
245 channel
= si
->si_value
.sival_ptr
;
248 if (channel
->switch_timer_error
) {
251 ht
= consumer_data
.stream_per_chan_id_ht
;
253 DBG("Live timer for channel %" PRIu64
, channel
->key
);
257 case LTTNG_CONSUMER32_UST
:
258 case LTTNG_CONSUMER64_UST
:
259 cds_lfht_for_each_entry_duplicate(ht
->ht
,
260 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
261 ht
->match_fct
, &channel
->key
, &iter
.iter
,
262 stream
, node_channel_id
.node
) {
263 ret
= check_ust_stream(stream
);
269 case LTTNG_CONSUMER_KERNEL
:
270 cds_lfht_for_each_entry_duplicate(ht
->ht
,
271 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
272 ht
->match_fct
, &channel
->key
, &iter
.iter
,
273 stream
, node_channel_id
.node
) {
274 ret
= check_kernel_stream(stream
);
280 case LTTNG_CONSUMER_UNKNOWN
:
293 void consumer_timer_signal_thread_qs(unsigned int signr
)
295 sigset_t pending_set
;
299 * We need to be the only thread interacting with the thread
300 * that manages signals for teardown synchronization.
302 pthread_mutex_lock(&timer_signal
.lock
);
304 /* Ensure we don't have any signal queued for this channel. */
306 ret
= sigemptyset(&pending_set
);
308 PERROR("sigemptyset");
310 ret
= sigpending(&pending_set
);
312 PERROR("sigpending");
314 if (!sigismember(&pending_set
, LTTNG_CONSUMER_SIG_SWITCH
)) {
321 * From this point, no new signal handler will be fired that would try to
322 * access "chan". However, we still need to wait for any currently
323 * executing handler to complete.
326 CMM_STORE_SHARED(timer_signal
.qs_done
, 0);
330 * Kill with LTTNG_CONSUMER_SIG_TEARDOWN, so signal management thread wakes
333 kill(getpid(), LTTNG_CONSUMER_SIG_TEARDOWN
);
335 while (!CMM_LOAD_SHARED(timer_signal
.qs_done
)) {
340 pthread_mutex_unlock(&timer_signal
.lock
);
344 * Set the timer for periodical metadata flush.
346 void consumer_timer_switch_start(struct lttng_consumer_channel
*channel
,
347 unsigned int switch_timer_interval
)
351 struct itimerspec its
;
354 assert(channel
->key
);
356 if (switch_timer_interval
== 0) {
360 sev
.sigev_notify
= SIGEV_SIGNAL
;
361 sev
.sigev_signo
= LTTNG_CONSUMER_SIG_SWITCH
;
362 sev
.sigev_value
.sival_ptr
= channel
;
363 ret
= timer_create(CLOCKID
, &sev
, &channel
->switch_timer
);
365 PERROR("timer_create");
367 channel
->switch_timer_enabled
= 1;
369 its
.it_value
.tv_sec
= switch_timer_interval
/ 1000000;
370 its
.it_value
.tv_nsec
= switch_timer_interval
% 1000000;
371 its
.it_interval
.tv_sec
= its
.it_value
.tv_sec
;
372 its
.it_interval
.tv_nsec
= its
.it_value
.tv_nsec
;
374 ret
= timer_settime(channel
->switch_timer
, 0, &its
, NULL
);
376 PERROR("timer_settime");
381 * Stop and delete timer.
383 void consumer_timer_switch_stop(struct lttng_consumer_channel
*channel
)
389 ret
= timer_delete(channel
->switch_timer
);
391 PERROR("timer_delete");
394 consumer_timer_signal_thread_qs(LTTNG_CONSUMER_SIG_SWITCH
);
396 channel
->switch_timer
= 0;
397 channel
->switch_timer_enabled
= 0;
401 * Set the timer for the live mode.
403 void consumer_timer_live_start(struct lttng_consumer_channel
*channel
,
404 int live_timer_interval
)
408 struct itimerspec its
;
411 assert(channel
->key
);
413 if (live_timer_interval
<= 0) {
417 sev
.sigev_notify
= SIGEV_SIGNAL
;
418 sev
.sigev_signo
= LTTNG_CONSUMER_SIG_LIVE
;
419 sev
.sigev_value
.sival_ptr
= channel
;
420 ret
= timer_create(CLOCKID
, &sev
, &channel
->live_timer
);
422 PERROR("timer_create");
424 channel
->live_timer_enabled
= 1;
426 its
.it_value
.tv_sec
= live_timer_interval
/ 1000000;
427 its
.it_value
.tv_nsec
= live_timer_interval
% 1000000;
428 its
.it_interval
.tv_sec
= its
.it_value
.tv_sec
;
429 its
.it_interval
.tv_nsec
= its
.it_value
.tv_nsec
;
431 ret
= timer_settime(channel
->live_timer
, 0, &its
, NULL
);
433 PERROR("timer_settime");
438 * Stop and delete timer.
440 void consumer_timer_live_stop(struct lttng_consumer_channel
*channel
)
446 ret
= timer_delete(channel
->live_timer
);
448 PERROR("timer_delete");
451 consumer_timer_signal_thread_qs(LTTNG_CONSUMER_SIG_LIVE
);
453 channel
->live_timer
= 0;
454 channel
->live_timer_enabled
= 0;
458 * Block the RT signals for the entire process. It must be called from the
459 * consumer main before creating the threads
461 void consumer_signal_init(void)
466 /* Block signal for entire process, so only our thread processes it. */
468 ret
= pthread_sigmask(SIG_BLOCK
, &mask
, NULL
);
471 PERROR("pthread_sigmask");
476 * This thread is the sighandler for signals LTTNG_CONSUMER_SIG_SWITCH,
477 * LTTNG_CONSUMER_SIG_TEARDOWN and LTTNG_CONSUMER_SIG_LIVE.
479 void *consumer_timer_thread(void *data
)
484 struct lttng_consumer_local_data
*ctx
= data
;
486 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_METADATA_TIMER
);
488 if (testpoint(consumerd_thread_metadata_timer
)) {
489 goto error_testpoint
;
492 health_code_update();
494 /* Only self thread will receive signal mask. */
496 CMM_STORE_SHARED(timer_signal
.tid
, pthread_self());
499 health_code_update();
502 signr
= sigwaitinfo(&mask
, &info
);
505 if (errno
!= EINTR
) {
506 PERROR("sigwaitinfo");
509 } else if (signr
== LTTNG_CONSUMER_SIG_SWITCH
) {
510 metadata_switch_timer(ctx
, info
.si_signo
, &info
, NULL
);
511 } else if (signr
== LTTNG_CONSUMER_SIG_TEARDOWN
) {
513 CMM_STORE_SHARED(timer_signal
.qs_done
, 1);
515 DBG("Signal timer metadata thread teardown");
516 } else if (signr
== LTTNG_CONSUMER_SIG_LIVE
) {
517 live_timer(ctx
, info
.si_signo
, &info
, NULL
);
519 ERR("Unexpected signal %d\n", info
.si_signo
);
524 /* Only reached in testpoint error */
526 health_unregister(health_consumerd
);