2 * Copyright (C) 2011-2012 Julien Desfossez
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License Version 2 as
6 * published by the Free Software Foundation;
8 * This program 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
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <babeltrace/babeltrace.h>
23 #include <babeltrace/ctf/events.h>
24 #include <babeltrace/ctf/callbacks.h>
25 #include <babeltrace/ctf/iterator.h>
37 #include <sys/types.h>
41 #include "lttngtoptypes.h"
43 #include "iostreamtop.h"
44 #include "cursesdisplay.h"
47 #define DEFAULT_FILE_ARRAY_SIZE 1
49 const char *opt_input_path
;
51 struct lttngtop
*copy
;
52 pthread_t display_thread
;
53 pthread_t timer_thread
;
55 unsigned long refresh_display
= 1 * NSEC_PER_SEC
;
56 unsigned long last_display_update
= 0;
68 static struct poptOption long_options
[] = {
69 /* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
70 { "help", 'h', POPT_ARG_NONE
, NULL
, OPT_HELP
, NULL
, NULL
},
71 { NULL
, 0, 0, NULL
, 0, NULL
, NULL
},
74 void *refresh_thread(void *p
)
82 sleep(refresh_display
/NSEC_PER_SEC
);
86 void *ncurses_display(void *p
)
88 unsigned int current_display_index
= 0;
92 * Prevent the 1 second delay when we hit ESC
99 sem_wait(&goodtodisplay
);
100 sem_wait(&pause_sem
);
102 copy
= g_ptr_array_index(copies
, current_display_index
);
104 display(current_display_index
++);
106 sem_post(&goodtoupdate
);
107 sem_post(&pause_sem
);
117 * hook on each event to check the timestamp and refresh the display if
120 enum bt_cb_ret
check_timestamp(struct bt_ctf_event
*call_data
, void *private_data
)
122 unsigned long timestamp
;
124 timestamp
= bt_ctf_get_timestamp(call_data
);
125 if (timestamp
== -1ULL)
128 if (last_display_update
== 0)
129 last_display_update
= timestamp
;
131 if (timestamp
- last_display_update
>= refresh_display
) {
132 sem_wait(&goodtoupdate
);
133 g_ptr_array_add(copies
, get_copy_lttngtop(last_display_update
,
135 sem_post(&goodtodisplay
);
136 sem_post(&bootstrap
);
137 last_display_update
= timestamp
;
142 fprintf(stderr
, "check_timestamp callback error\n");
143 return BT_CB_ERROR_STOP
;
147 * get_perf_counter : get or create and return a perf_counter struct for
148 * either a process or a cpu (only one of the 2 parameters mandatory)
150 struct perfcounter
*get_perf_counter(const char *name
, struct processtop
*proc
,
153 struct perfcounter
*ret
;
163 ret
= g_hash_table_lookup(table
, (gpointer
) name
);
167 ret
= g_new0(struct perfcounter
, 1);
168 /* by default, make it visible in the UI */
170 g_hash_table_insert(table
, (gpointer
) strdup(name
), ret
);
179 void update_perf_value(struct processtop
*proc
, struct cputime
*cpu
,
180 const char *name
, int value
)
182 struct perfcounter
*cpu_perf
, *process_perf
;
184 cpu_perf
= get_perf_counter(name
, NULL
, cpu
);
185 if (cpu_perf
->count
< value
) {
186 process_perf
= get_perf_counter(name
, proc
, NULL
);
187 process_perf
->count
+= value
- cpu_perf
->count
;
188 cpu_perf
->count
= value
;
192 void extract_perf_counter_scope(const struct bt_ctf_event
*event
,
193 const struct bt_definition
*scope
,
194 struct processtop
*proc
,
197 struct bt_definition
const * const *list
= NULL
;
198 const struct bt_definition
*field
;
200 struct perfcounter
*perfcounter
;
208 ret
= bt_ctf_get_field_list(event
, scope
, &list
, &count
);
215 g_hash_table_iter_init(&iter
, global_perf_liszt
);
216 while (g_hash_table_iter_next (&iter
, &key
, (gpointer
) &perfcounter
)) {
217 field
= bt_ctf_get_field(event
, scope
, (char *) key
);
219 int value
= bt_ctf_get_uint64(field
);
220 if (bt_ctf_field_get_error())
222 update_perf_value(proc
, cpu
, (char *) key
, value
);
230 void update_perf_counter(struct processtop
*proc
, const struct bt_ctf_event
*event
)
233 const struct bt_definition
*scope
;
235 cpu
= get_cpu(get_cpu_id(event
));
237 scope
= bt_ctf_get_top_level_scope(event
, BT_STREAM_EVENT_CONTEXT
);
238 extract_perf_counter_scope(event
, scope
, proc
, cpu
);
240 scope
= bt_ctf_get_top_level_scope(event
, BT_STREAM_PACKET_CONTEXT
);
241 extract_perf_counter_scope(event
, scope
, proc
, cpu
);
243 scope
= bt_ctf_get_top_level_scope(event
, BT_EVENT_CONTEXT
);
244 extract_perf_counter_scope(event
, scope
, proc
, cpu
);
247 enum bt_cb_ret
fix_process_table(struct bt_ctf_event
*call_data
,
252 struct processtop
*parent
, *child
;
253 unsigned long timestamp
;
255 timestamp
= bt_ctf_get_timestamp(call_data
);
256 if (timestamp
== -1ULL)
259 pid
= get_context_pid(call_data
);
263 tid
= get_context_tid(call_data
);
267 ppid
= get_context_ppid(call_data
);
271 comm
= get_context_comm(call_data
);
276 /* find or create the current process */
277 child
= find_process_tid(<tngtop
, tid
, comm
);
279 child
= add_proc(<tngtop
, tid
, comm
, timestamp
);
280 update_proc(child
, pid
, tid
, ppid
, comm
);
283 /* find or create the parent */
284 parent
= find_process_tid(<tngtop
, pid
, comm
);
286 parent
= add_proc(<tngtop
, pid
, comm
, timestamp
);
290 /* attach the parent to the current process */
291 child
->threadparent
= parent
;
292 add_thread(parent
, child
);
295 update_perf_counter(child
, call_data
);
300 return BT_CB_ERROR_STOP
;
305 copies
= g_ptr_array_new();
306 global_perf_liszt
= g_hash_table_new(g_str_hash
, g_str_equal
);
308 sem_init(&goodtodisplay
, 0, 0);
309 sem_init(&goodtoupdate
, 0, 1);
310 sem_init(&timer
, 0, 1);
311 sem_init(&bootstrap
, 0, 0);
312 sem_init(&pause_sem
, 0, 1);
313 sem_init(&end_trace_sem
, 0, 0);
315 reset_global_counters();
317 lttngtop
.nbthreads
= 0;
318 lttngtop
.nbfiles
= 0;
320 lttngtop
.process_table
= g_ptr_array_new();
321 lttngtop
.files_table
= g_ptr_array_new();
322 lttngtop
.cpu_table
= g_ptr_array_new();
327 fprintf(fp
, "LTTngTop %s\n\n", VERSION
);
328 fprintf(fp
, "Usage : lttngtop /path/to/trace\n");
332 * Return 0 if caller should continue, < 0 if caller should return
333 * error, > 0 if caller should exit without reporting error.
335 static int parse_options(int argc
, char **argv
)
342 return 1; /* exit cleanly */
345 pc
= poptGetContext(NULL
, argc
, (const char **) argv
, long_options
, 0);
346 poptReadDefaultConfig(pc
, 0);
348 while ((opt
= poptGetNextOpt(pc
)) != -1) {
352 ret
= 1; /* exit cleanly */
360 opt_input_path
= poptGetArg(pc
);
361 if (!opt_input_path
) {
372 void iter_trace(struct bt_context
*bt_ctx
)
374 struct bt_ctf_iter
*iter
;
375 struct bt_iter_pos begin_pos
;
376 const struct bt_ctf_event
*event
;
379 begin_pos
.type
= BT_SEEK_BEGIN
;
380 iter
= bt_ctf_iter_create(bt_ctx
, &begin_pos
, NULL
);
382 /* at each event check if we need to refresh */
383 bt_ctf_iter_add_callback(iter
, 0, NULL
, 0,
386 /* at each event, verify the status of the process table */
387 bt_ctf_iter_add_callback(iter
, 0, NULL
, 0,
390 /* to handle the scheduling events */
391 bt_ctf_iter_add_callback(iter
,
392 g_quark_from_static_string("sched_switch"),
393 NULL
, 0, handle_sched_switch
, NULL
, NULL
, NULL
);
394 /* to clean up the process table */
395 bt_ctf_iter_add_callback(iter
,
396 g_quark_from_static_string("sched_process_free"),
397 NULL
, 0, handle_sched_process_free
, NULL
, NULL
, NULL
);
398 /* to get all the process from the statedumps */
399 bt_ctf_iter_add_callback(iter
,
400 g_quark_from_static_string(
401 "lttng_statedump_process_state"),
402 NULL
, 0, handle_statedump_process_state
,
406 bt_ctf_iter_add_callback(iter
,
407 g_quark_from_static_string("exit_syscall"),
408 NULL
, 0, handle_exit_syscall
, NULL
, NULL
, NULL
);
409 bt_ctf_iter_add_callback(iter
,
410 g_quark_from_static_string("sys_write"),
411 NULL
, 0, handle_sys_write
, NULL
, NULL
, NULL
);
412 bt_ctf_iter_add_callback(iter
,
413 g_quark_from_static_string("sys_read"),
414 NULL
, 0, handle_sys_read
, NULL
, NULL
, NULL
);
415 bt_ctf_iter_add_callback(iter
,
416 g_quark_from_static_string("sys_open"),
417 NULL
, 0, handle_sys_open
, NULL
, NULL
, NULL
);
418 bt_ctf_iter_add_callback(iter
,
419 g_quark_from_static_string("sys_close"),
420 NULL
, 0, handle_sys_close
, NULL
, NULL
, NULL
);
421 bt_ctf_iter_add_callback(iter
,
422 g_quark_from_static_string(
423 "lttng_statedump_file_descriptor"),
424 NULL
, 0, handle_statedump_file_descriptor
,
427 while ((event
= bt_ctf_iter_read_event(iter
)) != NULL
) {
428 ret
= bt_iter_next(bt_ctf_get_iter(iter
));
433 /* block until quit, we reached the end of the trace */
434 sem_wait(&end_trace_sem
);
437 bt_ctf_iter_destroy(iter
);
441 * bt_context_add_traces_recursive: Open a trace recursively
442 * (copied from BSD code in converter/babeltrace.c)
444 * Find each trace present in the subdirectory starting from the given
445 * path, and add them to the context. The packet_seek parameter can be
446 * NULL: this specify to use the default format packet_seek.
448 * Return: 0 on success, nonzero on failure.
449 * Unable to open toplevel: failure.
450 * Unable to open some subdirectory or file: warn and continue;
452 int bt_context_add_traces_recursive(struct bt_context
*ctx
, const char *path
,
453 const char *format_str
,
454 void (*packet_seek
)(struct bt_stream_pos
*pos
,
455 size_t offset
, int whence
))
460 char lpath
[PATH_MAX
];
461 char * const paths
[2] = { lpath
, NULL
};
465 * Need to copy path, because fts_open can change it.
466 * It is the pointer array, not the strings, that are constant.
468 strncpy(lpath
, path
, PATH_MAX
);
469 lpath
[PATH_MAX
- 1] = '\0';
471 tree
= fts_open(paths
, FTS_NOCHDIR
| FTS_LOGICAL
, 0);
473 fprintf(stderr
, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
478 trace_ids
= g_array_new(FALSE
, TRUE
, sizeof(int));
480 while ((node
= fts_read(tree
))) {
483 if (!(node
->fts_info
& FTS_D
))
486 dirfd
= open(node
->fts_accpath
, 0);
488 fprintf(stderr
, "[error] [Context] Unable to open trace "
489 "directory file descriptor.\n");
493 metafd
= openat(dirfd
, "metadata", O_RDONLY
);
512 trace_id
= bt_context_add_trace(ctx
,
513 node
->fts_accpath
, format_str
,
514 packet_seek
, NULL
, NULL
);
516 fprintf(stderr
, "[warning] [Context] opening trace \"%s\" from %s "
517 "for reading.\n", node
->fts_accpath
, path
);
518 /* Allow to skip erroneous traces. */
521 g_array_append_val(trace_ids
, trace_id
);
525 g_array_free(trace_ids
, TRUE
);
532 static int check_field_requirements(const struct bt_ctf_field_decl
*const * field_list
,
533 int field_cnt
, int *tid_check
, int *pid_check
,
534 int *procname_check
, int *ppid_check
)
537 struct perfcounter
*global
;
540 for (j
= 0; j
< field_cnt
; j
++) {
541 name
= bt_ctf_get_decl_field_name(field_list
[j
]);
542 if (*tid_check
== 0) {
543 if (strncmp(name
, "tid", 3) == 0)
546 if (*pid_check
== 0) {
547 if (strncmp(name
, "pid", 3) == 0)
550 if (*ppid_check
== 0) {
551 if (strncmp(name
, "ppid", 4) == 0)
554 if (*procname_check
== 0) {
555 if (strncmp(name
, "procname", 8) == 0)
558 if (strncmp(name
, "perf_", 5) == 0) {
559 global
= g_hash_table_lookup(global_perf_liszt
, (gpointer
) name
);
561 global
= g_new0(struct perfcounter
, 1);
562 /* by default, sort on the first perf context */
563 if (g_hash_table_size(global_perf_liszt
) == 0)
566 g_hash_table_insert(global_perf_liszt
, (gpointer
) strdup(name
), global
);
571 if (*tid_check
== 1 && *pid_check
== 1 && *ppid_check
== 1 &&
572 *procname_check
== 1)
579 * check_requirements: check if the required context informations are available
581 * If each mandatory context information is available for at least in one
582 * event, return 0 otherwise return -1.
584 int check_requirements(struct bt_context
*ctx
)
586 unsigned int i
, evt_cnt
, field_cnt
;
587 struct bt_ctf_event_decl
*const * evt_list
;
588 const struct bt_ctf_field_decl
*const * field_list
;
591 int procname_check
= 0;
595 bt_ctf_get_event_decl_list(0, ctx
, &evt_list
, &evt_cnt
);
596 for (i
= 0; i
< evt_cnt
; i
++) {
597 bt_ctf_get_decl_fields(evt_list
[i
], BT_STREAM_EVENT_CONTEXT
,
598 &field_list
, &field_cnt
);
599 ret
= check_field_requirements(field_list
, field_cnt
,
600 &tid_check
, &pid_check
, &procname_check
,
603 bt_ctf_get_decl_fields(evt_list
[i
], BT_EVENT_CONTEXT
,
604 &field_list
, &field_cnt
);
605 ret
= check_field_requirements(field_list
, field_cnt
,
606 &tid_check
, &pid_check
, &procname_check
,
609 bt_ctf_get_decl_fields(evt_list
[i
], BT_STREAM_PACKET_CONTEXT
,
610 &field_list
, &field_cnt
);
611 ret
= check_field_requirements(field_list
, field_cnt
,
612 &tid_check
, &pid_check
, &procname_check
,
616 if (tid_check
== 0) {
618 fprintf(stderr
, "[error] missing tid context information\n");
620 if (pid_check
== 0) {
622 fprintf(stderr
, "[error] missing pid context information\n");
624 if (ppid_check
== 0) {
626 fprintf(stderr
, "[error] missing ppid context information\n");
628 if (procname_check
== 0) {
630 fprintf(stderr
, "[error] missing procname context information\n");
636 int main(int argc
, char **argv
)
639 struct bt_context
*bt_ctx
= NULL
;
641 ret
= parse_options(argc
, argv
);
643 fprintf(stdout
, "Error parsing options.\n\n");
646 } else if (ret
> 0) {
652 bt_ctx
= bt_context_create();
653 ret
= bt_context_add_traces_recursive(bt_ctx
, opt_input_path
, "ctf", NULL
);
655 fprintf(stderr
, "[error] Opening the trace\n");
659 ret
= check_requirements(bt_ctx
);
661 fprintf(stderr
, "[error] some mandatory contexts were missing, exiting.\n");
665 pthread_create(&display_thread
, NULL
, ncurses_display
, (void *) NULL
);
666 pthread_create(&timer_thread
, NULL
, refresh_thread
, (void *) NULL
);
671 pthread_join(display_thread
, NULL
);
672 pthread_join(timer_thread
, NULL
);
675 bt_context_put(bt_ctx
);