src/lttngtop.c

   1 /*
   2  * Copyright (C) 2011 Julien Desfossez
   3  *
   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;
   7  *
   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.
  12  *
  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.
  16  */
  17
  18 #define _GNU_SOURCE
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <stdint.h>
  22 #include <babeltrace/babeltrace.h>
  23 #include <babeltrace/ctf/events.h>
  24 #include <babeltrace/ctf/callbacks.h>
  25 #include <babeltrace/ctf/iterator.h>
  26 #include <fcntl.h>
  27 #include <pthread.h>
  28 #include <popt.h>
  29 #include <stdlib.h>
  30 #include <ftw.h>
  31 #include <dirent.h>
  32 #include <ctype.h>
  33 #include <sys/stat.h>
  34 #include <unistd.h>
  35 #include <string.h>
  36 #include <errno.h>
  37 #include <sys/types.h>
  38 #include <fts.h>
  39 #include <assert.h>
  40
  41 #include "lttngtoptypes.h"
  42 #include "cputop.h"
  43 #include "iostreamtop.h"
  44 #include "cursesdisplay.h"
  45 #include "common.h"
  46
  47 #define DEFAULT_FILE_ARRAY_SIZE 1
  48
  49 const char *opt_input_path;
  50
  51 struct lttngtop *copy;
  52 pthread_t display_thread;
  53 pthread_t timer_thread;
  54
  55 unsigned long refresh_display = 1 * NSEC_PER_SEC;
  56 unsigned long last_display_update = 0;
  57 int quit = 0;
  58
  59 enum {
  60         OPT_NONE = 0,
  61         OPT_HELP,
  62         OPT_LIST,
  63         OPT_VERBOSE,
  64         OPT_DEBUG,
  65         OPT_NAMES,
  66 };
  67
  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 },
  72 };
  73
  74 void *refresh_thread(void *p)
  75 {
  76         while (1) {
  77                 if (quit)
  78                         return NULL;
  79                 sem_wait(&pause_sem);
  80                 sem_post(&pause_sem);
  81                 sem_post(&timer);
  82                 sleep(refresh_display/NSEC_PER_SEC);
  83         }
  84 }
  85
  86 void *ncurses_display(void *p)
  87 {
  88         unsigned int current_display_index = 0;
  89
  90         sem_wait(&bootstrap);
  91         init_ncurses();
  92
  93         while (1) {
  94                 sem_wait(&timer);
  95                 sem_wait(&goodtodisplay);
  96                 sem_wait(&pause_sem);
  97
  98                 copy = g_ptr_array_index(copies, current_display_index);
  99                 assert(copy);
 100                 display(current_display_index++);
 101
 102                 sem_post(&goodtoupdate);
 103                 sem_post(&pause_sem);
 104
 105                 if (quit) {
 106                         reset_ncurses();
 107                         pthread_exit(0);
 108                 }
 109         }
 110 }
 111
 112 /*
 113  * hook on each event to check the timestamp and refresh the display if
 114  * necessary
 115  */
 116 enum bt_cb_ret check_timestamp(struct bt_ctf_event *call_data, void *private_data)
 117 {
 118         unsigned long timestamp;
 119
 120         timestamp = bt_ctf_get_timestamp(call_data);
 121         if (timestamp == -1ULL)
 122                 goto error;
 123
 124         if (last_display_update == 0)
 125                 last_display_update = timestamp;
 126
 127         if (timestamp - last_display_update >= refresh_display) {
 128                 sem_wait(&goodtoupdate);
 129                 g_ptr_array_add(copies, get_copy_lttngtop(last_display_update,
 130                                         timestamp));
 131                 sem_post(&goodtodisplay);
 132                 sem_post(&bootstrap);
 133                 last_display_update = timestamp;
 134         }
 135         return BT_CB_OK;
 136
 137 error:
 138         fprintf(stderr, "check_timestamp callback error\n");
 139         return BT_CB_ERROR_STOP;
 140 }
 141
 142 /*
 143  * get_perf_counter : get or create and return a perf_counter struct for
 144  * either a process or a cpu (only one of the 2 parameters mandatory)
 145  */
 146 struct perfcounter *get_perf_counter(const char *name, struct processtop *proc,
 147                 struct cputime *cpu)
 148 {
 149         struct perfcounter *ret, *global;
 150         GHashTable *table;
 151
 152         if (proc)
 153                 table = proc->perf;
 154         else if (cpu)
 155                 table = cpu->perf;
 156         else
 157                 goto error;
 158
 159         ret = g_hash_table_lookup(table, (gpointer) name);
 160         if (ret)
 161                 goto end;
 162
 163         ret = g_new0(struct perfcounter, 1);
 164         /* by default, make it visible in the UI */
 165         ret->visible = 1;
 166         g_hash_table_insert(table, (gpointer) strdup(name), ret);
 167
 168         global = g_hash_table_lookup(lttngtop.perf_list, (gpointer) name);
 169         if (!global) {
 170                 global = g_new0(struct perfcounter, 1);
 171                 memcpy(global, ret, sizeof(struct perfcounter));
 172                 /* by default, sort on the first perf context */
 173                 if (g_hash_table_size(lttngtop.perf_list) == 0)
 174                         global->sort = 1;
 175                 g_hash_table_insert(lttngtop.perf_list, (gpointer) strdup(name), global);
 176         }
 177
 178 end:
 179         return ret;
 180
 181 error:
 182         return NULL;
 183 }
 184
 185 void update_perf_value(struct processtop *proc, struct cputime *cpu,
 186                 const char *name, int value)
 187 {
 188         struct perfcounter *cpu_perf, *process_perf;
 189
 190         cpu_perf = get_perf_counter(name, NULL, cpu);
 191         if (cpu_perf->count < value) {
 192                 process_perf = get_perf_counter(name, proc, NULL);
 193                 process_perf->count += value - cpu_perf->count;
 194                 cpu_perf->count = value;
 195         }
 196 }
 197
 198 void extract_perf_counter_scope(const struct bt_ctf_event *event,
 199                 const struct definition *scope,
 200                 struct processtop *proc,
 201                 struct cputime *cpu)
 202 {
 203         struct definition const * const *list = NULL;
 204         unsigned int count;
 205         int i, ret;
 206
 207         if (!scope)
 208                 goto end;
 209
 210         ret = bt_ctf_get_field_list(event, scope, &list, &count);
 211         if (ret < 0)
 212                 goto end;
 213
 214         for (i = 0; i < count; i++) {
 215                 const char *name = bt_ctf_field_name(list[i]);
 216                 if (strncmp(name, "perf_", 5) == 0) {
 217                         int value = bt_ctf_get_uint64(list[i]);
 218                         if (bt_ctf_field_get_error())
 219                                 continue;
 220                         update_perf_value(proc, cpu, name, value);
 221                 }
 222         }
 223
 224 end:
 225         return;
 226 }
 227
 228 void update_perf_counter(struct processtop *proc, const struct bt_ctf_event *event)
 229 {
 230         struct cputime *cpu;
 231         const struct definition *scope;
 232
 233         cpu = get_cpu(get_cpu_id(event));
 234
 235         scope = bt_ctf_get_top_level_scope(event, BT_STREAM_EVENT_CONTEXT);
 236         extract_perf_counter_scope(event, scope, proc, cpu);
 237
 238         scope = bt_ctf_get_top_level_scope(event, BT_STREAM_PACKET_CONTEXT);
 239         extract_perf_counter_scope(event, scope, proc, cpu);
 240
 241         scope = bt_ctf_get_top_level_scope(event, BT_EVENT_CONTEXT);
 242         extract_perf_counter_scope(event, scope, proc, cpu);
 243 }
 244
 245 enum bt_cb_ret fix_process_table(struct bt_ctf_event *call_data,
 246                 void *private_data)
 247 {
 248         int pid, tid, ppid;
 249         char *comm;
 250         struct processtop *parent, *child;
 251         unsigned long timestamp;
 252
 253         /* FIXME : display nice error when missing context pid, tid, ppid and comm */
 254
 255         timestamp = bt_ctf_get_timestamp(call_data);
 256         if (timestamp == -1ULL)
 257                 goto error;
 258
 259         pid = get_context_pid(call_data);
 260         if (pid == -1ULL) {
 261 //              fprintf(stderr, "Missing pid context info\n");
 262                 goto error;
 263         }
 264         tid = get_context_tid(call_data);
 265         if (tid == -1ULL) {
 266 //              fprintf(stderr, "Missing tid context info\n");
 267                 goto error;
 268         }
 269         ppid = get_context_ppid(call_data);
 270         if (ppid == -1ULL) {
 271 //              fprintf(stderr, "Missing ppid context info\n");
 272                 goto error;
 273         }
 274         comm = get_context_comm(call_data);
 275         if (!comm) {
 276 //              fprintf(stderr, "Missing procname context info\n");
 277                 goto error;
 278         }
 279
 280         /* find or create the current process */
 281         child = find_process_tid(&lttngtop, tid, comm);
 282         if (!child)
 283                 child = add_proc(&lttngtop, tid, comm, timestamp);
 284         update_proc(child, pid, tid, ppid, comm);
 285
 286         if (pid != tid) {
 287                 /* find or create the parent */
 288                 parent = find_process_tid(&lttngtop, pid, comm);
 289                 if (!parent) {
 290                         parent = add_proc(&lttngtop, pid, comm, timestamp);
 291                         parent->pid = pid;
 292                 }
 293
 294                 /* attach the parent to the current process */
 295                 child->threadparent = parent;
 296                 add_thread(parent, child);
 297         }
 298
 299         update_perf_counter(child, call_data);
 300
 301         return BT_CB_OK;
 302
 303 error:
 304         return BT_CB_ERROR_STOP;
 305 }
 306
 307 void init_lttngtop()
 308 {
 309         copies = g_ptr_array_new();
 310         lttngtop.perf_list = g_hash_table_new(g_str_hash, g_str_equal);
 311
 312         sem_init(&goodtodisplay, 0, 0);
 313         sem_init(&goodtoupdate, 0, 1);
 314         sem_init(&timer, 0, 1);
 315         sem_init(&bootstrap, 0, 0);
 316         sem_init(&pause_sem, 0, 1);
 317         sem_init(&end_trace_sem, 0, 0);
 318
 319         lttngtop.process_table = g_ptr_array_new();
 320         lttngtop.files_table = g_ptr_array_new();
 321         lttngtop.cpu_table = g_ptr_array_new();
 322 }
 323
 324 void usage(FILE *fp)
 325 {
 326         fprintf(fp, "LTTngTop %s\n\n", VERSION);
 327         fprintf(fp, "Usage : lttngtop /path/to/trace\n");
 328 }
 329
 330 /*
 331  * Return 0 if caller should continue, < 0 if caller should return
 332  * error, > 0 if caller should exit without reporting error.
 333  */
 334 static int parse_options(int argc, char **argv)
 335 {
 336         poptContext pc;
 337         int opt, ret = 0;
 338
 339         if (argc == 1) {
 340                 usage(stdout);
 341                 return 1;   /* exit cleanly */
 342         }
 343
 344         pc = poptGetContext(NULL, argc, (const char **) argv, long_options, 0);
 345         poptReadDefaultConfig(pc, 0);
 346
 347         while ((opt = poptGetNextOpt(pc)) != -1) {
 348                 switch (opt) {
 349                         case OPT_HELP:
 350                                 usage(stdout);
 351                                 ret = 1;    /* exit cleanly */
 352                                 goto end;
 353                         case OPT_LIST:
 354                         //      list_formats(stdout);
 355                                 ret = 1;
 356                                 goto end;
 357                         case OPT_VERBOSE:
 358 //                              babeltrace_verbose = 1;
 359                                 break;
 360                         case OPT_DEBUG:
 361 //                              babeltrace_debug = 1;
 362                                 break;
 363                         case OPT_NAMES:
 364 //                              opt_field_names = 1;
 365                                 break;
 366                         default:
 367                                 ret = -EINVAL;
 368                                 goto end;
 369                 }
 370         }
 371
 372         opt_input_path = poptGetArg(pc);
 373         if (!opt_input_path) {
 374                 ret = -EINVAL;
 375                 goto end;
 376         }
 377 end:
 378         if (pc) {
 379                 poptFreeContext(pc);
 380         }
 381         return ret;
 382 }
 383
 384 void iter_trace(struct bt_context *bt_ctx)
 385 {
 386         struct bt_ctf_iter *iter;
 387         struct bt_iter_pos begin_pos;
 388         const struct bt_ctf_event *event;
 389         int ret = 0;
 390
 391         begin_pos.type = BT_SEEK_BEGIN;
 392         iter = bt_ctf_iter_create(bt_ctx, &begin_pos, NULL);
 393
 394         /* at each event check if we need to refresh */
 395         bt_ctf_iter_add_callback(iter, 0, NULL, 0,
 396                         check_timestamp,
 397                         NULL, NULL, NULL);
 398         /* at each event, verify the status of the process table */
 399         bt_ctf_iter_add_callback(iter, 0, NULL, 0,
 400                         fix_process_table,
 401                         NULL, NULL, NULL);
 402         /* to handle the scheduling events */
 403         bt_ctf_iter_add_callback(iter,
 404                         g_quark_from_static_string("sched_switch"),
 405                         NULL, 0, handle_sched_switch, NULL, NULL, NULL);
 406         /* to clean up the process table */
 407         bt_ctf_iter_add_callback(iter,
 408                         g_quark_from_static_string("sched_process_free"),
 409                         NULL, 0, handle_sched_process_free, NULL, NULL, NULL);
 410
 411         /* for IO top */
 412         bt_ctf_iter_add_callback(iter,
 413                         g_quark_from_static_string("exit_syscall"),
 414                         NULL, 0, handle_exit_syscall, NULL, NULL, NULL);
 415         bt_ctf_iter_add_callback(iter,
 416                         g_quark_from_static_string("sys_write"),
 417                         NULL, 0, handle_sys_write, NULL, NULL, NULL);
 418         bt_ctf_iter_add_callback(iter,
 419                         g_quark_from_static_string("sys_read"),
 420                         NULL, 0, handle_sys_read, NULL, NULL, NULL);
 421         bt_ctf_iter_add_callback(iter,
 422                         g_quark_from_static_string("sys_open"),
 423                         NULL, 0, handle_sys_open, NULL, NULL, NULL);
 424         bt_ctf_iter_add_callback(iter,
 425                         g_quark_from_static_string("sys_close"),
 426                         NULL, 0, handle_sys_close, NULL, NULL, NULL);
 427 /*
 428         bt_ctf_iter_add_callback(iter,
 429                         g_quark_from_static_string(
 430                                         "lttng_statedump_file_descriptor"),
 431                         NULL, 0, handle_statedump_file_descriptor,
 432                         NULL, NULL, NULL);
 433 */
 434         while ((event = bt_ctf_iter_read_event(iter)) != NULL) {
 435                 ret = bt_iter_next(bt_ctf_get_iter(iter));
 436                 if (ret < 0)
 437                         goto end_iter;
 438         }
 439
 440         /* block until quit, we reached the end of the trace */
 441         sem_wait(&end_trace_sem);
 442
 443 end_iter:
 444         bt_ctf_iter_destroy(iter);
 445 }
 446
 447 /*
 448  * bt_context_add_traces_recursive: Open a trace recursively
 449  * (copied from BSD code in converter/babeltrace.c)
 450  *
 451  * Find each trace present in the subdirectory starting from the given
 452  * path, and add them to the context. The packet_seek parameter can be
 453  * NULL: this specify to use the default format packet_seek.
 454  *
 455  * Return: 0 on success, nonzero on failure.
 456  * Unable to open toplevel: failure.
 457  * Unable to open some subdirectory or file: warn and continue;
 458  */
 459 int bt_context_add_traces_recursive(struct bt_context *ctx, const char *path,
 460                 const char *format_str,
 461                 void (*packet_seek)(struct stream_pos *pos,
 462                         size_t offset, int whence))
 463 {
 464         FTS *tree;
 465         FTSENT *node;
 466         GArray *trace_ids;
 467         char lpath[PATH_MAX];
 468         char * const paths[2] = { lpath, NULL };
 469         int ret;
 470
 471         /*
 472          * Need to copy path, because fts_open can change it.
 473          * It is the pointer array, not the strings, that are constant.
 474          */
 475         strncpy(lpath, path, PATH_MAX);
 476         lpath[PATH_MAX - 1] = '\0';
 477
 478         tree = fts_open(paths, FTS_NOCHDIR | FTS_LOGICAL, 0);
 479         if (tree == NULL) {
 480                 fprintf(stderr, "[error] [Context] Cannot traverse \"%s\" for reading.\n",
 481                                 path);
 482                 return -EINVAL;
 483         }
 484
 485         trace_ids = g_array_new(FALSE, TRUE, sizeof(int));
 486
 487         while ((node = fts_read(tree))) {
 488                 int dirfd, metafd;
 489
 490                 if (!(node->fts_info & FTS_D))
 491                         continue;
 492
 493                 dirfd = open(node->fts_accpath, 0);
 494                 if (dirfd < 0) {
 495                         fprintf(stderr, "[error] [Context] Unable to open trace "
 496                                 "directory file descriptor.\n");
 497                         ret = dirfd;
 498                         goto error;
 499                 }
 500                 metafd = openat(dirfd, "metadata", O_RDONLY);
 501                 if (metafd < 0) {
 502                         ret = close(dirfd);
 503                         if (ret < 0) {
 504                                 perror("close");
 505                                 goto error;
 506                         }
 507                 } else {
 508                         int trace_id;
 509
 510                         ret = close(metafd);
 511                         if (ret < 0) {
 512                                 perror("close");
 513                                 goto error;
 514                         }
 515                         ret = close(dirfd);
 516                         if (ret < 0) {
 517                                 perror("close");
 518                                 goto error;
 519                         }
 520
 521                         trace_id = bt_context_add_trace(ctx,
 522                                 node->fts_accpath, format_str,
 523                                 packet_seek, NULL, NULL);
 524                         if (trace_id < 0) {
 525                                 fprintf(stderr, "[error] [Context] opening trace \"%s\" from %s "
 526                                         "for reading.\n", node->fts_accpath, path);
 527                                 ret = trace_id;
 528                                 goto error;
 529                         }
 530                         g_array_append_val(trace_ids, trace_id);
 531                 }
 532         }
 533
 534         g_array_free(trace_ids, TRUE);
 535         return 0;
 536
 537 error:
 538         return ret;
 539 }
 540
 541 int main(int argc, char **argv)
 542 {
 543         int ret;
 544         struct bt_context *bt_ctx = NULL;
 545
 546         ret = parse_options(argc, argv);
 547         if (ret < 0) {
 548                 fprintf(stdout, "Error parsing options.\n\n");
 549                 usage(stdout);
 550                 exit(EXIT_FAILURE);
 551         } else if (ret > 0) {
 552                 exit(EXIT_SUCCESS);
 553         }
 554
 555         init_lttngtop();
 556
 557         bt_ctx = bt_context_create();
 558         ret = bt_context_add_traces_recursive(bt_ctx, opt_input_path, "ctf", NULL);
 559         if (ret < 0) {
 560                 printf("[error] Opening the trace\n");
 561                 goto end;
 562         }
 563
 564         pthread_create(&display_thread, NULL, ncurses_display, (void *) NULL);
 565         pthread_create(&timer_thread, NULL, refresh_thread, (void *) NULL);
 566
 567         iter_trace(bt_ctx);
 568
 569         quit = 1;
 570         pthread_join(display_thread, NULL);
 571         pthread_join(timer_thread, NULL);
 572
 573 end:
 574         bt_context_put(bt_ctx);
 575         return 0;
 576 }