3 * Linux Trace Toolkit Daemon
5 * This is a simple daemon that reads a few relay+debugfs channels and save
8 * CPU hot-plugging is supported using inotify.
11 * Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
24 #include <sys/types.h>
34 #include <sys/syscall.h>
36 #include <asm/ioctls.h>
38 #include <linux/version.h>
41 #include <asm/ioctl.h>
42 #include <asm/types.h>
44 /* Get the next sub buffer that can be read. */
45 #define RELAY_GET_SUBBUF _IOR(0xF5, 0x00,__u32)
46 /* Release the oldest reserved (by "get") sub buffer. */
47 #define RELAY_PUT_SUBBUF _IOW(0xF5, 0x01,__u32)
48 /* returns the number of sub buffers in the per cpu channel. */
49 #define RELAY_GET_N_SUBBUFS _IOR(0xF5, 0x02,__u32)
50 /* returns the size of the sub buffers. */
51 #define RELAY_GET_SUBBUF_SIZE _IOR(0xF5, 0x03,__u32)
53 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,14)
54 #include <sys/inotify.h>
55 /* From the inotify-tools 2.6 package */
56 static inline int inotify_init (void)
58 return syscall (__NR_inotify_init
);
61 static inline int inotify_add_watch (int fd
, const char *name
, __u32 mask
)
63 return syscall (__NR_inotify_add_watch
, fd
, name
, mask
);
66 static inline int inotify_rm_watch (int fd
, __u32 wd
)
68 return syscall (__NR_inotify_rm_watch
, fd
, wd
);
72 static inline int inotify_init (void)
77 static inline int inotify_add_watch (int fd
, const char *name
, __u32 mask
)
82 static inline int inotify_rm_watch (int fd
, __u32 wd
)
99 unsigned int n_subbufs
;
100 unsigned int subbuf_size
;
102 pthread_mutex_t mutex
;
105 struct channel_trace_fd
{
106 struct fd_pair
*pair
;
110 struct inotify_watch
{
112 char path_channel
[PATH_MAX
];
113 char path_trace
[PATH_MAX
];
116 struct inotify_watch_array
{
117 struct inotify_watch
*elem
;
121 static __thread
int thread_pipe
[2];
123 struct channel_trace_fd fd_pairs
= { NULL
, 0 };
125 struct inotify_watch_array inotify_watch_array
= { NULL
, 0 };
127 /* protects fd_pairs and inotify_watch_array */
128 pthread_rwlock_t fd_pairs_lock
= PTHREAD_RWLOCK_INITIALIZER
;
131 static char *trace_name
= NULL
;
132 static char *channel_name
= NULL
;
133 static int daemon_mode
= 0;
134 static int append_mode
= 0;
135 static unsigned long num_threads
= 1;
136 volatile static int quit_program
= 0; /* For signal handler */
137 static int dump_flight_only
= 0;
138 static int dump_normal_only
= 0;
139 static int verbose_mode
= 0;
141 #define printf_verbose(fmt, args...) \
144 printf(fmt, ##args); \
149 * -t directory Directory name of the trace to write to. Will be created.
150 * -c directory Root directory of the debugfs trace channels.
151 * -d Run in background (daemon).
152 * -a Trace append mode.
153 * -s Send SIGUSR1 to parent when ready for IO.
155 void show_arguments(void)
157 printf("Please use the following arguments :\n");
159 printf("-t directory Directory name of the trace to write to.\n"
160 " It will be created.\n");
161 printf("-c directory Root directory of the debugfs trace channels.\n");
162 printf("-d Run in background (daemon).\n");
163 printf("-a Append to an possibly existing trace.\n");
164 printf("-N Number of threads to start.\n");
165 printf("-f Dump only flight recorder channels.\n");
166 printf("-n Dump only normal channels.\n");
167 printf("-v Verbose mode.\n");
174 * Parses the command line arguments.
176 * Returns 1 if the arguments were correct, but doesn't ask for program
177 * continuation. Returns -1 if the arguments are incorrect, or 0 if OK.
179 int parse_arguments(int argc
, char **argv
)
185 if(strcmp(argv
[1], "-h") == 0) {
192 switch(argv
[argn
][0]) {
194 switch(argv
[argn
][1]) {
197 trace_name
= argv
[argn
+1];
203 channel_name
= argv
[argn
+1];
215 num_threads
= strtoul(argv
[argn
+1], NULL
, 0);
220 dump_flight_only
= 1;
223 dump_normal_only
= 1;
229 printf("Invalid argument '%s'.\n", argv
[argn
]);
235 printf("Invalid argument '%s'.\n", argv
[argn
]);
242 if(trace_name
== NULL
) {
243 printf("Please specify a trace name.\n");
248 if(channel_name
== NULL
) {
249 printf("Please specify a channel name.\n");
259 printf("Linux Trace Toolkit Trace Daemon " VERSION
"\n");
261 printf("Reading from debugfs directory : %s\n", channel_name
);
262 printf("Writing to trace directory : %s\n", trace_name
);
267 /* signal handling */
269 static void handler(int signo
)
271 printf("Signal %d received : exiting cleanly\n", signo
);
276 int open_buffer_file(char *filename
, char *path_channel
, char *path_trace
,
277 struct channel_trace_fd
*fd_pairs
)
281 struct stat stat_buf
;
283 if(strncmp(filename
, "flight-", sizeof("flight-")-1) != 0) {
284 if(dump_flight_only
) {
285 printf_verbose("Skipping normal channel %s\n",
290 if(dump_normal_only
) {
291 printf_verbose("Skipping flight channel %s\n",
296 printf_verbose("Opening file.\n");
298 fd_pairs
->pair
= realloc(fd_pairs
->pair
,
299 ++fd_pairs
->num_pairs
* sizeof(struct fd_pair
));
301 /* Open the channel in read mode */
302 fd_pairs
->pair
[fd_pairs
->num_pairs
-1].channel
=
303 open(path_channel
, O_RDONLY
| O_NONBLOCK
);
304 if(fd_pairs
->pair
[fd_pairs
->num_pairs
-1].channel
== -1) {
305 perror(path_channel
);
306 fd_pairs
->num_pairs
--;
307 return 0; /* continue */
309 /* Open the trace in write mode, only append if append_mode */
310 ret
= stat(path_trace
, &stat_buf
);
313 printf_verbose("Appending to file %s as requested\n",
316 fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
=
317 open(path_trace
, O_WRONLY
|O_APPEND
,
318 S_IRWXU
|S_IRWXG
|S_IRWXO
);
320 if(fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
== -1) {
324 printf("File %s exists, cannot open. Try append mode.\n", path_trace
);
329 if(errno
== ENOENT
) {
330 fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
=
331 open(path_trace
, O_WRONLY
|O_CREAT
|O_EXCL
,
332 S_IRWXU
|S_IRWXG
|S_IRWXO
);
333 if(fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
== -1) {
342 int open_channel_trace_pairs(char *subchannel_name
, char *subtrace_name
,
343 struct channel_trace_fd
*fd_pairs
, int *inotify_fd
,
344 struct inotify_watch_array
*iwatch_array
)
346 DIR *channel_dir
= opendir(subchannel_name
);
347 struct dirent
*entry
;
348 struct stat stat_buf
;
350 char path_channel
[PATH_MAX
];
351 int path_channel_len
;
352 char *path_channel_ptr
;
353 char path_trace
[PATH_MAX
];
355 char *path_trace_ptr
;
358 if(channel_dir
== NULL
) {
359 perror(subchannel_name
);
364 printf_verbose("Creating trace subdirectory %s\n", subtrace_name
);
365 ret
= mkdir(subtrace_name
, S_IRWXU
|S_IRWXG
|S_IRWXO
);
367 if(errno
!= EEXIST
) {
368 perror(subtrace_name
);
374 strncpy(path_channel
, subchannel_name
, PATH_MAX
-1);
375 path_channel_len
= strlen(path_channel
);
376 path_channel
[path_channel_len
] = '/';
378 path_channel_ptr
= path_channel
+ path_channel_len
;
380 strncpy(path_trace
, subtrace_name
, PATH_MAX
-1);
381 path_trace_len
= strlen(path_trace
);
382 path_trace
[path_trace_len
] = '/';
384 path_trace_ptr
= path_trace
+ path_trace_len
;
387 iwatch_array
->elem
= realloc(iwatch_array
->elem
,
388 ++iwatch_array
->num
* sizeof(struct inotify_watch
));
390 printf_verbose("Adding inotify for channel %s\n", path_channel
);
391 iwatch_array
->elem
[iwatch_array
->num
-1].wd
= inotify_add_watch(*inotify_fd
, path_channel
, IN_CREATE
);
392 strcpy(iwatch_array
->elem
[iwatch_array
->num
-1].path_channel
, path_channel
);
393 strcpy(iwatch_array
->elem
[iwatch_array
->num
-1].path_trace
, path_trace
);
394 printf_verbose("Added inotify for channel %s, wd %u\n",
395 iwatch_array
->elem
[iwatch_array
->num
-1].path_channel
,
396 iwatch_array
->elem
[iwatch_array
->num
-1].wd
);
399 while((entry
= readdir(channel_dir
)) != NULL
) {
401 if(entry
->d_name
[0] == '.') continue;
403 strncpy(path_channel_ptr
, entry
->d_name
, PATH_MAX
- path_channel_len
);
404 strncpy(path_trace_ptr
, entry
->d_name
, PATH_MAX
- path_trace_len
);
406 ret
= stat(path_channel
, &stat_buf
);
408 perror(path_channel
);
412 printf_verbose("Channel file : %s\n", path_channel
);
414 if(S_ISDIR(stat_buf
.st_mode
)) {
416 printf_verbose("Entering channel subdirectory...\n");
417 ret
= open_channel_trace_pairs(path_channel
, path_trace
, fd_pairs
,
418 inotify_fd
, iwatch_array
);
419 if(ret
< 0) continue;
420 } else if(S_ISREG(stat_buf
.st_mode
)) {
421 open_ret
= open_buffer_file(entry
->d_name
, path_channel
, path_trace
,
429 closedir(channel_dir
);
435 int read_subbuffer(struct fd_pair
*pair
)
437 unsigned int consumed_old
;
444 err
= ioctl(pair
->channel
, RELAY_GET_SUBBUF
, &consumed_old
);
445 printf_verbose("cookie : %u\n", consumed_old
);
448 perror("Reserving sub buffer failed (everything is normal, it is due to concurrency)");
452 err
= TEMP_FAILURE_RETRY(write(pair
->trace
,
454 + (consumed_old
& ((pair
->n_subbufs
* pair
->subbuf_size
)-1)),
459 perror("Error in writing to file");
463 len
= pair
->subbuf_size
;
466 printf_verbose("splice chan to pipe offset %lu\n",
467 (unsigned long)offset
);
468 ret
= splice(pair
->channel
, &offset
, thread_pipe
[1], NULL
,
470 printf_verbose("splice chan to pipe ret %ld\n", ret
);
472 perror("Error in relay splice");
475 ret
= splice(thread_pipe
[0], NULL
, pair
->trace
, NULL
,
477 printf_verbose("splice pipe to file %ld\n", ret
);
479 perror("Error in file splice");
486 err
= fsync(pair
->trace
);
489 perror("Error in writing to file");
495 err
= ioctl(pair
->channel
, RELAY_PUT_SUBBUF
, &consumed_old
);
498 if(errno
== EFAULT
) {
499 perror("Error in unreserving sub buffer\n");
500 } else if(errno
== EIO
) {
501 perror("Reader has been pushed by the writer, last subbuffer corrupted.");
502 /* FIXME : we may delete the last written buffer if we wish. */
512 int map_channels(struct channel_trace_fd
*fd_pairs
,
513 int idx_begin
, int idx_end
)
518 if(fd_pairs
->num_pairs
<= 0) {
519 printf("No channel to read\n");
523 /* Get the subbuf sizes and number */
525 for(i
=idx_begin
;i
<idx_end
;i
++) {
526 struct fd_pair
*pair
= &fd_pairs
->pair
[i
];
528 ret
= ioctl(pair
->channel
, RELAY_GET_N_SUBBUFS
,
531 perror("Error in getting the number of subbuffers");
534 ret
= ioctl(pair
->channel
, RELAY_GET_SUBBUF_SIZE
,
537 perror("Error in getting the size of the subbuffers");
540 ret
= pthread_mutex_init(&pair
->mutex
, NULL
); /* Fast mutex */
542 perror("Error in mutex init");
549 for(i
=idx_begin
;i
<idx_end
;i
++) {
550 struct fd_pair
*pair
= &fd_pairs
->pair
[i
];
552 pair
->mmap
= mmap(0, pair
->subbuf_size
* pair
->n_subbufs
, PROT_READ
,
553 MAP_SHARED
, pair
->channel
, 0);
554 if(pair
->mmap
== MAP_FAILED
) {
555 perror("Mmap error");
560 goto end
; /* success */
563 /* munmap only the successfully mmapped indexes */
566 for(j
=idx_begin
;j
<i
;j
++) {
567 struct fd_pair
*pair
= &fd_pairs
->pair
[j
];
570 err_ret
= munmap(pair
->mmap
, pair
->subbuf_size
* pair
->n_subbufs
);
572 perror("Error in munmap");
582 int unmap_channels(struct channel_trace_fd
*fd_pairs
)
588 for(j
=0;j
<fd_pairs
->num_pairs
;j
++) {
589 struct fd_pair
*pair
= &fd_pairs
->pair
[j
];
593 err_ret
= munmap(pair
->mmap
, pair
->subbuf_size
* pair
->n_subbufs
);
595 perror("Error in munmap");
599 err_ret
= pthread_mutex_destroy(&pair
->mutex
);
601 perror("Error in mutex destroy");
610 /* Inotify event arrived.
612 * Only support add file for now.
615 int read_inotify(int inotify_fd
,
616 struct channel_trace_fd
*fd_pairs
,
617 struct inotify_watch_array
*iwatch_array
)
619 char buf
[sizeof(struct inotify_event
) + PATH_MAX
];
620 char path_channel
[PATH_MAX
];
621 char path_trace
[PATH_MAX
];
623 struct inotify_event
*ievent
;
630 len
= read(inotify_fd
, buf
, sizeof(struct inotify_event
) + PATH_MAX
);
634 return 0; /* another thread got the data before us */
636 printf("Error in read from inotify FD %s.\n", strerror(len
));
639 while(offset
< len
) {
640 ievent
= (struct inotify_event
*)&(buf
[offset
]);
641 for(i
=0; i
<iwatch_array
->num
; i
++) {
642 if(iwatch_array
->elem
[i
].wd
== ievent
->wd
&&
643 ievent
->mask
== IN_CREATE
) {
645 "inotify wd %u event mask : %u for %s%s\n",
646 ievent
->wd
, ievent
->mask
,
647 iwatch_array
->elem
[i
].path_channel
,
649 old_num
= fd_pairs
->num_pairs
;
650 strcpy(path_channel
, iwatch_array
->elem
[i
].path_channel
);
651 strcat(path_channel
, ievent
->name
);
652 strcpy(path_trace
, iwatch_array
->elem
[i
].path_trace
);
653 strcat(path_trace
, ievent
->name
);
654 if(ret
= open_buffer_file(ievent
->name
, path_channel
,
655 path_trace
, fd_pairs
)) {
656 printf("Error opening buffer file\n");
659 if(ret
= map_channels(fd_pairs
, old_num
, fd_pairs
->num_pairs
)) {
660 printf("Error mapping channel\n");
666 offset
+= sizeof(*ievent
) + ievent
->len
;
675 * Read the debugfs channels and write them in the paired tracefiles.
677 * @fd_pairs : paired channels and trace files.
679 * returns 0 on success, -1 on error.
681 * Note that the high priority polled channels are consumed first. We then poll
682 * again to see if these channels are still in priority. Only when no
683 * high priority channel is left, we start reading low priority channels.
685 * Note that a channel is considered high priority when the buffer is almost
689 int read_channels(unsigned long thread_num
, struct channel_trace_fd
*fd_pairs
,
690 int inotify_fd
, struct inotify_watch_array
*iwatch_array
)
692 struct pollfd
*pollfd
= NULL
;
695 int num_rdy
, num_hup
;
699 unsigned int old_num
;
707 pthread_rwlock_rdlock(&fd_pairs_lock
);
709 /* Start polling the FD. Keep one fd for inotify */
710 pollfd
= malloc((inotify_fds
+ fd_pairs
->num_pairs
) * sizeof(struct pollfd
));
713 pollfd
[0].fd
= inotify_fd
;
714 pollfd
[0].events
= POLLIN
|POLLPRI
;
717 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
718 pollfd
[inotify_fds
+i
].fd
= fd_pairs
->pair
[i
].channel
;
719 pollfd
[inotify_fds
+i
].events
= POLLIN
|POLLPRI
;
721 num_pollfd
= inotify_fds
+ fd_pairs
->num_pairs
;
724 pthread_rwlock_unlock(&fd_pairs_lock
);
730 printf("Press a key for next poll...\n");
732 read(STDIN_FILENO
, &buf
, 1);
733 printf("Next poll (polling %d fd) :\n", num_pollfd
);
736 /* Have we received a signal ? */
737 if(quit_program
) break;
739 num_rdy
= poll(pollfd
, num_pollfd
, -1);
742 perror("Poll error");
746 printf_verbose("Data received\n");
748 switch(pollfd
[0].revents
) {
751 "Error returned in polling inotify fd %d.\n",
756 "Polling inotify fd %d tells it has hung up.\n",
761 "Polling inotify fd %d tells fd is not open.\n",
767 "Polling inotify fd %d : data ready.\n",
770 pthread_rwlock_wrlock(&fd_pairs_lock
);
771 read_inotify(inotify_fd
, fd_pairs
, iwatch_array
);
772 pthread_rwlock_unlock(&fd_pairs_lock
);
778 for(i
=inotify_fds
;i
<num_pollfd
;i
++) {
779 switch(pollfd
[i
].revents
) {
782 "Error returned in polling fd %d.\n",
788 "Polling fd %d tells it has hung up.\n",
794 "Polling fd %d tells fd is not open.\n",
799 pthread_rwlock_rdlock(&fd_pairs_lock
);
800 if(pthread_mutex_trylock(&fd_pairs
->pair
[i
-inotify_fds
].mutex
) == 0) {
802 "Urgent read on fd %d\n",
804 /* Take care of high priority channels first. */
806 /* it's ok to have an unavailable subbuffer */
807 ret
= read_subbuffer(&fd_pairs
->pair
[i
-inotify_fds
]);
808 if(ret
== EAGAIN
) ret
= 0;
810 ret
= pthread_mutex_unlock(&fd_pairs
->pair
[i
-inotify_fds
].mutex
);
812 printf("Error in mutex unlock : %s\n", strerror(ret
));
814 pthread_rwlock_unlock(&fd_pairs_lock
);
818 /* If every buffer FD has hung up, we end the read loop here */
819 if(num_hup
== num_pollfd
- inotify_fds
) break;
822 for(i
=inotify_fds
;i
<num_pollfd
;i
++) {
823 switch(pollfd
[i
].revents
) {
825 pthread_rwlock_rdlock(&fd_pairs_lock
);
826 if(pthread_mutex_trylock(&fd_pairs
->pair
[i
-inotify_fds
].mutex
) == 0) {
827 /* Take care of low priority channels. */
829 "Normal read on fd %d\n",
831 /* it's ok to have an unavailable subbuffer */
832 ret
= read_subbuffer(&fd_pairs
->pair
[i
-inotify_fds
]);
833 if(ret
== EAGAIN
) ret
= 0;
835 ret
= pthread_mutex_unlock(&fd_pairs
->pair
[i
-inotify_fds
].mutex
);
837 printf("Error in mutex unlock : %s\n", strerror(ret
));
839 pthread_rwlock_unlock(&fd_pairs_lock
);
845 /* Update pollfd array if an entry was added to fd_pairs */
846 pthread_rwlock_rdlock(&fd_pairs_lock
);
847 if((inotify_fds
+ fd_pairs
->num_pairs
) != num_pollfd
) {
848 pollfd
= realloc(pollfd
,
849 (inotify_fds
+ fd_pairs
->num_pairs
) * sizeof(struct pollfd
));
850 for(i
=num_pollfd
-inotify_fds
;i
<fd_pairs
->num_pairs
;i
++) {
851 pollfd
[inotify_fds
+i
].fd
= fd_pairs
->pair
[i
].channel
;
852 pollfd
[inotify_fds
+i
].events
= POLLIN
|POLLPRI
;
854 num_pollfd
= fd_pairs
->num_pairs
+ inotify_fds
;
856 pthread_rwlock_unlock(&fd_pairs_lock
);
858 /* NB: If the fd_pairs structure is updated by another thread from this
859 * point forward, the current thread will wait in the poll without
860 * monitoring the new channel. However, this thread will add the
861 * new channel on next poll (and this should not take too much time
862 * on a loaded system).
864 * This event is quite unlikely and can only occur if a CPU is
865 * hot-plugged while multple lttd threads are running.
877 void close_channel_trace_pairs(struct channel_trace_fd
*fd_pairs
, int inotify_fd
,
878 struct inotify_watch_array
*iwatch_array
)
883 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
884 ret
= close(fd_pairs
->pair
[i
].channel
);
885 if(ret
== -1) perror("Close error on channel");
886 ret
= close(fd_pairs
->pair
[i
].trace
);
887 if(ret
== -1) perror("Close error on trace");
889 free(fd_pairs
->pair
);
890 free(iwatch_array
->elem
);
894 void * thread_main(void *arg
)
897 unsigned long thread_num
= (unsigned long)arg
;
899 ret
= pipe(thread_pipe
);
901 perror("Error creating pipe");
904 ret
= read_channels(thread_num
, &fd_pairs
, inotify_fd
, &inotify_watch_array
);
905 close(thread_pipe
[0]); /* close read end */
906 close(thread_pipe
[1]); /* close write end */
915 inotify_fd
= inotify_init();
916 fcntl(inotify_fd
, F_SETFL
, O_NONBLOCK
);
918 if(ret
= open_channel_trace_pairs(channel_name
, trace_name
, &fd_pairs
,
919 &inotify_fd
, &inotify_watch_array
))
922 if(ret
= map_channels(&fd_pairs
, 0, fd_pairs
.num_pairs
))
927 close_channel_trace_pairs(&fd_pairs
, inotify_fd
, &inotify_watch_array
);
934 int main(int argc
, char ** argv
)
937 struct sigaction act
;
942 ret
= parse_arguments(argc
, argv
);
944 if(ret
!= 0) show_arguments();
945 if(ret
< 0) return EINVAL
;
946 if(ret
> 0) return 0;
950 /* Connect the signal handlers */
951 act
.sa_handler
= handler
;
953 sigemptyset(&(act
.sa_mask
));
954 sigaddset(&(act
.sa_mask
), SIGTERM
);
955 sigaddset(&(act
.sa_mask
), SIGQUIT
);
956 sigaddset(&(act
.sa_mask
), SIGINT
);
957 sigaction(SIGTERM
, &act
, NULL
);
958 sigaction(SIGQUIT
, &act
, NULL
);
959 sigaction(SIGINT
, &act
, NULL
);
961 if(ret
= channels_init())
968 perror("An error occured while daemonizing.");
973 tids
= malloc(sizeof(pthread_t
) * num_threads
);
974 for(i
=0; i
<num_threads
; i
++) {
976 ret
= pthread_create(&tids
[i
], NULL
, thread_main
, (void*)i
);
978 perror("Error creating thread");
983 for(i
=0; i
<num_threads
; i
++) {
984 ret
= pthread_join(tids
[i
], &tret
);
986 perror("Error joining thread");
989 if((long)tret
!= 0) {
990 printf("Error %s occured in thread %u\n",
991 strerror((long)tret
), i
);
996 ret
= unmap_channels(&fd_pairs
);
997 close_channel_trace_pairs(&fd_pairs
, inotify_fd
, &inotify_watch_array
);