Check Python object allocation failures in upb bindings (#30614) ## Summary Handle failed Python object allocations in several upb Python binding paths. This change addresses cases where `PyType_GenericAlloc()` could return `NULL` but the result was used immediately without validation. In an allocation failure scenario, the code could dereference a NULL pointer and terminate the Python process instead of propagating the allocation failure as a Python exception. ## Background `PyType_GenericAlloc()` is a Python C API allocation function. It may return `NULL` when object allocation fails, for example when the process is under memory pressure. Callers must check the returned pointer before initializing the object. The affected code paths assigned fields to the result immediately after the allocation call. If allocation failed, these assignments could dereference `NULL`, causing a native crash and preventing the original `MemoryError` from being propagated normally. ## Affected paths ### Extension dictionary creation PyUpb_Message_GetExtensionDict -> PyUpb_ExtensionDict_New -> PyType_GenericAlloc -> ext_dict->msg If allocation failed, `ext_dict` was `NULL` before `ext_dict->msg` was accessed. ### Map iterator creation Python map iteration -> PyUpb_MapIterator_New -> PyType_GenericAlloc -> iter->map The iterator constructor used the allocated object before checking whether allocation succeeded. ### Message object creation PyUpb_RepeatedCompositeContainer_AppendNew -> PyUpb_Message_Get -> PyUpb_Descriptor_GetClass -> PyType_GenericAlloc The message creation path now returns immediately when class lookup or object allocation fails. An invalid `Py_DECREF(NULL)` in the allocation failure path was also removed. ## Impact These issues are most relevant under allocation failure or severe memory pressure rather than during ordinary input processing. Without the checks, a failed allocation could result in: - NULL pointer dereference; - termination of the Python interpreter; - loss of the original allocation error; - failure to propagate `MemoryError` through the normal Python API. The practical impact is primarily process stability and availability. The patch does not change the behavior of successful object creation. ## Changes - Check the result of `PyType_GenericAlloc()` in `PyUpb_ExtensionDict_New`. - Check the result of `PyType_GenericAlloc()` in `PyUpb_MapIterator_New`. - Preserve the normal error return from `PyUpb_Message_Get()` when class lookup or object allocation fails. - Remove the invalid `Py_DECREF(NULL)` from the message allocation failure path. Related allocation checks in other Python binding constructors are already present in the current upstream code and are not duplicated by this change. ## Significance These checks make allocation failure paths conform to the Python C API error handling convention. They ensure that object construction either returns a valid initialized object or returns `NULL` so that the active Python exception can be propagated to the caller. This is a defensive stability improvement for unusual but valid interpreter states, including memory pressure and allocation-failure testing. Closes #30614 COPYBARA_INTEGRATE_REVIEW=https://github.com/protocolbuffers/protobuf/pull/30614 from dynapx:python-allocation-error-handling 0112317d1cd4ab5e9f072e807cab6e1648ad3f38 PiperOrigin-RevId: 1003153689
Copyright 2008 Google LLC
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.
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 supports Bzlmod with Bazel 8 +. Users should specify a dependency on protobuf in their MODULE.bazel file as follows.
bazel_dep(name = "protobuf", version = <VERSION>)
Users can optionally override the repo name, such as for compatibility with WORKSPACE.
bazel_dep(name = "protobuf", version = <VERSION>, repo_name = "com_google_protobuf")
Users can also add the following to their legacy WORKSPACE file.
Note that with the release of 30.x there are a few more load statements to properly set up rules_java and rules_python.
http_archive(
name = "com_google_protobuf",
strip_prefix = "protobuf-VERSION",
sha256 = ...,
url = ...,
)
load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
protobuf_deps()
load("@rules_java//java:rules_java_deps.bzl", "rules_java_dependencies")
rules_java_dependencies()
load("@rules_java//java:repositories.bzl", "rules_java_toolchains")
rules_java_toolchains()
load("@rules_python//python:repositories.bzl", "py_repositories")
py_repositories()
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 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:
| Language | Source |
|---|---|
| C++ (include C++ runtime and protoc) | src |
| Java | java |
| Python | python |
| Objective-C | objectivec |
| C# | csharp |
| Ruby | ruby |
| Go | protocolbuffers/protobuf-go |
| PHP | php |
| Dart | dart-lang/protobuf |
| JavaScript | protocolbuffers/protobuf-javascript |
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.
The complete documentation is available at the Protocol Buffers doc site.
Read about our version support policy to stay current on support timeframes for the language libraries.
To be alerted to upcoming changes in Protocol Buffers and connect with protobuf developers and users, join the Google Group.