mirror of
https://github.com/simdjson/simdjson
synced 2026-06-08 17:27:07 +00:00
Compare commits
177 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 11d9dbb7b7 | |||
| 896fb5d6a5 | |||
| e3d3b4b5a4 | |||
| 08e5943efc | |||
| 8aae14931d | |||
| 7068894be3 | |||
| ef3d1ac25f | |||
| 9292480a9b | |||
| 611ea97dbd | |||
| f249e7e128 | |||
| 44fddaa807 | |||
| be16e1ae04 | |||
| 124a33c160 | |||
| a0b870e9c2 | |||
| 68699eb73c | |||
| 06453f1637 | |||
| eb828d97ba | |||
| 00f84fb448 | |||
| 5bf0954c6e | |||
| 3056d54fa3 | |||
| 241b9f6ea7 | |||
| 015daad6a9 | |||
| fc3b7766c0 | |||
| b5c78288e5 | |||
| bd86bb0cfb | |||
| 4840a0347c | |||
| 7f68baec1e | |||
| e2ea5fb8de | |||
| 7dfd165ecd | |||
| 4dfa0a2407 | |||
| e252a21f65 | |||
| 89f2b634df | |||
| addca203d5 | |||
| 1825d7e88c | |||
| f87d6af3e9 | |||
| 8fff57578c | |||
| 056d66926a | |||
| b434a50681 | |||
| e8ff2fa692 | |||
| 1ebf115b2b | |||
| 172fbe785d | |||
| a10f096af2 | |||
| a85e474360 | |||
| 05752d6c6f | |||
| fb9a689dff | |||
| 472f818fe5 | |||
| 5c9c133632 | |||
| faf921bc7e | |||
| 626eedc3d8 | |||
| 294aa64f94 | |||
| 397b40e574 | |||
| fdc93528d1 | |||
| 3e00a431a0 | |||
| d3626c6a37 | |||
| 686a1869c8 | |||
| 4c0f86db44 | |||
| 6c4c934457 | |||
| fcae795042 | |||
| b7c51156b9 | |||
| 662e3d96c7 | |||
| 64009f7063 | |||
| 74fb3ecac7 | |||
| 26abf1d180 | |||
| e878dc6be3 | |||
| efa03f5733 | |||
| 8519623257 | |||
| 484a092c31 | |||
| 8bb520adbf | |||
| ec8e6a6758 | |||
| 769528b6c0 | |||
| 9fbc577be7 | |||
| a7c95e9cc8 | |||
| 248d4eb2aa | |||
| 559493e2bf | |||
| 75acae5c46 | |||
| bd761ef573 | |||
| 76ed73f07f | |||
| 1b59b38de8 | |||
| 4794b5d936 | |||
| 114f14924c | |||
| e94825c9a8 | |||
| 333fd72f98 | |||
| dd4d02617f | |||
| e28d63334e | |||
| 3d1ab87ecb | |||
| d365cfb4a1 | |||
| b9e308a727 | |||
| aa6817d5aa | |||
| 90e4a66c93 | |||
| e6240f18c4 | |||
| d43fb6ff84 | |||
| 5eec29a6db | |||
| 228501f786 | |||
| 9d9f2427c5 | |||
| 8d53840253 | |||
| 0a82fb110f | |||
| 11f273c580 | |||
| 31662531ac | |||
| 97eb557388 | |||
| 41ced28821 | |||
| 1078eb4034 | |||
| 6029af75b3 | |||
| 0cd774097f | |||
| b5e27af4da | |||
| c806e955c4 | |||
| 4acaf2ea1c | |||
| 86adda06d0 | |||
| 8df5f96eba | |||
| 937667796c | |||
| 7d86b04247 | |||
| 265022ad8f | |||
| 0c0ce1bd48 | |||
| f64c004cb7 | |||
| d7d19db6ae | |||
| a260c967ed | |||
| 16e390d81a | |||
| 8d34e14000 | |||
| b717136fd9 | |||
| f3ac74caf8 | |||
| 2369927661 | |||
| 818c0491a1 | |||
| 9f14f90a64 | |||
| 00843d2711 | |||
| 2887a17bab | |||
| d84c934768 | |||
| 7cec7c7ae4 | |||
| c52b010a57 | |||
| ee301599b1 | |||
| 7382dc2be8 | |||
| 8c14e0c56f | |||
| a9a62feb75 | |||
| b9228b4d3c | |||
| 726c3eb611 | |||
| 4cdc4f18ef | |||
| f3b034ac38 | |||
| 9c2e8a8f39 | |||
| dfa43f6cdd | |||
| 797e61742c | |||
| f289412e0a | |||
| 7bd79b4445 | |||
| 078e2c9073 | |||
| d7b6b20511 | |||
| dbea3bbd62 | |||
| e422933414 | |||
| de4d69b367 | |||
| b8675a7f7b | |||
| 5642bb93a4 | |||
| 1b23a77e03 | |||
| 57699bfed8 | |||
| 648303b26a | |||
| 9008960e36 | |||
| 8a9e8a1792 | |||
| ba33e9e78f | |||
| d98b351eef | |||
| 5488dca126 | |||
| 7712ecf164 | |||
| 2803ca3093 | |||
| e7f2463920 | |||
| 5bfa0b098c | |||
| f7ba9cb11b | |||
| d4bf0cc7ec | |||
| 2fbbea0b15 | |||
| c16486f702 | |||
| f615112093 | |||
| 6bbcbfbb95 | |||
| e6578fea39 | |||
| 6fb050d04e | |||
| b4242d3b4f | |||
| cbfe2d4a21 | |||
| 79126ca323 | |||
| 3f87f958d7 | |||
| cab383e1de | |||
| 9b314922a1 | |||
| 587beae307 | |||
| f53981d945 | |||
| 41b4ffd6aa | |||
| 6cd8a6d776 |
@@ -9,7 +9,8 @@ assignees: ''
|
|||||||
|
|
||||||
Before submitting an issue, please ensure that you have read the documentation:
|
Before submitting an issue, please ensure that you have read the documentation:
|
||||||
|
|
||||||
* Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
|
* Basics is an overview of how to use simdjson and its APIs to parse JSON: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
|
||||||
|
* Builder is an overview of how to use simdjson to generate JSON: https://github.com/simdjson/simdjson/blob/master/doc/builder.md
|
||||||
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
|
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
|
||||||
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
||||||
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017). If you wish to support features that are not part of RFC 8259, then you should not refer to your issue as a bug.
|
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017). If you wish to support features that are not part of RFC 8259, then you should not refer to your issue as a bug.
|
||||||
@@ -55,6 +56,8 @@ We support up-to-date 64-bit ARM and x64 FreeBSD, macOS, Windows and Linux syste
|
|||||||
pre-release version of a compiler, do not report it as a bug to simdjson. However, we always
|
pre-release version of a compiler, do not report it as a bug to simdjson. However, we always
|
||||||
invite contributions either in the form an analysis or of a code contribution.
|
invite contributions either in the form an analysis or of a code contribution.
|
||||||
|
|
||||||
|
Under Windows, we support Visual Studio (both with LLVM and without). We do not support MinGW and other alternate compiler systems. Windows users should be aware that there [is a long-running bug with GCC under Windows](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=54412).
|
||||||
|
|
||||||
**Indicate whether you are willing or able to provide a bug fix as a pull request**
|
**Indicate whether you are willing or able to provide a bug fix as a pull request**
|
||||||
|
|
||||||
If you plan to contribute to simdjson, please read our guide:
|
If you plan to contribute to simdjson, please read our guide:
|
||||||
|
|||||||
@@ -9,7 +9,8 @@ assignees: ''
|
|||||||
|
|
||||||
Before submitting an issue, please ensure that you have read the documentation:
|
Before submitting an issue, please ensure that you have read the documentation:
|
||||||
|
|
||||||
* Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
|
* Basics is an overview of how to use simdjson and its APIs to parse JSON: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
|
||||||
|
* Builder is an overview of how to use simdjson to generate JSON: https://github.com/simdjson/simdjson/blob/master/doc/builder.md
|
||||||
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
|
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
|
||||||
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
||||||
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).
|
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).
|
||||||
|
|||||||
@@ -9,7 +9,8 @@ assignees: ''
|
|||||||
|
|
||||||
Before submitting an issue, please ensure that you have read the documentation:
|
Before submitting an issue, please ensure that you have read the documentation:
|
||||||
|
|
||||||
* Basics is an overview of how to use simdjson and its APIs: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
|
* Basics is an overview of how to use simdjson and its APIs to parse JSON: https://github.com/simdjson/simdjson/blob/master/doc/basics.md
|
||||||
|
* Builder is an overview of how to use simdjson to generate JSON: https://github.com/simdjson/simdjson/blob/master/doc/builder.md
|
||||||
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
|
* Performance shows some more advanced scenarios and how to tune for them: https://github.com/simdjson/simdjson/blob/master/doc/performance.md
|
||||||
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
* Contributing: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
||||||
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).
|
* We follow the [JSON specification as described by RFC 8259](https://www.rfc-editor.org/rfc/rfc8259.txt) (T. Bray, 2017).
|
||||||
|
|||||||
@@ -1,8 +1,53 @@
|
|||||||
|
Short title (summary):
|
||||||
|
|
||||||
|
Description
|
||||||
|
- What did you change and why? (1-3 sentences)
|
||||||
|
- Issue reproduced / related issue: link the issue if relevant (e.g. #123)
|
||||||
|
|
||||||
|
Type of change
|
||||||
|
- [ ] Bug fix
|
||||||
|
- [ ] New feature
|
||||||
|
- [ ] Refactor / cleanup
|
||||||
|
- [ ] Documentation / tests
|
||||||
|
- [ ] Other (please describe):
|
||||||
|
|
||||||
|
How to verify / test
|
||||||
|
- Add additional tests to verify bugs or new features.
|
||||||
|
- If you claim performance gains, you should provide benchmark numbers using high quality benchmarking code.
|
||||||
|
|
||||||
|
|
||||||
Our tests check whether you have introduced trailing white space. If such a test fails, please check the "artifacts button" above, which if you click it gives a link to a downloadable file to help you identify the issue. You can also run scripts/remove_trailing_whitespace.sh locally if you have a bash shell and the sed command available on your system.
|
Please read before contributing:
|
||||||
|
- CONTRIBUTING: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
||||||
|
- HACKING: https://github.com/simdjson/simdjson/blob/master/HACKING.md
|
||||||
|
|
||||||
If you plan to contribute to simdjson, please read our
|
|
||||||
|
|
||||||
CONTRIBUTING guide: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md and our
|
|
||||||
HACKING guide: https://github.com/simdjson/simdjson/blob/master/HACKING.md
|
If you can, we recommend running our tests with the sanitizers turned on.
|
||||||
|
For non-Visual Studio users, it is as easy as doing:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cmake -B build -D SIMDJSON_SANITIZE=ON -D SIMDJSON_DEVELOPER_MODE=ON
|
||||||
|
cmake --build build
|
||||||
|
ctest --test-dir build
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Our CI checks, among other things, for trailing whitespace. If a test fails for that reason,
|
||||||
|
use the "artifacts" button to download the artifact and inspect the problematic lines,
|
||||||
|
or run `scripts/remove_trailing_whitespace.sh` locally if you have a bash shell and `sed`.
|
||||||
|
|
||||||
|
|
||||||
|
Checklist before submitting
|
||||||
|
- [ ] I added/updated tests covering my change (if applicable)
|
||||||
|
- [ ] Code builds locally and passes my check
|
||||||
|
- [ ] Documentation / README updated if needed
|
||||||
|
- [ ] Commits are atomic and messages are clear
|
||||||
|
- [ ] I linked the related issue (if applicable)
|
||||||
|
|
||||||
|
Final notes
|
||||||
|
- For large PRs, prefer smaller incremental PRs or request staged review.
|
||||||
|
|
||||||
|
Thanks for the contribution!
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: uraimo/run-on-arch-action@v2
|
- uses: uraimo/run-on-arch-action@v3
|
||||||
name: Test
|
name: Test
|
||||||
id: runcmd
|
id: runcmd
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -1,9 +1,8 @@
|
|||||||
name: Doxygen GitHub Pages
|
name: Doxygen GitHub Pages
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
release:
|
||||||
branches:
|
types: [created]
|
||||||
- master
|
|
||||||
# Allows you to run this workflow manually from the Actions tab
|
# Allows you to run this workflow manually from the Actions tab
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
|
||||||
|
- uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
||||||
|
- uses: mymindstorm/setup-emsdk@6ab9eb1bda2574c4ddb79809fc9247783eaf9021 # v14
|
||||||
|
- name: Verify
|
||||||
|
run: emcc -v
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v3.6.0
|
||||||
|
- name: Configure
|
||||||
|
run: emcmake cmake -B build
|
||||||
|
- name: Build # We build but do not test
|
||||||
|
run: cmake --build build
|
||||||
@@ -4,7 +4,7 @@ on: [push, pull_request]
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
whitespace:
|
whitespace:
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Remove whitespace and check the diff
|
- name: Remove whitespace and check the diff
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ jobs:
|
|||||||
implementations: haswell westmere fallback
|
implementations: haswell westmere fallback
|
||||||
UBSAN_OPTIONS: halt_on_error=1
|
UBSAN_OPTIONS: halt_on_error=1
|
||||||
MAXLEN: -max_len=4000
|
MAXLEN: -max_len=4000
|
||||||
CLANGVERSION: 15
|
CLANGVERSION: 19
|
||||||
# which optimization level to use for the sanitizer build (see build_fuzzer.variants.sh)
|
# which optimization level to use for the sanitizer build (see build_fuzzer.variants.sh)
|
||||||
OPTLEVEL: -O3
|
OPTLEVEL: -O3
|
||||||
|
|
||||||
@@ -125,7 +125,7 @@ jobs:
|
|||||||
done
|
done
|
||||||
|
|
||||||
- name: Save the corpus as a github artifact
|
- name: Save the corpus as a github artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
name: corpus
|
name: corpus
|
||||||
path: corpus.tar
|
path: corpus.tar
|
||||||
@@ -148,7 +148,7 @@ jobs:
|
|||||||
run: tar cf valgrind.tar valgrind-*.txt
|
run: tar cf valgrind.tar valgrind-*.txt
|
||||||
|
|
||||||
- name: Save valgrind output as a github artifact
|
- name: Save valgrind output as a github artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
name: valgrindresults
|
name: valgrindresults
|
||||||
@@ -156,7 +156,7 @@ jobs:
|
|||||||
if-no-files-found: ignore
|
if-no-files-found: ignore
|
||||||
|
|
||||||
- name: Archive any crashes as an artifact
|
- name: Archive any crashes as an artifact
|
||||||
uses: actions/upload-artifact@v3
|
uses: actions/upload-artifact@v4
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
name: crashes
|
name: crashes
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ jobs:
|
|||||||
- msystem: "MINGW64"
|
- msystem: "MINGW64"
|
||||||
install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang
|
install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang
|
||||||
type: Debug
|
type: Debug
|
||||||
- msystem: "MINGW64"
|
- msystem: "MINGW64"
|
||||||
install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang
|
install: mingw-w64-x86_64-libxml2 mingw-w64-x86_64-cmake mingw-w64-x86_64-ninja mingw-w64-x86_64-clang
|
||||||
type: RelWithDebInfo
|
type: RelWithDebInfo
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: uraimo/run-on-arch-action@v2
|
- uses: uraimo/run-on-arch-action@v3
|
||||||
name: Test
|
name: Test
|
||||||
id: runcmd
|
id: runcmd
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: uraimo/run-on-arch-action@v2
|
- uses: uraimo/run-on-arch-action@v3
|
||||||
name: Test
|
name: Test
|
||||||
id: runcmd
|
id: runcmd
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -0,0 +1,29 @@
|
|||||||
|
name: Ubuntu rvv VLEN=1024 (clang 18)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install packages
|
||||||
|
run: |
|
||||||
|
sudo apt-get update -q -y
|
||||||
|
sudo apt-get install -y cmake make g++-riscv64-linux-gnu qemu-user-static clang-18
|
||||||
|
- name: Build
|
||||||
|
run: |
|
||||||
|
CXX=clang++-18 CXXFLAGS="--target=riscv64-linux-gnu -march=rv64gcv_zvbb" \
|
||||||
|
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DCMAKE_BUILD_TYPE=Release -B build
|
||||||
|
cmake --build build/ -j$(nproc)
|
||||||
|
- name: Test VLEN=1024
|
||||||
|
run: |
|
||||||
|
export QEMU_LD_PREFIX="/usr/riscv64-linux-gnu"
|
||||||
|
export QEMU_CPU="rv64,v=on,zvbb=on,vlen=1024,rvv_ta_all_1s=on,rvv_ma_all_1s=on"
|
||||||
|
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
name: Ubuntu rvv VLEN=128 (clang 17)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install packages
|
||||||
|
run: |
|
||||||
|
sudo apt-get update -q -y
|
||||||
|
sudo apt-get install -y cmake make g++-riscv64-linux-gnu qemu-user-static clang-17
|
||||||
|
- name: Build
|
||||||
|
run: |
|
||||||
|
CXX=clang++-17 CXXFLAGS="--target=riscv64-linux-gnu -march=rv64gcv" \
|
||||||
|
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DCMAKE_BUILD_TYPE=Release -B build
|
||||||
|
cmake --build build/ -j$(nproc)
|
||||||
|
- name: Test VLEN=128
|
||||||
|
run: |
|
||||||
|
export QEMU_LD_PREFIX="/usr/riscv64-linux-gnu"
|
||||||
|
export QEMU_CPU="rv64,v=on,vlen=128,rvv_ta_all_1s=on,rvv_ma_all_1s=on"
|
||||||
|
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
name: Ubuntu rvv VLEN=256 (gcc 14)
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- master
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- name: Install packages
|
||||||
|
run: |
|
||||||
|
sudo apt-get update -q -y
|
||||||
|
sudo apt-get install -y cmake make g++-14-riscv64-linux-gnu qemu-user-static
|
||||||
|
- name: Build
|
||||||
|
run: |
|
||||||
|
CXX=riscv64-linux-gnu-g++-14 CXXFLAGS=-march=rv64gcv \
|
||||||
|
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DCMAKE_BUILD_TYPE=Release -B build
|
||||||
|
cmake --build build/ -j$(nproc)
|
||||||
|
- name: Test VLEN=256
|
||||||
|
run: |
|
||||||
|
export QEMU_LD_PREFIX="/usr/riscv64-linux-gnu"
|
||||||
|
export QEMU_CPU="rv64,v=on,zvbb=on,vlen=256,rvv_ta_all_1s=on,rvv_ma_all_1s=on"
|
||||||
|
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
|
||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: uraimo/run-on-arch-action@v2
|
- uses: uraimo/run-on-arch-action@v3
|
||||||
name: Test
|
name: Test
|
||||||
id: runcmd
|
id: runcmd
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -1,38 +0,0 @@
|
|||||||
name: Ubuntu 20.04 CI (GCC 8)
|
|
||||||
|
|
||||||
on: [push, pull_request]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
ubuntu-build:
|
|
||||||
if: >-
|
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
|
||||||
runs-on: ubuntu-20.04
|
|
||||||
env:
|
|
||||||
CXX: g++-8
|
|
||||||
CC: gcc-8
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: dependencies/.cache
|
|
||||||
key: ${{ hashFiles('dependencies/CMakeLists.txt') }}
|
|
||||||
- name: Install GCC 8
|
|
||||||
run: sudo apt-get install -y g++-8
|
|
||||||
- name: Use cmake
|
|
||||||
run: |
|
|
||||||
mkdir builddebug &&
|
|
||||||
cd builddebug &&
|
|
||||||
cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. &&
|
|
||||||
cmake --build . &&
|
|
||||||
ctest --output-on-failure -LE explicitonly -j &&
|
|
||||||
cd .. &&
|
|
||||||
mkdir build &&
|
|
||||||
cd build &&
|
|
||||||
cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. &&
|
|
||||||
cmake --build . &&
|
|
||||||
ctest --output-on-failure -LE explicitonly -j &&
|
|
||||||
cmake --install . &&
|
|
||||||
echo -e '#include <simdjson.h>\nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json &&
|
|
||||||
cd ../tests/installation_tests/find &&
|
|
||||||
mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build .
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
name: Ubuntu 20.04 CI (GCC 9)
|
|
||||||
|
|
||||||
on: [push, pull_request]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
ubuntu-build:
|
|
||||||
if: >-
|
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
|
||||||
runs-on: ubuntu-20.04
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- uses: actions/cache@v4
|
|
||||||
with:
|
|
||||||
path: dependencies/.cache
|
|
||||||
key: ${{ hashFiles('dependencies/CMakeLists.txt') }}
|
|
||||||
- name: Use cmake to build just the library
|
|
||||||
run: |
|
|
||||||
mkdir buildjustlib &&
|
|
||||||
cd buildjustlib &&
|
|
||||||
cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_DEVELOPER_MODE=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. &&
|
|
||||||
cmake --build . &&
|
|
||||||
cmake --install . &&
|
|
||||||
echo -e '#include <simdjson.h>\nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp &&
|
|
||||||
c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson &&
|
|
||||||
cd ../tests/installation_tests/find &&
|
|
||||||
mkdir buildjustlib &&
|
|
||||||
cd buildjustlib &&
|
|
||||||
cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../buildjustlib/destination .. &&
|
|
||||||
cmake --build .
|
|
||||||
- name: Use cmake
|
|
||||||
run: |
|
|
||||||
mkdir builddebug &&
|
|
||||||
cd builddebug &&
|
|
||||||
cmake -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. &&
|
|
||||||
cmake --build . &&
|
|
||||||
ctest --output-on-failure -LE explicitonly -j &&
|
|
||||||
cd .. &&
|
|
||||||
mkdir build &&
|
|
||||||
cd build &&
|
|
||||||
cmake -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. &&
|
|
||||||
cmake --build . &&
|
|
||||||
ctest --output-on-failure -LE explicitonly -j &&
|
|
||||||
cmake --install . &&
|
|
||||||
echo -e '#include <simdjson.h>\nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json &&
|
|
||||||
cd ../tests/installation_tests/find &&
|
|
||||||
mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build .
|
|
||||||
@@ -14,20 +14,52 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
path: dependencies/.cache
|
path: dependencies/.cache
|
||||||
key: ${{ hashFiles('dependencies/CMakeLists.txt') }}
|
key: ${{ hashFiles('dependencies/CMakeLists.txt') }}
|
||||||
- name: Use cmake
|
|
||||||
|
- name: Configure Debug Build
|
||||||
run: |
|
run: |
|
||||||
mkdir builddebug &&
|
CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -B builddebug
|
||||||
cd builddebug &&
|
|
||||||
CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF .. &&
|
- name: Compile Debug Build
|
||||||
cmake --build . &&
|
run: |
|
||||||
ctest --output-on-failure -LE explicitonly -j &&
|
cmake --build builddebug
|
||||||
cd .. &&
|
|
||||||
mkdir build &&
|
- name: Test Debug Build
|
||||||
cd build &&
|
run: |
|
||||||
CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. &&
|
ctest --output-on-failure -LE explicitonly -j --test-dir builddebug
|
||||||
cmake --build . &&
|
|
||||||
ctest --output-on-failure -LE explicitonly -j &&
|
- name: Configure Release Build
|
||||||
cmake --install . &&
|
run: |
|
||||||
echo -e '#include <simdjson.h>\nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp && c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson && ./linkandrun jsonexamples/twitter.json &&
|
CXX=g++-12 cmake -DSIMDJSON_CXX_STANDARD=20 -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination -B build
|
||||||
cd ../tests/installation_tests/find &&
|
|
||||||
mkdir build && cd build && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build/destination .. && cmake --build .
|
- name: Compile Release Build
|
||||||
|
run: |
|
||||||
|
cmake --build build
|
||||||
|
|
||||||
|
- name: Test Release Build
|
||||||
|
run: |
|
||||||
|
ctest --output-on-failure -LE explicitonly -j --test-dir build
|
||||||
|
|
||||||
|
- name: Install Release Build
|
||||||
|
run: |
|
||||||
|
cmake --install build
|
||||||
|
|
||||||
|
- name: Generate Example Code
|
||||||
|
run: |
|
||||||
|
echo -e '#include <simdjson.h>\nint main(int argc,char**argv) {simdjson::dom::parser parser;simdjson::dom::element tweets = parser.load(argv[1]); }' > tmp.cpp
|
||||||
|
|
||||||
|
- name: Compile Example Code
|
||||||
|
run: |
|
||||||
|
c++ -Idestination/include -Ldestination/lib -std=c++17 -Wl,-rpath,destination/lib -o linkandrun tmp.cpp -lsimdjson
|
||||||
|
|
||||||
|
- name: Run Example Code
|
||||||
|
run: |
|
||||||
|
./linkandrun jsonexamples/twitter.json
|
||||||
|
|
||||||
|
- name: Configure Find Tests
|
||||||
|
run: |
|
||||||
|
cd tests/installation_tests/find && \
|
||||||
|
cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../destination -B build
|
||||||
|
|
||||||
|
- name: Compile Find Tests
|
||||||
|
run: |
|
||||||
|
cd tests/installation_tests/find && cmake --build build
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ jobs:
|
|||||||
if: >-
|
if: >-
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
name: Ubuntu 24.04 CI (CXX 20, noexcept)
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
jobs:
|
||||||
|
ubuntu-build:
|
||||||
|
if: >-
|
||||||
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
|
runs-on: ubuntu-24.04
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
cxx: [g++-13, clang++-16]
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
|
||||||
|
- name: Prepare
|
||||||
|
run: cmake -DSIMDJSON_CXX_STANDARD=20 -DSIMDJSON_EXCEPTIONS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -B build
|
||||||
|
env:
|
||||||
|
CXX: ${{matrix.cxx}}
|
||||||
|
- name: Build
|
||||||
|
run: cmake --build build -j=2
|
||||||
|
- name: Test
|
||||||
|
run: ctest --output-on-failure --test-dir build
|
||||||
@@ -7,7 +7,7 @@ jobs:
|
|||||||
if: >-
|
if: >-
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
@@ -7,7 +7,7 @@ jobs:
|
|||||||
if: >-
|
if: >-
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
@@ -7,7 +7,7 @@ jobs:
|
|||||||
if: >-
|
if: >-
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
@@ -25,7 +25,7 @@ jobs:
|
|||||||
if: >-
|
if: >-
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
runs-on: ubuntu-20.04
|
runs-on: ubuntu-24.04
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- uses: actions/cache@v4
|
- uses: actions/cache@v4
|
||||||
@@ -10,7 +10,6 @@ jobs:
|
|||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
include:
|
include:
|
||||||
- {arch: ARM}
|
|
||||||
- {arch: ARM64}
|
- {arch: ARM64}
|
||||||
- {arch: ARM64EC}
|
- {arch: ARM64EC}
|
||||||
steps:
|
steps:
|
||||||
@@ -19,4 +18,4 @@ jobs:
|
|||||||
- name: Use cmake
|
- name: Use cmake
|
||||||
run: |
|
run: |
|
||||||
cmake -A ${{ matrix.arch }} -DCMAKE_SYSTEM_VERSION="10.0.22621.0" -DCMAKE_CROSSCOMPILING=1 -DSIMDJSON_DEVELOPER_MODE=ON -D SIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_EXCEPTIONS=OFF -B build &&
|
cmake -A ${{ matrix.arch }} -DCMAKE_SYSTEM_VERSION="10.0.22621.0" -DCMAKE_CROSSCOMPILING=1 -DSIMDJSON_DEVELOPER_MODE=ON -D SIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_EXCEPTIONS=OFF -B build &&
|
||||||
cmake --build build --verbose
|
cmake --build build --verbose
|
||||||
|
|||||||
@@ -0,0 +1,30 @@
|
|||||||
|
name: VS17-CI-SANITIZE
|
||||||
|
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
ci:
|
||||||
|
if: >-
|
||||||
|
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||||
|
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||||
|
name: windows-vs17
|
||||||
|
runs-on: windows-latest
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Debug}
|
||||||
|
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Release}
|
||||||
|
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: RelWithDebInfo}
|
||||||
|
steps:
|
||||||
|
- name: checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Configure
|
||||||
|
run: |
|
||||||
|
cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -DSANITIZE=ON -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -DBUILD_SHARED_LIBS=${{matrix.shared}} -B build
|
||||||
|
- name: Build
|
||||||
|
run: cmake --build build --config ${{matrix.build_type}} --verbose
|
||||||
|
- name: Run tests
|
||||||
|
run: |
|
||||||
|
cd build
|
||||||
|
ctest -C ${{matrix.build_type}} -LE explicitonly --output-on-failure
|
||||||
+3
-2
@@ -38,7 +38,7 @@ cmake-build-release/
|
|||||||
.history/
|
.history/
|
||||||
|
|
||||||
# Visual Studio artifacts
|
# Visual Studio artifacts
|
||||||
/VS/
|
/.vs/
|
||||||
|
|
||||||
# C/C++ build outputs
|
# C/C++ build outputs
|
||||||
.build/
|
.build/
|
||||||
@@ -88,6 +88,7 @@ objs
|
|||||||
# Build outputs
|
# Build outputs
|
||||||
/build*/
|
/build*/
|
||||||
/visual_studio/
|
/visual_studio/
|
||||||
|
/originbuild/
|
||||||
|
|
||||||
# Fuzzer outputs generated by instructions in fuzz/Fuzzing.md
|
# Fuzzer outputs generated by instructions in fuzz/Fuzzing.md
|
||||||
/corpus.zip
|
/corpus.zip
|
||||||
@@ -106,4 +107,4 @@ objs
|
|||||||
!.vscode/extensions.json
|
!.vscode/extensions.json
|
||||||
|
|
||||||
# clangd
|
# clangd
|
||||||
.cache
|
.cache
|
||||||
|
|||||||
Vendored
+3
@@ -3,6 +3,9 @@
|
|||||||
{"column": 95 },
|
{"column": 95 },
|
||||||
{"column": 120 }
|
{"column": 120 }
|
||||||
],
|
],
|
||||||
|
"cmake.configureArgs": [
|
||||||
|
"-DSIMDJSON_DEVELOPER_MODE=ON"
|
||||||
|
],
|
||||||
"files.trimTrailingWhitespace": true,
|
"files.trimTrailingWhitespace": true,
|
||||||
"files.associations": {
|
"files.associations": {
|
||||||
".clangd": "yaml",
|
".clangd": "yaml",
|
||||||
|
|||||||
+34
-5
@@ -3,7 +3,7 @@ cmake_minimum_required(VERSION 3.14)
|
|||||||
project(
|
project(
|
||||||
simdjson
|
simdjson
|
||||||
# The version number is modified by tools/release.py
|
# The version number is modified by tools/release.py
|
||||||
VERSION 3.10.1
|
VERSION 4.0.2
|
||||||
DESCRIPTION "Parsing gigabytes of JSON per second"
|
DESCRIPTION "Parsing gigabytes of JSON per second"
|
||||||
HOMEPAGE_URL "https://simdjson.org/"
|
HOMEPAGE_URL "https://simdjson.org/"
|
||||||
LANGUAGES CXX C
|
LANGUAGES CXX C
|
||||||
@@ -20,8 +20,8 @@ string(
|
|||||||
# ---- Options, variables ----
|
# ---- Options, variables ----
|
||||||
|
|
||||||
# These version numbers are modified by tools/release.py
|
# These version numbers are modified by tools/release.py
|
||||||
set(SIMDJSON_LIB_VERSION "23.0.0" CACHE STRING "simdjson library version")
|
set(SIMDJSON_LIB_VERSION "27.0.0" CACHE STRING "simdjson library version")
|
||||||
set(SIMDJSON_LIB_SOVERSION "23" CACHE STRING "simdjson library soversion")
|
set(SIMDJSON_LIB_SOVERSION "27" CACHE STRING "simdjson library soversion")
|
||||||
|
|
||||||
option(SIMDJSON_BUILD_STATIC_LIB "Build simdjson_static library along with simdjson (only makes sense if BUILD_SHARED_LIBS=ON)" OFF)
|
option(SIMDJSON_BUILD_STATIC_LIB "Build simdjson_static library along with simdjson (only makes sense if BUILD_SHARED_LIBS=ON)" OFF)
|
||||||
if(SIMDJSON_BUILD_STATIC_LIB AND NOT BUILD_SHARED_LIBS)
|
if(SIMDJSON_BUILD_STATIC_LIB AND NOT BUILD_SHARED_LIBS)
|
||||||
@@ -43,6 +43,20 @@ if(SIMDJSON_DISABLE_DEPRECATED_API)
|
|||||||
)
|
)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
if(${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.25.0")
|
||||||
|
option(SIMDJSON_STATIC_REFLECTION "Enables static reflection (experimental), requires C++26" OFF)
|
||||||
|
else()
|
||||||
|
set(SIMDJSON_STATIC_REFLECTION OFF CACHE BOOL "Enables static reflection (experimental)" FORCE)
|
||||||
|
message(WARNING "SIMDJSON_STATIC_REFLECTION is disabled because your CMake version is below 3.25")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if(SIMDJSON_STATIC_REFLECTION)
|
||||||
|
simdjson_add_props(
|
||||||
|
target_compile_definitions PUBLIC
|
||||||
|
SIMDJSON_STATIC_REFLECTION=1
|
||||||
|
)
|
||||||
|
endif()
|
||||||
|
|
||||||
option(SIMDJSON_DEVELOPMENT_CHECKS "Enable development-time aids, such as \
|
option(SIMDJSON_DEVELOPMENT_CHECKS "Enable development-time aids, such as \
|
||||||
checks for incorrect API usage. Enabled by default in DEBUG." OFF)
|
checks for incorrect API usage. Enabled by default in DEBUG." OFF)
|
||||||
if(SIMDJSON_DEVELOPMENT_CHECKS)
|
if(SIMDJSON_DEVELOPMENT_CHECKS)
|
||||||
@@ -84,7 +98,7 @@ set_target_properties(
|
|||||||
)
|
)
|
||||||
|
|
||||||
# FIXME: Use proper CMake integration for exports
|
# FIXME: Use proper CMake integration for exports
|
||||||
if(MSVC AND BUILD_SHARED_LIBS)
|
if(WIN32 AND BUILD_SHARED_LIBS)
|
||||||
target_compile_definitions(
|
target_compile_definitions(
|
||||||
simdjson
|
simdjson
|
||||||
PRIVATE SIMDJSON_BUILDING_WINDOWS_DYNAMIC_LIBRARY=1
|
PRIVATE SIMDJSON_BUILDING_WINDOWS_DYNAMIC_LIBRARY=1
|
||||||
@@ -98,7 +112,16 @@ simdjson_add_props(
|
|||||||
PRIVATE "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
|
PRIVATE "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
|
||||||
)
|
)
|
||||||
|
|
||||||
simdjson_add_props(target_compile_features PUBLIC cxx_std_11)
|
if(SIMDJSON_STATIC_REFLECTION)
|
||||||
|
# We would like to require C++26, but no compiler supports that!
|
||||||
|
# This is a hack:
|
||||||
|
simdjson_add_props(
|
||||||
|
target_compile_options PUBLIC
|
||||||
|
-freflection -fexpansion-statements -stdlib=libc++ -std=c++26
|
||||||
|
)
|
||||||
|
else()
|
||||||
|
simdjson_add_props(target_compile_features PUBLIC cxx_std_11)
|
||||||
|
endif()
|
||||||
|
|
||||||
# workaround for GNU GCC poor AVX load/store code generation
|
# workaround for GNU GCC poor AVX load/store code generation
|
||||||
if(
|
if(
|
||||||
@@ -111,6 +134,12 @@ if(
|
|||||||
)
|
)
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
option(SIMDJSON_MINUS_ZERO_AS_FLOAT "Treat -0 as a floating-point value" OFF)
|
||||||
|
|
||||||
|
if(SIMDJSON_MINUS_ZERO_AS_FLOAT)
|
||||||
|
simdjson_add_props(target_compile_definitions PRIVATE SIMDJSON_MINUS_ZERO_AS_FLOAT=1)
|
||||||
|
endif(SIMDJSON_MINUS_ZERO_AS_FLOAT)
|
||||||
|
|
||||||
if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(loongarch64)$")
|
if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(loongarch64)$")
|
||||||
option(SIMDJSON_PREFER_LSX "Prefer LoongArch SX" ON)
|
option(SIMDJSON_PREFER_LSX "Prefer LoongArch SX" ON)
|
||||||
include(CheckCXXCompilerFlag)
|
include(CheckCXXCompilerFlag)
|
||||||
|
|||||||
+1
-1
@@ -92,7 +92,7 @@ We welcome contributions from women and less represented groups. If you need hel
|
|||||||
|
|
||||||
Consider the following points when engaging with the project:
|
Consider the following points when engaging with the project:
|
||||||
|
|
||||||
- We discourage arguments from authority: ideas are discusssed on their own merits and not based on who stated it.
|
- We discourage arguments from authority: ideas are discussed on their own merits and not based on who stated it.
|
||||||
- Be mindful that what you may view as an aggression is maybe merely a difference of opinion or a misunderstanding.
|
- Be mindful that what you may view as an aggression is maybe merely a difference of opinion or a misunderstanding.
|
||||||
- Be mindful that a collection of small aggressions, even if mild in isolation, can become harmful.
|
- Be mindful that a collection of small aggressions, even if mild in isolation, can become harmful.
|
||||||
|
|
||||||
|
|||||||
@@ -38,7 +38,7 @@ PROJECT_NAME = simdjson
|
|||||||
# could be handy for archiving the generated documentation or if some version
|
# could be handy for archiving the generated documentation or if some version
|
||||||
# control system is used.
|
# control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = "3.10.1"
|
PROJECT_NUMBER = "4.0.2"
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer a
|
# for a project that appears at the top of each page and should give viewer a
|
||||||
|
|||||||
+46
-8
@@ -20,13 +20,54 @@ If you plan to contribute to simdjson, please read our [CONTRIBUTING](https://gi
|
|||||||
Build Quickstart
|
Build Quickstart
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
|
For non-Windows system,
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir build
|
cmake -B -D SIMDJSON_DEVELOPER_MODE=ON ..
|
||||||
cd build
|
cmake --build build
|
||||||
cmake -D SIMDJSON_DEVELOPER_MODE=ON ..
|
ctest --test-dir build
|
||||||
cmake --build .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
It is similar for Visual Studio users, please see the CMake or Visual Studio documentation.
|
||||||
|
|
||||||
|
By default the library is built in Release mode.
|
||||||
|
|
||||||
|
|
||||||
|
Assertions and development checks
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
We do not use conventional `assert` in simdjson. Instead we use the macro
|
||||||
|
`SIMDJSON_ASSUME`:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
SIMDJSON_ASSUME(something_that_is_true());
|
||||||
|
```
|
||||||
|
|
||||||
|
Sometimes, you need to do a bit more work that a simple check.
|
||||||
|
The `SIMDJSON_DEVELOPMENT_CHECKS` macro is true only in Debug mode unless manually set.
|
||||||
|
It is acceptable to add checks that you would not do in Release mode as long as
|
||||||
|
they are guarded:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#if SIMDJSON_DEVELOPMENT_CHECKS
|
||||||
|
// do sanity checks here
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Working with sanitizers
|
||||||
|
------------------------------
|
||||||
|
|
||||||
|
The simdjson library must be memory-safe. We cannot allow buffer overruns.
|
||||||
|
During development, if you system supports it, we recommend configuring
|
||||||
|
the project with `-D SIMDJSON_SANITIZE=ON`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cmake -B -D SIMDJSON_SANITIZE=ON -D SIMDJSON_DEVELOPER_MODE=ON ..
|
||||||
|
cmake --build build
|
||||||
|
ctest --test-dir build
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
Design notes
|
Design notes
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
@@ -103,12 +144,9 @@ simdjson's source structure, from the top level, looks like this:
|
|||||||
* generic/stage2/*.h: `simdjson::<implementation>::stage2` namespace. Generic implementation of the tape creator, which consumes the index from stage 1 and actually parses numbers and string and such. Used for the DOM interface.
|
* generic/stage2/*.h: `simdjson::<implementation>::stage2` namespace. Generic implementation of the tape creator, which consumes the index from stage 1 and actually parses numbers and string and such. Used for the DOM interface.
|
||||||
|
|
||||||
Other important files and directories:
|
Other important files and directories:
|
||||||
* **.drone.yml:** Definitions for Drone CI.
|
|
||||||
* **.appveyor.yml:** Definitions for Appveyor CI (Windows).
|
|
||||||
* **.circleci:** Definitions for Circle CI.
|
|
||||||
* **.github/workflows:** Definitions for GitHub Actions (CI).
|
* **.github/workflows:** Definitions for GitHub Actions (CI).
|
||||||
* **singleheader:** Contains generated `simdjson.h` and `simdjson.cpp` that we release. The files `singleheader/simdjson.h` and `singleheader/simdjson.cpp` should never be edited by hand.
|
* **singleheader:** Contains generated `simdjson.h` and `simdjson.cpp` that we release. The files `singleheader/simdjson.h` and `singleheader/simdjson.cpp` should never be edited by hand.
|
||||||
* **singleheader/amalgamate.py:** Generates `singleheader/simdjson.h` and `singleheader/simdjson.cpp` for release (python script).
|
* **singleheader/amalgamate.py:** Generates `singleheader/simdjson.h` and `singleheader/simdjson.cpp` for release (python script). If you add a new implementation (e.g., rvv), you need to edit this file (IMPLEMENTATIONS).
|
||||||
* **benchmark:** This is where we do benchmarking. Benchmarking is core to every change we make; the
|
* **benchmark:** This is where we do benchmarking. Benchmarking is core to every change we make; the
|
||||||
cardinal rule is don't regress performance without knowing exactly why, and what you're trading
|
cardinal rule is don't regress performance without knowing exactly why, and what you're trading
|
||||||
for it. Many of our benchmarks are microbenchmarks. We are effectively doing controlled scientific experiments for the purpose of understanding what affects our performance. So we simplify as much as possible. We try to avoid irrelevant factors such as page faults, interrupts, unnecessary system calls. We recommend checking the performance as follows:
|
for it. Many of our benchmarks are microbenchmarks. We are effectively doing controlled scientific experiments for the purpose of understanding what affects our performance. So we simplify as much as possible. We try to avoid irrelevant factors such as page faults, interrupts, unnecessary system calls. We recommend checking the performance as follows:
|
||||||
|
|||||||
@@ -186,7 +186,7 @@
|
|||||||
same "printed page" as the copyright notice for easier
|
same "printed page" as the copyright notice for easier
|
||||||
identification within third-party archives.
|
identification within third-party archives.
|
||||||
|
|
||||||
Copyright 2018-2023 The simdjson authors
|
Copyright 2018-2025 The simdjson authors
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
|
|||||||
+18
@@ -0,0 +1,18 @@
|
|||||||
|
Copyright 2018-2025 The simdjson authors
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||||
|
this software and associated documentation files (the "Software"), to deal in
|
||||||
|
the Software without restriction, including without limitation the rights to
|
||||||
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
||||||
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
||||||
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||||
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
@@ -1,7 +1,5 @@
|
|||||||
|
[![][license img]][license] [![][licensemit img]][licensemit]
|
||||||
|
|
||||||
[/badge.svg)](https://simdjson.org/plots.html)
|
|
||||||
[](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:simdjson)
|
|
||||||
[![][license img]][license]
|
|
||||||
|
|
||||||
[](https://simdjson.github.io/simdjson/)
|
[](https://simdjson.github.io/simdjson/)
|
||||||
|
|
||||||
@@ -31,6 +29,7 @@ Table of Contents
|
|||||||
* [Documentation](#documentation)
|
* [Documentation](#documentation)
|
||||||
* [Godbolt](#godbolt)
|
* [Godbolt](#godbolt)
|
||||||
* [Performance results](#performance-results)
|
* [Performance results](#performance-results)
|
||||||
|
* [Packages](#packages)
|
||||||
* [Bindings and Ports of simdjson](#bindings-and-ports-of-simdjson)
|
* [Bindings and Ports of simdjson](#bindings-and-ports-of-simdjson)
|
||||||
* [About simdjson](#about-simdjson)
|
* [About simdjson](#about-simdjson)
|
||||||
* [Funding](#funding)
|
* [Funding](#funding)
|
||||||
@@ -61,6 +60,9 @@ Real-world usage
|
|||||||
- [ada-url](https://github.com/ada-url/ada)
|
- [ada-url](https://github.com/ada-url/ada)
|
||||||
- [fastgron](https://github.com/adamritter/fastgron)
|
- [fastgron](https://github.com/adamritter/fastgron)
|
||||||
- [WasmEdge](https://wasmedge.org)
|
- [WasmEdge](https://wasmedge.org)
|
||||||
|
- [RonDB](https://github.com/logicalclocks/rondb)
|
||||||
|
- [GreptimeDB](https://github.com/GreptimeTeam/greptimedb)
|
||||||
|
|
||||||
|
|
||||||
If you are planning to use simdjson in a product, please work from one of our releases.
|
If you are planning to use simdjson in a product, please work from one of our releases.
|
||||||
|
|
||||||
@@ -105,6 +107,7 @@ Documentation
|
|||||||
Usage documentation is available:
|
Usage documentation is available:
|
||||||
|
|
||||||
* [Basics](doc/basics.md) is an overview of how to use simdjson and its APIs.
|
* [Basics](doc/basics.md) is an overview of how to use simdjson and its APIs.
|
||||||
|
* [Builder](doc/builder.md) is an overview of how to efficiently write JSON strings using simdjson.
|
||||||
* [Performance](doc/performance.md) shows some more advanced scenarios and how to tune for them.
|
* [Performance](doc/performance.md) shows some more advanced scenarios and how to tune for them.
|
||||||
* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and
|
* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and
|
||||||
how you can work with it.
|
how you can work with it.
|
||||||
@@ -116,6 +119,7 @@ Godbolt
|
|||||||
Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples:
|
Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples:
|
||||||
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/7G5qE4sr9)
|
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/7G5qE4sr9)
|
||||||
* [simdjson examples with errors without exceptions](https://godbolt.org/z/e9dWb9E4v)
|
* [simdjson examples with errors without exceptions](https://godbolt.org/z/e9dWb9E4v)
|
||||||
|
* [C++26 reflection example](https://godbolt.org/z/xK5TGKdPb)
|
||||||
|
|
||||||
Performance results
|
Performance results
|
||||||
-------------------
|
-------------------
|
||||||
@@ -143,6 +147,9 @@ speed for [synthetic files over various sizes generated with a script](https://g
|
|||||||
For NDJSON files, we can exceed 3 GB/s with [our multithreaded parsing functions](https://github.com/simdjson/simdjson/blob/master/doc/parse_many.md).
|
For NDJSON files, we can exceed 3 GB/s with [our multithreaded parsing functions](https://github.com/simdjson/simdjson/blob/master/doc/parse_many.md).
|
||||||
|
|
||||||
|
|
||||||
|
Packages
|
||||||
|
------------------------------
|
||||||
|
[](https://repology.org/project/simdjson/versions)
|
||||||
|
|
||||||
|
|
||||||
Bindings and Ports of simdjson
|
Bindings and Ports of simdjson
|
||||||
@@ -167,7 +174,8 @@ We distinguish between "bindings" (which just wrap the C++ code) and a port to a
|
|||||||
- [simdjsone](https://github.com/saleyn/simdjsone): erlang bindings.
|
- [simdjsone](https://github.com/saleyn/simdjsone): erlang bindings.
|
||||||
- [lua-simdjson](https://github.com/FourierTransformer/lua-simdjson): lua bindings.
|
- [lua-simdjson](https://github.com/FourierTransformer/lua-simdjson): lua bindings.
|
||||||
- [hermes-json](https://hackage.haskell.org/package/hermes-json): haskell bindings.
|
- [hermes-json](https://hackage.haskell.org/package/hermes-json): haskell bindings.
|
||||||
- [simdjzon](https://github.com/travisstaloch/simdjzon): zig port.
|
- [zimdjson](https://github.com/EzequielRamis/zimdjson): Zig port.
|
||||||
|
- [simdjzon](https://github.com/travisstaloch/simdjzon): Zig port.
|
||||||
- [JSON-Simd](https://github.com/rawleyfowler/JSON-simd): Raku bindings.
|
- [JSON-Simd](https://github.com/rawleyfowler/JSON-simd): Raku bindings.
|
||||||
- [JSON::SIMD](https://metacpan.org/pod/JSON::SIMD): Perl bindings; fully-featured JSON module that uses simdjson for decoding.
|
- [JSON::SIMD](https://metacpan.org/pod/JSON::SIMD): Perl bindings; fully-featured JSON module that uses simdjson for decoding.
|
||||||
- [gemmaJSON](https://github.com/sainttttt/gemmaJSON): Nim JSON parser based on simdjson bindings.
|
- [gemmaJSON](https://github.com/sainttttt/gemmaJSON): Nim JSON parser based on simdjson bindings.
|
||||||
@@ -207,6 +215,11 @@ RGPIN-2017-03910 and RGPIN-2024-03787.
|
|||||||
[license]: LICENSE
|
[license]: LICENSE
|
||||||
[license img]: https://img.shields.io/badge/License-Apache%202-blue.svg
|
[license img]: https://img.shields.io/badge/License-Apache%202-blue.svg
|
||||||
|
|
||||||
|
|
||||||
|
[licensemit]: LICENSE-MIT
|
||||||
|
[licensemit img]: https://img.shields.io/badge/License-MIT-blue.svg
|
||||||
|
|
||||||
|
|
||||||
Contributing to simdjson
|
Contributing to simdjson
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
@@ -216,7 +229,7 @@ Head over to [CONTRIBUTING.md](CONTRIBUTING.md) for information on contributing
|
|||||||
License
|
License
|
||||||
-------
|
-------
|
||||||
|
|
||||||
This code is made available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html).
|
This code is made available under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) as well as under the MIT License. As a user, you can pick the license you prefer.
|
||||||
|
|
||||||
Under Windows, we build some tools using the windows/dirent_portable.h file (which is outside our library code): it is under the liberal (business-friendly) MIT license.
|
Under Windows, we build some tools using the windows/dirent_portable.h file (which is outside our library code): it is under the liberal (business-friendly) MIT license.
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,9 @@ add_subdirectory(dom)
|
|||||||
include_directories( . linux )
|
include_directories( . linux )
|
||||||
link_libraries(simdjson-windows-headers test-data)
|
link_libraries(simdjson-windows-headers test-data)
|
||||||
link_libraries(simdjson)
|
link_libraries(simdjson)
|
||||||
|
if(SIMDJSON_STATIC_REFLECTION)
|
||||||
|
add_compile_definitions(SIMDJSON_STATIC_REFLECTION=1)
|
||||||
|
endif(SIMDJSON_STATIC_REFLECTION)
|
||||||
|
|
||||||
add_executable(benchfeatures benchfeatures.cpp)
|
add_executable(benchfeatures benchfeatures.cpp)
|
||||||
add_executable(get_corpus_benchmark get_corpus_benchmark.cpp)
|
add_executable(get_corpus_benchmark get_corpus_benchmark.cpp)
|
||||||
@@ -32,3 +35,16 @@ if (TARGET benchmark::benchmark)
|
|||||||
endif()
|
endif()
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
|
||||||
|
include(CheckCXXCompilerFlag)
|
||||||
|
check_cxx_compiler_flag("-std=c++20" SIMDJSON_COMPILER_SUPPORTS_CXX20)
|
||||||
|
if(SIMDJSON_STATIC_REFLECTION)
|
||||||
|
add_subdirectory(static_reflect)
|
||||||
|
else()
|
||||||
|
if(SIMDJSON_EXCEPTIONS AND SIMDJSON_COMPILER_SUPPORTS_CXX20)
|
||||||
|
add_subdirectory(from)
|
||||||
|
add_subdirectory(car_builder)
|
||||||
|
endif()
|
||||||
|
endif(SIMDJSON_STATIC_REFLECTION)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+618
@@ -0,0 +1,618 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# JSON Parsing Compilation Benchmark: Reflection Usage vs Manual Parsing
|
||||||
|
# Compares compilation times when ACTUALLY USING reflection for parsing vs manual parsing
|
||||||
|
# This measures the compile-time cost of reflection-based automatic deserialization
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "=== simdjson Reflection Usage Compilation Benchmark ==="
|
||||||
|
echo "Measuring compilation impact of ACTUALLY USING reflection for parsing"
|
||||||
|
echo "Starting at: $(date)"
|
||||||
|
echo
|
||||||
|
echo "╔════════════════════════════════════════════════════════════════════════════╗"
|
||||||
|
echo "║ METHODOLOGY ║"
|
||||||
|
echo "╠════════════════════════════════════════════════════════════════════════════╣"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ FAIR COMPARISON STRATEGY: ║"
|
||||||
|
echo "║ This benchmark compares two DIFFERENT approaches to parsing the same JSON: ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ • MANUAL PARSING: Traditional simdjson with explicit .get() calls ║"
|
||||||
|
echo "║ - Uses doc[\"field\"].get(variable) for each field ║"
|
||||||
|
echo "║ - No reflection involved ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ • REFLECTION PARSING: Automatic deserialization with reflection ║"
|
||||||
|
echo "║ - Uses doc.get<MyStruct>() for automatic field mapping ║"
|
||||||
|
echo "║ - Relies on compile-time reflection to generate parsing code ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ WHAT WE'RE MEASURING: ║"
|
||||||
|
echo "║ • Compile-time cost of reflection-based automatic deserialization ║"
|
||||||
|
echo "║ • Template instantiation overhead for reflection parsing ║"
|
||||||
|
echo "║ • Code generation complexity from using reflection features ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ TEST SCENARIOS: ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ 1. SIMPLE STRUCT: Basic fields (string, int, bool) ║"
|
||||||
|
echo "║ - Measures baseline reflection overhead ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ 2. NESTED STRUCT: Multiple levels of nested objects ║"
|
||||||
|
echo "║ - Measures reflection complexity scaling ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ 3. COMPLEX STRUCT: Arrays, optional fields, mixed types ║"
|
||||||
|
echo "║ - Measures real-world reflection usage impact ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ WHY THIS IS MEANINGFUL: ║"
|
||||||
|
echo "║ • Shows actual cost of using reflection features ║"
|
||||||
|
echo "║ • Measures compile-time code generation overhead ║"
|
||||||
|
echo "║ • Helps developers understand reflection's compilation impact ║"
|
||||||
|
echo "║ • Compares equivalent functionality implemented two different ways ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "╚════════════════════════════════════════════════════════════════════════════╝"
|
||||||
|
echo
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
ITERATIONS=10
|
||||||
|
JOBS=4
|
||||||
|
|
||||||
|
# ───────────────────────────── BOX-PRINT HELPER ────────────────────────────
|
||||||
|
BOX_WIDTH=74 # characters between the pipes
|
||||||
|
print_box_line() { # usage: print_box_line "text"
|
||||||
|
printf "║ %-*s ║\n" "${BOX_WIDTH}" "$1"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to test if a compiler supports reflection with debug output
|
||||||
|
test_reflection_support() {
|
||||||
|
local compiler="$1"
|
||||||
|
echo " → Testing compiler: $compiler"
|
||||||
|
|
||||||
|
if [ ! -x "$compiler" ] && ! command -v "$compiler" >/dev/null 2>&1; then
|
||||||
|
echo " → Compiler not found or not executable"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check compiler version first
|
||||||
|
echo " → Compiler version: $("$compiler" --version 2>/dev/null | head -n1 || echo "version check failed")"
|
||||||
|
|
||||||
|
# Simple test: check if compiler accepts reflection flags
|
||||||
|
local test_file=$(mktemp /tmp/reflection_test_XXXXXX.cpp)
|
||||||
|
cat > "$test_file" << 'EOF'
|
||||||
|
int main() {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
echo " → Testing basic reflection flags..."
|
||||||
|
local test_exe=$(mktemp /tmp/reflection_test_XXXXXX)
|
||||||
|
local basic_result=$("$compiler" -freflection -fexpansion-statements -std=c++26 "$test_file" -o "$test_exe" 2>&1)
|
||||||
|
local basic_exit_code=$?
|
||||||
|
|
||||||
|
if [ $basic_exit_code -ne 0 ]; then
|
||||||
|
echo " → Basic flags FAILED with exit code $basic_exit_code"
|
||||||
|
echo " → Error output: $basic_result"
|
||||||
|
rm -f "$test_file" "$test_exe"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
echo " → Basic flags: OK"
|
||||||
|
rm -f "$test_exe"
|
||||||
|
|
||||||
|
# Test reflection syntax
|
||||||
|
echo " → Testing reflection syntax..."
|
||||||
|
cat > "$test_file" << 'EOF'
|
||||||
|
struct Test {
|
||||||
|
int x;
|
||||||
|
};
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
auto refl = ^^Test;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
local syntax_result=$("$compiler" -freflection -fexpansion-statements -std=c++26 "$test_file" -o "$test_exe" 2>&1)
|
||||||
|
local syntax_exit_code=$?
|
||||||
|
|
||||||
|
if [ $syntax_exit_code -eq 0 ]; then
|
||||||
|
echo " → Reflection syntax: OK"
|
||||||
|
echo " → ✓ REFLECTION SUPPORT CONFIRMED"
|
||||||
|
rm -f "$test_file" "$test_exe"
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
echo " → Reflection syntax FAILED with exit code $syntax_exit_code"
|
||||||
|
echo " → Error output: $syntax_result"
|
||||||
|
rm -f "$test_file" "$test_exe"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# Find a compiler with reflection support
|
||||||
|
echo "Searching for clang++ with reflection support..."
|
||||||
|
|
||||||
|
REFLECTION_CXX=""
|
||||||
|
REFLECTION_CC=""
|
||||||
|
|
||||||
|
# List of potential clang++ locations to check
|
||||||
|
POTENTIAL_COMPILERS=(
|
||||||
|
"/usr/local/bin/clang++"
|
||||||
|
"/opt/clang/bin/clang++"
|
||||||
|
"/usr/bin/clang++"
|
||||||
|
"clang++"
|
||||||
|
)
|
||||||
|
|
||||||
|
# If CXX is already set, test it first
|
||||||
|
if [ -n "$CXX" ]; then
|
||||||
|
echo "Testing user-specified compiler: $CXX"
|
||||||
|
if test_reflection_support "$CXX"; then
|
||||||
|
REFLECTION_CXX="$CXX"
|
||||||
|
echo "✓ User-specified compiler supports reflection: $CXX"
|
||||||
|
else
|
||||||
|
echo "✗ User-specified compiler does not support reflection: $CXX"
|
||||||
|
echo "Will search for alternative..."
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If we don't have a working compiler yet, search for one
|
||||||
|
if [ -z "$REFLECTION_CXX" ]; then
|
||||||
|
for compiler in "${POTENTIAL_COMPILERS[@]}"; do
|
||||||
|
echo "Testing: $compiler"
|
||||||
|
if test_reflection_support "$compiler"; then
|
||||||
|
REFLECTION_CXX="$compiler"
|
||||||
|
echo "✓ Found reflection-enabled compiler: $compiler"
|
||||||
|
break
|
||||||
|
else
|
||||||
|
echo "✗ No reflection support: $compiler"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Check if we found a working compiler
|
||||||
|
if [ -z "$REFLECTION_CXX" ]; then
|
||||||
|
echo
|
||||||
|
echo "╔════════════════════════════════════════════════════════════════════════════╗"
|
||||||
|
echo "║ ERROR ║"
|
||||||
|
echo "╠════════════════════════════════════════════════════════════════════════════╣"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ No clang++ compiler with reflection support found! ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ This benchmark requires a compiler that supports C++26 reflection. ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ Options: ║"
|
||||||
|
echo "║ 1. Use the Docker container: ./p2996/run_docker.sh ║"
|
||||||
|
echo "║ 2. Build clang with reflection from: https://github.com/bloomberg/clang-p2996 ║"
|
||||||
|
echo "║ 3. Set CXX environment variable to point to reflection-enabled clang++ ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ Example: CXX=/path/to/reflection-clang++ ./benchmark_script.sh ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "╚════════════════════════════════════════════════════════════════════════════╝"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Set the compilers
|
||||||
|
export CXX="$REFLECTION_CXX"
|
||||||
|
|
||||||
|
# Find corresponding C compiler
|
||||||
|
if [ -n "$CC" ]; then
|
||||||
|
REFLECTION_CC="$CC"
|
||||||
|
elif [ "$REFLECTION_CXX" = "/usr/local/bin/clang++" ]; then
|
||||||
|
REFLECTION_CC="/usr/local/bin/clang"
|
||||||
|
elif [ "$REFLECTION_CXX" = "/opt/clang/bin/clang++" ]; then
|
||||||
|
REFLECTION_CC="/opt/clang/bin/clang"
|
||||||
|
elif [ "$REFLECTION_CXX" = "/usr/bin/clang++" ]; then
|
||||||
|
REFLECTION_CC="/usr/bin/clang"
|
||||||
|
else
|
||||||
|
REFLECTION_CC="clang"
|
||||||
|
fi
|
||||||
|
|
||||||
|
export CC="$REFLECTION_CC"
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "Using reflection-enabled compiler: $($CXX --version | head -n1)"
|
||||||
|
echo "Using C compiler: $($CC --version | head -n1)"
|
||||||
|
echo
|
||||||
|
|
||||||
|
# Function to create manual parsing test
|
||||||
|
create_manual_parsing_test() {
|
||||||
|
local test_name="$1"
|
||||||
|
local struct_complexity="$2"
|
||||||
|
|
||||||
|
cat > "${test_name}_manual.cpp" << 'EOF'
|
||||||
|
#include <simdjson.h>
|
||||||
|
#include <iostream>
|
||||||
|
#include <string>
|
||||||
|
#include <vector>
|
||||||
|
#include <optional>
|
||||||
|
|
||||||
|
// Test structures
|
||||||
|
struct Person {
|
||||||
|
std::string name;
|
||||||
|
int age;
|
||||||
|
bool active;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Address {
|
||||||
|
std::string street;
|
||||||
|
std::string city;
|
||||||
|
int zipcode;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Employee {
|
||||||
|
Person person;
|
||||||
|
Address address;
|
||||||
|
std::vector<std::string> skills;
|
||||||
|
std::optional<std::string> department;
|
||||||
|
double salary;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Manual parsing functions
|
||||||
|
bool parse_person_manual(simdjson::ondemand::value& val, Person& person) {
|
||||||
|
auto obj = val.get_object();
|
||||||
|
if (obj.error()) return false;
|
||||||
|
|
||||||
|
for (auto field : obj) {
|
||||||
|
std::string_view key = field.unescaped_key();
|
||||||
|
if (key == "name") {
|
||||||
|
std::string_view name_val;
|
||||||
|
if (field.value().get(name_val)) return false;
|
||||||
|
person.name = name_val;
|
||||||
|
} else if (key == "age") {
|
||||||
|
if (field.value().get(person.age)) return false;
|
||||||
|
} else if (key == "active") {
|
||||||
|
if (field.value().get(person.active)) return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool parse_address_manual(simdjson::ondemand::value& val, Address& address) {
|
||||||
|
auto obj = val.get_object();
|
||||||
|
if (obj.error()) return false;
|
||||||
|
|
||||||
|
for (auto field : obj) {
|
||||||
|
std::string_view key = field.unescaped_key();
|
||||||
|
if (key == "street") {
|
||||||
|
std::string_view street_val;
|
||||||
|
if (field.value().get(street_val)) return false;
|
||||||
|
address.street = street_val;
|
||||||
|
} else if (key == "city") {
|
||||||
|
std::string_view city_val;
|
||||||
|
if (field.value().get(city_val)) return false;
|
||||||
|
address.city = city_val;
|
||||||
|
} else if (key == "zipcode") {
|
||||||
|
if (field.value().get(address.zipcode)) return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
bool parse_employee_manual(simdjson::ondemand::document& doc, Employee& employee) {
|
||||||
|
auto obj = doc.get_object();
|
||||||
|
if (obj.error()) return false;
|
||||||
|
|
||||||
|
for (auto field : obj) {
|
||||||
|
std::string_view key = field.unescaped_key();
|
||||||
|
if (key == "person") {
|
||||||
|
auto person_val = field.value();
|
||||||
|
if (!parse_person_manual(person_val, employee.person)) return false;
|
||||||
|
} else if (key == "address") {
|
||||||
|
auto addr_val = field.value();
|
||||||
|
if (!parse_address_manual(addr_val, employee.address)) return false;
|
||||||
|
} else if (key == "skills") {
|
||||||
|
auto skills_array = field.value().get_array();
|
||||||
|
if (skills_array.error()) return false;
|
||||||
|
for (auto skill : skills_array) {
|
||||||
|
std::string_view skill_val;
|
||||||
|
if (skill.get(skill_val)) return false;
|
||||||
|
employee.skills.emplace_back(skill_val);
|
||||||
|
}
|
||||||
|
} else if (key == "department") {
|
||||||
|
std::string_view dept_val;
|
||||||
|
if (!field.value().get(dept_val)) {
|
||||||
|
employee.department = dept_val;
|
||||||
|
}
|
||||||
|
} else if (key == "salary") {
|
||||||
|
if (field.value().get(employee.salary)) return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
std::string json_str = R"({
|
||||||
|
"person": {
|
||||||
|
"name": "John Doe",
|
||||||
|
"age": 30,
|
||||||
|
"active": true
|
||||||
|
},
|
||||||
|
"address": {
|
||||||
|
"street": "123 Main St",
|
||||||
|
"city": "Anytown",
|
||||||
|
"zipcode": 12345
|
||||||
|
},
|
||||||
|
"skills": ["C++", "JSON", "Programming"],
|
||||||
|
"department": "Engineering",
|
||||||
|
"salary": 85000.50
|
||||||
|
})";
|
||||||
|
|
||||||
|
simdjson::ondemand::document doc;
|
||||||
|
auto error = parser.iterate(simdjson::pad(json_str)).get(doc);
|
||||||
|
if (error) {
|
||||||
|
std::cerr << "Parse error" << std::endl;
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
Employee employee;
|
||||||
|
if (!parse_employee_manual(doc, employee)) {
|
||||||
|
std::cerr << "Manual parsing failed" << std::endl;
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::cout << "Manual parsing successful: " << employee.person.name
|
||||||
|
<< ", age " << employee.person.age << std::endl;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to create reflection parsing test
|
||||||
|
create_reflection_parsing_test() {
|
||||||
|
local test_name="$1"
|
||||||
|
local struct_complexity="$2"
|
||||||
|
|
||||||
|
cat > "${test_name}_reflection.cpp" << 'EOF'
|
||||||
|
#include <simdjson.h>
|
||||||
|
#include <iostream>
|
||||||
|
#include <string>
|
||||||
|
#include <vector>
|
||||||
|
#include <optional>
|
||||||
|
|
||||||
|
// Test structures (same as manual version)
|
||||||
|
struct Person {
|
||||||
|
std::string name;
|
||||||
|
int age;
|
||||||
|
bool active;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Address {
|
||||||
|
std::string street;
|
||||||
|
std::string city;
|
||||||
|
int zipcode;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Employee {
|
||||||
|
Person person;
|
||||||
|
Address address;
|
||||||
|
std::vector<std::string> skills;
|
||||||
|
std::optional<std::string> department;
|
||||||
|
double salary;
|
||||||
|
};
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
std::string json_str = R"({
|
||||||
|
"person": {
|
||||||
|
"name": "John Doe",
|
||||||
|
"age": 30,
|
||||||
|
"active": true
|
||||||
|
},
|
||||||
|
"address": {
|
||||||
|
"street": "123 Main St",
|
||||||
|
"city": "Anytown",
|
||||||
|
"zipcode": 12345
|
||||||
|
},
|
||||||
|
"skills": ["C++", "JSON", "Programming"],
|
||||||
|
"department": "Engineering",
|
||||||
|
"salary": 85000.50
|
||||||
|
})";
|
||||||
|
|
||||||
|
simdjson::ondemand::document doc;
|
||||||
|
auto error = parser.iterate(simdjson::pad(json_str)).get(doc);
|
||||||
|
if (error) {
|
||||||
|
std::cerr << "Parse error" << std::endl;
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Use reflection-based automatic deserialization
|
||||||
|
Employee employee;
|
||||||
|
auto result = doc.get<Employee>();
|
||||||
|
if (result.error()) {
|
||||||
|
std::cerr << "Reflection parsing failed" << std::endl;
|
||||||
|
return 1;
|
||||||
|
}
|
||||||
|
employee = result.value();
|
||||||
|
|
||||||
|
std::cout << "Reflection parsing successful: " << employee.person.name
|
||||||
|
<< ", age " << employee.person.age << std::endl;
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
}
|
||||||
|
|
||||||
|
# Function to time compilation of parsing approach
|
||||||
|
time_parsing_compilation() {
|
||||||
|
local description="$1"
|
||||||
|
local test_file="$2"
|
||||||
|
local use_reflection="$3"
|
||||||
|
local iteration="$4"
|
||||||
|
|
||||||
|
echo "[$iteration] $description"
|
||||||
|
|
||||||
|
# Clean build
|
||||||
|
rm -rf build_parsing_test
|
||||||
|
mkdir build_parsing_test
|
||||||
|
cd build_parsing_test
|
||||||
|
|
||||||
|
# Copy test file
|
||||||
|
cp "../$test_file" .
|
||||||
|
|
||||||
|
echo " Configuring..."
|
||||||
|
if [ "$use_reflection" = "true" ]; then
|
||||||
|
cmake -DCMAKE_CXX_COMPILER="$CXX" \
|
||||||
|
-DSIMDJSON_DEVELOPER_MODE=ON \
|
||||||
|
-DSIMDJSON_STATIC_REFLECTION=ON \
|
||||||
|
-DBUILD_SHARED_LIBS=OFF \
|
||||||
|
../.. >/dev/null 2>&1
|
||||||
|
else
|
||||||
|
cmake -DCMAKE_CXX_COMPILER="$CXX" \
|
||||||
|
-DSIMDJSON_DEVELOPER_MODE=ON \
|
||||||
|
-DSIMDJSON_STATIC_REFLECTION=OFF \
|
||||||
|
-DBUILD_SHARED_LIBS=OFF \
|
||||||
|
../.. >/dev/null 2>&1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo " Building simdjson..."
|
||||||
|
cmake --build . --target simdjson >/dev/null 2>&1
|
||||||
|
|
||||||
|
echo " Compiling parsing test..."
|
||||||
|
# Time just the test compilation
|
||||||
|
start_time=$(date +%s.%N)
|
||||||
|
|
||||||
|
"$CXX" -std=c++17 -I../../include "$test_file" -L. -lsimdjson -o parsing_test >/dev/null 2>&1
|
||||||
|
|
||||||
|
end_time=$(date +%s.%N)
|
||||||
|
|
||||||
|
# Calculate time duration
|
||||||
|
time_taken=$(echo "$end_time $start_time" | awk '{printf "%.3f", $1 - $2}')
|
||||||
|
echo " Completed in: ${time_taken}s"
|
||||||
|
|
||||||
|
cd ..
|
||||||
|
rm -rf build_parsing_test
|
||||||
|
|
||||||
|
echo "$time_taken"
|
||||||
|
}
|
||||||
|
|
||||||
|
# Create test files
|
||||||
|
echo "Creating test files..."
|
||||||
|
create_manual_parsing_test "complex" "complex"
|
||||||
|
create_reflection_parsing_test "complex" "complex"
|
||||||
|
|
||||||
|
# Arrays to store times
|
||||||
|
times_manual=""
|
||||||
|
times_reflection=""
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "=== MANUAL PARSING COMPILATION ==="
|
||||||
|
echo "Testing traditional simdjson parsing with explicit .get() calls"
|
||||||
|
echo
|
||||||
|
|
||||||
|
for i in $(seq 1 $ITERATIONS); do
|
||||||
|
time_result=$(time_parsing_compilation "Compiling manual parsing test" "complex_manual.cpp" "false" "$i" | tail -n1)
|
||||||
|
times_manual="$times_manual $time_result"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "=== REFLECTION PARSING COMPILATION ==="
|
||||||
|
echo "Testing automatic deserialization with doc.get<Struct>()"
|
||||||
|
echo
|
||||||
|
|
||||||
|
for i in $(seq 1 $ITERATIONS); do
|
||||||
|
time_result=$(time_parsing_compilation "Compiling reflection parsing test" "complex_reflection.cpp" "true" "$i" | tail -n1)
|
||||||
|
times_reflection="$times_reflection $time_result"
|
||||||
|
done
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "╔════════════════════════════════════════════════════════════════════════════╗"
|
||||||
|
echo "║ REFLECTION USAGE COMPILATION RESULTS ║"
|
||||||
|
echo "╠════════════════════════════════════════════════════════════════════════════╣"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ MANUAL PARSING (explicit .get() calls): ║"
|
||||||
|
count=1
|
||||||
|
for t in $times_manual; do
|
||||||
|
if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
|
||||||
|
line=$(printf "Run %2d: %7.3f seconds" "$count" "$t")
|
||||||
|
print_box_line "$line"
|
||||||
|
count=$((count + 1))
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ REFLECTION PARSING (automatic doc.get<Struct>()): ║"
|
||||||
|
count=1
|
||||||
|
for t in $times_reflection; do
|
||||||
|
if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
|
||||||
|
line=$(printf "Run %2d: %7.3f seconds" "$count" "$t")
|
||||||
|
print_box_line "$line"
|
||||||
|
count=$((count + 1))
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
echo "╚════════════════════════════════════════════════════════════════════════════╝"
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "╔════════════════════════════════════════════════════════════════════════════╗"
|
||||||
|
echo "║ ANALYSIS SUMMARY ║"
|
||||||
|
echo "╠════════════════════════════════════════════════════════════════════════════╣"
|
||||||
|
echo "║ ║"
|
||||||
|
|
||||||
|
# Calculate averages and percentages - filter to only numeric values first
|
||||||
|
manual_numbers=""
|
||||||
|
reflection_numbers=""
|
||||||
|
|
||||||
|
for t in $times_manual; do
|
||||||
|
if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
|
||||||
|
manual_numbers="$manual_numbers $t"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
for t in $times_reflection; do
|
||||||
|
if [[ "$t" =~ ^[0-9]+\.?[0-9]*$ ]]; then
|
||||||
|
reflection_numbers="$reflection_numbers $t"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ -n "$manual_numbers" ] && [ -n "$reflection_numbers" ]; then
|
||||||
|
manual_avg=$(echo "$manual_numbers" | awk '{sum=0; for(i=1;i<=NF;i++) sum+=$i; print sum/NF}')
|
||||||
|
reflection_avg=$(echo "$reflection_numbers" | awk '{sum=0; for(i=1;i<=NF;i++) sum+=$i; print sum/NF}')
|
||||||
|
overhead=$(echo "$reflection_avg $manual_avg" | awk '{printf "%.3f", $1 - $2}')
|
||||||
|
|
||||||
|
if [ $(echo "$manual_avg > 0" | awk '{print ($1 > 0)}') -eq 1 ]; then
|
||||||
|
percent=$(echo "$reflection_avg $manual_avg" | awk '{printf "%.1f", ($1 - $2) / $2 * 100}')
|
||||||
|
else
|
||||||
|
percent="0"
|
||||||
|
fi
|
||||||
|
|
||||||
|
print_box_line "MANUAL PARSING RESULTS:"
|
||||||
|
print_box_line "$(printf "Average compilation time: %.3fs" "$manual_avg")"
|
||||||
|
print_box_line ""
|
||||||
|
print_box_line "REFLECTION PARSING RESULTS:"
|
||||||
|
print_box_line "$(printf "Average compilation time: %.3fs" "$reflection_avg")"
|
||||||
|
print_box_line ""
|
||||||
|
print_box_line "REFLECTION OVERHEAD:"
|
||||||
|
print_box_line "$(printf "Additional time: %.3fs (%+.1f%%)" "$overhead" "$percent")"
|
||||||
|
print_box_line ""
|
||||||
|
else
|
||||||
|
echo "║ ERROR: Could not extract valid timing data ║"
|
||||||
|
echo "║ Manual times: $times_manual"
|
||||||
|
echo "║ Reflection times: $times_reflection"
|
||||||
|
echo "║ ║"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "╠════════════════════════════════════════════════════════════════════════════╣"
|
||||||
|
echo "║ INTERPRETATION ║"
|
||||||
|
echo "╠════════════════════════════════════════════════════════════════════════════╣"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ WHAT THESE RESULTS SHOW: ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ • COMPILE-TIME COST: How much longer reflection parsing takes to compile ║"
|
||||||
|
echo "║ - Higher % = more expensive template instantiation and codegen ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ • CODE GENERATION OVERHEAD: Reflection creates parsing code at compile ║"
|
||||||
|
echo "║ time, which requires more template processing than manual parsing ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ • DEVELOPER TRADE-OFF: Reflection provides automatic deserialization ║"
|
||||||
|
echo "║ but at the cost of increased compilation time ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ EVALUATION: ║"
|
||||||
|
echo "║ • Low overhead (0-20%): Reflection is compile-time efficient ║"
|
||||||
|
echo "║ • Medium overhead (20-50%): Noticeable but potentially acceptable ║"
|
||||||
|
echo "║ • High overhead (50%+): Significant compilation cost for reflection ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "║ REAL-WORLD IMPACT: ║"
|
||||||
|
echo "║ • Small projects: Absolute time matters more than percentage ║"
|
||||||
|
echo "║ • Large projects: Percentage overhead compounds across many files ║"
|
||||||
|
echo "║ • CI/CD pipelines: Longer builds affect development velocity ║"
|
||||||
|
echo "║ ║"
|
||||||
|
echo "╚════════════════════════════════════════════════════════════════════════════╝"
|
||||||
|
|
||||||
|
# Clean up test files
|
||||||
|
rm -f complex_manual.cpp complex_reflection.cpp
|
||||||
|
|
||||||
|
echo
|
||||||
|
echo "Completed at: $(date)"
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
# Executable
|
||||||
|
add_executable(benchmark_car_builder benchmark_car_builder.cpp)
|
||||||
|
|
||||||
|
# Compile for C++20.
|
||||||
|
target_compile_features(benchmark_car_builder PRIVATE cxx_std_20)
|
||||||
|
|
||||||
|
# Check if -march=native is supported
|
||||||
|
include(CheckCXXCompilerFlag)
|
||||||
|
check_cxx_compiler_flag("-march=native" SIMDJSON_SUPPORTS_MARCH_NATIVE)
|
||||||
|
if(SIMDJSON_SUPPORTS_MARCH_NATIVE)
|
||||||
|
target_compile_options(benchmark_car_builder PRIVATE -march=native)
|
||||||
|
endif()
|
||||||
|
|
||||||
|
target_include_directories(benchmark_car_builder PRIVATE ${CMAKE_CURRENT_LIST_DIR}/..)
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
#include "event_counter.h"
|
||||||
|
#include <random>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <simdjson.h>
|
||||||
|
|
||||||
|
event_collector collector;
|
||||||
|
|
||||||
|
struct Car {
|
||||||
|
std::string make;
|
||||||
|
std::string model;
|
||||||
|
int64_t year; // We deliberately do not include the tire pressure.
|
||||||
|
};
|
||||||
|
|
||||||
|
std::vector<Car> generate_random_cars(size_t count) {
|
||||||
|
static const std::vector<std::string> makes = {"Toyota", "Honda", "Ford",
|
||||||
|
"BMW", "Mazda"};
|
||||||
|
static const std::vector<std::string> models = {"Camry", "Civic", "Focus",
|
||||||
|
"320i", "3"};
|
||||||
|
static thread_local std::mt19937 rng{std::random_device{}()};
|
||||||
|
std::uniform_int_distribution<int> make_dist(0, makes.size() - 1);
|
||||||
|
std::uniform_int_distribution<int> model_dist(0, models.size() - 1);
|
||||||
|
std::uniform_int_distribution<int64_t> year_dist(2000, 2025);
|
||||||
|
std::uniform_real_distribution<double> pressure_dist(30.0, 45.0);
|
||||||
|
|
||||||
|
std::vector<Car> cars;
|
||||||
|
cars.reserve(count);
|
||||||
|
for (size_t i = 0; i < count; ++i) {
|
||||||
|
Car car;
|
||||||
|
car.make = makes[make_dist(rng)];
|
||||||
|
car.model = models[model_dist(rng)];
|
||||||
|
car.year = year_dist(rng);
|
||||||
|
cars.push_back(std::move(car));
|
||||||
|
}
|
||||||
|
return cars;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string_view serialize(simdjson::builder::string_builder &sb,
|
||||||
|
const std::vector<Car> &cars) {
|
||||||
|
sb.clear();
|
||||||
|
sb.start_array();
|
||||||
|
for (const auto &car : cars) {
|
||||||
|
sb.start_object();
|
||||||
|
sb.append_key_value("make", car.make);
|
||||||
|
sb.append_comma();
|
||||||
|
sb.append_key_value("model", car.model);
|
||||||
|
sb.append_comma();
|
||||||
|
sb.append_key_value("year", car.year);
|
||||||
|
sb.end_object();
|
||||||
|
}
|
||||||
|
sb.end_array();
|
||||||
|
std::string_view result;
|
||||||
|
if (sb.view().get(result)) {
|
||||||
|
return ""; // unexpected (error)
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
double pretty_print(const std::string &name, size_t num_chars,
|
||||||
|
std::pair<event_aggregate, size_t> result) {
|
||||||
|
const auto &agg = result.first;
|
||||||
|
size_t N = result.second;
|
||||||
|
num_chars *= N;
|
||||||
|
printf("%-40s : %8.2f ns %8.2f GB/s", name.c_str(),
|
||||||
|
agg.elapsed_ns() / num_chars, num_chars / agg.elapsed_ns());
|
||||||
|
if (collector.has_events()) {
|
||||||
|
printf(" %8.2f GHz %8.2f cycles/char %8.2f ins./char %8.2f i/c",
|
||||||
|
agg.cycles() / agg.elapsed_ns(), agg.cycles() / num_chars,
|
||||||
|
agg.instructions() / num_chars, agg.instructions() / agg.cycles());
|
||||||
|
}
|
||||||
|
printf("\n");
|
||||||
|
return num_chars / agg.elapsed_ns();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class function_type>
|
||||||
|
std::pair<event_aggregate, size_t>
|
||||||
|
bench(const function_type &&function, size_t min_repeat = 100,
|
||||||
|
size_t min_time_ns = 40'000'000, size_t max_repeat = 10000000) {
|
||||||
|
size_t N = min_repeat;
|
||||||
|
if (N == 0) {
|
||||||
|
N = 1;
|
||||||
|
}
|
||||||
|
event_aggregate warm_aggregate{};
|
||||||
|
for (size_t i = 0; i < N; i++) {
|
||||||
|
std::atomic_thread_fence(std::memory_order_acquire);
|
||||||
|
collector.start();
|
||||||
|
function();
|
||||||
|
std::atomic_thread_fence(std::memory_order_release);
|
||||||
|
event_count allocate_count = collector.end();
|
||||||
|
warm_aggregate << allocate_count;
|
||||||
|
if ((i + 1 == N) && (warm_aggregate.total_elapsed_ns() < min_time_ns) &&
|
||||||
|
(N < max_repeat)) {
|
||||||
|
N *= 10;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
event_aggregate aggregate{};
|
||||||
|
for (size_t i = 0; i < 10; i++) {
|
||||||
|
std::atomic_thread_fence(std::memory_order_acquire);
|
||||||
|
collector.start();
|
||||||
|
for (size_t i = 0; i < N; i++) {
|
||||||
|
function();
|
||||||
|
}
|
||||||
|
std::atomic_thread_fence(std::memory_order_release);
|
||||||
|
event_count allocate_count = collector.end();
|
||||||
|
aggregate << allocate_count;
|
||||||
|
}
|
||||||
|
return {aggregate, N};
|
||||||
|
}
|
||||||
|
|
||||||
|
void run_benchmarks() {
|
||||||
|
std::vector<Car> source = generate_random_cars(100000);
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
size_t volume = serialize(sb, source).size();
|
||||||
|
|
||||||
|
pretty_print("string_builder", volume, bench([&source, &sb]() -> size_t {
|
||||||
|
return serialize(sb, source).size();
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
for (size_t trial = 0; trial < 3; trial++) {
|
||||||
|
printf("Trial %zu:\n", trial + 1);
|
||||||
|
run_benchmarks();
|
||||||
|
printf("\n");
|
||||||
|
}
|
||||||
|
return EXIT_SUCCESS;
|
||||||
|
}
|
||||||
@@ -25,12 +25,11 @@ int main(int argc, char *argv[]) {
|
|||||||
exit(1);
|
exit(1);
|
||||||
}
|
}
|
||||||
const char *filename = argv[1];
|
const char *filename = argv[1];
|
||||||
auto v = simdjson::padded_string::load(filename);
|
simdjson::padded_string p;
|
||||||
if (v.error()) {
|
if (simdjson::padded_string::load(filename).get(p)) {
|
||||||
std::cerr << "Could not load the file " << filename << std::endl;
|
std::cerr << "Could not load the file " << filename << std::endl;
|
||||||
return EXIT_FAILURE;
|
return EXIT_FAILURE;
|
||||||
}
|
}
|
||||||
const simdjson::padded_string& p = v.value_unsafe();
|
|
||||||
if (test_baseline) {
|
if (test_baseline) {
|
||||||
std::wclog << "Baseline: Getline + normal parse... " << std::endl;
|
std::wclog << "Baseline: Getline + normal parse... " << std::endl;
|
||||||
std::cout << "Gigabytes/second\t"
|
std::cout << "Gigabytes/second\t"
|
||||||
|
|||||||
@@ -122,6 +122,7 @@ struct event_aggregate {
|
|||||||
}
|
}
|
||||||
|
|
||||||
double elapsed_sec() const { return total.elapsed_sec() / iterations; }
|
double elapsed_sec() const { return total.elapsed_sec() / iterations; }
|
||||||
|
double total_elapsed_ns() const { return total.elapsed_ns(); }
|
||||||
double elapsed_ns() const { return total.elapsed_ns() / iterations; }
|
double elapsed_ns() const { return total.elapsed_ns() / iterations; }
|
||||||
double cycles() const { return total.cycles() / iterations; }
|
double cycles() const { return total.cycles() / iterations; }
|
||||||
double instructions() const { return total.instructions() / iterations; }
|
double instructions() const { return total.instructions() / iterations; }
|
||||||
|
|||||||
@@ -0,0 +1,15 @@
|
|||||||
|
# Executable
|
||||||
|
add_executable(from_benchmark from_benchmark.cpp)
|
||||||
|
|
||||||
|
# Compile for C++20.
|
||||||
|
if(CMAKE_CXX_STANDARD LESS 20)
|
||||||
|
target_compile_features(from_benchmark PRIVATE cxx_std_20)
|
||||||
|
endif()
|
||||||
|
# Check if -march=native is supported
|
||||||
|
include(CheckCXXCompilerFlag)
|
||||||
|
check_cxx_compiler_flag("-march=native" SIMDJSON_SUPPORTS_MARCH_NATIVE)
|
||||||
|
if(SIMDJSON_SUPPORTS_MARCH_NATIVE)
|
||||||
|
target_compile_options(from_benchmark PRIVATE -march=native)
|
||||||
|
endif()
|
||||||
|
|
||||||
|
target_include_directories(from_benchmark PRIVATE ${CMAKE_CURRENT_LIST_DIR}/..)
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
#ifndef BENCHMARK_HELPERS_H
|
||||||
|
#define BENCHMARK_HELPERS_H
|
||||||
|
|
||||||
|
#include "event_counter.h"
|
||||||
|
#include <atomic>
|
||||||
|
|
||||||
|
event_collector collector;
|
||||||
|
|
||||||
|
template <class function_type>
|
||||||
|
std::pair<event_aggregate, size_t>
|
||||||
|
bench(const function_type &&function, size_t min_repeat = 10,
|
||||||
|
size_t min_time_ns = 40'000'000, size_t max_repeat = 10000000) {
|
||||||
|
size_t N = min_repeat;
|
||||||
|
if (N == 0) {
|
||||||
|
N = 1;
|
||||||
|
}
|
||||||
|
event_aggregate warm_aggregate{};
|
||||||
|
for (size_t i = 0; i < N; i++) {
|
||||||
|
std::atomic_thread_fence(std::memory_order_acquire);
|
||||||
|
collector.start();
|
||||||
|
function();
|
||||||
|
std::atomic_thread_fence(std::memory_order_release);
|
||||||
|
event_count allocate_count = collector.end();
|
||||||
|
warm_aggregate << allocate_count;
|
||||||
|
if ((i + 1 == N) && (warm_aggregate.total_elapsed_ns() < min_time_ns) &&
|
||||||
|
(N < max_repeat)) {
|
||||||
|
N *= 10;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
event_aggregate aggregate{};
|
||||||
|
for (size_t i = 0; i < 10; i++) {
|
||||||
|
std::atomic_thread_fence(std::memory_order_acquire);
|
||||||
|
collector.start();
|
||||||
|
for (size_t i = 0; i < N; i++) {
|
||||||
|
function();
|
||||||
|
}
|
||||||
|
std::atomic_thread_fence(std::memory_order_release);
|
||||||
|
event_count allocate_count = collector.end();
|
||||||
|
aggregate << allocate_count;
|
||||||
|
}
|
||||||
|
return {aggregate, N};
|
||||||
|
}
|
||||||
|
|
||||||
|
double pretty_print(const std::string &name, size_t num_chars,
|
||||||
|
std::pair<event_aggregate, size_t> result) {
|
||||||
|
const auto &agg = result.first;
|
||||||
|
size_t N = result.second;
|
||||||
|
num_chars *= N;
|
||||||
|
printf("%-40s : %8.2f ns %8.2f GB/s", name.c_str(),
|
||||||
|
agg.elapsed_ns() / num_chars, num_chars / agg.elapsed_ns());
|
||||||
|
if (collector.has_events()) {
|
||||||
|
printf(" %8.2f GHz %8.2f cycles/char %8.2f ins./char %8.2f i/c",
|
||||||
|
agg.cycles() / agg.elapsed_ns(), agg.cycles() / num_chars,
|
||||||
|
agg.instructions() / num_chars, agg.instructions() / agg.cycles());
|
||||||
|
}
|
||||||
|
printf("\n");
|
||||||
|
return num_chars / agg.elapsed_ns();
|
||||||
|
}
|
||||||
|
|
||||||
|
double pretty_print_array(const std::string &name, size_t num_chars, size_t num_elements,
|
||||||
|
std::pair<event_aggregate, size_t> result) {
|
||||||
|
const auto &agg = result.first;
|
||||||
|
size_t N = result.second;
|
||||||
|
num_chars *= N;
|
||||||
|
printf("%-40s : %8.2f ns/char %8.2f ns/value %8.2f GB/s", name.c_str(),
|
||||||
|
agg.elapsed_ns() / num_chars, agg.elapsed_ns() / num_elements, num_chars / agg.elapsed_ns());
|
||||||
|
if (collector.has_events()) {
|
||||||
|
printf(" %8.2f GHz %8.2f cycles/char %8.2f ins./char %8.2f ins./value %8.2f i/c",
|
||||||
|
agg.cycles() / agg.elapsed_ns(), agg.cycles() / num_chars,
|
||||||
|
agg.instructions() / num_chars, agg.instructions() / num_elements, agg.instructions() / agg.cycles());
|
||||||
|
}
|
||||||
|
printf("\n");
|
||||||
|
return num_chars / agg.elapsed_ns();
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#endif
|
||||||
@@ -0,0 +1,146 @@
|
|||||||
|
#ifndef CAR_HELPERS_H
|
||||||
|
#define CAR_HELPERS_H
|
||||||
|
|
||||||
|
#include <iomanip>
|
||||||
|
#include <random>
|
||||||
|
#include <sstream>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
#include <simdjson.h>
|
||||||
|
|
||||||
|
struct Car {
|
||||||
|
std::string make;
|
||||||
|
std::string model;
|
||||||
|
int64_t year; // We deliberately do not include the tire pressure.
|
||||||
|
};
|
||||||
|
|
||||||
|
using namespace simdjson;
|
||||||
|
|
||||||
|
std::string random_car_json() {
|
||||||
|
static const std::vector<std::string> makes = {"Toyota", "Honda", "Ford",
|
||||||
|
"BMW", "Mazda"};
|
||||||
|
static const std::vector<std::string> models = {"Camry", "Civic", "Focus",
|
||||||
|
"320i", "3"};
|
||||||
|
static thread_local std::mt19937 rng{std::random_device{}()};
|
||||||
|
std::uniform_int_distribution<int> make_dist(0, makes.size() - 1);
|
||||||
|
std::uniform_int_distribution<int> model_dist(0, models.size() - 1);
|
||||||
|
std::uniform_int_distribution<int> year_dist(2000, 2025);
|
||||||
|
std::uniform_real_distribution<double> pressure_dist(30.0, 45.0);
|
||||||
|
|
||||||
|
std::ostringstream oss;
|
||||||
|
oss << R"({ "make": ")" << makes[make_dist(rng)] << R"(", "model": ")"
|
||||||
|
<< models[model_dist(rng)] << R"(", "year": )" << year_dist(rng)
|
||||||
|
<< R"(, "tire_pressure": [ )" << std::fixed << std::setprecision(1)
|
||||||
|
<< pressure_dist(rng) << ", " << pressure_dist(rng) << R"( ] })";
|
||||||
|
return oss.str();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string generate_car_json_stream(size_t N) {
|
||||||
|
std::ostringstream oss;
|
||||||
|
for (size_t i = 0; i < N; ++i) {
|
||||||
|
oss << random_car_json();
|
||||||
|
oss << "\n";
|
||||||
|
}
|
||||||
|
return oss.str();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string generate_car_json_array(size_t N) {
|
||||||
|
std::ostringstream oss;
|
||||||
|
oss << "[\n";
|
||||||
|
for (size_t i = 0; i < N; ++i) {
|
||||||
|
oss << random_car_json();
|
||||||
|
if (i < N - 1) {
|
||||||
|
oss << ",";
|
||||||
|
}
|
||||||
|
oss << "\n";
|
||||||
|
}
|
||||||
|
oss << "]";
|
||||||
|
return oss.str();
|
||||||
|
}
|
||||||
|
|
||||||
|
// We want to maximize C++ portability, but this is not needed with static
|
||||||
|
// reflection (C++26).
|
||||||
|
template <>
|
||||||
|
simdjson_inline simdjson_result<Car>
|
||||||
|
simdjson::ondemand::document::get() & noexcept {
|
||||||
|
ondemand::object obj;
|
||||||
|
auto error = get_object().get(obj);
|
||||||
|
if (error) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
Car car;
|
||||||
|
if ((error = obj["make"].get_string(car.make))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["model"].get_string(car.model))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["year"].get_int64().get(car.year))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
return car;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
simdjson_inline simdjson_result<Car> simdjson::ondemand::value::get() noexcept {
|
||||||
|
ondemand::object obj;
|
||||||
|
auto error = get_object().get(obj);
|
||||||
|
if (error) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
Car car;
|
||||||
|
if ((error = obj["make"].get_string(car.make))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["model"].get_string(car.model))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["year"].get_int64().get(car.year))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
return car;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
simdjson_inline simdjson_result<Car>
|
||||||
|
simdjson::ondemand::document_reference::get() & noexcept {
|
||||||
|
ondemand::object obj;
|
||||||
|
auto error = get_object().get(obj);
|
||||||
|
if (error) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
Car car;
|
||||||
|
if ((error = obj["make"].get_string(car.make))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["model"].get_string(car.model))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["year"].get_int64().get(car.year))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
return car;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <>
|
||||||
|
simdjson_inline simdjson_result<Car>
|
||||||
|
simdjson::ondemand::document_reference::get() && noexcept {
|
||||||
|
ondemand::object obj;
|
||||||
|
auto error = get_object().get(obj);
|
||||||
|
if (error) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
Car car;
|
||||||
|
if ((error = obj["make"].get_string(car.make))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["model"].get_string(car.model))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
if ((error = obj["year"].get_int64().get(car.year))) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
return car;
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
// We are going to assume C++20.
|
||||||
|
|
||||||
|
#include <cstdint>
|
||||||
|
#include <cstdio>
|
||||||
|
#include <cstdlib>
|
||||||
|
#include <simdjson.h>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
#include "benchmark_helpers.h"
|
||||||
|
#include "car_helpers.h"
|
||||||
|
|
||||||
|
using namespace simdjson;
|
||||||
|
|
||||||
|
void run_benchmarks() {
|
||||||
|
printf("Running benchmarks on tiny input...\n");
|
||||||
|
simdjson::padded_string json =
|
||||||
|
R"({ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9 ] })"_padded;
|
||||||
|
volatile size_t dummy = 0;
|
||||||
|
ondemand::parser parser;
|
||||||
|
|
||||||
|
// Classic On-Demand
|
||||||
|
pretty_print("simdjson classic", json.size(),
|
||||||
|
bench([&json, &dummy, &parser]() {
|
||||||
|
ondemand::document doc = parser.iterate(json);
|
||||||
|
Car car = doc.get<Car>();
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}));
|
||||||
|
|
||||||
|
// Benchmark simdjson::from() without parser
|
||||||
|
pretty_print("simdjson::from<Car>() (no parser)", json.size(),
|
||||||
|
bench([&json, &dummy]() {
|
||||||
|
Car car = simdjson::from(json);
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}));
|
||||||
|
|
||||||
|
// Benchmark simdjson::from() with parser
|
||||||
|
pretty_print("simdjson::from<Car>() (with parser)", json.size(),
|
||||||
|
bench([&json, &dummy, &parser]() {
|
||||||
|
Car car = simdjson::from(parser, json);
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
void run_array_benchmarks() {
|
||||||
|
printf("Running benchmarks on large array...\n");
|
||||||
|
size_t N = 1'000'000;
|
||||||
|
simdjson::padded_string json = generate_car_json_array(N);
|
||||||
|
volatile size_t dummy = 0;
|
||||||
|
ondemand::parser parser;
|
||||||
|
|
||||||
|
// Classic On-Demand
|
||||||
|
pretty_print_array("simdjson classic", json.size(), N,
|
||||||
|
bench([&json, &dummy, &parser]() {
|
||||||
|
dummy = 0;
|
||||||
|
ondemand::document doc = parser.iterate(json);
|
||||||
|
ondemand::array array = doc.get_array();
|
||||||
|
for (auto value : array) {
|
||||||
|
Car car = value.get<Car>();
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
// from with array
|
||||||
|
pretty_print_array("simdjson::from(json).array()", json.size(), N,
|
||||||
|
bench([&json, &dummy, &parser]() {
|
||||||
|
dummy = 0;
|
||||||
|
|
||||||
|
for (auto value : simdjson::from(json).array()) {
|
||||||
|
Car car = value.get<Car>();
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
#if SIMDJSON_SUPPORTS_RANGES_FROM
|
||||||
|
// Benchmark simdjson::from() without parser (EXPERIMENTAL)
|
||||||
|
pretty_print_array("simdjson::from<Car>() (experimental, no parser)",
|
||||||
|
json.size(), N, bench([&json, &dummy]() {
|
||||||
|
dummy = 0;
|
||||||
|
for (Car car :
|
||||||
|
simdjson::from(json) | simdjson::as<Car>()) {
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
// Benchmark simdjson::from() with parser (EXPERIMENTAL)
|
||||||
|
pretty_print_array("simdjson::from<Car>() (experimental, with parser)",
|
||||||
|
json.size(), N, bench([&json, &dummy, &parser]() {
|
||||||
|
dummy = 0;
|
||||||
|
for (Car car : simdjson::from(parser, json) |
|
||||||
|
simdjson::as<Car>()) {
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
#endif // SIMDJSON_SUPPORTS_RANGES_FROM
|
||||||
|
}
|
||||||
|
|
||||||
|
void run_stream_benchmarks() {
|
||||||
|
printf("Running stream benchmarks...\n");
|
||||||
|
simdjson::padded_string json = generate_car_json_stream(1'000'000);
|
||||||
|
volatile size_t dummy = 0;
|
||||||
|
ondemand::parser parser;
|
||||||
|
|
||||||
|
// Classic On-Demand
|
||||||
|
pretty_print("simdjson classic", json.size(),
|
||||||
|
bench([&json, &dummy, &parser]() {
|
||||||
|
ondemand::document_stream stream = parser.iterate_many(json);
|
||||||
|
for (auto doc : stream) {
|
||||||
|
Car car = doc.get<Car>();
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
// from_many
|
||||||
|
pretty_print("simdjson with thread local", json.size(),
|
||||||
|
bench([&json, &dummy, &parser]() {
|
||||||
|
ondemand::document_stream stream =
|
||||||
|
ondemand::parser::get_parser().iterate_many(json);
|
||||||
|
for (auto doc : stream) {
|
||||||
|
Car car = doc.get<Car>();
|
||||||
|
dummy = dummy + car.year;
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
int main() {
|
||||||
|
for (size_t trial = 0; trial < 3; trial++) {
|
||||||
|
printf("Trial %zu:\n", trial + 1);
|
||||||
|
run_array_benchmarks();
|
||||||
|
run_stream_benchmarks();
|
||||||
|
run_benchmarks();
|
||||||
|
printf("\n");
|
||||||
|
}
|
||||||
|
return EXIT_SUCCESS;
|
||||||
|
}
|
||||||
@@ -9,7 +9,11 @@ simdjson_never_inline
|
|||||||
double bench(std::string filename, simdjson::padded_string& p) {
|
double bench(std::string filename, simdjson::padded_string& p) {
|
||||||
std::chrono::time_point<std::chrono::steady_clock> start_clock =
|
std::chrono::time_point<std::chrono::steady_clock> start_clock =
|
||||||
std::chrono::steady_clock::now();
|
std::chrono::steady_clock::now();
|
||||||
simdjson::padded_string::load(filename).value_unsafe().swap(p);
|
auto error = simdjson::padded_string::load(filename).get(p);
|
||||||
|
if(error) {
|
||||||
|
std::cerr << simdjson::error_message(error) << std::endl;
|
||||||
|
std::abort();
|
||||||
|
}
|
||||||
std::chrono::time_point<std::chrono::steady_clock> end_clock =
|
std::chrono::time_point<std::chrono::steady_clock> end_clock =
|
||||||
std::chrono::steady_clock::now();
|
std::chrono::steady_clock::now();
|
||||||
std::chrono::duration<double> elapsed = end_clock - start_clock;
|
std::chrono::duration<double> elapsed = end_clock - start_clock;
|
||||||
|
|||||||
@@ -23,7 +23,29 @@ struct simdjson_ondemand {
|
|||||||
};
|
};
|
||||||
|
|
||||||
BENCHMARK_TEMPLATE(large_random, simdjson_ondemand)->UseManualTime();
|
BENCHMARK_TEMPLATE(large_random, simdjson_ondemand)->UseManualTime();
|
||||||
|
#if SIMDJSON_STATIC_REFLECTION
|
||||||
|
|
||||||
|
struct simdjson_ondemand_static_reflect {
|
||||||
|
static constexpr diff_flags DiffFlags = diff_flags::NONE;
|
||||||
|
|
||||||
|
ondemand::parser parser{};
|
||||||
|
|
||||||
|
bool run(simdjson::padded_string &json, std::vector<point> &result) {
|
||||||
|
auto doc = parser.iterate(json);
|
||||||
|
if(auto e = doc.get_array().get<std::vector<point>>(result); e) { return false; }
|
||||||
|
// We can also do it like so:
|
||||||
|
//for (ondemand::object coord : doc) {
|
||||||
|
// result.emplace_back(coord.get<point>());
|
||||||
|
//}
|
||||||
|
// It seems that doing the reflection is slower than doing the manual lookup.
|
||||||
|
// E.g., it is faster if we do result.emplace_back(coord["x"], coord["y"], coord["z"]);
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
BENCHMARK_TEMPLATE(large_random, simdjson_ondemand_static_reflect)->UseManualTime();
|
||||||
|
|
||||||
|
|
||||||
|
#endif
|
||||||
} // namespace large_random
|
} // namespace large_random
|
||||||
|
|
||||||
#endif // SIMDJSON_EXCEPTIONS
|
#endif // SIMDJSON_EXCEPTIONS
|
||||||
|
|||||||
@@ -0,0 +1,44 @@
|
|||||||
|
# Include reflect-cpp
|
||||||
|
CPMAddPackage(
|
||||||
|
NAME reflect-cpp
|
||||||
|
GITHUB_REPOSITORY getml/reflect-cpp
|
||||||
|
GIT_TAG v0.17.0
|
||||||
|
EXCLUDE_FROM_ALL YES
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
if(NOT WIN32)
|
||||||
|
# We want the check whether Rust is available before trying to build a crate.
|
||||||
|
CPMAddPackage(
|
||||||
|
NAME corrosion
|
||||||
|
GITHUB_REPOSITORY corrosion-rs/corrosion
|
||||||
|
VERSION 0.4.4
|
||||||
|
DOWNLOAD_ONLY ON
|
||||||
|
OPTIONS "Rust_FIND_QUIETLY OFF"
|
||||||
|
)
|
||||||
|
include("${corrosion_SOURCE_DIR}/cmake/FindRust.cmake")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
if(RUST_FOUND)
|
||||||
|
message(STATUS "Rust found: " ${Rust_VERSION} )
|
||||||
|
add_subdirectory("${corrosion_SOURCE_DIR}" "${PROJECT_BINARY_DIR}/_deps/corrosion" EXCLUDE_FROM_ALL)
|
||||||
|
# Important: we want to build in release mode!
|
||||||
|
corrosion_import_crate(MANIFEST_PATH "serde-benchmark/Cargo.toml" NO_LINKER_OVERRIDE PROFILE release)
|
||||||
|
else()
|
||||||
|
message(STATUS "Rust/Cargo is unavailable." )
|
||||||
|
message(STATUS "We will not benchmark serde-benchmark." )
|
||||||
|
if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
|
||||||
|
message(STATUS "Under macOS, you may be able to install rust with")
|
||||||
|
message(STATUS "curl https://sh.rustup.rs -sSf | sh")
|
||||||
|
elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
|
||||||
|
message(STATUS "Under Linux, you may be able to install rust with a command such as")
|
||||||
|
message(STATUS "apt-get install cargo" )
|
||||||
|
message(STATUS "or" )
|
||||||
|
message(STATUS "curl https://sh.rustup.rs -sSf | sh")
|
||||||
|
endif()
|
||||||
|
endif()
|
||||||
|
|
||||||
|
# Add the benchmark executable targets
|
||||||
|
add_subdirectory(twitter_benchmark)
|
||||||
|
add_subdirectory(citm_catalog_benchmark)
|
||||||
@@ -0,0 +1,52 @@
|
|||||||
|
#ifndef BENCHMARK_HELPER_HPP
|
||||||
|
#define BENCHMARK_HELPER_HPP
|
||||||
|
#include "event_counter.h"
|
||||||
|
#include <atomic>
|
||||||
|
|
||||||
|
inline event_collector &get_collector() {
|
||||||
|
static event_collector collector;
|
||||||
|
return collector;
|
||||||
|
}
|
||||||
|
|
||||||
|
template <class function_type>
|
||||||
|
event_aggregate bench(const function_type &function, size_t min_repeat = 10,
|
||||||
|
size_t min_time_ns = 1000000000,
|
||||||
|
size_t max_repeat = 100000) {
|
||||||
|
event_collector &collector = get_collector();
|
||||||
|
event_aggregate aggregate{};
|
||||||
|
size_t N = min_repeat;
|
||||||
|
if (N == 0) {
|
||||||
|
N = 1;
|
||||||
|
}
|
||||||
|
for (size_t i = 0; i < N; i++) {
|
||||||
|
std::atomic_thread_fence(std::memory_order_acquire);
|
||||||
|
collector.start();
|
||||||
|
function();
|
||||||
|
std::atomic_thread_fence(std::memory_order_release);
|
||||||
|
event_count allocate_count = collector.end();
|
||||||
|
aggregate << allocate_count;
|
||||||
|
if ((i + 1 == N) && (aggregate.total_elapsed_ns() < min_time_ns) &&
|
||||||
|
(N < max_repeat)) {
|
||||||
|
N *= 10;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return aggregate;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Source of the 2 functions below:
|
||||||
|
// https://github.com/simdutf/simdutf/blob/master/benchmarks/base64/benchmark_base64.cpp
|
||||||
|
inline void pretty_print(size_t strings, size_t bytes, std::string name,
|
||||||
|
event_aggregate agg) {
|
||||||
|
event_collector &collector = get_collector();
|
||||||
|
printf("%-60s : ", name.c_str());
|
||||||
|
printf(" %5.2f MB/s ", bytes * 1000 / agg.elapsed_ns());
|
||||||
|
printf(" %5.2f Ms/s ", strings * 1000 / agg.elapsed_ns());
|
||||||
|
if (collector.has_events()) {
|
||||||
|
printf(" %5.2f GHz ", agg.cycles() / agg.elapsed_ns());
|
||||||
|
printf(" %5.2f c/b ", agg.cycles() / bytes);
|
||||||
|
printf(" %5.2f i/b ", agg.instructions() / bytes);
|
||||||
|
printf(" %5.2f i/c ", agg.instructions() / agg.cycles());
|
||||||
|
}
|
||||||
|
printf("\n");
|
||||||
|
}
|
||||||
|
#endif
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
add_executable(benchmark_serialization_citm_catalog benchmark_serialization_citm_catalog.cpp)
|
||||||
|
|
||||||
|
# Link with Rust benchmarking code if available
|
||||||
|
if(TARGET serde-benchmark)
|
||||||
|
message(STATUS "serde-benchmark target was created. Linking CITM catalog benchmark with serde-benchmark.")
|
||||||
|
target_link_libraries(benchmark_serialization_citm_catalog PRIVATE serde-benchmark)
|
||||||
|
target_compile_definitions(benchmark_serialization_citm_catalog PRIVATE SIMDJSON_RUST_VERSION="${Rust_VERSION}")
|
||||||
|
endif()
|
||||||
|
|
||||||
|
target_link_libraries(benchmark_serialization_citm_catalog PRIVATE simdjson::simdjson nlohmann_json)
|
||||||
|
target_link_libraries(benchmark_serialization_citm_catalog PRIVATE reflectcpp)
|
||||||
|
target_compile_definitions(benchmark_serialization_citm_catalog PRIVATE SIMDJSON_BENCH_CPP_REFLECT=1)
|
||||||
|
|
||||||
|
target_compile_definitions(benchmark_serialization_citm_catalog PRIVATE JSON_FILE="${BENCH_CITM_JSON}")
|
||||||
+177
@@ -0,0 +1,177 @@
|
|||||||
|
#include <cassert>
|
||||||
|
#include <cstdlib>
|
||||||
|
#include <ctime>
|
||||||
|
#include <format>
|
||||||
|
#include <fstream>
|
||||||
|
#include <iostream>
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
#include <simdjson.h>
|
||||||
|
#include <string>
|
||||||
|
#include "citm_catalog_data.h"
|
||||||
|
#include "nlohmann_citm_catalog_data.h"
|
||||||
|
#include "../benchmark_utils/benchmark_helper.h"
|
||||||
|
|
||||||
|
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||||
|
#include <rfl.hpp>
|
||||||
|
#include <rfl/json.hpp>
|
||||||
|
void bench_reflect_cpp(CitmCatalog &data) {
|
||||||
|
std::string output = rfl::json::write(data);
|
||||||
|
size_t output_volume = output.size();
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(1, output_volume, "bench_reflect_cpp",
|
||||||
|
bench([&data, &measured_volume, &output_volume]() {
|
||||||
|
std::string output = rfl::json::write(data);
|
||||||
|
measured_volume = output.size();
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
#endif // SIMDJSON_BENCH_CPP_REFLECT
|
||||||
|
|
||||||
|
#ifdef SIMDJSON_RUST_VERSION
|
||||||
|
#include "../serde-benchmark/serde_benchmark.h"
|
||||||
|
|
||||||
|
void bench_rust(serde_benchmark::CitmCatalog *data) {
|
||||||
|
const char * output = serde_benchmark::str_from_citm(data);
|
||||||
|
size_t output_volume = strlen(output);
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(1, output_volume, "bench_rust",
|
||||||
|
bench([&data, &measured_volume, &output_volume]() {
|
||||||
|
const char * output = serde_benchmark::str_from_citm(data);
|
||||||
|
measured_volume = strlen(output);
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
serde_benchmark::free_str(const_cast<char*>(output));
|
||||||
|
}));
|
||||||
|
serde_benchmark::free_str(const_cast<char*>(output));
|
||||||
|
}
|
||||||
|
#endif // SIMDJSON_RUST_VERSION
|
||||||
|
|
||||||
|
void bench_nlohmann(CitmCatalog &data) {
|
||||||
|
std::string output = nlohmann_serialize(data);
|
||||||
|
size_t output_volume = output.size();
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(1, output_volume, "bench_nlohmann",
|
||||||
|
bench([&data, &measured_volume, &output_volume]() {
|
||||||
|
std::string output = nlohmann_serialize(data);
|
||||||
|
measured_volume = output.size();
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
void bench_simdjson_static_reflection(CitmCatalog &data) {
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
simdjson::builder::append(sb, data);
|
||||||
|
std::string_view p;
|
||||||
|
if(sb.view().get(p)) {
|
||||||
|
std::cerr << "Error!" << std::endl;
|
||||||
|
}
|
||||||
|
size_t output_volume = p.size();
|
||||||
|
sb.clear();
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(sizeof(data), output_volume, "bench_simdjson_static_reflection",
|
||||||
|
bench([&data, &measured_volume, &output_volume, &sb]() {
|
||||||
|
sb.clear();
|
||||||
|
simdjson::builder::append(sb, data);
|
||||||
|
std::string_view p;
|
||||||
|
if(sb.view().get(p)) {
|
||||||
|
std::cerr << "Error!" << std::endl;
|
||||||
|
}
|
||||||
|
measured_volume = sb.size();
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string read_file(const std::string &file_path, size_t read_size = 65536) {
|
||||||
|
std::ifstream stream(file_path, std::ios::binary);
|
||||||
|
if(!stream) {
|
||||||
|
std::cerr << "Could not open file '" << file_path << "'" << std::endl;
|
||||||
|
exit(EXIT_FAILURE);
|
||||||
|
}
|
||||||
|
stream.exceptions(std::ios_base::badbit);
|
||||||
|
std::string out;
|
||||||
|
std::string buf(read_size, '\0');
|
||||||
|
while (stream.read(&buf[0], read_size)) {
|
||||||
|
out.append(buf, 0, size_t(stream.gcount()));
|
||||||
|
}
|
||||||
|
out.append(buf, 0, size_t(stream.gcount()));
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Function to check if benchmark name contains filter substring
|
||||||
|
bool matches_filter(const std::string& benchmark_name, const std::string& filter) {
|
||||||
|
return filter.empty() || benchmark_name.find(filter) != std::string::npos;
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char* argv[]) {
|
||||||
|
std::string filter;
|
||||||
|
|
||||||
|
// Parse command-line arguments
|
||||||
|
for (int i = 1; i < argc; ++i) {
|
||||||
|
if (strcmp(argv[i], "-f") == 0 || strcmp(argv[i], "--filter") == 0) {
|
||||||
|
if (i + 1 < argc) {
|
||||||
|
filter = argv[++i];
|
||||||
|
} else {
|
||||||
|
std::cerr << "Error: -f/--filter requires an argument" << std::endl;
|
||||||
|
return EXIT_FAILURE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Testing correctness of round-trip (serialization + deserialization)
|
||||||
|
std::string json_str = read_file(JSON_FILE);
|
||||||
|
|
||||||
|
// Loading up the data into a structure.
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc;
|
||||||
|
if(parser.iterate(simdjson::pad(json_str)).get(doc)) {
|
||||||
|
std::cerr << "Error loading the document!" << std::endl;
|
||||||
|
return EXIT_FAILURE;
|
||||||
|
}
|
||||||
|
CitmCatalog my_struct;
|
||||||
|
if(doc.get<CitmCatalog>().get(my_struct)) {
|
||||||
|
std::cerr << "Error loading CitmCatalog!" << std::endl;
|
||||||
|
return EXIT_FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Benchmarking the serialization
|
||||||
|
if (matches_filter("nlohmann", filter)) {
|
||||||
|
bench_nlohmann(my_struct);
|
||||||
|
}
|
||||||
|
if (matches_filter("simdjson_static_reflection", filter)) {
|
||||||
|
bench_simdjson_static_reflection(my_struct);
|
||||||
|
}
|
||||||
|
#ifdef SIMDJSON_RUST_VERSION
|
||||||
|
if (matches_filter("rust", filter)) {
|
||||||
|
printf("# WARNING: The Rust benchmark may not be directly comparable since it does not use an equivalent data structure.\n");
|
||||||
|
// Create a Rust-compatible CitmCatalog structure from the JSON string
|
||||||
|
serde_benchmark::CitmCatalog* rust_data =
|
||||||
|
serde_benchmark::citm_from_str(json_str.c_str(), json_str.size());
|
||||||
|
|
||||||
|
if (rust_data == nullptr) {
|
||||||
|
printf("# Failed to initialize Rust data structure\n");
|
||||||
|
} else {
|
||||||
|
bench_rust(rust_data);
|
||||||
|
serde_benchmark::free_citm(rust_data);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||||
|
if (matches_filter("reflect_cpp", filter)) {
|
||||||
|
bench_reflect_cpp(my_struct);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
return EXIT_SUCCESS;
|
||||||
|
}
|
||||||
@@ -0,0 +1,82 @@
|
|||||||
|
#ifndef CITM_CATALOG_DATA_H
|
||||||
|
#define CITM_CATALOG_DATA_H
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#include <vector>
|
||||||
|
#include <map>
|
||||||
|
|
||||||
|
struct Area {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
int64_t parent;
|
||||||
|
std::vector<int64_t> childAreas;
|
||||||
|
bool operator==(const Area &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct AudienceSubCategory {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
int64_t parent;
|
||||||
|
bool operator==(const AudienceSubCategory &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Event {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
std::string description;
|
||||||
|
int64_t subTopic;
|
||||||
|
int64_t topic;
|
||||||
|
std::vector<int64_t> audience;
|
||||||
|
bool operator==(const Event &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Performance {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
int64_t event;
|
||||||
|
std::string start;
|
||||||
|
int64_t venueCode;
|
||||||
|
bool operator==(const Performance &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct SeatCategory {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
std::vector<int64_t> areas;
|
||||||
|
bool operator==(const SeatCategory &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct SubTopic {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
int64_t parent;
|
||||||
|
bool operator==(const SubTopic &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Topic {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
bool operator==(const Topic &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Venue {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
int64_t address;
|
||||||
|
bool operator==(const Venue &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct CitmCatalog {
|
||||||
|
std::map<std::string, Area> areas;
|
||||||
|
std::map<std::string, AudienceSubCategory> audienceSubCategory;
|
||||||
|
std::map<std::string, Event> events;
|
||||||
|
std::map<std::string, Performance> performances;
|
||||||
|
std::map<std::string, SeatCategory> seatCategory;
|
||||||
|
std::map<std::string, SubTopic> subTopic;
|
||||||
|
std::map<std::string, Topic> topic;
|
||||||
|
std::map<std::string, Venue> venue;
|
||||||
|
|
||||||
|
bool operator==(const CitmCatalog &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif
|
||||||
@@ -0,0 +1,171 @@
|
|||||||
|
// nlohmann_citm_catalog_data.h
|
||||||
|
#ifndef NLOHMANN_CITM_CATALOG_DATA_H
|
||||||
|
#define NLOHMANN_CITM_CATALOG_DATA_H
|
||||||
|
|
||||||
|
#include "citm_catalog_data.h"
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
#include <string>
|
||||||
|
|
||||||
|
using json = nlohmann::json;
|
||||||
|
|
||||||
|
// ---- Area ----
|
||||||
|
inline void to_json(json &j, const Area &a) {
|
||||||
|
j = json{
|
||||||
|
{"id", a.id},
|
||||||
|
{"name", a.name},
|
||||||
|
{"parent", a.parent},
|
||||||
|
{"childAreas", a.childAreas}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, Area &a) {
|
||||||
|
j.at("id").get_to(a.id);
|
||||||
|
j.at("name").get_to(a.name);
|
||||||
|
j.at("parent").get_to(a.parent);
|
||||||
|
j.at("childAreas").get_to(a.childAreas);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- AudienceSubCategory ----
|
||||||
|
inline void to_json(json &j, const AudienceSubCategory &asc) {
|
||||||
|
j = json{
|
||||||
|
{"id", asc.id},
|
||||||
|
{"name", asc.name},
|
||||||
|
{"parent", asc.parent}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, AudienceSubCategory &asc) {
|
||||||
|
j.at("id").get_to(asc.id);
|
||||||
|
j.at("name").get_to(asc.name);
|
||||||
|
j.at("parent").get_to(asc.parent);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Event ----
|
||||||
|
inline void to_json(json &j, const Event &e) {
|
||||||
|
j = json{
|
||||||
|
{"id", e.id},
|
||||||
|
{"name", e.name},
|
||||||
|
{"description", e.description},
|
||||||
|
{"subTopic", e.subTopic},
|
||||||
|
{"topic", e.topic},
|
||||||
|
{"audience", e.audience}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, Event &e) {
|
||||||
|
j.at("id").get_to(e.id);
|
||||||
|
j.at("name").get_to(e.name);
|
||||||
|
j.at("description").get_to(e.description);
|
||||||
|
j.at("subTopic").get_to(e.subTopic);
|
||||||
|
j.at("topic").get_to(e.topic);
|
||||||
|
j.at("audience").get_to(e.audience);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Performance ----
|
||||||
|
inline void to_json(json &j, const Performance &p) {
|
||||||
|
j = json{
|
||||||
|
{"id", p.id},
|
||||||
|
{"name", p.name},
|
||||||
|
{"event", p.event},
|
||||||
|
{"start", p.start},
|
||||||
|
{"venueCode", p.venueCode}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, Performance &p) {
|
||||||
|
j.at("id").get_to(p.id);
|
||||||
|
j.at("name").get_to(p.name);
|
||||||
|
j.at("event").get_to(p.event);
|
||||||
|
j.at("start").get_to(p.start);
|
||||||
|
j.at("venueCode").get_to(p.venueCode);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- SeatCategory ----
|
||||||
|
inline void to_json(json &j, const SeatCategory &sc) {
|
||||||
|
j = json{
|
||||||
|
{"id", sc.id},
|
||||||
|
{"name", sc.name},
|
||||||
|
{"areas", sc.areas}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, SeatCategory &sc) {
|
||||||
|
j.at("id").get_to(sc.id);
|
||||||
|
j.at("name").get_to(sc.name);
|
||||||
|
j.at("areas").get_to(sc.areas);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- SubTopic ----
|
||||||
|
inline void to_json(json &j, const SubTopic &st) {
|
||||||
|
j = json{
|
||||||
|
{"id", st.id},
|
||||||
|
{"name", st.name},
|
||||||
|
{"parent", st.parent}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, SubTopic &st) {
|
||||||
|
j.at("id").get_to(st.id);
|
||||||
|
j.at("name").get_to(st.name);
|
||||||
|
j.at("parent").get_to(st.parent);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Topic ----
|
||||||
|
inline void to_json(json &j, const Topic &t) {
|
||||||
|
j = json{
|
||||||
|
{"id", t.id},
|
||||||
|
{"name", t.name}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, Topic &t) {
|
||||||
|
j.at("id").get_to(t.id);
|
||||||
|
j.at("name").get_to(t.name);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- Venue ----
|
||||||
|
inline void to_json(json &j, const Venue &v) {
|
||||||
|
j = json{
|
||||||
|
{"id", v.id},
|
||||||
|
{"name", v.name},
|
||||||
|
{"address", v.address}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, Venue &v) {
|
||||||
|
j.at("id").get_to(v.id);
|
||||||
|
j.at("name").get_to(v.name);
|
||||||
|
j.at("address").get_to(v.address);
|
||||||
|
}
|
||||||
|
|
||||||
|
// ---- CitmCatalog ----
|
||||||
|
inline void to_json(json &j, const CitmCatalog &c) {
|
||||||
|
j = json{
|
||||||
|
{"areas", c.areas},
|
||||||
|
{"audienceSubCategory", c.audienceSubCategory},
|
||||||
|
{"events", c.events},
|
||||||
|
{"performances", c.performances},
|
||||||
|
{"seatCategory", c.seatCategory},
|
||||||
|
{"subTopic", c.subTopic},
|
||||||
|
{"topic", c.topic},
|
||||||
|
{"venue", c.venue}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
inline void from_json(const json &j, CitmCatalog &c) {
|
||||||
|
j.at("areas").get_to(c.areas);
|
||||||
|
j.at("audienceSubCategory").get_to(c.audienceSubCategory);
|
||||||
|
j.at("events").get_to(c.events);
|
||||||
|
j.at("performances").get_to(c.performances);
|
||||||
|
j.at("seatCategory").get_to(c.seatCategory);
|
||||||
|
j.at("subTopic").get_to(c.subTopic);
|
||||||
|
j.at("topic").get_to(c.topic);
|
||||||
|
j.at("venue").get_to(c.venue);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Optional convenience functions for benchmarking
|
||||||
|
inline std::string nlohmann_serialize(const CitmCatalog &catalog) {
|
||||||
|
json j = catalog;
|
||||||
|
return j.dump();
|
||||||
|
}
|
||||||
|
inline bool nlohmann_deserialize(const std::string &json_in, CitmCatalog &catalog) {
|
||||||
|
try {
|
||||||
|
catalog = json::parse(json_in);
|
||||||
|
return false; // success
|
||||||
|
} catch(...) {
|
||||||
|
return true; // failure
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // NLOHMANN_CITM_CATALOG_DATA_H
|
||||||
+103
@@ -0,0 +1,103 @@
|
|||||||
|
# This file is automatically @generated by Cargo.
|
||||||
|
# It is not intended for manual editing.
|
||||||
|
version = 3
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "itoa"
|
||||||
|
version = "1.0.11"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "libc"
|
||||||
|
version = "0.2.158"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "d8adc4bb1803a324070e64a98ae98f38934d91957a99cfb3a43dcbc01bc56439"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "memchr"
|
||||||
|
version = "2.7.4"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "proc-macro2"
|
||||||
|
version = "1.0.86"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77"
|
||||||
|
dependencies = [
|
||||||
|
"unicode-ident",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "quote"
|
||||||
|
version = "1.0.37"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af"
|
||||||
|
dependencies = [
|
||||||
|
"proc-macro2",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "ryu"
|
||||||
|
version = "1.0.18"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f"
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde"
|
||||||
|
version = "1.0.209"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "99fce0ffe7310761ca6bf9faf5115afbc19688edd00171d81b1bb1b116c63e09"
|
||||||
|
dependencies = [
|
||||||
|
"serde_derive",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde-benchmark"
|
||||||
|
version = "0.1.0"
|
||||||
|
dependencies = [
|
||||||
|
"libc",
|
||||||
|
"serde",
|
||||||
|
"serde_json",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde_derive"
|
||||||
|
version = "1.0.209"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "a5831b979fd7b5439637af1752d535ff49f4860c0f341d1baeb6faf0f4242170"
|
||||||
|
dependencies = [
|
||||||
|
"proc-macro2",
|
||||||
|
"quote",
|
||||||
|
"syn",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "serde_json"
|
||||||
|
version = "1.0.127"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "8043c06d9f82bd7271361ed64f415fe5e12a77fdb52e573e7f06a516dea329ad"
|
||||||
|
dependencies = [
|
||||||
|
"itoa",
|
||||||
|
"memchr",
|
||||||
|
"ryu",
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "syn"
|
||||||
|
version = "2.0.76"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "578e081a14e0cefc3279b0472138c513f37b41a08d5a3cca9b6e4e8ceb6cd525"
|
||||||
|
dependencies = [
|
||||||
|
"proc-macro2",
|
||||||
|
"quote",
|
||||||
|
"unicode-ident",
|
||||||
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "unicode-ident"
|
||||||
|
version = "1.0.12"
|
||||||
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
|
checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
[package]
|
||||||
|
name = "serde-benchmark"
|
||||||
|
version = "0.1.0"
|
||||||
|
|
||||||
|
[lib]
|
||||||
|
path = "lib.rs"
|
||||||
|
crate-type = ["cdylib"]
|
||||||
|
|
||||||
|
[dependencies]
|
||||||
|
serde = { version = "1.0", features = ["derive"] }
|
||||||
|
libc = "0.2"
|
||||||
|
serde_json = "1.0"
|
||||||
|
|
||||||
|
[profile.release]
|
||||||
|
opt-level = 3
|
||||||
|
debug = false
|
||||||
|
lto = true
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
## Rust Serde FFI
|
||||||
|
|
||||||
|
This folder includes FFI bindings for rust/serde.
|
||||||
|
|
||||||
|
### Links
|
||||||
|
|
||||||
|
- https://github.com/eqrion/cbindgen/blob/master/docs.md
|
||||||
|
- https://gist.github.com/zbraniecki/b251714d77ffebbc73c03447f2b2c69f
|
||||||
|
- https://michael-f-bryan.github.io/rust-ffi-guide/setting_up.html
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
- Generating cbindgen output
|
||||||
|
- Install dependencies with `brew install cbindgen` or `apt-get install cbindgen` or `cargo install cbindgen` or the equivalent: we used `cargo install --version 0.23.0 cbindgen`.
|
||||||
|
- Go to the directory where this README.md file is located
|
||||||
|
- Generate with `cbindgen --config cbindgen.toml --crate serde-benchmark --output serde_benchmark.h`
|
||||||
|
- Building
|
||||||
|
- Run with `cargo build --release`
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
autogen_warning = "/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */"
|
||||||
|
include_version = true
|
||||||
|
braces = "SameLine"
|
||||||
|
line_length = 100
|
||||||
|
tab_width = 2
|
||||||
|
language = "C++"
|
||||||
|
namespaces = ["serde_benchmark"]
|
||||||
|
include_guard = "serde_benchmark_ffi_h"
|
||||||
|
|
||||||
|
[parse]
|
||||||
|
parse_deps = true
|
||||||
|
include = ["serde_json", "serde"]
|
||||||
@@ -0,0 +1,482 @@
|
|||||||
|
extern crate serde;
|
||||||
|
extern crate serde_json;
|
||||||
|
extern crate libc;
|
||||||
|
|
||||||
|
use libc::{c_char, size_t};
|
||||||
|
use serde::{Serialize, Deserialize};
|
||||||
|
use std::{collections::HashMap, ffi::CString, ptr, slice};
|
||||||
|
use serde::de::{self, Deserializer};
|
||||||
|
/******************************************************/
|
||||||
|
/******************************************************/
|
||||||
|
/**
|
||||||
|
* Warning: the C++ code may not generate the same JSON.
|
||||||
|
*/
|
||||||
|
/******************************************************/
|
||||||
|
/******************************************************/
|
||||||
|
|
||||||
|
// This has no equivalent in C++:
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Metadata {
|
||||||
|
result_type: String,
|
||||||
|
iso_language_code: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct User {
|
||||||
|
id: i64,
|
||||||
|
id_str: String,
|
||||||
|
name: String,
|
||||||
|
screen_name: String,
|
||||||
|
location: String,
|
||||||
|
description: String,
|
||||||
|
// C++ does not have those:
|
||||||
|
// url: Option<String>,
|
||||||
|
//protected: bool,
|
||||||
|
//listed_count: i64,
|
||||||
|
//created_at: String,
|
||||||
|
//favourites_count: i64,
|
||||||
|
//utc_offset: Option<i64>,
|
||||||
|
//time_zone: Option<String>,
|
||||||
|
//geo_enabled: bool,
|
||||||
|
verified: bool,
|
||||||
|
followers_count: i64,
|
||||||
|
friends_count: i64,
|
||||||
|
statuses_count: i64,
|
||||||
|
// C++ does not have those:
|
||||||
|
//lang: String,
|
||||||
|
//profile_background_color: String,
|
||||||
|
//profile_background_image_url: String,
|
||||||
|
//profile_background_image_url_https: String,
|
||||||
|
//profile_background_tile: bool,
|
||||||
|
//profile_image_url: String,
|
||||||
|
//profile_image_url_https: String,
|
||||||
|
//profile_banner_url: Option<String>,
|
||||||
|
//profile_link_color: String,
|
||||||
|
//profile_sidebar_border_color: String,
|
||||||
|
//profile_sidebar_fill_color: String,
|
||||||
|
//profile_text_color: String,
|
||||||
|
//profile_use_background_image: bool,
|
||||||
|
//default_profile: bool,
|
||||||
|
//default_profile_image: bool,
|
||||||
|
//following: bool,
|
||||||
|
//follow_request_sent: bool,
|
||||||
|
//notifications: bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Hashtag {
|
||||||
|
text: String,
|
||||||
|
|
||||||
|
// C++ has those but D. Lemire does not know what they are, they don't appear in the JSON:
|
||||||
|
// int64_t indices_start;
|
||||||
|
// int64_t indices_end;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Url {
|
||||||
|
url: String,
|
||||||
|
expanded_url: String,
|
||||||
|
display_url: String,
|
||||||
|
// C++ has those but D. Lemire does not know what they are, they don't appear in the JSON:
|
||||||
|
// int64_t indices_start;
|
||||||
|
// int64_t indices_end;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct UserMention {
|
||||||
|
id: i64,
|
||||||
|
name: String,
|
||||||
|
screen_name: String,
|
||||||
|
// Not in the C++ equivalent:
|
||||||
|
//id_str: String,
|
||||||
|
//indices: Vec<i64>,
|
||||||
|
// C++ has those but D. Lemire does not know what they are, they don't appear in the JSON:
|
||||||
|
// int64_t indices_start;
|
||||||
|
// int64_t indices_end;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Entities {
|
||||||
|
hashtags: Vec<Hashtag>,
|
||||||
|
urls: Vec<Url>,
|
||||||
|
user_mentions: Vec<UserMention>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Status {
|
||||||
|
created_at: String,
|
||||||
|
id: i64,
|
||||||
|
text: String,
|
||||||
|
user: User,
|
||||||
|
entities: Entities,
|
||||||
|
retweet_count: i64,
|
||||||
|
favorite_count: i64,
|
||||||
|
favorited: bool,
|
||||||
|
retweeted: bool,
|
||||||
|
// None of these are in the C++ equivalent:
|
||||||
|
/*
|
||||||
|
metadata: Metadata,
|
||||||
|
id_str: String,
|
||||||
|
source: String,
|
||||||
|
truncated: bool,
|
||||||
|
in_reply_to_status_id: Option<i64>,
|
||||||
|
in_reply_to_status_id_str: Option<String>,
|
||||||
|
in_reply_to_user_id: Option<i64>,
|
||||||
|
in_reply_to_user_id_str: Option<String>,
|
||||||
|
in_reply_to_screen_name: Option<String>,
|
||||||
|
geo: Option<String>,
|
||||||
|
coordinates: Option<String>,
|
||||||
|
place: Option<String>,
|
||||||
|
contributors: Option<String>,
|
||||||
|
lang: String,
|
||||||
|
*/
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct TwitterData {
|
||||||
|
statuses: Vec<Status>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern "C" fn twitter_from_str(raw_input: *const c_char, raw_input_length: size_t) -> *mut TwitterData {
|
||||||
|
let input = std::str::from_utf8_unchecked(slice::from_raw_parts(raw_input as *const u8, raw_input_length));
|
||||||
|
match serde_json::from_str(&input) {
|
||||||
|
Ok(result) => Box::into_raw(Box::new(result)),
|
||||||
|
Err(_) => std::ptr::null_mut(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern "C" fn str_from_twitter(raw: *mut TwitterData) -> *const c_char {
|
||||||
|
let twitter_thing = { &*raw };
|
||||||
|
let serialized = serde_json::to_string(&twitter_thing).unwrap();
|
||||||
|
return std::ffi::CString::new(serialized.as_str()).unwrap().into_raw()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern "C" fn free_twitter(raw: *mut TwitterData) {
|
||||||
|
if raw.is_null() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
drop(Box::from_raw(raw))
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern fn free_string(ptr: *const c_char) {
|
||||||
|
let _ = std::ffi::CString::from_raw(ptr as *mut _);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Functions associated with the CitmCatalog benchmark
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Area {
|
||||||
|
pub id: i64,
|
||||||
|
pub name: Option<String>, // Changed to Option
|
||||||
|
pub parent: i64,
|
||||||
|
#[serde(rename = "childAreas")]
|
||||||
|
pub child_areas: Vec<i64>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct AudienceSubCategory {
|
||||||
|
pub id: i64,
|
||||||
|
pub name: Option<String>, // Changed to Option
|
||||||
|
pub parent: i64,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize, Debug)]
|
||||||
|
pub struct Event {
|
||||||
|
#[serde(default)]
|
||||||
|
pub description: Option<String>,
|
||||||
|
pub id: i64,
|
||||||
|
#[serde(default)]
|
||||||
|
pub logo: Option<String>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub name: Option<String>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub subTopicIds: Vec<i64>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub subjectCode: Option<String>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub subtitle: Option<String>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub topicIds: Vec<i64>,
|
||||||
|
// Add a catch-all for any other fields
|
||||||
|
#[serde(flatten)]
|
||||||
|
pub extra: HashMap<String, serde_json::Value>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize, Debug)]
|
||||||
|
pub struct Performance {
|
||||||
|
#[serde(default)]
|
||||||
|
pub id: i64,
|
||||||
|
|
||||||
|
#[serde(default)]
|
||||||
|
pub name: Option<String>,
|
||||||
|
|
||||||
|
#[serde(default)]
|
||||||
|
pub event: i64,
|
||||||
|
|
||||||
|
// This is the key fix - accept any JSON value type for timestamps
|
||||||
|
// This allows both string dates and integer timestamps (line 3511)
|
||||||
|
#[serde(default)]
|
||||||
|
pub start: serde_json::Value,
|
||||||
|
|
||||||
|
#[serde(rename = "venueCode")]
|
||||||
|
pub venue_code: String,
|
||||||
|
|
||||||
|
// Add a catch-all for any other fields
|
||||||
|
#[serde(flatten)]
|
||||||
|
pub extra: HashMap<String, serde_json::Value>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct SeatCategory {
|
||||||
|
pub id: i64,
|
||||||
|
pub name: Option<String>, // Changed to Option
|
||||||
|
pub areas: Vec<i64>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct SubTopic {
|
||||||
|
pub id: i64,
|
||||||
|
pub name: Option<String>, // Changed to Option
|
||||||
|
pub parent: i64,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Topic {
|
||||||
|
pub id: i64,
|
||||||
|
pub name: Option<String>, // Changed to Option
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
pub struct Venue {
|
||||||
|
pub id: i64,
|
||||||
|
pub name: Option<String>, // Changed to Option
|
||||||
|
pub address: i64,
|
||||||
|
}
|
||||||
|
|
||||||
|
// Custom deserializers
|
||||||
|
fn deserialize_string_to_area<'de, D>(deserializer: D) -> Result<HashMap<String, Area>, D::Error>
|
||||||
|
where D: Deserializer<'de> {
|
||||||
|
let string_map: HashMap<String, String> = HashMap::deserialize(deserializer)?;
|
||||||
|
let mut result = HashMap::new();
|
||||||
|
|
||||||
|
for (id, name) in string_map {
|
||||||
|
let id_num = id.parse::<i64>().unwrap_or(0);
|
||||||
|
result.insert(id.clone(), Area {
|
||||||
|
id: id_num,
|
||||||
|
name: Some(name),
|
||||||
|
parent: 0,
|
||||||
|
child_areas: Vec::new(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn deserialize_string_to_audience_subcategory<'de, D>(deserializer: D) -> Result<HashMap<String, AudienceSubCategory>, D::Error>
|
||||||
|
where D: Deserializer<'de> {
|
||||||
|
let string_map: HashMap<String, String> = HashMap::deserialize(deserializer)?;
|
||||||
|
let mut result = HashMap::new();
|
||||||
|
|
||||||
|
for (id, name) in string_map {
|
||||||
|
let id_num = id.parse::<i64>().unwrap_or(0);
|
||||||
|
result.insert(id.clone(), AudienceSubCategory {
|
||||||
|
id: id_num,
|
||||||
|
name: Some(name),
|
||||||
|
parent: 0,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn deserialize_string_to_seat_category<'de, D>(deserializer: D) -> Result<HashMap<String, SeatCategory>, D::Error>
|
||||||
|
where D: Deserializer<'de> {
|
||||||
|
let string_map: HashMap<String, String> = HashMap::deserialize(deserializer)?;
|
||||||
|
let mut result = HashMap::new();
|
||||||
|
|
||||||
|
for (id, name) in string_map {
|
||||||
|
let id_num = id.parse::<i64>().unwrap_or(0);
|
||||||
|
result.insert(id.clone(), SeatCategory {
|
||||||
|
id: id_num,
|
||||||
|
name: Some(name),
|
||||||
|
areas: Vec::new(),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn deserialize_string_to_subtopic<'de, D>(deserializer: D) -> Result<HashMap<String, SubTopic>, D::Error>
|
||||||
|
where D: Deserializer<'de> {
|
||||||
|
let string_map: HashMap<String, String> = HashMap::deserialize(deserializer)?;
|
||||||
|
let mut result = HashMap::new();
|
||||||
|
|
||||||
|
for (id, name) in string_map {
|
||||||
|
let id_num = id.parse::<i64>().unwrap_or(0);
|
||||||
|
result.insert(id.clone(), SubTopic {
|
||||||
|
id: id_num,
|
||||||
|
name: Some(name),
|
||||||
|
parent: 0,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn deserialize_string_to_topic<'de, D>(deserializer: D) -> Result<HashMap<String, Topic>, D::Error>
|
||||||
|
where D: Deserializer<'de> {
|
||||||
|
let string_map: HashMap<String, String> = HashMap::deserialize(deserializer)?;
|
||||||
|
let mut result = HashMap::new();
|
||||||
|
|
||||||
|
for (id, name) in string_map {
|
||||||
|
let id_num = id.parse::<i64>().unwrap_or(0);
|
||||||
|
result.insert(id.clone(), Topic {
|
||||||
|
id: id_num,
|
||||||
|
name: Some(name),
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn deserialize_string_to_venue<'de, D>(deserializer: D) -> Result<HashMap<String, Venue>, D::Error>
|
||||||
|
where D: Deserializer<'de> {
|
||||||
|
let string_map: HashMap<String, String> = HashMap::deserialize(deserializer)?;
|
||||||
|
let mut result = HashMap::new();
|
||||||
|
|
||||||
|
for (id, name) in string_map {
|
||||||
|
result.insert(id.clone(), Venue {
|
||||||
|
id: 0,
|
||||||
|
name: Some(name),
|
||||||
|
address: 0,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize, Debug)]
|
||||||
|
pub struct CitmCatalog {
|
||||||
|
#[serde(rename = "areaNames")]
|
||||||
|
pub area_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
#[serde(rename = "audienceSubCategoryNames")]
|
||||||
|
pub audience_subcategory_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
#[serde(default)]
|
||||||
|
#[serde(rename = "blockNames")]
|
||||||
|
pub block_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
pub events: HashMap<String, Event>,
|
||||||
|
|
||||||
|
#[serde(default)]
|
||||||
|
pub performances: Vec<Performance>,
|
||||||
|
|
||||||
|
#[serde(rename = "seatCategoryNames")]
|
||||||
|
pub seat_category_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
#[serde(rename = "subTopicNames")]
|
||||||
|
pub subtopic_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
#[serde(default)]
|
||||||
|
#[serde(rename = "subjectNames")]
|
||||||
|
pub subject_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
#[serde(rename = "topicNames")]
|
||||||
|
pub topic_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
#[serde(rename = "topicSubTopics")]
|
||||||
|
pub topic_subtopics: HashMap<String, Vec<i64>>,
|
||||||
|
|
||||||
|
#[serde(rename = "venueNames")]
|
||||||
|
pub venue_names: HashMap<String, String>,
|
||||||
|
|
||||||
|
// Catch-all for other fields
|
||||||
|
#[serde(flatten)]
|
||||||
|
pub extra: HashMap<String, serde_json::Value>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Creates a CitmCatalog from a JSON string (UTF-8 encoded).
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern "C" fn citm_from_str(
|
||||||
|
raw_input: *const c_char,
|
||||||
|
raw_input_length: usize
|
||||||
|
) -> *mut CitmCatalog {
|
||||||
|
if raw_input.is_null() {
|
||||||
|
eprintln!("Error: Input pointer is null");
|
||||||
|
return ptr::null_mut();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Convert the raw pointer + length into a Rust slice
|
||||||
|
let bytes = slice::from_raw_parts(raw_input as *const u8, raw_input_length);
|
||||||
|
let input_str = match std::str::from_utf8(bytes) {
|
||||||
|
Ok(s) => s,
|
||||||
|
Err(e) => {
|
||||||
|
eprintln!("Error: Invalid UTF-8 string: {}", e);
|
||||||
|
return ptr::null_mut();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Try deserializing the input string into CitmCatalog
|
||||||
|
match serde_json::from_str::<CitmCatalog>(input_str) {
|
||||||
|
Ok(catalog) => Box::into_raw(Box::new(catalog)),
|
||||||
|
Err(e) => {
|
||||||
|
eprintln!("Error deserializing JSON: {}", e);
|
||||||
|
eprintln!("JSON snippet (first 200 chars): {:.200}...", input_str);
|
||||||
|
ptr::null_mut()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Serializes a CitmCatalog into a JSON string (UTF-8).
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern "C" fn str_from_citm(raw_catalog: *mut CitmCatalog) -> *mut c_char {
|
||||||
|
if raw_catalog.is_null() {
|
||||||
|
eprintln!("Error: Catalog pointer is null");
|
||||||
|
return ptr::null_mut();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fix: Actually serialize the catalog
|
||||||
|
let catalog = &*raw_catalog;
|
||||||
|
|
||||||
|
match serde_json::to_string(catalog) {
|
||||||
|
Ok(serialized) => {
|
||||||
|
match CString::new(serialized) {
|
||||||
|
Ok(cstr) => cstr.into_raw(),
|
||||||
|
Err(e) => {
|
||||||
|
eprintln!("Error creating CString: {}", e);
|
||||||
|
ptr::null_mut()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
Err(e) => {
|
||||||
|
eprintln!("Error serializing catalog to JSON: {}", e);
|
||||||
|
ptr::null_mut()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Frees the CitmCatalog pointer.
|
||||||
|
#[no_mangle]
|
||||||
|
pub unsafe extern "C" fn free_citm(raw_catalog: *mut CitmCatalog) {
|
||||||
|
if !raw_catalog.is_null() {
|
||||||
|
drop(Box::from_raw(raw_catalog));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[no_mangle]
|
||||||
|
pub extern "C" fn free_str(ptr: *mut c_char) {
|
||||||
|
if !ptr.is_null() {
|
||||||
|
unsafe {
|
||||||
|
// Convert back into a CString, which automatically frees the memory
|
||||||
|
let _ = CString::from_raw(ptr);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,45 @@
|
|||||||
|
#ifndef serde_benchmark_ffi_h
|
||||||
|
#define serde_benchmark_ffi_h
|
||||||
|
|
||||||
|
/* Generated with cbindgen:0.28.0 */
|
||||||
|
|
||||||
|
/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
|
||||||
|
|
||||||
|
#include <cstdarg>
|
||||||
|
#include <cstdint>
|
||||||
|
#include <cstdlib>
|
||||||
|
#include <ostream>
|
||||||
|
#include <new>
|
||||||
|
|
||||||
|
namespace serde_benchmark {
|
||||||
|
|
||||||
|
struct CitmCatalog;
|
||||||
|
|
||||||
|
struct TwitterData;
|
||||||
|
|
||||||
|
extern "C" {
|
||||||
|
|
||||||
|
TwitterData *twitter_from_str(const char *raw_input, size_t raw_input_length);
|
||||||
|
|
||||||
|
const char *str_from_twitter(TwitterData *raw);
|
||||||
|
|
||||||
|
void free_twitter(TwitterData *raw);
|
||||||
|
|
||||||
|
void free_string(const char *ptr);
|
||||||
|
|
||||||
|
/// Creates a CitmCatalog from a JSON string (UTF-8 encoded).
|
||||||
|
CitmCatalog *citm_from_str(const char *raw_input, uintptr_t raw_input_length);
|
||||||
|
|
||||||
|
/// Serializes a CitmCatalog into a JSON string (UTF-8).
|
||||||
|
char *str_from_citm(CitmCatalog *raw_catalog);
|
||||||
|
|
||||||
|
/// Frees the CitmCatalog pointer.
|
||||||
|
void free_citm(CitmCatalog *raw_catalog);
|
||||||
|
|
||||||
|
void free_str(char *ptr);
|
||||||
|
|
||||||
|
} // extern "C"
|
||||||
|
|
||||||
|
} // namespace serde_benchmark
|
||||||
|
|
||||||
|
#endif // serde_benchmark_ffi_h
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
|
||||||
|
# Add executable targets
|
||||||
|
add_executable(benchmark_serialization_twitter benchmark_serialization_twitter.cpp)
|
||||||
|
|
||||||
|
if(TARGET serde-benchmark)
|
||||||
|
message(STATUS "serde-benchmark target was created. Linking benchmarks and serde-benchmark.")
|
||||||
|
target_link_libraries(benchmark_serialization_twitter PRIVATE serde-benchmark)
|
||||||
|
target_compile_definitions(benchmark_serialization_twitter PRIVATE SIMDJSON_RUST_VERSION="${Rust_VERSION}")
|
||||||
|
endif()
|
||||||
|
target_link_libraries(benchmark_serialization_twitter PRIVATE simdjson::simdjson nlohmann_json)
|
||||||
|
target_link_libraries(benchmark_serialization_twitter PRIVATE reflectcpp)
|
||||||
|
target_compile_definitions(benchmark_serialization_twitter PRIVATE SIMDJSON_BENCH_CPP_REFLECT=1)
|
||||||
|
|
||||||
|
target_compile_definitions(benchmark_serialization_twitter PRIVATE JSON_FILE="${EXAMPLE_JSON}")
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
#include <cassert>
|
||||||
|
#include <cstdlib>
|
||||||
|
#include <ctime>
|
||||||
|
#include <format>
|
||||||
|
#include <fstream>
|
||||||
|
#include <iostream>
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
#include <simdjson.h>
|
||||||
|
#include <string>
|
||||||
|
#include "twitter_data.h"
|
||||||
|
#include "nlohmann_twitter_data.h"
|
||||||
|
#include "../benchmark_utils/benchmark_helper.h"
|
||||||
|
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||||
|
#include <rfl.hpp>
|
||||||
|
#include <rfl/json.hpp>
|
||||||
|
void bench_reflect_cpp(TwitterData &data) {
|
||||||
|
std::string output = rfl::json::write(data);
|
||||||
|
size_t output_volume = output.size();
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(1, output_volume, "bench_reflect_cpp",
|
||||||
|
bench([&data, &measured_volume, &output_volume]() {
|
||||||
|
std::string output = rfl::json::write(data);
|
||||||
|
measured_volume = output.size();
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
#endif // SIMDJSON_BENCH_CPP_REFLECT
|
||||||
|
|
||||||
|
#ifdef SIMDJSON_RUST_VERSION
|
||||||
|
#include "../serde-benchmark/serde_benchmark.h"
|
||||||
|
|
||||||
|
|
||||||
|
void bench_rust(serde_benchmark::TwitterData *data) {
|
||||||
|
const char * output = serde_benchmark::str_from_twitter(data);
|
||||||
|
size_t output_volume = strlen(output);
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(1, output_volume, "bench_rust",
|
||||||
|
bench([&data, &measured_volume, &output_volume]() {
|
||||||
|
const char * output = serde_benchmark::str_from_twitter(data);
|
||||||
|
serde_benchmark::free_string(output);
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
||||||
|
template <class T> void bench_simdjson_static_reflection(T &data) {
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
simdjson::builder::append(sb, data);
|
||||||
|
std::string_view p;
|
||||||
|
if(sb.view().get(p)) {
|
||||||
|
std::cerr << "Error!" << std::endl;
|
||||||
|
}
|
||||||
|
size_t output_volume = p.size();
|
||||||
|
sb.clear();
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(sizeof(data), output_volume, "bench_simdjson_static_reflection",
|
||||||
|
bench([&data, &measured_volume, &output_volume, &sb]() {
|
||||||
|
sb.clear();
|
||||||
|
simdjson::builder::append(sb, data);
|
||||||
|
std::string_view p;
|
||||||
|
if(sb.view().get(p)) {
|
||||||
|
std::cerr << "Error!" << std::endl;
|
||||||
|
}
|
||||||
|
measured_volume = sb.size();
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
void bench_nlohmann(TwitterData &data) {
|
||||||
|
std::string output = nlohmann_serialize(data);
|
||||||
|
size_t output_volume = output.size();
|
||||||
|
printf("# output volume: %zu bytes\n", output_volume);
|
||||||
|
|
||||||
|
volatile size_t measured_volume = 0;
|
||||||
|
pretty_print(1, output_volume, "bench_nlohmann",
|
||||||
|
bench([&data, &measured_volume, &output_volume]() {
|
||||||
|
std::string output = nlohmann_serialize(data);
|
||||||
|
measured_volume = output.size();
|
||||||
|
if (measured_volume != output_volume) {
|
||||||
|
printf("mismatch\n");
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
|
||||||
|
size_t WriteCallback(void *contents, size_t size, size_t nmemb, void *userp) {
|
||||||
|
((std::string *)userp)->append((char *)contents, size * nmemb);
|
||||||
|
return size * nmemb;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string read_file(std::string filename) {
|
||||||
|
printf("# Reading file %s\n", filename.c_str());
|
||||||
|
constexpr size_t read_size = 4096;
|
||||||
|
auto stream = std::ifstream(filename.c_str());
|
||||||
|
stream.exceptions(std::ios_base::badbit);
|
||||||
|
std::string out;
|
||||||
|
std::string buf(read_size, '\0');
|
||||||
|
while (stream.read(&buf[0], read_size)) {
|
||||||
|
out.append(buf, 0, size_t(stream.gcount()));
|
||||||
|
}
|
||||||
|
out.append(buf, 0, size_t(stream.gcount()));
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Function to check if benchmark name contains filter substring
|
||||||
|
bool matches_filter(const std::string& benchmark_name, const std::string& filter) {
|
||||||
|
return filter.empty() || benchmark_name.find(filter) != std::string::npos;
|
||||||
|
}
|
||||||
|
|
||||||
|
int main(int argc, char* argv[]) {
|
||||||
|
std::string filter;
|
||||||
|
|
||||||
|
// Parse command-line arguments
|
||||||
|
for (int i = 1; i < argc; ++i) {
|
||||||
|
if (strcmp(argv[i], "-f") == 0 || strcmp(argv[i], "--filter") == 0) {
|
||||||
|
if (i + 1 < argc) {
|
||||||
|
filter = argv[++i];
|
||||||
|
} else {
|
||||||
|
std::cerr << "Error: -f/--filter requires an argument" << std::endl;
|
||||||
|
return EXIT_FAILURE;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// Testing correctness of round-trip (serialization + deserialization)
|
||||||
|
std::string json_str = read_file(JSON_FILE);
|
||||||
|
|
||||||
|
// Loading up the data into a structure.
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc;
|
||||||
|
if(parser.iterate(simdjson::pad(json_str)).get(doc)) {
|
||||||
|
std::cerr << "Error loading the document!" << std::endl;
|
||||||
|
return EXIT_FAILURE;
|
||||||
|
}
|
||||||
|
TwitterData my_struct;
|
||||||
|
if(doc.get<TwitterData>().get(my_struct)) {
|
||||||
|
std::cerr << "Error loading TwitterData!" << std::endl;
|
||||||
|
return EXIT_FAILURE;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Benchmarking the serialization
|
||||||
|
if (matches_filter("nlohmann", filter)) {
|
||||||
|
bench_nlohmann(my_struct);
|
||||||
|
}
|
||||||
|
if (matches_filter("simdjson_static_reflection", filter)) {
|
||||||
|
bench_simdjson_static_reflection(my_struct);
|
||||||
|
}
|
||||||
|
#ifdef SIMDJSON_RUST_VERSION
|
||||||
|
if (matches_filter("rust", filter)) {
|
||||||
|
printf("# WARNING: The Rust benchmark may not be directly comparable since it does not use an equivalent data structure.\n");
|
||||||
|
serde_benchmark::TwitterData * td = serde_benchmark::twitter_from_str(json_str.c_str(), json_str.size());
|
||||||
|
bench_rust(td);
|
||||||
|
serde_benchmark::free_twitter(td);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||||
|
if (matches_filter("reflect_cpp", filter)) {
|
||||||
|
bench_reflect_cpp(my_struct);
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
return EXIT_SUCCESS;
|
||||||
|
}
|
||||||
@@ -0,0 +1,116 @@
|
|||||||
|
#ifndef NLOHMANN_TWITTER_DATA_H
|
||||||
|
#define NLOHMANN_TWITTER_DATA_H
|
||||||
|
|
||||||
|
#include "twitter_data.h"
|
||||||
|
#include <nlohmann/json.hpp>
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const User &u) {
|
||||||
|
j = nlohmann::json{{"id", u.id},
|
||||||
|
{"name", u.name},
|
||||||
|
{"screen_name", u.screen_name},
|
||||||
|
{"location", u.location},
|
||||||
|
{"description", u.description},
|
||||||
|
{"verified", u.verified},
|
||||||
|
{"followers_count", u.followers_count},
|
||||||
|
{"friends_count", u.friends_count},
|
||||||
|
{"statuses_count", u.statuses_count}};
|
||||||
|
}
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const Hashtag &h) {
|
||||||
|
j = nlohmann::json{{"text", h.text},
|
||||||
|
{"indices_start", h.indices_start},
|
||||||
|
{"indices_end", h.indices_end}};
|
||||||
|
}
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const Url &u) {
|
||||||
|
j = nlohmann::json{{"url", u.url},
|
||||||
|
{"expanded_url", u.expanded_url},
|
||||||
|
{"display_url", u.display_url},
|
||||||
|
{"indices_start", u.indices_start},
|
||||||
|
{"indices_end", u.indices_end}};
|
||||||
|
}
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const UserMention &um) {
|
||||||
|
j = nlohmann::json{{"id", um.id},
|
||||||
|
{"name", um.name},
|
||||||
|
{"screen_name", um.screen_name},
|
||||||
|
{"indices_start", um.indices_start},
|
||||||
|
{"indices_end", um.indices_end}};
|
||||||
|
}
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const Entities &e) {
|
||||||
|
j = nlohmann::json{{"hashtags", e.hashtags},
|
||||||
|
{"urls", e.urls},
|
||||||
|
{"user_mentions", e.user_mentions}};
|
||||||
|
}
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const Status &s) {
|
||||||
|
j = nlohmann::json{{"created_at", s.created_at},
|
||||||
|
{"id", s.id},
|
||||||
|
{"text", s.text},
|
||||||
|
{"user", s.user},
|
||||||
|
{"entities", s.entities},
|
||||||
|
{"retweet_count", s.retweet_count},
|
||||||
|
{"favorite_count", s.favorite_count},
|
||||||
|
{"favorited", s.favorited},
|
||||||
|
{"retweeted", s.retweeted}};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
std::string nlohmann_serialize(const std::vector<Hashtag>& v) {
|
||||||
|
nlohmann::json a = nlohmann::json::array();
|
||||||
|
for(const Hashtag & h : v) {
|
||||||
|
a.push_back(nlohmann::json{{"text", h.text},
|
||||||
|
{"indices_start", h.indices_start},
|
||||||
|
{"indices_end", h.indices_end}});
|
||||||
|
}
|
||||||
|
return a.dump();
|
||||||
|
}
|
||||||
|
std::string nlohmann_serialize(const std::vector<Url>& v) {
|
||||||
|
nlohmann::json a = nlohmann::json::array();
|
||||||
|
for(const Url & u : v) {
|
||||||
|
a.push_back(nlohmann::json{{"url", u.url},
|
||||||
|
{"expanded_url", u.expanded_url},
|
||||||
|
{"display_url", u.display_url},
|
||||||
|
{"indices_start", u.indices_start},
|
||||||
|
{"indices_end", u.indices_end}});
|
||||||
|
}
|
||||||
|
return a.dump();
|
||||||
|
}
|
||||||
|
std::string nlohmann_serialize(const std::vector<UserMention>& v) {
|
||||||
|
nlohmann::json a = nlohmann::json::array();
|
||||||
|
for(const UserMention & um : v) {
|
||||||
|
a.push_back(nlohmann::json{{"id", um.id},
|
||||||
|
{"name", um.name},
|
||||||
|
{"screen_name", um.screen_name},
|
||||||
|
{"indices_start", um.indices_start},
|
||||||
|
{"indices_end", um.indices_end}});
|
||||||
|
}
|
||||||
|
return a.dump();
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string nlohmann_serialize(const std::vector<Status>& v) {
|
||||||
|
nlohmann::json a = nlohmann::json::array();
|
||||||
|
for(const Status & s : v) {
|
||||||
|
a.push_back(nlohmann::json{{"created_at", s.created_at},
|
||||||
|
{"id", s.id},
|
||||||
|
{"text", s.text},
|
||||||
|
{"user", s.user},
|
||||||
|
{"entities", s.entities},
|
||||||
|
{"retweet_count", s.retweet_count},
|
||||||
|
{"favorite_count", s.favorite_count},
|
||||||
|
{"favorited", s.favorited},
|
||||||
|
{"retweeted", s.retweeted}});
|
||||||
|
}
|
||||||
|
return a.dump();
|
||||||
|
}
|
||||||
|
|
||||||
|
void to_json(nlohmann::json &j, const TwitterData &t) {
|
||||||
|
j = nlohmann::json{{"statuses", t.statuses}};
|
||||||
|
}
|
||||||
|
|
||||||
|
std::string nlohmann_serialize(const TwitterData &data) {
|
||||||
|
return nlohmann_serialize(data.statuses);
|
||||||
|
}
|
||||||
|
|
||||||
|
#endif // NLOHMANN_TWITTER_DATA_H
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
#ifndef TWITTER_DATA_H
|
||||||
|
#define TWITTER_DATA_H
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
|
struct User {
|
||||||
|
int64_t id;
|
||||||
|
std::string id_str;
|
||||||
|
std::string name;
|
||||||
|
std::string screen_name;
|
||||||
|
std::string location;
|
||||||
|
std::string description;
|
||||||
|
bool verified;
|
||||||
|
int64_t followers_count;
|
||||||
|
int64_t friends_count;
|
||||||
|
int64_t statuses_count;
|
||||||
|
bool operator<=>(const User &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Hashtag {
|
||||||
|
std::string text;
|
||||||
|
int64_t indices_start;
|
||||||
|
int64_t indices_end;
|
||||||
|
bool operator<=>(const Hashtag &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Url {
|
||||||
|
std::string url;
|
||||||
|
std::string expanded_url;
|
||||||
|
std::string display_url;
|
||||||
|
int64_t indices_start;
|
||||||
|
int64_t indices_end;
|
||||||
|
bool operator<=>(const Url &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct UserMention {
|
||||||
|
int64_t id;
|
||||||
|
std::string name;
|
||||||
|
std::string screen_name;
|
||||||
|
int64_t indices_start;
|
||||||
|
int64_t indices_end;
|
||||||
|
bool operator<=>(const UserMention &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Entities {
|
||||||
|
std::vector<Hashtag> hashtags;
|
||||||
|
std::vector<Url> urls;
|
||||||
|
std::vector<UserMention> user_mentions;
|
||||||
|
bool operator==(const Entities &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct Status {
|
||||||
|
std::string created_at;
|
||||||
|
int64_t id;
|
||||||
|
std::string text;
|
||||||
|
User user;
|
||||||
|
Entities entities;
|
||||||
|
int64_t retweet_count;
|
||||||
|
int64_t favorite_count;
|
||||||
|
bool favorited;
|
||||||
|
bool retweeted;
|
||||||
|
bool operator==(const Status &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
struct TwitterData {
|
||||||
|
std::vector<Status> statuses;
|
||||||
|
bool operator==(const TwitterData &other) const = default;
|
||||||
|
};
|
||||||
|
|
||||||
|
#endif
|
||||||
@@ -2,7 +2,10 @@
|
|||||||
# Flags used by exes and by the simdjson library (project-wide flags)
|
# Flags used by exes and by the simdjson library (project-wide flags)
|
||||||
#
|
#
|
||||||
add_library(simdjson-internal-flags INTERFACE)
|
add_library(simdjson-internal-flags INTERFACE)
|
||||||
|
if(NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE)
|
||||||
|
# We default to ON for all targets, so that we can use the library in shared libraries.
|
||||||
|
set_target_properties(simdjson-internal-flags PROPERTIES INTERFACE_POSITION_INDEPENDENT_CODE ON)
|
||||||
|
endif(NOT DEFINED CMAKE_POSITION_INDEPENDENT_CODE)
|
||||||
|
|
||||||
option(SIMDJSON_CHECK_EOF "Check for the end of the input buffer. The setting is unnecessary since we require padding of the inputs. You should expect tests to fail with this option turned on." OFF)
|
option(SIMDJSON_CHECK_EOF "Check for the end of the input buffer. The setting is unnecessary since we require padding of the inputs. You should expect tests to fail with this option turned on." OFF)
|
||||||
if(SIMDJSON_CHECK_EOF)
|
if(SIMDJSON_CHECK_EOF)
|
||||||
@@ -29,6 +32,9 @@ undefined behavior.")
|
|||||||
link_libraries(
|
link_libraries(
|
||||||
-fsanitize=address -fno-omit-frame-pointer -fno-sanitize-recover=all
|
-fsanitize=address -fno-omit-frame-pointer -fno-sanitize-recover=all
|
||||||
)
|
)
|
||||||
|
elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
|
||||||
|
add_compile_options(-fsanitize=address)
|
||||||
|
link_libraries(-fsanitize=address)
|
||||||
else()
|
else()
|
||||||
message(
|
message(
|
||||||
STATUS
|
STATUS
|
||||||
@@ -52,7 +58,6 @@ endif()
|
|||||||
|
|
||||||
option(SIMDJSON_SANITIZE_MEMORY "Sanitize memory" OFF)
|
option(SIMDJSON_SANITIZE_MEMORY "Sanitize memory" OFF)
|
||||||
|
|
||||||
|
|
||||||
if(SIMDJSON_SANITIZE_MEMORY)
|
if(SIMDJSON_SANITIZE_MEMORY)
|
||||||
message(STATUS "Setting the memory sanitizer.")
|
message(STATUS "Setting the memory sanitizer.")
|
||||||
add_compile_options(
|
add_compile_options(
|
||||||
@@ -110,8 +115,14 @@ endif()
|
|||||||
|
|
||||||
# We compile tools, tests, etc. with C++ 17. Override yourself if you need on a
|
# We compile tools, tests, etc. with C++ 17. Override yourself if you need on a
|
||||||
# target.
|
# target.
|
||||||
set(SIMDJSON_CXX_STANDARD 17 CACHE STRING "the C++ standard to use for simdjson")
|
if(SIMDJSON_STATIC_REFLECTION)
|
||||||
set(CMAKE_CXX_STANDARD ${SIMDJSON_CXX_STANDARD})
|
# This is temporary.
|
||||||
|
set(SIMDJSON_CXX_STANDARD 26 CACHE STRING "the C++ standard to use for simdjson")
|
||||||
|
#set(CMAKE_CXX_STANDARD ${SIMDJSON_CXX_STANDARD})
|
||||||
|
else()
|
||||||
|
set(SIMDJSON_CXX_STANDARD 17 CACHE STRING "the C++ standard to use for simdjson")
|
||||||
|
set(CMAKE_CXX_STANDARD ${SIMDJSON_CXX_STANDARD})
|
||||||
|
endif()
|
||||||
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
set(CMAKE_CXX_STANDARD_REQUIRED ON)
|
||||||
set(CMAKE_CXX_EXTENSIONS OFF)
|
set(CMAKE_CXX_EXTENSIONS OFF)
|
||||||
set(CMAKE_THREAD_PREFER_PTHREAD ON)
|
set(CMAKE_THREAD_PREFER_PTHREAD ON)
|
||||||
@@ -158,9 +169,6 @@ We recommend Visual Studio 2019 or better on a 64-bit system.")
|
|||||||
add_compile_options(/Zi)
|
add_compile_options(/Zi)
|
||||||
endif()
|
endif()
|
||||||
else()
|
else()
|
||||||
if(NOT WIN32)
|
|
||||||
target_compile_options(simdjson-internal-flags INTERFACE -fPIC)
|
|
||||||
endif()
|
|
||||||
target_compile_options(
|
target_compile_options(
|
||||||
simdjson-internal-flags INTERFACE
|
simdjson-internal-flags INTERFACE
|
||||||
-Werror -Wall -Wextra -Weffc++ -Wsign-compare -Wshadow -Wwrite-strings
|
-Werror -Wall -Wextra -Weffc++ -Wsign-compare -Wshadow -Wwrite-strings
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
#
|
#
|
||||||
# Implementation selection
|
# Implementation selection
|
||||||
#
|
#
|
||||||
set(SIMDJSON_ALL_IMPLEMENTATIONS fallback westmere haswell icelake arm64 ppc64)
|
set(SIMDJSON_ALL_IMPLEMENTATIONS fallback westmere haswell icelake arm64 ppc64 rvv)
|
||||||
|
|
||||||
set(
|
set(
|
||||||
SIMDJSON_IMPLEMENTATION ""
|
SIMDJSON_IMPLEMENTATION ""
|
||||||
@@ -15,7 +15,7 @@ set(
|
|||||||
SIMDJSON_EXCLUDE_IMPLEMENTATION ""
|
SIMDJSON_EXCLUDE_IMPLEMENTATION ""
|
||||||
CACHE STRING "\
|
CACHE STRING "\
|
||||||
Semicolon-separated list of implementations to exclude \
|
Semicolon-separated list of implementations to exclude \
|
||||||
(icelake/haswell/westmere/arm64/ppc64/fallback). By default, excludes any \
|
(icelake/haswell/westmere/arm64/ppc64/rvv/fallback). By default, excludes any \
|
||||||
implementations that are unsupported at compile time or cannot be selected at \
|
implementations that are unsupported at compile time or cannot be selected at \
|
||||||
runtime."
|
runtime."
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -0,0 +1,4 @@
|
|||||||
|
set(CMAKE_SYSTEM_NAME Linux)
|
||||||
|
set(CMAKE_SYSTEM_PROCESSOR riscv64)
|
||||||
|
|
||||||
|
set(CMAKE_CROSSCOMPILING_EMULATOR "qemu-riscv64-static")
|
||||||
Vendored
+6
-14
@@ -7,12 +7,12 @@ option(SIMDJSON_ALLOW_DOWNLOADS
|
|||||||
cmake_dependent_option(SIMDJSON_COMPETITION "Compile competitive benchmarks" ON
|
cmake_dependent_option(SIMDJSON_COMPETITION "Compile competitive benchmarks" ON
|
||||||
SIMDJSON_ALLOW_DOWNLOADS OFF)
|
SIMDJSON_ALLOW_DOWNLOADS OFF)
|
||||||
cmake_dependent_option(SIMDJSON_GOOGLE_BENCHMARKS "compile the Google Benchmark benchmarks" ON
|
cmake_dependent_option(SIMDJSON_GOOGLE_BENCHMARKS "compile the Google Benchmark benchmarks" ON
|
||||||
SIMDJSON_ALLOW_DOWNLOADS OFF)
|
"SIMDJSON_ALLOW_DOWNLOADS OR MINGW" OFF)
|
||||||
|
|
||||||
if(SIMDJSON_GOOGLE_BENCHMARKS)
|
if(SIMDJSON_GOOGLE_BENCHMARKS)
|
||||||
CPMAddPackage(
|
CPMAddPackage(
|
||||||
NAME google_benchmarks
|
NAME google_benchmarks
|
||||||
URL https://github.com/google/benchmark/archive/refs/tags/v1.7.1.zip
|
URL https://github.com/google/benchmark/archive/refs/tags/v1.9.4.zip
|
||||||
OPTIONS
|
OPTIONS
|
||||||
"BENCHMARK_ENABLE_TESTING OFF"
|
"BENCHMARK_ENABLE_TESTING OFF"
|
||||||
"BENCHMARK_ENABLE_INSTALL OFF"
|
"BENCHMARK_ENABLE_INSTALL OFF"
|
||||||
@@ -22,7 +22,7 @@ endif()
|
|||||||
|
|
||||||
CPMAddPackage(
|
CPMAddPackage(
|
||||||
NAME simdjson-data
|
NAME simdjson-data
|
||||||
URL https://github.com/simdjson/simdjson-data/archive/a5b13babe65c1bba7186b41b43d4cbdc20a5c470.zip
|
URL https://github.com/simdjson/simdjson-data/archive/351949906abde446f0314bf79606fb5d884f5be7.zip
|
||||||
)
|
)
|
||||||
|
|
||||||
option(SIMDJSON_USE_BOOST_JSON "Try to include BOOST_JSON, this may break your binaries under some systems." OFF)
|
option(SIMDJSON_USE_BOOST_JSON "Try to include BOOST_JSON, this may break your binaries under some systems." OFF)
|
||||||
@@ -93,19 +93,11 @@ int main() {}
|
|||||||
|
|
||||||
CPMAddPackage(
|
CPMAddPackage(
|
||||||
NAME nlohmann_json
|
NAME nlohmann_json
|
||||||
URL https://github.com/nlohmann/json/archive/refs/tags/v3.10.5.zip
|
URL https://github.com/nlohmann/json/archive/refs/tags/v3.12.0.zip
|
||||||
)
|
)
|
||||||
|
|
||||||
set_property(TARGET nlohmann_json APPEND PROPERTY INTERFACE_COMPILE_DEFINITIONS SIMDJSON_COMPETITION_NLOHMANN_JSON)
|
set_property(TARGET nlohmann_json APPEND PROPERTY INTERFACE_COMPILE_DEFINITIONS SIMDJSON_COMPETITION_NLOHMANN_JSON)
|
||||||
|
|
||||||
CPMAddPackage(
|
|
||||||
NAME json11
|
|
||||||
URL https://github.com/dropbox/json11/archive/ec4e45219af1d7cde3d58b49ed762376fccf1ace.zip
|
|
||||||
DOWNLOAD_ONLY YES
|
|
||||||
)
|
|
||||||
add_library(json11 STATIC "${json11_SOURCE_DIR}/json11.cpp")
|
|
||||||
target_include_directories(json11 SYSTEM PUBLIC "${json11_SOURCE_DIR}")
|
|
||||||
target_compile_definitions(json11 INTERFACE SIMDJSON_COMPETITION_JSON11)
|
|
||||||
|
|
||||||
set(jsoncpp_SOURCE_DIR "${simdjson_SOURCE_DIR}/dependencies/jsoncppdist")
|
set(jsoncpp_SOURCE_DIR "${simdjson_SOURCE_DIR}/dependencies/jsoncppdist")
|
||||||
add_library(jsoncpp STATIC "${jsoncpp_SOURCE_DIR}/jsoncpp.cpp")
|
add_library(jsoncpp STATIC "${jsoncpp_SOURCE_DIR}/jsoncpp.cpp")
|
||||||
@@ -114,7 +106,7 @@ int main() {}
|
|||||||
|
|
||||||
CPMAddPackage(
|
CPMAddPackage(
|
||||||
NAME rapidjson
|
NAME rapidjson
|
||||||
URL https://github.com/Tencent/rapidjson/archive/f54b0e47a08782a6131cc3d60f94d038fa6e0a51.zip
|
URL https://github.com/Tencent/rapidjson/archive/805d7ed5dfe97a39b8b0816fd5eeed8731dc4936.zip
|
||||||
DOWNLOAD_ONLY YES
|
DOWNLOAD_ONLY YES
|
||||||
)
|
)
|
||||||
add_library(rapidjson INTERFACE)
|
add_library(rapidjson INTERFACE)
|
||||||
@@ -177,7 +169,7 @@ int main() {}
|
|||||||
endif()
|
endif()
|
||||||
|
|
||||||
add_library(competition-all INTERFACE)
|
add_library(competition-all INTERFACE)
|
||||||
target_link_libraries(competition-all INTERFACE competition-core jsoncpp json11 fastjson gason ujson4c)
|
target_link_libraries(competition-all INTERFACE competition-core jsoncpp fastjson gason ujson4c)
|
||||||
endfunction()
|
endfunction()
|
||||||
|
|
||||||
if(SIMDJSON_COMPETITION)
|
if(SIMDJSON_COMPETITION)
|
||||||
|
|||||||
+424
-86
@@ -1,59 +1,64 @@
|
|||||||
The Basics
|
The Basics
|
||||||
==========
|
==========
|
||||||
|
|
||||||
An overview of what you need to know to use simdjson, with examples.
|
An overview of what you need to know to use simdjson to parse JSON documents, with examples.
|
||||||
|
[Our documentation regarding the generation (serialization) of JSON documents is in a
|
||||||
- [The Basics](#the-basics)
|
separate document](https://github.com/simdjson/simdjson/blob/master/doc/builder.md).
|
||||||
- [Requirements](#requirements)
|
|
||||||
- [Including simdjson](#including-simdjson)
|
|
||||||
- [Using simdjson with package managers](#using-simdjson-with-package-managers)
|
|
||||||
- [Using simdjson as a CMake dependency](#using-simdjson-as-a-cmake-dependency)
|
|
||||||
- [Versions](#versions)
|
|
||||||
- [The basics: loading and parsing JSON documents](#the-basics-loading-and-parsing-json-documents)
|
|
||||||
- [Documents are iterators](#documents-are-iterators)
|
|
||||||
- [Parser, document and JSON scope](#parser-document-and-json-scope)
|
|
||||||
- [string_view](#string_view)
|
|
||||||
- [Avoiding pitfalls: enable development checks](#avoiding-pitfalls-enable-development-checks)
|
|
||||||
- [Using the parsed JSON](#using-the-parsed-json)
|
|
||||||
- [Using the parsed JSON: additional examples](#using-the-parsed-json-additional-examples)
|
|
||||||
- [Adding support for custom types](#adding-support-for-custom-types)
|
|
||||||
- [1. Specialize `simdjson::ondemand::value::get` to get custom types (pre-C++20)](#1-specialize-simdjsonondemandvalueget-to-get-custom-types-pre-c20)
|
|
||||||
- [2. Use `tag_invoke` for custom types (C++20)](#2-use-tag_invoke-for-custom-types-c20)
|
|
||||||
- [Minifying JSON strings without parsing](#minifying-json-strings-without-parsing)
|
|
||||||
- [UTF-8 validation (alone)](#utf-8-validation-alone)
|
|
||||||
- [JSON Pointer](#json-pointer)
|
|
||||||
- [JSONPath](#jsonpath)
|
|
||||||
- [Error handling](#error-handling)
|
|
||||||
- [Error handling examples without exceptions](#error-handling-examples-without-exceptions)
|
|
||||||
- [Disabling exceptions](#disabling-exceptions)
|
|
||||||
- [Exceptions](#exceptions)
|
|
||||||
- [Current location in document](#current-location-in-document)
|
|
||||||
- [Checking for trailing content](#checking-for-trailing-content)
|
|
||||||
- [Rewinding](#rewinding)
|
|
||||||
- [Newline-Delimited JSON (ndjson) and JSON lines](#newline-delimited-json-ndjson-and-json-lines)
|
|
||||||
- [Parsing numbers inside strings](#parsing-numbers-inside-strings)
|
|
||||||
- [Dynamic Number Types](#dynamic-number-types)
|
|
||||||
- [Raw strings from keys](#raw-strings-from-keys)
|
|
||||||
- [General direct access to the raw JSON string](#general-direct-access-to-the-raw-json-string)
|
|
||||||
- [Storing directly into an existing string instance](#storing-directly-into-an-existing-string-instance)
|
|
||||||
- [Thread safety](#thread-safety)
|
|
||||||
- [Standard compliance](#standard-compliance)
|
|
||||||
- [Backwards compatibility](#backwards-compatibility)
|
|
||||||
- [Examples](#examples)
|
|
||||||
- [Performance tips](#performance-tips)
|
|
||||||
- [Further reading](#further-reading)
|
|
||||||
|
|
||||||
|
- [Requirements](#requirements)
|
||||||
|
- [Including simdjson](#including-simdjson)
|
||||||
|
- [Using simdjson with package managers](#using-simdjson-with-package-managers)
|
||||||
|
- [Using simdjson as a CMake dependency](#using-simdjson-as-a-cmake-dependency)
|
||||||
|
- [Versions](#versions)
|
||||||
|
- [The basics: loading and parsing JSON documents](#the-basics-loading-and-parsing-json-documents)
|
||||||
|
- [Documents are iterators](#documents-are-iterators)
|
||||||
|
* [Parser, document and JSON scope](#parser-document-and-json-scope)
|
||||||
|
- [string_view](#string_view)
|
||||||
|
- [Avoiding pitfalls: enable development checks](#avoiding-pitfalls-enable-development-checks)
|
||||||
|
- [Using the parsed JSON](#using-the-parsed-json)
|
||||||
|
* [Using the parsed JSON: additional examples](#using-the-parsed-json-additional-examples)
|
||||||
|
- [Adding support for custom types](#adding-support-for-custom-types)
|
||||||
|
* [1. Specialize `simdjson::ondemand::value::get` to get custom types (pre-C++20)](#1-specialize-simdjsonondemandvalueget-to-get-custom-types-pre-c20)
|
||||||
|
* [2. Use `tag_invoke` for custom types (C++20)](#2-use-tag_invoke-for-custom-types-c20)
|
||||||
|
* [3. Using static reflection (C++26)](#3-using-static-reflection-c26)
|
||||||
|
* [The simdjson::from shortcut (experimental, C++20)](#the-simdjsonfrom-shortcut-experimental-c20)
|
||||||
|
- [Minifying JSON strings without parsing](#minifying-json-strings-without-parsing)
|
||||||
|
- [UTF-8 validation (alone)](#utf-8-validation-alone)
|
||||||
|
- [JSON Pointer](#json-pointer)
|
||||||
|
- [JSONPath](#jsonpath)
|
||||||
|
- [Error handling](#error-handling)
|
||||||
|
* [Error handling examples without exceptions](#error-handling-examples-without-exceptions)
|
||||||
|
* [Disabling exceptions](#disabling-exceptions)
|
||||||
|
* [Exceptions](#exceptions)
|
||||||
|
* [Current location in document](#current-location-in-document)
|
||||||
|
* [Checking for trailing content](#checking-for-trailing-content)
|
||||||
|
- [Rewinding](#rewinding)
|
||||||
|
- [Newline-Delimited JSON (ndjson) and JSON lines](#newline-delimited-json-ndjson-and-json-lines)
|
||||||
|
- [Parsing numbers inside strings](#parsing-numbers-inside-strings)
|
||||||
|
- [Dynamic Number Types](#dynamic-number-types)
|
||||||
|
- [Raw strings from keys](#raw-strings-from-keys)
|
||||||
|
- [General direct access to the raw JSON string](#general-direct-access-to-the-raw-json-string)
|
||||||
|
* [Raw JSON string for objects and arrays](#raw-json-string-for-objects-and-arrays)
|
||||||
|
- [Storing directly into an existing string instance](#storing-directly-into-an-existing-string-instance)
|
||||||
|
- [Thread safety](#thread-safety)
|
||||||
|
- [Standard compliance](#standard-compliance)
|
||||||
|
- [Backwards compatibility](#backwards-compatibility)
|
||||||
|
- [Examples](#examples)
|
||||||
|
- [Performance tips](#performance-tips)
|
||||||
|
- [Further reading](#further-reading)
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
- A recent compiler (LLVM clang 6 or better, GNU GCC 7.4 or better, Xcode 11 or better) on a 64-bit (PPC, ARM or x64 Intel/AMD) POSIX systems such as macOS, freeBSD or Linux. We require that the compiler supports the C++11 standard or better.
|
The simdjson library is widely deployed in popular systems such as the Node.js runtime
|
||||||
- Visual Studio 2017 or better under 64-bit Windows. Users should target a 64-bit build (x64 or ARM64) instead of a 32-bit build (x86). We support the LLVM clang compiler under Visual Studio (clangcl) as well as as the regular Visual Studio compiler. We also support MinGW 64-bit under Windows.
|
environment.
|
||||||
|
|
||||||
|
- A recent compiler (LLVM clang 6 or better, GNU GCC 7.4 or better, Xcode 11 or better) on POSIX systems such as macOS, FreeBSD or Linux. We require that the compiler supports the C++11 standard or better. We test the library on a big-endian system (IBM s390x with Linux).
|
||||||
|
- Visual Studio 2017 or better. We support the LLVM clang compiler under Visual Studio (clang-cl) as well as the regular Visual Studio compiler. For better release performance (both compile time and execution time), we recommend Visual Studio users adopt LLVM (clang-cl). We discourage using GCC under Windows: there [is a long-running bug with GCC under Windows](https://gcc.gnu.org/bugzilla/show_bug.cgi?id=54412).
|
||||||
|
|
||||||
Support for AVX-512 require a processor with AVX512-VBMI2 support (Ice Lake or better, AMD Zen 4 or better) under a 64-bit system and a recent compiler (LLVM clang 6 or better, GCC 8 or better, Visual Studio 2019 or better). You need a correspondingly recent assembler such as gas (2.30+) or nasm (2.14+): recent compilers usually come with recent assemblers. If you mix a recent compiler with an incompatible/old assembler (e.g., when using a recent compiler with an old Linux distribution), you may get errors at build time because the compiler produces instructions that the assembler does not recognize: you should update your assembler to match your compiler (e.g., upgrade binutils to version 2.30 or better under Linux) or use an older compiler matching the capabilities of your assembler.
|
Support for AVX-512 require a processor with AVX512-VBMI2 support (Ice Lake or better, AMD Zen 4 or better) under a 64-bit system and a recent compiler (LLVM clang 6 or better, GCC 8 or better, Visual Studio 2019 or better). You need a correspondingly recent assembler such as gas (2.30+) or nasm (2.14+): recent compilers usually come with recent assemblers. If you mix a recent compiler with an incompatible/old assembler (e.g., when using a recent compiler with an old Linux distribution), you may get errors at build time because the compiler produces instructions that the assembler does not recognize: you should update your assembler to match your compiler (e.g., upgrade binutils to version 2.30 or better under Linux) or use an older compiler matching the capabilities of your assembler.
|
||||||
|
|
||||||
We test the library on a big-endian system (IBM s390x with Linux).
|
|
||||||
|
|
||||||
Including simdjson
|
Including simdjson
|
||||||
------------------
|
------------------
|
||||||
@@ -73,14 +78,14 @@ c++ myproject.cpp simdjson.cpp
|
|||||||
```
|
```
|
||||||
|
|
||||||
Note:
|
Note:
|
||||||
- We recommend that you use simdjson by copying the single-header `simdjson.h` file along with the source file `simdjson.cpp` directly in your project, as they are part of [every release](https://github.com/simdjson/simdjson/releases) as assets. In this manner, you only have to compile `simdjson.cpp` as any other source file: it works well in every development environment. However, you may also use simdjson as a git submodule ([example](https://github.com/simdjson/cmakedemo)), using FetchContent ([example](https://github.com/simdjson/cmake_demo_single_file)), with ExternalProject_Add ([example](https://github.com/simdjson/cmakedemo_externalproject)) or with CPM ([example](https://github.com/cpm-cmake/CPM.cmake/tree/master/examples/simdjson)).
|
- We recommend that you use simdjson by copying the single-header `simdjson.h` file along with the source file `simdjson.cpp` directly into your project, as they are part of [every release](https://github.com/simdjson/simdjson/releases) as assets. In this manner, you only have to compile `simdjson.cpp` as any other source file: it works well in every development environment. However, you may also use simdjson as a git submodule ([example](https://github.com/simdjson/cmakedemo)), using FetchContent ([example](https://github.com/simdjson/cmake_demo_single_file)), with ExternalProject_Add ([example](https://github.com/simdjson/cmakedemo_externalproject)) or with CPM ([example](https://github.com/cpm-cmake/CPM.cmake/tree/master/examples/simdjson)).
|
||||||
- Users on macOS and other platforms where default compilers do not provide C++11 compliant by default should request it with the appropriate flag (e.g., `c++ -std=c++11 myproject.cpp simdjson.cpp`).
|
- Users on macOS and other platforms where default compilers do not provide C++11 compliant by default should request it with the appropriate flag (e.g., `c++ -std=c++11 myproject.cpp simdjson.cpp`).
|
||||||
- The library relies on [runtime CPU detection](implementation-selection.md): avoid specifying an architecture at compile time (e.g., `-march-native`) if you want your binaries to run everywhere.
|
- The library relies on [runtime CPU detection](implementation-selection.md): avoid specifying an architecture at compile time (e.g., `-march-native`) if you want your binaries to run everywhere.
|
||||||
|
|
||||||
Using simdjson with package managers
|
Using simdjson with package managers
|
||||||
------------------
|
------------------
|
||||||
|
|
||||||
You can install the simdjson library on your system or in your project using multiple package managers such as MSYS2, the conan package manager, vcpkg, brew, the apt package manager (debian-based Linux systems), the FreeBSD package manager (FreeBSD), and so on. E.g., [we provide an complete example with vcpkg](https://github.com/simdjson/simdjson-vcpkg) that works under Windows. [Visit our wiki for more details](https://github.com/simdjson/simdjson/wiki/Installing-simdjson-with-a-package-manager).
|
You can install the simdjson library on your system or in your project using multiple package managers such as MSYS2, the conan package manager, vcpkg, brew, the apt package manager (debian-based Linux systems), the FreeBSD package manager (FreeBSD), and so on. E.g., [we provide a complete example with vcpkg](https://github.com/simdjson/simdjson-vcpkg) that works under Windows. [Visit our wiki for more details](https://github.com/simdjson/simdjson/wiki/Installing-simdjson-with-a-package-manager).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -175,6 +180,18 @@ auto json = padded_string::load("twitter.json"); // load JSON file 'twitter.json
|
|||||||
ondemand::document doc = parser.iterate(json); // position a pointer at the beginning of the JSON data
|
ondemand::document doc = parser.iterate(json); // position a pointer at the beginning of the JSON data
|
||||||
```
|
```
|
||||||
|
|
||||||
|
If you prefer not to create your own `ondemand::parser` instance, you can access
|
||||||
|
a thread-local version by calling `ondemand::parser.get_parser()`.
|
||||||
|
|
||||||
|
|
||||||
|
```c++
|
||||||
|
ondemand::document doc = ondemand::parser.get_parser().iterate(json);
|
||||||
|
```
|
||||||
|
|
||||||
|
However, you should be careful because a parser instance can only be used for one
|
||||||
|
document at a time, thus it is only applicable when you are only parsing one
|
||||||
|
document per thread at any one time.
|
||||||
|
|
||||||
You can also create a padded string---and call `iterate()`:
|
You can also create a padded string---and call `iterate()`:
|
||||||
|
|
||||||
```c++
|
```c++
|
||||||
@@ -209,13 +226,31 @@ std::string data = "my data";
|
|||||||
simdjson::padded_string my_padded_data(data); // copies to a padded buffer
|
simdjson::padded_string my_padded_data(data); // copies to a padded buffer
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can then parse the JSON data from the `simdjson::padded_string` instance:
|
||||||
|
|
||||||
|
|
||||||
|
```c++
|
||||||
|
ondemand::document doc = parser.iterate(my_padded_data);
|
||||||
|
```
|
||||||
|
|
||||||
|
Whenever you pass an `std::string` reference to `parser::iterate`,
|
||||||
|
the parser will access the bytes beyond the end of
|
||||||
|
the string but before the end of the allocated memory (`std::string::capacity()`).
|
||||||
|
If you are using a sanitizer that checks for reading uninitialized bytes or `std::string`'s
|
||||||
|
container-overflow checks, you may encounter sanitizer warnings.
|
||||||
|
You can safely ignore these warnings. Or you can call `simdjson::pad(std::string&)` to pad the
|
||||||
|
string with `SIMDJSON_PADDING` spaces: this function returns a `simdjson::padding_string_view` which can be be passed to the parser's iterator function:
|
||||||
|
|
||||||
|
```c++
|
||||||
|
std::string json = "[1]";
|
||||||
|
ondemand::document doc = parser.iterate(simdjson::pad(json));
|
||||||
|
```
|
||||||
|
|
||||||
We recommend against creating many `std::string` or many `std::padding_string` instances in your application to store your JSON data.
|
We recommend against creating many `std::string` or many `std::padding_string` instances in your application to store your JSON data.
|
||||||
Consider reusing the same buffers and limiting memory allocations.
|
Consider reusing the same buffers and limiting memory allocations.
|
||||||
|
|
||||||
By default, the simdjson library throws exceptions (`simdjson_error`) on errors. We omit `try`-`catch` clauses from our illustrating examples: if you omit `try`-`catch` in your code, an uncaught exception will halt your program. It is also possible to use simdjson without generating exceptions, and you may even build the library without exception support at all. See [Error handling](#error-handling) for details.
|
By default, the simdjson library throws exceptions (`simdjson_error`) on errors. We omit `try`-`catch` clauses from our illustrating examples: if you omit `try`-`catch` in your code, an uncaught exception will halt your program. It is also possible to use simdjson without generating exceptions, and you may even build the library without exception support at all. See [Error handling](#error-handling) for details.
|
||||||
|
|
||||||
|
|
||||||
Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples:
|
Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples:
|
||||||
|
|
||||||
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/98Kx9Kqjn)
|
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/98Kx9Kqjn)
|
||||||
@@ -285,7 +320,7 @@ At the cost of some memory allocation, you may convert your `std::string_view` i
|
|||||||
For convenience, we also allow [storing an escaped string directly into an existing string instance](#storing-directly-into-an-existing-string-instance).
|
For convenience, we also allow [storing an escaped string directly into an existing string instance](#storing-directly-into-an-existing-string-instance).
|
||||||
|
|
||||||
The `std::string_view` class has become standard as part of C++17 but it is not always available
|
The `std::string_view` class has become standard as part of C++17 but it is not always available
|
||||||
on compilers which only supports C++11. When we detect that `string_view` is natively
|
on compilers that only supports C++11. When we detect that `string_view` is natively
|
||||||
available, we define the macro `SIMDJSON_HAS_STRING_VIEW`.
|
available, we define the macro `SIMDJSON_HAS_STRING_VIEW`.
|
||||||
|
|
||||||
When we detect that it is unavailable,
|
When we detect that it is unavailable,
|
||||||
@@ -301,13 +336,15 @@ transcode the UTF-8 strings produced by the simdjson library to other formats. S
|
|||||||
Avoiding pitfalls: enable development checks
|
Avoiding pitfalls: enable development checks
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
We recommend that you first compile and run your code in Debug mode:
|
We recommend that you first compile and run your code in debug mode:
|
||||||
|
|
||||||
- under Visual Studio, it means having the `_DEBUG` macro defined,
|
- under Visual Studio, it means having the `_DEBUG` macro defined,
|
||||||
- for other compilers, it means leaving the `__OPTIMIZE__` macro undefined.
|
- for many other compilers, it means leaving the `__OPTIMIZE__` macro undefined.
|
||||||
|
|
||||||
The simdjson code will set `SIMDJSON_DEVELOPMENT_CHECKS=1` in debug mode.
|
The simdjson code will set `SIMDJSON_DEVELOPMENT_CHECKS=1` in debug mode. Because
|
||||||
Alternatively, you can set the macro `SIMDJSON_DEVELOPMENT_CHECKS` to 1 prior to including
|
the C++ standard does not provide a direct way of checking for a debug build, and
|
||||||
|
because you may want the checks while building with optimizations, you can set
|
||||||
|
the macro `SIMDJSON_DEVELOPMENT_CHECKS` to 1 prior to including
|
||||||
the `simdjson.h` header to enable these additional checks: just make sure you remove the
|
the `simdjson.h` header to enable these additional checks: just make sure you remove the
|
||||||
definition once your code has been tested. When `SIMDJSON_DEVELOPMENT_CHECKS` is set to 1, the
|
definition once your code has been tested. When `SIMDJSON_DEVELOPMENT_CHECKS` is set to 1, the
|
||||||
simdjson library runs additional (expensive) tests on your code to help ensure that you are
|
simdjson library runs additional (expensive) tests on your code to help ensure that you are
|
||||||
@@ -316,9 +353,12 @@ using the library in a safe manner.
|
|||||||
Once your code has been tested, you can then run it in
|
Once your code has been tested, you can then run it in
|
||||||
Release mode: under Visual Studio, it means having the `_DEBUG` macro undefined, and, for other
|
Release mode: under Visual Studio, it means having the `_DEBUG` macro undefined, and, for other
|
||||||
compilers, it means setting `__OPTIMIZE__` to a positive integer. You can also forcefully
|
compilers, it means setting `__OPTIMIZE__` to a positive integer. You can also forcefully
|
||||||
disable these checks by setting `SIMDJSON_DEVELOPMENT_CHECKS` to 0. Once your code is tested, we
|
disable these checks by setting `SIMDJSON_DEVELOPMENT_CHECKS` to 0.
|
||||||
further encourage you to define `NDEBUG` in your Release builds to disable additional runtime
|
|
||||||
testing and get the best performance.
|
Once your code is tested, we further encourage you to define `NDEBUG` in your release
|
||||||
|
builds to disable additional runtime testing and get the best performance. We
|
||||||
|
disable these checks on a best-effort basis but the C++ standard does not provide
|
||||||
|
a direct way to check for a release build.
|
||||||
|
|
||||||
Using the parsed JSON
|
Using the parsed JSON
|
||||||
---------------------
|
---------------------
|
||||||
@@ -331,9 +371,8 @@ and arrays (`simdjson::ondemand::array`).
|
|||||||
We also have a generic ephemeral type (`simdjson::ondemand::value`) which represents a potential
|
We also have a generic ephemeral type (`simdjson::ondemand::value`) which represents a potential
|
||||||
array or object, or scalar type (`double`, `uint64_t`, `int64_t`, `bool`, `null`, string) inside
|
array or object, or scalar type (`double`, `uint64_t`, `int64_t`, `bool`, `null`, string) inside
|
||||||
an array or an object. Both generic types (`simdjson::ondemand::document` and
|
an array or an object. Both generic types (`simdjson::ondemand::document` and
|
||||||
`simdjson::ondemand::value`) have a `type()` method returning a `json_type` value describing the
|
`simdjson::ondemand::value`) have a `type()` method returning a `json_type` value describing indicating the type (`json_type::array`, `json_type::object`, `json_type::number`, `json_type::string`,
|
||||||
value (`json_type::array`, `json_type::object`, `json_type::number`, `json_type::string`,
|
`json_type::boolean`, `json_type::null`, and `json_type::unknown` for unrecognized types). The `type()` method does not consume nor validate the value: e.g., you must still call `is_null()` to check that the value is a `null` even if `json_type::null` is returned. Starting with simdjson 4.0, we return `json_type::unknown` for bad tokens such as the `NaN` token in `{"key":NaN}`. A `json_type::unknown` type value indicates an error in the JSON document but you might still be able to proceed, see [General direct access to the raw JSON string](#general-direct-access-to-the-raw-json-string). A generic value (`simdjson::ondemand::value`)
|
||||||
`json_type::boolean`, `json_type::null`). A generic value (`simdjson::ondemand::value`)
|
|
||||||
is only valid temporarily, as soon as you access other values, other keys in objects, etc.
|
is only valid temporarily, as soon as you access other values, other keys in objects, etc.
|
||||||
it becomes invalid: you should therefore consume the value immediately by converting it to a
|
it becomes invalid: you should therefore consume the value immediately by converting it to a
|
||||||
scalar type, an array or an object.
|
scalar type, an array or an object.
|
||||||
@@ -366,7 +405,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
|||||||
ondemand::object and ondemand::array. We also have explicit methods such as `get_string()`, `get_double()`,
|
ondemand::object and ondemand::array. We also have explicit methods such as `get_string()`, `get_double()`,
|
||||||
`get_uint64()`, `get_int64()`, `get_bool()`, `get_object()` and `get_array()`. After a cast or an explicit method,
|
`get_uint64()`, `get_int64()`, `get_bool()`, `get_object()` and `get_array()`. After a cast or an explicit method,
|
||||||
the number, string or boolean will be parsed, or the initial `{` or `[` will be verified for `ondemand::object` and `ondemand::array`. An exception may be thrown if
|
the number, string or boolean will be parsed, or the initial `{` or `[` will be verified for `ondemand::object` and `ondemand::array`. An exception may be thrown if
|
||||||
the cast is not possible: there error code is `simdjson::INCORRECT_TYPE` (see [Error handling](#error-handling)). Importantly, when getting an ondemand::object or ondemand::array instance, its content is
|
the cast is not possible: the error code is `simdjson::INCORRECT_TYPE` (see [Error handling](#error-handling)). Importantly, when getting an ondemand::object or ondemand::array instance, its content is
|
||||||
not validated: you are only guaranteed that the corresponding initial character (`{` or `[`) is present. Thus,
|
not validated: you are only guaranteed that the corresponding initial character (`{` or `[`) is present. Thus,
|
||||||
for example, you could have an ondemand::object instance pointing at the invalid JSON `{ "this is not a valid object" }`: the validation occurs as you access the content.
|
for example, you could have an ondemand::object instance pointing at the invalid JSON `{ "this is not a valid object" }`: the validation occurs as you access the content.
|
||||||
The `get_string()` returns a valid UTF-8 string, after
|
The `get_string()` returns a valid UTF-8 string, after
|
||||||
@@ -403,13 +442,17 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
|||||||
of the object: to warn you, an OUT_OF_ORDER_ITERATION error is generated [when development checks](#avoiding-pitfalls-enable-development-checks) are active. If you need to access an object more
|
of the object: to warn you, an OUT_OF_ORDER_ITERATION error is generated [when development checks](#avoiding-pitfalls-enable-development-checks) are active. If you need to access an object more
|
||||||
than once, you may call `reset()` on it although we discourage this practice. Keep in mind that
|
than once, you may call `reset()` on it although we discourage this practice. Keep in mind that
|
||||||
you should consume each value at most once.
|
you should consume each value at most once.
|
||||||
|
|
||||||
|
When you are iterating through an object, you are advancing through its keys and values. You should not also access the object or other objects. E.g. within a loop over `myobject`, you should not be accessing `myobject`. The following is an anti-pattern: `for(auto value: myobject) {myobject["mykey"]}`.
|
||||||
|
|
||||||
|
You should never reset an object as you are iterating through it. The following is an anti-pattern: `for(auto value: myobject) {myobject.reset()}`.
|
||||||
* **Array Index:** Because it is forward-only, you cannot look up an array element by index by index. Instead,
|
* **Array Index:** Because it is forward-only, you cannot look up an array element by index by index. Instead,
|
||||||
you should iterate through the array and keep an index yourself. Exceptionally, if need a single value
|
you should iterate through the array and keep an index yourself. Exceptionally, if need a single value
|
||||||
out of the array, you may use an array access (e.g., `array[1]`).
|
out of the array, you may use an array access (e.g., `array[1]`). You should never reset an array as you are iterating through it. The following is an anti-pattern: `for(auto value: myarray) {myarray.reset()}`.
|
||||||
* **Field Access:** To get the value of the "foo" field in an object, use `object["foo"]`. This will
|
* **Field Access:** To get the value of the "foo" field in an object, use `object["foo"]`. This will
|
||||||
scan through the object looking for the field with the matching string, doing a character-by-character
|
scan through the object looking for the field with the matching string, doing a character-by-character
|
||||||
comparison. It may generate the error `simdjson::NO_SUCH_FIELD` if there is no such key in the object, it may throw an exception (see [Error handling](#error-handling)). For efficiency reason, you should avoid looking up the same field repeatedly: e.g., do
|
comparison. It may generate the error `simdjson::NO_SUCH_FIELD` if there is no such key in the object, it may throw an exception (see [Error handling](#error-handling)). For efficiency reason, you should avoid looking up the same field repeatedly: e.g., do
|
||||||
not do `object["foo"]` followed by `object["foo"]` with the same `object` instance. For best performance, you should try to query the keys in the same order they appear in the document. If you need several keys and you cannot predict the order they will appear in, it is recommended to iterate through all keys `for(auto field : object) {...}`. Generally, you should not mix and match iterating through an object (`for(auto field : object) {...}`) and key accesses (`object["foo"]`): if you need to iterate through an object after a key access, you need to call `reset()` on the object. Whenever you call `reset()`, you need to keep in mind that though you can iterate over the array repeatedly, values should be consumedonly once (e.g., repeatedly calling `unescaped_key()` on the same key is forbidden). Keep in mind that On-Demand does not buffer or save the result of the parsing: if you repeatedly access `object["foo"]`, then it must repeatedly seek the key and parse the content. The library does not provide a distinct function to check if a key is present, instead we recommend you attempt to access the key: e.g., by doing `ondemand::value val{}; if (!object["foo"].get(val)) {...}`, you have that `val` contains the requested value inside the if clause. It is your responsibility as a user to temporarily keep a reference to the value (`auto v = object["foo"]`), or to consume the content and store it in your own data structures. If you consume an
|
not do `object["foo"]` followed by `object["foo"]` with the same `object` instance. Generally, you should not mix and match iterating through an object (`for(auto field : object) {...}`) and key accesses (`object["foo"]`): if you need to iterate through an object after a key access, you need to call `reset()` on the object. Whenever you call `reset()`, you need to keep in mind that though you can iterate over the array repeatedly, values should be consumedonly once (e.g., repeatedly calling `unescaped_key()` on the same key is forbidden). Keep in mind that On-Demand does not buffer or save the result of the parsing: if you repeatedly access `object["foo"]`, then it must repeatedly seek the key and parse the content. The library does not provide a distinct function to check if a key is present, instead we recommend you attempt to access the key: e.g., by doing `ondemand::value val{}; if (!object["foo"].get(val)) {...}`, you have that `val` contains the requested value inside the if clause. It is your responsibility as a user to temporarily keep a reference to the value (`auto v = object["foo"]`), or to consume the content and store it in your own data structures. If you consume an
|
||||||
object twice: `std::string_view(object["foo"]` followed by `std::string_view(object["foo"]` then your code
|
object twice: `std::string_view(object["foo"]` followed by `std::string_view(object["foo"]` then your code
|
||||||
is in error. Furthermore, you can only consume one field at a time, on the same object. The
|
is in error. Furthermore, you can only consume one field at a time, on the same object. The
|
||||||
value instance you get from `content["bids"]` becomes invalid when you call `content["asks"]`.
|
value instance you get from `content["bids"]` becomes invalid when you call `content["asks"]`.
|
||||||
@@ -472,7 +515,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
|||||||
> double y = doc["y"]; // The cursor is now after the 2 (at })
|
> double y = doc["y"]; // The cursor is now after the 2 (at })
|
||||||
> double x = doc["x"]; // Success: [] loops back around to find "x"
|
> double x = doc["x"]; // Success: [] loops back around to find "x"
|
||||||
> ```
|
> ```
|
||||||
* **Output to strings:** Given a document, a value, an array or an object in a JSON document, you can output a JSON string version suitable to be parsed again as JSON content: `simdjson::to_json_string(element)`. A call to `to_json_string` consumes fully the element: if you apply it on a document, the JSON pointer is advanced to the end of the document. The `simdjson::to_json_string` does not allocate memory. The `to_json_string` function should not be confused with retrieving the value of a string instance which are escaped and represented using a lightweight `std::string_view` instance pointing at an internal string buffer inside the parser instance. To illustrate, the first of the following two code segments will print the unescaped string `"test"` complete with the quote whereas the second one will print the escaped content of the string (without the quotes).
|
* **Output to strings:** Given a document, a value, an array or an object in a JSON document, you can output a JSON string version suitable to be parsed again as JSON content: `simdjson::to_json_string(element)`. A call to `to_json_string` consumes fully the element: if you apply it on a document, the internal pointer is advanced to the end of the document. The `simdjson::to_json_string` does not allocate memory. The `to_json_string` function should not be confused with retrieving the value of a string instance which are escaped and represented using a lightweight `std::string_view` instance pointing at an internal string buffer inside the parser instance. To illustrate, the first of the following two code segments will print the unescaped string `"test"` complete with the quote whereas the second one will print the escaped content of the string (without the quotes).
|
||||||
> ```C++
|
> ```C++
|
||||||
> // serialize a JSON to an escaped std::string instance so that it can be parsed again as JSON
|
> // serialize a JSON to an escaped std::string instance so that it can be parsed again as JSON
|
||||||
> auto silly_json = R"( { "test": "result" } )"_padded;
|
> auto silly_json = R"( { "test": "result" } )"_padded;
|
||||||
@@ -538,7 +581,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
|||||||
For this purpose, `array` instances have a `count_elements` method. Users should be
|
For this purpose, `array` instances have a `count_elements` method. Users should be
|
||||||
aware that the `count_elements` method can be costly since it requires scanning the
|
aware that the `count_elements` method can be costly since it requires scanning the
|
||||||
whole array. You should only call `count_elements` as a last resort as it may
|
whole array. You should only call `count_elements` as a last resort as it may
|
||||||
require scanning the document twice or more. You may use it as follows if your document is itself an array:
|
require scanning the document twice or more. You should never use the `count_elements` as part of an attempt to iterate through the array: use a `for` loop to iterate through arrays. In the spirit of On-Demand, the `count_elements` function does not validate the values in the array: they are validated when they are consumed. You may use it as follows if your document is itself an array:
|
||||||
|
|
||||||
```C++
|
```C++
|
||||||
auto cars_json = R"( [ 40.1, 39.9, 37.7, 40.4 ] )"_padded;
|
auto cars_json = R"( [ 40.1, 39.9, 37.7, 40.4 ] )"_padded;
|
||||||
@@ -655,6 +698,9 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
|||||||
cout << "null";
|
cout << "null";
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
|
case ondemand::json_type::unknown:
|
||||||
|
cout << "unknown"; // indicates an error
|
||||||
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
void basics_treewalk() {
|
void basics_treewalk() {
|
||||||
@@ -790,15 +836,17 @@ for (ondemand::object points : parser.iterate(points_json)) {
|
|||||||
Adding support for custom types
|
Adding support for custom types
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
There are 2 main ways provided by simdjson to deserialize a value into a custom type:
|
There are 3 main ways provided by simdjson to deserialize a value into a custom type:
|
||||||
|
|
||||||
1. Provide a [**template specialization** for member functions](https://en.cppreference.com/w/cpp/language/template_specialization#Members_of_specializations)
|
1. Provide a [**template specialization** for member functions](https://en.cppreference.com/w/cpp/language/template_specialization#Members_of_specializations)
|
||||||
1. Specialize `simdjson::ondemand::document::get` for the whole document
|
1. Specialize `simdjson::ondemand::document::get` for the whole document
|
||||||
2. Specialize `simdjson::ondemand::value::get` for each value
|
2. Specialize `simdjson::ondemand::value::get` for each value
|
||||||
2. Using `tag_invoke` *(the recommended way if your system supports C++20 or better)*
|
2. Using `tag_invoke` *(the recommended way if your system supports C++20 or better)*
|
||||||
|
3. Using static reflection (requires C++26 or better)
|
||||||
|
|
||||||
We describe both of them in the following sections. Most users who have systems compatible with
|
We describe all of them in the following sections. Most users who have systems compatible with
|
||||||
C++20 or better should skip ahead to [using `tag_invoke` for custom types (C++20)](#2-use-tag_invoke-for-custom-types-c20) as it is more powerful and simpler.
|
C++20 or better should skip ahead to [using `tag_invoke` for custom types (C++20)](#2-use-tag_invoke-for-custom-types-c20) as it is more powerful and simpler.
|
||||||
|
The C++26 approach is even simpler.
|
||||||
|
|
||||||
### 1. Specialize `simdjson::ondemand::value::get` to get custom types (pre-C++20)
|
### 1. Specialize `simdjson::ondemand::value::get` to get custom types (pre-C++20)
|
||||||
|
|
||||||
@@ -836,13 +884,13 @@ type:
|
|||||||
|
|
||||||
We may do so by providing additional template definitions to the `ondemand::value` type.
|
We may do so by providing additional template definitions to the `ondemand::value` type.
|
||||||
We may start by providing a definition for `std::vector<double>` as follows. Observe
|
We may start by providing a definition for `std::vector<double>` as follows. Observe
|
||||||
how we guard the code with `#if !SIMDJSON_SUPPORTS_DESERIALIZATION`: that is because the necessary code
|
how we guard the code with `#if !SIMDJSON_SUPPORTS_CONCEPTS`: that is because the necessary code
|
||||||
is automatically provided by simdjson if C++20 (and concepts) are available.
|
is automatically provided by simdjson if C++20 (and concepts) are available.
|
||||||
See [Use `tag_invoke` for custom types](#2-use-tag_invoke-for-custom-types-c20) if you have
|
See [Use `tag_invoke` for custom types](#2-use-tag_invoke-for-custom-types-c20) if you have
|
||||||
C++20 support.
|
C++20 support.
|
||||||
|
|
||||||
```c++
|
```c++
|
||||||
#if !SIMDJSON_SUPPORTS_DESERIALIZATION
|
#if !SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
// The code is unnecessary with C++20:
|
// The code is unnecessary with C++20:
|
||||||
template <>
|
template <>
|
||||||
simdjson_inline simdjson_result<std::vector<double>>
|
simdjson_inline simdjson_result<std::vector<double>>
|
||||||
@@ -898,7 +946,7 @@ struct Car {
|
|||||||
std::vector<double> tire_pressure;
|
std::vector<double> tire_pressure;
|
||||||
};
|
};
|
||||||
|
|
||||||
#if !SIMDJSON_SUPPORTS_DESERIALIZATION
|
#if !SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
// This code is not necessary if you have a C++20 compliant system:
|
// This code is not necessary if you have a C++20 compliant system:
|
||||||
template <>
|
template <>
|
||||||
simdjson_inline simdjson_result<std::vector<double>>
|
simdjson_inline simdjson_result<std::vector<double>>
|
||||||
@@ -999,7 +1047,7 @@ struct Car {
|
|||||||
std::vector<double> tire_pressure;
|
std::vector<double> tire_pressure;
|
||||||
};
|
};
|
||||||
|
|
||||||
#if !SIMDJSON_SUPPORTS_DESERIALIZATION
|
#if !SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
// This code is not necessary if you have a C++20 compliant system:
|
// This code is not necessary if you have a C++20 compliant system:
|
||||||
template <>
|
template <>
|
||||||
simdjson_inline simdjson_result<std::vector<double>>
|
simdjson_inline simdjson_result<std::vector<double>>
|
||||||
@@ -1058,6 +1106,32 @@ int main(void) {
|
|||||||
|
|
||||||
### 2. Use `tag_invoke` for custom types (C++20)
|
### 2. Use `tag_invoke` for custom types (C++20)
|
||||||
|
|
||||||
|
The simdjson library takes advantage of C++20. An immediate benefit
|
||||||
|
is that you can deserialize JSON data directly in standard containers
|
||||||
|
and other standard value types:
|
||||||
|
|
||||||
|
```C++
|
||||||
|
simdjson::padded_string json = R"({"data" : [1,2,3,4]})"_padded;
|
||||||
|
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document d = parser.iterate(json);
|
||||||
|
std::vector<uint8_t> array = d["data"].get<std::vector<uint8_t>>();
|
||||||
|
```
|
||||||
|
|
||||||
|
Appending to an existing container is just as easy:
|
||||||
|
|
||||||
|
```C++
|
||||||
|
std::vector<uint32_t> array = {0, 0};
|
||||||
|
|
||||||
|
simdjson::padded_string json = R"({"data" : [1,2,3,4]})"_padded;
|
||||||
|
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document d = parser.iterate(json);
|
||||||
|
|
||||||
|
d["data"].get<std::vector<uint32_t>>(array);
|
||||||
|
// array is now {0,0,1,2,3,4}
|
||||||
|
```
|
||||||
|
|
||||||
In C++20, the standard introduced the notion of *customization point*.
|
In C++20, the standard introduced the notion of *customization point*.
|
||||||
A customization point is a function or function object that can be customized for different types. It allows library authors to provide default behavior while giving users the ability to override this behavior for specific types.
|
A customization point is a function or function object that can be customized for different types. It allows library authors to provide default behavior while giving users the ability to override this behavior for specific types.
|
||||||
|
|
||||||
@@ -1068,7 +1142,7 @@ The first argument is usually a tag type (often an empty struct) that uniquely i
|
|||||||
|
|
||||||
If your system supports C++20, we recommend that you adopt the `tag_invoke` approach
|
If your system supports C++20, we recommend that you adopt the `tag_invoke` approach
|
||||||
instead to deserialize custom types. It may prove to be considerably simpler. When
|
instead to deserialize custom types. It may prove to be considerably simpler. When
|
||||||
simdjson detects the necessary support, it sets the `SIMDJSON_SUPPORTS_DESERIALIZATION` macro
|
simdjson detects the necessary support, it sets the `SIMDJSON_SUPPORTS_CONCEPTS` macro
|
||||||
to 1, otherwise it is set to 0.
|
to 1, otherwise it is set to 0.
|
||||||
|
|
||||||
Consider a custom class `Car`:
|
Consider a custom class `Car`:
|
||||||
@@ -1082,7 +1156,7 @@ struct Car {
|
|||||||
};
|
};
|
||||||
```
|
```
|
||||||
|
|
||||||
Observe how we defined the class to use types that simdjson does not directly support (`float`, `int`).
|
Observe how we define the class to use types that simdjson does not directly support (`float`, `int`).
|
||||||
With C++20 support, the library grabs from the JSON the generic type (`double`, `int`) and then it
|
With C++20 support, the library grabs from the JSON the generic type (`double`, `int`) and then it
|
||||||
casts it automatically.
|
casts it automatically.
|
||||||
|
|
||||||
@@ -1220,7 +1294,6 @@ int main() {
|
|||||||
You may also conditionally fill in `std::optional` values.
|
You may also conditionally fill in `std::optional` values.
|
||||||
|
|
||||||
```C++
|
```C++
|
||||||
|
|
||||||
padded_string json =
|
padded_string json =
|
||||||
R"( { "car1": { "make": "Toyota", "model": "Camry", "year": 2018,
|
R"( { "car1": { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||||
"tire_pressure": [ 40.1, 39.9 ] }
|
"tire_pressure": [ 40.1, 39.9 ] }
|
||||||
@@ -1235,6 +1308,23 @@ You may also conditionally fill in `std::optional` values.
|
|||||||
// error is simdjson::SUCCESS
|
// error is simdjson::SUCCESS
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can also deserialize to map-like types with keys that can be constructed
|
||||||
|
from `std::string_view` instances:
|
||||||
|
|
||||||
|
|
||||||
|
```C++
|
||||||
|
padded_string json =
|
||||||
|
R"( { "car1": { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||||
|
"tire_pressure": [ 40.1, 39.9 ] }
|
||||||
|
})"_padded;
|
||||||
|
ondemand::parser parser;
|
||||||
|
ondemand::document doc = parser.iterate(json);
|
||||||
|
std::map<std::string,Car> cars;
|
||||||
|
error = doc.get<std::map<std::string,Car>>().get(cars);
|
||||||
|
// car has value car1->Car{"Toyota", "Camry", 2018, {40.1f, 39.9f}}
|
||||||
|
// error is simdjson::SUCCESS
|
||||||
|
```
|
||||||
|
|
||||||
And so forth.
|
And so forth.
|
||||||
|
|
||||||
Advanced users may want to overwrite the defaults provided by the simdjson library.
|
Advanced users may want to overwrite the defaults provided by the simdjson library.
|
||||||
@@ -1270,6 +1360,142 @@ With this code, deserializing an `std::list<Car>` instance would capture only th
|
|||||||
that are not made by Toyota.
|
that are not made by Toyota.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 3. Using static reflection (C++26)
|
||||||
|
|
||||||
|
If you have a C++26 compatible compiler, you can compile
|
||||||
|
your code with the `SIMDJSON_STATIC_REFLECTION` macro set:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#define SIMDJSON_STATIC_REFLECTION 1
|
||||||
|
//...
|
||||||
|
#include "simdjson.h"
|
||||||
|
```
|
||||||
|
|
||||||
|
Then you can deserialize a type such as `Car` automatically:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```C++
|
||||||
|
struct Car {
|
||||||
|
std::string make;
|
||||||
|
std::string model;
|
||||||
|
int year;
|
||||||
|
std::vector<float> tire_pressure;
|
||||||
|
};
|
||||||
|
|
||||||
|
std::string json = R"( { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||||
|
"tire_pressure": [ 40.1, 39.9 ] } )";
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc = parser.iterate(simdjson::pad(json));
|
||||||
|
Car c = doc.get<Car>();
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
We try to automate the parsing of any given structure or class
|
||||||
|
by looking at its non-static public members. At compile-time,
|
||||||
|
the library looks at a simple structre like `Car` and
|
||||||
|
maps it to parsing code. We call the default constructor,
|
||||||
|
and then assign values to the public members.
|
||||||
|
|
||||||
|
|
||||||
|
#### Special cases
|
||||||
|
|
||||||
|
However, there are instances where the construction cannot
|
||||||
|
be easily automated. Let us consider a class without any
|
||||||
|
public member.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
|
||||||
|
class MyDate {
|
||||||
|
public:
|
||||||
|
void assign(std::string_view str) {
|
||||||
|
date_str = str;
|
||||||
|
}
|
||||||
|
const std::string& to_string() const {
|
||||||
|
return date_str;
|
||||||
|
}
|
||||||
|
private:
|
||||||
|
std::string date_str;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
This class has a default constructor, but it must be initialized
|
||||||
|
with the `assign` method. We need to help the library with
|
||||||
|
a `tag_invoke` function (just as in the C++20 case).
|
||||||
|
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
namespace simdjson {
|
||||||
|
template <typename simdjson_value>
|
||||||
|
auto tag_invoke(deserialize_tag, simdjson_value &val, MyDate& date) {
|
||||||
|
std::string_view str;
|
||||||
|
auto error = val.get_string().get(str);
|
||||||
|
if(error) { return error; }
|
||||||
|
date.assign(str);
|
||||||
|
return simdjson::SUCCESS;
|
||||||
|
}
|
||||||
|
} // namespace simdjson
|
||||||
|
```
|
||||||
|
|
||||||
|
Once this is done, we can now automatically parse a custom type
|
||||||
|
like `complicated_weather_data` containing `MyDate` values.
|
||||||
|
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
struct complicated_weather_data {
|
||||||
|
std::vector<MyDate> time;
|
||||||
|
std::vector<float> temperature;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
The code might as simple as the following.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
auto padded = R"({"time":["2023-03-15T12:00:00Z"],"temperature":[42]})"_padded;
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc = parser.iterate(padded);
|
||||||
|
complicated_weather_data p = doc.get<>(complicated_weather_data);
|
||||||
|
```
|
||||||
|
|
||||||
|
Thus you can combine C++26 static reflection with custom deserialization
|
||||||
|
functions.
|
||||||
|
|
||||||
|
You can also automatically serialize the `Car` instance to a JSON string, see
|
||||||
|
our [Builder documentation](builder.md).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### The simdjson::from shortcut (experimental, C++20)
|
||||||
|
|
||||||
|
|
||||||
|
For even more convenience, you can parse a JSON document directly to a supported
|
||||||
|
type without a document instance like so:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
Car car = simdjson::from(json);
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also use the `simdjson::from` syntax to iterate over an array.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
for(auto val : simdjson::from(json).array()) {
|
||||||
|
Car c = val.get<Car>(); // ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Standard STL types are supported:
|
||||||
|
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
std::map<std::string, std::string> obj =
|
||||||
|
simdjson::from(R"({"key": "value"})"_padded);
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
The `simdjson::from` construction is EXPERIMENTAL and subject to changes.
|
||||||
|
|
||||||
Minifying JSON strings without parsing
|
Minifying JSON strings without parsing
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
@@ -1311,9 +1537,9 @@ If you find yourself needing only fast Unicode functions, consider using the sim
|
|||||||
JSON Pointer
|
JSON Pointer
|
||||||
------------
|
------------
|
||||||
|
|
||||||
The simdjson library also supports [JSON pointer](https://tools.ietf.org/html/rfc6901) through the `at_pointer()` method, letting you reach further down into the document in a single call. JSON pointer is supported by both the [DOM approach](https://github.com/simdjson/simdjson/blob/master/doc/dom.md#json-pointer) as well as the On-Demand approach.
|
The simdjson library also supports [JSON pointer](https://tools.ietf.org/html/rfc6901) through the `at_pointer()` method, letting you reach further down into the document in a single call. JSON Pointer is supported by both the [DOM approach](https://github.com/simdjson/simdjson/blob/master/doc/dom.md#json-pointer) as well as the On-Demand approach.
|
||||||
|
|
||||||
**Note:** The On-Demand implementation of JSON pointer relies on `find_field` which implies that it does not unescape keys when matching.
|
**Note:** The On-Demand implementation of JSON Pointer relies on `find_field` which implies that it does not unescape keys when matching.
|
||||||
|
|
||||||
Consider the following example:
|
Consider the following example:
|
||||||
|
|
||||||
@@ -1333,7 +1559,7 @@ index allows you to select the indexed node. Within objects, the string value of
|
|||||||
select the value. If your keys contain the characters '/' or '~', they must be escaped as '~1' and
|
select the value. If your keys contain the characters '/' or '~', they must be escaped as '~1' and
|
||||||
'~0' respectively. An empty JSON Pointer Path refers to the whole document.
|
'~0' respectively. An empty JSON Pointer Path refers to the whole document.
|
||||||
|
|
||||||
For multiple JSON pointer queries on a document, one can call `at_pointer` multiple times.
|
For multiple JSON Pointer queries on a document, one can call `at_pointer` multiple times.
|
||||||
|
|
||||||
```c++
|
```c++
|
||||||
auto cars_json = R"( [
|
auto cars_json = R"( [
|
||||||
@@ -1488,7 +1714,7 @@ x = obj.at_path("$.d.foo2.a.2"); // 30
|
|||||||
Error handling
|
Error handling
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
Error handing with exception and a single try/catch clause makes the code simple, but it gives you little control over errors. For easier debugging or more robust error handling, you may want to consider our exception-free approach.
|
Error handling with exception and a single try/catch clause makes the code simple, but it gives you little control over errors. For easier debugging or more robust error handling, you may want to consider our exception-free approach.
|
||||||
|
|
||||||
The entire simdjson API is usable with and without exceptions. All simdjson APIs that can fail return `simdjson_result<T>`, which is a <value, error_code>
|
The entire simdjson API is usable with and without exceptions. All simdjson APIs that can fail return `simdjson_result<T>`, which is a <value, error_code>
|
||||||
pair. You can retrieve the value with .get() without generating an exception, like so:
|
pair. You can retrieve the value with .get() without generating an exception, like so:
|
||||||
@@ -1508,7 +1734,20 @@ Some errors are recoverable:
|
|||||||
* You may get the error `simdjson::INCORRECT_TYPE` after trying to convert a value to an incorrect type: e.g., you expected a number and try to convert the value to a number, but it is an array.
|
* You may get the error `simdjson::INCORRECT_TYPE` after trying to convert a value to an incorrect type: e.g., you expected a number and try to convert the value to a number, but it is an array.
|
||||||
* You may query a key from an object, but the key is missing in which case you get the error `simdjson::NO_SUCH_FIELD`: e.g., you call `obj["myname"]` and the object does not have a key `"myname"`.
|
* You may query a key from an object, but the key is missing in which case you get the error `simdjson::NO_SUCH_FIELD`: e.g., you call `obj["myname"]` and the object does not have a key `"myname"`.
|
||||||
|
|
||||||
Other errors (e.g., `simdjson::INCOMPLETE_ARRAY_OR_OBJECT`) may indicate a fatal error and often follow from the fact that the document is not valid JSON. In which case, it is no longer possible to continue accessing the document: calling the method `is_alive()` on the document instance returns false. All following accesses will keep returning the same fatal error (e.g., `simdjson::INCOMPLETE_ARRAY_OR_OBJECT`).
|
Other errors (`simdjson::INCOMPLETE_ARRAY_OR_OBJECT` and `simdjson::TAPE_ERROR`) indicate a fatal error and follow from the fact that the document is not valid JSON. These errors are not recoverable: you cannot continue. In which case, it is no longer safe to continue accessing the document: calling the method `is_alive()` on the document instance returns false. It is your responsibility as a user to stop using the simdjson
|
||||||
|
document after encountering these fatal errors. Consider the following example, after
|
||||||
|
the fatal error, the document instance cannot be used. Observe how the JSON input is invalid.
|
||||||
|
```cpp
|
||||||
|
simdjson::padded_string badjson = R"( { "make": "Toyota", "model": "Camry", "year"})"_padded;
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc;
|
||||||
|
auto errordoc = parser.iterate(badjson).get(doc);
|
||||||
|
// errordoc == simdjson::SUCCESS
|
||||||
|
simdjson::ondemand::value v;
|
||||||
|
auto error = doc.get_object()["year"].get(v);
|
||||||
|
// simdjson::is_fatal(error)) is true!
|
||||||
|
// doc.is_alive() is false
|
||||||
|
```
|
||||||
|
|
||||||
When you use the code without exceptions, it is your responsibility to check for error before using the
|
When you use the code without exceptions, it is your responsibility to check for error before using the
|
||||||
result: if there is an error, the result value will not be valid and using it will caused undefined behavior. Most compilers should be able to help you if you activate the right
|
result: if there is an error, the result value will not be valid and using it will caused undefined behavior. Most compilers should be able to help you if you activate the right
|
||||||
@@ -1606,7 +1845,7 @@ The following is a similar example where one wants to get the id of the first tw
|
|||||||
triggering exceptions. To do this, we use `["statuses"].at(0)["id"]`. We break that expression down:
|
triggering exceptions. To do this, we use `["statuses"].at(0)["id"]`. We break that expression down:
|
||||||
|
|
||||||
- Get the list of tweets (the `"statuses"` key of the document) using `["statuses"]`). The result is expected to be an array.
|
- Get the list of tweets (the `"statuses"` key of the document) using `["statuses"]`). The result is expected to be an array.
|
||||||
- Get the first tweet using `.at(0)`. The result is expected to be an object.
|
- Get the first tweet using `.at(0)`. The result is expected to be an object. Observe that the `at` method can only be called once on an array (it cannot be used for iteration).
|
||||||
- Get the id of the tweet using ["id"]. We expect the value to be a non-negative integer.
|
- Get the id of the tweet using ["id"]. We expect the value to be a non-negative integer.
|
||||||
|
|
||||||
Observe how we use the `at` method when querying an index into an array, and not the bracket operator.
|
Observe how we use the `at` method when querying an index into an array, and not the bracket operator.
|
||||||
@@ -1631,8 +1870,8 @@ int main(void) {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The `at` method can only be called once on an array. It cannot be used
|
*Important remark*: The `at` method can only be called once on an array. It cannot be used
|
||||||
to iterate through the values of an array.
|
to iterate through the values of an array. We deliberately forbid this usage to avoid performance antipatterns. If you need to iterate through the values of an array, you should use a `for` loop.
|
||||||
|
|
||||||
### Error handling examples without exceptions
|
### Error handling examples without exceptions
|
||||||
|
|
||||||
@@ -1897,6 +2136,8 @@ conclude that you have trailing content and that your document is not valid JSON
|
|||||||
You may then use `doc.current_location()` to obtain a pointer to the start of the trailing
|
You may then use `doc.current_location()` to obtain a pointer to the start of the trailing
|
||||||
content.
|
content.
|
||||||
|
|
||||||
|
Example 1.
|
||||||
|
|
||||||
```C++
|
```C++
|
||||||
auto json = R"([1, 2] foo ])"_padded;
|
auto json = R"([1, 2] foo ])"_padded;
|
||||||
ondemand::parser parser;
|
ondemand::parser parser;
|
||||||
@@ -1911,6 +2152,21 @@ content.
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Example 2.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
auto json = R"(["extra close"]])"_padded;
|
||||||
|
ondemand::parser parser;
|
||||||
|
ondemand::document doc = parser.iterate(json);
|
||||||
|
ondemand::array array = doc.get_array();
|
||||||
|
for (std::string_view values : array) {
|
||||||
|
std::cout << values << std::endl;
|
||||||
|
}
|
||||||
|
if(!doc.at_end()) {
|
||||||
|
std::cerr << "trailing content at byte index " << doc.current_location() - json.data() << std::endl;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
The `at_end()` method is equivalent to `doc.current_location().error() == simdjson::SUCCESS` but
|
The `at_end()` method is equivalent to `doc.current_location().error() == simdjson::SUCCESS` but
|
||||||
more convenient.
|
more convenient.
|
||||||
|
|
||||||
@@ -1951,6 +2207,7 @@ to the document `rewind()` method, except that it does not rewind the
|
|||||||
internal string buffer. Thus you should consume values only once
|
internal string buffer. Thus you should consume values only once
|
||||||
even if you can iterate through the array or object more than once.
|
even if you can iterate through the array or object more than once.
|
||||||
If you unescape a string within an array more than once, you have unsafe code.
|
If you unescape a string within an array more than once, you have unsafe code.
|
||||||
|
You must not call `reset()` on an object or an array as you are iterating through it.
|
||||||
|
|
||||||
|
|
||||||
Newline-Delimited JSON (ndjson) and JSON lines
|
Newline-Delimited JSON (ndjson) and JSON lines
|
||||||
@@ -1962,7 +2219,7 @@ serialize data into streams of multiple JSON documents. That is, instead of one
|
|||||||
write out multiple records as independent JSON documents, to be read one-by-one.
|
write out multiple records as independent JSON documents, to be read one-by-one.
|
||||||
|
|
||||||
The simdjson library also supports multithreaded JSON streaming through a large file
|
The simdjson library also supports multithreaded JSON streaming through a large file
|
||||||
containing many smaller JSON documents in either [ndjson](http://ndjson.org)
|
containing many smaller JSON documents in either [ndjson](https://github.com/ndjson/ndjson-spec)
|
||||||
or [JSON lines](http://jsonlines.org) format. If your JSON documents all contain arrays
|
or [JSON lines](http://jsonlines.org) format. If your JSON documents all contain arrays
|
||||||
or objects, we even support direct file concatenation without whitespace. However, if there
|
or objects, we even support direct file concatenation without whitespace. However, if there
|
||||||
is content between your JSON documents, it should be exclusively ASCII white-space characters.
|
is content between your JSON documents, it should be exclusively ASCII white-space characters.
|
||||||
@@ -2051,7 +2308,8 @@ The simdjson library supports parsing valid numbers inside strings which makes i
|
|||||||
three methods: `get_double_in_string`, `get_int64_in_string` and `get_uint64_in_string`. However, it is important to note that these methods are not substitute to the regular
|
three methods: `get_double_in_string`, `get_int64_in_string` and `get_uint64_in_string`. However, it is important to note that these methods are not substitute to the regular
|
||||||
`get_double`, `get_int64` and `get_uint64`. The usage of the `get_*_in_string` methods is solely to parse valid JSON numbers inside strings, and so we expect users to call these
|
`get_double`, `get_int64` and `get_uint64`. The usage of the `get_*_in_string` methods is solely to parse valid JSON numbers inside strings, and so we expect users to call these
|
||||||
methods appropriately. In particular, a valid JSON number has no leading and no trailing whitespaces, and the strings `"nan"`, `"1e"` and `"infinity"` will not be accepted as valid
|
methods appropriately. In particular, a valid JSON number has no leading and no trailing whitespaces, and the strings `"nan"`, `"1e"` and `"infinity"` will not be accepted as valid
|
||||||
numbers. As an example, suppose we have the following JSON text:
|
numbers (although you have access to the raw string with the `raw_json_token()` method, see [General direct access to the raw JSON string](#general-direct-access-to-the-raw-json-string)
|
||||||
|
). As an example, suppose we have the following JSON text:
|
||||||
|
|
||||||
```c++
|
```c++
|
||||||
auto json =
|
auto json =
|
||||||
@@ -2176,6 +2434,11 @@ Thus it is a dynamically typed number. Before accessing the value, you must dete
|
|||||||
such a number of `get_number()`, you get the error `BIGINT_ERROR`. You can access the underlying string of digits with the function `raw_json_token()` which returns a `std::string_view` instance starting at the beginning of the digit. You can also call `get_double()` to get a floating-point approximation.
|
such a number of `get_number()`, you get the error `BIGINT_ERROR`. You can access the underlying string of digits with the function `raw_json_token()` which returns a `std::string_view` instance starting at the beginning of the digit. You can also call `get_double()` to get a floating-point approximation.
|
||||||
|
|
||||||
|
|
||||||
|
By default, the string `-0` is parsed as the integer 0 as in Python or C++. If you set the macro
|
||||||
|
`SIMDJSON_MINUS_ZERO_AS_FLOAT` to `1` when building simdjson, you can get that `-0` is mapped to `-0.0`
|
||||||
|
as in JavaScript. You can get the desired effect by building simdjson with cmake setting the
|
||||||
|
`SIMDJSON_MINUS_ZERO_AS_FLOAT` to on: `cmake -B build -D SIMDJSON_MINUS_ZERO_AS_FLOAT=ON`.
|
||||||
|
|
||||||
You must check the type before accessing the value: it is an error to call `get_int64()` when `number.get_number_type()` is not `number_type::signed_integer` and when `number.is_int64()` is false. You are responsible for this check as the user of the library.
|
You must check the type before accessing the value: it is an error to call `get_int64()` when `number.get_number_type()` is not `number_type::signed_integer` and when `number.is_int64()` is false. You are responsible for this check as the user of the library.
|
||||||
|
|
||||||
The `get_number()` function is designed with performance in mind. When calling `get_number()`, you scan the number string only once, determining efficiently the type and storing it in an efficient manner.
|
The `get_number()` function is designed with performance in mind. When calling `get_number()`, you scan the number string only once, determining efficiently the type and storing it in an efficient manner.
|
||||||
@@ -2365,10 +2628,36 @@ The `raw_json_token()` should be fast and free of allocation.
|
|||||||
Given a quote-deliminated string, you find the string sequence inside the quote with a
|
Given a quote-deliminated string, you find the string sequence inside the quote with a
|
||||||
single line of code:
|
single line of code:
|
||||||
|
|
||||||
```C++
|
```cpp
|
||||||
std::string_view noquote(std::string_view v) { return {v.data()+1, v.find_last_of('"')-1}; }
|
std::string_view noquote(std::string_view v) { return {v.data()+1, v.find_last_of('"')-1}; }
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
The `raw_json_token()` method can enable you to provide fallbacks when parsing fails.
|
||||||
|
Consider the following example.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
padded_string json = "{\"key\": NaN}"_padded;
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc = parser.iterate(json);
|
||||||
|
simdjson::ondemand::object object = doc.get_object();
|
||||||
|
simdjson::ondemand::value val = object["key"];
|
||||||
|
simdjson::ondemand::json_type type = val.type();
|
||||||
|
// type == simdjson::ondemand::json_type::unknown
|
||||||
|
try {
|
||||||
|
double num = val.get_double();
|
||||||
|
} catch (const simdjson::simdjson_error& e) {
|
||||||
|
// e == simdjson::error_code::INCORRECT_TYPE
|
||||||
|
std::string_view str = val.raw_json_token();
|
||||||
|
// str == "NaN"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
The NaN is not supported in JSON. However, in the On-Demand API, you can check
|
||||||
|
the string corresponding to the JSON token and determine how to handle it.
|
||||||
|
|
||||||
|
### Raw JSON string for objects and arrays
|
||||||
|
|
||||||
If your value is an array or an object, `raw_json_token()` returns effectively a single
|
If your value is an array or an object, `raw_json_token()` returns effectively a single
|
||||||
character (`[`) or (`}`) which is not very useful. For arrays and objects, we have another
|
character (`[`) or (`}`) which is not very useful. For arrays and objects, we have another
|
||||||
method called `raw_json()` which consumes (traverses) the array or the object.
|
method called `raw_json()` which consumes (traverses) the array or the object.
|
||||||
@@ -2503,6 +2792,20 @@ can use it with features such as `std::optional`:
|
|||||||
// value was populated with "3.1416"
|
// value was populated with "3.1416"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can generally convert any answer that would return an `std::string_view`.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
auto json = R"({"\u0062\u0065\u0062\u0065": 2} })"_padded;
|
||||||
|
ondemand::parser parser;
|
||||||
|
ondemand::document doc = parser.iterate(json);
|
||||||
|
ondemand::object object = doc.get_object();
|
||||||
|
for (auto field : object) {
|
||||||
|
std::string key;
|
||||||
|
error = field.unescaped_key().get(key);
|
||||||
|
if(error) { /* */ }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
You should be mindful of the trade-off: allocating multiple
|
You should be mindful of the trade-off: allocating multiple
|
||||||
`std::string` instances can become expensive.
|
`std::string` instances can become expensive.
|
||||||
|
|
||||||
@@ -2521,7 +2824,7 @@ The CPU detection, which runs the first time parsing is attempted and switches t
|
|||||||
parser for your CPU, is transparent and thread-safe.
|
parser for your CPU, is transparent and thread-safe.
|
||||||
Our runtime dispatching is based on global objects that are instantiated at the beginning of the
|
Our runtime dispatching is based on global objects that are instantiated at the beginning of the
|
||||||
main thread and may be discarded at the end of the main thread. If you have multiple threads running
|
main thread and may be discarded at the end of the main thread. If you have multiple threads running
|
||||||
and some threads use the library while the main thread is cleaning up ressources, you may encounter
|
and some threads use the library while the main thread is cleaning up resources, you may encounter
|
||||||
issues. If you expect such problems, you may consider using [std::quick_exit](https://en.cppreference.com/w/cpp/utility/program/quick_exit).
|
issues. If you expect such problems, you may consider using [std::quick_exit](https://en.cppreference.com/w/cpp/utility/program/quick_exit).
|
||||||
|
|
||||||
In a threaded environment, stack space is often limited. Running code like simdjson in debug mode may require hundreds of kilobytes of stack memory. Thus stack overflows are a possibility. We recommend you turn on optimization when working in an environment where stack space is limited. If you must run your code in debug mode, we recommend you configure your system to have more stack space. We discourage you from running production code based on a debug build.
|
In a threaded environment, stack space is often limited. Running code like simdjson in debug mode may require hundreds of kilobytes of stack memory. Thus stack overflows are a possibility. We recommend you turn on optimization when working in an environment where stack space is limited. If you must run your code in debug mode, we recommend you configure your system to have more stack space. We discourage you from running production code based on a debug build.
|
||||||
@@ -2873,10 +3176,45 @@ Performance tips
|
|||||||
- The On-Demand front-end works best when doing a single pass over the input: avoid calling `count_elements`, `rewind`, `reset` and similar methods.
|
- The On-Demand front-end works best when doing a single pass over the input: avoid calling `count_elements`, `rewind`, `reset` and similar methods.
|
||||||
- If you are familiar with assembly language, you may use the online tool godbolt to explore the compiled code. The following example may work: [https://godbolt.org/z/xE4GWs573](https://godbolt.org/z/xE4GWs573).
|
- If you are familiar with assembly language, you may use the online tool godbolt to explore the compiled code. The following example may work: [https://godbolt.org/z/xE4GWs573](https://godbolt.org/z/xE4GWs573).
|
||||||
- Given a field `field` in an object, calling `field.key()` is often faster than `field.unescaped_key()` so if you do not need an unescaped `std::string_view` instance, prefer `field.key()`. Similarly, we expect `field.escaped_key()` to be faster than `field.unescaped_key()` even though both return a `std::string_view` instance.
|
- Given a field `field` in an object, calling `field.key()` is often faster than `field.unescaped_key()` so if you do not need an unescaped `std::string_view` instance, prefer `field.key()`. Similarly, we expect `field.escaped_key()` to be faster than `field.unescaped_key()` even though both return a `std::string_view` instance.
|
||||||
- For release builds, we recommend setting `NDEBUG` pre-processor directive when compiling the `simdjson` library. Importantly, using the optimization flags `-O2` or `-O3` under GCC and LLVM clang does not set the `NDEBUG` directive, you must set it manually (e.g., `-DNDEBUG`).
|
- For release builds, we recommend setting the `NDEBUG` pre-processor directive when compiling the `simdjson` library. Importantly, using the optimization flags `-O2` or `-O3` under GCC and LLVM clang does not set the `NDEBUG` directive, you must set it manually (e.g., `-DNDEBUG`).
|
||||||
- For long streams of JSON documents, consider [`iterate_many`](iterate_many.md) and [`parse_many`](parse_many.md) for better performance.
|
- For long streams of JSON documents, consider [`iterate_many`](iterate_many.md) and [`parse_many`](parse_many.md) for better performance.
|
||||||
- Never seek to access a field twice (e.g., o["data"] and later again o["data"]). Instead capture once an ondemand::value and reuse it.
|
- Never seek to access a field twice (e.g., o["data"] and later again o["data"]). Instead capture once an ondemand::value and reuse it.
|
||||||
- If you must access several different keys in an object, it might be preferable to iterate through all the fields in the object instead, and branch on the field keys.
|
- If you must access several different keys in an object, it might be preferable to iterate through all the fields in the object instead, and branch on the field keys. Consider this example.
|
||||||
|
```cpp
|
||||||
|
|
||||||
|
auto json = R"({"price": 123.456789, "volume": 9999,
|
||||||
|
"timestamp": "2025-09-04T09:45:00Z",
|
||||||
|
"symbol": "XYZ", "currency": "USD", "change": 1.23,
|
||||||
|
"isActive": true})"_padded;
|
||||||
|
|
||||||
|
simdjson::ondemand::parser parser;
|
||||||
|
simdjson::ondemand::document doc = parser.iterate(json);
|
||||||
|
|
||||||
|
for(auto keyvalue : doc.get_object()) {
|
||||||
|
simdjson::ondemand::raw_json_string key = keyvalue.key();
|
||||||
|
switch(key[0]) {
|
||||||
|
case 'p': // price
|
||||||
|
if (key == "price") {
|
||||||
|
std::string_view price_str = keyvalue.value().raw_json();
|
||||||
|
std::cout << "Price: " << price_str << std::endl;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 'v': // volume
|
||||||
|
if (key == "volume") {
|
||||||
|
std::string_view volume_str = keyvalue.value().raw_json();
|
||||||
|
std::cout << "Volume: " << volume_str << std::endl;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
case 't': // timestamp
|
||||||
|
if (key == "timestamp") {
|
||||||
|
std::string_view timestamp = keyvalue.value();
|
||||||
|
std::cout << "Timestamp: " << timestamp << std::endl;
|
||||||
|
}
|
||||||
|
break;
|
||||||
|
default: break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
- If possible, refer to each object and array in your code once. For example, the following code repeatedly refers to the `"data"` key to create an object...
|
- If possible, refer to each object and array in your code once. For example, the following code repeatedly refers to the `"data"` key to create an object...
|
||||||
```C++
|
```C++
|
||||||
std::string_view make = o["data"]["make"];
|
std::string_view make = o["data"]["make"];
|
||||||
|
|||||||
+256
@@ -0,0 +1,256 @@
|
|||||||
|
Builder
|
||||||
|
==========
|
||||||
|
|
||||||
|
Sometimes you want to generate JSON string outputs efficiently.
|
||||||
|
The simdjson library provides high-performance low-level facilities.
|
||||||
|
When using these low-level functionalities, you are responsible to
|
||||||
|
define the structure of your JSON document. Our more advanced interface
|
||||||
|
automates the process using C++26 static reflection: you get both high
|
||||||
|
speed and high convenience.
|
||||||
|
|
||||||
|
- [Builder](#builder)
|
||||||
|
* [Overview: string_builder](#overview--string-builder)
|
||||||
|
* [Example: string_builder](#example--string-builder)
|
||||||
|
* [C++26 static reflection](#c--26-static-reflection)
|
||||||
|
+ [Without `string_buffer` instance](#without--string-buffer--instance)
|
||||||
|
+ [Without `string_buffer` instance but with explicit error handling](#without--string-buffer--instance-but-with-explicit-error-handling)
|
||||||
|
|
||||||
|
Overview: string_builder
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
The string_builder class is a low-level utility for constructing JSON strings representing documents. It is optimized for performance, potentially leveraging kernel-specific features like SIMD instructions for tasks such as string escaping. This class supports atomic types (e.g., booleans, numbers, strings) but does not handle composed types directly (like arrays or objects).
|
||||||
|
Note that JSON strings are always encoded as UTF-8.
|
||||||
|
|
||||||
|
An `string_builder` is created with an initial buffer capacity (e.g., 1kB). The memory
|
||||||
|
is reallocated when needed.
|
||||||
|
The efficiency of `string_builder` stems from its internal use of a resizable array or buffer. When you append data, it adds the characters to this buffer, resizing it only when necessary, typically in a way that minimizes reallocations. This approach contrasts with regular string concatenation, where each operation creates a new string, copying all previous content, leading to quadratic time complexity for repeated concatenations.
|
||||||
|
|
||||||
|
|
||||||
|
It has the following methods to add content to the string:
|
||||||
|
|
||||||
|
|
||||||
|
- `append(number_type v)`: Appends a number (including booleans) to the JSON buffer. Booleans are converted to the strings "false" or "true". Numbers are formatted according to the JSON standard, with floating-point numbers using the shortest representation that accurately reflects the value.
|
||||||
|
- `append(char c)`: Appends a single character to the JSON buffer.
|
||||||
|
- `append_null()`: Appends the string "null" to the JSON buffer.
|
||||||
|
- `clear()`: Clears the contents of the JSON buffer, resetting the position to 0 while retaining the allocated capacity.
|
||||||
|
- `escape_and_append(std::string_view input)`: Appends a string view to the JSON buffer after escaping special characters (e.g., quotes, backslashes) as required by JSON.
|
||||||
|
- `escape_and_append_with_quotes(std::string_view input)` Appends a string view surrounded by double quotes (e.g., "input") to the JSON buffer after escaping special characters.
|
||||||
|
Parameters:
|
||||||
|
- `escape_and_append_with_quotes(char input)`: Appends a single character surrounded by double quotes (e.g., "c") to the JSON buffer after escaping it if necessary.
|
||||||
|
- `append_raw(const char *c)`: Appends a null-terminated C string directly to the JSON buffer without escaping.
|
||||||
|
- `append_raw(std::string_view input)`: Appends a string view directly to the JSON buffer without escaping.
|
||||||
|
- `append_raw(const char *str, size_t len)`: Appends a specified number of characters from a C string directly to the JSON
|
||||||
|
|
||||||
|
After writting the content, if you have reasons to believe that the content might violate UTF-8 conventions, you can check it as follows:
|
||||||
|
|
||||||
|
- `validate_unicode()`: Checks if the content in the JSON buffer is valid UTF-8. Returns: true if the content is valid UTF-8, false otherwise.
|
||||||
|
|
||||||
|
You might need to do unicode validation if you have strings in your data structures containing
|
||||||
|
malformed UTF-8. Note that we do not automatically call `validate_unicode()`.
|
||||||
|
|
||||||
|
Once you are satisfied, you can recover the string as follows:
|
||||||
|
|
||||||
|
- `operator std::string()`: Converts the JSON buffer to an std::string. (Might throw if an error occurred.)
|
||||||
|
- `operator std::string_view()`: Converts the JSON buffer to an std::string_view. (Might throw if an error occurred.)
|
||||||
|
- `view()`: Returns a view of the written JSON buffer as a `simdjson_result<std::string_view>`.
|
||||||
|
|
||||||
|
The later method (`view()`) is recommended. For performance reasons, we expect you to explicitly call `validate_unicode()` as needed (e.g., prior to calling `view()`).
|
||||||
|
|
||||||
|
Example: string_builder
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
```C++
|
||||||
|
struct Car {
|
||||||
|
std::string make;
|
||||||
|
std::string model;
|
||||||
|
int64_t year;
|
||||||
|
std::vector<double> tire_pressure;
|
||||||
|
};
|
||||||
|
|
||||||
|
void serialize_car(const Car& car, simdjson::builder::string_builder& builder) {
|
||||||
|
// start of JSON
|
||||||
|
builder.start_object();
|
||||||
|
|
||||||
|
// "make"
|
||||||
|
builder.append_key_value("make", car.make);
|
||||||
|
builder.append_comma();
|
||||||
|
|
||||||
|
// "model"
|
||||||
|
builder.append_key_value("model", car.model);
|
||||||
|
builder.append_comma();
|
||||||
|
|
||||||
|
// "year"
|
||||||
|
builder.append_key_value("year", car.year);
|
||||||
|
builder.append_comma();
|
||||||
|
|
||||||
|
// "tire_pressure"
|
||||||
|
builder.escape_and_append_with_quotes("tire_pressure");
|
||||||
|
builder.append_colon();
|
||||||
|
builder.start_array();
|
||||||
|
// vector tire_pressure
|
||||||
|
for (size_t i = 0; i < car.tire_pressure.size(); ++i) {
|
||||||
|
builder.append(car.tire_pressure[i]);
|
||||||
|
if (i < car.tire_pressure.size() - 1) {
|
||||||
|
builder.append_comma();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
builder.end_array();
|
||||||
|
builder.end_object();
|
||||||
|
}
|
||||||
|
|
||||||
|
bool car_test() {
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
|
||||||
|
serialize_car(c, sb);
|
||||||
|
std::string_view p{sb};
|
||||||
|
// p holds the JSON:
|
||||||
|
// "{\"make\":\"Toyota\",\"model\":\"Corolla\",\"year\":2017,\"tire_pressure\":[30.0,30.2,30.513,30.79]}"
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
The `string_builder` constructor takes an optional parameter which specifies the initial
|
||||||
|
memory allocation in byte. If you know approximately the size of your JSON output, you can
|
||||||
|
pass this value as a parameter (e.g., `simdjson::builder::string_builder sb{1233213}`).
|
||||||
|
|
||||||
|
The `string_builder` might throw an exception in case of error when you cast it result to `std::string_view`. If you wish to avoid exceptions, you can use the following programming pattern:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
std::string_view p;
|
||||||
|
if(sb.view().get(p)) {
|
||||||
|
return false; // there was an error
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
In all cases, the `std::string_view` instance depends the corresponding `string_builder` instance.
|
||||||
|
|
||||||
|
### C++20
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
If you have C++20, you can simplify the code, as the `std::vector<double>` is automatically
|
||||||
|
supported.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
sb.start_object();
|
||||||
|
sb.append_key_value("make", c.make);
|
||||||
|
sb.append_comma();
|
||||||
|
sb.append_key_value("model", c.model);
|
||||||
|
sb.append_comma();
|
||||||
|
sb.append_key_value("year", c.year);
|
||||||
|
sb.append_comma();
|
||||||
|
sb.append_key_value("tire_pressure", c.tire_pressure);
|
||||||
|
sb.end_object();
|
||||||
|
std::string_view p = sb.view();
|
||||||
|
```
|
||||||
|
|
||||||
|
With C++20, you can similarly handle standard containers transparently.
|
||||||
|
For example, you can serialize `std::map<std::string,T>` types.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
std::map<std::string,double> c = {{"key1", 1}, {"key2", 1}};
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
sb.append(c);
|
||||||
|
std::string_view p = sb.view();
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also serialize `std::vector<T>` types.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
std::vector<std::vector<double>> c = {{1.0, 2.0}, {3.0, 4.0}};
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
sb.append(c);
|
||||||
|
std::string_view p = sb.view();
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also skip the creation for the `string_builder` instance in such simple cases.
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
std::vector<std::vector<double>> c = {{1.0, 2.0}, {3.0, 4.0}};
|
||||||
|
std::string json = simdjson::to_json(c);
|
||||||
|
```
|
||||||
|
|
||||||
|
We do recommend that you create and reuse the `string_builder` instance for performance
|
||||||
|
reasons.
|
||||||
|
|
||||||
|
C++26 static reflection
|
||||||
|
------------------------
|
||||||
|
|
||||||
|
Static reflection (or compile-time reflection) in C++26 introduces a powerful compile-time mechanism that allows a program to inspect and manipulate its own structure, such as types, variables, functions, and other program elements, during compilation. Unlike runtime reflection in languages like Java or Python, C++26’s static reflection operates entirely at compile time, aligning with C++’s emphasis on zero-overhead abstractions and high performance. It means
|
||||||
|
that you can delegate much of the work to the library.
|
||||||
|
If you have a compiler with support C++26 static reflection, you can compile
|
||||||
|
your code with the `SIMDJSON_STATIC_REFLECTION` macro set:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
#define SIMDJSON_STATIC_REFLECTION 1
|
||||||
|
//...
|
||||||
|
#include "simdjson.h"
|
||||||
|
```
|
||||||
|
|
||||||
|
And then you can append your data structures to a `string_builder` instance
|
||||||
|
automatically. In most cases, it should work automatically:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
struct Car {
|
||||||
|
std::string make;
|
||||||
|
std::string model;
|
||||||
|
int64_t year;
|
||||||
|
std::vector<double> tire_pressure;
|
||||||
|
};
|
||||||
|
|
||||||
|
bool car_test() {
|
||||||
|
simdjson::builder::string_builder sb;
|
||||||
|
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
|
||||||
|
sb << c;
|
||||||
|
std::string_view p{sb};
|
||||||
|
// p holds the JSON:
|
||||||
|
// "{\"make\":\"Toyota\",\"model\":\"Corolla\",\"year\":2017,\"tire_pressure\":[30.0,30.2,30.513,30.79]}"
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### Without `string_buffer` instance
|
||||||
|
|
||||||
|
In some instances, you might want to create a string directly from your own data type.
|
||||||
|
You can create a string directly, without an explicit `string_builder` instance
|
||||||
|
with the `simdjson::to_json` template function.
|
||||||
|
(Under the hood a `string_builder` instance may still be created.)
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
struct Car {
|
||||||
|
std::string make;
|
||||||
|
std::string model;
|
||||||
|
int64_t year;
|
||||||
|
std::vector<double> tire_pressure;
|
||||||
|
};
|
||||||
|
|
||||||
|
void f() {
|
||||||
|
Car c = {"Toyota", "Corolla", 2017, {30.0,30.2,30.513,30.79}};
|
||||||
|
std::string json = simdjson::to_json(c);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If you know the output size, in bytes, of your JSON string, you may
|
||||||
|
pass it as a second parameter (e.g., `simdjson::to_json(c, 31123)`).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### Without `string_buffer` instance but with explicit error handling
|
||||||
|
|
||||||
|
If prefer a version without exceptions and explicit error handling, you can use the following
|
||||||
|
pattern:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
std::string json;
|
||||||
|
if(simdjson::to(c).get(json)) {
|
||||||
|
// there was an error
|
||||||
|
} else {
|
||||||
|
// json contain the serialized JSON
|
||||||
|
}
|
||||||
|
```
|
||||||
+122
-3
@@ -1,12 +1,16 @@
|
|||||||
The Document-Object-Model (DOM) front-end
|
The Document-Object-Model (DOM) front-end
|
||||||
==========
|
==========
|
||||||
|
|
||||||
An overview of what you need to know to use simdjson, with examples.
|
An overview of what you need to know to use simdjson to parse JSON documents with
|
||||||
|
our DOM API, with examples. [Our documentation regarding the generation (serialization) of JSON documents is in a
|
||||||
|
separate document](https://github.com/simdjson/simdjson/blob/master/doc/builder.md).
|
||||||
|
|
||||||
|
|
||||||
* [DOM vs On-Demand](#dom-vs-on-demand)
|
* [DOM vs On-Demand](#dom-vs-on-demand)
|
||||||
* [The Basics: Loading and Parsing JSON Documents](#the-basics-loading-and-parsing-json-documents-using-the-dom-front-end)
|
* [The Basics: Loading and Parsing JSON Documents](#the-basics-loading-and-parsing-json-documents-using-the-dom-front-end)
|
||||||
* [Using the Parsed JSON](#using-the-parsed-json)
|
* [Using the Parsed JSON](#using-the-parsed-json)
|
||||||
* [C++17 Support](#c17-support)
|
* [C++17 Support](#c17-support)
|
||||||
|
* [C++20 Support](#c20-support)
|
||||||
* [JSON Pointer](#json-pointer)
|
* [JSON Pointer](#json-pointer)
|
||||||
* [JSONPath](#jsonpath)
|
* [JSONPath](#jsonpath)
|
||||||
* [Error Handling](#error-handling)
|
* [Error Handling](#error-handling)
|
||||||
@@ -27,6 +31,10 @@ a conventional Document-Object-Model (DOM) front-end. In such a scenario, the JS
|
|||||||
entirely parsed, validated and materialized in memory as the first step. The programmer may
|
entirely parsed, validated and materialized in memory as the first step. The programmer may
|
||||||
then access the parsed data using this in-memory model.
|
then access the parsed data using this in-memory model.
|
||||||
|
|
||||||
|
On-Demand is a different model where you parse just what you need, directly into your own
|
||||||
|
data structure. The On-Demand approach, when well tuned, can provide superior performance.
|
||||||
|
[We refer you to the On-Demand documentation for further details](https://github.com/simdjson/simdjson/blob/master/doc/basics.md).
|
||||||
|
|
||||||
The Basics: Loading and Parsing JSON Documents using the DOM front-end
|
The Basics: Loading and Parsing JSON Documents using the DOM front-end
|
||||||
----------------------------------------------
|
----------------------------------------------
|
||||||
|
|
||||||
@@ -60,6 +68,26 @@ std::string data = "my data";
|
|||||||
simdjson::padded_string my_padded_data(data); // copies to a padded buffer
|
simdjson::padded_string my_padded_data(data); // copies to a padded buffer
|
||||||
```
|
```
|
||||||
|
|
||||||
|
You can then parse the JSON document from the `simdjson::padded_string` instance:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
simdjson::dom::parser parser;
|
||||||
|
simdjson::dom::element doc = parser.parse(my_padded_data);
|
||||||
|
```
|
||||||
|
|
||||||
|
Whenever you pass an `std::string` reference to `parser::parse`,
|
||||||
|
the parser will access the bytes beyond the end of
|
||||||
|
the string but before the end of the allocated memory (`std::string::capacity()`).
|
||||||
|
If you are using a sanitizer that checks for reading uninitialized bytes or `std::string`'s
|
||||||
|
container-overflow checks, you may encounter sanitizer warnings.
|
||||||
|
You can safely ignore these warnings. Or you can call `simdjson::pad(std::string&)` to pad the
|
||||||
|
string with `SIMDJSON_PADDING` spaces: this function returns a `simdjson::padding_string_view` which can be be passed to the parser's iterator function:
|
||||||
|
|
||||||
|
```c++
|
||||||
|
std::string json = "[1]";
|
||||||
|
dom::element doc = parser.parse(simdjson::pad(json));
|
||||||
|
```
|
||||||
|
|
||||||
The parsed document resulting from the `parser.load` and `parser.parse` calls depends on the `parser` instance. Thus the `parser` instance must remain in scope. Furthermore, you must have at most one parsed document in play per `parser` instance.
|
The parsed document resulting from the `parser.load` and `parser.parse` calls depends on the `parser` instance. Thus the `parser` instance must remain in scope. Furthermore, you must have at most one parsed document in play per `parser` instance.
|
||||||
You cannot copy a `parser` instance, you may only move it.
|
You cannot copy a `parser` instance, you may only move it.
|
||||||
|
|
||||||
@@ -70,7 +98,7 @@ During the`load` or `parse` calls, neither the input file nor the input string a
|
|||||||
For best performance, a `parser` instance should be reused over several files: otherwise you will needlessly reallocate memory, an expensive process. It is also possible to avoid entirely memory allocations during parsing when using simdjson. [See our performance notes for details](performance.md).
|
For best performance, a `parser` instance should be reused over several files: otherwise you will needlessly reallocate memory, an expensive process. It is also possible to avoid entirely memory allocations during parsing when using simdjson. [See our performance notes for details](performance.md).
|
||||||
|
|
||||||
If you need a lower-level interface, you may call the function `parser.parse(const char * p, size_t l)` on a pointer `p` while specifying the
|
If you need a lower-level interface, you may call the function `parser.parse(const char * p, size_t l)` on a pointer `p` while specifying the
|
||||||
length of your input `l` in bytes. To see how to get the very best performance from a low-level approach, you way want to read our [performance notes](https://github.com/simdjson/simdjson/blob/master/doc/performance.md#padding-and-temporary-copies) on this topic (see the Padding and Temporary Copies section).
|
length of your input `l` in bytes.
|
||||||
|
|
||||||
*Windows-specific*: Windows users who need to read files with
|
*Windows-specific*: Windows users who need to read files with
|
||||||
non-ANSI characters in the name should set their code page to
|
non-ANSI characters in the name should set their code page to
|
||||||
@@ -99,6 +127,12 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
|
|||||||
std::cout << "I parsed " << value << " from " << numberstring.data() << std::endl;
|
std::cout << "I parsed " << value << " from " << numberstring.data() << std::endl;
|
||||||
```
|
```
|
||||||
The strings contain unescaped valid UTF-8 strings: no unmatched surrogate is allowed.
|
The strings contain unescaped valid UTF-8 strings: no unmatched surrogate is allowed.
|
||||||
|
Internally, numbers are stored as either 64-bit integers or 64-bit floating-point numbers.
|
||||||
|
Thus it is possible to get the full 64-bit integer range (either signed or unsigned).
|
||||||
|
By default, the string `-0` is parsed as the integer 0 as in Pytho or C++. If you set the macro
|
||||||
|
`SIMDJSON_MINUS_ZERO_AS_FLOAT` to `1` when building simdjson, you can get that `-0` is mapped to `-0.0`
|
||||||
|
as in JavaScript. You can get the desired effect by building simdjson with cmake setting the
|
||||||
|
`SIMDJSON_MINUS_ZERO_AS_FLOAT` to on: `cmake -B build -D SIMDJSON_MINUS_ZERO_AS_FLOAT=ON`.
|
||||||
* **Field Access:** To get the value of the "foo" field in an object, use `object["foo"]`.
|
* **Field Access:** To get the value of the "foo" field in an object, use `object["foo"]`.
|
||||||
* **Array Iteration:** To iterate through an array, use `for (auto value : array) { ... }`. If you
|
* **Array Iteration:** To iterate through an array, use `for (auto value : array) { ... }`. If you
|
||||||
know the type of the value, you can cast it right there, too! `for (double value : array) { ... }`
|
know the type of the value, you can cast it right there, too! `for (double value : array) { ... }`
|
||||||
@@ -212,6 +246,23 @@ for (dom::key_value_pair field : object) {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
C++20 Support
|
||||||
|
------------
|
||||||
|
|
||||||
|
simdjson library also supports some C++20 feature including `std::ranges`:
|
||||||
|
|
||||||
|
```c++
|
||||||
|
auto cars_json = R"( [
|
||||||
|
{ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9, 37.7, 40.4 ] },
|
||||||
|
{ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0, 28.6, 28.7 ] },
|
||||||
|
{ "make": "Toyota", "model": "Tercel", "year": 1999, "tire_pressure": [ 29.8, 30.0, 30.2, 30.5 ] }
|
||||||
|
] )"_padded;
|
||||||
|
dom::parser parser;
|
||||||
|
auto justmodel = [](auto car) { return car["model"]; };
|
||||||
|
for (auto car : parser.parse(cars_json).get_array() | std::views::transform(justmodel)) {
|
||||||
|
std::cout << car << std::endl;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
JSON Pointer
|
JSON Pointer
|
||||||
------------
|
------------
|
||||||
@@ -303,6 +354,74 @@ if(error) { /*won't happen*/ }
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Using `at_path_with_wildcard` for JSONPath Queries
|
||||||
|
|
||||||
|
The `at_path_with_wildcard` function in simdjson extends the JSONPath querying capabilities by supporting wildcard expressions (`*`) in JSON paths. This allows users to retrieve multiple elements from a JSON document in a single query. For example, you can use `$.address.*` to fetch all fields within the `address` object or `$.phoneNumbers[*].numbers[*]` to retrieve all phone numbers across multiple objects in an array.
|
||||||
|
|
||||||
|
The `*` wildcard matches all elements at a specific level. For instance, `$.address.*` retrieves all key-value pairs in the `address` object, while `$.*.streetAddress` fetches all `streetAddress` fields across objects at the root level. You can combine wildcards with array indexing. For example, `$.phoneNumbers[*].numbers[1]` retrieves the second number from each `numbers` array in the `phoneNumbers` array. If no elements match the wildcard query, the function returns an empty result. For instance, querying `$.empty_object.*` or `$.empty_array.*` will yield an empty set.
|
||||||
|
|
||||||
|
### Example Usage
|
||||||
|
|
||||||
|
Here is an example demonstrating the use of `at_path_with_wildcard`:
|
||||||
|
|
||||||
|
```cpp
|
||||||
|
simdjson::padded_string json_string = R"(
|
||||||
|
{
|
||||||
|
"firstName": "John",
|
||||||
|
"lastName": "doe",
|
||||||
|
"age": 26,
|
||||||
|
"address": {
|
||||||
|
"streetAddress": "naist street",
|
||||||
|
"city": "Nara",
|
||||||
|
"postalCode": "630-0192"
|
||||||
|
},
|
||||||
|
"phoneNumbers": [
|
||||||
|
{
|
||||||
|
"type": "iPhone",
|
||||||
|
"numbers": ["0123-4567-8888", "0123-4567-8788"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "home",
|
||||||
|
"numbers": ["0123-4567-8910"]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
})"_padded;
|
||||||
|
|
||||||
|
dom::parser parser;
|
||||||
|
dom::element parsed_json = parser.parse(json_string);
|
||||||
|
std::vector<dom::element> values;
|
||||||
|
|
||||||
|
// Fetch all fields in the address object
|
||||||
|
auto error = parsed_json.at_path_with_wildcard("$.address.*").get(values);
|
||||||
|
if(error) {
|
||||||
|
// do something
|
||||||
|
}
|
||||||
|
for (auto &value : values) {
|
||||||
|
std::string_view field;
|
||||||
|
error = value.get(field);
|
||||||
|
if(error) {
|
||||||
|
// do something
|
||||||
|
}
|
||||||
|
std::cout << field << std::endl;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fetch all phone numbers
|
||||||
|
error = parsed_json.at_path_with_wildcard("$.phoneNumbers[*].numbers[*]").get(values);
|
||||||
|
if(error) {
|
||||||
|
// do something
|
||||||
|
}
|
||||||
|
for (auto &value : values) {
|
||||||
|
std::string_view number;
|
||||||
|
error = value.get(number);
|
||||||
|
if(error) {
|
||||||
|
// do something
|
||||||
|
}
|
||||||
|
std::cout << number << std::endl;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
This function is particularly useful for extracting data from complex JSON structures with nested arrays and objects. By leveraging wildcards, you can simplify your queries and reduce the need for multiple iterations.
|
||||||
|
|
||||||
Error Handling
|
Error Handling
|
||||||
--------------
|
--------------
|
||||||
|
|
||||||
@@ -713,5 +832,5 @@ Setting the `realloc_if_needed` parameter `false` in this manner may lead to bet
|
|||||||
Performance Tips
|
Performance Tips
|
||||||
---------------------
|
---------------------
|
||||||
|
|
||||||
- For release builds, we recommend setting `NDEBUG` pre-processor directive when compiling the `simdjson` library. Importantly, using the optimization flags `-O2` or `-O3` under GCC and LLVM clang does not set the `NDEBUG` directrive, you must set it manually (e.g., `-DNDEBUG`).
|
- For release builds, we recommend setting `NDEBUG` pre-processor directive when compiling the `simdjson` library. Importantly, using the optimization flags `-O2` or `-O3` under GCC and LLVM clang does not set the `NDEBUG` directive, you must set it manually (e.g., `-DNDEBUG`).
|
||||||
- For long streams of JSON documents, consider [`iterate_many`](iterate_many.md) and [`parse_many`](parse_many.md) for better performance.
|
- For long streams of JSON documents, consider [`iterate_many`](iterate_many.md) and [`parse_many`](parse_many.md) for better performance.
|
||||||
|
|||||||
+3
-3
@@ -130,7 +130,7 @@ If your documents are all objects or arrays, then you may even have nothing betw
|
|||||||
E.g., `[1,2]{"32":1}` is recognized as two documents.
|
E.g., `[1,2]{"32":1}` is recognized as two documents.
|
||||||
|
|
||||||
Some official formats **(non-exhaustive list)**:
|
Some official formats **(non-exhaustive list)**:
|
||||||
- [Newline-Delimited JSON (NDJSON)](http://ndjson.org/)
|
- [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec/)
|
||||||
- [JSON lines (JSONL)](http://jsonlines.org/)
|
- [JSON lines (JSONL)](http://jsonlines.org/)
|
||||||
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by JsonStream!
|
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by JsonStream!
|
||||||
- [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming)
|
- [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming)
|
||||||
@@ -309,7 +309,7 @@ The first argument is usually a tag type (often an empty struct) that uniquely i
|
|||||||
|
|
||||||
|
|
||||||
You can deserialize you own data structures conveniently if your system supports C++20.
|
You can deserialize you own data structures conveniently if your system supports C++20.
|
||||||
When it is the case, the macro `SIMDJSON_SUPPORTS_DESERIALIZATION` will be set to 1 by
|
When it is the case, the macro `SIMDJSON_SUPPORTS_CONCEPTS` will be set to 1 by
|
||||||
the simdjson library.
|
the simdjson library.
|
||||||
|
|
||||||
Consider a custom class `Car`:
|
Consider a custom class `Car`:
|
||||||
@@ -367,7 +367,7 @@ Please see our main documentation (`basics.md`) under
|
|||||||
"Use `tag_invoke` for custom types (C++20)" for details about
|
"Use `tag_invoke` for custom types (C++20)" for details about
|
||||||
tag_invoke functions.
|
tag_invoke functions.
|
||||||
|
|
||||||
Given a stream of JSON documents, you can add them to a data struture
|
Given a stream of JSON documents, you can add them to a data structure
|
||||||
such as a `std::vector<Car>` like so if you support exceptions:
|
such as a `std::vector<Car>` like so if you support exceptions:
|
||||||
|
|
||||||
```C++
|
```C++
|
||||||
|
|||||||
@@ -102,7 +102,7 @@ or indexing (`object["key"]`). In some cases, the values are even deserialized d
|
|||||||
maps.
|
maps.
|
||||||
|
|
||||||
The DOM approach is conceptually simple and "programmer friendly". Using the
|
The DOM approach is conceptually simple and "programmer friendly". Using the
|
||||||
DOM tree is often easy enough that many users use the DOM as-is instead of creating
|
DOM tree is often easy enough that many users process the DOM as-is instead of creating
|
||||||
their own custom data structures.
|
their own custom data structures.
|
||||||
|
|
||||||
The DOM approach was the only way to parse JSON documents up to version 0.6 of the simdjson library.
|
The DOM approach was the only way to parse JSON documents up to version 0.6 of the simdjson library.
|
||||||
|
|||||||
+22
-11
@@ -4,9 +4,9 @@ Performance Notes
|
|||||||
simdjson strives to be at its fastest *without tuning*, and generally achieves this. However, there
|
simdjson strives to be at its fastest *without tuning*, and generally achieves this. However, there
|
||||||
are still some scenarios where tuning can enhance performance.
|
are still some scenarios where tuning can enhance performance.
|
||||||
Once your code is tested, we
|
Once your code is tested, we
|
||||||
further encourage you to define `NDEBUG` in your Release builds to disable additional runtime
|
further encourage you to define `NDEBUG` in your release builds to disable additional runtime
|
||||||
testing and get the best performance.
|
testing and get the best performance.
|
||||||
* [NDEBUG directive](#ndebug-directive)
|
* [NDEBUG macro](#ndebug-macro)
|
||||||
* [Reusing the parser for maximum efficiency](#reusing-the-parser-for-maximum-efficiency)
|
* [Reusing the parser for maximum efficiency](#reusing-the-parser-for-maximum-efficiency)
|
||||||
* [Reusing string buffers](#reusing-string-buffers)
|
* [Reusing string buffers](#reusing-string-buffers)
|
||||||
* [Server Loops: Long-Running Processes and Memory Capacity](#server-loops-long-running-processes-and-memory-capacity)
|
* [Server Loops: Long-Running Processes and Memory Capacity](#server-loops-long-running-processes-and-memory-capacity)
|
||||||
@@ -17,16 +17,27 @@ testing and get the best performance.
|
|||||||
* [Free Padding](#free-padding)
|
* [Free Padding](#free-padding)
|
||||||
|
|
||||||
|
|
||||||
NDEBUG directive
|
NDEBUG macro
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
In C/C++, the `NDEBUG` pre-processor directive is not set by default. When it is not set, the simdjson library does
|
We recommend that you set `NDEBUG` macro in your release builds.
|
||||||
many additional checks that may impact negatively the performance. We recommend that, once your code
|
|
||||||
is well tested, you define `NDEBUG` directive in your Release builds. The `NDEBUG` directive should be defined
|
|
||||||
prior to including the `simdjson.h` header.
|
|
||||||
|
|
||||||
The `NDEBUG` directive is generally independent from optimization flags. For example, setting `-O3` under
|
In C/C++, the `NDEBUG` macro is not set by default.
|
||||||
GCC does not set the `NDEBUG` directive.
|
When it is not set, the software may do many additional checks that may impact
|
||||||
|
negatively the performance. We recommend that, once your code
|
||||||
|
is well tested, you define `NDEBUG` directive in your release builds.
|
||||||
|
|
||||||
|
The `NDEBUG` directive is generally independent from optimization flags.
|
||||||
|
For example, setting `-O3` under GCC does not set the `NDEBUG` directive.
|
||||||
|
However, tools like `CMake` automatically
|
||||||
|
set `NDEBUG` for release builds.
|
||||||
|
|
||||||
|
In the simdjson library, we check the `NDEBUG` macro as well as other
|
||||||
|
macros to make performant release builds. However, the C++ standard
|
||||||
|
does not provide a definitive approach to determine whether you are
|
||||||
|
compiling for a release build. Thus we recommend that you follow
|
||||||
|
the practice of setting the `NDEBUG` macro in release mode to make sure
|
||||||
|
that you do not get undesirable expensive checks.
|
||||||
|
|
||||||
Reusing the parser for maximum efficiency
|
Reusing the parser for maximum efficiency
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
@@ -158,9 +169,9 @@ On Intel and AMD Windows platforms, Microsoft Visual Studio enables programmers
|
|||||||
|
|
||||||
When compiling with Visual Studio, we recommend the flags `/Ob2 /O2` or better. We do not recommend that you compile simdjson with architecture-specific flags such as `arch:AVX2`. The simdjson library automatically selects the best execution kernel at runtime.
|
When compiling with Visual Studio, we recommend the flags `/Ob2 /O2` or better. We do not recommend that you compile simdjson with architecture-specific flags such as `arch:AVX2`. The simdjson library automatically selects the best execution kernel at runtime.
|
||||||
|
|
||||||
Recent versions of Microsoft Visual Studio on Windows provides support for the LLVM Clang compiler. You only need to install the "Clang compiler" optional component (ClangCL). You may also get a copy of the 64-bit LLVM CLang compiler for [Windows directly from LLVM](https://releases.llvm.org/download.html). The simdjson library fully supports the LLVM Clang compiler under Windows. In fact, you may get better performance out of simdjson with the LLVM Clang compiler than with the regular Visual Studio compiler. Meanwhile the [LLVM CLang compiler is binary compatible with Visual Studio](https://clang.llvm.org/docs/MSVCCompatibility.html) which means that you can combine their binaries (executables and libraries).
|
Recent versions of Microsoft Visual Studio on Windows provides support for the LLVM Clang compiler. You only need to install the "Clang compiler" optional component (clang-cl). You may also get a copy of the 64-bit LLVM CLang compiler for [Windows directly from LLVM](https://releases.llvm.org/download.html). The simdjson library fully supports the LLVM Clang compiler under Windows. In fact, you may get better performance out of simdjson with the LLVM Clang compiler than with the regular Visual Studio compiler. Meanwhile the [LLVM CLang compiler is binary compatible with Visual Studio](https://clang.llvm.org/docs/MSVCCompatibility.html) which means that you can combine their binaries (executables and libraries).
|
||||||
|
|
||||||
Under Windows, we also support the GNU GCC compiler via MSYS2. The performance of 64-bit MSYS2 under Windows is excellent (on par with Linux).
|
We recommend Visual Studio users prefer LLVM (clang-cl). It compiles to faster release binaries. Furthermore, it compilers faster in release mode.
|
||||||
|
|
||||||
|
|
||||||
Power Usage and Downclocking
|
Power Usage and Downclocking
|
||||||
|
|||||||
@@ -20,10 +20,14 @@ IF(${CMAKE_SYSTEM_NAME} MATCHES "Linux")
|
|||||||
endif()
|
endif()
|
||||||
|
|
||||||
add_quickstart_test(quickstart_noexceptions quickstart_noexceptions.cpp NO_EXCEPTIONS LABELS acceptance)
|
add_quickstart_test(quickstart_noexceptions quickstart_noexceptions.cpp NO_EXCEPTIONS LABELS acceptance)
|
||||||
add_quickstart_test(quickstart_noexceptions11 quickstart_noexceptions.cpp NO_EXCEPTIONS CXX_STANDARD c++11)
|
if(NOT SIMDJSON_STATIC_REFLECTION)
|
||||||
|
add_quickstart_test(quickstart_noexceptions11 quickstart_noexceptions.cpp NO_EXCEPTIONS CXX_STANDARD c++11)
|
||||||
|
endif(NOT SIMDJSON_STATIC_REFLECTION)
|
||||||
|
|
||||||
add_quickstart_test(quickstart2_noexceptions quickstart2_noexceptions.cpp NO_EXCEPTIONS LABELS acceptance)
|
add_quickstart_test(quickstart2_noexceptions quickstart2_noexceptions.cpp NO_EXCEPTIONS LABELS acceptance)
|
||||||
add_quickstart_test(quickstart2_noexceptions11 quickstart2_noexceptions.cpp NO_EXCEPTIONS CXX_STANDARD c++11)
|
if(NOT SIMDJSON_STATIC_REFLECTION)
|
||||||
|
add_quickstart_test(quickstart2_noexceptions11 quickstart2_noexceptions.cpp NO_EXCEPTIONS CXX_STANDARD c++11)
|
||||||
|
endif(NOT SIMDJSON_STATIC_REFLECTION)
|
||||||
|
|
||||||
# On-Demand Quick Start
|
# On-Demand Quick Start
|
||||||
if (SIMDJSON_EXCEPTIONS)
|
if (SIMDJSON_EXCEPTIONS)
|
||||||
@@ -33,6 +37,8 @@ IF(${CMAKE_SYSTEM_NAME} MATCHES "Linux")
|
|||||||
endif()
|
endif()
|
||||||
|
|
||||||
add_quickstart_test(quickstart_ondemand_noexceptions quickstart_ondemand_noexceptions.cpp NO_EXCEPTIONS LABELS quickstart_ondemand acceptance)
|
add_quickstart_test(quickstart_ondemand_noexceptions quickstart_ondemand_noexceptions.cpp NO_EXCEPTIONS LABELS quickstart_ondemand acceptance)
|
||||||
add_quickstart_test(quickstart_ondemand_noexceptions11 quickstart_ondemand_noexceptions.cpp NO_EXCEPTIONS CXX_STANDARD c++11 LABELS quickstart_ondemand)
|
if(NOT SIMDJSON_STATIC_REFLECTION)
|
||||||
|
add_quickstart_test(quickstart_ondemand_noexceptions11 quickstart_ondemand_noexceptions.cpp NO_EXCEPTIONS CXX_STANDARD c++11 LABELS quickstart_ondemand)
|
||||||
|
endif(NOT SIMDJSON_STATIC_REFLECTION)
|
||||||
|
|
||||||
endif()
|
endif()
|
||||||
|
|||||||
@@ -72,7 +72,7 @@ extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
|
|||||||
|
|
||||||
// make this dynamic, so it works regardless of how it was compiled
|
// make this dynamic, so it works regardless of how it was compiled
|
||||||
// or what hardware it runs on
|
// or what hardware it runs on
|
||||||
constexpr std::size_t Nimplementations_max=3;
|
constexpr std::size_t Nimplementations_max=4;
|
||||||
const std::size_t Nimplementations = supported_implementations.size();
|
const std::size_t Nimplementations = supported_implementations.size();
|
||||||
|
|
||||||
if(Nimplementations>Nimplementations_max) {
|
if(Nimplementations>Nimplementations_max) {
|
||||||
|
|||||||
@@ -18,7 +18,7 @@ extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
|
|||||||
auto error = parser.parse(str).get(elem);
|
auto error = parser.parse(str).get(elem);
|
||||||
if (error) { return 0; }
|
if (error) { return 0; }
|
||||||
|
|
||||||
std::string minified=simdjson::minify(elem);
|
std::string minified = simdjson::minify(elem);
|
||||||
(void)minified;
|
(void)minified;
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -53,4 +53,6 @@
|
|||||||
|
|
||||||
#include "simdjson/dom.h"
|
#include "simdjson/dom.h"
|
||||||
#include "simdjson/ondemand.h"
|
#include "simdjson/ondemand.h"
|
||||||
|
#include "simdjson/convert.h"
|
||||||
|
#include "simdjson/convert-inl.h"
|
||||||
#endif // SIMDJSON_H
|
#endif // SIMDJSON_H
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ SIMDJSON_NO_SANITIZE_UNDEFINED
|
|||||||
// See issue https://github.com/simdjson/simdjson/issues/1965
|
// See issue https://github.com/simdjson/simdjson/issues/1965
|
||||||
SIMDJSON_NO_SANITIZE_MEMORY
|
SIMDJSON_NO_SANITIZE_MEMORY
|
||||||
simdjson_inline int trailing_zeroes(uint64_t input_num) {
|
simdjson_inline int trailing_zeroes(uint64_t input_num) {
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
unsigned long ret;
|
unsigned long ret;
|
||||||
// Search the mask data from least significant bit (LSB)
|
// Search the mask data from least significant bit (LSB)
|
||||||
// to the most significant bit (MSB) for a set bit (1).
|
// to the most significant bit (MSB) for a set bit (1).
|
||||||
@@ -43,7 +43,7 @@ simdjson_inline uint64_t clear_lowest_bit(uint64_t input_num) {
|
|||||||
SIMDJSON_NO_SANITIZE_UNDEFINED
|
SIMDJSON_NO_SANITIZE_UNDEFINED
|
||||||
/* result might be undefined when input_num is zero */
|
/* result might be undefined when input_num is zero */
|
||||||
simdjson_inline int leading_zeroes(uint64_t input_num) {
|
simdjson_inline int leading_zeroes(uint64_t input_num) {
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
unsigned long leading_zero = 0;
|
unsigned long leading_zero = 0;
|
||||||
// Search the mask data from most significant bit (MSB)
|
// Search the mask data from most significant bit (MSB)
|
||||||
// to least significant bit (LSB) for a set bit (1).
|
// to least significant bit (LSB) for a set bit (1).
|
||||||
@@ -96,7 +96,7 @@ simdjson_inline uint64_t zero_leading_bit(uint64_t rev_bits, int leading_zeroes)
|
|||||||
#endif
|
#endif
|
||||||
|
|
||||||
simdjson_inline bool add_overflow(uint64_t value1, uint64_t value2, uint64_t *result) {
|
simdjson_inline bool add_overflow(uint64_t value1, uint64_t value2, uint64_t *result) {
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
*result = value1 + value2;
|
*result = value1 + value2;
|
||||||
return *result < value1;
|
return *result < value1;
|
||||||
#else
|
#else
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ namespace arm64 {
|
|||||||
namespace {
|
namespace {
|
||||||
namespace simd {
|
namespace simd {
|
||||||
|
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
namespace {
|
namespace {
|
||||||
// Start of private section with Visual Studio workaround
|
// Start of private section with Visual Studio workaround
|
||||||
|
|
||||||
@@ -121,7 +121,7 @@ namespace {
|
|||||||
// We return uint32_t instead of uint16_t because that seems to be more efficient for most
|
// We return uint32_t instead of uint16_t because that seems to be more efficient for most
|
||||||
// purposes (cutting it down to uint16_t costs performance in some compilers).
|
// purposes (cutting it down to uint16_t costs performance in some compilers).
|
||||||
simdjson_inline uint32_t to_bitmask() const {
|
simdjson_inline uint32_t to_bitmask() const {
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
const uint8x16_t bit_mask = simdjson_make_uint8x16_t(0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80,
|
const uint8x16_t bit_mask = simdjson_make_uint8x16_t(0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80,
|
||||||
0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80);
|
0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80);
|
||||||
#else
|
#else
|
||||||
@@ -134,6 +134,12 @@ namespace {
|
|||||||
tmp = vpaddq_u8(tmp, tmp);
|
tmp = vpaddq_u8(tmp, tmp);
|
||||||
return vgetq_lane_u16(vreinterpretq_u16_u8(tmp), 0);
|
return vgetq_lane_u16(vreinterpretq_u16_u8(tmp), 0);
|
||||||
}
|
}
|
||||||
|
// Returns 4-bit out of each byte, alternating between the high 4 bits and low
|
||||||
|
// bits result it is 64 bit.
|
||||||
|
simdjson_inline uint64_t to_bitmask64() const {
|
||||||
|
return vget_lane_u64(
|
||||||
|
vreinterpret_u64_u8(vshrn_n_u16(vreinterpretq_u16_u8(*this), 4)), 0);
|
||||||
|
}
|
||||||
simdjson_inline bool any() const { return vmaxvq_u32(vreinterpretq_u32_u8(*this)) != 0; }
|
simdjson_inline bool any() const { return vmaxvq_u32(vreinterpretq_u32_u8(*this)) != 0; }
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -152,7 +158,7 @@ namespace {
|
|||||||
// Splat constructor
|
// Splat constructor
|
||||||
simdjson_inline simd8(uint8_t _value) : simd8(splat(_value)) {}
|
simdjson_inline simd8(uint8_t _value) : simd8(splat(_value)) {}
|
||||||
// Member-by-member initialization
|
// Member-by-member initialization
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
simdjson_inline simd8(
|
simdjson_inline simd8(
|
||||||
uint8_t v0, uint8_t v1, uint8_t v2, uint8_t v3, uint8_t v4, uint8_t v5, uint8_t v6, uint8_t v7,
|
uint8_t v0, uint8_t v1, uint8_t v2, uint8_t v3, uint8_t v4, uint8_t v5, uint8_t v6, uint8_t v7,
|
||||||
uint8_t v8, uint8_t v9, uint8_t v10, uint8_t v11, uint8_t v12, uint8_t v13, uint8_t v14, uint8_t v15
|
uint8_t v8, uint8_t v9, uint8_t v10, uint8_t v11, uint8_t v12, uint8_t v13, uint8_t v14, uint8_t v15
|
||||||
@@ -210,7 +216,7 @@ namespace {
|
|||||||
|
|
||||||
// Bit-specific operations
|
// Bit-specific operations
|
||||||
simdjson_inline simd8<bool> any_bits_set(simd8<uint8_t> bits) const { return vtstq_u8(*this, bits); }
|
simdjson_inline simd8<bool> any_bits_set(simd8<uint8_t> bits) const { return vtstq_u8(*this, bits); }
|
||||||
simdjson_inline bool any_bits_set_anywhere() const { return this->max_val() != 0; }
|
simdjson_inline bool any_bits_set_anywhere() const { return vmaxvq_u32(vreinterpretq_u32_u8(*this)) != 0; }
|
||||||
simdjson_inline bool any_bits_set_anywhere(simd8<uint8_t> bits) const { return (*this & bits).any_bits_set_anywhere(); }
|
simdjson_inline bool any_bits_set_anywhere(simd8<uint8_t> bits) const { return (*this & bits).any_bits_set_anywhere(); }
|
||||||
template<int N>
|
template<int N>
|
||||||
simdjson_inline simd8<uint8_t> shr() const { return vshrq_n_u8(*this, N); }
|
simdjson_inline simd8<uint8_t> shr() const { return vshrq_n_u8(*this, N); }
|
||||||
@@ -223,7 +229,12 @@ namespace {
|
|||||||
return lookup_table.apply_lookup_16_to(*this);
|
return lookup_table.apply_lookup_16_to(*this);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Returns 4-bit out of each byte, alternating between the high 4 bits and low
|
||||||
|
// bits result it is 64 bit.
|
||||||
|
simdjson_inline uint64_t to_bitmask64() const {
|
||||||
|
return vget_lane_u64(
|
||||||
|
vreinterpret_u64_u8(vshrn_n_u16(vreinterpretq_u16_u8(*this), 4)), 0);
|
||||||
|
}
|
||||||
// Copies to 'output" all bytes corresponding to a 0 in the mask (interpreted as a bitset).
|
// Copies to 'output" all bytes corresponding to a 0 in the mask (interpreted as a bitset).
|
||||||
// Passing a 0 value for mask would be equivalent to writing out every byte to output.
|
// Passing a 0 value for mask would be equivalent to writing out every byte to output.
|
||||||
// Only the first 16 - count_ones(mask) bytes of the result are significant but 16 bytes
|
// Only the first 16 - count_ones(mask) bytes of the result are significant but 16 bytes
|
||||||
@@ -246,7 +257,7 @@ namespace {
|
|||||||
uint64x2_t shufmask64 = {thintable_epi8[mask1], thintable_epi8[mask2]};
|
uint64x2_t shufmask64 = {thintable_epi8[mask1], thintable_epi8[mask2]};
|
||||||
uint8x16_t shufmask = vreinterpretq_u8_u64(shufmask64);
|
uint8x16_t shufmask = vreinterpretq_u8_u64(shufmask64);
|
||||||
// we increment by 0x08 the second half of the mask
|
// we increment by 0x08 the second half of the mask
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
uint8x16_t inc = simdjson_make_uint8x16_t(0, 0, 0, 0, 0, 0, 0, 0, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08);
|
uint8x16_t inc = simdjson_make_uint8x16_t(0, 0, 0, 0, 0, 0, 0, 0, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08);
|
||||||
#else
|
#else
|
||||||
uint8x16_t inc = {0, 0, 0, 0, 0, 0, 0, 0, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08};
|
uint8x16_t inc = {0, 0, 0, 0, 0, 0, 0, 0, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08};
|
||||||
@@ -276,7 +287,7 @@ namespace {
|
|||||||
uint8x8_t compactmask1 = vcreate_u8(thintable_epi8[mask1]);
|
uint8x8_t compactmask1 = vcreate_u8(thintable_epi8[mask1]);
|
||||||
uint8x8_t compactmask2 = vcreate_u8(thintable_epi8[mask2]);
|
uint8x8_t compactmask2 = vcreate_u8(thintable_epi8[mask2]);
|
||||||
// we increment by 0x08 the second half of the mask
|
// we increment by 0x08 the second half of the mask
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
uint8x8_t inc = simdjson_make_uint8x8_t(0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08);
|
uint8x8_t inc = simdjson_make_uint8x8_t(0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08);
|
||||||
#else
|
#else
|
||||||
uint8x8_t inc = {0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08};
|
uint8x8_t inc = {0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08, 0x08};
|
||||||
@@ -328,7 +339,7 @@ namespace {
|
|||||||
// Array constructor
|
// Array constructor
|
||||||
simdjson_inline simd8(const int8_t* values) : simd8(load(values)) {}
|
simdjson_inline simd8(const int8_t* values) : simd8(load(values)) {}
|
||||||
// Member-by-member initialization
|
// Member-by-member initialization
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
simdjson_inline simd8(
|
simdjson_inline simd8(
|
||||||
int8_t v0, int8_t v1, int8_t v2, int8_t v3, int8_t v4, int8_t v5, int8_t v6, int8_t v7,
|
int8_t v0, int8_t v1, int8_t v2, int8_t v3, int8_t v4, int8_t v5, int8_t v6, int8_t v7,
|
||||||
int8_t v8, int8_t v9, int8_t v10, int8_t v11, int8_t v12, int8_t v13, int8_t v14, int8_t v15
|
int8_t v8, int8_t v9, int8_t v10, int8_t v11, int8_t v12, int8_t v13, int8_t v14, int8_t v15
|
||||||
@@ -449,7 +460,7 @@ namespace {
|
|||||||
}
|
}
|
||||||
|
|
||||||
simdjson_inline uint64_t to_bitmask() const {
|
simdjson_inline uint64_t to_bitmask() const {
|
||||||
#ifdef SIMDJSON_REGULAR_VISUAL_STUDIO
|
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||||
const uint8x16_t bit_mask = simdjson_make_uint8x16_t(
|
const uint8x16_t bit_mask = simdjson_make_uint8x16_t(
|
||||||
0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80,
|
0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80,
|
||||||
0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80
|
0x01, 0x02, 0x4, 0x8, 0x10, 0x20, 0x40, 0x80
|
||||||
|
|||||||
@@ -46,6 +46,32 @@ simdjson_inline backslash_and_quote backslash_and_quote::copy_and_find(const uin
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
struct escaping {
|
||||||
|
static constexpr uint32_t BYTES_PROCESSED = 16;
|
||||||
|
simdjson_inline static escaping copy_and_find(const uint8_t *src, uint8_t *dst);
|
||||||
|
|
||||||
|
simdjson_inline bool has_escape() { return escape_bits != 0; }
|
||||||
|
simdjson_inline int escape_index() { return trailing_zeroes(escape_bits) / 4; }
|
||||||
|
|
||||||
|
uint64_t escape_bits;
|
||||||
|
}; // struct escaping
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
simdjson_inline escaping escaping::copy_and_find(const uint8_t *src, uint8_t *dst) {
|
||||||
|
static_assert(SIMDJSON_PADDING >= (BYTES_PROCESSED - 1), "escaping finder must process fewer than SIMDJSON_PADDING bytes");
|
||||||
|
simd8<uint8_t> v(src);
|
||||||
|
v.store(dst);
|
||||||
|
simd8<bool> is_quote = (v == '"');
|
||||||
|
simd8<bool> is_backslash = (v == '\\');
|
||||||
|
simd8<bool> is_control = (v < 32);
|
||||||
|
return {
|
||||||
|
(is_backslash | is_quote | is_control).to_bitmask64()
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
} // unnamed namespace
|
} // unnamed namespace
|
||||||
} // namespace arm64
|
} // namespace arm64
|
||||||
} // namespace simdjson
|
} // namespace simdjson
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
#include "simdjson/error.h"
|
#include "simdjson/error.h"
|
||||||
#include "simdjson/portability.h"
|
#include "simdjson/portability.h"
|
||||||
#include "simdjson/concepts.h"
|
#include "simdjson/concepts.h"
|
||||||
|
#include "simdjson/constevalutil.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief The top level simdjson namespace, containing everything the library provides.
|
* @brief The top level simdjson namespace, containing everything the library provides.
|
||||||
|
|||||||
@@ -24,6 +24,8 @@
|
|||||||
#include "simdjson/lsx.h"
|
#include "simdjson/lsx.h"
|
||||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||||
#include "simdjson/lasx.h"
|
#include "simdjson/lasx.h"
|
||||||
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv)
|
||||||
|
#include "simdjson/rvv.h"
|
||||||
#else
|
#else
|
||||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -21,6 +21,8 @@ namespace simdjson {
|
|||||||
namespace lsx {}
|
namespace lsx {}
|
||||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||||
namespace lasx {}
|
namespace lasx {}
|
||||||
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv)
|
||||||
|
namespace rvv {}
|
||||||
#else
|
#else
|
||||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -23,6 +23,8 @@
|
|||||||
#include "simdjson/lsx/implementation.h"
|
#include "simdjson/lsx/implementation.h"
|
||||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||||
#include "simdjson/lasx/implementation.h"
|
#include "simdjson/lasx/implementation.h"
|
||||||
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv)
|
||||||
|
#include "simdjson/rvv/implementation.h"
|
||||||
#else
|
#else
|
||||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -24,6 +24,8 @@
|
|||||||
#include "simdjson/lsx/ondemand.h"
|
#include "simdjson/lsx/ondemand.h"
|
||||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||||
#include "simdjson/lasx/ondemand.h"
|
#include "simdjson/lasx/ondemand.h"
|
||||||
|
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv)
|
||||||
|
#include "simdjson/rvv/ondemand.h"
|
||||||
#else
|
#else
|
||||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||||
#endif
|
#endif
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ double from_chars(const char *first, const char* end) noexcept;
|
|||||||
}
|
}
|
||||||
|
|
||||||
#ifndef SIMDJSON_EXCEPTIONS
|
#ifndef SIMDJSON_EXCEPTIONS
|
||||||
#if __cpp_exceptions
|
#if defined(__cpp_exceptions) || defined(_CPPUNWIND)
|
||||||
#define SIMDJSON_EXCEPTIONS 1
|
#define SIMDJSON_EXCEPTIONS 1
|
||||||
#else
|
#else
|
||||||
#define SIMDJSON_EXCEPTIONS 0
|
#define SIMDJSON_EXCEPTIONS 0
|
||||||
@@ -199,17 +199,6 @@ double from_chars(const char *first, const char* end) noexcept;
|
|||||||
// We assume by default static linkage
|
// We assume by default static linkage
|
||||||
#define SIMDJSON_DLLIMPORTEXPORT
|
#define SIMDJSON_DLLIMPORTEXPORT
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/**
|
|
||||||
* Workaround for the vcpkg package manager. Only vcpkg should
|
|
||||||
* ever touch the next line. The SIMDJSON_USING_LIBRARY macro is otherwise unused.
|
|
||||||
*/
|
|
||||||
#if SIMDJSON_USING_LIBRARY
|
|
||||||
#define SIMDJSON_DLLIMPORTEXPORT __declspec(dllimport)
|
|
||||||
#endif
|
|
||||||
/**
|
|
||||||
* End of workaround for the vcpkg package manager.
|
|
||||||
*/
|
|
||||||
#else
|
#else
|
||||||
#define SIMDJSON_DLLIMPORTEXPORT
|
#define SIMDJSON_DLLIMPORTEXPORT
|
||||||
#endif
|
#endif
|
||||||
@@ -226,12 +215,14 @@ double from_chars(const char *first, const char* end) noexcept;
|
|||||||
// even if we do not have C++17 support.
|
// even if we do not have C++17 support.
|
||||||
#ifdef __cpp_lib_string_view
|
#ifdef __cpp_lib_string_view
|
||||||
#define SIMDJSON_HAS_STRING_VIEW
|
#define SIMDJSON_HAS_STRING_VIEW
|
||||||
|
#include <string_view>
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
// Some systems have string_view even if we do not have C++17 support,
|
// Some systems have string_view even if we do not have C++17 support,
|
||||||
// and even if __cpp_lib_string_view is undefined, it is the case
|
// and even if __cpp_lib_string_view is undefined, it is the case
|
||||||
// with Apple clang version 11.
|
// with Apple clang version 11.
|
||||||
// We must handle it. *This is important.*
|
// We must handle it. *This is important.*
|
||||||
|
#ifndef _MSC_VER
|
||||||
#ifndef SIMDJSON_HAS_STRING_VIEW
|
#ifndef SIMDJSON_HAS_STRING_VIEW
|
||||||
#if defined __has_include
|
#if defined __has_include
|
||||||
// do not combine the next #if with the previous one (unsafe)
|
// do not combine the next #if with the previous one (unsafe)
|
||||||
@@ -247,6 +238,7 @@ double from_chars(const char *first, const char* end) noexcept;
|
|||||||
#endif // __has_include (<string_view>)
|
#endif // __has_include (<string_view>)
|
||||||
#endif // defined __has_include
|
#endif // defined __has_include
|
||||||
#endif // def SIMDJSON_HAS_STRING_VIEW
|
#endif // def SIMDJSON_HAS_STRING_VIEW
|
||||||
|
#endif // def _MSC_VER
|
||||||
// end of complicated but important routine to try to detect string_view.
|
// end of complicated but important routine to try to detect string_view.
|
||||||
|
|
||||||
//
|
//
|
||||||
@@ -279,16 +271,25 @@ namespace std {
|
|||||||
// It could also wrongly set SIMDJSON_DEVELOPMENT_CHECKS (e.g., if the programmer
|
// It could also wrongly set SIMDJSON_DEVELOPMENT_CHECKS (e.g., if the programmer
|
||||||
// sets _DEBUG in a release build under Visual Studio, or if some compiler fails to
|
// sets _DEBUG in a release build under Visual Studio, or if some compiler fails to
|
||||||
// set the __OPTIMIZE__ macro).
|
// set the __OPTIMIZE__ macro).
|
||||||
|
// We make it so that if NDEBUG is defined, then SIMDJSON_DEVELOPMENT_CHECKS
|
||||||
|
// is not defined, irrespective of the compiler.
|
||||||
|
// We recommend that users set NDEBUG in release builds, so that
|
||||||
|
// SIMDJSON_DEVELOPMENT_CHECKS is not defined in release builds by default,
|
||||||
|
// irrespective of the compiler.
|
||||||
#ifndef SIMDJSON_DEVELOPMENT_CHECKS
|
#ifndef SIMDJSON_DEVELOPMENT_CHECKS
|
||||||
#ifdef _MSC_VER
|
#ifdef _MSC_VER
|
||||||
// Visual Studio seems to set _DEBUG for debug builds.
|
// Visual Studio seems to set _DEBUG for debug builds.
|
||||||
#ifdef _DEBUG
|
// We set SIMDJSON_DEVELOPMENT_CHECKS to 1 if _DEBUG is defined
|
||||||
|
// and NDEBUG is not defined.
|
||||||
|
#if defined(_DEBUG) && !defined(NDEBUG)
|
||||||
#define SIMDJSON_DEVELOPMENT_CHECKS 1
|
#define SIMDJSON_DEVELOPMENT_CHECKS 1
|
||||||
#endif // _DEBUG
|
#endif // _DEBUG
|
||||||
#else // _MSC_VER
|
#else // _MSC_VER
|
||||||
// All other compilers appear to set __OPTIMIZE__ to a positive integer
|
// All other compilers appear to set __OPTIMIZE__ to a positive integer
|
||||||
// when the compiler is optimizing.
|
// when the compiler is optimizing.
|
||||||
#ifndef __OPTIMIZE__
|
// We only set SIMDJSON_DEVELOPMENT_CHECKS if both __OPTIMIZE__
|
||||||
|
// and NDEBUG are not defined.
|
||||||
|
#if !defined(__OPTIMIZE__) && !defined(NDEBUG)
|
||||||
#define SIMDJSON_DEVELOPMENT_CHECKS 1
|
#define SIMDJSON_DEVELOPMENT_CHECKS 1
|
||||||
#endif // __OPTIMIZE__
|
#endif // __OPTIMIZE__
|
||||||
#endif // _MSC_VER
|
#endif // _MSC_VER
|
||||||
@@ -344,4 +345,16 @@ namespace std {
|
|||||||
#define SIMDJSON_AVX512_ALLOWED 1
|
#define SIMDJSON_AVX512_ALLOWED 1
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#ifndef __has_cpp_attribute
|
||||||
|
#define simdjson_lifetime_bound
|
||||||
|
#elif __has_cpp_attribute(msvc::lifetimebound)
|
||||||
|
#define simdjson_lifetime_bound [[msvc::lifetimebound]]
|
||||||
|
#elif __has_cpp_attribute(clang::lifetimebound)
|
||||||
|
#define simdjson_lifetime_bound [[clang::lifetimebound]]
|
||||||
|
#elif __has_cpp_attribute(lifetimebound)
|
||||||
|
#define simdjson_lifetime_bound [[lifetimebound]]
|
||||||
|
#else
|
||||||
|
#define simdjson_lifetime_bound
|
||||||
|
#endif
|
||||||
#endif // SIMDJSON_COMMON_DEFS_H
|
#endif // SIMDJSON_COMMON_DEFS_H
|
||||||
|
|||||||
@@ -50,16 +50,69 @@
|
|||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
#ifndef SIMDJSON_CONSTEXPR_LAMBDA
|
||||||
|
#if SIMDJSON_CPLUSPLUS17
|
||||||
|
#define SIMDJSON_CONSTEXPR_LAMBDA constexpr
|
||||||
|
#else
|
||||||
|
#define SIMDJSON_CONSTEXPR_LAMBDA
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#ifdef __has_include
|
#ifdef __has_include
|
||||||
#if __has_include(<version>)
|
#if __has_include(<version>)
|
||||||
#include <version>
|
#include <version>
|
||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
#ifdef __cpp_concepts
|
// The current specification is unclear on how we detect
|
||||||
|
// static reflection, both __cpp_lib_reflection and
|
||||||
|
// __cpp_impl_reflection are proposed in the draft specification.
|
||||||
|
// For now, we disable static reflect by default. It must be
|
||||||
|
// specified at compiler time.
|
||||||
|
#ifndef SIMDJSON_STATIC_REFLECTION
|
||||||
|
#define SIMDJSON_STATIC_REFLECTION 0 // disabled by default.
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if defined(__apple_build_version__)
|
||||||
|
#if __apple_build_version__ < 14000000
|
||||||
|
#define SIMDJSON_CONCEPT_DISABLED 1 // apple-clang/13 doesn't support std::convertible_to
|
||||||
|
#endif
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if defined(__cpp_lib_ranges) && __cpp_lib_ranges >= 201911L
|
||||||
|
#include <ranges>
|
||||||
|
#define SIMDJSON_SUPPORTS_RANGES 1
|
||||||
|
#else
|
||||||
|
#define SIMDJSON_SUPPORTS_RANGES 0
|
||||||
|
#endif
|
||||||
|
|
||||||
|
#if defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
|
||||||
|
#if __cpp_concepts >= 201907L
|
||||||
#include <utility>
|
#include <utility>
|
||||||
|
#define SIMDJSON_SUPPORTS_CONCEPTS 1
|
||||||
|
#else
|
||||||
|
#define SIMDJSON_SUPPORTS_CONCEPTS 0
|
||||||
|
#endif
|
||||||
|
#else // defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
|
||||||
|
#define SIMDJSON_SUPPORTS_CONCEPTS 0
|
||||||
|
#endif // defined(__cpp_concepts) && !defined(SIMDJSON_CONCEPT_DISABLED)
|
||||||
|
|
||||||
|
// copy SIMDJSON_SUPPORTS_CONCEPTS to SIMDJSON_SUPPORTS_DESERIALIZATION.
|
||||||
|
#if SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
#define SIMDJSON_SUPPORTS_DESERIALIZATION 1
|
#define SIMDJSON_SUPPORTS_DESERIALIZATION 1
|
||||||
#else // __cpp_concepts
|
#else
|
||||||
#define SIMDJSON_SUPPORTS_DESERIALIZATION 0
|
#define SIMDJSON_SUPPORTS_DESERIALIZATION 0
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
|
#if !defined(SIMDJSON_CONSTEVAL)
|
||||||
|
#if defined(__cpp_consteval) && __cpp_consteval >= 201811L && defined(__cpp_lib_constexpr_string) && __cpp_lib_constexpr_string >= 201907L
|
||||||
|
#define SIMDJSON_CONSTEVAL 1
|
||||||
|
#else
|
||||||
|
#define SIMDJSON_CONSTEVAL 0
|
||||||
|
#endif // defined(__cpp_consteval) && __cpp_consteval >= 201811L && defined(__cpp_lib_constexpr_string) && __cpp_lib_constexpr_string >= 201907L
|
||||||
|
#endif // !defined(SIMDJSON_CONSTEVAL)
|
||||||
|
|
||||||
#endif // SIMDJSON_COMPILER_CHECK_H
|
#endif // SIMDJSON_COMPILER_CHECK_H
|
||||||
|
|||||||
+32
-13
@@ -1,6 +1,6 @@
|
|||||||
#ifndef SIMDJSON_CONCEPTS_H
|
#ifndef SIMDJSON_CONCEPTS_H
|
||||||
#define SIMDJSON_CONCEPTS_H
|
#define SIMDJSON_CONCEPTS_H
|
||||||
#if SIMDJSON_SUPPORTS_DESERIALIZATION
|
#if SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
|
|
||||||
#include <concepts>
|
#include <concepts>
|
||||||
#include <type_traits>
|
#include <type_traits>
|
||||||
@@ -20,26 +20,44 @@ namespace details {
|
|||||||
}; \
|
}; \
|
||||||
};
|
};
|
||||||
|
|
||||||
SIMDJSON_IMPL_CONCEPT(emplace_back, emplace_back);
|
SIMDJSON_IMPL_CONCEPT(emplace_back, emplace_back)
|
||||||
SIMDJSON_IMPL_CONCEPT(emplace, emplace);
|
SIMDJSON_IMPL_CONCEPT(emplace, emplace)
|
||||||
SIMDJSON_IMPL_CONCEPT(push_back, push_back);
|
SIMDJSON_IMPL_CONCEPT(push_back, push_back)
|
||||||
SIMDJSON_IMPL_CONCEPT(add, add);
|
SIMDJSON_IMPL_CONCEPT(add, add)
|
||||||
SIMDJSON_IMPL_CONCEPT(push, push);
|
SIMDJSON_IMPL_CONCEPT(push, push)
|
||||||
SIMDJSON_IMPL_CONCEPT(append, append);
|
SIMDJSON_IMPL_CONCEPT(append, append)
|
||||||
SIMDJSON_IMPL_CONCEPT(insert, insert);
|
SIMDJSON_IMPL_CONCEPT(insert, insert)
|
||||||
SIMDJSON_IMPL_CONCEPT(op_append, operator+=);
|
SIMDJSON_IMPL_CONCEPT(op_append, operator+=)
|
||||||
|
|
||||||
#undef SIMDJSON_IMPL_CONCEPT
|
#undef SIMDJSON_IMPL_CONCEPT
|
||||||
} // namespace details
|
} // namespace details
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
concept is_pair = requires { typename T::first_type; typename T::second_type; } &&
|
||||||
|
std::same_as<T, std::pair<typename T::first_type, typename T::second_type>>;
|
||||||
|
template <typename T>
|
||||||
|
concept string_view_like = std::is_convertible_v<T, std::string_view> &&
|
||||||
|
!std::is_convertible_v<T, const char*>;
|
||||||
|
|
||||||
|
template<typename T>
|
||||||
|
concept constructible_from_string_view = std::is_constructible_v<T, std::string_view>
|
||||||
|
&& !std::is_same_v<T, std::string_view>
|
||||||
|
&& std::is_default_constructible_v<T>;
|
||||||
|
|
||||||
|
template<typename M>
|
||||||
|
concept string_view_keyed_map = string_view_like<typename M::key_type>
|
||||||
|
&& requires(std::remove_cvref_t<M>& m, typename M::key_type sv, typename M::mapped_type v) {
|
||||||
|
{ m.emplace(sv, v) } -> std::same_as<std::pair<typename M::iterator, bool>>;
|
||||||
|
};
|
||||||
|
|
||||||
/// Check if T is a container that we can append to, including:
|
/// Check if T is a container that we can append to, including:
|
||||||
/// std::vector, std::deque, std::list, std::string, ...
|
/// std::vector, std::deque, std::list, std::string, ...
|
||||||
template <typename T>
|
template <typename T>
|
||||||
concept appendable_containers =
|
concept appendable_containers =
|
||||||
details::supports_emplace_back<T> || details::supports_emplace<T> ||
|
(details::supports_emplace_back<T> || details::supports_emplace<T> ||
|
||||||
details::supports_push_back<T> || details::supports_push<T> ||
|
details::supports_push_back<T> || details::supports_push<T> ||
|
||||||
details::supports_add<T> || details::supports_append<T> ||
|
details::supports_add<T> || details::supports_append<T> ||
|
||||||
details::supports_insert<T>;
|
details::supports_insert<T>) && !string_view_keyed_map<T>;
|
||||||
|
|
||||||
/// Insert into the container however possible
|
/// Insert into the container however possible
|
||||||
template <appendable_containers T, typename... Args>
|
template <appendable_containers T, typename... Args>
|
||||||
@@ -99,7 +117,6 @@ concept optional_type = requires(std::remove_cvref_t<T> obj) {
|
|||||||
{ obj.value() } -> std::same_as<typename std::remove_cvref_t<T>::value_type&>;
|
{ obj.value() } -> std::same_as<typename std::remove_cvref_t<T>::value_type&>;
|
||||||
requires requires(typename std::remove_cvref_t<T>::value_type &&val) {
|
requires requires(typename std::remove_cvref_t<T>::value_type &&val) {
|
||||||
obj.emplace(std::move(val));
|
obj.emplace(std::move(val));
|
||||||
obj = std::move(val);
|
|
||||||
{
|
{
|
||||||
obj.value_or(val)
|
obj.value_or(val)
|
||||||
} -> std::convertible_to<typename std::remove_cvref_t<T>::value_type>;
|
} -> std::convertible_to<typename std::remove_cvref_t<T>::value_type>;
|
||||||
@@ -107,7 +124,9 @@ concept optional_type = requires(std::remove_cvref_t<T> obj) {
|
|||||||
{ static_cast<bool>(obj) } -> std::same_as<bool>; // convertible to bool
|
{ static_cast<bool>(obj) } -> std::same_as<bool>; // convertible to bool
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
} // namespace concepts
|
} // namespace concepts
|
||||||
} // namespace simdjson
|
} // namespace simdjson
|
||||||
#endif // SIMDJSON_SUPPORTS_DESERIALIZATION
|
#endif // SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
#endif // SIMDJSON_CONCEPTS_H
|
#endif // SIMDJSON_CONCEPTS_H
|
||||||
|
|||||||
@@ -0,0 +1,53 @@
|
|||||||
|
#ifndef SIMDJSON_CONSTEVALUTIL_H
|
||||||
|
#define SIMDJSON_CONSTEVALUTIL_H
|
||||||
|
|
||||||
|
#include <string>
|
||||||
|
#include <string_view>
|
||||||
|
#include <array>
|
||||||
|
|
||||||
|
#if SIMDJSON_CONSTEVAL
|
||||||
|
namespace simdjson {
|
||||||
|
namespace constevalutil {
|
||||||
|
|
||||||
|
constexpr static std::array<uint8_t, 256> json_quotable_character = {
|
||||||
|
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
|
||||||
|
1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
|
||||||
|
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
|
||||||
|
constexpr static std::array<std::string_view, 32> control_chars = {
|
||||||
|
"\\u0000", "\\u0001", "\\u0002", "\\u0003", "\\u0004", "\\u0005", "\\u0006",
|
||||||
|
"\\u0007", "\\b", "\\t", "\\n", "\\u000b", "\\f", "\\r",
|
||||||
|
"\\u000e", "\\u000f", "\\u0010", "\\u0011", "\\u0012", "\\u0013", "\\u0014",
|
||||||
|
"\\u0015", "\\u0016", "\\u0017", "\\u0018", "\\u0019", "\\u001a", "\\u001b",
|
||||||
|
"\\u001c", "\\u001d", "\\u001e", "\\u001f"};
|
||||||
|
// unoptimized, meant for compile-time execution
|
||||||
|
consteval std::string consteval_to_quoted_escaped(std::string_view input) {
|
||||||
|
std::string out = "\"";
|
||||||
|
for (char c : input) {
|
||||||
|
if (json_quotable_character[uint8_t(c)]) {
|
||||||
|
if (c == '"') {
|
||||||
|
out.append("\\\"");
|
||||||
|
} else if (c == '\\') {
|
||||||
|
out.append("\\\\");
|
||||||
|
} else {
|
||||||
|
std::string_view v = control_chars[uint8_t(c)];
|
||||||
|
out.append(v);
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
out.push_back(c);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out.push_back('"');
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
} // namespace constevalutil
|
||||||
|
} // namespace simdjson
|
||||||
|
#endif // SIMDJSON_CONSTEVAL
|
||||||
|
#endif // SIMDJSON_CONSTEVALUTIL_H
|
||||||
@@ -0,0 +1,123 @@
|
|||||||
|
|
||||||
|
#ifndef SIMDJSON_CONVERT_INL_H
|
||||||
|
#define SIMDJSON_CONVERT_INL_H
|
||||||
|
|
||||||
|
#include "simdjson/convert.h"
|
||||||
|
#if SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
|
namespace simdjson {
|
||||||
|
namespace convert {
|
||||||
|
namespace internal {
|
||||||
|
// auto_parser method definitions
|
||||||
|
template <typename parser_type>
|
||||||
|
inline auto_parser<parser_type>::auto_parser(parser_type &&parser, ondemand::document &&doc) noexcept requires(!std::is_pointer_v<parser_type>)
|
||||||
|
: m_parser{std::move(parser)}, m_doc{std::move(doc)} {}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline auto_parser<parser_type>::auto_parser(parser_type &&parser, padded_string_view const str) noexcept requires(!std::is_pointer_v<parser_type>)
|
||||||
|
: m_parser{std::move(parser)}, m_doc{}, m_error{SUCCESS} {
|
||||||
|
m_error = m_parser.iterate(str).get(m_doc);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline auto_parser<parser_type>::auto_parser(std::remove_pointer_t<parser_type> &parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>)
|
||||||
|
: m_parser{&parser}, m_doc{std::move(doc)} {}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline auto_parser<parser_type>::auto_parser(std::remove_pointer_t<parser_type> &parser, padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>)
|
||||||
|
: m_parser{&parser}, m_doc{}, m_error{SUCCESS} {
|
||||||
|
m_error = m_parser->iterate(str).get(m_doc);
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline auto_parser<parser_type>::auto_parser(padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>)
|
||||||
|
: auto_parser{ondemand::parser::get_parser(), str} {}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline auto_parser<parser_type>::auto_parser(parser_type parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>)
|
||||||
|
: auto_parser{*parser, std::move(doc)} {}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline std::remove_pointer_t<parser_type> &auto_parser<parser_type>::parser() noexcept {
|
||||||
|
if constexpr (std::is_pointer_v<parser_type>) {
|
||||||
|
return *m_parser;
|
||||||
|
} else {
|
||||||
|
return m_parser;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
template <typename T>
|
||||||
|
inline simdjson_result<T> auto_parser<parser_type>::result() noexcept(is_nothrow_gettable<T>) {
|
||||||
|
if (m_error != SUCCESS) {
|
||||||
|
return m_error;
|
||||||
|
}
|
||||||
|
return m_doc.get<T>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline simdjson_result<ondemand::array> auto_parser<parser_type>::array() noexcept {
|
||||||
|
return result<ondemand::array>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline simdjson_result<ondemand::object> auto_parser<parser_type>::object() noexcept {
|
||||||
|
return result<ondemand::object>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
inline simdjson_result<ondemand::number> auto_parser<parser_type>::number() noexcept {
|
||||||
|
return result<ondemand::number>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
template <typename T>
|
||||||
|
inline auto_parser<parser_type>::operator simdjson_result<T>() noexcept(is_nothrow_gettable<T>) {
|
||||||
|
return result<T>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
template <typename T>
|
||||||
|
inline auto_parser<parser_type>::operator T() noexcept(false) {
|
||||||
|
if (m_error != SUCCESS) {
|
||||||
|
throw simdjson_error(m_error);
|
||||||
|
}
|
||||||
|
return m_doc.get<T>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename parser_type>
|
||||||
|
template <typename T>
|
||||||
|
inline std::optional<T> auto_parser<parser_type>::optional() noexcept(is_nothrow_gettable<T>) {
|
||||||
|
if (m_error != SUCCESS) {
|
||||||
|
return std::nullopt;
|
||||||
|
}
|
||||||
|
T value;
|
||||||
|
if (m_doc.get<T>().get(value)) [[unlikely]] {
|
||||||
|
return std::nullopt;
|
||||||
|
}
|
||||||
|
return {std::move(value)};
|
||||||
|
}
|
||||||
|
|
||||||
|
// to_adaptor method definitions
|
||||||
|
template <typename T>
|
||||||
|
inline T to_adaptor<T>::operator()(simdjson_result<ondemand::value> &val) const noexcept {
|
||||||
|
return val.get<T>();
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
inline auto to_adaptor<T>::operator()(padded_string_view const str) const noexcept {
|
||||||
|
return auto_parser{str};
|
||||||
|
}
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
inline auto to_adaptor<T>::operator()(ondemand::parser &parser, padded_string_view const str) const noexcept {
|
||||||
|
return auto_parser<ondemand::parser *>{parser, str};
|
||||||
|
}
|
||||||
|
} // namespace internal
|
||||||
|
} // namespace convert
|
||||||
|
} // namespace simdjson
|
||||||
|
#endif // SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
|
#endif // SIMDJSON_CONVERT_INL_H
|
||||||
@@ -0,0 +1,111 @@
|
|||||||
|
|
||||||
|
#ifndef SIMDJSON_CONVERT_H
|
||||||
|
#define SIMDJSON_CONVERT_H
|
||||||
|
|
||||||
|
#include "simdjson/ondemand.h"
|
||||||
|
#include <optional>
|
||||||
|
|
||||||
|
#if SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
|
|
||||||
|
|
||||||
|
namespace simdjson {
|
||||||
|
namespace convert {
|
||||||
|
namespace internal {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A utility class for automatically parsing JSON documents.
|
||||||
|
* This template is NOT part of our public API.
|
||||||
|
* It is subject to changes.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
template <typename parser_type = ondemand::parser*>
|
||||||
|
struct auto_parser {
|
||||||
|
private:
|
||||||
|
parser_type m_parser;
|
||||||
|
ondemand::document m_doc;
|
||||||
|
error_code m_error{SUCCESS};
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
static constexpr bool is_nothrow_gettable = requires(ondemand::document doc) {
|
||||||
|
{ doc.get<T>() } noexcept;
|
||||||
|
};
|
||||||
|
public:
|
||||||
|
explicit auto_parser(parser_type &&parser, ondemand::document &&doc) noexcept requires(!std::is_pointer_v<parser_type>);
|
||||||
|
explicit auto_parser(parser_type &&parser, padded_string_view const str) noexcept requires(!std::is_pointer_v<parser_type>);
|
||||||
|
explicit auto_parser(std::remove_pointer_t<parser_type> &parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>);
|
||||||
|
explicit auto_parser(std::remove_pointer_t<parser_type> &parser, padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>);
|
||||||
|
explicit auto_parser(padded_string_view const str) noexcept requires(std::is_pointer_v<parser_type>);
|
||||||
|
explicit auto_parser(parser_type parser, ondemand::document &&doc) noexcept requires(std::is_pointer_v<parser_type>);
|
||||||
|
auto_parser(auto_parser const &) = delete;
|
||||||
|
auto_parser &operator=(auto_parser const &) = delete;
|
||||||
|
auto_parser(auto_parser &&) noexcept = default;
|
||||||
|
auto_parser &operator=(auto_parser &&) noexcept = default;
|
||||||
|
~auto_parser() = default;
|
||||||
|
|
||||||
|
simdjson_warn_unused std::remove_pointer_t<parser_type> &parser() noexcept;
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
simdjson_warn_unused simdjson_inline simdjson_result<T> result() noexcept(is_nothrow_gettable<T>);
|
||||||
|
|
||||||
|
simdjson_warn_unused simdjson_inline simdjson_result<ondemand::array> array() noexcept;
|
||||||
|
simdjson_warn_unused simdjson_inline simdjson_result<ondemand::object> object() noexcept;
|
||||||
|
simdjson_warn_unused simdjson_inline simdjson_result<ondemand::number> number() noexcept;
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
simdjson_warn_unused simdjson_inline explicit(false) operator simdjson_result<T>() noexcept(is_nothrow_gettable<T>);
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
simdjson_warn_unused simdjson_inline explicit(false) operator T() noexcept(false);
|
||||||
|
|
||||||
|
template <typename T>
|
||||||
|
simdjson_warn_unused simdjson_inline std::optional<T> optional() noexcept(is_nothrow_gettable<T>);
|
||||||
|
};
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A utility class for adapting values for the `auto_parser`.
|
||||||
|
* This template is not part of our public API. It is subject to changes.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
template <typename T = void>
|
||||||
|
struct to_adaptor {
|
||||||
|
T operator()(simdjson_result<ondemand::value> &val) const noexcept;
|
||||||
|
auto operator()(padded_string_view const str) const noexcept;
|
||||||
|
auto operator()(ondemand::parser &parser, padded_string_view const str) const noexcept;
|
||||||
|
};
|
||||||
|
} // namespace internal
|
||||||
|
} // namespace convert
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The simdjson::from instance is EXPERIMENTAL AND SUBJECT TO CHANGES.
|
||||||
|
*
|
||||||
|
* The `from` instance is a utility adaptor for parsing JSON strings into objects.
|
||||||
|
* It provides a convenient way to convert JSON data into C++ objects using the `auto_parser`.
|
||||||
|
*
|
||||||
|
* Example usage:
|
||||||
|
*
|
||||||
|
* ```cpp
|
||||||
|
* std::map<std::string, std::string> obj =
|
||||||
|
* simdjson::from(R"({"key": "value"})"_padded);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* This will parse the JSON string and return an object representation. By default, we
|
||||||
|
* use the simdjson::ondemand::parser::get_parser() instance. A parser instance should
|
||||||
|
* be used for just one document at a time.
|
||||||
|
*
|
||||||
|
* You can also pass you own parser instance:
|
||||||
|
* ```cpp
|
||||||
|
* simdjson::ondemand::parser parser;
|
||||||
|
* std::map<std::string, std::string> obj =
|
||||||
|
* simdjson::from(parser, R"({"key": "value"})"_padded);
|
||||||
|
* ```
|
||||||
|
* The parser instance can be reused.
|
||||||
|
*
|
||||||
|
* This functionality requires C++20 or better.
|
||||||
|
*/
|
||||||
|
static constexpr convert::internal::to_adaptor<> from{};
|
||||||
|
|
||||||
|
} // namespace simdjson
|
||||||
|
|
||||||
|
#endif // SIMDJSON_SUPPORTS_CONCEPTS
|
||||||
|
#endif // SIMDJSON_CONVERT_H
|
||||||
@@ -52,11 +52,22 @@ inline simdjson_result<dom::element> simdjson_result<dom::array>::at_pointer(std
|
|||||||
return at_pointer(json_pointer);
|
return at_pointer(json_pointer);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline simdjson_result<std::vector<dom::element>> simdjson_result<dom::array>::at_path_with_wildcard(std::string_view json_path) const noexcept {
|
||||||
|
if (error()) {
|
||||||
|
return error();
|
||||||
|
}
|
||||||
|
return first.at_path_with_wildcard(json_path);
|
||||||
|
}
|
||||||
|
|
||||||
inline simdjson_result<dom::element> simdjson_result<dom::array>::at(size_t index) const noexcept {
|
inline simdjson_result<dom::element> simdjson_result<dom::array>::at(size_t index) const noexcept {
|
||||||
if (error()) { return error(); }
|
if (error()) { return error(); }
|
||||||
return first.at(index);
|
return first.at(index);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline std::vector<dom::element>& simdjson_result<dom::array>::get_values(std::vector<dom::element>& out) const noexcept {
|
||||||
|
return first.get_values(out);
|
||||||
|
}
|
||||||
|
|
||||||
namespace dom {
|
namespace dom {
|
||||||
|
|
||||||
//
|
//
|
||||||
@@ -127,6 +138,93 @@ inline simdjson_result<element> array::at_path(std::string_view json_path) const
|
|||||||
return at_pointer(json_pointer);
|
return at_pointer(json_pointer);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline void array::process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept {
|
||||||
|
if (current == end) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
simdjson_result<std::vector<element>> result;
|
||||||
|
|
||||||
|
|
||||||
|
for (auto it = current; it != end; ++it) {
|
||||||
|
std::vector<element> child_result;
|
||||||
|
auto error = it->at_path_with_wildcard(path_suffix).get(child_result);
|
||||||
|
if(error) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
accumulator.reserve(accumulator.size() + child_result.size());
|
||||||
|
accumulator.insert(accumulator.end(),
|
||||||
|
std::make_move_iterator(child_result.begin()),
|
||||||
|
std::make_move_iterator(child_result.end()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
inline simdjson_result<std::vector<element>> array::at_path_with_wildcard(std::string_view json_path) const noexcept {
|
||||||
|
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
|
||||||
|
|
||||||
|
size_t i = 0;
|
||||||
|
// json_path.starts_with('$') requires C++20.
|
||||||
|
if (!json_path.empty() && json_path.front() == '$') {
|
||||||
|
i = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (i >= json_path.size() || (json_path[i] != '.' && json_path[i] != '[')) {
|
||||||
|
return INVALID_JSON_POINTER;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (json_path.find("*") != std::string::npos) {
|
||||||
|
std::vector<element> child_values;
|
||||||
|
|
||||||
|
if (
|
||||||
|
(json_path.compare(i, 3, "[*]") == 0 && json_path.size() == i + 3) ||
|
||||||
|
(json_path.compare(i, 2,".*") == 0 && json_path.size() == i + 2)
|
||||||
|
) {
|
||||||
|
get_values(child_values);
|
||||||
|
return child_values;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::pair<std::string_view, std::string_view> key_and_json_path = get_next_key_and_json_path(json_path);
|
||||||
|
|
||||||
|
std::string_view key = key_and_json_path.first;
|
||||||
|
json_path = key_and_json_path.second;
|
||||||
|
|
||||||
|
if (key.size() > 0) {
|
||||||
|
if (key == "*") {
|
||||||
|
get_values(child_values);
|
||||||
|
} else {
|
||||||
|
element pointer_result;
|
||||||
|
std::string json_pointer = std::string("/") + std::string(key);
|
||||||
|
auto error = at_pointer(json_pointer).get(pointer_result);
|
||||||
|
|
||||||
|
if (!error) {
|
||||||
|
child_values.emplace_back(pointer_result);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
std::vector<element> result = {};
|
||||||
|
|
||||||
|
if (child_values.size() > 0) {
|
||||||
|
std::vector<element>::iterator child_values_begin = child_values.begin();
|
||||||
|
std::vector<element>::iterator child_values_end = child_values.end();
|
||||||
|
|
||||||
|
process_json_path_of_child_elements(child_values_begin, child_values_end, json_path, result);
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
} else {
|
||||||
|
return INVALID_JSON_POINTER;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
element result;
|
||||||
|
auto error = at_path(json_path).get(result);
|
||||||
|
if (error) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
|
||||||
|
return std::vector<element>{std::move(result)};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
inline simdjson_result<element> array::at(size_t index) const noexcept {
|
inline simdjson_result<element> array::at(size_t index) const noexcept {
|
||||||
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
|
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
|
||||||
size_t i=0;
|
size_t i=0;
|
||||||
@@ -137,6 +235,15 @@ inline simdjson_result<element> array::at(size_t index) const noexcept {
|
|||||||
return INDEX_OUT_OF_BOUNDS;
|
return INDEX_OUT_OF_BOUNDS;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline std::vector<element>& array::get_values(std::vector<element>& out) const noexcept {
|
||||||
|
out.reserve(this->size());
|
||||||
|
for (auto element : *this) {
|
||||||
|
out.emplace_back(element);
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
}
|
||||||
|
|
||||||
inline array::operator element() const noexcept {
|
inline array::operator element() const noexcept {
|
||||||
return element(tape);
|
return element(tape);
|
||||||
}
|
}
|
||||||
@@ -183,13 +290,13 @@ inline bool array::iterator::operator>(const array::iterator& other) const noexc
|
|||||||
|
|
||||||
#include "simdjson/dom/element-inl.h"
|
#include "simdjson/dom/element-inl.h"
|
||||||
|
|
||||||
#if defined(__cpp_lib_ranges)
|
#if SIMDJSON_SUPPORTS_RANGES
|
||||||
static_assert(std::ranges::view<simdjson::dom::array>);
|
static_assert(std::ranges::view<simdjson::dom::array>);
|
||||||
static_assert(std::ranges::sized_range<simdjson::dom::array>);
|
static_assert(std::ranges::sized_range<simdjson::dom::array>);
|
||||||
#if SIMDJSON_EXCEPTIONS
|
#if SIMDJSON_EXCEPTIONS
|
||||||
static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::array>>);
|
static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::array>>);
|
||||||
static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::array>>);
|
static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::array>>);
|
||||||
#endif // SIMDJSON_EXCEPTIONS
|
#endif // SIMDJSON_EXCEPTIONS
|
||||||
#endif // defined(__cpp_lib_ranges)
|
#endif // SIMDJSON_SUPPORTS_RANGES
|
||||||
|
|
||||||
#endif // SIMDJSON_ARRAY_INL_H
|
#endif // SIMDJSON_ARRAY_INL_H
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
#ifndef SIMDJSON_DOM_ARRAY_H
|
#ifndef SIMDJSON_DOM_ARRAY_H
|
||||||
#define SIMDJSON_DOM_ARRAY_H
|
#define SIMDJSON_DOM_ARRAY_H
|
||||||
|
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
#include "simdjson/dom/base.h"
|
#include "simdjson/dom/base.h"
|
||||||
#include "simdjson/internal/tape_ref.h"
|
#include "simdjson/internal/tape_ref.h"
|
||||||
|
|
||||||
@@ -57,7 +59,7 @@ public:
|
|||||||
iterator& operator=(const iterator&) noexcept = default;
|
iterator& operator=(const iterator&) noexcept = default;
|
||||||
private:
|
private:
|
||||||
simdjson_inline iterator(const internal::tape_ref &tape) noexcept;
|
simdjson_inline iterator(const internal::tape_ref &tape) noexcept;
|
||||||
internal::tape_ref tape;
|
internal::tape_ref tape{};
|
||||||
friend class array;
|
friend class array;
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -108,6 +110,17 @@ public:
|
|||||||
*/
|
*/
|
||||||
inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept;
|
inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recursive function which processes the json path of each child element
|
||||||
|
*/
|
||||||
|
inline void process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept;
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds support for JSONPath expression with wildcards '*'
|
||||||
|
*/
|
||||||
|
inline simdjson_result<std::vector<element>> at_path_with_wildcard(std::string_view json_path) const noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the value associated with the given JSONPath expression. We only support
|
* Get the value associated with the given JSONPath expression. We only support
|
||||||
* JSONPath queries that trivially convertible to JSON Pointer queries: key
|
* JSONPath queries that trivially convertible to JSON Pointer queries: key
|
||||||
@@ -141,6 +154,15 @@ public:
|
|||||||
*/
|
*/
|
||||||
inline simdjson_result<element> at(size_t index) const noexcept;
|
inline simdjson_result<element> at(size_t index) const noexcept;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the values of items in an array element
|
||||||
|
* This function has linear-time complexity: the values are checked one by one.
|
||||||
|
*
|
||||||
|
* @return The child elements of an array
|
||||||
|
*/
|
||||||
|
|
||||||
|
inline std::vector<element>& get_values(std::vector<element>& out) const noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Implicitly convert object to element
|
* Implicitly convert object to element
|
||||||
*/
|
*/
|
||||||
@@ -148,7 +170,7 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
simdjson_inline array(const internal::tape_ref &tape) noexcept;
|
simdjson_inline array(const internal::tape_ref &tape) noexcept;
|
||||||
internal::tape_ref tape;
|
internal::tape_ref tape{};
|
||||||
friend class element;
|
friend class element;
|
||||||
friend struct simdjson_result<element>;
|
friend struct simdjson_result<element>;
|
||||||
template<typename T>
|
template<typename T>
|
||||||
@@ -167,8 +189,11 @@ public:
|
|||||||
simdjson_inline simdjson_result(error_code error) noexcept; ///< @private
|
simdjson_inline simdjson_result(error_code error) noexcept; ///< @private
|
||||||
|
|
||||||
inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept;
|
inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept;
|
||||||
|
inline void process_json_path_of_child_elements(std::vector<dom::element>::iterator& current, std::vector<dom::element>::iterator& end, const std::string_view& path_suffix, std::vector<dom::element>& accumulator) const noexcept;
|
||||||
|
inline simdjson_result<std::vector<dom::element>> at_path_with_wildcard(std::string_view json_path) const noexcept;
|
||||||
inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept;
|
inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept;
|
||||||
inline simdjson_result<dom::element> at(size_t index) const noexcept;
|
inline simdjson_result<dom::element> at(size_t index) const noexcept;
|
||||||
|
inline std::vector<dom::element>& get_values(std::vector<dom::element>& out) const noexcept;
|
||||||
|
|
||||||
#if SIMDJSON_EXCEPTIONS
|
#if SIMDJSON_EXCEPTIONS
|
||||||
inline dom::array::iterator begin() const noexcept(false);
|
inline dom::array::iterator begin() const noexcept(false);
|
||||||
@@ -181,9 +206,7 @@ public:
|
|||||||
|
|
||||||
} // namespace simdjson
|
} // namespace simdjson
|
||||||
|
|
||||||
#if defined(__cpp_lib_ranges)
|
#if SIMDJSON_SUPPORTS_RANGES
|
||||||
#include <ranges>
|
|
||||||
|
|
||||||
namespace std {
|
namespace std {
|
||||||
namespace ranges {
|
namespace ranges {
|
||||||
template<>
|
template<>
|
||||||
@@ -194,6 +217,6 @@ inline constexpr bool enable_view<simdjson::simdjson_result<simdjson::dom::array
|
|||||||
#endif // SIMDJSON_EXCEPTIONS
|
#endif // SIMDJSON_EXCEPTIONS
|
||||||
} // namespace ranges
|
} // namespace ranges
|
||||||
} // namespace std
|
} // namespace std
|
||||||
#endif // defined(__cpp_lib_ranges)
|
#endif // SIMDJSON_SUPPORTS_RANGES
|
||||||
|
|
||||||
#endif // SIMDJSON_DOM_ARRAY_H
|
#endif // SIMDJSON_DOM_ARRAY_H
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ public:
|
|||||||
* The memory allocation is strict: you
|
* The memory allocation is strict: you
|
||||||
* can you use this function to increase
|
* can you use this function to increase
|
||||||
* or lower the amount of allocated memory.
|
* or lower the amount of allocated memory.
|
||||||
* Passsing zero clears the memory.
|
* Passing zero clears the memory.
|
||||||
*/
|
*/
|
||||||
error_code allocate(size_t len) noexcept;
|
error_code allocate(size_t len) noexcept;
|
||||||
/** @private Capacity in bytes, in terms
|
/** @private Capacity in bytes, in terms
|
||||||
|
|||||||
@@ -128,6 +128,12 @@ simdjson_inline simdjson_result<dom::element> simdjson_result<dom::element>::at_
|
|||||||
if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
|
if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
|
||||||
return at_pointer(json_pointer);
|
return at_pointer(json_pointer);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
simdjson_inline simdjson_result<std::vector<dom::element>> simdjson_result<dom::element>::at_path_with_wildcard(const std::string_view json_path) const noexcept {
|
||||||
|
if (error()) { return error(); }
|
||||||
|
return first.at_path_with_wildcard(json_path);
|
||||||
|
}
|
||||||
|
|
||||||
#ifndef SIMDJSON_DISABLE_DEPRECATED_API
|
#ifndef SIMDJSON_DISABLE_DEPRECATED_API
|
||||||
[[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
|
[[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
|
||||||
simdjson_inline simdjson_result<dom::element> simdjson_result<dom::element>::at(const std::string_view json_pointer) const noexcept {
|
simdjson_inline simdjson_result<dom::element> simdjson_result<dom::element>::at(const std::string_view json_pointer) const noexcept {
|
||||||
@@ -418,6 +424,20 @@ inline simdjson_result<element> element::at_pointer(std::string_view json_pointe
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline simdjson_result<std::vector<element>> element::at_path_with_wildcard(std::string_view json_path) const noexcept {
|
||||||
|
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
|
||||||
|
|
||||||
|
switch (tape.tape_ref_type()) {
|
||||||
|
case internal::tape_type::START_OBJECT:
|
||||||
|
return object(tape).at_path_with_wildcard(json_path);
|
||||||
|
case internal::tape_type::START_ARRAY:
|
||||||
|
return array(tape).at_path_with_wildcard(json_path);
|
||||||
|
default:
|
||||||
|
return std::vector<element>{};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
inline simdjson_result<element> element::at_path(std::string_view json_path) const noexcept {
|
inline simdjson_result<element> element::at_path(std::string_view json_path) const noexcept {
|
||||||
auto json_pointer = json_path_to_pointer_conversion(json_path);
|
auto json_pointer = json_path_to_pointer_conversion(json_path);
|
||||||
if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
|
if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
#ifndef SIMDJSON_DOM_ELEMENT_H
|
#ifndef SIMDJSON_DOM_ELEMENT_H
|
||||||
#define SIMDJSON_DOM_ELEMENT_H
|
#define SIMDJSON_DOM_ELEMENT_H
|
||||||
|
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
#include "simdjson/dom/base.h"
|
#include "simdjson/dom/base.h"
|
||||||
#include "simdjson/dom/array.h"
|
#include "simdjson/dom/array.h"
|
||||||
|
|
||||||
@@ -372,6 +374,8 @@ public:
|
|||||||
* - INCORRECT_TYPE if this is not an object
|
* - INCORRECT_TYPE if this is not an object
|
||||||
*/
|
*/
|
||||||
inline simdjson_result<element> operator[](const char *key) const noexcept;
|
inline simdjson_result<element> operator[](const char *key) const noexcept;
|
||||||
|
simdjson_result<element> operator[](int) const noexcept = delete;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the value associated with the given JSON pointer. We use the RFC 6901
|
* Get the value associated with the given JSON pointer. We use the RFC 6901
|
||||||
@@ -397,6 +401,8 @@ public:
|
|||||||
*/
|
*/
|
||||||
inline simdjson_result<element> at_pointer(const std::string_view json_pointer) const noexcept;
|
inline simdjson_result<element> at_pointer(const std::string_view json_pointer) const noexcept;
|
||||||
|
|
||||||
|
inline simdjson_result<std::vector<element>> at_path_with_wildcard(const std::string_view json_path) const noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the value associated with the given JSONPath expression. We only support
|
* Get the value associated with the given JSONPath expression. We only support
|
||||||
* JSONPath queries that trivially convertible to JSON Pointer queries: key
|
* JSONPath queries that trivially convertible to JSON Pointer queries: key
|
||||||
@@ -490,7 +496,7 @@ public:
|
|||||||
|
|
||||||
private:
|
private:
|
||||||
simdjson_inline element(const internal::tape_ref &tape) noexcept;
|
simdjson_inline element(const internal::tape_ref &tape) noexcept;
|
||||||
internal::tape_ref tape;
|
internal::tape_ref tape{};
|
||||||
friend class document;
|
friend class document;
|
||||||
friend class object;
|
friend class object;
|
||||||
friend class array;
|
friend class array;
|
||||||
@@ -540,7 +546,9 @@ public:
|
|||||||
|
|
||||||
simdjson_inline simdjson_result<dom::element> operator[](std::string_view key) const noexcept;
|
simdjson_inline simdjson_result<dom::element> operator[](std::string_view key) const noexcept;
|
||||||
simdjson_inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
|
simdjson_inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
|
||||||
|
simdjson_result<dom::element> operator[](int) const noexcept = delete;
|
||||||
simdjson_inline simdjson_result<dom::element> at_pointer(const std::string_view json_pointer) const noexcept;
|
simdjson_inline simdjson_result<dom::element> at_pointer(const std::string_view json_pointer) const noexcept;
|
||||||
|
simdjson_inline simdjson_result<std::vector<dom::element>> at_path_with_wildcard(const std::string_view json_path) const noexcept;
|
||||||
simdjson_inline simdjson_result<dom::element> at_path(const std::string_view json_path) const noexcept;
|
simdjson_inline simdjson_result<dom::element> at_path(const std::string_view json_path) const noexcept;
|
||||||
[[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
|
[[deprecated("For standard compliance, use at_pointer instead, and prefix your pointers with a slash '/', see RFC6901 ")]]
|
||||||
simdjson_inline simdjson_result<dom::element> at(const std::string_view json_pointer) const noexcept;
|
simdjson_inline simdjson_result<dom::element> at(const std::string_view json_pointer) const noexcept;
|
||||||
|
|||||||
@@ -40,10 +40,19 @@ inline simdjson_result<dom::element> simdjson_result<dom::object>::at_path(std::
|
|||||||
if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
|
if (json_pointer == "-1") { return INVALID_JSON_POINTER; }
|
||||||
return at_pointer(json_pointer);
|
return at_pointer(json_pointer);
|
||||||
}
|
}
|
||||||
|
inline simdjson_result<std::vector<dom::element>> simdjson_result<dom::object>::at_path_with_wildcard(std::string_view json_path) const noexcept {
|
||||||
|
if (error()) {
|
||||||
|
return error();
|
||||||
|
}
|
||||||
|
return first.at_path_with_wildcard(json_path);
|
||||||
|
}
|
||||||
inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key(std::string_view key) const noexcept {
|
inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key(std::string_view key) const noexcept {
|
||||||
if (error()) { return error(); }
|
if (error()) { return error(); }
|
||||||
return first.at_key(key);
|
return first.at_key(key);
|
||||||
}
|
}
|
||||||
|
inline std::vector<dom::element>& simdjson_result<dom::object>::get_values(std::vector<dom::element>& out) const noexcept {
|
||||||
|
return first.get_values(out);
|
||||||
|
}
|
||||||
inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key_case_insensitive(std::string_view key) const noexcept {
|
inline simdjson_result<dom::element> simdjson_result<dom::object>::at_key_case_insensitive(std::string_view key) const noexcept {
|
||||||
if (error()) { return error(); }
|
if (error()) { return error(); }
|
||||||
return first.at_key_case_insensitive(key);
|
return first.at_key_case_insensitive(key);
|
||||||
@@ -143,6 +152,97 @@ inline simdjson_result<element> object::at_path(std::string_view json_path) cons
|
|||||||
return at_pointer(json_pointer);
|
return at_pointer(json_pointer);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline void object::process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept {
|
||||||
|
if (current == end) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
simdjson_result<std::vector<element>> result;
|
||||||
|
|
||||||
|
for (auto it = current; it != end; ++it) {
|
||||||
|
std::vector<element> child_result;
|
||||||
|
auto error = it->at_path_with_wildcard(path_suffix).get(child_result);
|
||||||
|
if(error) {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
accumulator.reserve(accumulator.size() + child_result.size());
|
||||||
|
accumulator.insert(accumulator.end(),
|
||||||
|
std::make_move_iterator(child_result.begin()),
|
||||||
|
std::make_move_iterator(child_result.end()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
inline simdjson_result<std::vector<element>> object::at_path_with_wildcard(std::string_view json_path) const noexcept {
|
||||||
|
SIMDJSON_DEVELOPMENT_ASSERT(tape.usable()); // https://github.com/simdjson/simdjson/issues/1914
|
||||||
|
|
||||||
|
size_t i = 0;
|
||||||
|
if (json_path.empty()) {
|
||||||
|
return INVALID_JSON_POINTER;
|
||||||
|
}
|
||||||
|
// if JSONPath starts with $, skip it
|
||||||
|
// json_path.starts_with('$') requires C++20.
|
||||||
|
if (json_path.front() == '$') {
|
||||||
|
i = 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (i >= json_path.size() || (json_path[i] != '.' && json_path[i] != '[')) {
|
||||||
|
// expect json path to always start with $ but this isn't currently
|
||||||
|
// expected in jsonpathutil.h.
|
||||||
|
return INVALID_JSON_POINTER;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (json_path.find("*") != std::string::npos) {
|
||||||
|
|
||||||
|
std::vector<element> child_values;
|
||||||
|
|
||||||
|
if (
|
||||||
|
(json_path.compare(i, 3, "[*]") == 0 && json_path.size() == i + 3) ||
|
||||||
|
(json_path.compare(i, 2,".*") == 0 && json_path.size() == i + 2)
|
||||||
|
) {
|
||||||
|
get_values(child_values);
|
||||||
|
return child_values;
|
||||||
|
}
|
||||||
|
|
||||||
|
std::pair<std::string_view, std::string_view> key_and_json_path = get_next_key_and_json_path(json_path);
|
||||||
|
|
||||||
|
std::string_view key = key_and_json_path.first;
|
||||||
|
json_path = key_and_json_path.second;
|
||||||
|
|
||||||
|
if (key.size() > 0) {
|
||||||
|
if (key == "*") {
|
||||||
|
get_values(child_values);
|
||||||
|
} else {
|
||||||
|
element pointer_result;
|
||||||
|
auto error = at_pointer(std::string("/") + std::string(key)).get(pointer_result);
|
||||||
|
|
||||||
|
if (!error) {
|
||||||
|
child_values.emplace_back(pointer_result);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
std::vector<element> result = {};
|
||||||
|
if (child_values.size() > 0) {
|
||||||
|
|
||||||
|
std::vector<element>::iterator child_values_begin = child_values.begin();
|
||||||
|
std::vector<element>::iterator child_values_end = child_values.end();
|
||||||
|
|
||||||
|
process_json_path_of_child_elements(child_values_begin, child_values_end, json_path, result);
|
||||||
|
}
|
||||||
|
|
||||||
|
return result;
|
||||||
|
} else {
|
||||||
|
return INVALID_JSON_POINTER;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
element result;
|
||||||
|
auto error = this->at_path(json_path).get(result);
|
||||||
|
if (error) {
|
||||||
|
return error;
|
||||||
|
}
|
||||||
|
return std::vector<element>{std::move(result)};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
inline simdjson_result<element> object::at_key(std::string_view key) const noexcept {
|
inline simdjson_result<element> object::at_key(std::string_view key) const noexcept {
|
||||||
iterator end_field = end();
|
iterator end_field = end();
|
||||||
for (iterator field = begin(); field != end_field; ++field) {
|
for (iterator field = begin(); field != end_field; ++field) {
|
||||||
@@ -152,6 +252,18 @@ inline simdjson_result<element> object::at_key(std::string_view key) const noexc
|
|||||||
}
|
}
|
||||||
return NO_SUCH_FIELD;
|
return NO_SUCH_FIELD;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
inline std::vector<element>& object::get_values(std::vector<element>& out) const noexcept {
|
||||||
|
iterator end_field = end();
|
||||||
|
iterator begin_field = begin();
|
||||||
|
|
||||||
|
out.reserve(std::distance(begin_field, end_field));
|
||||||
|
for (iterator field = begin_field; field != end_field; ++field) {
|
||||||
|
out.emplace_back(field.value());
|
||||||
|
}
|
||||||
|
|
||||||
|
return out;
|
||||||
|
}
|
||||||
// In case you wonder why we need this, please see
|
// In case you wonder why we need this, please see
|
||||||
// https://github.com/simdjson/simdjson/issues/323
|
// https://github.com/simdjson/simdjson/issues/323
|
||||||
// People do seek keys in a case-insensitive manner.
|
// People do seek keys in a case-insensitive manner.
|
||||||
@@ -263,13 +375,13 @@ inline key_value_pair::key_value_pair(std::string_view _key, element _value) noe
|
|||||||
|
|
||||||
} // namespace simdjson
|
} // namespace simdjson
|
||||||
|
|
||||||
#if defined(__cpp_lib_ranges)
|
#if SIMDJSON_SUPPORTS_RANGES
|
||||||
static_assert(std::ranges::view<simdjson::dom::object>);
|
static_assert(std::ranges::view<simdjson::dom::object>);
|
||||||
static_assert(std::ranges::sized_range<simdjson::dom::object>);
|
static_assert(std::ranges::sized_range<simdjson::dom::object>);
|
||||||
#if SIMDJSON_EXCEPTIONS
|
#if SIMDJSON_EXCEPTIONS
|
||||||
static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::object>>);
|
static_assert(std::ranges::view<simdjson::simdjson_result<simdjson::dom::object>>);
|
||||||
static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::object>>);
|
static_assert(std::ranges::sized_range<simdjson::simdjson_result<simdjson::dom::object>>);
|
||||||
#endif // SIMDJSON_EXCEPTIONS
|
#endif // SIMDJSON_EXCEPTIONS
|
||||||
#endif // defined(__cpp_lib_ranges)
|
#endif // SIMDJSON_SUPPORTS_RANGES
|
||||||
|
|
||||||
#endif // SIMDJSON_OBJECT_INL_H
|
#endif // SIMDJSON_OBJECT_INL_H
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
#ifndef SIMDJSON_DOM_OBJECT_H
|
#ifndef SIMDJSON_DOM_OBJECT_H
|
||||||
#define SIMDJSON_DOM_OBJECT_H
|
#define SIMDJSON_DOM_OBJECT_H
|
||||||
|
|
||||||
|
#include <vector>
|
||||||
|
|
||||||
#include "simdjson/dom/base.h"
|
#include "simdjson/dom/base.h"
|
||||||
#include "simdjson/dom/element.h"
|
#include "simdjson/dom/element.h"
|
||||||
#include "simdjson/internal/tape_ref.h"
|
#include "simdjson/internal/tape_ref.h"
|
||||||
@@ -89,7 +91,7 @@ public:
|
|||||||
private:
|
private:
|
||||||
simdjson_inline iterator(const internal::tape_ref &tape) noexcept;
|
simdjson_inline iterator(const internal::tape_ref &tape) noexcept;
|
||||||
|
|
||||||
internal::tape_ref tape;
|
internal::tape_ref tape{};
|
||||||
|
|
||||||
friend class object;
|
friend class object;
|
||||||
};
|
};
|
||||||
@@ -145,6 +147,7 @@ public:
|
|||||||
* - INCORRECT_TYPE if this is not an object
|
* - INCORRECT_TYPE if this is not an object
|
||||||
*/
|
*/
|
||||||
inline simdjson_result<element> operator[](const char *key) const noexcept;
|
inline simdjson_result<element> operator[](const char *key) const noexcept;
|
||||||
|
simdjson_result<element> operator[](int) const noexcept = delete;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the value associated with the given JSON pointer. We use the RFC 6901
|
* Get the value associated with the given JSON pointer. We use the RFC 6901
|
||||||
@@ -171,6 +174,16 @@ public:
|
|||||||
*/
|
*/
|
||||||
inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept;
|
inline simdjson_result<element> at_pointer(std::string_view json_pointer) const noexcept;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Recursive function which processes the json path of each child element
|
||||||
|
*/
|
||||||
|
inline void process_json_path_of_child_elements(std::vector<element>::iterator& current, std::vector<element>::iterator& end, const std::string_view& path_suffix, std::vector<element>& accumulator) const noexcept;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds support for JSONPath expression with wildcards '*'
|
||||||
|
*/
|
||||||
|
inline simdjson_result<std::vector<element>> at_path_with_wildcard(std::string_view json_path) const noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the value associated with the given JSONPath expression. We only support
|
* Get the value associated with the given JSONPath expression. We only support
|
||||||
* JSONPath queries that trivially convertible to JSON Pointer queries: key
|
* JSONPath queries that trivially convertible to JSON Pointer queries: key
|
||||||
@@ -202,6 +215,14 @@ public:
|
|||||||
*/
|
*/
|
||||||
inline simdjson_result<element> at_key(std::string_view key) const noexcept;
|
inline simdjson_result<element> at_key(std::string_view key) const noexcept;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets the values associated with keys of an object
|
||||||
|
* This function has linear-time complexity: the keys are checked one by one.
|
||||||
|
*
|
||||||
|
* @return the values associated with each key of an object
|
||||||
|
*/
|
||||||
|
inline std::vector<element>& get_values(std::vector<element>& out) const noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get the value associated with the given key in a case-insensitive manner.
|
* Get the value associated with the given key in a case-insensitive manner.
|
||||||
* It is only guaranteed to work over ASCII inputs.
|
* It is only guaranteed to work over ASCII inputs.
|
||||||
@@ -223,7 +244,7 @@ public:
|
|||||||
private:
|
private:
|
||||||
simdjson_inline object(const internal::tape_ref &tape) noexcept;
|
simdjson_inline object(const internal::tape_ref &tape) noexcept;
|
||||||
|
|
||||||
internal::tape_ref tape;
|
internal::tape_ref tape{};
|
||||||
|
|
||||||
friend class element;
|
friend class element;
|
||||||
friend struct simdjson_result<element>;
|
friend struct simdjson_result<element>;
|
||||||
@@ -258,9 +279,13 @@ public:
|
|||||||
|
|
||||||
inline simdjson_result<dom::element> operator[](std::string_view key) const noexcept;
|
inline simdjson_result<dom::element> operator[](std::string_view key) const noexcept;
|
||||||
inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
|
inline simdjson_result<dom::element> operator[](const char *key) const noexcept;
|
||||||
|
simdjson_result<dom::element> operator[](int) const noexcept = delete;
|
||||||
inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept;
|
inline simdjson_result<dom::element> at_pointer(std::string_view json_pointer) const noexcept;
|
||||||
|
inline void process_json_path_of_child_elements(std::vector<dom::element>::iterator& current, std::vector<dom::element>::iterator& end, const std::string_view& path_suffix, std::vector<dom::element>& accumulator) const noexcept;
|
||||||
|
inline simdjson_result<std::vector<dom::element>> at_path_with_wildcard(std::string_view json_path_new) const noexcept;
|
||||||
inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept;
|
inline simdjson_result<dom::element> at_path(std::string_view json_path) const noexcept;
|
||||||
inline simdjson_result<dom::element> at_key(std::string_view key) const noexcept;
|
inline simdjson_result<dom::element> at_key(std::string_view key) const noexcept;
|
||||||
|
inline std::vector<dom::element>& get_values(std::vector<dom::element>& out) const noexcept;
|
||||||
inline simdjson_result<dom::element> at_key_case_insensitive(std::string_view key) const noexcept;
|
inline simdjson_result<dom::element> at_key_case_insensitive(std::string_view key) const noexcept;
|
||||||
|
|
||||||
#if SIMDJSON_EXCEPTIONS
|
#if SIMDJSON_EXCEPTIONS
|
||||||
@@ -272,9 +297,7 @@ public:
|
|||||||
|
|
||||||
} // namespace simdjson
|
} // namespace simdjson
|
||||||
|
|
||||||
#if defined(__cpp_lib_ranges)
|
#if SIMDJSON_SUPPORTS_RANGES
|
||||||
#include <ranges>
|
|
||||||
|
|
||||||
namespace std {
|
namespace std {
|
||||||
namespace ranges {
|
namespace ranges {
|
||||||
template<>
|
template<>
|
||||||
@@ -285,6 +308,6 @@ inline constexpr bool enable_view<simdjson::simdjson_result<simdjson::dom::objec
|
|||||||
#endif // SIMDJSON_EXCEPTIONS
|
#endif // SIMDJSON_EXCEPTIONS
|
||||||
} // namespace ranges
|
} // namespace ranges
|
||||||
} // namespace std
|
} // namespace std
|
||||||
#endif // defined(__cpp_lib_ranges)
|
#endif // SIMDJSON_SUPPORTS_RANGES
|
||||||
|
|
||||||
#endif // SIMDJSON_DOM_OBJECT_H
|
#endif // SIMDJSON_DOM_OBJECT_H
|
||||||
|
|||||||
@@ -35,11 +35,11 @@ inline bool parser::dump_raw_tape(std::ostream &os) const noexcept {
|
|||||||
return valid ? doc.dump_raw_tape(os) : false;
|
return valid ? doc.dump_raw_tape(os) : false;
|
||||||
}
|
}
|
||||||
|
|
||||||
inline simdjson_result<size_t> parser::read_file(const std::string &path) noexcept {
|
inline simdjson_result<size_t> parser::read_file(std::string_view path) noexcept {
|
||||||
// Open the file
|
// Open the file
|
||||||
SIMDJSON_PUSH_DISABLE_WARNINGS
|
SIMDJSON_PUSH_DISABLE_WARNINGS
|
||||||
SIMDJSON_DISABLE_DEPRECATED_WARNING // Disable CRT_SECURE warning on MSVC: manually verified this is safe
|
SIMDJSON_DISABLE_DEPRECATED_WARNING // Disable CRT_SECURE warning on MSVC: manually verified this is safe
|
||||||
std::FILE *fp = std::fopen(path.c_str(), "rb");
|
std::FILE *fp = std::fopen(path.data(), "rb");
|
||||||
SIMDJSON_POP_DISABLE_WARNINGS
|
SIMDJSON_POP_DISABLE_WARNINGS
|
||||||
|
|
||||||
if (fp == nullptr) {
|
if (fp == nullptr) {
|
||||||
@@ -91,18 +91,18 @@ inline simdjson_result<size_t> parser::read_file(const std::string &path) noexce
|
|||||||
return bytes_read;
|
return bytes_read;
|
||||||
}
|
}
|
||||||
|
|
||||||
inline simdjson_result<element> parser::load(const std::string &path) & noexcept {
|
inline simdjson_result<element> parser::load(std::string_view path) & noexcept {
|
||||||
return load_into_document(doc, path);
|
return load_into_document(doc, path);
|
||||||
}
|
}
|
||||||
|
|
||||||
inline simdjson_result<element> parser::load_into_document(document& provided_doc, const std::string &path) & noexcept {
|
inline simdjson_result<element> parser::load_into_document(document& provided_doc, std::string_view path) & noexcept {
|
||||||
size_t len;
|
size_t len;
|
||||||
auto _error = read_file(path).get(len);
|
auto _error = read_file(path).get(len);
|
||||||
if (_error) { return _error; }
|
if (_error) { return _error; }
|
||||||
return parse_into_document(provided_doc, loaded_bytes.get(), len, false);
|
return parse_into_document(provided_doc, loaded_bytes.get(), len, false);
|
||||||
}
|
}
|
||||||
|
|
||||||
inline simdjson_result<document_stream> parser::load_many(const std::string &path, size_t batch_size) noexcept {
|
inline simdjson_result<document_stream> parser::load_many(std::string_view path, size_t batch_size) noexcept {
|
||||||
size_t len;
|
size_t len;
|
||||||
auto _error = read_file(path).get(len);
|
auto _error = read_file(path).get(len);
|
||||||
if (_error) { return _error; }
|
if (_error) { return _error; }
|
||||||
|
|||||||
@@ -102,8 +102,8 @@ public:
|
|||||||
* - other json errors if parsing fails. You should not rely on these errors to always the same for the
|
* - other json errors if parsing fails. You should not rely on these errors to always the same for the
|
||||||
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
|
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
|
||||||
*/
|
*/
|
||||||
inline simdjson_result<element> load(const std::string &path) & noexcept;
|
inline simdjson_result<element> load(std::string_view path) & noexcept;
|
||||||
inline simdjson_result<element> load(const std::string &path) && = delete ;
|
inline simdjson_result<element> load(std::string_view path) && = delete ;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Load a JSON document from a file into a provide document instance and return a temporary reference to it.
|
* Load a JSON document from a file into a provide document instance and return a temporary reference to it.
|
||||||
@@ -148,8 +148,8 @@ public:
|
|||||||
* - other json errors if parsing fails. You should not rely on these errors to always the same for the
|
* - other json errors if parsing fails. You should not rely on these errors to always the same for the
|
||||||
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
|
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
|
||||||
*/
|
*/
|
||||||
inline simdjson_result<element> load_into_document(document& doc, const std::string &path) & noexcept;
|
inline simdjson_result<element> load_into_document(document& doc, std::string_view path) & noexcept;
|
||||||
inline simdjson_result<element> load_into_document(document& doc, const std::string &path) && =delete;
|
inline simdjson_result<element> load_into_document(document& doc, std::string_view path) && =delete;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse a JSON document and return a temporary reference to it.
|
* Parse a JSON document and return a temporary reference to it.
|
||||||
@@ -202,6 +202,22 @@ public:
|
|||||||
* simdjson::dom::parser parser;
|
* simdjson::dom::parser parser;
|
||||||
* simdjson::dom::element element = parser.parse(padded_json_copy.get(), json_len, false);
|
* simdjson::dom::element element = parser.parse(padded_json_copy.get(), json_len, false);
|
||||||
*
|
*
|
||||||
|
* ### std::string references
|
||||||
|
*
|
||||||
|
* If you pass a mutable std::string reference (std::string&), the parser will seek to extend
|
||||||
|
* its capacity to SIMDJSON_PADDING bytes beyond the end of the string.
|
||||||
|
*
|
||||||
|
* Whenever you pass an std::string reference, the parser will access the bytes beyond the end of
|
||||||
|
* the string but before the end of the allocated memory (std::string::capacity()).
|
||||||
|
* If you are using a sanitizer that checks for reading uninitialized bytes or std::string's
|
||||||
|
* container-overflow checks, you may encounter sanitizer warnings.
|
||||||
|
* You can safely ignore these warnings. Or you can call simdjson::pad(std::string&) to pad the
|
||||||
|
* string with SIMDJSON_PADDING spaces: this function returns a simdjson::padding_string_view
|
||||||
|
* which can be be passed to the parser's parse function:
|
||||||
|
*
|
||||||
|
* std::string json = R"({ "foo": 1 } { "foo": 2 } { "foo": 3 } )";
|
||||||
|
* element doc = parser.parse(simdjson::pad(json));
|
||||||
|
*
|
||||||
* ### Parser Capacity
|
* ### Parser Capacity
|
||||||
*
|
*
|
||||||
* If the parser's current capacity is less than len, it will allocate enough capacity
|
* If the parser's current capacity is less than len, it will allocate enough capacity
|
||||||
@@ -324,7 +340,7 @@ public:
|
|||||||
* arrays or objects) MUST be separated with whitespace.
|
* arrays or objects) MUST be separated with whitespace.
|
||||||
*
|
*
|
||||||
* The documents must not exceed batch_size bytes (by default 1MB) or they will fail to parse.
|
* The documents must not exceed batch_size bytes (by default 1MB) or they will fail to parse.
|
||||||
* Setting batch_size to excessively large or excesively small values may impact negatively the
|
* Setting batch_size to excessively large or excessively small values may impact negatively the
|
||||||
* performance.
|
* performance.
|
||||||
*
|
*
|
||||||
* ### Error Handling
|
* ### Error Handling
|
||||||
@@ -370,7 +386,7 @@ public:
|
|||||||
* - other json errors if parsing fails. You should not rely on these errors to always the same for the
|
* - other json errors if parsing fails. You should not rely on these errors to always the same for the
|
||||||
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
|
* same document: they may vary under runtime dispatch (so they may vary depending on your system and hardware).
|
||||||
*/
|
*/
|
||||||
inline simdjson_result<document_stream> load_many(const std::string &path, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
|
inline simdjson_result<document_stream> load_many(std::string_view path, size_t batch_size = dom::DEFAULT_BATCH_SIZE) noexcept;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Parse a buffer containing many JSON documents.
|
* Parse a buffer containing many JSON documents.
|
||||||
@@ -418,7 +434,7 @@ public:
|
|||||||
* arrays or objects) MUST be separated with whitespace.
|
* arrays or objects) MUST be separated with whitespace.
|
||||||
*
|
*
|
||||||
* The documents must not exceed batch_size bytes (by default 1MB) or they will fail to parse.
|
* The documents must not exceed batch_size bytes (by default 1MB) or they will fail to parse.
|
||||||
* Setting batch_size to excessively large or excesively small values may impact negatively the
|
* Setting batch_size to excessively large or excessively small values may impact negatively the
|
||||||
* performance.
|
* performance.
|
||||||
*
|
*
|
||||||
* ### Error Handling
|
* ### Error Handling
|
||||||
@@ -641,7 +657,7 @@ private:
|
|||||||
inline error_code ensure_capacity(document& doc, size_t desired_capacity) noexcept;
|
inline error_code ensure_capacity(document& doc, size_t desired_capacity) noexcept;
|
||||||
|
|
||||||
/** Read the file into loaded_bytes */
|
/** Read the file into loaded_bytes */
|
||||||
inline simdjson_result<size_t> read_file(const std::string &path) noexcept;
|
inline simdjson_result<size_t> read_file(std::string_view path) noexcept;
|
||||||
|
|
||||||
friend class parser::Iterator;
|
friend class parser::Iterator;
|
||||||
friend class document_stream;
|
friend class document_stream;
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user