Documentation updates#25
Open
gheber wants to merge 2 commits into
Open
Conversation
| | Field | Description | | ||
| |-------|-------------| | ||
| | `raw` | `global_frhp_id_len` bytes containing a managed, huge, or tiny heap ID. Managed IDs encode a logical heap offset and object length; huge IDs encode either an inline address/size tuple or a version 2 B-tree key; tiny IDs embed the object bytes inline. | | ||
|
|
Collaborator
There was a problem hiding this comment.
I suggest to give a bit more details about the different types of fractal heap IDs as in the format spec.
| | `signature` | 4-byte signature: 'F' 'H' 'D' 'B'. Must match exactly. | | ||
| | `version` | Direct block format version. Must be 0. | | ||
| | `hdr_addr_raw` | Back-pointer: file address of the Fractal Heap header (`sizeof_offsets` bytes). | | ||
| | `block_off_raw` | Logical heap offset of this direct block in the managed heap address space (`global_frhp_heap_off_size` bytes). | |
Collaborator
There was a problem hiding this comment.
There are a few global_XXXXXX mentioned in this file. It may be helpful to mention at the beginning about globals being set via constraints or func setters. See v2_btree.md.
| |-------|-------------| | ||
| | `raw` | `global_frhp_id_len` bytes containing a managed, huge, or tiny heap ID. Managed IDs encode a logical heap offset and object length; huge IDs encode either an inline address/size tuple or a version 2 B-tree key; tiny IDs embed the object bytes inline. | | ||
|
|
||
|
|
Collaborator
There was a problem hiding this comment.
As a future enhancement, it may be worth describing the connection between the fractal heap IDs and the v2 btree record types.
vchoi-hdfgroup
requested changes
May 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
[f,g,l]heap.pk