-
Notifications
You must be signed in to change notification settings - Fork 1
docs: Add related.md documenting prior art for fd passing IPC #4
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
base: main
Are you sure you want to change the base?
Conversation
Document related protocols and implementations that support file descriptor passing over IPC, including: - systemd's varlink fd passing extension (SCM_RIGHTS-based, index references in JSON, used by mountfsd/machined/nsresourced/etc.) - containerd's ttrpc fd passing efforts - D-Bus UNIX_FD support - Comparison with jsonrpc-fdpass approach This provides context for the design decisions in jsonrpc-fdpass and helps users understand the landscape of fd-passing IPC protocols. Assisted-by: OpenCode (Claude claude-opus-4-5) Signed-off-by: Colin Walters <walters@verbum.org>
Summary of ChangesHello @cgwalters, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces new documentation to contextualize the design decisions behind Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a new documentation file, docs/related.md, which provides a comprehensive overview of related protocols and implementations for file descriptor passing. The document is well-structured and clearly explains the approaches taken by systemd's varlink, containerd's ttrpc, and D-Bus, comparing them with jsonrpc-fdpass. This is a valuable addition for users to understand the design choices and the broader context. I have one suggestion to slightly expand the section on containerd ttrpc to make it even more informative.
| ## containerd ttrpc | ||
|
|
||
| [ttrpc](https://github.com/containerd/ttrpc) is containerd's lightweight RPC | ||
| protocol, an alternative to gRPC for local IPC. There has been work to add fd | ||
| passing support: | ||
|
|
||
| - [containerd/ttrpc#75](https://github.com/containerd/ttrpc/pull/75) - PR | ||
| exploring fd passing | ||
|
|
||
| ttrpc uses protobuf for message encoding rather than JSON. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The section on containerd ttrpc is quite brief. To provide more context for the reader, consider expanding it with a short summary of the proposed approach for FD passing, similar to the detail provided for systemd's varlink.
For example, you could mention:
- The underlying mechanism used (e.g.,
SCM_RIGHTS). - How the protocol signals the presence of FDs.
- The status of the linked pull request (e.g., open, stalled).
This would make the comparison richer and more informative.
Document related protocols and implementations that support file descriptor passing over IPC, including:
This provides context for the design decisions in jsonrpc-fdpass and helps users understand the landscape of fd-passing IPC protocols.
Assisted-by: OpenCode (Claude claude-opus-4-5)