vm/debug.cpp

   1 #include "master.hpp"
   2
   3 using namespace std;
   4
   5 namespace factor {
   6
   7 bool factor_print_p = true;
   8
   9 ostream& operator<<(ostream& out, const string* str) {
  10   for (cell i = 0; i < string_capacity(str); i++)
  11     out << (char)str->data()[i];
  12   return out;
  13 }
  14
  15 void factor_vm::print_word(ostream& out, word* word, cell nesting) {
  16   if (tagged<object>(word->vocabulary).type_p(STRING_TYPE))
  17     out << untag<string>(word->vocabulary) << ":";
  18
  19   if (tagged<object>(word->name).type_p(STRING_TYPE))
  20     out << untag<string>(word->name);
  21   else {
  22     out << "#<not a string: ";
  23     print_nested_obj(out, word->name, nesting);
  24     out << ">";
  25   }
  26 }
  27
  28 void factor_vm::print_factor_string(ostream& out, string* str) {
  29   out << '"' << str << '"';
  30 }
  31
  32 void factor_vm::print_array(ostream& out, array* array, cell nesting) {
  33   cell length = array_capacity(array);
  34   cell i;
  35   bool trimmed;
  36
  37   if (length > 10 && !full_output) {
  38     trimmed = true;
  39     length = 10;
  40   } else
  41     trimmed = false;
  42
  43   for (i = 0; i < length; i++) {
  44     out << " ";
  45     print_nested_obj(out, array_nth(array, i), nesting);
  46   }
  47
  48   if (trimmed)
  49     out << "...";
  50 }
  51
  52 void factor_vm::print_alien(ostream& out, alien* alien, cell nesting) {
  53   if (to_boolean(alien->expired))
  54     out << "#<expired alien>";
  55   else if (to_boolean(alien->base)) {
  56     out << "#<displaced alien " << alien->displacement << "+";
  57     print_nested_obj(out, alien->base, nesting);
  58     out << ">";
  59   } else {
  60     out << "#<alien " << (void*)alien->address << ">";
  61   }
  62 }
  63
  64 void factor_vm::print_byte_array(ostream& out, byte_array* array, cell nesting) {
  65   cell length = array->capacity;
  66   cell i;
  67   bool trimmed;
  68   unsigned char* data = array->data<unsigned char>();
  69
  70   if (length > 16 && !full_output) {
  71     trimmed = true;
  72     length = 16;
  73   } else
  74     trimmed = false;
  75
  76   for (i = 0; i < length; i++) {
  77     out << " " << (unsigned) data[i];
  78   }
  79
  80   if (trimmed)
  81     out << "...";
  82 }
  83
  84 void factor_vm::print_tuple(ostream& out, tuple* tuple, cell nesting) {
  85   tuple_layout* layout = untag<tuple_layout>(tuple->layout);
  86   cell length = to_cell(layout->size);
  87
  88   out << " ";
  89   print_nested_obj(out, layout->klass, nesting);
  90
  91   bool trimmed;
  92   if (length > 10 && !full_output) {
  93     trimmed = true;
  94     length = 10;
  95   } else
  96     trimmed = false;
  97
  98   for (cell i = 0; i < length; i++) {
  99     out << " ";
 100     print_nested_obj(out, tuple->data()[i], nesting);
 101   }
 102
 103   if (trimmed)
 104     out << "...";
 105 }
 106
 107 void factor_vm::print_nested_obj(ostream& out, cell obj, fixnum nesting) {
 108   if (nesting <= 0 && !full_output) {
 109     out << " ... ";
 110     return;
 111   }
 112
 113   quotation* quot;
 114
 115   switch (tagged<object>(obj).type()) {
 116     case FIXNUM_TYPE:
 117       out << untag_fixnum(obj);
 118       break;
 119     case FLOAT_TYPE:
 120       out << untag_float(obj);
 121       break;
 122     case WORD_TYPE:
 123       print_word(out, untag<word>(obj), nesting - 1);
 124       break;
 125     case STRING_TYPE:
 126       print_factor_string(out, untag<string>(obj));
 127       break;
 128     case F_TYPE:
 129       out << "f";
 130       break;
 131     case TUPLE_TYPE:
 132       out << "T{";
 133       print_tuple(out, untag<tuple>(obj), nesting - 1);
 134       out << " }";
 135       break;
 136     case WRAPPER_TYPE:
 137       out << "W{ ";
 138       print_nested_obj(out, untag<wrapper>(obj)->object, nesting - 1);
 139       out << " }";
 140       break;
 141     case BYTE_ARRAY_TYPE:
 142       out << "B{";
 143       print_byte_array(out, untag<byte_array>(obj), nesting - 1);
 144       out << " }";
 145       break;
 146     case ARRAY_TYPE:
 147       out << "{";
 148       print_array(out, untag<array>(obj), nesting - 1);
 149       out << " }";
 150       break;
 151     case QUOTATION_TYPE:
 152       out << "[";
 153       quot = untag<quotation>(obj);
 154       print_array(out, untag<array>(quot->array), nesting - 1);
 155       out << " ]";
 156       break;
 157     case ALIEN_TYPE:
 158       print_alien(out, untag<alien>(obj), nesting - 1);
 159       break;
 160     default:
 161       out << "#<" << type_name(tagged<object>(obj).type()) << " @ ";
 162       out << (void*)obj << ">";
 163       break;
 164   }
 165   out << flush;
 166 }
 167
 168 void factor_vm::print_obj(ostream& out, cell obj) {
 169   print_nested_obj(out, obj, 10);
 170 }
 171
 172 void factor_vm::print_objects(ostream& out, cell* start, cell* end) {
 173   for (; start <= end; start++) {
 174     print_obj(out, *start);
 175     cout << endl;
 176   }
 177 }
 178
 179 void factor_vm::print_datastack(ostream& out) {
 180   out << "==== DATA STACK:" << endl;
 181   if (ctx)
 182     print_objects(out,
 183                   (cell*)ctx->datastack_seg->start,
 184                   (cell*)ctx->datastack);
 185   else
 186     out << "*** Context not initialized" << endl;
 187 }
 188
 189 void factor_vm::print_retainstack(ostream& out) {
 190   out << "==== RETAIN STACK:" << endl;
 191   if (ctx)
 192     print_objects(out,
 193                   (cell*)ctx->retainstack_seg->start,
 194                   (cell*)ctx->retainstack);
 195   else
 196     out << "*** Context not initialized" << endl;
 197 }
 198
 199 struct stack_frame_printer {
 200   factor_vm* parent;
 201   ostream& out;
 202
 203   explicit stack_frame_printer(factor_vm* parent, ostream& out)
 204       : parent(parent), out(out) {}
 205   void operator()(cell frame_top, cell size, code_block* owner, cell addr) {
 206     out << endl;
 207     out << "frame: " << (void*)frame_top << " size " << size << endl;
 208     out << "executing: ";
 209     parent->print_obj(out, owner->owner);
 210     out << endl;
 211     out << "scan: ";
 212     parent->print_obj(out, owner->scan(parent, addr));
 213     out << endl;
 214     out << "word/quot addr: ";
 215     out << hex << owner->owner << dec;
 216     out << endl;
 217     out << "word/quot xt: ";
 218     out << hex << owner->entry_point() << dec;
 219     out << endl;
 220     out << "return address: ";
 221     out << hex << addr << dec;
 222     out << endl;
 223   }
 224 };
 225
 226 void factor_vm::print_callstack(ostream& out) {
 227   out << "==== CALL STACK:" << endl;
 228   if (ctx) {
 229     stack_frame_printer printer(this, out);
 230     iterate_callstack(ctx, printer);
 231   } else
 232     out << "*** Context not initialized" << endl;
 233 }
 234
 235 void factor_vm::print_callstack_object(ostream& out, callstack* obj) {
 236   stack_frame_printer printer(this, out);
 237   iterate_callstack_object(obj, printer);
 238 }
 239
 240 struct padded_address {
 241   cell value;
 242
 243   explicit padded_address(cell value) : value(value) {}
 244 };
 245
 246 ostream& operator<<(ostream& out, const padded_address& value) {
 247   char prev = out.fill('0');
 248   out.width(sizeof(cell) * 2);
 249   out << hex << value.value << dec;
 250   out.fill(prev);
 251   return out;
 252 }
 253
 254 void factor_vm::dump_cell(ostream& out, cell x) {
 255   out << padded_address(x) << ": ";
 256   x = *(cell*)x;
 257   out << padded_address(x) << " tag " << TAG(x) << endl;
 258 }
 259
 260 void factor_vm::dump_memory(ostream& out, cell from, cell to) {
 261   from = UNTAG(from);
 262
 263   for (; from <= to; from += sizeof(cell))
 264     dump_cell(out, from);
 265 }
 266
 267 template <typename Generation>
 268 void factor_vm::dump_generation(ostream& out, const char* name, Generation* gen) {
 269   out << name << ": ";
 270   out << "Start=" << gen->start;
 271   out << ", size=" << gen->size;
 272   out << ", end=" << gen->end;
 273   out << endl;
 274 }
 275
 276 void factor_vm::dump_generations(ostream& out) {
 277   out << hex;
 278
 279   dump_generation(out, "Nursery", &nursery);
 280   dump_generation(out, "Aging", data->aging);
 281   dump_generation(out, "Tenured", data->tenured);
 282
 283   out << "Cards:";
 284   out << "base=" << (cell)data->cards << ", ";
 285   out << "size=" << (cell)(data->cards_end - data->cards) << endl;
 286   out << dec;
 287 }
 288
 289 void factor_vm::dump_objects(ostream& out, cell type) {
 290   primitive_full_gc();
 291   auto object_dumper = [&](object* obj) {
 292      if (type == TYPE_COUNT || obj->type() == type) {
 293       out << padded_address((cell)obj) << " ";
 294       print_nested_obj(out, tag_dynamic(obj), 2);
 295       out << endl;
 296     }
 297   };
 298   each_object(object_dumper);
 299 }
 300
 301 struct find_data_reference_slot_visitor {
 302   cell look_for;
 303   object* obj;
 304   factor_vm* parent;
 305   ostream& out;
 306
 307   find_data_reference_slot_visitor(cell look_for,
 308                                    object* obj,
 309                                    factor_vm* parent,
 310                                    ostream& out)
 311     : look_for(look_for), obj(obj), parent(parent), out(out) {}
 312
 313   void operator()(cell* scan) {
 314     if (look_for == *scan) {
 315       out << padded_address((cell)obj) << " ";
 316       parent->print_nested_obj(out, tag_dynamic(obj), 2);
 317       out << endl;
 318     }
 319   }
 320 };
 321
 322 struct dump_edges_slot_visitor {
 323   object* obj;
 324   factor_vm* parent;
 325   ostream& out;
 326
 327   dump_edges_slot_visitor(cell, object* obj, factor_vm* parent, ostream& out)
 328       : obj(obj), parent(parent), out(out) {}
 329
 330   void operator()(cell* scan) {
 331     if (TAG(*scan) > F_TYPE)
 332       out << (void*)tag_dynamic(obj) << " ==> " << (void*)*scan << endl;
 333   }
 334 };
 335
 336 template <typename SlotVisitor> struct data_reference_object_visitor {
 337   cell look_for;
 338   factor_vm* parent;
 339   ostream& out;
 340
 341   data_reference_object_visitor(cell look_for, factor_vm* parent, ostream& out)
 342       : look_for(look_for), parent(parent), out(out) {}
 343
 344   void operator()(object* obj) {
 345     SlotVisitor visitor(look_for, obj, parent, out);
 346     obj->each_slot(visitor);
 347   }
 348 };
 349
 350 void factor_vm::find_data_references(ostream& out, cell look_for) {
 351   data_reference_object_visitor<find_data_reference_slot_visitor>
 352       visitor(look_for, this, out);
 353   each_object(visitor);
 354 }
 355
 356 void factor_vm::dump_edges(ostream& out) {
 357   data_reference_object_visitor<dump_edges_slot_visitor> visitor(0, this, out);
 358   each_object(visitor);
 359 }
 360
 361 struct code_block_printer {
 362   factor_vm* parent;
 363   ostream& out;
 364   cell reloc_size, parameter_size;
 365
 366   explicit code_block_printer(factor_vm* parent, ostream& out)
 367       : parent(parent), out(out), reloc_size(0), parameter_size(0) {}
 368
 369   void operator()(code_block* scan, cell size) {
 370     const char* status;
 371     if (scan->free_p())
 372       status = "free";
 373     else {
 374       reloc_size += parent->object_size(scan->relocation);
 375       parameter_size += parent->object_size(scan->parameters);
 376
 377       if (parent->code->allocator->state.marked_p((cell)scan))
 378         status = "marked";
 379       else
 380         status = "allocated";
 381
 382       out << hex << (cell)scan << dec << " ";
 383       out << hex << size << dec << " ";
 384       out << status << " ";
 385       out << "stack frame " << scan->stack_frame_size();
 386       out << endl;
 387     }
 388   }
 389 };
 390
 391 /* Dump all code blocks for debugging */
 392 void factor_vm::dump_code_heap(ostream& out) {
 393   code_block_printer printer(this, out);
 394   code->allocator->iterate(printer);
 395   out << printer.reloc_size << " bytes used by relocation tables" << endl;
 396   out << printer.parameter_size << " bytes used by parameter tables" << endl;
 397 }
 398
 399 void factor_vm::factorbug_usage(bool advanced_p) {
 400   cout << "Basic commands:" << endl;
 401 #ifdef WINDOWS
 402   cout << "  q ^Z             -- quit Factor" << endl;
 403 #else
 404   cout << "  q ^D             -- quit Factor" << endl;
 405 #endif
 406   cout << "  c                -- continue executing Factor - NOT SAFE"
 407        << endl;
 408   cout << "  t                -- throw exception in Factor - NOT SAFE"
 409        << endl;
 410   cout << "  .s .r .c         -- print data, retain, call stacks"
 411        << endl;
 412   if (advanced_p) {
 413     cout << "  help             -- reprint this message" << endl;
 414     cout << "Advanced commands:" << endl;
 415     cout << "  e                -- dump environment" << endl;
 416     cout << "  d <addr> <count> -- dump memory" << endl;
 417     cout << "  u <addr>         -- dump object at tagged <addr>"
 418          << endl;
 419     cout << "  . <addr>         -- print object at tagged <addr>"
 420          << endl;
 421     cout << "  g                -- dump generations" << endl;
 422     cout << "  ds dr            -- dump data, retain stacks" << endl;
 423     cout << "  trim             -- toggle output trimming" << endl;
 424     cout << "  data             -- data heap dump" << endl;
 425     cout << "  words            -- words dump" << endl;
 426     cout << "  tuples           -- tuples dump" << endl;
 427     cout << "  edges            -- print all object-to-object references"
 428          << endl;
 429     cout << "  refs <addr>      -- find data heap references to object"
 430          << endl;
 431     cout << "  push <addr>      -- push object on data stack - NOT SAFE"
 432          << endl;
 433     cout << "  gc               -- trigger full GC - NOT SAFE"
 434          << endl;
 435     cout << "  compact-gc       -- trigger compacting GC - NOT SAFE"
 436          << endl;
 437     cout << "  code             -- code heap dump" << endl;
 438     cout << "  abort            -- call abort()" << endl;
 439     cout << "  breakpoint       -- trigger system breakpoint" << endl;
 440   } else {
 441     cout << "  help             -- full help, including advanced commands"
 442          << endl;
 443   }
 444   cout << endl;
 445 }
 446
 447 static void exit_fep(factor_vm* vm) {
 448   unlock_console();
 449   handle_ctrl_c();
 450   vm->fep_p = false;
 451 }
 452
 453 void factor_vm::factorbug() {
 454   if (fep_disabled) {
 455     cout << "Low level debugger disabled" << endl;
 456     exit(1);
 457   }
 458
 459   if (sampling_profiler_p)
 460     end_sampling_profiler();
 461
 462   fep_p = true;
 463
 464   cout << "Starting low level debugger..." << endl;
 465
 466   // Even though we've stopped the VM, the stdin_loop thread (see os-*.cpp)
 467   // that pumps the console is still running concurrently. We lock a mutex so
 468   // the thread will take a break and give us exclusive access to stdin.
 469   lock_console();
 470   ignore_ctrl_c();
 471
 472   if (!fep_help_was_shown) {
 473     factorbug_usage(false);
 474     fep_help_was_shown = true;
 475   }
 476   bool seen_command = false;
 477
 478   for (;;) {
 479     std::string cmd;
 480
 481     cout << "> " << flush;
 482
 483     cin >> setw(1024) >> cmd >> setw(0);
 484     if (!cin.good()) {
 485       if (!seen_command) {
 486         /* If we exit with an EOF immediately, then
 487            dump stacks. This is useful for builder and
 488            other cases where Factor is run with stdin
 489            redirected to /dev/null */
 490         fep_disabled = true;
 491
 492         print_datastack(cout);
 493         print_retainstack(cout);
 494         print_callstack(cout);
 495       }
 496
 497       exit(1);
 498     }
 499
 500     seen_command = true;
 501
 502     if (cmd == "q")
 503       exit(1);
 504     if (cmd == "d") {
 505       cell addr = read_cell_hex();
 506       if (cin.peek() == ' ')
 507         cin.ignore();
 508
 509       if (!cin.good())
 510         break;
 511       cell count = read_cell_hex();
 512       dump_memory(cout, addr, addr + count);
 513     } else if (cmd == "u") {
 514       cell addr = read_cell_hex();
 515       cell count = object_size(addr);
 516       dump_memory(cout, addr, addr + count);
 517     } else if (cmd == ".") {
 518       cell addr = read_cell_hex();
 519       print_obj(cout, addr);
 520       cout << endl;
 521     } else if (cmd == "trim")
 522       full_output = !full_output;
 523     else if (cmd == "ds")
 524       dump_memory(cout, ctx->datastack_seg->start, ctx->datastack);
 525     else if (cmd == "dr")
 526       dump_memory(cout, ctx->retainstack_seg->start, ctx->retainstack);
 527     else if (cmd == ".s")
 528       print_datastack(cout);
 529     else if (cmd == ".r")
 530       print_retainstack(cout);
 531     else if (cmd == ".c")
 532       print_callstack(cout);
 533     else if (cmd == "e") {
 534       for (cell i = 0; i < special_object_count; i++)
 535         dump_cell(cout, (cell)&special_objects[i]);
 536     } else if (cmd == "g")
 537       dump_generations(cout);
 538     else if (cmd == "c") {
 539       exit_fep(this);
 540       return;
 541     } else if (cmd == "t") {
 542       exit_fep(this);
 543       general_error(ERROR_INTERRUPT, false_object, false_object);
 544       FACTOR_ASSERT(false);
 545     } else if (cmd == "data")
 546       dump_objects(cout, TYPE_COUNT);
 547     else if (cmd == "edges")
 548       dump_edges(cout);
 549     else if (cmd == "refs") {
 550       cell addr = read_cell_hex();
 551       cout << "Data heap references:" << endl;
 552       find_data_references(cout, addr);
 553       cout << endl;
 554     } else if (cmd == "words")
 555       dump_objects(cout, WORD_TYPE);
 556     else if (cmd == "tuples")
 557       dump_objects(cout, TUPLE_TYPE);
 558     else if (cmd == "push") {
 559       cell addr = read_cell_hex();
 560       ctx->push(addr);
 561     } else if (cmd == "code")
 562       dump_code_heap(cout);
 563     else if (cmd == "compact-gc")
 564       primitive_compact_gc();
 565     else if (cmd == "gc")
 566       primitive_full_gc();
 567     else if (cmd == "compact-gc")
 568       primitive_compact_gc();
 569     else if (cmd == "help")
 570       factorbug_usage(true);
 571     else if (cmd == "abort")
 572       abort();
 573     else if (cmd == "breakpoint")
 574       breakpoint();
 575     else
 576       cout << "unknown command" << endl;
 577   }
 578 }
 579
 580 void factor_vm::primitive_die() {
 581   cout << "The die word was called by the library. Unless you called it "
 582       "yourself," << endl;
 583   cout << "you have triggered a bug in Factor. Please report."
 584        << endl;
 585   factorbug();
 586 }
 587
 588 }