3 * Linux Trace Toolkit Daemon
5 * This is a simple daemon that reads a few relayfs channels and save them in a
10 * Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
21 #include <sys/types.h>
32 #include <asm/ioctl.h>
33 #include <asm/types.h>
35 /* Get the next sub buffer that can be read. */
36 #define RELAYFS_GET_SUBBUF _IOR(0xF4, 0x00,__u32)
37 /* Release the oldest reserved (by "get") sub buffer. */
38 #define RELAYFS_PUT_SUBBUF _IO(0xF4, 0x01)
39 /* returns the number of sub buffers in the per cpu channel. */
40 #define RELAYFS_GET_N_SUBBUFS _IOR(0xF4, 0x02,__u32)
41 /* returns the size of the sub buffers. */
42 #define RELAYFS_GET_SUBBUF_SIZE _IOR(0xF4, 0x03,__u32)
56 unsigned int n_subbufs
;
57 unsigned int subbuf_size
;
61 struct channel_trace_fd
{
66 static char *trace_name
= NULL
;
67 static char *channel_name
= NULL
;
68 static int daemon_mode
= 0;
69 static int append_mode
= 0;
70 static int sig_parent
= 0;
71 volatile static int quit_program
= 0; /* For signal handler */
75 * -t directory Directory name of the trace to write to. Will be created.
76 * -c directory Root directory of the relayfs trace channels.
77 * -d Run in background (daemon).
78 * -a Trace append mode.
79 * -s Send SIGIO to parent when ready for IO.
81 void show_arguments(void)
83 printf("Please use the following arguments :\n");
85 printf("-t directory Directory name of the trace to write to.\n"
86 " It will be created.\n");
87 printf("-c directory Root directory of the relayfs trace channels.\n");
88 printf("-d Run in background (daemon).\n");
89 printf("-a Append to an possibly existing trace.\n");
90 printf("-s Send SIGIO to parent when ready for IO.\n");
97 * Parses the command line arguments.
99 * Returns 1 if the arguments were correct, but doesn't ask for program
100 * continuation. Returns -1 if the arguments are incorrect, or 0 if OK.
102 int parse_arguments(int argc
, char **argv
)
108 if(strcmp(argv
[1], "-h") == 0) {
115 switch(argv
[argn
][0]) {
117 switch(argv
[argn
][1]) {
120 trace_name
= argv
[argn
+1];
126 channel_name
= argv
[argn
+1];
140 printf("Invalid argument '%s'.\n", argv
[argn
]);
146 printf("Invalid argument '%s'.\n", argv
[argn
]);
153 if(trace_name
== NULL
) {
154 printf("Please specify a trace name.\n");
159 if(channel_name
== NULL
) {
160 printf("Please specify a channel name.\n");
170 printf("Linux Trace Toolkit Trace Daemon\n");
172 printf("Reading from relayfs directory : %s\n", channel_name
);
173 printf("Writing to trace directory : %s\n", trace_name
);
178 /* signal handling */
180 static void handler(int signo
)
182 printf("Signal %d received : exiting cleanly\n", signo
);
188 int open_channel_trace_pairs(char *subchannel_name
, char *subtrace_name
,
189 struct channel_trace_fd
*fd_pairs
)
191 DIR *channel_dir
= opendir(subchannel_name
);
192 struct dirent
*entry
;
193 struct stat stat_buf
;
195 char path_channel
[PATH_MAX
];
196 int path_channel_len
;
197 char *path_channel_ptr
;
198 char path_trace
[PATH_MAX
];
200 char *path_trace_ptr
;
202 if(channel_dir
== NULL
) {
203 perror(subchannel_name
);
207 printf("Creating trace subdirectory %s\n", subtrace_name
);
208 ret
= mkdir(subtrace_name
, S_IRWXU
|S_IRWXG
|S_IRWXO
);
210 if(errno
== EEXIST
&& append_mode
) {
211 printf("Appending to directory %s as resquested\n", subtrace_name
);
213 perror(subtrace_name
);
218 strncpy(path_channel
, subchannel_name
, PATH_MAX
-1);
219 path_channel_len
= strlen(path_channel
);
220 path_channel
[path_channel_len
] = '/';
222 path_channel_ptr
= path_channel
+ path_channel_len
;
224 strncpy(path_trace
, subtrace_name
, PATH_MAX
-1);
225 path_trace_len
= strlen(path_trace
);
226 path_trace
[path_trace_len
] = '/';
228 path_trace_ptr
= path_trace
+ path_trace_len
;
230 while((entry
= readdir(channel_dir
)) != NULL
) {
232 if(entry
->d_name
[0] == '.') continue;
234 strncpy(path_channel_ptr
, entry
->d_name
, PATH_MAX
- path_channel_len
);
235 strncpy(path_trace_ptr
, entry
->d_name
, PATH_MAX
- path_trace_len
);
237 ret
= stat(path_channel
, &stat_buf
);
239 perror(path_channel
);
243 printf("Channel file : %s\n", path_channel
);
245 if(S_ISDIR(stat_buf
.st_mode
)) {
247 printf("Entering channel subdirectory...\n");
248 ret
= open_channel_trace_pairs(path_channel
, path_trace
, fd_pairs
);
249 if(ret
< 0) continue;
250 } else if(S_ISREG(stat_buf
.st_mode
)) {
251 printf("Opening file.\n");
253 fd_pairs
->pair
= realloc(fd_pairs
->pair
,
254 ++fd_pairs
->num_pairs
* sizeof(struct fd_pair
));
256 /* Open the channel in read mode */
257 fd_pairs
->pair
[fd_pairs
->num_pairs
-1].channel
=
258 open(path_channel
, O_RDONLY
| O_NONBLOCK
);
259 if(fd_pairs
->pair
[fd_pairs
->num_pairs
-1].channel
== -1) {
260 perror(path_channel
);
261 fd_pairs
->num_pairs
--;
264 /* Open the trace in write mode, only append if append_mode */
265 ret
= stat(path_trace
, &stat_buf
);
268 printf("Appending to file %s as requested\n", path_trace
);
270 fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
=
271 open(path_trace
, O_WRONLY
|O_APPEND
,
272 S_IRWXU
|S_IRWXG
|S_IRWXO
);
274 if(fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
== -1) {
278 printf("File %s exists, cannot open. Try append mode.\n", path_trace
);
282 if(errno
== ENOENT
) {
283 fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
=
284 open(path_trace
, O_WRONLY
|O_CREAT
|O_EXCL
,
285 S_IRWXU
|S_IRWXG
|S_IRWXO
);
286 if(fd_pairs
->pair
[fd_pairs
->num_pairs
-1].trace
== -1) {
294 closedir(channel_dir
);
300 int read_subbuffer(struct fd_pair
*pair
)
302 unsigned int subbuf_index
;
306 err
= ioctl(pair
->channel
, RELAYFS_GET_SUBBUF
,
308 printf("index : %u\n", subbuf_index
);
310 perror("Error in reserving sub buffer");
315 err
= TEMP_FAILURE_RETRY(write(pair
->trace
,
316 pair
->mmap
+ (subbuf_index
* pair
->subbuf_size
),
320 perror("Error in writing to file");
327 err
= ioctl(pair
->channel
, RELAYFS_PUT_SUBBUF
);
329 perror("Error in unreserving sub buffer");
341 * Read the realyfs channels and write them in the paired tracefiles.
343 * @fd_pairs : paired channels and trace files.
345 * returns 0 on success, -1 on error.
347 * Note that the high priority polled channels are consumed first. We then poll
348 * again to see if these channels are still in priority. Only when no
349 * high priority channel is left, we start reading low priority channels.
351 * Note that a channel is considered high priority when the buffer is almost
355 int read_channels(struct channel_trace_fd
*fd_pairs
)
357 struct pollfd
*pollfd
;
359 int num_rdy
, num_hup
;
363 if(fd_pairs
->num_pairs
<= 0) {
364 printf("No channel to read\n");
368 /* Get the subbuf sizes and number */
370 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
371 struct fd_pair
*pair
= &fd_pairs
->pair
[i
];
373 ret
= ioctl(pair
->channel
, RELAYFS_GET_N_SUBBUFS
,
376 perror("Error in getting the number of subbuffers");
379 ret
= ioctl(pair
->channel
, RELAYFS_GET_SUBBUF_SIZE
,
382 perror("Error in getting the size of the subbuffers");
388 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
389 struct fd_pair
*pair
= &fd_pairs
->pair
[i
];
391 pair
->mmap
= mmap(0, pair
->subbuf_size
* pair
->n_subbufs
, PROT_READ
,
392 MAP_SHARED
, pair
->channel
, 0);
393 if(pair
->mmap
== MAP_FAILED
) {
394 perror("Mmap error");
400 /* Start polling the FD */
402 pollfd
= malloc(fd_pairs
->num_pairs
* sizeof(struct pollfd
));
404 /* Note : index in pollfd is the same index as fd_pair->pair */
405 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
406 pollfd
[i
].fd
= fd_pairs
->pair
[i
].channel
;
407 pollfd
[i
].events
= POLLIN
|POLLPRI
;
410 /* Signal the parent that ready for IO */
411 if(sig_parent
) kill(getppid(), SIGIO
);
417 printf("Press a key for next poll...\n");
419 read(STDIN_FILENO
, &buf
, 1);
420 printf("Next poll (polling %d fd) :\n", fd_pairs
->num_pairs
);
423 /* Have we received a signal ? */
424 if(quit_program
) break;
426 num_rdy
= poll(pollfd
, fd_pairs
->num_pairs
, -1);
428 perror("Poll error");
432 printf("Data received\n");
434 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
435 switch(pollfd
[i
].revents
) {
437 printf("Error returned in polling fd %d.\n", pollfd
[i
].fd
);
441 printf("Polling fd %d tells it has hung up.\n", pollfd
[i
].fd
);
445 printf("Polling fd %d tells fd is not open.\n", pollfd
[i
].fd
);
449 printf("Urgent read on fd %d\n", pollfd
[i
].fd
);
450 /* Take care of high priority channels first. */
452 ret
|= read_subbuffer(&fd_pairs
->pair
[i
]);
456 /* If every FD has hung up, we end the read loop here */
457 if(num_hup
== fd_pairs
->num_pairs
) break;
460 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
461 switch(pollfd
[i
].revents
) {
463 /* Take care of low priority channels. */
464 printf("Normal read on fd %d\n", pollfd
[i
].fd
);
465 ret
|= read_subbuffer(&fd_pairs
->pair
[i
]);
476 /* munmap only the successfully mmapped indexes */
477 i
= fd_pairs
->num_pairs
;
481 struct fd_pair
*pair
= &fd_pairs
->pair
[j
];
484 err_ret
= munmap(pair
->mmap
, pair
->subbuf_size
* pair
->n_subbufs
);
486 perror("Error in munmap");
496 void close_channel_trace_pairs(struct channel_trace_fd
*fd_pairs
)
501 for(i
=0;i
<fd_pairs
->num_pairs
;i
++) {
502 ret
= close(fd_pairs
->pair
[i
].channel
);
503 if(ret
== -1) perror("Close error on channel");
504 ret
= close(fd_pairs
->pair
[i
].trace
);
505 if(ret
== -1) perror("Close error on trace");
507 free(fd_pairs
->pair
);
510 int main(int argc
, char ** argv
)
514 struct channel_trace_fd fd_pairs
= { NULL
, 0 };
515 struct sigaction act
;
517 ret
= parse_arguments(argc
, argv
);
519 if(ret
!= 0) show_arguments();
520 if(ret
< 0) return EINVAL
;
521 if(ret
> 0) return 0;
533 printf("An error occured while forking.\n");
536 /* else, we are the child, continue... */
539 /* Connect the signal handlers */
540 act
.sa_handler
= handler
;
542 sigemptyset(&(act
.sa_mask
));
543 sigaddset(&(act
.sa_mask
), SIGTERM
);
544 sigaddset(&(act
.sa_mask
), SIGQUIT
);
545 sigaddset(&(act
.sa_mask
), SIGINT
);
546 sigaction(SIGTERM
, &act
, NULL
);
547 sigaction(SIGQUIT
, &act
, NULL
);
548 sigaction(SIGINT
, &act
, NULL
);
551 if(ret
= open_channel_trace_pairs(channel_name
, trace_name
, &fd_pairs
))
554 ret
= read_channels(&fd_pairs
);
557 close_channel_trace_pairs(&fd_pairs
);