Skip to content

Conversation

@cgwalters
Copy link
Collaborator

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)

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>
@gemini-code-assist
Copy link

Summary of Changes

Hello @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 jsonrpc-fdpass by outlining various existing IPC protocols that support file descriptor passing. It aims to help users understand the landscape of such protocols and how jsonrpc-fdpass fits within it, particularly by detailing systemd's varlink extension and comparing it with the jsonrpc-fdpass approach.

Highlights

  • New Documentation File: Added a new documentation file, docs/related.md, which details prior art and related protocols for file descriptor passing over Inter-Process Communication (IPC).
  • Systemd Varlink FD Passing: The document provides an in-depth look at systemd's specific extension to the varlink protocol for FD passing, including its API, wire protocol, JSON index references, and production usage examples.
  • Comparison with jsonrpc-fdpass: A direct comparison table highlights key differences between systemd's varlink FD passing and the jsonrpc-fdpass approach, focusing on FD indication, batching, and language support.
  • Other FD Passing Protocols: Briefly covers containerd's ttrpc FD passing efforts and D-Bus's UNIX_FD support, providing a broader context of existing solutions.

🧠 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
  • docs/related.md
    • Added a new document detailing related protocols and implementations for IPC with file descriptor passing.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a 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.

Comment on lines +104 to +113
## 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant