Google Git
Sign in
pigweed / pigweed / examples / 7787f58067b58c7596e506f4a62766f73b632a69
commit7787f58067b58c7596e506f4a62766f73b632a69[log] [tgz]
authorScott Builta <scottbuilta@pigweed.infra.roller.google.com>Tue Mar 18 08:13:32 2025 -0700
committerCQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>Tue Mar 18 08:13:32 2025 -0700
treec9ba21b3e1360986d4cc8a5fdfb71d16cdc0ff1c
parent31ed41ac2999a04e235cdd3d527e606f3f8967d9 [diff]
roll: third_party/pigweed pw_rpc: Add benchmark tools, echo service, and a sim instance

This CL consolidates the CL 228567, 231171, and 233394 into a
single change under the `pw_rpc` module instead of its own
separate module.

The CL adds a RPC benchmarking tool under the
`benchmark_tools` folder, server-size (target) services for
testing, a client-side (host) utility for measurements, and a
default, client-side runner for user convenience. It also
adds unit tests and a customizable echo message users can
specialize to their specific testing needs.

The code can be invoked form the command line or instantiated
in a user's project and customized as desired. Future CLs wil
expand the default testing capabilities of this utility.

Test: added unit tests for the services.
Original-Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257914
Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com>
Original-Revision: c550290a303cc8e65067b268054f119d9c3f1be0

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 2e233e7fbe7605..c550290a303cc8
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8720049127470889601
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I52caedf99780ce7b4701c7fa49df96f01347bf64
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/examples/+/276514
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: c9ba21b3e1360986d4cc8a5fdfb71d16cdc0ff1c
  1. build_overrides/
  2. docs/
  3. examples/
  4. images/
  5. infra/
  6. libraries/
  7. targets/
  8. third_party/
  9. tools/
  10. .clang-format ⇨ third_party/pigweed/.clang-format
  11. activate.sh ⇨ bootstrap.sh
  12. .bazelignore
  13. .bazelrc
  14. .bazelversion
  15. .gitattributes
  16. .gitignore
  17. .gitmodules
  18. .gn
  19. .pw_console.yaml
  20. activate.bat
  21. banner.txt
  22. bootstrap.bat
  23. bootstrap.sh
  24. BUILD.bazel
  25. BUILD.gn
  26. BUILDCONFIG.gn
  27. LICENSE
  28. MODULE.bazel
  29. navbar.md
  30. OWNERS
  31. pigweed.json
  32. pyproject.toml
  33. README.md
README.md

Pigweed Sample Project

This repository outlines the recommended way of using Pigweed in a new or existing project. Feel free to fork this repository, or read it as a reference.

For more information see the Pigweed Getting started guide.

Check back for more complex examples and features coming soon!

Getting started

Make sure you've set up Pigweed's prerequisites.

If you're on Windows, you can automate the initial setup by downloading the first-time setup script from cmd.exe:

curl https://pigweed.googlesource.com/pigweed/sample_project/+/main/tools/setup_windows_prerequisites.bat?format=TEXT > setup_pigweed_prerequisites.b64 && certutil -decode -f setup_pigweed_prerequisites.b64 setup_pigweed_prerequisites.bat && del setup_pigweed_prerequisites.b64

Then you can run the script with the following command in cmd.exe:

setup_pigweed_prerequisites.bat

Note: You may see a few UAC prompts as the script installs Git, Python, and enables developer mode.

Once that is done, you can clone this project with the following command:

git clone https://pigweed.googlesource.com/pigweed/sample_project

Environment setup

Pigweed uses a local development environment for most of its tools. This means tools are not installed to your machine, and are instead stored in a directory inside your project (Note: git ignores this directory). The tools are temporarily added to the PATH of the current shell session.

To make sure the latest tooling has been fetched and set up, run the bootstrap command for your operating system:

Windows

bootstrap.bat

Linux & Mac

source ./bootstrap.sh

After tooling updates, you might need to run bootstrap again to ensure the latest tools.

After the initial bootstrap, you can use use the activate scripts to configure the current shell for development without doing a full update.

Windows

activate.bat

Linux & Mac

source ./activate.sh

Building

All of these commands must be run from inside an activated developer environment. See Environment setup

One-shot build

To build the project, documentation, and tests, run the following command in an activated environment:

pw build

Automatically build on file save

Alternatively, if you'd like an automatic rebuild to trigger whenever you save changes to files, use pw watch:

pw watch

Typical workflow

When you pull latest repository changes, run bootstrap:

source ./bootstrap.sh

If you're just launching a new shell session, you can activate instead:

source ./activate.sh

and rebuild with:

pw build

More info and Examples

Extended documentation and examples are built along code changes. You can view them at out/gn/docs/gen/docs/html/index.html.