2cdb6fcb |
1 | /* lttctl |
2 | * |
3 | * Linux Trace Toolkit Control |
4 | * |
5 | * Small program that controls LTT through libltt. |
6 | * |
7 | * Copyright 2005 - |
8 | * Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca> |
9 | */ |
10 | |
4e4d11b3 |
11 | #ifdef HAVE_CONFIG_H |
12 | #include <config.h> |
13 | #endif |
14 | |
5adba60f |
15 | #include <libltt/libltt.h> |
16 | #include <errno.h> |
17 | #include <stdio.h> |
18 | #include <stdlib.h> |
19 | #include <sys/types.h> |
20 | #include <unistd.h> |
21 | #include <signal.h> |
d5fbdb60 |
22 | #include <dirent.h> |
23 | #include <string.h> |
24 | #include <sys/stat.h> |
25 | |
26 | /* Buffer for file copy : 4k seems optimal. */ |
27 | #define BUF_SIZE 4194304 |
2cdb6fcb |
28 | |
5adba60f |
29 | enum trace_ctl_op { |
b7f08766 |
30 | CTL_OP_CREATE_START, |
5adba60f |
31 | CTL_OP_CREATE, |
32 | CTL_OP_DESTROY, |
b7f08766 |
33 | CTL_OP_STOP_DESTROY, |
5adba60f |
34 | CTL_OP_START, |
35 | CTL_OP_STOP, |
36 | CTL_OP_DAEMON, |
129fd24a |
37 | CTL_OP_DESCRIPTION, |
5adba60f |
38 | CTL_OP_NONE |
39 | }; |
2cdb6fcb |
40 | |
5adba60f |
41 | static char *trace_name = NULL; |
42 | static char *mode_name = NULL; |
988614ed |
43 | static unsigned subbuf_size = 0; |
44 | static unsigned n_subbufs = 0; |
5adba60f |
45 | static enum trace_mode mode = LTT_TRACE_NORMAL; |
46 | static enum trace_ctl_op op = CTL_OP_NONE; |
47 | static char *channel_root = NULL; |
48 | static char *trace_root = NULL; |
49 | |
ada84671 |
50 | static int sigio_received = 0; |
51 | |
5adba60f |
52 | void handler(int signo) |
53 | { |
54 | printf("signal %d received\n", signo); |
ada84671 |
55 | sigio_received = 1; |
5adba60f |
56 | } |
57 | |
58 | |
59 | /* Args : |
60 | * |
61 | */ |
62 | void show_arguments(void) |
63 | { |
64 | printf("Please use the following arguments :\n"); |
65 | printf("\n"); |
66 | printf("-n name Name of the trace.\n"); |
b7f08766 |
67 | printf("-b Create trace channels and start tracing (no daemon).\n"); |
bc0fcb31 |
68 | printf("-c Create trace channels.\n"); |
69 | printf("-m mode Normal or flight recorder mode.\n"); |
5adba60f |
70 | printf(" Mode values : normal (default) or flight.\n"); |
71 | printf("-r Destroy trace channels.\n"); |
b7f08766 |
72 | printf("-R Stop tracing and destroy trace channels.\n"); |
5adba60f |
73 | printf("-s Start tracing.\n"); |
74 | //printf(" Note : will automatically create a normal trace if " |
75 | // "none exists.\n"); |
76 | printf("-q Stop tracing.\n"); |
77 | printf("-d Create trace, spawn a lttd daemon, start tracing.\n"); |
d5fbdb60 |
78 | printf(" (optionnaly, you can set LTT_DAEMON\n"); |
79 | printf(" and the LTT_FACILITIES env. vars.)\n"); |
5adba60f |
80 | printf("-t Trace root path. (ex. /root/traces/example_trace)\n"); |
81 | printf("-l LTT channels root path. (ex. /mnt/relayfs/ltt)\n"); |
4085af66 |
82 | printf("-z Size of the subbuffers (will be rounded to next page size)\n"); |
988614ed |
83 | printf("-x Number of subbuffers\n"); |
129fd24a |
84 | printf("-e Get XML facilities description\n"); |
5adba60f |
85 | printf("\n"); |
86 | } |
87 | |
88 | |
89 | /* parse_arguments |
90 | * |
91 | * Parses the command line arguments. |
92 | * |
93 | * Returns 1 if the arguments were correct, but doesn't ask for program |
94 | * continuation. Returns -1 if the arguments are incorrect, or 0 if OK. |
95 | */ |
96 | int parse_arguments(int argc, char **argv) |
97 | { |
98 | int ret = 0; |
99 | int argn = 1; |
100 | |
101 | if(argc == 2) { |
102 | if(strcmp(argv[1], "-h") == 0) { |
103 | return 1; |
104 | } |
105 | } |
106 | |
107 | while(argn < argc) { |
108 | |
109 | switch(argv[argn][0]) { |
110 | case '-': |
111 | switch(argv[argn][1]) { |
112 | case 'n': |
113 | if(argn+1 < argc) { |
114 | trace_name = argv[argn+1]; |
115 | argn++; |
116 | } else { |
117 | printf("Specify a trace name after -n.\n", argv[argn]); |
118 | printf("\n"); |
119 | ret = -1; |
120 | } |
121 | |
122 | break; |
b7f08766 |
123 | case 'b': |
124 | op = CTL_OP_CREATE_START; |
5adba60f |
125 | case 'c': |
126 | op = CTL_OP_CREATE; |
bc0fcb31 |
127 | break; |
128 | case 'm': |
5adba60f |
129 | if(argn+1 < argc) { |
130 | mode_name = argv[argn+1]; |
131 | argn++; |
132 | if(strcmp(mode_name, "normal") == 0) |
133 | mode = LTT_TRACE_NORMAL; |
134 | else if(strcmp(mode_name, "flight") == 0) |
135 | mode = LTT_TRACE_FLIGHT; |
136 | else { |
137 | printf("Invalid mode '%s'.\n", argv[argn]); |
138 | printf("\n"); |
139 | ret = -1; |
140 | } |
141 | } else { |
bc0fcb31 |
142 | printf("Specify a mode after -m.\n"); |
5adba60f |
143 | printf("\n"); |
144 | ret = -1; |
145 | } |
146 | break; |
147 | case 'r': |
148 | op = CTL_OP_DESTROY; |
149 | break; |
b7f08766 |
150 | case 'R': |
151 | op = CTL_OP_STOP_DESTROY; |
152 | break; |
5adba60f |
153 | case 's': |
154 | op = CTL_OP_START; |
155 | break; |
156 | case 'q': |
157 | op = CTL_OP_STOP; |
158 | break; |
988614ed |
159 | case 'z': |
160 | if(argn+1 < argc) { |
161 | subbuf_size = (unsigned)atoi(argv[argn+1]); |
162 | argn++; |
163 | } else { |
164 | printf("Specify a number of subbuffers after -z.\n"); |
165 | printf("\n"); |
166 | ret = -1; |
167 | } |
168 | break; |
169 | case 'x': |
170 | if(argn+1 < argc) { |
171 | n_subbufs = (unsigned)atoi(argv[argn+1]); |
172 | argn++; |
173 | } else { |
174 | printf("Specify a subbuffer size after -x.\n"); |
175 | printf("\n"); |
176 | ret = -1; |
177 | } |
178 | break; |
5adba60f |
179 | case 'd': |
180 | op = CTL_OP_DAEMON; |
181 | break; |
129fd24a |
182 | case 'e': |
183 | op = CTL_OP_DESCRIPTION; |
184 | break; |
5adba60f |
185 | case 't': |
186 | if(argn+1 < argc) { |
187 | trace_root = argv[argn+1]; |
188 | argn++; |
189 | } else { |
988614ed |
190 | printf("Specify a trace root path after -t.\n"); |
5adba60f |
191 | printf("\n"); |
192 | ret = -1; |
193 | } |
194 | break; |
195 | case 'l': |
196 | if(argn+1 < argc) { |
197 | channel_root = argv[argn+1]; |
198 | argn++; |
199 | } else { |
988614ed |
200 | printf("Specify a channel root path after -l.\n"); |
5adba60f |
201 | printf("\n"); |
202 | ret = -1; |
203 | } |
204 | break; |
205 | default: |
206 | printf("Invalid argument '%s'.\n", argv[argn]); |
207 | printf("\n"); |
208 | ret = -1; |
209 | } |
210 | break; |
211 | default: |
212 | printf("Invalid argument '%s'.\n", argv[argn]); |
213 | printf("\n"); |
214 | ret = -1; |
215 | } |
216 | argn++; |
217 | } |
218 | |
129fd24a |
219 | if(op != CTL_OP_DESCRIPTION && trace_name == NULL) { |
5adba60f |
220 | printf("Please specify a trace name.\n"); |
221 | printf("\n"); |
222 | ret = -1; |
223 | } |
224 | |
225 | if(op == CTL_OP_NONE) { |
226 | printf("Please specify an operation.\n"); |
227 | printf("\n"); |
228 | ret = -1; |
229 | } |
230 | |
231 | if(op == CTL_OP_DAEMON) { |
232 | if(trace_root == NULL) { |
233 | printf("Please specify -t trace_root_path with the -d option.\n"); |
234 | printf("\n"); |
235 | ret = -1; |
236 | } |
237 | if(channel_root == NULL) { |
238 | printf("Please specify -l ltt_root_path with the -d option.\n"); |
239 | printf("\n"); |
240 | ret = -1; |
241 | } |
242 | } |
243 | |
129fd24a |
244 | if(op == CTL_OP_DESCRIPTION) { |
245 | if(trace_root == NULL) { |
246 | printf("Please specify -t trace_root_path with the -e option.\n"); |
247 | printf("\n"); |
248 | ret = -1; |
249 | } |
250 | } |
251 | |
5adba60f |
252 | return ret; |
253 | } |
254 | |
255 | void show_info(void) |
256 | { |
257 | printf("Linux Trace Toolkit Trace Control\n"); |
258 | printf("\n"); |
129fd24a |
259 | if(trace_name != NULL) { |
260 | printf("Controlling trace : %s\n", trace_name); |
261 | printf("\n"); |
262 | } |
263 | } |
264 | |
265 | int create_eventdefs(void) |
266 | { |
267 | int ret = 0; |
268 | char eventdefs_path[PATH_MAX]; |
269 | char eventdefs_file[PATH_MAX]; |
270 | char facilities_file[PATH_MAX]; |
271 | char read_buf[BUF_SIZE]; |
272 | struct dirent *entry; |
273 | char *facilities_path = getenv("LTT_FACILITIES"); |
274 | if(facilities_path == NULL) facilities_path = |
275 | "/usr/share/LinuxTraceToolkitViewer/facilities"; |
276 | |
277 | ret = mkdir(trace_root, S_IRWXU|S_IRWXG|S_IRWXO); |
278 | if(ret == -1 && errno != EEXIST) { |
279 | perror("Cannot create trace_root directory"); |
280 | printf("trace_root is %s\n", trace_root); |
281 | goto error; |
282 | } |
bd55296c |
283 | ret = 0; |
129fd24a |
284 | |
285 | size_t trace_root_len = strlen(trace_root); |
286 | strncpy(eventdefs_path, trace_root, PATH_MAX); |
287 | strncat(eventdefs_path, "/eventdefs/", PATH_MAX - trace_root_len); |
288 | size_t eventdefs_path_len = strlen(eventdefs_path); |
289 | ret = mkdir(eventdefs_path, S_IRWXU|S_IRWXG|S_IRWXO); |
290 | if(ret == -1 && errno != EEXIST) { |
291 | perror("Cannot create eventdefs directory"); |
292 | goto error; |
293 | } |
bd55296c |
294 | ret = 0; |
129fd24a |
295 | |
296 | DIR *facilities_dir = opendir(facilities_path); |
297 | |
298 | while((entry = readdir(facilities_dir)) != NULL) { |
299 | if(entry->d_name[0] == '.') continue; |
300 | |
301 | printf("Appending facility file %s\n", entry->d_name); |
302 | strncpy(eventdefs_file, eventdefs_path, PATH_MAX); |
303 | strncat(eventdefs_file, entry->d_name, PATH_MAX - eventdefs_path_len); |
304 | /* Append to the file */ |
305 | FILE *dest = fopen(eventdefs_file, "a"); |
306 | if(!dest) { |
307 | perror("Cannot create eventdefs file"); |
308 | continue; |
309 | } |
310 | strncpy(facilities_file, facilities_path, PATH_MAX); |
311 | size_t facilities_dir_len = strlen(facilities_path); |
312 | strncat(facilities_file, "/", PATH_MAX - facilities_dir_len); |
313 | strncat(facilities_file, entry->d_name, PATH_MAX - facilities_dir_len-1); |
314 | FILE *src = fopen(facilities_file, "r"); |
315 | if(!src) { |
316 | perror("Cannot open eventdefs file for reading"); |
317 | goto close_dest; |
318 | } |
319 | |
320 | do { |
321 | size_t read_size, write_size; |
322 | read_size = fread(read_buf, sizeof(char), BUF_SIZE, src); |
323 | if(ferror(src)) { |
324 | perror("Cannot read eventdefs file"); |
325 | goto close_src; |
326 | } |
327 | write_size = fwrite(read_buf, sizeof(char), read_size, dest); |
328 | if(ferror(dest)) { |
329 | perror("Cannot write eventdefs file"); |
330 | goto close_src; |
331 | } |
332 | } while(!feof(src)); |
333 | |
334 | /* Add spacing between facilities */ |
335 | fwrite("\n", 1, 1, dest); |
336 | |
337 | close_src: |
338 | fclose(src); |
339 | close_dest: |
340 | fclose(dest); |
341 | } |
342 | |
343 | closedir(facilities_dir); |
344 | |
345 | error: |
346 | return ret; |
347 | |
5adba60f |
348 | } |
349 | |
129fd24a |
350 | |
5adba60f |
351 | int lttctl_daemon(struct lttctl_handle *handle, char *trace_name) |
352 | { |
353 | char channel_path[PATH_MAX] = ""; |
354 | pid_t pid; |
355 | int ret; |
356 | char *lttd_path = getenv("LTT_DAEMON"); |
357 | struct sigaction act; |
358 | |
359 | if(lttd_path == NULL) lttd_path = "lttd"; |
360 | |
361 | strcat(channel_path, channel_root); |
362 | strcat(channel_path, "/"); |
363 | strcat(channel_path, trace_name); |
364 | |
365 | |
988614ed |
366 | ret = lttctl_create_trace(handle, trace_name, mode, subbuf_size, n_subbufs); |
5adba60f |
367 | if(ret != 0) goto create_error; |
368 | |
369 | act.sa_handler = handler; |
370 | sigemptyset(&(act.sa_mask)); |
371 | sigaddset(&(act.sa_mask), SIGIO); |
372 | sigaction(SIGIO, &act, NULL); |
373 | |
ada84671 |
374 | sigio_received = 0; |
375 | |
5adba60f |
376 | pid = fork(); |
377 | |
378 | if(pid > 0) { |
5adba60f |
379 | /* parent */ |
ada84671 |
380 | while(!sigio_received) pause(); |
5adba60f |
381 | |
382 | /* Now the trace is created, go on and create the supplementary files... */ |
d5fbdb60 |
383 | |
5adba60f |
384 | printf("Creating supplementary trace files\n"); |
129fd24a |
385 | ret = create_eventdefs(); |
386 | if(ret) goto start_error; |
5adba60f |
387 | |
388 | } else if(pid == 0) { |
389 | /* child */ |
390 | int ret = |
391 | execlp(lttd_path, lttd_path, "-t", trace_root, "-c", channel_path, "-s", NULL); |
392 | if(ret) { |
393 | perror("Error in executing the lttd daemon"); |
394 | exit(-1); |
395 | } |
396 | } else { |
397 | /* error */ |
398 | perror("Error in forking for lttd daemon"); |
399 | |
400 | } |
401 | |
402 | ret = lttctl_start(handle, trace_name); |
403 | if(ret != 0) goto start_error; |
404 | |
405 | return 0; |
406 | |
407 | /* error handling */ |
408 | start_error: |
409 | ret |= lttctl_destroy_trace(handle, trace_name); |
410 | create_error: |
411 | return ret; |
412 | } |
413 | |
414 | int main(int argc, char ** argv) |
415 | { |
416 | int ret; |
417 | struct lttctl_handle *handle; |
418 | |
419 | ret = parse_arguments(argc, argv); |
420 | |
421 | if(ret != 0) show_arguments(); |
422 | if(ret < 0) return EINVAL; |
423 | if(ret > 0) return 0; |
424 | |
425 | show_info(); |
426 | |
427 | handle = lttctl_create_handle(); |
428 | |
429 | if(handle == NULL) return -1; |
430 | |
431 | switch(op) { |
b7f08766 |
432 | case CTL_OP_CREATE_START: |
433 | ret = lttctl_create_trace(handle, trace_name, mode, subbuf_size, |
434 | n_subbufs); |
435 | if(!ret) |
436 | ret = lttctl_start(handle, trace_name); |
437 | break; |
5adba60f |
438 | case CTL_OP_CREATE: |
988614ed |
439 | ret = lttctl_create_trace(handle, trace_name, mode, subbuf_size, |
440 | n_subbufs); |
24ba6df0 |
441 | break; |
5adba60f |
442 | case CTL_OP_DESTROY: |
443 | ret = lttctl_destroy_trace(handle, trace_name); |
444 | break; |
b7f08766 |
445 | case CTL_OP_STOP_DESTROY: |
446 | ret = lttctl_stop(handle, trace_name); |
447 | if(!ret) |
448 | ret = lttctl_destroy_trace(handle, trace_name); |
449 | break; |
5adba60f |
450 | case CTL_OP_START: |
451 | ret = lttctl_start(handle, trace_name); |
452 | break; |
453 | case CTL_OP_STOP: |
454 | ret = lttctl_stop(handle, trace_name); |
455 | break; |
456 | case CTL_OP_DAEMON: |
457 | ret = lttctl_daemon(handle, trace_name); |
458 | break; |
129fd24a |
459 | case CTL_OP_DESCRIPTION: |
460 | ret = create_eventdefs(); |
461 | break; |
5adba60f |
462 | case CTL_OP_NONE: |
463 | break; |
464 | } |
465 | |
466 | ret |= lttctl_destroy_handle(handle); |
467 | |
468 | return ret; |
469 | } |