Skip to content

fix(storage): optimize gRPC writer with zero-copy and lazy allocation#13481

Merged
cpriti-os merged 15 commits into
googleapis:mainfrom
cpriti-os:zero-grpc
Mar 5, 2026
Merged

fix(storage): optimize gRPC writer with zero-copy and lazy allocation#13481
cpriti-os merged 15 commits into
googleapis:mainfrom
cpriti-os:zero-grpc

Conversation

@cpriti-os

@cpriti-os cpriti-os commented Dec 15, 2025

Copy link
Copy Markdown
Contributor

This change eliminates unnecessary double-buffering in the gRPC writer,
reducing memory usage by up to 50% for Parallel Composite Uploads (PCU)
and large single-shot uploads.

Key changes:

  • Implements a Zero-Copy path in gRPCWriter: if in one-shot mode, the writer now
    passes the user's memory directly to the gRPC transport layer instead
    of copying it into an internal buffer.
  • Implements Lazy Allocation: The internal buffer (w.buf) is now
    initialized to nil and is only allocated if the "Slow Path" (buffering)
    is triggered. This allows purely zero-copy workloads to run with
    near-zero overhead.
  • Adds chunkSize to gRPCWriter to support logic when w.buf is nil.
  • Adds comprehensive tests verifying memory addresses to ensure the
    optimization is active and strictly correct during retries.

@cpriti-os cpriti-os requested review from a team December 15, 2025 12:22
@cpriti-os cpriti-os requested a review from a team as a code owner December 15, 2025 12:22
@product-auto-label product-auto-label Bot added the api: storage Issues related to the Cloud Storage API. label Dec 15, 2025
@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @cpriti-os, 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 significantly optimizes the gRPC writer by eliminating unnecessary double-buffering, which can reduce memory usage by up to 50% for large file uploads and parallel composite uploads. The core improvements involve introducing a zero-copy path for efficient data transfer and implementing lazy allocation for the internal write buffer, ensuring that memory is only used when strictly necessary.

Highlights

  • Zero-Copy Path: Implemented a zero-copy mechanism in gRPCWriter that directly passes user memory to the gRPC transport layer for large inputs (>= chunk size) or one-shot uploads, avoiding internal buffer copies.
  • Lazy Buffer Allocation: The internal buffer (w.buf) is now initialized to nil and only allocated if buffering is required, reducing overhead for purely zero-copy workloads.
  • chunkSize Field: Added chunkSize to the gRPCWriter struct to support the new zero-copy and lazy allocation logic.
  • Comprehensive Testing: New tests were added to verify the zero-copy optimization, including scenarios for one-shot uploads, buffering fallback, and correct memory address handling during retries.
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.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 introduces a significant optimization to the gRPC writer by implementing a zero-copy path and lazy allocation of the internal buffer. The changes are well-structured, and the logic for handling zero-copy writes, including partial sends and retries, appears robust. The addition of comprehensive tests that verify memory addresses is excellent and provides strong confidence in the correctness of the optimization. I've found one potential issue regarding integer overflow on 32-bit systems, for which I've left a specific comment. Overall, this is a great improvement for memory efficiency.

Comment thread storage/grpc_writer.go Outdated
cpriti-os and others added 2 commits December 15, 2025 17:59
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

@tritone tritone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great optimization!

Looks like there are some failing emulator tests involving progress func callbacks, race detector issues, and a deadlock. LMK if you have any questions about any of these. Probably you'll need to work on thread safety between the buffer alloc and the pipelined sends.

In addition we'd probably want to think about how to message this -- does this change how the writer "should" be used for gRPC? Do we want to suggest buffer pooling in the user application?

Finally, it'd be useful to get a pprof CPU/memory profile for before/after on this.

@cpriti-os cpriti-os requested review from a team as code owners February 25, 2026 09:19
@cpriti-os

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

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 introduces a zero-copy optimization and lazy buffer allocation for the gRPC writer, which is a great improvement for memory efficiency. The implementation looks solid, especially the retry logic in the zero-copy path. I've found a couple of areas for improvement: one is a potential memory leak issue in the new zero-copy logic, and the other is an issue in the new tests that causes them to not correctly verify the new behavior. My detailed comments are below.

Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer_test.go Outdated

@krishnamd-jkp krishnamd-jkp left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

initial review

Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer.go
Comment thread storage/grpc_writer_test.go Outdated
@krishnamd-jkp

Copy link
Copy Markdown
Contributor

Approving based on the changes. Just check if the synchronous nature of the single shot write does not qualify for a breaking change.

@cpriti-os cpriti-os added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 2, 2026
@kokoro-team kokoro-team removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 2, 2026

@tritone tritone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Generally looks good, a few questions

Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer.go Outdated
Comment thread storage/grpc_writer_test.go Outdated
@cpriti-os cpriti-os merged commit df64147 into googleapis:main Mar 5, 2026
10 checks passed
@cpriti-os cpriti-os deleted the zero-grpc branch March 6, 2026 11:25
krishnamd-jkp added a commit that referenced this pull request Mar 10, 2026
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.

Librarian Version: v0.8.3
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/librarian-go@sha256:19bb93e8f1f916c61b597db2bad65dc432f79baaabb210499d7d0e4ad1dffe29
<details><summary>storage: v1.61.0</summary>

##
[v1.61.0](storage/v1.60.0...storage/v1.61.0)
(2026-03-10)

### Features

* add bucket encryption enforcement configuration (#13874)
([245c8d7](245c8d76))

* add multistream options to MRD (#13758)
([4557675](4557675e))

* add a DeleteFolderRecursive API definition (PiperOrigin-RevId:
866471251)
([6f31019](6f310199))

* add multistream support to MRD (#13792)
([ffa7268](ffa7268c))

### Bug Fixes

* Fix TM download dir corner case (#14142)
([87cdcc9](87cdcc9f))

* Omit auto checksum in final request when MD5 is given (#14024)
([d404777](d4047774))

* optimize gRPC writer with zero-copy and lazy allocation (#13481)
([df64147](df641476))

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

Labels

api: storage Issues related to the Cloud Storage API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants