Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions doc/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,27 @@ Library versions are tracked with simple
Versioning policy is described in the [version.h](../include/mp/version.h)
include.

## v14
- Adds support for nonunix platforms, making API changes that are not backwards compatible ([#274](https://github.com/bitcoin-core/libmultiprocess/pull/274)).
## v15
- Current unstable version.

## [v14.0](https://github.com/bitcoin-core/libmultiprocess/commits/v14.0)
- Adds support for nonunix platforms, making API changes that are not backwards compatible ([#274](https://github.com/bitcoin-core/libmultiprocess/pull/274)). Follow-ups add a `CurrentThread()` accessor matching compatibility code in [bitcoin/bitcoin#35084](https://github.com/bitcoin/bitcoin/pull/35084) ([#323](https://github.com/bitcoin-core/libmultiprocess/pull/323)) and remove code for Cap'n Proto versions before 0.9 ([#331](https://github.com/bitcoin-core/libmultiprocess/pull/331)).

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

re: #388 (review)

Do you usually note a capnproto version requirement bump in these notes? It's already in doc/install.md, and bitcoin core is probably the main (only) user, so probably not necessary.

Thanks for the review! The notes mention it only in passing, in the first bullet: the nonunix support in #274 raised the minimum to 0.9, and #331 removed code for older versions. I agree a separate note isn't needed since doc/install.md has the requirement, so I'll leave it as is and merge.

- Fixes a data race between IPC calls running on worker threads and disconnects, found by Antithesis ([#349](https://github.com/bitcoin-core/libmultiprocess/pull/349)).
- Fixes a use-after-free when a socket disconnects before `ConnectStream` connects, and leaks and hangs when a client `construct()` call throws ([#298](https://github.com/bitcoin-core/libmultiprocess/pull/298)).
- Fixes a race where file descriptors from `SpawnProcess` could leak into processes forked at the same time by other threads, by clearing `FD_CLOEXEC` in the child after forking ([#311](https://github.com/bitcoin-core/libmultiprocess/pull/311)).
- Makes `SpawnProcess` report `exec` failures back to the parent and throw, reaping the child ([#312](https://github.com/bitcoin-core/libmultiprocess/pull/312)).
- Adds support for `std::chrono::time_point` fields ([#303](https://github.com/bitcoin-core/libmultiprocess/pull/303)) and for serializing lists of interface objects that need to be moved from ([#304](https://github.com/bitcoin-core/libmultiprocess/pull/304)), both needed by [bitcoin/bitcoin#10102](https://github.com/bitcoin/bitcoin/pull/10102).
- Accepts container fields and parameters with any comparator, hash, and allocator types, like Bitcoin Core's `GCSFilter::ElementSet`, needed by [bitcoin/bitcoin#29409](https://github.com/bitcoin/bitcoin/pull/29409) ([#379](https://github.com/bitcoin-core/libmultiprocess/pull/379)).
- Finds the `capnp` tool in vcpkg and Windows builds, needed by [bitcoin/bitcoin#32387](https://github.com/bitcoin/bitcoin/pull/32387) ([#317](https://github.com/bitcoin-core/libmultiprocess/pull/317)).
- Adds a `destroy_connection` option to `ServeStream` and `ConnectStream`, lets `ServeStream` take ownership of the init object and return the new server and its connection, and adds an `EventLoop::incomingConnections()` accessor, simplifying test setup in both repositories and needed by [bitcoin/bitcoin#35932](https://github.com/bitcoin/bitcoin/pull/35932) ([#365](https://github.com/bitcoin-core/libmultiprocess/pull/365)).
- Replaces `EventLoop::post()` with `sync()` taking a `kj::FunctionParam`, avoiding a heap allocation per call ([#347](https://github.com/bitcoin-core/libmultiprocess/pull/347)).
- Names threads spawned by the event loop so they can be told apart in tools and logs ([#324](https://github.com/bitcoin-core/libmultiprocess/pull/324)).
- Fixes warnings that Bitcoin Core enables or plans to enable: adds `[[noreturn]]` attributes for `-Wmissing-noreturn` ([#339](https://github.com/bitcoin-core/libmultiprocess/pull/339), for [bitcoin/bitcoin#35911](https://github.com/bitcoin/bitcoin/pull/35911)), and fixes `-Wunused` ([#362](https://github.com/bitcoin-core/libmultiprocess/pull/362), for [bitcoin/bitcoin#36167](https://github.com/bitcoin/bitcoin/pull/36167)), `-Wunused-const-variable` and `-Wundef` ([#370](https://github.com/bitcoin-core/libmultiprocess/pull/370)), and `-Wmissing-prototypes` ([#386](https://github.com/bitcoin-core/libmultiprocess/pull/386), for [bitcoin/bitcoin#36743](https://github.com/bitcoin/bitcoin/pull/36743)) warnings.
- Fails at compile time with a suggested workaround when Cap'n Proto misdetects exception support (`KJ_NO_EXCEPTIONS`), as happens on NetBSD ([#364](https://github.com/bitcoin-core/libmultiprocess/pull/364)).
- Build improvements: fixes stale generated code when the `mpgen` binary changes ([#316](https://github.com/bitcoin-core/libmultiprocess/pull/316)), fixes `mpgen` link order for static Cap'n Proto builds ([#367](https://github.com/bitcoin-core/libmultiprocess/pull/367)), links `mpgen` against `kj-async` instead of `capnp-rpc` ([#327](https://github.com/bitcoin-core/libmultiprocess/pull/327)), shows Cap'n Proto `find_package` diagnostics ([#325](https://github.com/bitcoin-core/libmultiprocess/pull/325)), installs `type-unordered-set.h` and `version.h` ([#350](https://github.com/bitcoin-core/libmultiprocess/pull/350)), and shows include-what-you-use errors instead of failing silently ([#371](https://github.com/bitcoin-core/libmultiprocess/pull/371)).
- Test, CI, documentation, and minor code improvements: fix for a startup race in the example program ([#315](https://github.com/bitcoin-core/libmultiprocess/pull/315)), new test for immediate client disconnects in `ListenConnections` ([#310](https://github.com/bitcoin-core/libmultiprocess/pull/310)), `ReadList` return value check ([#338](https://github.com/bitcoin-core/libmultiprocess/pull/338)), connect test race fix ([#343](https://github.com/bitcoin-core/libmultiprocess/pull/343)) and cleanups ([#344](https://github.com/bitcoin-core/libmultiprocess/pull/344)), `std::ranges::copy` follow-ups ([#307](https://github.com/bitcoin-core/libmultiprocess/pull/307)), trailing whitespace removal ([#345](https://github.com/bitcoin-core/libmultiprocess/pull/345)), Cap'n Proto version documentation fix ([#357](https://github.com/bitcoin-core/libmultiprocess/pull/357)), clang-tidy updates ([#358](https://github.com/bitcoin-core/libmultiprocess/pull/358), [#360](https://github.com/bitcoin-core/libmultiprocess/pull/360), [#380](https://github.com/bitcoin-core/libmultiprocess/pull/380), [#389](https://github.com/bitcoin-core/libmultiprocess/pull/389)), new CI job testing newer cmake and Cap'n Proto versions ([#212](https://github.com/bitcoin-core/libmultiprocess/pull/212), [#359](https://github.com/bitcoin-core/libmultiprocess/pull/359)), CI coverage for the minimum supported g++ ([#330](https://github.com/bitcoin-core/libmultiprocess/pull/330), [#366](https://github.com/bitcoin-core/libmultiprocess/pull/366)), new CI warnings ([#332](https://github.com/bitcoin-core/libmultiprocess/pull/332), [#341](https://github.com/bitcoin-core/libmultiprocess/pull/341)), CI parallelism ([#334](https://github.com/bitcoin-core/libmultiprocess/pull/334), [#356](https://github.com/bitcoin-core/libmultiprocess/pull/356)), CI diagnostics ([#351](https://github.com/bitcoin-core/libmultiprocess/pull/351), [#352](https://github.com/bitcoin-core/libmultiprocess/pull/352)), Nix and LLVM updates ([#296](https://github.com/bitcoin-core/libmultiprocess/pull/296), [#363](https://github.com/bitcoin-core/libmultiprocess/pull/363)), NetBSD and OpenBSD CI fixes ([#321](https://github.com/bitcoin-core/libmultiprocess/pull/321), [#340](https://github.com/bitcoin-core/libmultiprocess/pull/340), [#381](https://github.com/bitcoin-core/libmultiprocess/pull/381)), building Cap'n Proto with GCC in the 32-bit CI job to avoid an ABI mismatch ([#383](https://github.com/bitcoin-core/libmultiprocess/pull/383)), and GitHub Actions updates ([#387](https://github.com/bitcoin-core/libmultiprocess/pull/387)).
- Used in Bitcoin Core 33.x and newer releases with [#36747](https://github.com/bitcoin/bitcoin/pull/36747).

## [v13.0](https://github.com/bitcoin-core/libmultiprocess/commits/v13.0)
- Fixes a `memcpy` ubsan warning by using `std::ranges::copy` ([#305](https://github.com/bitcoin-core/libmultiprocess/pull/305)).
- Misc: map serialization round-trip test coverage ([#297](https://github.com/bitcoin-core/libmultiprocess/pull/297)) and version bump ([#306](https://github.com/bitcoin-core/libmultiprocess/pull/306)).
Expand Down
2 changes: 1 addition & 1 deletion include/mp/version.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
//! pointing at the prior merge commit. The /doc/versions.md file should also be
//! updated, noting any significant or incompatible changes made since the
//! previous version.
#define MP_MAJOR_VERSION 14
#define MP_MAJOR_VERSION 15

//! Minor version number. Should be incremented in stable branches after
//! backporting changes. The /doc/versions.md file should also be updated to
Expand Down
Loading