1 /* Copyright (C) 2009 Pierre-Marc Fournier
3 * This library is free software; you can redistribute it and/or
4 * modify it under the terms of the GNU Lesser General Public
5 * License as published by the Free Software Foundation; either
6 * version 2.1 of the License, or (at your option) any later version.
8 * This library 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 GNU
11 * Lesser General Public License for more details.
13 * You should have received a copy of the GNU Lesser General Public
14 * License along with this library; if not, write to the Free Software
15 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 #include <sys/types.h>
23 #include <sys/socket.h>
32 #include <ust/marker.h>
36 #include "buffers.h" /* FIXME: remove */
37 #include "marker-control.h"
41 #define USTSIGNAL SIGIO
43 #define MAX_MSG_SIZE (100)
45 #define MSG_REGISTER_NOTIF 2
47 char consumer_stack
[10000];
49 /* This should only be accessed by the constructor, before the creation
50 * of the listener, and then only by the listener.
54 struct list_head blocked_consumers
= LIST_HEAD_INIT(blocked_consumers
);
56 static struct ustcomm_app ustcomm_app
;
58 struct tracecmd
{ /* no padding */
63 /* volatile because shared between the listener and the main thread */
64 volatile sig_atomic_t buffers_to_export
= 0;
67 /* size: the size of all the fields except size itself */
70 /* Only the necessary part of the payload is transferred. It
71 * may even be none of it.
76 struct consumer_channel
{
78 struct ltt_channel_struct
*chan
;
81 struct blocked_consumer
{
86 /* args to ustcomm_send_reply */
87 struct ustcomm_server server
;
88 struct ustcomm_source src
;
90 /* args to ust_buffers_do_get_subbuf */
91 struct ust_buffer
*buf
;
93 struct list_head list
;
96 static long long make_pidunique(void)
101 gettimeofday(&tv
, NULL
);
105 retval
|= tv
.tv_usec
;
110 static void print_markers(FILE *fp
)
112 struct marker_iter iter
;
115 marker_iter_reset(&iter
);
116 marker_iter_start(&iter
);
119 fprintf(fp
, "marker: %s/%s %d \"%s\" %p\n", iter
.marker
->channel
, iter
.marker
->name
, (int)imv_read(iter
.marker
->state
), iter
.marker
->format
, iter
.marker
->location
);
120 marker_iter_next(&iter
);
125 static int init_socket(void);
127 /* This needs to be called whenever a new thread is created. It notifies
128 * liburcu of the new thread.
131 void ust_register_thread(void)
133 rcu_register_thread();
140 struct trctl_msg msg
;
142 /* FIXME: fd_notif should probably be protected by a spinlock */
147 msg
.type
= MSG_NOTIF
;
148 msg
.size
= sizeof(msg
.type
);
150 /* FIXME: don't block here */
151 result
= write(fd_notif
, &msg
, msg
.size
+sizeof(msg
.size
));
158 /* Ask the daemon to collect a trace called trace_name and being
159 * produced by this pid.
161 * The trace must be at least allocated. (It can also be started.)
162 * This is because _ltt_trace_find is used.
165 static void inform_consumer_daemon(const char *trace_name
)
168 struct ltt_trace_struct
*trace
;
169 pid_t pid
= getpid();
174 trace
= _ltt_trace_find(trace_name
);
176 WARN("inform_consumer_daemon: could not find trace \"%s\"; it is probably already destroyed", trace_name
);
180 for(i
=0; i
< trace
->nr_channels
; i
++) {
181 result
= ustcomm_request_consumer(pid
, trace
->channels
[i
].channel_name
);
183 WARN("Failed to request collection for channel %s. Is the daemon available?", trace
->channels
[i
].channel_name
);
184 /* continue even if fail */
193 void process_blocked_consumers(void)
197 struct blocked_consumer
*bc
;
202 list_for_each_entry(bc
, &blocked_consumers
, list
) {
206 fds
= (struct pollfd
*) malloc(n_fds
* sizeof(struct pollfd
));
208 ERR("malloc returned NULL");
212 list_for_each_entry(bc
, &blocked_consumers
, list
) {
213 fds
[idx
].fd
= bc
->fd_producer
;
214 fds
[idx
].events
= POLLIN
;
215 bc
->tmp_poll_idx
= idx
;
219 while((result
= poll(fds
, n_fds
, 0)) == -1 && errno
== EINTR
)
226 list_for_each_entry(bc
, &blocked_consumers
, list
) {
227 if(fds
[bc
->tmp_poll_idx
].revents
) {
228 long consumed_old
= 0;
231 result
= read(bc
->fd_producer
, &inbuf
, 1);
239 close(bc
->fd_producer
);
243 result
= ustcomm_send_reply(&bc
->server
, "END", &bc
->src
);
245 ERR("ustcomm_send_reply failed");
252 result
= ust_buffers_do_get_subbuf(bc
->buf
, &consumed_old
);
253 if(result
== -EAGAIN
) {
254 WARN("missed buffer?");
257 else if(result
< 0) {
258 DBG("ust_buffers_do_get_subbuf: error: %s", strerror(-result
));
260 asprintf(&reply
, "%s %ld", "OK", consumed_old
);
261 result
= ustcomm_send_reply(&bc
->server
, reply
, &bc
->src
);
263 ERR("ustcomm_send_reply failed");
275 void *listener_main(void *p
)
279 ust_register_thread();
284 char trace_name
[] = "auto";
285 char trace_type
[] = "ustrelay";
288 struct ustcomm_source src
;
290 process_blocked_consumers();
292 result
= ustcomm_app_recv_message(&ustcomm_app
, &recvbuf
, &src
, 5);
294 WARN("error in ustcomm_app_recv_message");
297 else if(result
== 0) {
302 DBG("received a message! it's: %s", recvbuf
);
303 len
= strlen(recvbuf
);
305 if(!strcmp(recvbuf
, "print_markers")) {
306 print_markers(stderr
);
308 else if(!strcmp(recvbuf
, "list_markers")) {
313 fp
= open_memstream(&ptr
, &size
);
317 result
= ustcomm_send_reply(&ustcomm_app
.server
, ptr
, &src
);
321 else if(!strcmp(recvbuf
, "start")) {
322 /* start is an operation that setups the trace, allocates it and starts it */
323 result
= ltt_trace_setup(trace_name
);
325 ERR("ltt_trace_setup failed");
329 result
= ltt_trace_set_type(trace_name
, trace_type
);
331 ERR("ltt_trace_set_type failed");
335 result
= ltt_trace_alloc(trace_name
);
337 ERR("ltt_trace_alloc failed");
341 inform_consumer_daemon(trace_name
);
343 result
= ltt_trace_start(trace_name
);
345 ERR("ltt_trace_start failed");
349 else if(!strcmp(recvbuf
, "trace_setup")) {
352 result
= ltt_trace_setup(trace_name
);
354 ERR("ltt_trace_setup failed");
358 result
= ltt_trace_set_type(trace_name
, trace_type
);
360 ERR("ltt_trace_set_type failed");
364 else if(!strcmp(recvbuf
, "trace_alloc")) {
367 result
= ltt_trace_alloc(trace_name
);
369 ERR("ltt_trace_alloc failed");
373 else if(!strcmp(recvbuf
, "trace_start")) {
376 result
= ltt_trace_start(trace_name
);
378 ERR("ltt_trace_start failed");
382 else if(!strcmp(recvbuf
, "trace_stop")) {
385 result
= ltt_trace_stop(trace_name
);
387 ERR("ltt_trace_stop failed");
391 else if(!strcmp(recvbuf
, "trace_destroy")) {
393 DBG("trace destroy");
395 result
= ltt_trace_destroy(trace_name
);
397 ERR("ltt_trace_destroy failed");
401 else if(nth_token_is(recvbuf
, "get_shmid", 0) == 1) {
402 struct ltt_trace_struct
*trace
;
403 char trace_name
[] = "auto";
409 channel_name
= nth_token(recvbuf
, 1);
410 if(channel_name
== NULL
) {
411 ERR("get_shmid: cannot parse channel");
416 trace
= _ltt_trace_find(trace_name
);
420 ERR("cannot find trace!");
424 for(i
=0; i
<trace
->nr_channels
; i
++) {
425 struct ust_channel
*channel
= &trace
->channels
[i
];
426 struct ust_buffer
*buf
= channel
->buf
;
428 if(!strcmp(trace
->channels
[i
].channel_name
, channel_name
)) {
431 DBG("the shmid for the requested channel is %d", buf
->shmid
);
432 DBG("the shmid for its buffer structure is %d", channel
->buf_shmid
);
433 asprintf(&reply
, "%d %d", buf
->shmid
, channel
->buf_shmid
);
435 result
= ustcomm_send_reply(&ustcomm_app
.server
, reply
, &src
);
437 ERR("listener: get_shmid: ustcomm_send_reply failed");
449 else if(nth_token_is(recvbuf
, "get_n_subbufs", 0) == 1) {
450 struct ltt_trace_struct
*trace
;
451 char trace_name
[] = "auto";
455 DBG("get_n_subbufs");
457 channel_name
= nth_token(recvbuf
, 1);
458 if(channel_name
== NULL
) {
459 ERR("get_n_subbufs: cannot parse channel");
464 trace
= _ltt_trace_find(trace_name
);
468 ERR("cannot find trace!");
472 for(i
=0; i
<trace
->nr_channels
; i
++) {
473 struct ust_channel
*channel
= &trace
->channels
[i
];
475 if(!strcmp(trace
->channels
[i
].channel_name
, channel_name
)) {
478 DBG("the n_subbufs for the requested channel is %d", channel
->subbuf_cnt
);
479 asprintf(&reply
, "%d", channel
->subbuf_cnt
);
481 result
= ustcomm_send_reply(&ustcomm_app
.server
, reply
, &src
);
483 ERR("listener: get_n_subbufs: ustcomm_send_reply failed");
493 else if(nth_token_is(recvbuf
, "get_subbuf_size", 0) == 1) {
494 struct ltt_trace_struct
*trace
;
495 char trace_name
[] = "auto";
499 DBG("get_subbuf_size");
501 channel_name
= nth_token(recvbuf
, 1);
502 if(channel_name
== NULL
) {
503 ERR("get_subbuf_size: cannot parse channel");
508 trace
= _ltt_trace_find(trace_name
);
512 ERR("cannot find trace!");
516 for(i
=0; i
<trace
->nr_channels
; i
++) {
517 struct ust_channel
*channel
= &trace
->channels
[i
];
519 if(!strcmp(trace
->channels
[i
].channel_name
, channel_name
)) {
522 DBG("the subbuf_size for the requested channel is %zd", channel
->subbuf_size
);
523 asprintf(&reply
, "%zd", channel
->subbuf_size
);
525 result
= ustcomm_send_reply(&ustcomm_app
.server
, reply
, &src
);
527 ERR("listener: get_subbuf_size: ustcomm_send_reply failed");
537 else if(nth_token_is(recvbuf
, "load_probe_lib", 0) == 1) {
540 libfile
= nth_token(recvbuf
, 1);
542 DBG("load_probe_lib loading %s", libfile
);
544 else if(nth_token_is(recvbuf
, "get_subbuffer", 0) == 1) {
545 struct ltt_trace_struct
*trace
;
546 char trace_name
[] = "auto";
552 channel_name
= nth_token(recvbuf
, 1);
553 if(channel_name
== NULL
) {
554 ERR("get_subbuf: cannot parse channel");
559 trace
= _ltt_trace_find(trace_name
);
563 ERR("cannot find trace!");
567 for(i
=0; i
<trace
->nr_channels
; i
++) {
568 struct ust_channel
*channel
= &trace
->channels
[i
];
570 if(!strcmp(trace
->channels
[i
].channel_name
, channel_name
)) {
571 struct ust_buffer
*buf
= channel
->buf
;
572 struct blocked_consumer
*bc
;
574 bc
= (struct blocked_consumer
*) malloc(sizeof(struct blocked_consumer
));
576 ERR("malloc returned NULL");
579 bc
->fd_consumer
= src
.fd
;
580 bc
->fd_producer
= buf
->data_ready_fd_read
;
583 bc
->server
= ustcomm_app
.server
;
585 list_add(&bc
->list
, &blocked_consumers
);
591 else if(nth_token_is(recvbuf
, "put_subbuffer", 0) == 1) {
592 struct ltt_trace_struct
*trace
;
593 char trace_name
[] = "auto";
597 char *consumed_old_str
;
602 channel_name
= strdup_malloc(nth_token(recvbuf
, 1));
603 if(channel_name
== NULL
) {
604 ERR("put_subbuf_size: cannot parse channel");
608 consumed_old_str
= strdup_malloc(nth_token(recvbuf
, 2));
609 if(consumed_old_str
== NULL
) {
610 ERR("put_subbuf: cannot parse consumed_old");
613 consumed_old
= strtol(consumed_old_str
, &endptr
, 10);
614 if(*endptr
!= '\0') {
615 ERR("put_subbuf: invalid value for consumed_old");
620 trace
= _ltt_trace_find(trace_name
);
624 ERR("cannot find trace!");
628 for(i
=0; i
<trace
->nr_channels
; i
++) {
629 struct ust_channel
*channel
= &trace
->channels
[i
];
631 if(!strcmp(trace
->channels
[i
].channel_name
, channel_name
)) {
632 struct ust_buffer
*buf
= channel
->buf
;
636 result
= ust_buffers_do_put_subbuf(buf
, consumed_old
);
638 WARN("ust_buffers_do_put_subbuf: error (subbuf=%s)", channel_name
);
639 asprintf(&reply
, "%s", "ERROR");
642 DBG("ust_buffers_do_put_subbuf: success (subbuf=%s)", channel_name
);
643 asprintf(&reply
, "%s", "OK");
646 result
= ustcomm_send_reply(&ustcomm_app
.server
, reply
, &src
);
648 ERR("listener: put_subbuf: ustcomm_send_reply failed");
659 free(consumed_old_str
);
661 else if(nth_token_is(recvbuf
, "enable_marker", 0) == 1) {
662 char *channel_slash_name
= nth_token(recvbuf
, 1);
663 char channel_name
[256]="";
664 char marker_name
[256]="";
666 result
= sscanf(channel_slash_name
, "%255[^/]/%255s", channel_name
, marker_name
);
668 if(channel_name
== NULL
|| marker_name
== NULL
) {
669 WARN("invalid marker name");
672 printf("%s %s\n", channel_name
, marker_name
);
674 result
= ltt_marker_connect(channel_name
, marker_name
, "default");
676 WARN("could not enable marker; channel=%s, name=%s", channel_name
, marker_name
);
679 else if(nth_token_is(recvbuf
, "disable_marker", 0) == 1) {
680 char *channel_slash_name
= nth_token(recvbuf
, 1);
684 result
= sscanf(channel_slash_name
, "%a[^/]/%as", &channel_name
, &marker_name
);
686 if(marker_name
== NULL
) {
688 printf("%s %s\n", channel_name
, marker_name
);
690 result
= ltt_marker_disconnect(channel_name
, marker_name
, "default");
692 WARN("could not disable marker; channel=%s, name=%s", channel_name
, marker_name
);
695 else if(nth_token_is(recvbuf
, "get_pidunique", 0) == 1) {
698 asprintf(&reply
, "%lld", pidunique
);
700 result
= ustcomm_send_reply(&ustcomm_app
.server
, reply
, &src
);
702 ERR("listener: get_pidunique: ustcomm_send_reply failed");
708 // else if(nth_token_is(recvbuf, "get_notifications", 0) == 1) {
709 // struct ltt_trace_struct *trace;
710 // char trace_name[] = "auto";
712 // char *channel_name;
714 // DBG("get_notifications");
716 // channel_name = strdup_malloc(nth_token(recvbuf, 1));
717 // if(channel_name == NULL) {
718 // ERR("put_subbuf_size: cannot parse channel");
722 // ltt_lock_traces();
723 // trace = _ltt_trace_find(trace_name);
724 // ltt_unlock_traces();
726 // if(trace == NULL) {
727 // ERR("cannot find trace!");
731 // for(i=0; i<trace->nr_channels; i++) {
732 // struct rchan *rchan = trace->channels[i].trans_channel_data;
735 // if(!strcmp(trace->channels[i].channel_name, channel_name)) {
736 // struct rchan_buf *rbuf = rchan->buf;
737 // struct ltt_channel_buf_struct *lttbuf = trace->channels[i].buf;
739 // result = fd = ustcomm_app_detach_client(&ustcomm_app, &src);
740 // if(result == -1) {
741 // ERR("ustcomm_app_detach_client failed");
745 // lttbuf->wake_consumer_arg = (void *) fd;
749 // lttbuf->call_wake_consumer = 1;
755 // free(channel_name);
758 ERR("unable to parse message: %s", recvbuf
);
766 volatile sig_atomic_t have_listener
= 0;
768 void create_listener(void)
771 static char listener_stack
[16384];
778 WARN("not creating listener because we already had one");
783 result
= clone((int (*)(void *)) listener_main
, listener_stack
+sizeof(listener_stack
)-1, CLONE_FS
| CLONE_FILES
| CLONE_VM
| CLONE_SIGHAND
| CLONE_THREAD
, NULL
);
790 pthread_create(&thread
, NULL
, listener_main
, NULL
);
796 static int init_socket(void)
798 return ustcomm_init_app(getpid(), &ustcomm_app
);
801 #define AUTOPROBE_DISABLED 0
802 #define AUTOPROBE_ENABLE_ALL 1
803 #define AUTOPROBE_ENABLE_REGEX 2
804 static int autoprobe_method
= AUTOPROBE_DISABLED
;
805 static regex_t autoprobe_regex
;
807 static void auto_probe_connect(struct marker
*m
)
811 char* concat_name
= NULL
;
812 const char *probe_name
= "default";
814 if(autoprobe_method
== AUTOPROBE_DISABLED
) {
817 else if(autoprobe_method
== AUTOPROBE_ENABLE_REGEX
) {
818 result
= asprintf(&concat_name
, "%s/%s", m
->channel
, m
->name
);
820 ERR("auto_probe_connect: asprintf failed (marker %s/%s)",
821 m
->channel
, m
->name
);
824 if (regexec(&autoprobe_regex
, concat_name
, 0, NULL
, 0)) {
831 result
= ltt_marker_connect(m
->channel
, m
->name
, probe_name
);
832 if(result
&& result
!= -EEXIST
)
833 ERR("ltt_marker_connect (marker = %s/%s, errno = %d)", m
->channel
, m
->name
, -result
);
835 DBG("auto connected marker %s (addr: %p) %s to probe default", m
->channel
, m
, m
->name
);
839 static void __attribute__((constructor
)) init()
842 char* autoprobe_val
= NULL
;
844 /* Assign the pidunique, to be able to differentiate the processes with same
845 * pid, (before and after an exec).
847 pidunique
= make_pidunique();
849 /* Initialize RCU in case the constructor order is not good. */
852 /* It is important to do this before events start to be generated. */
853 ust_register_thread();
855 DBG("Tracectl constructor");
857 /* Must create socket before signal handler to prevent races.
859 result
= init_socket();
861 ERR("init_socket error");
867 autoprobe_val
= getenv("UST_AUTOPROBE");
869 struct marker_iter iter
;
871 DBG("Autoprobe enabled.");
873 /* Ensure markers are initialized */
876 /* Ensure marker control is initialized, for the probe */
877 init_marker_control();
879 /* first, set the callback that will connect the
880 * probe on new markers
882 if(autoprobe_val
[0] == '/') {
883 result
= regcomp(&autoprobe_regex
, autoprobe_val
+1, 0);
887 regerror(result
, &autoprobe_regex
, regexerr
, sizeof(regexerr
));
888 ERR("cannot parse regex %s (%s), will ignore UST_AUTOPROBE", autoprobe_val
, regexerr
);
889 /* don't crash the application just for this */
892 autoprobe_method
= AUTOPROBE_ENABLE_REGEX
;
896 /* just enable all instrumentation */
897 autoprobe_method
= AUTOPROBE_ENABLE_ALL
;
900 marker_set_new_marker_cb(auto_probe_connect
);
902 /* Now, connect the probes that were already registered. */
903 marker_iter_reset(&iter
);
904 marker_iter_start(&iter
);
906 DBG("now iterating on markers already registered");
908 DBG("now iterating on marker %s", iter
.marker
->name
);
909 auto_probe_connect(iter
.marker
);
910 marker_iter_next(&iter
);
914 if(getenv("UST_TRACE")) {
915 char trace_name
[] = "auto";
916 char trace_type
[] = "ustrelay";
918 DBG("starting early tracing");
920 /* Ensure marker control is initialized */
921 init_marker_control();
923 /* Ensure relay is initialized */
924 init_ustrelay_transport();
926 /* Ensure markers are initialized */
930 ltt_channels_register("ust");
932 result
= ltt_trace_setup(trace_name
);
934 ERR("ltt_trace_setup failed");
938 result
= ltt_trace_set_type(trace_name
, trace_type
);
940 ERR("ltt_trace_set_type failed");
944 result
= ltt_trace_alloc(trace_name
);
946 ERR("ltt_trace_alloc failed");
950 result
= ltt_trace_start(trace_name
);
952 ERR("ltt_trace_start failed");
956 /* Do this after the trace is started in order to avoid creating confusion
957 * if the trace fails to start. */
958 inform_consumer_daemon(trace_name
);
964 /* should decrementally destroy stuff if error */
968 /* This is only called if we terminate normally, not with an unhandled signal,
969 * so we cannot rely on it. However, for now, LTTV requires that the header of
970 * the last sub-buffer contain a valid end time for the trace. This is done
971 * automatically only when the trace is properly stopped.
973 * If the traced program crashed, it is always possible to manually add the
974 * right value in the header, or to open the trace in text mode.
976 * FIXME: Fix LTTV so it doesn't need this.
979 static void destroy_traces(void)
983 /* if trace running, finish it */
985 DBG("destructor stopping traces");
987 result
= ltt_trace_stop("auto");
989 ERR("ltt_trace_stop error");
992 result
= ltt_trace_destroy("auto");
994 ERR("ltt_trace_destroy error");
998 static int trace_recording(void)
1001 struct ltt_trace_struct
*trace
;
1005 list_for_each_entry(trace
, <t_traces
.head
, list
) {
1012 ltt_unlock_traces();
1018 static int have_consumer(void)
1020 return !list_empty(&blocked_consumers
);
1024 int restarting_usleep(useconds_t usecs
)
1030 tv
.tv_nsec
= usecs
* 1000;
1033 result
= nanosleep(&tv
, &tv
);
1034 } while(result
== -1 && errno
== EINTR
);
1039 /* This destructor keeps the process alive for a few seconds in order
1040 * to leave time to ustd to connect to its buffers. This is necessary
1041 * for programs whose execution is very short. It is also useful in all
1042 * programs when tracing is started close to the end of the program
1045 * FIXME: For now, this only works for the first trace created in a
1049 static void __attribute__((destructor
)) keepalive()
1051 if(trace_recording() && buffers_to_export
) {
1053 DBG("Keeping process alive for consumer daemon...");
1054 while(buffers_to_export
) {
1055 const int interv
= 200000;
1056 restarting_usleep(interv
);
1059 if(total
>= 3000000) {
1060 WARN("non-consumed buffers remaining after wait limit; not waiting anymore");
1064 DBG("Finally dying...");
1069 ustcomm_fini_app(&ustcomm_app
);
1072 void ust_potential_exec(void)
1074 trace_mark(ust
, potential_exec
, MARK_NOARGS
);
1081 /* Notify ust that there was a fork. This needs to be called inside
1082 * the new process, anytime a process whose memory is not shared with
1083 * the parent is created. If this function is not called, the events
1084 * of the new process will not be collected.
1089 struct blocked_consumer
*bc
;
1090 struct blocked_consumer
*deletable_bc
= NULL
;
1093 DBG("ust: forking");
1094 ltt_trace_stop("auto");
1095 ltt_trace_destroy("auto");
1096 /* Delete all active connections */
1097 ustcomm_close_all_connections(&ustcomm_app
.server
);
1099 /* Delete all blocked consumers */
1100 list_for_each_entry(bc
, &blocked_consumers
, list
) {
1101 close(bc
->fd_producer
);
1102 close(bc
->fd_consumer
);
1105 list_del(&bc
->list
);
1111 ltt_trace_setup("auto");
1112 result
= ltt_trace_set_type("auto", "ustrelay");
1114 ERR("ltt_trace_set_type failed");
1118 ltt_trace_alloc("auto");
1119 ltt_trace_start("auto");
1120 inform_consumer_daemon("auto");