extra/tools/image-analyzer/gc-info/gc-info-docs.factor

   1 USING: assocs help.markup help.syntax vm words ;
   2 IN: tools.image-analyzer.gc-info
   3
   4 ARTICLE: "tools.image-analyzer.gc-info" "GC maps decoder"
   5 "A vocab that disassembles words gc maps. It's useful to have when debugging garbage collection issues." ;
   6
   7 HELP: word>gc-maps
   8 { $values { "word" word } { "gc-maps" assoc } }
   9 { $description "Main word of the vocab. Decodes the gc maps for a word into an assoc with the following format:"
  10   { $list
  11     "Each key is the return addess of a gc callsite (as an offset relative to the blocks entry point)."
  12     {
  13         "Each value is a two-tuple where:"
  14         { $list
  15           "The first element contains the scrub patterns for the gc roots."
  16           "The second element is a sequence of derived roots for the callsite."
  17         }
  18     }
  19   }
  20 }
  21 { $examples
  22   { $unchecked-example
  23     "USING: effects prettyprint ;"
  24     "\\ <effect> word>gc-maps ."
  25     "{ { 155 { ?{ f t t t t } { } } } }"
  26   }
  27 } ;
  28
  29 ABOUT: "tools.image-analyzer.gc-info"