output.c revision adec201a52c240cf4b533c05106aedddc911ca76
1/* 2 * This file is part of ltrace. 3 * Copyright (C) 2011,2012 Petr Machata, Red Hat Inc. 4 * Copyright (C) 2010 Joe Damato 5 * Copyright (C) 1997,1998,1999,2001,2002,2003,2004,2007,2008,2009 Juan Cespedes 6 * Copyright (C) 2006 Paul Gilliam, IBM Corporation 7 * Copyright (C) 2006 Ian Wienand 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License as 11 * published by the Free Software Foundation; either version 2 of the 12 * License, or (at your option) any later version. 13 * 14 * This program is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License 20 * along with this program; if not, write to the Free Software 21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 22 * 02110-1301 USA 23 */ 24 25#include "config.h" 26 27#include <stdio.h> 28#include <stdlib.h> 29#include <stdarg.h> 30#include <string.h> 31#include <time.h> 32#include <sys/time.h> 33#include <unistd.h> 34#include <errno.h> 35#include <assert.h> 36 37#include "common.h" 38#include "proc.h" 39#include "library.h" 40#include "type.h" 41#include "value.h" 42#include "value_dict.h" 43#include "param.h" 44#include "fetch.h" 45#include "lens_default.h" 46 47/* TODO FIXME XXX: include in common.h: */ 48extern struct timeval current_time_spent; 49 50Dict *dict_opt_c = NULL; 51 52static Process *current_proc = 0; 53static size_t current_depth = 0; 54static int current_column = 0; 55 56static void 57output_indent(struct Process *proc) 58{ 59 int d = options.indent * (proc->callstack_depth - 1); 60 current_column += fprintf(options.output, "%*s", d, ""); 61} 62 63static void 64begin_of_line(Process *proc, int is_func, int indent) 65{ 66 current_column = 0; 67 if (!proc) { 68 return; 69 } 70 if ((options.output != stderr) && (opt_p || options.follow)) { 71 current_column += fprintf(options.output, "%u ", proc->pid); 72 } else if (options.follow) { 73 current_column += fprintf(options.output, "[pid %u] ", proc->pid); 74 } 75 if (opt_r) { 76 struct timeval tv; 77 struct timezone tz; 78 static struct timeval old_tv = { 0, 0 }; 79 struct timeval diff; 80 81 gettimeofday(&tv, &tz); 82 83 if (old_tv.tv_sec == 0 && old_tv.tv_usec == 0) { 84 old_tv.tv_sec = tv.tv_sec; 85 old_tv.tv_usec = tv.tv_usec; 86 } 87 diff.tv_sec = tv.tv_sec - old_tv.tv_sec; 88 if (tv.tv_usec >= old_tv.tv_usec) { 89 diff.tv_usec = tv.tv_usec - old_tv.tv_usec; 90 } else { 91 diff.tv_sec--; 92 diff.tv_usec = 1000000 + tv.tv_usec - old_tv.tv_usec; 93 } 94 old_tv.tv_sec = tv.tv_sec; 95 old_tv.tv_usec = tv.tv_usec; 96 current_column += fprintf(options.output, "%3lu.%06d ", 97 diff.tv_sec, (int)diff.tv_usec); 98 } 99 if (opt_t) { 100 struct timeval tv; 101 struct timezone tz; 102 103 gettimeofday(&tv, &tz); 104 if (opt_t > 2) { 105 current_column += fprintf(options.output, "%lu.%06d ", 106 tv.tv_sec, (int)tv.tv_usec); 107 } else if (opt_t > 1) { 108 struct tm *tmp = localtime(&tv.tv_sec); 109 current_column += 110 fprintf(options.output, "%02d:%02d:%02d.%06d ", 111 tmp->tm_hour, tmp->tm_min, tmp->tm_sec, 112 (int)tv.tv_usec); 113 } else { 114 struct tm *tmp = localtime(&tv.tv_sec); 115 current_column += fprintf(options.output, "%02d:%02d:%02d ", 116 tmp->tm_hour, tmp->tm_min, 117 tmp->tm_sec); 118 } 119 } 120 if (opt_i) { 121 if (is_func) 122 current_column += fprintf(options.output, "[%p] ", 123 proc->return_addr); 124 else 125 current_column += fprintf(options.output, "[%p] ", 126 proc->instruction_pointer); 127 } 128 if (options.indent > 0 && indent) { 129 output_indent(proc); 130 } 131} 132 133static struct arg_type_info * 134get_unknown_type(void) 135{ 136 static struct arg_type_info *info = NULL; 137 if (info == NULL) { 138 info = malloc(sizeof(*info)); 139 if (info == NULL) { 140 report_global_error("malloc: %s", strerror(errno)); 141 abort(); 142 } 143 *info = *type_get_simple(ARGTYPE_LONG); 144 info->lens = &guess_lens; 145 } 146 return info; 147} 148 149/* The default prototype is: long X(long, long, long, long). */ 150static Function * 151build_default_prototype(void) 152{ 153 Function *ret = malloc(sizeof(*ret)); 154 size_t i = 0; 155 if (ret == NULL) 156 goto err; 157 memset(ret, 0, sizeof(*ret)); 158 159 struct arg_type_info *unknown_type = get_unknown_type(); 160 161 ret->return_info = unknown_type; 162 ret->own_return_info = 0; 163 164 ret->num_params = 4; 165 ret->params = malloc(sizeof(*ret->params) * ret->num_params); 166 if (ret->params == NULL) 167 goto err; 168 169 for (i = 0; i < ret->num_params; ++i) 170 param_init_type(&ret->params[i], unknown_type, 0); 171 172 return ret; 173 174err: 175 report_global_error("malloc: %s", strerror(errno)); 176 if (ret->params != NULL) { 177 while (i-- > 0) 178 param_destroy(&ret->params[i]); 179 free(ret->params); 180 } 181 182 free(ret); 183 184 return NULL; 185} 186 187static Function * 188name2func(char const *name) { 189 Function *tmp; 190 const char *str1, *str2; 191 192 for (tmp = list_of_functions; tmp != NULL; tmp = tmp->next) { 193 str1 = tmp->name; 194 str2 = name; 195 if (!strcmp(str1, str2)) 196 return tmp; 197 } 198 199 static Function *def = NULL; 200 if (def == NULL) 201 def = build_default_prototype(); 202 203 return def; 204} 205 206void 207output_line(struct Process *proc, const char *fmt, ...) 208{ 209 if (options.summary) 210 return; 211 212 if (current_proc != NULL) { 213 if (current_proc->callstack[current_depth].return_addr) 214 fprintf(options.output, " <unfinished ...>\n"); 215 else 216 fprintf(options.output, " <no return ...>\n"); 217 } 218 current_proc = NULL; 219 if (fmt == NULL) 220 return; 221 222 begin_of_line(proc, 0, 0); 223 224 va_list args; 225 va_start(args, fmt); 226 vfprintf(options.output, fmt, args); 227 fprintf(options.output, "\n"); 228 va_end(args); 229 230 current_column = 0; 231} 232 233static void 234tabto(int col) { 235 if (current_column < col) { 236 fprintf(options.output, "%*s", col - current_column, ""); 237 } 238} 239 240static int 241output_error(void) 242{ 243 return account_output(¤t_column, fprintf(options.output, "?")); 244} 245 246static int 247fetch_simple_param(enum tof type, Process *proc, struct fetch_context *context, 248 struct value_dict *arguments, 249 struct arg_type_info *info, int own, 250 struct value *valuep) 251{ 252 /* Arrays decay into pointers per C standard. We check for 253 * this here, because here we also capture arrays that come 254 * from parameter packs. */ 255 if (info->type == ARGTYPE_ARRAY) { 256 struct arg_type_info *tmp = malloc(sizeof(*tmp)); 257 if (tmp != NULL) { 258 type_init_pointer(tmp, info, own); 259 tmp->lens = info->lens; 260 info = tmp; 261 own = 1; 262 } 263 } 264 265 struct value value; 266 value_init(&value, proc, NULL, info, own); 267 if (fetch_arg_next(context, type, proc, info, &value) < 0) 268 return -1; 269 270 if (val_dict_push_next(arguments, &value) < 0) { 271 value_destroy(&value); 272 return -1; 273 } 274 275 if (valuep != NULL) 276 *valuep = value; 277 278 return 0; 279} 280 281static void 282fetch_param_stop(struct value_dict *arguments, ssize_t *params_leftp) 283{ 284 if (*params_leftp == -1) 285 *params_leftp = val_dict_count(arguments); 286} 287 288static int 289fetch_param_pack(enum tof type, Process *proc, struct fetch_context *context, 290 struct value_dict *arguments, struct param *param, 291 ssize_t *params_leftp) 292{ 293 struct param_enum *e = param_pack_init(param, arguments); 294 if (e == NULL) 295 return -1; 296 297 int ret = 0; 298 while (1) { 299 int insert_stop = 0; 300 struct arg_type_info *info = malloc(sizeof(*info)); 301 if (info == NULL 302 || param_pack_next(param, e, info, &insert_stop) < 0) { 303 fail: 304 free(info); 305 ret = -1; 306 break; 307 } 308 309 if (insert_stop) 310 fetch_param_stop(arguments, params_leftp); 311 312 if (info->type == ARGTYPE_VOID) { 313 type_destroy(info); 314 free(info); 315 break; 316 } 317 318 struct value val; 319 if (fetch_simple_param(type, proc, context, arguments, 320 info, 1, &val) < 0) 321 goto fail; 322 323 int stop = 0; 324 switch (param_pack_stop(param, e, &val)) { 325 case PPCB_ERR: 326 goto fail; 327 case PPCB_STOP: 328 stop = 1; 329 case PPCB_CONT: 330 break; 331 } 332 333 if (stop) 334 break; 335 } 336 337 param_pack_done(param, e); 338 return ret; 339} 340 341static int 342fetch_one_param(enum tof type, Process *proc, struct fetch_context *context, 343 struct value_dict *arguments, struct param *param, 344 ssize_t *params_leftp) 345{ 346 switch (param->flavor) { 347 int rc; 348 case PARAM_FLAVOR_TYPE: 349 return fetch_simple_param(type, proc, context, arguments, 350 param->u.type.type, 0, NULL); 351 352 case PARAM_FLAVOR_PACK: 353 if (fetch_param_pack_start(context, 354 param->u.pack.ppflavor) < 0) 355 return -1; 356 rc = fetch_param_pack(type, proc, context, arguments, 357 param, params_leftp); 358 fetch_param_pack_end(context); 359 return rc; 360 361 case PARAM_FLAVOR_STOP: 362 fetch_param_stop(arguments, params_leftp); 363 return 0; 364 } 365 366 assert(!"Invalid param flavor!"); 367 abort(); 368} 369 370static int 371fetch_params(enum tof type, Process *proc, struct fetch_context *context, 372 struct value_dict *arguments, Function *func, ssize_t *params_leftp) 373{ 374 size_t i; 375 for (i = 0; i < func->num_params; ++i) 376 if (fetch_one_param(type, proc, context, arguments, 377 &func->params[i], params_leftp) < 0) 378 return -1; 379 380 /* Implicit stop at the end of parameter list. */ 381 fetch_param_stop(arguments, params_leftp); 382 383 return 0; 384} 385 386static int 387output_one(struct value *val, struct value_dict *arguments) 388{ 389 int o = format_argument(options.output, val, arguments); 390 if (account_output(¤t_column, o) < 0) { 391 if (output_error() < 0) 392 return -1; 393 o = 1; 394 } 395 return o; 396} 397 398static int 399output_params(struct value_dict *arguments, size_t start, size_t end, 400 int *need_delimp) 401{ 402 size_t i; 403 int need_delim = *need_delimp; 404 for (i = start; i < end; ++i) { 405 if (need_delim 406 && account_output(¤t_column, 407 fprintf(options.output, ", ")) < 0) 408 return -1; 409 struct value *value = val_dict_get_num(arguments, i); 410 if (value == NULL) 411 return -1; 412 need_delim = output_one(value, arguments); 413 if (need_delim < 0) 414 return -1; 415 } 416 *need_delimp = need_delim; 417 return 0; 418} 419 420void 421output_left(enum tof type, struct Process *proc, 422 struct library_symbol *libsym) 423{ 424 const char *function_name = libsym->name; 425 Function *func; 426 427 if (options.summary) { 428 return; 429 } 430 if (current_proc) { 431 fprintf(options.output, " <unfinished ...>\n"); 432 current_column = 0; 433 } 434 current_proc = proc; 435 current_depth = proc->callstack_depth; 436 begin_of_line(proc, type == LT_TOF_FUNCTION, 1); 437 if (!options.hide_caller && libsym->lib != NULL 438 && libsym->plt_type != LS_TOPLT_NONE) 439 current_column += fprintf(options.output, "%s->", 440 libsym->lib->soname); 441 442 const char *name = function_name; 443#ifdef USE_DEMANGLE 444 if (options.demangle) 445 name = my_demangle(function_name); 446#endif 447 if (account_output(¤t_column, 448 fprintf(options.output, "%s(", name)) < 0) 449 return; 450 451 func = name2func(function_name); 452 if (func == NULL) 453 return; 454 455 struct fetch_context *context = fetch_arg_init(type, proc, 456 func->return_info); 457 struct value_dict *arguments = malloc(sizeof(*arguments)); 458 if (arguments == NULL) 459 return; 460 val_dict_init(arguments); 461 462 ssize_t params_left = -1; 463 int need_delim = 0; 464 if (fetch_params(type, proc, context, arguments, func, ¶ms_left) < 0 465 || output_params(arguments, 0, params_left, &need_delim) < 0) { 466 val_dict_destroy(arguments); 467 fetch_arg_done(context); 468 arguments = NULL; 469 context = NULL; 470 } 471 472 struct callstack_element *stel 473 = &proc->callstack[proc->callstack_depth - 1]; 474 stel->fetch_context = context; 475 stel->arguments = arguments; 476 stel->out.params_left = params_left; 477 stel->out.need_delim = need_delim; 478} 479 480void 481output_right(enum tof type, struct Process *proc, struct library_symbol *libsym) 482{ 483 const char *function_name = libsym->name; 484 Function *func = name2func(function_name); 485 if (func == NULL) 486 return; 487 488 if (options.summary) { 489 struct opt_c_struct *st; 490 if (!dict_opt_c) { 491 dict_opt_c = 492 dict_init(dict_key2hash_string, 493 dict_key_cmp_string); 494 } 495 st = dict_find_entry(dict_opt_c, function_name); 496 if (!st) { 497 char *na; 498 st = malloc(sizeof(struct opt_c_struct)); 499 na = strdup(function_name); 500 if (!st || !na) { 501 perror("malloc()"); 502 exit(1); 503 } 504 st->count = 0; 505 st->tv.tv_sec = st->tv.tv_usec = 0; 506 dict_enter(dict_opt_c, na, st); 507 } 508 if (st->tv.tv_usec + current_time_spent.tv_usec > 1000000) { 509 st->tv.tv_usec += current_time_spent.tv_usec - 1000000; 510 st->tv.tv_sec++; 511 } else { 512 st->tv.tv_usec += current_time_spent.tv_usec; 513 } 514 st->count++; 515 st->tv.tv_sec += current_time_spent.tv_sec; 516 517// fprintf(options.output, "%s <%lu.%06d>\n", function_name, 518// current_time_spent.tv_sec, (int)current_time_spent.tv_usec); 519 return; 520 } 521 if (current_proc && (current_proc != proc || 522 current_depth != proc->callstack_depth)) { 523 fprintf(options.output, " <unfinished ...>\n"); 524 current_proc = 0; 525 } 526 if (current_proc != proc) { 527 begin_of_line(proc, type == LT_TOF_FUNCTIONR, 1); 528#ifdef USE_DEMANGLE 529 current_column += 530 fprintf(options.output, "<... %s resumed> ", 531 options.demangle ? my_demangle(function_name) : function_name); 532#else 533 current_column += 534 fprintf(options.output, "<... %s resumed> ", function_name); 535#endif 536 } 537 538 struct callstack_element *stel 539 = &proc->callstack[proc->callstack_depth - 1]; 540 541 struct fetch_context *context = stel->fetch_context; 542 543 /* Fetch & enter into dictionary the retval first, so that 544 * other values can use it in expressions. */ 545 struct value retval; 546 int own_retval = 0; 547 if (context != NULL) { 548 value_init(&retval, proc, NULL, func->return_info, 0); 549 own_retval = 1; 550 if (fetch_retval(context, type, proc, func->return_info, 551 &retval) < 0) 552 value_set_type(&retval, NULL, 0); 553 else if (stel->arguments != NULL 554 && val_dict_push_named(stel->arguments, &retval, 555 "retval", 0) == 0) 556 own_retval = 0; 557 } 558 559 if (stel->arguments != NULL) 560 output_params(stel->arguments, stel->out.params_left, 561 val_dict_count(stel->arguments), 562 &stel->out.need_delim); 563 564 current_column += fprintf(options.output, ") "); 565 tabto(options.align - 1); 566 fprintf(options.output, "= "); 567 568 if (context != NULL && retval.type != NULL) 569 output_one(&retval, stel->arguments); 570 571 if (own_retval) 572 value_destroy(&retval); 573 574 if (opt_T) { 575 fprintf(options.output, " <%lu.%06d>", 576 current_time_spent.tv_sec, 577 (int)current_time_spent.tv_usec); 578 } 579 fprintf(options.output, "\n"); 580 581#if defined(HAVE_LIBUNWIND) 582 if (options.bt_depth > 0) { 583 unw_cursor_t cursor; 584 unw_word_t ip, sp; 585 int unwind_depth = options.bt_depth; 586 char fn_name[100]; 587 588 unw_init_remote(&cursor, proc->unwind_as, proc->unwind_priv); 589 while (unwind_depth) { 590 unw_get_reg(&cursor, UNW_REG_IP, &ip); 591 unw_get_reg(&cursor, UNW_REG_SP, &sp); 592 unw_get_proc_name(&cursor, fn_name, 100, NULL); 593 fprintf(options.output, "\t\t\t%s (ip = 0x%lx)\n", fn_name, (long) ip); 594 if (unw_step(&cursor) <= 0) 595 break; 596 unwind_depth--; 597 } 598 fprintf(options.output, "\n"); 599 } 600#endif /* defined(HAVE_LIBUNWIND) */ 601 602 current_proc = 0; 603 current_column = 0; 604} 605 606int 607account_output(int *countp, int c) 608{ 609 if (c > 0) 610 *countp += c; 611 return c; 612} 613 614static void 615do_report(const char *filename, unsigned line_no, const char *severity, 616 const char *fmt, va_list args) 617{ 618 char buf[128]; 619 vsnprintf(buf, sizeof(buf), fmt, args); 620 buf[sizeof(buf) - 1] = 0; 621 if (filename != NULL) 622 output_line(0, "%s:%d: %s: %s", 623 filename, line_no, severity, buf); 624 else 625 output_line(0, "%s: %s", severity, buf); 626} 627 628void 629report_error(const char *filename, unsigned line_no, const char *fmt, ...) 630{ 631 va_list args; 632 va_start(args, fmt); 633 do_report(filename, line_no, "error", fmt, args); 634 va_end(args); 635} 636 637void 638report_warning(const char *filename, unsigned line_no, const char *fmt, ...) 639{ 640 va_list args; 641 va_start(args, fmt); 642 do_report(filename, line_no, "warning", fmt, args); 643 va_end(args); 644} 645 646void 647report_global_error(const char *fmt, ...) 648{ 649 va_list args; 650 va_start(args, fmt); 651 do_report(NULL, 0, "error", fmt, args); 652 va_end(args); 653} 654