Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(SwingSet): Document the "R"/"_" reachability flag in kref-to-vref c-list entries #10181

Merged
merged 1 commit into from
Oct 12, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/SwingSet/docs/c-lists.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The SwingSet kernel supports a number of vats, in a star configuration. At the b
| kp8 | p-3 |
| kd4 | d-4 |

The c-list is currently stored as `kvStore` entries in the kernel's swing-store DB. Each c-list entry gets two kvStore keys, one for each direction. The kref-to-vref mapping gets a key of `${vatID}.c.${kref}`, while the vref-to-kref mapping gets `${vatID}.c.${vref}`. The value is the vref or kref, respectively. (The c-list is also used to track the reachable/recognizable status of the vat's import, so the krev-to-vref direction has additional flag characters in its value).
The c-list is currently stored as `kvStore` entries in the kernel's swing-store DB. Each c-list entry gets two kvStore keys, one for each direction. The kref-to-vref mapping gets a key of `${vatID}.c.${kref}` and a value of `${flag} ${vref}` (where the flag is `R` for reachable references and `_` for merely recognizable ones, cf. [Garbage Collection in SwingSet](./garbage-collection.md)), while the vref-to-kref mapping gets a key of `${vatID}.c.${vref}` and a value of `${kref}`.

Object krefs (`koNN`) point into the kernel object table. Each such object is exported by exactly one vat, and might be imported by one or more other vats.

Expand Down
Loading