Docs: reorg of the compiler.constants docs a little

db4
Björn Lindqvist 2015-08-29 23:41:17 +02:00
parent 84ec2164c2
commit a89b0c2b30
1 changed files with 29 additions and 14 deletions

View File

@ -13,40 +13,55 @@ HELP: string-offset
{ $values { "n" integer } } { $values { "n" integer } }
{ $description "hm" } ; { $description "hm" } ;
HELP: vm-context-offset
{ $values { "n" integer } }
{ $description "Offset in bytes from the start of the vm struct to the context (ctx) field." } ;
ARTICLE: "compiler.constants" "VM memory layout constants" ARTICLE: "compiler.constants" "VM memory layout constants"
"Common constants." "Common constants. All the values are given in relation to the bootstrap image being built."
$nl $nl
"Constants that must match vm/memory.hpp:" "Constants that must match vm/memory.hpp:"
{ $subsections card-bits card-mark deck-bits } { $subsections card-bits card-mark deck-bits }
"Constants that must match vm/layouts.hpp:" "Constants that must match vm/layouts.hpp:"
{ $subsections { $subsections
alien-offset profile-count-offset
array-start-offset slot-offset
byte-array-offset }
callstack-length-offset "Offsets to fields in the context struct:"
callstack-top-offset { $subsections
context-callstack-bottom-offset context-callstack-bottom-offset
context-callstack-save-offset context-callstack-save-offset
context-callstack-seg-offset context-callstack-seg-offset
context-datastack-offset context-datastack-offset
context-callstack-top-offset context-callstack-top-offset
context-retainstack-offset context-retainstack-offset
float-offset }
profile-count-offset "Offsets to field in the segment struct:"
quot-entry-point-offset { $subsections
segment-end-offset segment-end-offset
segment-size-offset segment-size-offset
segment-start-offset segment-start-offset
slot-offset }
string-aux-offset "Offsets to fields in the vm struct:"
string-offset { $subsections
tuple-class-offset
underlying-alien-offset
vm-context-offset vm-context-offset
vm-fault-flag-offset vm-fault-flag-offset
vm-signal-handler-addr-offset vm-signal-handler-addr-offset
vm-spare-context-offset vm-spare-context-offset
}
"Offsets to fields in data objects:"
{ $subsections
alien-offset
array-start-offset
byte-array-offset
callstack-length-offset
callstack-top-offset
float-offset
quot-entry-point-offset
string-aux-offset
string-offset
tuple-class-offset
underlying-alien-offset
word-entry-point-offset word-entry-point-offset
} ; } ;