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->data()[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 *)ctx->datastack_seg->start,(cell *)ctx->datastack);
 149 }
 150
 151 void factor_vm::print_retainstack()
 152 {
 153         std::cout << "==== RETAIN STACK:\n";
 154         print_objects((cell *)ctx->retainstack_seg->start,(cell *)ctx->retainstack);
 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                 std::cout << "frame: " << std::hex << (cell)frame << std::dec << std::endl;
 164                 std::cout << "executing: ";
 165                 parent->print_obj(parent->frame_executing(frame));
 166                 std::cout << std::endl;
 167                 std::cout << "scan: ";
 168                 parent->print_obj(parent->frame_scan(frame));
 169                 std::cout << std::endl;
 170                 std::cout << "word/quot addr: ";
 171                 std::cout << std::hex << (cell)parent->frame_executing(frame) << std::dec;
 172                 std::cout << std::endl;
 173                 std::cout << "word/quot xt: ";
 174                 std::cout << std::hex << (cell)frame->entry_point << std::dec;
 175                 std::cout << std::endl;
 176                 std::cout << "return address: ";
 177                 std::cout << std::hex << (cell)FRAME_RETURN_ADDRESS(frame,parent) << std::dec;
 178                 std::cout << std::endl;
 179         }
 180 };
 181
 182 void factor_vm::print_callstack()
 183 {
 184         std::cout << "==== CALL STACK:\n";
 185         stack_frame_printer printer(this);
 186         iterate_callstack(ctx,printer);
 187 }
 188
 189 struct padded_address {
 190         cell value;
 191
 192         explicit padded_address(cell value_) : value(value_) {}
 193 };
 194
 195 std::ostream &operator<<(std::ostream &out, const padded_address &value)
 196 {
 197         char prev = out.fill('0');
 198         out.width(sizeof(cell) * 2);
 199         out << std::hex << value.value << std::dec;
 200         out.fill(prev);
 201         return out;
 202 }
 203
 204 void factor_vm::dump_cell(cell x)
 205 {
 206         std::cout << padded_address(x) << ": ";
 207         x = *(cell *)x;
 208         std::cout << padded_address(x) << " tag " << TAG(x) << std::endl;
 209 }
 210
 211 void factor_vm::dump_memory(cell from, cell to)
 212 {
 213         from = UNTAG(from);
 214
 215         for(; from <= to; from += sizeof(cell))
 216                 dump_cell(from);
 217 }
 218
 219 template<typename Generation>
 220 void factor_vm::dump_generation(const char *name, Generation *gen)
 221 {
 222         std::cout << name << ": ";
 223         std::cout << "Start=" << gen->start;
 224         std::cout << ", size=" << gen->size;
 225         std::cout << ", end=" << gen->end;
 226         std::cout << std::endl;
 227 }
 228
 229 void factor_vm::dump_generations()
 230 {
 231         dump_generation("Nursery",&nursery);
 232         dump_generation("Aging",data->aging);
 233         dump_generation("Tenured",data->tenured);
 234
 235         std::cout << "Cards:";
 236         std::cout << "base=" << (cell)data->cards << ", ";
 237         std::cout << "size=" << (cell)(data->cards_end - data->cards) << std::endl;
 238 }
 239
 240 struct object_dumper {
 241         factor_vm *parent;
 242         cell type;
 243
 244         explicit object_dumper(factor_vm *parent_, cell type_) :
 245                 parent(parent_), type(type_) {}
 246
 247         void operator()(object *obj)
 248         {
 249                 if(type == TYPE_COUNT || obj->type() == type)
 250                 {
 251                         std::cout << padded_address((cell)obj) << " ";
 252                         parent->print_nested_obj(tag_dynamic(obj),2);
 253                         std::cout << std::endl;
 254                 }
 255         }
 256 };
 257
 258 void factor_vm::dump_objects(cell type)
 259 {
 260         primitive_full_gc();
 261         object_dumper dumper(this,type);
 262         each_object(dumper);
 263 }
 264
 265 struct data_reference_slot_visitor {
 266         cell look_for;
 267         object *obj;
 268         factor_vm *parent;
 269
 270         explicit data_reference_slot_visitor(cell look_for_, object *obj_, factor_vm *parent_) :
 271                 look_for(look_for_), obj(obj_), parent(parent_) { }
 272
 273         void operator()(cell *scan)
 274         {
 275                 if(look_for == *scan)
 276                 {
 277                         std::cout << padded_address((cell)obj) << " ";
 278                         parent->print_nested_obj(tag_dynamic(obj),2);
 279                         std::cout << std::endl;
 280                 }
 281         }
 282 };
 283
 284 struct data_reference_object_visitor {
 285         cell look_for;
 286         factor_vm *parent;
 287
 288         explicit data_reference_object_visitor(cell look_for_, factor_vm *parent_) :
 289                 look_for(look_for_), parent(parent_) {}
 290
 291         void operator()(object *obj)
 292         {
 293                 data_reference_slot_visitor visitor(look_for,obj,parent);
 294                 obj->each_slot(visitor);
 295         }
 296 };
 297
 298 void factor_vm::find_data_references(cell look_for)
 299 {
 300         data_reference_object_visitor visitor(look_for,this);
 301         each_object(visitor);
 302 }
 303
 304 struct code_block_printer {
 305         factor_vm *parent;
 306         cell reloc_size, parameter_size;
 307
 308         explicit code_block_printer(factor_vm *parent_) :
 309                 parent(parent_), reloc_size(0), parameter_size(0) {}
 310
 311         void operator()(code_block *scan, cell size)
 312         {
 313                 const char *status;
 314                 if(scan->free_p())
 315                         status = "free";
 316                 else
 317                 {
 318                         reloc_size += parent->object_size(scan->relocation);
 319                         parameter_size += parent->object_size(scan->parameters);
 320
 321                         if(parent->code->marked_p(scan))
 322                                 status = "marked";
 323                         else
 324                                 status = "allocated";
 325
 326                         std::cout << std::hex << (cell)scan << std::dec << " ";
 327                         std::cout << std::hex << size << std::dec << " ";
 328                         std::cout << status << std::endl;
 329                 }
 330         }
 331 };
 332
 333 /* Dump all code blocks for debugging */
 334 void factor_vm::dump_code_heap()
 335 {
 336         code_block_printer printer(this);
 337         code->allocator->iterate(printer);
 338         std::cout << printer.reloc_size << " bytes used by relocation tables\n";
 339         std::cout << printer.parameter_size << " bytes used by parameter tables\n";
 340 }
 341
 342 void factor_vm::factorbug()
 343 {
 344         if(fep_disabled)
 345         {
 346                 std::cout << "Low level debugger disabled\n";
 347                 exit(1);
 348         }
 349
 350         /* open_console(); */
 351
 352         std::cout << "Starting low level debugger...\n";
 353         std::cout << "  Basic commands:\n";
 354         std::cout << "q                -- continue executing Factor - NOT SAFE\n";
 355         std::cout << "im               -- save image to fep.image\n";
 356         std::cout << "x                -- exit Factor\n";
 357         std::cout << "  Advanced commands:\n";
 358         std::cout << "d <addr> <count> -- dump memory\n";
 359         std::cout << "u <addr>         -- dump object at tagged <addr>\n";
 360         std::cout << ". <addr>         -- print object at tagged <addr>\n";
 361         std::cout << "t                -- toggle output trimming\n";
 362         std::cout << "s r              -- dump data, retain stacks\n";
 363         std::cout << ".s .r .c         -- print data, retain, call stacks\n";
 364         std::cout << "e                -- dump environment\n";
 365         std::cout << "g                -- dump generations\n";
 366         std::cout << "data             -- data heap dump\n";
 367         std::cout << "words            -- words dump\n";
 368         std::cout << "tuples           -- tuples dump\n";
 369         std::cout << "refs <addr>      -- find data heap references to object\n";
 370         std::cout << "push <addr>      -- push object on data stack - NOT SAFE\n";
 371         std::cout << "code             -- code heap dump\n";
 372
 373         bool seen_command = false;
 374
 375         for(;;)
 376         {
 377                 char cmd[1024];
 378
 379                 std::cout << "READY\n";
 380                 fflush(stdout);
 381
 382                 if(scanf("%1000s",cmd) <= 0)
 383                 {
 384                         if(!seen_command)
 385                         {
 386                                 /* If we exit with an EOF immediately, then
 387                                 dump stacks. This is useful for builder and
 388                                 other cases where Factor is run with stdin
 389                                 redirected to /dev/null */
 390                                 fep_disabled = true;
 391
 392                                 print_datastack();
 393                                 print_retainstack();
 394                                 print_callstack();
 395                         }
 396
 397                         exit(1);
 398                 }
 399
 400                 seen_command = true;
 401
 402                 if(strcmp(cmd,"d") == 0)
 403                 {
 404                         cell addr = read_cell_hex();
 405                         if(scanf(" ") < 0) break;
 406                         cell count = read_cell_hex();
 407                         dump_memory(addr,addr+count);
 408                 }
 409                 else if(strcmp(cmd,"u") == 0)
 410                 {
 411                         cell addr = read_cell_hex();
 412                         cell count = object_size(addr);
 413                         dump_memory(addr,addr+count);
 414                 }
 415                 else if(strcmp(cmd,".") == 0)
 416                 {
 417                         cell addr = read_cell_hex();
 418                         print_obj(addr);
 419                         std::cout << std::endl;
 420                 }
 421                 else if(strcmp(cmd,"t") == 0)
 422                         full_output = !full_output;
 423                 else if(strcmp(cmd,"s") == 0)
 424                         dump_memory(ctx->datastack_seg->start,ctx->datastack);
 425                 else if(strcmp(cmd,"r") == 0)
 426                         dump_memory(ctx->retainstack_seg->start,ctx->retainstack);
 427                 else if(strcmp(cmd,".s") == 0)
 428                         print_datastack();
 429                 else if(strcmp(cmd,".r") == 0)
 430                         print_retainstack();
 431                 else if(strcmp(cmd,".c") == 0)
 432                         print_callstack();
 433                 else if(strcmp(cmd,"e") == 0)
 434                 {
 435                         for(cell i = 0; i < special_object_count; i++)
 436                                 dump_cell((cell)&special_objects[i]);
 437                 }
 438                 else if(strcmp(cmd,"g") == 0)
 439                         dump_generations();
 440                 else if(strcmp(cmd,"q") == 0)
 441                         return;
 442                 else if(strcmp(cmd,"x") == 0)
 443                         exit(1);
 444                 else if(strcmp(cmd,"im") == 0)
 445                         save_image(STRING_LITERAL("fep.image.saving"),STRING_LITERAL("fep.image"));
 446                 else if(strcmp(cmd,"data") == 0)
 447                         dump_objects(TYPE_COUNT);
 448                 else if(strcmp(cmd,"refs") == 0)
 449                 {
 450                         cell addr = read_cell_hex();
 451                         std::cout << "Data heap references:\n";
 452                         find_data_references(addr);
 453                         std::cout << std::endl;
 454                 }
 455                 else if(strcmp(cmd,"words") == 0)
 456                         dump_objects(WORD_TYPE);
 457                 else if(strcmp(cmd,"tuples") == 0)
 458                         dump_objects(TUPLE_TYPE);
 459                 else if(strcmp(cmd,"push") == 0)
 460                 {
 461                         cell addr = read_cell_hex();
 462                         ctx->push(addr);
 463                 }
 464                 else if(strcmp(cmd,"code") == 0)
 465                         dump_code_heap();
 466                 else
 467                         std::cout << "unknown command\n";
 468         }
 469 }
 470
 471 void factor_vm::primitive_die()
 472 {
 473         std::cout << "The die word was called by the library. Unless you called it yourself,\n";
 474         std::cout << "you have triggered a bug in Factor. Please report.\n";
 475         factorbug();
 476 }
 477
 478 }