vm/debug.cpp

   1 #include "master.hpp"
   2
   3 namespace factor
   4 {
   5
   6 std::ostream &operator<<(std::ostream &out, const string *str)
   7 {
   8         for(cell i = 0; i < string_capacity(str); i++)
   9                 out << (char)str->nth(i);
  10         return out;
  11 }
  12
  13 void factor_vm::print_word(word* word, cell nesting)
  14 {
  15         if(tagged<object>(word->vocabulary).type_p(STRING_TYPE))
  16                 std::cout << untag<string>(word->vocabulary) << ":";
  17
  18         if(tagged<object>(word->name).type_p(STRING_TYPE))
  19                 std::cout << untag<string>(word->name);
  20         else
  21         {
  22                 std::cout << "#<not a string: ";
  23                 print_nested_obj(word->name,nesting);
  24                 std::cout << ">";
  25         }
  26 }
  27
  28 void factor_vm::print_factor_string(string *str)
  29 {
  30         std::cout << '"' << str << '"';
  31 }
  32
  33 void factor_vm::print_array(array* array, cell nesting)
  34 {
  35         cell length = array_capacity(array);
  36         cell i;
  37         bool trimmed;
  38
  39         if(length > 10 && !full_output)
  40         {
  41                 trimmed = true;
  42                 length = 10;
  43         }
  44         else
  45                 trimmed = false;
  46
  47         for(i = 0; i < length; i++)
  48         {
  49                 std::cout << " ";
  50                 print_nested_obj(array_nth(array,i),nesting);
  51         }
  52
  53         if(trimmed)
  54                 std::cout << "...";
  55 }
  56
  57 void factor_vm::print_tuple(tuple *tuple, cell nesting)
  58 {
  59         tuple_layout *layout = untag<tuple_layout>(tuple->layout);
  60         cell length = to_fixnum(layout->size);
  61
  62         std::cout << " ";
  63         print_nested_obj(layout->klass,nesting);
  64
  65         bool trimmed;
  66         if(length > 10 && !full_output)
  67         {
  68                 trimmed = true;
  69                 length = 10;
  70         }
  71         else
  72                 trimmed = false;
  73
  74         for(cell i = 0; i < length; i++)
  75         {
  76                 std::cout << " ";
  77                 print_nested_obj(tuple->data()[i],nesting);
  78         }
  79
  80         if(trimmed)
  81                 std::cout << "...";
  82 }
  83
  84 void factor_vm::print_nested_obj(cell obj, fixnum nesting)
  85 {
  86         if(nesting <= 0 && !full_output)
  87         {
  88                 std::cout << " ... ";
  89                 return;
  90         }
  91
  92         quotation *quot;
  93
  94         switch(tagged<object>(obj).type())
  95         {
  96         case FIXNUM_TYPE:
  97                 std::cout << untag_fixnum(obj);
  98                 break;
  99         case WORD_TYPE:
 100                 print_word(untag<word>(obj),nesting - 1);
 101                 break;
 102         case STRING_TYPE:
 103                 print_factor_string(untag<string>(obj));
 104                 break;
 105         case F_TYPE:
 106                 std::cout << "f";
 107                 break;
 108         case TUPLE_TYPE:
 109                 std::cout << "T{";
 110                 print_tuple(untag<tuple>(obj),nesting - 1);
 111                 std::cout << " }";
 112                 break;
 113         case ARRAY_TYPE:
 114                 std::cout << "{";
 115                 print_array(untag<array>(obj),nesting - 1);
 116                 std::cout << " }";
 117                 break;
 118         case QUOTATION_TYPE:
 119                 std::cout << "[";
 120                 quot = untag<quotation>(obj);
 121                 print_array(untag<array>(quot->array),nesting - 1);
 122                 std::cout << " ]";
 123                 break;
 124         default:
 125                 std::cout << "#<type " << tagged<object>(obj).type() << " @ ";
 126                 std::cout << std::hex << obj << std::dec << ">";
 127                 break;
 128         }
 129 }
 130
 131 void factor_vm::print_obj(cell obj)
 132 {
 133         print_nested_obj(obj,10);
 134 }
 135
 136 void factor_vm::print_objects(cell *start, cell *end)
 137 {
 138         for(; start <= end; start++)
 139         {
 140                 print_obj(*start);
 141                 std::cout << std::endl;
 142         }
 143 }
 144
 145 void factor_vm::print_datastack()
 146 {
 147         std::cout << "==== DATA STACK:\n";
 148         print_objects((cell *)ds_bot,(cell *)ds);
 149 }
 150
 151 void factor_vm::print_retainstack()
 152 {
 153         std::cout << "==== RETAIN STACK:\n";
 154         print_objects((cell *)rs_bot,(cell *)rs);
 155 }
 156
 157 struct stack_frame_printer {
 158         factor_vm *parent;
 159
 160         explicit stack_frame_printer(factor_vm *parent_) : parent(parent_) {}
 161         void operator()(stack_frame *frame)
 162         {
 163                 parent->print_obj(parent->frame_executing(frame));
 164                 std::cout << std::endl;
 165                 parent->print_obj(parent->frame_scan(frame));
 166                 std::cout << std::endl;
 167                 std::cout << "word/quot addr: ";
 168                 std::cout << std::hex << (cell)parent->frame_executing(frame) << std::dec;
 169                 std::cout << std::endl;
 170                 std::cout << "word/quot xt: ";
 171                 std::cout << std::hex << (cell)frame->xt << std::dec;
 172                 std::cout << std::endl;
 173                 std::cout << "return address: ";
 174                 std::cout << std::hex << (cell)FRAME_RETURN_ADDRESS(frame,parent) << std::dec;
 175                 std::cout << std::endl;
 176         }
 177 };
 178
 179 void factor_vm::print_callstack()
 180 {
 181         std::cout << "==== CALL STACK:\n";
 182         stack_frame_printer printer(this);
 183         iterate_callstack(ctx,printer);
 184 }
 185
 186 struct padded_address {
 187         cell value;
 188
 189         explicit padded_address(cell value_) : value(value_) {}
 190 };
 191
 192 std::ostream &operator<<(std::ostream &out, const padded_address &value)
 193 {
 194         char prev = out.fill('0');
 195         out.width(sizeof(cell) * 2);
 196         out << std::hex << value.value << std::dec;
 197         out.fill(prev);
 198         return out;
 199 }
 200
 201 void factor_vm::dump_cell(cell x)
 202 {
 203         std::cout << padded_address(x) << ": ";
 204         x = *(cell *)x;
 205         std::cout << padded_address(x) << " tag " << TAG(x) << std::endl;
 206 }
 207
 208 void factor_vm::dump_memory(cell from, cell to)
 209 {
 210         from = UNTAG(from);
 211
 212         for(; from <= to; from += sizeof(cell))
 213                 dump_cell(from);
 214 }
 215
 216 template<typename Generation>
 217 void factor_vm::dump_generation(const char *name, Generation *gen)
 218 {
 219         std::cout << name << ": ";
 220         std::cout << "Start=" << gen->start;
 221         std::cout << ", size=" << gen->size;
 222         std::cout << ", end=" << gen->end;
 223         std::cout << std::endl;
 224 }
 225
 226 void factor_vm::dump_generations()
 227 {
 228         dump_generation("Nursery",&nursery);
 229         dump_generation("Aging",data->aging);
 230         dump_generation("Tenured",data->tenured);
 231
 232         std::cout << "Cards:";
 233         std::cout << "base=" << (cell)data->cards << ", ";
 234         std::cout << "size=" << (cell)(data->cards_end - data->cards) << std::endl;
 235 }
 236
 237 struct object_dumper {
 238         factor_vm *parent;
 239         cell type;
 240
 241         explicit object_dumper(factor_vm *parent_, cell type_) :
 242                 parent(parent_), type(type_) {}
 243
 244         void operator()(object *obj)
 245         {
 246                 if(type == TYPE_COUNT || obj->type() == type)
 247                 {
 248                         std::cout << padded_address((cell)obj) << " ";
 249                         parent->print_nested_obj(tag_dynamic(obj),2);
 250                         std::cout << std::endl;
 251                 }
 252         }
 253 };
 254
 255 void factor_vm::dump_objects(cell type)
 256 {
 257         primitive_full_gc();
 258         object_dumper dumper(this,type);
 259         each_object(dumper);
 260 }
 261
 262 struct data_reference_slot_visitor {
 263         cell look_for;
 264         object *obj;
 265         factor_vm *parent;
 266
 267         explicit data_reference_slot_visitor(cell look_for_, object *obj_, factor_vm *parent_) :
 268                 look_for(look_for_), obj(obj_), parent(parent_) { }
 269
 270         void operator()(cell *scan)
 271         {
 272                 if(look_for == *scan)
 273                 {
 274                         std::cout << padded_address((cell)obj) << " ";
 275                         parent->print_nested_obj(tag_dynamic(obj),2);
 276                         std::cout << std::endl;
 277                 }
 278         }
 279 };
 280
 281 struct data_reference_object_visitor {
 282         cell look_for;
 283         factor_vm *parent;
 284
 285         explicit data_reference_object_visitor(cell look_for_, factor_vm *parent_) :
 286                 look_for(look_for_), parent(parent_) {}
 287
 288         void operator()(object *obj)
 289         {
 290                 data_reference_slot_visitor visitor(look_for,obj,parent);
 291                 obj->each_slot(visitor);
 292         }
 293 };
 294
 295 void factor_vm::find_data_references(cell look_for)
 296 {
 297         data_reference_object_visitor visitor(look_for,this);
 298         each_object(visitor);
 299 }
 300
 301 struct code_block_printer {
 302         factor_vm *parent;
 303         cell reloc_size, parameter_size;
 304
 305         explicit code_block_printer(factor_vm *parent_) :
 306                 parent(parent_), reloc_size(0), parameter_size(0) {}
 307
 308         void operator()(code_block *scan, cell size)
 309         {
 310                 const char *status;
 311                 if(scan->free_p())
 312                         status = "free";
 313                 else
 314                 {
 315                         reloc_size += parent->object_size(scan->relocation);
 316                         parameter_size += parent->object_size(scan->parameters);
 317
 318                         if(parent->code->marked_p(scan))
 319                                 status = "marked";
 320                         else
 321                                 status = "allocated";
 322
 323                         std::cout << std::hex << (cell)scan << std::dec << " ";
 324                         std::cout << std::hex << size << std::dec << " ";
 325                         std::cout << status << std::endl;
 326                 }
 327         }
 328 };
 329
 330 /* Dump all code blocks for debugging */
 331 void factor_vm::dump_code_heap()
 332 {
 333         code_block_printer printer(this);
 334         code->allocator->iterate(printer);
 335         std::cout << printer.reloc_size << " bytes used by relocation tables\n";
 336         std::cout << printer.parameter_size << " bytes used by parameter tables\n";
 337 }
 338
 339 void factor_vm::factorbug()
 340 {
 341         if(fep_disabled)
 342         {
 343                 std::cout << "Low level debugger disabled\n";
 344                 exit(1);
 345         }
 346
 347         /* open_console(); */
 348
 349         std::cout << "Starting low level debugger...\n";
 350         std::cout << "  Basic commands:\n";
 351         std::cout << "q                -- continue executing Factor - NOT SAFE\n";
 352         std::cout << "im               -- save image to fep.image\n";
 353         std::cout << "x                -- exit Factor\n";
 354         std::cout << "  Advanced commands:\n";
 355         std::cout << "d <addr> <count> -- dump memory\n";
 356         std::cout << "u <addr>         -- dump object at tagged <addr>\n";
 357         std::cout << ". <addr>         -- print object at tagged <addr>\n";
 358         std::cout << "t                -- toggle output trimming\n";
 359         std::cout << "s r              -- dump data, retain stacks\n";
 360         std::cout << ".s .r .c         -- print data, retain, call stacks\n";
 361         std::cout << "e                -- dump environment\n";
 362         std::cout << "g                -- dump generations\n";
 363         std::cout << "data             -- data heap dump\n";
 364         std::cout << "words            -- words dump\n";
 365         std::cout << "tuples           -- tuples dump\n";
 366         std::cout << "refs <addr>      -- find data heap references to object\n";
 367         std::cout << "push <addr>      -- push object on data stack - NOT SAFE\n";
 368         std::cout << "code             -- code heap dump\n";
 369
 370         bool seen_command = false;
 371
 372         for(;;)
 373         {
 374                 char cmd[1024];
 375
 376                 std::cout << "READY\n";
 377                 fflush(stdout);
 378
 379                 if(scanf("%1000s",cmd) <= 0)
 380                 {
 381                         if(!seen_command)
 382                         {
 383                                 /* If we exit with an EOF immediately, then
 384                                 dump stacks. This is useful for builder and
 385                                 other cases where Factor is run with stdin
 386                                 redirected to /dev/null */
 387                                 fep_disabled = true;
 388
 389                                 print_datastack();
 390                                 print_retainstack();
 391                                 print_callstack();
 392                         }
 393
 394                         exit(1);
 395                 }
 396
 397                 seen_command = true;
 398
 399                 if(strcmp(cmd,"d") == 0)
 400                 {
 401                         cell addr = read_cell_hex();
 402                         if(scanf(" ") < 0) break;
 403                         cell count = read_cell_hex();
 404                         dump_memory(addr,addr+count);
 405                 }
 406                 else if(strcmp(cmd,"u") == 0)
 407                 {
 408                         cell addr = read_cell_hex();
 409                         cell count = object_size(addr);
 410                         dump_memory(addr,addr+count);
 411                 }
 412                 else if(strcmp(cmd,".") == 0)
 413                 {
 414                         cell addr = read_cell_hex();
 415                         print_obj(addr);
 416                         std::cout << std::endl;
 417                 }
 418                 else if(strcmp(cmd,"t") == 0)
 419                         full_output = !full_output;
 420                 else if(strcmp(cmd,"s") == 0)
 421                         dump_memory(ds_bot,ds);
 422                 else if(strcmp(cmd,"r") == 0)
 423                         dump_memory(rs_bot,rs);
 424                 else if(strcmp(cmd,".s") == 0)
 425                         print_datastack();
 426                 else if(strcmp(cmd,".r") == 0)
 427                         print_retainstack();
 428                 else if(strcmp(cmd,".c") == 0)
 429                         print_callstack();
 430                 else if(strcmp(cmd,"e") == 0)
 431                 {
 432                         for(cell i = 0; i < special_object_count; i++)
 433                                 dump_cell((cell)&special_objects[i]);
 434                 }
 435                 else if(strcmp(cmd,"g") == 0)
 436                         dump_generations();
 437                 else if(strcmp(cmd,"q") == 0)
 438                         return;
 439                 else if(strcmp(cmd,"x") == 0)
 440                         exit(1);
 441                 else if(strcmp(cmd,"im") == 0)
 442                         save_image(STRING_LITERAL("fep.image"));
 443                 else if(strcmp(cmd,"data") == 0)
 444                         dump_objects(TYPE_COUNT);
 445                 else if(strcmp(cmd,"refs") == 0)
 446                 {
 447                         cell addr = read_cell_hex();
 448                         std::cout << "Data heap references:\n";
 449                         find_data_references(addr);
 450                         std::cout << std::endl;
 451                 }
 452                 else if(strcmp(cmd,"words") == 0)
 453                         dump_objects(WORD_TYPE);
 454                 else if(strcmp(cmd,"tuples") == 0)
 455                         dump_objects(TUPLE_TYPE);
 456                 else if(strcmp(cmd,"push") == 0)
 457                 {
 458                         cell addr = read_cell_hex();
 459                         dpush(addr);
 460                 }
 461                 else if(strcmp(cmd,"code") == 0)
 462                         dump_code_heap();
 463                 else
 464                         std::cout << "unknown command\n";
 465         }
 466 }
 467
 468 void factor_vm::primitive_die()
 469 {
 470         std::cout << "The die word was called by the library. Unless you called it yourself,\n";
 471         std::cout << "you have triggered a bug in Factor. Please report.\n";
 472         factorbug();
 473 }
 474
 475 }