Google Git
Sign in
pigweed / third_party / github / protocolbuffers / protobuf / 68da9337b4a77f12d1e1e68ebff78c30581ca598
commit68da9337b4a77f12d1e1e68ebff78c30581ca598[log] [tgz]
authorJakob Buchgraber <buchgr@google.com>Fri May 31 03:23:26 2024 -0700
committerCopybara-Service <copybara-worker@google.com>Fri May 31 03:25:31 2024 -0700
tree544d18f4301c99de75bf92875edf138e4a18411f
parentefaaeba6a8bf5a5d822bf9820f649394aa815d52 [diff]
Remove 'assert_c_type_sizes' test

The test I am removing fails on 32-bit ARM, as pointers are 4-byte aligned. `upb_MessageValue` is a union. The alignment of a union is the max. alignment of any of its fields. Among the fields are 8-byte types like u64 and thus `upb_MessageValue` is 8-byte aligned even on 32-bit ARM. 4 != 8 and it fails.

I am split on the usefulness of the test, as I find it somewhat unlikely to catch any divergence between the FFI and C types in the future. I can't imagine a practical scenario where upb_MessageValue would change in C code and this test would fail. IMO our actual unit & integration tests plus the IFTT lints are much better guards.

We could fix the test by testing the alignment of u64 instead of *const c_void, which is always 8 bytes on the hw platforms we care about.

PiperOrigin-RevId: 638976482
1 file changed
tree: 544d18f4301c99de75bf92875edf138e4a18411f
  1. .bcr/
  2. .github/
  3. bazel/
  4. benchmarks/
  5. build_defs/
  6. ci/
  7. cmake/
  8. compatibility/
  9. conformance/
  10. csharp/
  11. docs/
  12. editions/
  13. editors/
  14. examples/
  15. java/
  16. lua/
  17. objectivec/
  18. php/
  19. pkg/
  20. protos/
  21. protos_generator/
  22. python/
  23. ruby/
  24. rust/
  25. src/
  26. third_party/
  27. toolchain/
  28. upb/
  29. upb_generator/
  30. .bazelignore
  31. .bazelrc
  32. .clang-format
  33. .gitignore
  34. .gitmodules
  35. .readthedocs.yml
  36. appveyor.bat
  37. appveyor.yml
  38. BUILD.bazel
  39. Cargo.bazel.lock
  40. Cargo.lock
  41. CMakeLists.txt
  42. CODE_OF_CONDUCT.md
  43. CONTRIBUTING.md
  44. CONTRIBUTORS.txt
  45. fix_permissions.sh
  46. generate_descriptor_proto.sh
  47. global.json
  48. google3_export_generated_files.sh
  49. LICENSE
  50. maven_install.json
  51. MODULE.bazel
  52. PrivacyInfo.xcprivacy
  53. Protobuf-C++.podspec
  54. protobuf.bzl
  55. Protobuf.podspec
  56. protobuf_deps.bzl
  57. protobuf_release.bzl
  58. protobuf_version.bzl
  59. README.md
  60. regenerate_stale_files.sh
  61. SECURITY.md
  62. version.json
  63. WORKSPACE
README.md

Protocol Buffers - Google's data interchange format

OpenSSF Scorecard

Copyright 2023 Google LLC

Overview

Protocol Buffers (a.k.a., protobuf) are Google's language-neutral, platform-neutral, extensible mechanism for serializing structured data. You can learn more about it in protobuf's documentation.

This README file contains protobuf installation instructions. To install protobuf, you need to install the protocol compiler (used to compile .proto files) and the protobuf runtime for your chosen programming language.

Working With Protobuf Source Code

Most users will find working from supported releases to be the easiest path.

If you choose to work from the head revision of the main branch your build will occasionally be broken by source-incompatible changes and insufficiently-tested (and therefore broken) behavior.

If you are using C++ or otherwise need to build protobuf from source as a part of your project, you should pin to a release commit on a release branch.

This is because even release branches can experience some instability in between release commits.

Protobuf Compiler Installation

The protobuf compiler is written in C++. If you are using C++, please follow the C++ Installation Instructions to install protoc along with the C++ runtime.

For non-C++ users, the simplest way to install the protocol compiler is to download a pre-built binary from our GitHub release page.

In the downloads section of each release, you can find pre-built binaries in zip packages: protoc-$VERSION-$PLATFORM.zip. It contains the protoc binary as well as a set of standard .proto files distributed along with protobuf.

If you are looking for an old version that is not available in the release page, check out the Maven repository.

These pre-built binaries are only provided for released versions. If you want to use the github main version at HEAD, or you need to modify protobuf code, or you are using C++, it's recommended to build your own protoc binary from source.

If you would like to build protoc binary from source, see the C++ Installation Instructions.

Protobuf Runtime Installation

Protobuf supports several different programming languages. For each programming language, you can find instructions in the corresponding source directory about how to install protobuf runtime for that specific language:

LanguageSource
C++ (include C++ runtime and protoc)src
Javajava
Pythonpython
Objective-Cobjectivec
C#csharp
Rubyruby
Goprotocolbuffers/protobuf-go
PHPphp
Dartdart-lang/protobuf
JavaScriptprotocolbuffers/protobuf-javascript

Quick Start

The best way to learn how to use protobuf is to follow the tutorials in our developer guide.

If you want to learn from code examples, take a look at the examples in the examples directory.

Documentation

The complete documentation is available at the Protocol Buffers doc site.

Support Policy

Read about our version support policy to stay current on support timeframes for the language libraries.

Developer Community

To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.