adding a C++17 padded_input for convenience.#2667
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a C++17 simdjson::padded_input convenience wrapper to automate “free padding” page-boundary handling, and updates docs/tests/examples to demonstrate and validate the new input type.
Changes:
- Introduce
simdjson::padded_input(C++17) plusget_page_size()helper to decide when to copy into apadded_stringvs keep a view. - Add a new ondemand test binary for
padded_input, and wire it into the ondemand test CMake. - Update documentation and readme example tests (DOM + ondemand) to show
padded_inputusage.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
include/simdjson/padded_string_view.h |
Declares get_page_size() and new padded_input wrapper type. |
include/simdjson/padded_string_view-inl.h |
Implements get_page_size() and padded_input logic (page-boundary check, view vs copy). |
tests/ondemand/ondemand_padded_input.cpp |
New test program covering padded_input with ondemand + DOM parsers. |
tests/ondemand/CMakeLists.txt |
Adds the new ondemand_padded_input test target. |
tests/ondemand/ondemand_readme_examples.cpp |
Adds ondemand readme-style examples using padded_input. |
tests/dom/readme_examples.cpp |
Adds DOM readme-style examples using padded_input. |
tests/ondemand/ondemand_cacheline.cpp |
Clarifies need_allocation() precondition in comment. |
doc/performance.md |
Documents padded_input as a C++17+ simplification for padding management. |
doc/dom.md |
Adds DOM docs snippet showing padded_input usage and caveats. |
doc/basics.md |
Updates “basics” docs to include padded_input and reorganizes input/padding guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
This is automates the rather complicated memory page hacking.