6 std::ostream &operator<<(std::ostream &out, const string *str)
8 for(cell i = 0; i < string_capacity(str); i++)
9 out << (char)str->data()[i];
13 void factor_vm::print_word(word *word, cell nesting)
15 if(tagged<object>(word->vocabulary).type_p(STRING_TYPE))
16 std::cout << untag<string>(word->vocabulary) << ":";
18 if(tagged<object>(word->name).type_p(STRING_TYPE))
19 std::cout << untag<string>(word->name);
22 std::cout << "#<not a string: ";
23 print_nested_obj(word->name,nesting);
28 void factor_vm::print_factor_string(string *str)
30 std::cout << '"' << str << '"';
33 void factor_vm::print_array(array *array, cell nesting)
35 cell length = array_capacity(array);
39 if(length > 10 && !full_output)
47 for(i = 0; i < length; i++)
50 print_nested_obj(array_nth(array,i),nesting);
57 void factor_vm::print_alien(alien *alien, cell nesting)
59 if (to_boolean(alien->expired))
60 std::cout << "#<expired alien>";
61 else if (to_boolean(alien->base))
63 std::cout << "#<displaced alien " << alien->displacement << "+";
64 print_nested_obj(alien->base, nesting);
69 std::cout << "#<alien " << (void*)alien->address << ">";
73 void factor_vm::print_byte_array(byte_array *array, cell nesting)
75 cell length = array->capacity;
78 unsigned char *data = array->data<unsigned char>();
80 if(length > 16 && !full_output)
88 for(i = 0; i < length; i++)
90 std::cout << " " << (unsigned)data[i];
97 void factor_vm::print_tuple(tuple *tuple, cell nesting)
99 tuple_layout *layout = untag<tuple_layout>(tuple->layout);
100 cell length = to_fixnum(layout->size);
103 print_nested_obj(layout->klass,nesting);
106 if(length > 10 && !full_output)
114 for(cell i = 0; i < length; i++)
117 print_nested_obj(tuple->data()[i],nesting);
124 void factor_vm::print_nested_obj(cell obj, fixnum nesting)
126 if(nesting <= 0 && !full_output)
128 std::cout << " ... ";
134 switch(tagged<object>(obj).type())
137 std::cout << untag_fixnum(obj);
140 std::cout << untag_float(obj);
143 print_word(untag<word>(obj),nesting - 1);
146 print_factor_string(untag<string>(obj));
153 print_tuple(untag<tuple>(obj),nesting - 1);
158 print_nested_obj(untag<wrapper>(obj)->object,nesting - 1);
161 case BYTE_ARRAY_TYPE:
163 print_byte_array(untag<byte_array>(obj),nesting - 1);
168 print_array(untag<array>(obj),nesting - 1);
173 quot = untag<quotation>(obj);
174 print_array(untag<array>(quot->array),nesting - 1);
178 print_alien(untag<alien>(obj), nesting - 1);
181 std::cout << "#<" << type_name(tagged<object>(obj).type()) << " @ ";
182 std::cout << (void*)obj << ">";
187 void factor_vm::print_obj(cell obj)
189 print_nested_obj(obj,10);
192 void factor_vm::print_objects(cell *start, cell *end)
194 for(; start <= end; start++)
197 std::cout << std::endl;
201 void factor_vm::print_datastack()
203 std::cout << "==== DATA STACK:" << std::endl;
205 print_objects((cell *)ctx->datastack_seg->start,(cell *)ctx->datastack);
207 std::cout << "*** Context not initialized" << std::endl;
210 void factor_vm::print_retainstack()
212 std::cout << "==== RETAIN STACK:" << std::endl;
214 print_objects((cell *)ctx->retainstack_seg->start,(cell *)ctx->retainstack);
216 std::cout << "*** Context not initialized" << std::endl;
219 struct stack_frame_printer {
222 explicit stack_frame_printer(factor_vm *parent_) : parent(parent_) {}
223 void operator()(stack_frame *frame)
225 std::cout << "frame: " << std::hex << (cell)frame << std::dec << std::endl;
226 std::cout << "executing: ";
227 parent->print_obj(parent->frame_executing(frame));
228 std::cout << std::endl;
229 std::cout << "scan: ";
230 parent->print_obj(parent->frame_scan(frame));
231 std::cout << std::endl;
232 std::cout << "word/quot addr: ";
233 std::cout << std::hex << (cell)parent->frame_executing(frame) << std::dec;
234 std::cout << std::endl;
235 std::cout << "word/quot xt: ";
236 std::cout << std::hex << (cell)frame->entry_point << std::dec;
237 std::cout << std::endl;
238 std::cout << "return address: ";
239 std::cout << std::hex << (cell)FRAME_RETURN_ADDRESS(frame,parent) << std::dec;
240 std::cout << std::endl;
244 void factor_vm::print_callstack()
246 std::cout << "==== CALL STACK:" << std::endl;
249 stack_frame_printer printer(this);
250 iterate_callstack(ctx,printer);
253 std::cout << "*** Context not initialized" << std::endl;
256 struct padded_address {
259 explicit padded_address(cell value_) : value(value_) {}
262 std::ostream &operator<<(std::ostream &out, const padded_address &value)
264 char prev = out.fill('0');
265 out.width(sizeof(cell) * 2);
266 out << std::hex << value.value << std::dec;
271 void factor_vm::dump_cell(cell x)
273 std::cout << padded_address(x) << ": ";
275 std::cout << padded_address(x) << " tag " << TAG(x) << std::endl;
278 void factor_vm::dump_memory(cell from, cell to)
282 for(; from <= to; from += sizeof(cell))
286 template<typename Generation>
287 void factor_vm::dump_generation(const char *name, Generation *gen)
289 std::cout << name << ": ";
290 std::cout << "Start=" << gen->start;
291 std::cout << ", size=" << gen->size;
292 std::cout << ", end=" << gen->end;
293 std::cout << std::endl;
296 void factor_vm::dump_generations()
298 std::cout << std::hex;
300 dump_generation("Nursery",&nursery);
301 dump_generation("Aging",data->aging);
302 dump_generation("Tenured",data->tenured);
304 std::cout << "Cards:";
305 std::cout << "base=" << (cell)data->cards << ", ";
306 std::cout << "size=" << (cell)(data->cards_end - data->cards) << std::endl;
308 std::cout << std::dec;
311 struct object_dumper {
315 explicit object_dumper(factor_vm *parent_, cell type_) :
316 parent(parent_), type(type_) {}
318 void operator()(object *obj)
320 if(type == TYPE_COUNT || obj->type() == type)
322 std::cout << padded_address((cell)obj) << " ";
323 parent->print_nested_obj(tag_dynamic(obj),2);
324 std::cout << std::endl;
329 void factor_vm::dump_objects(cell type)
332 object_dumper dumper(this,type);
336 struct find_data_reference_slot_visitor {
341 explicit find_data_reference_slot_visitor(cell look_for_, object *obj_, factor_vm *parent_) :
342 look_for(look_for_), obj(obj_), parent(parent_) { }
344 void operator()(cell *scan)
346 if(look_for == *scan)
348 std::cout << padded_address((cell)obj) << " ";
349 parent->print_nested_obj(tag_dynamic(obj),2);
350 std::cout << std::endl;
355 struct dump_edges_slot_visitor {
359 explicit dump_edges_slot_visitor(cell, object *obj_, factor_vm *parent_) :
360 obj(obj_), parent(parent_) { }
362 void operator()(cell *scan)
364 if (TAG(*scan) > F_TYPE)
365 std::cout << (void*)tag_dynamic(obj) << " ==> " << (void*)*scan << std::endl;
369 template <typename SlotVisitor>
370 struct data_reference_object_visitor {
374 explicit data_reference_object_visitor(cell look_for_, factor_vm *parent_) :
375 look_for(look_for_), parent(parent_) {}
377 void operator()(object *obj)
379 SlotVisitor visitor(look_for,obj,parent);
380 obj->each_slot(visitor);
384 void factor_vm::find_data_references(cell look_for)
386 data_reference_object_visitor<find_data_reference_slot_visitor> visitor(look_for,this);
387 each_object(visitor);
390 void factor_vm::dump_edges()
392 data_reference_object_visitor<dump_edges_slot_visitor> visitor(0,this);
393 each_object(visitor);
396 struct code_block_printer {
398 cell reloc_size, parameter_size;
400 explicit code_block_printer(factor_vm *parent_) :
401 parent(parent_), reloc_size(0), parameter_size(0) {}
403 void operator()(code_block *scan, cell size)
410 reloc_size += parent->object_size(scan->relocation);
411 parameter_size += parent->object_size(scan->parameters);
413 if(parent->code->marked_p(scan))
416 status = "allocated";
418 std::cout << std::hex << (cell)scan << std::dec << " ";
419 std::cout << std::hex << size << std::dec << " ";
420 std::cout << status << std::endl;
425 /* Dump all code blocks for debugging */
426 void factor_vm::dump_code_heap()
428 code_block_printer printer(this);
429 code->allocator->iterate(printer);
430 std::cout << printer.reloc_size << " bytes used by relocation tables" << std::endl;
431 std::cout << printer.parameter_size << " bytes used by parameter tables" << std::endl;
434 void factor_vm::factorbug_usage(bool advanced_p)
436 std::cout << "Basic commands:" << std::endl;
438 std::cout << " q ^Z -- quit Factor" << std::endl;
440 std::cout << " q ^D -- quit Factor" << std::endl;
442 std::cout << " c -- continue executing Factor - NOT SAFE" << std::endl;
443 std::cout << " t -- throw exception in Factor - NOT SAFE" << std::endl;
444 std::cout << " .s .r .c -- print data, retain, call stacks" << std::endl;
447 std::cout << " help -- reprint this message" << std::endl;
448 std::cout << "Advanced commands:" << std::endl;
449 std::cout << " e -- dump environment" << std::endl;
450 std::cout << " d <addr> <count> -- dump memory" << std::endl;
451 std::cout << " u <addr> -- dump object at tagged <addr>" << std::endl;
452 std::cout << " . <addr> -- print object at tagged <addr>" << std::endl;
453 std::cout << " g -- dump generations" << std::endl;
454 std::cout << " ds dr -- dump data, retain stacks" << std::endl;
455 std::cout << " trim -- toggle output trimming" << std::endl;
456 std::cout << " data -- data heap dump" << std::endl;
457 std::cout << " words -- words dump" << std::endl;
458 std::cout << " tuples -- tuples dump" << std::endl;
459 std::cout << " edges -- print all object-to-object references" << std::endl;
460 std::cout << " refs <addr> -- find data heap references to object" << std::endl;
461 std::cout << " push <addr> -- push object on data stack - NOT SAFE" << std::endl;
462 std::cout << " gc -- trigger full GC - NOT SAFE" << std::endl;
463 std::cout << " code -- code heap dump" << std::endl;
464 std::cout << " abort -- call abort()" << std::endl;
465 std::cout << " breakpoint -- trigger system breakpoint" << std::endl;
469 std::cout << " help -- full help, including advanced commands" << std::endl;
472 std::cout << std::endl;
476 static void exit_fep(factor_vm *vm)
478 vm->unlock_console();
483 void factor_vm::factorbug()
487 std::cout << "Low level debugger disabled" << std::endl;
491 if (sampling_profiler_p)
492 end_sampling_profiler();
496 std::cout << "Starting low level debugger..." << std::endl;
498 // Even though we've stopped the VM, the stdin_loop thread (see os-*.cpp)
499 // that pumps the console is still running concurrently. We lock a mutex so
500 // the thread will take a break and give us exclusive access to stdin.
504 if (!fep_help_was_shown) {
505 factorbug_usage(false);
506 fep_help_was_shown = true;
508 bool seen_command = false;
514 std::cout << "> " << std::flush;
516 std::cin >> std::setw(1024) >> cmd >> std::setw(0);
521 /* If we exit with an EOF immediately, then
522 dump stacks. This is useful for builder and
523 other cases where Factor is run with stdin
524 redirected to /dev/null */
537 if(strcmp(cmd,"q") == 0)
539 if(strcmp(cmd,"d") == 0)
541 cell addr = read_cell_hex();
542 if (std::cin.peek() == ' ')
545 if(!std::cin.good()) break;
546 cell count = read_cell_hex();
547 dump_memory(addr,addr+count);
549 else if(strcmp(cmd,"u") == 0)
551 cell addr = read_cell_hex();
552 cell count = object_size(addr);
553 dump_memory(addr,addr+count);
555 else if(strcmp(cmd,".") == 0)
557 cell addr = read_cell_hex();
559 std::cout << std::endl;
561 else if(strcmp(cmd,"trim") == 0)
562 full_output = !full_output;
563 else if(strcmp(cmd,"ds") == 0)
564 dump_memory(ctx->datastack_seg->start,ctx->datastack);
565 else if(strcmp(cmd,"dr") == 0)
566 dump_memory(ctx->retainstack_seg->start,ctx->retainstack);
567 else if(strcmp(cmd,".s") == 0)
569 else if(strcmp(cmd,".r") == 0)
571 else if(strcmp(cmd,".c") == 0)
573 else if(strcmp(cmd,"e") == 0)
575 for(cell i = 0; i < special_object_count; i++)
576 dump_cell((cell)&special_objects[i]);
578 else if(strcmp(cmd,"g") == 0)
580 else if(strcmp(cmd,"c") == 0)
585 else if(strcmp(cmd,"t") == 0)
588 general_error(ERROR_INTERRUPT,false_object,false_object);
589 FACTOR_ASSERT(false);
591 else if(strcmp(cmd,"data") == 0)
592 dump_objects(TYPE_COUNT);
593 else if(strcmp(cmd,"edges") == 0)
595 else if(strcmp(cmd,"refs") == 0)
597 cell addr = read_cell_hex();
598 std::cout << "Data heap references:" << std::endl;
599 find_data_references(addr);
600 std::cout << std::endl;
602 else if(strcmp(cmd,"words") == 0)
603 dump_objects(WORD_TYPE);
604 else if(strcmp(cmd,"tuples") == 0)
605 dump_objects(TUPLE_TYPE);
606 else if(strcmp(cmd,"push") == 0)
608 cell addr = read_cell_hex();
611 else if(strcmp(cmd,"code") == 0)
613 else if(strcmp(cmd,"gc") == 0)
615 else if(strcmp(cmd,"help") == 0)
616 factorbug_usage(true);
617 else if(strcmp(cmd,"abort") == 0)
619 else if(strcmp(cmd,"breakpoint") == 0)
622 std::cout << "unknown command" << std::endl;
626 void factor_vm::primitive_die()
628 std::cout << "The die word was called by the library. Unless you called it yourself," << std::endl;
629 std::cout << "you have triggered a bug in Factor. Please report." << std::endl;