docs: add external byte stream proposal - #1791
Open
andreiltd wants to merge 2 commits into
Open
Conversation
Signed-off-by: Tomasz Andrzejak <andreiltd@gmail.com>
andreiltd
requested review from
danbugs,
dblnz,
devigned,
jprendes,
jsturtevant,
ludfjig,
simongdavies,
squillace and
syntactically
as code owners
September 3, 2026 11:38
andreiltd
added
area/documentation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
Changes are documentation-only and the identified issues are minor wording/clarity nits with straightforward fixes.
Pull request overview
Adds HIP 0002 proposal documentation describing a wire format that keeps message structure in a FlatBuffer “envelope” while carrying large payload bytes in an ordered external byte stream immediately following the envelope, to avoid intermediate copies (notably for virtq scatter/gather).
Changes:
- Document the motivation and wire layout for a FlatBuffer envelope + external byte stream design.
- Specify serialization/consumption semantics and validation requirements for external bytes.
- Note relationship/inspiration from Apache Arrow IPC buffer descriptors.
File summaries
| File | Description |
|---|---|
| proposals/0002-envelope-external-byte-stream/README.md | New proposal document defining the envelope + external byte stream approach, including semantics and validation requirements. |
Review details
Suppressed comments (2)
proposals/0002-envelope-external-byte-stream/README.md:13
- Hyphenate the compound modifier "format-independent" for correct grammar.
of writing. The optimization is format independent and applies wherever serialized metadata can
proposals/0002-envelope-external-byte-stream/README.md:81
- Hyphenate "protocol-defined" here (and keep usage consistent) since it is a compound modifier for "order".
The external bytes are consumed in protocol defined order. For function call parameters, this can be
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Tomasz Andrzejak <andreiltd@users.noreply.github.com>
jsturtevant
approved these changes
Sep 3, 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
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.
Rendered