Google Git
Sign in
pigweed / pigweed / pigweed / 854adece942803d6670b6aa0664e2e167e91fd5f
commit854adece942803d6670b6aa0664e2e167e91fd5f[log] [tgz]
authorKeir Mierle <keir@google.com>Thu Sep 03 14:07:19 2020 -0700
committerCQ Bot Account <commit-bot@chromium.org>Fri Sep 25 20:14:31 2020 +0000
treec18e7abaabdd6f5e5cd86b08d911d2d2b7814466
parentdc6d984004bb5def88772737d8c2d7dad7f4535b [diff]
pw_assert: Add new "light" PW_ASSERT macros

This introduces two new macros: PW_ASSERT() and PW_DASSERT(). These
exist to offer a lightweight assert that is safe to use in headers and
is safe for constexpr. Most of the time, these macros should not be
used, and instead the PW_CHECK() and PW_DCHECK() variants used instead.

Other changes:

- Renames PW_ASSERT_ENABLE_DCHECK to PW_ASSERT_ENABLE_DEBUG, to reflect
  that the setting applies to both PW_CHECK and PW_ASSERT.
- Updates Roadamp & Status documentation sections

Testing: Since currently it is not possible to test the PW_ASSERT macros
due to needing to swap the backend, this is manually tested by flipping
the #if in pw_assert/light_test.cc to 1, and verifying that it crashes
as expected.

Change-Id: I6d2c68f772da4280e61a52576bfb6ab60e280bdf
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/17462
Reviewed-by: Wyatt Hepler <hepler@google.com>
Commit-Queue: Keir Mierle <keir@google.com>
13 files changed
tree: c18e7abaabdd6f5e5cd86b08d911d2d2b7814466
  1. build_overrides/
  2. docker/
  3. docs/
  4. pw_allocator/
  5. pw_arduino_build/
  6. pw_assert/
  7. pw_assert_basic/
  8. pw_assert_log/
  9. pw_base64/
  10. pw_bloat/
  11. pw_blob_store/
  12. pw_boot_armv7m/
  13. pw_build/
  14. pw_bytes/
  15. pw_checksum/
  16. pw_cli/
  17. pw_containers/
  18. pw_cpu_exception/
  19. pw_cpu_exception_armv7m/
  20. pw_docgen/
  21. pw_doctor/
  22. pw_env_setup/
  23. pw_fuzzer/
  24. pw_hdlc_lite/
  25. pw_hex_dump/
  26. pw_kvs/
  27. pw_log/
  28. pw_log_basic/
  29. pw_log_null/
  30. pw_log_rpc/
  31. pw_log_tokenized/
  32. pw_malloc/
  33. pw_malloc_freelist/
  34. pw_metric/
  35. pw_minimal_cpp_stdlib/
  36. pw_module/
  37. pw_polyfill/
  38. pw_preprocessor/
  39. pw_presubmit/
  40. pw_protobuf/
  41. pw_protobuf_compiler/
  42. pw_random/
  43. pw_result/
  44. pw_ring_buffer/
  45. pw_rpc/
  46. pw_span/
  47. pw_status/
  48. pw_stream/
  49. pw_string/
  50. pw_sys_io/
  51. pw_sys_io_arduino/
  52. pw_sys_io_baremetal_lm3s6965evb/
  53. pw_sys_io_baremetal_stm32f429/
  54. pw_sys_io_stdio/
  55. pw_target_runner/
  56. pw_tokenizer/
  57. pw_toolchain/
  58. pw_trace/
  59. pw_trace_tokenized/
  60. pw_unit_test/
  61. pw_varint/
  62. pw_watch/
  63. pw_web_ui/
  64. targets/
  65. third_party/
  66. .dockerignore ⇨ .gitignore
  67. activate.sh ⇨ bootstrap.sh
  68. .bazelignore
  69. .clang-format
  70. .eslintrc.json
  71. .gitignore
  72. .gn
  73. .prettierrc.js
  74. .pylintrc
  75. activate.bat
  76. AUTHORS
  77. bootstrap.bat
  78. bootstrap.sh
  79. BUILD
  80. BUILD.gn
  81. BUILDCONFIG.gn
  82. CMakeLists.txt
  83. CODE_OF_CONDUCT.md
  84. CONTRIBUTING.md
  85. LICENSE
  86. modules.gni
  87. OWNERS
  88. package.json
  89. PW_PLUGINS
  90. README.md
  91. tsconfig.json
  92. WORKSPACE
  93. yarn.lock
README.md

Pigweed

Pigweed is an open source collection of embedded-targeted libraries--or as we like to call them, modules. These modules are building blocks and infrastructure that enable faster and more reliable development on small-footprint MMU-less 32-bit microcontrollers like the STMicroelectronics STM32L452 or the Nordic nRF52832.

Pigweed is in the early stages of development, and should be considered experimental. We’re continuing to evolve the platform and add new modules. We value developer feedback along the way.

Quick links

Get the code: git clone https://pigweed.googlesource.com/pigweed/pigweed

Getting Started

If you'd like to get set up with Pigweed, please visit the getting started guide.

What does Pigweed offer?

There are many modules in Pigweed, and this section only showcases a small selection that happen to produce visual output. For more information about the different Pigweed module offerings, refer to “Module Guides” section in the full documentation.

Note: For now the full documentation is not available online; you must build it. Building the docs is easy; see the getting started guide for how.

pw_watch - Build, flash, run, & test on save

In the web development space, file system watchers are prevalent. These watchers trigger a web server reload on source change, making development much faster. In the embedded space, file system watchers are less prevalent; however, they are no less useful! The Pigweed watcher module makes it easy to instantly compile, flash, and run tests upon save. Combined with the GN-based build which expresses the full dependency tree, only the exact tests affected by a file change are run on saves.

The demo below shows pw_watch building for a STMicroelectronics STM32F429I-DISC1 development board, flashing the board with the affected test, and verifying the test runs as expected. Once this is set up, you can attach multiple devices to run tests in a distributed manner to reduce the time it takes to run tests.

pw watch running on-device tests

pw_presubmit - Vacuum code lint on every commit

Presubmit checks are essential tools, but they take work to set up, and projects don’t always get around to it. The pw_presubmit module provides tools for setting up high quality presubmit checks for any project. We use this framework to run Pigweed’s presubmit on our workstations and in our automated building tools.

The pw_presubmit module includes pw format command, a tool that provides a unified interface for automatically formatting code in a variety of languages. With pw format, you can format C, C++, Python, GN, and Go code according to configurations defined by your project. pw format leverages existing tools like clang-format, and it’s simple to add support for new languages.

pw presubmit demo

pw_env_setup - Cross platform embedded compiler setup

A classic problem in the embedded space is reducing the time from git clone to having a binary executing on a device. The issue is that an entire suite of tools is needed for non-trivial production embedded projects. For example:

  • A C++ compiler for your target device, and also for your host
  • A build system or three; for example, GN, Ninja, CMake, Bazel
  • A code formatting program like clang-format
  • A debugger like OpenOCD to flash and debug your embedded device
  • A known Python version with known modules installed for scripting
  • A Go compiler for the Go-based command line tools
  • ... and so on

In the server space, container solutions like Docker or Podman solve this; however, in our experience container solutions are a mixed bag for embedded systems development where one frequently needs access to native system resources like USB devices, or must operate on Windows.

pw_env_setup is our compromise solution for this problem that works on Mac, Windows, and Linux. It leverages the Chrome packaging system CIPD to bootstrap a Python installation, which in turn inflates a virtual environment. The tooling is installed into your workspace, and makes no changes to your system. This tooling is designed to be reused by any project.