diff --git a/.clusterfuzzlite/Dockerfile b/.clusterfuzzlite/Dockerfile index 4e7d64e7f..692a22c73 100644 --- a/.clusterfuzzlite/Dockerfile +++ b/.clusterfuzzlite/Dockerfile @@ -1,4 +1,4 @@ -FROM gcr.io/oss-fuzz-base/base-builder@sha256:e808bf977a4c4bfab17c3c41c6c7e8d131a488c5e844296bd515ae5f90930131 +FROM gcr.io/oss-fuzz-base/base-builder@sha256:6bc204c52f3c00f691125cadc3f13cce24bd663fb0fed41fec4119444f8bfe5b RUN apt-get update && apt-get upgrade -y --no-install-recommends \ ninja-build \ diff --git a/.clusterfuzzlite/build.sh b/.clusterfuzzlite/build.sh index 5cfed44fe..b185aec90 100644 --- a/.clusterfuzzlite/build.sh +++ b/.clusterfuzzlite/build.sh @@ -1,6 +1,6 @@ #!/bin/bash -eu -cmake --preset Fuzzing -cmake --build --preset Fuzzing +cmake --preset fuzzing +cmake --build --preset fuzzing -cp build/Fuzzing/infra/syntax/fuzz/infra.syntax_json_fuzzer $OUT/infra-syntax_json_fuzzer +cp build/fuzzing/infra/syntax/fuzz/infra.syntax_json_fuzzer $OUT/infra-syntax_json_fuzzer diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 000000000..6d2442bad --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1 @@ +FROM ghcr.io/philips-software/amp-devcontainer:v4.0.2@sha256:2d052e0bcb3840ea45aaa21ea6904f6d84b0e310c97e5690a6d48da522ec384e diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index df9f970f3..cf0d16912 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,18 +1,36 @@ { // This devcontainer has been set-up to run docker-from-docker scenarios as per // https://github.com/microsoft/vscode-dev-containers/tree/main/containers/docker-from-docker - "name": "amp-devcontainer", - "image": "ghcr.io/philips-software/amp-devcontainer:2.2.0", + "build": { + "context": "..", + "dockerfile": "Dockerfile" + }, "runArgs": ["--add-host=host.docker.internal:host-gateway"], "remoteEnv": { "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}" }, "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ], - "extensions": [ - "llvm-vs-code-extensions.vscode-clangd", - "marus25.cortex-debug", - "matepek.vscode-catch2-test-adapter", - "ms-vscode.cmake-tools", - "SonarSource.sonarlint-vscode" - ] + "customizations": { + "vscode": { + "extensions": [ + "llvm-vs-code-extensions.vscode-clangd", + "marus25.cortex-debug", + "matepek.vscode-catch2-test-adapter", + "mhutchie.git-graph", + "ms-vscode.cmake-tools", + "ms-vscode.cpptools", + "ms-vsliveshare.vsliveshare", + "SonarSource.sonarlint-vscode" + ], + "settings": { + "C_Cpp.autoAddFileAssociations": false, + "C_Cpp.intelliSenseEngine": "disabled", + "clangd.arguments": ["--query-driver=/**/arm-none-eabi-*"], + "cmake.copyCompileCommands": "${workspaceFolder}/build/compile_commands.json", + "cmake.statusbar.visibility": "default", + "cmake.useProjectStatusView": false, + "sonarlint.pathToCompileCommands": "${workspaceFolder}/build/compile_commands.json" + } + } + } } diff --git a/.github/dependabot.yml b/.github/dependabot.yml index d7a361356..3c5d27e4d 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -8,5 +8,9 @@ updates: interval: daily - package-ecosystem: docker directory: .clusterfuzzlite + schedule: + interval: monthly + - package-ecosystem: docker + directory: .devcontainer schedule: interval: daily diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cb650a5ca..3e5975375 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,30 +22,31 @@ jobs: name: Host Build & Test (ubuntu-latest) runs-on: ubuntu-latest steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - uses: hendrikmuhs/ccache-action@6d1841ec156c39a52b1b23a810da917ab98da1f4 # v1.2.10 with: key: ${{ github.job }}-ubuntu-latest variant: sccache - - uses: lukka/run-cmake@c2b72aff009141774c5a5fabe74ea46c8c04d9c4 # v10.6 + - uses: seanmiddleditch/gha-setup-ninja@8b297075da4cd2a5f1fd21fe011b499edf06e9d2 # v4 + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 with: - configurePreset: "ContinuousIntegration" - buildPreset: "ContinuousIntegrationWithPackage" - testPreset: "ContinuousIntegration" + configurePreset: "host" + buildPreset: "host-Debug-WithPackage" + testPreset: "host" configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=sccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache']" - - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 + - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 with: name: emil - path: build/ContinuousIntegration/emil-*-Linux.tar.gz + path: build/host/emil-*-Linux.tar.gz if-no-files-found: error - name: Upload test logs if: ${{ failure() }} - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 + uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 with: name: test-logs - path: build/ContinuousIntegration/Testing/Temporary/ + path: build/host/Testing/Temporary/ host_build_test: name: Host Build & Test runs-on: ${{ matrix.os }} @@ -53,25 +54,25 @@ jobs: matrix: os: [macos-latest, windows-latest, windows-2019] steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - uses: hendrikmuhs/ccache-action@6d1841ec156c39a52b1b23a810da917ab98da1f4 # v1.2.10 with: key: ${{ github.job }}-${{ matrix.os }} variant: sccache - - uses: lukka/run-cmake@c2b72aff009141774c5a5fabe74ea46c8c04d9c4 # v10.6 + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 with: - configurePreset: "ContinuousIntegration" - buildPreset: "ContinuousIntegration" - testPreset: "ContinuousIntegration" + configurePreset: "host-single-Debug" + buildPreset: "host-single-Debug" + testPreset: "host-single-Debug" configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=sccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache']" - name: Upload test logs if: ${{ failure() }} - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 + uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 with: name: test-logs - path: build/ContinuousIntegration/Testing/Temporary/ + path: build/host/Testing/Temporary/ embedded_build: name: Embedded Build runs-on: ubuntu-latest @@ -81,11 +82,11 @@ jobs: gcc: ["7-2018-q2", "8-2019-q3", "9-2020-q2", "10.3-2021.10"] configuration: ["RelWithDebInfo"] steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - name: Install GNU Arm Embedded Toolchain ${{ matrix.gcc }} - uses: carlosperate/arm-none-eabi-gcc-action@6a221d7c85f5b36647d6e9b25e874abf187409d3 # v1.7.1 + uses: carlosperate/arm-none-eabi-gcc-action@e9cd61b92edb079b14b2d0449b21f8a517121fe8 # v1.8.0 with: release: ${{ matrix.gcc }} - run: sudo apt-get update && sudo apt-get install ninja-build @@ -97,10 +98,30 @@ jobs: name: emil - run: tar -zxvf emil-*.tar.gz - run: mkdir install && mv emil-*/* install/ - - uses: lukka/run-cmake@c2b72aff009141774c5a5fabe74ea46c8c04d9c4 # v10.6 + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 with: - configurePreset: "Embedded" - buildPreset: "Embedded-${{ matrix.configuration }}" + configurePreset: "embedded" + buildPreset: "embedded-${{ matrix.configuration }}" + configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']" + embedded_build_without_host_install: + name: Embedded Build Without Host Install + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + persist-credentials: false + - name: Install GNU Arm Embedded Toolchain 10.3-2021.10 + uses: carlosperate/arm-none-eabi-gcc-action@e9cd61b92edb079b14b2d0449b21f8a517121fe8 # v1.8.0 + with: + release: "10.3-2021.10" + - run: sudo apt-get update && sudo apt-get install ninja-build + - uses: hendrikmuhs/ccache-action@6d1841ec156c39a52b1b23a810da917ab98da1f4 # v1.2.10 + with: + key: ${{ github.job }} + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 + with: + configurePreset: "embedded" + buildPreset: "embedded-RelWithDebInfo" configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']" rtos: name: Embedded Build - RTOS @@ -110,11 +131,11 @@ jobs: matrix: rtos: ["FreeRTOS", "ThreadX"] steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - - name: Install GNU Arm Embedded Toolchain "10.3-2021.10" - uses: carlosperate/arm-none-eabi-gcc-action@6a221d7c85f5b36647d6e9b25e874abf187409d3 # v1.7.1 + - name: Install GNU Arm Embedded Toolchain 10.3-2021.10 + uses: carlosperate/arm-none-eabi-gcc-action@e9cd61b92edb079b14b2d0449b21f8a517121fe8 # v1.8.0 with: release: "10.3-2021.10" - run: sudo apt-get update && sudo apt-get install ninja-build @@ -126,8 +147,8 @@ jobs: name: emil - run: tar -zxvf emil-*.tar.gz - run: mkdir install && mv emil-*/* install/ - - uses: lukka/run-cmake@c2b72aff009141774c5a5fabe74ea46c8c04d9c4 # v10.6 + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 with: - configurePreset: "Embedded-${{ matrix.rtos }}" - buildPreset: "Embedded-${{ matrix.rtos }}-RelWithDebInfo" + configurePreset: "embedded-${{ matrix.rtos }}" + buildPreset: "embedded-${{ matrix.rtos }}-RelWithDebInfo" configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']" diff --git a/.github/workflows/dependency-scanner.yml b/.github/workflows/dependency-scanner.yml index dbf3fef7b..5cf6beb79 100644 --- a/.github/workflows/dependency-scanner.yml +++ b/.github/workflows/dependency-scanner.yml @@ -16,16 +16,16 @@ jobs: contents: write pull-requests: write steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 - uses: philips-forks/cmake-dependency-submission@72880580a7cafc16145d82268f1892c0ece3da2a # main dependency-review: runs-on: ubuntu-latest - if: github.event_name == 'pull_request' + if: ${{ github.event_name == 'pull_request' }} needs: [dependency-submission] permissions: pull-requests: write steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 - - uses: actions/dependency-review-action@f6fff72a3217f580d5afd49a46826795305b63c7 # v3.0.8 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: actions/dependency-review-action@7bbfa034e752445ea40215fff1c3bf9597993d3f # v3.1.3 with: comment-summary-in-pr: true diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 58d4a1c7c..3ac1685c6 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -16,7 +16,7 @@ jobs: if: ${{ github.ref == 'refs/heads/main' }} steps: - name: Checkout - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: fetch-depth: 0 persist-credentials: false @@ -28,7 +28,7 @@ jobs: antora_generator: "antora-site-generator-lunr" antora_docsearch_enabled: "true" - name: Store Antora Site - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce + uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 with: name: antora path: "${{ github.workspace }}/build/site" @@ -44,7 +44,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: fetch-depth: 0 persist-credentials: false @@ -56,7 +56,7 @@ jobs: antora_generator: "antora-site-generator-lunr" antora_docsearch_enabled: "true" - name: Store Antora Site - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 + uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 with: name: antora-branch path: "${{ github.workspace }}/build/site" @@ -69,7 +69,7 @@ jobs: name: Publish to GitHub Pages steps: - name: Checkout - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 - name: Retrieve Antora Site uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2 with: diff --git a/.github/workflows/fuzzing-batch.yml b/.github/workflows/fuzzing-batch.yml index 638b80623..e4c4a4604 100644 --- a/.github/workflows/fuzzing-batch.yml +++ b/.github/workflows/fuzzing-batch.yml @@ -18,12 +18,12 @@ jobs: sanitizer: [address, undefined] steps: - name: Build Fuzzers (${{ matrix.sanitizer }}) - uses: google/clusterfuzzlite/actions/build_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/build_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: language: c++ sanitizer: ${{ matrix.sanitizer }} - name: Run Fuzzers (${{ matrix.sanitizer }}) - uses: google/clusterfuzzlite/actions/run_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/run_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: github-token: ${{ secrets.GITHUB_TOKEN }} fuzz-seconds: 1800 diff --git a/.github/workflows/fuzzing-cron.yml b/.github/workflows/fuzzing-cron.yml index ca68f1ba6..e640930bc 100644 --- a/.github/workflows/fuzzing-cron.yml +++ b/.github/workflows/fuzzing-cron.yml @@ -14,11 +14,11 @@ jobs: runs-on: ubuntu-latest steps: - name: Build Fuzzers - uses: google/clusterfuzzlite/actions/build_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/build_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: language: c++ - name: Run Fuzzers - uses: google/clusterfuzzlite/actions/run_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/run_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: github-token: ${{ secrets.GITHUB_TOKEN }} fuzz-seconds: 600 @@ -28,12 +28,12 @@ jobs: runs-on: ubuntu-latest steps: - name: Build Fuzzers - uses: google/clusterfuzzlite/actions/build_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/build_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: language: c++ sanitizer: coverage - name: Run Fuzzers - uses: google/clusterfuzzlite/actions/run_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/run_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: github-token: ${{ secrets.GITHUB_TOKEN }} fuzz-seconds: 600 diff --git a/.github/workflows/fuzzing-pr.yml b/.github/workflows/fuzzing-pr.yml index 3815ca3ad..916746b3c 100644 --- a/.github/workflows/fuzzing-pr.yml +++ b/.github/workflows/fuzzing-pr.yml @@ -22,14 +22,14 @@ jobs: sanitizer: [address, undefined] steps: - name: Build Fuzzers (${{ matrix.sanitizer }}) - uses: google/clusterfuzzlite/actions/build_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/build_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: language: c++ github-token: ${{ secrets.GITHUB_TOKEN }} sanitizer: ${{ matrix.sanitizer }} storage-repo: https://${{ secrets.METRICS_TOKEN }}@github.com/philips-software/amp-embedded-infra-lib-metrics.git - name: Run Fuzzers (${{ matrix.sanitizer }}) - uses: google/clusterfuzzlite/actions/run_fuzzers@1e163f06cba7820da5154ac9fe1a32d7fe6f73a3 + uses: google/clusterfuzzlite/actions/run_fuzzers@884713a6c30a92e5e8544c39945cd7cb630abcd1 with: github-token: ${{ secrets.GITHUB_TOKEN }} fuzz-seconds: 300 diff --git a/.github/workflows/linting-formatting.yml b/.github/workflows/linting-formatting.yml index 229157d6e..6a15006d6 100644 --- a/.github/workflows/linting-formatting.yml +++ b/.github/workflows/linting-formatting.yml @@ -21,7 +21,7 @@ jobs: contents: read pull-requests: write steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - uses: DoozyX/clang-format-lint-action@a83a8fb7d371f66da7dd1c4f33a193023899494b # v0.16 @@ -30,7 +30,7 @@ jobs: inplace: true extensions: "cpp,hpp" exclude: "./external" - - uses: reviewdog/action-suggester@3f60d0e826f0873905e0eeca522d562a6e67afbd # v1.7.1 + - uses: reviewdog/action-suggester@94877e550e6b522dc1d21231974b645ff2f084ce # v1.8.0 with: tool_name: clang-format filter_mode: diff_context @@ -42,26 +42,26 @@ jobs: pull-requests: write security-events: write steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: fetch-depth: 0 persist-credentials: false - - uses: oxsecurity/megalinter@fda6ac3a38be0e969820709ac16e442464e5a035 # v7.3.0 + - uses: oxsecurity/megalinter@b48455a119cc28045eee8f1e9d0a542a85e71f4f # v7.5.0 env: APPLY_FIXES: all VALIDATE_ALL_CODEBASE: true GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - uses: github/codeql-action/upload-sarif@6ca1aa8c195c3ca3e77c174fe0356db1bce3b319 # v2.21.1 - if: ${{ success() }} || ${{ failure() }} + - uses: github/codeql-action/upload-sarif@66b90a5db151a8042fa97405c6cf843bbe433f7b # v2.22.7 + if: ${{ success() || failure() }} with: sarif_file: megalinter-reports/megalinter-report.sarif - - uses: actions/upload-artifact@0b7f8abb1508181956e8e162db84b466c27e18ce # v3.1.2 - if: ${{ success() }} || ${{ failure() }} + - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 + if: ${{ success() || failure() }} with: name: linter path: | megalinter-reports - - uses: reviewdog/action-suggester@3f60d0e826f0873905e0eeca522d562a6e67afbd # v1.7.1 + - uses: reviewdog/action-suggester@94877e550e6b522dc1d21231974b645ff2f084ce # v1.8.0 with: tool_name: MegaLinter filter_mode: diff_context diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 893c91ccb..487fc0b51 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -26,7 +26,7 @@ jobs: app_id: ${{ secrets.FOREST_RELEASER_APP_ID }} app_base64_private_key: ${{ secrets.FOREST_RELEASER_APP_PRIVATE_KEY_BASE64 }} auth_type: installation - - uses: google-github-actions/release-please-action@ca6063f4ed81b55db15b8c42d1b6f7925866342d # v3.7.11 + - uses: google-github-actions/release-please-action@db8f2c60ee802b3748b512940dde88eabd7b7e01 # v3.7.13 id: release with: command: manifest @@ -43,17 +43,17 @@ jobs: matrix: os: [macos-latest, ubuntu-latest, windows-latest] steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - uses: hendrikmuhs/ccache-action@6d1841ec156c39a52b1b23a810da917ab98da1f4 # v1.2.10 with: key: ${{ github.job }}-${{ matrix.os }} variant: sccache - - uses: lukka/run-cmake@c2b72aff009141774c5a5fabe74ea46c8c04d9c4 # v10.6 + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 with: - configurePreset: "Package" - buildPreset: "Package" + configurePreset: "host-single-MinSizeRel" + buildPreset: "release-package" configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=sccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=sccache']" - run: gh release upload ${{ needs.release_please.outputs.tag_name }} build/**/emil-*.zip --clobber shell: bash diff --git a/.github/workflows/security.yml b/.github/workflows/security.yml index 58186f616..d8aaeb19f 100644 --- a/.github/workflows/security.yml +++ b/.github/workflows/security.yml @@ -21,16 +21,16 @@ jobs: actions: read contents: read steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - name: Analysis - uses: ossf/scorecard-action@08b4669551908b1024bb425080c797723083c031 # v2.2.0 + uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1 with: results_file: scorecards.sarif results_format: sarif repo_token: ${{ secrets.SCORECARD_READ_TOKEN }} publish_results: true - - uses: github/codeql-action/upload-sarif@6ca1aa8c195c3ca3e77c174fe0356db1bce3b319 # v2.21.1 + - uses: github/codeql-action/upload-sarif@66b90a5db151a8042fa97405c6cf843bbe433f7b # v2.22.7 with: sarif_file: scorecards.sarif diff --git a/.github/workflows/social-interaction.yml b/.github/workflows/social-interaction.yml index f03c75c26..ab77aaa8c 100644 --- a/.github/workflows/social-interaction.yml +++ b/.github/workflows/social-interaction.yml @@ -14,7 +14,7 @@ jobs: pull-requests: write if: ${{ github.actor != 'dependabot[bot]' }} steps: - - uses: actions/first-interaction@1d8459ca65b335265f1285568221e229d45a995e + - uses: actions/first-interaction@1dbfe1ba5525b8257e1f259b09745bee346d62d8 continue-on-error: true with: repo-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml index fe911e555..a15240a81 100644 --- a/.github/workflows/static-analysis.yml +++ b/.github/workflows/static-analysis.yml @@ -18,47 +18,42 @@ jobs: sonar: name: SonarCloud runs-on: ubuntu-latest + container: ghcr.io/philips-software/amp-devcontainer:v4.0.2@sha256:2d052e0bcb3840ea45aaa21ea6904f6d84b0e310c97e5690a6d48da522ec384e env: - SONAR_SCANNER_VERSION: 4.7.0.2747 + SONAR_SCANNER_VERSION: 5.0.1.3006 SONAR_SERVER_URL: "https://sonarcloud.io" steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: fetch-depth: 0 # Disable shallow clone to enable blame information persist-credentials: false - - run: sudo apt-get update && sudo apt-get install --no-install-recommends jq ninja-build xsltproc - - uses: actions/setup-python@61a6322f88396a6271a6ee3565807d608ecaddd1 # v4.7.0 - - uses: BSFishy/pip-action@8f2d471d809dc20b6ada98c91910b6ae6243f318 - with: - packages: gcovr==5.2 - - name: Install Sonar Scanner & Mull + - name: Install Sonar Scanner run: | wget -qN "https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-${{ env.SONAR_SCANNER_VERSION }}-linux.zip" unzip -qqo "sonar-scanner-cli-${{ env.SONAR_SCANNER_VERSION }}-linux.zip" echo "${PWD}/sonar-scanner-${{ env.SONAR_SCANNER_VERSION }}-linux/bin" >> "$GITHUB_PATH" - wget -qN https://github.com/mull-project/mull/releases/download/0.18.0/Mull-12-0.18.0-LLVM-12.0-ubuntu-20.04.deb - sudo dpkg -i Mull-12-0.18.0-LLVM-12.0-ubuntu-20.04.deb - uses: hendrikmuhs/ccache-action@6d1841ec156c39a52b1b23a810da917ab98da1f4 # v1.2.10 with: key: ${{ github.job }} max-size: 2G - name: Build & Collect Coverage run: | - cmake --preset Coverage -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache - cmake --build --preset Coverage - GTEST_OUTPUT="xml:${PWD}/testresults/" ctest --preset Coverage - gcovr --sonarqube=coverage.xml --exclude-lines-by-pattern '.*assert\(.*\);|.*really_assert\(.*\);|.*std::abort();' --exclude-unreachable-branches --exclude-throw-branches -j 2 --exclude=.*/generated/.* --exclude=.*/examples/.* --exclude=.*/external/.* --exclude=.*/lwip/.* --exclude=.*/tracing/.* --exclude=.*/test/.* - - name: Build & Run Mutation Tests - run: | - cmake --preset MutationTesting -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache - cmake --build --preset MutationTesting - ctest --preset MutationTesting + cmake --preset coverage -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache + cmake --build --preset coverage + GTEST_OUTPUT="xml:${PWD}/testresults/" ctest --preset coverage + gcovr --sonarqube=coverage.xml --exclude-lines-by-pattern '.*assert\(.*\);|.*really_assert\(.*\);|.*std::abort();' --exclude-unreachable-branches --exclude-throw-branches -j "$(nproc)" --exclude=.*/generated/.* --exclude=.*/examples/.* --exclude=.*/external/.* --exclude=.*/lwip/.* --exclude=.*/tracing/.* --exclude=.*/test/.* + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 + with: + configurePreset: "mutation-testing" + buildPreset: "mutation-testing" + testPreset: "mutation-testing" + configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']" - name: Convert Results run: | { echo ''; xsltproc .github/formatters/gtest-to-generic-execution.xslt testresults/*.xml; echo ''; } | tee execution.xml > /dev/null jq -s 'reduce .[] as $item ({}; . * $item)' reports/mull/*.json > reports/mull/merged-mutation.json jq --arg workspace "$GITHUB_WORKSPACE" -f .github/formatters/mutation-report-to-generic-issue.jq reports/mull/merged-mutation.json > mutation-sonar.json - cp build/Coverage/compile_commands.json compile_commands.json + cp build/coverage/compile_commands.json compile_commands.json - name: Run Analysis # skip the analysis step for dependabot PRs since dependabot does not have access to secrets if: ${{ github.actor != 'dependabot[bot]' }} @@ -70,20 +65,22 @@ jobs: codeql: name: CodeQL runs-on: ubuntu-latest + container: ghcr.io/philips-software/amp-devcontainer:v4.0.2@sha256:2d052e0bcb3840ea45aaa21ea6904f6d84b0e310c97e5690a6d48da522ec384e permissions: security-events: write steps: - - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3 + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 with: persist-credentials: false - - run: sudo apt-get update && sudo apt-get install ninja-build - uses: hendrikmuhs/ccache-action@6d1841ec156c39a52b1b23a810da917ab98da1f4 # v1.2.10 with: key: ${{ github.job }} - - uses: github/codeql-action/init@6ca1aa8c195c3ca3e77c174fe0356db1bce3b319 # v2.21.1 + - uses: github/codeql-action/init@66b90a5db151a8042fa97405c6cf843bbe433f7b # v2.22.7 with: languages: cpp - - run: | - cmake --preset ContinuousIntegration -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache - cmake --build --preset ContinuousIntegration - - uses: github/codeql-action/analyze@6ca1aa8c195c3ca3e77c174fe0356db1bce3b319 # v2.21.1 + - uses: lukka/run-cmake@2ce8982be71b8e9a3c4d5e432135035afd1e76a7 # v10.7 + with: + configurePreset: "host" + buildPreset: "host-Debug" + configurePresetAdditionalArgs: "['-DCMAKE_C_COMPILER_LAUNCHER=ccache', '-DCMAKE_CXX_COMPILER_LAUNCHER=ccache']" + - uses: github/codeql-action/analyze@66b90a5db151a8042fa97405c6cf843bbe433f7b # v2.22.7 diff --git a/.github/workflows/validate-pr.yml b/.github/workflows/validate-pr.yml index c8b2c855c..d85172744 100644 --- a/.github/workflows/validate-pr.yml +++ b/.github/workflows/validate-pr.yml @@ -11,7 +11,7 @@ jobs: conventional_commit: runs-on: ubuntu-latest steps: - - uses: Namchee/conventional-pr@15e783651cfaa0c26ed993b971edf4418f50aba0 # v0.13.0 + - uses: Namchee/conventional-pr@93f510707dd4ef011c5e8fe7c94c93c59fc86d4c # v0.15.1 with: access_token: ${{ secrets.GITHUB_TOKEN }} body: false diff --git a/.release-please-manifest.json b/.release-please-manifest.json index e6f877563..9d5573ce6 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.0.0" + ".": "5.0.1" } diff --git a/.vscode/extensions.json b/.vscode/extensions.json deleted file mode 100644 index 0a94675c8..000000000 --- a/.vscode/extensions.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "recommendations": ["ms-vscode-remote.vscode-remote-extensionpack"] -} diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index dba4ddea6..000000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "cmake.copyCompileCommands": "${workspaceFolder}/build/compile_commands.json", - "sonarlint.pathToCompileCommands": "${workspaceFolder}/build/compile_commands.json", - "clangd.arguments": ["--query-driver=/**/arm-none-eabi-*"], - "cmake.statusbar.visibility": "compact", - "cmake.useProjectStatusView": false -} diff --git a/CHANGELOG.md b/CHANGELOG.md index b9b3070ff..786f4bc16 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,46 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +## [5.0.1](https://github.com/philips-software/amp-embedded-infra-lib/compare/v5.0.0...v5.0.1) (2023-11-15) + + +### Bug Fixes + +* Corrected incorrect destructor syntax ([#460](https://github.com/philips-software/amp-embedded-infra-lib/issues/460)) ([e01dd98](https://github.com/philips-software/amp-embedded-infra-lib/commit/e01dd985d0d4699dc859d3e8fc375c72dccf8a89)) +* Various fixes for echo ([#462](https://github.com/philips-software/amp-embedded-infra-lib/issues/462)) ([0062598](https://github.com/philips-software/amp-embedded-infra-lib/commit/006259893b8bd57b7c0796977cd96fc4bfbcc626)) + +## [5.0.0](https://github.com/philips-software/amp-embedded-infra-lib/compare/v4.0.0...v5.0.0) (2023-11-09) + + +### ⚠ BREAKING CHANGES + +* generic pairing/bonding classes updated ([#330](https://github.com/philips-software/amp-embedded-infra-lib/issues/330)) +* ble interface improvements ([#300](https://github.com/philips-software/amp-embedded-infra-lib/issues/300)) + +### Features + +* Add protobuf/echo/ProtoMessageBuilder ([#416](https://github.com/philips-software/amp-embedded-infra-lib/issues/416)) ([f5260dd](https://github.com/philips-software/amp-embedded-infra-lib/commit/f5260dd65ae4adfea14755dfef04a18074441951)) +* Add ServiceProxyResponseQueue ([#338](https://github.com/philips-software/amp-embedded-infra-lib/issues/338)) ([88cb197](https://github.com/philips-software/amp-embedded-infra-lib/commit/88cb197acb2f38d3b6fad00f88983cf15d49c864)) +* Add streaming of little endian mac addresses ([#336](https://github.com/philips-software/amp-embedded-infra-lib/issues/336)) ([e3d7fd8](https://github.com/philips-software/amp-embedded-infra-lib/commit/e3d7fd8f12ad934b98a86a6b27d8f574049f12b3)) +* Added SerialCommunicationLoopback ([#440](https://github.com/philips-software/amp-embedded-infra-lib/issues/440)) ([2c87dfb](https://github.com/philips-software/amp-embedded-infra-lib/commit/2c87dfb5ecd1e76669af69a97f80c29bfab773b9)) +* Ble interface improvements ([#300](https://github.com/philips-software/amp-embedded-infra-lib/issues/300)) ([88a4689](https://github.com/philips-software/amp-embedded-infra-lib/commit/88a4689e8f08e2afe856170aa5b5036f69d1610c)) +* Generic pairing/bonding classes updated ([#330](https://github.com/philips-software/amp-embedded-infra-lib/issues/330)) ([dbda405](https://github.com/philips-software/amp-embedded-infra-lib/commit/dbda405cc2ef2d356fbe707df5389042a49c7959)) +* Removed Dac.hpp ([#439](https://github.com/philips-software/amp-embedded-infra-lib/issues/439)) ([4b52156](https://github.com/philips-software/amp-embedded-infra-lib/commit/4b5215609b9ee2a6ca72d8d660b8c797aa3e31c9)) +* Support payloads bigger than the MaxSendStreamSize ([#331](https://github.com/philips-software/amp-embedded-infra-lib/issues/331)) ([c411f66](https://github.com/philips-software/amp-embedded-infra-lib/commit/c411f66f7ae972786a7fa1134989ab8e4f0631aa)) +* Support streaming echo messages ([#435](https://github.com/philips-software/amp-embedded-infra-lib/issues/435)) ([07756bb](https://github.com/philips-software/amp-embedded-infra-lib/commit/07756bb41f068adbf3a2eb76adb2778fff5491f0)) + + +### Bug Fixes + +* Add acd sources to lwip ([#400](https://github.com/philips-software/amp-embedded-infra-lib/issues/400)) ([a4f68ef](https://github.com/philips-software/amp-embedded-infra-lib/commit/a4f68efdf19e7b556cb6fe2cba0165908f56be8c)) +* Added workaround mbedtls and clang-cl incomatibility ([#441](https://github.com/philips-software/amp-embedded-infra-lib/issues/441)) ([063b595](https://github.com/philips-software/amp-embedded-infra-lib/commit/063b59508f1d09c2675b338c7b54d64934f7792c)) +* Cpp:S6232 well-defined type-punning method should be used instead of a union-based one ([d809c17](https://github.com/philips-software/amp-embedded-infra-lib/commit/d809c173cacefd3bf2d661718111d5d301a95fc1)) +* Destruction of HttpClientJson while resetting the reader resulted in memory corruption ([#404](https://github.com/philips-software/amp-embedded-infra-lib/issues/404)) ([ed8a8a0](https://github.com/philips-software/amp-embedded-infra-lib/commit/ed8a8a0e5893074fc56fde94cfdb003a870e930c)) +* Detaching HttpClient while in HeaderAvailable resulted in a crash ([#406](https://github.com/philips-software/amp-embedded-infra-lib/issues/406)) ([a905a30](https://github.com/philips-software/amp-embedded-infra-lib/commit/a905a306be194c7cf6380e70cf83b668c8d27425)) +* Enable service scoping of method invocations in services.echo_console ([#325](https://github.com/philips-software/amp-embedded-infra-lib/issues/325)) ([7090a40](https://github.com/philips-software/amp-embedded-infra-lib/commit/7090a407f50d89073c468381e5207f1c0f56b6c1)) +* UpgradePackBuilderFacade setting mbedtls global memory pool on stack ([#324](https://github.com/philips-software/amp-embedded-infra-lib/issues/324)) ([ec567d5](https://github.com/philips-software/amp-embedded-infra-lib/commit/ec567d511f40eb3c0962ac4b6ac3479f64c0a871)) +* UpgradePackBuilderFacade setting mbedtls global memory pool on stack, causing a crash when combined with ConnectionMbedTls ([ec567d5](https://github.com/philips-software/amp-embedded-infra-lib/commit/ec567d511f40eb3c0962ac4b6ac3479f64c0a871)) + ## [4.0.0](https://github.com/philips-software/amp-embedded-infra-lib/compare/v3.2.0...v4.0.0) (2023-06-02) diff --git a/CMakeLists.txt b/CMakeLists.txt index 546496543..f39f7aa10 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -7,7 +7,7 @@ if (APPLE) set(CMAKE_OSX_DEPLOYMENT_TARGET "10.15" CACHE STRING "Minimum OS X deployment version") endif() -project(emil LANGUAGES C CXX VERSION 4.0.0) # x-release-please-version +project(emil LANGUAGES C CXX VERSION 5.0.1) # x-release-please-version set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED On) @@ -88,7 +88,7 @@ option(EMIL_BUILD_TESTS "Enable building the tests" ${EMIL_DEFAULTOPT}) option(EMIL_BUILD_EXAMPLES "Enable building the examples" ${EMIL_DEFAULTOPT}) option(EMIL_ENABLE_FUZZING "Enable building the fuzzing targets" Off) option(EMIL_ENABLE_DOCKER_TOOLS "Enable shift-left tools (e.g. linters, formatters) that are run using Docker" On) -option(EMIL_GENERATE_PACKAGE_CONFIG "Enable generation of package configuration and install files" ${EMIL_HOST_BUILD}) +option(EMIL_BUILD_ECHO_COMPILERS "Build and install the Protobuf ECHO compilers" ${EMIL_DEFAULTOPT}) option(EMIL_ENABLE_GLOBAL_TRACING "Enable Global Tracing" On) # Enable or disable optional features. @@ -149,18 +149,12 @@ if (EMIL_STANDALONE) emil_folderize_all_targets() endif() -if (EMIL_GENERATE_PACKAGE_CONFIG) +if (EMIL_BUILD_ECHO_COMPILERS) function(generate_export_targets name) - # Generate and install export file install(EXPORT emil${name}Targets FILE emil${name}Targets.cmake DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/emil ) - - # Generate the export targets for the build tree - export(EXPORT emil${name}Targets - FILE "${CMAKE_CURRENT_BINARY_DIR}/cmake/emil${name}Targets.cmake" - ) endfunction() foreach(target IN ITEMS Protobuf) @@ -185,20 +179,20 @@ if (EMIL_GENERATE_PACKAGE_CONFIG) "${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}ConfigVersion.cmake" DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME} ) - - set(CPACK_GENERATOR "ZIP;TGZ") - set(CPACK_SOURCE_IGNORE_FILES ".vs/;.git/;build/") - set(CPACK_PACKAGE_NAME "${PROJECT_NAME}") - set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}") - set(CPACK_PACKAGE_VENDOR "Koninklijke Philips N.V") - set(CPACK_PACKAGE_DESCRIPTION "${PROJECT_DESCRIPTION}") - set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}") - set(CPACK_RPM_PACKAGE_NAME "${CPACK_PACKAGE_NAME}") - set(CPACK_PACKAGE_HOMEPAGE_URL "${PROJECT_HOMEPAGE_URL}") - set(CPACK_PACKAGE_MAINTAINER "${CPACK_PACKAGE_VENDOR}") - set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${CPACK_PACKAGE_VENDOR}") - set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.md") - set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md") - - include(CPack) endif() + +set(CPACK_GENERATOR "ZIP;TGZ") +set(CPACK_SOURCE_IGNORE_FILES ".vs/;.git/;build/") +set(CPACK_PACKAGE_NAME "${PROJECT_NAME}") +set(CPACK_PACKAGE_VERSION "${PROJECT_VERSION}") +set(CPACK_PACKAGE_VENDOR "Koninklijke Philips N.V") +set(CPACK_PACKAGE_DESCRIPTION "${PROJECT_DESCRIPTION}") +set(CPACK_DEBIAN_PACKAGE_NAME "${CPACK_PACKAGE_NAME}") +set(CPACK_RPM_PACKAGE_NAME "${CPACK_PACKAGE_NAME}") +set(CPACK_PACKAGE_HOMEPAGE_URL "${PROJECT_HOMEPAGE_URL}") +set(CPACK_PACKAGE_MAINTAINER "${CPACK_PACKAGE_VENDOR}") +set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${CPACK_PACKAGE_VENDOR}") +set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.md") +set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md") + +include(CPack) diff --git a/CMakePresets.json b/CMakePresets.json index 99cdfaf78..1442446cf 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -12,51 +12,57 @@ } }, { - "name": "ContinuousIntegration", - "displayName": "Configuration for Continuous Integration", + "name": "host", + "displayName": "Configuration for Host Tooling and Tests", + "inherits": "defaults", + "cacheVariables": { + "CMAKE_CONFIGURATION_TYPES": "Debug;Release;RelWithDebInfo;MinSizeRel" + }, + "generator": "Ninja Multi-Config" + }, + { + "name": "host-single-Debug", + "displayName": "Configuration for Host Tooling and Tests, Single Config Generator, Debug", "inherits": "defaults", "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug", - "EMIL_ENABLE_DOCKER_TOOLS": "Off", - "EMIL_BUILD_EXAMPLES": "On" + "EMIL_ENABLE_DOCKER_TOOLS": "Off" } }, { - "name": "Package", - "displayName": "Configuration for CPack package generation", + "name": "host-single-MinSizeRel", + "displayName": "Configuration for Host Tooling and Tests, Single Config Generator, MinSizeRel", "inherits": "defaults", "cacheVariables": { "CMAKE_BUILD_TYPE": "MinSizeRel", - "EMIL_ENABLE_DOCKER_TOOLS": "Off", - "EMIL_BUILD_TESTS": "Off", - "EMIL_BUILD_EXAMPLES": "Off" + "EMIL_ENABLE_DOCKER_TOOLS": "Off" } }, { - "name": "Coverage", + "name": "coverage", "displayName": "Configuration for Code Coverage", - "inherits": "ContinuousIntegration", + "inherits": "host", "cacheVariables": { "EMIL_ENABLE_COVERAGE": "On" }, "generator": "Ninja" }, { - "name": "MutationTesting", + "name": "mutation-testing", "displayName": "Configuration for Mutation Testing", - "inherits": "ContinuousIntegration", + "inherits": "host", "cacheVariables": { - "CMAKE_C_COMPILER": "clang-12", - "CMAKE_CXX_COMPILER": "clang++-12", + "CMAKE_C_COMPILER": "clang", + "CMAKE_CXX_COMPILER": "clang++", "EMIL_ENABLE_MUTATION_TESTING": "On", - "EMIL_MUTATION_TESTING_RUNNER_ARGUMENTS": "--reporters;Elements;--report-dir;${sourceDir}/reports/mull" + "EMIL_MUTATION_TESTING_RUNNER_ARGUMENTS": "--allow-surviving;--reporters;Elements;--report-dir;${sourceDir}/reports/mull" }, "generator": "Ninja" }, { - "name": "Fuzzing", + "name": "fuzzing", "displayName": "Configuration for Fuzzing", - "inherits": "ContinuousIntegration", + "inherits": "host", "cacheVariables": { "CMAKE_C_COMPILER": "clang", "CMAKE_CXX_COMPILER": "clang++", @@ -67,18 +73,7 @@ "generator": "Ninja" }, { - "name": "Host", - "displayName": "Configuration for Host Tooling", - "inherits": "defaults", - "cacheVariables": { - "CMAKE_CONFIGURATION_TYPES": "Debug;Release;RelWithDebInfo;MinSizeRel", - "EMIL_BUILD_TESTS": "Off", - "EMIL_BUILD_EXAMPLES": "Off" - }, - "generator": "Ninja Multi-Config" - }, - { - "name": "HostClangMsvc", + "name": "host-ClangMsvc", "displayName": "Configuration for Host Tooling using clang-cl to target Windows", "inherits": "defaults", "toolchainFile": "${sourceDir}/cmake/toolchain-clang-x86_64-pc-windows-msvc.cmake", @@ -91,8 +86,8 @@ "generator": "Ninja Multi-Config" }, { - "name": "Embedded", - "displayName": "Configuration for Embedded", + "name": "embedded", + "displayName": "Configuration for embedded", "inherits": "defaults", "toolchainFile": "${sourceDir}/cmake/toolchain-arm-gcc-m4-fpv4-sp-d16.cmake", "cacheVariables": { @@ -102,18 +97,18 @@ "generator": "Ninja Multi-Config" }, { - "name": "Embedded-FreeRTOS", - "displayName": "Configuration for Embedded with FreeRTOS", - "inherits": "Embedded", + "name": "embedded-FreeRTOS", + "displayName": "Configuration for embedded with FreeRTOS", + "inherits": "embedded", "cacheVariables": { "EMIL_INCLUDE_FREERTOS": "On", "FREERTOS_CONFIG_FILE_DIRECTORY": "${sourceDir}/examples/threading/config" } }, { - "name": "Embedded-ThreadX", - "displayName": "Configuration for Embedded with ThreadX", - "inherits": "Embedded", + "name": "embedded-ThreadX", + "displayName": "Configuration for embedded with ThreadX", + "inherits": "embedded", "cacheVariables": { "EMIL_INCLUDE_THREADX": "On" } @@ -121,96 +116,96 @@ ], "buildPresets": [ { - "name": "ContinuousIntegration", + "name": "host-Debug", "configuration": "Debug", - "configurePreset": "ContinuousIntegration" + "configurePreset": "host" }, { - "name": "ContinuousIntegrationWithPackage", + "name": "host-Debug-WithPackage", "configuration": "Debug", - "configurePreset": "ContinuousIntegration", + "configurePreset": "host", "targets": ["all", "package"] }, { - "name": "Package", - "configuration": "MinSizeRel", - "configurePreset": "Package", - "targets": ["package"] + "name": "host-Release", + "configuration": "Release", + "configurePreset": "host" }, { - "name": "Coverage", - "configuration": "Debug", - "configurePreset": "Coverage" + "name": "host-RelWithDebInfo", + "configuration": "RelWithDebInfo", + "configurePreset": "host" }, { - "name": "MutationTesting", - "configuration": "Debug", - "configurePreset": "MutationTesting" + "name": "host-MinSizeRel", + "configuration": "MinSizeRel", + "configurePreset": "host" }, { - "name": "Fuzzing", + "name": "host-single-Debug", "configuration": "Debug", - "configurePreset": "Fuzzing" + "configurePreset": "host-single-Debug" }, { - "name": "Host-Debug", - "configuration": "Debug", - "configurePreset": "Host" + "name": "release-package", + "configuration": "MinSizeRel", + "configurePreset": "host-single-MinSizeRel", + "targets": ["package"] }, { - "name": "Host-Release", - "configuration": "Release", - "configurePreset": "Host" + "name": "coverage", + "configuration": "Debug", + "configurePreset": "coverage" }, { - "name": "Host-RelWithDebInfo", - "configuration": "RelWithDebInfo", - "configurePreset": "Host" + "name": "mutation-testing", + "configuration": "Debug", + "configurePreset": "mutation-testing" }, { - "name": "Host-MinSizeRel", - "configuration": "MinSizeRel", - "configurePreset": "Host" + "name": "fuzzing", + "configuration": "Debug", + "configurePreset": "fuzzing" }, { - "name": "HostClangMsvc-Debug", + "name": "host-ClangMsvc-Debug", "configuration": "Debug", - "configurePreset": "HostClangMsvc" + "configurePreset": "host-ClangMsvc" }, { - "name": "HostClangMsvc-RelWithDebInfo", + "name": "host-ClangMsvc-RelWithDebInfo", "configuration": "RelWithDebInfo", - "configurePreset": "HostClangMsvc" + "configurePreset": "host-ClangMsvc" }, { - "name": "Embedded-Debug", + "name": "embedded-Debug", "configuration": "Debug", - "configurePreset": "Embedded" + "configurePreset": "embedded" }, { - "name": "Embedded-Release", + "name": "embedded-Release", "configuration": "Release", - "configurePreset": "Embedded" + "configurePreset": "embedded" }, { - "name": "Embedded-RelWithDebInfo", + "name": "embedded-RelWithDebInfo", "configuration": "RelWithDebInfo", - "configurePreset": "Embedded" + "configurePreset": "embedded" }, { - "name": "Embedded-MinSizeRel", + "name": "embedded-MinSizeRel", "configuration": "MinSizeRel", - "configurePreset": "Embedded" + "configurePreset": "embedded" }, { - "name": "Embedded-FreeRTOS-RelWithDebInfo", + "name": "embedded-FreeRTOS-RelWithDebInfo", "configuration": "RelWithDebInfo", - "configurePreset": "Embedded-FreeRTOS" + "configurePreset": "embedded-FreeRTOS" }, { - "name": "Embedded-ThreadX-RelWithDebInfo", + "name": "embedded-ThreadX-RelWithDebInfo", "configuration": "RelWithDebInfo", - "configurePreset": "Embedded-ThreadX" + "configurePreset": "embedded-ThreadX" } ], "testPresets": [ @@ -226,20 +221,26 @@ } }, { - "name": "ContinuousIntegration", - "configurePreset": "ContinuousIntegration", + "name": "host", + "configurePreset": "host", + "configuration": "Debug", + "inherits": "defaults" + }, + { + "name": "host-single-Debug", + "configurePreset": "host-single-Debug", "configuration": "Debug", "inherits": "defaults" }, { - "name": "Coverage", - "configurePreset": "Coverage", + "name": "coverage", + "configurePreset": "coverage", "configuration": "Debug", "inherits": "defaults" }, { - "name": "MutationTesting", - "configurePreset": "MutationTesting", + "name": "mutation-testing", + "configurePreset": "mutation-testing", "configuration": "Debug", "inherits": "defaults", "output": { diff --git a/cmake/emil_build_for.cmake b/cmake/emil_build_for.cmake index 0aa6e90da..282ce81cb 100644 --- a/cmake/emil_build_for.cmake +++ b/cmake/emil_build_for.cmake @@ -88,3 +88,10 @@ function(emil_build_for target) endif() endfunction() + +function(emil_install target) + get_target_property(exclude ${target} EXCLUDE_FROM_ALL) + if (NOT ${exclude}) + install(TARGETS ${target} ${ARGN}) + endif() +endfunction() diff --git a/cmake/emil_test_helpers.cmake b/cmake/emil_test_helpers.cmake index 5be8b44f7..77fca450a 100644 --- a/cmake/emil_test_helpers.cmake +++ b/cmake/emil_test_helpers.cmake @@ -2,12 +2,10 @@ option(EMIL_ENABLE_COVERAGE "Enable compiler flags for code coverage measurement option(EMIL_ENABLE_MUTATION_TESTING "Enable compiler flags for mutation testing" Off) set(EMIL_MUTATION_TESTING_RUNNER_ARGUMENTS "" CACHE STRING "Additional arguments for the mutation testing runner") -function(emil_enable_testing) - include(GoogleTest) - +function(emil_fetch_googletest) FetchContent_Declare( googletest - GIT_REPOSITORY https://github.com/google/googletest.git + GIT_REPOSITORY https://github.com/google/googletest GIT_TAG release-1.12.1 ) @@ -18,6 +16,12 @@ function(emil_enable_testing) set_target_properties(gtest gtest_main gmock gmock_main PROPERTIES FOLDER External/GoogleTest) mark_as_advanced(BUILD_GMOCK BUILD_GTEST BUILD_SHARED_LIBS gmock_build_tests gtest_build_samples test_build_tests gtest_disable_pthreads gtest_force_shared_crt gtest_hide_internal_symbols) +endfunction() + +function(emil_enable_testing) + include(GoogleTest) + + emil_fetch_googletest() if (EMIL_ENABLE_COVERAGE) add_compile_options( @@ -34,19 +38,9 @@ function(emil_enable_testing) if (EMIL_ENABLE_MUTATION_TESTING) if (CMAKE_CXX_COMPILER_ID MATCHES "Clang") - execute_process(COMMAND ${CMAKE_CXX_COMPILER} -dumpversion OUTPUT_VARIABLE CLANG_VERSION) - - if(CLANG_VERSION VERSION_GREATER 15.0 OR CLANG_VERSION VERSION_EQUAL 15.0) - add_compile_options( - -g -O0 -grecord-command-line -fprofile-instr-generate -fcoverage-mapping - -fexperimental-new-pass-manager -fpass-plugin=/usr/lib/mull-ir-frontend - ) - else() - add_compile_options( - -g -O0 -grecord-command-line -fprofile-instr-generate -fcoverage-mapping - -fexperimental-new-pass-manager -fpass-plugin=/usr/lib/mull-ir-frontend-12 - ) - endif() + add_compile_options( + -g -O0 -grecord-command-line -fprofile-instr-generate -fcoverage-mapping -fpass-plugin=/usr/lib/mull-ir-frontend + ) add_link_options(-fprofile-instr-generate) else() @@ -68,13 +62,7 @@ function(emil_add_test target) get_target_property(exclude ${target} EXCLUDE_FROM_ALL) if (NOT ${exclude}) if (EMIL_ENABLE_MUTATION_TESTING) - execute_process(COMMAND ${CMAKE_CXX_COMPILER} -dumpversion OUTPUT_VARIABLE CLANG_VERSION) - - if(CLANG_VERSION VERSION_GREATER 15.0 OR CLANG_VERSION VERSION_EQUAL 15.0) - add_test(NAME ${target} COMMAND mull-runner ${EMIL_MUTATION_TESTING_RUNNER_ARGUMENTS} $) - else() - add_test(NAME ${target} COMMAND mull-runner-12 ${EMIL_MUTATION_TESTING_RUNNER_ARGUMENTS} $) - endif() + add_test(NAME ${target} COMMAND mull-runner ${EMIL_MUTATION_TESTING_RUNNER_ARGUMENTS} $) else() add_test(NAME ${target} COMMAND ${target}) endif() diff --git a/documents/antora.yml b/documents/antora.yml index 8cd191ba9..088eb1760 100644 --- a/documents/antora.yml +++ b/documents/antora.yml @@ -1,5 +1,5 @@ name: embedded_infrastructure_library title: Embedded Infrastructure Library documentation -version: 4.0.0 # x-release-please-version +version: 5.0.1 # x-release-please-version nav: - modules/ROOT/nav.adoc diff --git a/examples/rpc/Server.cpp b/examples/rpc/Server.cpp index 6e8f6ac32..c960da908 100644 --- a/examples/rpc/Server.cpp +++ b/examples/rpc/Server.cpp @@ -23,8 +23,9 @@ class EchoConnection : public services::EchoOnConnection { public: - EchoConnection() - : console(*this) + EchoConnection(services::MethodSerializerFactory& serializerFactory) + : services::EchoOnConnection(serializerFactory) + , console(*this) {} private: @@ -45,12 +46,13 @@ class RpcServer connection->::services::ConnectionObserver::Subject().AbortAndDestroy(); if (connection.Allocatable()) - createdObserver(connection.Emplace()); + createdObserver(connection.Emplace(serializerFactory)); } private: infra::SharedPtr listener; infra::SharedOptional connection; + services::MethodSerializerFactory::OnHeap serializerFactory; }; int main(int argc, const char* argv[], const char* env[]) diff --git a/external/crypto/mbedtls/CMakeLists.txt b/external/crypto/mbedtls/CMakeLists.txt index db0eb2144..e44c96cd6 100644 --- a/external/crypto/mbedtls/CMakeLists.txt +++ b/external/crypto/mbedtls/CMakeLists.txt @@ -11,12 +11,36 @@ set(ENABLE_TESTING Off CACHE INTERNAL "") set(ENABLE_PROGRAMS Off CACHE INTERNAL "") set(GEN_FILES Off CACHE INTERNAL "") +# mbedtls uses CMAKE_C_COMPILER_ID to determine the type of compiler used. +# When compiling with clang-cl, mbedtls thinks the clang compiler +# is used, and sets flags according to what clang expects as arguments. +# However, clang-cl expects MSVC like arguments. Therefore we have to trick mbedtls +# in to thinking MSVC is being used as a compiler. +# After making mbedtls available the original COMPILER_ID will be restored +set(ORIGINAL_C_COMPILER_ID ${CMAKE_C_COMPILER_ID}) +set(ORIGINAL_CXX_COMPILER_ID ${CMAKE_CXX_COMPILER_ID}) + +if (CMAKE_C_SIMULATE_ID) + set(CMAKE_C_COMPILER_ID ${CMAKE_C_SIMULATE_ID}) +endif() + +if (CMAKE_CXX_SIMULATE_ID) + set(CMAKE_CXX_COMPILER_ID ${CMAKE_CXX_SIMULATE_ID}) +endif() + FetchContent_MakeAvailable(mbedtls) +set(CMAKE_C_COMPILER_ID ${ORIGINAL_C_COMPILER_ID}) +set(CMAKE_CXX_COMPILER_ID ${ORIGINAL_CXX_COMPILER_ID}) + function(add_mbedtls_target_properties) foreach(target ${ARGN}) target_compile_options(${target} PUBLIC -DMBEDTLS_CONFIG_FILE="mbedtls/mbedtls_emil_config.h" + # see https://github.com/Mbed-TLS/mbedtls/pull/6966 + # mbedtls sets the -Wdocumentation flag, which is throwing warnings + # since clang-15 + $<$:-Wno-documentation> ) target_include_directories(${target} PUBLIC diff --git a/external/protoc/CMakeLists.txt b/external/protoc/CMakeLists.txt index e95241f24..07c71cfd8 100644 --- a/external/protoc/CMakeLists.txt +++ b/external/protoc/CMakeLists.txt @@ -106,7 +106,7 @@ function(protocol_buffer_csharp target input) endfunction() function(protocol_buffer_java target input) - protocol_buffer_generator(TARGET ${target} INPUT ${input} GENERATOR java PATH_INFIX "/com/philips/emil/ProtobufEcho/" GENERATED_POSTFIXES Proto.java) + protocol_buffer_generator(TARGET ${target} INPUT ${input} GENERATOR java PATH_INFIX "/com/philips/emil/protobufEcho/" GENERATED_POSTFIXES Proto.java) endfunction() function(protocol_buffer_all target input) diff --git a/hal/interfaces/CMakeLists.txt b/hal/interfaces/CMakeLists.txt index f163c562f..0d94b4dcd 100644 --- a/hal/interfaces/CMakeLists.txt +++ b/hal/interfaces/CMakeLists.txt @@ -18,7 +18,6 @@ target_sources(hal.interfaces PRIVATE Can.cpp Can.hpp CommunicationConfigurator.hpp - Dac.hpp DigitalToAnalogPin.hpp Ethernet.hpp Flash.cpp diff --git a/hal/interfaces/Dac.hpp b/hal/interfaces/Dac.hpp deleted file mode 100644 index 930247590..000000000 --- a/hal/interfaces/Dac.hpp +++ /dev/null @@ -1,59 +0,0 @@ -#ifndef HAL_DAC_HPP -#define HAL_DAC_HPP - -#include "infra/util/Unit.hpp" - -namespace hal -{ - template - class Dac - { - protected: - Dac() = default; - - Dac(const Dac&) = delete; - Dac& operator=(const Dac&) = delete; - ~Dac() = default; - - public: - virtual void SetOutput(infra::Quantity value) = 0; - }; - - class DacImplBase - { - protected: - ~DacImplBase() = default; - - public: - virtual void SetOutput(uint16_t value) = 0; - }; - - template - class DacConverter - : public Dac - , public Impl - { - public: - template - DacConverter(Args&&... args); - - void SetOutput(infra::Quantity value); - }; - - //// Implementation //// - - template - template - DacConverter::DacConverter(Args&&... args) - : Impl(std::forward(args)...) - {} - - template - void DacConverter::SetOutput(infra::Quantity value) - { - infra::Quantity convertedValue(value * infra::Quantity(1)); - Impl::SetOutput(convertedValue.Value()); - } -} - -#endif diff --git a/infra/stream/BufferingStreamReader.cpp b/infra/stream/BufferingStreamReader.cpp new file mode 100644 index 000000000..53c32f5ed --- /dev/null +++ b/infra/stream/BufferingStreamReader.cpp @@ -0,0 +1,109 @@ +#include "infra/stream/BufferingStreamReader.hpp" + +namespace infra +{ + BufferingStreamReader::BufferingStreamReader(infra::BoundedDeque& buffer, infra::StreamReaderWithRewinding& input) + : buffer(buffer) + , input(input) + {} + + BufferingStreamReader::~BufferingStreamReader() + { + StoreRemainder(); + } + + void BufferingStreamReader::Extract(infra::ByteRange range, infra::StreamErrorPolicy& errorPolicy) + { + if (index != buffer.size()) + { + Read(infra::Head(buffer.contiguous_range(buffer.begin() + index), range.size()), range); + // Perhaps the deque just wrapped around, try once more + Read(infra::Head(buffer.contiguous_range(buffer.begin() + index), range.size()), range); + } + + if (!range.empty()) + Read(input.ExtractContiguousRange(range.size()), range); + + errorPolicy.ReportResult(range.empty()); + } + + uint8_t BufferingStreamReader::Peek(infra::StreamErrorPolicy& errorPolicy) + { + auto range = PeekContiguousRange(0); + + errorPolicy.ReportResult(!range.empty()); + + if (range.empty()) + return 0; + else + return range.front(); + } + + infra::ConstByteRange BufferingStreamReader::ExtractContiguousRange(std::size_t max) + { + if (index < buffer.size()) + { + auto from = infra::Head(buffer.contiguous_range(buffer.begin() + index), max); + index += from.size(); + return from; + } + + auto result = input.ExtractContiguousRange(max); + index += result.size(); + return result; + } + + infra::ConstByteRange BufferingStreamReader::PeekContiguousRange(std::size_t start) + { + if (index + start < buffer.size()) + return buffer.contiguous_range(buffer.begin() + index + start); + + return input.PeekContiguousRange(index + start - buffer.size()); + } + + bool BufferingStreamReader::Empty() const + { + return Available() == 0; + } + + std::size_t BufferingStreamReader::Available() const + { + return buffer.size() + input.Available(); + } + + std::size_t BufferingStreamReader::ConstructSaveMarker() const + { + return index; + } + + void BufferingStreamReader::Rewind(std::size_t marker) + { + if (index > buffer.size()) + { + auto rewindAmount = std::min(index - marker, index - buffer.size()); + input.Rewind(input.ConstructSaveMarker() - rewindAmount); + index -= rewindAmount; + } + + if (marker < buffer.size()) + index = marker; + } + + void BufferingStreamReader::Read(infra::ConstByteRange from, infra::ByteRange& to) + { + infra::Copy(from, infra::Head(to, from.size())); + to.pop_front(from.size()); + index += from.size(); + } + + void BufferingStreamReader::StoreRemainder() + { + std::size_t bufferDecrease = std::min(buffer.size(), index); + buffer.erase(buffer.begin(), buffer.begin() + bufferDecrease); + while (!input.Empty()) + { + auto range = input.ExtractContiguousRange(std::numeric_limits::max()); + buffer.insert(buffer.end(), range.begin(), range.end()); + } + } +} diff --git a/infra/stream/BufferingStreamReader.hpp b/infra/stream/BufferingStreamReader.hpp new file mode 100644 index 000000000..3df25964f --- /dev/null +++ b/infra/stream/BufferingStreamReader.hpp @@ -0,0 +1,39 @@ +#ifndef INFRA_BUFFERING_STREAM_READER_HPP +#define INFRA_BUFFERING_STREAM_READER_HPP + +#include "infra/stream/InputStream.hpp" +#include "infra/util/BoundedDeque.hpp" + +namespace infra +{ + // Usage: Everything that is not read from the inputData is stored into the buffer upon destruction of the BufferingStreamReader + // Any data already present in the buffer is read first from the reader + class BufferingStreamReader + : public infra::StreamReaderWithRewinding + { + public: + BufferingStreamReader(infra::BoundedDeque& buffer, infra::StreamReaderWithRewinding& input); + ~BufferingStreamReader() override; + + // Implementation of StreamReaderWithRewinding + void Extract(infra::ByteRange range, infra::StreamErrorPolicy& errorPolicy) override; + uint8_t Peek(infra::StreamErrorPolicy& errorPolicy) override; + infra::ConstByteRange ExtractContiguousRange(std::size_t max) override; + infra::ConstByteRange PeekContiguousRange(std::size_t start) override; + bool Empty() const override; + std::size_t Available() const override; + std::size_t ConstructSaveMarker() const override; + void Rewind(std::size_t marker) override; + + private: + void Read(infra::ConstByteRange range, infra::ByteRange& to); + void StoreRemainder(); + + private: + infra::BoundedDeque& buffer; + infra::StreamReaderWithRewinding& input; + std::size_t index = 0; + }; +} + +#endif diff --git a/infra/stream/BufferingStreamWriter.cpp b/infra/stream/BufferingStreamWriter.cpp new file mode 100644 index 000000000..c66445491 --- /dev/null +++ b/infra/stream/BufferingStreamWriter.cpp @@ -0,0 +1,65 @@ +#include "infra/stream/BufferingStreamWriter.hpp" + +namespace infra +{ + BufferingStreamWriter::BufferingStreamWriter(infra::BoundedDeque& buffer, infra::StreamWriter& output) + : buffer(buffer) + , output(output) + { + LoadRemainder(); + } + + void BufferingStreamWriter::Insert(infra::ConstByteRange range, infra::StreamErrorPolicy& errorPolicy) + { + auto first = infra::Head(range, output.Available()); + output.Insert(first, errorPolicy); + index += first.size(); + range.pop_front(first.size()); + + buffer.insert(buffer.end(), range.begin(), range.end()); + index += range.size(); + } + + std::size_t BufferingStreamWriter::Available() const + { + return output.Available() + buffer.max_size() - buffer.size(); + } + + std::size_t BufferingStreamWriter::ConstructSaveMarker() const + { + return index; + } + + std::size_t BufferingStreamWriter::GetProcessedBytesSince(std::size_t marker) const + { + return index - marker; + } + + [[noreturn]] infra::ByteRange BufferingStreamWriter::SaveState(std::size_t marker) + { + std::abort(); + } + + [[noreturn]] void BufferingStreamWriter::RestoreState(infra::ByteRange range) + { + std::abort(); + } + + [[noreturn]] infra::ByteRange BufferingStreamWriter::Overwrite(std::size_t marker) + { + std::abort(); + } + + void BufferingStreamWriter::LoadRemainder() + { + infra::StreamErrorPolicy errorPolicy; + auto from = infra::Head(buffer.contiguous_range(buffer.begin()), output.Available()); + output.Insert(from, errorPolicy); + buffer.erase(buffer.begin(), buffer.begin() + from.size()); + from = infra::Head(buffer.contiguous_range(buffer.begin()), output.Available()); + output.Insert(from, errorPolicy); + buffer.erase(buffer.begin(), buffer.begin() + from.size()); + + index = buffer.size(); + } +} diff --git a/infra/stream/BufferingStreamWriter.hpp b/infra/stream/BufferingStreamWriter.hpp new file mode 100644 index 000000000..79f2d4216 --- /dev/null +++ b/infra/stream/BufferingStreamWriter.hpp @@ -0,0 +1,36 @@ +#ifndef INFRA_BUFFERING_STREAM_WRITER_HPP +#define INFRA_BUFFERING_STREAM_WRITER_HPP + +#include "infra/stream/OutputStream.hpp" +#include "infra/util/BoundedDeque.hpp" + +namespace infra +{ + // Usage: Any data that does not fit into the output stream is written to the buffer + // Any data already present in the buffer is written to the output stream upon construction of BufferingStreamWriter + class BufferingStreamWriter + : public infra::StreamWriter + { + public: + BufferingStreamWriter(infra::BoundedDeque& buffer, infra::StreamWriter& output); + + // Implementation of StreamWriter + void Insert(infra::ConstByteRange range, infra::StreamErrorPolicy& errorPolicy) override; + std::size_t Available() const override; + std::size_t ConstructSaveMarker() const override; + std::size_t GetProcessedBytesSince(std::size_t marker) const override; + [[noreturn]] infra::ByteRange SaveState(std::size_t marker) override; + [[noreturn]] void RestoreState(infra::ByteRange range) override; + [[noreturn]] infra::ByteRange Overwrite(std::size_t marker) override; + + private: + void LoadRemainder(); + + private: + infra::BoundedDeque& buffer; + infra::StreamWriter& output; + std::size_t index = 0; + }; +} + +#endif diff --git a/infra/stream/CMakeLists.txt b/infra/stream/CMakeLists.txt index eab26fd3f..4b3537a71 100644 --- a/infra/stream/CMakeLists.txt +++ b/infra/stream/CMakeLists.txt @@ -13,6 +13,10 @@ target_sources(infra.stream PRIVATE BoundedVectorInputStream.hpp BoundedVectorOutputStream.cpp BoundedVectorOutputStream.hpp + BufferingStreamReader.cpp + BufferingStreamReader.hpp + BufferingStreamWriter.cpp + BufferingStreamWriter.hpp ByteInputStream.cpp ByteInputStream.hpp ByteOutputStream.cpp diff --git a/infra/stream/CountingOutputStream.cpp b/infra/stream/CountingOutputStream.cpp index befd5208f..95a46a230 100644 --- a/infra/stream/CountingOutputStream.cpp +++ b/infra/stream/CountingOutputStream.cpp @@ -2,6 +2,10 @@ namespace infra { + CountingStreamWriter::CountingStreamWriter(infra::ByteRange saveStateStorage) + : saveStateStorage(saveStateStorage) + {} + std::size_t CountingStreamWriter::Processed() const { return processed; @@ -24,16 +28,18 @@ namespace infra std::size_t CountingStreamWriter::GetProcessedBytesSince(std::size_t marker) const { - return marker - processed; + return processed - marker; } infra::ByteRange CountingStreamWriter::SaveState(std::size_t marker) { - return infra::ByteRange(); + return saveStateStorage; } void CountingStreamWriter::RestoreState(infra::ByteRange range) - {} + { + processed += saveStateStorage.size() - range.size(); + } infra::ByteRange CountingStreamWriter::Overwrite(std::size_t marker) { diff --git a/infra/stream/CountingOutputStream.hpp b/infra/stream/CountingOutputStream.hpp index 781802eb4..69c09c974 100644 --- a/infra/stream/CountingOutputStream.hpp +++ b/infra/stream/CountingOutputStream.hpp @@ -9,6 +9,8 @@ namespace infra : public StreamWriter { public: + explicit CountingStreamWriter(infra::ByteRange saveStateStorage = {}); + std::size_t Processed() const; void Insert(ConstByteRange range, StreamErrorPolicy& errorPolicy) override; @@ -20,6 +22,7 @@ namespace infra infra::ByteRange Overwrite(std::size_t marker) override; private: + infra::ByteRange saveStateStorage; std::size_t processed = 0; }; } diff --git a/infra/stream/LimitedInputStream.cpp b/infra/stream/LimitedInputStream.cpp index 3fe3bba94..dd0f6cb56 100644 --- a/infra/stream/LimitedInputStream.cpp +++ b/infra/stream/LimitedInputStream.cpp @@ -58,7 +58,7 @@ namespace infra } LimitedStreamReaderWithRewinding::LimitedStreamReaderWithRewinding(StreamReaderWithRewinding& input, uint32_t length) - : input(input) + : input(&input) , length(length) {} @@ -72,12 +72,22 @@ namespace infra length = newLength; } + bool LimitedStreamReaderWithRewinding::LimitReached() const + { + return length == 0; + } + + void LimitedStreamReaderWithRewinding::SwitchInput(StreamReaderWithRewinding& newInput) + { + this->input = &newInput; + } + void LimitedStreamReaderWithRewinding::Extract(ByteRange range, StreamErrorPolicy& errorPolicy) { errorPolicy.ReportResult(length >= range.size()); range.shrink_from_back_to(length); length -= range.size(); - input.Extract(range, errorPolicy); + input->Extract(range, errorPolicy); } uint8_t LimitedStreamReaderWithRewinding::Peek(StreamErrorPolicy& errorPolicy) @@ -85,42 +95,42 @@ namespace infra errorPolicy.ReportResult(length != 0); if (length != 0) - return input.Peek(errorPolicy); + return input->Peek(errorPolicy); else return 0; } ConstByteRange LimitedStreamReaderWithRewinding::ExtractContiguousRange(std::size_t max) { - ConstByteRange result = input.ExtractContiguousRange(std::min(length, max)); + ConstByteRange result = input->ExtractContiguousRange(std::min(length, max)); length -= result.size(); return result; } ConstByteRange infra::LimitedStreamReaderWithRewinding::PeekContiguousRange(std::size_t start) { - return input.PeekContiguousRange(start); + return input->PeekContiguousRange(start); } bool LimitedStreamReaderWithRewinding::Empty() const { - return length == 0 || input.Empty(); + return length == 0 || input->Empty(); } std::size_t LimitedStreamReaderWithRewinding::Available() const { - return std::min(length, input.Available()); + return std::min(length, input->Available()); } std::size_t LimitedStreamReaderWithRewinding::ConstructSaveMarker() const { - return input.ConstructSaveMarker(); + return input->ConstructSaveMarker(); } void LimitedStreamReaderWithRewinding::Rewind(std::size_t marker) { - auto now = input.ConstructSaveMarker(); - input.Rewind(marker); + auto now = input->ConstructSaveMarker(); + input->Rewind(marker); length += now - marker; } diff --git a/infra/stream/LimitedInputStream.hpp b/infra/stream/LimitedInputStream.hpp index 2a170b6cf..66e6ecf77 100644 --- a/infra/stream/LimitedInputStream.hpp +++ b/infra/stream/LimitedInputStream.hpp @@ -44,6 +44,8 @@ namespace infra ~LimitedStreamReaderWithRewinding() = default; void ResetLength(uint32_t newLength); + bool LimitReached() const; + void SwitchInput(StreamReaderWithRewinding& newInput); public: void Extract(ByteRange range, StreamErrorPolicy& errorPolicy) override; @@ -56,7 +58,7 @@ namespace infra void Rewind(std::size_t marker) override; private: - StreamReaderWithRewinding& input; + StreamReaderWithRewinding* input; uint32_t length; }; diff --git a/infra/stream/OutputStream.hpp b/infra/stream/OutputStream.hpp index a0fe2702f..ed15456f1 100644 --- a/infra/stream/OutputStream.hpp +++ b/infra/stream/OutputStream.hpp @@ -27,6 +27,11 @@ namespace infra virtual void Insert(ConstByteRange range, StreamErrorPolicy& errorPolicy) = 0; virtual std::size_t Available() const = 0; + bool Empty() const + { + return Available() == 0; + } + virtual std::size_t ConstructSaveMarker() const; virtual std::size_t GetProcessedBytesSince(std::size_t marker) const; virtual infra::ByteRange SaveState(std::size_t marker); diff --git a/infra/stream/test/CMakeLists.txt b/infra/stream/test/CMakeLists.txt index 957be3ce4..5f41d2420 100644 --- a/infra/stream/test/CMakeLists.txt +++ b/infra/stream/test/CMakeLists.txt @@ -12,9 +12,12 @@ target_sources(infra.stream_test PRIVATE StreamMock.hpp TestBoundedDequeInputStream.cpp TestBoundedVectorOutputStream.cpp + TestBufferingStreamReader.cpp + TestBufferingStreamWriter.cpp TestByteInputStream.cpp TestByteOutputStream.cpp TestCountingInputStream.cpp + TestCountingOutputStream.cpp TestFormatter.cpp TestLimitedInputStream.cpp TestLimitedOutputStream.cpp diff --git a/infra/stream/test/TestBufferingStreamReader.cpp b/infra/stream/test/TestBufferingStreamReader.cpp new file mode 100644 index 000000000..1d58c3b79 --- /dev/null +++ b/infra/stream/test/TestBufferingStreamReader.cpp @@ -0,0 +1,206 @@ +#include "infra/stream/BufferingStreamReader.hpp" +#include "infra/stream/test/StreamMock.hpp" +#include "gmock/gmock.h" + +class BufferingStreamReaderTest + : public testing::Test +{ +public: + ~BufferingStreamReaderTest() + { + EXPECT_CALL(input, Empty()).WillOnce(testing::Return(true)); + } + + void Extract(std::size_t amount) + { + std::vector data(amount, 0); + std::vector inputData; + EXPECT_CALL(input, ExtractContiguousRange(testing::_)).Times(testing::AnyNumber()).WillRepeatedly(testing::Invoke([&](std::size_t max) + { + inputData.resize(max); + return infra::MakeRange(inputData); + })); + reader.Extract(infra::MakeRange(data), errorPolicy); + } + + void ExpectBuffer(const std::vector contents) + { + EXPECT_EQ(infra::BoundedDeque::WithMaxSize<100>(contents.begin(), contents.end()), buffer); + } + + infra::BoundedDeque::WithMaxSize<4> buffer{ std::initializer_list{ 1, 2 } }; + testing::StrictMock input; + infra::StreamErrorPolicy errorPolicy{ infra::noFail }; + infra::BufferingStreamReader reader{ buffer, input }; +}; + +TEST_F(BufferingStreamReaderTest, Extract_from_empty_buffer) +{ + buffer.clear(); + std::array data; + EXPECT_CALL(input, ExtractContiguousRange(2)).WillOnce(testing::Return(infra::ConstByteRange())); + reader.Extract(data, errorPolicy); + EXPECT_TRUE(errorPolicy.Failed()); +} + +TEST_F(BufferingStreamReaderTest, Extract_from_buffer) +{ + std::array data; + reader.Extract(data, errorPolicy); + EXPECT_EQ((std::array{ 1, 2 }), data); + EXPECT_FALSE(errorPolicy.Failed()); +} + +TEST_F(BufferingStreamReaderTest, Extract_from_wrapped_buffer) +{ + buffer.push_back(3); + buffer.push_back(4); + buffer.pop_front(); + buffer.pop_front(); + buffer.push_back(5); + buffer.push_back(6); + + std::array data; + reader.Extract(data, errorPolicy); + EXPECT_EQ((std::array{ 3, 4, 5, 6 }), data); +} + +TEST_F(BufferingStreamReaderTest, Extract_from_buffer_and_input) +{ + std::array data; + std::array inputData{ 3, 4 }; + EXPECT_CALL(input, ExtractContiguousRange(2)).WillOnce(testing::Invoke([&](std::size_t max) + { + return infra::MakeRange(inputData); + })); + reader.Extract(data, errorPolicy); + EXPECT_EQ((std::array{ 1, 2, 3, 4 }), data); +} + +TEST_F(BufferingStreamReaderTest, PeekContiguous_range_from_buffer_head) +{ + EXPECT_EQ((std::array{ 1, 2 }), reader.PeekContiguousRange(0)); +} + +TEST_F(BufferingStreamReaderTest, PeekContiguous_range_from_buffer_1) +{ + EXPECT_EQ((std::array{ 2 }), reader.PeekContiguousRange(1)); +} + +TEST_F(BufferingStreamReaderTest, PeekContiguous_range_from_input) +{ + std::array inputData{ 3, 4 }; + EXPECT_CALL(input, PeekContiguousRange(0)).WillOnce(testing::Invoke([&](std::size_t start) + { + return infra::MakeRange(inputData); + })); + EXPECT_EQ((std::array{ 3, 4 }), reader.PeekContiguousRange(2)); +} + +TEST_F(BufferingStreamReaderTest, Peek_from_buffer) +{ + EXPECT_EQ(1, reader.Peek(errorPolicy)); + reader.ExtractContiguousRange(2); + + std::array inputData{ 3, 4 }; + EXPECT_CALL(input, PeekContiguousRange(0)).WillOnce(testing::Invoke([&](std::size_t start) + { + return infra::MakeRange(inputData); + })); + EXPECT_EQ(3, reader.Peek(errorPolicy)); +} + +TEST_F(BufferingStreamReaderTest, Available) +{ + EXPECT_CALL(input, Available()).WillOnce(testing::Return(1)); + EXPECT_EQ(3, reader.Available()); + + EXPECT_CALL(input, Available()).WillOnce(testing::Return(1)); + EXPECT_FALSE(reader.Empty()); +} + +TEST_F(BufferingStreamReaderTest, ConstructSaveMarker) +{ + EXPECT_EQ(0, reader.ConstructSaveMarker()); + + reader.ExtractContiguousRange(2); + EXPECT_EQ(2, reader.ConstructSaveMarker()); +} + +TEST_F(BufferingStreamReaderTest, Rewind_in_buffer) +{ + reader.ExtractContiguousRange(2); + reader.Rewind(1); + EXPECT_EQ(2, reader.Peek(errorPolicy)); +} + +TEST_F(BufferingStreamReaderTest, Rewind_from_input_to_input) +{ + Extract(4); + + EXPECT_CALL(input, ConstructSaveMarker()).WillOnce(testing::Return(100)); + EXPECT_CALL(input, Rewind(99)); + reader.Rewind(3); + std::array inputData2{ 4 }; + EXPECT_CALL(input, PeekContiguousRange(1)).WillOnce(testing::Invoke([&](std::size_t start) + { + return infra::MakeRange(inputData2); + })); + EXPECT_EQ(4, reader.Peek(errorPolicy)); +} + +TEST_F(BufferingStreamReaderTest, Rewind_from_input_to_buffer) +{ + Extract(4); + + EXPECT_CALL(input, ConstructSaveMarker()).WillOnce(testing::Return(100)); + EXPECT_CALL(input, Rewind(98)); + reader.Rewind(1); + EXPECT_EQ(2, reader.Peek(errorPolicy)); +} + +TEST_F(BufferingStreamReaderTest, destruction_reduces_buffer) +{ + Extract(1); + + EXPECT_CALL(input, Empty()).WillOnce(testing::Return(true)); + infra::ReConstruct(reader, buffer, input); + + ExpectBuffer({ 2 }); +} + +TEST_F(BufferingStreamReaderTest, destruction_consumes_buffer) +{ + Extract(3); + + EXPECT_CALL(input, Empty()).WillOnce(testing::Return(true)); + infra::ReConstruct(reader, buffer, input); + + ExpectBuffer({}); +} + +TEST_F(BufferingStreamReaderTest, destruction_stores_input) +{ + EXPECT_CALL(input, Empty()).WillOnce(testing::Return(false)).WillOnce(testing::Return(true)); + std::array inputData{ 3, 4 }; + EXPECT_CALL(input, ExtractContiguousRange(std::numeric_limits::max())).WillOnce(testing::Invoke([&](std::size_t max) + { + return infra::MakeRange(inputData); + })); + infra::ReConstruct(reader, buffer, input); + + ExpectBuffer({ 1, 2, 3, 4 }); +} + +TEST_F(BufferingStreamReaderTest, destruction_stores_input_until_empty) +{ + EXPECT_CALL(input, Empty()).WillOnce(testing::Return(false)).WillOnce(testing::Return(false)).WillOnce(testing::Return(true)); + std::array inputData{ 3 }; + EXPECT_CALL(input, ExtractContiguousRange(std::numeric_limits::max())).WillRepeatedly(testing::Invoke([&](std::size_t max) + { + return infra::MakeRange(inputData); + })); + infra::ReConstruct(reader, buffer, input); + + ExpectBuffer({ 1, 2, 3, 3 }); +} diff --git a/infra/stream/test/TestBufferingStreamWriter.cpp b/infra/stream/test/TestBufferingStreamWriter.cpp new file mode 100644 index 000000000..2bb6db290 --- /dev/null +++ b/infra/stream/test/TestBufferingStreamWriter.cpp @@ -0,0 +1,103 @@ +#include "infra/stream/BufferingStreamWriter.hpp" +#include "infra/stream/test/StreamMock.hpp" +#include "infra/util/test_helper/MemoryRangeMatcher.hpp" +#include "gmock/gmock.h" + +class BufferingStreamWriterTest + : public testing::Test +{ +public: + void ExpectBuffer(const std::vector contents) + { + EXPECT_EQ(infra::BoundedDeque::WithMaxSize<100>(contents.begin(), contents.end()), buffer); + } + + infra::BoundedDeque::WithMaxSize<4> buffer; + testing::StrictMock output; + infra::StreamErrorPolicy errorPolicy{ infra::noFail }; + infra::Execute execute{ [this]() + { + EXPECT_CALL(output, Available()).WillRepeatedly(testing::Return(0)); + EXPECT_CALL(output, Insert(testing::_, testing::_)).Times(2); + } }; + infra::BufferingStreamWriter writer{ buffer, output }; +}; + +TEST_F(BufferingStreamWriterTest, Insert_into_output) +{ + std::array data{ 3, 4 }; + EXPECT_CALL(output, Available()).WillOnce(testing::Return(10)); + EXPECT_CALL(output, Insert(infra::ContentsEqual(data), testing::Ref(errorPolicy))); + writer.Insert(data, errorPolicy); + + ExpectBuffer({}); + EXPECT_EQ(2, writer.ConstructSaveMarker()); +} + +TEST_F(BufferingStreamWriterTest, Insert_overflows_output) +{ + std::array data{ 3, 4 }; + EXPECT_CALL(output, Available()).WillOnce(testing::Return(1)); + EXPECT_CALL(output, Insert(infra::ByteRangeContentsEqual(infra::Head(infra::MakeRange(data), 1)), testing::Ref(errorPolicy))); + writer.Insert(data, errorPolicy); + + ExpectBuffer({ 4 }); + EXPECT_EQ(2, writer.ConstructSaveMarker()); +} + +TEST_F(BufferingStreamWriterTest, GetProcessedBytesSince) +{ + EXPECT_EQ(0, writer.GetProcessedBytesSince(0)); + + std::array data{ 3, 4 }; + EXPECT_CALL(output, Available()).WillOnce(testing::Return(10)); + EXPECT_CALL(output, Insert(infra::ContentsEqual(data), testing::Ref(errorPolicy))); + writer.Insert(data, errorPolicy); + + EXPECT_EQ(2, writer.GetProcessedBytesSince(0)); + EXPECT_EQ(1, writer.GetProcessedBytesSince(1)); +} + +TEST_F(BufferingStreamWriterTest, LoadRemainder_loads_from_buffer) +{ + std::array data{ 1, 2 }; + buffer.insert(buffer.end(), data.begin(), data.end()); + + EXPECT_CALL(output, Available()).WillOnce(testing::Return(2)).WillOnce(testing::Return(0)); + EXPECT_CALL(output, Insert(infra::ContentsEqual(data), testing::_)); + EXPECT_CALL(output, Insert(infra::ByteRangeContentsEqual(infra::ConstByteRange()), testing::_)); + infra::ReConstruct(writer, buffer, output); +} + +TEST_F(BufferingStreamWriterTest, LoadRemainder_loads_from_circular_buffer) +{ + std::array data1{ 1, 2 }; + std::array data2{ 3, 4 }; + std::array data3{ 5, 6 }; + buffer.insert(buffer.end(), data1.begin(), data1.end()); + buffer.insert(buffer.end(), data2.begin(), data2.end()); + buffer.pop_front(); + buffer.pop_front(); + buffer.insert(buffer.end(), data3.begin(), data3.end()); + + EXPECT_CALL(output, Available()).WillOnce(testing::Return(4)).WillOnce(testing::Return(2)); + EXPECT_CALL(output, Insert(infra::ContentsEqual(data2), testing::_)); + EXPECT_CALL(output, Insert(infra::ContentsEqual(data3), testing::_)); + infra::ReConstruct(writer, buffer, output); +} + +TEST_F(BufferingStreamWriterTest, LoadRemainder_constrained_by_output_writes_in_chunks) +{ + std::array data{ 1, 2 }; + buffer.insert(buffer.end(), data.begin(), data.end()); + + EXPECT_CALL(output, Available()).WillOnce(testing::Return(1)).WillOnce(testing::Return(0)); + EXPECT_CALL(output, Insert(infra::ByteRangeContentsEqual(infra::Head(infra::MakeRange(data), 1)), testing::_)); + EXPECT_CALL(output, Insert(infra::ByteRangeContentsEqual(infra::ConstByteRange()), testing::_)); + infra::ReConstruct(writer, buffer, output); + + EXPECT_CALL(output, Available()).WillOnce(testing::Return(1)).WillOnce(testing::Return(0)); + EXPECT_CALL(output, Insert(infra::ByteRangeContentsEqual(infra::DiscardHead(infra::MakeRange(data), 1)), testing::_)); + EXPECT_CALL(output, Insert(infra::ByteRangeContentsEqual(infra::ConstByteRange()), testing::_)); + infra::ReConstruct(writer, buffer, output); +} diff --git a/infra/stream/test/TestCountingOutputStream.cpp b/infra/stream/test/TestCountingOutputStream.cpp new file mode 100644 index 000000000..b37cfcdbd --- /dev/null +++ b/infra/stream/test/TestCountingOutputStream.cpp @@ -0,0 +1,30 @@ +#include "infra/stream/CountingOutputStream.hpp" +#include "gmock/gmock.h" + +TEST(CountingOutputStreamTest, Insert) +{ + infra::CountingStreamWriter writer; + infra::StreamErrorPolicy errorPolicy; + + std::array data; + writer.Insert(data, errorPolicy); + EXPECT_EQ(4, writer.Processed()); + EXPECT_EQ(std::numeric_limits::max(), writer.Available()); +} + +TEST(CountingOutputStreamTest, save_and_restore) +{ + std::array saveStateStorage; + infra::CountingStreamWriter writer(saveStateStorage); + infra::StreamErrorPolicy errorPolicy; + + std::array data; + writer.Insert(data, errorPolicy); + + EXPECT_EQ(4, writer.ConstructSaveMarker()); + EXPECT_EQ(infra::MakeRange(saveStateStorage), writer.SaveState(4)); + writer.Insert(infra::Head(infra::MakeRange(data), 3), errorPolicy); + EXPECT_EQ(3, writer.GetProcessedBytesSince(4)); + writer.RestoreState(infra::Tail(infra::MakeRange(saveStateStorage), 1)); // Restore 1 out of the 6 bytes + EXPECT_EQ(4 + 3 + 5, writer.Processed()); +} diff --git a/infra/syntax/ProtoFormatter.cpp b/infra/syntax/ProtoFormatter.cpp index efb630d04..7b3e9d99a 100644 --- a/infra/syntax/ProtoFormatter.cpp +++ b/infra/syntax/ProtoFormatter.cpp @@ -130,6 +130,12 @@ namespace infra PutBytes(bytes); } + void ProtoFormatter::PutLengthDelimitedSize(std::size_t size, uint32_t fieldNumber) + { + PutVarInt((fieldNumber << 3) | 2); + PutVarInt(size); + } + ProtoLengthDelimitedFormatter ProtoFormatter::LengthDelimitedFormatter(uint32_t fieldNumber) { return ProtoLengthDelimitedFormatter(*this, fieldNumber); diff --git a/infra/syntax/ProtoFormatter.hpp b/infra/syntax/ProtoFormatter.hpp index 45748075b..7c717ce3c 100644 --- a/infra/syntax/ProtoFormatter.hpp +++ b/infra/syntax/ProtoFormatter.hpp @@ -14,6 +14,7 @@ namespace infra { public: ProtoLengthDelimitedFormatter(ProtoFormatter& formatter, uint32_t fieldNumber); + ProtoLengthDelimitedFormatter(ProtoFormatter& formatter, uint32_t fieldNumber, std::size_t size); ProtoLengthDelimitedFormatter(const ProtoLengthDelimitedFormatter& other) = delete; ProtoLengthDelimitedFormatter(ProtoLengthDelimitedFormatter&& other) noexcept; ProtoLengthDelimitedFormatter& operator=(const ProtoLengthDelimitedFormatter& other) = delete; @@ -43,6 +44,7 @@ namespace infra void PutLengthDelimitedField(infra::ConstByteRange range, uint32_t fieldNumber); void PutStringField(infra::BoundedConstString string, uint32_t fieldNumber); void PutBytesField(infra::ConstByteRange bytes, uint32_t fieldNumber); + void PutLengthDelimitedSize(std::size_t size, uint32_t fieldNumber); ProtoLengthDelimitedFormatter LengthDelimitedFormatter(uint32_t fieldNumber); private: diff --git a/infra/syntax/ProtoParser.cpp b/infra/syntax/ProtoParser.cpp index 513ebf7a6..445b84466 100644 --- a/infra/syntax/ProtoParser.cpp +++ b/infra/syntax/ProtoParser.cpp @@ -90,6 +90,7 @@ namespace infra uint64_t result = 0; uint8_t byte = 0; uint8_t shift = 0; + uint8_t index = 0; do { @@ -97,7 +98,11 @@ namespace infra result += static_cast(byte & 0x7f) << shift; shift += 7; - } while (!input.Failed() && (byte & 0x80) != 0); + ++index; + } while (!input.Failed() && (byte & 0x80) != 0 && index != 10); + + if (!input.Failed() && (byte & 0x80) != 0 && index == 10) + formatErrorPolicy.Failed(); return result; } @@ -116,7 +121,40 @@ namespace infra return result; } + struct MakeFullField + : infra::StaticVisitor + { + MakeFullField(infra::DataInputStream inputStream, infra::StreamErrorPolicy& formatErrorPolicy, uint32_t fieldNumber) + : inputStream(inputStream) + , formatErrorPolicy(formatErrorPolicy) + , fieldNumber(fieldNumber) + {} + + template + ProtoParser::Field operator()(T value) const + { + return { value, fieldNumber }; + } + + ProtoParser::Field operator()(PartialProtoLengthDelimited value) const + { + return { ProtoLengthDelimited(inputStream, formatErrorPolicy, value.length), fieldNumber }; + } + + private: + infra::DataInputStream inputStream; + infra::StreamErrorPolicy& formatErrorPolicy; + uint32_t fieldNumber; + }; + ProtoParser::Field ProtoParser::GetField() + { + auto [value, fieldNumber] = GetPartialField(); + MakeFullField visitor(input, formatErrorPolicy, fieldNumber); + return infra::ApplyVisitor(visitor, value); + } + + ProtoParser::PartialField ProtoParser::GetPartialField() { uint32_t x = static_cast(GetVarInt()); uint8_t type = x & 7; @@ -129,7 +167,7 @@ namespace infra case 1: return std::make_pair(GetFixed64(), fieldNumber); case 2: - return std::make_pair(ProtoLengthDelimited(input, formatErrorPolicy, static_cast(GetVarInt())), fieldNumber); + return std::make_pair(PartialProtoLengthDelimited{ static_cast(GetVarInt()) }, fieldNumber); case 5: return std::make_pair(GetFixed32(), fieldNumber); default: diff --git a/infra/syntax/ProtoParser.hpp b/infra/syntax/ProtoParser.hpp index 3cb6d8306..652041edc 100644 --- a/infra/syntax/ProtoParser.hpp +++ b/infra/syntax/ProtoParser.hpp @@ -34,10 +34,18 @@ namespace infra infra::StreamErrorPolicy& formatErrorPolicy; }; + struct PartialProtoLengthDelimited + { + uint32_t length; + }; + class ProtoParser { public: - using Field = std::pair, uint32_t>; + using FieldVariant = infra::Variant; + using Field = std::pair; + using PartialFieldVariant = infra::Variant; + using PartialField = std::pair; explicit ProtoParser(infra::DataInputStream inputStream); ProtoParser(infra::DataInputStream inputStream, infra::StreamErrorPolicy& formatErrorPolicy); @@ -48,6 +56,7 @@ namespace infra uint64_t GetFixed64(); Field GetField(); + PartialField GetPartialField(); void ReportFormatResult(bool ok); bool FormatFailed() const; diff --git a/infra/syntax/test/TestProtoFormatter.cpp b/infra/syntax/test/TestProtoFormatter.cpp index 6b34a148a..e42384893 100644 --- a/infra/syntax/test/TestProtoFormatter.cpp +++ b/infra/syntax/test/TestProtoFormatter.cpp @@ -76,6 +76,17 @@ TEST(ProtoFormatterTest, PutBytesField) EXPECT_EQ((std::array{ 4 << 3 | 2, 1, 5 }), stream.Writer().Processed()); } +TEST(ProtoFormatterTest, PutSubObjectOfKnownSize) +{ + infra::ByteOutputStream::WithStorage<20> stream; + infra::ProtoFormatter formatter(stream); + + formatter.PutLengthDelimitedSize(2, 4); + formatter.PutVarIntField(2, 4); + + EXPECT_EQ((std::array{ 4 << 3 | 2, 2, 4 << 3, 2 }), stream.Writer().Processed()); +} + TEST(ProtoFormatterTest, PutSubObject) { infra::ByteOutputStream::WithStorage<20> stream; diff --git a/infra/util/BoundedVector.hpp b/infra/util/BoundedVector.hpp index 109cf119f..1d3f534c0 100644 --- a/infra/util/BoundedVector.hpp +++ b/infra/util/BoundedVector.hpp @@ -492,12 +492,7 @@ namespace infra { really_assert(size() + n <= max_size()); move_up(position, n); - - for (size_type i = 0; i != n; ++i) - { - *position = value; - ++position; - } + std::fill_n(position, n, value); } template @@ -508,13 +503,7 @@ namespace infra really_assert(size() + n <= max_size()); move_up(position, n); - - while (first != last) - { - *position = *first; - ++position; - ++first; - } + std::copy(first, last, position); } template diff --git a/infra/util/CMakeLists.txt b/infra/util/CMakeLists.txt index adf3e3df7..8d7a032db 100644 --- a/infra/util/CMakeLists.txt +++ b/infra/util/CMakeLists.txt @@ -51,6 +51,7 @@ target_sources(infra.util PRIVATE IntrusiveSet.hpp IntrusiveUnorderedSet.hpp MemoryRange.hpp + MultiFunction.hpp Observer.hpp Optional.cpp Optional.hpp diff --git a/infra/util/ConstructBin.cpp b/infra/util/ConstructBin.cpp index ce30b8fff..001ae1dce 100644 --- a/infra/util/ConstructBin.cpp +++ b/infra/util/ConstructBin.cpp @@ -32,6 +32,13 @@ namespace infra return *this; } + ConstructBin& ConstructBin::Repeat(std::size_t amount, std::initializer_list v) + { + for (size_t i = 0; i != amount; ++i) + contents.insert(contents.end(), v.begin(), v.end()); + return *this; + } + ConstructBin& ConstructBin::RepeatString(std::size_t amount, const std::string& v) { for (size_t i = 0; i != amount; ++i) diff --git a/infra/util/ConstructBin.hpp b/infra/util/ConstructBin.hpp index ba514fd4e..83631f5c4 100644 --- a/infra/util/ConstructBin.hpp +++ b/infra/util/ConstructBin.hpp @@ -17,6 +17,7 @@ namespace infra ConstructBin& operator()(std::initializer_list v); ConstructBin& Repeat(std::size_t amount, uint8_t v); + ConstructBin& Repeat(std::size_t amount, std::initializer_list v); ConstructBin& RepeatString(std::size_t amount, const std::string& v); template diff --git a/infra/util/Function.hpp b/infra/util/Function.hpp index 70a008b1c..db8486bd5 100644 --- a/infra/util/Function.hpp +++ b/infra/util/Function.hpp @@ -488,7 +488,7 @@ namespace infra {} template - ExecuteOnDestruction::WithExtraSize::~WithExtraSize() + ExecuteOnDestruction::WithExtraSize::~WithExtraSize() { f(); } diff --git a/infra/util/MultiFunction.hpp b/infra/util/MultiFunction.hpp index 59549d22d..64b3937e7 100644 --- a/infra/util/MultiFunction.hpp +++ b/infra/util/MultiFunction.hpp @@ -23,7 +23,9 @@ namespace infra using And = MultiFunctionHelper>; MultiFunctionHelper() = default; - MultiFunctionHelper(std::nullptr_t) {} + + MultiFunctionHelper(std::nullptr_t) + {} template struct IndexOf @@ -86,12 +88,15 @@ namespace infra } template - bool Invocable(EMIL_MAYBE_UNUSED Args&&...args) + bool Invocable(EMIL_MAYBE_UNUSED Args&&... args) { return functions.Which() == IndexOf::Value + 1; } - explicit operator bool() const { return functions.Which() != 0; } + explicit operator bool() const + { + return functions.Which() != 0; + } bool operator==(const std::nullptr_t) const { diff --git a/infra/util/WithStorage.hpp b/infra/util/WithStorage.hpp index 52f78eb9e..1b199ef7a 100644 --- a/infra/util/WithStorage.hpp +++ b/infra/util/WithStorage.hpp @@ -26,6 +26,8 @@ namespace infra WithStorage(); template WithStorage(InPlace, StorageArg&& storageArg, Args&&... args); + template + WithStorage(InPlace, std::initializer_list initializerList); template WithStorage(Arg&& arg, std::enable_if_t>>, std::nullptr_t> = nullptr); template @@ -89,6 +91,13 @@ namespace infra , Base(detail::StorageHolder::storage, std::forward(args)...) {} + template + template + WithStorage::WithStorage(InPlace, std::initializer_list initializerList) + : detail::StorageHolder(initializerList) + , Base(detail::StorageHolder::storage) + {} + template template WithStorage::WithStorage(Arg&& arg, std::enable_if_t>>, std::nullptr_t>) diff --git a/infra/util/test/TestMultiFunction.cpp b/infra/util/test/TestMultiFunction.cpp index be536d7ff..6076ef4a3 100644 --- a/infra/util/test/TestMultiFunction.cpp +++ b/infra/util/test/TestMultiFunction.cpp @@ -1,6 +1,6 @@ -#include "gtest/gtest.h" #include "infra/util/MultiFunction.hpp" #include "infra/util/test_helper/MockCallback.hpp" +#include "gtest/gtest.h" TEST(MultiFunctionTest, construct_empty) { @@ -24,7 +24,10 @@ TEST(MultiFunctionTest, construct_with_function) { infra::VerifyingFunctionMock m; - infra::MultiFunction f([&]() { m.callback(); }); + infra::MultiFunction f([&]() + { + m.callback(); + }); f(); } @@ -32,7 +35,10 @@ TEST(MultiFunctionTest, multi_function_construct_with_first) { infra::VerifyingFunctionMock m; - infra::MultiFunction::And::And f([&]() { m.callback(); }); + infra::MultiFunction::And::And f([&]() + { + m.callback(); + }); f(); } @@ -40,7 +46,10 @@ TEST(MultiFunctionTest, multi_function_construct_with_second) { infra::VerifyingFunctionMock m(true); - infra::MultiFunction::And f([&](bool v) { m.callback(v); }); + infra::MultiFunction::And f([&](bool v) + { + m.callback(v); + }); f(true); } @@ -49,7 +58,10 @@ TEST(MultiFunctionTest, reassign_multi_function) infra::VerifyingFunctionMock m(true); infra::MultiFunction::And f([]() {}); - f = [&](bool v) { m.callback(v); }; + f = [&](bool v) + { + m.callback(v); + }; f(true); } @@ -65,7 +77,10 @@ TEST(MultiFunctionTest, return_value) infra::MockCallback m; EXPECT_CALL(m, callback()).WillOnce(testing::Return(5)); - infra::MultiFunction::And f([&]() { return m.callback(); }); + infra::MultiFunction::And f([&]() + { + return m.callback(); + }); EXPECT_EQ(5, f()); } @@ -78,7 +93,10 @@ TEST(MultiFunctionTest, multi_function_Invocable) TEST(MultiFunctionTest, mutable_function) { - infra::MultiFunction f([n = 0]() mutable { return ++n; }); + infra::MultiFunction f([n = 0]() mutable + { + return ++n; + }); EXPECT_EQ(1, f()); EXPECT_EQ(2, f()); EXPECT_EQ(3, f()); diff --git a/lwip/lwip/CMakeLists.txt b/lwip/lwip/CMakeLists.txt index f2e96a950..9419cc360 100644 --- a/lwip/lwip/CMakeLists.txt +++ b/lwip/lwip/CMakeLists.txt @@ -54,6 +54,7 @@ target_sources(lwip.lwip PRIVATE ${lwip_SOURCE_DIR}/src/core/tcp_out.c ${lwip_SOURCE_DIR}/src/core/timeouts.c ${lwip_SOURCE_DIR}/src/core/udp.c + ${lwip_SOURCE_DIR}/src/core/ipv4/acd.c ${lwip_SOURCE_DIR}/src/core/ipv4/autoip.c ${lwip_SOURCE_DIR}/src/core/ipv4/dhcp.c ${lwip_SOURCE_DIR}/src/core/ipv4/etharp.c @@ -71,6 +72,7 @@ target_sources(lwip.lwip PRIVATE ${lwip_SOURCE_DIR}/src/core/ipv6/ip6_frag.c ${lwip_SOURCE_DIR}/src/core/ipv6/mld6.c ${lwip_SOURCE_DIR}/src/core/ipv6/nd6.c + ${lwip_SOURCE_DIR}/src/include/lwip/acd.h ${lwip_SOURCE_DIR}/src/include/lwip/altcp.h ${lwip_SOURCE_DIR}/src/include/lwip/altcp_tcp.h ${lwip_SOURCE_DIR}/src/include/lwip/altcp_tls.h diff --git a/lwip/lwip_cpp/DatagramLwIp.cpp b/lwip/lwip_cpp/DatagramLwIp.cpp index eae05b7b8..1a23b7d5b 100644 --- a/lwip/lwip_cpp/DatagramLwIp.cpp +++ b/lwip/lwip_cpp/DatagramLwIp.cpp @@ -46,6 +46,7 @@ namespace services control = CreateUdpPcb(versions); really_assert(control != nullptr); ip_set_option(control, SOF_BROADCAST); + ip_set_option(control, SOF_REUSEADDR); err_t result = udp_bind(control, IpAddrAny(versions), port); assert(result == ERR_OK); diff --git a/osal/freertos_std_thread/stdmutex.hpp b/osal/freertos_std_thread/stdmutex.hpp index 88fd40a29..f652448c7 100644 --- a/osal/freertos_std_thread/stdmutex.hpp +++ b/osal/freertos_std_thread/stdmutex.hpp @@ -56,7 +56,7 @@ namespace std return xSemaphoreTake(handle, (chrono::duration_cast(duration).count() + adjustForInaccuracies) / portTICK_RATE_MS) == pdTRUE; } - template + template bool try_lock_until(const chrono::time_point& timePoint) { return try_lock_for(timePoint - Clock::now()); @@ -112,7 +112,7 @@ namespace std return xSemaphoreTakeRecursive(handle, chrono::duration_cast(duration) + adjustForInaccuracies) == pdTRUE; } - template + template bool try_lock_until(const chrono::time_point& timePoint) { return try_lock_for(timePoint - Clock::now()); @@ -134,8 +134,8 @@ namespace std mutex& operator=(const mutex& other) = delete; ~mutex() = default; - using timed_mutex::native_handle_type; using timed_mutex::lock; + using timed_mutex::native_handle_type; using timed_mutex::try_lock; using timed_mutex::unlock; }; @@ -149,8 +149,8 @@ namespace std recursive_mutex& operator=(const recursive_mutex&) = delete; ~recursive_mutex() = default; - using recursive_timed_mutex::native_handle_type; using recursive_timed_mutex::lock; + using recursive_timed_mutex::native_handle_type; using recursive_timed_mutex::try_lock; using recursive_timed_mutex::unlock; }; diff --git a/osal/freertos_std_thread/test/semphr.h b/osal/freertos_std_thread/test/semphr.h index 8367ca16b..e425c143a 100644 --- a/osal/freertos_std_thread/test/semphr.h +++ b/osal/freertos_std_thread/test/semphr.h @@ -1,8 +1,8 @@ #ifndef TEST_FREERTOS_STD_THREAD_SEMPHR_H #define TEST_FREERTOS_STD_THREAD_SEMPHR_H -#include #include "gmock/gmock.h" +#include typedef void* xSemaphoreHandle; typedef std::chrono::system_clock::duration::rep portTickType; diff --git a/osal/freertos_std_thread/test/test_condition_variable.cpp b/osal/freertos_std_thread/test/test_condition_variable.cpp index f77ee8f02..7920abeda 100644 --- a/osal/freertos_std_thread/test/test_condition_variable.cpp +++ b/osal/freertos_std_thread/test/test_condition_variable.cpp @@ -101,8 +101,9 @@ TEST_F(SemaphoreWaitFixture, WhenWaitingNotifyOneReleasesSemaphore) EXPECT_CALL(mock, SemaphoreTake(p1, 3000)) .WillOnce(testing::Invoke([this](xSemaphoreHandle, portTickType) { - condition_variable.notify_one(); - return true; })); + condition_variable.notify_one(); + return true; + })); EXPECT_CALL(mock, SemaphoreGive(p1)); @@ -116,8 +117,9 @@ TEST_F(SemaphoreWaitFixture, WhenWaitingNotifyAllReleasesSemaphore) EXPECT_CALL(mock, SemaphoreTake(p1, 3000)) .WillOnce(testing::Invoke([this](xSemaphoreHandle, portTickType) { - condition_variable.notify_all(); - return true; })); + condition_variable.notify_all(); + return true; + })); EXPECT_CALL(mock, SemaphoreGive(p1)); @@ -138,9 +140,10 @@ TEST_F(SemaphoreFixture, WhenWaitingTwiceNotifyAllReleasesTwoSemaphores) EXPECT_CALL(mock, SemaphoreTake(p1, 3000)) .WillOnce(testing::Invoke([this](xSemaphoreHandle, portTickType) { - std::unique_lock lock(mutex); - condition_variable.wait_for(lock, std::chrono::seconds(2)); - return true; })); + std::unique_lock lock(mutex); + condition_variable.wait_for(lock, std::chrono::seconds(2)); + return true; + })); EXPECT_CALL(mock, SemaphoreCreateBinary()) .WillOnce(testing::Return(p2)); @@ -150,8 +153,9 @@ TEST_F(SemaphoreFixture, WhenWaitingTwiceNotifyAllReleasesTwoSemaphores) EXPECT_CALL(mock, SemaphoreTake(p2, 2000)) .WillOnce(testing::Invoke([this](xSemaphoreHandle, portTickType) { - condition_variable.notify_all(); - return true; })); + condition_variable.notify_all(); + return true; + })); EXPECT_CALL(mock, SemaphoreGive(p1)); EXPECT_CALL(mock, SemaphoreGive(p2)); @@ -175,9 +179,10 @@ TEST_F(SemaphoreFixture, WhenWaitingTwiceNotifyOneReleasesFirstSemaphore) EXPECT_CALL(mock, SemaphoreTake(p1, 3000)) .WillOnce(testing::Invoke([this](xSemaphoreHandle, portTickType) { - std::unique_lock lock(mutex); - condition_variable.wait_for(lock, std::chrono::seconds(2)); - return true; })); + std::unique_lock lock(mutex); + condition_variable.wait_for(lock, std::chrono::seconds(2)); + return true; + })); EXPECT_CALL(mock, SemaphoreCreateBinary()) .WillOnce(testing::Return(p2)); @@ -187,8 +192,9 @@ TEST_F(SemaphoreFixture, WhenWaitingTwiceNotifyOneReleasesFirstSemaphore) EXPECT_CALL(mock, SemaphoreTake(p2, 2000)) .WillOnce(testing::Invoke([this](xSemaphoreHandle, portTickType) { - condition_variable.notify_one(); - return false; })); // Second semaphore times out + condition_variable.notify_one(); + return false; + })); // Second semaphore times out EXPECT_CALL(mock, SemaphoreGive(p1)); diff --git a/osal/freertos_system_time/TimerServiceFreeRtos.hpp b/osal/freertos_system_time/TimerServiceFreeRtos.hpp index 0d9136728..d32302a23 100644 --- a/osal/freertos_system_time/TimerServiceFreeRtos.hpp +++ b/osal/freertos_system_time/TimerServiceFreeRtos.hpp @@ -1,7 +1,6 @@ #ifndef TIMER_SERVICE_FREE_RTOS_HPP #define TIMER_SERVICE_FREE_RTOS_HPP -//#include "hal_st/cortex/InterruptCortex.hpp" #include "infra/timer/TickOnInterruptTimerService.hpp" #include "infra/util/InterfaceConnector.hpp" diff --git a/protobuf/CMakeLists.txt b/protobuf/CMakeLists.txt index da2d6f17d..e6fe5e065 100644 --- a/protobuf/CMakeLists.txt +++ b/protobuf/CMakeLists.txt @@ -1,5 +1,5 @@ -add_subdirectory(echo) add_subdirectory(echo_attributes) +add_subdirectory(echo) add_subdirectory(protoc_echo_plugin) add_subdirectory(protoc_echo_plugin_csharp) add_subdirectory(protoc_echo_plugin_java) diff --git a/protobuf/echo/CMakeLists.txt b/protobuf/echo/CMakeLists.txt index 168b25331..6f345eece 100644 --- a/protobuf/echo/CMakeLists.txt +++ b/protobuf/echo/CMakeLists.txt @@ -8,6 +8,15 @@ target_link_libraries(protobuf.echo PUBLIC target_sources(protobuf.echo PRIVATE Echo.cpp Echo.hpp + EchoErrorPolicy.cpp + EchoErrorPolicy.hpp + Proto.hpp + ProtoMessageReceiver.cpp + ProtoMessageReceiver.hpp + ProtoMessageSender.cpp + ProtoMessageSender.hpp + Serialization.cpp + Serialization.hpp ServiceForwarder.cpp ServiceForwarder.hpp TracingEcho.cpp diff --git a/protobuf/echo/Echo.cpp b/protobuf/echo/Echo.cpp index 2f357edfe..20cba19e1 100644 --- a/protobuf/echo/Echo.cpp +++ b/protobuf/echo/Echo.cpp @@ -1,26 +1,10 @@ #include "protobuf/echo/Echo.hpp" -#include "infra/event/EventDispatcherWithWeakPtr.hpp" namespace services { - EchoErrorPolicyAbortOnMessageFormatError echoErrorPolicyAbortOnMessageFormatError; - EchoErrorPolicyAbort echoErrorPolicyAbort; - void Service::MethodDone() { - inProgress = false; - Rpc().ServiceDone(*this); - } - - bool Service::InProgress() const - { - return inProgress; - } - - void Service::HandleMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, EchoErrorPolicy& errorPolicy) - { - inProgress = true; - Handle(serviceId, methodId, contents, errorPolicy); + Rpc().ServiceDone(); } Echo& Service::Rpc() @@ -50,9 +34,10 @@ namespace services echo.RequestSend(*this); } - void ServiceProxy::GrantSend() + infra::SharedPtr ServiceProxy::GrantSend() { onGranted(); + return methodSerializer; } uint32_t ServiceProxy::MaxMessageSize() const @@ -65,124 +50,184 @@ namespace services return currentRequestedSize; } - void EchoErrorPolicyAbortOnMessageFormatError::MessageFormatError() + void ServiceProxy::SetSerializer(const infra::SharedPtr& serializer) { - std::abort(); + methodSerializer = serializer; } - void EchoErrorPolicyAbortOnMessageFormatError::ServiceNotFound(uint32_t serviceId) + EchoOnStreams::EchoOnStreams(services::MethodSerializerFactory& serializerFactory, const EchoErrorPolicy& errorPolicy) + : serializerFactory(serializerFactory) + , errorPolicy(errorPolicy) {} - void EchoErrorPolicyAbortOnMessageFormatError::MethodNotFound(uint32_t serviceId, uint32_t methodId) - {} - - void EchoErrorPolicyAbort::ServiceNotFound(uint32_t serviceId) + EchoOnStreams::~EchoOnStreams() { - std::abort(); + readerAccess.SetAction(nullptr); } - void EchoErrorPolicyAbort::MethodNotFound(uint32_t serviceId, uint32_t methodId) + void EchoOnStreams::RequestSend(ServiceProxy& serviceProxy) { - std::abort(); - } + sendRequesters.push_back(serviceProxy); - EchoOnStreams::EchoOnStreams(EchoErrorPolicy& errorPolicy) - : errorPolicy(errorPolicy) - {} + TryGrantSend(); + } - void EchoOnStreams::RequestSend(ServiceProxy& serviceProxy) + void EchoOnStreams::ServiceDone() { - if (sendRequesters.empty() && streamWriter == nullptr) - { - sendRequesters.push_back(serviceProxy); - RequestSendStream(serviceProxy.CurrentRequestedSize()); - } - else - sendRequesters.push_back(serviceProxy); + methodDeserializer = nullptr; + + if (readerPtr != nullptr) + DataReceived(); } - infra::StreamWriter& EchoOnStreams::SendStreamWriter() + services::MethodSerializerFactory& EchoOnStreams::SerializerFactory() { - return *streamWriter; + return serializerFactory; } - void EchoOnStreams::Send() + void EchoOnStreams::DataReceived(infra::SharedPtr&& reader) { - streamWriter = nullptr; + assert(readerPtr == nullptr); + readerPtr = std::move(reader); + bufferedReader.Emplace(receiveBuffer, *readerPtr); + DataReceived(); + } - if (!sendRequesters.empty()) - RequestSendStream(sendRequesters.front().CurrentRequestedSize()); + void EchoOnStreams::ReleaseReader() + { + readerAccess.SetAction(nullptr); + bufferedReader = infra::none; + readerPtr = nullptr; } - void EchoOnStreams::ServiceDone(Service& service) + void EchoOnStreams::TryGrantSend() { - if (serviceBusy && service.AcceptsService(*serviceBusy)) + if (sendingProxy == nullptr && !sendRequesters.empty()) { - serviceBusy = infra::none; - infra::EventDispatcherWithWeakPtr::Instance().Schedule([](infra::SharedPtr echo) - { - echo->BusyServiceDone(); - }, - SharedFromThis()); + sendingProxy = &sendRequesters.front(); + sendRequesters.pop_front(); + RequestSendStream(sendingProxy->CurrentRequestedSize() + 2 * infra::MaxVarIntSize(std::numeric_limits::max())); } } - void EchoOnStreams::ExecuteMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, infra::StreamReaderWithRewinding& reader) + infra::SharedPtr EchoOnStreams::GrantSend(ServiceProxy& proxy) { - if (!NotifyObservers([this, serviceId, methodId, &contents](auto& service) - { - if (service.AcceptsService(serviceId)) - { - if (service.InProgress()) - serviceBusy = serviceId; - else - service.HandleMethod(serviceId, methodId, contents, errorPolicy); - - return true; - } + return proxy.GrantSend(); + } - return false; - })) - { - errorPolicy.ServiceNotFound(serviceId); - contents.SkipEverything(); - } + infra::SharedPtr EchoOnStreams::StartingMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const infra::SharedPtr& deserializer) + { + return deserializer; } - void EchoOnStreams::SetStreamWriter(infra::SharedPtr&& writer) + void EchoOnStreams::SendStreamAvailable(infra::SharedPtr&& writer) { - streamWriter = std::move(writer); + if (methodSerializer == nullptr) + methodSerializer = GrantSend(*sendingProxy); + + auto more = methodSerializer->Serialize(std::move(writer)); - ServiceProxy& proxy = sendRequesters.front(); - sendRequesters.pop_front(); - proxy.GrantSend(); + if (more) + RequestSendStream(sendingProxy->CurrentRequestedSize()); + else + { + sendingProxy = nullptr; + methodSerializer->SerializationDone(); + methodSerializer = nullptr; + TryGrantSend(); + } } - bool EchoOnStreams::ServiceBusy() const + void EchoOnStreams::DataReceived() { - return serviceBusy != infra::none; + while (readerPtr != nullptr && methodDeserializer == nullptr && !readerAccess.Referenced()) + { + if (limitedReader == infra::none) + StartReceiveMessage(); + + if (limitedReader != infra::none) + ContinueReceiveMessage(); + } } - bool EchoOnStreams::ProcessMessage(infra::StreamReaderWithRewinding& reader) + void EchoOnStreams::StartReceiveMessage() { - infra::DataInputStream::WithErrorPolicy stream(reader, infra::softFail); + auto start = bufferedReader->ConstructSaveMarker(); + infra::DataInputStream::WithErrorPolicy stream(*bufferedReader, infra::softFail); infra::StreamErrorPolicy formatErrorPolicy(infra::softFail); infra::ProtoParser parser(stream, formatErrorPolicy); uint32_t serviceId = static_cast(parser.GetVarInt()); - infra::ProtoParser::Field message = parser.GetField(); - if (stream.Failed()) - return false; + auto [contents, methodId] = parser.GetPartialField(); - if (formatErrorPolicy.Failed() || !message.first.Is()) + if (stream.Failed()) + { + bufferedReader->Rewind(start); + bufferedReader = infra::none; + readerPtr = nullptr; + } + else if (formatErrorPolicy.Failed() || !contents.Is()) + { errorPolicy.MessageFormatError(); + AckReceived(); + } else { - ExecuteMethod(serviceId, message.second, message.first.Get(), reader); + limitedReader.Emplace(*bufferedReader, contents.Get().length); + StartMethod(serviceId, methodId, contents.Get().length); - if (stream.Failed() || formatErrorPolicy.Failed()) + if (formatErrorPolicy.Failed()) errorPolicy.MessageFormatError(); } + } + + void EchoOnStreams::ContinueReceiveMessage() + { + limitedReader->SwitchInput(*bufferedReader); + readerAccess.SetAction(infra::emptyFunction); + methodDeserializer->MethodContents(readerAccess.MakeShared(*limitedReader)); + + if (readerAccess.Referenced()) + readerAccess.SetAction([this]() + { + ReaderDone(); + DataReceived(); + }); + else + ReaderDone(); + } + + void EchoOnStreams::StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size) + { + if (!NotifyObservers([this, serviceId, methodId, size](auto& service) + { + if (service.AcceptsService(serviceId)) + { + methodDeserializer = StartingMethod(serviceId, methodId, size, service.StartMethod(serviceId, methodId, size, errorPolicy)); + return true; + } + + return false; + })) + { + errorPolicy.ServiceNotFound(serviceId); + methodDeserializer = deserializerDummy.Emplace(*this); + } + } - return true; + void EchoOnStreams::ReaderDone() + { + AckReceived(); + + if (limitedReader->LimitReached()) + { + limitedReader = infra::none; + if (methodDeserializer->Failed()) + { + errorPolicy.MessageFormatError(); + methodDeserializer = nullptr; + } + else + methodDeserializer->ExecuteMethod(); + } } } diff --git a/protobuf/echo/Echo.hpp b/protobuf/echo/Echo.hpp index 81d04ba97..aa4d5b9ac 100644 --- a/protobuf/echo/Echo.hpp +++ b/protobuf/echo/Echo.hpp @@ -1,13 +1,15 @@ #ifndef PROTOBUF_ECHO_HPP #define PROTOBUF_ECHO_HPP -#include "infra/syntax/ProtoFormatter.hpp" -#include "infra/syntax/ProtoParser.hpp" +#include "infra/stream/BufferingStreamReader.hpp" #include "infra/util/BoundedDeque.hpp" #include "infra/util/Compatibility.hpp" #include "infra/util/Function.hpp" +#include "infra/util/Observer.hpp" #include "infra/util/Optional.hpp" -#include "services/util/MessageCommunication.hpp" +#include "protobuf/echo/EchoErrorPolicy.hpp" +#include "protobuf/echo/Proto.hpp" +#include "protobuf/echo/Serialization.hpp" namespace services { @@ -15,152 +17,6 @@ namespace services class Service; class ServiceProxy; - struct ProtoBool - {}; - - struct ProtoUInt32 - {}; - - struct ProtoInt32 - {}; - - struct ProtoUInt64 - {}; - - struct ProtoInt64 - {}; - - struct ProtoFixed32 - {}; - - struct ProtoFixed64 - {}; - - struct ProtoSFixed32 - {}; - - struct ProtoSFixed64 - {}; - - struct ProtoUnboundedString - {}; - - struct ProtoUnboundedBytes - {}; - - template - struct ProtoMessage - {}; - - template - struct ProtoEnum - {}; - - template - struct ProtoBytes - {}; - - template - struct ProtoString - {}; - - template - struct ProtoRepeated - {}; - - template - struct ProtoUnboundedRepeated - {}; - - void SerializeField(ProtoBool, infra::ProtoFormatter& formatter, bool value, uint32_t fieldNumber); - void SerializeField(ProtoUInt32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber); - void SerializeField(ProtoInt32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber); - void SerializeField(ProtoUInt64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber); - void SerializeField(ProtoInt64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber); - void SerializeField(ProtoFixed32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber); - void SerializeField(ProtoFixed64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber); - void SerializeField(ProtoSFixed32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber); - void SerializeField(ProtoSFixed64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber); - void SerializeField(ProtoUnboundedString, infra::ProtoFormatter& formatter, const std::string& value, uint32_t fieldNumber); - void SerializeField(ProtoUnboundedBytes, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber); - - template - void SerializeField(ProtoRepeated, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber); - template - void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber); - template - void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber); - template - void SerializeField(ProtoMessage, infra::ProtoFormatter& formatter, const U& value, uint32_t fieldNumber); - template - void SerializeField(ProtoEnum, infra::ProtoFormatter& formatter, T value, uint32_t fieldNumber); - template - void SerializeField(ProtoBytes, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber); - template - void SerializeField(ProtoString, infra::ProtoFormatter& formatter, infra::BoundedConstString value, uint32_t fieldNumber); - - void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::Field& field, bool& value); - void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint32_t& value); - void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int32_t& value); - void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint64_t& value); - void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int64_t& value); - void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint32_t& value); - void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint64_t& value); - void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int32_t& value); - void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int64_t& value); - void DeserializeField(ProtoUnboundedString, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::string& value); - void DeserializeField(ProtoUnboundedBytes, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::vector& value); - - template - void DeserializeField(ProtoRepeated, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedVector& value); - template - void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::vector& value); - template - void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::vector& value); - template - void DeserializeField(ProtoMessage, infra::ProtoParser& parser, infra::ProtoParser::Field& field, U& value); - template - void DeserializeField(ProtoEnum, infra::ProtoParser& parser, infra::ProtoParser::Field& field, T& value); - template - void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedVector& value); - template - void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::ConstByteRange& value); - template - void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedString& value); - template - void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedConstString& value); - - class EchoErrorPolicy - { - protected: - ~EchoErrorPolicy() = default; - - public: - virtual void MessageFormatError() = 0; - virtual void ServiceNotFound(uint32_t serviceId) = 0; - virtual void MethodNotFound(uint32_t serviceId, uint32_t methodId) = 0; - }; - - class EchoErrorPolicyAbortOnMessageFormatError - : public EchoErrorPolicy - { - public: - void MessageFormatError() override; - void ServiceNotFound(uint32_t serviceId) override; - void MethodNotFound(uint32_t serviceId, uint32_t methodId) override; - }; - - class EchoErrorPolicyAbort - : public EchoErrorPolicyAbortOnMessageFormatError - { - public: - void ServiceNotFound(uint32_t serviceId) override; - void MethodNotFound(uint32_t serviceId, uint32_t methodId) override; - }; - - extern EchoErrorPolicyAbortOnMessageFormatError echoErrorPolicyAbortOnMessageFormatError; - extern EchoErrorPolicyAbort echoErrorPolicyAbort; - class Service : public infra::Observer { @@ -170,25 +26,10 @@ namespace services virtual bool AcceptsService(uint32_t id) const = 0; void MethodDone(); - bool InProgress() const; - void HandleMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, EchoErrorPolicy& errorPolicy); + virtual infra::SharedPtr StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const EchoErrorPolicy& errorPolicy) = 0; protected: Echo& Rpc(); - virtual void Handle(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, EchoErrorPolicy& errorPolicy) = 0; - - private: - bool inProgress = false; - }; - - class Echo - : public infra::Subject - { - public: - virtual void RequestSend(ServiceProxy& serviceProxy) = 0; - virtual infra::StreamWriter& SendStreamWriter() = 0; - virtual void Send() = 0; - virtual void ServiceDone(Service& service) = 0; }; class ServiceProxy @@ -200,46 +41,26 @@ namespace services Echo& Rpc(); virtual void RequestSend(infra::Function onGranted); virtual void RequestSend(infra::Function onGranted, uint32_t requestedSize); - void GrantSend(); + virtual infra::SharedPtr GrantSend(); uint32_t MaxMessageSize() const; uint32_t CurrentRequestedSize() const; + void SetSerializer(const infra::SharedPtr& serializer); private: Echo& echo; uint32_t maxMessageSize; infra::Function onGranted; uint32_t currentRequestedSize = 0; + infra::SharedPtr methodSerializer; }; - template - class ServiceProxyResponseQueue - : public ServiceProxyType + class Echo + : public infra::Subject { public: - struct Request - { - infra::Function onRequestGranted; - uint32_t requestedSize; - }; - - using Container = infra::BoundedDeque; - - template - using WithStorage = infra::WithStorage>; - - template - explicit ServiceProxyResponseQueue(Container& container, Args&&... args); - - void RequestSend(infra::Function onRequestGranted) override; - void RequestSend(infra::Function onRequestGranted, uint32_t requestedSize) override; - - private: - void ProcessSendQueue(); - - private: - Container& container; - - bool responseInProgress{ false }; + virtual void RequestSend(ServiceProxy& serviceProxy) = 0; + virtual void ServiceDone() = 0; + virtual services::MethodSerializerFactory& SerializerFactory() = 0; }; class EchoOnStreams @@ -247,329 +68,50 @@ namespace services , public infra::EnableSharedFromThis { public: - explicit EchoOnStreams(EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); + explicit EchoOnStreams(services::MethodSerializerFactory& serializerFactory, const EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); + ~EchoOnStreams() override; // Implementation of Echo void RequestSend(ServiceProxy& serviceProxy) override; - infra::StreamWriter& SendStreamWriter() override; - void Send() override; - void ServiceDone(Service& service) override; + void ServiceDone() override; + services::MethodSerializerFactory& SerializerFactory() override; protected: + virtual infra::SharedPtr GrantSend(ServiceProxy& proxy); + virtual infra::SharedPtr StartingMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const infra::SharedPtr& deserializer); virtual void RequestSendStream(std::size_t size) = 0; - virtual void BusyServiceDone() = 0; + virtual void AckReceived() = 0; - virtual void ExecuteMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, infra::StreamReaderWithRewinding& reader); - virtual void SetStreamWriter(infra::SharedPtr&& writer); - bool ServiceBusy() const; - bool ProcessMessage(infra::StreamReaderWithRewinding& reader); - - protected: - EchoErrorPolicy& errorPolicy; + void SendStreamAvailable(infra::SharedPtr&& writer); + void DataReceived(infra::SharedPtr&& reader); + void ReleaseReader(); private: - infra::SharedPtr streamWriter; - infra::IntrusiveList sendRequesters; - infra::Optional serviceBusy; - }; - - //// Implementation //// - - inline void SerializeField(ProtoBool, infra::ProtoFormatter& formatter, bool value, uint32_t fieldNumber) - { - formatter.PutVarIntField(value, fieldNumber); - } + void TryGrantSend(); - inline void SerializeField(ProtoUInt32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber) - { - formatter.PutVarIntField(value, fieldNumber); - } - - inline void SerializeField(ProtoInt32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber) - { - formatter.PutVarIntField(value, fieldNumber); - } - - inline void SerializeField(ProtoUInt64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber) - { - formatter.PutVarIntField(value, fieldNumber); - } - - inline void SerializeField(ProtoInt64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber) - { - formatter.PutVarIntField(value, fieldNumber); - } - - inline void SerializeField(ProtoFixed32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber) - { - formatter.PutFixed32Field(value, fieldNumber); - } + void DataReceived(); + void StartReceiveMessage(); + void ContinueReceiveMessage(); + void StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size); + void ReaderDone(); - inline void SerializeField(ProtoFixed64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber) - { - formatter.PutFixed64Field(value, fieldNumber); - } - - inline void SerializeField(ProtoSFixed32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber) - { - formatter.PutFixed32Field(static_cast(value), fieldNumber); - } - - inline void SerializeField(ProtoSFixed64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber) - { - formatter.PutFixed64Field(static_cast(value), fieldNumber); - } - - inline void SerializeField(ProtoUnboundedString, infra::ProtoFormatter& formatter, const std::string& value, uint32_t fieldNumber) - { - formatter.PutStringField(value, fieldNumber); - } - - inline void SerializeField(ProtoUnboundedBytes, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber) - { - formatter.PutBytesField(value, fieldNumber); - } - - template - void SerializeField(ProtoRepeated, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber) - { - for (auto& v : value) - SerializeField(T(), formatter, v, fieldNumber); - } - - template - void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber) - { - for (auto& v : value) - SerializeField(T(), formatter, v, fieldNumber); - } - - template - void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber) - { - for (auto v : value) - SerializeField(T(), formatter, v, fieldNumber); - } - - template - void SerializeField(ProtoMessage, infra::ProtoFormatter& formatter, const U& value, uint32_t fieldNumber) - { - infra::ProtoLengthDelimitedFormatter nestedMessage(formatter, fieldNumber); - value.Serialize(formatter); - } - - template - void SerializeField(ProtoEnum, infra::ProtoFormatter& formatter, T value, uint32_t fieldNumber) - { - formatter.PutVarIntField(static_cast(value), fieldNumber); - } - - template - void SerializeField(ProtoBytes, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber) - { - formatter.PutBytesField(infra::MakeRange(value), fieldNumber); - } - - template - void SerializeField(ProtoString, infra::ProtoFormatter& formatter, infra::BoundedConstString value, uint32_t fieldNumber) - { - formatter.PutStringField(value, fieldNumber); - } - - inline void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::Field& field, bool& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = field.first.Get() != 0; - } - - inline void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint32_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = static_cast(field.first.Get()); - } - - inline void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int32_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = static_cast(field.first.Get()); - } - - inline void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint64_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = field.first.Get(); - } - - inline void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int64_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = static_cast(field.first.Get()); - } - - inline void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint32_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = field.first.Get(); - } - - inline void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, uint64_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = field.first.Get(); - } - - inline void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int32_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = static_cast(field.first.Get()); - } - - inline void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::Field& field, int64_t& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = static_cast(field.first.Get()); - } - - inline void DeserializeField(ProtoUnboundedString, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::string& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = field.first.Get().GetStdString(); - } - - inline void DeserializeField(ProtoUnboundedBytes, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::vector& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = field.first.Get().GetUnboundedBytes(); - } - - template - void DeserializeField(ProtoRepeated, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedVector& value) - { - parser.ReportFormatResult(!value.full()); - if (!value.full()) - { - value.emplace_back(); - DeserializeField(T(), parser, field, value.back()); - } - } - - template - void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::vector& value) - { - value.emplace_back(); - DeserializeField(T(), parser, field, value.back()); - } - - template - void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::Field& field, std::vector& value) - { - bool result{}; - DeserializeField(T(), parser, field, result); - value.push_back(result); - } - - template - void DeserializeField(ProtoMessage, infra::ProtoParser& parser, infra::ProtoParser::Field& field, U& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - { - infra::ProtoParser nestedParser = field.first.Get().Parser(); - value.Deserialize(nestedParser); - } - } - - template - void DeserializeField(ProtoEnum, infra::ProtoParser& parser, infra::ProtoParser::Field& field, T& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - value = static_cast(field.first.Get()); - } - - template - void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedVector& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - field.first.Get().GetBytes(value); - } - - template - void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::ConstByteRange& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - field.first.Get().GetBytesReference(value); - } - - template - void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedString& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - field.first.Get().GetString(value); - } - - template - void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::Field& field, infra::BoundedConstString& value) - { - parser.ReportFormatResult(field.first.Is()); - if (field.first.Is()) - field.first.Get().GetStringReference(value); - } - - template - template - ServiceProxyResponseQueue::ServiceProxyResponseQueue(Container& container, Args&&... args) - : ServiceProxyType{ std::forward(args)... } - , container{ container } - {} - - template - void ServiceProxyResponseQueue::RequestSend(infra::Function onRequestGranted) - { - RequestSend(onRequestGranted, ServiceProxyType::MaxMessageSize()); - } - - template - void ServiceProxyResponseQueue::RequestSend(infra::Function onRequestGranted, uint32_t requestedSize) - { - if (container.full()) - return; + private: + services::MethodSerializerFactory& serializerFactory; + const EchoErrorPolicy& errorPolicy; - container.push_back({ onRequestGranted, requestedSize }); - ProcessSendQueue(); - } + infra::IntrusiveList sendRequesters; + ServiceProxy* sendingProxy = nullptr; + infra::SharedPtr methodSerializer; - template - void ServiceProxyResponseQueue::ProcessSendQueue() - { - if (!responseInProgress && !container.empty()) - { - responseInProgress = true; - ServiceProxyType::RequestSend([this] - { - container.front().onRequestGranted(); - container.pop_front(); + infra::SharedPtr readerPtr; + infra::Optional limitedReader; + infra::SharedPtr methodDeserializer; + infra::BoundedDeque::WithMaxSize<32> receiveBuffer; + infra::Optional bufferedReader; + infra::AccessedBySharedPtr readerAccess; - responseInProgress = false; - ProcessSendQueue(); - }, - container.front().requestedSize); - } - } + infra::SharedOptional deserializerDummy; + }; } #endif diff --git a/protobuf/echo/EchoErrorPolicy.cpp b/protobuf/echo/EchoErrorPolicy.cpp new file mode 100644 index 000000000..985c2e754 --- /dev/null +++ b/protobuf/echo/EchoErrorPolicy.cpp @@ -0,0 +1,28 @@ +#include "protobuf/echo/EchoErrorPolicy.hpp" + +namespace services +{ + const EchoErrorPolicyAbortOnMessageFormatError echoErrorPolicyAbortOnMessageFormatError; + const EchoErrorPolicyAbort echoErrorPolicyAbort; + + void EchoErrorPolicyAbortOnMessageFormatError::MessageFormatError() const + { + std::abort(); + } + + void EchoErrorPolicyAbortOnMessageFormatError::ServiceNotFound(uint32_t serviceId) const + {} + + void EchoErrorPolicyAbortOnMessageFormatError::MethodNotFound(uint32_t serviceId, uint32_t methodId) const + {} + + void EchoErrorPolicyAbort::ServiceNotFound(uint32_t serviceId) const + { + std::abort(); + } + + void EchoErrorPolicyAbort::MethodNotFound(uint32_t serviceId, uint32_t methodId) const + { + std::abort(); + } +} diff --git a/protobuf/echo/EchoErrorPolicy.hpp b/protobuf/echo/EchoErrorPolicy.hpp new file mode 100644 index 000000000..73af320f2 --- /dev/null +++ b/protobuf/echo/EchoErrorPolicy.hpp @@ -0,0 +1,47 @@ +#ifndef PROTOBUF_ECHO_ERROR_POLICY_HPP +#define PROTOBUF_ECHO_ERROR_POLICY_HPP + +#include "infra/stream/BufferingStreamReader.hpp" +#include "infra/util/BoundedDeque.hpp" +#include "infra/util/Compatibility.hpp" +#include "infra/util/Function.hpp" +#include "infra/util/Observer.hpp" +#include "infra/util/Optional.hpp" +#include "protobuf/echo/Proto.hpp" +#include "protobuf/echo/Serialization.hpp" + +namespace services +{ + class EchoErrorPolicy + { + protected: + virtual ~EchoErrorPolicy() = default; + + public: + virtual void MessageFormatError() const = 0; + virtual void ServiceNotFound(uint32_t serviceId) const = 0; + virtual void MethodNotFound(uint32_t serviceId, uint32_t methodId) const = 0; + }; + + class EchoErrorPolicyAbortOnMessageFormatError + : public EchoErrorPolicy + { + public: + void MessageFormatError() const override; + void ServiceNotFound(uint32_t serviceId) const override; + void MethodNotFound(uint32_t serviceId, uint32_t methodId) const override; + }; + + class EchoErrorPolicyAbort + : public EchoErrorPolicyAbortOnMessageFormatError + { + public: + void ServiceNotFound(uint32_t serviceId) const override; + void MethodNotFound(uint32_t serviceId, uint32_t methodId) const override; + }; + + extern const EchoErrorPolicyAbortOnMessageFormatError echoErrorPolicyAbortOnMessageFormatError; + extern const EchoErrorPolicyAbort echoErrorPolicyAbort; +} + +#endif diff --git a/protobuf/echo/Proto.hpp b/protobuf/echo/Proto.hpp new file mode 100644 index 000000000..b52204c66 --- /dev/null +++ b/protobuf/echo/Proto.hpp @@ -0,0 +1,544 @@ +#ifndef PROTOBUF_PROTO_HPP +#define PROTOBUF_PROTO_HPP + +#include "infra/syntax/ProtoFormatter.hpp" +#include "infra/syntax/ProtoParser.hpp" +#include + +namespace services +{ + struct ProtoBool + {}; + + struct ProtoUInt32 + {}; + + struct ProtoInt32 + {}; + + struct ProtoUInt64 + {}; + + struct ProtoInt64 + {}; + + struct ProtoFixed32 + {}; + + struct ProtoFixed64 + {}; + + struct ProtoSFixed32 + {}; + + struct ProtoSFixed64 + {}; + + struct ProtoUnboundedString + {}; + + struct ProtoUnboundedBytes + {}; + + template + struct ProtoMessage + {}; + + template + struct ProtoEnum + {}; + + struct ProtoBytesBase + {}; + + template + struct ProtoBytes + : ProtoBytesBase + {}; + + struct ProtoStringBase + {}; + + template + struct ProtoString + : ProtoStringBase + {}; + + template + struct ProtoRepeatedBase + {}; + + template + struct ProtoRepeated + : ProtoRepeatedBase + {}; + + template + struct ProtoUnboundedRepeated + {}; + + void SerializeField(ProtoBool, infra::ProtoFormatter& formatter, bool value, uint32_t fieldNumber); + void SerializeField(ProtoUInt32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber); + void SerializeField(ProtoInt32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber); + void SerializeField(ProtoUInt64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber); + void SerializeField(ProtoInt64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber); + void SerializeField(ProtoFixed32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber); + void SerializeField(ProtoFixed64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber); + void SerializeField(ProtoSFixed32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber); + void SerializeField(ProtoSFixed64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber); + void SerializeField(ProtoUnboundedString, infra::ProtoFormatter& formatter, const std::string& value, uint32_t fieldNumber); + void SerializeField(ProtoUnboundedBytes, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber); + + template + void SerializeField(ProtoRepeated, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber); + template + void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber); + template + void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber); + template + void SerializeField(ProtoMessage, infra::ProtoFormatter& formatter, const U& value, uint32_t fieldNumber); + template + void SerializeField(ProtoEnum, infra::ProtoFormatter& formatter, T value, uint32_t fieldNumber); + template + void SerializeField(ProtoBytes, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber); + template + void SerializeField(ProtoString, infra::ProtoFormatter& formatter, infra::BoundedConstString value, uint32_t fieldNumber); + + void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, bool& value); + void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint32_t& value); + void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int32_t& value); + void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint64_t& value); + void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int64_t& value); + void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint32_t& value); + void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint64_t& value); + void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int32_t& value); + void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int64_t& value); + void DeserializeField(ProtoUnboundedString, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::string& value); + void DeserializeField(ProtoUnboundedBytes, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::vector& value); + + template + void DeserializeField(ProtoRepeated, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedVector& value); + template + void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::vector& value); + template + void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::vector& value); + template + void DeserializeField(ProtoMessage, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, U& value); + template + void DeserializeField(ProtoEnum, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, T& value); + template + void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedVector& value); + template + void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::ConstByteRange& value); + template + void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedString& value); + template + void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedConstString& value); + + void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, bool& value); + void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value); + void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value); + void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value); + void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value); + void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value); + void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value); + void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value); + void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value); + + template + struct MessageDepth + { + static constexpr uint32_t value = 0; + }; + + template<> + struct MessageDepth + { + static constexpr uint32_t value = 1; + }; + + template<> + struct MessageDepth + { + static constexpr uint32_t value = 1; + }; + + template + struct MessageDepth> + { + static constexpr uint32_t value = 1; + }; + + template + struct MessageDepth> + { + static constexpr uint32_t value = 1; + }; + + template + struct MessageDepth> + { + static constexpr uint32_t value = 1; + }; + + template + struct MessageDepth> + { + static constexpr uint32_t value = 1; + }; + + template + struct Max + { + static constexpr uint32_t value = 0; + }; + + template + struct Max + { + static constexpr uint32_t value = V; + }; + + template + struct Max + { + static constexpr uint32_t value = std::max(V, Max::value); + }; + + template + struct MaxFieldsDepth; + + template + struct MaxFieldsDepth> + { + static constexpr uint32_t value = Max>::value...>::value; + }; + + template + struct MessageDepth> + { + static constexpr uint32_t value = MaxFieldsDepth>::value + 1; + }; + + //// Implementation //// + + inline void SerializeField(ProtoBool, infra::ProtoFormatter& formatter, bool value, uint32_t fieldNumber) + { + formatter.PutVarIntField(value, fieldNumber); + } + + inline void SerializeField(ProtoUInt32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber) + { + formatter.PutVarIntField(value, fieldNumber); + } + + inline void SerializeField(ProtoInt32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber) + { + formatter.PutVarIntField(value, fieldNumber); + } + + inline void SerializeField(ProtoUInt64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber) + { + formatter.PutVarIntField(value, fieldNumber); + } + + inline void SerializeField(ProtoInt64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber) + { + formatter.PutVarIntField(value, fieldNumber); + } + + inline void SerializeField(ProtoFixed32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber) + { + formatter.PutFixed32Field(value, fieldNumber); + } + + inline void SerializeField(ProtoFixed64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber) + { + formatter.PutFixed64Field(value, fieldNumber); + } + + inline void SerializeField(ProtoSFixed32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber) + { + formatter.PutFixed32Field(static_cast(value), fieldNumber); + } + + inline void SerializeField(ProtoSFixed64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber) + { + formatter.PutFixed64Field(static_cast(value), fieldNumber); + } + + inline void SerializeField(ProtoUnboundedString, infra::ProtoFormatter& formatter, const std::string& value, uint32_t fieldNumber) + { + formatter.PutStringField(value, fieldNumber); + } + + inline void SerializeField(ProtoUnboundedBytes, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber) + { + formatter.PutBytesField(value, fieldNumber); + } + + template + void SerializeField(ProtoRepeated, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber) + { + for (auto& v : value) + SerializeField(T(), formatter, v, fieldNumber); + } + + template + void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber) + { + for (auto& v : value) + SerializeField(T(), formatter, v, fieldNumber); + } + + template + void SerializeField(ProtoUnboundedRepeated, infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber) + { + for (auto v : value) + SerializeField(T(), formatter, v, fieldNumber); + } + + template + void SerializeField(ProtoMessage, infra::ProtoFormatter& formatter, const U& value, uint32_t fieldNumber) + { + infra::ProtoLengthDelimitedFormatter nestedMessage(formatter, fieldNumber); + value.Serialize(formatter); + } + + template + void SerializeField(ProtoEnum, infra::ProtoFormatter& formatter, T value, uint32_t fieldNumber) + { + formatter.PutVarIntField(static_cast(value), fieldNumber); + } + + template + void SerializeField(ProtoBytes, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber) + { + formatter.PutBytesField(infra::MakeRange(value), fieldNumber); + } + + template + void SerializeField(ProtoString, infra::ProtoFormatter& formatter, infra::BoundedConstString value, uint32_t fieldNumber) + { + formatter.PutStringField(value, fieldNumber); + } + + inline void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, bool& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get() != 0; + } + + inline void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get(); + } + + inline void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get(); + } + + inline void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, uint64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get(); + } + + inline void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, int64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoUnboundedString, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::string& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get().GetStdString(); + } + + inline void DeserializeField(ProtoUnboundedBytes, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::vector& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get().GetUnboundedBytes(); + } + + template + void DeserializeField(ProtoRepeated, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedVector& value) + { + parser.ReportFormatResult(!value.full()); + if (!value.full()) + { + value.emplace_back(); + DeserializeField(T(), parser, field, value.back()); + } + } + + template + void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::vector& value) + { + value.emplace_back(); + DeserializeField(T(), parser, field, value.back()); + } + + template + void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, std::vector& value) + { + bool result{}; + DeserializeField(T(), parser, field, result); + value.push_back(result); + } + + template + void DeserializeField(ProtoMessage, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, U& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + { + infra::ProtoParser nestedParser = field.Get().Parser(); + value.Deserialize(nestedParser); + } + } + + template + void DeserializeField(ProtoEnum, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, T& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + template + void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedVector& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + field.Get().GetBytes(value); + } + + template + void DeserializeField(ProtoBytes, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::ConstByteRange& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + field.Get().GetBytesReference(value); + } + + template + void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedString& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + field.Get().GetString(value); + } + + template + void DeserializeField(ProtoString, infra::ProtoParser& parser, infra::ProtoParser::FieldVariant& field, infra::BoundedConstString& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + field.Get().GetStringReference(value); + } + + inline void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, bool& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get() != 0; + } + + inline void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get(); + } + + inline void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get(); + } + + inline void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = field.Get(); + } + + inline void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + inline void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } +} + +#endif diff --git a/protobuf/echo/ProtoMessageReceiver.cpp b/protobuf/echo/ProtoMessageReceiver.cpp new file mode 100644 index 000000000..880abbf1a --- /dev/null +++ b/protobuf/echo/ProtoMessageReceiver.cpp @@ -0,0 +1,161 @@ +#include "protobuf/echo/ProtoMessageReceiver.hpp" +#include "infra/stream/BufferingStreamReader.hpp" + +namespace services +{ + ProtoMessageReceiverBase::ProtoMessageReceiverBase(infra::BoundedVector>>& stack) + : stack(stack) + {} + + void ProtoMessageReceiverBase::Feed(infra::StreamReaderWithRewinding& data) + { + infra::BufferingStreamReader reader{ buffer, data }; + + while (true) + { + infra::LimitedStreamReaderWithRewinding limitedReader(reader, stack.back().first); + infra::DataInputStream::WithErrorPolicy stream{ limitedReader, infra::softFail }; + + auto available = limitedReader.Available(); + + const auto& current = stack.back(); + current.second(stream); + + if (stream.Failed() || reader.Empty()) + { + failed = stream.Failed(); + break; + } + + ConsumeStack(current, available - limitedReader.Available()); + } + } + + bool ProtoMessageReceiverBase::Failed() const + { + return failed; + } + + void ProtoMessageReceiverBase::ConsumeStack(const std::pair>& current, std::size_t amount) + { + if (¤t != &stack.front()) + { + for (auto& i : stack) + { + i.first -= amount; + + if (&i == ¤t) + break; + } + + while (stack.size() > 1 && stack.back().first == 0) + stack.pop_back(); + } + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, bool& value) const + { + services::DeserializeField(ProtoBool(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value) const + { + services::DeserializeField(ProtoUInt32(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value) const + { + services::DeserializeField(ProtoInt32(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value) const + { + services::DeserializeField(ProtoUInt64(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value) const + { + services::DeserializeField(ProtoInt64(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value) const + { + services::DeserializeField(ProtoFixed32(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value) const + { + services::DeserializeField(ProtoFixed64(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value) const + { + services::DeserializeField(ProtoSFixed32(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value) const + { + services::DeserializeField(ProtoSFixed64(), parser, field, value); + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoStringBase, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, infra::BoundedString& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + { + auto stringSize = field.Get().length; + stack.emplace_back(stringSize, [&value](const infra::DataInputStream& stream) + { + while (!stream.Empty()) + value.append(infra::ByteRangeAsString(stream.ContiguousRange())); + }); + value.clear(); + } + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoUnboundedString, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, std::string& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + { + auto stringSize = field.Get().length; + stack.emplace_back(stringSize, [&value](const infra::DataInputStream& stream) + { + while (!stream.Empty()) + value.append(infra::ByteRangeAsStdString(stream.ContiguousRange())); + }); + value.clear(); + } + } + + void ProtoMessageReceiverBase::DeserializeField(ProtoBytesBase, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, infra::BoundedVector& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + { + auto bytesSize = field.Get().length; + stack.emplace_back(bytesSize, [&value](const infra::DataInputStream& stream) + { + while (!stream.Empty()) + { + auto range = stream.ContiguousRange(); + value.insert(value.end(), range.begin(), range.end()); + } + }); + value.clear(); + } + } + + void ProtoMessageReceiverBase::ConsumeUnknownField(infra::ProtoParser::PartialField& field) + { + if (field.first.Is()) + { + auto size = field.first.Get().length; + stack.emplace_back(size, [](const infra::DataInputStream& stream) + { + while (!stream.Empty()) + stream.ContiguousRange(); + }); + } + } +} diff --git a/protobuf/echo/ProtoMessageReceiver.hpp b/protobuf/echo/ProtoMessageReceiver.hpp new file mode 100644 index 000000000..7d13c084d --- /dev/null +++ b/protobuf/echo/ProtoMessageReceiver.hpp @@ -0,0 +1,177 @@ +#ifndef PROTOBUF_PROTO_MESSAGE_RECEIVER_HPP +#define PROTOBUF_PROTO_MESSAGE_RECEIVER_HPP + +#include "infra/syntax/ProtoParser.hpp" +#include "infra/util/BoundedDeque.hpp" +#include "infra/util/BoundedVector.hpp" +#include "protobuf/echo/Proto.hpp" + +namespace services +{ + class ProtoMessageReceiverBase + { + public: + explicit ProtoMessageReceiverBase(infra::BoundedVector>>& stack); + + void Feed(infra::StreamReaderWithRewinding& data); + bool Failed() const; + + protected: + template + void FeedForMessage(const infra::DataInputStream& stream, Message& message); + + private: + void ConsumeStack(const std::pair>& current, std::size_t amount); + + template + bool DeserializeFields(infra::ProtoParser::PartialField& field, infra::ProtoParser& parser, Message& message, std::index_sequence); + + template + bool DeserializeSingleField(infra::ProtoParser::PartialField& field, infra::ProtoParser& parser, Message& message); + + void DeserializeField(ProtoBool, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, bool& value) const; + void DeserializeField(ProtoUInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value) const; + void DeserializeField(ProtoInt32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value) const; + void DeserializeField(ProtoUInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value) const; + void DeserializeField(ProtoInt64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value) const; + void DeserializeField(ProtoFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint32_t& value) const; + void DeserializeField(ProtoFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, uint64_t& value) const; + void DeserializeField(ProtoSFixed32, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int32_t& value) const; + void DeserializeField(ProtoSFixed64, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, int64_t& value) const; + + void DeserializeField(ProtoStringBase, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, infra::BoundedString& value); + void DeserializeField(ProtoUnboundedString, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, std::string& value); + void DeserializeField(ProtoBytesBase, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, infra::BoundedVector& value); + + template + void DeserializeField(ProtoEnum, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Enum& value) const; + template + void DeserializeField(ProtoMessage, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Message& value); + template + void DeserializeField(ProtoRepeatedBase, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Type& value) const; + template + void DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Type& value) const; + + void ConsumeUnknownField(infra::ProtoParser::PartialField& field); + + private: + infra::BoundedDeque::WithMaxSize<32> buffer; + infra::BoundedVector>>& stack; + bool failed = false; + }; + + template + class ProtoMessageReceiver + : public ProtoMessageReceiverBase + { + public: + ProtoMessageReceiver(); + + Message message; + + private: + infra::BoundedVector>>::WithMaxSize>::value + 1> stack{ { std::pair>{ std::numeric_limits::max(), [this](const infra::DataInputStream& stream) + { + FeedForMessage(stream, message); + } } } }; + }; +} + +//// Implementation //// + +namespace services +{ + template + void ProtoMessageReceiverBase::FeedForMessage(const infra::DataInputStream& stream, Message& message) + { + infra::ProtoParser parser{ stream }; + + while (!stream.Empty()) + { + auto marker = static_cast(stream.Reader()).ConstructSaveMarker(); + auto field = parser.GetPartialField(); + + if (stream.Failed()) + { + static_cast(stream.Reader()).Rewind(marker); + break; + } + + auto stackSize = stack.size(); + if (!DeserializeFields(field, parser, message, std::make_index_sequence{})) + ConsumeUnknownField(field); + + if (stackSize != stack.size()) + { + stream.Failed(); + return; + } + } + } + + template + bool ProtoMessageReceiverBase::DeserializeFields(infra::ProtoParser::PartialField& field, infra::ProtoParser& parser, Message& message, std::index_sequence) + { + return (DeserializeSingleField(field, parser, message) || ...); + } + + template + bool ProtoMessageReceiverBase::DeserializeSingleField(infra::ProtoParser::PartialField& field, infra::ProtoParser& parser, Message& message) + { + if (field.second == Message::template fieldNumber) + { + DeserializeField(typename Message::template ProtoType(), parser, field.first, message.Get(std::integral_constant())); + return true; + } + + return false; + } + + template + void ProtoMessageReceiverBase::DeserializeField(ProtoEnum, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Enum& value) const + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + value = static_cast(field.Get()); + } + + template + void ProtoMessageReceiverBase::DeserializeField(ProtoMessage, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Message& value) + { + parser.ReportFormatResult(field.Is()); + if (field.Is()) + { + auto messageSize = field.Get().length; + stack.emplace_back(messageSize, [this, &value](const infra::DataInputStream& stream) + { + FeedForMessage(stream, value); + }); + infra::ReConstruct(value); + } + } + + template + void ProtoMessageReceiverBase::DeserializeField(ProtoRepeatedBase, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Type& value) const + { + parser.ReportFormatResult(!value.full()); + if (!value.full()) + { + value.emplace_back(); + DeserializeField(ProtoType(), parser, field, value.back()); + } + } + + template + void ProtoMessageReceiverBase::DeserializeField(ProtoUnboundedRepeated, infra::ProtoParser& parser, infra::ProtoParser::PartialFieldVariant& field, Type& value) const + { + value.emplace_back(); + DeserializeField(ProtoType(), parser, field, value.back()); + } + + template + ProtoMessageReceiver::ProtoMessageReceiver() + : ProtoMessageReceiverBase(stack) + {} +} + +#endif diff --git a/protobuf/echo/ProtoMessageSender.cpp b/protobuf/echo/ProtoMessageSender.cpp new file mode 100644 index 000000000..c9a4c0b8d --- /dev/null +++ b/protobuf/echo/ProtoMessageSender.cpp @@ -0,0 +1,132 @@ +#include "protobuf/echo/ProtoMessageSender.hpp" +#include "infra/stream/BufferingStreamWriter.hpp" + +namespace services +{ + ProtoMessageSenderBase::ProtoMessageSenderBase(infra::BoundedVector>>& stack) + : stack(stack) + {} + + void ProtoMessageSenderBase::Fill(infra::DataOutputStream output) + { + infra::BufferingStreamWriter writer{ buffer, output.Writer() }; + + while (!stack.empty()) + { + infra::DataOutputStream stream{ writer, output.ErrorPolicy() }; + + auto& [index, callback] = stack.back(); + bool retry = false; + auto result = callback(stream, index, retry, output.Writer()); + if (result) + stack.pop_back(); + else if (!retry) + break; + } + } + + bool ProtoMessageSenderBase::SerializeField(ProtoBool, infra::ProtoFormatter& formatter, bool value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoBool(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoUInt32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoUInt32(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoInt32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoInt32(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoUInt64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoUInt64(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoInt64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoInt64(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoFixed32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoFixed32(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoSFixed32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoSFixed32(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoFixed64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoFixed64(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoSFixed64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoSFixed64(), formatter, value, fieldNumber); + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoStringBase, infra::ProtoFormatter& formatter, const infra::BoundedString& value, uint32_t fieldNumber, bool& retry) const + { + formatter.PutVarInt((fieldNumber << 3) | 2); + formatter.PutVarInt(value.size()); + + stack.emplace_back(0, [&value](infra::DataOutputStream& stream, uint32_t& index, const bool&, const infra::StreamWriter&) + { + auto range = infra::Head(infra::DiscardHead(infra::StringAsByteRange(value), index), stream.Available()); + stream << range; + index += range.size(); + return index == value.size(); + }); + + retry = true; + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoUnboundedString, infra::ProtoFormatter& formatter, const std::string& value, uint32_t fieldNumber, bool& retry) const + { + formatter.PutVarInt((fieldNumber << 3) | 2); + formatter.PutVarInt(value.size()); + + stack.emplace_back(0, [&value](infra::DataOutputStream& stream, uint32_t& index, const bool&, const infra::StreamWriter&) + { + auto range = infra::Head(infra::DiscardHead(infra::StdStringAsByteRange(value), index), stream.Available()); + stream << range; + index += range.size(); + return index == value.size(); + }); + + retry = true; + return true; + } + + bool ProtoMessageSenderBase::SerializeField(ProtoBytesBase, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber, bool& retry) const + { + formatter.PutVarInt((fieldNumber << 3) | 2); + formatter.PutVarInt(value.size()); + + stack.emplace_back(0, [&value](infra::DataOutputStream& stream, uint32_t& index, const bool&, const infra::StreamWriter&) + { + auto range = infra::Head(infra::DiscardHead(infra::MakeRange(value), index), stream.Available()); + stream << range; + index += range.size(); + return index == value.size(); + }); + + retry = true; + return true; + } +} diff --git a/protobuf/echo/ProtoMessageSender.hpp b/protobuf/echo/ProtoMessageSender.hpp new file mode 100644 index 000000000..930c3df9f --- /dev/null +++ b/protobuf/echo/ProtoMessageSender.hpp @@ -0,0 +1,180 @@ +#ifndef PROTOBUF_PROTO_MESSAGE_SENDER_HPP +#define PROTOBUF_PROTO_MESSAGE_SENDER_HPP + +#include "infra/stream/CountingOutputStream.hpp" +#include "infra/syntax/ProtoFormatter.hpp" +#include "infra/util/BoundedDeque.hpp" +#include "infra/util/BoundedVector.hpp" +#include "protobuf/echo/Proto.hpp" + +namespace services +{ + class ProtoMessageSenderBase + { + public: + explicit ProtoMessageSenderBase(infra::BoundedVector>>& stack); + + void Fill(infra::DataOutputStream output); + + protected: + template + bool FillForMessage(infra::DataOutputStream& stream, const Message& message, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter) const; + + private: + template + bool SerializeFields(infra::ProtoFormatter& formatter, const Message& message, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter, std::index_sequence) const; + + template + bool SerializeSingleField(infra::ProtoFormatter& formatter, const Message& message, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter) const; + + bool SerializeField(ProtoBool, infra::ProtoFormatter& formatter, bool value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoUInt32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoInt32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoUInt64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoInt64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoFixed32, infra::ProtoFormatter& formatter, uint32_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoSFixed32, infra::ProtoFormatter& formatter, int32_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoFixed64, infra::ProtoFormatter& formatter, uint64_t value, uint32_t fieldNumber, const bool& retry) const; + bool SerializeField(ProtoSFixed64, infra::ProtoFormatter& formatter, int64_t value, uint32_t fieldNumber, const bool& retry) const; + + bool SerializeField(ProtoStringBase, infra::ProtoFormatter& formatter, const infra::BoundedString& value, uint32_t fieldNumber, bool& retry) const; + bool SerializeField(ProtoUnboundedString, infra::ProtoFormatter& formatter, const std::string& value, uint32_t fieldNumber, bool& retry) const; + bool SerializeField(ProtoBytesBase, infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber, bool& retry) const; + + template + bool SerializeField(ProtoEnum, infra::ProtoFormatter& formatter, const Enum& value, uint32_t fieldNumber, const bool& retry) const; + template + bool SerializeField(ProtoMessage, infra::ProtoFormatter& formatter, const Message& value, uint32_t fieldNumber, bool& retry) const; + template + bool SerializeField(ProtoRepeatedBase, const infra::ProtoFormatter& formatter, const infra::BoundedVector& value, uint32_t fieldNumber, bool& retry) const; + template + bool SerializeField(ProtoUnboundedRepeated, const infra::ProtoFormatter& formatter, const std::vector& value, uint32_t fieldNumber, bool& retry) const; + + private: + infra::BoundedDeque::WithMaxSize<32> buffer; + infra::BoundedVector>>& stack; + }; + + template + class ProtoMessageSender + : public ProtoMessageSenderBase + { + public: + explicit ProtoMessageSender(const Message& message); + + private: + const Message& message; + infra::BoundedVector>>::WithMaxSize>::value + 1> stack{ { std::pair>{ 0, [this](infra::DataOutputStream& stream, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter) + { + return FillForMessage(stream, message, index, retry, finalWriter); + } } } }; + }; + + //// Implementation //// + + template + bool ProtoMessageSenderBase::FillForMessage(infra::DataOutputStream& stream, const Message& message, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter) const + { + infra::ProtoFormatter formatter{ stream }; + + return SerializeFields(formatter, message, index, retry, finalWriter, std::make_index_sequence{}); + } + + template + bool ProtoMessageSenderBase::SerializeFields(infra::ProtoFormatter& formatter, const Message& message, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter, std::index_sequence) const + { + return (SerializeSingleField(formatter, message, index, retry, finalWriter) && ...); + } + + template + bool ProtoMessageSenderBase::SerializeSingleField(infra::ProtoFormatter& formatter, const Message& message, uint32_t& index, bool& retry, const infra::StreamWriter& finalWriter) const + { + if (finalWriter.Available() == 0) + return false; + + if (index == I) + { + if (!SerializeField(typename Message::template ProtoType(), formatter, message.Get(std::integral_constant()), Message::template fieldNumber, retry)) + return false; + + index = I + 1; + return !retry; + } + + return true; + } + + template + bool ProtoMessageSenderBase::SerializeField(ProtoEnum, infra::ProtoFormatter& formatter, const Enum& value, uint32_t fieldNumber, [[maybe_unused]] const bool& retry) const + { + services::SerializeField(ProtoEnum(), formatter, value, fieldNumber); + return true; + } + + template + bool ProtoMessageSenderBase::SerializeField(ProtoMessage, infra::ProtoFormatter& formatter, const Message& value, uint32_t fieldNumber, bool& retry) const + { + infra::DataOutputStream::WithWriter countingStream; + infra::ProtoFormatter countingFormatter{ countingStream }; + value.Serialize(countingFormatter); + formatter.PutLengthDelimitedSize(countingStream.Writer().Processed(), fieldNumber); + + stack.emplace_back(0, [this, &value](infra::DataOutputStream& stream, uint32_t& index, bool& retry2, const infra::StreamWriter& finalWriter) + { + return FillForMessage(stream, value, index, retry2, finalWriter); + }); + + retry = true; + return true; + } + + template + bool ProtoMessageSenderBase::SerializeField(ProtoRepeatedBase, const infra::ProtoFormatter&, const infra::BoundedVector& value, uint32_t fieldNumber, bool& retry) const + { + stack.emplace_back(0, [this, &value, fieldNumber](infra::DataOutputStream& stream, uint32_t& index, const bool&, const infra::StreamWriter& finalWriter) + { + infra::ProtoFormatter formatter{ stream }; + + for (; index != value.size(); ++index) + { + if (finalWriter.Available() == 0) + return false; + services::SerializeField(ProtoType(), formatter, value[index], fieldNumber); + } + + return true; + }); + + retry = true; + return true; + } + + template + bool ProtoMessageSenderBase::SerializeField(ProtoUnboundedRepeated, const infra::ProtoFormatter&, const std::vector& value, uint32_t fieldNumber, bool& retry) const + { + stack.emplace_back(0, [this, &value, fieldNumber](infra::DataOutputStream& stream, uint32_t& index, const bool&, const infra::StreamWriter& finalWriter) + { + infra::ProtoFormatter formatter{ stream }; + + for (; index != value.size(); ++index) + { + if (finalWriter.Available() == 0) + return false; + services::SerializeField(ProtoType(), formatter, value[index], fieldNumber); + } + + return true; + }); + + retry = true; + return true; + } + + template + ProtoMessageSender::ProtoMessageSender(const Message& message) + : ProtoMessageSenderBase(stack) + , message(message) + {} +} + +#endif diff --git a/protobuf/echo/Serialization.cpp b/protobuf/echo/Serialization.cpp new file mode 100644 index 000000000..aea1646c9 --- /dev/null +++ b/protobuf/echo/Serialization.cpp @@ -0,0 +1,64 @@ +#include "protobuf/echo/Serialization.hpp" +#include "protobuf/echo/Echo.hpp" + +namespace services +{ + MethodDeserializerDummy::MethodDeserializerDummy(Echo& echo) + : echo(echo) + {} + + void MethodDeserializerDummy::MethodContents(infra::SharedPtr&& reader) + { + while (!reader->Empty()) + reader->ExtractContiguousRange(std::numeric_limits::max()); + + reader = nullptr; + } + + void MethodDeserializerDummy::ExecuteMethod() + { + echo.ServiceDone(); + } + + bool MethodDeserializerDummy::Failed() const + { + return false; + } + + infra::SharedPtr MethodSerializerFactory::MakeDummyDeserializer(Echo& echo) + { + using Deserializer = MethodDeserializerDummy; + + auto memory = DeserializerMemory(sizeof(Deserializer)); + auto deserializer = new (memory->begin()) Deserializer(echo); + return infra::MakeContainedSharedObject(*deserializer, memory); + } + + infra::SharedPtr MethodSerializerFactory::OnHeap::SerializerMemory(uint32_t size) + { + auto m = new uint8_t[size]; + serializerMemory = { m, + m + size }; + return serializerAccess.MakeShared(serializerMemory); + } + + infra::SharedPtr MethodSerializerFactory::OnHeap::DeserializerMemory(uint32_t size) + { + auto m = new uint8_t[size]; + deserializerMemory = { m, + m + size }; + return deserializerAccess.MakeShared(deserializerMemory); + } + + void MethodSerializerFactory::OnHeap::DeAllocateSerializer() + { + delete[] serializerMemory.begin(); + serializerMemory = {}; + } + + void MethodSerializerFactory::OnHeap::DeAllocateDeserializer() + { + delete[] deserializerMemory.begin(); + deserializerMemory = {}; + } +} diff --git a/protobuf/echo/Serialization.hpp b/protobuf/echo/Serialization.hpp new file mode 100644 index 000000000..0221d9e44 --- /dev/null +++ b/protobuf/echo/Serialization.hpp @@ -0,0 +1,350 @@ +#ifndef PROTOBUF_SERIALIZATION_HPP +#define PROTOBUF_SERIALIZATION_HPP + +#include "infra/util/ReallyAssert.hpp" +#include "infra/util/SharedOptional.hpp" +#include "protobuf/echo/ProtoMessageReceiver.hpp" +#include "protobuf/echo/ProtoMessageSender.hpp" + +namespace services +{ + class Echo; + + class MethodDeserializer + { + public: + MethodDeserializer() = default; + MethodDeserializer(const MethodDeserializer& other) = delete; + MethodDeserializer& operator=(const MethodDeserializer& other) = delete; + virtual ~MethodDeserializer() = default; + + virtual void MethodContents(infra::SharedPtr&& reader) = 0; + virtual void ExecuteMethod() = 0; + virtual bool Failed() const = 0; + }; + + class MethodSerializer + { + public: + MethodSerializer() = default; + MethodSerializer(const MethodSerializer& other) = delete; + MethodSerializer& operator=(const MethodSerializer& other) = delete; + virtual ~MethodSerializer() = default; + + virtual bool Serialize(infra::SharedPtr&& writer) = 0; + + virtual void SerializationDone() + {} + }; + + class MethodDeserializerDummy + : public MethodDeserializer + { + public: + explicit MethodDeserializerDummy(Echo& echo); + + void MethodContents(infra::SharedPtr&& reader) override; + void ExecuteMethod() override; + bool Failed() const override; + + private: + Echo& echo; + }; + + template + class MethodDeserializerImpl + : public MethodDeserializer + { + public: + explicit MethodDeserializerImpl(const infra::Function& method); + + void MethodContents(infra::SharedPtr&& reader) override; + void ExecuteMethod() override; + bool Failed() const override; + + private: + template + void Execute(std::index_sequence); + + private: + ProtoMessageReceiver receiver; + infra::Function method; + }; + + template + class MethodSerializerImpl + : public MethodSerializer + { + public: + MethodSerializerImpl(uint32_t serviceId, uint32_t methodId, Args... args); + + bool Serialize(infra::SharedPtr&& writer) override; + + private: + uint32_t serviceId; + uint32_t methodId; + bool headerSent = false; + Message message; + ProtoMessageSender sender{ message }; + }; + + class MethodSerializerFactory + { + public: + template + class ForServices; + + class OnHeap; + + MethodSerializerFactory() = default; + MethodSerializerFactory(const MethodSerializerFactory& other) = delete; + MethodSerializerFactory& operator=(const MethodSerializerFactory& other) = delete; + virtual ~MethodSerializerFactory() = default; + + virtual infra::SharedPtr SerializerMemory(uint32_t size) = 0; + virtual infra::SharedPtr DeserializerMemory(uint32_t size) = 0; + + template + infra::SharedPtr MakeSerializer(uint32_t serviceId, uint32_t methodId, Args... args); + + template + infra::SharedPtr MakeDeserializer(const infra::Function& method); + + infra::SharedPtr MakeDummyDeserializer(Echo& echo); + }; + + class EmptyMessage + { + public: + static const uint32_t numberOfFields = 0; + template + using ProtoType = void; + template + using Type = void; + template + static const uint32_t fieldNumber = 0; + + public: + void Serialize([[maybe_unused]] infra::ProtoFormatter& formatter) const + {} + }; + + template + struct MaxSerializerSize; + + template<> + struct MaxSerializerSize> + { + static constexpr std::size_t maxSize = sizeof(MethodSerializerImpl); + }; + + template + struct MaxSerializerSize> + { + static constexpr std::size_t maxSize = std::max(sizeof(MethodSerializerImpl), MaxSerializerSize>::maxSize); + }; + + template + struct MaxDeserializerSize; + + template<> + struct MaxDeserializerSize> + { + static constexpr std::size_t maxSize = sizeof(MethodDeserializerImpl); + }; + + template + struct MaxDeserializerSize> + { + static constexpr std::size_t maxSize = std::max(sizeof(MethodDeserializerImpl), MaxDeserializerSize>::maxSize); + }; + + template + struct MaxServiceSize; + + template<> + struct MaxServiceSize<> + { + static constexpr std::size_t maxSize = sizeof(MethodDeserializerDummy); + }; + + template + struct MaxServiceSize + { + static constexpr std::size_t maxSize = std::max(MaxDeserializerSize::maxSize, MaxServiceSize::maxSize); + }; + + template + struct MaxServiceProxySize; + + template<> + struct MaxServiceProxySize<> + { + static constexpr std::size_t maxSize = sizeof(MethodSerializerImpl); + }; + + template + struct MaxServiceProxySize + { + static constexpr std::size_t maxSize = std::max(MaxSerializerSize::maxSize, MaxServiceProxySize::maxSize); + }; + + template + class MethodSerializerFactory::ForServices + { + public: + template + class AndProxies; + }; + + template + template + class MethodSerializerFactory::ForServices::AndProxies + : public MethodSerializerFactory + { + public: + infra::SharedPtr SerializerMemory(uint32_t size) override; + infra::SharedPtr DeserializerMemory(uint32_t size) override; + + private: + alignas(std::max_align_t) std::array::maxSize> serializerStorage; + alignas(std::max_align_t) std::array::maxSize> deserializerStorage; + infra::ByteRange serializerMemory; + infra::ByteRange deserializerMemory; + infra::AccessedBySharedPtr serializerAccess{ infra::emptyFunction }; + infra::AccessedBySharedPtr deserializerAccess{ infra::emptyFunction }; + }; + + class MethodSerializerFactory::OnHeap + : public MethodSerializerFactory + { + public: + infra::SharedPtr SerializerMemory(uint32_t size) override; + infra::SharedPtr DeserializerMemory(uint32_t size) override; + + private: + void DeAllocateSerializer(); + void DeAllocateDeserializer(); + + private: + infra::AccessedBySharedPtr serializerAccess{ + [this]() + { + DeAllocateSerializer(); + } + }; + + infra::AccessedBySharedPtr deserializerAccess{ + [this]() + { + DeAllocateDeserializer(); + } + }; + + infra::ByteRange serializerMemory; + infra::ByteRange deserializerMemory; + }; + + //// Implementation //// + + template + MethodDeserializerImpl::MethodDeserializerImpl(const infra::Function& method) + : method(method) + {} + + template + void MethodDeserializerImpl::MethodContents(infra::SharedPtr&& reader) + { + receiver.Feed(*reader); + } + + template + void MethodDeserializerImpl::ExecuteMethod() + { + Execute(std::make_index_sequence{}); + } + + template + bool MethodDeserializerImpl::Failed() const + { + return receiver.Failed(); + } + + template + template + void MethodDeserializerImpl::Execute(std::index_sequence) + { + method(receiver.message.Get(std::integral_constant{})...); + } + + template + MethodSerializerImpl::MethodSerializerImpl(uint32_t serviceId, uint32_t methodId, Args... args) + : serviceId(serviceId) + , methodId(methodId) + , message(args...) + {} + + template + bool MethodSerializerImpl::Serialize(infra::SharedPtr&& writer) + { + infra::DataOutputStream::WithErrorPolicy stream(*writer, infra::softFail); + + if (!headerSent) + { + std::array saveStateStorage; // For writing length fields + infra::DataOutputStream::WithWriter countingStream(saveStateStorage); + infra::ProtoFormatter countingFormatter{ countingStream }; + message.Serialize(countingFormatter); + + infra::ProtoFormatter formatter(stream); + formatter.PutVarInt(serviceId); + formatter.PutLengthDelimitedSize(countingStream.Writer().Processed(), methodId); + + headerSent = true; + } + + sender.Fill(stream); + writer = nullptr; + return stream.Failed(); + } + + template + infra::SharedPtr MethodSerializerFactory::MakeSerializer(uint32_t serviceId, uint32_t methodId, Args... args) + { + using Serializer = MethodSerializerImpl; + + auto memory = SerializerMemory(sizeof(Serializer)); + auto serializer = new (memory->begin()) Serializer(serviceId, methodId, args...); + return infra::MakeContainedSharedObject(*serializer, memory); + } + + template + infra::SharedPtr MethodSerializerFactory::MakeDeserializer(const infra::Function& method) + { + using Deserializer = MethodDeserializerImpl; + + auto memory = DeserializerMemory(sizeof(Deserializer)); + auto deserializer = new (memory->begin()) Deserializer(method); + return infra::MakeContainedSharedObject(*deserializer, memory); + } + + template + template + infra::SharedPtr MethodSerializerFactory::ForServices::AndProxies::SerializerMemory(uint32_t size) + { + really_assert(size <= serializerStorage.size()); + serializerMemory = infra::Head(infra::MakeRange(serializerStorage), size); + return serializerAccess.MakeShared(serializerMemory); + } + + template + template + infra::SharedPtr MethodSerializerFactory::ForServices::AndProxies::DeserializerMemory(uint32_t size) + { + really_assert(size <= deserializerStorage.size()); + deserializerMemory = infra::Head(infra::MakeRange(deserializerStorage), size); + return deserializerAccess.MakeShared(deserializerMemory); + } +} + +#endif diff --git a/protobuf/echo/ServiceForwarder.cpp b/protobuf/echo/ServiceForwarder.cpp index 5bb906fc9..293805633 100644 --- a/protobuf/echo/ServiceForwarder.cpp +++ b/protobuf/echo/ServiceForwarder.cpp @@ -2,46 +2,82 @@ namespace services { - ServiceForwarderBase::ServiceForwarderBase(infra::ByteRange messageBuffer, Echo& echo, Echo& forwardTo) + ServiceForwarderBase::ServiceForwarderBase(Echo& echo, Echo& forwardTo) : Service(echo) - , ServiceProxy(forwardTo, messageBuffer.size()) - , messageBuffer(messageBuffer) + , ServiceProxy(forwardTo, 0) {} - void ServiceForwarderBase::Handle(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, EchoErrorPolicy& errorPolicy) + infra::SharedPtr ServiceForwarderBase::StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const EchoErrorPolicy& errorPolicy) { - this->forwardingServiceId = serviceId; - bytes.Emplace(messageBuffer); - uint32_t processedSize = 0; + forwardingServiceId = serviceId; + forwardingMethodId = methodId; + forwardingSize = size; + processedSize = 0; + sentHeader = false; - while (true) + RequestSend([this]() + { + SetSerializer(infra::UnOwnedSharedPtr(static_cast(*this))); + }, + size); + + return infra::UnOwnedSharedPtr(static_cast(*this)); + } + + void ServiceForwarderBase::MethodContents(infra::SharedPtr&& reader) + { + contentsReader = std::move(reader); + Transfer(); + } + + void ServiceForwarderBase::ExecuteMethod() + { + MethodDone(); + } + + bool ServiceForwarderBase::Failed() const + { + return false; + } + + bool ServiceForwarderBase::Serialize(infra::SharedPtr&& writer) + { + contentsWriter = std::move(writer); + auto result = processedSize + contentsWriter->Available() < forwardingSize; + Transfer(); + + return result; + } + + void ServiceForwarderBase::Transfer() + { + if (!sentHeader) { - infra::ConstByteRange contiguousBytes; - contents.GetBytesReference(contiguousBytes); + if (contentsWriter == nullptr) + return; + + infra::DataOutputStream::WithErrorPolicy stream(*contentsWriter); - if (contiguousBytes.size() == 0) - break; + infra::ProtoFormatter formatter(stream); + formatter.PutVarInt(forwardingServiceId); + formatter.PutLengthDelimitedSize(forwardingSize, forwardingMethodId); - std::copy(contiguousBytes.begin(), contiguousBytes.end(), bytes->begin() + processedSize); - processedSize += contiguousBytes.size(); + sentHeader = true; } - bytes->shrink_from_back_to(processedSize); + infra::StreamErrorPolicy errorPolicy; - uint32_t messageSize = infra::MaxVarIntSize(this->forwardingServiceId) + infra::MaxVarIntSize((methodId << 3) | 2) + infra::MaxVarIntSize(bytes->size()) + bytes->size(); + while (processedSize != forwardingSize && contentsWriter != nullptr && contentsReader != nullptr) + { + auto range = contentsReader->ExtractContiguousRange(forwardingSize - processedSize); + contentsWriter->Insert(range, errorPolicy); + processedSize += range.size(); + } - RequestSend([this, methodId]() - { - infra::DataOutputStream::WithErrorPolicy stream(services::ServiceProxy::Rpc().SendStreamWriter()); - infra::ProtoFormatter formatter(stream); - formatter.PutVarInt(this->forwardingServiceId); - formatter.PutBytesField(*bytes, methodId); - bytes = infra::none; - - services::ServiceProxy::Rpc().Send(); - MethodDone(); - }, - messageSize); + if (processedSize == forwardingSize || (contentsReader != nullptr && contentsReader->Empty())) + contentsReader = nullptr; + if (processedSize == forwardingSize || (contentsWriter != nullptr && contentsWriter->Empty())) + contentsWriter = nullptr; } bool ServiceForwarderAll::AcceptsService(uint32_t id) const @@ -49,8 +85,8 @@ namespace services return true; } - ServiceForwarder::ServiceForwarder(infra::ByteRange messageBuffer, Echo& echo, uint32_t id, Echo& forwardTo) - : ServiceForwarderBase(messageBuffer, echo, forwardTo) + ServiceForwarder::ServiceForwarder(Echo& echo, uint32_t id, Echo& forwardTo) + : ServiceForwarderBase(echo, forwardTo) , serviceId(id) {} diff --git a/protobuf/echo/ServiceForwarder.hpp b/protobuf/echo/ServiceForwarder.hpp index fe8113934..0d7f1c2e4 100644 --- a/protobuf/echo/ServiceForwarder.hpp +++ b/protobuf/echo/ServiceForwarder.hpp @@ -6,18 +6,38 @@ namespace services { class ServiceForwarderBase - : public services::Service - , private services::ServiceProxy + : public Service + , private ServiceProxy + , private MethodDeserializer + , private MethodSerializer { public: - ServiceForwarderBase(infra::ByteRange messageBuffer, Echo& echo, Echo& forwardTo); + ServiceForwarderBase(Echo& echo, Echo& forwardTo); - void Handle(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, EchoErrorPolicy& errorPolicy) override; + // Implementation of Service + infra::SharedPtr StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const EchoErrorPolicy& errorPolicy) override; + + private: + // Implementation of MethodDeserializer + void MethodContents(infra::SharedPtr&& reader) override; + void ExecuteMethod() override; + bool Failed() const override; + + // Implementation of MethodSerializer + bool Serialize(infra::SharedPtr&& writer) override; + + private: + void Transfer(); private: - const infra::ByteRange messageBuffer; - infra::Optional bytes; uint32_t forwardingServiceId; + uint32_t forwardingMethodId; + uint32_t forwardingSize; + uint32_t processedSize; + bool sentHeader; + + infra::SharedPtr contentsReader; + infra::SharedPtr contentsWriter; }; class ServiceForwarderAll @@ -26,9 +46,6 @@ namespace services public: using ServiceForwarderBase::ServiceForwarderBase; - template - using WithMaxMessageSize = infra::WithStorage>; - bool AcceptsService(uint32_t id) const override; }; @@ -36,10 +53,7 @@ namespace services : public ServiceForwarderBase { public: - ServiceForwarder(infra::ByteRange messageBuffer, Echo& echo, uint32_t id, Echo& forwardTo); - - template - using WithMaxMessageSize = infra::WithStorage>; + ServiceForwarder(Echo& echo, uint32_t id, Echo& forwardTo); bool AcceptsService(uint32_t id) const override; diff --git a/protobuf/echo/protocol_buffer_echo.cmake b/protobuf/echo/protocol_buffer_echo.cmake index ef1bf83bb..d69bb6fc8 100644 --- a/protobuf/echo/protocol_buffer_echo.cmake +++ b/protobuf/echo/protocol_buffer_echo.cmake @@ -17,7 +17,7 @@ function(emil_fetch_echo_plugins) return() endif() - set(emil_version "4.0.0") # x-release-please-version + set(emil_version "5.0.1") # x-release-please-version if (CMAKE_HOST_WIN32) set(os_postfix "win64") diff --git a/protobuf/echo/test/CMakeLists.txt b/protobuf/echo/test/CMakeLists.txt index 3176af5dc..6fb247752 100644 --- a/protobuf/echo/test/CMakeLists.txt +++ b/protobuf/echo/test/CMakeLists.txt @@ -2,8 +2,11 @@ add_executable(protobuf.echo_test) emil_build_for(protobuf.echo_test BOOL EMIL_BUILD_TESTS) emil_add_test(protobuf.echo_test) +protocol_buffer_echo_cpp(protobuf.echo_test TestMessages.proto) + target_sources(protobuf.echo_test PRIVATE - TestEchoServiceResponseQueue.cpp + TestProtoMessageReceiver.cpp + TestProtoMessageSender.cpp TestServiceForwarder.cpp ) diff --git a/protobuf/echo/test/TestEchoServiceResponseQueue.cpp b/protobuf/echo/test/TestEchoServiceResponseQueue.cpp deleted file mode 100644 index 93f6e7169..000000000 --- a/protobuf/echo/test/TestEchoServiceResponseQueue.cpp +++ /dev/null @@ -1,66 +0,0 @@ -#include "infra/util/Function.hpp" -#include "infra/util/test_helper/MockCallback.hpp" -#include "protobuf/echo/Echo.hpp" -#include "protobuf/echo/test_doubles/EchoMock.hpp" -#include "protobuf/echo/test_doubles/ServiceStub.hpp" -#include "gmock/gmock.h" -#include "gtest/gtest.h" - -namespace services -{ - class EchoServiceResponseQueueTest - : public testing::Test - { - public: - testing::StrictMock echo; - testing::StrictMock>::WithStorage<2> serviceProxy{ echo }; - }; - - TEST_F(EchoServiceResponseQueueTest, RequestSendWhileEmptyImmediatelyForwardsRequestToEcho) - { - EXPECT_CALL(echo, RequestSend(testing::Ref(serviceProxy))); - - serviceProxy.RequestSend(infra::emptyFunction); - } - - TEST_F(EchoServiceResponseQueueTest, RequestsNextRequestAfterGrantingAccess) - { - infra::VerifyingFunctionMock request1{}; - infra::VerifyingFunctionMock request2{}; - - EXPECT_CALL(echo, RequestSend(testing::Ref(serviceProxy))).Times(2); - - serviceProxy.RequestSend(request1, 128); - serviceProxy.RequestSend(request2, 50); - - EXPECT_THAT(serviceProxy.CurrentRequestedSize(), testing::Eq(128)); - serviceProxy.GrantSend(); - - EXPECT_THAT(serviceProxy.CurrentRequestedSize(), testing::Eq(50)); - serviceProxy.GrantSend(); - } - - TEST_F(EchoServiceResponseQueueTest, DiscardsRequestWhenQueueFull) - { - infra::VerifyingFunctionMock request1{}; - infra::VerifyingFunctionMock request2{}; - infra::VerifyingFunctionMock request4{}; - - EXPECT_CALL(echo, RequestSend(testing::Ref(serviceProxy))) - .Times(3); - - serviceProxy.RequestSend(request1); - serviceProxy.RequestSend(request2); - - serviceProxy.RequestSend([] - { - FAIL(); - }); - - serviceProxy.GrantSend(); - serviceProxy.GrantSend(); - - serviceProxy.RequestSend(request4); - serviceProxy.GrantSend(); - } -} diff --git a/protobuf/protoc_echo_plugin/test/TestMessages.proto b/protobuf/echo/test/TestMessages.proto similarity index 87% rename from protobuf/protoc_echo_plugin/test/TestMessages.proto rename to protobuf/echo/test/TestMessages.proto index 8f931978e..cf1ee6c9f 100644 --- a/protobuf/protoc_echo_plugin/test/TestMessages.proto +++ b/protobuf/echo/test/TestMessages.proto @@ -64,7 +64,7 @@ message TestRepeatedString { } message TestBytes { - bytes value = 1 [(bytes_size) = 10]; + bytes value = 1 [(bytes_size) = 50]; } message TestUnboundedBytes { @@ -72,7 +72,11 @@ message TestUnboundedBytes { } message TestRepeatedUInt32 { - repeated uint32 value = 1 [(array_size) = 10]; + repeated uint32 value = 1 [(array_size) = 50]; +} + +message TestUnboundedRepeatedUInt32 { + repeated uint32 value = 1; } message TestMessageWithMessageField { @@ -166,5 +170,17 @@ service TestService2 { option (service_id) = 2; - rpc Search (TestString) returns (Nothing) { option (method_id) = 1; } + rpc Search(TestString) returns (Nothing) { option (method_id) = 1; } +} + +service TestServiceNoParameter +{ + option (service_id) = 3; + + rpc Method(Nothing) returns (Nothing) { option (method_id) = 1; } +} + +message TestBoolWithBytes { + bytes b = 1 [(bytes_size) = 30]; + bool value = 2; } diff --git a/protobuf/echo/test/TestProtoMessageReceiver.cpp b/protobuf/echo/test/TestProtoMessageReceiver.cpp new file mode 100644 index 000000000..fe7a83fc0 --- /dev/null +++ b/protobuf/echo/test/TestProtoMessageReceiver.cpp @@ -0,0 +1,222 @@ +#include "generated/echo/TestMessages.pb.hpp" +#include "infra/stream/StdVectorInputStream.hpp" +#include "protobuf/echo/ProtoMessageReceiver.hpp" +#include + +TEST(ProtoMessageReceiverTest, parse_bool) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 1 }); + receiver.Feed(data); + + EXPECT_EQ(true, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_unknown_simple_field) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 2 << 3, 1, 1 << 3, 1 }); + receiver.Feed(data); + + EXPECT_EQ(true, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_unknown_length_delimited) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 1, (2 << 3) | 2, 2, 1 << 3, 0 }); + receiver.Feed(data); + + EXPECT_EQ(true, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_incomplete_bool) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 8 }); + receiver.Feed(data); + + EXPECT_EQ(false, receiver.message.value); + + infra::StdVectorInputStreamReader::WithStorage data2(infra::inPlace, std::initializer_list{ 1 }); + receiver.Feed(data2); + + EXPECT_EQ(true, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_uint32) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 5 }); + receiver.Feed(data); + + EXPECT_EQ(5, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_int32) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 8, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 1 }); + receiver.Feed(data); + + EXPECT_EQ(-1, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_uint64) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 5 }); + receiver.Feed(data); + + EXPECT_EQ(5, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_int64) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 8, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 1 }); + receiver.Feed(data); + + EXPECT_EQ(-1, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_fixed32) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 13, 0x90, 0x91, 0x0f, 0 }); + receiver.Feed(data); + + EXPECT_EQ(1020304, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_fixed64) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 9, 0x64, 0xc8, 0x0c, 0xce, 0xcb, 0x5c, 0x00, 0x00 }); + receiver.Feed(data); + + EXPECT_EQ(102030405060708, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_sfixed32) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 13, 0xff, 0xff, 0xff, 0xff }); + receiver.Feed(data); + + EXPECT_EQ(-1, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_sfixed64) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 9, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }); + receiver.Feed(data); + + EXPECT_EQ(-1, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_enum) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 1 }); + receiver.Feed(data); + + EXPECT_EQ(test_messages::Enumeration::val1, receiver.message.e); +} + +TEST(ProtoMessageReceiverTest, parse_repeated_uint32) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 5, 1 << 3, 6 }); + receiver.Feed(data); + + EXPECT_EQ((infra::BoundedVector::WithMaxSize<10>{ { 5, 6 } }), receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_unbounded_repeated_uint32) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 1 << 3, 5, 1 << 3, 6 }); + receiver.Feed(data); + + EXPECT_EQ((std::vector{ { 5, 6 } }), receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_incomplete_int) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 8, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }); + receiver.Feed(data); + EXPECT_EQ(0, receiver.message.value); + + infra::StdVectorInputStreamReader::WithStorage data2(infra::inPlace, std::initializer_list{ 0xff, 1 }); + receiver.Feed(data2); + EXPECT_EQ(-1, receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_string) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 10, 4, 'a', 'b', 'c', 'd' }); + receiver.Feed(data); + + EXPECT_EQ("abcd", receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_std_string) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 10, 4, 'a', 'b', 'c', 'd' }); + receiver.Feed(data); + + EXPECT_EQ("abcd", receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_bytes) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ 10, 2, 5, 6 }); + receiver.Feed(data); + + EXPECT_EQ((infra::BoundedVector::WithMaxSize<10>{ { 5, 6 } }), receiver.message.value); +} + +TEST(ProtoMessageReceiverTest, parse_message) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ (1 << 3) | 2, 2, 1 << 3, 5 }); + receiver.Feed(data); + + EXPECT_EQ((test_messages::TestMessageWithMessageField(test_messages::TestUInt32(5))), receiver.message.message); +} + +TEST(ProtoMessageReceiverTest, parse_more_nested_message) +{ + services::ProtoMessageReceiver receiver; + + infra::StdVectorInputStreamReader::WithStorage data(infra::inPlace, std::initializer_list{ (1 << 3) | 2, 2, 1 << 3, 5, (2 << 3) | 2, 2, 2 << 3, 10 }); + receiver.Feed(data); + + EXPECT_EQ((test_messages::TestMoreNestedMessage({ 5 }, { 10 })), receiver.message); +} diff --git a/protobuf/echo/test/TestProtoMessageSender.cpp b/protobuf/echo/test/TestProtoMessageSender.cpp new file mode 100644 index 000000000..3cefc4282 --- /dev/null +++ b/protobuf/echo/test/TestProtoMessageSender.cpp @@ -0,0 +1,222 @@ +#include "generated/echo/TestMessages.pb.hpp" +#include "infra/stream/BoundedVectorOutputStream.hpp" +#include "infra/stream/ByteOutputStream.hpp" +#include "infra/stream/StdVectorOutputStream.hpp" +#include "infra/util/ConstructBin.hpp" +#include "protobuf/echo/ProtoMessageSender.hpp" +#include + +class ProtoMessageSenderTest + : public testing::Test +{ +public: + template + void ExpectFill(const std::vector& data, services::ProtoMessageSender& sender) + { + infra::StdVectorOutputStream::WithStorage stream; + sender.Fill(stream); + + EXPECT_EQ(data, stream.Storage()); + } +}; + +TEST_F(ProtoMessageSenderTest, format_bool) +{ + test_messages::TestBool message{ true }; + services::ProtoMessageSender sender(message); + + ExpectFill({ 1 << 3, 1 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_uint32) +{ + test_messages::TestUInt32 message(5); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 1 << 3, 5 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_int32) +{ + test_messages::TestInt32 message(-1); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 8, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 1 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_uint64) +{ + test_messages::TestUInt64 message(5); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 1 << 3, 5 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_int64) +{ + test_messages::TestInt64 message(-1); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 8, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 1 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_fixed32) +{ + test_messages::TestFixed32 message(1020304); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 13, 0x90, 0x91, 0x0f, 0 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_fixed64) +{ + test_messages::TestFixed64 message(102030405060708); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 9, 0x64, 0xc8, 0x0c, 0xce, 0xcb, 0x5c, 0x00, 0x00 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_sfixed32) +{ + test_messages::TestSFixed32 message(-1); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 13, 0xff, 0xff, 0xff, 0xff }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_sfixed64) +{ + test_messages::TestSFixed64 message(-1); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 9, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff }, sender); +} + +TEST_F(ProtoMessageSenderTest, partially_format_bool) +{ + test_messages::TestBool message{ true }; + services::ProtoMessageSender sender(message); + + infra::ByteOutputStream::WithStorage<1> partialStream; + sender.Fill(partialStream); + infra::StdVectorOutputStream::WithStorage stream; + sender.Fill(stream); + + EXPECT_EQ((std::array{ 1 << 3 }), partialStream.Storage()); + EXPECT_EQ((std::vector{ 1 }), stream.Storage()); +} + +TEST_F(ProtoMessageSenderTest, format_enum) +{ + test_messages::TestEnum message{ test_messages::Enumeration::val1 }; + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 1 << 3, 1 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_repeated_uint32) +{ + test_messages::TestRepeatedUInt32 message; + message.value.push_back(5); + message.value.push_back(6); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 1 << 3, 5, 1 << 3, 6 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_unbounded_repeated_uint32) +{ + test_messages::TestUnboundedRepeatedUInt32 message; + message.value.push_back(5); + message.value.push_back(6); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 1 << 3, 5, 1 << 3, 6 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_string) +{ + test_messages::TestString message{ "abcd" }; + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 10, 4, 'a', 'b', 'c', 'd' }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_std_string) +{ + test_messages::TestStdString message{ "abcd" }; + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 10, 4, 'a', 'b', 'c', 'd' }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_bytes) +{ + test_messages::TestBytes message; + message.value.push_back(5); + message.value.push_back(6); + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 10, 2, 5, 6 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_message) +{ + test_messages::TestMessageWithMessageField message{ 5 }; + services::ProtoMessageSender sender{ message }; + + ExpectFill({ 1 << 3 | 2, 2, 1 << 3, 5 }, sender); +} + +TEST_F(ProtoMessageSenderTest, format_more_nested_message) +{ + test_messages::TestMoreNestedMessage message{ { 5 }, { 10 } }; + services::ProtoMessageSender sender{ message }; + + ExpectFill({ (1 << 3) | 2, 2, 1 << 3, 5, (2 << 3) | 2, 2, 2 << 3, 10 }, sender); +} + +TEST_F(ProtoMessageSenderTest, dont_format_on_buffer_full) +{ + test_messages::TestBoolWithBytes message; + message.b.insert(message.b.begin(), 30, static_cast(5)); + message.value = true; + services::ProtoMessageSender sender{ message }; + + infra::ByteOutputStream::WithStorage<1> partialStream; + sender.Fill(partialStream); + + infra::StdVectorOutputStream::WithStorage stream; + sender.Fill(stream); + EXPECT_EQ((std::vector{ 30, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 2 << 3, 1 }), stream.Storage()); +} + +TEST_F(ProtoMessageSenderTest, format_many_repeated_uint32) +{ + test_messages::TestRepeatedUInt32 message; + message.value.insert(message.value.end(), 50, static_cast(5)); + services::ProtoMessageSender sender{ message }; + + infra::ByteOutputStream::WithStorage<10> partialStream; + sender.Fill(partialStream); + EXPECT_EQ((std::array{ 1 << 3, 5, 1 << 3, 5, 1 << 3, 5, 1 << 3, 5, 1 << 3, 5 }), partialStream.Storage()); + + infra::StdVectorOutputStream::WithStorage stream; + sender.Fill(stream); + EXPECT_EQ(infra::ConstructBin().Repeat(45, { 1 << 3, 5 }).Vector(), stream.Storage()); +} + +TEST_F(ProtoMessageSenderTest, format_many_bytes) +{ + test_messages::TestBytes message; + message.value.insert(message.value.end(), 50, static_cast(5)); + services::ProtoMessageSender sender{ message }; + + infra::ByteOutputStream::WithStorage<10> partialStream; + sender.Fill(partialStream); + EXPECT_EQ((std::array{ 10, 50, 5, 5, 5, 5, 5, 5, 5, 5 }), partialStream.Storage()); + + infra::StdVectorOutputStream::WithStorage stream; + sender.Fill(stream); + EXPECT_EQ((std::vector{ 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5 }), stream.Storage()); +} diff --git a/protobuf/echo/test/TestServiceForwarder.cpp b/protobuf/echo/test/TestServiceForwarder.cpp index e359e39dc..87e99171a 100644 --- a/protobuf/echo/test/TestServiceForwarder.cpp +++ b/protobuf/echo/test/TestServiceForwarder.cpp @@ -9,7 +9,7 @@ class ServiceForwarderAllTest public: testing::StrictMock echoFrom; testing::StrictMock echoTo; - services::ServiceForwarderAll::WithMaxMessageSize<100> forwarder{ echoFrom, echoTo }; + services::ServiceForwarderAll forwarder{ echoFrom, echoTo }; testing::StrictMock errorPolicy; }; @@ -25,24 +25,24 @@ TEST_F(ServiceForwarderAllTest, accept_any_service) TEST_F(ServiceForwarderAllTest, forward_message) { - echoFrom.NotifyObservers([this](auto& service) + infra::StdVectorOutputStreamWriter::WithStorage writer; + + echoFrom.NotifyObservers([this, &writer](auto& service) { - infra::StreamErrorPolicy streamErrorPolicy; infra::StdVectorInputStream::WithStorage inputStream{ infra::inPlace, std::vector{ 1, 2, 3, 4, 5 } }; - infra::ProtoLengthDelimited contents{ inputStream, streamErrorPolicy, static_cast(inputStream.Available()) }; - EXPECT_CALL(echoTo, RequestSend(testing::_)).WillOnce(testing::Invoke([this, &service](services::ServiceProxy& serviceProxy) + EXPECT_CALL(echoTo, RequestSend(testing::_)).WillOnce(testing::Invoke([this, &service, &writer](services::ServiceProxy& serviceProxy) { - infra::StdVectorOutputStreamWriter::WithStorage writer; - EXPECT_CALL(echoTo, SendStreamWriter()).WillOnce(testing::ReturnRef(writer)); - EXPECT_CALL(echoTo, Send()); - EXPECT_CALL(echoFrom, ServiceDone(testing::Ref(service))); - serviceProxy.GrantSend(); - - EXPECT_EQ((std::vector{ 1, 42, 5, 1, 2, 3, 4, 5 }), writer.Storage()); + EXPECT_CALL(echoFrom, ServiceDone()); + auto serializer = serviceProxy.GrantSend(); + EXPECT_FALSE(serializer->Serialize(infra::UnOwnedSharedPtr(writer))); })); - service.HandleMethod(1, 5, contents, errorPolicy); + auto deserializer = service.StartMethod(1, 5, 5, errorPolicy); + deserializer->MethodContents(infra::UnOwnedSharedPtr(inputStream.Reader())); + deserializer->ExecuteMethod(); }); + + EXPECT_EQ((std::vector{ 1, 42, 5, 1, 2, 3, 4, 5 }), writer.Storage()); } class ServiceForwarderTest @@ -51,7 +51,7 @@ class ServiceForwarderTest public: testing::StrictMock echoFrom; testing::StrictMock echoTo; - services::ServiceForwarder::WithMaxMessageSize<100> forwarder{ echoFrom, 1, echoTo }; + services::ServiceForwarder forwarder{ echoFrom, 1, echoTo }; testing::StrictMock errorPolicy; }; diff --git a/protobuf/echo/test_doubles/EchoMock.hpp b/protobuf/echo/test_doubles/EchoMock.hpp index f13f91bf5..4080c7172 100644 --- a/protobuf/echo/test_doubles/EchoMock.hpp +++ b/protobuf/echo/test_doubles/EchoMock.hpp @@ -10,27 +10,18 @@ namespace services : public services::Echo { public: - MOCK_METHOD1(RequestSend, void(ServiceProxy& serviceProxy)); - MOCK_METHOD0(SendStreamWriter, infra::StreamWriter&()); - MOCK_METHOD0(Send, void()); - MOCK_METHOD1(ServiceDone, void(Service& service)); + MOCK_METHOD(void, RequestSend, (ServiceProxy & serviceProxy), (override)); + MOCK_METHOD(void, ServiceDone, (), (override)); + MOCK_METHOD(services::MethodSerializerFactory&, SerializerFactory, (), (override)); }; class EchoErrorPolicyMock : public services::EchoErrorPolicy { public: - MOCK_METHOD0(MessageFormatError, void()); - MOCK_METHOD1(ServiceNotFound, void(uint32_t serviceId)); - MOCK_METHOD2(MethodNotFound, void(uint32_t serviceId, uint32_t methodId)); - }; - - class MessageCommunicationMock - : public services::MessageCommunication - { - public: - MOCK_METHOD1(RequestSendMessage, void(uint16_t size)); - MOCK_CONST_METHOD0(MaxSendMessageSize, std::size_t()); + MOCK_METHOD(void, MessageFormatError, (), (const override)); + MOCK_METHOD(void, ServiceNotFound, (uint32_t serviceId), (const override)); + MOCK_METHOD(void, MethodNotFound, (uint32_t serviceId, uint32_t methodId), (const override)); }; } diff --git a/protobuf/echo/test_doubles/EchoSingleLoopback.cpp b/protobuf/echo/test_doubles/EchoSingleLoopback.cpp index 4c1fd3a76..dcece74ff 100644 --- a/protobuf/echo/test_doubles/EchoSingleLoopback.cpp +++ b/protobuf/echo/test_doubles/EchoSingleLoopback.cpp @@ -1,5 +1,4 @@ #include "protobuf/echo/test_doubles/EchoSingleLoopback.hpp" -#include "infra/stream/ByteInputStream.hpp" namespace application { @@ -7,20 +6,37 @@ namespace application { storage.clear(); storage.resize(size); - auto writer = sendStream.Emplace(infra::MakeRange(storage)); - SetStreamWriter(std::move(writer)); + infra::ReConstruct(sendStream, infra::MakeRange(storage)); + SendStreamAvailable(sendStreamAccess.MakeShared(sendStream)); } - void EchoSingleLoopback::BusyServiceDone() + EchoSingleLoopback::~EchoSingleLoopback() { - // In this class, services are never busy, so BusyServiceDone() is never invoked - std::abort(); + ReleaseReader(); } + void EchoSingleLoopback::AckReceived() + {} + void EchoSingleLoopback::SendStreamFilled() { - infra::ByteInputStreamReader reader(infra::MakeRange(storage)); - if (!ProcessMessage(reader)) - errorPolicy.MessageFormatError(); + sending.push_back({ sendStream.Processed().begin(), sendStream.Processed().end() }); + + TryForward(); + } + + void EchoSingleLoopback::TryForward() + { + if (reader.Allocatable() && !sending.empty()) + { + auto data = sending.front(); + sending.pop_front(); + DataReceived(reader.Emplace(infra::MakeRange(data))); + } + } + + void EchoSingleLoopback::ReaderDone() + { + TryForward(); } } diff --git a/protobuf/echo/test_doubles/EchoSingleLoopback.hpp b/protobuf/echo/test_doubles/EchoSingleLoopback.hpp index 73b4fa7a2..e0cc88550 100644 --- a/protobuf/echo/test_doubles/EchoSingleLoopback.hpp +++ b/protobuf/echo/test_doubles/EchoSingleLoopback.hpp @@ -1,9 +1,11 @@ #ifndef PROTOBUF_TEST_HELPER_ECHO_SINGLE_LOOPBACK_HPP #define PROTOBUF_TEST_HELPER_ECHO_SINGLE_LOOPBACK_HPP +#include "infra/stream/ByteInputStream.hpp" #include "infra/stream/ByteOutputStream.hpp" #include "infra/util/SharedOptional.hpp" #include "protobuf/echo/Echo.hpp" +#include namespace application { @@ -12,21 +14,36 @@ namespace application { public: using services::EchoOnStreams::EchoOnStreams; + ~EchoSingleLoopback() override; protected: // Implementation of services::EchoOnStreams void RequestSendStream(std::size_t size) override; - void BusyServiceDone() override; + void AckReceived() override; private: void SendStreamFilled(); + void TryForward(); + void ReaderDone(); private: std::vector storage; - infra::NotifyingSharedOptional sendStream{ [this]() + infra::ByteOutputStreamWriter sendStream{ infra::ByteRange() }; + infra::AccessedBySharedPtr sendStreamAccess{ + [this]() { SendStreamFilled(); - } }; + } + }; + + infra::NotifyingSharedOptional reader{ + [this]() + { + ReaderDone(); + } + }; + + std::deque> sending; }; } diff --git a/protobuf/echo/test_doubles/ServiceStub.cpp b/protobuf/echo/test_doubles/ServiceStub.cpp index a9216d6ee..c71695cca 100644 --- a/protobuf/echo/test_doubles/ServiceStub.cpp +++ b/protobuf/echo/test_doubles/ServiceStub.cpp @@ -2,39 +2,51 @@ namespace services { - void ServiceStub::Handle(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, services::EchoErrorPolicy& errorPolicy) + Message::Message(uint32_t value) + : value(value) + {} + + void Message::Serialize(infra::ProtoFormatter& formatter) const + { + SerializeField(services::ProtoInt32(), formatter, value, 1); + } + + uint32_t& Message::Get(std::integral_constant) + { + return value; + } + + const uint32_t& Message::Get(std::integral_constant) const { - infra::ProtoParser parser(contents.Parser()); + return value; + } + ServiceStub::ServiceStub(Echo& echo) + : Service(echo) + {} + + bool ServiceStub::AcceptsService(uint32_t id) const + { + return id == serviceId; + } + + infra::SharedPtr ServiceStub::StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const services::EchoErrorPolicy& errorPolicy) + { switch (methodId) { - uint32_t value; - case idMethod: - { - while (!parser.Empty()) - { - infra::ProtoParser::Field field = parser.GetField(); - - switch (field.second) + return Rpc().SerializerFactory().MakeDeserializer(infra::Function([this](uint32_t v) + { + Method(v); + })); + case idMethodNoParameter: + return Rpc().SerializerFactory().MakeDeserializer(infra::Function([this]() { - case 1: - DeserializeField(services::ProtoUInt32(), parser, field, value); - break; - default: - if (field.first.Is()) - field.first.Get().SkipEverything(); - break; - } - } - - if (!parser.FormatFailed()) - Method(value); - break; - } + MethodNoParameter(); + })); default: errorPolicy.MethodNotFound(serviceId, methodId); - contents.SkipEverything(); + return Rpc().SerializerFactory().MakeDummyDeserializer(Rpc()); } } @@ -44,13 +56,13 @@ namespace services void ServiceStubProxy::Method(uint32_t value) { - infra::DataOutputStream::WithErrorPolicy stream(Rpc().SendStreamWriter()); - infra::ProtoFormatter formatter(stream); - formatter.PutVarInt(serviceId); - { - infra::ProtoLengthDelimitedFormatter argumentFormatter = formatter.LengthDelimitedFormatter(idMethod); - SerializeField(services::ProtoUInt32(), formatter, value, 1); - } - Rpc().Send(); + auto serializer = Rpc().SerializerFactory().MakeSerializer(serviceId, idMethod, value); + SetSerializer(serializer); + } + + void ServiceStubProxy::MethodNoParameter() + { + auto serializer = Rpc().SerializerFactory().MakeSerializer(serviceId, idMethodNoParameter); + SetSerializer(serializer); } } diff --git a/protobuf/echo/test_doubles/ServiceStub.hpp b/protobuf/echo/test_doubles/ServiceStub.hpp index cca507b0d..4ec33c159 100644 --- a/protobuf/echo/test_doubles/ServiceStub.hpp +++ b/protobuf/echo/test_doubles/ServiceStub.hpp @@ -6,26 +6,52 @@ namespace services { + struct Message + { + public: + static const uint32_t numberOfFields = 1; + template + using ProtoType = ProtoUInt32; + template + using Type = uint32_t; + template + static const uint32_t fieldNumber = 1; + + public: + Message() = default; + Message(uint32_t value); + + void Serialize(infra::ProtoFormatter& formatter) const; + + uint32_t& Get(std::integral_constant); + const uint32_t& Get(std::integral_constant) const; + + public: + uint32_t value = 0; + }; + class ServiceStub : public services::Service { public: - using services::Service::Service; + ServiceStub(Echo& echo); - bool AcceptsService(uint32_t id) const override - { - return id == serviceId; - } + bool AcceptsService(uint32_t id) const override; - MOCK_METHOD1(Method, void(uint32_t value)); + MOCK_METHOD(void, Method, (uint32_t value)); + MOCK_METHOD(void, MethodNoParameter, ()); protected: - void Handle(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, services::EchoErrorPolicy& errorPolicy) override; + infra::SharedPtr StartMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const services::EchoErrorPolicy& errorPolicy) override; public: static const uint32_t serviceId = 1; static const uint32_t idMethod = 1; + static const uint32_t idMethodNoParameter = 3; static const uint32_t maxMessageSize = 18; + + public: + using MethodTypeList = infra::List; }; class ServiceStubProxy @@ -36,11 +62,16 @@ namespace services public: void Method(uint32_t value); + void MethodNoParameter(); public: - static const uint32_t serviceId = 1; - static const uint32_t idMethod = 1; - static const uint32_t maxMessageSize = 18; + static constexpr uint32_t serviceId = 1; + static constexpr uint32_t idMethod = 1; + static const uint32_t idMethodNoParameter = 3; + static constexpr uint32_t maxMessageSize = 18; + + public: + using MethodTypeList = infra::List; }; } diff --git a/protobuf/echo_attributes/EchoAttributes.proto b/protobuf/echo_attributes/EchoAttributes.proto index 6e054e302..206d9acd7 100644 --- a/protobuf/echo_attributes/EchoAttributes.proto +++ b/protobuf/echo_attributes/EchoAttributes.proto @@ -1,6 +1,6 @@ syntax = "proto3"; -option java_package = "com.philips.emil.ProtobufEcho"; +option java_package = "com.philips.emil.protobufEcho"; option java_outer_classname = "EchoAttributesProto"; import "google/protobuf/descriptor.proto"; diff --git a/protobuf/protoc_echo_plugin/CMakeLists.txt b/protobuf/protoc_echo_plugin/CMakeLists.txt index c9f8b14e7..19fce22c6 100644 --- a/protobuf/protoc_echo_plugin/CMakeLists.txt +++ b/protobuf/protoc_echo_plugin/CMakeLists.txt @@ -26,8 +26,8 @@ if (EMIL_HOST_BUILD) if (NOT CMAKE_CROSSCOMPILING) add_executable(protobuf.protoc_echo_plugin) - emil_build_for(protobuf.protoc_echo_plugin BOOL EMIL_STANDALONE) - install(TARGETS protobuf.protoc_echo_plugin EXPORT emilProtobufTargets DESTINATION bin) + emil_build_for(protobuf.protoc_echo_plugin BOOL EMIL_BUILD_ECHO_COMPILERS) + emil_install(protobuf.protoc_echo_plugin EXPORT emilProtobufTargets DESTINATION bin) target_link_libraries(protobuf.protoc_echo_plugin PUBLIC protobuf.protoc_echo_plugin_lib diff --git a/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.cpp b/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.cpp index 493f2b7bc..db61651a2 100644 --- a/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.cpp +++ b/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.cpp @@ -319,7 +319,7 @@ namespace application , prefix(prefix) {} - void MessageTypeMapGenerator::Run(Entities& formatter) + void MessageTypeMapGenerator::Run(Entities& formatter) const { auto typeMapNamespace = std::make_shared("detail"); @@ -331,15 +331,21 @@ namespace application { auto typeMapSpecialization = std::make_shared(MessageName() + "TypeMap"); typeMapSpecialization->TemplateSpecialization(google::protobuf::SimpleItoa(std::distance(message->fields.data(), &field))); - typeMapSpecialization->Add(std::make_shared("ProtoType", field->protoType)); + AddTypeMapProtoType(*field, *typeMapSpecialization); AddTypeMapType(*field, *typeMapSpecialization); + AddTypeMapFieldNumber(*field, *typeMapSpecialization); typeMapNamespace->Add(typeMapSpecialization); } formatter.Add(typeMapNamespace); } - void MessageTypeMapGenerator::AddTypeMapType(EchoField& field, Entities& entities) + void MessageTypeMapGenerator::AddTypeMapProtoType(const EchoField& field, Entities& entities) const + { + entities.Add(std::make_shared("ProtoType", field.protoType)); + } + + void MessageTypeMapGenerator::AddTypeMapType(const EchoField& field, Entities& entities) const { std::string result; StorageTypeVisitor visitor(result); @@ -347,6 +353,11 @@ namespace application entities.Add(std::make_shared("Type", result)); } + void MessageTypeMapGenerator::AddTypeMapFieldNumber(const EchoField& field, Entities& entities) const + { + entities.Add(std::make_shared("fieldNumber", "static const uint32_t", google::protobuf::SimpleItoa(field.number))); + } + std::string MessageTypeMapGenerator::MessageName() const { return prefix + message->name + MessageSuffix(); @@ -357,27 +368,12 @@ namespace application return ""; } - void MessageReferenceTypeMapGenerator::Run(Entities& formatter) + void MessageReferenceTypeMapGenerator::AddTypeMapProtoType(const EchoField& field, Entities& entities) const { - auto typeMapNamespace = std::make_shared("detail"); - - auto typeMapDeclaration = std::make_shared(MessageName() + "TypeMap"); - typeMapDeclaration->TemplateParameter("std::size_t fieldIndex"); - typeMapNamespace->Add(typeMapDeclaration); - - for (auto& field : message->fields) - { - auto typeMapSpecialization = std::make_shared(MessageName() + "TypeMap"); - typeMapSpecialization->TemplateSpecialization(google::protobuf::SimpleItoa(std::distance(message->fields.data(), &field))); - typeMapSpecialization->Add(std::make_shared("ProtoType", field->protoReferenceType)); - AddTypeMapType(*field, *typeMapSpecialization); - typeMapNamespace->Add(typeMapSpecialization); - } - - formatter.Add(typeMapNamespace); + entities.Add(std::make_shared("ProtoType", field.protoReferenceType)); } - void MessageReferenceTypeMapGenerator::AddTypeMapType(EchoField& field, Entities& entities) + void MessageReferenceTypeMapGenerator::AddTypeMapType(const EchoField& field, Entities& entities) const { std::string result; ParameterReferenceTypeVisitor visitor(result); @@ -476,12 +472,16 @@ namespace application { auto typeMap = std::make_shared("public"); + auto numberOfFields = std::make_shared("numberOfFields", "static const uint32_t", google::protobuf::SimpleItoa(message->fields.size())); + typeMap->Add(numberOfFields); auto protoTypeUsing = std::make_shared("ProtoType", "typename " + TypeMapName() + "::ProtoType"); protoTypeUsing->TemplateParameter("std::size_t fieldIndex"); typeMap->Add(protoTypeUsing); auto typeUsing = std::make_shared("Type", "typename " + TypeMapName() + "::Type"); typeUsing->TemplateParameter("std::size_t fieldIndex"); typeMap->Add(typeUsing); + auto fieldNumber = std::make_shared("fieldNumber", "template static const uint32_t", TypeMapName() + "::fieldNumber"); + typeMap->Add(fieldNumber); classFormatter->Add(typeMap); } @@ -493,9 +493,12 @@ namespace application for (auto& field : message->fields) { auto index = std::distance(message->fields.data(), &field); - auto function = std::make_shared("Get", "return " + field->name + ";\n", ClassName() + "::Type<" + google::protobuf::SimpleItoa(index) + ">&", 0); - function->Parameter("std::integral_constant"); - getters->Add(function); + auto functionGet = std::make_shared("Get", "return " + field->name + ";\n", ClassName() + "::Type<" + google::protobuf::SimpleItoa(index) + ">&", 0); + functionGet->Parameter("std::integral_constant"); + getters->Add(functionGet); + auto functionConstGet = std::make_shared("Get", "return " + field->name + ";\n", "const " + ClassName() + "::Type<" + google::protobuf::SimpleItoa(index) + ">&", Function::fConst); + functionConstGet->Parameter("std::integral_constant"); + getters->Add(functionConstGet); } classFormatter->Add(getters); @@ -618,7 +621,7 @@ namespace application for (auto& field : message->fields) printer.Print(R"(case $constant$: - DeserializeField($type$(), parser, field, $name$); + DeserializeField($type$(), parser, field.first, $name$); break; )", "constant", field->constantName, "type", field->protoType, "name", field->name); @@ -740,9 +743,12 @@ namespace application for (auto& field : message->fields) { auto index = std::distance(message->fields.data(), &field); - auto function = std::make_shared("Get", "return " + field->name + ";\n", ClassName() + "::Type<" + google::protobuf::SimpleItoa(index) + ">&", 0); - function->Parameter("std::integral_constant"); - getters->Add(function); + auto functionGet = std::make_shared("Get", "return " + field->name + ";\n", ClassName() + "::Type<" + google::protobuf::SimpleItoa(index) + ">&", 0); + functionGet->Parameter("std::integral_constant"); + getters->Add(functionGet); + auto functionConstGet = std::make_shared("Get", "return " + field->name + ";\n", ClassName() + "::Type<" + google::protobuf::SimpleItoa(index) + ">", Function::fConst); + functionConstGet->Parameter("std::integral_constant"); + getters->Add(functionConstGet); } classFormatter->Add(getters); @@ -820,6 +826,7 @@ namespace application GenerateServiceFunctions(); GenerateServiceProxyFunctions(); GenerateFieldConstants(); + GenerateMethodTypeList(); } void ServiceGenerator::GenerateServiceConstructors() @@ -864,16 +871,16 @@ namespace application functions->Add(serviceMethod); } - auto acceptsService = std::make_shared("AcceptsService", AcceptsServiceBody(), "bool", Function::fConst | Function::fVirtual | Function::fOverride); + auto acceptsService = std::make_shared("AcceptsService", AcceptsServiceBody(), "bool", Function::fConst | Function::fOverride); acceptsService->Parameter("uint32_t id"); functions->Add(acceptsService); - auto handle = std::make_shared("Handle", HandleBody(), "void", Function::fVirtual | Function::fOverride); - handle->Parameter("uint32_t serviceId"); - handle->Parameter("uint32_t methodId"); - handle->Parameter("infra::ProtoLengthDelimited& contents"); - handle->Parameter("services::EchoErrorPolicy& errorPolicy"); - functions->Add(handle); + auto startMethod = std::make_shared("StartMethod", StartMethodBody(), "infra::SharedPtr", Function::fOverride); + startMethod->Parameter("uint32_t serviceId"); + startMethod->Parameter("uint32_t methodId"); + startMethod->Parameter("uint32_t size"); + startMethod->Parameter("const services::EchoErrorPolicy& errorPolicy"); + functions->Add(startMethod); serviceFormatter->Add(functions); } @@ -906,17 +913,37 @@ namespace application { auto fields = std::make_shared("public"); - fields->Add(std::make_shared("serviceId", "static const uint32_t", google::protobuf::SimpleItoa(service->serviceId))); + fields->Add(std::make_shared("serviceId", "static constexpr uint32_t", google::protobuf::SimpleItoa(service->serviceId))); for (auto& method : service->methods) - fields->Add(std::make_shared("id" + method.name, "static const uint32_t", google::protobuf::SimpleItoa(method.methodId))); + fields->Add(std::make_shared("id" + method.name, "static constexpr uint32_t", google::protobuf::SimpleItoa(method.methodId))); - fields->Add(std::make_shared("maxMessageSize", "static const uint32_t", google::protobuf::SimpleItoa(MaxMessageSize()))); + fields->Add(std::make_shared("maxMessageSize", "static constexpr uint32_t", google::protobuf::SimpleItoa(MaxMessageSize()))); serviceFormatter->Add(fields); serviceProxyFormatter->Add(fields); } + void ServiceGenerator::GenerateMethodTypeList() + { + auto methodTypeListAccess = std::make_shared("public"); + + std::string definition; + + for (auto& method : service->methods) + if (method.parameter != nullptr) + { + if (!definition.empty()) + definition += ", "; + definition += method.parameter->qualifiedName; + } + + methodTypeListAccess->Add(std::make_shared("MethodTypeList", "infra::List<" + definition + ">")); + + serviceFormatter->Add(methodTypeListAccess); + serviceProxyFormatter->Add(methodTypeListAccess); + } + uint32_t ServiceGenerator::MaxMessageSize() const { uint32_t result = 0; @@ -947,53 +974,31 @@ namespace application return result.str(); } - std::string ServiceGenerator::HandleBody() const + std::string ServiceGenerator::StartMethodBody() const { std::ostringstream result; { google::protobuf::io::OstreamOutputStream stream(&result); google::protobuf::io::Printer printer(&stream, '$', nullptr); - printer.Print(R"(infra::ProtoParser parser(contents.Parser()); - -switch (methodId) + printer.Print(R"(switch (methodId) { )"); for (auto& method : service->methods) { if (method.parameter) - { - printer.Print(R"( case id$name$: - { - $argument$ argument(parser); - if (!parser.FormatFailed()) - $name$()", - "name", method.name, "argument", method.parameter->qualifiedName); - - for (auto& field : method.parameter->fields) - { - printer.Print("argument.$field$", "field", field->name); - if (&field != &method.parameter->fields.back()) - printer.Print(", "); - } - - printer.Print(R"(); - break; - } -)"); - } + PrintMethodCaseWithParameter(method, printer); else printer.Print(R"( case id$name$: - $name$(); - break; + return Rpc().SerializerFactory().MakeDeserializer(infra::Function([this]() { $name$(); })); )", "name", method.name); } printer.Print(R"( default: errorPolicy.MethodNotFound(serviceId, methodId); - contents.SkipEverything(); + return Rpc().SerializerFactory().MakeDummyDeserializer(Rpc()); )"); printer.Print("}\n"); @@ -1002,6 +1007,66 @@ switch (methodId) return result.str(); } + void ServiceGenerator::PrintMethodCaseWithParameter(const EchoMethod& method, google::protobuf::io::Printer& printer) const + { + printer.Print(R"( case id$name$: + return Rpc().SerializerFactory().MakeDeserializer<$argument$)", + "name", method.name, "argument", method.parameter->qualifiedName); + + for (auto& field : method.parameter->fields) + { + std::string typeName; + ParameterTypeVisitor visitor(typeName); + field->Accept(visitor); + + printer.Print(", $type$", "type", typeName); + } + + printer.Print(">(infra::Functionfields) + { + if (&field != &method.parameter->fields.front()) + printer.Print(", "); + + std::string typeName; + ParameterTypeVisitor visitor(typeName); + field->Accept(visitor); + + printer.Print("$type$", "type", typeName); + } + + printer.Print(")>([this]("); + + for (auto& field : method.parameter->fields) + { + auto index = std::distance(&method.parameter->fields.front(), &field); + if (index != 0) + printer.Print(", "); + + std::string typeName; + ParameterTypeVisitor visitor(typeName); + field->Accept(visitor); + + printer.Print("$type$ v$index$", "type", typeName, "index", google::protobuf::SimpleItoa(index)); + } + + printer.Print(R"() { $name$()", + "name", method.name); + + for (auto& field : method.parameter->fields) + { + auto index = std::distance(&method.parameter->fields.front(), &field); + if (index != 0) + printer.Print(", "); + + printer.Print("v$index$", "index", google::protobuf::SimpleItoa(index)); + } + + printer.Print(R"(); })); +)"); + } + std::string ServiceGenerator::ProxyMethodBody(const EchoMethod& method) const { std::ostringstream result; @@ -1009,34 +1074,29 @@ switch (methodId) google::protobuf::io::OstreamOutputStream stream(&result); google::protobuf::io::Printer printer(&stream, '$', nullptr); - printer.Print(R"(infra::DataOutputStream::WithErrorPolicy stream(Rpc().SendStreamWriter()); -infra::ProtoFormatter formatter(stream); -formatter.PutVarInt(serviceId); -{ - infra::ProtoLengthDelimitedFormatter argumentFormatter = formatter.LengthDelimitedFormatter(id$name$); -)", - "name", method.name); - - if (method.parameter) + if (method.parameter != nullptr) { - printer.Print(" $type$(", "type", method.parameter->qualifiedName); + printer.Print(R"(auto serializer = Rpc().SerializerFactory().MakeSerializer<$type$)", "type", method.parameter->qualifiedName); for (auto& field : method.parameter->fields) { std::string typeName; ParameterTypeVisitor visitor(typeName); field->Accept(visitor); - printer.Print("$field$", "field", field->name); - if (&field != &method.parameter->fields.back()) - printer.Print(", "); + printer.Print(", $type$", "type", typeName); } - - printer.Print(R"().Serialize(formatter); -)"); } + else + printer.Print(R"(auto serializer = Rpc().SerializerFactory().MakeSerializer(serviceId, $methodId$", "methodId", google::protobuf::SimpleItoa(method.methodId)); + + if (method.parameter != nullptr) + for (const auto& field : method.parameter->fields) + printer.Print(", $field$", "field", field->name); - printer.Print(R"(} -Rpc().Send(); + printer.Print(R"(); +SetSerializer(serializer); )"); } @@ -1075,7 +1135,7 @@ Rpc().Send(); { auto functions = std::make_shared("public"); - auto handle = std::make_shared("TraceMethod", TraceMethodBody(), "void", Function::fVirtual | Function::fOverride | Function::fConst); + auto handle = std::make_shared("TraceMethod", TraceMethodBody(), "void", Function::fOverride | Function::fConst); handle->Parameter("uint32_t methodId"); handle->Parameter("infra::ProtoLengthDelimited& contents"); handle->Parameter("services::Tracer& tracer"); @@ -1176,6 +1236,7 @@ switch (methodId) auto includesByHeader = std::make_shared(); includesByHeader->Path("infra/util/BoundedString.hpp"); includesByHeader->Path("infra/util/BoundedVector.hpp"); + includesByHeader->Path("infra/util/VariadicTemplates.hpp"); includesByHeader->Path("protobuf/echo/Echo.hpp"); includesByHeader->Path("infra/syntax/ProtoFormatter.hpp"); includesByHeader->Path("infra/syntax/ProtoParser.hpp"); diff --git a/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.hpp b/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.hpp index 81c3676f6..53479bccb 100644 --- a/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.hpp +++ b/protobuf/protoc_echo_plugin/ProtoCEchoPlugin.hpp @@ -55,10 +55,12 @@ namespace application MessageTypeMapGenerator& operator=(const MessageTypeMapGenerator& other) = delete; ~MessageTypeMapGenerator() = default; - void Run(Entities& formatter); + void Run(Entities& formatter) const; protected: - virtual void AddTypeMapType(EchoField& field, Entities& entities); + virtual void AddTypeMapProtoType(const EchoField& field, Entities& entities) const; + virtual void AddTypeMapType(const EchoField& field, Entities& entities) const; + void AddTypeMapFieldNumber(const EchoField& field, Entities& entities) const; std::string MessageName() const; virtual std::string MessageSuffix() const; @@ -73,10 +75,9 @@ namespace application public: using MessageTypeMapGenerator::MessageTypeMapGenerator; - void Run(Entities& formatter); - protected: - void AddTypeMapType(EchoField& field, Entities& entities) override; + void AddTypeMapProtoType(const EchoField& field, Entities& entities) const override; + void AddTypeMapType(const EchoField& field, Entities& entities) const override; std::string MessageSuffix() const override; }; @@ -156,10 +157,13 @@ namespace application void GenerateServiceFunctions(); void GenerateServiceProxyFunctions(); void GenerateFieldConstants(); + void GenerateMethodTypeList(); uint32_t MaxMessageSize() const; std::string AcceptsServiceBody() const; - std::string HandleBody() const; + std::string StartMethodBody() const; + void PrintMethodCaseWithParameter(const EchoMethod& method, google::protobuf::io::Printer& printer) const; + std::string ProxyMethodBody(const EchoMethod& method) const; private: diff --git a/protobuf/protoc_echo_plugin/test/CMakeLists.txt b/protobuf/protoc_echo_plugin/test/CMakeLists.txt index e301e87a6..9e2eed725 100644 --- a/protobuf/protoc_echo_plugin/test/CMakeLists.txt +++ b/protobuf/protoc_echo_plugin/test/CMakeLists.txt @@ -2,7 +2,7 @@ add_executable(protobuf.protoc_echo_plugin_test) emil_build_for(protobuf.protoc_echo_plugin_test BOOL EMIL_BUILD_TESTS) emil_add_test(protobuf.protoc_echo_plugin_test) -protocol_buffer_echo_cpp(protobuf.protoc_echo_plugin_test TestMessages.proto) +protocol_buffer_echo_cpp(protobuf.protoc_echo_plugin_test ../../echo/test/TestMessages.proto) target_sources(protobuf.protoc_echo_plugin_test PRIVATE TestCppFormatter.cpp diff --git a/protobuf/protoc_echo_plugin/test/TestProtoCEchoPlugin.cpp b/protobuf/protoc_echo_plugin/test/TestProtoCEchoPlugin.cpp index 83aa9272e..5bf5bbf8f 100644 --- a/protobuf/protoc_echo_plugin/test/TestProtoCEchoPlugin.cpp +++ b/protobuf/protoc_echo_plugin/test/TestProtoCEchoPlugin.cpp @@ -159,6 +159,28 @@ TEST(ProtoCEchoPluginTest, deserialize_bool) EXPECT_EQ(true, message.value); } +TEST(ProtoCEchoPluginTest, serialize_enum) +{ + test_messages::TestEnum message; + message.e = test_messages::Enumeration::val1; + + infra::ByteOutputStream::WithStorage<100> stream; + infra::ProtoFormatter formatter(stream); + message.Serialize(formatter); + + EXPECT_EQ((std::array{ 8, 1 }), stream.Writer().Processed()); +} + +TEST(ProtoCEchoPluginTest, deserialize_enum) +{ + std::array data{ 8, 1 }; + infra::ByteInputStream stream(data); + infra::ProtoParser parser(stream); + + test_messages::TestEnum message(parser); + EXPECT_EQ(test_messages::Enumeration::val1, message.e); +} + TEST(ProtoCEchoPluginTest, serialize_string) { test_messages::TestString message; @@ -265,6 +287,32 @@ TEST(ProtoCEchoPluginTest, deserialize_bytes) EXPECT_EQ(value, message.value); } +TEST(ProtoCEchoPluginTest, serialize_unbounded_bytes) +{ + test_messages::TestUnboundedBytes message; + message.value.push_back(5); + message.value.push_back(6); + + infra::ByteOutputStream::WithStorage<100> stream; + infra::ProtoFormatter formatter(stream); + message.Serialize(formatter); + + EXPECT_EQ((std::array{ 10, 2, 5, 6 }), stream.Writer().Processed()); +} + +TEST(ProtoCEchoPluginTest, deserialize_unbounded_bytes) +{ + std::array data{ 10, 2, 5, 6 }; + infra::ByteInputStream stream(data); + infra::ProtoParser parser(stream); + + test_messages::TestUnboundedBytes message(parser); + std::vector value; + value.push_back(5); + value.push_back(6); + EXPECT_EQ(value, message.value); +} + TEST(ProtoCEchoPluginTest, serialize_uint32) { test_messages::TestUInt32 message; @@ -334,6 +382,31 @@ TEST(ProtoCEchoPluginTest, deserialize_repeated_uint32) EXPECT_EQ(6, message.value[1]); } +TEST(ProtoCEchoPluginTest, serialize_unbounded_repeated_uint32) +{ + test_messages::TestUnboundedRepeatedUInt32 message; + message.value.push_back(5); + message.value.push_back(6); + + infra::ByteOutputStream::WithStorage<100> stream; + infra::ProtoFormatter formatter(stream); + message.Serialize(formatter); + + EXPECT_EQ((std::array{ 1 << 3, 5, 1 << 3, 6 }), stream.Writer().Processed()); +} + +TEST(ProtoCEchoPluginTest, deserialize_unbounded_repeated_uint32) +{ + std::array data{ 1 << 3, 5, 1 << 3, 6 }; + infra::ByteInputStream stream(data); + infra::ProtoParser parser(stream); + + test_messages::TestUnboundedRepeatedUInt32 message(parser); + EXPECT_EQ(2, message.value.size()); + EXPECT_EQ(5, message.value[0]); + EXPECT_EQ(6, message.value[1]); +} + TEST(ProtoCEchoPluginTest, serialize_message) { test_messages::TestMessageWithMessageField message; diff --git a/protobuf/protoc_echo_plugin_csharp/CMakeLists.txt b/protobuf/protoc_echo_plugin_csharp/CMakeLists.txt index e4a223263..8e6ae63c8 100644 --- a/protobuf/protoc_echo_plugin_csharp/CMakeLists.txt +++ b/protobuf/protoc_echo_plugin_csharp/CMakeLists.txt @@ -1,7 +1,7 @@ if (EMIL_HOST_BUILD AND NOT CMAKE_CROSSCOMPILING) add_executable(protobuf.protoc_echo_plugin_csharp) - emil_build_for(protobuf.protoc_echo_plugin_csharp BOOL EMIL_STANDALONE) - install(TARGETS protobuf.protoc_echo_plugin_csharp EXPORT emilProtobufTargets DESTINATION bin) + emil_build_for(protobuf.protoc_echo_plugin_csharp BOOL EMIL_BUILD_ECHO_COMPILERS) + emil_install(protobuf.protoc_echo_plugin_csharp EXPORT emilProtobufTargets DESTINATION bin) target_link_libraries(protobuf.protoc_echo_plugin_csharp PUBLIC protobuf.protoc_echo_plugin_lib diff --git a/protobuf/protoc_echo_plugin_java/CMakeLists.txt b/protobuf/protoc_echo_plugin_java/CMakeLists.txt index 4e8182fc4..3d1ef6b4a 100644 --- a/protobuf/protoc_echo_plugin_java/CMakeLists.txt +++ b/protobuf/protoc_echo_plugin_java/CMakeLists.txt @@ -1,7 +1,7 @@ if (EMIL_HOST_BUILD AND NOT CMAKE_CROSSCOMPILING) add_executable(protobuf.protoc_echo_plugin_java) - emil_build_for(protobuf.protoc_echo_plugin_java BOOL EMIL_STANDALONE) - install(TARGETS protobuf.protoc_echo_plugin_java EXPORT emilProtobufTargets DESTINATION bin) + emil_build_for(protobuf.protoc_echo_plugin_java BOOL EMIL_BUILD_ECHO_COMPILERS) + emil_install(protobuf.protoc_echo_plugin_java EXPORT emilProtobufTargets DESTINATION bin) target_link_libraries(protobuf.protoc_echo_plugin_java PUBLIC protobuf.protoc_echo_plugin_lib diff --git a/services/ble/test/TestGapCentral.cpp b/services/ble/test/TestGapCentral.cpp index 5f269750e..05697cca4 100644 --- a/services/ble/test/TestGapCentral.cpp +++ b/services/ble/test/TestGapCentral.cpp @@ -1,7 +1,6 @@ -#include "infra/util/ByteRange.hpp" #include "infra/stream/StringOutputStream.hpp" +#include "infra/util/ByteRange.hpp" #include "infra/util/test_helper/MemoryRangeMatcher.hpp" -#include "infra/stream/StringOutputStream.hpp" #include "services/ble/test_doubles/GapCentralMock.hpp" #include "services/ble/test_doubles/GapCentralObserverMock.hpp" #include "services/ble/test_doubles/GapPeripheralMock.hpp" diff --git a/services/ble/test_doubles/GattServerMock.hpp b/services/ble/test_doubles/GattServerMock.hpp index 98d1c663e..9658334cc 100644 --- a/services/ble/test_doubles/GattServerMock.hpp +++ b/services/ble/test_doubles/GattServerMock.hpp @@ -11,31 +11,30 @@ namespace services : public GattServer { public: - MOCK_METHOD1(AddService, void(GattServerService& service)); + MOCK_METHOD(void, AddService, (GattServerService & service)); }; class GattServerCharacteristicOperationsMock : public services::GattServerCharacteristicOperations { public: - MOCK_CONST_METHOD2(Update, UpdateStatus(const services::GattServerCharacteristicOperationsObserver& characteristic, infra::ConstByteRange data)); + MOCK_METHOD(UpdateStatus, Update, (const services::GattServerCharacteristicOperationsObserver& characteristic, infra::ConstByteRange data), (const)); }; class GattServerCharacteristicUpdateMock : public GattServerCharacteristicUpdate { public: - MOCK_METHOD2(Update, void(infra::ConstByteRange data, infra::Function onDone)); + MOCK_METHOD(void, Update, (infra::ConstByteRange data, infra::Function onDone)); }; class GattServerCharacteristicMock : public GattServerCharacteristic { public: - MOCK_CONST_METHOD0(ServiceHandle, AttAttribute::Handle()); - MOCK_CONST_METHOD0(CharacteristicHandle, AttAttribute::Handle()); - - MOCK_METHOD2(Update, void(infra::ConstByteRange data, infra::Function onDone)); + MOCK_METHOD(AttAttribute::Handle, ServiceHandle, (), (const)); + MOCK_METHOD(AttAttribute::Handle, CharacteristicHandle, (), (const)); + MOCK_METHOD(void, Update, (infra::ConstByteRange data, infra::Function onDone)); }; } diff --git a/services/echo_console/CMakeLists.txt b/services/echo_console/CMakeLists.txt index eb292ad84..43ba34bb1 100644 --- a/services/echo_console/CMakeLists.txt +++ b/services/echo_console/CMakeLists.txt @@ -1,6 +1,6 @@ if (EMIL_HOST_BUILD) add_executable(services.echo_console ${EMIL_EXCLUDE_FROM_ALL}) - install(TARGETS services.echo_console EXPORT emilProtobufTargets DESTINATION bin) + emil_install(services.echo_console DESTINATION bin) target_link_libraries(services.echo_console PUBLIC args diff --git a/services/network/EchoOnConnection.cpp b/services/network/EchoOnConnection.cpp index a7b28c3d8..1619bf1b6 100644 --- a/services/network/EchoOnConnection.cpp +++ b/services/network/EchoOnConnection.cpp @@ -4,30 +4,21 @@ namespace services { void EchoOnConnection::SendStreamAvailable(infra::SharedPtr&& writer) { - SetStreamWriter(std::move(writer)); + EchoOnStreams::SendStreamAvailable(std::move(writer)); } void EchoOnConnection::DataReceived() { - while (!ServiceBusy()) - { - infra::SharedPtr reader = ConnectionObserver::Subject().ReceiveStream(); - - if (!ProcessMessage(*reader)) - break; - - if (!ServiceBusy()) // The message was not executed when ServiceBusy() is true, so don't ack the received data - ConnectionObserver::Subject().AckReceived(); - } + EchoOnStreams::DataReceived(ConnectionObserver::Subject().ReceiveStream()); } void EchoOnConnection::RequestSendStream(std::size_t size) { - ConnectionObserver::Subject().RequestSendStream(size); + ConnectionObserver::Subject().RequestSendStream(std::min(size, ConnectionObserver::Subject().MaxSendStreamSize())); } - void EchoOnConnection::BusyServiceDone() + void EchoOnConnection::AckReceived() { - DataReceived(); + ConnectionObserver::Subject().AckReceived(); } } diff --git a/services/network/EchoOnConnection.hpp b/services/network/EchoOnConnection.hpp index d14256b97..e29c5b13b 100644 --- a/services/network/EchoOnConnection.hpp +++ b/services/network/EchoOnConnection.hpp @@ -20,7 +20,7 @@ namespace services protected: // Implementation of EchoOnStreams void RequestSendStream(std::size_t size) override; - void BusyServiceDone() override; + void AckReceived() override; }; } diff --git a/services/network/Gap.proto b/services/network/Gap.proto index 4a8171ae2..4f658d32f 100644 --- a/services/network/Gap.proto +++ b/services/network/Gap.proto @@ -1,7 +1,7 @@ syntax = "proto3"; package gap; -option java_package = "com.philips.emil.ProtobufEcho"; +option java_package = "com.philips.emil.protobufEcho"; option java_outer_classname = "GapProto"; message IoCapabilities diff --git a/services/network/Http.cpp b/services/network/Http.cpp index e33a856ad..9d06ac993 100644 --- a/services/network/Http.cpp +++ b/services/network/Http.cpp @@ -251,8 +251,15 @@ namespace services return; } + bool localDestroyed = false; + destroyed = &localDestroyed; + auto header = HeaderFromString(headerLine); observer.HeaderAvailable(header); + + if (localDestroyed) + return; + destroyed = nullptr; } else if (headerBuffer.full()) { diff --git a/services/network/HttpClientJson.cpp b/services/network/HttpClientJson.cpp index 9ca5941cc..80806ab5b 100644 --- a/services/network/HttpClientJson.cpp +++ b/services/network/HttpClientJson.cpp @@ -70,10 +70,14 @@ namespace services while (!destructed && jsonParser != infra::none && !stream.Empty()) (*jsonParser)->Feed(infra::ByteRangeAsString(stream.ContiguousRange())); + // If this object is already destructed, readerPtr cannot be touched anymore if (!destructed) { readerPtr = nullptr; - destructedIndication = nullptr; + + // Destroying the reader can lead to destruction, so check again + if (!destructed) + destructedIndication = nullptr; } } diff --git a/services/network/Network.proto b/services/network/Network.proto index e00153fad..f8b515841 100644 --- a/services/network/Network.proto +++ b/services/network/Network.proto @@ -3,7 +3,7 @@ syntax = "proto3"; import "EchoAttributes.proto"; package network; -option java_package = "com.philips.emil.ProtobufEcho"; +option java_package = "com.philips.emil.protobufEcho"; option java_outer_classname = "NetworkProto"; message IpConfig diff --git a/services/network/TracingEchoOnConnection.cpp b/services/network/TracingEchoOnConnection.cpp index 9e2766721..ecfbab29e 100644 --- a/services/network/TracingEchoOnConnection.cpp +++ b/services/network/TracingEchoOnConnection.cpp @@ -1,10 +1,10 @@ #include "services/network/TracingEchoOnConnection.hpp" -#include "infra/stream/ByteInputStream.hpp" +#include "infra/stream/BoundedVectorInputStream.hpp" namespace services { - TracingEchoOnConnection::TracingEchoOnConnection(services::Tracer& tracer, EchoErrorPolicy& errorPolicy) - : EchoOnConnection(errorPolicy) + TracingEchoOnConnection::TracingEchoOnConnection(services::Tracer& tracer, services::MethodSerializerFactory& serializerFactory, const EchoErrorPolicy& errorPolicy) + : EchoOnConnection(serializerFactory, errorPolicy) , tracer(tracer) {} @@ -18,49 +18,83 @@ namespace services services.erase_slow(service); } - void TracingEchoOnConnection::ExecuteMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, infra::StreamReaderWithRewinding& reader) + infra::SharedPtr TracingEchoOnConnection::GrantSend(ServiceProxy& proxy) { - auto service = FindService(serviceId); - - if (service != nullptr) - { - auto marker = reader.ConstructSaveMarker(); + writerBuffer.clear(); + serializer = EchoOnConnection::GrantSend(proxy); + return infra::MakeContainedSharedObject(static_cast(*this), serializer); + } - infra::DataInputStream::WithErrorPolicy stream(reader, infra::noFail); - infra::ProtoLengthDelimited contentsCopy(stream, stream.ErrorPolicy(), contents.Available()); + infra::SharedPtr TracingEchoOnConnection::StartingMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const infra::SharedPtr& deserializer) + { + receivingService = FindService(serviceId); - tracer.Trace() << "< "; - service->TraceMethod(methodId, contentsCopy, tracer); + if (receivingService != nullptr) + { + receivingMethodId = methodId; - reader.Rewind(marker); + readerBuffer.clear(); + this->deserializer = deserializer; + return infra::MakeContainedSharedObject(static_cast(*this), deserializer); } else + { tracer.Trace() << "< Unknown service " << serviceId << " method " << methodId; - - EchoOnConnection::ExecuteMethod(serviceId, methodId, contents, reader); + return deserializer; + } } - void TracingEchoOnConnection::SetStreamWriter(infra::SharedPtr&& writer) + bool TracingEchoOnConnection::Serialize(infra::SharedPtr&& writer) { - EchoOnConnection::SetStreamWriter(tracingWriter.Emplace(std::move(writer), *this)); + return serializer->Serialize(tracingWriter.Emplace(std::move(writer), *this)); } - void TracingEchoOnConnection::SendingData(infra::ConstByteRange range) const + void TracingEchoOnConnection::SerializationDone() { - infra::ByteInputStream stream(range, infra::noFail); + infra::BoundedVectorInputStream stream(writerBuffer, infra::noFail); infra::StreamErrorPolicy formatErrorPolicy(infra::softFail); infra::ProtoParser parser(stream, formatErrorPolicy); auto serviceId = static_cast(parser.GetVarInt()); auto message = parser.GetField(); - if (stream.Failed() || formatErrorPolicy.Failed() || !message.first.Is()) - { + if (stream.Failed()) + tracer.Trace() << "> message too big"; + else if (formatErrorPolicy.Failed() || !message.first.Is()) tracer.Trace() << "> Malformed message"; - return; + else + { + SendingMethod(serviceId, message.second, message.first.Get()); + if (stream.Failed() || formatErrorPolicy.Failed()) + tracer.Continue() << "... Malformed message"; } + } - SendingMethod(serviceId, message.second, message.first.Get()); - if (stream.Failed() || formatErrorPolicy.Failed()) - tracer.Continue() << "... Malformed message"; + void TracingEchoOnConnection::MethodContents(infra::SharedPtr&& reader) + { + auto start = reader->ConstructSaveMarker(); + while (!reader->Empty() && !readerBuffer.full()) + { + auto range = reader->ExtractContiguousRange(readerBuffer.max_size() - readerBuffer.size()); + readerBuffer.insert(readerBuffer.end(), range.begin(), range.end()); + } + reader->Rewind(start); + + deserializer->MethodContents(std::move(reader)); + } + + void TracingEchoOnConnection::ExecuteMethod() + { + infra::BoundedVectorInputStream stream(readerBuffer, infra::noFail); + infra::ProtoLengthDelimited contentsCopy(stream, stream.ErrorPolicy(), static_cast(stream.Available())); + + tracer.Trace() << "< "; + receivingService->TraceMethod(receivingMethodId, contentsCopy, tracer); + + deserializer->ExecuteMethod(); + } + + bool TracingEchoOnConnection::Failed() const + { + return deserializer->Failed(); } void TracingEchoOnConnection::SendingMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents) const @@ -86,18 +120,14 @@ namespace services } TracingEchoOnConnection::TracingWriter::TracingWriter(infra::SharedPtr&& delegate, TracingEchoOnConnection& echo) - : echo(echo) - , delegate(std::move(delegate)) + : delegate(std::move(delegate)) + , writer(echo.writerBuffer) {} - TracingEchoOnConnection::TracingWriter::~TracingWriter() - { - echo.SendingData(infra::MakeRange(writer.Storage())); - } - void TracingEchoOnConnection::TracingWriter::Insert(infra::ConstByteRange range, infra::StreamErrorPolicy& errorPolicy) { - writer.Insert(range, errorPolicy); + infra::StreamErrorPolicy tracingErrorPolicy(infra::noFail); + writer.Insert(range, tracingErrorPolicy); delegate->Insert(range, errorPolicy); } diff --git a/services/network/TracingEchoOnConnection.hpp b/services/network/TracingEchoOnConnection.hpp index 76923bcab..06be61014 100644 --- a/services/network/TracingEchoOnConnection.hpp +++ b/services/network/TracingEchoOnConnection.hpp @@ -8,20 +8,31 @@ namespace services { class TracingEchoOnConnection : public EchoOnConnection + , private MethodSerializer + , private MethodDeserializer { public: - TracingEchoOnConnection(services::Tracer& tracer, EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); + TracingEchoOnConnection(services::Tracer& tracer, services::MethodSerializerFactory& serializerFactory, const EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); void AddServiceTracer(ServiceTracer& service); void RemoveServiceTracer(ServiceTracer& service); protected: // Implementation of EchoOnConnection - void ExecuteMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents, infra::StreamReaderWithRewinding& reader) override; - void SetStreamWriter(infra::SharedPtr&& writer) override; + infra::SharedPtr GrantSend(ServiceProxy& proxy) override; + infra::SharedPtr StartingMethod(uint32_t serviceId, uint32_t methodId, uint32_t size, const infra::SharedPtr& deserializer) override; + + private: + // Implementation of MethodSerializer + virtual bool Serialize(infra::SharedPtr&& writer) override; + virtual void SerializationDone() override; + + // Implementation of MethodDeserializer + virtual void MethodContents(infra::SharedPtr&& reader) override; + virtual void ExecuteMethod() override; + virtual bool Failed() const override; private: - void SendingData(infra::ConstByteRange range) const; void SendingMethod(uint32_t serviceId, uint32_t methodId, infra::ProtoLengthDelimited& contents) const; const ServiceTracer* FindService(uint32_t serviceId) const; @@ -31,7 +42,6 @@ namespace services { public: TracingWriter(infra::SharedPtr&& delegate, TracingEchoOnConnection& echo); - ~TracingWriter(); // Implementation of StreamWriter void Insert(infra::ConstByteRange range, infra::StreamErrorPolicy& errorPolicy) override; @@ -43,9 +53,8 @@ namespace services infra::ByteRange Overwrite(std::size_t marker) override; private: - TracingEchoOnConnection& echo; infra::SharedPtr delegate; - infra::BoundedVectorStreamWriter::WithStorage<1024> writer; + infra::BoundedVectorStreamWriter writer; infra::ByteRange savedRange; infra::ByteRange savedDelegateRange; }; @@ -55,6 +64,13 @@ namespace services infra::IntrusiveForwardList services; infra::SharedOptional tracingWriter; + infra::SharedPtr serializer; + infra::BoundedVector::WithMaxSize<1024> writerBuffer; + + infra::SharedPtr deserializer; + infra::BoundedVector::WithMaxSize<1024> readerBuffer; + const ServiceTracer* receivingService; + uint32_t receivingMethodId; }; } diff --git a/services/network/test/CMakeLists.txt b/services/network/test/CMakeLists.txt index 3daa8cc1d..ec0939cb3 100644 --- a/services/network/test/CMakeLists.txt +++ b/services/network/test/CMakeLists.txt @@ -22,8 +22,6 @@ target_link_libraries(services.network_test PUBLIC target_sources(services.network_test PRIVATE TestAddress.cpp TestBonjourServer.cpp - TestCertificateConvertor.cpp - TestCertificatesMbedTls.cpp TestConnectionMbedTls.cpp TestDnsResolver.cpp TestDnsServer.cpp @@ -50,3 +48,23 @@ target_sources(services.network_test PRIVATE TestWebSocketServerConnectionObserver.cpp TestWiFiNetwork.cpp ) + +add_executable(services.network_test_certificates) +emil_build_for(services.network_test_certificates BOOL EMIL_BUILD_TESTS) +emil_add_test(services.network_test_certificates) + +if (${CMAKE_CXX_COMPILER_ID} MATCHES "Clang|AppleClang") + target_compile_options(services.network_test_certificates PRIVATE -Wno-braced-scalar-init) +endif() + +target_link_libraries(services.network_test_certificates PUBLIC + gmock_main + services.network + services.network_test_doubles + hal.generic +) + +target_sources(services.network_test_certificates PRIVATE + TestCertificateConvertor.cpp + TestCertificatesMbedTls.cpp +) diff --git a/services/network/test/TestEchoOnConnection.cpp b/services/network/test/TestEchoOnConnection.cpp index d11be8bb1..84f4acb1c 100644 --- a/services/network/test/TestEchoOnConnection.cpp +++ b/services/network/test/TestEchoOnConnection.cpp @@ -1,6 +1,7 @@ #include "infra/event/test_helper/EventDispatcherWithWeakPtrFixture.hpp" #include "infra/stream/ByteInputStream.hpp" #include "infra/stream/ByteOutputStream.hpp" +#include "infra/stream/StdVectorInputStream.hpp" #include "infra/util/test_helper/MockCallback.hpp" #include "protobuf/echo/test_doubles/EchoMock.hpp" #include "protobuf/echo/test_doubles/ServiceStub.hpp" @@ -18,8 +19,9 @@ class EchoOnConnectionTest } testing::StrictMock errorPolicy; - services::ConnectionMock connection; - services::EchoOnConnection echo{ errorPolicy }; + testing::StrictMock connection; + services::MethodSerializerFactory::ForServices::AndProxies serializerFactory; + services::EchoOnConnection echo{ serializerFactory, errorPolicy }; testing::StrictMock service{ echo }; }; @@ -27,77 +29,57 @@ TEST_F(EchoOnConnectionTest, invoke_service_proxy_method) { services::ServiceStubProxy serviceProxy{ echo }; - testing::StrictMock> onGranted; - EXPECT_CALL(connection, RequestSendStream(18)); - serviceProxy.RequestSend([&onGranted]() + EXPECT_CALL(connection, MaxSendStreamSize()).WillOnce(testing::Return(1000)); + EXPECT_CALL(connection, RequestSendStream(38)); + serviceProxy.RequestSend([&serviceProxy]() { - onGranted.callback(); + serviceProxy.Method(5); }); infra::ByteOutputStreamWriter::WithStorage<128> writer; auto writerPtr = infra::UnOwnedSharedPtr(writer); - EXPECT_CALL(onGranted, callback()); connection.Observer().SendStreamAvailable(writerPtr); - serviceProxy.Method(5); EXPECT_EQ((std::vector{ 1, 10, 2, 8, 5 }), (std::vector(writer.Storage().begin(), writer.Storage().begin() + 5))); } TEST_F(EchoOnConnectionTest, service_method_is_invoked) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 10, 2, 8, 5 }), infra::Head(infra::MakeRange(reader.Storage()), 5)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(emptyReaderPtr)); - EXPECT_CALL(service, Method(5)); - EXPECT_CALL(connection, AckReceived()); - connection.Observer().DataReceived(); -} - -TEST_F(EchoOnConnectionTest, on_partial_message_service_method_is_not_invoked) -{ - infra::ByteInputStreamReader::WithStorage<4> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 10, 2, 8 }), infra::Head(infra::MakeRange(reader.Storage()), 4)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 1, 10, 2, 8, 5 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); + EXPECT_CALL(service, Method(5)).WillOnce(testing::Invoke([this]() + { + service.MethodDone(); + })); + EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); } TEST_F(EchoOnConnectionTest, service_method_is_invoked_twice) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 10, 2, 8, 5 }), infra::Head(infra::MakeRange(reader.Storage()), 5)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<128> reader2; - infra::Copy(infra::MakeRange(std::array{ 1, 10, 2, 8, 5 }), infra::Head(infra::MakeRange(reader2.Storage()), 5)); - auto reader2Ptr = infra::UnOwnedSharedPtr(reader2); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(reader2Ptr)); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 1, 10, 2, 8, 5, 1, 10, 2, 8, 6 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); + + EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); EXPECT_CALL(service, Method(5)); EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); - reader2.Rewind(0); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(reader2Ptr)).WillOnce(testing::Return(emptyReaderPtr)); - EXPECT_CALL(service, Method(5)); + EXPECT_CALL(service, Method(6)).WillOnce(testing::Invoke([this]() + { + service.MethodDone(); + })); EXPECT_CALL(connection, AckReceived()); service.MethodDone(); - ExecuteAllActions(); } TEST_F(EchoOnConnectionTest, MessageFormatError_is_reported_when_message_is_not_a_LengthDelimited) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 0, 2 }), infra::Head(infra::MakeRange(reader.Storage()), 3)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(emptyReaderPtr)); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 1, 0, 2 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); + + EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); EXPECT_CALL(errorPolicy, MessageFormatError()); EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); @@ -105,12 +87,10 @@ TEST_F(EchoOnConnectionTest, MessageFormatError_is_reported_when_message_is_not_ TEST_F(EchoOnConnectionTest, MessageFormatError_is_reported_when_message_is_of_unknown_type) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 6 }), infra::Head(infra::MakeRange(reader.Storage()), 2)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(emptyReaderPtr)); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 1, 6 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); + + EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); EXPECT_CALL(errorPolicy, MessageFormatError()); EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); @@ -118,12 +98,10 @@ TEST_F(EchoOnConnectionTest, MessageFormatError_is_reported_when_message_is_of_u TEST_F(EchoOnConnectionTest, MessageFormatError_is_reported_when_parameter_in_message_is_of_incorrect_type) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 10, 2, 13, 5, 0, 0, 0 }), infra::Head(infra::MakeRange(reader.Storage()), 8)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(emptyReaderPtr)); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 1, 10, 5, 13, 5, 0, 0, 0 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); + + EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); EXPECT_CALL(errorPolicy, MessageFormatError()); EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); @@ -131,12 +109,10 @@ TEST_F(EchoOnConnectionTest, MessageFormatError_is_reported_when_parameter_in_me TEST_F(EchoOnConnectionTest, ServiceNotFound_is_reported) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 2, 10, 2, 8, 5 }), infra::Head(infra::MakeRange(reader.Storage()), 5)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(emptyReaderPtr)); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 2, 10, 2, 8, 5 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); + + EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); EXPECT_CALL(errorPolicy, ServiceNotFound(2)); EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); @@ -144,12 +120,10 @@ TEST_F(EchoOnConnectionTest, ServiceNotFound_is_reported) TEST_F(EchoOnConnectionTest, MethodNotFound_is_reported) { - infra::ByteInputStreamReader::WithStorage<128> reader; - infra::Copy(infra::MakeRange(std::array{ 1, 18, 2, 8, 5 }), infra::Head(infra::MakeRange(reader.Storage()), 5)); - auto readerPtr = infra::UnOwnedSharedPtr(reader); - infra::ByteInputStreamReader::WithStorage<0> emptyReader; - auto emptyReaderPtr = infra::UnOwnedSharedPtr(emptyReader); - EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)).WillOnce(testing::Return(emptyReaderPtr)); + infra::StdVectorInputStream::WithStorage stream(infra::inPlace, std::vector{ 1, 18, 2, 8, 5 }); + auto readerPtr = infra::UnOwnedSharedPtr(stream.Reader()); + + EXPECT_CALL(connection, ReceiveStream()).WillOnce(testing::Return(readerPtr)); EXPECT_CALL(errorPolicy, MethodNotFound(1, 2)); EXPECT_CALL(connection, AckReceived()); connection.Observer().DataReceived(); diff --git a/services/network/test/TestHttpClient.cpp b/services/network/test/TestHttpClient.cpp index 0fd154418..b8603227b 100644 --- a/services/network/test/TestHttpClient.cpp +++ b/services/network/test/TestHttpClient.cpp @@ -594,7 +594,7 @@ TEST_F(HttpClientTest, data_in_excess_of_ContentLength_is_ignored) connection.SimulateDataReceived(infra::StringAsByteRange(infra::BoundedConstString("extradata"))); } -TEST_F(HttpClientTest, Close_while_DataAvailable_is_handled) +TEST_F(HttpClientTest, Close_while_StatusAvailable_is_handled) { Connect(); @@ -611,6 +611,26 @@ TEST_F(HttpClientTest, Close_while_DataAvailable_is_handled) connection.SimulateDataReceived(infra::StringAsByteRange(infra::BoundedConstString("HTTP/1.1 200 Success\r\n"))); } +TEST_F(HttpClientTest, Close_while_HeaderAvailable_is_handled) +{ + Connect(); + + client.Subject().Get("/"); + ExecuteAllActions(); + + EXPECT_CALL(client, StatusAvailable(services::HttpStatusCode::OK)); + EXPECT_CALL(client, HeaderAvailable(testing::_)).WillOnce(testing::Invoke([this](services::HttpHeader header) + { + ASSERT_EQ("header", header.Field()); + ASSERT_EQ("a", header.Value()); + EXPECT_CALL(connection, CloseAndDestroyMock()); + EXPECT_CALL(client, Detaching()); + client.Subject().CloseConnection(); + })); + + connection.SimulateDataReceived(infra::StringAsByteRange(infra::BoundedConstString("HTTP/1.1 200 Success\r\nheader: a\r\nheader: b\r\n"))); +} + TEST_F(HttpClientTest, Close_while_BodyAvailable_is_handled) { Connect(); diff --git a/services/network/test/TestHttpClientJson.cpp b/services/network/test/TestHttpClientJson.cpp index 8f944d228..9acde408f 100644 --- a/services/network/test/TestHttpClientJson.cpp +++ b/services/network/test/TestHttpClientJson.cpp @@ -164,3 +164,48 @@ TEST_F(HttpClientJsonTest, ContentError_during_parsing_closes_connection) EXPECT_CALL(httpClient, CloseConnection()); httpClient.Observer().BodyAvailable(infra::UnOwnedSharedPtr(reader)); } + +TEST_F(HttpClientJsonTest, close_while_BodyAvailable) +{ + EXPECT_CALL(httpClient, Get("/path", testing::_)); + EXPECT_CALL(controller, Headers()).WillOnce(testing::Return(headersIn)); + EXPECT_CALL(controller, TopJsonObjectVisitor()).WillOnce(testing::ReturnRef(jsonObjectVisitor)); + httpClientObserverFactory->ConnectionEstablished([this](infra::SharedPtr client) + { + httpClient.Attach(client); + }); + + testing::StrictMock reader; + EXPECT_CALL(reader, Empty()).WillOnce(testing::Return(false)); + EXPECT_CALL(reader, ExtractContiguousRange(testing::_)).WillOnce(testing::Return(infra::MakeStringByteRange(R"({ })"))); + EXPECT_CALL(jsonObjectVisitor, Close()).WillOnce(testing::Invoke([this]() + { + EXPECT_CALL(controller, Error(testing::_)); + httpClient.Detach(); + infra::ReConstruct(controller, url, services::HttpClientJson::ConnectionInfo{ jsonParserCreator, 443, httpClientConnector }, services::noAutoConnect); + })); + httpClient.Observer().BodyAvailable(infra::UnOwnedSharedPtr(reader)); +} + +TEST_F(HttpClientJsonTest, close_upon_destructing_reader_in_BodyAvailable) +{ + EXPECT_CALL(httpClient, Get("/path", testing::_)); + EXPECT_CALL(controller, Headers()).WillOnce(testing::Return(headersIn)); + EXPECT_CALL(controller, TopJsonObjectVisitor()).WillOnce(testing::ReturnRef(jsonObjectVisitor)); + httpClientObserverFactory->ConnectionEstablished([this](infra::SharedPtr client) + { + httpClient.Attach(client); + }); + + testing::StrictMock reader; + EXPECT_CALL(reader, Empty()).WillOnce(testing::Return(false)).WillOnce(testing::Return(true)); + EXPECT_CALL(reader, ExtractContiguousRange(testing::_)).WillOnce(testing::Return(infra::MakeStringByteRange(R"({ })"))); + EXPECT_CALL(jsonObjectVisitor, Close()); + infra::AccessedBySharedPtr access([this]() + { + EXPECT_CALL(controller, Error(testing::_)); + httpClient.Detach(); + infra::ReConstruct(controller, url, services::HttpClientJson::ConnectionInfo{ jsonParserCreator, 443, httpClientConnector }, services::noAutoConnect); + }); + httpClient.Observer().BodyAvailable(access.MakeShared(reader)); +} diff --git a/services/network/test_doubles/Certificates.cpp b/services/network/test_doubles/Certificates.cpp index 304f07a74..bffa0ff77 100644 --- a/services/network/test_doubles/Certificates.cpp +++ b/services/network/test_doubles/Certificates.cpp @@ -53,7 +53,7 @@ namespace services "-----END CERTIFICATE-----\r\n"; const char testServerKeyData[] = - "-----BEGIN RSA PRIVATE KEY-----\r\n" + "-----BEGIN RSA PRIVATE KEY-----\r\n" //NOSONAR "MIIEogIBAAKCAQEArcYgmszNxJu5pfLpploIw12iIfAyZWK6PZ1/6zlifaR1v0KL\r\n" "x08aLSQAOAvnb8jmfVzkBwpt3hYVm69gWdTJcFpRXMuZ1nIur7HEDQXtzrgvmV6v\r\n" "d8Eu7ngoGfHijP9eiuwxoYNiMmbyvTM2hYnRn5WllOnbK5OBldnh0Vawh/XErMO/\r\n" @@ -105,7 +105,7 @@ namespace services "-----END CERTIFICATE-----\r\n"; const char testClientKeyData[] = - "-----BEGIN RSA PRIVATE KEY-----\r\n" + "-----BEGIN RSA PRIVATE KEY-----\r\n" //NOSONAR "MIIEowIBAAKCAQEAqNdp/w5eM4io5Ki/amQC8FAuhhdk1H3ELm11MmkYTLXJBsSc\r\n" "RCLIdiyM3Ten/I3bZtI0Ak7yvubQnozeBZig3usBBapfOvx5adCSsZfwGjgsqLF+\r\n" "zQ2maEd15pHSRPPXBAJ++4ZpxdVkfr0r/ZRIxWJwvyxtK3N0BJfUcop1J2fa3cZx\r\n" diff --git a/services/synchronous_util/CMakeLists.txt b/services/synchronous_util/CMakeLists.txt index 82b016dd9..9b131f510 100644 --- a/services/synchronous_util/CMakeLists.txt +++ b/services/synchronous_util/CMakeLists.txt @@ -1,6 +1,7 @@ add_library(services.synchronous_util ${EMIL_EXCLUDE_FROM_ALL} STATIC) target_link_libraries(services.synchronous_util PUBLIC + hal.interfaces hal.synchronous_interfaces ) diff --git a/services/util/CMakeLists.txt b/services/util/CMakeLists.txt index 9e8191af2..ab5588d3d 100644 --- a/services/util/CMakeLists.txt +++ b/services/util/CMakeLists.txt @@ -58,6 +58,8 @@ target_sources(services.util PRIVATE MessageCommunicationWindowed.hpp RepeatingButton.cpp RepeatingButton.hpp + SerialCommunicationLoopback.cpp + SerialCommunicationLoopback.hpp Sha256.hpp SignalLed.cpp SignalLed.hpp diff --git a/services/util/EchoInstantiation.hpp b/services/util/EchoInstantiation.hpp index f7d85e7eb..a194b610d 100644 --- a/services/util/EchoInstantiation.hpp +++ b/services/util/EchoInstantiation.hpp @@ -12,8 +12,9 @@ namespace main_ template struct EchoOnSerialCommunication { - explicit EchoOnSerialCommunication(hal::SerialCommunication& serialCommunication) + explicit EchoOnSerialCommunication(hal::SerialCommunication& serialCommunication, services::MethodSerializerFactory& serializerFactory) : cobs(serialCommunication) + , echo(windowed, serializerFactory) {} operator services::Echo&() @@ -23,7 +24,7 @@ namespace main_ services::MessageCommunicationCobs::WithMaxMessageSize cobs; services::MessageCommunicationWindowed::WithReceiveBuffer windowed{ cobs }; - services::EchoOnMessageCommunication echo{ windowed }; + services::EchoOnMessageCommunication echo; }; template @@ -56,14 +57,14 @@ namespace main_ services::Echo& from; services::Echo& to; - typename infra::BoundedVector>::template WithMaxSize forwarders; + typename infra::BoundedVector::template WithMaxSize forwarders; }; template struct EchoForwarderToSerial { - EchoForwarderToSerial(services::Echo& from, hal::SerialCommunication& toSerial) - : to(toSerial) + EchoForwarderToSerial(services::Echo& from, hal::SerialCommunication& toSerial, services::MethodSerializerFactory& serializerFactory) + : to(toSerial, serializerFactory) , echoForwarder(from, to) {} diff --git a/services/util/EchoOnMessageCommunication.cpp b/services/util/EchoOnMessageCommunication.cpp index 30ab77651..391d1cca0 100644 --- a/services/util/EchoOnMessageCommunication.cpp +++ b/services/util/EchoOnMessageCommunication.cpp @@ -2,8 +2,8 @@ namespace services { - EchoOnMessageCommunication::EchoOnMessageCommunication(MessageCommunication& subject, EchoErrorPolicy& errorPolicy) - : EchoOnStreams(errorPolicy) + EchoOnMessageCommunication::EchoOnMessageCommunication(MessageCommunication& subject, services::MethodSerializerFactory& serializerFactory, const EchoErrorPolicy& errorPolicy) + : EchoOnStreams(serializerFactory, errorPolicy) , MessageCommunicationObserver(subject) {} @@ -12,35 +12,19 @@ namespace services void EchoOnMessageCommunication::SendMessageStreamAvailable(infra::SharedPtr&& writer) { - SetStreamWriter(std::move(writer)); + EchoOnStreams::SendStreamAvailable(std::move(writer)); } void EchoOnMessageCommunication::ReceivedMessage(infra::SharedPtr&& reader) { - this->reader = std::move(reader); - ProcessMessage(); - } - - void EchoOnMessageCommunication::ServiceDone(Service& service) - { - reader = nullptr; - EchoOnStreams::ServiceDone(service); + DataReceived(std::move(reader)); } void EchoOnMessageCommunication::RequestSendStream(std::size_t size) { - MessageCommunicationObserver::Subject().RequestSendMessage(static_cast(size)); + MessageCommunicationObserver::Subject().RequestSendMessage(static_cast(std::min(size, MessageCommunicationObserver::Subject().MaxSendMessageSize()))); } - void EchoOnMessageCommunication::BusyServiceDone() - { - // In this class, services are never busy, so BusyServiceDone() is never invoked - std::abort(); - } - - void EchoOnMessageCommunication::ProcessMessage() - { - if (!EchoOnStreams::ProcessMessage(*reader)) - errorPolicy.MessageFormatError(); - } + void EchoOnMessageCommunication::AckReceived() + {} } diff --git a/services/util/EchoOnMessageCommunication.hpp b/services/util/EchoOnMessageCommunication.hpp index 1f7068e88..a7b93a995 100644 --- a/services/util/EchoOnMessageCommunication.hpp +++ b/services/util/EchoOnMessageCommunication.hpp @@ -11,24 +11,20 @@ namespace services , public MessageCommunicationObserver { public: - EchoOnMessageCommunication(MessageCommunication& subject, EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); + EchoOnMessageCommunication(MessageCommunication& subject, services::MethodSerializerFactory& serializerFactory, const EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); // Implementation of MessageCommunicationObserver void Initialized() override; void SendMessageStreamAvailable(infra::SharedPtr&& writer) override; void ReceivedMessage(infra::SharedPtr&& reader) override; - void ServiceDone(Service& service) override; - protected: + // Implementation of EchoOnStreams void RequestSendStream(std::size_t size) override; - void BusyServiceDone() override; + void AckReceived() override; private: void ProcessMessage(); - - private: - infra::SharedPtr reader; }; } diff --git a/services/util/EchoOnMessageCommunicationSymmetricKey.cpp b/services/util/EchoOnMessageCommunicationSymmetricKey.cpp index f5c726aaf..eaea7d4b4 100644 --- a/services/util/EchoOnMessageCommunicationSymmetricKey.cpp +++ b/services/util/EchoOnMessageCommunicationSymmetricKey.cpp @@ -20,8 +20,8 @@ namespace services } } - EchoOnMessageCommunicationSymmetricKey::EchoOnMessageCommunicationSymmetricKey(MessageCommunicationSecured& secured, hal::SynchronousRandomDataGenerator& randomDataGenerator, EchoErrorPolicy& errorPolicy) - : EchoOnMessageCommunication(secured, errorPolicy) + EchoOnMessageCommunicationSymmetricKey::EchoOnMessageCommunicationSymmetricKey(MessageCommunicationSecured& secured, MethodSerializerFactory& serializerFactory, hal::SynchronousRandomDataGenerator& randomDataGenerator, const EchoErrorPolicy& errorPolicy) + : EchoOnMessageCommunication(secured, serializerFactory, errorPolicy) , SymmetricKeyEstablishment(static_cast(*this)) , SymmetricKeyEstablishmentProxy(static_cast(*this)) , secured(secured) @@ -46,7 +46,7 @@ namespace services auto key = randomDataGenerator.GenerateRandomData(); auto iv = randomDataGenerator.GenerateRandomData(); SymmetricKeyEstablishmentProxy::ActivateNewKeyMaterial(Convert(key), Convert(iv)); - secured.SetSendKey(key, iv); + secured.SetNextSendKey(key, iv); initializingSending = false; ReQueueWaitingProxies(); diff --git a/services/util/EchoOnMessageCommunicationSymmetricKey.hpp b/services/util/EchoOnMessageCommunicationSymmetricKey.hpp index 0541a21a8..29ab18bf8 100644 --- a/services/util/EchoOnMessageCommunicationSymmetricKey.hpp +++ b/services/util/EchoOnMessageCommunicationSymmetricKey.hpp @@ -14,7 +14,7 @@ namespace services , private message_communication_security::SymmetricKeyEstablishmentProxy { public: - EchoOnMessageCommunicationSymmetricKey(MessageCommunicationSecured& secured, hal::SynchronousRandomDataGenerator& randomDataGenerator, EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); + EchoOnMessageCommunicationSymmetricKey(MessageCommunicationSecured& secured, MethodSerializerFactory& serializerFactory, hal::SynchronousRandomDataGenerator& randomDataGenerator, const EchoErrorPolicy& errorPolicy = echoErrorPolicyAbortOnMessageFormatError); // Implementation of Echo void RequestSend(ServiceProxy& serviceProxy) override; diff --git a/services/util/MessageCommunicationSecured.cpp b/services/util/MessageCommunicationSecured.cpp index 48a6591c0..2e6f41569 100644 --- a/services/util/MessageCommunicationSecured.cpp +++ b/services/util/MessageCommunicationSecured.cpp @@ -1,4 +1,5 @@ #include "services/util/MessageCommunicationSecured.hpp" +#include "mbedtls/version.h" #include namespace services @@ -26,10 +27,12 @@ namespace services mbedtls_gcm_free(&sendContext); } - void MessageCommunicationSecured::SetSendKey(const KeyType& sendKey, const IvType& sendIv) + void MessageCommunicationSecured::SetNextSendKey(const KeyType& sendKey, const IvType& sendIv) { - mbedtls_gcm_setkey(&sendContext, MBEDTLS_CIPHER_ID_AES, reinterpret_cast(sendKey.data()), sendKey.size() * 8); //NOSONAR - this->sendIv = sendIv; + nextKeys = { sendKey, sendIv }; + + if (sendWriter == nullptr) + ActivateSendKey(); } void MessageCommunicationSecured::SetReceiveKey(const KeyType& receiveKey, const IvType& receiveIv) @@ -57,6 +60,18 @@ namespace services return std::min(MessageCommunicationObserver::Subject().MaxSendMessageSize(), sendBuffer.max_size()) - blockSize; } + void MessageCommunicationSecured::SetSendKey(const KeyType& sendKey, const IvType& sendIv) + { + mbedtls_gcm_setkey(&sendContext, MBEDTLS_CIPHER_ID_AES, reinterpret_cast(sendKey.data()), sendKey.size() * 8); //NOSONAR + this->sendIv = sendIv; + } + + void MessageCommunicationSecured::ActivateSendKey() + { + SetSendKey(nextKeys->first, nextKeys->second); + nextKeys = infra::none; + } + void MessageCommunicationSecured::SendMessageStreamAvailable(infra::SharedPtr&& writer) { sendWriter = std::move(writer); @@ -71,7 +86,12 @@ namespace services return; receiveBuffer.clear(); + +#if MBEDTLS_VERSION_MAJOR < 3 + really_assert(mbedtls_gcm_starts(&receiveContext, MBEDTLS_GCM_DECRYPT, reinterpret_cast(receiveIv.data()), receiveIv.size(), nullptr, 0) == 0); +#else really_assert(mbedtls_gcm_starts(&receiveContext, MBEDTLS_GCM_DECRYPT, reinterpret_cast(receiveIv.data()), receiveIv.size()) == 0); +#endif while (stream.Available() != blockSize) { @@ -80,14 +100,22 @@ namespace services stream >> infra::MakeRange(encrypted); receiveBuffer.resize(receiveBuffer.size() + encrypted.size()); +#if MBEDTLS_VERSION_MAJOR < 3 + really_assert(mbedtls_gcm_update(&receiveContext, encrypted.size(), encrypted.data(), receiveBuffer.data() + receiveBuffer.size() - encrypted.size()) == 0); +#else std::size_t processedSize = 0; really_assert(mbedtls_gcm_update(&receiveContext, encrypted.data(), encrypted.size(), receiveBuffer.data() + receiveBuffer.size() - encrypted.size(), receiveBuffer.size(), &processedSize) == 0); receiveBuffer.resize(receiveBuffer.size() - encrypted.size() + processedSize); +#endif } std::array computedMac; +#if MBEDTLS_VERSION_MAJOR < 3 + really_assert(mbedtls_gcm_finish(&receiveContext, reinterpret_cast(computedMac.data()), computedMac.size()) == 0); +#else std::size_t processedSize = 0; really_assert(mbedtls_gcm_finish(&receiveContext, nullptr, 0, &processedSize, reinterpret_cast(computedMac.data()), computedMac.size()) == 0); +#endif std::array receivedMac; stream >> infra::MakeRange(receivedMac); @@ -101,21 +129,37 @@ namespace services void MessageCommunicationSecured::SendMessageStreamReleased() { +#if MBEDTLS_VERSION_MAJOR < 3 + really_assert(mbedtls_gcm_starts(&sendContext, MBEDTLS_GCM_ENCRYPT, reinterpret_cast(sendIv.data()), sendIv.size(), nullptr, 0) == 0); +#else really_assert(mbedtls_gcm_starts(&sendContext, MBEDTLS_GCM_ENCRYPT, reinterpret_cast(sendIv.data()), sendIv.size()) == 0); +#endif +#if MBEDTLS_VERSION_MAJOR < 3 + really_assert(mbedtls_gcm_update(&sendContext, sendBuffer.size(), sendBuffer.data(), sendBuffer.data()) == 0); +#else std::size_t processedSize = 0; really_assert(mbedtls_gcm_update(&sendContext, sendBuffer.data(), sendBuffer.size(), sendBuffer.data(), sendBuffer.size(), &processedSize) == 0); +#endif + sendBuffer.resize(sendBuffer.size() + blockSize); +#if MBEDTLS_VERSION_MAJOR < 3 + really_assert(mbedtls_gcm_finish(&sendContext, sendBuffer.data() + sendBuffer.size() - blockSize, blockSize) == 0); +#else std::size_t moreProcessedSize = 0; really_assert(mbedtls_gcm_finish(&sendContext, sendBuffer.data() + processedSize, sendBuffer.size() - processedSize - blockSize, &moreProcessedSize, sendBuffer.data() + sendBuffer.size() - blockSize, blockSize) == 0); really_assert(processedSize + moreProcessedSize + blockSize == sendBuffer.size()); +#endif infra::DataOutputStream::WithErrorPolicy stream(*sendWriter); stream << infra::MakeRange(sendBuffer); sendBuffer.clear(); IncreaseIv(sendIv); sendWriter = nullptr; + + if (nextKeys) + ActivateSendKey(); } void MessageCommunicationSecured::IncreaseIv(infra::ByteRange iv) const diff --git a/services/util/MessageCommunicationSecured.hpp b/services/util/MessageCommunicationSecured.hpp index 8ac9bf048..bbc2d7f02 100644 --- a/services/util/MessageCommunicationSecured.hpp +++ b/services/util/MessageCommunicationSecured.hpp @@ -28,7 +28,7 @@ namespace services MessageCommunicationSecured(infra::BoundedVector& sendBuffer, infra::BoundedVector& receiveBuffer, MessageCommunication& delegate, const KeyType& sendKey, const IvType& sendIv, const KeyType& receiveKey, const IvType& receiveIv); ~MessageCommunicationSecured(); - void SetSendKey(const KeyType& sendKey, const IvType& sendIv); + void SetNextSendKey(const KeyType& sendKey, const IvType& sendIv); void SetReceiveKey(const KeyType& receiveKey, const IvType& receiveIv); // Implementation of MessageCommunication @@ -41,6 +41,8 @@ namespace services void SendMessageStreamAvailable(infra::SharedPtr&& writer) override; void ReceivedMessage(infra::SharedPtr&& reader) override; + void SetSendKey(const KeyType& sendKey, const IvType& sendIv); + void ActivateSendKey(); void SendMessageStreamReleased(); void IncreaseIv(infra::ByteRange iv) const; @@ -67,6 +69,7 @@ namespace services SendMessageStreamReleased(); } }; uint16_t requestedSendSize = 0; + infra::Optional> nextKeys; mbedtls_gcm_context receiveContext; infra::BoundedVector& receiveBuffer; diff --git a/services/util/SerialCommunicationLoopback.cpp b/services/util/SerialCommunicationLoopback.cpp new file mode 100644 index 000000000..c0e166e90 --- /dev/null +++ b/services/util/SerialCommunicationLoopback.cpp @@ -0,0 +1,42 @@ +#include "services/util/SerialCommunicationLoopback.hpp" +#include "hal/interfaces/SerialCommunication.hpp" +#include "infra/event/EventDispatcher.hpp" + +namespace services +{ + SerialCommunicationLoopback::SerialCommunicationLoopback() + : server(&client) + , client(&server) + {} + + hal::SerialCommunication& SerialCommunicationLoopback::Server() + { + return server; + } + + hal::SerialCommunication& SerialCommunicationLoopback::Client() + { + return client; + } + + SerialCommunicationLoopback::SerialCommunicationLoopbackPeer::SerialCommunicationLoopbackPeer(SerialCommunicationLoopbackPeer* other) + : other{ *other } + {} + + void SerialCommunicationLoopback::SerialCommunicationLoopbackPeer::SendData(infra::ConstByteRange data, infra::Function actionOnCompletion) + { + this->data = data; + this->actionOnCompletion = actionOnCompletion; + + infra::EventDispatcher::Instance().Schedule([this] + { + other.dataReceived(this->data); + this->actionOnCompletion(); + }); + } + + void SerialCommunicationLoopback::SerialCommunicationLoopbackPeer::ReceiveData(infra::Function dataReceived) + { + this->dataReceived = dataReceived; + } +} diff --git a/services/util/SerialCommunicationLoopback.hpp b/services/util/SerialCommunicationLoopback.hpp new file mode 100644 index 000000000..5b63250b2 --- /dev/null +++ b/services/util/SerialCommunicationLoopback.hpp @@ -0,0 +1,43 @@ +#ifndef SERVICES_SERIAL_COMMUNICATION_LOOPBACK_HPP +#define SERVICES_SERIAL_COMMUNICATION_LOOPBACK_HPP + +#include "hal/interfaces/SerialCommunication.hpp" + +namespace services +{ + + class SerialCommunicationLoopback + { + public: + SerialCommunicationLoopback(); + + hal::SerialCommunication& Server(); + hal::SerialCommunication& Client(); + + private: + class SerialCommunicationLoopbackPeer + : public hal::SerialCommunication + { + public: + // pointer instead of reference to avoid defining a copy constructor + // pass by reference generates a warning with clang and -Wunitialized + explicit SerialCommunicationLoopbackPeer(SerialCommunicationLoopbackPeer* other); + + void SendData(infra::ConstByteRange data, infra::Function actionOnCompletion) override; + void ReceiveData(infra::Function dataReceived) override; + + private: + SerialCommunicationLoopbackPeer& other; + + infra::ConstByteRange data; + infra::Function actionOnCompletion; + infra::Function dataReceived; + }; + + private: + SerialCommunicationLoopbackPeer server; + SerialCommunicationLoopbackPeer client; + }; +} + +#endif diff --git a/services/util/test/CMakeLists.txt b/services/util/test/CMakeLists.txt index 3a5634451..7a307a65a 100644 --- a/services/util/test/CMakeLists.txt +++ b/services/util/test/CMakeLists.txt @@ -14,6 +14,7 @@ target_link_libraries(services.util_test PUBLIC hal.interfaces_test_doubles infra.timer_test_helper infra.util_test_helper + infra.event_test_helper ) target_sources(services.util_test PRIVATE @@ -39,6 +40,7 @@ target_sources(services.util_test PRIVATE TestMessageCommunicationSecured.cpp TestMessageCommunicationWindowed.cpp TestRepeatingButton.cpp + TestSerialCommunicationLoopback.cpp TestSignalLed.cpp TestSpiMasterWithChipSelect.cpp TestSpiMultipleAccess.cpp diff --git a/services/util/test/TestEchoOnMessageCommunication.cpp b/services/util/test/TestEchoOnMessageCommunication.cpp index 63c05e6ef..4b5267989 100644 --- a/services/util/test/TestEchoOnMessageCommunication.cpp +++ b/services/util/test/TestEchoOnMessageCommunication.cpp @@ -2,11 +2,23 @@ #include "infra/stream/ByteInputStream.hpp" #include "infra/stream/ByteOutputStream.hpp" #include "infra/util/ConstructBin.hpp" +#include "infra/util/SharedOptional.hpp" #include "infra/util/test_helper/MockCallback.hpp" #include "protobuf/echo/test_doubles/EchoMock.hpp" #include "protobuf/echo/test_doubles/ServiceStub.hpp" #include "services/network/test_doubles/ConnectionMock.hpp" #include "services/util/EchoOnMessageCommunication.hpp" +#include "services/util/test_doubles/MessageCommunicationMock.hpp" + +namespace services +{ + class MethodSerializerMock + : public MethodSerializer + { + public: + MOCK_METHOD(bool, Serialize, (infra::SharedPtr && writer), (override)); + }; +} class EchoOnMessageCommunicationTest : public testing::Test @@ -19,41 +31,63 @@ class EchoOnMessageCommunicationTest messageCommunication.GetObserver().ReceivedMessage(infra::UnOwnedSharedPtr(reader)); } + services::MethodSerializerFactory::ForServices::AndProxies serializerFactory; testing::StrictMock errorPolicy; testing::StrictMock messageCommunication; - services::EchoOnMessageCommunication echo{ messageCommunication, errorPolicy }; + services::EchoOnMessageCommunication echo{ messageCommunication, serializerFactory, errorPolicy }; services::ServiceStubProxy serviceProxy{ echo }; testing::StrictMock service{ echo }; + + infra::SharedOptional> serializer; }; TEST_F(EchoOnMessageCommunicationTest, invoke_service_proxy_method) { - testing::StrictMock> onGranted; - EXPECT_CALL(messageCommunication, RequestSendMessage(18)); - serviceProxy.RequestSend([&onGranted]() + EXPECT_CALL(messageCommunication, MaxSendMessageSize()).WillOnce(testing::Return(1000)); + EXPECT_CALL(messageCommunication, RequestSendMessage(38)); + serviceProxy.RequestSend([this]() { - onGranted.callback(); + serviceProxy.Method(5); }); infra::ByteOutputStreamWriter::WithStorage<128> writer; - EXPECT_CALL(onGranted, callback()); messageCommunication.GetObserver().SendMessageStreamAvailable(infra::UnOwnedSharedPtr(writer)); - serviceProxy.Method(5); - EXPECT_EQ((std::vector{ 1, 10, 2, 8, 5 }), (std::vector(writer.Storage().begin(), writer.Storage().begin() + 5))); + EXPECT_EQ((std::vector{ 1, (1 << 3) | 2, 2, 8, 5 }), (std::vector(writer.Storage().begin(), writer.Storage().begin() + 5))); +} + +TEST_F(EchoOnMessageCommunicationTest, invoke_service_proxy_method_without_parameters) +{ + EXPECT_CALL(messageCommunication, MaxSendMessageSize()).WillOnce(testing::Return(1000)); + EXPECT_CALL(messageCommunication, RequestSendMessage(38)); + serviceProxy.RequestSend([this]() + { + serviceProxy.MethodNoParameter(); + }); + + infra::ByteOutputStreamWriter::WithStorage<128> writer; + messageCommunication.GetObserver().SendMessageStreamAvailable(infra::UnOwnedSharedPtr(writer)); + + EXPECT_EQ((std::vector{ 1, (3 << 3) | 2, 0 }), (std::vector(writer.Storage().begin(), writer.Storage().begin() + 3))); } TEST_F(EchoOnMessageCommunicationTest, service_method_is_invoked) { - EXPECT_CALL(service, Method(5)); + EXPECT_CALL(service, Method(5)).WillOnce(testing::Invoke([this]() + { + service.MethodDone(); + })); ReceiveMessage(infra::ConstructBin()({ 1, 10, 2, 8, 5 }).Range()); } -TEST_F(EchoOnMessageCommunicationTest, on_partial_MessageFormatError_is_reported) +TEST_F(EchoOnMessageCommunicationTest, service_method_without_parameter_is_invoked) { - EXPECT_CALL(errorPolicy, MessageFormatError()); - ReceiveMessage(infra::ConstructBin()({ 1, 10, 2, 8 }).Range()); + EXPECT_CALL(service, MethodNoParameter()).WillOnce(testing::Invoke([this]() + { + service.MethodDone(); + })); + ReceiveMessage(infra::ConstructBin()({ 1, (3 << 3) | 2, 0 }).Range()); } TEST_F(EchoOnMessageCommunicationTest, MessageFormatError_is_reported_when_message_is_not_a_LengthDelimited) @@ -71,7 +105,7 @@ TEST_F(EchoOnMessageCommunicationTest, MessageFormatError_is_reported_when_messa TEST_F(EchoOnMessageCommunicationTest, MessageFormatError_is_reported_when_parameter_in_message_is_of_incorrect_type) { EXPECT_CALL(errorPolicy, MessageFormatError()); - ReceiveMessage(infra::ConstructBin()({ 1, 10, 2, 13, 5, 0, 0, 0 }).Range()); + ReceiveMessage(infra::ConstructBin()({ 1, 10, 5, 13, 5, 0, 0, 0 }).Range()); } TEST_F(EchoOnMessageCommunicationTest, ServiceNotFound_is_reported) diff --git a/services/util/test/TestEchoOnMessageCommunicationSymmetricKey.cpp b/services/util/test/TestEchoOnMessageCommunicationSymmetricKey.cpp index d92a78e4c..ecc30d6a2 100644 --- a/services/util/test/TestEchoOnMessageCommunicationSymmetricKey.cpp +++ b/services/util/test/TestEchoOnMessageCommunicationSymmetricKey.cpp @@ -6,6 +6,7 @@ #include "protobuf/echo/test_doubles/ServiceStub.hpp" #include "services/network/test_doubles/ConnectionMock.hpp" #include "services/util/EchoOnMessageCommunicationSymmetricKey.hpp" +#include "services/util/test_doubles/MessageCommunicationMock.hpp" class EchoOnMessageCommunicationSymmetricKeyTest : public testing::Test @@ -54,13 +55,14 @@ class EchoOnMessageCommunicationSymmetricKeyTest ASSERT_TRUE(reader.Allocatable()); } + services::MethodSerializerFactory::ForServices::AndProxies serializerFactory; testing::StrictMock errorPolicy; testing::StrictMock randomDataGenerator; testing::StrictMock lower; std::array key{ 1, 2 }; std::array iv{ 1, 3 }; services::MessageCommunicationSecured::WithBuffers<64> secured{ lower, key, iv, key, iv }; - services::EchoOnMessageCommunicationSymmetricKey echo{ secured, randomDataGenerator, errorPolicy }; + services::EchoOnMessageCommunicationSymmetricKey echo{ secured, serializerFactory, randomDataGenerator, errorPolicy }; services::ServiceStubProxy serviceProxy{ echo }; testing::StrictMock service{ echo }; diff --git a/services/util/test/TestMessageCommunicationSecured.cpp b/services/util/test/TestMessageCommunicationSecured.cpp index e1334999e..6f6877bbe 100644 --- a/services/util/test/TestMessageCommunicationSecured.cpp +++ b/services/util/test/TestMessageCommunicationSecured.cpp @@ -110,7 +110,7 @@ TEST_F(MessageCommunicationSecuredTest, key_change_to_default_key_results_in_sam auto first = sentData; Receive("abcd"); - secured.SetSendKey(key, iv); + secured.SetNextSendKey(key, iv); secured.SetReceiveKey(key, iv); Send("abcd"); @@ -128,7 +128,7 @@ TEST_F(MessageCommunicationSecuredTest, key_change_to_different_key_results_in_d std::array key2{ 1, 2, 1 }; std::array iv2{ 1, 3, 1 }; - secured.SetSendKey(key2, iv2); + secured.SetNextSendKey(key2, iv2); Send("abcd"); auto second = sentData; @@ -144,7 +144,7 @@ TEST_F(MessageCommunicationSecuredTest, initialization_results_in_default_keys) std::array key2{ 1, 2, 1 }; std::array iv2{ 1, 3, 1 }; - secured.SetSendKey(key2, iv2); + secured.SetNextSendKey(key2, iv2); EXPECT_CALL(upper, Initialized()); lower.GetObserver().Initialized(); diff --git a/services/util/test/TestSerialCommunicationLoopback.cpp b/services/util/test/TestSerialCommunicationLoopback.cpp new file mode 100644 index 000000000..748bf5db8 --- /dev/null +++ b/services/util/test/TestSerialCommunicationLoopback.cpp @@ -0,0 +1,63 @@ +#include "hal/interfaces/SerialCommunication.hpp" +#include "infra/event/test_helper/EventDispatcherFixture.hpp" +#include "infra/util/ByteRange.hpp" +#include "infra/util/Function.hpp" +#include "infra/util/test_helper/MockCallback.hpp" +#include "services/util/SerialCommunicationLoopback.hpp" +#include "gmock/gmock.h" +#include "gtest/gtest.h" + +class SerialCommunicationLoopbackTest + : public testing::Test + , public infra::EventDispatcherFixture +{ +public: + services::SerialCommunicationLoopback SerialCommunicationLoopback; + hal::SerialCommunication& server{ SerialCommunicationLoopback.Server() }; + hal::SerialCommunication& client{ SerialCommunicationLoopback.Client() }; +}; + +TEST_F(SerialCommunicationLoopbackTest, SendFromServerReceiveByClient) +{ + infra::ConstByteRange data = infra::MakeStringByteRange("hello"); + infra::VerifyingFunctionMock clientReceiveCallback{ data }; + + client.ReceiveData(clientReceiveCallback); + server.SendData(data, infra::emptyFunction); + + ExecuteAllActions(); +} + +TEST_F(SerialCommunicationLoopbackTest, SendFromClientReceiveByServer) +{ + infra::ConstByteRange data = infra::MakeStringByteRange("world"); + infra::VerifyingFunctionMock serverReceiveCallback{ data }; + + server.ReceiveData(serverReceiveCallback); + client.SendData(data, infra::emptyFunction); + + ExecuteAllActions(); +} + +TEST_F(SerialCommunicationLoopbackTest, ActionOnCompletionAfterDataReceivedByOtherPeer) +{ + infra::ConstByteRange data = infra::MakeStringByteRange("Hello World!"); + infra::MockCallback dataReceivedMockCallback; + infra::MockCallback actionOnCompletionMockCallback; + + server.ReceiveData([&dataReceivedMockCallback](infra::ConstByteRange data) + { + dataReceivedMockCallback.callback(data); + }); + + client.SendData(data, [&actionOnCompletionMockCallback] + { + actionOnCompletionMockCallback.callback(); + }); + + testing::InSequence sequence; + EXPECT_CALL(dataReceivedMockCallback, callback(data)); + EXPECT_CALL(actionOnCompletionMockCallback, callback()); + + ExecuteAllActions(); +} diff --git a/sonar-project.properties b/sonar-project.properties index c91e052d0..a0eb212d1 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -3,7 +3,7 @@ sonar.organization=philips-software sonar.projectName=embeddedinfralib # x-release-please-start-version -sonar.projectVersion=4.0.0 +sonar.projectVersion=5.0.1 # x-release-please-end sonar.links.homepage=https://github.com/philips-software/amp-embedded-infra-lib diff --git a/upgrade/security_key_generator/CMakeLists.txt b/upgrade/security_key_generator/CMakeLists.txt index 885f1ba2c..660983433 100644 --- a/upgrade/security_key_generator/CMakeLists.txt +++ b/upgrade/security_key_generator/CMakeLists.txt @@ -1,6 +1,6 @@ add_executable(upgrade.security_key_generator) emil_build_for(upgrade.security_key_generator HOST All PREREQUISITE_BOOL EMIL_STANDALONE) -install(TARGETS upgrade.security_key_generator EXPORT emilUpgradeTargets DESTINATION bin) +emil_install(upgrade.security_key_generator EXPORT emilUpgradeTargets DESTINATION bin) target_link_libraries(upgrade.security_key_generator PUBLIC args