Skip to content

[Backends] Provide a variant of DeviceBuffer::resize that skip data copy#1503

Merged
tdavidcl merged 4 commits into
Shamrock-code:mainfrom
tdavidcl:patch-2025-12-30-10-00
Dec 31, 2025
Merged

[Backends] Provide a variant of DeviceBuffer::resize that skip data copy#1503
tdavidcl merged 4 commits into
Shamrock-code:mainfrom
tdavidcl:patch-2025-12-30-10-00

Conversation

@tdavidcl

Copy link
Copy Markdown
Member

closing issue #1502

@github-actions

Copy link
Copy Markdown
Contributor

Thanks @tdavidcl for opening this PR!

You can do multiple things directly here:
1 - Comment pre-commit.ci run to run pre-commit checks.
2 - Comment pre-commit.ci autofix to apply fixes.
3 - Add label autofix.ci to fix authorship & pre-commit for every commit made.
4 - Add label light-ci to only trigger a reduced & faster version of the CI (need the full one before merge).
5 - Add label trigger-ci to create an empty commit to trigger the CI.

Once the workflow completes a message will appear displaying informations related to the run.

Also the PR gets automatically reviewed by gemini, you can:
1 - Comment /gemini review to trigger a review
2 - Comment /gemini summary for a summary
3 - Tag it using @gemini-code-assist either in the PR or in review comments on files

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @tdavidcl, 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 a significant optimization to the DeviceBuffer class by providing a mechanism to resize buffers without the overhead of data copying when the existing data is no longer relevant. This enhancement offers greater control over memory management and can lead to performance improvements in scenarios where buffer contents are frequently discarded or reinitialized after resizing, directly addressing issue #1502.

Highlights

  • Enhanced DeviceBuffer::resize: The resize method in DeviceBuffer now includes an optional keep_data boolean parameter, defaulting to true, allowing callers to explicitly control whether existing data is copied during reallocation.
  • New resize_discard_data method: A new convenience method, resize_discard_data(size_t new_size), has been introduced. This method calls resize with keep_data set to false, providing a clear way to resize a buffer without preserving its current contents.
  • Optimized free_alloc: The free_alloc() method, which previously called resize(0), has been updated to call resize_discard_data(0). This ensures that freeing allocated memory does not involve unnecessary data copying.
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 useful optimization for DeviceBuffer::resize by allowing data to be discarded when resizing. The implementation of the feature itself seems correct. However, there are a couple of points to address. The documentation for the modified resize function and the new resize_discard_data function should be improved for clarity and consistency. More importantly, this change lacks corresponding tests. It is crucial to add unit tests to verify the new behavior, especially that resize(new_size, false) correctly discards data upon reallocation.

Comment thread src/shambackends/include/shambackends/DeviceBuffer.hpp
Comment thread src/shambackends/include/shambackends/DeviceBuffer.hpp
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@github-actions

Copy link
Copy Markdown
Contributor

Workflow report

workflow report corresponding to commit 55598ff
Commiter email is timothee.davidcleris@proton.me
GitHub page artifact URL GitHub page artifact link (can expire)

Pre-commit check report

Pre-commit check: ✅

trim trailing whitespace.................................................Passed
fix end of files.........................................................Passed
check for merge conflicts................................................Passed
check that executables have shebangs.....................................Passed
check that scripts with shebangs are executable..........................Passed
check for added large files..............................................Passed
check for case conflicts.................................................Passed
check for broken symlinks................................................Passed
check yaml...............................................................Passed
detect private key.......................................................Passed
No-tabs checker..........................................................Passed
Tabs remover.............................................................Passed
Validate GitHub Workflows................................................Passed
clang-format.............................................................Passed
black....................................................................Passed
ruff check...............................................................Passed
Check doxygen headers....................................................Passed
Check license headers....................................................Passed
Check #pragma once.......................................................Passed
Check SYCL #include......................................................Passed
No ssh in git submodules remote..........................................Passed

Test pipeline can run.

Clang-tidy diff report

No relevant changes found.
Well done!

You should now go back to your normal life and enjoy a hopefully sunny day while waiting for the review.

Doxygen diff with main

Removed warnings : 0
New warnings : 0
Warnings count : 7609 → 7609 (0.0%)

Detailed changes :

@tdavidcl tdavidcl merged commit ce69ca0 into Shamrock-code:main Dec 31, 2025
62 checks passed
@tdavidcl tdavidcl deleted the patch-2025-12-30-10-00 branch December 31, 2025 08:44
DavidFang03 pushed a commit to DavidFang03/Shamrock that referenced this pull request Jan 6, 2026
Guo-astro pushed a commit to Guo-astro/shamrock that referenced this pull request Jan 9, 2026
Guo-astro pushed a commit to Guo-astro/shamrock that referenced this pull request Jan 9, 2026
Guo-astro pushed a commit to Guo-astro/shamrock that referenced this pull request Jan 9, 2026
aserhani pushed a commit to aserhani/Shamrock that referenced this pull request Feb 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Backends] Provide a variant of DeviceBuffer::resize that skip data copy

1 participant