steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

compiler.codegen.gc-maps: update docs so that they match how factors gc-maps currently work

db4
Björn Lindqvist 2014-10-19 14:17:54 +02:00
parent a617855aef
commit 961d0c4eb9
2 changed files with 17 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
basis/compiler/codegen/gc-maps/gc-maps-docs.factor
View File

@ -8,28 +8,28 @@ ARTICLE: "compiler.codegen.gc-maps" "GC maps"
"or" "or"
{ $list { $list
{ {
"bitmap, byte aligned, three subsequences:" "bitmap, byte aligned, five subsequences:"
{ $list { $list
"<scrubbed data stack locations>" "scrubbed data stack locations"
"<scrubbed retain stack locations>" "scrubbed retain stack locations"
"<GC root spill slots>" "checked data stack locations"
"checked retain stack locations"
"GC root spill slots"
} }
} }
"uint[] <base pointers>" "uint[] base pointers"
"uint[] <return addresses>" "uint[] return addresses"
"uint <largest scrubbed data stack location>" "uint largest scrubbed data stack location"
"uint <largest scrubbed retain stack location>" "uint largest scrubbed retain stack location"
"uint <largest GC root spill slot>" "uint largest checked data stack location"
"uint <largest derived root spill slot>" "uint largest checked retain stack location"
"int <number of return addresses>" "uint largest GC root spill slot"
"uint largest derived root spill slot"
"int number of return addresses"
} ; } ;
HELP: emit-gc-info-bitmaps HELP: emit-gc-info-bitmaps
{ $values { $values { "scrub-and-check-counts" "counts of the five different types of gc checks" } }
{ "scrub-d-count" "Number of scrubbable datastack locations" }
{ "scrub-r-count" "Number of scrubbable retainstack locations" }
{ "gc-root-count" "Unknown!" }
}
{ $description "Emits the scrub location data in all gc-maps registered in the " { $link gc-maps } " variable to the make sequence being created. The result is a concatenation of all datastack scrub locations, retainstack scrub locations and gc root locations converted into a byte-array. Given that byte-array and knowledge of the number of scrub locations, the original gc-map can be reconstructed." } ; { $description "Emits the scrub location data in all gc-maps registered in the " { $link gc-maps } " variable to the make sequence being created. The result is a concatenation of all datastack scrub locations, retainstack scrub locations and gc root locations converted into a byte-array. Given that byte-array and knowledge of the number of scrub locations, the original gc-map can be reconstructed." } ;
HELP: emit-scrub HELP: emit-scrub
@ -63,7 +63,7 @@ HELP: gc-maps
{ $var-description "Variable that holds a sequence of " { $link gc-map } " tuples." } ; { $var-description "Variable that holds a sequence of " { $link gc-map } " tuples." } ;
HELP: gc-map-needed? HELP: gc-map-needed?
{ $values { "gc-map" gc-map } { "?" "a boolean" } } { $values { "gc-map/f" "a " { $link gc-map } " or f" } { "?" "a boolean" } }
{ $description "If all slots in the gc-map are empty, then it doesn't need to be emitted." } ; { $description "If all slots in the gc-map are empty, then it doesn't need to be emitted." } ;
HELP: serialize-gc-maps HELP: serialize-gc-maps

22
basis/compiler/codegen/gc-maps/gc-maps.factor
View File

@ -6,28 +6,6 @@ compiler.codegen.relocation cpu.architecture fry kernel layouts
make math math.order namespaces sequences sequences.generalizations ; make math math.order namespaces sequences sequences.generalizations ;
IN: compiler.codegen.gc-maps IN: compiler.codegen.gc-maps
! GC maps
! Every code block either ends with
!
! uint 0
!
! or
!
! bitmap, byte aligned, three subsequences:
! - <scrubbed data stack locations>
! - <scrubbed retain stack locations>
! - <GC root spill slots>
! uint[] <base pointers>
! uint[] <return addresses>
! uint <largest scrubbed data stack location>
! uint <largest scrubbed retain stack location>
! uint <largest checked data stack location>
! uint <largest checked retain stack location>
! uint <largest GC root spill slot>
! uint <largest derived root spill slot>
! int <number of return addresses>
SYMBOLS: return-addresses gc-maps ; SYMBOLS: return-addresses gc-maps ;
: gc-map-needed? ( gc-map/f -- ? ) : gc-map-needed? ( gc-map/f -- ? )