Compare commits
142 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| cd4a074653 | |||
| 0ab7e2d701 | |||
| 0a694273e2 | |||
| b9b20be80e | |||
| f902769b35 | |||
| 389f7ce8e3 | |||
| 32b52e3f34 | |||
| b3fe96cdb2 | |||
| 45d296e219 | |||
| c1681e9d0a | |||
| 63b10bca21 | |||
| 3b782fab7a | |||
| df16e96767 | |||
| 2e7ad956eb | |||
| 30d7204312 | |||
| b6af1a0456 | |||
| 7cc60672e3 | |||
| 3ecda9ee99 | |||
| b648a5fc0a | |||
| 4ec44e88c9 | |||
| ede3129081 | |||
| 8ea4c1c2e6 | |||
| 486b2a3828 | |||
| 22773f3c70 | |||
| 249eb2c28a | |||
| 94c429aa70 | |||
| 72e51a9a81 | |||
| 1a57afec1f | |||
| 4de7426b9f | |||
| 85cadf4074 | |||
| bc48e72070 | |||
| 8955c2c6d5 | |||
| 73e69a5e84 | |||
| fb83b114ef | |||
| 542cd7af71 | |||
| 769364abb2 | |||
| f25d5f9fc2 | |||
| 12fb30ae9c | |||
| c0a952687d | |||
| 307ddd4415 | |||
| 21657455ed | |||
| afb1c9f4b1 | |||
| 9973f7b3a3 | |||
| 18d612df15 | |||
| bddb23177e | |||
| 2c5de6c6ed | |||
| 844e5eac23 | |||
| 45caa861cd | |||
| 50bf372d3f | |||
| b4a0fd3ff4 | |||
| a1ff05a5e8 | |||
| 5395aacb8b | |||
| 781ea4b495 | |||
| 03e8d14eee | |||
| be94694290 | |||
| 6065b3b424 | |||
| 019bf1dfe0 | |||
| 2922822622 | |||
| 262ddad037 | |||
| ba007b0cb9 | |||
| ec675d9c61 | |||
| 7dcc196f66 | |||
| 7ec4572d33 | |||
| 5891d4b64b | |||
| 3cd9875f1f | |||
| 6cf1bdba43 | |||
| 817f10dd7d | |||
| e829566589 | |||
| dbe0c1543e | |||
| 06c774c655 | |||
| 95d8c81810 | |||
| af2a43610e | |||
| e362b18499 | |||
| 6e60ed8338 | |||
| e2ca00c841 | |||
| b7124f7c64 | |||
| e6c6db6493 | |||
| 6fffc99dac | |||
| 8c5cc8c443 | |||
| d8c49a8f25 | |||
| cda98064b8 | |||
| e532d61e16 | |||
| db93de2a21 | |||
| fc57c09cf0 | |||
| 2058b47dfe | |||
| b0486c7fa2 | |||
| feb1e7feb6 | |||
| 2c7fbc1538 | |||
| 8b69401d8a | |||
| f504e57e7a | |||
| 135c173053 | |||
| b4ed3a99a9 | |||
| d8e1b36c88 | |||
| c249a1b456 | |||
| 9c4b793c90 | |||
| dd92a8414c | |||
| 835bdba123 | |||
| ad3cd71ca2 | |||
| 860f7e0458 | |||
| 980f2ad3af | |||
| 7ad9fe63a6 | |||
| 7987418b1f | |||
| 5e871f6724 | |||
| 5d16fd5f31 | |||
| 4e9ff03af5 | |||
| aa7489060a | |||
| ae32422891 | |||
| 667d0ed3c7 | |||
| b1c31b428d | |||
| 56ac56ba32 | |||
| 19549c60ec | |||
| 16e99f229b | |||
| 21342a4142 | |||
| d0e841d3e9 | |||
| a962652ec3 | |||
| 77d73b068a | |||
| 19ff7a572d | |||
| 235dbc5369 | |||
| 2b9c8977af | |||
| 3d87bd4abc | |||
| a60c0d1e39 | |||
| 86bfbaada7 | |||
| ccac6403d9 | |||
| aade58c3dc | |||
| 3319815e25 | |||
| a24f845bd7 | |||
| 212e2d5857 | |||
| 547e156e33 | |||
| 98a45f7229 | |||
| 8589509d1e | |||
| 2fce4a843d | |||
| 62803512e4 | |||
| 76d9dee854 | |||
| bf15f21b0b | |||
| 32b301893c | |||
| 7f1531a1f9 | |||
| 0a3b555ff7 | |||
| 114d45ad54 | |||
| bf52d8198b | |||
| def2b6efd2 | |||
| d326f2ce9f | |||
| ca42a49fba |
@@ -29,6 +29,9 @@ We accept the identification of an issue by a sanitizer or some checker tool (e.
|
||||
|
||||
We recommend that you run your tests using different optimization levels. In particular, we recommend your run tests with the simdjson library and you code compiled in debug mode. The simdjson then sets the SIMDJSON_DEVELOPMENT_CHECKS macro to 1, and this triggers additional checks on your code and on the internals of the library. If possible, we recommend that you run tests with sanitizers (e.g., see [No more leaks with sanitize flags in gcc and clang](https://lemire.me/blog/2016/04/20/no-more-leaks-with-sanitize-flags-in-gcc-and-clang/)). You can compile the library with sanitizers for debugging purposes (e.g., set SIMDJSON_SANITIZE to ON using CMake), but you should also turn on sanitizers on your own code. You may also use tools like valgrind or the commercial equivalent.
|
||||
|
||||
Mixing debug and release simdjson code is unsafe: you either build all your code using simdjson in
|
||||
release mode or all of it in debug mode.
|
||||
|
||||
Before reporting a bug, please ensure that you have read our documentation.
|
||||
|
||||
**To Reproduce**
|
||||
@@ -38,7 +41,7 @@ If we cannot reproduce the issue, then we cannot address it. Note that a stack t
|
||||
|
||||
It should be possible to trigger the bug by using solely simdjson with our default build setup. If you can only observe the bug within some specific context, with some other software, please reduce the issue first.
|
||||
|
||||
**simjson release**
|
||||
**simdjson release**
|
||||
|
||||
Unless you plan to contribute to simdjson, you should only work from releases. Please be mindful that our main branch may have additional features, bugs and documentation items.
|
||||
|
||||
@@ -55,6 +58,7 @@ We support up-to-date 64-bit ARM and x64 FreeBSD, macOS, Windows and Linux syste
|
||||
* We do not support unreleased or experimental compilers. If you encounter an issue with a
|
||||
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.
|
||||
* Vendors (e.g., Apple and Microsoft) stop supporting old systems. Once a compiler system is no longer supported by its vendor, we no longer support it. We will gladly accept code contributions, but we do not consider it a *bug* if you have issues with an obsolete compiler systems. This policy extends to obsolete standard libraries, linkers and other build tools. Please do not report it as an issue. If you cannot resolve the issue yourself, we encourage you to reach out to the vendor for legacy support.
|
||||
|
||||
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).
|
||||
|
||||
|
||||
@@ -6,6 +6,7 @@ Description
|
||||
|
||||
Type of change
|
||||
- [ ] Bug fix
|
||||
- [ ] Optimization
|
||||
- [ ] New feature
|
||||
- [ ] Refactor / cleanup
|
||||
- [ ] Documentation / tests
|
||||
@@ -19,7 +20,7 @@ How to verify / test
|
||||
Please read before contributing:
|
||||
- CONTRIBUTING: https://github.com/simdjson/simdjson/blob/master/CONTRIBUTING.md
|
||||
- HACKING: https://github.com/simdjson/simdjson/blob/master/HACKING.md
|
||||
|
||||
- AI Usage Policy: https://github.com/simdjson/simdjson/blob/master/AI_USAGE_POLICY.md
|
||||
|
||||
|
||||
If you can, we recommend running our tests with the sanitizers turned on.
|
||||
|
||||
@@ -42,3 +42,14 @@ jobs:
|
||||
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 buildshared && cd buildshared && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../buildshared/destination .. && cmake --build .
|
||||
- name: Use cmake (parsing for NaN/Infinity enabled)
|
||||
run: |
|
||||
mkdir build_nan_inf &&
|
||||
cd build_nan_inf &&
|
||||
cmake -DSIMDJSON_ENABLE_NAN_INF=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=ON -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_nan_inf && cd build_nan_inf && cmake -DCMAKE_INSTALL_PREFIX:PATH=../../../build_nan_inf/destination .. && cmake --build .
|
||||
|
||||
@@ -19,11 +19,11 @@ jobs:
|
||||
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)
|
||||
CC=clang-18 CXX=clang++-18 CFLAGS="--target=riscv64-linux-gnu -march=rv64gcv_zvbb" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build
|
||||
cmake --build build/ -j$(nproc) --config Release
|
||||
- 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"
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
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)
|
||||
|
||||
@@ -19,11 +19,6 @@ jobs:
|
||||
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)
|
||||
CC=clang-17 CXX=clang++-17 CFLAGS="--target=riscv64-linux-gnu -march=rv64gcv" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build
|
||||
cmake --build build/ -j$(nproc) --config Release
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
name: Ubuntu rvv VLEN=128 (clang 20)
|
||||
|
||||
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-20
|
||||
- name: Build
|
||||
run: |
|
||||
CC=clang-20 CXX=clang++-20 CFLAGS="--target=riscv64-linux-gnu -march=rv64gcv" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build
|
||||
cmake --build build/ -j$(nproc) --config Release
|
||||
- name: Test VLEN=128
|
||||
run: |
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
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)
|
||||
- name: Build VLS
|
||||
run: |
|
||||
CC=clang-20 CXX=clang++-20 CFLAGS="--target=riscv64-linux-gnu -march=rv64gcv_zvl128b_zba_zbb_zbc -mrvv-vector-bits=zvl" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build-vls
|
||||
cmake --build build-vls/ -j$(nproc) --config Release
|
||||
- name: Test VLEN=128 VLS
|
||||
run: |
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
QEMU_CPU="rv64,v=on,zba=on,zbb=on,zbc=on,vlen=128,rvv_ta_all_1s=on,rvv_ma_all_1s=on" \
|
||||
ctest --timeout 1800 --output-on-failure --test-dir build-vls -j $(nproc)
|
||||
@@ -19,11 +19,21 @@ jobs:
|
||||
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)
|
||||
CC=riscv64-linux-gnu-gcc-14 CXX=riscv64-linux-gnu-g++-14 CFLAGS=-march=rv64gcv CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build
|
||||
cmake --build build/ -j$(nproc) --config Release
|
||||
- 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"
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
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)
|
||||
- name: Build VLS
|
||||
run: |
|
||||
CC=riscv64-linux-gnu-gcc-14 CXX=riscv64-linux-gnu-g++-14 CFLAGS="-march=rv64gcv_zvl256b -mrvv-vector-bits=zvl" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build-vls
|
||||
cmake --build build-vls/ -j$(nproc) --config Release
|
||||
- name: Test VLEN=256 VLS
|
||||
run: |
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
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-vls -j $(nproc)
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
name: Ubuntu rvv VLEN=512 (clang 19)
|
||||
|
||||
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-19
|
||||
- name: Build
|
||||
run: |
|
||||
CC=clang-19 CXX=clang++-19 CFLAGS="--target=riscv64-linux-gnu -march=rv64gcv" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build
|
||||
cmake --build build/ -j$(nproc) --config Release
|
||||
- name: Test VLEN=512
|
||||
run: |
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
QEMU_CPU="rv64,v=on,vlen=512,rvv_ta_all_1s=on,rvv_ma_all_1s=on" \
|
||||
ctest --timeout 1800 --output-on-failure --test-dir build -j $(nproc)
|
||||
- name: Build VLS
|
||||
run: |
|
||||
CC=clang-19 CXX=clang++-19 CFLAGS="--target=riscv64-linux-gnu -march=rv64gcv_zvl512b_zba_zbb_zbc -mrvv-vector-bits=zvl" CXXFLAGS="${CFLAGS}" \
|
||||
cmake --toolchain=cmake/toolchains-ci/riscv64-linux-gnu.cmake -DSIMDJSON_DEVELOPER_MODE=ON -B build-vls
|
||||
cmake --build build-vls/ -j$(nproc) --config Release
|
||||
- name: Test VLEN=512 VLS
|
||||
run: |
|
||||
QEMU_LD_PREFIX="/usr/riscv64-linux-gnu" \
|
||||
QEMU_CPU="rv64,v=on,zba=on,zbb=on,zbc=on,vlen=512,rvv_ta_all_1s=on,rvv_ma_all_1s=on" \
|
||||
ctest --timeout 1800 --output-on-failure --test-dir build-vls -j $(nproc)
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Performance check on Ubuntu 20.04 CI (GCC 9)
|
||||
name: Performance check on Ubuntu 24.04 CI (GCC 13)
|
||||
|
||||
on:
|
||||
push:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Ubuntu 20.04 CI (GCC 9) without exceptions
|
||||
name: Ubuntu 24.04 CI (GCC 13) without exceptions
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
@@ -24,7 +24,7 @@ jobs:
|
||||
cd .. &&
|
||||
mkdir build &&
|
||||
cd build &&
|
||||
cmake -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_EXCEPTIONS=OFF -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. &&
|
||||
cmake -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_GOOGLE_BENCHMARKS=ON -DSIMDJSON_EXCEPTIONS=OFF -DBUILD_SHARED_LIBS=OFF -DCMAKE_INSTALL_PREFIX:PATH=destination .. &&
|
||||
cmake --build . &&
|
||||
ctest --output-on-failure -LE explicitonly -j &&
|
||||
make install &&
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
name: Ubuntu 20.04 CI (GCC 9) Without Threads
|
||||
name: Ubuntu 24.04 CI (GCC 13) Without Threads
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
name: Ubuntu 20.04 CI (GCC 9) With Memory Sanitizer
|
||||
name: Ubuntu 24.04 CI (GCC 13) With Memory Sanitizer
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
ubuntu-build-address-sanitizier:
|
||||
ubuntu-build-address-sanitizer:
|
||||
if: >-
|
||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||
! contains(toJSON(github.event.commits.*.message), '[skip github]')
|
||||
@@ -21,6 +21,13 @@ jobs:
|
||||
cmake -DSIMDJSON_SANITIZE=ON -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
|
||||
- name: Use cmake with address sanitizer (Parsing of NaN/Infinity enabled)
|
||||
run: |
|
||||
mkdir builddebug_nan_inf &&
|
||||
cd builddebug_nan_inf &&
|
||||
cmake -DSIMDJSON_SANITIZE=ON -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_ENABLE_NAN_INF=ON .. &&
|
||||
cmake --build . &&
|
||||
ctest --output-on-failure -LE explicitonly -j
|
||||
ubuntu-build-undefined-sanitizer:
|
||||
if: >-
|
||||
! contains(toJSON(github.event.commits.*.message), '[skip ci]') &&
|
||||
@@ -39,3 +46,10 @@ jobs:
|
||||
cmake -DSIMDJSON_SANITIZE_UNDEFINED=ON -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
|
||||
- name: Use cmake with undefined sanitizer (Parsing of NaN/Infinity enabled)
|
||||
run: |
|
||||
mkdir builddebugundefsani_nan_inf &&
|
||||
cd builddebugundefsani_nan_inf &&
|
||||
cmake -DSIMDJSON_SANITIZE_UNDEFINED=ON -DCMAKE_BUILD_TYPE=Debug -DSIMDJSON_GOOGLE_BENCHMARKS=OFF -DSIMDJSON_DEVELOPER_MODE=ON -DBUILD_SHARED_LIBS=OFF -DSIMDJSON_ENABLE_NAN_INF=ON .. &&
|
||||
cmake --build . &&
|
||||
ctest --output-on-failure -LE explicitonly -j
|
||||
|
||||
@@ -12,14 +12,15 @@ jobs:
|
||||
shared: [ON, OFF]
|
||||
cxx: [g++-13, clang++-16]
|
||||
sanitizer: [ON, OFF]
|
||||
nan_inf: [ON, OFF]
|
||||
build_type: [RelWithDebInfo, Debug, Release]
|
||||
steps:
|
||||
- uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
|
||||
- name: Prepare
|
||||
run: cmake -DCMAKE_BUILD_TYPE=${{matrix.build_type}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_SANITIZE=${{matrix.sanitizer}} -DBUILD_SHARED_LIBS=${{matrix.shared}} -B build
|
||||
run: cmake -DCMAKE_BUILD_TYPE=${{matrix.build_type}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_SANITIZE=${{matrix.sanitizer}} -DBUILD_SHARED_LIBS=${{matrix.shared}} -DSIMDJSON_ENABLE_NAN_INF=${{matrix.nan_inf}} -B build
|
||||
env:
|
||||
CXX: ${{matrix.cxx}}
|
||||
- name: Build
|
||||
run: cmake --build build -j=2
|
||||
- name: Test
|
||||
run: ctest --output-on-failure --test-dir build
|
||||
run: ctest --output-on-failure --test-dir build
|
||||
|
||||
@@ -13,18 +13,22 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- {gen: Visual Studio 17 2022, arch: Win32, shared: ON, build_type: Release}
|
||||
- {gen: Visual Studio 17 2022, arch: Win32, shared: OFF, build_type: Release}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: ON, build_type: Release}
|
||||
- {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}
|
||||
- {gen: Visual Studio 17 2022, arch: Win32, shared: ON, build_type: Release, memory_map: OFF, nan_inf: OFF}
|
||||
- {gen: Visual Studio 17 2022, arch: Win32, shared: OFF, build_type: Release, memory_map: OFF, nan_inf: OFF}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: ON, build_type: Release, memory_map: OFF, nan_inf: OFF}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Debug, memory_map: OFF, nan_inf: OFF}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Release, memory_map: OFF, nan_inf: OFF}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: RelWithDebInfo, memory_map: OFF, nan_inf: OFF}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Debug, memory_map: OFF, nan_inf: ON}
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Release, memory_map: OFF, nan_inf: ON}
|
||||
# Exercise the opt-in Windows memory-file mapping path at least once in CI.
|
||||
- {gen: Visual Studio 17 2022, arch: x64, shared: OFF, build_type: Release, memory_map: ON, nan_inf: OFF}
|
||||
steps:
|
||||
- name: checkout
|
||||
uses: actions/checkout@v4
|
||||
- name: Configure
|
||||
run: |
|
||||
cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -DBUILD_SHARED_LIBS=${{matrix.shared}} -B build
|
||||
cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -DSIMDJSON_DEVELOPER_MODE=ON -DSIMDJSON_COMPETITION=OFF -DBUILD_SHARED_LIBS=${{matrix.shared}} -DSIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=${{matrix.memory_map}} -DSIMDJSON_ENABLE_NAN_INF=${{matrix.nan_inf}} -B build
|
||||
- name: Build Debug
|
||||
run: cmake --build build --config ${{matrix.build_type}} --verbose
|
||||
- name: Run tests
|
||||
@@ -37,4 +41,4 @@ jobs:
|
||||
- name: Test Installation
|
||||
run: |
|
||||
cmake -G "${{matrix.gen}}" -A ${{matrix.arch}} -B build_install_test tests/installation_tests/find
|
||||
cmake --build build_install_test --config ${{matrix.build_type}}
|
||||
cmake --build build_install_test --config ${{matrix.build_type}}
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
# AI Usage Policy
|
||||
|
||||
Contributors can use whatever tools they would like to
|
||||
craft their contributions, but there must be a **human in the loop**.
|
||||
**Contributors must read and review all LLM-generated code or text before they
|
||||
ask other project members to review it.** The contributor is always the author
|
||||
and is fully accountable for their contributions. Contributors should be
|
||||
sufficiently confident that the contribution is high enough quality that asking
|
||||
for a review is a good use of scarce maintainer time, and they should be **able
|
||||
to answer questions about their work** during review.
|
||||
|
||||
We expect that new contributors will be less confident in their contributions,
|
||||
and our guidance to them is to **start with small contributions** that they can
|
||||
fully understand to build confidence. We aspire to be a welcoming community
|
||||
that helps new contributors grow their expertise, but learning involves taking
|
||||
small steps, getting feedback, and iterating. Passing maintainer feedback to an
|
||||
LLM doesn't help anyone grow, and does not sustain our community.
|
||||
|
||||
This policy includes, but is not limited to, the following kinds of
|
||||
contributions:
|
||||
|
||||
- Code, usually in the form of a pull request
|
||||
- Issues or security vulnerabilities
|
||||
- Comments and feedback on pull requests
|
||||
|
||||
## Extractive Contributions
|
||||
|
||||
The reason for our "human-in-the-loop" contribution policy is that processing
|
||||
patches, PRs, RFCs, and comments is not free -- it takes a lot of
|
||||
maintainer time and energy to review those contributions! Sending the
|
||||
unreviewed output of an LLM to open source project maintainers *extracts* work
|
||||
from them in the form of design and code review, so we call this kind of
|
||||
contribution an "extractive contribution".
|
||||
|
||||
## Transparency
|
||||
|
||||
For contributions involving significant AI assistance, we encourage you to disclose
|
||||
its use and explain your process. If a submission appears to rely heavily on AI
|
||||
without disclosure, we may doubt that the **human-in-the-loop** requirement has
|
||||
been met. Please show awareness of your use of AI.
|
||||
|
||||
## Copyright
|
||||
|
||||
Artificial intelligence systems raise many questions around copyright that have
|
||||
yet to be answered. Our policy on AI tools is similar to our copyright policy:
|
||||
Contributors are responsible for ensuring that they have the right to
|
||||
contribute code under the terms of our license, typically meaning that either
|
||||
they, their employer, or their collaborators hold the copyright. Using AI tools
|
||||
to regenerate copyrighted material does not remove the copyright, and
|
||||
contributors are responsible for ensuring that such material does not appear in
|
||||
their contributions. Contributions found to violate this policy will be removed
|
||||
just like any other offending contribution.
|
||||
|
||||
## Reference
|
||||
|
||||
- [LLVM AI Tool Use Policy](https://discourse.llvm.org/t/rfc-llvm-ai-tool-policy-human-in-the-loop/89159)
|
||||
@@ -1,9 +1,18 @@
|
||||
cmake_minimum_required(VERSION 3.14)
|
||||
|
||||
# Build performance optimizations
|
||||
set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE BOOL "Export compile commands for faster IDE integration")
|
||||
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
|
||||
|
||||
# Enable parallel compilation on MSVC
|
||||
if(MSVC)
|
||||
add_compile_options(/MP)
|
||||
endif()
|
||||
|
||||
project(
|
||||
simdjson
|
||||
# The version number is modified by tools/release.py
|
||||
VERSION 4.1.0
|
||||
VERSION 4.6.1
|
||||
DESCRIPTION "Parsing gigabytes of JSON per second"
|
||||
HOMEPAGE_URL "https://simdjson.org/"
|
||||
LANGUAGES CXX C
|
||||
@@ -20,8 +29,8 @@ string(
|
||||
# ---- Options, variables ----
|
||||
|
||||
# These version numbers are modified by tools/release.py
|
||||
set(SIMDJSON_LIB_VERSION "28.0.0" CACHE STRING "simdjson library version")
|
||||
set(SIMDJSON_LIB_SOVERSION "28" CACHE STRING "simdjson library soversion")
|
||||
set(SIMDJSON_LIB_VERSION "33.0.0" CACHE STRING "simdjson library version")
|
||||
set(SIMDJSON_LIB_SOVERSION "33" 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)
|
||||
if(SIMDJSON_BUILD_STATIC_LIB AND NOT BUILD_SHARED_LIBS)
|
||||
@@ -66,10 +75,48 @@ if(SIMDJSON_DEVELOPMENT_CHECKS)
|
||||
)
|
||||
endif()
|
||||
|
||||
# padded_memory_map is always available on POSIX. On Windows it is disabled
|
||||
# by default because it depends on the `CreateFileMapping2` / `MapViewOfFile3`
|
||||
# APIs, which require Windows 10 version 1803 or later and are exported via
|
||||
# onecore.lib rather than the default kernel32.lib. Turn this option ON to
|
||||
# opt into the feature on Windows; simdjson will then set the appropriate
|
||||
# Windows version macros and link onecore, so everything that links
|
||||
# simdjson picks up both the compile-time declarations and the import
|
||||
# library automatically. The option is a no-op on POSIX (where the feature
|
||||
# is unconditionally enabled).
|
||||
option(SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS
|
||||
"Enable simdjson::padded_memory_map on Windows (requires Windows 10 \
|
||||
version 1803 or later). Always enabled on POSIX." OFF)
|
||||
if(SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS)
|
||||
simdjson_add_props(
|
||||
target_compile_definitions PUBLIC
|
||||
SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=1
|
||||
)
|
||||
if(WIN32)
|
||||
# Raise the Windows version floor so that <windows.h> declares the
|
||||
# modern memory-mapping APIs, and link the import library that
|
||||
# actually exports them. _WIN32_WINNT / WINVER / NTDDI_VERSION together
|
||||
# tell <sdkddkver.h> which APIs to light up.
|
||||
simdjson_add_props(
|
||||
target_compile_definitions PUBLIC
|
||||
_WIN32_WINNT=0x0A00
|
||||
WINVER=0x0A00
|
||||
NTDDI_VERSION=0x0A000006 # NTDDI_WIN10_RS5, Windows 10 version 1809
|
||||
)
|
||||
simdjson_add_props(
|
||||
target_link_libraries PUBLIC
|
||||
onecore
|
||||
)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
if(is_top_project)
|
||||
option(SIMDJSON_INSTALL "Enable target install" ON)
|
||||
option(SIMDJSON_DEVELOPER_MODE "Enable targets for developing simdjson" OFF)
|
||||
option(BUILD_SHARED_LIBS "Build simdjson as a shared library" OFF)
|
||||
option(SIMDJSON_SINGLEHEADER "Disable singleheader generation" ON)
|
||||
else()
|
||||
option(SIMDJSON_INSTALL "Enable target install" ${BUILD_SHARED_LIBS})
|
||||
endif()
|
||||
|
||||
include(cmake/handle-deprecations.cmake)
|
||||
@@ -83,10 +130,45 @@ add_library(simdjson ${SIMDJSON_SOURCES})
|
||||
add_library(simdjson::simdjson ALIAS simdjson)
|
||||
set(SIMDJSON_LIBRARIES simdjson)
|
||||
|
||||
# Check for <bit> header compatibility
|
||||
include(CheckIncludeFileCXX)
|
||||
check_include_file_cxx(bit SIMDJSON_HAS_BIT_HEADER)
|
||||
|
||||
# Enable precompiled headers for faster builds
|
||||
if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.16")
|
||||
set(SIMDJSON_PRECOMPILE_HEADERS
|
||||
<algorithm>
|
||||
<array>
|
||||
<atomic>
|
||||
<cassert>
|
||||
<cctype>
|
||||
<cerrno>
|
||||
<cstddef>
|
||||
<cstdint>
|
||||
<cstdlib>
|
||||
<cstring>
|
||||
<memory>
|
||||
<string>
|
||||
<utility>
|
||||
<vector>
|
||||
)
|
||||
|
||||
if(SIMDJSON_HAS_BIT_HEADER)
|
||||
list(APPEND SIMDJSON_PRECOMPILE_HEADERS <bit>)
|
||||
endif()
|
||||
|
||||
target_precompile_headers(simdjson PRIVATE ${SIMDJSON_PRECOMPILE_HEADERS})
|
||||
endif()
|
||||
|
||||
if(SIMDJSON_BUILD_STATIC_LIB)
|
||||
add_library(simdjson_static STATIC ${SIMDJSON_SOURCES})
|
||||
add_library(simdjson::simdjson_static ALIAS simdjson_static)
|
||||
list(APPEND SIMDJSON_LIBRARIES simdjson_static)
|
||||
|
||||
# Reuse precompiled headers for static library
|
||||
if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.16")
|
||||
target_precompile_headers(simdjson_static REUSE_FROM simdjson)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
set_target_properties(
|
||||
@@ -112,13 +194,45 @@ simdjson_add_props(
|
||||
PRIVATE "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/src>"
|
||||
)
|
||||
|
||||
# Optimize linker settings for faster builds
|
||||
if(MSVC)
|
||||
target_link_options(simdjson PRIVATE /INCREMENTAL)
|
||||
if(CMAKE_BUILD_TYPE STREQUAL "Debug")
|
||||
target_link_options(simdjson PRIVATE /DEBUG:FASTLINK)
|
||||
endif()
|
||||
endif()
|
||||
|
||||
|
||||
|
||||
if(SIMDJSON_STATIC_REFLECTION)
|
||||
|
||||
|
||||
if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND CMAKE_CXX_COMPILER_VERSION MATCHES "^21")
|
||||
execute_process(
|
||||
COMMAND ${CMAKE_CXX_COMPILER} --version
|
||||
OUTPUT_VARIABLE CLANG_VERSION_OUTPUT
|
||||
ERROR_VARIABLE CLANG_VERSION_ERROR
|
||||
RESULT_VARIABLE CLANG_VERSION_RESULT
|
||||
)
|
||||
if(CLANG_VERSION_RESULT EQUAL 0 AND CLANG_VERSION_OUTPUT MATCHES "https://github.com/bloomberg/clang-p2996.git")
|
||||
set(IS_BLOOMBERG_P2996_CLANG ON)
|
||||
message(STATUS "Using Bloomberg P2996 Clang fork")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
# We would like to require C++26, but no compiler supports that!
|
||||
# This is a hack:
|
||||
if(IS_BLOOMBERG_P2996_CLANG)
|
||||
simdjson_add_props(
|
||||
target_compile_options PUBLIC
|
||||
-freflection -fexpansion-statements -stdlib=libc++ -std=c++26
|
||||
)
|
||||
else()
|
||||
simdjson_add_props(
|
||||
target_compile_options PUBLIC
|
||||
-freflection -std=c++26
|
||||
)
|
||||
endif()
|
||||
else()
|
||||
simdjson_add_props(target_compile_features PUBLIC cxx_std_11)
|
||||
endif()
|
||||
@@ -140,22 +254,10 @@ 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)$")
|
||||
option(SIMDJSON_PREFER_LSX "Prefer LoongArch SX" ON)
|
||||
include(CheckCXXCompilerFlag)
|
||||
check_cxx_compiler_flag(-mlasx COMPILER_SUPPORTS_LASX)
|
||||
check_cxx_compiler_flag(-mlsx COMPILER_SUPPORTS_LSX)
|
||||
if(COMPILER_SUPPORTS_LASX AND NOT SIMDJSON_PREFER_LSX)
|
||||
simdjson_add_props(
|
||||
target_compile_options PRIVATE
|
||||
-mlasx
|
||||
)
|
||||
elseif(COMPILER_SUPPORTS_LSX)
|
||||
simdjson_add_props(
|
||||
target_compile_options PRIVATE
|
||||
-mlsx
|
||||
)
|
||||
endif()
|
||||
option(SIMDJSON_ENABLE_NAN_INF "Allow parsing of NaN and Infinity JSON values" OFF)
|
||||
if(SIMDJSON_ENABLE_NAN_INF)
|
||||
message(STATUS "simdjson NaN and Infinity parsing is enabled.")
|
||||
simdjson_add_props(target_compile_definitions PUBLIC SIMDJSON_ENABLE_NAN_INF=1)
|
||||
endif()
|
||||
|
||||
# GCC and Clang have horrendous Debug builds when using SIMD.
|
||||
@@ -171,7 +273,12 @@ if(
|
||||
target_compile_options PRIVATE
|
||||
$<$<CONFIG:DEBUG>:-Og>
|
||||
)
|
||||
endif()
|
||||
# We still want to enable development checks in Debug mode
|
||||
simdjson_add_props(
|
||||
target_compile_definitions PUBLIC
|
||||
SIMDJSON_DEVELOPMENT_CHECKS
|
||||
)
|
||||
endif()
|
||||
|
||||
if(SIMDJSON_ENABLE_THREADS)
|
||||
find_package(Threads REQUIRED)
|
||||
@@ -186,87 +293,89 @@ endif()
|
||||
|
||||
# ---- Install rules ----
|
||||
|
||||
include(CMakePackageConfigHelpers)
|
||||
include(GNUInstallDirs)
|
||||
if(SIMDJSON_INSTALL)
|
||||
include(CMakePackageConfigHelpers)
|
||||
include(GNUInstallDirs)
|
||||
|
||||
if(SIMDJSON_SINGLEHEADER)
|
||||
install(
|
||||
FILES singleheader/simdjson.h
|
||||
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
if(SIMDJSON_SINGLEHEADER)
|
||||
install(
|
||||
FILES singleheader/simdjson.h
|
||||
DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
endif()
|
||||
|
||||
install(
|
||||
TARGETS simdjson
|
||||
EXPORT simdjsonTargets
|
||||
RUNTIME COMPONENT simdjson_Runtime
|
||||
LIBRARY COMPONENT simdjson_Runtime
|
||||
NAMELINK_COMPONENT simdjson_Development
|
||||
ARCHIVE COMPONENT simdjson_Development
|
||||
INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
|
||||
)
|
||||
configure_file(cmake/simdjson-config.cmake.in simdjson-config.cmake @ONLY)
|
||||
|
||||
write_basic_package_version_file(
|
||||
simdjson-config-version.cmake
|
||||
COMPATIBILITY SameMinorVersion
|
||||
)
|
||||
|
||||
set(
|
||||
SIMDJSON_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/simdjson"
|
||||
CACHE STRING "CMake package config location relative to the install prefix"
|
||||
)
|
||||
mark_as_advanced(SIMDJSON_INSTALL_CMAKEDIR)
|
||||
|
||||
install(
|
||||
FILES
|
||||
"${PROJECT_BINARY_DIR}/simdjson-config.cmake"
|
||||
"${PROJECT_BINARY_DIR}/simdjson-config-version.cmake"
|
||||
DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
|
||||
install(
|
||||
EXPORT simdjsonTargets
|
||||
NAMESPACE simdjson::
|
||||
DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
|
||||
if(SIMDJSON_BUILD_STATIC_LIB)
|
||||
install(
|
||||
TARGETS simdjson_static
|
||||
EXPORT simdjson_staticTargets
|
||||
ARCHIVE COMPONENT simdjson_Development
|
||||
INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
|
||||
)
|
||||
install(
|
||||
EXPORT simdjson_staticTargets
|
||||
NAMESPACE simdjson::
|
||||
DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
endif()
|
||||
|
||||
# pkg-config
|
||||
include(cmake/JoinPaths.cmake)
|
||||
join_paths(PKGCONFIG_INCLUDEDIR "\${prefix}" "${CMAKE_INSTALL_INCLUDEDIR}")
|
||||
join_paths(PKGCONFIG_LIBDIR "\${prefix}" "${CMAKE_INSTALL_LIBDIR}")
|
||||
|
||||
if(SIMDJSON_ENABLE_THREADS)
|
||||
set(PKGCONFIG_CFLAGS "-DSIMDJSON_THREADS_ENABLED=1")
|
||||
if(CMAKE_THREAD_LIBS_INIT)
|
||||
set(PKGCONFIG_LIBS_PRIVATE "Libs.private: ${CMAKE_THREAD_LIBS_INIT}")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
configure_file("simdjson.pc.in" "simdjson.pc" @ONLY)
|
||||
install(
|
||||
FILES "${CMAKE_CURRENT_BINARY_DIR}/simdjson.pc"
|
||||
DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig"
|
||||
)
|
||||
endif()
|
||||
|
||||
install(
|
||||
TARGETS simdjson
|
||||
EXPORT simdjsonTargets
|
||||
RUNTIME COMPONENT simdjson_Runtime
|
||||
LIBRARY COMPONENT simdjson_Runtime
|
||||
NAMELINK_COMPONENT simdjson_Development
|
||||
ARCHIVE COMPONENT simdjson_Development
|
||||
INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
|
||||
)
|
||||
configure_file(cmake/simdjson-config.cmake.in simdjson-config.cmake @ONLY)
|
||||
|
||||
write_basic_package_version_file(
|
||||
simdjson-config-version.cmake
|
||||
COMPATIBILITY SameMinorVersion
|
||||
)
|
||||
|
||||
set(
|
||||
SIMDJSON_INSTALL_CMAKEDIR "${CMAKE_INSTALL_LIBDIR}/cmake/simdjson"
|
||||
CACHE STRING "CMake package config location relative to the install prefix"
|
||||
)
|
||||
mark_as_advanced(SIMDJSON_INSTALL_CMAKEDIR)
|
||||
|
||||
install(
|
||||
FILES
|
||||
"${PROJECT_BINARY_DIR}/simdjson-config.cmake"
|
||||
"${PROJECT_BINARY_DIR}/simdjson-config-version.cmake"
|
||||
DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
|
||||
install(
|
||||
EXPORT simdjsonTargets
|
||||
NAMESPACE simdjson::
|
||||
DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
|
||||
if(SIMDJSON_BUILD_STATIC_LIB)
|
||||
install(
|
||||
TARGETS simdjson_static
|
||||
EXPORT simdjson_staticTargets
|
||||
ARCHIVE COMPONENT simdjson_Development
|
||||
INCLUDES DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}"
|
||||
)
|
||||
install(
|
||||
EXPORT simdjson_staticTargets
|
||||
NAMESPACE simdjson::
|
||||
DESTINATION "${SIMDJSON_INSTALL_CMAKEDIR}"
|
||||
COMPONENT simdjson_Development
|
||||
)
|
||||
endif()
|
||||
|
||||
# pkg-config
|
||||
include(cmake/JoinPaths.cmake)
|
||||
join_paths(PKGCONFIG_INCLUDEDIR "\${prefix}" "${CMAKE_INSTALL_INCLUDEDIR}")
|
||||
join_paths(PKGCONFIG_LIBDIR "\${prefix}" "${CMAKE_INSTALL_LIBDIR}")
|
||||
|
||||
if(SIMDJSON_ENABLE_THREADS)
|
||||
set(PKGCONFIG_CFLAGS "-DSIMDJSON_THREADS_ENABLED=1")
|
||||
if(CMAKE_THREAD_LIBS_INIT)
|
||||
set(PKGCONFIG_LIBS_PRIVATE "Libs.private: ${CMAKE_THREAD_LIBS_INIT}")
|
||||
endif()
|
||||
endif()
|
||||
|
||||
configure_file("simdjson.pc.in" "simdjson.pc" @ONLY)
|
||||
install(
|
||||
FILES "${CMAKE_CURRENT_BINARY_DIR}/simdjson.pc"
|
||||
DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig"
|
||||
)
|
||||
|
||||
#
|
||||
# CPack
|
||||
#
|
||||
@@ -343,18 +452,25 @@ add_subdirectory(fuzz)
|
||||
#
|
||||
# Source files should be just ASCII
|
||||
#
|
||||
find_program(FIND find)
|
||||
find_program(FILE file)
|
||||
find_program(GREP grep)
|
||||
if(FIND AND FILE AND GREP)
|
||||
find_program(FIND_CMD find)
|
||||
find_program(FILE_CMD file)
|
||||
find_program(GREP_CMD grep)
|
||||
if(FIND_CMD AND FILE_CMD AND GREP_CMD)
|
||||
add_test(
|
||||
NAME just_ascii
|
||||
COMMAND sh -c "\
|
||||
${FIND} include src windows tools singleheader tests examples benchmark \
|
||||
-path benchmark/checkperf-reference -prune -name '*.h' -o -name '*.cpp' \
|
||||
-type f -exec ${FILE} '{}' \; | ${GREP} -qv ASCII || exit 0 && exit 1"
|
||||
non_ascii=$(${FIND_CMD} include src windows tools singleheader tests examples benchmark \
|
||||
-path benchmark/checkperf-reference -prune -name '*.h' -o -name '*.cpp' \
|
||||
-type f -exec ${FILE_CMD} '{}' \; | ${GREP_CMD} -v ASCII); \
|
||||
if [ -n \"$non_ascii\" ]; then \
|
||||
echo 'The following files contain non-ASCII characters:'; \
|
||||
echo \"$non_ascii\"; \
|
||||
exit 1; \
|
||||
fi"
|
||||
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
|
||||
)
|
||||
else()
|
||||
message(WARNING "just_ascii test disabled because required tools were not found: find='${FIND_CMD}', file='${FILE_CMD}', grep='${GREP_CMD}'")
|
||||
endif()
|
||||
|
||||
##
|
||||
|
||||
@@ -101,3 +101,10 @@ Getting Started Hacking
|
||||
|
||||
An overview of simdjson's directory structure, with pointers to architecture and design
|
||||
considerations and other helpful notes, can be found at [HACKING.md](HACKING.md).
|
||||
|
||||
|
||||
|
||||
AI Usage Policy
|
||||
---------------
|
||||
|
||||
Please also review our [AI Usage Policy](AI_USAGE_POLICY.md).
|
||||
|
||||
@@ -38,7 +38,7 @@ PROJECT_NAME = simdjson
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = "4.1.0"
|
||||
PROJECT_NUMBER = "4.6.1"
|
||||
|
||||
# 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
|
||||
|
||||
@@ -110,6 +110,24 @@ workflows used by simdjson.
|
||||
Directory Structure and Source
|
||||
------------------------------
|
||||
|
||||
Before diving into the directory structure, here are key concepts used in the codebase:
|
||||
|
||||
- **Amalgamated File**: A file that is conditionally included in the amalgamation process. These are wrapped in `#ifndef SIMDJSON_CONDITIONAL_INCLUDE` blocks and are included based on the target implementation (e.g., ARM64, x86). They include implementation-specific files (e.g., `arm64.h`) and generic files (e.g., under `generic/`). Amalgamated files have associated dependency files (`dependencies.h`) to track includes.
|
||||
|
||||
- **Amalgamator File**: A file that orchestrates the inclusion of amalgamated files. Examples: `arm64.h`, `arm64/implementation.h`, `generic/amalgamated.h`. These are not themselves amalgamated but control conditional inclusions.
|
||||
|
||||
- **Free Dependency File**: A top-level header that is always included unconditionally. These do not have dependency files and represent the public API (e.g., main headers).
|
||||
|
||||
- **Implementation-Specific File**: A file tied to a specific CPU architecture or instruction set (e.g., `arm64/`, `haswell/`). These must be amalgamated.
|
||||
|
||||
- **Generic File**: A shared file (under `generic/` or `simdjson/generic/`) that contains common code included once per implementation.
|
||||
|
||||
- **Builtin File**: Special files under `simdjson/builtin/` that handle the builtin implementation, a fallback/default implementation used when no optimized implementation is available.
|
||||
|
||||
- **Conditional Include Block**: A section wrapped in `#ifndef SIMDJSON_CONDITIONAL_INCLUDE` for editor-only or implementation-specific content.
|
||||
|
||||
The script `singleheader/amalgation_helper.py` will generate an HTML report which you can use to visualize the status of each file.
|
||||
|
||||
simdjson's source structure, from the top level, looks like this:
|
||||
|
||||
* **CMakeLists.txt:** The main build system.
|
||||
@@ -133,6 +151,12 @@ simdjson's source structure, from the top level, looks like this:
|
||||
* simdjson/generic/ondemand/*.h: individual On-Demand classes, generically written.
|
||||
* simdjson/generic/ondemand/dependencies.h: dependencies on common, non-implementation-specific simdjson classes. This will be included before including amalgamated.h.
|
||||
* simdjson/generic/ondemand/amalgamated.h: all generic ondemand classes for an implementation.
|
||||
* simdjson/builder.h: the `simdjson::builder` namespace. Includes all public builder classes.
|
||||
* simdjson/builtin/builder.h: the `simdjson::builtin::builder` namespace.
|
||||
* simdjson/arm64|fallback|haswell|icelake|ppc64|westmere/builder.h: the `simdjson::<implementation>::builder` namespace. Builder compiled for the specific implementation.
|
||||
* simdjson/generic/builder/*.h: individual Builder classes, generically written.
|
||||
* simdjson/generic/builder/dependencies.h: dependencies on common, non-implementation-specific simdjson classes. This will be included before including amalgamated.h.
|
||||
* simdjson/generic/builder/amalgamated.h: all generic builder classes for an implementation.
|
||||
* **src:** The source files for non-inlined functionality (e.g. the architecture-specific parser
|
||||
implementations).
|
||||
* simdjson.cpp: A "main source" that includes all implementation files from src/. This is
|
||||
@@ -147,6 +171,7 @@ Other important files and directories:
|
||||
* **.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/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).
|
||||
* **singleheader/amalgation_helper.py:** Generates and `amalgamation_report.html` that helps you understand the status of each file.
|
||||
* **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
|
||||
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:
|
||||
|
||||
@@ -6,7 +6,8 @@
|
||||
simdjson : Parsing gigabytes of JSON per second
|
||||
===============================================
|
||||
|
||||
<img src="images/logo.png" width="10%" style="float: right">
|
||||
<img src="images/official_logo/logo_noir/SVG/logo_simdjson_noir.svg" width="40%" style="float: right">
|
||||
|
||||
JSON is everywhere on the Internet. Servers spend a *lot* of time parsing it. We need a fresh
|
||||
approach. The simdjson library uses commonly available SIMD instructions and microparallel algorithms
|
||||
to parse JSON 4x faster than RapidJSON and 25x faster than JSON for Modern C++.
|
||||
@@ -63,6 +64,8 @@ Real-world usage
|
||||
- [RonDB](https://github.com/logicalclocks/rondb)
|
||||
- [GreptimeDB](https://github.com/GreptimeTeam/greptimedb)
|
||||
- [mamba](https://github.com/mamba-org/mamba)
|
||||
- [Ladybird Browser](https://ladybird.org)
|
||||
- [SereneDB](https://github.com/serenedb/serenedb)
|
||||
|
||||
|
||||
If you are planning to use simdjson in a product, please work from one of our releases.
|
||||
@@ -116,6 +119,8 @@ Usage documentation is available:
|
||||
* [Implementation Selection](doc/implementation-selection.md) describes runtime CPU detection and
|
||||
how you can work with it.
|
||||
* [API](https://simdjson.github.io/simdjson/) contains the automatically generated API documentation.
|
||||
* [Compile-Time Parsing](doc/compile_time.md) presents our compile-time parsing function (C++26 only).
|
||||
|
||||
|
||||
Godbolt
|
||||
-------------
|
||||
@@ -184,6 +189,7 @@ We distinguish between "bindings" (which just wrap the C++ code) and a port to a
|
||||
- [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.
|
||||
- [simdjson-java](https://github.com/simdjson/simdjson-java): Java port.
|
||||
- [mruby-fast-json](https://github.com/Asmod4n/mruby-fast-json): mruby binding with high API coverage.
|
||||
|
||||
About simdjson
|
||||
--------------
|
||||
@@ -206,10 +212,31 @@ We have an in-depth paper focused on the UTF-8 validation:
|
||||
|
||||
We also have an informal [blog post providing some background and context](https://branchfree.org/2019/02/25/paper-parsing-gigabytes-of-json-per-second/).
|
||||
|
||||
For the video inclined, <br />
|
||||
For the video inclined, we had a talk at QCon San Francisco 2019<br />
|
||||
[](http://www.youtube.com/watch?v=wlvKAT7SZIQ)<br />
|
||||
(It was the best voted talk, we're kinda proud of it.)
|
||||
|
||||
We also had a CppCon 2025 talk. We show how C++26 reflection allows for one-line serialization (to_json(player)) or deserialization—without invasive macros or manual mapping—using nothing but the C++ standard library. Whether you’re a performance junkie or simply interested in the roadmap for the next decade of C++ development, watch our full talk!
|
||||
|
||||
[](http://www.youtube.com/watch?v=Mcgk3CxHYMs)<br />
|
||||
|
||||
|
||||
|
||||
Citing this work
|
||||
-----------------
|
||||
|
||||
If you use simdjson in published research, please cite the software library. A suitable BibTeX entry is:
|
||||
|
||||
```bibtex
|
||||
@misc{simdjson,
|
||||
title={{The simdjson library: Parsing Gigabytes of JSON per Second}},
|
||||
author={Daniel Lemire and Geoff Langdale and John Keiser and Paul Dreik and Francisco Thiesen and others},
|
||||
year={2019},
|
||||
howpublished={Software library},
|
||||
note={https://github.com/simdjson/simdjson}
|
||||
}
|
||||
```
|
||||
|
||||
Funding
|
||||
-------
|
||||
|
||||
|
||||
@@ -1,9 +1,10 @@
|
||||
add_subdirectory(dom)
|
||||
|
||||
|
||||
include_directories( . linux )
|
||||
include_directories( . )
|
||||
link_libraries(simdjson-windows-headers test-data)
|
||||
link_libraries(simdjson)
|
||||
link_libraries(counters)
|
||||
if(SIMDJSON_STATIC_REFLECTION)
|
||||
add_compile_definitions(SIMDJSON_STATIC_REFLECTION=1)
|
||||
endif(SIMDJSON_STATIC_REFLECTION)
|
||||
@@ -15,6 +16,7 @@ if (TARGET benchmark::benchmark)
|
||||
link_libraries(benchmark::benchmark)
|
||||
add_executable(bench_parse_call bench_parse_call.cpp)
|
||||
add_executable(bench_dom_api bench_dom_api.cpp)
|
||||
add_executable(bench_stream_formats bench_stream_formats.cpp)
|
||||
if(SIMDJSON_EXCEPTIONS)
|
||||
add_executable(bench_ondemand bench_ondemand.cpp)
|
||||
if(TARGET yyjson)
|
||||
|
||||
@@ -124,6 +124,7 @@ SIMDJSON_POP_DISABLE_WARNINGS
|
||||
#include "kostya/boostjson.h"
|
||||
|
||||
#include "large_random/simdjson_ondemand.h"
|
||||
#include "large_random/simdjson_ondemand_ranges.h"
|
||||
#if SIMDJSON_COMPETITION_ONDEMAND_UNORDERED
|
||||
#include "large_random/simdjson_ondemand_unordered.h"
|
||||
#endif // SIMDJSON_COMPETITION_ONDEMAND_UNORDERED
|
||||
|
||||
@@ -0,0 +1,216 @@
|
||||
#include <benchmark/benchmark.h>
|
||||
#include <string>
|
||||
#include "simdjson.h"
|
||||
|
||||
using namespace simdjson;
|
||||
|
||||
namespace {
|
||||
|
||||
enum class stream_case {
|
||||
ndjson_small,
|
||||
ndjson_large,
|
||||
rfc7464_small,
|
||||
rfc7464_large,
|
||||
comma_delimited_small,
|
||||
comma_delimited_large
|
||||
};
|
||||
|
||||
constexpr size_t TARGET_BYTES = 128 * 1000 * 1000;
|
||||
constexpr size_t SMALL_PAYLOAD = 16;
|
||||
constexpr size_t LARGE_PAYLOAD = 4096;
|
||||
constexpr size_t BATCH_SIZE = 1 << 20;
|
||||
|
||||
struct stream_dataset {
|
||||
padded_string json;
|
||||
size_t count{};
|
||||
};
|
||||
|
||||
std::string make_document(size_t id, size_t payload_size) {
|
||||
return std::string{"{\"id\":"} + std::to_string(id) +
|
||||
",\"name\":\"aaaaaaaa\",\"payload\":\"" +
|
||||
std::string(payload_size, 'x') + "\",\"flag\":true}";
|
||||
}
|
||||
|
||||
stream_dataset build_dataset(stream_case which) {
|
||||
const bool small = which == stream_case::ndjson_small ||
|
||||
which == stream_case::rfc7464_small ||
|
||||
which == stream_case::comma_delimited_small;
|
||||
const bool rfc = which == stream_case::rfc7464_small ||
|
||||
which == stream_case::rfc7464_large;
|
||||
const bool comma = which == stream_case::comma_delimited_small ||
|
||||
which == stream_case::comma_delimited_large;
|
||||
const size_t payload_size = small ? SMALL_PAYLOAD : LARGE_PAYLOAD;
|
||||
const size_t count = TARGET_BYTES / (payload_size + 48);
|
||||
std::string out;
|
||||
out.reserve(count * (payload_size + 64));
|
||||
for (size_t i = 0; i < count; i++) {
|
||||
if (rfc) {
|
||||
out += char(0x1E);
|
||||
}
|
||||
if (comma && i > 0) {
|
||||
out += ',';
|
||||
}
|
||||
out += make_document(i, payload_size);
|
||||
if (!comma) {
|
||||
out += '\n';
|
||||
}
|
||||
}
|
||||
return {padded_string(out), count};
|
||||
}
|
||||
|
||||
const stream_dataset &get_dataset(stream_case which) {
|
||||
static const stream_dataset ndjson_small =
|
||||
build_dataset(stream_case::ndjson_small);
|
||||
static const stream_dataset ndjson_large =
|
||||
build_dataset(stream_case::ndjson_large);
|
||||
static const stream_dataset rfc_small =
|
||||
build_dataset(stream_case::rfc7464_small);
|
||||
static const stream_dataset rfc_large =
|
||||
build_dataset(stream_case::rfc7464_large);
|
||||
static const stream_dataset comma_small =
|
||||
build_dataset(stream_case::comma_delimited_small);
|
||||
static const stream_dataset comma_large =
|
||||
build_dataset(stream_case::comma_delimited_large);
|
||||
switch (which) {
|
||||
case stream_case::ndjson_small:
|
||||
return ndjson_small;
|
||||
case stream_case::ndjson_large:
|
||||
return ndjson_large;
|
||||
case stream_case::rfc7464_small:
|
||||
return rfc_small;
|
||||
case stream_case::rfc7464_large:
|
||||
return rfc_large;
|
||||
case stream_case::comma_delimited_small:
|
||||
return comma_small;
|
||||
case stream_case::comma_delimited_large:
|
||||
return comma_large;
|
||||
}
|
||||
return ndjson_small;
|
||||
}
|
||||
|
||||
void set_counters(benchmark::State &state, const stream_dataset &dataset) {
|
||||
state.SetBytesProcessed(int64_t(state.iterations()) * int64_t(dataset.json.size()));
|
||||
state.SetItemsProcessed(int64_t(state.iterations()) * int64_t(dataset.count));
|
||||
}
|
||||
|
||||
template <stream_case which, bool threaded = true>
|
||||
static void bench_ondemand(benchmark::State &state) {
|
||||
const auto &dataset = get_dataset(which);
|
||||
ondemand::parser parser;
|
||||
parser.threaded = threaded;
|
||||
stream_format format = stream_format::whitespace_delimited;
|
||||
if constexpr (which == stream_case::rfc7464_small ||
|
||||
which == stream_case::rfc7464_large) {
|
||||
format = stream_format::json_sequence;
|
||||
} else if constexpr (which == stream_case::comma_delimited_small ||
|
||||
which == stream_case::comma_delimited_large) {
|
||||
format = stream_format::comma_delimited;
|
||||
}
|
||||
for (const auto _ : state) {
|
||||
ondemand::document_stream docs;
|
||||
auto error = parser.iterate_many(dataset.json, BATCH_SIZE, format).get(docs);
|
||||
if (error) {
|
||||
state.SkipWithError(error_message(error));
|
||||
return;
|
||||
}
|
||||
uint64_t sum = 0;
|
||||
for (auto doc : docs) {
|
||||
ondemand::object obj;
|
||||
if ((error = doc.get_object().get(obj))) {
|
||||
state.SkipWithError(error_message(error));
|
||||
return;
|
||||
}
|
||||
uint64_t id;
|
||||
if ((error = obj["id"].get_uint64().get(id))) {
|
||||
state.SkipWithError(error_message(error));
|
||||
return;
|
||||
}
|
||||
sum += id;
|
||||
}
|
||||
benchmark::DoNotOptimize(sum);
|
||||
}
|
||||
set_counters(state, dataset);
|
||||
}
|
||||
|
||||
template <stream_case which>
|
||||
static void bench_dom(benchmark::State &state) {
|
||||
const auto &dataset = get_dataset(which);
|
||||
dom::parser parser;
|
||||
parser.threaded = true;
|
||||
stream_format format = stream_format::whitespace_delimited;
|
||||
if constexpr (which == stream_case::rfc7464_small ||
|
||||
which == stream_case::rfc7464_large) {
|
||||
format = stream_format::json_sequence;
|
||||
} else if constexpr (which == stream_case::comma_delimited_small ||
|
||||
which == stream_case::comma_delimited_large) {
|
||||
format = stream_format::comma_delimited;
|
||||
}
|
||||
for (const auto _ : state) {
|
||||
dom::document_stream docs;
|
||||
auto error = parser.parse_many(dataset.json, BATCH_SIZE, format).get(docs);
|
||||
if (error) {
|
||||
state.SkipWithError(error_message(error));
|
||||
return;
|
||||
}
|
||||
uint64_t sum = 0;
|
||||
for (auto doc : docs) {
|
||||
uint64_t id;
|
||||
if ((error = doc["id"].get(id))) {
|
||||
state.SkipWithError(error_message(error));
|
||||
return;
|
||||
}
|
||||
sum += id;
|
||||
}
|
||||
benchmark::DoNotOptimize(sum);
|
||||
}
|
||||
set_counters(state, dataset);
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
BENCHMARK(bench_ondemand<stream_case::ndjson_small>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_ondemand<stream_case::ndjson_large>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_ondemand<stream_case::rfc7464_small>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_ondemand<stream_case::rfc7464_large>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_ondemand<stream_case::comma_delimited_small>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_ondemand<stream_case::comma_delimited_large>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
// Non-threaded comma_delimited for comparison
|
||||
BENCHMARK(bench_ondemand<stream_case::comma_delimited_small, false>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_ondemand<stream_case::comma_delimited_large, false>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
|
||||
BENCHMARK(bench_dom<stream_case::ndjson_small>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_dom<stream_case::ndjson_large>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_dom<stream_case::rfc7464_small>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_dom<stream_case::rfc7464_large>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_dom<stream_case::comma_delimited_small>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
BENCHMARK(bench_dom<stream_case::comma_delimited_large>)
|
||||
->UseRealTime()
|
||||
->DisplayAggregatesOnly(true);
|
||||
|
||||
BENCHMARK_MAIN();
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
|
||||
#include <cassert>
|
||||
#include <cctype>
|
||||
@@ -25,7 +26,6 @@
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "linux-perf-events.h"
|
||||
#ifdef __linux__
|
||||
#include <libgen.h>
|
||||
#endif
|
||||
@@ -204,12 +204,8 @@ struct feature_benchmarker {
|
||||
}
|
||||
// Rate of 1-7-structural misses per 8-structural flip
|
||||
double struct1_7_miss_rate(BenchmarkStage stage) const {
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
return 1;
|
||||
#else
|
||||
if (!has_events()) { return 1; }
|
||||
return struct7_miss[stage].best.branch_misses() - struct7[stage].best.branch_misses() / double(struct7_miss.stats->blocks_with_1_structural_flipped);
|
||||
#endif
|
||||
}
|
||||
// Extra cost of an 8-15 structural block over a 1-7 structural block
|
||||
double struct8_15_cost(BenchmarkStage stage) const {
|
||||
@@ -221,12 +217,8 @@ struct feature_benchmarker {
|
||||
}
|
||||
// Rate of 8-15-structural misses per 8-structural flip
|
||||
double struct8_15_miss_rate(BenchmarkStage stage) const {
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
return 1;
|
||||
#else
|
||||
if (!has_events()) { return 1; }
|
||||
return double(struct15_miss[stage].best.branch_misses() - struct15[stage].best.branch_misses()) / double(struct15_miss.stats->blocks_with_8_structurals_flipped);
|
||||
#endif
|
||||
}
|
||||
|
||||
// Extra cost of a 16+-structural block over an 8-15 structural block (actual varies based on # of structurals!)
|
||||
@@ -239,12 +231,8 @@ struct feature_benchmarker {
|
||||
}
|
||||
// Rate of 16-structural misses per 16-structural flip
|
||||
double struct16_miss_rate(BenchmarkStage stage) const {
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
return 1;
|
||||
#else
|
||||
if (!has_events()) { return 1; }
|
||||
return double(struct23_miss[stage].best.branch_misses() - struct23[stage].best.branch_misses()) / double(struct23_miss.stats->blocks_with_16_structurals_flipped);
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
@@ -258,12 +246,8 @@ struct feature_benchmarker {
|
||||
}
|
||||
// Rate of UTF-8 misses per UTF-8 flip
|
||||
double utf8_miss_rate(BenchmarkStage stage) const {
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
return 1;
|
||||
#else
|
||||
if (!has_events()) { return 1; }
|
||||
return double(utf8_miss[stage].best.branch_misses() - utf8[stage].best.branch_misses()) / double(utf8_miss.stats->blocks_with_utf8_flipped);
|
||||
#endif
|
||||
}
|
||||
// Extra cost of having escapes in a block
|
||||
double escape_cost(BenchmarkStage stage) const {
|
||||
@@ -275,12 +259,8 @@ struct feature_benchmarker {
|
||||
}
|
||||
// Rate of escape misses per escape flip
|
||||
double escape_miss_rate(BenchmarkStage stage) const {
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
return 1;
|
||||
#else
|
||||
if (!has_events()) { return 1; }
|
||||
return double(escape_miss[stage].best.branch_misses() - escape[stage].best.branch_misses()) / double(escape_miss.stats->blocks_with_escapes_flipped);
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
@@ -378,22 +358,6 @@ struct feature_benchmarker {
|
||||
}
|
||||
};
|
||||
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
void print_file_effectiveness(BenchmarkStage stage, const char* filename, const benchmarker& results, const feature_benchmarker& features) {
|
||||
double actual = results[stage].best.elapsed_ns() / double(results.stats->blocks);
|
||||
double calc = features.calc_expected(stage, results);
|
||||
double calc_misses = features.calc_expected_misses(stage, results);
|
||||
double calc_miss_cost = features.calc_expected_miss_cost(stage, results);
|
||||
printf(" | %-8s ", benchmark_stage_name(stage));
|
||||
printf("| %-15s ", filename);
|
||||
printf("| %8.3g ", features.calc_expected_feature_cost(stage, results));
|
||||
printf("| %8.3g ", calc_miss_cost);
|
||||
printf("| %8.3g ", calc);
|
||||
printf("| %8.3g ", actual);
|
||||
printf("| %+8.3g ", actual - calc);
|
||||
printf("| %13llu ", (long long unsigned)(calc_misses));
|
||||
}
|
||||
#else
|
||||
void print_file_effectiveness(BenchmarkStage stage, const char* filename, const benchmarker& results, const feature_benchmarker& features) {
|
||||
double actual = results[stage].best.elapsed_ns() / double(results.stats->blocks);
|
||||
double calc = features.calc_expected(stage, results);
|
||||
@@ -417,7 +381,6 @@ void print_file_effectiveness(BenchmarkStage stage, const char* filename, const
|
||||
}
|
||||
printf("|\n");
|
||||
}
|
||||
#endif
|
||||
|
||||
int main(int argc, char *argv[]) {
|
||||
// Read options
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
#ifndef _BENCHMARK_H_
|
||||
#define _BENCHMARK_H_
|
||||
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
|
||||
/*
|
||||
* Prints the best number of operations per cycle where
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
#ifndef __BENCHMARKER_H
|
||||
#define __BENCHMARKER_H
|
||||
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
#include "simdjson.h"
|
||||
|
||||
#include <cassert>
|
||||
@@ -28,11 +29,9 @@
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "linux-perf-events.h"
|
||||
#ifdef __linux__
|
||||
#include <libgen.h>
|
||||
#endif
|
||||
#include "simdjson.h"
|
||||
|
||||
#include <functional>
|
||||
|
||||
@@ -423,18 +422,12 @@ struct benchmarker {
|
||||
stage.instructions() / static_cast<double>(stats->structurals),
|
||||
stage.instructions() / static_cast<double>(stage.cycles())
|
||||
);
|
||||
#if !SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
// NOTE: removed cycles/miss because it is a somewhat misleading stat
|
||||
printf("%s%-13s: %7.0f branch misses (%6.2f%%) - %.0f cache misses (%6.2f%%) - %.2f cache references\n",
|
||||
printf("%s%-13s: %7.0f branch misses (%6.2f%%)\n",
|
||||
prefix,
|
||||
"Misses",
|
||||
stage.branch_misses(),
|
||||
percent(stage.branch_misses(), all_stages_without_allocation.branch_misses()),
|
||||
stage.cache_misses(),
|
||||
percent(stage.cache_misses(), all_stages_without_allocation.cache_misses()),
|
||||
stage.cache_references()
|
||||
percent(stage.branch_misses(), all_stages_without_allocation.branch_misses())
|
||||
);
|
||||
#endif
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
#include <random>
|
||||
#include <vector>
|
||||
|
||||
|
||||
@@ -1,11 +1,12 @@
|
||||
include_directories( .. ../linux )
|
||||
include_directories( .. )
|
||||
link_libraries(simdjson-windows-headers test-data)
|
||||
link_libraries(simdjson)
|
||||
link_libraries(counters)
|
||||
|
||||
add_executable(perfdiff perfdiff.cpp)
|
||||
add_executable(parse parse.cpp)
|
||||
add_executable(parse_stream parse_stream.cpp)
|
||||
add_executable(statisticalmodel statisticalmodel.cpp)
|
||||
|
||||
|
||||
add_executable(parse_noutf8validation parse.cpp)
|
||||
target_compile_definitions(parse_noutf8validation PRIVATE SIMDJSON_SKIPUTF8VALIDATION)
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
|
||||
#include <cassert>
|
||||
#include <cctype>
|
||||
@@ -24,7 +25,6 @@
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "linux-perf-events.h"
|
||||
#ifdef __linux__
|
||||
#include <libgen.h>
|
||||
#endif
|
||||
|
||||
@@ -1,207 +0,0 @@
|
||||
#include <iostream>
|
||||
#include <unistd.h>
|
||||
#include "simdjson.h"
|
||||
#ifdef __linux__
|
||||
#include "linux-perf-events.h"
|
||||
#endif
|
||||
|
||||
size_t count_nonasciibytes(const uint8_t *input, size_t length) {
|
||||
size_t count = 0;
|
||||
for (size_t i = 0; i < length; i++) {
|
||||
count += input[i] >> 7;
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
size_t count_backslash(const uint8_t *input, size_t length) {
|
||||
size_t count = 0;
|
||||
for (size_t i = 0; i < length; i++) {
|
||||
count += (input[i] == '\\') ? 1 : 0;
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
struct stat_s {
|
||||
size_t integer_count;
|
||||
size_t float_count;
|
||||
size_t string_count;
|
||||
size_t backslash_count;
|
||||
size_t non_ascii_byte_count;
|
||||
size_t object_count;
|
||||
size_t array_count;
|
||||
size_t null_count;
|
||||
size_t true_count;
|
||||
size_t false_count;
|
||||
size_t byte_count;
|
||||
size_t structural_indexes_count;
|
||||
bool valid;
|
||||
};
|
||||
|
||||
using stat_t = struct stat_s;
|
||||
|
||||
|
||||
|
||||
simdjson_inline void simdjson_process_atom(stat_t &s,
|
||||
simdjson::dom::element element) {
|
||||
if (element.is<int64_t>()) {
|
||||
s.integer_count++;
|
||||
} else if(element.is<std::string_view>()) {
|
||||
s.string_count++;
|
||||
} else if(element.is<double>()) {
|
||||
s.float_count++;
|
||||
} else if (element.is<bool>()) {
|
||||
bool v;
|
||||
simdjson::error_code error;
|
||||
if ((error = element.get(v))) { std::cerr << error << std::endl; abort(); }
|
||||
if (v) {
|
||||
s.true_count++;
|
||||
} else {
|
||||
s.false_count++;
|
||||
}
|
||||
} else if (element.is_null()) {
|
||||
s.null_count++;
|
||||
}
|
||||
}
|
||||
|
||||
void simdjson_recurse(stat_t &s, simdjson::dom::element element) {
|
||||
simdjson::error_code error;
|
||||
if (element.is<simdjson::dom::array>()) {
|
||||
s.array_count++;
|
||||
simdjson::dom::array array;
|
||||
if ((error = element.get(array))) { std::cerr << error << std::endl; abort(); }
|
||||
for (auto child : array) {
|
||||
if (child.is<simdjson::dom::array>() || child.is<simdjson::dom::object>()) {
|
||||
simdjson_recurse(s, child);
|
||||
} else {
|
||||
simdjson_process_atom(s, child);
|
||||
}
|
||||
}
|
||||
} else if (element.is<simdjson::dom::object>()) {
|
||||
s.object_count++;
|
||||
simdjson::dom::object object;
|
||||
if ((error = element.get(object))) { std::cerr << error << std::endl; abort(); }
|
||||
for (auto field : object) {
|
||||
s.string_count++; // for key
|
||||
if (field.value.is<simdjson::dom::array>() || field.value.is<simdjson::dom::object>()) {
|
||||
simdjson_recurse(s, field.value);
|
||||
} else {
|
||||
simdjson_process_atom(s, field.value);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
simdjson_process_atom(s, element);
|
||||
}
|
||||
}
|
||||
|
||||
stat_t simdjson_compute_stats(const simdjson::padded_string &p) {
|
||||
stat_t answer{};
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::element doc;
|
||||
auto error = parser.parse(p).get(doc);
|
||||
if (error) {
|
||||
answer.valid = false;
|
||||
return answer;
|
||||
}
|
||||
answer.valid = true;
|
||||
answer.backslash_count =
|
||||
count_backslash(reinterpret_cast<const uint8_t *>(p.data()), p.size());
|
||||
answer.non_ascii_byte_count = count_nonasciibytes(
|
||||
reinterpret_cast<const uint8_t *>(p.data()), p.size());
|
||||
answer.byte_count = p.size();
|
||||
answer.structural_indexes_count = parser.implementation->n_structural_indexes;
|
||||
simdjson_recurse(answer, doc);
|
||||
return answer;
|
||||
}
|
||||
|
||||
int main(int argc, char *argv[]) {
|
||||
#ifndef _MSC_VER
|
||||
int c;
|
||||
while ((c = getopt(argc, argv, "")) != -1) {
|
||||
switch (c) {
|
||||
|
||||
default:
|
||||
abort();
|
||||
}
|
||||
}
|
||||
#else
|
||||
int optind = 1;
|
||||
#endif
|
||||
if (optind >= argc) {
|
||||
std::cerr << "Reads json, prints stats. " << std::endl;
|
||||
std::cerr << "Usage: " << argv[0] << " <jsonfile>" << std::endl;
|
||||
|
||||
exit(1);
|
||||
}
|
||||
const char *filename = argv[optind];
|
||||
if (optind + 1 < argc) {
|
||||
std::cerr << "warning: ignoring everything after " << argv[optind + 1]
|
||||
<< std::endl;
|
||||
}
|
||||
simdjson::padded_string p;
|
||||
auto error = simdjson::padded_string::load(filename).get(p);
|
||||
if (error) {
|
||||
std::cerr << "Could not load the file " << filename << std::endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
stat_t s = simdjson_compute_stats(p);
|
||||
if (!s.valid) {
|
||||
std::cerr << "not a valid JSON" << std::endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
|
||||
printf("# integer_count float_count string_count backslash_count "
|
||||
"non_ascii_byte_count object_count array_count null_count true_count "
|
||||
"false_count byte_count structural_indexes_count ");
|
||||
#ifdef __linux__
|
||||
printf(" stage1_cycle_count stage1_instruction_count stage2_cycle_count "
|
||||
" stage2_instruction_count stage3_cycle_count "
|
||||
"stage3_instruction_count ");
|
||||
#else
|
||||
printf("(you are not under linux, so perf counters are disaabled)");
|
||||
#endif
|
||||
printf("\n");
|
||||
printf("%zu %zu %zu %zu %zu %zu %zu %zu %zu %zu %zu %zu ", s.integer_count,
|
||||
s.float_count, s.string_count, s.backslash_count,
|
||||
s.non_ascii_byte_count, s.object_count, s.array_count, s.null_count,
|
||||
s.true_count, s.false_count, s.byte_count, s.structural_indexes_count);
|
||||
#ifdef __linux__
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::error_code alloc_error = parser.allocate(p.size());
|
||||
if (alloc_error) {
|
||||
std::cerr << alloc_error << std::endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
const uint32_t iterations = p.size() < 1 * 1000 * 1000 ? 1000 : 50;
|
||||
std::vector<int> evts;
|
||||
evts.push_back(PERF_COUNT_HW_CPU_CYCLES);
|
||||
evts.push_back(PERF_COUNT_HW_INSTRUCTIONS);
|
||||
LinuxEvents<PERF_TYPE_HARDWARE> unified(evts);
|
||||
unsigned long cy1 = 0, cy2 = 0;
|
||||
unsigned long cl1 = 0, cl2 = 0;
|
||||
std::vector<unsigned long long> results;
|
||||
results.resize(evts.size());
|
||||
for (uint32_t i = 0; i < iterations; i++) {
|
||||
unified.start();
|
||||
// The default template is simdjson::architecture::NATIVE.
|
||||
bool isok = (parser.implementation->stage1((const uint8_t *)p.data(), p.size(), simdjson::stage1_mode::regular) == simdjson::SUCCESS);
|
||||
unified.end(results);
|
||||
|
||||
cy1 += results[0];
|
||||
cl1 += results[1];
|
||||
|
||||
unified.start();
|
||||
isok = isok && (parser.implementation->stage2(parser.doc) == simdjson::SUCCESS);
|
||||
unified.end(results);
|
||||
|
||||
cy2 += results[0];
|
||||
cl2 += results[1];
|
||||
if (!isok) {
|
||||
std::cerr << "failure?" << std::endl;
|
||||
}
|
||||
}
|
||||
printf("%f %f %f %f ", static_cast<double>(cy1) / static_cast<double>(iterations), static_cast<double>(cl1) / static_cast<double>(iterations),
|
||||
static_cast<double>(cy2) / static_cast<double>(iterations), static_cast<double>(cl2) / static_cast<double>(iterations));
|
||||
#endif // __linux__
|
||||
printf("\n");
|
||||
return EXIT_SUCCESS;
|
||||
}
|
||||
@@ -1,201 +0,0 @@
|
||||
#ifndef __EVENT_COUNTER_H
|
||||
#define __EVENT_COUNTER_H
|
||||
|
||||
#ifndef SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
#ifdef __aarch64__
|
||||
// on ARM, we use just cycles and instructions
|
||||
#define SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS 1
|
||||
#else
|
||||
// elsewhere, we try to use four counters.
|
||||
#define SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS 0
|
||||
#endif
|
||||
#endif
|
||||
#include <cassert>
|
||||
#include <cctype>
|
||||
#ifndef _MSC_VER
|
||||
#include <dirent.h>
|
||||
#endif
|
||||
#include <unistd.h>
|
||||
#include <cinttypes>
|
||||
|
||||
#include <cstdio>
|
||||
#include <cstdlib>
|
||||
#include <cstring>
|
||||
|
||||
#include <algorithm>
|
||||
#include <chrono>
|
||||
#include <cstring>
|
||||
#include <fstream>
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
#include <map>
|
||||
#include <set>
|
||||
#include <sstream>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#ifdef __linux__
|
||||
#include "linux-perf-events.h"
|
||||
#include <libgen.h>
|
||||
#endif
|
||||
|
||||
#if __APPLE__ && __aarch64__
|
||||
#include "apple/apple_arm_events.h"
|
||||
#endif
|
||||
|
||||
#include "simdjson.h"
|
||||
|
||||
using std::string;
|
||||
using std::vector;
|
||||
using std::chrono::steady_clock;
|
||||
using std::chrono::time_point;
|
||||
using std::chrono::duration;
|
||||
|
||||
struct event_count {
|
||||
duration<double> elapsed;
|
||||
vector<unsigned long long> event_counts;
|
||||
event_count() : elapsed(0), event_counts{0,0,0,0,0} {}
|
||||
event_count(const duration<double> _elapsed, const vector<unsigned long long> _event_counts) : elapsed(_elapsed), event_counts(_event_counts) {}
|
||||
event_count(const event_count& other): elapsed(other.elapsed), event_counts(other.event_counts) { }
|
||||
|
||||
// The types of counters (so we can read the getter more easily)
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
enum event_counter_types {
|
||||
CPU_CYCLES,
|
||||
INSTRUCTIONS
|
||||
};
|
||||
#else
|
||||
enum event_counter_types {
|
||||
CPU_CYCLES,
|
||||
INSTRUCTIONS,
|
||||
BRANCH_MISSES,
|
||||
CACHE_REFERENCES,
|
||||
CACHE_MISSES
|
||||
};
|
||||
#endif
|
||||
double elapsed_sec() const { return duration<double>(elapsed).count(); }
|
||||
double elapsed_ns() const { return duration<double, std::nano>(elapsed).count(); }
|
||||
double cycles() const { return static_cast<double>(event_counts[CPU_CYCLES]); }
|
||||
double instructions() const { return static_cast<double>(event_counts[INSTRUCTIONS]); }
|
||||
#if !SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
double branch_misses() const { return static_cast<double>(event_counts[BRANCH_MISSES]); }
|
||||
double cache_references() const { return static_cast<double>(event_counts[CACHE_REFERENCES]); }
|
||||
double cache_misses() const { return static_cast<double>(event_counts[CACHE_MISSES]); }
|
||||
#endif
|
||||
event_count& operator=(const event_count& other) {
|
||||
this->elapsed = other.elapsed;
|
||||
this->event_counts = other.event_counts;
|
||||
return *this;
|
||||
}
|
||||
event_count operator+(const event_count& other) const {
|
||||
return event_count(elapsed+other.elapsed, {
|
||||
event_counts[0]+other.event_counts[0],
|
||||
event_counts[1]+other.event_counts[1],
|
||||
event_counts[2]+other.event_counts[2],
|
||||
event_counts[3]+other.event_counts[3],
|
||||
event_counts[4]+other.event_counts[4],
|
||||
});
|
||||
}
|
||||
|
||||
void operator+=(const event_count& other) {
|
||||
*this = *this + other;
|
||||
}
|
||||
};
|
||||
|
||||
struct event_aggregate {
|
||||
int iterations = 0;
|
||||
event_count total{};
|
||||
event_count best{};
|
||||
event_count worst{};
|
||||
|
||||
event_aggregate() {}
|
||||
|
||||
void operator<<(const event_count& other) {
|
||||
if (iterations == 0 || other.elapsed < best.elapsed) {
|
||||
best = other;
|
||||
}
|
||||
if (iterations == 0 || other.elapsed > worst.elapsed) {
|
||||
worst = other;
|
||||
}
|
||||
iterations++;
|
||||
total += other;
|
||||
}
|
||||
|
||||
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 cycles() const { return total.cycles() / iterations; }
|
||||
double instructions() const { return total.instructions() / iterations; }
|
||||
#if !SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
double branch_misses() const { return total.branch_misses() / iterations; }
|
||||
double cache_references() const { return total.cache_references() / iterations; }
|
||||
double cache_misses() const { return total.cache_misses() / iterations; }
|
||||
#endif
|
||||
};
|
||||
|
||||
struct event_collector {
|
||||
event_count count{};
|
||||
time_point<steady_clock> start_clock{};
|
||||
|
||||
#if defined(__linux__)
|
||||
LinuxEvents<PERF_TYPE_HARDWARE> linux_events;
|
||||
event_collector() : linux_events(vector<int>{
|
||||
#if SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
PERF_COUNT_HW_CPU_CYCLES,
|
||||
PERF_COUNT_HW_INSTRUCTIONS,
|
||||
#else
|
||||
PERF_COUNT_HW_CPU_CYCLES,
|
||||
PERF_COUNT_HW_INSTRUCTIONS,
|
||||
PERF_COUNT_HW_BRANCH_MISSES,
|
||||
PERF_COUNT_HW_CACHE_REFERENCES,
|
||||
PERF_COUNT_HW_CACHE_MISSES
|
||||
#endif
|
||||
}) {}
|
||||
bool has_events() {
|
||||
return linux_events.is_working();
|
||||
}
|
||||
#elif __APPLE__ && __aarch64__
|
||||
AppleEvents apple_events;
|
||||
performance_counters diff;
|
||||
event_collector() : diff(0) {
|
||||
apple_events.setup_performance_counters();
|
||||
}
|
||||
bool has_events() {
|
||||
return apple_events.setup_performance_counters();
|
||||
}
|
||||
#else
|
||||
event_collector() {}
|
||||
bool has_events() {
|
||||
return false;
|
||||
}
|
||||
#endif
|
||||
|
||||
simdjson_inline void start() {
|
||||
#if defined(__linux)
|
||||
linux_events.start();
|
||||
#elif __APPLE__ && __aarch64__
|
||||
if(has_events()) { diff = apple_events.get_counters(); }
|
||||
#endif
|
||||
start_clock = steady_clock::now();
|
||||
}
|
||||
simdjson_inline event_count& end() {
|
||||
time_point<steady_clock> end_clock = steady_clock::now();
|
||||
#if defined(__linux)
|
||||
linux_events.end(count.event_counts);
|
||||
#elif __APPLE__ && __aarch64__
|
||||
if(has_events()) {
|
||||
performance_counters end = apple_events.get_counters();
|
||||
diff = end - diff;
|
||||
}
|
||||
count.event_counts[0] = diff.cycles;
|
||||
count.event_counts[1] = diff.instructions;
|
||||
count.event_counts[2] = diff.missed_branches;
|
||||
count.event_counts[3] = 0;
|
||||
count.event_counts[4] = 0;
|
||||
#endif
|
||||
count.elapsed = end_clock - start_clock;
|
||||
return count;
|
||||
}
|
||||
};
|
||||
|
||||
#endif
|
||||
@@ -1,7 +1,8 @@
|
||||
#ifndef BENCHMARK_HELPERS_H
|
||||
#define BENCHMARK_HELPERS_H
|
||||
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
#include <atomic>
|
||||
|
||||
event_collector collector;
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
#pragma once
|
||||
|
||||
#include "simdjson.h"
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
#include <iostream>
|
||||
|
||||
namespace json_benchmark {
|
||||
@@ -58,11 +59,7 @@ template<typename B, typename R> static void run_json_benchmark(benchmark::State
|
||||
if (collector.has_events()) {
|
||||
state.counters["instructions"] = events.instructions();
|
||||
state.counters["cycles"] = events.cycles();
|
||||
#if !SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
state.counters["branch_miss"] = events.branch_misses();
|
||||
state.counters["cache_miss"] = events.cache_misses();
|
||||
state.counters["cache_ref"] = events.cache_references();
|
||||
#endif
|
||||
state.counters["instructions_per_byte"] = events.instructions() / double(bench.bytes_per_iteration());
|
||||
state.counters["instructions_per_cycle"] = events.instructions() / events.cycles();
|
||||
state.counters["cycles_per_byte"] = events.cycles() / double(bench.bytes_per_iteration());
|
||||
@@ -70,11 +67,7 @@ template<typename B, typename R> static void run_json_benchmark(benchmark::State
|
||||
|
||||
state.counters["best_instructions"] = events.best.instructions();
|
||||
state.counters["best_cycles"] = events.best.cycles();
|
||||
#if !SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
state.counters["best_branch_miss"] = events.best.branch_misses();
|
||||
state.counters["best_cache_miss"] = events.best.cache_misses();
|
||||
state.counters["best_cache_ref"] = events.best.cache_references();
|
||||
#endif
|
||||
|
||||
state.counters["best_instructions_per_byte"] = events.best.instructions() / double(bench.bytes_per_iteration());
|
||||
state.counters["best_instructions_per_cycle"] = events.best.instructions() / events.best.cycles();
|
||||
@@ -95,11 +88,7 @@ template<typename B, typename R> static void run_json_benchmark(benchmark::State
|
||||
if (collector.has_events()) {
|
||||
label << " instructions=" << setw(12) << uint64_t(events.best.instructions()) << setw(0);
|
||||
label << " cycles=" << setw(12) << uint64_t(events.best.cycles()) << setw(0);
|
||||
#if !SIMDJSON_SIMPLE_PERFORMANCE_COUNTERS
|
||||
label << " branch_miss=" << setw(8) << uint64_t(events.best.branch_misses()) << setw(0);
|
||||
label << " cache_miss=" << setw(8) << uint64_t(events.best.cache_misses()) << setw(0);
|
||||
label << " cache_ref=" << setw(10) << uint64_t(events.best.cache_references()) << setw(0);
|
||||
#endif
|
||||
}
|
||||
|
||||
label << " items=" << setw(10) << bench.items_per_iteration() << setw(0);
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#pragma once
|
||||
|
||||
#include "json_benchmark/string_runner.h"
|
||||
#include <fstream>
|
||||
#include <map>
|
||||
#include <string>
|
||||
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
#pragma once
|
||||
|
||||
#if SIMDJSON_EXCEPTIONS && SIMDJSON_SUPPORTS_RANGES
|
||||
|
||||
#include "large_random.h"
|
||||
|
||||
namespace large_random {
|
||||
|
||||
using namespace simdjson;
|
||||
|
||||
// Identical to simdjson_ondemand but uses get_range() for iteration.
|
||||
// Demonstrates that the ranges wrapper has zero per-element overhead.
|
||||
struct simdjson_ondemand_ranges {
|
||||
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);
|
||||
for (auto coord_result : ondemand::get_range(doc.get_array())) {
|
||||
ondemand::object coord = coord_result;
|
||||
result.emplace_back(json_benchmark::point{coord.find_field("x"), coord.find_field("y"), coord.find_field("z")});
|
||||
}
|
||||
return true;
|
||||
}
|
||||
};
|
||||
|
||||
BENCHMARK_TEMPLATE(large_random, simdjson_ondemand_ranges)->UseManualTime();
|
||||
|
||||
} // namespace large_random
|
||||
|
||||
#endif // SIMDJSON_EXCEPTIONS && SIMDJSON_SUPPORTS_RANGES
|
||||
@@ -103,7 +103,12 @@ error_code Sax::RunNoExcept(const padded_string &json) noexcept {
|
||||
|
||||
error_code Sax::Allocate(size_t new_capacity) {
|
||||
// string_capacity copied from document::allocate
|
||||
size_t string_capacity = SIMDJSON_ROUNDUP_N(5 * new_capacity / 3 + SIMDJSON_PADDING, 64);
|
||||
// a document with only zero-length strings... could have capacity/3 string
|
||||
// and we would need capacity/3 * 5 bytes on the string buffer
|
||||
if(5 * (new_capacity / 3) + SIMDJSON_PADDING < SIMDJSON_PADDING) {
|
||||
return CAPACITY; // overflow, only happen on legacy 32-bit systems with very large capacity
|
||||
}
|
||||
size_t string_capacity = SIMDJSON_ROUNDUP_N(5 * (new_capacity / 3) + SIMDJSON_PADDING, 64);
|
||||
string_buf.reset(new (std::nothrow) uint8_t[string_capacity]);
|
||||
if (auto error = dom_parser.set_capacity(new_capacity)) { return error; }
|
||||
if (capacity == 0) { // set max depth the first time only
|
||||
|
||||
@@ -1,105 +0,0 @@
|
||||
#pragma once
|
||||
#ifdef __linux__
|
||||
|
||||
#include <asm/unistd.h> // for __NR_perf_event_open
|
||||
#include <linux/perf_event.h> // for perf event constants
|
||||
#include <sys/ioctl.h> // for ioctl
|
||||
#include <unistd.h> // for syscall
|
||||
|
||||
#include <cerrno> // for errno
|
||||
#include <cstring> // for memset
|
||||
#include <stdexcept>
|
||||
|
||||
#include <iostream>
|
||||
#include <vector>
|
||||
|
||||
template <int TYPE = PERF_TYPE_HARDWARE> class LinuxEvents {
|
||||
int fd;
|
||||
bool working;
|
||||
perf_event_attr attribs{};
|
||||
size_t num_events{};
|
||||
std::vector<uint64_t> temp_result_vec{};
|
||||
std::vector<uint64_t> ids{};
|
||||
|
||||
public:
|
||||
explicit LinuxEvents(std::vector<int> config_vec) : fd(0), working(true) {
|
||||
memset(&attribs, 0, sizeof(attribs));
|
||||
attribs.type = TYPE;
|
||||
attribs.size = sizeof(attribs);
|
||||
attribs.disabled = 1;
|
||||
attribs.exclude_kernel = 1;
|
||||
attribs.exclude_hv = 1;
|
||||
|
||||
attribs.sample_period = 0;
|
||||
attribs.read_format = PERF_FORMAT_GROUP | PERF_FORMAT_ID;
|
||||
const int pid = 0; // the current process
|
||||
const int cpu = -1; // all CPUs
|
||||
const unsigned long flags = 0;
|
||||
|
||||
int group = -1; // no group
|
||||
num_events = config_vec.size();
|
||||
ids.resize(config_vec.size());
|
||||
uint32_t i = 0;
|
||||
for (auto config : config_vec) {
|
||||
attribs.config = config;
|
||||
int _fd = static_cast<int>(syscall(__NR_perf_event_open, &attribs, pid, cpu, group, flags));
|
||||
if (_fd == -1) {
|
||||
report_error("perf_event_open");
|
||||
}
|
||||
ioctl(_fd, PERF_EVENT_IOC_ID, &ids[i++]);
|
||||
if (group == -1) {
|
||||
group = _fd;
|
||||
fd = _fd;
|
||||
}
|
||||
}
|
||||
|
||||
temp_result_vec.resize(num_events * 2 + 1);
|
||||
}
|
||||
|
||||
~LinuxEvents() { if (fd != -1) { close(fd); } }
|
||||
|
||||
inline void start() {
|
||||
if (fd != -1) {
|
||||
if (ioctl(fd, PERF_EVENT_IOC_RESET, PERF_IOC_FLAG_GROUP) == -1) {
|
||||
report_error("ioctl(PERF_EVENT_IOC_RESET)");
|
||||
}
|
||||
|
||||
if (ioctl(fd, PERF_EVENT_IOC_ENABLE, PERF_IOC_FLAG_GROUP) == -1) {
|
||||
report_error("ioctl(PERF_EVENT_IOC_ENABLE)");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
inline void end(std::vector<unsigned long long> &results) {
|
||||
if (fd != -1) {
|
||||
if (ioctl(fd, PERF_EVENT_IOC_DISABLE, PERF_IOC_FLAG_GROUP) == -1) {
|
||||
report_error("ioctl(PERF_EVENT_IOC_DISABLE)");
|
||||
}
|
||||
|
||||
if (read(fd, temp_result_vec.data(), temp_result_vec.size() * 8) == -1) {
|
||||
report_error("read");
|
||||
}
|
||||
}
|
||||
// our actual results are in slots 1,3,5, ... of this structure
|
||||
for (uint32_t i = 1; i < temp_result_vec.size(); i += 2) {
|
||||
results[i / 2] = temp_result_vec[i];
|
||||
}
|
||||
for (uint32_t i = 2; i < temp_result_vec.size(); i += 2) {
|
||||
if(ids[i/2-1] != temp_result_vec[i]) {
|
||||
report_error("event mismatch");
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
bool is_working() {
|
||||
return working;
|
||||
}
|
||||
|
||||
private:
|
||||
void report_error(const std::string &) {
|
||||
working = false;
|
||||
}
|
||||
};
|
||||
#endif
|
||||
@@ -10,7 +10,7 @@ namespace partial_tweets {
|
||||
// {
|
||||
// "created_at": "Sun Aug 31 00:29:15 +0000 2014",
|
||||
// "id": 505874924095815700,
|
||||
// "text": "@aym0566x \n\n名前:前田あゆみ\n第一印象:なんか怖っ!\n今の印象:とりあえずキモい。噛み合わない\n好きなところ:ぶすでキモいとこ😋✨✨\n思い出:んーーー、ありすぎ😊❤️\nLINE交換できる?:あぁ……ごめん✋\nトプ画をみて:照れますがな😘✨\n一言:お前は一生もんのダチ💖",
|
||||
// "text": "@aym0566x ...",
|
||||
// "in_reply_to_status_id": null,
|
||||
// "user": {
|
||||
// "id": 1186275104,
|
||||
|
||||
@@ -8,7 +8,7 @@ CPMAddPackage(
|
||||
|
||||
option(SIMDJSON_USE_RUST "Build the static_reflect benchmark" OFF)
|
||||
|
||||
if(SIMDJSON_USER_RUST)
|
||||
if(SIMDJSON_USE_RUST)
|
||||
if(NOT WIN32)
|
||||
# We want the check whether Rust is available before trying to build a crate.
|
||||
CPMAddPackage(
|
||||
@@ -39,9 +39,9 @@ if(SIMDJSON_USER_RUST)
|
||||
message(STATUS "curl https://sh.rustup.rs -sSf | sh")
|
||||
endif()
|
||||
endif()
|
||||
else(SIMDJSON_USER_RUST)
|
||||
else(SIMDJSON_USE_RUST)
|
||||
message(STATUS "We will not benchmark serde-benchmark." )
|
||||
endif(SIMDJSON_USER_RUST)
|
||||
endif(SIMDJSON_USE_RUST)
|
||||
|
||||
# Add the benchmark executable targets
|
||||
add_subdirectory(twitter_benchmark)
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
#ifndef BENCHMARK_HELPER_HPP
|
||||
#define BENCHMARK_HELPER_HPP
|
||||
#include "event_counter.h"
|
||||
#include <counters/event_counter.h>
|
||||
using namespace counters;
|
||||
#include <atomic>
|
||||
|
||||
inline event_collector &get_collector() {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
add_executable(benchmark_serialization_citm_catalog benchmark_serialization_citm_catalog.cpp)
|
||||
add_executable(benchmark_parsing_citm benchmark_parsing_citm.cpp)
|
||||
|
||||
# Link with Rust benchmarking code if available
|
||||
if(TARGET serde-benchmark)
|
||||
@@ -11,4 +12,29 @@ target_link_libraries(benchmark_serialization_citm_catalog PRIVATE simdjson::sim
|
||||
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}")
|
||||
if(TARGET yyjson)
|
||||
target_link_libraries(benchmark_serialization_citm_catalog PRIVATE yyjson)
|
||||
target_compile_definitions(benchmark_serialization_citm_catalog PRIVATE SIMDJSON_COMPETITION_YYJSON)
|
||||
endif()
|
||||
|
||||
target_compile_definitions(benchmark_serialization_citm_catalog PRIVATE JSON_FILE="${BENCH_CITM_JSON}")
|
||||
|
||||
# Configuration for parsing benchmark
|
||||
if(TARGET serde-benchmark)
|
||||
target_link_libraries(benchmark_parsing_citm PRIVATE serde-benchmark)
|
||||
target_compile_definitions(benchmark_parsing_citm PRIVATE SIMDJSON_RUST_VERSION="${Rust_VERSION}")
|
||||
endif()
|
||||
|
||||
target_link_libraries(benchmark_parsing_citm PRIVATE simdjson::simdjson nlohmann_json)
|
||||
|
||||
if(TARGET rapidjson)
|
||||
target_link_libraries(benchmark_parsing_citm PRIVATE rapidjson)
|
||||
target_compile_definitions(benchmark_parsing_citm PRIVATE SIMDJSON_COMPETITION_RAPIDJSON)
|
||||
endif()
|
||||
|
||||
if(TARGET yyjson)
|
||||
target_link_libraries(benchmark_parsing_citm PRIVATE yyjson)
|
||||
target_compile_definitions(benchmark_parsing_citm PRIVATE SIMDJSON_COMPETITION_YYJSON)
|
||||
endif()
|
||||
|
||||
target_compile_definitions(benchmark_parsing_citm PRIVATE JSON_FILE="${BENCH_CITM_JSON}")
|
||||
@@ -0,0 +1,563 @@
|
||||
#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"
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_RAPIDJSON
|
||||
#include "rapidjson_citm_catalog_data.h"
|
||||
#endif
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
#include "yyjson_citm_catalog_data.h"
|
||||
#endif
|
||||
|
||||
#ifdef SIMDJSON_RUST_VERSION
|
||||
#include "../serde-benchmark/serde_benchmark.h"
|
||||
|
||||
void bench_rust_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_rust_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
serde_benchmark::CitmCatalog *catalog = serde_benchmark::citm_from_str(json_str.c_str(), json_str.size());
|
||||
result = (catalog != nullptr);
|
||||
if (catalog) {
|
||||
serde_benchmark::free_citm(catalog);
|
||||
}
|
||||
if (!result) {
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
template <class T> void bench_simdjson_static_reflection_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
// Pre-allocate padded buffer outside the benchmark loop
|
||||
std::string mutable_json = json_str;
|
||||
simdjson::pad(mutable_json);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_simdjson_static_reflection_parsing",
|
||||
bench([&mutable_json, &result]() {
|
||||
simdjson::ondemand::parser parser;
|
||||
simdjson::ondemand::document doc;
|
||||
if(parser.iterate(mutable_json).get(doc)) {
|
||||
result = false;
|
||||
return;
|
||||
}
|
||||
T my_struct;
|
||||
if(doc.get<T>().get(my_struct)) {
|
||||
result = false;
|
||||
}
|
||||
if (!result) {
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
template <class T> void bench_simdjson_from_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
// Pre-allocate padded buffer outside the benchmark loop
|
||||
simdjson::padded_string padded = simdjson::padded_string(json_str);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_simdjson_from_parsing",
|
||||
bench([&padded, &result]() {
|
||||
T my_struct;
|
||||
auto err = simdjson::from(padded).get(my_struct);
|
||||
if (err) {
|
||||
result = false;
|
||||
printf("parse error: %s\n", simdjson::error_message(err));
|
||||
return;
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
// nlohmann::json deserialization functions
|
||||
void from_json(const nlohmann::json &j, CITMPrice &p) {
|
||||
j.at("amount").get_to(p.amount);
|
||||
j.at("audienceSubCategoryId").get_to(p.audienceSubCategoryId);
|
||||
j.at("seatCategoryId").get_to(p.seatCategoryId);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, CITMArea &a) {
|
||||
j.at("areaId").get_to(a.areaId);
|
||||
j.at("blockIds").get_to(a.blockIds);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, CITMSeatCategory &s) {
|
||||
j.at("areas").get_to(s.areas);
|
||||
j.at("seatCategoryId").get_to(s.seatCategoryId);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, CITMPerformance &p) {
|
||||
j.at("id").get_to(p.id);
|
||||
j.at("eventId").get_to(p.eventId);
|
||||
if (j.contains("logo") && !j["logo"].is_null()) {
|
||||
p.logo = j["logo"].get<std::string>();
|
||||
}
|
||||
if (j.contains("name") && !j["name"].is_null()) {
|
||||
p.name = j["name"].get<std::string>();
|
||||
}
|
||||
j.at("prices").get_to(p.prices);
|
||||
j.at("seatCategories").get_to(p.seatCategories);
|
||||
if (j.contains("seatMapImage") && !j["seatMapImage"].is_null()) {
|
||||
p.seatMapImage = j["seatMapImage"].get<std::string>();
|
||||
}
|
||||
j.at("start").get_to(p.start);
|
||||
j.at("venueCode").get_to(p.venueCode);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, CITMEvent &e) {
|
||||
j.at("id").get_to(e.id);
|
||||
j.at("name").get_to(e.name);
|
||||
if (j.contains("description") && !j["description"].is_null()) {
|
||||
e.description = j["description"].get<std::string>();
|
||||
}
|
||||
if (j.contains("logo") && !j["logo"].is_null()) {
|
||||
e.logo = j["logo"].get<std::string>();
|
||||
}
|
||||
j.at("subTopicIds").get_to(e.subTopicIds);
|
||||
if (j.contains("subjectCode") && !j["subjectCode"].is_null()) {
|
||||
e.subjectCode = j["subjectCode"].get<std::string>();
|
||||
}
|
||||
if (j.contains("subtitle") && !j["subtitle"].is_null()) {
|
||||
e.subtitle = j["subtitle"].get<std::string>();
|
||||
}
|
||||
j.at("topicIds").get_to(e.topicIds);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, CitmCatalog &c) {
|
||||
j.at("events").get_to(c.events);
|
||||
j.at("performances").get_to(c.performances);
|
||||
}
|
||||
|
||||
CitmCatalog nlohmann_deserialize(const std::string &json_str) {
|
||||
nlohmann::json j = nlohmann::json::parse(json_str);
|
||||
return j.get<CitmCatalog>();
|
||||
}
|
||||
|
||||
void bench_nlohmann_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_nlohmann_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
try {
|
||||
CitmCatalog data = nlohmann_deserialize(json_str);
|
||||
result = true;
|
||||
} catch (...) {
|
||||
result = false;
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_RAPIDJSON
|
||||
CitmCatalog rapidjson_deserialize(const std::string &json_str) {
|
||||
rapidjson::Document doc;
|
||||
doc.Parse(json_str.c_str());
|
||||
|
||||
if (doc.HasParseError()) {
|
||||
throw std::runtime_error("RapidJSON parse error");
|
||||
}
|
||||
|
||||
CitmCatalog catalog;
|
||||
|
||||
// Parse events
|
||||
if (doc.HasMember("events") && doc["events"].IsObject()) {
|
||||
for (auto& m : doc["events"].GetObject()) {
|
||||
CITMEvent event;
|
||||
const auto& e = m.value;
|
||||
|
||||
event.id = e["id"].GetUint64();
|
||||
event.name = e["name"].GetString();
|
||||
if (e.HasMember("description") && !e["description"].IsNull()) {
|
||||
event.description = e["description"].GetString();
|
||||
}
|
||||
if (e.HasMember("logo") && !e["logo"].IsNull()) {
|
||||
event.logo = e["logo"].GetString();
|
||||
}
|
||||
|
||||
event.subTopicIds.clear();
|
||||
for (auto& id : e["subTopicIds"].GetArray()) {
|
||||
event.subTopicIds.push_back(id.GetUint64());
|
||||
}
|
||||
|
||||
if (e.HasMember("subjectCode") && !e["subjectCode"].IsNull()) {
|
||||
event.subjectCode = e["subjectCode"].GetString();
|
||||
}
|
||||
if (e.HasMember("subtitle") && !e["subtitle"].IsNull()) {
|
||||
event.subtitle = e["subtitle"].GetString();
|
||||
}
|
||||
|
||||
event.topicIds.clear();
|
||||
for (auto& id : e["topicIds"].GetArray()) {
|
||||
event.topicIds.push_back(id.GetUint64());
|
||||
}
|
||||
|
||||
catalog.events[m.name.GetString()] = event;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse performances
|
||||
if (doc.HasMember("performances") && doc["performances"].IsArray()) {
|
||||
for (auto& p : doc["performances"].GetArray()) {
|
||||
CITMPerformance perf;
|
||||
|
||||
perf.id = p["id"].GetUint64();
|
||||
perf.eventId = p["eventId"].GetUint64();
|
||||
if (p.HasMember("logo") && !p["logo"].IsNull()) {
|
||||
perf.logo = p["logo"].GetString();
|
||||
}
|
||||
if (p.HasMember("name") && !p["name"].IsNull()) {
|
||||
perf.name = p["name"].GetString();
|
||||
}
|
||||
|
||||
// Parse prices
|
||||
for (auto& price : p["prices"].GetArray()) {
|
||||
CITMPrice pr;
|
||||
pr.amount = price["amount"].GetUint64();
|
||||
pr.audienceSubCategoryId = price["audienceSubCategoryId"].GetUint64();
|
||||
pr.seatCategoryId = price["seatCategoryId"].GetUint64();
|
||||
perf.prices.push_back(pr);
|
||||
}
|
||||
|
||||
// Parse seat categories
|
||||
for (auto& sc : p["seatCategories"].GetArray()) {
|
||||
CITMSeatCategory seatCat;
|
||||
seatCat.seatCategoryId = sc["seatCategoryId"].GetUint64();
|
||||
|
||||
for (auto& area : sc["areas"].GetArray()) {
|
||||
CITMArea ar;
|
||||
ar.areaId = area["areaId"].GetUint64();
|
||||
for (auto& block : area["blockIds"].GetArray()) {
|
||||
ar.blockIds.push_back(block.GetUint64());
|
||||
}
|
||||
seatCat.areas.push_back(ar);
|
||||
}
|
||||
perf.seatCategories.push_back(seatCat);
|
||||
}
|
||||
|
||||
if (p.HasMember("seatMapImage") && !p["seatMapImage"].IsNull()) {
|
||||
perf.seatMapImage = p["seatMapImage"].GetString();
|
||||
}
|
||||
perf.start = p["start"].GetUint64();
|
||||
perf.venueCode = p["venueCode"].GetString();
|
||||
|
||||
catalog.performances.push_back(perf);
|
||||
}
|
||||
}
|
||||
|
||||
return catalog;
|
||||
}
|
||||
|
||||
void bench_rapidjson_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_rapidjson_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
try {
|
||||
CitmCatalog data = rapidjson_deserialize(json_str);
|
||||
result = true;
|
||||
} catch (...) {
|
||||
result = false;
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
CitmCatalog yyjson_deserialize(const std::string &json_str) {
|
||||
yyjson_doc *doc = yyjson_read(json_str.c_str(), json_str.size(), 0);
|
||||
if (!doc) {
|
||||
throw std::runtime_error("YYJson parse error");
|
||||
}
|
||||
|
||||
yyjson_val *root = yyjson_doc_get_root(doc);
|
||||
CitmCatalog catalog;
|
||||
|
||||
// Parse events
|
||||
yyjson_val *events = yyjson_obj_get(root, "events");
|
||||
if (events) {
|
||||
size_t idx, max;
|
||||
yyjson_val *key, *val;
|
||||
yyjson_obj_foreach(events, idx, max, key, val) {
|
||||
CITMEvent event;
|
||||
|
||||
event.id = yyjson_get_uint(yyjson_obj_get(val, "id"));
|
||||
const char* name = yyjson_get_str(yyjson_obj_get(val, "name"));
|
||||
if (name) event.name = name;
|
||||
|
||||
yyjson_val *desc = yyjson_obj_get(val, "description");
|
||||
if (desc && !yyjson_is_null(desc)) {
|
||||
const char* str = yyjson_get_str(desc);
|
||||
if (str) event.description = str;
|
||||
}
|
||||
|
||||
yyjson_val *logo = yyjson_obj_get(val, "logo");
|
||||
if (logo && !yyjson_is_null(logo)) {
|
||||
const char* str = yyjson_get_str(logo);
|
||||
if (str) event.logo = str;
|
||||
}
|
||||
|
||||
yyjson_val *subTopics = yyjson_obj_get(val, "subTopicIds");
|
||||
if (subTopics) {
|
||||
size_t sidx, smax;
|
||||
yyjson_val *sval;
|
||||
yyjson_arr_foreach(subTopics, sidx, smax, sval) {
|
||||
event.subTopicIds.push_back(yyjson_get_uint(sval));
|
||||
}
|
||||
}
|
||||
|
||||
yyjson_val *subjectCode = yyjson_obj_get(val, "subjectCode");
|
||||
if (subjectCode && !yyjson_is_null(subjectCode)) {
|
||||
const char* str = yyjson_get_str(subjectCode);
|
||||
if (str) event.subjectCode = str;
|
||||
}
|
||||
|
||||
yyjson_val *subtitle = yyjson_obj_get(val, "subtitle");
|
||||
if (subtitle && !yyjson_is_null(subtitle)) {
|
||||
const char* str = yyjson_get_str(subtitle);
|
||||
if (str) event.subtitle = str;
|
||||
}
|
||||
|
||||
yyjson_val *topics = yyjson_obj_get(val, "topicIds");
|
||||
if (topics) {
|
||||
size_t tidx, tmax;
|
||||
yyjson_val *tval;
|
||||
yyjson_arr_foreach(topics, tidx, tmax, tval) {
|
||||
event.topicIds.push_back(yyjson_get_uint(tval));
|
||||
}
|
||||
}
|
||||
|
||||
const char* keyStr = yyjson_get_str(key);
|
||||
if (keyStr) {
|
||||
catalog.events[keyStr] = event;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Parse performances
|
||||
yyjson_val *performances = yyjson_obj_get(root, "performances");
|
||||
if (performances) {
|
||||
size_t idx, max;
|
||||
yyjson_val *val;
|
||||
yyjson_arr_foreach(performances, idx, max, val) {
|
||||
CITMPerformance perf;
|
||||
|
||||
perf.id = yyjson_get_uint(yyjson_obj_get(val, "id"));
|
||||
perf.eventId = yyjson_get_uint(yyjson_obj_get(val, "eventId"));
|
||||
|
||||
yyjson_val *logo = yyjson_obj_get(val, "logo");
|
||||
if (logo && !yyjson_is_null(logo)) {
|
||||
const char* str = yyjson_get_str(logo);
|
||||
if (str) perf.logo = str;
|
||||
}
|
||||
|
||||
yyjson_val *name = yyjson_obj_get(val, "name");
|
||||
if (name && !yyjson_is_null(name)) {
|
||||
const char* str = yyjson_get_str(name);
|
||||
if (str) perf.name = str;
|
||||
}
|
||||
|
||||
// Parse prices
|
||||
yyjson_val *prices = yyjson_obj_get(val, "prices");
|
||||
if (prices) {
|
||||
size_t pidx, pmax;
|
||||
yyjson_val *pval;
|
||||
yyjson_arr_foreach(prices, pidx, pmax, pval) {
|
||||
CITMPrice price;
|
||||
price.amount = yyjson_get_uint(yyjson_obj_get(pval, "amount"));
|
||||
price.audienceSubCategoryId = yyjson_get_uint(yyjson_obj_get(pval, "audienceSubCategoryId"));
|
||||
price.seatCategoryId = yyjson_get_uint(yyjson_obj_get(pval, "seatCategoryId"));
|
||||
perf.prices.push_back(price);
|
||||
}
|
||||
}
|
||||
|
||||
// Parse seat categories
|
||||
yyjson_val *seatCats = yyjson_obj_get(val, "seatCategories");
|
||||
if (seatCats) {
|
||||
size_t scidx, scmax;
|
||||
yyjson_val *scval;
|
||||
yyjson_arr_foreach(seatCats, scidx, scmax, scval) {
|
||||
CITMSeatCategory seatCat;
|
||||
seatCat.seatCategoryId = yyjson_get_uint(yyjson_obj_get(scval, "seatCategoryId"));
|
||||
|
||||
yyjson_val *areas = yyjson_obj_get(scval, "areas");
|
||||
if (areas) {
|
||||
size_t aidx, amax;
|
||||
yyjson_val *aval;
|
||||
yyjson_arr_foreach(areas, aidx, amax, aval) {
|
||||
CITMArea area;
|
||||
area.areaId = yyjson_get_uint(yyjson_obj_get(aval, "areaId"));
|
||||
|
||||
yyjson_val *blocks = yyjson_obj_get(aval, "blockIds");
|
||||
if (blocks) {
|
||||
size_t bidx, bmax;
|
||||
yyjson_val *bval;
|
||||
yyjson_arr_foreach(blocks, bidx, bmax, bval) {
|
||||
area.blockIds.push_back(yyjson_get_uint(bval));
|
||||
}
|
||||
}
|
||||
seatCat.areas.push_back(area);
|
||||
}
|
||||
}
|
||||
perf.seatCategories.push_back(seatCat);
|
||||
}
|
||||
}
|
||||
|
||||
yyjson_val *seatMapImage = yyjson_obj_get(val, "seatMapImage");
|
||||
if (seatMapImage && !yyjson_is_null(seatMapImage)) {
|
||||
const char* str = yyjson_get_str(seatMapImage);
|
||||
if (str) perf.seatMapImage = str;
|
||||
}
|
||||
|
||||
perf.start = yyjson_get_uint(yyjson_obj_get(val, "start"));
|
||||
const char* venueCode = yyjson_get_str(yyjson_obj_get(val, "venueCode"));
|
||||
if (venueCode) perf.venueCode = venueCode;
|
||||
|
||||
catalog.performances.push_back(perf);
|
||||
}
|
||||
}
|
||||
|
||||
yyjson_doc_free(doc);
|
||||
return catalog;
|
||||
}
|
||||
|
||||
void bench_yyjson_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_yyjson_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
try {
|
||||
CitmCatalog data = yyjson_deserialize(json_str);
|
||||
result = true;
|
||||
} catch (...) {
|
||||
result = false;
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
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);
|
||||
stream.exceptions(std::ios_base::badbit);
|
||||
|
||||
if (!stream) {
|
||||
std::cerr << "Error: Failed to open file " << filename << std::endl;
|
||||
exit(EXIT_FAILURE);
|
||||
}
|
||||
|
||||
std::string out;
|
||||
auto buf = std::string(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 matches any of the comma-separated filters
|
||||
bool matches_filter(const std::string& benchmark_name, const std::string& filter) {
|
||||
if (filter.empty()) return true;
|
||||
|
||||
// Split filter by comma
|
||||
size_t start = 0;
|
||||
size_t end = filter.find(',');
|
||||
while (end != std::string::npos) {
|
||||
std::string token = filter.substr(start, end - start);
|
||||
if (benchmark_name.find(token) != std::string::npos) {
|
||||
return true;
|
||||
}
|
||||
start = end + 1;
|
||||
end = filter.find(',', start);
|
||||
}
|
||||
// Check last token
|
||||
std::string token = filter.substr(start);
|
||||
return benchmark_name.find(token) != std::string::npos;
|
||||
}
|
||||
|
||||
int main(int argc, char *argv[]) {
|
||||
// Get the JSON file path from preprocessor or use default
|
||||
std::string filename;
|
||||
#ifdef JSON_FILE
|
||||
filename = JSON_FILE;
|
||||
#else
|
||||
filename = "jsonexamples/citm_catalog.json";
|
||||
#endif
|
||||
|
||||
std::string json_str = read_file(filename);
|
||||
|
||||
// Parse command-line arguments for filter
|
||||
std::string filter;
|
||||
for (int i = 1; i < argc; i++) {
|
||||
std::string arg = argv[i];
|
||||
if (arg == "-f" && i + 1 < argc) {
|
||||
filter = argv[i + 1];
|
||||
printf("# Filter: %s\n", filter.c_str());
|
||||
i++;
|
||||
}
|
||||
}
|
||||
|
||||
// If no filter provided, run all benchmarks
|
||||
if (filter.empty()) {
|
||||
printf("# Running all benchmarks (use -f <filter> to run specific ones)\n");
|
||||
}
|
||||
|
||||
// Benchmarking the parsing
|
||||
if (matches_filter("nlohmann", filter)) {
|
||||
bench_nlohmann_parsing(json_str);
|
||||
}
|
||||
#ifdef SIMDJSON_COMPETITION_RAPIDJSON
|
||||
if (matches_filter("rapidjson", filter)) {
|
||||
bench_rapidjson_parsing(json_str);
|
||||
}
|
||||
#endif
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
if (matches_filter("yyjson", filter)) {
|
||||
bench_yyjson_parsing(json_str);
|
||||
}
|
||||
#endif
|
||||
if (matches_filter("simdjson_static_reflection", filter)) {
|
||||
bench_simdjson_static_reflection_parsing<CitmCatalog>(json_str);
|
||||
}
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
if (matches_filter("simdjson_from", filter)) {
|
||||
bench_simdjson_from_parsing<CitmCatalog>(json_str);
|
||||
}
|
||||
#endif
|
||||
#ifdef SIMDJSON_RUST_VERSION
|
||||
if (matches_filter("rust", filter)) {
|
||||
printf("# Note: Rust/Serde parsing test\n");
|
||||
bench_rust_parsing(json_str);
|
||||
}
|
||||
#endif
|
||||
return EXIT_SUCCESS;
|
||||
}
|
||||
@@ -11,6 +11,10 @@
|
||||
#include "nlohmann_citm_catalog_data.h"
|
||||
#include "../benchmark_utils/benchmark_helper.h"
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
#include "yyjson_citm_catalog_data.h"
|
||||
#endif
|
||||
|
||||
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||
#include <rfl.hpp>
|
||||
#include <rfl/json.hpp>
|
||||
@@ -35,20 +39,15 @@ void bench_reflect_cpp(CitmCatalog &data) {
|
||||
#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);
|
||||
serde_benchmark::set_citm_data(data);
|
||||
size_t output_volume = serde_benchmark::serialize_citm_to_string();
|
||||
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));
|
||||
bench([&measured_volume, &output_volume]() {
|
||||
measured_volume = serde_benchmark::serialize_citm_to_string();
|
||||
}));
|
||||
serde_benchmark::free_str(const_cast<char*>(output));
|
||||
}
|
||||
#endif // SIMDJSON_RUST_VERSION
|
||||
|
||||
@@ -68,7 +67,55 @@ void bench_nlohmann(CitmCatalog &data) {
|
||||
}));
|
||||
}
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
void bench_yyjson(CitmCatalog &data) {
|
||||
std::string output = yyjson_serialize_citm(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_yyjson",
|
||||
bench([&data, &measured_volume, &output_volume]() {
|
||||
std::string output = yyjson_serialize_citm(data);
|
||||
measured_volume = output.size();
|
||||
if (measured_volume != output_volume) {
|
||||
printf("mismatch\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
// Fair allocation variant: allocates fresh buffer each iteration (matches other libraries)
|
||||
void bench_simdjson_static_reflection(CitmCatalog &data) {
|
||||
// First run to determine expected size
|
||||
simdjson::builder::string_builder sb_init;
|
||||
simdjson::builder::append(sb_init, data);
|
||||
std::string_view p_init;
|
||||
if(sb_init.view().get(p_init)) {
|
||||
std::cerr << "Error!" << std::endl;
|
||||
}
|
||||
size_t output_volume = p_init.size();
|
||||
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]() {
|
||||
// Fresh allocation each iteration - fair comparison
|
||||
simdjson::builder::string_builder sb;
|
||||
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");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
// Optimized variant: reuses buffer across iterations (shows API potential)
|
||||
void bench_simdjson_static_reflection_reuse(CitmCatalog &data) {
|
||||
simdjson::builder::string_builder sb;
|
||||
simdjson::builder::append(sb, data);
|
||||
std::string_view p;
|
||||
@@ -80,7 +127,7 @@ void bench_simdjson_static_reflection(CitmCatalog &data) {
|
||||
printf("# output volume: %zu bytes\n", output_volume);
|
||||
|
||||
volatile size_t measured_volume = 0;
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_static_reflection",
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_reuse_buffer",
|
||||
bench([&data, &measured_volume, &output_volume, &sb]() {
|
||||
sb.clear();
|
||||
simdjson::builder::append(sb, data);
|
||||
@@ -95,25 +142,97 @@ void bench_simdjson_static_reflection(CitmCatalog &data) {
|
||||
}));
|
||||
}
|
||||
|
||||
std::string read_file(const std::string &file_path, size_t read_size = 65536) {
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
// Fair allocation variant: allocates fresh string each iteration
|
||||
void bench_simdjson_to(CitmCatalog &data) {
|
||||
// First run to determine size
|
||||
std::string output_init;
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output_init); err) {
|
||||
std::cerr << "Error in to_json initialization!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
size_t output_volume = output_init.size();
|
||||
printf("# output volume: %zu bytes\n", output_volume);
|
||||
|
||||
volatile size_t measured_volume = 0;
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_to",
|
||||
bench([&data, &measured_volume, &output_volume]() {
|
||||
// Fresh allocation each iteration - fair comparison
|
||||
std::string output;
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output); err) {
|
||||
std::cerr << "Error in to_json!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
measured_volume = output.size();
|
||||
if (measured_volume != output_volume) {
|
||||
printf("mismatch\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
// Optimized variant: reuses pre-allocated string
|
||||
void bench_simdjson_to_reuse(CitmCatalog &data) {
|
||||
std::string output;
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output); err) {
|
||||
std::cerr << "Error in to_json initialization!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
size_t output_volume = output.size();
|
||||
printf("# output volume: %zu bytes\n", output_volume);
|
||||
|
||||
// Pre-allocate string with sufficient capacity to avoid reallocation
|
||||
output.reserve(output_volume * 2);
|
||||
|
||||
volatile size_t measured_volume = 0;
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_to_reuse",
|
||||
bench([&data, &measured_volume, &output_volume, &output]() {
|
||||
// Reuse the pre-allocated string - avoids allocation
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output); err) {
|
||||
std::cerr << "Error in to_json!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
measured_volume = output.size();
|
||||
if (measured_volume != output_volume) {
|
||||
printf("mismatch\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
simdjson::padded_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;
|
||||
simdjson::padded_string_builder builder;
|
||||
std::string buf(read_size, '\0');
|
||||
while (stream.read(&buf[0], read_size)) {
|
||||
out.append(buf, 0, size_t(stream.gcount()));
|
||||
builder.append(buf.data(), size_t(stream.gcount()));
|
||||
}
|
||||
out.append(buf, 0, size_t(stream.gcount()));
|
||||
return out;
|
||||
builder.append(buf.data(), size_t(stream.gcount()));
|
||||
return builder.convert();
|
||||
}
|
||||
|
||||
// Function to check if benchmark name contains filter substring
|
||||
// Function to check if benchmark name matches any of the comma-separated filters
|
||||
bool matches_filter(const std::string& benchmark_name, const std::string& filter) {
|
||||
return filter.empty() || benchmark_name.find(filter) != std::string::npos;
|
||||
if (filter.empty()) return true;
|
||||
|
||||
// Split filter by comma
|
||||
size_t start = 0;
|
||||
size_t end = filter.find(',');
|
||||
while (end != std::string::npos) {
|
||||
std::string token = filter.substr(start, end - start);
|
||||
if (benchmark_name.find(token) != std::string::npos) {
|
||||
return true;
|
||||
}
|
||||
start = end + 1;
|
||||
end = filter.find(',', start);
|
||||
}
|
||||
// Check last token
|
||||
std::string token = filter.substr(start);
|
||||
return benchmark_name.find(token) != std::string::npos;
|
||||
}
|
||||
|
||||
int main(int argc, char* argv[]) {
|
||||
@@ -131,12 +250,12 @@ int main(int argc, char* argv[]) {
|
||||
}
|
||||
}
|
||||
// Testing correctness of round-trip (serialization + deserialization)
|
||||
std::string json_str = read_file(JSON_FILE);
|
||||
simdjson::padded_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)) {
|
||||
if(parser.iterate(json_str).get(doc)) {
|
||||
std::cerr << "Error loading the document!" << std::endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
@@ -147,18 +266,37 @@ int main(int argc, char* argv[]) {
|
||||
}
|
||||
|
||||
// Benchmarking the serialization
|
||||
// Note: simdjson benchmarks include both "fair" (fresh allocation) and "reuse" (buffer reuse) variants
|
||||
// The "fair" variants allocate fresh memory each iteration, matching other libraries' behavior
|
||||
// The "reuse" variants demonstrate the API's potential when buffer reuse is possible
|
||||
|
||||
if (matches_filter("nlohmann", filter)) {
|
||||
bench_nlohmann(my_struct);
|
||||
}
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
if (matches_filter("yyjson", filter)) {
|
||||
bench_yyjson(my_struct);
|
||||
}
|
||||
#endif
|
||||
if (matches_filter("simdjson_static_reflection", filter)) {
|
||||
bench_simdjson_static_reflection(my_struct);
|
||||
}
|
||||
if (matches_filter("simdjson_reuse", filter)) {
|
||||
bench_simdjson_static_reflection_reuse(my_struct);
|
||||
}
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
if (matches_filter("simdjson_to", filter)) {
|
||||
bench_simdjson_to(my_struct);
|
||||
}
|
||||
if (matches_filter("simdjson_to_reuse", filter)) {
|
||||
bench_simdjson_to_reuse(my_struct);
|
||||
}
|
||||
#endif
|
||||
#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());
|
||||
serde_benchmark::citm_from_str(json_str.data(), json_str.size());
|
||||
|
||||
if (rust_data == nullptr) {
|
||||
printf("# Failed to initialize Rust data structure\n");
|
||||
|
||||
@@ -4,79 +4,65 @@
|
||||
#include <string>
|
||||
#include <vector>
|
||||
#include <map>
|
||||
#include <optional>
|
||||
#include <cstdint>
|
||||
|
||||
struct Area {
|
||||
int64_t id;
|
||||
std::string name;
|
||||
int64_t parent;
|
||||
std::vector<int64_t> childAreas;
|
||||
bool operator==(const Area &other) const = default;
|
||||
// Price structure - field names must match JSON keys for reflection
|
||||
struct CITMPrice {
|
||||
uint64_t amount;
|
||||
uint64_t audienceSubCategoryId;
|
||||
uint64_t seatCategoryId;
|
||||
bool operator==(const CITMPrice&) const = default;
|
||||
};
|
||||
|
||||
struct AudienceSubCategory {
|
||||
int64_t id;
|
||||
std::string name;
|
||||
int64_t parent;
|
||||
bool operator==(const AudienceSubCategory &other) const = default;
|
||||
struct CITMArea {
|
||||
uint64_t areaId;
|
||||
std::vector<uint64_t> blockIds;
|
||||
bool operator==(const CITMArea&) 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 CITMSeatCategory {
|
||||
std::vector<CITMArea> areas;
|
||||
uint64_t seatCategoryId;
|
||||
bool operator==(const CITMSeatCategory&) 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 CITMPerformance {
|
||||
uint64_t id;
|
||||
uint64_t eventId;
|
||||
std::optional<std::string> logo;
|
||||
std::optional<std::string> name;
|
||||
std::vector<CITMPrice> prices;
|
||||
std::vector<CITMSeatCategory> seatCategories;
|
||||
std::optional<std::string> seatMapImage;
|
||||
uint64_t start;
|
||||
std::string venueCode;
|
||||
bool operator==(const CITMPerformance&) 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 CITMEvent {
|
||||
uint64_t id;
|
||||
std::string name;
|
||||
std::optional<std::string> description;
|
||||
std::optional<std::string> logo;
|
||||
std::vector<uint64_t> subTopicIds;
|
||||
std::optional<std::string> subjectCode;
|
||||
std::optional<std::string> subtitle;
|
||||
std::vector<uint64_t> topicIds;
|
||||
bool operator==(const CITMEvent&) 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;
|
||||
std::map<std::string, CITMEvent> events;
|
||||
std::vector<CITMPerformance> performances;
|
||||
bool operator==(const CitmCatalog&) const = default;
|
||||
};
|
||||
|
||||
#endif
|
||||
// Type aliases
|
||||
using Event = CITMEvent;
|
||||
using Performance = CITMPerformance;
|
||||
using Price = CITMPrice;
|
||||
using SeatArea = CITMArea;
|
||||
using SeatCategoryInfo = CITMSeatCategory;
|
||||
|
||||
#endif
|
||||
@@ -8,164 +8,72 @@
|
||||
|
||||
using json = nlohmann::json;
|
||||
|
||||
// ---- Area ----
|
||||
inline void to_json(json &j, const Area &a) {
|
||||
// ---- CITMPrice ----
|
||||
inline void to_json(json &j, const CITMPrice &p) {
|
||||
j = json{
|
||||
{"id", a.id},
|
||||
{"name", a.name},
|
||||
{"parent", a.parent},
|
||||
{"childAreas", a.childAreas}
|
||||
{"amount", p.amount},
|
||||
{"audienceSubCategoryId", p.audienceSubCategoryId},
|
||||
{"seatCategoryId", p.seatCategoryId}
|
||||
};
|
||||
}
|
||||
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) {
|
||||
// ---- CITMArea ----
|
||||
inline void to_json(json &j, const CITMArea &a) {
|
||||
j = json{
|
||||
{"id", asc.id},
|
||||
{"name", asc.name},
|
||||
{"parent", asc.parent}
|
||||
{"areaId", a.areaId},
|
||||
{"blockIds", a.blockIds}
|
||||
};
|
||||
}
|
||||
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) {
|
||||
// ---- CITMSeatCategory ----
|
||||
inline void to_json(json &j, const CITMSeatCategory &s) {
|
||||
j = json{
|
||||
{"id", e.id},
|
||||
{"name", e.name},
|
||||
{"description", e.description},
|
||||
{"subTopic", e.subTopic},
|
||||
{"topic", e.topic},
|
||||
{"audience", e.audience}
|
||||
{"areas", s.areas},
|
||||
{"seatCategoryId", s.seatCategoryId}
|
||||
};
|
||||
}
|
||||
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) {
|
||||
// ---- CITMPerformance ----
|
||||
inline void to_json(json &j, const CITMPerformance &p) {
|
||||
j = json{
|
||||
{"id", p.id},
|
||||
{"eventId", p.eventId},
|
||||
{"logo", p.logo},
|
||||
{"name", p.name},
|
||||
{"event", p.event},
|
||||
{"prices", p.prices},
|
||||
{"seatCategories", p.seatCategories},
|
||||
{"seatMapImage", p.seatMapImage},
|
||||
{"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) {
|
||||
// ---- CITMEvent ----
|
||||
inline void to_json(json &j, const CITMEvent &e) {
|
||||
j = json{
|
||||
{"id", sc.id},
|
||||
{"name", sc.name},
|
||||
{"areas", sc.areas}
|
||||
{"id", e.id},
|
||||
{"name", e.name},
|
||||
{"description", e.description},
|
||||
{"logo", e.logo},
|
||||
{"subTopicIds", e.subTopicIds},
|
||||
{"subjectCode", e.subjectCode},
|
||||
{"subtitle", e.subtitle},
|
||||
{"topicIds", e.topicIds}
|
||||
};
|
||||
}
|
||||
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}
|
||||
{"performances", c.performances}
|
||||
};
|
||||
}
|
||||
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
|
||||
// Serialization function
|
||||
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
|
||||
@@ -0,0 +1,189 @@
|
||||
#ifndef RAPIDJSON_CITM_CATALOG_DATA_H
|
||||
#define RAPIDJSON_CITM_CATALOG_DATA_H
|
||||
|
||||
#include "citm_catalog_data.h"
|
||||
#include <rapidjson/document.h>
|
||||
#include <rapidjson/writer.h>
|
||||
#include <rapidjson/stringbuffer.h>
|
||||
#include <rapidjson/error/en.h>
|
||||
|
||||
using namespace rapidjson;
|
||||
|
||||
// RapidJSON deserialization for CITM Catalog data
|
||||
CitmCatalog rapidjson_deserialize_citm(const std::string& json_str) {
|
||||
Document doc;
|
||||
doc.Parse(json_str.c_str());
|
||||
|
||||
if (doc.HasParseError()) {
|
||||
throw std::runtime_error("RapidJSON parse error");
|
||||
}
|
||||
|
||||
CitmCatalog catalog;
|
||||
|
||||
// Parse events
|
||||
if (doc.HasMember("events") && doc["events"].IsObject()) {
|
||||
const Value& events = doc["events"];
|
||||
for (auto it = events.MemberBegin(); it != events.MemberEnd(); ++it) {
|
||||
Event event;
|
||||
const Value& ev = it->value;
|
||||
|
||||
if (ev.HasMember("description") && ev["description"].IsString())
|
||||
event.description = ev["description"].GetString();
|
||||
if (ev.HasMember("id") && ev["id"].IsUint64())
|
||||
event.id = ev["id"].GetUint64();
|
||||
if (ev.HasMember("logo") && ev["logo"].IsString())
|
||||
event.logo = ev["logo"].GetString();
|
||||
if (ev.HasMember("name") && ev["name"].IsString())
|
||||
event.name = ev["name"].GetString();
|
||||
if (ev.HasMember("subjectCode") && ev["subjectCode"].IsString())
|
||||
event.subjectCode = ev["subjectCode"].GetString();
|
||||
if (ev.HasMember("subtitle") && ev["subtitle"].IsString())
|
||||
event.subtitle = ev["subtitle"].GetString();
|
||||
|
||||
if (ev.HasMember("topicIds") && ev["topicIds"].IsArray()) {
|
||||
const Value& topics = ev["topicIds"];
|
||||
for (SizeType j = 0; j < topics.Size(); j++) {
|
||||
if (topics[j].IsUint64())
|
||||
event.topicIds.push_back(topics[j].GetUint64());
|
||||
}
|
||||
}
|
||||
|
||||
if (ev.HasMember("subTopicIds") && ev["subTopicIds"].IsArray()) {
|
||||
const Value& subtopics = ev["subTopicIds"];
|
||||
for (SizeType j = 0; j < subtopics.Size(); j++) {
|
||||
if (subtopics[j].IsUint64())
|
||||
event.subTopicIds.push_back(subtopics[j].GetUint64());
|
||||
}
|
||||
}
|
||||
|
||||
catalog.events[it->name.GetString()] = event;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse performances
|
||||
if (doc.HasMember("performances") && doc["performances"].IsArray()) {
|
||||
const Value& performances = doc["performances"];
|
||||
for (SizeType i = 0; i < performances.Size(); i++) {
|
||||
Performance perf;
|
||||
const Value& p = performances[i];
|
||||
|
||||
if (p.HasMember("id") && p["id"].IsUint64())
|
||||
perf.id = p["id"].GetUint64();
|
||||
if (p.HasMember("eventId") && p["eventId"].IsUint64())
|
||||
perf.eventId = p["eventId"].GetUint64();
|
||||
if (p.HasMember("start") && p["start"].IsUint64())
|
||||
perf.start = p["start"].GetUint64();
|
||||
if (p.HasMember("venueCode") && p["venueCode"].IsString())
|
||||
perf.venueCode = p["venueCode"].GetString();
|
||||
if (p.HasMember("name") && p["name"].IsString())
|
||||
perf.name = p["name"].GetString();
|
||||
|
||||
catalog.performances.push_back(perf);
|
||||
}
|
||||
}
|
||||
|
||||
// Parse other string maps
|
||||
auto parseStringMap = [&doc](const char* key, std::map<std::string, std::string>& target) {
|
||||
if (doc.HasMember(key) && doc[key].IsObject()) {
|
||||
const Value& obj = doc[key];
|
||||
for (auto it = obj.MemberBegin(); it != obj.MemberEnd(); ++it) {
|
||||
if (it->value.IsString()) {
|
||||
target[it->name.GetString()] = it->value.GetString();
|
||||
}
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
return catalog;
|
||||
}
|
||||
|
||||
// RapidJSON serialization for CITM Catalog data
|
||||
std::string rapidjson_serialize_citm(const CitmCatalog& catalog) {
|
||||
Document doc;
|
||||
doc.SetObject();
|
||||
Document::AllocatorType& allocator = doc.GetAllocator();
|
||||
|
||||
// Serialize events
|
||||
Value events_obj(kObjectType);
|
||||
for (const auto& [key, event] : catalog.events) {
|
||||
Value event_obj(kObjectType);
|
||||
|
||||
if (event.description) {
|
||||
Value desc;
|
||||
desc.SetString(event.description->c_str(), allocator);
|
||||
event_obj.AddMember("description", desc, allocator);
|
||||
}
|
||||
|
||||
event_obj.AddMember("id", event.id, allocator);
|
||||
|
||||
if (event.logo) {
|
||||
Value logo;
|
||||
logo.SetString(event.logo->c_str(), allocator);
|
||||
event_obj.AddMember("logo", logo, allocator);
|
||||
}
|
||||
|
||||
Value name;
|
||||
name.SetString(event.name.c_str(), allocator);
|
||||
event_obj.AddMember("name", name, allocator);
|
||||
|
||||
if (event.subjectCode) {
|
||||
Value subject;
|
||||
subject.SetString(event.subjectCode->c_str(), allocator);
|
||||
event_obj.AddMember("subjectCode", subject, allocator);
|
||||
}
|
||||
|
||||
if (event.subtitle) {
|
||||
Value subtitle;
|
||||
subtitle.SetString(event.subtitle->c_str(), allocator);
|
||||
event_obj.AddMember("subtitle", subtitle, allocator);
|
||||
}
|
||||
|
||||
Value topicIds(kArrayType);
|
||||
for (uint64_t id : event.topicIds) {
|
||||
topicIds.PushBack(id, allocator);
|
||||
}
|
||||
event_obj.AddMember("topicIds", topicIds, allocator);
|
||||
|
||||
Value subTopicIds(kArrayType);
|
||||
for (uint64_t id : event.subTopicIds) {
|
||||
subTopicIds.PushBack(id, allocator);
|
||||
}
|
||||
event_obj.AddMember("subTopicIds", subTopicIds, allocator);
|
||||
|
||||
Value key_val;
|
||||
key_val.SetString(key.c_str(), allocator);
|
||||
events_obj.AddMember(key_val, event_obj, allocator);
|
||||
}
|
||||
doc.AddMember("events", events_obj, allocator);
|
||||
|
||||
// Serialize performances
|
||||
Value performances_array(kArrayType);
|
||||
for (const auto& perf : catalog.performances) {
|
||||
Value perf_obj(kObjectType);
|
||||
perf_obj.AddMember("id", perf.id, allocator);
|
||||
perf_obj.AddMember("eventId", perf.eventId, allocator);
|
||||
perf_obj.AddMember("start", perf.start, allocator);
|
||||
|
||||
Value venue;
|
||||
venue.SetString(perf.venueCode.c_str(), allocator);
|
||||
perf_obj.AddMember("venueCode", venue, allocator);
|
||||
|
||||
if (perf.name) {
|
||||
Value name;
|
||||
name.SetString(perf.name->c_str(), allocator);
|
||||
perf_obj.AddMember("name", name, allocator);
|
||||
}
|
||||
|
||||
|
||||
performances_array.PushBack(perf_obj, allocator);
|
||||
}
|
||||
doc.AddMember("performances", performances_array, allocator);
|
||||
|
||||
StringBuffer buffer;
|
||||
Writer<StringBuffer> writer(buffer);
|
||||
doc.Accept(writer);
|
||||
|
||||
return buffer.GetString();
|
||||
}
|
||||
|
||||
#endif // RAPIDJSON_CITM_CATALOG_DATA_H
|
||||
@@ -0,0 +1,231 @@
|
||||
#ifndef YYJSON_CITM_CATALOG_DATA_H
|
||||
#define YYJSON_CITM_CATALOG_DATA_H
|
||||
|
||||
#include "citm_catalog_data.h"
|
||||
#include <yyjson.h>
|
||||
#include <string>
|
||||
#include <stdexcept>
|
||||
|
||||
// yyjson deserialization for CITM Catalog data
|
||||
// Matches C++ CitmCatalog struct (only events + performances)
|
||||
CitmCatalog yyjson_deserialize_citm(const std::string &json_str) {
|
||||
CitmCatalog catalog;
|
||||
|
||||
yyjson_doc *doc = yyjson_read(json_str.c_str(), json_str.size(), 0);
|
||||
if (!doc) {
|
||||
throw std::runtime_error("yyjson parse error");
|
||||
}
|
||||
|
||||
yyjson_val *root = yyjson_doc_get_root(doc);
|
||||
if (!root) {
|
||||
yyjson_doc_free(doc);
|
||||
return catalog;
|
||||
}
|
||||
|
||||
// Parse events
|
||||
yyjson_val *events_val = yyjson_obj_get(root, "events");
|
||||
if (events_val && yyjson_is_obj(events_val)) {
|
||||
size_t idx, max;
|
||||
yyjson_val *key, *val;
|
||||
yyjson_obj_foreach(events_val, idx, max, key, val) {
|
||||
CITMEvent event;
|
||||
|
||||
yyjson_val *v;
|
||||
v = yyjson_obj_get(val, "description");
|
||||
if (v && yyjson_is_str(v)) event.description = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(val, "id");
|
||||
if (v && yyjson_is_uint(v)) event.id = yyjson_get_uint(v);
|
||||
|
||||
v = yyjson_obj_get(val, "logo");
|
||||
if (v && yyjson_is_str(v)) event.logo = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(val, "name");
|
||||
if (v && yyjson_is_str(v)) event.name = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(val, "subjectCode");
|
||||
if (v && yyjson_is_str(v)) event.subjectCode = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(val, "subtitle");
|
||||
if (v && yyjson_is_str(v)) event.subtitle = yyjson_get_str(v);
|
||||
|
||||
// Parse topicIds array
|
||||
v = yyjson_obj_get(val, "topicIds");
|
||||
if (v && yyjson_is_arr(v)) {
|
||||
size_t arr_idx, arr_max;
|
||||
yyjson_val *arr_val;
|
||||
yyjson_arr_foreach(v, arr_idx, arr_max, arr_val) {
|
||||
if (yyjson_is_uint(arr_val))
|
||||
event.topicIds.push_back(yyjson_get_uint(arr_val));
|
||||
}
|
||||
}
|
||||
|
||||
// Parse subTopicIds array
|
||||
v = yyjson_obj_get(val, "subTopicIds");
|
||||
if (v && yyjson_is_arr(v)) {
|
||||
size_t arr_idx, arr_max;
|
||||
yyjson_val *arr_val;
|
||||
yyjson_arr_foreach(v, arr_idx, arr_max, arr_val) {
|
||||
if (yyjson_is_uint(arr_val))
|
||||
event.subTopicIds.push_back(yyjson_get_uint(arr_val));
|
||||
}
|
||||
}
|
||||
|
||||
if (yyjson_is_str(key))
|
||||
catalog.events[yyjson_get_str(key)] = event;
|
||||
}
|
||||
}
|
||||
|
||||
// Parse performances (simplified - full parsing would need prices/seatCategories)
|
||||
yyjson_val *performances_val = yyjson_obj_get(root, "performances");
|
||||
if (performances_val && yyjson_is_arr(performances_val)) {
|
||||
size_t idx, max;
|
||||
yyjson_val *perf_val;
|
||||
yyjson_arr_foreach(performances_val, idx, max, perf_val) {
|
||||
CITMPerformance perf;
|
||||
|
||||
yyjson_val *v;
|
||||
v = yyjson_obj_get(perf_val, "id");
|
||||
if (v && yyjson_is_uint(v)) perf.id = yyjson_get_uint(v);
|
||||
|
||||
v = yyjson_obj_get(perf_val, "eventId");
|
||||
if (v && yyjson_is_uint(v)) perf.eventId = yyjson_get_uint(v);
|
||||
|
||||
v = yyjson_obj_get(perf_val, "start");
|
||||
if (v && yyjson_is_uint(v)) perf.start = yyjson_get_uint(v);
|
||||
|
||||
v = yyjson_obj_get(perf_val, "venueCode");
|
||||
if (v && yyjson_is_str(v)) perf.venueCode = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(perf_val, "name");
|
||||
if (v && yyjson_is_str(v)) perf.name = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(perf_val, "logo");
|
||||
if (v && yyjson_is_str(v)) perf.logo = yyjson_get_str(v);
|
||||
|
||||
v = yyjson_obj_get(perf_val, "seatMapImage");
|
||||
if (v && yyjson_is_str(v)) perf.seatMapImage = yyjson_get_str(v);
|
||||
|
||||
// Note: prices and seatCategories parsing omitted for brevity
|
||||
// The serialization benchmark uses data loaded by simdjson
|
||||
|
||||
catalog.performances.push_back(perf);
|
||||
}
|
||||
}
|
||||
|
||||
yyjson_doc_free(doc);
|
||||
return catalog;
|
||||
}
|
||||
|
||||
// Helper to add optional string field
|
||||
static inline void yyjson_add_optional_str(yyjson_mut_doc *doc, yyjson_mut_val *obj,
|
||||
const char *key, const std::optional<std::string> &val) {
|
||||
if (val.has_value()) {
|
||||
yyjson_mut_obj_add_str(doc, obj, key, val->c_str());
|
||||
} else {
|
||||
yyjson_mut_obj_add_null(doc, obj, key);
|
||||
}
|
||||
}
|
||||
|
||||
// yyjson serialization for CITM Catalog data
|
||||
// Matches C++ CitmCatalog struct exactly (only events + performances)
|
||||
std::string yyjson_serialize_citm(const CitmCatalog &catalog) {
|
||||
yyjson_mut_doc *doc = yyjson_mut_doc_new(NULL);
|
||||
yyjson_mut_val *root = yyjson_mut_obj(doc);
|
||||
yyjson_mut_doc_set_root(doc, root);
|
||||
|
||||
// Create events object
|
||||
yyjson_mut_val *events_obj = yyjson_mut_obj(doc);
|
||||
for (const auto& [key, event] : catalog.events) {
|
||||
yyjson_mut_val *event_obj = yyjson_mut_obj(doc);
|
||||
|
||||
yyjson_add_optional_str(doc, event_obj, "description", event.description);
|
||||
yyjson_mut_obj_add_uint(doc, event_obj, "id", event.id);
|
||||
yyjson_add_optional_str(doc, event_obj, "logo", event.logo);
|
||||
// name is not optional in CITMEvent
|
||||
yyjson_mut_obj_add_str(doc, event_obj, "name", event.name.c_str());
|
||||
|
||||
// Add subTopicIds array
|
||||
yyjson_mut_val *subtopic_ids = yyjson_mut_arr(doc);
|
||||
for (uint64_t id : event.subTopicIds) {
|
||||
yyjson_mut_arr_add_uint(doc, subtopic_ids, id);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, event_obj, "subTopicIds", subtopic_ids);
|
||||
|
||||
yyjson_add_optional_str(doc, event_obj, "subjectCode", event.subjectCode);
|
||||
yyjson_add_optional_str(doc, event_obj, "subtitle", event.subtitle);
|
||||
|
||||
// Add topicIds array
|
||||
yyjson_mut_val *topic_ids = yyjson_mut_arr(doc);
|
||||
for (uint64_t id : event.topicIds) {
|
||||
yyjson_mut_arr_add_uint(doc, topic_ids, id);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, event_obj, "topicIds", topic_ids);
|
||||
|
||||
yyjson_mut_obj_add_val(doc, events_obj, key.c_str(), event_obj);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, root, "events", events_obj);
|
||||
|
||||
// Create performances array
|
||||
yyjson_mut_val *performances_array = yyjson_mut_arr(doc);
|
||||
for (const auto& perf : catalog.performances) {
|
||||
yyjson_mut_val *perf_obj = yyjson_mut_obj(doc);
|
||||
|
||||
yyjson_mut_obj_add_uint(doc, perf_obj, "eventId", perf.eventId);
|
||||
yyjson_mut_obj_add_uint(doc, perf_obj, "id", perf.id);
|
||||
yyjson_add_optional_str(doc, perf_obj, "logo", perf.logo);
|
||||
yyjson_add_optional_str(doc, perf_obj, "name", perf.name);
|
||||
|
||||
// Add prices array
|
||||
yyjson_mut_val *prices_array = yyjson_mut_arr(doc);
|
||||
for (const auto& price : perf.prices) {
|
||||
yyjson_mut_val *price_obj = yyjson_mut_obj(doc);
|
||||
yyjson_mut_obj_add_uint(doc, price_obj, "amount", price.amount);
|
||||
yyjson_mut_obj_add_uint(doc, price_obj, "audienceSubCategoryId", price.audienceSubCategoryId);
|
||||
yyjson_mut_obj_add_uint(doc, price_obj, "seatCategoryId", price.seatCategoryId);
|
||||
yyjson_mut_arr_append(prices_array, price_obj);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, perf_obj, "prices", prices_array);
|
||||
|
||||
// Add seatCategories array
|
||||
yyjson_mut_val *seat_cats_array = yyjson_mut_arr(doc);
|
||||
for (const auto& seatCat : perf.seatCategories) {
|
||||
yyjson_mut_val *seat_cat_obj = yyjson_mut_obj(doc);
|
||||
|
||||
// Add areas array
|
||||
yyjson_mut_val *areas_array = yyjson_mut_arr(doc);
|
||||
for (const auto& area : seatCat.areas) {
|
||||
yyjson_mut_val *area_obj = yyjson_mut_obj(doc);
|
||||
yyjson_mut_obj_add_uint(doc, area_obj, "areaId", area.areaId);
|
||||
|
||||
yyjson_mut_val *block_ids = yyjson_mut_arr(doc);
|
||||
for (uint64_t blockId : area.blockIds) {
|
||||
yyjson_mut_arr_add_uint(doc, block_ids, blockId);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, area_obj, "blockIds", block_ids);
|
||||
yyjson_mut_arr_append(areas_array, area_obj);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, seat_cat_obj, "areas", areas_array);
|
||||
yyjson_mut_obj_add_uint(doc, seat_cat_obj, "seatCategoryId", seatCat.seatCategoryId);
|
||||
yyjson_mut_arr_append(seat_cats_array, seat_cat_obj);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, perf_obj, "seatCategories", seat_cats_array);
|
||||
|
||||
yyjson_add_optional_str(doc, perf_obj, "seatMapImage", perf.seatMapImage);
|
||||
yyjson_mut_obj_add_uint(doc, perf_obj, "start", perf.start);
|
||||
yyjson_mut_obj_add_str(doc, perf_obj, "venueCode", perf.venueCode.c_str());
|
||||
|
||||
yyjson_mut_arr_append(performances_array, perf_obj);
|
||||
}
|
||||
yyjson_mut_obj_add_val(doc, root, "performances", performances_array);
|
||||
|
||||
// Write to string
|
||||
char *json_output = yyjson_mut_write(doc, 0, NULL);
|
||||
std::string result(json_output);
|
||||
free(json_output);
|
||||
yyjson_mut_doc_free(doc);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
#endif // YYJSON_CITM_CATALOG_DATA_H
|
||||
@@ -5,405 +5,165 @@ 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,
|
||||
}
|
||||
//==============================================================================
|
||||
// Twitter Benchmark Structures
|
||||
// These match the C++ TwitterData structures exactly
|
||||
//==============================================================================
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct User {
|
||||
id: i64,
|
||||
id_str: String,
|
||||
id: u64,
|
||||
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>,
|
||||
followers_count: u64,
|
||||
friends_count: u64,
|
||||
statuses_count: u64,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct Status {
|
||||
created_at: String,
|
||||
id: i64,
|
||||
id: u64,
|
||||
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,
|
||||
*/
|
||||
retweet_count: u64,
|
||||
favorite_count: u64,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct TwitterData {
|
||||
statuses: Vec<Status>,
|
||||
}
|
||||
static mut TWITTER_DATA: *mut TwitterData = std::ptr::null_mut();
|
||||
|
||||
#[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(),
|
||||
}
|
||||
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()
|
||||
pub unsafe extern "C" fn set_twitter_data(raw: *mut TwitterData) {
|
||||
TWITTER_DATA = raw;
|
||||
}
|
||||
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn serialize_twitter_to_string() -> usize {
|
||||
if TWITTER_DATA.is_null() {
|
||||
return 0;
|
||||
}
|
||||
let data = &*TWITTER_DATA;
|
||||
serde_json::to_string(data).unwrap().len()
|
||||
}
|
||||
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn free_twitter(raw: *mut TwitterData) {
|
||||
if raw.is_null() {
|
||||
return;
|
||||
}
|
||||
|
||||
drop(Box::from_raw(raw))
|
||||
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
|
||||
//==============================================================================
|
||||
// CITM Catalog Benchmark Structures
|
||||
// These match the C++ CitmCatalog structures EXACTLY for fair comparison
|
||||
//==============================================================================
|
||||
|
||||
#[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>,
|
||||
/// Matches C++ CITMPrice struct exactly
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
pub struct CITMPrice {
|
||||
pub amount: u64,
|
||||
#[serde(rename = "audienceSubCategoryId")]
|
||||
pub audience_sub_category_id: u64,
|
||||
#[serde(rename = "seatCategoryId")]
|
||||
pub seat_category_id: u64,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
pub struct AudienceSubCategory {
|
||||
pub id: i64,
|
||||
pub name: Option<String>, // Changed to Option
|
||||
pub parent: i64,
|
||||
/// Matches C++ CITMArea struct exactly
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
pub struct CITMArea {
|
||||
#[serde(rename = "areaId")]
|
||||
pub area_id: u64,
|
||||
#[serde(rename = "blockIds")]
|
||||
pub block_ids: Vec<u64>,
|
||||
}
|
||||
|
||||
#[derive(Serialize, Deserialize, Debug)]
|
||||
pub struct Event {
|
||||
#[serde(default)]
|
||||
pub description: Option<String>,
|
||||
pub id: i64,
|
||||
/// Matches C++ CITMSeatCategory struct exactly
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
pub struct CITMSeatCategory {
|
||||
pub areas: Vec<CITMArea>,
|
||||
#[serde(rename = "seatCategoryId")]
|
||||
pub seat_category_id: u64,
|
||||
}
|
||||
|
||||
/// Matches C++ CITMPerformance struct exactly
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
pub struct CITMPerformance {
|
||||
pub id: u64,
|
||||
#[serde(rename = "eventId")]
|
||||
pub event_id: u64,
|
||||
#[serde(default)]
|
||||
pub logo: Option<String>,
|
||||
#[serde(default)]
|
||||
pub name: Option<String>,
|
||||
pub prices: Vec<CITMPrice>,
|
||||
#[serde(rename = "seatCategories")]
|
||||
pub seat_categories: Vec<CITMSeatCategory>,
|
||||
#[serde(default)]
|
||||
pub subTopicIds: Vec<i64>,
|
||||
#[serde(rename = "seatMapImage")]
|
||||
pub seat_map_image: Option<String>,
|
||||
pub start: u64,
|
||||
#[serde(rename = "venueCode")]
|
||||
pub venue_code: String,
|
||||
}
|
||||
|
||||
/// Matches C++ CITMEvent struct exactly
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
pub struct CITMEvent {
|
||||
pub id: u64,
|
||||
#[serde(default)]
|
||||
pub subjectCode: Option<String>,
|
||||
pub name: Option<String>,
|
||||
#[serde(default)]
|
||||
pub description: Option<String>,
|
||||
#[serde(default)]
|
||||
pub logo: Option<String>,
|
||||
#[serde(default)]
|
||||
#[serde(rename = "subTopicIds")]
|
||||
pub sub_topic_ids: Vec<u64>,
|
||||
#[serde(default)]
|
||||
#[serde(rename = "subjectCode")]
|
||||
pub subject_code: 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)
|
||||
#[serde(rename = "topicIds")]
|
||||
pub topic_ids: Vec<u64>,
|
||||
}
|
||||
|
||||
/// Matches C++ CitmCatalog struct exactly - ONLY events and performances
|
||||
/// This is the key fix: we serialize only what C++ serializes
|
||||
#[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>,
|
||||
pub events: HashMap<String, CITMEvent>,
|
||||
pub performances: Vec<CITMPerformance>,
|
||||
}
|
||||
|
||||
static mut CITM_DATA: *mut CitmCatalog = std::ptr::null_mut();
|
||||
|
||||
/// Creates a CitmCatalog from a JSON string (UTF-8 encoded).
|
||||
/// Only extracts events and performances to match C++ behavior.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn citm_from_str(
|
||||
raw_input: *const c_char,
|
||||
@@ -414,7 +174,6 @@ pub unsafe extern "C" fn citm_from_str(
|
||||
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,
|
||||
@@ -424,12 +183,23 @@ pub unsafe extern "C" fn citm_from_str(
|
||||
}
|
||||
};
|
||||
|
||||
// Try deserializing the input string into CitmCatalog
|
||||
match serde_json::from_str::<CitmCatalog>(input_str) {
|
||||
Ok(catalog) => Box::into_raw(Box::new(catalog)),
|
||||
// Parse the full JSON to extract only events and performances
|
||||
match serde_json::from_str::<serde_json::Value>(input_str) {
|
||||
Ok(full_json) => {
|
||||
// Extract only the fields we need (matching C++ behavior)
|
||||
let events: HashMap<String, CITMEvent> = full_json.get("events")
|
||||
.and_then(|v| serde_json::from_value(v.clone()).ok())
|
||||
.unwrap_or_default();
|
||||
|
||||
let performances: Vec<CITMPerformance> = full_json.get("performances")
|
||||
.and_then(|v| serde_json::from_value(v.clone()).ok())
|
||||
.unwrap_or_default();
|
||||
|
||||
let catalog = CitmCatalog { events, performances };
|
||||
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()
|
||||
}
|
||||
}
|
||||
@@ -437,30 +207,17 @@ pub unsafe extern "C" fn citm_from_str(
|
||||
|
||||
/// 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();
|
||||
}
|
||||
pub unsafe extern "C" fn set_citm_data(raw: *mut CitmCatalog) {
|
||||
CITM_DATA = raw;
|
||||
}
|
||||
|
||||
// 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()
|
||||
}
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn serialize_citm_to_string() -> usize {
|
||||
if CITM_DATA.is_null() {
|
||||
return 0;
|
||||
}
|
||||
let data = &*CITM_DATA;
|
||||
return serde_json::to_string(data).unwrap().len();
|
||||
}
|
||||
|
||||
/// Frees the CitmCatalog pointer.
|
||||
@@ -475,8 +232,120 @@ pub unsafe extern "C" fn free_citm(raw_catalog: *mut CitmCatalog) {
|
||||
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);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
//==============================================================================
|
||||
// FFI Overhead Measurement Functions
|
||||
// These allow measuring the actual FFI overhead vs pure Rust serialization
|
||||
//==============================================================================
|
||||
|
||||
/// Result structure for FFI overhead measurement
|
||||
#[repr(C)]
|
||||
pub struct FfiOverheadResult {
|
||||
/// Time in nanoseconds for pure serde_json::to_string() (no FFI overhead)
|
||||
pub pure_serde_ns: u64,
|
||||
/// Time in nanoseconds for serde + CString conversion
|
||||
pub serde_plus_cstring_ns: u64,
|
||||
/// Number of iterations performed
|
||||
pub iterations: u64,
|
||||
/// Output size in bytes (for verification)
|
||||
pub output_size: u64,
|
||||
}
|
||||
|
||||
/// Prevents compiler from optimizing away the value
|
||||
/// Works on stable Rust (unlike std::hint::black_box which is unstable)
|
||||
#[inline(never)]
|
||||
fn black_box<T>(dummy: T) -> T {
|
||||
unsafe {
|
||||
let ret = std::ptr::read_volatile(&dummy);
|
||||
std::mem::forget(dummy);
|
||||
ret
|
||||
}
|
||||
}
|
||||
|
||||
/// Measures FFI overhead for Twitter serialization.
|
||||
/// Performs `iterations` serializations entirely in Rust and returns timing data.
|
||||
/// This allows comparing against per-call FFI overhead.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn measure_twitter_ffi_overhead(
|
||||
raw: *mut TwitterData,
|
||||
iterations: u64
|
||||
) -> FfiOverheadResult {
|
||||
use std::time::Instant;
|
||||
|
||||
let twitter_data = &*raw;
|
||||
let output_size: u64;
|
||||
|
||||
// Warm-up run
|
||||
let warmup = serde_json::to_string(&twitter_data).unwrap();
|
||||
output_size = warmup.len() as u64;
|
||||
|
||||
// Measure pure serde_json::to_string() - no CString conversion
|
||||
let start_pure = Instant::now();
|
||||
for _ in 0..iterations {
|
||||
let serialized = serde_json::to_string(&twitter_data).unwrap();
|
||||
// Prevent optimization from eliminating the work
|
||||
black_box(&serialized);
|
||||
}
|
||||
let pure_serde_ns = start_pure.elapsed().as_nanos() as u64;
|
||||
|
||||
// Measure serde + CString conversion (but not FFI return)
|
||||
let start_cstring = Instant::now();
|
||||
for _ in 0..iterations {
|
||||
let serialized = serde_json::to_string(&twitter_data).unwrap();
|
||||
let cstring = CString::new(serialized).unwrap();
|
||||
// Prevent optimization from eliminating the work
|
||||
black_box(&cstring);
|
||||
}
|
||||
let serde_plus_cstring_ns = start_cstring.elapsed().as_nanos() as u64;
|
||||
|
||||
FfiOverheadResult {
|
||||
pure_serde_ns,
|
||||
serde_plus_cstring_ns,
|
||||
iterations,
|
||||
output_size,
|
||||
}
|
||||
}
|
||||
|
||||
/// Measures FFI overhead for CITM serialization.
|
||||
#[no_mangle]
|
||||
pub unsafe extern "C" fn measure_citm_ffi_overhead(
|
||||
raw: *mut CitmCatalog,
|
||||
iterations: u64
|
||||
) -> FfiOverheadResult {
|
||||
use std::time::Instant;
|
||||
|
||||
let catalog = &*raw;
|
||||
let output_size: u64;
|
||||
|
||||
// Warm-up run
|
||||
let warmup = serde_json::to_string(&catalog).unwrap();
|
||||
output_size = warmup.len() as u64;
|
||||
|
||||
// Measure pure serde_json::to_string() - no CString conversion
|
||||
let start_pure = Instant::now();
|
||||
for _ in 0..iterations {
|
||||
let serialized = serde_json::to_string(&catalog).unwrap();
|
||||
black_box(&serialized);
|
||||
}
|
||||
let pure_serde_ns = start_pure.elapsed().as_nanos() as u64;
|
||||
|
||||
// Measure serde + CString conversion
|
||||
let start_cstring = Instant::now();
|
||||
for _ in 0..iterations {
|
||||
let serialized = serde_json::to_string(&catalog).unwrap();
|
||||
let cstring = CString::new(serialized).unwrap();
|
||||
black_box(&cstring);
|
||||
}
|
||||
let serde_plus_cstring_ns = start_cstring.elapsed().as_nanos() as u64;
|
||||
|
||||
FfiOverheadResult {
|
||||
pure_serde_ns,
|
||||
serde_plus_cstring_ns,
|
||||
iterations,
|
||||
output_size,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
/* Generated with cbindgen:0.28.0 */
|
||||
|
||||
/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
|
||||
/* Note: FfiOverheadResult and measurement functions added manually */
|
||||
|
||||
#include <cstdarg>
|
||||
#include <cstdint>
|
||||
@@ -17,11 +18,25 @@ struct CitmCatalog;
|
||||
|
||||
struct TwitterData;
|
||||
|
||||
/// Result structure for FFI overhead measurement
|
||||
struct FfiOverheadResult {
|
||||
/// Time in nanoseconds for pure serde_json::to_string() (no FFI overhead)
|
||||
uint64_t pure_serde_ns;
|
||||
/// Time in nanoseconds for serde + CString conversion
|
||||
uint64_t serde_plus_cstring_ns;
|
||||
/// Number of iterations performed
|
||||
uint64_t iterations;
|
||||
/// Output size in bytes (for verification)
|
||||
uint64_t output_size;
|
||||
};
|
||||
|
||||
extern "C" {
|
||||
|
||||
TwitterData *twitter_from_str(const char *raw_input, size_t raw_input_length);
|
||||
|
||||
const char *str_from_twitter(TwitterData *raw);
|
||||
void set_twitter_data(TwitterData *raw);
|
||||
|
||||
size_t serialize_twitter_to_string();
|
||||
|
||||
void free_twitter(TwitterData *raw);
|
||||
|
||||
@@ -30,14 +45,22 @@ 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);
|
||||
void set_citm_data(CitmCatalog *raw);
|
||||
|
||||
size_t serialize_citm_to_string();
|
||||
|
||||
/// Frees the CitmCatalog pointer.
|
||||
void free_citm(CitmCatalog *raw_catalog);
|
||||
|
||||
void free_str(char *ptr);
|
||||
|
||||
/// Measures FFI overhead for Twitter serialization.
|
||||
/// Performs `iterations` serializations entirely in Rust and returns timing data.
|
||||
FfiOverheadResult measure_twitter_ffi_overhead(TwitterData *raw, uint64_t iterations);
|
||||
|
||||
/// Measures FFI overhead for CITM serialization.
|
||||
FfiOverheadResult measure_citm_ffi_overhead(CitmCatalog *raw, uint64_t iterations);
|
||||
|
||||
} // extern "C"
|
||||
|
||||
} // namespace serde_benchmark
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
use std::fs;
|
||||
|
||||
// Include the lib.rs content directly
|
||||
include!("../lib.rs");
|
||||
|
||||
fn main() {
|
||||
// Read the Twitter JSON file
|
||||
let json_str = fs::read_to_string("/Users/random_person/Desktop/simdjson/build/jsonexamples/twitter.json")
|
||||
.expect("Failed to read file");
|
||||
|
||||
// Parse it
|
||||
let data: TwitterData = serde_json::from_str(&json_str)
|
||||
.expect("Failed to parse JSON");
|
||||
|
||||
// Serialize it back
|
||||
let output = serde_json::to_string(&data)
|
||||
.expect("Failed to serialize");
|
||||
|
||||
// Write to file for comparison
|
||||
fs::write("rust_output.json", &output)
|
||||
.expect("Failed to write output");
|
||||
|
||||
println!("Output size: {} bytes", output.len());
|
||||
println!("Written to rust_output.json");
|
||||
|
||||
// Also write pretty version for easier inspection
|
||||
let pretty = serde_json::to_string_pretty(&data)
|
||||
.expect("Failed to serialize pretty");
|
||||
fs::write("rust_output_pretty.json", &pretty)
|
||||
.expect("Failed to write pretty output");
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
use std::fs;
|
||||
|
||||
// Import from the parent lib.rs
|
||||
include!("../lib.rs");
|
||||
|
||||
fn main() {
|
||||
// Read the Twitter JSON file
|
||||
let json_str = fs::read_to_string("/Users/random_person/Desktop/simdjson/build/jsonexamples/twitter.json")
|
||||
.expect("Failed to read file");
|
||||
|
||||
// Parse it
|
||||
let data: TwitterData = serde_json::from_str(&json_str)
|
||||
.expect("Failed to parse JSON");
|
||||
|
||||
// Serialize it back (compact)
|
||||
let output = serde_json::to_vec(&data)
|
||||
.expect("Failed to serialize");
|
||||
|
||||
let output_str = String::from_utf8(output.clone()).unwrap();
|
||||
|
||||
// Write to file for comparison
|
||||
fs::write("rust_output_test.json", &output)
|
||||
.expect("Failed to write output");
|
||||
|
||||
println!("Output size: {} bytes", output.len());
|
||||
|
||||
// Count statuses
|
||||
println!("Number of statuses: {}", data.statuses.len());
|
||||
|
||||
// Check what fields are in the first status
|
||||
if let Some(first) = data.statuses.first() {
|
||||
// Let's serialize just the first status to see what fields are included
|
||||
let first_json = serde_json::to_string_pretty(first).unwrap();
|
||||
println!("First status (pretty):\n{}", first_json);
|
||||
}
|
||||
}
|
||||
@@ -1,14 +1,32 @@
|
||||
|
||||
# Add executable targets
|
||||
add_executable(benchmark_serialization_twitter benchmark_serialization_twitter.cpp)
|
||||
add_executable(benchmark_parsing_twitter benchmark_parsing_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_link_libraries(benchmark_parsing_twitter PRIVATE serde-benchmark)
|
||||
target_compile_definitions(benchmark_serialization_twitter PRIVATE SIMDJSON_RUST_VERSION="${Rust_VERSION}")
|
||||
target_compile_definitions(benchmark_parsing_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}")
|
||||
target_link_libraries(benchmark_parsing_twitter PRIVATE simdjson::simdjson nlohmann_json)
|
||||
|
||||
if(TARGET rapidjson)
|
||||
target_link_libraries(benchmark_parsing_twitter PRIVATE rapidjson)
|
||||
target_compile_definitions(benchmark_parsing_twitter PRIVATE SIMDJSON_COMPETITION_RAPIDJSON)
|
||||
endif()
|
||||
|
||||
if(TARGET yyjson)
|
||||
target_link_libraries(benchmark_parsing_twitter PRIVATE yyjson)
|
||||
target_compile_definitions(benchmark_parsing_twitter PRIVATE SIMDJSON_COMPETITION_YYJSON)
|
||||
target_link_libraries(benchmark_serialization_twitter PRIVATE yyjson)
|
||||
target_compile_definitions(benchmark_serialization_twitter PRIVATE SIMDJSON_COMPETITION_YYJSON)
|
||||
endif()
|
||||
|
||||
target_compile_definitions(benchmark_serialization_twitter PRIVATE JSON_FILE="${EXAMPLE_JSON}")
|
||||
target_compile_definitions(benchmark_parsing_twitter PRIVATE JSON_FILE="${EXAMPLE_JSON}")
|
||||
@@ -0,0 +1,232 @@
|
||||
#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"
|
||||
#ifdef SIMDJSON_COMPETITION_RAPIDJSON
|
||||
#include "rapidjson_twitter_data.h"
|
||||
#endif
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
#include "yyjson_twitter_data.h"
|
||||
#endif
|
||||
|
||||
#ifdef SIMDJSON_RUST_VERSION
|
||||
#include "../serde-benchmark/serde_benchmark.h"
|
||||
|
||||
void bench_rust_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_rust_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
serde_benchmark::TwitterData *td = serde_benchmark::twitter_from_str(json_str.c_str(), json_str.size());
|
||||
result = (td != nullptr);
|
||||
if (td) {
|
||||
serde_benchmark::free_twitter(td);
|
||||
}
|
||||
if (!result) {
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
// OPTIMIZED VERSION: Reuses parser across iterations
|
||||
template <class T>
|
||||
void bench_simdjson_static_reflection_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
// Pre-allocate padded buffer outside the benchmark loop
|
||||
simdjson::padded_string padded = simdjson::padded_string(json_str);
|
||||
|
||||
// CRITICAL: Create parser OUTSIDE the loop for reuse
|
||||
simdjson::ondemand::parser parser;
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_simdjson_static_reflection_parsing",
|
||||
bench([&padded, &result, &parser]() {
|
||||
// Reuse the same parser instance
|
||||
simdjson::ondemand::document doc;
|
||||
if(parser.iterate(padded).get(doc)) {
|
||||
result = false;
|
||||
return;
|
||||
}
|
||||
T my_struct;
|
||||
if(doc.get<T>().get(my_struct)) {
|
||||
result = false;
|
||||
}
|
||||
if (!result) {
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
template <class T>
|
||||
void bench_simdjson_from_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
// Pre-allocate padded buffer outside the benchmark loop
|
||||
simdjson::padded_string padded = simdjson::padded_string(json_str);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_simdjson_from_parsing",
|
||||
bench([&padded, &result]() {
|
||||
T my_struct;
|
||||
auto err = simdjson::from(padded).get(my_struct);
|
||||
if (err) {
|
||||
result = false;
|
||||
printf("parse error: %s\n", simdjson::error_message(err));
|
||||
return;
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
void bench_nlohmann_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_nlohmann_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
try {
|
||||
TwitterData data = nlohmann_deserialize(json_str);
|
||||
result = true;
|
||||
} catch (...) {
|
||||
result = false;
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_RAPIDJSON
|
||||
void bench_rapidjson_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_rapidjson_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
try {
|
||||
TwitterData data = rapidjson_deserialize(json_str);
|
||||
result = true;
|
||||
} catch (...) {
|
||||
result = false;
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
void bench_yyjson_parsing(const std::string &json_str) {
|
||||
size_t input_volume = json_str.size();
|
||||
printf("# input volume: %zu bytes\n", input_volume);
|
||||
|
||||
volatile bool result = true;
|
||||
pretty_print(1, input_volume, "bench_yyjson_parsing",
|
||||
bench([&json_str, &result]() {
|
||||
try {
|
||||
TwitterData data = yyjson_deserialize(json_str);
|
||||
result = true;
|
||||
} catch (...) {
|
||||
result = false;
|
||||
printf("parse error\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
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 matches any of the comma-separated filters
|
||||
bool matches_filter(const std::string& benchmark_name, const std::string& filter) {
|
||||
if (filter.empty()) return true;
|
||||
|
||||
// Split filter by comma
|
||||
size_t start = 0;
|
||||
size_t end = filter.find(',');
|
||||
while (end != std::string::npos) {
|
||||
std::string token = filter.substr(start, end - start);
|
||||
if (benchmark_name.find(token) != std::string::npos) {
|
||||
return true;
|
||||
}
|
||||
start = end + 1;
|
||||
end = filter.find(',', start);
|
||||
}
|
||||
// Check last token
|
||||
std::string token = filter.substr(start);
|
||||
return benchmark_name.find(token) != 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;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Load the JSON data
|
||||
std::string json_str = read_file(JSON_FILE);
|
||||
|
||||
// Benchmarking the parsing
|
||||
if (matches_filter("nlohmann", filter)) {
|
||||
bench_nlohmann_parsing(json_str);
|
||||
}
|
||||
#ifdef SIMDJSON_COMPETITION_RAPIDJSON
|
||||
if (matches_filter("rapidjson", filter)) {
|
||||
bench_rapidjson_parsing(json_str);
|
||||
}
|
||||
#endif
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
if (matches_filter("yyjson", filter)) {
|
||||
bench_yyjson_parsing(json_str);
|
||||
}
|
||||
#endif
|
||||
if (matches_filter("simdjson_static_reflection", filter)) {
|
||||
bench_simdjson_static_reflection_parsing<TwitterData>(json_str);
|
||||
}
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
if (matches_filter("simdjson_from", filter)) {
|
||||
bench_simdjson_from_parsing<TwitterData>(json_str);
|
||||
}
|
||||
#endif
|
||||
#ifdef SIMDJSON_RUST_VERSION
|
||||
if (matches_filter("rust", filter)) {
|
||||
printf("# Note: Rust/Serde parsing test\n");
|
||||
bench_rust_parsing(json_str);
|
||||
}
|
||||
#endif
|
||||
return EXIT_SUCCESS;
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
#include <cassert>
|
||||
#include <chrono>
|
||||
#include <cstdlib>
|
||||
#include <ctime>
|
||||
#include <format>
|
||||
@@ -10,6 +11,9 @@
|
||||
#include "twitter_data.h"
|
||||
#include "nlohmann_twitter_data.h"
|
||||
#include "../benchmark_utils/benchmark_helper.h"
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
#include "yyjson_twitter_data.h"
|
||||
#endif
|
||||
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||
#include <rfl.hpp>
|
||||
#include <rfl/json.hpp>
|
||||
@@ -35,19 +39,49 @@ void bench_reflect_cpp(TwitterData &data) {
|
||||
|
||||
|
||||
void bench_rust(serde_benchmark::TwitterData *data) {
|
||||
const char * output = serde_benchmark::str_from_twitter(data);
|
||||
size_t output_volume = strlen(output);
|
||||
serde_benchmark::set_twitter_data(data);
|
||||
size_t output_volume = serde_benchmark::serialize_twitter_to_string();
|
||||
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);
|
||||
bench([&measured_volume, &output_volume]() {
|
||||
measured_volume = serde_benchmark::serialize_twitter_to_string();
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
// Fair allocation variant: allocates fresh buffer each iteration (matches other libraries)
|
||||
template <class T> void bench_simdjson_static_reflection(T &data) {
|
||||
// First run to determine expected size
|
||||
simdjson::builder::string_builder sb_init;
|
||||
simdjson::builder::append(sb_init, data);
|
||||
std::string_view p_init;
|
||||
if(sb_init.view().get(p_init)) {
|
||||
std::cerr << "Error!" << std::endl;
|
||||
}
|
||||
size_t output_volume = p_init.size();
|
||||
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]() {
|
||||
// Fresh allocation each iteration - fair comparison
|
||||
simdjson::builder::string_builder sb;
|
||||
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");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
// Optimized variant: reuses buffer across iterations (shows API potential)
|
||||
template <class T> void bench_simdjson_static_reflection_reuse(T &data) {
|
||||
simdjson::builder::string_builder sb;
|
||||
simdjson::builder::append(sb, data);
|
||||
std::string_view p;
|
||||
@@ -59,7 +93,7 @@ template <class T> void bench_simdjson_static_reflection(T &data) {
|
||||
printf("# output volume: %zu bytes\n", output_volume);
|
||||
|
||||
volatile size_t measured_volume = 0;
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_static_reflection",
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_reuse_buffer",
|
||||
bench([&data, &measured_volume, &output_volume, &sb]() {
|
||||
sb.clear();
|
||||
simdjson::builder::append(sb, data);
|
||||
@@ -74,6 +108,63 @@ template <class T> void bench_simdjson_static_reflection(T &data) {
|
||||
}));
|
||||
}
|
||||
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
// Fair allocation variant: allocates fresh string each iteration
|
||||
template <class T> void bench_simdjson_to(T &data) {
|
||||
// First run to determine size
|
||||
std::string output_init;
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output_init); err) {
|
||||
std::cerr << "Error in to_json initialization!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
size_t output_volume = output_init.size();
|
||||
printf("# output volume: %zu bytes\n", output_volume);
|
||||
|
||||
volatile size_t measured_volume = 0;
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_to",
|
||||
bench([&data, &measured_volume, &output_volume]() {
|
||||
// Fresh allocation each iteration - fair comparison
|
||||
std::string output;
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output); err) {
|
||||
std::cerr << "Error in to_json!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
measured_volume = output.size();
|
||||
if (measured_volume != output_volume) {
|
||||
printf("mismatch\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
|
||||
// Optimized variant: reuses pre-allocated string
|
||||
template <class T> void bench_simdjson_to_reuse(T &data) {
|
||||
std::string output;
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output); err) {
|
||||
std::cerr << "Error in to_json initialization!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
size_t output_volume = output.size();
|
||||
printf("# output volume: %zu bytes\n", output_volume);
|
||||
|
||||
// Pre-allocate string with sufficient capacity to avoid reallocation
|
||||
output.reserve(output_volume * 2);
|
||||
|
||||
volatile size_t measured_volume = 0;
|
||||
pretty_print(sizeof(data), output_volume, "bench_simdjson_to_reuse",
|
||||
bench([&data, &measured_volume, &output_volume, &output]() {
|
||||
// Reuse the pre-allocated string - avoids allocation
|
||||
if (simdjson::error_code err = simdjson::builder::to_json(data, output); err) {
|
||||
std::cerr << "Error in to_json!" << simdjson::error_message(err) << std::endl;
|
||||
return;
|
||||
}
|
||||
measured_volume = output.size();
|
||||
if (measured_volume != output_volume) {
|
||||
printf("mismatch\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
void bench_nlohmann(TwitterData &data) {
|
||||
std::string output = nlohmann_serialize(data);
|
||||
size_t output_volume = output.size();
|
||||
@@ -90,28 +181,61 @@ void bench_nlohmann(TwitterData &data) {
|
||||
}));
|
||||
}
|
||||
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
void bench_yyjson(TwitterData &data) {
|
||||
std::string output = yyjson_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_yyjson",
|
||||
bench([&data, &measured_volume, &output_volume]() {
|
||||
std::string output = yyjson_serialize(data);
|
||||
measured_volume = output.size();
|
||||
if (measured_volume != output_volume) {
|
||||
printf("mismatch\n");
|
||||
}
|
||||
}));
|
||||
}
|
||||
#endif
|
||||
|
||||
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) {
|
||||
simdjson::padded_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;
|
||||
simdjson::padded_string_builder builder;
|
||||
std::string buf(read_size, '\0');
|
||||
while (stream.read(&buf[0], read_size)) {
|
||||
out.append(buf, 0, size_t(stream.gcount()));
|
||||
builder.append(buf.data(), size_t(stream.gcount()));
|
||||
}
|
||||
out.append(buf, 0, size_t(stream.gcount()));
|
||||
return out;
|
||||
builder.append(buf.data(), size_t(stream.gcount()));
|
||||
return builder.convert();
|
||||
}
|
||||
|
||||
// Function to check if benchmark name contains filter substring
|
||||
// Function to check if benchmark name matches any of the comma-separated filters
|
||||
bool matches_filter(const std::string& benchmark_name, const std::string& filter) {
|
||||
return filter.empty() || benchmark_name.find(filter) != std::string::npos;
|
||||
if (filter.empty()) return true;
|
||||
|
||||
// Split filter by comma
|
||||
size_t start = 0;
|
||||
size_t end = filter.find(',');
|
||||
while (end != std::string::npos) {
|
||||
std::string token = filter.substr(start, end - start);
|
||||
if (benchmark_name.find(token) != std::string::npos) {
|
||||
return true;
|
||||
}
|
||||
start = end + 1;
|
||||
end = filter.find(',', start);
|
||||
}
|
||||
// Check last token
|
||||
std::string token = filter.substr(start);
|
||||
return benchmark_name.find(token) != std::string::npos;
|
||||
}
|
||||
|
||||
int main(int argc, char* argv[]) {
|
||||
@@ -129,12 +253,12 @@ int main(int argc, char* argv[]) {
|
||||
}
|
||||
}
|
||||
// Testing correctness of round-trip (serialization + deserialization)
|
||||
std::string json_str = read_file(JSON_FILE);
|
||||
simdjson::padded_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)) {
|
||||
if(parser.iterate(json_str).get(doc)) {
|
||||
std::cerr << "Error loading the document!" << std::endl;
|
||||
return EXIT_FAILURE;
|
||||
}
|
||||
@@ -145,18 +269,41 @@ int main(int argc, char* argv[]) {
|
||||
}
|
||||
|
||||
// Benchmarking the serialization
|
||||
// Note: simdjson benchmarks include both "fair" (fresh allocation) and "reuse" (buffer reuse) variants
|
||||
// The "fair" variants allocate fresh memory each iteration, matching other libraries' behavior
|
||||
// The "reuse" variants demonstrate the API's potential when buffer reuse is possible
|
||||
|
||||
if (matches_filter("nlohmann", filter)) {
|
||||
bench_nlohmann(my_struct);
|
||||
}
|
||||
#ifdef SIMDJSON_COMPETITION_YYJSON
|
||||
if (matches_filter("yyjson", filter)) {
|
||||
bench_yyjson(my_struct);
|
||||
}
|
||||
#endif
|
||||
if (matches_filter("simdjson_static_reflection", filter)) {
|
||||
bench_simdjson_static_reflection(my_struct);
|
||||
}
|
||||
if (matches_filter("simdjson_reuse", filter)) {
|
||||
bench_simdjson_static_reflection_reuse(my_struct);
|
||||
}
|
||||
#if SIMDJSON_STATIC_REFLECTION
|
||||
if (matches_filter("simdjson_to", filter)) {
|
||||
bench_simdjson_to(my_struct);
|
||||
}
|
||||
if (matches_filter("simdjson_to_reuse", filter)) {
|
||||
bench_simdjson_to_reuse(my_struct);
|
||||
}
|
||||
#endif
|
||||
#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);
|
||||
serde_benchmark::TwitterData * td = serde_benchmark::twitter_from_str(json_str.data(), json_str.size());
|
||||
if (td == nullptr) {
|
||||
printf("# Failed to parse Twitter data for Rust benchmark\n");
|
||||
} else {
|
||||
bench_rust(td);
|
||||
serde_benchmark::free_twitter(td);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
#if SIMDJSON_BENCH_CPP_REFLECT
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
#include "twitter_data.h"
|
||||
#include <nlohmann/json.hpp>
|
||||
|
||||
// Serialization functions for nlohmann
|
||||
void to_json(nlohmann::json &j, const User &u) {
|
||||
j = nlohmann::json{{"id", u.id},
|
||||
{"name", u.name},
|
||||
@@ -16,101 +17,54 @@ void to_json(nlohmann::json &j, const User &u) {
|
||||
{"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();
|
||||
{"favorite_count", s.favorite_count}};
|
||||
}
|
||||
|
||||
void to_json(nlohmann::json &j, const TwitterData &t) {
|
||||
j = nlohmann::json{{"statuses", t.statuses}};
|
||||
}
|
||||
|
||||
// Deserialization functions for nlohmann
|
||||
void from_json(const nlohmann::json &j, User &u) {
|
||||
j.at("id").get_to(u.id);
|
||||
j.at("name").get_to(u.name);
|
||||
j.at("screen_name").get_to(u.screen_name);
|
||||
j.at("location").get_to(u.location);
|
||||
j.at("description").get_to(u.description);
|
||||
j.at("verified").get_to(u.verified);
|
||||
j.at("followers_count").get_to(u.followers_count);
|
||||
j.at("friends_count").get_to(u.friends_count);
|
||||
j.at("statuses_count").get_to(u.statuses_count);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, Status &s) {
|
||||
j.at("created_at").get_to(s.created_at);
|
||||
j.at("id").get_to(s.id);
|
||||
j.at("text").get_to(s.text);
|
||||
j.at("user").get_to(s.user);
|
||||
j.at("retweet_count").get_to(s.retweet_count);
|
||||
j.at("favorite_count").get_to(s.favorite_count);
|
||||
}
|
||||
|
||||
void from_json(const nlohmann::json &j, TwitterData &t) {
|
||||
j.at("statuses").get_to(t.statuses);
|
||||
}
|
||||
|
||||
// Helper functions for benchmarking
|
||||
std::string nlohmann_serialize(const TwitterData &data) {
|
||||
return nlohmann_serialize(data.statuses);
|
||||
nlohmann::json j = data;
|
||||
return j.dump();
|
||||
}
|
||||
|
||||
TwitterData nlohmann_deserialize(const std::string &json_str) {
|
||||
nlohmann::json j = nlohmann::json::parse(json_str);
|
||||
return j.get<TwitterData>();
|
||||
}
|
||||
|
||||
#endif // NLOHMANN_TWITTER_DATA_H
|
||||
@@ -0,0 +1,142 @@
|
||||
#ifndef RAPIDJSON_TWITTER_DATA_H
|
||||
#define RAPIDJSON_TWITTER_DATA_H
|
||||
|
||||
#include "twitter_data.h"
|
||||
#include <rapidjson/document.h>
|
||||
#include <rapidjson/writer.h>
|
||||
#include <rapidjson/stringbuffer.h>
|
||||
#include <rapidjson/error/en.h>
|
||||
|
||||
using namespace rapidjson;
|
||||
|
||||
// RapidJSON deserialization for simplified Twitter data
|
||||
TwitterData rapidjson_deserialize(const std::string& json_str) {
|
||||
Document doc;
|
||||
doc.Parse(json_str.c_str());
|
||||
|
||||
if (doc.HasParseError()) {
|
||||
throw std::runtime_error("RapidJSON parse error");
|
||||
}
|
||||
|
||||
TwitterData data;
|
||||
|
||||
if (!doc.HasMember("statuses") || !doc["statuses"].IsArray()) {
|
||||
return data;
|
||||
}
|
||||
|
||||
const Value& statuses = doc["statuses"];
|
||||
data.statuses.reserve(statuses.Size());
|
||||
|
||||
for (SizeType i = 0; i < statuses.Size(); i++) {
|
||||
const Value& status_json = statuses[i];
|
||||
Status status;
|
||||
|
||||
// Parse status fields
|
||||
if (status_json.HasMember("created_at") && status_json["created_at"].IsString())
|
||||
status.created_at = status_json["created_at"].GetString();
|
||||
if (status_json.HasMember("id") && status_json["id"].IsUint64())
|
||||
status.id = status_json["id"].GetUint64();
|
||||
if (status_json.HasMember("text") && status_json["text"].IsString())
|
||||
status.text = status_json["text"].GetString();
|
||||
if (status_json.HasMember("retweet_count") && status_json["retweet_count"].IsUint64())
|
||||
status.retweet_count = status_json["retweet_count"].GetUint64();
|
||||
if (status_json.HasMember("favorite_count") && status_json["favorite_count"].IsUint64())
|
||||
status.favorite_count = status_json["favorite_count"].GetUint64();
|
||||
|
||||
// Parse user
|
||||
if (status_json.HasMember("user") && status_json["user"].IsObject()) {
|
||||
const Value& user_json = status_json["user"];
|
||||
User user;
|
||||
|
||||
if (user_json.HasMember("id") && user_json["id"].IsUint64())
|
||||
user.id = user_json["id"].GetUint64();
|
||||
if (user_json.HasMember("name") && user_json["name"].IsString())
|
||||
user.name = user_json["name"].GetString();
|
||||
if (user_json.HasMember("screen_name") && user_json["screen_name"].IsString())
|
||||
user.screen_name = user_json["screen_name"].GetString();
|
||||
if (user_json.HasMember("location") && user_json["location"].IsString())
|
||||
user.location = user_json["location"].GetString();
|
||||
if (user_json.HasMember("description") && user_json["description"].IsString())
|
||||
user.description = user_json["description"].GetString();
|
||||
if (user_json.HasMember("verified") && user_json["verified"].IsBool())
|
||||
user.verified = user_json["verified"].GetBool();
|
||||
if (user_json.HasMember("followers_count") && user_json["followers_count"].IsUint64())
|
||||
user.followers_count = user_json["followers_count"].GetUint64();
|
||||
if (user_json.HasMember("friends_count") && user_json["friends_count"].IsUint64())
|
||||
user.friends_count = user_json["friends_count"].GetUint64();
|
||||
if (user_json.HasMember("statuses_count") && user_json["statuses_count"].IsUint64())
|
||||
user.statuses_count = user_json["statuses_count"].GetUint64();
|
||||
|
||||
status.user = user;
|
||||
}
|
||||
|
||||
data.statuses.push_back(status);
|
||||
}
|
||||
|
||||
return data;
|
||||
}
|
||||
|
||||
// RapidJSON serialization for simplified Twitter data
|
||||
std::string rapidjson_serialize(const TwitterData& data) {
|
||||
Document doc;
|
||||
doc.SetObject();
|
||||
Document::AllocatorType& allocator = doc.GetAllocator();
|
||||
|
||||
Value statuses_array(kArrayType);
|
||||
|
||||
for (const auto& status : data.statuses) {
|
||||
Value status_obj(kObjectType);
|
||||
|
||||
Value created_at;
|
||||
created_at.SetString(status.created_at.c_str(), allocator);
|
||||
status_obj.AddMember("created_at", created_at, allocator);
|
||||
|
||||
status_obj.AddMember("id", status.id, allocator);
|
||||
|
||||
Value text;
|
||||
text.SetString(status.text.c_str(), allocator);
|
||||
status_obj.AddMember("text", text, allocator);
|
||||
|
||||
// Add user
|
||||
Value user_obj(kObjectType);
|
||||
user_obj.AddMember("id", status.user.id, allocator);
|
||||
|
||||
Value name;
|
||||
name.SetString(status.user.name.c_str(), allocator);
|
||||
user_obj.AddMember("name", name, allocator);
|
||||
|
||||
Value screen_name;
|
||||
screen_name.SetString(status.user.screen_name.c_str(), allocator);
|
||||
user_obj.AddMember("screen_name", screen_name, allocator);
|
||||
|
||||
Value location;
|
||||
location.SetString(status.user.location.c_str(), allocator);
|
||||
user_obj.AddMember("location", location, allocator);
|
||||
|
||||
Value description;
|
||||
description.SetString(status.user.description.c_str(), allocator);
|
||||
user_obj.AddMember("description", description, allocator);
|
||||
|
||||
user_obj.AddMember("verified", status.user.verified, allocator);
|
||||
user_obj.AddMember("followers_count", status.user.followers_count, allocator);
|
||||
user_obj.AddMember("friends_count", status.user.friends_count, allocator);
|
||||
user_obj.AddMember("statuses_count", status.user.statuses_count, allocator);
|
||||
|
||||
status_obj.AddMember("user", user_obj, allocator);
|
||||
|
||||
status_obj.AddMember("retweet_count", status.retweet_count, allocator);
|
||||
status_obj.AddMember("favorite_count", status.favorite_count, allocator);
|
||||
|
||||
statuses_array.PushBack(status_obj, allocator);
|
||||
}
|
||||
|
||||
doc.AddMember("statuses", statuses_array, allocator);
|
||||
|
||||
StringBuffer buffer;
|
||||
Writer<StringBuffer> writer(buffer);
|
||||
doc.Accept(writer);
|
||||
|
||||
return buffer.GetString();
|
||||
}
|
||||
|
||||
#endif // RAPIDJSON_TWITTER_DATA_H
|
||||
@@ -4,68 +4,31 @@
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
// Simplified Twitter structures for benchmarking
|
||||
|
||||
struct User {
|
||||
int64_t id;
|
||||
std::string id_str;
|
||||
uint64_t id;
|
||||
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;
|
||||
uint64_t followers_count;
|
||||
uint64_t friends_count;
|
||||
uint64_t statuses_count;
|
||||
};
|
||||
|
||||
struct Status {
|
||||
std::string created_at;
|
||||
int64_t id;
|
||||
uint64_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;
|
||||
uint64_t retweet_count;
|
||||
uint64_t favorite_count;
|
||||
};
|
||||
|
||||
struct TwitterData {
|
||||
std::vector<Status> statuses;
|
||||
bool operator==(const TwitterData &other) const = default;
|
||||
};
|
||||
|
||||
#endif
|
||||
#endif // TWITTER_DATA_H
|
||||
@@ -0,0 +1,145 @@
|
||||
#ifndef YYJSON_TWITTER_DATA_H
|
||||
#define YYJSON_TWITTER_DATA_H
|
||||
|
||||
#include "twitter_data.h"
|
||||
#include <yyjson.h>
|
||||
#include <string>
|
||||
#include <stdexcept>
|
||||
|
||||
// yyjson deserialization for simplified Twitter data
|
||||
TwitterData yyjson_deserialize(const std::string &json_str) {
|
||||
TwitterData data;
|
||||
|
||||
yyjson_doc *doc = yyjson_read(json_str.c_str(), json_str.size(), 0);
|
||||
if (!doc) {
|
||||
throw std::runtime_error("yyjson parse error");
|
||||
}
|
||||
|
||||
yyjson_val *root = yyjson_doc_get_root(doc);
|
||||
if (!root) {
|
||||
yyjson_doc_free(doc);
|
||||
return data;
|
||||
}
|
||||
|
||||
// Get statuses array
|
||||
yyjson_val *statuses_val = yyjson_obj_get(root, "statuses");
|
||||
if (!statuses_val || !yyjson_is_arr(statuses_val)) {
|
||||
yyjson_doc_free(doc);
|
||||
return data;
|
||||
}
|
||||
|
||||
size_t idx, max;
|
||||
yyjson_val *status_val;
|
||||
yyjson_arr_foreach(statuses_val, idx, max, status_val) {
|
||||
Status status;
|
||||
|
||||
// Parse status fields
|
||||
yyjson_val *val;
|
||||
|
||||
val = yyjson_obj_get(status_val, "created_at");
|
||||
if (val && yyjson_is_str(val)) status.created_at = yyjson_get_str(val);
|
||||
|
||||
val = yyjson_obj_get(status_val, "id");
|
||||
if (val && yyjson_is_uint(val)) status.id = yyjson_get_uint(val);
|
||||
|
||||
val = yyjson_obj_get(status_val, "text");
|
||||
if (val && yyjson_is_str(val)) status.text = yyjson_get_str(val);
|
||||
|
||||
val = yyjson_obj_get(status_val, "retweet_count");
|
||||
if (val && yyjson_is_uint(val)) status.retweet_count = yyjson_get_uint(val);
|
||||
|
||||
val = yyjson_obj_get(status_val, "favorite_count");
|
||||
if (val && yyjson_is_uint(val)) status.favorite_count = yyjson_get_uint(val);
|
||||
|
||||
// Parse user
|
||||
yyjson_val *user_val = yyjson_obj_get(status_val, "user");
|
||||
if (user_val && yyjson_is_obj(user_val)) {
|
||||
User user;
|
||||
|
||||
val = yyjson_obj_get(user_val, "id");
|
||||
if (val && yyjson_is_uint(val)) user.id = yyjson_get_uint(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "name");
|
||||
if (val && yyjson_is_str(val)) user.name = yyjson_get_str(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "screen_name");
|
||||
if (val && yyjson_is_str(val)) user.screen_name = yyjson_get_str(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "location");
|
||||
if (val && yyjson_is_str(val)) user.location = yyjson_get_str(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "description");
|
||||
if (val && yyjson_is_str(val)) user.description = yyjson_get_str(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "verified");
|
||||
if (val && yyjson_is_bool(val)) user.verified = yyjson_get_bool(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "followers_count");
|
||||
if (val && yyjson_is_uint(val)) user.followers_count = yyjson_get_uint(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "friends_count");
|
||||
if (val && yyjson_is_uint(val)) user.friends_count = yyjson_get_uint(val);
|
||||
|
||||
val = yyjson_obj_get(user_val, "statuses_count");
|
||||
if (val && yyjson_is_uint(val)) user.statuses_count = yyjson_get_uint(val);
|
||||
|
||||
status.user = user;
|
||||
}
|
||||
|
||||
data.statuses.push_back(status);
|
||||
}
|
||||
|
||||
yyjson_doc_free(doc);
|
||||
return data;
|
||||
}
|
||||
|
||||
// yyjson serialization for simplified Twitter data
|
||||
std::string yyjson_serialize(const TwitterData &data) {
|
||||
yyjson_mut_doc *doc = yyjson_mut_doc_new(NULL);
|
||||
yyjson_mut_val *root = yyjson_mut_obj(doc);
|
||||
yyjson_mut_doc_set_root(doc, root);
|
||||
|
||||
// Create statuses array
|
||||
yyjson_mut_val *statuses_array = yyjson_mut_arr(doc);
|
||||
|
||||
for (const auto& status : data.statuses) {
|
||||
yyjson_mut_val *status_obj = yyjson_mut_obj(doc);
|
||||
|
||||
// Add status fields
|
||||
yyjson_mut_obj_add_str(doc, status_obj, "created_at", status.created_at.c_str());
|
||||
yyjson_mut_obj_add_uint(doc, status_obj, "id", status.id);
|
||||
yyjson_mut_obj_add_str(doc, status_obj, "text", status.text.c_str());
|
||||
|
||||
// User object
|
||||
yyjson_mut_val *user_obj = yyjson_mut_obj(doc);
|
||||
yyjson_mut_obj_add_uint(doc, user_obj, "id", status.user.id);
|
||||
yyjson_mut_obj_add_str(doc, user_obj, "name", status.user.name.c_str());
|
||||
yyjson_mut_obj_add_str(doc, user_obj, "screen_name", status.user.screen_name.c_str());
|
||||
yyjson_mut_obj_add_str(doc, user_obj, "location", status.user.location.c_str());
|
||||
yyjson_mut_obj_add_str(doc, user_obj, "description", status.user.description.c_str());
|
||||
yyjson_mut_obj_add_bool(doc, user_obj, "verified", status.user.verified);
|
||||
yyjson_mut_obj_add_uint(doc, user_obj, "followers_count", status.user.followers_count);
|
||||
yyjson_mut_obj_add_uint(doc, user_obj, "friends_count", status.user.friends_count);
|
||||
yyjson_mut_obj_add_uint(doc, user_obj, "statuses_count", status.user.statuses_count);
|
||||
yyjson_mut_obj_add_val(doc, status_obj, "user", user_obj);
|
||||
|
||||
// Other fields
|
||||
yyjson_mut_obj_add_uint(doc, status_obj, "retweet_count", status.retweet_count);
|
||||
yyjson_mut_obj_add_uint(doc, status_obj, "favorite_count", status.favorite_count);
|
||||
|
||||
yyjson_mut_arr_append(statuses_array, status_obj);
|
||||
}
|
||||
|
||||
// Add statuses array to root
|
||||
yyjson_mut_obj_add_val(doc, root, "statuses", statuses_array);
|
||||
|
||||
// Write to string
|
||||
char *json_output = yyjson_mut_write(doc, 0, NULL);
|
||||
std::string result(json_output);
|
||||
free(json_output);
|
||||
yyjson_mut_doc_free(doc);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
#endif // YYJSON_TWITTER_DATA_H
|
||||
@@ -17,8 +17,9 @@ editing CMAKE_CXX_FLAGS")
|
||||
# /EHc used in conjection with /EHs indicates that extern "C" functions
|
||||
# never throw (terminate-on-throw)
|
||||
# Here, we disable both with the - argument negation operator
|
||||
string(REPLACE "/EHsc" "/EHs-c-" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
|
||||
|
||||
if(CMAKE_CXX_FLAGS)
|
||||
string(REPLACE "/EHsc" "/EHs-c-" CMAKE_CXX_FLAGS ${CMAKE_CXX_FLAGS})
|
||||
endif()
|
||||
# Because we cannot change the flag above on an individual target (yet), the
|
||||
# definition below must similarly be added globally
|
||||
add_definitions(-D_HAS_EXCEPTIONS=0)
|
||||
|
||||
@@ -12,7 +12,7 @@ cmake_dependent_option(SIMDJSON_GOOGLE_BENCHMARKS "compile the Google Benchmark
|
||||
if(SIMDJSON_GOOGLE_BENCHMARKS)
|
||||
CPMAddPackage(
|
||||
NAME google_benchmarks
|
||||
URL https://github.com/google/benchmark/archive/refs/tags/v1.9.4.zip
|
||||
URL https://github.com/google/benchmark/archive/refs/tags/v1.9.5.zip
|
||||
OPTIONS
|
||||
"BENCHMARK_ENABLE_TESTING OFF"
|
||||
"BENCHMARK_ENABLE_INSTALL OFF"
|
||||
@@ -20,6 +20,14 @@ if(SIMDJSON_GOOGLE_BENCHMARKS)
|
||||
)
|
||||
endif()
|
||||
|
||||
CPMAddPackage(
|
||||
NAME counters
|
||||
URL https://github.com/lemire/counters/archive/refs/tags/v3.1.0.zip
|
||||
OPTIONS
|
||||
"COUNTERS_BUILD_TESTS OFF"
|
||||
"COUNTERS_INSTALL OFF"
|
||||
)
|
||||
|
||||
CPMAddPackage(
|
||||
NAME simdjson-data
|
||||
URL https://github.com/simdjson/simdjson-data/archive/351949906abde446f0314bf79606fb5d884f5be7.zip
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
The Basics
|
||||
==========
|
||||
|
||||
|
||||
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
|
||||
separate document](https://github.com/simdjson/simdjson/blob/master/doc/builder.md).
|
||||
@@ -21,11 +22,15 @@ separate document](https://github.com/simdjson/simdjson/blob/master/doc/builder.
|
||||
* [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)
|
||||
+ [Special cases](#special-cases)
|
||||
* [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)
|
||||
* [Using `for_each_at_path_with_wildcard` for JSONPath Queries (On-Demand)](#using-for_each_at_path_with_wildcard-for-jsonpath-queries-on-demand)
|
||||
+ [Example Usage](#example-usage)
|
||||
- [C++20 Ranges Support](#c20-ranges-support)
|
||||
- [Compile-Time JSONPath and JSON Pointer (C++26 Reflection)](#compile-time-jsonpath-and-json-pointer-c26-reflection)
|
||||
- [Error handling](#error-handling)
|
||||
* [Error handling examples without exceptions](#error-handling-examples-without-exceptions)
|
||||
@@ -54,7 +59,7 @@ Requirements
|
||||
The simdjson library is widely deployed in popular systems such as the Node.js runtime
|
||||
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).
|
||||
- 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). We support [Fil-C, the memory-safe C/C++ compiler](https://fil-c.org).
|
||||
- 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.
|
||||
@@ -159,49 +164,77 @@ The basics: loading and parsing JSON documents
|
||||
----------------------------------------------
|
||||
|
||||
The simdjson library allows you to navigate and validate JSON documents ([RFC 8259](https://www.tbray.org/ongoing/When/201x/2017/12/14/rfc8259.html)).
|
||||
As required by the standard, your JSON document should be in a Unicode (UTF-8) string. The whole
|
||||
string, from the beginning to the end, needs to be valid: we do not attempt to tolerate bad
|
||||
inputs before or after a document.
|
||||
Your JSON document should be a valid Unicode (UTF-8) string.
|
||||
|
||||
For efficiency reasons, simdjson requires a string with a few bytes (`simdjson::SIMDJSON_PADDING`)
|
||||
at the end, these bytes may be read but their content does not affect the parsing. In practice,
|
||||
it means that the JSON inputs should be stored in a memory region with `simdjson::SIMDJSON_PADDING`
|
||||
extra bytes at the end. You do not have to set these bytes to specific values though you may
|
||||
want to if you want to avoid runtime warnings with some sanitizers. Advanced users may want to
|
||||
read the section Free Padding in [our performance notes](performance.md).
|
||||
|
||||
The simdjson library offers a tree-like [API](https://en.wikipedia.org/wiki/API), which you can
|
||||
access by creating a `ondemand::parser` and calling the `iterate()` method. The iterate method
|
||||
quickly indexes the input string and may detect some errors. The following example illustrates
|
||||
how to get started with an input JSON file (`"twitter.json"`):
|
||||
To parse JSON, create a `ondemand::parser` and call its `iterate()` method on a padded input.
|
||||
The simplest way to load a JSON file is with `padded_string::load`:
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
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
|
||||
auto json = padded_string::load("twitter.json");
|
||||
ondemand::document doc = parser.iterate(json);
|
||||
```
|
||||
|
||||
If you prefer not to create your own `ondemand::parser` instance, you can access
|
||||
a thread-local version by calling `ondemand::parser.get_parser()`.
|
||||
For inline JSON strings, use the `_padded` suffix:
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
auto json = "[1,2,3]"_padded;
|
||||
ondemand::document doc = parser.iterate(json);
|
||||
```
|
||||
|
||||
If you are compiling with C++17 or better, you can use `simdjson::padded_input`
|
||||
which accepts any string-like input and handles padding automatically:
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
std::string_view json = "[1,2,3]";
|
||||
simdjson::padded_input input(json);
|
||||
ondemand::document doc = parser.iterate(input);
|
||||
|
||||
// Also works with std::string, considering reserved capacity
|
||||
std::string json_str = "[1,2,3]";
|
||||
json_str.reserve(100); // Reserve extra space
|
||||
simdjson::padded_input input2(json_str); // May avoid copying
|
||||
ondemand::document doc2 = parser.iterate(input2);
|
||||
```
|
||||
|
||||
The simdjson library also accepts `std::string` instances directly---if the provided
|
||||
reference is non-const, it will allocate padding as needed:
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
std::string json = "[1,2,3]";
|
||||
ondemand::document doc = parser.iterate(json);
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
|
||||
### Advanced input options
|
||||
|
||||
This section covers additional ways to provide JSON input to simdjson, including
|
||||
options for fine-grained control over padding and memory.
|
||||
|
||||
**Thread-local parser.** If you prefer not to create your own `ondemand::parser` instance, you can access
|
||||
a thread-local version by calling `ondemand::parser.get_parser()`:
|
||||
|
||||
```cpp
|
||||
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
|
||||
A parser instance can only be used for one document at a time, so
|
||||
the thread-local parser is only applicable when you parse one
|
||||
document per thread at any one time.
|
||||
|
||||
You can also create a padded string---and call `iterate()`:
|
||||
**`padded_input` details (C++17+).** The actual padding only occurs when the JSON string ends near the boundary of a memory page, which is
|
||||
uncommon. Using a `simdjson::padded_input` is safe although sanitizers and tools like valgrind
|
||||
might report illegal reads (which are safe in our case because they remain in the mapped page). You should avoid `simdjson::padded_input`
|
||||
on systems without a page size of at least 4096: virtually all systems qualify except for
|
||||
some niche embedded systems running custom operating systems. Standard Linux, Windows, macOS, Android, iOS, etc., are all fine. Note that, most times, a `simdjson::padded_input` instance will not copy the data and will only act
|
||||
as a view (it does not own the memory).
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
auto json = "[1,2,3]"_padded; // The _padded suffix creates a simdjson::padded_string instance
|
||||
ondemand::document doc = parser.iterate(json); // parse a string
|
||||
```
|
||||
|
||||
If you have a buffer of your own with enough padding already (SIMDJSON_PADDING extra bytes allocated), you can use `padded_string_view` to pass it in:
|
||||
**User-managed buffers.** If you have a buffer of your own with enough padding already (`SIMDJSON_PADDING` extra bytes allocated), you can use `padded_string_view` to pass it in:
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
@@ -210,60 +243,99 @@ strcpy(json, "[1]");
|
||||
ondemand::document doc = parser.iterate(json, strlen(json), sizeof(json));
|
||||
```
|
||||
|
||||
The simdjson library will also accept `std::string` instances. If the provided
|
||||
reference is non-const, it will allocate padding as needed.
|
||||
|
||||
You can copy your data directly on a `simdjson::padded_string` as follows:
|
||||
**Copying into a `padded_string`.** You can copy your data directly into a `simdjson::padded_string`:
|
||||
|
||||
```cpp
|
||||
const char * data = "my data"; // 7 bytes
|
||||
simdjson::padded_string my_padded_data(data, 7); // copies to a padded buffer
|
||||
```
|
||||
|
||||
Or as follows...
|
||||
Or from a `std::string`:
|
||||
|
||||
```cpp
|
||||
std::string data = "my data";
|
||||
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:
|
||||
|
||||
|
||||
```cpp
|
||||
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
|
||||
**`std::string` and sanitizer warnings.** Whenever you pass an `std::string` reference to `parser::iterate`,
|
||||
the parser may access 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:
|
||||
Sanitizers that check for reading uninitialized bytes may produce warnings.
|
||||
You can safely ignore these warnings, or call `simdjson::pad(std::string&)` to pad the
|
||||
string explicitly:
|
||||
|
||||
```cpp
|
||||
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::padded_string` instances in your application to store your JSON data.
|
||||
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.
|
||||
**Memory-file mapping.** You can use `simdjson::padded_memory_map` to create a
|
||||
`simdjson::padded_string_view` from a file on disk. On POSIX systems (Linux,
|
||||
macOS, BSD, ...) it uses `mmap` for true zero-copy access and is always
|
||||
available. On Windows it is an **opt-in** feature because it relies on the
|
||||
`CreateFileMapping2` / `MapViewOfFile3` APIs (Windows 10, version 1803 or
|
||||
later) which are exported from `onecore.lib` rather than the default
|
||||
`kernel32.lib`. To enable it, you must satisfy **all** of the following:
|
||||
|
||||
Some users may want to browse code along with the compiled assembly. You want to check out the following lists of examples:
|
||||
1. Building simdjson with `-DSIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=ON`, or
|
||||
defining `SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=1` and raising
|
||||
`NTDDI_VERSION` to at least `NTDDI_WIN10_RS4` (Windows 10, version 1803)
|
||||
and linking `onecore.lib` manually if you are consuming simdjson as a
|
||||
pre-built library.
|
||||
2. `#include <windows.h>` before including simdjson, in every translation
|
||||
unit that uses `padded_memory_map`.
|
||||
|
||||
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/98Kx9Kqjn)
|
||||
* [simdjson examples with errors without exceptions](https://godbolt.org/z/PKG7GdbPo)
|
||||
The Windows implementation then uses `CreateFileMapping2` / `MapViewOfFile3`
|
||||
for true zero-copy access whenever possible, with a transparent
|
||||
buffered-read fallback for files that end too close to a page boundary.
|
||||
|
||||
*Windows-specific*: Windows users who need to read files with
|
||||
The availability of the class can be tested with the preprocessor macro
|
||||
`SIMDJSON_HAS_PADDED_MEMORY_MAP`.
|
||||
|
||||
```cpp
|
||||
#ifdef _WIN32
|
||||
#include <windows.h> // Must come BEFORE <simdjson.h> on Windows
|
||||
#endif
|
||||
#include "simdjson.h"
|
||||
// ...
|
||||
simdjson::padded_memory_map map(myfilename);
|
||||
if (!map.is_valid()) { /* handle error */ }
|
||||
simdjson::padded_string_view view = map.view();
|
||||
ondemand::document doc = parser.iterate(view);
|
||||
```
|
||||
|
||||
**Windows-specific notes.** Windows users compiling with C++17 or better may use `wchar_t` strings to support non-ASCII
|
||||
filenames: `padded_string::load(L"twitter.json")`. Windows users who need to read files with
|
||||
non-ANSI characters in the name should set their code page to
|
||||
UTF-8 (65001). This should be the default with Windows 11 and better.
|
||||
Further, they may use the AreFileApisANSI function to determine whether
|
||||
the filename is interpreted using the ANSI or the system default OEM
|
||||
codepage, and they may call SetFileApisToOEM accordingly.
|
||||
|
||||
Some users may want to browse code along with the compiled assembly:
|
||||
|
||||
* [simdjson examples with errors handled through exceptions](https://godbolt.org/z/98Kx9Kqjn)
|
||||
* [simdjson examples with errors without exceptions](https://godbolt.org/z/PKG7GdbPo)
|
||||
|
||||
**Summary of input types:**
|
||||
|
||||
|
||||
| Input Type / Method | Padding Requirement | How Padding is Handled | Ownership / Copying | Notes / Warnings |
|
||||
|----------------------------------------------|-------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------|----------------------------------------------|----------------------------------------------------------------------------------|
|
||||
| `padded_string::load("file.json")` | Automatic (SIMDJSON_PADDING extra bytes) | Library allocates padded buffer and loads file into it | Owned by `padded_string` | Recommended for files; safest and simplest. |
|
||||
| `"...json..."_padded` literal | Automatic (built-in padding) | Creates `padded_string` with padding | Owned by `padded_string` | Convenient for small hardcoded JSON. |
|
||||
| `simdjson::padded_input` (C++17+) | Automatic when needed | Adds padding **only** if the string ends near a memory page boundary. For `std::string`, considers `capacity()` | Usually a non-owning view (no copy most times) | Safe on standard OS (page size ≥ 4096). May trigger sanitizer/valgrind warnings (harmless). Avoid on niche embedded systems. |
|
||||
| User buffer with explicit padding | Must have at least `SIMDJSON_PADDING` extra allocated bytes after JSON content | Pass via `iterate(ptr, json_length, total_allocated_size)` or `padded_string_view` | User-owned (no copy) | Use `char buf[len + SIMDJSON_PADDING]`. Library reads (but never writes) into padding. |
|
||||
| `std::string` (non-const) | Library checks `capacity()` | If insufficient, library may allocate a padded copy | May copy (depends on capacity) | Can trigger sanitizer warnings on uninitialized bytes. Use `simdjson::pad(json)` to avoid. |
|
||||
| `simdjson::pad(std::string&)` | Adds padding if needed | Returns `padded_string_view` pointing to the (possibly resized) string | References original string | Recommended to silence sanitizers when using `std::string`. |
|
||||
| `padded_string(data, length)` or `padded_string(std::string)` | Automatic (copies into padded buffer) | Explicit copy into owned padded buffer | Owned by `padded_string` | Safe when you want full ownership and padding guaranteed. |
|
||||
| `padded_string_view` (manual) | User guarantees `SIMDJSON_PADDING` extra bytes after the viewed length | User provides pointer + length + capacity | Non-owning view | Low-level; requires careful buffer management. |
|
||||
| Memory-mapped file (`padded_memory_map`) | Automatic via mapping / padded read | Creates view with sufficient padding | Non-owning (tied to map lifetime) | Always available on POSIX (zero-copy `mmap`). On Windows, opt-in via `-DSIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=ON` (requires Windows 10 1803+ and links `onecore.lib`) and `#include <windows.h>` before simdjson; uses `CreateFileMapping2` + `MapViewOfFile3`. |
|
||||
|
||||
|
||||
Documents are iterators
|
||||
-----------------------
|
||||
|
||||
@@ -349,7 +421,13 @@ 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
|
||||
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
|
||||
using the library in a safe manner.
|
||||
using the library in a safe manner. We add asserts which may halt your program, helping
|
||||
you find the bad programming pattern.
|
||||
|
||||
When `SIMDJSON_DEVELOPMENT_CHECKS`, some of our data structures contain extra data for
|
||||
tracking explicitly potential programming mistakes. Thus you should not relying on the
|
||||
size (`sizeof`) of our data structures to be constant: they may change depending on the
|
||||
compiler settings.
|
||||
|
||||
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
|
||||
@@ -361,6 +439,10 @@ 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.
|
||||
|
||||
|
||||
Warnign: Mixing debug and release simdjson code is unsafe: you either build all your code
|
||||
using simdjson in release mode or all of it in debug mode.
|
||||
|
||||
Using the parsed JSON
|
||||
---------------------
|
||||
|
||||
@@ -404,7 +486,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
* **Extracting Values:** You can cast a JSON element to a native type:
|
||||
`double(element)`. This works for `std::string_view`, double, uint64_t, int64_t, bool,
|
||||
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_uint32()`, `get_int32()`, `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 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,
|
||||
@@ -414,8 +496,8 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
pass `true` (`get_string(true)`) as a parameter to get replacement characters where errors
|
||||
occur. If you somehow need to access non-UTF-8 strings in a lossless manner
|
||||
(e.g., if you strings contain unpaired surrogates), you may use the `get_wobbly_string()` function to get a string in the [WTF-8 format](https://simonsapin.github.io/wtf-8).
|
||||
When calling `get_uint64()` and `get_int64()`, if the number does not fit in a corresponding
|
||||
64-bit integer type, it is also considered an error. When parsing numbers or other scalar values, the library checks
|
||||
When calling `get_uint64()`, `get_int64()`, `get_uint32()` or `get_int32()`, if the number does not fit in the
|
||||
corresponding integer type, it is also considered an error (`NUMBER_OUT_OF_RANGE`). When parsing numbers or other scalar values, the library checks
|
||||
that the value is followed by an expected character, thus you *may* get a number parsing error when accessing the digits
|
||||
as an integer in the following strings: `{"number":12332a`, `{"number":12332\0`, `{"number":12332` (the digits appear at the end). We always abide by the [RFC 8259](https://www.tbray.org/ongoing/When/201x/2017/12/14/rfc8259.html) JSON specification so that, for example, numbers prefixed by the `+` sign are in error.
|
||||
|
||||
@@ -432,8 +514,8 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
|
||||
If you know the type of the value, you can cast it right there, too! `for (double value : array) { ... }`.
|
||||
|
||||
You may also use explicit iterators: `for(auto i = array.begin(); i != array.end(); i++) {}`. You can check that an array is empty with the condition `auto i = array.begin(); if (i == array.end()) {...}`.
|
||||
* **Object Iteration:** You can iterate through an object's fields, as well: `for (auto field : object) { ... }`. You may also use explicit iterators : `for(auto i = object.begin(); i != object.end(); i++) { auto field = *i; .... }`. You can check that an object is empty with the condition `auto i = object.begin(); if (i == object.end()) {...}`.
|
||||
You may also use explicit iterators: `for(auto i = array.begin(); i != array.end(); i++) {}`. You can check that an array is empty with the condition `auto i = array.begin(); if (i == array.end()) {...}`. You should derefence (`*i`) an iterator at most once before incrementing it (`i++`), when compiling in debug mode with development checks, we add asserts to help you identify such a mistake.
|
||||
* **Object Iteration:** You can iterate through an object's fields, as well: `for (auto field : object) { ... }`.
|
||||
- `field.unescaped_key()` will get you the unescaped key string as a `std::string_view` instance. E.g., the JSON string `"\u00e1"` becomes the Unicode string `á`. Optionally, you pass `true` as a parameter to the `unescaped_key` method if you want invalid escape sequences to be replaced by a default replacement character (e.g., `\ud800\ud801\ud811`): otherwise bad escape sequences lead to an immediate error.
|
||||
- `field.escaped_key()` will get you the key string as as a `std::string_view` instance, but unlike `unescaped_key()`, the key is not processed, so no unescaping is done. E.g., the JSON string `"\u00e1"` becomes the Unicode string `\u00e1`. We expect that `escaped_key()` is faster than `field.unescaped_key()`.
|
||||
- `field.value()` will get you the value, which you can then use all these other methods on.
|
||||
@@ -446,13 +528,17 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
|
||||
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"]}`.
|
||||
|
||||
We discourage using the object iterators explicitly: `for(auto i = object.begin(); i != object.end(); i++) { auto field = *i; .... }`. In addition to the usual requirement to check against `end()` prior to dereferencing, you must also always dereference the pointer (`*it`) exactly once before you increment it (`it++`). You must also only deference the iterator once (never more than once). When compiling in
|
||||
debug mode with development checks, we add asserts to help check whether you correctly
|
||||
dereferenced the pointer before incrementing it.
|
||||
|
||||
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. Instead,
|
||||
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]`). 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
|
||||
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)). The returned value is only valid so long as you do not access another field: normally, you should therefore grab the value right after accessing a key (i.e., convert it to number, string, object, array...). 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. 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
|
||||
is in error. Furthermore, you can only consume one field at a time, on the same object. The
|
||||
@@ -476,7 +562,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
> unlike `key()`, it has to determine the location of the final quote character.
|
||||
>
|
||||
> ```cpp
|
||||
> auto json = R"({"k\u0065y": 1})"_padded;
|
||||
> auto json = R"({"k\u0065y": 1})"_padded; // R"( ... )" is a C++ raw string literal.
|
||||
> ondemand::parser parser;
|
||||
> auto doc = parser.iterate(json);
|
||||
> ondemand::object object = doc.get_object();
|
||||
@@ -501,7 +587,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
>
|
||||
> ```cpp
|
||||
> ondemand::parser parser;
|
||||
> auto json = R"( { "x": 1, "y": 2 } )"_padded;
|
||||
> auto json = R"( { "x": 1, "y": 2 } )"_padded; // R"( ... )" is a C++ raw string literal.
|
||||
> auto doc = parser.iterate(json);
|
||||
> double y = doc.find_field("y"); // The cursor is now after the 2 (at })
|
||||
> double x = doc.find_field("x"); // This fails, because there are no more fields after "y"
|
||||
@@ -522,13 +608,13 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
> auto silly_json = R"( { "test": "result" } )"_padded;
|
||||
> ondemand::document doc = parser.iterate(silly_json);
|
||||
> std::cout << simdjson::to_json_string(doc["test"]) << std::endl; // Requires simdjson 1.0 or better
|
||||
>````
|
||||
> ```
|
||||
> ```cpp
|
||||
> // retrieves an unescaped string value as a string_view instance
|
||||
> auto silly_json = R"( { "test": "result" } )"_padded;
|
||||
> ondemand::document doc = parser.iterate(silly_json);
|
||||
> std::cout << std::string_view(doc["test"]) << std::endl;
|
||||
>````
|
||||
> ```
|
||||
You can use `to_json_string` to efficiently extract components of a JSON document to reconstruct a new JSON document, as in the following example:
|
||||
> ```cpp
|
||||
> auto cars_json = R"( [
|
||||
@@ -557,7 +643,7 @@ support for users who avoid exceptions. See [the simdjson error handling documen
|
||||
> oss << "]";
|
||||
> auto json_string = oss.str();
|
||||
> // json_string == "[[ 40.1, 39.9, 37.7, 40.4 ],[ 30.1, 31.0, 28.6, 28.7 ]]"
|
||||
>````
|
||||
> ```
|
||||
* **Extracting Values (without exceptions):** You can use a variant usage of `get()` with error
|
||||
codes to avoid exceptions. You first declare the variable of the appropriate type (`double`,
|
||||
`uint64_t`, `int64_t`, `bool`, `ondemand::object` and `ondemand::array`) and pass it by reference
|
||||
@@ -1264,10 +1350,6 @@ You can also use the custom `Car` type as part of a template such as `std::vecto
|
||||
simdjson::ondemand::parser parser;
|
||||
simdjson::ondemand::document doc = parser.iterate(json);
|
||||
std::vector<Car> cars(doc);
|
||||
// visual studio users need an explicit call:
|
||||
// std::vector<Car> cars = doc.get<std::vector<Car>>();
|
||||
// because the compiler does not know whether to convert
|
||||
// doc to an unsigned int or to a vector.
|
||||
for(Car& c : cars) {
|
||||
std::cout << c.year << std::endl;
|
||||
}
|
||||
@@ -1361,6 +1443,8 @@ With this code, deserializing an `std::list<Car>` instance would capture only th
|
||||
that are not made by Toyota.
|
||||
|
||||
|
||||
**Performance tip**: You will get better performance if you order the attributes (make, model)
|
||||
in the order they appear in the JSON document.
|
||||
|
||||
|
||||
### 3. Using static reflection (C++26)
|
||||
@@ -1437,6 +1521,10 @@ void f() {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
**Performance tip**: You will get better performance if you order the attributes (make, model)
|
||||
in the order they appear in the JSON document.
|
||||
|
||||
#### Special cases
|
||||
|
||||
However, there are instances where the construction cannot
|
||||
@@ -1514,6 +1602,10 @@ type without a document instance like so:
|
||||
Car car = simdjson::from(json);
|
||||
```
|
||||
|
||||
The string must be a `simdjson::padded_string_view`, which can be created from an std::string
|
||||
instance with `simdjson::pad()` function, from a `simdjson::padded_string` instance, or string literal using the `_padded` user-defined literal.
|
||||
|
||||
|
||||
You can also use the `simdjson::from` syntax without exceptions, like so:
|
||||
```cpp
|
||||
Car car;
|
||||
@@ -1754,57 +1846,126 @@ int64_t x = obj.at_path("$.c.foo.a[1]"); // 20
|
||||
x = obj.at_path("$.d.foo2.a.2"); // 30
|
||||
```
|
||||
|
||||
## Using `for_each_at_path_with_wildcard` for JSONPath Queries (On-Demand)
|
||||
|
||||
The `for_each_at_path_with_wildcard` function in simdjson extends the JSONPath querying capabilities by supporting wildcard expressions (`*`) in JSON paths. It calls a user-provided callback for each matching element, avoiding the need to materialize all results into a vector. 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.
|
||||
|
||||
### C++26
|
||||
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 callback is simply never called. For instance, querying `$.empty_object.*` or `$.empty_array.*` will yield no callbacks.
|
||||
|
||||
### Example Usage
|
||||
|
||||
We also support shit
|
||||
If you have C++26 support with reflection, and you have set the `SIMDJSON_STATIC_REFLECTION` macro, e
|
||||
Here is an example demonstrating the use of `for_each_at_path_with_wildcard`:
|
||||
|
||||
```cpp
|
||||
#define SIMDJSON_STATIC_REFLECTION 1
|
||||
//...
|
||||
#include "simdjson.h"
|
||||
```
|
||||
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;
|
||||
|
||||
```cpp
|
||||
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;
|
||||
ondemand::parser parser;
|
||||
auto cars = parser.iterate(cars_json);
|
||||
cout << cars.at_path("[0].tire_pressure[1]") << endl; // Prints 39.9
|
||||
ondemand::document doc = parser.iterate(json_string);
|
||||
|
||||
// Fetch all fields in the address object
|
||||
auto error = doc.for_each_at_path_with_wildcard("$.address.*",
|
||||
[](ondemand::value value) {
|
||||
std::string_view field;
|
||||
if (value.get(field) == SUCCESS) {
|
||||
std::cout << field << std::endl;
|
||||
}
|
||||
});
|
||||
|
||||
// Fetch all phone numbers
|
||||
doc.for_each_at_path_with_wildcard("$.phoneNumbers[*].numbers[*]",
|
||||
[](ondemand::value value) {
|
||||
std::string_view number;
|
||||
if (value.get(number) == SUCCESS) {
|
||||
std::cout << number << std::endl;
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### C++26
|
||||
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.
|
||||
|
||||
## C++20 Ranges Support
|
||||
|
||||
We also support shit
|
||||
If you have C++26 support with reflection, and you have set the `SIMDJSON_STATIC_REFLECTION` macro, e
|
||||
When compiling with C++20 (or later), you can use `std::ranges` with the On-Demand API
|
||||
via the `get_range()` helper. This enables use of range adaptors such as `std::views::transform`.
|
||||
|
||||
```cpp
|
||||
#define SIMDJSON_STATIC_REFLECTION 1
|
||||
//...
|
||||
#include "simdjson.h"
|
||||
#include <ranges>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
auto json = R"([
|
||||
{ "name": "Alice", "age": 30 },
|
||||
{ "name": "Bob", "age": 25 },
|
||||
{ "name": "Carol", "age": 35 }
|
||||
])"_padded;
|
||||
|
||||
ondemand::parser parser;
|
||||
auto doc = parser.iterate(json);
|
||||
auto arr = doc.get_array();
|
||||
|
||||
// Use std::views::transform to extract names
|
||||
auto names = ondemand::get_range(arr)
|
||||
| std::views::transform([](auto elem) -> std::string {
|
||||
return std::string(std::string_view(elem["name"]));
|
||||
});
|
||||
|
||||
for (auto name : names) {
|
||||
std::cout << name << std::endl; // Alice, Bob, Carol
|
||||
}
|
||||
```
|
||||
|
||||
The `get_range()` and `get_key_value_range()` functions wrap an `ondemand::array`
|
||||
or `ondemand::object` in a `std::ranges::view` that satisfies `std::ranges::input_range`.
|
||||
They work with both exception and non-exception code:
|
||||
|
||||
```cpp
|
||||
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;
|
||||
ondemand::parser parser;
|
||||
auto cars = parser.iterate(cars_json);
|
||||
cout << cars.at_path("[0].tire_pressure[1]") << endl; // Prints 39.9
|
||||
// With exceptions:
|
||||
auto range = ondemand::get_range(doc.get_array());
|
||||
|
||||
// Without exceptions:
|
||||
ondemand::array arr;
|
||||
if (doc.get_array().get(arr) == SUCCESS) {
|
||||
auto range = ondemand::get_range(arr);
|
||||
for (auto elem : range) { /* ... */ }
|
||||
}
|
||||
```
|
||||
|
||||
Object iteration uses `get_key_value_range()` and yields `simdjson_result<ondemand::field>` elements:
|
||||
|
||||
```cpp
|
||||
auto obj = doc.get_object();
|
||||
for (auto field_result : ondemand::get_key_value_range(obj)) {
|
||||
std::cout << field_result.key() << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
The range wrappers are zero-cost: they forward directly to the underlying
|
||||
On-Demand iterators with no value buffering or extra per-element overhead.
|
||||
|
||||
## Compile-Time JSONPath and JSON Pointer (C++26 Reflection)
|
||||
|
||||
simdjson provides **compile-time validated** JSONPath and JSON Pointer accessors when using C++26 Static Reflection. These accessors validate paths against struct definitions at compile time and generate optimized code with zero runtime overhead. In some cases, we find that it is much faster. Furthermore, it is safer in the sense that the expression
|
||||
The simdjson library provides **compile-time validated** JSONPath and JSON Pointer accessors when using C++26 Static Reflection. These accessors validate paths against struct definitions at compile time and generate optimized code with zero runtime overhead. In some cases, we find that it is much faster. Furthermore, it is safer in the sense that the expression
|
||||
is validated at compile-time.
|
||||
|
||||
**Requirements:** C++26 compiler with P2996 reflection support and `-DSIMDJSON_STATIC_REFLECTION=ON` build flag.
|
||||
|
||||
@@ -14,6 +14,7 @@ speed and high convenience.
|
||||
* [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)
|
||||
+ [Pretty formatted (fractured JSON)](#pretty-formatted-fractured-json)
|
||||
|
||||
Overview: string_builder
|
||||
---------------------------
|
||||
@@ -332,7 +333,7 @@ pattern:
|
||||
|
||||
### Customization
|
||||
|
||||
If you want to serialize a value in a custome way, you can do it with a
|
||||
If you want to serialize a value in a custom way, you can do it with a
|
||||
`tag_invoke` specialization like the following example which will map
|
||||
the year attribute to a string.
|
||||
|
||||
@@ -363,4 +364,50 @@ void tag_invoke(serialize_tag, builder_type &builder, const Car& car) {
|
||||
}
|
||||
|
||||
} // namespace simdjson
|
||||
```
|
||||
```
|
||||
|
||||
### Pretty formatted (fractured JSON)
|
||||
|
||||
In some instances, you may want your JSON to be more readable. For this pupose, we also
|
||||
support the Fractured JSON standard.
|
||||
|
||||
```Cpp
|
||||
TableTestData data{
|
||||
{{1, "Alice", true}, {2, "Bob", false}, {3, "Carol", true}, {4, "Dave", false}}
|
||||
};
|
||||
|
||||
fractured_json_options opts;
|
||||
opts.enable_table_format = true;
|
||||
opts.min_table_rows = 3;
|
||||
|
||||
std::string formatted = simdjson::to_fractured_json_string(data, opts);
|
||||
```
|
||||
|
||||
The result might be as follows.
|
||||
|
||||
```json
|
||||
{
|
||||
"records": [
|
||||
{ "active": true , "id": 1, "name": "Alice" },
|
||||
{ "active": false, "id": 2, "name": "Bob" },
|
||||
{ "active": true , "id": 3, "name": "Carol" },
|
||||
{ "active": false, "id": 4, "name": "Dave" }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The `fractured_json_options` struct allows you to customize the formatting behavior. It includes the following options:
|
||||
|
||||
- `max_total_line_length` (default: 120): Maximum total characters per line. Content exceeding this will be expanded to multiple lines.
|
||||
- `max_inline_length` (default: 80): Maximum length for inlined elements. Simple arrays/objects shorter than this may be rendered inline.
|
||||
- `max_inline_complexity` (default: 2): Maximum nesting depth for inline rendering. Elements with complexity exceeding this will be expanded. Complexity 0 = scalar, 1 = flat array/object, 2 = one level of nesting.
|
||||
- `max_compact_array_complexity` (default: 1): Maximum complexity for compact array formatting. Arrays with elements of this complexity or less may have multiple items per line.
|
||||
- `indent_spaces` (default: 4): Number of spaces per indentation level.
|
||||
- `enable_table_format` (default: true): Enable tabular formatting for arrays of similar objects. When enabled, arrays of objects with identical keys are formatted as aligned tables.
|
||||
- `min_table_rows` (default: 3): Minimum number of rows to trigger table mode.
|
||||
- `table_similarity_threshold` (default: 0.8): Similarity threshold for table detection. Objects must share at least this fraction of keys to be formatted as a table.
|
||||
- `enable_compact_multiline` (default: true): Enable compact multiline arrays. When enabled, arrays of simple elements may have multiple items per line.
|
||||
- `max_items_per_line` (default: 10): Maximum array items per line in compact mode.
|
||||
- `simple_bracket_padding` (default: true): Add space inside brackets for simple containers. When true: `{ "key": "value" }`, when false: `{"key": "value"}`.
|
||||
- `colon_padding` (default: true): Add space after colons. When true: `"key": "value"`, when false: `"key":"value"`.
|
||||
- `comma_padding` (default: true): Add space after commas in inline content. When true: `[1, 2, 3]`, when false: `[1,2,3]`.
|
||||
@@ -0,0 +1,250 @@
|
||||
# Parse json at compile time
|
||||
* [Introduction](#introduction)
|
||||
* [Example](#example)
|
||||
* [Concepts](#concepts)
|
||||
* [Loading from disk](#loading-from-disk)
|
||||
* [Limitations (compile-time errors)](#limitations-compile-time-errors)
|
||||
|
||||
|
||||
## Introduction
|
||||
In some instances, you may want to configure your software at compile-time with a JSON document.
|
||||
Maybe you have a single code base but many different possible configurations, all resulting in
|
||||
different software. For example, you might be programming robots, using the same software, but
|
||||
different robot configurations.
|
||||
|
||||
To achieve the desired result, you have a few options. You may start the software and parser a
|
||||
JSON file at runtime. Or you might convert your JSON data into C++ code that you can compile with
|
||||
your software.
|
||||
|
||||
With C++26, there is another way: parse the JSON file along with your C++ code. In this manner,
|
||||
the JSON data becomes native C++ data.
|
||||
|
||||
The simdjson library supports parsing JSON documents at compile time if you have C++26 support. To
|
||||
activate C++26 reflection support, you can compile
|
||||
your code with the `SIMDJSON_STATIC_REFLECTION` macro set:
|
||||
|
||||
```cpp
|
||||
#define SIMDJSON_STATIC_REFLECTION 1
|
||||
//...
|
||||
#include "simdjson.h"
|
||||
```
|
||||
|
||||
The `simdjson::compile_time::parse_json` function parses a JSON document at **compile time** and returns a `constexpr` structure reflecting its content. We support the full range of JSON values, which are mapped to C++ types as in
|
||||
the following table.
|
||||
|
||||
For convenience, you can also use the `""_json` user-defined literal operator, which is available in the `simdjson::literals` namespace:
|
||||
|
||||
```cpp
|
||||
using namespace simdjson::literals;
|
||||
|
||||
constexpr auto cfg = R"(
|
||||
{
|
||||
"port": 8080,
|
||||
"host": "localhost"
|
||||
}
|
||||
)"_json;
|
||||
```
|
||||
|
||||
Alternatively, you can use the qualified name `simdjson::literals::operator""_json`.
|
||||
|
||||
|
||||
| JSON type | C++ type |
|
||||
|----------------|----------------------------------|
|
||||
| object | anonymous struct |
|
||||
| array | `std::array<T, N>` (homogeneous) |
|
||||
| string | `const char*` (UTF-8) |
|
||||
| number | `int64_t`, `uint64_t`, `double` |
|
||||
| `true`/`false` | `bool` |
|
||||
| `null` | `std::nullptr_t` |
|
||||
|
||||
## Example
|
||||
|
||||
Suppose you want to parse the following JSON document:
|
||||
|
||||
```cpp
|
||||
{
|
||||
"port": 8080,
|
||||
"host": "localhost",
|
||||
"debug": true
|
||||
}
|
||||
```
|
||||
|
||||
**Reminder**: In C++, `R"( )"` allows us to write multi-line strings with unescaped quotes.
|
||||
|
||||
|
||||
You can do so, at compile-time, as follows:
|
||||
|
||||
|
||||
```cpp
|
||||
using namespace simdjson::literals;
|
||||
|
||||
constexpr auto cfg = R"(
|
||||
|
||||
{
|
||||
"port": 8080,
|
||||
"host": "localhost",
|
||||
"debug": true
|
||||
}
|
||||
|
||||
)"_json;
|
||||
|
||||
// cfg.port == 8080
|
||||
// std::string_view(cfg.host) == "localhost"
|
||||
// cfg.debug == true
|
||||
```
|
||||
|
||||
You can nest objects and arrays:
|
||||
|
||||
```cpp
|
||||
using namespace simdjson::literals;
|
||||
|
||||
constexpr auto data = R"(
|
||||
|
||||
{
|
||||
"servers": [
|
||||
{"host": "s1", "port": 3000},
|
||||
{"host": "s2", "port": 3001}
|
||||
]
|
||||
}
|
||||
|
||||
)"_json;
|
||||
|
||||
|
||||
// data.servers.size() == 2
|
||||
// std::string_view(data.servers[0].host) == "s1"
|
||||
```
|
||||
|
||||
Top-level arrays are allowed:
|
||||
|
||||
```cpp
|
||||
using namespace simdjson::literals;
|
||||
|
||||
constexpr auto arr = R"(
|
||||
|
||||
[1, 2, 3]
|
||||
|
||||
)"_json;
|
||||
static_assert(arr.size() == 3);
|
||||
static_assert(arr[1] == 2);
|
||||
```
|
||||
|
||||
|
||||
## Concepts
|
||||
|
||||
Given that the parsed data is made of structures that depend on the JSON input, you might
|
||||
want to check that it conforms to your expectation. You can do so with concepts.
|
||||
|
||||
Let us consider this example:
|
||||
|
||||
```cpp
|
||||
using namespace simdjson::literals;
|
||||
|
||||
constexpr auto config = R"(
|
||||
|
||||
[
|
||||
{ "name": "Alice", "age": 30 },
|
||||
{ "name": "Bob", "age": 25 },
|
||||
{ "name": "Charlie", "age": 35 }
|
||||
]
|
||||
|
||||
)"_json;
|
||||
```
|
||||
|
||||
You might want to ensure that the result is an array of persons. You can define your
|
||||
expectation with concepts like so:
|
||||
|
||||
```cpp
|
||||
template <typename T>
|
||||
concept person = requires(T p) {
|
||||
std::string_view(p.name); // has name field convertible to string_view
|
||||
p.age; // has age field
|
||||
requires std::is_integral_v<decltype(p.age)>; // age is integral
|
||||
};
|
||||
|
||||
/**
|
||||
* Concept to validate that a type is an array of person objects
|
||||
*/
|
||||
template <typename T>
|
||||
concept array_of_person = requires(T arr) {
|
||||
arr.size(); // has size method
|
||||
arr[0]; // can access elements with []
|
||||
requires person<decltype(arr[0])>; // elements satisfy person concept
|
||||
};
|
||||
```
|
||||
|
||||
And then a simple static assert with `decltype` is sufficient to check that the expectation is met:
|
||||
|
||||
```cpp
|
||||
constexpr auto config = R"(
|
||||
|
||||
[
|
||||
{ "name": "Alice", "age": 30 },
|
||||
{ "name": "Bob", "age": 25 },
|
||||
{ "name": "Charlie", "age": 35 }
|
||||
]
|
||||
|
||||
)"_json;
|
||||
|
||||
|
||||
// Validate that the array satisfies the array_of_person concept
|
||||
static_assert(array_of_person<decltype(config)>);
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Loading from disk
|
||||
|
||||
In practice, you may have a JSON file, say `json_data` that you want to parse
|
||||
at compile time. You may do so as follows.
|
||||
|
||||
```c++
|
||||
constexpr const char json_data[] = {
|
||||
#embed "test.json"
|
||||
, 0
|
||||
};
|
||||
|
||||
constexpr auto json = simdjson::compile_time::parse_json<json_data>();
|
||||
```
|
||||
|
||||
|
||||
## Limitations (compile-time errors)
|
||||
|
||||
We have a few limitations which trigger compile-time errors if violated.
|
||||
|
||||
|
||||
- Only JSON objects and arrays are supported at the top level (no primitives).
|
||||
We will lift this limitation in the future.
|
||||
- Strings are represented using the `const char*` in UTF-8, but they must not
|
||||
contain embedded nulls. We would prefer to represent them as std::string or
|
||||
std::string_view, and hope to do so in the future.
|
||||
- Heterogeneous arrays are not supported yet. E.g., you need to have arrays of
|
||||
all integers, or all strings, all floats, all compatible objects, etc.
|
||||
For example, the following is accepted:
|
||||
```json
|
||||
[
|
||||
{ "name": "Alice", "age": 30 },
|
||||
{ "name": "Bob", "age": 25 },
|
||||
{ "name": "Charlie", "age": 35 }
|
||||
]
|
||||
```
|
||||
but the following is not:
|
||||
```json
|
||||
[
|
||||
{ "name": "Alice", "age": 30 },
|
||||
"Just a string",
|
||||
42,
|
||||
{ "name": "Charlie", "age": 35 }
|
||||
]
|
||||
```
|
||||
We may support heterogeneous arrays in the future with std::variant types.
|
||||
- We parse the first JSON document encountered in the string. Trailing
|
||||
characters are ignored. Thus if your JSON begins with {"a":1}, everything
|
||||
after the closing brace is ignored. This limitation will be lifted in the future,
|
||||
reporting an error.
|
||||
|
||||
These limitations are safe in the sense that they result in compile-time errors.
|
||||
Thus you will not get truncated strings or imprecise floats silently.
|
||||
|
||||
|
||||
Although we are committed to maintaining the functionality in the long run, the
|
||||
`compile_time::parse_json` function is subject to change.
|
||||
@@ -40,6 +40,7 @@ struct User {
|
||||
std::vector<std::string> emails;
|
||||
};
|
||||
|
||||
// R"( ... )" is a C++ raw string literal.
|
||||
const padded_string json = R"({
|
||||
"name": "Alice",
|
||||
"age": 30,
|
||||
|
||||
@@ -54,6 +54,24 @@ dom::parser parser;
|
||||
dom::element doc = parser.parse("[1,2,3]"_padded); // parse a string, the _padded suffix creates a simdjson::padded_string instance
|
||||
```
|
||||
|
||||
You can also load a `padded_string` from a file.
|
||||
|
||||
|
||||
```cpp
|
||||
auto json = padded_string::load("twitter.json"); // load JSON file 'twitter.json'.
|
||||
dom::element doc = parser.parse(json);
|
||||
```
|
||||
|
||||
[You can similarly fetch a file from a URL to a padded string](https://github.com/simdjson/curltostring) using our `simdjson::padded_string_builder`.
|
||||
|
||||
(Windows users compiling with C++17 or better may use `wchar_t` strings to support non-ASCII
|
||||
filenames: `padded_string::load(L"twitter.json")`.)
|
||||
|
||||
|
||||
(Windows users compiling with C++17 or better may use `wchar_t` strings to support non-ASCII
|
||||
filenames: `padded_string::load(L"twitter.json")`.)
|
||||
|
||||
|
||||
You can copy your data directly on a `simdjson::padded_string` as follows:
|
||||
|
||||
```cpp
|
||||
@@ -107,6 +125,42 @@ Further, they may use the AreFileApisANSI function to determine whether
|
||||
the filename is interpreted using the ANSI or the system default OEM
|
||||
codepage, and they may call SetFileApisToOEM accordingly.
|
||||
|
||||
|
||||
**Advanced feature:**
|
||||
You can use `simdjson::padded_memory_map` to create a `simdjson::padded_string_view`
|
||||
from a file on disk without copying the file contents into your own buffer.
|
||||
On POSIX systems (Linux, macOS, BSD, ...) it uses `mmap` for true zero-copy
|
||||
access. On Windows it is available as an **opt-in** feature and requires:
|
||||
|
||||
1. Building simdjson with `-DSIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=ON`, or
|
||||
defining `SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=1` and raising
|
||||
`NTDDI_VERSION` to at least `NTDDI_WIN10_RS4` (Windows 10, version 1803)
|
||||
and linking `onecore.lib` manually if you are consuming simdjson as a
|
||||
pre-built library.
|
||||
2. `#include <windows.h>` before `#include "simdjson.h"` in every
|
||||
translation unit where you want to use `padded_memory_map`.
|
||||
|
||||
When enabled on Windows, the implementation uses `CreateFileMapping2` and
|
||||
`MapViewOfFile3` for true zero-copy mapping whenever the file does not end
|
||||
within `SIMDJSON_PADDING` bytes of a page boundary; otherwise it falls back
|
||||
to reading the file into a padded heap buffer. If those requirements are
|
||||
not met, the class is not declared and the code below will fail to compile.
|
||||
|
||||
```cpp
|
||||
#ifdef _WIN32
|
||||
#include <windows.h> // Must come BEFORE <simdjson.h> on Windows
|
||||
#endif
|
||||
#include "simdjson.h"
|
||||
// ...
|
||||
simdjson::padded_memory_map map(TWITTER_JSON);
|
||||
if (!map.is_valid()) { /* handle error */ }
|
||||
simdjson::padded_string_view view = map.view(); // view is usable while padded_memory_map is in scope
|
||||
ondemand::document doc = parser.iterate(view); // parse the JSON
|
||||
```
|
||||
|
||||
Using memory-file mapping requires some care. The file should not be modified while you are
|
||||
accessing it.
|
||||
|
||||
Using the Parsed JSON
|
||||
---------------------
|
||||
|
||||
@@ -119,6 +173,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
|
||||
`dom::object` and `dom::array`) and pass it by reference to `get()` which gives you back an error code: e.g.,
|
||||
```cpp
|
||||
simdjson::error_code error;
|
||||
// _padded returns an simdjson::padded_string instance
|
||||
simdjson::padded_string numberstring = "1.2"_padded; // our JSON input ("1.2")
|
||||
simdjson::dom::parser parser;
|
||||
double value; // variable where we store the value to be parsed
|
||||
@@ -133,6 +188,23 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
|
||||
`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`.
|
||||
* **Big Integer Support (opt-in):** By default, integers that exceed the 64-bit range cause parsing to fail with `BIGINT_ERROR`. You can opt in to big integer support so that these numbers are stored as raw digit strings on the tape instead:
|
||||
```cpp
|
||||
simdjson::dom::parser parser;
|
||||
parser.number_as_string(true); // opt-in, default false
|
||||
simdjson::dom::element doc;
|
||||
auto error = parser.parse("[1, 123456789012345678901]"_padded).get(doc);
|
||||
if (error) { std::cerr << error << std::endl; return EXIT_FAILURE; }
|
||||
for (simdjson::dom::element elem : doc) {
|
||||
if (elem.is_bigint()) {
|
||||
std::string_view digits;
|
||||
error = elem.get_bigint().get(digits);
|
||||
if (error) { std::cerr << error << std::endl; return EXIT_FAILURE; }
|
||||
std::cout << "big integer: " << digits << std::endl;
|
||||
}
|
||||
}
|
||||
```
|
||||
When enabled, big integers have type `element_type::BIGINT`. Calling `get_int64()`, `get_uint64()`, or `get_double()` on a big integer returns `INCORRECT_TYPE`. Normal numbers (int64, uint64, double) are unaffected.
|
||||
* **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
|
||||
know the type of the value, you can cast it right there, too! `for (double value : array) { ... }`
|
||||
@@ -145,7 +217,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
|
||||
* **Array and Object size** Given an array or an object, you can get its size (number of elements or keys)
|
||||
with the `size()` method.
|
||||
* **Checking an Element Type:** You can check an element's type with `element.type()`. It
|
||||
returns an `element_type` with values such as `simdjson::dom::element_type::ARRAY`, `simdjson::dom::element_type::OBJECT`, `simdjson::dom::element_type::INT64`, `simdjson::dom::element_type::UINT64`,`simdjson::dom::element_type::DOUBLE`, `simdjson::dom::element_type::STRING`, `simdjson::dom::element_type::BOOL` or, `simdjson::dom::element_type::NULL_VALUE`.
|
||||
returns an `element_type` with values such as `simdjson::dom::element_type::ARRAY`, `simdjson::dom::element_type::OBJECT`, `simdjson::dom::element_type::INT64`, `simdjson::dom::element_type::UINT64`,`simdjson::dom::element_type::DOUBLE`, `simdjson::dom::element_type::STRING`, `simdjson::dom::element_type::BOOL`, `simdjson::dom::element_type::NULL_VALUE` or, `simdjson::dom::element_type::BIGINT` (when big integer support is enabled).
|
||||
* **Output to streams and strings:** Given a document or an element (or node) out of a JSON document, you can output a minified string version using the C++ stream idiom (`out << element`). You can also request the construction of a minified string version (`simdjson::minify(element)`) or a prettified string version (`simdjson::prettify(element)`). Numbers are serialized as 64-bit floating-point numbers (`double`).
|
||||
|
||||
### Examples
|
||||
@@ -153,6 +225,7 @@ Once you have an element, you can navigate it with idiomatic C++ iterators, oper
|
||||
The following code illustrates all of the above:
|
||||
|
||||
```cpp
|
||||
// R"( ... )" is a C++ raw string literal.
|
||||
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 ] },
|
||||
@@ -717,6 +790,9 @@ void basics_treewalk_1() {
|
||||
}
|
||||
```
|
||||
|
||||
Notice that we do not include `dom::element_type::BIGINT` in this example
|
||||
as `dom::element_type::BIGINT` type is only generated if the parser was
|
||||
set to support big integers (`parser.number_as_string(true)`).
|
||||
|
||||
|
||||
Reusing the parser for maximum efficiency
|
||||
@@ -825,10 +901,23 @@ memcpy(padded_json_copy.get(), json, json_len);
|
||||
memset(padded_json_copy.get() + json_len, 0, SIMDJSON_PADDING);
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::element element = parser.parse(padded_json_copy.get(), json_len, false);
|
||||
````
|
||||
```
|
||||
|
||||
Setting the `realloc_if_needed` parameter `false` in this manner may lead to better performance since copies are avoided, but it requires that the user takes more responsibilities: the simdjson library cannot verify that the input buffer was padded with SIMDJSON_PADDING extra bytes.
|
||||
|
||||
If you are compiling your project with C++17 or better, you can use a `simdjson::padded_input`:
|
||||
|
||||
```cpp
|
||||
simdjson::dom::parser parser;
|
||||
std::string_view json = "[1,2,3]";
|
||||
simdjson::padded_input input(json); // Automatically pads if needed
|
||||
simdjson::dom::element element = parser.parse(input);
|
||||
```
|
||||
|
||||
The actual padding only occurs if the JSON string ends near the boundary of a memory page, which is uncommon. Using a `simdjson::padded_input` is safe although sanitizers and tools like valgrind might report illegal reads (which are safe in our case because they remain in the mapped page). You should avoid `simdjson::padded_input` on systems without a page size of at least 4096: virtually all systems qualify except for some niche embedded systems running custom operating systems. Standard Linux, Windows, macOS, Android, iOS, etc., are all fine. Note that, most times, an `simdjson::padded_input` instance will not copy the data and will only act
|
||||
as a view (it does not own the memory).
|
||||
|
||||
|
||||
Performance Tips
|
||||
---------------------
|
||||
|
||||
|
||||
@@ -33,6 +33,9 @@ compiles *all* the implementations into the executable. On Intel, it will includ
|
||||
(icelake, haswell, westmere and fallback), on 64-bit ARM it will include just one since running dispatching is unnecessary, and on PPC
|
||||
it will include 2 (ppc64 and fallback).
|
||||
|
||||
On Loongson processors, LASX runtime dispatching is only enabled on GCC 15+, not on LLVM or older versions of GCC.
|
||||
Thus unless you compile specifically for LASX or use GCC 15+, you will not benefit from LASX support.
|
||||
|
||||
If you know more about where you're going to run and want to save the space, you can disable any of
|
||||
these implementations at compile time with `-DSIMDJSON_IMPLEMENTATION_X=0` (where X is ICELAKE, HASWELL,
|
||||
WESTMERE, ARM64, PPC64, LSX, LASX and FALLBACK).
|
||||
|
||||
@@ -8,7 +8,7 @@ library provides high-speed access to files or streams containing multiple small
|
||||
{"text":"a"}
|
||||
{"text":"b"}
|
||||
{"text":"c"}
|
||||
...
|
||||
"..."
|
||||
```
|
||||
... you want to read the entries (individual JSON documents) as quickly and as conveniently as possible. Importantly, the input might span several gigabytes, but you want to use a small (fixed) amount of memory. Ideally, you'd also like the parallelize the processing (using more than one core) to speed up the process.
|
||||
|
||||
@@ -22,10 +22,12 @@ Contents
|
||||
- [Threads](#threads)
|
||||
- [Support](#support)
|
||||
- [API](#api)
|
||||
- [Streaming directly from a memory-mapped file](#streaming-directly-from-a-memory-mapped-file)
|
||||
- [Use cases](#use-cases)
|
||||
- [Tracking your position](#tracking-your-position)
|
||||
- [Incomplete streams](#incomplete-streams)
|
||||
- [C++20 features](#c20-features)
|
||||
- [C++26 features (static reflection)](#c26-features-static-reflection)
|
||||
|
||||
Motivation
|
||||
-----------
|
||||
@@ -132,7 +134,7 @@ E.g., `[1,2]{"32":1}` is recognized as two documents.
|
||||
Some official formats **(non-exhaustive list)**:
|
||||
- [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec/)
|
||||
- [JSON lines (JSONL)](http://jsonlines.org/)
|
||||
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by simdjson!
|
||||
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464)
|
||||
- [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming)
|
||||
|
||||
API
|
||||
@@ -141,7 +143,9 @@ API
|
||||
Example:
|
||||
|
||||
```cpp
|
||||
// R"( ... )" is a C++ raw string literal.
|
||||
auto json = R"({ "foo": 1 } { "foo": 2 } { "foo": 3 } )"_padded;
|
||||
// _padded returns an simdjson::padded_string instance
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream docs = parser.iterate_many(json);
|
||||
for (auto doc : docs) {
|
||||
@@ -152,6 +156,86 @@ for (auto doc : docs) {
|
||||
|
||||
See [basics.md](basics.md#newline-delimited-json-ndjson-and-json-lines) for an overview of the API.
|
||||
|
||||
|
||||
Streaming directly from a memory-mapped file
|
||||
--------------------------------------------
|
||||
|
||||
When your input is a large NDJSON / JSON-lines file on disk, the most efficient
|
||||
way to feed `iterate_many` is to use `simdjson::padded_memory_map`. It returns
|
||||
a `padded_string_view` with the right amount of trailing padding, so you can
|
||||
hand it straight to `iterate_many` without ever copying the file contents into
|
||||
your own buffer.
|
||||
|
||||
`padded_memory_map` is available on POSIX systems (Linux, macOS, BSD, ...) by
|
||||
default. On Windows it is an **opt-in** feature with the following
|
||||
requirements:
|
||||
|
||||
1. Build simdjson with `-DSIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=ON`, or — if
|
||||
you consume simdjson as a pre-built library — define
|
||||
`SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=1`, raise `NTDDI_VERSION` to at
|
||||
least `NTDDI_WIN10_RS4` (`0x0A000005`, Windows 10 version 1803), and
|
||||
add `onecore.lib` to your link line yourself. The Windows
|
||||
implementation uses the modern memory APIs `CreateFileMapping2` /
|
||||
`MapViewOfFile3`, which are available starting with that version of
|
||||
Windows and are exported by `onecore.lib`.
|
||||
2. `#include <windows.h>` before `#include "simdjson.h"` in every
|
||||
translation unit where you want to use `padded_memory_map`. simdjson
|
||||
deliberately does not pull in `<windows.h>` itself, so the class is
|
||||
only declared when the Win32 types are already visible.
|
||||
|
||||
If either requirement is not met on Windows, the `padded_memory_map` class is
|
||||
not declared at all and any code that references it fails to compile with an
|
||||
"unknown identifier" error. The availability of the class can be tested with
|
||||
the macro `SIMDJSON_HAS_PADDED_MEMORY_MAP`.
|
||||
|
||||
On POSIX, `padded_memory_map` uses `mmap` to map the file directly into
|
||||
memory with zero copies. On Windows (when enabled), it uses
|
||||
`CreateFileMapping2` + `MapViewOfFile3` for true zero-copy mapping
|
||||
whenever the file does not end within `SIMDJSON_PADDING` bytes of a page
|
||||
boundary; for those rare cases, it transparently falls back to reading
|
||||
the file into a heap-allocated padded buffer so that the returned view
|
||||
always has `SIMDJSON_PADDING` accessible zero bytes after the file content.
|
||||
|
||||
```cpp
|
||||
#ifdef _WIN32
|
||||
#include <windows.h> // Must come BEFORE <simdjson.h> on Windows
|
||||
#endif
|
||||
#include "simdjson.h"
|
||||
|
||||
// ...
|
||||
|
||||
simdjson::padded_memory_map map("huge_stream.ndjson");
|
||||
if (!map.is_valid()) { /* file missing, unreadable, too large, ... */ return; }
|
||||
|
||||
simdjson::ondemand::parser parser;
|
||||
simdjson::ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(map.view()).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
|
||||
for (auto doc : stream) {
|
||||
// process each JSON document in the stream
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
Important lifetime rule: the `padded_string_view` returned by `map.view()` is
|
||||
only valid while the `padded_memory_map` instance is alive, so keep `map`
|
||||
alive for as long as you are iterating the stream.
|
||||
|
||||
The file must not be modified while the memory map is in use. If you need a
|
||||
fully independent copy of the data, use `simdjson::padded_string::load(...)`
|
||||
instead.
|
||||
|
||||
If you prefer single-document parsing on a memory-mapped file, the same
|
||||
pattern applies to `parser.iterate(...)`:
|
||||
|
||||
```cpp
|
||||
simdjson::padded_memory_map map(myfilename);
|
||||
if (!map.is_valid()) { /* handle error */ }
|
||||
simdjson::padded_string_view view = map.view(); // view is usable while padded_memory_map is in scope
|
||||
ondemand::document doc = parser.iterate(view); // parse the JSON
|
||||
```
|
||||
|
||||
## Use cases
|
||||
|
||||
From [jsonlines.org](http://jsonlines.org/examples/):
|
||||
@@ -262,39 +346,131 @@ Importantly, you should only call `truncated_bytes()` after iterating through al
|
||||
Comma-separated documents
|
||||
-----------
|
||||
|
||||
We also support comma-separated documents, but with some performance limitations. The `iterate_many` function takes in an option to allow parsing of comma separated documents (which defaults on false). In this mode, the entire buffer is processed in one batch. Therefore, the total size of the document should not exceed the maximal capacity of the parser (4 GB). This mode also effectively disallow multithreading. It is therefore mostly suitable for not "very large" inputs. In this mode, the batch_size parameter
|
||||
is effectively ignored, as it is set to at least the document size.
|
||||
|
||||
Example:
|
||||
To parse comma-separated documents like `{"a":1},{"b":2},{"c":3}`, use the `stream_format::comma_delimited` parameter:
|
||||
|
||||
```cpp
|
||||
auto json = R"( 1, 2, 3, 4, "a", "b", "c", {"hello": "world"} , [1, 2, 3])"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream doc_stream;
|
||||
// We pass '32' as the batch size, but it is a bogus parameter because, since
|
||||
// we pass 'true' to the allow_comma parameter, the batch size will be set to at least
|
||||
// the document size.
|
||||
auto error = parser.iterate_many(json, 32, true).get(doc_stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : doc_stream) {
|
||||
std::cout << doc.type() << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
This will print:
|
||||
|
||||
auto json = R"({"a":1},{"b":2},{"c":3})"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(json, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : stream) {
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
// Prints: {"a":1}
|
||||
// {"b":2}
|
||||
// {"c":3}
|
||||
```
|
||||
number
|
||||
number
|
||||
number
|
||||
number
|
||||
string
|
||||
string
|
||||
string
|
||||
object
|
||||
array
|
||||
|
||||
Whitespace around the commas is allowed:
|
||||
```cpp
|
||||
auto json = R"({"a":1} , {"b":2} , {"c":3})"_padded; // Also works
|
||||
```
|
||||
|
||||
Nested commas inside objects and arrays are preserved:
|
||||
```cpp
|
||||
auto json = R"({"arr":[1,2,3]},{"obj":{"x":1,"y":2}})"_padded;
|
||||
// Correctly parses as 2 documents, not 6
|
||||
```
|
||||
|
||||
Mixed document types are supported:
|
||||
```cpp
|
||||
auto json = R"(1, 2, 3, 4, "a", "b", "c", {"hello": "world"}, [1, 2, 3])"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream doc_stream;
|
||||
auto error = parser.iterate_many(json, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited).get(doc_stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : doc_stream) {
|
||||
std::cout << doc.type() << std::endl;
|
||||
}
|
||||
// Prints: number number number number string string string object array
|
||||
```
|
||||
|
||||
Extra top-level separators are tolerated for compatibility with the legacy
|
||||
`allow_comma_separated` behavior. For example, leading commas, trailing commas,
|
||||
and repeated commas are treated as empty separators rather than documents.
|
||||
|
||||
### Legacy `allow_comma_separated` parameter (deprecated)
|
||||
|
||||
The `allow_comma_separated` boolean parameter is deprecated. When set to `true`, it now internally maps to `stream_format::comma_delimited`.
|
||||
|
||||
The old single-batch limitation no longer applies - comma-delimited parsing now supports multi-batch processing and threading for optimal performance on large files.
|
||||
|
||||
JSON Text Sequences (RFC 7464)
|
||||
------------------------------
|
||||
|
||||
[RFC 7464](https://tools.ietf.org/html/rfc7464) defines a format for streaming JSON values using ASCII Record Separator (RS, 0x1E) as a delimiter. Each JSON text is preceded by RS and optionally followed by ASCII Line Feed (LF, 0x0A).
|
||||
|
||||
Example input:
|
||||
```
|
||||
<RS>{"name":"doc1"}<LF>
|
||||
<RS>{"name":"doc2"}<LF>
|
||||
<RS>{"name":"doc3"}<LF>
|
||||
```
|
||||
|
||||
To parse JSON text sequences, use the `stream_format::json_sequence` parameter:
|
||||
|
||||
```cpp
|
||||
// Build input with RS (0x1E) and LF (0x0A) delimiters
|
||||
std::string input_str;
|
||||
input_str += '\x1e'; input_str += "{\"a\":1}"; input_str += '\x0a';
|
||||
input_str += '\x1e'; input_str += "{\"b\":2}"; input_str += '\x0a';
|
||||
input_str += '\x1e'; input_str += "{\"c\":3}"; input_str += '\x0a';
|
||||
simdjson::padded_string input(input_str);
|
||||
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(input, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::json_sequence).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : stream) {
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
The `stream_format` enum has the following values:
|
||||
- `stream_format::whitespace_delimited` (default): Standard NDJSON/JSON Lines format
|
||||
- `stream_format::json_sequence`: RFC 7464 format with RS delimiters
|
||||
- `stream_format::comma_delimited`: Comma-separated JSON documents
|
||||
- `stream_format::comma_delimited_array`: A single JSON array whose elements are iterated as comma-delimited documents (see below)
|
||||
|
||||
The trailing LF after each JSON text is optional but recommended by the RFC for robustness.
|
||||
|
||||
JSON Array As A Document Stream
|
||||
-------------------------------
|
||||
|
||||
Sometimes an input is a single, well-formed JSON array — `[{"a":1},{"b":2},{"c":3}]` — but you want to iterate its elements one at a time without materializing the whole array. Use `stream_format::comma_delimited_array`:
|
||||
|
||||
```cpp
|
||||
auto json = R"([{"a":1},{"b":2},{"c":3}])"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(json, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited_array).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : stream) {
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
// Prints: {"a":1}
|
||||
// {"b":2}
|
||||
// {"c":3}
|
||||
```
|
||||
|
||||
The parser strips the outer `[` and `]` plus any surrounding JSON whitespace (space, tab, LF, CR) and then behaves exactly like `stream_format::comma_delimited` over the remaining bytes. All comma-delimited features are inherited: multi-batch processing, threading, mixed scalar types, and nested commas preserved inside inner objects and arrays.
|
||||
|
||||
```cpp
|
||||
// All of these work:
|
||||
auto a = R"([1, "x", true, null, {"k":"v"}, [1,2]])"_padded; // mixed scalars
|
||||
auto b = R"( [ 1, 2, 3 ] )"_padded; // whitespace
|
||||
auto c = R"([])"_padded; // empty array → 0 docs
|
||||
```
|
||||
|
||||
If the input is not a well-formed outer array (missing `[`, missing `]`, or empty / all-whitespace), `iterate_many` returns `TAPE_ERROR`. Content **inside** the array is not validated up front — individual document parse errors surface when you iterate, just like `comma_delimited`.
|
||||
|
||||
Positions reported via `current_index()` are relative to the **stripped** buffer (the bytes between `[` and `]`), not the original input, for consistency with the existing BOM-stripping behavior.
|
||||
|
||||
|
||||
C++20 features
|
||||
--------------------
|
||||
@@ -401,4 +577,162 @@ Otherwise you may use this longer version for explicit handling of errors:
|
||||
}
|
||||
cars.push_back(c);
|
||||
}
|
||||
```
|
||||
```
|
||||
|
||||
**Performance tip**: You will get better performance if you order the attributes (make, model)
|
||||
in the order they appear in the JSON document.
|
||||
|
||||
C++26 features (static reflection)
|
||||
-----------------------------------
|
||||
|
||||
If you have a C++26 compatible compiler with [P2996](https://wg21.link/P2996)
|
||||
static reflection support, you can compile the simdjson library with the
|
||||
`SIMDJSON_STATIC_REFLECTION` macro set to `1`. When this is the case, simdjson
|
||||
can deserialize a stream of JSON documents directly into your own structures
|
||||
**without** writing any `tag_invoke` function. The library inspects the
|
||||
non-static public members of your type at compile time and produces the
|
||||
parsing code automatically.
|
||||
|
||||
```cpp
|
||||
#define SIMDJSON_STATIC_REFLECTION 1
|
||||
#include "simdjson.h"
|
||||
```
|
||||
|
||||
Consider the same `Car` structure used in the C++20 example, but **without**
|
||||
any `tag_invoke` glue:
|
||||
|
||||
```cpp
|
||||
struct Car {
|
||||
std::string make;
|
||||
std::string model;
|
||||
int year;
|
||||
std::vector<double> tire_pressure;
|
||||
};
|
||||
```
|
||||
|
||||
With C++26 static reflection enabled, you can iterate a stream of cars and
|
||||
push them into a `std::vector<Car>` directly:
|
||||
|
||||
```cpp
|
||||
auto json = R"( { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||
"tire_pressure": [ 40.1, 39.9 ] }
|
||||
{ "make": "Kia", "model": "Soul", "year": 2012,
|
||||
"tire_pressure": [ 30.1, 31.0 ] }
|
||||
{ "make": "Toyota", "model": "Tercel", "year": 1999,
|
||||
"tire_pressure": [ 29.8, 30.0 ] } )"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(json).get(stream);
|
||||
if (error) { /* handle error */ }
|
||||
std::vector<Car> cars;
|
||||
for (auto doc : stream) {
|
||||
Car c;
|
||||
if ((error = doc.get<Car>().get(c))) { /* handle error */ }
|
||||
cars.push_back(c);
|
||||
}
|
||||
```
|
||||
|
||||
This works for every `stream_format` value supported by `iterate_many`. The
|
||||
following examples each parse the same three cars, but laid out using a
|
||||
different streaming convention.
|
||||
|
||||
### Whitespace-delimited (default, NDJSON / JSON Lines)
|
||||
|
||||
```cpp
|
||||
auto json = R"( { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||
"tire_pressure": [ 40.1, 39.9 ] }
|
||||
{ "make": "Kia", "model": "Soul", "year": 2012,
|
||||
"tire_pressure": [ 30.1, 31.0 ] }
|
||||
{ "make": "Toyota", "model": "Tercel", "year": 1999,
|
||||
"tire_pressure": [ 29.8, 30.0 ] } )"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(json, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::whitespace_delimited).get(stream);
|
||||
if (error) { /* handle error */ }
|
||||
std::vector<Car> cars;
|
||||
for (auto doc : stream) {
|
||||
cars.push_back((Car)doc); // throws on error
|
||||
}
|
||||
```
|
||||
|
||||
### Comma-delimited documents
|
||||
|
||||
```cpp
|
||||
auto json = R"( { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||
"tire_pressure": [ 40.1, 39.9 ] },
|
||||
{ "make": "Kia", "model": "Soul", "year": 2012,
|
||||
"tire_pressure": [ 30.1, 31.0 ] },
|
||||
{ "make": "Toyota", "model": "Tercel", "year": 1999,
|
||||
"tire_pressure": [ 29.8, 30.0 ] } )"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(json, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited).get(stream);
|
||||
if (error) { /* handle error */ }
|
||||
std::vector<Car> cars;
|
||||
for (auto doc : stream) {
|
||||
Car c;
|
||||
if ((error = doc.get<Car>().get(c))) { /* handle error */ }
|
||||
cars.push_back(c);
|
||||
}
|
||||
```
|
||||
|
||||
### A single JSON array as a stream of documents
|
||||
|
||||
When the input is a single JSON array, you can stream its elements one at a
|
||||
time without materializing the entire array as a `std::vector` upfront:
|
||||
|
||||
```cpp
|
||||
auto json = R"( [ { "make": "Toyota", "model": "Camry", "year": 2018,
|
||||
"tire_pressure": [ 40.1, 39.9 ] },
|
||||
{ "make": "Kia", "model": "Soul", "year": 2012,
|
||||
"tire_pressure": [ 30.1, 31.0 ] },
|
||||
{ "make": "Toyota", "model": "Tercel", "year": 1999,
|
||||
"tire_pressure": [ 29.8, 30.0 ] } ] )"_padded;
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(json, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited_array).get(stream);
|
||||
if (error) { /* handle error */ }
|
||||
std::vector<Car> cars;
|
||||
for (auto doc : stream) {
|
||||
Car c;
|
||||
if ((error = doc.get<Car>().get(c))) { /* handle error */ }
|
||||
cars.push_back(c);
|
||||
}
|
||||
```
|
||||
|
||||
### JSON Text Sequences (RFC 7464)
|
||||
|
||||
```cpp
|
||||
// Build input with RS (0x1E) and LF (0x0A) delimiters
|
||||
std::string input_str;
|
||||
auto append = [&](std::string_view doc) {
|
||||
input_str += '\x1e'; input_str += doc; input_str += '\x0a';
|
||||
};
|
||||
append(R"({ "make": "Toyota", "model": "Camry", "year": 2018, "tire_pressure": [ 40.1, 39.9 ] })");
|
||||
append(R"({ "make": "Kia", "model": "Soul", "year": 2012, "tire_pressure": [ 30.1, 31.0 ] })");
|
||||
append(R"({ "make": "Toyota", "model": "Tercel", "year": 1999, "tire_pressure": [ 29.8, 30.0 ] })");
|
||||
simdjson::padded_string input(input_str);
|
||||
|
||||
ondemand::parser parser;
|
||||
ondemand::document_stream stream;
|
||||
auto error = parser.iterate_many(input, ondemand::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::json_sequence).get(stream);
|
||||
if (error) { /* handle error */ }
|
||||
std::vector<Car> cars;
|
||||
for (auto doc : stream) {
|
||||
Car c;
|
||||
if ((error = doc.get<Car>().get(c))) { /* handle error */ }
|
||||
cars.push_back(c);
|
||||
}
|
||||
```
|
||||
|
||||
In every case, the user-defined type (`Car` here) does not need a hand-written
|
||||
`tag_invoke` overload: the library generates the deserialization code from the
|
||||
type's public data members at compile time.
|
||||
|
||||
|
||||
**Performance tip**: You will get better performance if you order the attributes (make, model)
|
||||
in the order they appear in the JSON document.
|
||||
@@ -545,7 +545,7 @@ To help visualize the algorithm, we'll walk through the example C++ given at the
|
||||
"statuses": [
|
||||
{ "id": 1, "text": "first!", "user": { "screen_name": "lemire", "name": "Daniel" }, "retweet_count": 40 },
|
||||
{ "id": 2, "text": "second!", "user": { "screen_name": "jkeiser2", "name": "John" }, "retweet_count": 3 }
|
||||
^ (depth 3 - root > statuses > tweet)
|
||||
^ (depth 4 - root > statuses > tweet > field)
|
||||
],
|
||||
"search_metadata": { "count": 2 }
|
||||
}
|
||||
@@ -672,7 +672,9 @@ in production systems:
|
||||
|
||||
```cpp
|
||||
ondemand::parser parser;
|
||||
// R"( ... )" is a C++ raw string literal.
|
||||
const padded_string json = R"({ "parent": {"child1": {"name": "John"} , "child2": {"name": "Daniel"}} })"_padded;
|
||||
// _padded returns an simdjson padded_string instance
|
||||
auto doc = parser.iterate(json);
|
||||
ondemand::object parent = doc["parent"];
|
||||
// parent owns the focus
|
||||
|
||||
@@ -18,6 +18,7 @@ Contents
|
||||
- [How it works](#how-it-works)
|
||||
- [Support](#support)
|
||||
- [API](#api)
|
||||
- [Streaming directly from a memory-mapped file](#streaming-directly-from-a-memory-mapped-file)
|
||||
- [Use cases](#use-cases)
|
||||
- [Tracking your position](#tracking-your-position)
|
||||
- [Incomplete streams](#incomplete-streams)
|
||||
@@ -132,7 +133,7 @@ Whitespace Characters:
|
||||
Some official formats **(non-exhaustive list)**:
|
||||
- [Newline-Delimited JSON (NDJSON)](https://github.com/ndjson/ndjson-spec)
|
||||
- [JSON lines (JSONL)](http://jsonlines.org/)
|
||||
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464) <- Not supported by simdjson!
|
||||
- [Record separator-delimited JSON (RFC 7464)](https://tools.ietf.org/html/rfc7464)
|
||||
- [More on Wikipedia...](https://en.wikipedia.org/wiki/JSON_streaming)
|
||||
|
||||
API
|
||||
@@ -217,6 +218,86 @@ got full document at 29
|
||||
```
|
||||
|
||||
|
||||
|
||||
Streaming directly from a memory-mapped file
|
||||
--------------------------------------------
|
||||
|
||||
When your input is a large NDJSON / JSON-lines file on disk, the most
|
||||
efficient way to feed `parse_many` is to use `simdjson::padded_memory_map`.
|
||||
It returns a `padded_string_view` with the right amount of trailing padding,
|
||||
so you can pass it directly to `parse_many` without copying the file content
|
||||
into your own buffer first.
|
||||
|
||||
`padded_memory_map` is available on POSIX systems (Linux, macOS, BSD, ...) by
|
||||
default. On Windows it is an **opt-in** feature with the following
|
||||
requirements:
|
||||
|
||||
1. Build simdjson with `-DSIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=ON`, or — if
|
||||
you consume simdjson as a pre-built library — define
|
||||
`SIMDJSON_ENABLE_MEMORY_FILE_MAPPING_ON_WINDOWS=1`, raise `NTDDI_VERSION` to at
|
||||
least `NTDDI_WIN10_RS4` (`0x0A000005`, Windows 10 version 1803), and
|
||||
add `onecore.lib` to your link line yourself. The Windows
|
||||
implementation uses the modern memory APIs `CreateFileMapping2` /
|
||||
`MapViewOfFile3`, which are available starting with that version of
|
||||
Windows and are exported by `onecore.lib`.
|
||||
2. `#include <windows.h>` before `#include "simdjson.h"` in every
|
||||
translation unit where you want to use `padded_memory_map`. simdjson
|
||||
deliberately does not pull in `<windows.h>` itself, so the class is
|
||||
only declared when the Win32 types are already visible.
|
||||
|
||||
If either requirement is not met on Windows, the `padded_memory_map` class is
|
||||
not declared at all and any code that references it fails to compile with an
|
||||
"unknown identifier" error. The availability of the class can be tested with
|
||||
the macro `SIMDJSON_HAS_PADDED_MEMORY_MAP`.
|
||||
|
||||
On POSIX, `padded_memory_map` uses `mmap` to map the file directly into
|
||||
memory with zero copies. On Windows (when enabled), it uses
|
||||
`CreateFileMapping2` + `MapViewOfFile3` for true zero-copy mapping
|
||||
whenever the file does not end within `SIMDJSON_PADDING` bytes of a page
|
||||
boundary; for those rare cases, it transparently falls back to reading
|
||||
the file into a heap-allocated padded buffer so that the returned view
|
||||
always has `SIMDJSON_PADDING` accessible zero bytes after the file content.
|
||||
|
||||
```cpp
|
||||
#ifdef _WIN32
|
||||
#include <windows.h> // Must come BEFORE <simdjson.h> on Windows
|
||||
#endif
|
||||
#include "simdjson.h"
|
||||
|
||||
// ...
|
||||
|
||||
simdjson::padded_memory_map map("huge_stream.ndjson");
|
||||
if (!map.is_valid()) { /* file missing, unreadable, too large, ... */ return; }
|
||||
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::document_stream stream;
|
||||
auto error = parser.parse_many(map.view()).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
|
||||
for (auto doc : stream) {
|
||||
// process each JSON document in the stream
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
Important lifetime rule: the `padded_string_view` returned by `map.view()` is
|
||||
only valid while the `padded_memory_map` instance is alive, so keep `map`
|
||||
alive for as long as you are iterating the stream.
|
||||
|
||||
The file must not be modified while the memory map is in use. If you need a
|
||||
fully independent copy of the data, use `simdjson::padded_string::load(...)`
|
||||
instead.
|
||||
|
||||
If you prefer single-document parsing on a memory-mapped file, the same
|
||||
pattern applies to `parser.parse(...)`:
|
||||
|
||||
```cpp
|
||||
simdjson::padded_memory_map map(myfilename);
|
||||
if (!map.is_valid()) { /* handle error */ }
|
||||
simdjson::padded_string_view view = map.view(); // view is usable while padded_memory_map is in scope
|
||||
simdjson::dom::element doc = parser.parse(view); // parse the JSON
|
||||
```
|
||||
|
||||
Incomplete streams
|
||||
-----------
|
||||
|
||||
@@ -239,3 +320,115 @@ Consider the following example where a truncated document (`{"key":"intentionall
|
||||
|
||||
|
||||
Importantly, you should only call `truncated_bytes()` after iterating through all of the documents since the stream cannot tell whether there are truncated documents at the very end when it may not have accessed that part of the data yet.
|
||||
|
||||
JSON Text Sequences (RFC 7464)
|
||||
------------------------------
|
||||
|
||||
[RFC 7464](https://tools.ietf.org/html/rfc7464) defines a format for streaming JSON values using ASCII Record Separator (RS, 0x1E) as a delimiter. Each JSON text is preceded by RS and optionally followed by ASCII Line Feed (LF, 0x0A).
|
||||
|
||||
Example input:
|
||||
```
|
||||
<RS>{"name":"doc1"}<LF>
|
||||
<RS>{"name":"doc2"}<LF>
|
||||
<RS>{"name":"doc3"}<LF>
|
||||
```
|
||||
|
||||
To parse JSON text sequences, use the `stream_format::json_sequence` parameter:
|
||||
|
||||
```cpp
|
||||
// Build input with RS (0x1E) and LF (0x0A) delimiters
|
||||
std::string input_str;
|
||||
input_str += '\x1e'; input_str += "{\"a\":1}"; input_str += '\x0a';
|
||||
input_str += '\x1e'; input_str += "{\"b\":2}"; input_str += '\x0a';
|
||||
input_str += '\x1e'; input_str += "{\"c\":3}"; input_str += '\x0a';
|
||||
simdjson::padded_string input(input_str);
|
||||
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::document_stream stream;
|
||||
auto error = parser.parse_many(input, simdjson::dom::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::json_sequence).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : stream) {
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
```
|
||||
|
||||
The `stream_format` enum has the following values:
|
||||
- `stream_format::whitespace_delimited` (default): Standard NDJSON/JSON Lines format
|
||||
- `stream_format::json_sequence`: RFC 7464 format with RS delimiters
|
||||
- `stream_format::comma_delimited`: Comma-separated JSON documents
|
||||
- `stream_format::comma_delimited_array`: A single JSON array whose elements are iterated as comma-delimited documents (see below)
|
||||
|
||||
The trailing LF after each JSON text is optional but recommended by the RFC for robustness.
|
||||
|
||||
Comma-Separated Documents
|
||||
-------------------------
|
||||
|
||||
Some systems produce JSON documents separated by commas, like `{"a":1},{"b":2},{"c":3}`. This is common when extracting elements from a JSON array or when APIs return comma-separated results.
|
||||
|
||||
To parse comma-separated documents, use the `stream_format::comma_delimited` parameter:
|
||||
|
||||
```cpp
|
||||
auto json = R"({"a":1},{"b":2},{"c":3})"_padded;
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::document_stream stream;
|
||||
auto error = parser.parse_many(json, simdjson::dom::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : stream) {
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
// Prints: {"a":1}
|
||||
// {"b":2}
|
||||
// {"c":3}
|
||||
```
|
||||
|
||||
Whitespace around the commas is allowed:
|
||||
```cpp
|
||||
auto json = R"({"a":1} , {"b":2} , {"c":3})"_padded; // Also works
|
||||
```
|
||||
|
||||
Nested commas inside objects and arrays are preserved:
|
||||
```cpp
|
||||
auto json = R"({"arr":[1,2,3]},{"obj":{"x":1,"y":2}})"_padded;
|
||||
// Correctly parses as 2 documents, not 6
|
||||
```
|
||||
|
||||
Extra top-level separators are tolerated for compatibility with the legacy
|
||||
On-Demand comma-separated mode. Leading commas, trailing commas, and repeated
|
||||
commas are treated as empty separators rather than documents.
|
||||
|
||||
Unlike the legacy `allow_comma_separated` parameter, `stream_format::comma_delimited` supports multi-batch processing and threading for optimal performance on large files.
|
||||
|
||||
JSON Array As A Document Stream
|
||||
-------------------------------
|
||||
|
||||
Sometimes an input is a single, well-formed JSON array — `[{"a":1},{"b":2},{"c":3}]` — but you want to iterate its elements one at a time without materializing the whole array. Use `stream_format::comma_delimited_array`:
|
||||
|
||||
```cpp
|
||||
auto json = R"([{"a":1},{"b":2},{"c":3}])"_padded;
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::document_stream stream;
|
||||
auto error = parser.parse_many(json, simdjson::dom::DEFAULT_BATCH_SIZE,
|
||||
simdjson::stream_format::comma_delimited_array).get(stream);
|
||||
if (error) { std::cerr << error << std::endl; return; }
|
||||
for (auto doc : stream) {
|
||||
std::cout << doc << std::endl;
|
||||
}
|
||||
// Prints: {"a":1}
|
||||
// {"b":2}
|
||||
// {"c":3}
|
||||
```
|
||||
|
||||
The parser strips the outer `[` and `]` plus any surrounding JSON whitespace (space, tab, LF, CR) and then behaves exactly like `stream_format::comma_delimited` over the remaining bytes. All comma-delimited features are inherited: multi-batch processing, threading, mixed scalar types, and nested commas preserved inside inner objects and arrays.
|
||||
|
||||
```cpp
|
||||
// All of these work:
|
||||
auto a = R"([1, "x", true, null, {"k":"v"}, [1,2]])"_padded; // mixed scalars
|
||||
auto b = R"( [ 1, 2, 3 ] )"_padded; // whitespace
|
||||
auto c = R"([])"_padded; // empty array → 0 docs
|
||||
```
|
||||
|
||||
If the input is not a well-formed outer array (missing `[`, missing `]`, or empty / all-whitespace), `parse_many` returns `TAPE_ERROR`. Content **inside** the array is not validated up front — individual document parse errors surface when you iterate, just like `comma_delimited`.
|
||||
|
||||
Positions reported via `current_index()` are relative to the **stripped** buffer (the bytes between `[` and `]`), not the original input, for consistency with the existing BOM-stripping behavior.
|
||||
|
||||
@@ -204,9 +204,31 @@ but can be significantly larger. E.g., Apple systems favour pages spanning 16 ki
|
||||
|
||||
In effect, it means that you can almost always read a few bytes beyond your current buffer---without
|
||||
allocating extra memory. However, tools such as valgrind or memory sanitizers will flag such behavior as unsafe.
|
||||
Nevertheless, you can still make sure of this capability in your code if you are an expert
|
||||
programmer and you are willing to silence sanitizer warnings. The following code provides
|
||||
a portable example.
|
||||
You can still make sure of this capability in your code if you are an expert
|
||||
programmer and you are willing to silence sanitizer warnings.
|
||||
|
||||
If you are building simdjson with C++17 or better, you can use `simdjson::padded_input`.
|
||||
The `padded_input` struct automatically manages padding for you. It can be constructed from a `std::string_view`, a C-style string with length, or a `std::string`. For `std::string`, it takes into account the reserved capacity when determining if sufficient padding exists. If the input already has sufficient padding (up to the end of the memory page), it creates a view without copying. Otherwise, it copies the data into a `padded_string` with proper padding.
|
||||
|
||||
Example usage:
|
||||
|
||||
```cpp
|
||||
std::string_view json = get_json_data();
|
||||
simdjson::padded_input input(json); // Automatically pads if needed
|
||||
auto result = parser.parse(input);
|
||||
|
||||
// Also works with std::string, considering capacity
|
||||
std::string json_str = get_json_string();
|
||||
json_str.reserve(json_str.size() + 100); // Reserve extra space
|
||||
simdjson::padded_input input2(json_str); // May avoid copying if capacity is sufficient
|
||||
auto result2 = parser.parse(input2);
|
||||
```
|
||||
|
||||
This simplifies padding management compared to manually checking and allocating.
|
||||
|
||||
|
||||
More generally, the following code provides a portable example.
|
||||
|
||||
|
||||
|
||||
The conditional compilation checks for the `_MSC_VER` macro (indicating Microsoft Visual Studio)
|
||||
@@ -250,7 +272,7 @@ long page_size() {
|
||||
}
|
||||
|
||||
// Returns true if the buffer + len + simdjson::SIMDJSON_PADDING crosses the
|
||||
// page boundary.
|
||||
// page boundary. Assumes len != 0.
|
||||
bool need_allocation(const char *buf, size_t len) {
|
||||
return ((reinterpret_cast<uintptr_t>(buf + len - 1) % page_size())
|
||||
+ simdjson::SIMDJSON_PADDING >= static_cast<uintptr_t>(page_size()));
|
||||
@@ -297,4 +319,62 @@ int main() {
|
||||
}
|
||||
return EXIT_SUCCESS;
|
||||
}
|
||||
```
|
||||
|
||||
Further, whenever you allocate N bytes, memory allocators tend to allocate more memory, without you necessarily knowing about it. Under linux, you can use the `malloc_usable_size` function to see how much memory was actually allocated.
|
||||
Under an Apple plateform, you can `malloc_size`. The following program illustrates the usage.
|
||||
|
||||
```cpp
|
||||
#include <iostream>
|
||||
#include <cstddef>
|
||||
#include <memory>
|
||||
#include <cstdlib>
|
||||
#ifdef __APPLE__
|
||||
#include <malloc/malloc.h> // for malloc_size on macOS
|
||||
#endif
|
||||
#ifdef __linux__
|
||||
#include <malloc.h> // for malloc_usable_size on Linux
|
||||
#endif
|
||||
size_t get_usable_size(void* ptr) {
|
||||
#ifdef __linux__
|
||||
return malloc_usable_size(ptr);
|
||||
#elif defined(__APPLE__)
|
||||
return malloc_size(ptr);
|
||||
#else
|
||||
return 0; // Unsupported platform
|
||||
#endif
|
||||
}
|
||||
|
||||
int main() {
|
||||
std::cout << "Demonstrating allocation overhead and rounding with operator new\n\n";
|
||||
|
||||
#ifdef __linux__
|
||||
std::cout << "Platform: Linux\n";
|
||||
#elif defined(__APPLE__)
|
||||
std::cout << "Platform: macOS (using malloc_size)\n";
|
||||
#else
|
||||
std::cout << "Platform: Other/unsupported (usable size will show 0)\n";
|
||||
#endif
|
||||
|
||||
std::cout << "Requested size | Actual usable size\n";
|
||||
std::cout << "---------------|-------------------\n";
|
||||
size_t total_requested = 0;
|
||||
size_t total_usable = 0;
|
||||
for (size_t requested = 1; requested <= 4096; requested++) {
|
||||
total_requested += requested;
|
||||
std::unique_ptr<char[]> ptr(new char[requested]); // Allocate
|
||||
size_t usable = get_usable_size(ptr.get()); // Get usable size
|
||||
total_usable += usable;
|
||||
|
||||
std::cout << requested << "\t | " << usable << "\n";
|
||||
}
|
||||
std::cout << "---------------|-------------------\n";
|
||||
std::cout << "Total requested: " << total_requested << " bytes\n";
|
||||
std::cout << "Total usable: " << total_usable << " bytes\n";
|
||||
std::cout << "Total overhead: " << (total_usable - total_requested) << " bytes\n";
|
||||
std::cout << "Percentage overhead: "
|
||||
<< ((total_usable - total_requested) * 100.0 / total_requested) << " %\n";
|
||||
|
||||
return EXIT_SUCCESS;
|
||||
}
|
||||
```
|
||||
@@ -93,6 +93,14 @@ Float values are represented as two 64-bit tape elements:
|
||||
|
||||
Performance consideration: We store numbers of the main tape because we believe that locality of reference is helpful for performance.
|
||||
|
||||
## Big Integers
|
||||
|
||||
When a JSON integer exceeds the 64-bit range (both signed and unsigned), it is classified as a big integer. By default, parsing returns `BIGINT_ERROR`. When `parser.number_as_string(true)` is set, the raw digits are stored on the string tape using the same format as strings (4-byte little-endian length prefix, followed by the UTF-8 digit bytes, followed by a null terminator).
|
||||
|
||||
A big integer is represented on the main tape as the 64-bit tape element `('Z' << 56) + x` where the payload `x` is the location on the string tape of the null-terminated digit string.
|
||||
|
||||
For example, the JSON value `99999999999999999999` would be stored as the string `"99999999999999999999"` on the string tape, with a `'Z'` tag on the main tape. Negative big integers include the leading minus sign.
|
||||
|
||||
## Root node
|
||||
|
||||
Each JSON document will have two special 64-bit tape elements representing a root node, one at the beginning and one at the end.
|
||||
|
||||
@@ -54,6 +54,9 @@ static void print_json(std::ostream& os, simdjson::dom::element element) noexcep
|
||||
case simdjson::dom::element_type::NULL_VALUE:
|
||||
os << "null" << endl;
|
||||
break;
|
||||
case simdjson::dom::element_type::BIGINT:
|
||||
os << element.get_bigint().value_unsafe() << endl;
|
||||
break;
|
||||
}
|
||||
}
|
||||
extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
|
||||
|
||||
@@ -8,16 +8,11 @@
|
||||
* Minifies by first parsing, then minifying.
|
||||
*/
|
||||
extern "C" int LLVMFuzzerTestOneInput(const uint8_t *Data, size_t Size) {
|
||||
|
||||
auto begin = as_chars(Data);
|
||||
auto end = begin + Size;
|
||||
|
||||
std::string str(begin, end);
|
||||
simdjson::padded_string str(reinterpret_cast<const char *>(Data), Size);
|
||||
simdjson::dom::parser parser;
|
||||
simdjson::dom::element elem;
|
||||
auto error = parser.parse(str).get(elem);
|
||||
if (error) { return 0; }
|
||||
|
||||
std::string minified = simdjson::minify(elem);
|
||||
(void)minified;
|
||||
return 0;
|
||||
|
||||
@@ -35,7 +35,7 @@ cmake .. \
|
||||
-DSIMDJSON_DISABLE_DEPRECATED_API=On \
|
||||
-DSIMDJSON_FUZZ_LDFLAGS=$LIB_FUZZING_ENGINE
|
||||
|
||||
cmake --build . --target all_fuzzers
|
||||
cmake --build . --target all_fuzzers all_tests
|
||||
|
||||
cp fuzz/fuzz_* $OUT
|
||||
|
||||
|
||||
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 4.2 KiB |
|
After Width: | Height: | Size: 35 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 226 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 46 KiB |
|
After Width: | Height: | Size: 108 KiB |
|
After Width: | Height: | Size: 256 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 46 KiB |
|
After Width: | Height: | Size: 109 KiB |
|
After Width: | Height: | Size: 258 KiB |
|
After Width: | Height: | Size: 136 KiB |
@@ -52,7 +52,13 @@
|
||||
#include "simdjson/padded_string_view-inl.h"
|
||||
|
||||
#include "simdjson/dom.h"
|
||||
#include "simdjson/builder.h"
|
||||
#include "simdjson/ondemand.h"
|
||||
#include "simdjson/convert.h"
|
||||
#include "simdjson/convert-inl.h"
|
||||
|
||||
// Compile-time JSON parsing (C++26 P2996 reflection)
|
||||
#include "simdjson/compile_time_json.h"
|
||||
#include "simdjson/compile_time_json-inl.h"
|
||||
|
||||
#endif // SIMDJSON_H
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
#ifndef SIMDJSON_ARM64_BUILDER_H
|
||||
#define SIMDJSON_ARM64_BUILDER_H
|
||||
|
||||
#include "simdjson/arm64/begin.h"
|
||||
#include "simdjson/generic/builder/amalgamated.h"
|
||||
#include "simdjson/arm64/end.h"
|
||||
|
||||
#endif // SIMDJSON_ARM64_BUILDER_H
|
||||
@@ -428,6 +428,7 @@ namespace {
|
||||
static constexpr int NUM_CHUNKS = 64 / sizeof(simd8<T>);
|
||||
static_assert(NUM_CHUNKS == 4, "ARM kernel should use four registers per 64-byte block.");
|
||||
const simd8<T> chunks[NUM_CHUNKS];
|
||||
template<int idx> simd8<uint8_t> get() const { return idx < NUM_CHUNKS ? chunks[idx] : simd8<T>(); }
|
||||
|
||||
simd8x64(const simd8x64<T>& o) = delete; // no copy allowed
|
||||
simd8x64<T>& operator=(const simd8<T>& other) = delete; // no assignment allowed
|
||||
|
||||
@@ -21,6 +21,10 @@ SIMDJSON_PUSH_DISABLE_UNUSED_WARNINGS
|
||||
|
||||
/** The maximum document size supported by simdjson. */
|
||||
constexpr size_t SIMDJSON_MAXSIZE_BYTES = 0xFFFFFFFF;
|
||||
/** The maximum depth of nested objects and arrays supported by simdjson.
|
||||
A depth of SIMDJSON_MAXSIZE_BYTES/2 is not reasonable and would be
|
||||
adversarial, but it serves as an upper bound for validation purposes. */
|
||||
constexpr size_t SIMDJSON_MAX_DEPTH = SIMDJSON_MAXSIZE_BYTES/2;
|
||||
|
||||
/**
|
||||
* The amount of padding needed in a buffer to parse JSON.
|
||||
@@ -46,6 +50,21 @@ struct padded_string;
|
||||
class padded_string_view;
|
||||
enum class stage1_mode;
|
||||
|
||||
/**
|
||||
* Stream format for parse_many/iterate_many.
|
||||
*/
|
||||
enum class stream_format {
|
||||
whitespace_delimited, ///< Whitespace-delimited JSON documents (default, includes NDJSON/JSONL)
|
||||
json_sequence, ///< RFC 7464 JSON text sequences (RS-delimited)
|
||||
comma_delimited, ///< Comma-separated JSON documents (e.g., `{...},{...},{...}`)
|
||||
comma_delimited_array ///< A single JSON array whose elements are iterated as
|
||||
///< comma-separated documents (e.g., `[{...},{...},{...}]`).
|
||||
///< The parser strips the outer `[` / `]` plus any
|
||||
///< surrounding JSON whitespace (space, tab, LF, CR)
|
||||
///< and then behaves like `comma_delimited` over the
|
||||
///< remaining bytes.
|
||||
};
|
||||
|
||||
namespace internal {
|
||||
|
||||
template<typename T>
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
#ifndef SIMDJSON_BUILDER_H
|
||||
#define SIMDJSON_BUILDER_H
|
||||
|
||||
#include "simdjson/builtin/builder.h"
|
||||
|
||||
namespace simdjson {
|
||||
/**
|
||||
* @copydoc simdjson::builtin::builder
|
||||
*/
|
||||
namespace builder = builtin::builder;
|
||||
|
||||
} // namespace simdjson
|
||||
|
||||
#endif // SIMDJSON_BUILDER_H
|
||||
@@ -20,10 +20,12 @@
|
||||
#include "simdjson/ppc64.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(westmere)
|
||||
#include "simdjson/westmere.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lsx)
|
||||
#include "simdjson/lsx.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||
#include "simdjson/lasx.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lsx)
|
||||
#include "simdjson/lsx.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv_vls)
|
||||
#include "simdjson/rvv-vls.h"
|
||||
#else
|
||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||
#endif
|
||||
|
||||
@@ -21,6 +21,8 @@ namespace simdjson {
|
||||
namespace lsx {}
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||
namespace lasx {}
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv_vls)
|
||||
namespace rvv_vls {}
|
||||
#else
|
||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||
#endif
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
#ifndef SIMDJSON_BUILTIN_BUILDER_H
|
||||
#define SIMDJSON_BUILTIN_BUILDER_H
|
||||
|
||||
#include "simdjson/builtin.h"
|
||||
#include "simdjson/builtin/base.h"
|
||||
|
||||
#include "simdjson/generic/builder/dependencies.h"
|
||||
|
||||
#define SIMDJSON_CONDITIONAL_INCLUDE
|
||||
|
||||
#if SIMDJSON_BUILTIN_IMPLEMENTATION_IS(arm64)
|
||||
#include "simdjson/arm64/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(fallback)
|
||||
#include "simdjson/fallback/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(haswell)
|
||||
#include "simdjson/haswell/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(icelake)
|
||||
#include "simdjson/icelake/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(ppc64)
|
||||
#include "simdjson/ppc64/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(westmere)
|
||||
#include "simdjson/westmere/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lsx)
|
||||
#include "simdjson/lsx/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||
#include "simdjson/lasx/builder.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv_vls)
|
||||
#include "simdjson/rvv-vls/builder.h"
|
||||
#else
|
||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||
#endif
|
||||
|
||||
#undef SIMDJSON_CONDITIONAL_INCLUDE
|
||||
|
||||
namespace simdjson {
|
||||
/**
|
||||
* @copydoc simdjson::SIMDJSON_BUILTIN_IMPLEMENTATION::builder
|
||||
*/
|
||||
namespace builder = SIMDJSON_BUILTIN_IMPLEMENTATION::builder;
|
||||
} // namespace simdjson
|
||||
|
||||
#endif // SIMDJSON_BUILTIN_BUILDER_H
|
||||
@@ -23,6 +23,8 @@
|
||||
#include "simdjson/lsx/implementation.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||
#include "simdjson/lasx/implementation.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv_vls)
|
||||
#include "simdjson/rvv-vls/implementation.h"
|
||||
#else
|
||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||
#endif
|
||||
@@ -39,4 +41,4 @@ namespace simdjson {
|
||||
const implementation * builtin_implementation();
|
||||
} // namespace simdjson
|
||||
|
||||
#endif // SIMDJSON_BUILTIN_IMPLEMENTATION_H
|
||||
#endif // SIMDJSON_BUILTIN_IMPLEMENTATION_H
|
||||
|
||||
@@ -24,6 +24,8 @@
|
||||
#include "simdjson/lsx/ondemand.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(lasx)
|
||||
#include "simdjson/lasx/ondemand.h"
|
||||
#elif SIMDJSON_BUILTIN_IMPLEMENTATION_IS(rvv_vls)
|
||||
#include "simdjson/rvv-vls/ondemand.h"
|
||||
#else
|
||||
#error Unknown SIMDJSON_BUILTIN_IMPLEMENTATION
|
||||
#endif
|
||||
@@ -37,4 +39,4 @@ namespace simdjson {
|
||||
namespace ondemand = SIMDJSON_BUILTIN_IMPLEMENTATION::ondemand;
|
||||
} // namespace simdjson
|
||||
|
||||
#endif // SIMDJSON_BUILTIN_ONDEMAND_H
|
||||
#endif // SIMDJSON_BUILTIN_ONDEMAND_H
|
||||
|
||||
@@ -30,6 +30,10 @@ double from_chars(const char *first, const char* end) noexcept;
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#ifndef SIMDJSON_ENABLE_NAN_INF
|
||||
#define SIMDJSON_ENABLE_NAN_INF 0
|
||||
#endif
|
||||
|
||||
} // namespace simdjson
|
||||
|
||||
#if defined(__GNUC__)
|
||||
@@ -45,9 +49,6 @@ double from_chars(const char *first, const char* end) noexcept;
|
||||
|
||||
// Align to N-byte boundary
|
||||
#define SIMDJSON_ROUNDUP_N(a, n) (((a) + ((n)-1)) & ~((n)-1))
|
||||
#define SIMDJSON_ROUNDDOWN_N(a, n) ((a) & ~((n)-1))
|
||||
|
||||
#define SIMDJSON_ISALIGNED_N(ptr, n) (((uintptr_t)(ptr) & ((n)-1)) == 0)
|
||||
|
||||
#if SIMDJSON_REGULAR_VISUAL_STUDIO
|
||||
// We could use [[deprecated]] but it requires C++14
|
||||
@@ -55,6 +56,7 @@ double from_chars(const char *first, const char* end) noexcept;
|
||||
|
||||
#define simdjson_really_inline __forceinline
|
||||
#define simdjson_never_inline __declspec(noinline)
|
||||
#define simdjson_really_flatten [[msvc::flatten]]
|
||||
|
||||
#define simdjson_unused
|
||||
#define simdjson_warn_unused
|
||||
@@ -95,6 +97,7 @@ double from_chars(const char *first, const char* end) noexcept;
|
||||
|
||||
#define simdjson_really_inline inline __attribute__((always_inline))
|
||||
#define simdjson_never_inline inline __attribute__((noinline))
|
||||
#define simdjson_really_flatten [[gnu::flatten]]
|
||||
|
||||
#define simdjson_unused __attribute__((unused))
|
||||
#define simdjson_warn_unused __attribute__((warn_unused_result))
|
||||
@@ -171,6 +174,15 @@ double from_chars(const char *first, const char* end) noexcept;
|
||||
#define simdjson_inline simdjson_really_inline
|
||||
#endif
|
||||
|
||||
#if defined(simdjson_flatten)
|
||||
// Prefer the user's definition of simdjson_flatten; don't define it ourselves.
|
||||
#elif (defined(__GNUC__) && !defined(__OPTIMIZE__)) || (defined(_DEBUG) && _MSC_VER )
|
||||
// Flattening can lead to significant code bloat and high compile times. Don't use it for unoptimized builds.
|
||||
#define simdjson_flatten
|
||||
#else
|
||||
#define simdjson_flatten simdjson_really_flatten
|
||||
#endif
|
||||
|
||||
#if SIMDJSON_VISUAL_STUDIO
|
||||
/**
|
||||
* Windows users need to do some extra work when building
|
||||
@@ -289,7 +301,9 @@ namespace std {
|
||||
// when the compiler is optimizing.
|
||||
// We only set SIMDJSON_DEVELOPMENT_CHECKS if both __OPTIMIZE__
|
||||
// and NDEBUG are not defined.
|
||||
#if !defined(__OPTIMIZE__) && !defined(NDEBUG)
|
||||
// We recognize _DEBUG as overriding __OPTIMIZE__ so that if both
|
||||
// __OPTIMIZE__ and _DEBUG are defined, we still set SIMDJSON_DEVELOPMENT_CHECKS.
|
||||
#if ((!defined(__OPTIMIZE__) || defined(_DEBUG)) && !defined(NDEBUG))
|
||||
#define SIMDJSON_DEVELOPMENT_CHECKS 1
|
||||
#endif // __OPTIMIZE__
|
||||
#endif // _MSC_VER
|
||||
|
||||