From fa1df840caa5dd8c04430c0e2a78091960e60af9 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 01:46:58 -0700 Subject: [PATCH 01/13] spike --- .../dylints/lossy_feedback/.cargo/config.toml | 2 + .github/dylints/lossy_feedback/Cargo.lock | 1581 +++++++++++++++++ .github/dylints/lossy_feedback/Cargo.toml | 18 + .github/dylints/lossy_feedback/rust-toolchain | 5 + .github/dylints/lossy_feedback/src/lib.rs | 355 ++++ .github/dylints/lossy_feedback/ui/main.rs | 106 ++ .github/dylints/lossy_feedback/ui/main.stderr | 27 + Cargo.toml | 1 + actor/src/benches/mailbox.rs | 6 +- actor/src/lib.rs | 67 +- actor/src/mailbox.rs | 53 +- collector/fuzz/fuzz_targets/collector.rs | 6 +- collector/src/p2p/mocks/sender.rs | 6 +- consensus/src/reporter.rs | 9 - .../discovery/actors/peer/actor.rs | 3 +- .../discovery/actors/peer/ingress.rs | 4 +- .../discovery/actors/router/ingress.rs | 8 +- .../discovery/actors/spawner/ingress.rs | 12 +- p2p/src/authenticated/discovery/channels.rs | 4 +- .../authenticated/lookup/actors/peer/actor.rs | 4 +- .../lookup/actors/router/ingress.rs | 6 +- .../lookup/actors/spawner/ingress.rs | 12 +- p2p/src/authenticated/lookup/channels.rs | 4 +- p2p/src/authenticated/relay.rs | 10 +- p2p/src/lib.rs | 8 +- p2p/src/simulated/network.rs | 14 +- p2p/src/utils/codec.rs | 6 +- p2p/src/utils/limited.rs | 8 +- p2p/src/utils/mocks/mod.rs | 10 +- p2p/src/utils/mux.rs | 12 +- resolver/src/p2p/fetcher.rs | 17 +- 31 files changed, 2279 insertions(+), 105 deletions(-) create mode 100644 .github/dylints/lossy_feedback/.cargo/config.toml create mode 100644 .github/dylints/lossy_feedback/Cargo.lock create mode 100644 .github/dylints/lossy_feedback/Cargo.toml create mode 100644 .github/dylints/lossy_feedback/rust-toolchain create mode 100644 .github/dylints/lossy_feedback/src/lib.rs create mode 100644 .github/dylints/lossy_feedback/ui/main.rs create mode 100644 .github/dylints/lossy_feedback/ui/main.stderr diff --git a/.github/dylints/lossy_feedback/.cargo/config.toml b/.github/dylints/lossy_feedback/.cargo/config.toml new file mode 100644 index 00000000000..d58627620a1 --- /dev/null +++ b/.github/dylints/lossy_feedback/.cargo/config.toml @@ -0,0 +1,2 @@ +[target.'cfg(all())'] +rustflags = ["-C", "linker=dylint-link"] diff --git a/.github/dylints/lossy_feedback/Cargo.lock b/.github/dylints/lossy_feedback/Cargo.lock new file mode 100644 index 00000000000..d9f5e09af80 --- /dev/null +++ b/.github/dylints/lossy_feedback/Cargo.lock @@ -0,0 +1,1581 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "aho-corasick" +version = "1.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ddd31a130427c27518df266943a5308ed92d4b226cc639f5a8f1002816174301" +dependencies = [ + "memchr", +] + +[[package]] +name = "anstream" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d" +dependencies = [ + "anstyle", + "anstyle-parse", + "anstyle-query", + "anstyle-wincon", + "colorchoice", + "is_terminal_polyfill", + "utf8parse", +] + +[[package]] +name = "anstyle" +version = "1.0.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000" + +[[package]] +name = "anstyle-parse" +version = "1.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e" +dependencies = [ + "utf8parse", +] + +[[package]] +name = "anstyle-query" +version = "1.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "anstyle-wincon" +version = "3.0.11" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" +dependencies = [ + "anstyle", + "once_cell_polyfill", + "windows-sys 0.61.2", +] + +[[package]] +name = "anyhow" +version = "1.0.102" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" + +[[package]] +name = "bitflags" +version = "2.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3" + +[[package]] +name = "camino" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e629a66d692cb9ff1a1c664e41771b3dcaf961985a9774c0eb0bd1b51cf60a48" +dependencies = [ + "serde_core", +] + +[[package]] +name = "cargo-platform" +version = "0.3.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dd0061da739915fae12ea00e16397555ed4371a6bb285431aab930f61b0aa4ba" +dependencies = [ + "serde", + "serde_core", +] + +[[package]] +name = "cargo_metadata" +version = "0.23.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ef987d17b0a113becdd19d3d0022d04d7ef41f9efe4f3fb63ac44ba61df3ade9" +dependencies = [ + "camino", + "cargo-platform", + "semver", + "serde", + "serde_json", + "thiserror 2.0.18", +] + +[[package]] +name = "cc" +version = "1.2.62" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a1dce859f0832a7d088c4f1119888ab94ef4b5d6795d1ce05afb7fe159d79f98" +dependencies = [ + "find-msvc-tools", + "jobserver", + "libc", + "shlex", +] + +[[package]] +name = "cfg-if" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" + +[[package]] +name = "colorchoice" +version = "1.0.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570" + +[[package]] +name = "compiletest_rs" +version = "0.11.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f150fe9105fcd2a57cad53f0c079a24de65195903ef670990f5909f695eac04c" +dependencies = [ + "diff", + "filetime", + "getopts", + "lazy_static", + "libc", + "log", + "miow", + "regex", + "rustfix", + "serde", + "serde_derive", + "serde_json", + "tester", + "windows-sys 0.59.0", +] + +[[package]] +name = "diff" +version = "0.1.13" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8" + +[[package]] +name = "dirs-next" +version = "2.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b98cf8ebf19c3d1b223e151f99a4f9f0690dca41414773390fc824184ac833e1" +dependencies = [ + "cfg-if", + "dirs-sys-next", +] + +[[package]] +name = "dirs-sys-next" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4ebda144c4fe02d1f7ea1a7d9641b6fc6b580adcfa024ae48797ecdeb6825b4d" +dependencies = [ + "libc", + "redox_users", + "winapi", +] + +[[package]] +name = "displaydoc" +version = "0.2.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "dylint" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b795f98802f87352aab60584eea87f942c53ab30edcafab4b31a6cbdd9e8a3ac" +dependencies = [ + "anstyle", + "anyhow", + "cargo_metadata", + "dylint_internal", + "log", + "once_cell", + "semver", + "serde", + "serde_json", + "tempfile", +] + +[[package]] +name = "dylint_internal" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a03ff51e671fceef87e50fef97ddc1569241af242d76e0b367dfcc812c860eb0" +dependencies = [ + "anstyle", + "anyhow", + "bitflags", + "cargo_metadata", + "git2", + "home", + "log", + "regex", + "serde", + "tar", + "thiserror 2.0.18", + "toml", +] + +[[package]] +name = "dylint_linting" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c3efcb9b741bccdd6f1ce701c4b17b452112e8c0cd045c8b894a112584ff5d55" +dependencies = [ + "cargo_metadata", + "dylint_internal", + "paste", + "rustversion", + "serde", + "thiserror 2.0.18", + "toml", +] + +[[package]] +name = "dylint_testing" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2eaa3ca6e1f740cd587630c321f61927b4cafdc2abf7c2fbacc3fca8635fcc48" +dependencies = [ + "anyhow", + "cargo_metadata", + "compiletest_rs", + "dylint", + "dylint_internal", + "env_logger", + "once_cell", + "regex", + "serde_json", + "tempfile", +] + +[[package]] +name = "env_filter" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32e90c2accc4b07a8456ea0debdc2e7587bdd890680d71173a15d4ae604f6eef" +dependencies = [ + "log", + "regex", +] + +[[package]] +name = "env_logger" +version = "0.11.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0621c04f2196ac3f488dd583365b9c09be011a4ab8b9f37248ffcc8f6198b56a" +dependencies = [ + "anstream", + "anstyle", + "env_filter", + "jiff", + "log", +] + +[[package]] +name = "equivalent" +version = "1.0.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" + +[[package]] +name = "errno" +version = "0.3.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" +dependencies = [ + "libc", + "windows-sys 0.61.2", +] + +[[package]] +name = "fastrand" +version = "2.4.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f1f227452a390804cdb637b74a86990f2a7d7ba4b7d5693aac9b4dd6defd8d6" + +[[package]] +name = "filetime" +version = "0.2.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c287a33c7f0a620c38e641e7f60827713987b3c0f26e8ddc9462cc69cf75759" +dependencies = [ + "cfg-if", + "libc", +] + +[[package]] +name = "find-msvc-tools" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5baebc0774151f905a1a2cc41989300b1e6fbb29aff0ceffa1064fdd3088d582" + +[[package]] +name = "foldhash" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" + +[[package]] +name = "form_urlencoded" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" +dependencies = [ + "percent-encoding", +] + +[[package]] +name = "getopts" +version = "0.2.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cfe4fbac503b8d1f88e6676011885f34b7174f46e59956bba534ba83abded4df" +dependencies = [ + "unicode-width", +] + +[[package]] +name = "getrandom" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0" +dependencies = [ + "cfg-if", + "libc", + "wasi", +] + +[[package]] +name = "getrandom" +version = "0.3.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd" +dependencies = [ + "cfg-if", + "libc", + "r-efi 5.3.0", + "wasip2", +] + +[[package]] +name = "getrandom" +version = "0.4.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0de51e6874e94e7bf76d726fc5d13ba782deca734ff60d5bb2fb2607c7406555" +dependencies = [ + "cfg-if", + "libc", + "r-efi 6.0.0", + "wasip2", + "wasip3", +] + +[[package]] +name = "git2" +version = "0.20.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b88256088d75a56f8ecfa070513a775dd9107f6530ef14919dac831af9cfe2b" +dependencies = [ + "bitflags", + "libc", + "libgit2-sys", + "log", + "openssl-probe", + "openssl-sys", + "url", +] + +[[package]] +name = "hashbrown" +version = "0.15.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" +dependencies = [ + "foldhash", +] + +[[package]] +name = "hashbrown" +version = "0.17.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" + +[[package]] +name = "heck" +version = "0.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" + +[[package]] +name = "hermit-abi" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c" + +[[package]] +name = "home" +version = "0.5.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cc627f471c528ff0c4a49e1d5e60450c8f6461dd6d10ba9dcd3a61d3dff7728d" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "icu_collections" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2984d1cd16c883d7935b9e07e44071dca8d917fd52ecc02c04d5fa0b5a3f191c" +dependencies = [ + "displaydoc", + "potential_utf", + "utf8_iter", + "yoke", + "zerofrom", + "zerovec", +] + +[[package]] +name = "icu_locale_core" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92219b62b3e2b4d88ac5119f8904c10f8f61bf7e95b640d25ba3075e6cac2c29" +dependencies = [ + "displaydoc", + "litemap", + "tinystr", + "writeable", + "zerovec", +] + +[[package]] +name = "icu_normalizer" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c56e5ee99d6e3d33bd91c5d85458b6005a22140021cc324cea84dd0e72cff3b4" +dependencies = [ + "icu_collections", + "icu_normalizer_data", + "icu_properties", + "icu_provider", + "smallvec", + "zerovec", +] + +[[package]] +name = "icu_normalizer_data" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "da3be0ae77ea334f4da67c12f149704f19f81d1adf7c51cf482943e84a2bad38" + +[[package]] +name = "icu_properties" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bee3b67d0ea5c2cca5003417989af8996f8604e34fb9ddf96208a033901e70de" +dependencies = [ + "icu_collections", + "icu_locale_core", + "icu_properties_data", + "icu_provider", + "zerotrie", + "zerovec", +] + +[[package]] +name = "icu_properties_data" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e2bbb201e0c04f7b4b3e14382af113e17ba4f63e2c9d2ee626b720cbce54a14" + +[[package]] +name = "icu_provider" +version = "2.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "139c4cf31c8b5f33d7e199446eff9c1e02decfc2f0eec2c8d71f65befa45b421" +dependencies = [ + "displaydoc", + "icu_locale_core", + "writeable", + "yoke", + "zerofrom", + "zerotrie", + "zerovec", +] + +[[package]] +name = "id-arena" +version = "2.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3d3067d79b975e8844ca9eb072e16b31c3c1c36928edf9c6789548c524d0d954" + +[[package]] +name = "idna" +version = "1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" +dependencies = [ + "idna_adapter", + "smallvec", + "utf8_iter", +] + +[[package]] +name = "idna_adapter" +version = "1.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cb68373c0d6620ef8105e855e7745e18b0d00d3bdb07fb532e434244cdb9a714" +dependencies = [ + "icu_normalizer", + "icu_properties", +] + +[[package]] +name = "indexmap" +version = "2.14.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d466e9454f08e4a911e14806c24e16fba1b4c121d1ea474396f396069cf949d9" +dependencies = [ + "equivalent", + "hashbrown 0.17.1", + "serde", + "serde_core", +] + +[[package]] +name = "is_terminal_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" + +[[package]] +name = "itoa" +version = "1.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" + +[[package]] +name = "jiff" +version = "0.2.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f00b5dbd620d61dfdcb6007c9c1f6054ebd75319f163d886a9055cec1155073d" +dependencies = [ + "jiff-static", + "log", + "portable-atomic", + "portable-atomic-util", + "serde_core", +] + +[[package]] +name = "jiff-static" +version = "0.2.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e000de030ff8022ea1da3f466fbb0f3a809f5e51ed31f6dd931c35181ad8e6d7" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "jobserver" +version = "0.1.34" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9afb3de4395d6b3e67a780b6de64b51c978ecf11cb9a462c66be7d4ca9039d33" +dependencies = [ + "getrandom 0.3.4", + "libc", +] + +[[package]] +name = "lazy_static" +version = "1.5.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" + +[[package]] +name = "leb128fmt" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09edd9e8b54e49e587e4f6295a7d29c3ea94d469cb40ab8ca70b288248a81db2" + +[[package]] +name = "libc" +version = "0.2.186" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66" + +[[package]] +name = "libgit2-sys" +version = "0.18.4+1.9.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b26f66f35e1871b22efcf7191564123d2a446ca0538cde63c23adfefa9b15b7" +dependencies = [ + "cc", + "libc", + "libssh2-sys", + "libz-sys", + "openssl-sys", + "pkg-config", +] + +[[package]] +name = "libredox" +version = "0.1.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e02f3bb43d335493c96bf3fd3a321600bf6bd07ed34bc64118e9293bdffea46c" +dependencies = [ + "libc", +] + +[[package]] +name = "libssh2-sys" +version = "0.3.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "220e4f05ad4a218192533b300327f5150e809b54c4ec83b5a1d91833601811b9" +dependencies = [ + "cc", + "libc", + "libz-sys", + "openssl-sys", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "libz-sys" +version = "1.1.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc3a226e576f50782b3305c5ccf458698f92798987f551c6a02efe8276721e22" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "linux-raw-sys" +version = "0.12.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" + +[[package]] +name = "litemap" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "92daf443525c4cce67b150400bc2316076100ce0b3686209eb8cf3c31612e6f0" + +[[package]] +name = "log" +version = "0.4.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897" + +[[package]] +name = "lossy_feedback" +version = "0.0.1" +dependencies = [ + "dylint_linting", + "dylint_testing", +] + +[[package]] +name = "memchr" +version = "2.8.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79" + +[[package]] +name = "miow" +version = "0.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "536bfad37a309d62069485248eeaba1e8d9853aaf951caaeaed0585a95346f08" +dependencies = [ + "windows-sys 0.61.2", +] + +[[package]] +name = "num_cpus" +version = "1.17.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "91df4bbde75afed763b708b7eee1e8e7651e02d97f6d5dd763e89367e957b23b" +dependencies = [ + "hermit-abi", + "libc", +] + +[[package]] +name = "once_cell" +version = "1.21.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" + +[[package]] +name = "once_cell_polyfill" +version = "1.70.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" + +[[package]] +name = "openssl-probe" +version = "0.1.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d05e27ee213611ffe7d6348b942e8f942b37114c00cc03cec254295a4a17852e" + +[[package]] +name = "openssl-sys" +version = "0.9.116" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f28a22dc7140cda5f096e5e7724a6962ca81a7f8bfd2979f9b18c11af56318c4" +dependencies = [ + "cc", + "libc", + "pkg-config", + "vcpkg", +] + +[[package]] +name = "paste" +version = "1.0.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a" + +[[package]] +name = "percent-encoding" +version = "2.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" + +[[package]] +name = "pin-project-lite" +version = "0.2.17" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" + +[[package]] +name = "pkg-config" +version = "0.3.33" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "19f132c84eca552bf34cab8ec81f1c1dcc229b811638f9d283dceabe58c5569e" + +[[package]] +name = "portable-atomic" +version = "1.13.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49" + +[[package]] +name = "portable-atomic-util" +version = "0.2.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c2a106d1259c23fac8e543272398ae0e3c0b8d33c88ed73d0cc71b0f1d902618" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "potential_utf" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0103b1cef7ec0cf76490e969665504990193874ea05c85ff9bab8b911d0a0564" +dependencies = [ + "zerovec", +] + +[[package]] +name = "prettyplease" +version = "0.2.37" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b" +dependencies = [ + "proc-macro2", + "syn", +] + +[[package]] +name = "proc-macro2" +version = "1.0.106" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.45" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "r-efi" +version = "5.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f" + +[[package]] +name = "r-efi" +version = "6.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" + +[[package]] +name = "redox_users" +version = "0.4.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43" +dependencies = [ + "getrandom 0.2.17", + "libredox", + "thiserror 1.0.69", +] + +[[package]] +name = "regex" +version = "1.12.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e10754a14b9137dd7b1e3e5b0493cc9171fdd105e0ab477f51b72e7f3ac0e276" +dependencies = [ + "aho-corasick", + "memchr", + "regex-automata", + "regex-syntax", +] + +[[package]] +name = "regex-automata" +version = "0.4.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6e1dd4122fc1595e8162618945476892eefca7b88c52820e74af6262213cae8f" +dependencies = [ + "aho-corasick", + "memchr", + "regex-syntax", +] + +[[package]] +name = "regex-syntax" +version = "0.8.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a" + +[[package]] +name = "rustfix" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82fa69b198d894d84e23afde8e9ab2af4400b2cba20d6bf2b428a8b01c222c5a" +dependencies = [ + "serde", + "serde_json", + "thiserror 1.0.69", + "tracing", +] + +[[package]] +name = "rustix" +version = "1.1.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6fe4565b9518b83ef4f91bb47ce29620ca828bd32cb7e408f0062e9930ba190" +dependencies = [ + "bitflags", + "errno", + "libc", + "linux-raw-sys", + "windows-sys 0.61.2", +] + +[[package]] +name = "rustversion" +version = "1.0.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d" + +[[package]] +name = "semver" +version = "1.0.28" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" +dependencies = [ + "serde", + "serde_core", +] + +[[package]] +name = "serde" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" +dependencies = [ + "serde_core", + "serde_derive", +] + +[[package]] +name = "serde_core" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.228" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "serde_json" +version = "1.0.149" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "83fc039473c5595ace860d8c4fafa220ff474b3fc6bfdb4293327f1a37e94d86" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "serde_spanned" +version = "1.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6662b5879511e06e8999a8a235d848113e942c9124f211511b16466ee2995f26" +dependencies = [ + "serde_core", +] + +[[package]] +name = "shlex" +version = "1.3.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" + +[[package]] +name = "smallvec" +version = "1.15.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" + +[[package]] +name = "stable_deref_trait" +version = "1.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" + +[[package]] +name = "syn" +version = "2.0.117" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "synstructure" +version = "0.13.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "tar" +version = "0.4.46" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3f6221d9a6003c78398e3b239969f352578258df48c8eb051caadae0015bc840" +dependencies = [ + "filetime", + "libc", + "xattr", +] + +[[package]] +name = "tempfile" +version = "3.27.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" +dependencies = [ + "fastrand", + "getrandom 0.4.2", + "once_cell", + "rustix", + "windows-sys 0.61.2", +] + +[[package]] +name = "term" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c59df8ac95d96ff9bede18eb7300b0fda5e5d8d90960e76f8e14ae765eedbf1f" +dependencies = [ + "dirs-next", + "rustversion", + "winapi", +] + +[[package]] +name = "tester" +version = "0.9.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "89e8bf7e0eb2dd7b4228cc1b6821fc5114cd6841ae59f652a85488c016091e5f" +dependencies = [ + "cfg-if", + "getopts", + "libc", + "num_cpus", + "term", +] + +[[package]] +name = "thiserror" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" +dependencies = [ + "thiserror-impl 1.0.69", +] + +[[package]] +name = "thiserror" +version = "2.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4" +dependencies = [ + "thiserror-impl 2.0.18", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "thiserror-impl" +version = "2.0.18" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "tinystr" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c8323304221c2a851516f22236c5722a72eaa19749016521d6dff0824447d96d" +dependencies = [ + "displaydoc", + "zerovec", +] + +[[package]] +name = "toml" +version = "1.1.2+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "81f3d15e84cbcd896376e6730314d59fb5a87f31e4b038454184435cd57defee" +dependencies = [ + "indexmap", + "serde_core", + "serde_spanned", + "toml_datetime", + "toml_parser", + "toml_writer", + "winnow", +] + +[[package]] +name = "toml_datetime" +version = "1.1.1+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3165f65f62e28e0115a00b2ebdd37eb6f3b641855f9d636d3cd4103767159ad7" +dependencies = [ + "serde_core", +] + +[[package]] +name = "toml_parser" +version = "1.1.2+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2abe9b86193656635d2411dc43050282ca48aa31c2451210f4202550afb7526" +dependencies = [ + "winnow", +] + +[[package]] +name = "toml_writer" +version = "1.1.1+spec-1.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "756daf9b1013ebe47a8776667b466417e2d4c5679d441c26230efd9ef78692db" + +[[package]] +name = "tracing" +version = "0.1.44" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" +dependencies = [ + "pin-project-lite", + "tracing-core", +] + +[[package]] +name = "tracing-core" +version = "0.1.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" +dependencies = [ + "once_cell", +] + +[[package]] +name = "unicode-ident" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75" + +[[package]] +name = "unicode-width" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b4ac048d71ede7ee76d585517add45da530660ef4390e49b098733c6e897f254" + +[[package]] +name = "unicode-xid" +version = "0.2.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" + +[[package]] +name = "url" +version = "2.5.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" +dependencies = [ + "form_urlencoded", + "idna", + "percent-encoding", + "serde", +] + +[[package]] +name = "utf8_iter" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" + +[[package]] +name = "utf8parse" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" + +[[package]] +name = "vcpkg" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" + +[[package]] +name = "wasi" +version = "0.11.1+wasi-snapshot-preview1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" + +[[package]] +name = "wasip2" +version = "1.0.3+wasi-0.2.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "20064672db26d7cdc89c7798c48a0fdfac8213434a1186e5ef29fd560ae223d6" +dependencies = [ + "wit-bindgen 0.57.1", +] + +[[package]] +name = "wasip3" +version = "0.4.0+wasi-0.3.0-rc-2026-01-06" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5428f8bf88ea5ddc08faddef2ac4a67e390b88186c703ce6dbd955e1c145aca5" +dependencies = [ + "wit-bindgen 0.51.0", +] + +[[package]] +name = "wasm-encoder" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "990065f2fe63003fe337b932cfb5e3b80e0b4d0f5ff650e6985b1048f62c8319" +dependencies = [ + "leb128fmt", + "wasmparser", +] + +[[package]] +name = "wasm-metadata" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bb0e353e6a2fbdc176932bbaab493762eb1255a7900fe0fea1a2f96c296cc909" +dependencies = [ + "anyhow", + "indexmap", + "wasm-encoder", + "wasmparser", +] + +[[package]] +name = "wasmparser" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "47b807c72e1bac69382b3a6fb3dbe8ea4c0ed87ff5629b8685ae6b9a611028fe" +dependencies = [ + "bitflags", + "hashbrown 0.15.5", + "indexmap", + "semver", +] + +[[package]] +name = "winapi" +version = "0.3.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" +dependencies = [ + "winapi-i686-pc-windows-gnu", + "winapi-x86_64-pc-windows-gnu", +] + +[[package]] +name = "winapi-i686-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" + +[[package]] +name = "winapi-x86_64-pc-windows-gnu" +version = "0.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" + +[[package]] +name = "windows-link" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" + +[[package]] +name = "windows-sys" +version = "0.59.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" +dependencies = [ + "windows-targets", +] + +[[package]] +name = "windows-sys" +version = "0.61.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" +dependencies = [ + "windows-link", +] + +[[package]] +name = "windows-targets" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" +dependencies = [ + "windows_aarch64_gnullvm", + "windows_aarch64_msvc", + "windows_i686_gnu", + "windows_i686_gnullvm", + "windows_i686_msvc", + "windows_x86_64_gnu", + "windows_x86_64_gnullvm", + "windows_x86_64_msvc", +] + +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" + +[[package]] +name = "windows_aarch64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" + +[[package]] +name = "windows_i686_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" + +[[package]] +name = "windows_i686_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" + +[[package]] +name = "windows_i686_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" + +[[package]] +name = "windows_x86_64_gnu" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" + +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" + +[[package]] +name = "windows_x86_64_msvc" +version = "0.52.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" + +[[package]] +name = "winnow" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0592e1c9d151f854e6fd382574c3a0855250e1d9b2f99d9281c6e6391af352f1" + +[[package]] +name = "wit-bindgen" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d7249219f66ced02969388cf2bb044a09756a083d0fab1e566056b04d9fbcaa5" +dependencies = [ + "wit-bindgen-rust-macro", +] + +[[package]] +name = "wit-bindgen" +version = "0.57.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e" + +[[package]] +name = "wit-bindgen-core" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ea61de684c3ea68cb082b7a88508a8b27fcc8b797d738bfc99a82facf1d752dc" +dependencies = [ + "anyhow", + "heck", + "wit-parser", +] + +[[package]] +name = "wit-bindgen-rust" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7c566e0f4b284dd6561c786d9cb0142da491f46a9fbed79ea69cdad5db17f21" +dependencies = [ + "anyhow", + "heck", + "indexmap", + "prettyplease", + "syn", + "wasm-metadata", + "wit-bindgen-core", + "wit-component", +] + +[[package]] +name = "wit-bindgen-rust-macro" +version = "0.51.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0c0f9bfd77e6a48eccf51359e3ae77140a7f50b1e2ebfe62422d8afdaffab17a" +dependencies = [ + "anyhow", + "prettyplease", + "proc-macro2", + "quote", + "syn", + "wit-bindgen-core", + "wit-bindgen-rust", +] + +[[package]] +name = "wit-component" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9d66ea20e9553b30172b5e831994e35fbde2d165325bec84fc43dbf6f4eb9cb2" +dependencies = [ + "anyhow", + "bitflags", + "indexmap", + "log", + "serde", + "serde_derive", + "serde_json", + "wasm-encoder", + "wasm-metadata", + "wasmparser", + "wit-parser", +] + +[[package]] +name = "wit-parser" +version = "0.244.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "ecc8ac4bc1dc3381b7f59c34f00b67e18f910c2c0f50015669dde7def656a736" +dependencies = [ + "anyhow", + "id-arena", + "indexmap", + "log", + "semver", + "serde", + "serde_derive", + "serde_json", + "unicode-xid", + "wasmparser", +] + +[[package]] +name = "writeable" +version = "0.6.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1ffae5123b2d3fc086436f8834ae3ab053a283cfac8fe0a0b8eaae044768a4c4" + +[[package]] +name = "xattr" +version = "1.6.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32e45ad4206f6d2479085147f02bc2ef834ac85886624a23575ae137c8aa8156" +dependencies = [ + "libc", + "rustix", +] + +[[package]] +name = "yoke" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "abe8c5fda708d9ca3df187cae8bfb9ceda00dd96231bed36e445a1a48e66f9ca" +dependencies = [ + "stable_deref_trait", + "yoke-derive", + "zerofrom", +] + +[[package]] +name = "yoke-derive" +version = "0.8.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "de844c262c8848816172cef550288e7dc6c7b7814b4ee56b3e1553f275f1858e" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "synstructure", +] + +[[package]] +name = "zerofrom" +version = "0.1.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0ec05a11813ea801ff6d75110ad09cd0824ddba17dfe17128ea0d5f68e6c5272" +dependencies = [ + "zerofrom-derive", +] + +[[package]] +name = "zerofrom-derive" +version = "0.1.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11532158c46691caf0f2593ea8358fed6bbf68a0315e80aae9bd41fbade684a1" +dependencies = [ + "proc-macro2", + "quote", + "syn", + "synstructure", +] + +[[package]] +name = "zerotrie" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0f9152d31db0792fa83f70fb2f83148effb5c1f5b8c7686c3459e361d9bc20bf" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + +[[package]] +name = "zerovec" +version = "0.11.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "90f911cbc359ab6af17377d242225f4d75119aec87ea711a880987b18cd7b239" +dependencies = [ + "yoke", + "zerofrom", + "zerovec-derive", +] + +[[package]] +name = "zerovec-derive" +version = "0.11.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "625dc425cab0dca6dc3c3319506e6593dcb08a9f387ea3b284dbd52a92c40555" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "zmij" +version = "1.0.21" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b8848ee67ecc8aedbaf3e4122217aff892639231befc6a1b58d29fff4c2cabaa" diff --git a/.github/dylints/lossy_feedback/Cargo.toml b/.github/dylints/lossy_feedback/Cargo.toml new file mode 100644 index 00000000000..8094722ef00 --- /dev/null +++ b/.github/dylints/lossy_feedback/Cargo.toml @@ -0,0 +1,18 @@ +[package] +name = "lossy_feedback" +version = "0.0.1" +description = "Require lossy mailboxes to return Lossy." +edition = "2021" +publish = false + +[lib] +crate-type = ["cdylib"] + +[dependencies] +dylint_linting = "6.0.0" + +[dev-dependencies] +dylint_testing = "6.0.0" + +[package.metadata.rust-analyzer] +rustc_private = true diff --git a/.github/dylints/lossy_feedback/rust-toolchain b/.github/dylints/lossy_feedback/rust-toolchain new file mode 100644 index 00000000000..588e8755f3a --- /dev/null +++ b/.github/dylints/lossy_feedback/rust-toolchain @@ -0,0 +1,5 @@ +# Dylint discovers library toolchains from this directory, so the just/CI +# `cargo +nightly-... dylint` invocation does not pin the library build. +[toolchain] +channel = "nightly" +components = ["rustc-dev", "llvm-tools-preview"] diff --git a/.github/dylints/lossy_feedback/src/lib.rs b/.github/dylints/lossy_feedback/src/lib.rs new file mode 100644 index 00000000000..e876f75a78f --- /dev/null +++ b/.github/dylints/lossy_feedback/src/lib.rs @@ -0,0 +1,355 @@ +#![feature(rustc_private)] +#![warn(unused_extern_crates)] + +extern crate rustc_ast; +extern crate rustc_errors; +extern crate rustc_hir; +extern crate rustc_middle; +extern crate rustc_span; + +use rustc_ast::ast::LitKind; +use rustc_errors::DiagDecorator; +use rustc_hir::{ + intravisit::{self, Visitor}, + Arm, BodyId, Expr, ExprKind, FnDecl, FnRetTy, ImplItem, ImplItemKind, ItemKind, Node, Pat, + PatExprKind, PatKind, QPath, Ty, TyKind, +}; +use rustc_lint::{LateContext, LateLintPass, LintContext}; +use rustc_middle::ty; +use rustc_span::{ + def_id::{DefId, LocalDefId}, + Span, Symbol, +}; +use std::collections::{HashMap, HashSet}; + +dylint_linting::impl_late_lint! { + /// ### What it does + /// + /// Detects functions that return plain `Feedback` from a mailbox whose + /// [`Policy::handle`] implementation can return `false`. + /// + /// ### Why is this bad? + /// + /// A mailbox policy that returns `false` rejects live work under backpressure. + /// Returning `Lossy` makes that lossy contract explicit at the API + /// boundary. + /// + /// ### Example + /// + /// ```rust + /// fn submit(&self, message: Message) -> Feedback { + /// self.sender.enqueue(message) + /// } + /// ``` + /// + /// Use instead: + /// + /// ```rust + /// fn submit(&self, message: Message) -> Lossy { + /// self.sender.enqueue_lossy(message) + /// } + /// ``` + pub LOSSY_FEEDBACK, + Deny, + "lossy mailbox returns plain Feedback", + LossyFeedback::default() +} + +#[derive(Default)] +pub struct LossyFeedback { + lossy_messages: HashMap, +} + +#[derive(Default)] +struct LossyPolicy { + all: bool, + variants: HashSet, +} + +impl LossyPolicy { + fn merge(&mut self, other: LossyPolicy) { + self.all |= other.all; + self.variants.extend(other.variants); + } + + fn is_empty(&self) -> bool { + !self.all && self.variants.is_empty() + } +} + +impl<'tcx> LateLintPass<'tcx> for LossyFeedback { + fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx ImplItem<'tcx>) { + let ImplItemKind::Fn(_, body_id) = item.kind else { + return; + }; + if item.ident.name != Symbol::intern("handle") { + return; + } + + let Some(message) = policy_self_ty(cx, item) else { + return; + }; + let policy = lossy_policy(cx, body_id); + if !policy.is_empty() { + self.lossy_messages.insert(message, policy); + } + } + + fn check_fn( + &mut self, + cx: &LateContext<'tcx>, + _kind: rustc_hir::intravisit::FnKind<'tcx>, + decl: &'tcx FnDecl<'tcx>, + body: &'tcx rustc_hir::Body<'tcx>, + _span: Span, + _id: LocalDefId, + ) { + if !returns_plain_feedback(decl) { + return; + } + + let mut visitor = LossyEnqueueVisitor { + cx, + lossy_messages: &self.lossy_messages, + span: None, + }; + visitor.visit_expr(body.value); + + if let Some(span) = visitor.span { + cx.emit_span_lint( + LOSSY_FEEDBACK, + span, + DiagDecorator(|diag| { + diag.primary_message("lossy mailbox returns plain Feedback"); + diag.span_help(span, "use enqueue_lossy and return Lossy"); + }), + ); + } + } +} + +fn policy_self_ty(cx: &LateContext<'_>, item: &ImplItem<'_>) -> Option { + let Node::Item(parent) = cx.tcx.parent_hir_node(item.hir_id()) else { + return None; + }; + let ItemKind::Impl(impl_) = parent.kind else { + return None; + }; + let trait_ref = impl_.of_trait.as_ref()?; + if trait_ref.trait_ref.path.segments.last()?.ident.name != Symbol::intern("Policy") { + return None; + } + ty_def_id(impl_.self_ty) +} + +fn ty_def_id(ty: &Ty<'_>) -> Option { + let TyKind::Path(QPath::Resolved(_, path)) = ty.kind else { + return None; + }; + path.res.opt_def_id() +} + +fn lossy_policy(cx: &LateContext<'_>, body_id: BodyId) -> LossyPolicy { + let body = cx.tcx.hir_body(body_id); + let mut policy = LossyPolicy::default(); + + let mut visitor = ReturnVisitor { + policy: &mut policy, + }; + visitor.visit_expr(body.value); + collect_tail_lossy(body.value, &mut policy); + + policy +} + +struct ReturnVisitor<'a> { + policy: &'a mut LossyPolicy, +} + +impl<'tcx> Visitor<'tcx> for ReturnVisitor<'_> { + fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) { + match expr.kind { + ExprKind::Closure(_) => {} + ExprKind::Ret(Some(value)) => { + if bool_value(value) == Some(false) { + self.policy.all = true; + } + intravisit::walk_expr(self, expr); + } + _ => intravisit::walk_expr(self, expr), + } + } +} + +fn collect_tail_lossy(expr: &Expr<'_>, policy: &mut LossyPolicy) { + match expr.kind { + ExprKind::Block(block, _) => { + if let Some(expr) = block.expr { + collect_tail_lossy(expr, policy); + } + } + ExprKind::If(_, then, Some(otherwise)) => { + collect_tail_lossy(then, policy); + collect_tail_lossy(otherwise, policy); + } + ExprKind::If(_, then, None) => collect_tail_lossy(then, policy), + ExprKind::Match(_, arms, _) => collect_match_lossy(arms, policy), + ExprKind::Closure(_) => {} + _ => { + if bool_value(expr) == Some(false) { + policy.all = true; + } + } + } +} + +fn collect_match_lossy(arms: &[Arm<'_>], policy: &mut LossyPolicy) { + for arm in arms { + let mut arm_policy = LossyPolicy::default(); + collect_tail_lossy(arm.body, &mut arm_policy); + if arm_policy.is_empty() { + continue; + } + if arm_policy.all { + collect_lossy_pattern(arm.pat, policy); + } else { + policy.merge(arm_policy); + } + } +} + +fn collect_lossy_pattern(pat: &Pat<'_>, policy: &mut LossyPolicy) { + match pat.kind { + PatKind::Struct(qpath, ..) | PatKind::TupleStruct(qpath, ..) => { + if let Some(variant) = qpath_name(qpath) { + policy.variants.insert(variant); + } else { + policy.all = true; + } + } + PatKind::Expr(expr) => { + if let PatExprKind::Path(qpath) = expr.kind { + if let Some(variant) = qpath_name(qpath) { + policy.variants.insert(variant); + } else { + policy.all = true; + } + } else { + policy.all = true; + } + } + PatKind::Or(pats) => { + for pat in pats { + collect_lossy_pattern(pat, policy); + } + } + PatKind::Binding(_, _, _, Some(pat)) | PatKind::Ref(pat, _, _) => { + collect_lossy_pattern(pat, policy); + } + _ => policy.all = true, + } +} + +fn bool_value(expr: &Expr<'_>) -> Option { + if let ExprKind::Lit(lit) = expr.kind { + if let LitKind::Bool(value) = lit.node { + return Some(value); + } + } + None +} + +fn returns_plain_feedback(decl: &FnDecl<'_>) -> bool { + let FnRetTy::Return(ty) = decl.output else { + return false; + }; + path_ty_name(ty) == Some(Symbol::intern("Feedback")) +} + +fn path_ty_name(ty: &Ty<'_>) -> Option { + let TyKind::Path(QPath::Resolved(_, path)) = ty.kind else { + return None; + }; + Some(path.segments.last()?.ident.name) +} + +fn qpath_name(qpath: QPath<'_>) -> Option { + match qpath { + QPath::Resolved(_, path) => Some(path.segments.last()?.ident.name), + QPath::TypeRelative(_, segment) => Some(segment.ident.name), + } +} + +struct LossyEnqueueVisitor<'a, 'tcx> { + cx: &'a LateContext<'tcx>, + lossy_messages: &'a HashMap, + span: Option, +} + +impl<'tcx> Visitor<'tcx> for LossyEnqueueVisitor<'_, 'tcx> { + fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) { + if self.span.is_some() || expr.span.from_expansion() { + return; + } + + match expr.kind { + ExprKind::Closure(_) => {} + ExprKind::MethodCall(segment, receiver, args, _) + if segment.ident.name == Symbol::intern("enqueue") + && self.enqueue_is_lossy(receiver, args.first()) => + { + self.span = Some(expr.span); + } + _ => intravisit::walk_expr(self, expr), + } + } +} + +impl LossyEnqueueVisitor<'_, '_> { + fn enqueue_is_lossy(&self, receiver: &Expr<'_>, message: Option<&Expr<'_>>) -> bool { + let Some(policy) = self.receiver_lossy_policy(receiver) else { + return false; + }; + if policy.all { + return true; + } + + let Some(message) = message else { + return false; + }; + message_variant(message).is_some_and(|variant| policy.variants.contains(&variant)) + } + + fn receiver_lossy_policy(&self, receiver: &Expr<'_>) -> Option<&LossyPolicy> { + let receiver_ty = self.cx.typeck_results().expr_ty(receiver).peel_refs(); + let ty::Adt(_, args) = receiver_ty.kind() else { + return None; + }; + let message_ty = args.get(0).and_then(|arg| arg.as_type())?; + let ty::Adt(message, _) = message_ty.peel_refs().kind() else { + return None; + }; + self.lossy_messages.get(&message.did()) + } +} + +fn message_variant(expr: &Expr<'_>) -> Option { + match expr.kind { + ExprKind::Struct(qpath, ..) => qpath_name(*qpath), + ExprKind::Path(qpath) => qpath_name(qpath), + ExprKind::Call(callee, _) => { + if let ExprKind::Path(qpath) = callee.kind { + qpath_name(qpath) + } else { + None + } + } + ExprKind::Block(block, _) => block.expr.and_then(message_variant), + _ => None, + } +} + +#[test] +fn ui() { + dylint_testing::ui_test(env!("CARGO_PKG_NAME"), "ui"); +} diff --git a/.github/dylints/lossy_feedback/ui/main.rs b/.github/dylints/lossy_feedback/ui/main.rs new file mode 100644 index 00000000000..7e73ce053ed --- /dev/null +++ b/.github/dylints/lossy_feedback/ui/main.rs @@ -0,0 +1,106 @@ +enum Feedback { + Ok, + Backoff, + Closed, +} + +enum Lossy { + Handled(T), + Rejected, +} + +mod mailbox { + use super::{Feedback, Lossy}; + use std::marker::PhantomData; + + pub trait Policy: Sized { + type Overflow; + + fn handle(overflow: &mut Self::Overflow, message: Self) -> bool; + } + + pub struct Sender(PhantomData); + + impl Sender { + pub fn enqueue(&self, _message: T) -> Feedback { + Feedback::Ok + } + + pub fn enqueue_lossy(&self, _message: T) -> Lossy { + Lossy::Handled(Feedback::Ok) + } + } +} + +struct ReliableMessage; + +impl mailbox::Policy for ReliableMessage { + type Overflow = (); + + fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { + true + } +} + +struct LossyMessage; + +impl mailbox::Policy for LossyMessage { + type Overflow = (); + + fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { + false + } +} + +enum MixedMessage { + Content, + Release, +} + +impl mailbox::Policy for MixedMessage { + type Overflow = Vec; + + fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + match message { + Self::Content => false, + message => { + overflow.push(message); + true + } + } + } +} + +struct Mailbox { + reliable: mailbox::Sender, + lossy: mailbox::Sender, + mixed: mailbox::Sender, +} + +impl Mailbox { + fn allowed_reliable(&self, message: ReliableMessage) -> Feedback { + self.reliable.enqueue(message) + } + + fn bad_lossy(&self, message: LossyMessage) -> Feedback { + self.lossy.enqueue(message) + } + + fn good_lossy(&self, message: LossyMessage) -> Lossy { + self.lossy.enqueue_lossy(message) + } + + fn bad_content(&self) -> Feedback { + self.mixed.enqueue(MixedMessage::Content) + } + + fn allowed_release(&self) -> Feedback { + self.mixed.enqueue(MixedMessage::Release) + } + + fn ignored(&self, message: LossyMessage) { + let _ = self.lossy.enqueue(message); + } +} + +fn main() {} diff --git a/.github/dylints/lossy_feedback/ui/main.stderr b/.github/dylints/lossy_feedback/ui/main.stderr new file mode 100644 index 00000000000..020ccfdf06f --- /dev/null +++ b/.github/dylints/lossy_feedback/ui/main.stderr @@ -0,0 +1,27 @@ +error: lossy mailbox returns plain Feedback + --> $DIR/main.rs:86:9 + | +LL | self.lossy.enqueue(message) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ + | +help: use enqueue_lossy and return Lossy + --> $DIR/main.rs:86:9 + | +LL | self.lossy.enqueue(message) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ + = note: `#[deny(lossy_feedback)]` on by default + +error: lossy mailbox returns plain Feedback + --> $DIR/main.rs:94:9 + | +LL | self.mixed.enqueue(MixedMessage::Content) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + | +help: use enqueue_lossy and return Lossy + --> $DIR/main.rs:94:9 + | +LL | self.mixed.enqueue(MixedMessage::Content) + | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +error: aborting due to 2 previous errors + diff --git a/Cargo.toml b/Cargo.toml index 7b8857288f7..19b0ad6fd5b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -48,6 +48,7 @@ members = [ exclude = [ ".github/dylints/borrowed_child_context", ".github/dylints/child_attribute_name_conflict", + ".github/dylints/lossy_feedback", ] resolver = "2" diff --git a/actor/src/benches/mailbox.rs b/actor/src/benches/mailbox.rs index f52d4e3e656..f2bbb528205 100644 --- a/actor/src/benches/mailbox.rs +++ b/actor/src/benches/mailbox.rs @@ -1,4 +1,4 @@ -use commonware_actor::{mailbox, Feedback}; +use commonware_actor::{mailbox, Feedback, Lossy}; use commonware_runtime::{ telemetry::metrics::{Metric, Registered, Registration}, Metrics, Name, Supervisor, @@ -257,8 +257,8 @@ fn bench_overflow_drop(c: &mut Criterion) { }, |(sender, _receiver)| { for _ in 0..MESSAGES { - let result = sender.enqueue(black_box(Message::drop())); - assert_eq!(result, Feedback::Rejected); + let result = sender.enqueue_lossy(black_box(Message::drop())); + assert_eq!(result, Lossy::Rejected); black_box(result); } }, diff --git a/actor/src/lib.rs b/actor/src/lib.rs index 795fe344bf8..6b9acb46d6b 100644 --- a/actor/src/lib.rs +++ b/actor/src/lib.rs @@ -17,8 +17,6 @@ commonware_macros::stability_scope!(BETA { Ok, /// The submission exceeded configured capacity but was handled by the overflow policy. Backoff, - /// The submission exceeded configured capacity and was rejected by the overflow policy. - Rejected, /// The endpoint is closed. Closed, } @@ -30,5 +28,70 @@ commonware_macros::stability_scope!(BETA { } } + /// Feedback from endpoints that may drop work under backpressure. + #[derive(Clone, Copy, Debug, PartialEq, Eq)] + pub enum Lossy { + /// The work was handled by the endpoint. + Handled(T), + /// The work was rejected by the endpoint. + Rejected, + } + + impl Lossy { + /// Create handled feedback for an endpoint that may reject live work. + pub const fn new(feedback: Feedback) -> Self { + Self::Handled(feedback) + } + + /// Create rejected feedback. + pub const fn rejected() -> Self { + Self::Rejected + } + + /// Return the underlying feedback. + /// + /// # Panics + /// + /// Panics if the endpoint rejected the work. + pub fn into_inner(self) -> Feedback { + match self { + Self::Handled(feedback) => feedback, + Self::Rejected => panic!("lossy feedback was rejected"), + } + } + + /// Returns `true` when the endpoint handled the submission. + pub const fn accepted(self) -> bool { + match self { + Self::Handled(feedback) => feedback.accepted(), + Self::Rejected => false, + } + } + } + + impl From for Lossy { + fn from(feedback: Feedback) -> Self { + Self::new(feedback) + } + } + + impl From> for Feedback { + fn from(feedback: Lossy) -> Self { + feedback.into_inner() + } + } + + impl PartialEq for Lossy { + fn eq(&self, other: &Feedback) -> bool { + matches!(self, Self::Handled(feedback) if feedback == other) + } + } + + impl PartialEq> for Feedback { + fn eq(&self, other: &Lossy) -> bool { + other == self + } + } + pub mod mailbox; }); diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 07db962651e..1a5fd4eada6 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -39,7 +39,7 @@ //! Enqueue calls from the same sender will be delivered in order. Concurrent enqueue calls, //! however, are not globally ordered and may be observed in any interleaving. -use crate::Feedback; +use crate::{Feedback, Lossy}; use commonware_runtime::{ telemetry::metrics::{Counter, MetricsExt as _}, Metrics, @@ -282,13 +282,18 @@ impl OverflowState { ready.push(message) } - fn enqueue(&self, ready: &Ready, message: T, is_closed: impl Fn() -> bool) -> Feedback { + fn enqueue_lossy( + &self, + ready: &Ready, + message: T, + is_closed: impl Fn() -> bool, + ) -> Lossy { // Mark overflow active so racing senders stay off the ready fast path. let mutation = Mutation::begin(&self.activity); let mut queue = lock(&self.queue); if is_closed() { mutation.publish(queue.is_empty()); - return Feedback::Closed; + return Lossy::new(Feedback::Closed); } // The fast-path push may have observed stale ready fullness. Retry @@ -298,7 +303,7 @@ impl OverflowState { match ready.push(message) { Ok(()) => { mutation.publish(queue.is_empty()); - return Feedback::Ok; + return Lossy::new(Feedback::Ok); } Err(message) => message, } @@ -310,9 +315,9 @@ impl OverflowState { let handled = T::handle(&mut queue, message); mutation.publish(queue.is_empty()); if handled { - Feedback::Backoff + Lossy::new(Feedback::Backoff) } else { - Feedback::Rejected + Lossy::Rejected } } @@ -427,11 +432,24 @@ impl fmt::Debug for Sender { impl Sender { /// Submit a message without waiting for inbox capacity. + /// + /// Use this for policies that handle all overflow messages. Use [`Sender::enqueue_lossy`] when + /// the policy may reject a message under backpressure. + /// + /// # Panics + /// + /// Panics if the overflow policy rejects the message. #[must_use = "caller must handle enqueue feedback"] pub fn enqueue(&self, message: T) -> Feedback { + self.enqueue_lossy(message).into_inner() + } + + /// Submit a message without waiting for inbox capacity, allowing policy rejection. + #[must_use = "caller must handle enqueue feedback"] + pub fn enqueue_lossy(&self, message: T) -> Lossy { // Receiver closure makes new sends fail immediately. if self.state.closed.load(Ordering::Acquire) { - return Feedback::Closed; + return Lossy::new(Feedback::Closed); } // Common case: publish directly to ready without taking overflow lock. @@ -439,18 +457,21 @@ impl Sender { Ok(()) => { if self.state.closed.load(Ordering::Acquire) { self.state.overflow.drain(&self.state.ready); - return Feedback::Closed; + return Lossy::new(Feedback::Closed); } self.state.waker.wake(); - return Feedback::Ok; + return Lossy::new(Feedback::Ok); } Err(message) => message, }; // Slow path: serialize through overflow and apply the policy. - let feedback = self.state.overflow.enqueue(&self.state.ready, message, || { - self.state.closed.load(Ordering::Acquire) - }); + let feedback = self + .state + .overflow + .enqueue_lossy(&self.state.ready, message, || { + self.state.closed.load(Ordering::Acquire) + }); // Record any backoff. if feedback == Feedback::Backoff { @@ -754,7 +775,7 @@ mod tests { async fn full_inbox_rejects_non_replaceable_message() { let (sender, mut receiver) = new(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Vote(2)), Feedback::Rejected); + assert_eq!(sender.enqueue_lossy(Message::Vote(2)), Lossy::Rejected); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); } @@ -797,14 +818,14 @@ mod tests { } #[test] - fn rejected_feedback_is_not_accepted_or_counted_as_backoff() { + fn lossy_rejected_feedback_is_not_accepted_or_counted_as_backoff() { let executor = deterministic::Runner::default(); executor.start(|context| async move { let (sender, _receiver) = super::new(context.child("mailbox"), NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - let feedback = sender.enqueue(Message::Vote(2)); + let feedback = sender.enqueue_lossy(Message::Vote(2)); - assert_eq!(feedback, Feedback::Rejected); + assert_eq!(feedback, Lossy::Rejected); assert!(!feedback.accepted()); let buffer = context.encode(); diff --git a/collector/fuzz/fuzz_targets/collector.rs b/collector/fuzz/fuzz_targets/collector.rs index 00d267ac940..cf5648b4832 100644 --- a/collector/fuzz/fuzz_targets/collector.rs +++ b/collector/fuzz/fuzz_targets/collector.rs @@ -1,7 +1,7 @@ #![no_main] use arbitrary::Arbitrary; -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_codec::{ Encode, EncodeSize, Error as CodecError, FixedSize, RangeCfg, Read, ReadExt, ReadRangeExt, Write, @@ -231,8 +231,8 @@ impl CheckedSender for MockCheckedSender { Vec::new() } - fn send(self, _message: impl Into + Send, _priority: bool) -> Feedback { - Feedback::Ok + fn send(self, _message: impl Into + Send, _priority: bool) -> Lossy { + Lossy::new(Feedback::Ok) } } diff --git a/collector/src/p2p/mocks/sender.rs b/collector/src/p2p/mocks/sender.rs index ab95819a9f2..55bef1e2c54 100644 --- a/collector/src/p2p/mocks/sender.rs +++ b/collector/src/p2p/mocks/sender.rs @@ -1,6 +1,6 @@ //! Mock sender implementations for testing. -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_p2p::{CheckedSender, LimitedSender, Recipients}; use commonware_runtime::IoBufs; @@ -43,7 +43,7 @@ impl CheckedSender for CheckedFailing

{ Vec::new() } - fn send(self, _message: impl Into + Send, _priority: bool) -> Feedback { - Feedback::Closed + fn send(self, _message: impl Into + Send, _priority: bool) -> Lossy { + Lossy::new(Feedback::Closed) } } diff --git a/consensus/src/reporter.rs b/consensus/src/reporter.rs index df2e7f63d7c..5c0fa1c2dde 100644 --- a/consensus/src/reporter.rs +++ b/consensus/src/reporter.rs @@ -50,7 +50,6 @@ where const fn combine(a: Feedback, b: Feedback) -> Feedback { match (a, b) { (Feedback::Closed, _) | (_, Feedback::Closed) => Feedback::Closed, - (Feedback::Rejected, _) | (_, Feedback::Rejected) => Feedback::Rejected, (Feedback::Backoff, _) | (_, Feedback::Backoff) => Feedback::Backoff, (Feedback::Ok, Feedback::Ok) => Feedback::Ok, } @@ -146,14 +145,6 @@ mod tests { Feedback::Closed ); assert_eq!(combine(Feedback::Backoff, Feedback::Ok), Feedback::Backoff); - assert_eq!( - combine(Feedback::Rejected, Feedback::Ok), - Feedback::Rejected - ); - assert_eq!( - combine(Feedback::Rejected, Feedback::Backoff), - Feedback::Rejected - ); assert_eq!(combine(Feedback::Ok, Feedback::Ok), Feedback::Ok); } } diff --git a/p2p/src/authenticated/discovery/actors/peer/actor.rs b/p2p/src/authenticated/discovery/actors/peer/actor.rs index d7171df4add..7a3de23849b 100644 --- a/p2p/src/authenticated/discovery/actors/peer/actor.rs +++ b/p2p/src/authenticated/discovery/actors/peer/actor.rs @@ -363,7 +363,8 @@ impl // processing of gossip messages (BitVec, Peers), causing the // peer connection to stall and potentially disconnect. let sender = senders.get_mut(&data.channel).unwrap(); - let _ = sender.enqueue(channels::Inbound((peer.clone(), data.message))); + let _ = + sender.enqueue_lossy(channels::Inbound((peer.clone(), data.message))); } types::Payload::Greeting(_) => unreachable!(), types::Payload::BitVec(bit_vec) => { diff --git a/p2p/src/authenticated/discovery/actors/peer/ingress.rs b/p2p/src/authenticated/discovery/actors/peer/ingress.rs index 2a9438b3786..5590f4a2b75 100644 --- a/p2p/src/authenticated/discovery/actors/peer/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/peer/ingress.rs @@ -40,11 +40,11 @@ impl Mailbox { } pub fn bit_vec(&self, bit_vec: types::BitVec) { - let _ = self.0.enqueue(Message::BitVec(bit_vec)); + let _ = self.0.enqueue_lossy(Message::BitVec(bit_vec)); } pub fn peers(&self, peers: Vec>) { - let _ = self.0.enqueue(Message::Peers(peers)); + let _ = self.0.enqueue_lossy(Message::Peers(peers)); } pub fn kill(&self) { diff --git a/p2p/src/authenticated/discovery/actors/router/ingress.rs b/p2p/src/authenticated/discovery/actors/router/ingress.rs index d98a6d82a7c..34c3ded99eb 100644 --- a/p2p/src/authenticated/discovery/actors/router/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/router/ingress.rs @@ -9,7 +9,7 @@ use crate::{ }; use commonware_actor::{ mailbox::{self, Policy}, - Feedback, + Feedback, Lossy, }; use commonware_cryptography::PublicKey; use commonware_runtime::{BufferPool, IoBufs}; @@ -120,11 +120,11 @@ impl Messenger

{ channel: Channel, message: IoBufs, priority: bool, - ) -> Feedback { + ) -> Lossy { // Build Data and encode Payload::Data once for all recipients let encoded = types::Payload::

::encode_data(&self.pool, channel, message); - self.sender.0.enqueue(Message::Content { + self.sender.0.enqueue_lossy(Message::Content { recipients, encoded, priority, @@ -177,7 +177,7 @@ mod tests { ); assert_eq!( messenger.content(Recipients::One(peer), 7, IoBuf::from(b"two").into(), false), - Feedback::Rejected + Lossy::Rejected ); assert_eq!( mailbox.release(PrivateKey::from_seed(2).public_key()), diff --git a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs index 2b656f8a0e3..abbd262ed76 100644 --- a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::{discovery::actors::tracker::Reservation, Mailbox}; -use commonware_actor::{mailbox::Policy, Feedback}; +use commonware_actor::{mailbox::Policy, Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{Sink, Stream}; use commonware_stream::encrypted::{Receiver, Sender}; @@ -32,14 +32,14 @@ impl Policy for Message { impl Mailbox> { /// Send a message to the actor to spawn a new task for the given peer. /// - /// This may fail during shutdown if the spawner has already exited, - /// which is harmless since no new connections need to be spawned. + /// This may reject when the spawner is backlogged or closed, which is harmless since stale + /// connections do not need to be spawned. pub fn spawn( &mut self, connection: (Sender, Receiver), reservation: Reservation

, - ) -> Feedback { - self.0.enqueue(Message::Spawn { + ) -> Lossy { + self.0.enqueue_lossy(Message::Spawn { peer: reservation.metadata().public_key().clone(), connection, reservation, @@ -157,7 +157,7 @@ mod tests { assert_eq!(spawner.spawn(connection_1, reservation_1), Feedback::Ok); assert_eq!( spawner.spawn(connection_2, reservation_2), - Feedback::Rejected + Lossy::Rejected ); let release = tracker_receiver diff --git a/p2p/src/authenticated/discovery/channels.rs b/p2p/src/authenticated/discovery/channels.rs index 851a8563949..a62b31f3411 100644 --- a/p2p/src/authenticated/discovery/channels.rs +++ b/p2p/src/authenticated/discovery/channels.rs @@ -5,7 +5,7 @@ use crate::{ }; use commonware_actor::{ mailbox::{self, Policy}, - Feedback, + Feedback, Lossy, }; use commonware_cryptography::PublicKey; use commonware_runtime::{Clock, IoBufs, Metrics, Quota}; @@ -44,7 +44,7 @@ impl crate::UnlimitedSender for UnlimitedSender

{ recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Feedback { + ) -> Lossy { let message = message.into(); assert!( message.len() <= self.max_size as usize, diff --git a/p2p/src/authenticated/lookup/actors/peer/actor.rs b/p2p/src/authenticated/lookup/actors/peer/actor.rs index bf2af0cb272..5d36f2a3669 100644 --- a/p2p/src/authenticated/lookup/actors/peer/actor.rs +++ b/p2p/src/authenticated/lookup/actors/peer/actor.rs @@ -306,8 +306,8 @@ impl // processing of Ping messages, causing the peer connection to // stall and potentially disconnect. let sender = senders.get_mut(&data.channel).unwrap(); - let _ = - sender.enqueue(channels::Inbound((peer.clone(), data.message))); + let _ = sender + .enqueue_lossy(channels::Inbound((peer.clone(), data.message))); } types::Message::Ping => { // We ignore ping messages, they are only used to keep diff --git a/p2p/src/authenticated/lookup/actors/router/ingress.rs b/p2p/src/authenticated/lookup/actors/router/ingress.rs index 5b8ef368a15..937c73f8532 100644 --- a/p2p/src/authenticated/lookup/actors/router/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/router/ingress.rs @@ -9,7 +9,7 @@ use crate::{ }; use commonware_actor::{ mailbox::{self, Policy}, - Feedback, + Feedback, Lossy, }; use commonware_cryptography::PublicKey; use commonware_runtime::{BufferPool, IoBufs}; @@ -120,11 +120,11 @@ impl Messenger

{ channel: Channel, message: IoBufs, priority: bool, - ) -> Feedback { + ) -> Lossy { // Build Data and encode Message::Data once for all recipients let encoded = types::Message::encode_data(&self.pool, channel, message); - self.sender.0.enqueue(Message::Content { + self.sender.0.enqueue_lossy(Message::Content { recipients, encoded, priority, diff --git a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs index 6c680467aa9..bba807f1353 100644 --- a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::{lookup::actors::tracker::Reservation, Mailbox}; -use commonware_actor::{mailbox::Policy, Feedback}; +use commonware_actor::{mailbox::Policy, Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{Sink, Stream}; use commonware_stream::encrypted::{Receiver, Sender}; @@ -32,14 +32,14 @@ impl Policy for Message { impl Mailbox> { /// Send a message to the actor to spawn a new task for the given peer. /// - /// This may fail during shutdown if the spawner has already exited, - /// which is harmless since no new connections need to be spawned. + /// This may reject when the spawner is backlogged or closed, which is harmless since stale + /// connections do not need to be spawned. pub fn spawn( &mut self, connection: (Sender, Receiver), reservation: Reservation

, - ) -> Feedback { - self.0.enqueue(Message::Spawn { + ) -> Lossy { + self.0.enqueue_lossy(Message::Spawn { peer: reservation.metadata().public_key().clone(), connection, reservation, @@ -157,7 +157,7 @@ mod tests { assert_eq!(spawner.spawn(connection_1, reservation_1), Feedback::Ok); assert_eq!( spawner.spawn(connection_2, reservation_2), - Feedback::Rejected + Lossy::Rejected ); let release = tracker_receiver diff --git a/p2p/src/authenticated/lookup/channels.rs b/p2p/src/authenticated/lookup/channels.rs index 26ce1f80471..5e4409f7242 100644 --- a/p2p/src/authenticated/lookup/channels.rs +++ b/p2p/src/authenticated/lookup/channels.rs @@ -6,7 +6,7 @@ use crate::{ }; use commonware_actor::{ mailbox::{self, Policy}, - Feedback, + Feedback, Lossy, }; use commonware_cryptography::PublicKey; use commonware_runtime::{Clock, IoBufs, Metrics, Quota}; @@ -45,7 +45,7 @@ impl crate::UnlimitedSender for UnlimitedSender

{ recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Feedback { + ) -> Lossy { let message = message.into(); assert!( message.len() <= self.max_size as usize, diff --git a/p2p/src/authenticated/relay.rs b/p2p/src/authenticated/relay.rs index c2e5d33697c..28df25f7971 100644 --- a/p2p/src/authenticated/relay.rs +++ b/p2p/src/authenticated/relay.rs @@ -1,6 +1,6 @@ use commonware_actor::{ mailbox::{self, Policy}, - Feedback, + Feedback, Lossy, }; use commonware_macros::select; use commonware_runtime::Metrics; @@ -52,11 +52,11 @@ impl Relay { /// Submits `message` to the priority channel selected by `priority`. /// - /// This never waits for capacity. [`Feedback::Rejected`] means the selected channel was full + /// This never waits for capacity. [`Lossy::Rejected`] means the selected channel was full /// and did not handle the message, and [`Feedback::Closed`] means the receiver is gone. - pub fn send(&self, message: T, priority: bool) -> Feedback { + pub fn send(&self, message: T, priority: bool) -> Lossy { let sender = if priority { &self.high } else { &self.low }; - sender.enqueue(Message(message)) + sender.enqueue_lossy(Message(message)) } } @@ -128,7 +128,7 @@ mod tests { let (relay, mut receivers) = Relay::new(Metrics, NZUsize!(1)); assert_eq!(relay.send(1, false), Feedback::Ok); - assert_eq!(relay.send(2, false), Feedback::Rejected); + assert_eq!(relay.send(2, false), Lossy::Rejected); assert_eq!(receivers.low.try_recv().map(Message::into_inner), Ok(1)); assert!(receivers.low.try_recv().is_err()); } diff --git a/p2p/src/lib.rs b/p2p/src/lib.rs index d0880c2fd0b..0b56ce3c269 100644 --- a/p2p/src/lib.rs +++ b/p2p/src/lib.rs @@ -14,7 +14,7 @@ use commonware_macros::{stability_mod, stability_scope}; stability_mod!(ALPHA, pub mod simulated); stability_scope!(BETA { - use commonware_actor::Feedback; + use commonware_actor::{Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{IoBuf, IoBufs}; use commonware_utils::{ @@ -62,13 +62,14 @@ stability_scope!(BETA { /// # Returns /// /// Feedback from submitting the message for delivery. + /// [`Lossy`] indicates that local submission may be rejected under backpressure. /// [`Feedback::accepted`] does not guarantee that the recipient will receive the message. fn send( &mut self, recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Feedback; + ) -> Lossy; } /// Interface for constructing a [`CheckedSender`] from a set of [`Recipients`], @@ -120,8 +121,9 @@ stability_scope!(BETA { /// # Returns /// /// Feedback from submitting the message for delivery. + /// [`Lossy`] indicates that local submission may be rejected under backpressure. /// [`Feedback::accepted`] does not guarantee that the recipient will receive the message. - fn send(self, message: impl Into + Send, priority: bool) -> Feedback; + fn send(self, message: impl Into + Send, priority: bool) -> Lossy; } /// Interface for sending messages to a set of recipients. diff --git a/p2p/src/simulated/network.rs b/p2p/src/simulated/network.rs index 294eae27049..633f52c63a3 100644 --- a/p2p/src/simulated/network.rs +++ b/p2p/src/simulated/network.rs @@ -14,7 +14,7 @@ use crate::{ Channel, Message as NetworkMessage, PeerSetUpdate, Recipients, TrackedPeers, UnlimitedSender as _, }; -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_codec::{DecodeExt, FixedSize}; use commonware_cryptography::PublicKey; use commonware_macros::select_loop; @@ -960,7 +960,7 @@ impl crate::UnlimitedSender for UnlimitedSender { recipients: Recipients

, message: impl Into + Send, priority: bool, - ) -> Feedback { + ) -> Lossy { let message = message.into().coalesce(); assert!( message.len() <= self.max_size as usize, @@ -970,7 +970,7 @@ impl crate::UnlimitedSender for UnlimitedSender { ); if !self.active.load(Ordering::Acquire) || self.sender.is_closed() { - return Feedback::Closed; + return Lossy::new(Feedback::Closed); } // The simulated network handles send submissions and topology updates @@ -983,9 +983,9 @@ impl crate::UnlimitedSender for UnlimitedSender { message, priority, }) { - Feedback::Ok + Lossy::new(Feedback::Ok) } else { - Feedback::Closed + Lossy::new(Feedback::Closed) } } } @@ -1141,13 +1141,13 @@ impl<'a, P: PublicKey, E: Clock, F: SplitForwarder

> crate::CheckedSender crate::CheckedSender::recipients(&self.checked) } - fn send(self, message: impl Into + Send, priority: bool) -> Feedback { + fn send(self, message: impl Into + Send, priority: bool) -> Lossy { // Convert to IoBuf here since forwarder needs to inspect the message let message = message.into().coalesce(); // Determine the set of recipients that will receive the message let Some(recipients) = (self.forwarder)(self.replica, &self.recipients, &message) else { - return Feedback::Rejected; + return Lossy::Rejected; }; // Extract the inner sender and send directly with the new recipients diff --git a/p2p/src/utils/codec.rs b/p2p/src/utils/codec.rs index 40583947408..2ad67164b40 100644 --- a/p2p/src/utils/codec.rs +++ b/p2p/src/utils/codec.rs @@ -1,7 +1,7 @@ //! Codec wrapper for [Sender] and [Receiver]. use crate::{Blocker, CheckedSender, Receiver, Recipients, Sender}; -use commonware_actor::{mailbox, Feedback}; +use commonware_actor::{mailbox, Feedback, Lossy}; use commonware_codec::{Codec, Error}; use commonware_cryptography::PublicKey; use commonware_macros::select_loop; @@ -86,7 +86,7 @@ impl<'a, S: Sender, V: Codec> CheckedWrappedSender<'a, S, V> { self.sender.recipients() } - pub fn send(self, message: V, priority: bool) -> Feedback { + pub fn send(self, message: V, priority: bool) -> Lossy { let encoded = message.encode_with_pool(self.pool); self.sender.send(encoded, priority) } @@ -278,7 +278,7 @@ where let (peer, decode_result) = result; match decode_result { Ok(value) => { - let _ = sender.enqueue(Decoded(peer, value)); + let _ = sender.enqueue_lossy(Decoded(peer, value)); } Err(err) => { crate::block!(blocker, peer, ?err, "received invalid message"); diff --git a/p2p/src/utils/limited.rs b/p2p/src/utils/limited.rs index 79daba2fc9a..ec2e1d3ce0f 100644 --- a/p2p/src/utils/limited.rs +++ b/p2p/src/utils/limited.rs @@ -1,7 +1,7 @@ //! Rate-limited [`UnlimitedSender`] wrapper. use crate::{Recipients, UnlimitedSender}; -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{Clock, IoBufs, KeyedRateLimiter, Quota}; use commonware_utils::{channel::ring, sync::Mutex}; @@ -210,7 +210,7 @@ impl<'a, S: UnlimitedSender> crate::CheckedSender for CheckedSender<'a, S> { } } - fn send(self, message: impl Into + Send, priority: bool) -> Feedback { + fn send(self, message: impl Into + Send, priority: bool) -> Lossy { self.sender.send(self.recipients, message, priority) } } @@ -260,10 +260,10 @@ mod tests { recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Feedback { + ) -> Lossy { let message = message.into().coalesce(); self.sent.lock().push((recipients, message, priority)); - Feedback::Ok + Lossy::new(Feedback::Ok) } } diff --git a/p2p/src/utils/mocks/mod.rs b/p2p/src/utils/mocks/mod.rs index 69fc4020088..6fed5074ad7 100644 --- a/p2p/src/utils/mocks/mod.rs +++ b/p2p/src/utils/mocks/mod.rs @@ -1,7 +1,7 @@ //! Mock implementations for testing. use crate::{CheckedSender, LimitedSender, Receiver, Recipients}; -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{ telemetry::metrics::{Metric, Registered, Registration}, @@ -92,8 +92,8 @@ impl CheckedSender for InertCheckedSender

{ self.recipients.clone() } - fn send(self, _: impl Into + Send, _: bool) -> Feedback { - Feedback::Ok + fn send(self, _: impl Into + Send, _: bool) -> Lossy { + Lossy::new(Feedback::Ok) } } @@ -153,8 +153,8 @@ mod tests { vec![self.peer.clone()] } - fn send(self, _message: impl Into + Send, _priority: bool) -> Feedback { - Feedback::Rejected + fn send(self, _message: impl Into + Send, _priority: bool) -> Lossy { + Lossy::Rejected } } diff --git a/p2p/src/utils/mux.rs b/p2p/src/utils/mux.rs index d1afd8fafef..327f3298244 100644 --- a/p2p/src/utils/mux.rs +++ b/p2p/src/utils/mux.rs @@ -9,7 +9,7 @@ //! even if the muxer is already running. use crate::{Channel, CheckedSender, LimitedSender, Message, Receiver, Recipients, Sender}; -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_codec::{varint::UInt, Encode, Error as CodecError, ReadExt}; use commonware_macros::select_loop; use commonware_runtime::{spawn_cell, ContextCell, Handle, IoBuf, IoBufs, Spawner}; @@ -301,9 +301,9 @@ impl GlobalSender { recipients: Recipients, payload: impl Into + Send, priority: bool, - ) -> Feedback { + ) -> Lossy { self.check(recipients).map_or_else( - |_| Feedback::Rejected, + |_| Lossy::Rejected, |checked| checked.with_subchannel(subchannel).send(payload, priority), ) } @@ -347,7 +347,7 @@ impl<'a, S: Sender> CheckedSender for CheckedGlobalSender<'a, S> { self.inner.recipients() } - fn send(self, message: impl Into + Send, priority: bool) -> Feedback { + fn send(self, message: impl Into + Send, priority: bool) -> Lossy { let subchannel = UInt(self.subchannel.expect("subchannel not set")); let mut message = message.into(); message.prepend(subchannel.encode().into()); @@ -674,7 +674,7 @@ mod tests { unreachable!("rate-limited sender should not produce a checked sender"); } - fn send(self, _: impl Into + Send, _: bool) -> Feedback { + fn send(self, _: impl Into + Send, _: bool) -> Lossy { unreachable!("rate-limited sender should not send"); } } @@ -695,7 +695,7 @@ mod tests { fn test_global_sender_rate_limited_send_rejected() { let mut sender = GlobalSender::new(RateLimitedSender); let feedback = sender.send(0, Recipients::One(pk(0)), b"rate-limited", false); - assert_eq!(feedback, Feedback::Rejected); + assert_eq!(feedback, Lossy::Rejected); assert!(!feedback.accepted()); } diff --git a/resolver/src/p2p/fetcher.rs b/resolver/src/p2p/fetcher.rs index 148251dfa7d..585fce07057 100644 --- a/resolver/src/p2p/fetcher.rs +++ b/resolver/src/p2p/fetcher.rs @@ -1,5 +1,5 @@ use crate::p2p::wire; -use commonware_actor::Feedback; +use commonware_actor::{Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_p2p::{utils::codec::WrappedSender, Recipients, Sender}; use commonware_runtime::{ @@ -292,7 +292,7 @@ where payload: wire::Payload::Request(key.clone()), }; match checked.send(message, self.priority_requests) { - Feedback::Ok | Feedback::Backoff => { + Lossy::Handled(Feedback::Ok | Feedback::Backoff) => { // Success - move from pending to active self.requests_sent.inc(Status::Success); self.pending.remove(&key); @@ -310,7 +310,7 @@ where self.key_to_id.insert(key, id); return; } - feedback @ (Feedback::Rejected | Feedback::Closed) => { + feedback @ (Lossy::Rejected | Lossy::Handled(Feedback::Closed)) => { // Send was not handled, try next peer self.requests_sent.inc(Status::Dropped); debug!(?peer, ?feedback, "send failed"); @@ -536,6 +536,7 @@ where mod tests { use super::*; use crate::p2p::mocks::Key as MockKey; + use commonware_actor::Lossy; use commonware_cryptography::{ ed25519::{PrivateKey, PublicKey}, Signer, @@ -565,7 +566,7 @@ mod tests { } } - fn send(self, message: impl Into + Send, priority: bool) -> Feedback { + fn send(self, message: impl Into + Send, priority: bool) -> Lossy { self.sender.send(self.recipients, message, priority) } } @@ -581,8 +582,8 @@ mod tests { _recipients: Recipients, _message: impl Into + Send, _priority: bool, - ) -> Feedback { - Feedback::Rejected + ) -> Lossy { + Lossy::Rejected } } @@ -617,9 +618,9 @@ mod tests { recipients: Recipients, _message: impl Into + Send, _priority: bool, - ) -> Feedback { + ) -> Lossy { match recipients { - Recipients::One(_) => Feedback::Ok, + Recipients::One(_) => Lossy::new(Feedback::Ok), _ => unimplemented!(), } } From 2e16f575d357e06d16ae995686ac423d9c57d13b Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 02:11:25 -0700 Subject: [PATCH 02/13] more polish --- .../dylints/lossy_feedback/.cargo/config.toml | 2 - .github/dylints/lossy_feedback/Cargo.lock | 1581 ----------------- .github/dylints/lossy_feedback/Cargo.toml | 18 - .github/dylints/lossy_feedback/rust-toolchain | 5 - .github/dylints/lossy_feedback/src/lib.rs | 355 ---- .github/dylints/lossy_feedback/ui/main.rs | 106 -- .github/dylints/lossy_feedback/ui/main.stderr | 27 - Cargo.toml | 1 - actor/src/benches/mailbox.rs | 17 +- actor/src/lib.rs | 18 - actor/src/mailbox.rs | 512 ++++-- broadcast/src/buffered/ingress.rs | 5 +- broadcast/src/buffered/mod.rs | 4 +- collector/src/p2p/ingress.rs | 3 +- consensus/src/aggregation/mocks/reporter.rs | 3 +- .../src/marshal/coding/shards/mailbox.rs | 5 +- consensus/src/marshal/core/mailbox.rs | 26 +- consensus/src/marshal/resolver/handler.rs | 5 +- .../src/ordered_broadcast/mocks/reporter.rs | 3 +- .../src/simplex/actors/batcher/ingress.rs | 9 +- .../src/simplex/actors/resolver/ingress.rs | 14 +- consensus/src/simplex/actors/voter/ingress.rs | 9 +- examples/bridge/src/application/ingress.rs | 3 +- examples/log/src/application/ingress.rs | 3 +- examples/reshare/src/dkg/ingress.rs | 3 +- examples/reshare/src/orchestrator/ingress.rs | 3 +- .../discovery/actors/peer/actor.rs | 17 +- .../discovery/actors/peer/ingress.rs | 17 +- .../discovery/actors/router/actor.rs | 4 +- .../discovery/actors/router/ingress.rs | 21 +- .../discovery/actors/spawner/actor.rs | 2 +- .../discovery/actors/spawner/ingress.rs | 6 +- .../discovery/actors/tracker/ingress.rs | 3 +- p2p/src/authenticated/discovery/channels.rs | 14 +- .../authenticated/lookup/actors/peer/actor.rs | 18 +- .../lookup/actors/router/actor.rs | 4 +- .../lookup/actors/router/ingress.rs | 15 +- .../lookup/actors/spawner/actor.rs | 2 +- .../lookup/actors/spawner/ingress.rs | 6 +- .../lookup/actors/tracker/ingress.rs | 3 +- p2p/src/authenticated/lookup/channels.rs | 14 +- p2p/src/authenticated/mailbox.rs | 10 +- p2p/src/authenticated/relay.rs | 28 +- p2p/src/utils/codec.rs | 12 +- resolver/src/p2p/ingress.rs | 3 +- 45 files changed, 510 insertions(+), 2429 deletions(-) delete mode 100644 .github/dylints/lossy_feedback/.cargo/config.toml delete mode 100644 .github/dylints/lossy_feedback/Cargo.lock delete mode 100644 .github/dylints/lossy_feedback/Cargo.toml delete mode 100644 .github/dylints/lossy_feedback/rust-toolchain delete mode 100644 .github/dylints/lossy_feedback/src/lib.rs delete mode 100644 .github/dylints/lossy_feedback/ui/main.rs delete mode 100644 .github/dylints/lossy_feedback/ui/main.stderr diff --git a/.github/dylints/lossy_feedback/.cargo/config.toml b/.github/dylints/lossy_feedback/.cargo/config.toml deleted file mode 100644 index d58627620a1..00000000000 --- a/.github/dylints/lossy_feedback/.cargo/config.toml +++ /dev/null @@ -1,2 +0,0 @@ -[target.'cfg(all())'] -rustflags = ["-C", "linker=dylint-link"] diff --git a/.github/dylints/lossy_feedback/Cargo.lock b/.github/dylints/lossy_feedback/Cargo.lock deleted file mode 100644 index d9f5e09af80..00000000000 --- a/.github/dylints/lossy_feedback/Cargo.lock +++ /dev/null @@ -1,1581 +0,0 @@ -# This file is automatically @generated by Cargo. -# It is not intended for manual editing. -version = 4 - -[[package]] -name = "aho-corasick" -version = "1.1.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ddd31a130427c27518df266943a5308ed92d4b226cc639f5a8f1002816174301" -dependencies = [ - "memchr", -] - -[[package]] -name = "anstream" -version = "1.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "824a212faf96e9acacdbd09febd34438f8f711fb84e09a8916013cd7815ca28d" -dependencies = [ - "anstyle", - "anstyle-parse", - "anstyle-query", - "anstyle-wincon", - "colorchoice", - "is_terminal_polyfill", - "utf8parse", -] - -[[package]] -name = "anstyle" -version = "1.0.14" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "940b3a0ca603d1eade50a4846a2afffd5ef57a9feac2c0e2ec2e14f9ead76000" - -[[package]] -name = "anstyle-parse" -version = "1.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "52ce7f38b242319f7cabaa6813055467063ecdc9d355bbb4ce0c68908cd8130e" -dependencies = [ - "utf8parse", -] - -[[package]] -name = "anstyle-query" -version = "1.1.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "40c48f72fd53cd289104fc64099abca73db4166ad86ea0b4341abe65af83dadc" -dependencies = [ - "windows-sys 0.61.2", -] - -[[package]] -name = "anstyle-wincon" -version = "3.0.11" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "291e6a250ff86cd4a820112fb8898808a366d8f9f58ce16d1f538353ad55747d" -dependencies = [ - "anstyle", - "once_cell_polyfill", - "windows-sys 0.61.2", -] - -[[package]] -name = "anyhow" -version = "1.0.102" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f202df86484c868dbad7eaa557ef785d5c66295e41b460ef922eca0723b842c" - -[[package]] -name = "bitflags" -version = "2.11.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3" - -[[package]] -name = "camino" -version = "1.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e629a66d692cb9ff1a1c664e41771b3dcaf961985a9774c0eb0bd1b51cf60a48" -dependencies = [ - "serde_core", -] - -[[package]] -name = "cargo-platform" -version = "0.3.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dd0061da739915fae12ea00e16397555ed4371a6bb285431aab930f61b0aa4ba" -dependencies = [ - "serde", - "serde_core", -] - -[[package]] -name = "cargo_metadata" -version = "0.23.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ef987d17b0a113becdd19d3d0022d04d7ef41f9efe4f3fb63ac44ba61df3ade9" -dependencies = [ - "camino", - "cargo-platform", - "semver", - "serde", - "serde_json", - "thiserror 2.0.18", -] - -[[package]] -name = "cc" -version = "1.2.62" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1dce859f0832a7d088c4f1119888ab94ef4b5d6795d1ce05afb7fe159d79f98" -dependencies = [ - "find-msvc-tools", - "jobserver", - "libc", - "shlex", -] - -[[package]] -name = "cfg-if" -version = "1.0.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801" - -[[package]] -name = "colorchoice" -version = "1.0.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1d07550c9036bf2ae0c684c4297d503f838287c83c53686d05370d0e139ae570" - -[[package]] -name = "compiletest_rs" -version = "0.11.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f150fe9105fcd2a57cad53f0c079a24de65195903ef670990f5909f695eac04c" -dependencies = [ - "diff", - "filetime", - "getopts", - "lazy_static", - "libc", - "log", - "miow", - "regex", - "rustfix", - "serde", - "serde_derive", - "serde_json", - "tester", - "windows-sys 0.59.0", -] - -[[package]] -name = "diff" -version = "0.1.13" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "56254986775e3233ffa9c4d7d3faaf6d36a2c09d30b20687e9f88bc8bafc16c8" - -[[package]] -name = "dirs-next" -version = "2.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b98cf8ebf19c3d1b223e151f99a4f9f0690dca41414773390fc824184ac833e1" -dependencies = [ - "cfg-if", - "dirs-sys-next", -] - -[[package]] -name = "dirs-sys-next" -version = "0.1.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4ebda144c4fe02d1f7ea1a7d9641b6fc6b580adcfa024ae48797ecdeb6825b4d" -dependencies = [ - "libc", - "redox_users", - "winapi", -] - -[[package]] -name = "displaydoc" -version = "0.2.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "97369cbbc041bc366949bc74d34658d6cda5621039731c6310521892a3a20ae0" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "dylint" -version = "6.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b795f98802f87352aab60584eea87f942c53ab30edcafab4b31a6cbdd9e8a3ac" -dependencies = [ - "anstyle", - "anyhow", - "cargo_metadata", - "dylint_internal", - "log", - "once_cell", - "semver", - "serde", - "serde_json", - "tempfile", -] - -[[package]] -name = "dylint_internal" -version = "6.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a03ff51e671fceef87e50fef97ddc1569241af242d76e0b367dfcc812c860eb0" -dependencies = [ - "anstyle", - "anyhow", - "bitflags", - "cargo_metadata", - "git2", - "home", - "log", - "regex", - "serde", - "tar", - "thiserror 2.0.18", - "toml", -] - -[[package]] -name = "dylint_linting" -version = "6.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c3efcb9b741bccdd6f1ce701c4b17b452112e8c0cd045c8b894a112584ff5d55" -dependencies = [ - "cargo_metadata", - "dylint_internal", - "paste", - "rustversion", - "serde", - "thiserror 2.0.18", - "toml", -] - -[[package]] -name = "dylint_testing" -version = "6.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2eaa3ca6e1f740cd587630c321f61927b4cafdc2abf7c2fbacc3fca8635fcc48" -dependencies = [ - "anyhow", - "cargo_metadata", - "compiletest_rs", - "dylint", - "dylint_internal", - "env_logger", - "once_cell", - "regex", - "serde_json", - "tempfile", -] - -[[package]] -name = "env_filter" -version = "1.0.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32e90c2accc4b07a8456ea0debdc2e7587bdd890680d71173a15d4ae604f6eef" -dependencies = [ - "log", - "regex", -] - -[[package]] -name = "env_logger" -version = "0.11.10" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0621c04f2196ac3f488dd583365b9c09be011a4ab8b9f37248ffcc8f6198b56a" -dependencies = [ - "anstream", - "anstyle", - "env_filter", - "jiff", - "log", -] - -[[package]] -name = "equivalent" -version = "1.0.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" - -[[package]] -name = "errno" -version = "0.3.14" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "39cab71617ae0d63f51a36d69f866391735b51691dbda63cf6f96d042b63efeb" -dependencies = [ - "libc", - "windows-sys 0.61.2", -] - -[[package]] -name = "fastrand" -version = "2.4.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9f1f227452a390804cdb637b74a86990f2a7d7ba4b7d5693aac9b4dd6defd8d6" - -[[package]] -name = "filetime" -version = "0.2.29" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c287a33c7f0a620c38e641e7f60827713987b3c0f26e8ddc9462cc69cf75759" -dependencies = [ - "cfg-if", - "libc", -] - -[[package]] -name = "find-msvc-tools" -version = "0.1.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5baebc0774151f905a1a2cc41989300b1e6fbb29aff0ceffa1064fdd3088d582" - -[[package]] -name = "foldhash" -version = "0.1.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d9c4f5dac5e15c24eb999c26181a6ca40b39fe946cbe4c263c7209467bc83af2" - -[[package]] -name = "form_urlencoded" -version = "1.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" -dependencies = [ - "percent-encoding", -] - -[[package]] -name = "getopts" -version = "0.2.24" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cfe4fbac503b8d1f88e6676011885f34b7174f46e59956bba534ba83abded4df" -dependencies = [ - "unicode-width", -] - -[[package]] -name = "getrandom" -version = "0.2.17" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff2abc00be7fca6ebc474524697ae276ad847ad0a6b3faa4bcb027e9a4614ad0" -dependencies = [ - "cfg-if", - "libc", - "wasi", -] - -[[package]] -name = "getrandom" -version = "0.3.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "899def5c37c4fd7b2664648c28120ecec138e4d395b459e5ca34f9cce2dd77fd" -dependencies = [ - "cfg-if", - "libc", - "r-efi 5.3.0", - "wasip2", -] - -[[package]] -name = "getrandom" -version = "0.4.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0de51e6874e94e7bf76d726fc5d13ba782deca734ff60d5bb2fb2607c7406555" -dependencies = [ - "cfg-if", - "libc", - "r-efi 6.0.0", - "wasip2", - "wasip3", -] - -[[package]] -name = "git2" -version = "0.20.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7b88256088d75a56f8ecfa070513a775dd9107f6530ef14919dac831af9cfe2b" -dependencies = [ - "bitflags", - "libc", - "libgit2-sys", - "log", - "openssl-probe", - "openssl-sys", - "url", -] - -[[package]] -name = "hashbrown" -version = "0.15.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" -dependencies = [ - "foldhash", -] - -[[package]] -name = "hashbrown" -version = "0.17.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ed5909b6e89a2db4456e54cd5f673791d7eca6732202bbf2a9cc504fe2f9b84a" - -[[package]] -name = "heck" -version = "0.5.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" - -[[package]] -name = "hermit-abi" -version = "0.5.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fc0fef456e4baa96da950455cd02c081ca953b141298e41db3fc7e36b1da849c" - -[[package]] -name = "home" -version = "0.5.12" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cc627f471c528ff0c4a49e1d5e60450c8f6461dd6d10ba9dcd3a61d3dff7728d" -dependencies = [ - "windows-sys 0.61.2", -] - -[[package]] -name = "icu_collections" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2984d1cd16c883d7935b9e07e44071dca8d917fd52ecc02c04d5fa0b5a3f191c" -dependencies = [ - "displaydoc", - "potential_utf", - "utf8_iter", - "yoke", - "zerofrom", - "zerovec", -] - -[[package]] -name = "icu_locale_core" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "92219b62b3e2b4d88ac5119f8904c10f8f61bf7e95b640d25ba3075e6cac2c29" -dependencies = [ - "displaydoc", - "litemap", - "tinystr", - "writeable", - "zerovec", -] - -[[package]] -name = "icu_normalizer" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c56e5ee99d6e3d33bd91c5d85458b6005a22140021cc324cea84dd0e72cff3b4" -dependencies = [ - "icu_collections", - "icu_normalizer_data", - "icu_properties", - "icu_provider", - "smallvec", - "zerovec", -] - -[[package]] -name = "icu_normalizer_data" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "da3be0ae77ea334f4da67c12f149704f19f81d1adf7c51cf482943e84a2bad38" - -[[package]] -name = "icu_properties" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bee3b67d0ea5c2cca5003417989af8996f8604e34fb9ddf96208a033901e70de" -dependencies = [ - "icu_collections", - "icu_locale_core", - "icu_properties_data", - "icu_provider", - "zerotrie", - "zerovec", -] - -[[package]] -name = "icu_properties_data" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8e2bbb201e0c04f7b4b3e14382af113e17ba4f63e2c9d2ee626b720cbce54a14" - -[[package]] -name = "icu_provider" -version = "2.2.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "139c4cf31c8b5f33d7e199446eff9c1e02decfc2f0eec2c8d71f65befa45b421" -dependencies = [ - "displaydoc", - "icu_locale_core", - "writeable", - "yoke", - "zerofrom", - "zerotrie", - "zerovec", -] - -[[package]] -name = "id-arena" -version = "2.3.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3d3067d79b975e8844ca9eb072e16b31c3c1c36928edf9c6789548c524d0d954" - -[[package]] -name = "idna" -version = "1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" -dependencies = [ - "idna_adapter", - "smallvec", - "utf8_iter", -] - -[[package]] -name = "idna_adapter" -version = "1.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb68373c0d6620ef8105e855e7745e18b0d00d3bdb07fb532e434244cdb9a714" -dependencies = [ - "icu_normalizer", - "icu_properties", -] - -[[package]] -name = "indexmap" -version = "2.14.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d466e9454f08e4a911e14806c24e16fba1b4c121d1ea474396f396069cf949d9" -dependencies = [ - "equivalent", - "hashbrown 0.17.1", - "serde", - "serde_core", -] - -[[package]] -name = "is_terminal_polyfill" -version = "1.70.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a6cb138bb79a146c1bd460005623e142ef0181e3d0219cb493e02f7d08a35695" - -[[package]] -name = "itoa" -version = "1.0.18" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f42a60cbdf9a97f5d2305f08a87dc4e09308d1276d28c869c684d7777685682" - -[[package]] -name = "jiff" -version = "0.2.24" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f00b5dbd620d61dfdcb6007c9c1f6054ebd75319f163d886a9055cec1155073d" -dependencies = [ - "jiff-static", - "log", - "portable-atomic", - "portable-atomic-util", - "serde_core", -] - -[[package]] -name = "jiff-static" -version = "0.2.24" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e000de030ff8022ea1da3f466fbb0f3a809f5e51ed31f6dd931c35181ad8e6d7" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "jobserver" -version = "0.1.34" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9afb3de4395d6b3e67a780b6de64b51c978ecf11cb9a462c66be7d4ca9039d33" -dependencies = [ - "getrandom 0.3.4", - "libc", -] - -[[package]] -name = "lazy_static" -version = "1.5.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe" - -[[package]] -name = "leb128fmt" -version = "0.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09edd9e8b54e49e587e4f6295a7d29c3ea94d469cb40ab8ca70b288248a81db2" - -[[package]] -name = "libc" -version = "0.2.186" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66" - -[[package]] -name = "libgit2-sys" -version = "0.18.4+1.9.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9b26f66f35e1871b22efcf7191564123d2a446ca0538cde63c23adfefa9b15b7" -dependencies = [ - "cc", - "libc", - "libssh2-sys", - "libz-sys", - "openssl-sys", - "pkg-config", -] - -[[package]] -name = "libredox" -version = "0.1.16" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e02f3bb43d335493c96bf3fd3a321600bf6bd07ed34bc64118e9293bdffea46c" -dependencies = [ - "libc", -] - -[[package]] -name = "libssh2-sys" -version = "0.3.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "220e4f05ad4a218192533b300327f5150e809b54c4ec83b5a1d91833601811b9" -dependencies = [ - "cc", - "libc", - "libz-sys", - "openssl-sys", - "pkg-config", - "vcpkg", -] - -[[package]] -name = "libz-sys" -version = "1.1.28" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fc3a226e576f50782b3305c5ccf458698f92798987f551c6a02efe8276721e22" -dependencies = [ - "cc", - "libc", - "pkg-config", - "vcpkg", -] - -[[package]] -name = "linux-raw-sys" -version = "0.12.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32a66949e030da00e8c7d4434b251670a91556f4144941d37452769c25d58a53" - -[[package]] -name = "litemap" -version = "0.8.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "92daf443525c4cce67b150400bc2316076100ce0b3686209eb8cf3c31612e6f0" - -[[package]] -name = "log" -version = "0.4.29" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5e5032e24019045c762d3c0f28f5b6b8bbf38563a65908389bf7978758920897" - -[[package]] -name = "lossy_feedback" -version = "0.0.1" -dependencies = [ - "dylint_linting", - "dylint_testing", -] - -[[package]] -name = "memchr" -version = "2.8.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79" - -[[package]] -name = "miow" -version = "0.6.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "536bfad37a309d62069485248eeaba1e8d9853aaf951caaeaed0585a95346f08" -dependencies = [ - "windows-sys 0.61.2", -] - -[[package]] -name = "num_cpus" -version = "1.17.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "91df4bbde75afed763b708b7eee1e8e7651e02d97f6d5dd763e89367e957b23b" -dependencies = [ - "hermit-abi", - "libc", -] - -[[package]] -name = "once_cell" -version = "1.21.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" - -[[package]] -name = "once_cell_polyfill" -version = "1.70.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "384b8ab6d37215f3c5301a95a4accb5d64aa607f1fcb26a11b5303878451b4fe" - -[[package]] -name = "openssl-probe" -version = "0.1.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d05e27ee213611ffe7d6348b942e8f942b37114c00cc03cec254295a4a17852e" - -[[package]] -name = "openssl-sys" -version = "0.9.116" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f28a22dc7140cda5f096e5e7724a6962ca81a7f8bfd2979f9b18c11af56318c4" -dependencies = [ - "cc", - "libc", - "pkg-config", - "vcpkg", -] - -[[package]] -name = "paste" -version = "1.0.15" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a" - -[[package]] -name = "percent-encoding" -version = "2.3.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" - -[[package]] -name = "pin-project-lite" -version = "0.2.17" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" - -[[package]] -name = "pkg-config" -version = "0.3.33" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "19f132c84eca552bf34cab8ec81f1c1dcc229b811638f9d283dceabe58c5569e" - -[[package]] -name = "portable-atomic" -version = "1.13.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c33a9471896f1c69cecef8d20cbe2f7accd12527ce60845ff44c153bb2a21b49" - -[[package]] -name = "portable-atomic-util" -version = "0.2.7" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c2a106d1259c23fac8e543272398ae0e3c0b8d33c88ed73d0cc71b0f1d902618" -dependencies = [ - "portable-atomic", -] - -[[package]] -name = "potential_utf" -version = "0.1.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0103b1cef7ec0cf76490e969665504990193874ea05c85ff9bab8b911d0a0564" -dependencies = [ - "zerovec", -] - -[[package]] -name = "prettyplease" -version = "0.2.37" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b" -dependencies = [ - "proc-macro2", - "syn", -] - -[[package]] -name = "proc-macro2" -version = "1.0.106" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934" -dependencies = [ - "unicode-ident", -] - -[[package]] -name = "quote" -version = "1.0.45" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924" -dependencies = [ - "proc-macro2", -] - -[[package]] -name = "r-efi" -version = "5.3.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "69cdb34c158ceb288df11e18b4bd39de994f6657d83847bdffdbd7f346754b0f" - -[[package]] -name = "r-efi" -version = "6.0.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f8dcc9c7d52a811697d2151c701e0d08956f92b0e24136cf4cf27b57a6a0d9bf" - -[[package]] -name = "redox_users" -version = "0.4.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43" -dependencies = [ - "getrandom 0.2.17", - "libredox", - "thiserror 1.0.69", -] - -[[package]] -name = "regex" -version = "1.12.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e10754a14b9137dd7b1e3e5b0493cc9171fdd105e0ab477f51b72e7f3ac0e276" -dependencies = [ - "aho-corasick", - "memchr", - "regex-automata", - "regex-syntax", -] - -[[package]] -name = "regex-automata" -version = "0.4.14" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6e1dd4122fc1595e8162618945476892eefca7b88c52820e74af6262213cae8f" -dependencies = [ - "aho-corasick", - "memchr", - "regex-syntax", -] - -[[package]] -name = "regex-syntax" -version = "0.8.10" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc897dd8d9e8bd1ed8cdad82b5966c3e0ecae09fb1907d58efaa013543185d0a" - -[[package]] -name = "rustfix" -version = "0.8.7" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "82fa69b198d894d84e23afde8e9ab2af4400b2cba20d6bf2b428a8b01c222c5a" -dependencies = [ - "serde", - "serde_json", - "thiserror 1.0.69", - "tracing", -] - -[[package]] -name = "rustix" -version = "1.1.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6fe4565b9518b83ef4f91bb47ce29620ca828bd32cb7e408f0062e9930ba190" -dependencies = [ - "bitflags", - "errno", - "libc", - "linux-raw-sys", - "windows-sys 0.61.2", -] - -[[package]] -name = "rustversion" -version = "1.0.22" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d" - -[[package]] -name = "semver" -version = "1.0.28" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8a7852d02fc848982e0c167ef163aaff9cd91dc640ba85e263cb1ce46fae51cd" -dependencies = [ - "serde", - "serde_core", -] - -[[package]] -name = "serde" -version = "1.0.228" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9a8e94ea7f378bd32cbbd37198a4a91436180c5bb472411e48b5ec2e2124ae9e" -dependencies = [ - "serde_core", - "serde_derive", -] - -[[package]] -name = "serde_core" -version = "1.0.228" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "41d385c7d4ca58e59fc732af25c3983b67ac852c1a25000afe1175de458b67ad" -dependencies = [ - "serde_derive", -] - -[[package]] -name = "serde_derive" -version = "1.0.228" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d540f220d3187173da220f885ab66608367b6574e925011a9353e4badda91d79" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "serde_json" -version = "1.0.149" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "83fc039473c5595ace860d8c4fafa220ff474b3fc6bfdb4293327f1a37e94d86" -dependencies = [ - "itoa", - "memchr", - "serde", - "serde_core", - "zmij", -] - -[[package]] -name = "serde_spanned" -version = "1.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6662b5879511e06e8999a8a235d848113e942c9124f211511b16466ee2995f26" -dependencies = [ - "serde_core", -] - -[[package]] -name = "shlex" -version = "1.3.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" - -[[package]] -name = "smallvec" -version = "1.15.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "67b1b7a3b5fe4f1376887184045fcf45c69e92af734b7aaddc05fb777b6fbd03" - -[[package]] -name = "stable_deref_trait" -version = "1.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6ce2be8dc25455e1f91df71bfa12ad37d7af1092ae736f3a6cd0e37bc7810596" - -[[package]] -name = "syn" -version = "2.0.117" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99" -dependencies = [ - "proc-macro2", - "quote", - "unicode-ident", -] - -[[package]] -name = "synstructure" -version = "0.13.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "tar" -version = "0.4.46" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3f6221d9a6003c78398e3b239969f352578258df48c8eb051caadae0015bc840" -dependencies = [ - "filetime", - "libc", - "xattr", -] - -[[package]] -name = "tempfile" -version = "3.27.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32497e9a4c7b38532efcdebeef879707aa9f794296a4f0244f6f69e9bc8574bd" -dependencies = [ - "fastrand", - "getrandom 0.4.2", - "once_cell", - "rustix", - "windows-sys 0.61.2", -] - -[[package]] -name = "term" -version = "0.7.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c59df8ac95d96ff9bede18eb7300b0fda5e5d8d90960e76f8e14ae765eedbf1f" -dependencies = [ - "dirs-next", - "rustversion", - "winapi", -] - -[[package]] -name = "tester" -version = "0.9.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "89e8bf7e0eb2dd7b4228cc1b6821fc5114cd6841ae59f652a85488c016091e5f" -dependencies = [ - "cfg-if", - "getopts", - "libc", - "num_cpus", - "term", -] - -[[package]] -name = "thiserror" -version = "1.0.69" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" -dependencies = [ - "thiserror-impl 1.0.69", -] - -[[package]] -name = "thiserror" -version = "2.0.18" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4288b5bcbc7920c07a1149a35cf9590a2aa808e0bc1eafaade0b80947865fbc4" -dependencies = [ - "thiserror-impl 2.0.18", -] - -[[package]] -name = "thiserror-impl" -version = "1.0.69" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "thiserror-impl" -version = "2.0.18" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ebc4ee7f67670e9b64d05fa4253e753e016c6c95ff35b89b7941d6b856dec1d5" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "tinystr" -version = "0.8.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c8323304221c2a851516f22236c5722a72eaa19749016521d6dff0824447d96d" -dependencies = [ - "displaydoc", - "zerovec", -] - -[[package]] -name = "toml" -version = "1.1.2+spec-1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "81f3d15e84cbcd896376e6730314d59fb5a87f31e4b038454184435cd57defee" -dependencies = [ - "indexmap", - "serde_core", - "serde_spanned", - "toml_datetime", - "toml_parser", - "toml_writer", - "winnow", -] - -[[package]] -name = "toml_datetime" -version = "1.1.1+spec-1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3165f65f62e28e0115a00b2ebdd37eb6f3b641855f9d636d3cd4103767159ad7" -dependencies = [ - "serde_core", -] - -[[package]] -name = "toml_parser" -version = "1.1.2+spec-1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a2abe9b86193656635d2411dc43050282ca48aa31c2451210f4202550afb7526" -dependencies = [ - "winnow", -] - -[[package]] -name = "toml_writer" -version = "1.1.1+spec-1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "756daf9b1013ebe47a8776667b466417e2d4c5679d441c26230efd9ef78692db" - -[[package]] -name = "tracing" -version = "0.1.44" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "63e71662fa4b2a2c3a26f570f037eb95bb1f85397f3cd8076caed2f026a6d100" -dependencies = [ - "pin-project-lite", - "tracing-core", -] - -[[package]] -name = "tracing-core" -version = "0.1.36" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "db97caf9d906fbde555dd62fa95ddba9eecfd14cb388e4f491a66d74cd5fb79a" -dependencies = [ - "once_cell", -] - -[[package]] -name = "unicode-ident" -version = "1.0.24" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75" - -[[package]] -name = "unicode-width" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b4ac048d71ede7ee76d585517add45da530660ef4390e49b098733c6e897f254" - -[[package]] -name = "unicode-xid" -version = "0.2.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ebc1c04c71510c7f702b52b7c350734c9ff1295c464a03335b00bb84fc54f853" - -[[package]] -name = "url" -version = "2.5.8" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff67a8a4397373c3ef660812acab3268222035010ab8680ec4215f38ba3d0eed" -dependencies = [ - "form_urlencoded", - "idna", - "percent-encoding", - "serde", -] - -[[package]] -name = "utf8_iter" -version = "1.0.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6c140620e7ffbb22c2dee59cafe6084a59b5ffc27a8859a5f0d494b5d52b6be" - -[[package]] -name = "utf8parse" -version = "0.2.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" - -[[package]] -name = "vcpkg" -version = "0.2.15" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "accd4ea62f7bb7a82fe23066fb0957d48ef677f6eeb8215f372f52e48bb32426" - -[[package]] -name = "wasi" -version = "0.11.1+wasi-snapshot-preview1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" - -[[package]] -name = "wasip2" -version = "1.0.3+wasi-0.2.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "20064672db26d7cdc89c7798c48a0fdfac8213434a1186e5ef29fd560ae223d6" -dependencies = [ - "wit-bindgen 0.57.1", -] - -[[package]] -name = "wasip3" -version = "0.4.0+wasi-0.3.0-rc-2026-01-06" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5428f8bf88ea5ddc08faddef2ac4a67e390b88186c703ce6dbd955e1c145aca5" -dependencies = [ - "wit-bindgen 0.51.0", -] - -[[package]] -name = "wasm-encoder" -version = "0.244.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "990065f2fe63003fe337b932cfb5e3b80e0b4d0f5ff650e6985b1048f62c8319" -dependencies = [ - "leb128fmt", - "wasmparser", -] - -[[package]] -name = "wasm-metadata" -version = "0.244.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bb0e353e6a2fbdc176932bbaab493762eb1255a7900fe0fea1a2f96c296cc909" -dependencies = [ - "anyhow", - "indexmap", - "wasm-encoder", - "wasmparser", -] - -[[package]] -name = "wasmparser" -version = "0.244.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "47b807c72e1bac69382b3a6fb3dbe8ea4c0ed87ff5629b8685ae6b9a611028fe" -dependencies = [ - "bitflags", - "hashbrown 0.15.5", - "indexmap", - "semver", -] - -[[package]] -name = "winapi" -version = "0.3.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419" -dependencies = [ - "winapi-i686-pc-windows-gnu", - "winapi-x86_64-pc-windows-gnu", -] - -[[package]] -name = "winapi-i686-pc-windows-gnu" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" - -[[package]] -name = "winapi-x86_64-pc-windows-gnu" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" - -[[package]] -name = "windows-link" -version = "0.2.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5" - -[[package]] -name = "windows-sys" -version = "0.59.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b" -dependencies = [ - "windows-targets", -] - -[[package]] -name = "windows-sys" -version = "0.61.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae137229bcbd6cdf0f7b80a31df61766145077ddf49416a728b02cb3921ff3fc" -dependencies = [ - "windows-link", -] - -[[package]] -name = "windows-targets" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973" -dependencies = [ - "windows_aarch64_gnullvm", - "windows_aarch64_msvc", - "windows_i686_gnu", - "windows_i686_gnullvm", - "windows_i686_msvc", - "windows_x86_64_gnu", - "windows_x86_64_gnullvm", - "windows_x86_64_msvc", -] - -[[package]] -name = "windows_aarch64_gnullvm" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" - -[[package]] -name = "windows_aarch64_msvc" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" - -[[package]] -name = "windows_i686_gnu" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" - -[[package]] -name = "windows_i686_gnullvm" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" - -[[package]] -name = "windows_i686_msvc" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" - -[[package]] -name = "windows_x86_64_gnu" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" - -[[package]] -name = "windows_x86_64_gnullvm" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" - -[[package]] -name = "windows_x86_64_msvc" -version = "0.52.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" - -[[package]] -name = "winnow" -version = "1.0.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0592e1c9d151f854e6fd382574c3a0855250e1d9b2f99d9281c6e6391af352f1" - -[[package]] -name = "wit-bindgen" -version = "0.51.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d7249219f66ced02969388cf2bb044a09756a083d0fab1e566056b04d9fbcaa5" -dependencies = [ - "wit-bindgen-rust-macro", -] - -[[package]] -name = "wit-bindgen" -version = "0.57.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1ebf944e87a7c253233ad6766e082e3cd714b5d03812acc24c318f549614536e" - -[[package]] -name = "wit-bindgen-core" -version = "0.51.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ea61de684c3ea68cb082b7a88508a8b27fcc8b797d738bfc99a82facf1d752dc" -dependencies = [ - "anyhow", - "heck", - "wit-parser", -] - -[[package]] -name = "wit-bindgen-rust" -version = "0.51.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b7c566e0f4b284dd6561c786d9cb0142da491f46a9fbed79ea69cdad5db17f21" -dependencies = [ - "anyhow", - "heck", - "indexmap", - "prettyplease", - "syn", - "wasm-metadata", - "wit-bindgen-core", - "wit-component", -] - -[[package]] -name = "wit-bindgen-rust-macro" -version = "0.51.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0c0f9bfd77e6a48eccf51359e3ae77140a7f50b1e2ebfe62422d8afdaffab17a" -dependencies = [ - "anyhow", - "prettyplease", - "proc-macro2", - "quote", - "syn", - "wit-bindgen-core", - "wit-bindgen-rust", -] - -[[package]] -name = "wit-component" -version = "0.244.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9d66ea20e9553b30172b5e831994e35fbde2d165325bec84fc43dbf6f4eb9cb2" -dependencies = [ - "anyhow", - "bitflags", - "indexmap", - "log", - "serde", - "serde_derive", - "serde_json", - "wasm-encoder", - "wasm-metadata", - "wasmparser", - "wit-parser", -] - -[[package]] -name = "wit-parser" -version = "0.244.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ecc8ac4bc1dc3381b7f59c34f00b67e18f910c2c0f50015669dde7def656a736" -dependencies = [ - "anyhow", - "id-arena", - "indexmap", - "log", - "semver", - "serde", - "serde_derive", - "serde_json", - "unicode-xid", - "wasmparser", -] - -[[package]] -name = "writeable" -version = "0.6.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1ffae5123b2d3fc086436f8834ae3ab053a283cfac8fe0a0b8eaae044768a4c4" - -[[package]] -name = "xattr" -version = "1.6.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32e45ad4206f6d2479085147f02bc2ef834ac85886624a23575ae137c8aa8156" -dependencies = [ - "libc", - "rustix", -] - -[[package]] -name = "yoke" -version = "0.8.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "abe8c5fda708d9ca3df187cae8bfb9ceda00dd96231bed36e445a1a48e66f9ca" -dependencies = [ - "stable_deref_trait", - "yoke-derive", - "zerofrom", -] - -[[package]] -name = "yoke-derive" -version = "0.8.2" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "de844c262c8848816172cef550288e7dc6c7b7814b4ee56b3e1553f275f1858e" -dependencies = [ - "proc-macro2", - "quote", - "syn", - "synstructure", -] - -[[package]] -name = "zerofrom" -version = "0.1.8" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0ec05a11813ea801ff6d75110ad09cd0824ddba17dfe17128ea0d5f68e6c5272" -dependencies = [ - "zerofrom-derive", -] - -[[package]] -name = "zerofrom-derive" -version = "0.1.7" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "11532158c46691caf0f2593ea8358fed6bbf68a0315e80aae9bd41fbade684a1" -dependencies = [ - "proc-macro2", - "quote", - "syn", - "synstructure", -] - -[[package]] -name = "zerotrie" -version = "0.2.4" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0f9152d31db0792fa83f70fb2f83148effb5c1f5b8c7686c3459e361d9bc20bf" -dependencies = [ - "displaydoc", - "yoke", - "zerofrom", -] - -[[package]] -name = "zerovec" -version = "0.11.6" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "90f911cbc359ab6af17377d242225f4d75119aec87ea711a880987b18cd7b239" -dependencies = [ - "yoke", - "zerofrom", - "zerovec-derive", -] - -[[package]] -name = "zerovec-derive" -version = "0.11.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "625dc425cab0dca6dc3c3319506e6593dcb08a9f387ea3b284dbd52a92c40555" -dependencies = [ - "proc-macro2", - "quote", - "syn", -] - -[[package]] -name = "zmij" -version = "1.0.21" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b8848ee67ecc8aedbaf3e4122217aff892639231befc6a1b58d29fff4c2cabaa" diff --git a/.github/dylints/lossy_feedback/Cargo.toml b/.github/dylints/lossy_feedback/Cargo.toml deleted file mode 100644 index 8094722ef00..00000000000 --- a/.github/dylints/lossy_feedback/Cargo.toml +++ /dev/null @@ -1,18 +0,0 @@ -[package] -name = "lossy_feedback" -version = "0.0.1" -description = "Require lossy mailboxes to return Lossy." -edition = "2021" -publish = false - -[lib] -crate-type = ["cdylib"] - -[dependencies] -dylint_linting = "6.0.0" - -[dev-dependencies] -dylint_testing = "6.0.0" - -[package.metadata.rust-analyzer] -rustc_private = true diff --git a/.github/dylints/lossy_feedback/rust-toolchain b/.github/dylints/lossy_feedback/rust-toolchain deleted file mode 100644 index 588e8755f3a..00000000000 --- a/.github/dylints/lossy_feedback/rust-toolchain +++ /dev/null @@ -1,5 +0,0 @@ -# Dylint discovers library toolchains from this directory, so the just/CI -# `cargo +nightly-... dylint` invocation does not pin the library build. -[toolchain] -channel = "nightly" -components = ["rustc-dev", "llvm-tools-preview"] diff --git a/.github/dylints/lossy_feedback/src/lib.rs b/.github/dylints/lossy_feedback/src/lib.rs deleted file mode 100644 index e876f75a78f..00000000000 --- a/.github/dylints/lossy_feedback/src/lib.rs +++ /dev/null @@ -1,355 +0,0 @@ -#![feature(rustc_private)] -#![warn(unused_extern_crates)] - -extern crate rustc_ast; -extern crate rustc_errors; -extern crate rustc_hir; -extern crate rustc_middle; -extern crate rustc_span; - -use rustc_ast::ast::LitKind; -use rustc_errors::DiagDecorator; -use rustc_hir::{ - intravisit::{self, Visitor}, - Arm, BodyId, Expr, ExprKind, FnDecl, FnRetTy, ImplItem, ImplItemKind, ItemKind, Node, Pat, - PatExprKind, PatKind, QPath, Ty, TyKind, -}; -use rustc_lint::{LateContext, LateLintPass, LintContext}; -use rustc_middle::ty; -use rustc_span::{ - def_id::{DefId, LocalDefId}, - Span, Symbol, -}; -use std::collections::{HashMap, HashSet}; - -dylint_linting::impl_late_lint! { - /// ### What it does - /// - /// Detects functions that return plain `Feedback` from a mailbox whose - /// [`Policy::handle`] implementation can return `false`. - /// - /// ### Why is this bad? - /// - /// A mailbox policy that returns `false` rejects live work under backpressure. - /// Returning `Lossy` makes that lossy contract explicit at the API - /// boundary. - /// - /// ### Example - /// - /// ```rust - /// fn submit(&self, message: Message) -> Feedback { - /// self.sender.enqueue(message) - /// } - /// ``` - /// - /// Use instead: - /// - /// ```rust - /// fn submit(&self, message: Message) -> Lossy { - /// self.sender.enqueue_lossy(message) - /// } - /// ``` - pub LOSSY_FEEDBACK, - Deny, - "lossy mailbox returns plain Feedback", - LossyFeedback::default() -} - -#[derive(Default)] -pub struct LossyFeedback { - lossy_messages: HashMap, -} - -#[derive(Default)] -struct LossyPolicy { - all: bool, - variants: HashSet, -} - -impl LossyPolicy { - fn merge(&mut self, other: LossyPolicy) { - self.all |= other.all; - self.variants.extend(other.variants); - } - - fn is_empty(&self) -> bool { - !self.all && self.variants.is_empty() - } -} - -impl<'tcx> LateLintPass<'tcx> for LossyFeedback { - fn check_impl_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx ImplItem<'tcx>) { - let ImplItemKind::Fn(_, body_id) = item.kind else { - return; - }; - if item.ident.name != Symbol::intern("handle") { - return; - } - - let Some(message) = policy_self_ty(cx, item) else { - return; - }; - let policy = lossy_policy(cx, body_id); - if !policy.is_empty() { - self.lossy_messages.insert(message, policy); - } - } - - fn check_fn( - &mut self, - cx: &LateContext<'tcx>, - _kind: rustc_hir::intravisit::FnKind<'tcx>, - decl: &'tcx FnDecl<'tcx>, - body: &'tcx rustc_hir::Body<'tcx>, - _span: Span, - _id: LocalDefId, - ) { - if !returns_plain_feedback(decl) { - return; - } - - let mut visitor = LossyEnqueueVisitor { - cx, - lossy_messages: &self.lossy_messages, - span: None, - }; - visitor.visit_expr(body.value); - - if let Some(span) = visitor.span { - cx.emit_span_lint( - LOSSY_FEEDBACK, - span, - DiagDecorator(|diag| { - diag.primary_message("lossy mailbox returns plain Feedback"); - diag.span_help(span, "use enqueue_lossy and return Lossy"); - }), - ); - } - } -} - -fn policy_self_ty(cx: &LateContext<'_>, item: &ImplItem<'_>) -> Option { - let Node::Item(parent) = cx.tcx.parent_hir_node(item.hir_id()) else { - return None; - }; - let ItemKind::Impl(impl_) = parent.kind else { - return None; - }; - let trait_ref = impl_.of_trait.as_ref()?; - if trait_ref.trait_ref.path.segments.last()?.ident.name != Symbol::intern("Policy") { - return None; - } - ty_def_id(impl_.self_ty) -} - -fn ty_def_id(ty: &Ty<'_>) -> Option { - let TyKind::Path(QPath::Resolved(_, path)) = ty.kind else { - return None; - }; - path.res.opt_def_id() -} - -fn lossy_policy(cx: &LateContext<'_>, body_id: BodyId) -> LossyPolicy { - let body = cx.tcx.hir_body(body_id); - let mut policy = LossyPolicy::default(); - - let mut visitor = ReturnVisitor { - policy: &mut policy, - }; - visitor.visit_expr(body.value); - collect_tail_lossy(body.value, &mut policy); - - policy -} - -struct ReturnVisitor<'a> { - policy: &'a mut LossyPolicy, -} - -impl<'tcx> Visitor<'tcx> for ReturnVisitor<'_> { - fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) { - match expr.kind { - ExprKind::Closure(_) => {} - ExprKind::Ret(Some(value)) => { - if bool_value(value) == Some(false) { - self.policy.all = true; - } - intravisit::walk_expr(self, expr); - } - _ => intravisit::walk_expr(self, expr), - } - } -} - -fn collect_tail_lossy(expr: &Expr<'_>, policy: &mut LossyPolicy) { - match expr.kind { - ExprKind::Block(block, _) => { - if let Some(expr) = block.expr { - collect_tail_lossy(expr, policy); - } - } - ExprKind::If(_, then, Some(otherwise)) => { - collect_tail_lossy(then, policy); - collect_tail_lossy(otherwise, policy); - } - ExprKind::If(_, then, None) => collect_tail_lossy(then, policy), - ExprKind::Match(_, arms, _) => collect_match_lossy(arms, policy), - ExprKind::Closure(_) => {} - _ => { - if bool_value(expr) == Some(false) { - policy.all = true; - } - } - } -} - -fn collect_match_lossy(arms: &[Arm<'_>], policy: &mut LossyPolicy) { - for arm in arms { - let mut arm_policy = LossyPolicy::default(); - collect_tail_lossy(arm.body, &mut arm_policy); - if arm_policy.is_empty() { - continue; - } - if arm_policy.all { - collect_lossy_pattern(arm.pat, policy); - } else { - policy.merge(arm_policy); - } - } -} - -fn collect_lossy_pattern(pat: &Pat<'_>, policy: &mut LossyPolicy) { - match pat.kind { - PatKind::Struct(qpath, ..) | PatKind::TupleStruct(qpath, ..) => { - if let Some(variant) = qpath_name(qpath) { - policy.variants.insert(variant); - } else { - policy.all = true; - } - } - PatKind::Expr(expr) => { - if let PatExprKind::Path(qpath) = expr.kind { - if let Some(variant) = qpath_name(qpath) { - policy.variants.insert(variant); - } else { - policy.all = true; - } - } else { - policy.all = true; - } - } - PatKind::Or(pats) => { - for pat in pats { - collect_lossy_pattern(pat, policy); - } - } - PatKind::Binding(_, _, _, Some(pat)) | PatKind::Ref(pat, _, _) => { - collect_lossy_pattern(pat, policy); - } - _ => policy.all = true, - } -} - -fn bool_value(expr: &Expr<'_>) -> Option { - if let ExprKind::Lit(lit) = expr.kind { - if let LitKind::Bool(value) = lit.node { - return Some(value); - } - } - None -} - -fn returns_plain_feedback(decl: &FnDecl<'_>) -> bool { - let FnRetTy::Return(ty) = decl.output else { - return false; - }; - path_ty_name(ty) == Some(Symbol::intern("Feedback")) -} - -fn path_ty_name(ty: &Ty<'_>) -> Option { - let TyKind::Path(QPath::Resolved(_, path)) = ty.kind else { - return None; - }; - Some(path.segments.last()?.ident.name) -} - -fn qpath_name(qpath: QPath<'_>) -> Option { - match qpath { - QPath::Resolved(_, path) => Some(path.segments.last()?.ident.name), - QPath::TypeRelative(_, segment) => Some(segment.ident.name), - } -} - -struct LossyEnqueueVisitor<'a, 'tcx> { - cx: &'a LateContext<'tcx>, - lossy_messages: &'a HashMap, - span: Option, -} - -impl<'tcx> Visitor<'tcx> for LossyEnqueueVisitor<'_, 'tcx> { - fn visit_expr(&mut self, expr: &'tcx Expr<'tcx>) { - if self.span.is_some() || expr.span.from_expansion() { - return; - } - - match expr.kind { - ExprKind::Closure(_) => {} - ExprKind::MethodCall(segment, receiver, args, _) - if segment.ident.name == Symbol::intern("enqueue") - && self.enqueue_is_lossy(receiver, args.first()) => - { - self.span = Some(expr.span); - } - _ => intravisit::walk_expr(self, expr), - } - } -} - -impl LossyEnqueueVisitor<'_, '_> { - fn enqueue_is_lossy(&self, receiver: &Expr<'_>, message: Option<&Expr<'_>>) -> bool { - let Some(policy) = self.receiver_lossy_policy(receiver) else { - return false; - }; - if policy.all { - return true; - } - - let Some(message) = message else { - return false; - }; - message_variant(message).is_some_and(|variant| policy.variants.contains(&variant)) - } - - fn receiver_lossy_policy(&self, receiver: &Expr<'_>) -> Option<&LossyPolicy> { - let receiver_ty = self.cx.typeck_results().expr_ty(receiver).peel_refs(); - let ty::Adt(_, args) = receiver_ty.kind() else { - return None; - }; - let message_ty = args.get(0).and_then(|arg| arg.as_type())?; - let ty::Adt(message, _) = message_ty.peel_refs().kind() else { - return None; - }; - self.lossy_messages.get(&message.did()) - } -} - -fn message_variant(expr: &Expr<'_>) -> Option { - match expr.kind { - ExprKind::Struct(qpath, ..) => qpath_name(*qpath), - ExprKind::Path(qpath) => qpath_name(qpath), - ExprKind::Call(callee, _) => { - if let ExprKind::Path(qpath) = callee.kind { - qpath_name(qpath) - } else { - None - } - } - ExprKind::Block(block, _) => block.expr.and_then(message_variant), - _ => None, - } -} - -#[test] -fn ui() { - dylint_testing::ui_test(env!("CARGO_PKG_NAME"), "ui"); -} diff --git a/.github/dylints/lossy_feedback/ui/main.rs b/.github/dylints/lossy_feedback/ui/main.rs deleted file mode 100644 index 7e73ce053ed..00000000000 --- a/.github/dylints/lossy_feedback/ui/main.rs +++ /dev/null @@ -1,106 +0,0 @@ -enum Feedback { - Ok, - Backoff, - Closed, -} - -enum Lossy { - Handled(T), - Rejected, -} - -mod mailbox { - use super::{Feedback, Lossy}; - use std::marker::PhantomData; - - pub trait Policy: Sized { - type Overflow; - - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool; - } - - pub struct Sender(PhantomData); - - impl Sender { - pub fn enqueue(&self, _message: T) -> Feedback { - Feedback::Ok - } - - pub fn enqueue_lossy(&self, _message: T) -> Lossy { - Lossy::Handled(Feedback::Ok) - } - } -} - -struct ReliableMessage; - -impl mailbox::Policy for ReliableMessage { - type Overflow = (); - - fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { - true - } -} - -struct LossyMessage; - -impl mailbox::Policy for LossyMessage { - type Overflow = (); - - fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { - false - } -} - -enum MixedMessage { - Content, - Release, -} - -impl mailbox::Policy for MixedMessage { - type Overflow = Vec; - - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { - match message { - Self::Content => false, - message => { - overflow.push(message); - true - } - } - } -} - -struct Mailbox { - reliable: mailbox::Sender, - lossy: mailbox::Sender, - mixed: mailbox::Sender, -} - -impl Mailbox { - fn allowed_reliable(&self, message: ReliableMessage) -> Feedback { - self.reliable.enqueue(message) - } - - fn bad_lossy(&self, message: LossyMessage) -> Feedback { - self.lossy.enqueue(message) - } - - fn good_lossy(&self, message: LossyMessage) -> Lossy { - self.lossy.enqueue_lossy(message) - } - - fn bad_content(&self) -> Feedback { - self.mixed.enqueue(MixedMessage::Content) - } - - fn allowed_release(&self) -> Feedback { - self.mixed.enqueue(MixedMessage::Release) - } - - fn ignored(&self, message: LossyMessage) { - let _ = self.lossy.enqueue(message); - } -} - -fn main() {} diff --git a/.github/dylints/lossy_feedback/ui/main.stderr b/.github/dylints/lossy_feedback/ui/main.stderr deleted file mode 100644 index 020ccfdf06f..00000000000 --- a/.github/dylints/lossy_feedback/ui/main.stderr +++ /dev/null @@ -1,27 +0,0 @@ -error: lossy mailbox returns plain Feedback - --> $DIR/main.rs:86:9 - | -LL | self.lossy.enqueue(message) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - | -help: use enqueue_lossy and return Lossy - --> $DIR/main.rs:86:9 - | -LL | self.lossy.enqueue(message) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ - = note: `#[deny(lossy_feedback)]` on by default - -error: lossy mailbox returns plain Feedback - --> $DIR/main.rs:94:9 - | -LL | self.mixed.enqueue(MixedMessage::Content) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - | -help: use enqueue_lossy and return Lossy - --> $DIR/main.rs:94:9 - | -LL | self.mixed.enqueue(MixedMessage::Content) - | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -error: aborting due to 2 previous errors - diff --git a/Cargo.toml b/Cargo.toml index 19b0ad6fd5b..7b8857288f7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -48,7 +48,6 @@ members = [ exclude = [ ".github/dylints/borrowed_child_context", ".github/dylints/child_attribute_name_conflict", - ".github/dylints/lossy_feedback", ] resolver = "2" diff --git a/actor/src/benches/mailbox.rs b/actor/src/benches/mailbox.rs index f2bbb528205..7bb49ef50f8 100644 --- a/actor/src/benches/mailbox.rs +++ b/actor/src/benches/mailbox.rs @@ -51,10 +51,10 @@ impl Metrics for NoopMetrics { } } -fn new( +fn new( capacity: std::num::NonZeroUsize, -) -> (mailbox::Sender, mailbox::Receiver) { - mailbox::new(NoopMetrics, capacity) +) -> (mailbox::LossySender, mailbox::LossyReceiver) { + mailbox::new_lossy(NoopMetrics, capacity) } #[derive(Clone, Copy, Debug, PartialEq, Eq)] @@ -89,7 +89,7 @@ impl Message { } } -impl mailbox::Policy for Message { +impl mailbox::LossyPolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -257,7 +257,7 @@ fn bench_overflow_drop(c: &mut Criterion) { }, |(sender, _receiver)| { for _ in 0..MESSAGES { - let result = sender.enqueue_lossy(black_box(Message::drop())); + let result = sender.enqueue(black_box(Message::drop())); assert_eq!(result, Lossy::Rejected); black_box(result); } @@ -294,7 +294,12 @@ fn bench_overflow_spill(c: &mut Criterion) { group.finish(); } -fn replace_queue(newest: bool) -> (mailbox::Sender, mailbox::Receiver) { +fn replace_queue( + newest: bool, +) -> ( + mailbox::LossySender, + mailbox::LossyReceiver, +) { let (sender, receiver) = new::(NZUsize!(REPLACE_CAPACITY)); for _ in 0..REPLACE_CAPACITY { diff --git a/actor/src/lib.rs b/actor/src/lib.rs index 6b9acb46d6b..366c2e43907 100644 --- a/actor/src/lib.rs +++ b/actor/src/lib.rs @@ -48,18 +48,6 @@ commonware_macros::stability_scope!(BETA { Self::Rejected } - /// Return the underlying feedback. - /// - /// # Panics - /// - /// Panics if the endpoint rejected the work. - pub fn into_inner(self) -> Feedback { - match self { - Self::Handled(feedback) => feedback, - Self::Rejected => panic!("lossy feedback was rejected"), - } - } - /// Returns `true` when the endpoint handled the submission. pub const fn accepted(self) -> bool { match self { @@ -75,12 +63,6 @@ commonware_macros::stability_scope!(BETA { } } - impl From> for Feedback { - fn from(feedback: Lossy) -> Self { - feedback.into_inner() - } - } - impl PartialEq for Lossy { fn eq(&self, other: &Feedback) -> bool { matches!(self, Self::Handled(feedback) if feedback == other) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 1a5fd4eada6..cdc5736fdd6 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -48,6 +48,7 @@ use std::{ collections::VecDeque, fmt, future::poll_fn, + marker::PhantomData, num::NonZeroUsize, sync::mpsc::TryRecvError, task::{Context, Poll}, @@ -93,11 +94,32 @@ pub trait Policy: Sized { /// Handle `message` when it cannot enter the bounded ready queue immediately. /// - /// Returns `true` when the policy considered the message's effects. This includes - /// retaining the message, coalescing it with retained work, replacing older retained work, - /// or deliberately doing no work because the message is already satisfied, superseded, or no - /// longer needed (for example, a request whose response channel is already closed). These - /// no-op cases are still handled: there is no remaining work, so there is no loss to report. + /// This may retain the message, coalesce it with retained work, replace older retained work, + /// or deliberately do no work because the message is already satisfied, superseded, or no + /// longer needed (for example, a request whose response channel is already closed). + /// + /// # Warning + /// + /// Do not enqueue into the same mailbox from this method or from destructors triggered by + /// editing `overflow`. This method runs while the mailbox holds its overflow lock, so same + /// mailbox re-entry can deadlock. + /// + /// This method should not unwind after mutating `overflow`. A panic, including one from a + /// destructor triggered while editing `overflow`, can leave retained overflow data stranded in + /// the mailbox. + fn handle(overflow: &mut Self::Overflow, message: Self); +} + +/// Overflow behavior for actor messages that can be rejected when an inbox is full. +pub trait LossyPolicy: Sized { + /// Overflow storage used by this policy. + type Overflow: Overflow; + + /// Handle `message` when it cannot enter the bounded ready queue immediately. + /// + /// Returns `true` when the policy considered the message's effects. This includes retaining + /// the message, coalescing it with retained work, replacing older retained work, or deliberately + /// doing no work because the message is already satisfied, superseded, or no longer needed. /// /// Returns `false` only when the policy rejects the message under backpressure. This is the /// lossy case: the submitted work was not semantically handled, and callers that care should @@ -115,6 +137,76 @@ pub trait Policy: Sized { fn handle(overflow: &mut Self::Overflow, message: Self) -> bool; } +struct Infallible; + +struct LossyMode; + +trait MailboxMode: Sized { + type Overflow: Overflow; + type Feedback; + + fn handle(overflow: &mut Self::Overflow, message: T) -> bool; + fn ready_feedback(feedback: Feedback) -> Self::Feedback; + fn overflow_feedback(handled: bool) -> Self::Feedback; + fn is_backoff(feedback: &Self::Feedback) -> bool; + fn is_closed(feedback: &Self::Feedback) -> bool; +} + +impl MailboxMode for Infallible { + type Overflow = T::Overflow; + type Feedback = Feedback; + + fn handle(overflow: &mut Self::Overflow, message: T) -> bool { + T::handle(overflow, message); + true + } + + fn ready_feedback(feedback: Feedback) -> Self::Feedback { + feedback + } + + fn overflow_feedback(_handled: bool) -> Self::Feedback { + Feedback::Backoff + } + + fn is_backoff(feedback: &Self::Feedback) -> bool { + *feedback == Feedback::Backoff + } + + fn is_closed(feedback: &Self::Feedback) -> bool { + *feedback == Feedback::Closed + } +} + +impl MailboxMode for LossyMode { + type Overflow = T::Overflow; + type Feedback = Lossy; + + fn handle(overflow: &mut Self::Overflow, message: T) -> bool { + T::handle(overflow, message) + } + + fn ready_feedback(feedback: Feedback) -> Self::Feedback { + Lossy::new(feedback) + } + + fn overflow_feedback(handled: bool) -> Self::Feedback { + if handled { + Lossy::new(Feedback::Backoff) + } else { + Lossy::Rejected + } + } + + fn is_backoff(feedback: &Self::Feedback) -> bool { + *feedback == Feedback::Backoff + } + + fn is_closed(feedback: &Self::Feedback) -> bool { + *feedback == Feedback::Closed + } +} + // `activity` packs the published overflow state and in-flight overflow // mutations into one atomic word. The overflow lock serializes actual // overflow changes (this word lets the ready fast path avoid that lock when @@ -260,17 +352,19 @@ cfg_if::cfg_if! { } } -struct OverflowState { - queue: Mutex, +struct OverflowState> { + queue: Mutex, activity: AtomicUsize, + _phantom: PhantomData T>, } -impl OverflowState { +impl> OverflowState { #[allow(clippy::missing_const_for_fn)] fn new() -> Self { Self { - queue: Mutex::new(T::Overflow::default()), + queue: Mutex::new(M::Overflow::default()), activity: AtomicUsize::new(0), + _phantom: PhantomData, } } @@ -282,18 +376,18 @@ impl OverflowState { ready.push(message) } - fn enqueue_lossy( + fn enqueue_overflow( &self, ready: &Ready, message: T, is_closed: impl Fn() -> bool, - ) -> Lossy { + ) -> M::Feedback { // Mark overflow active so racing senders stay off the ready fast path. let mutation = Mutation::begin(&self.activity); let mut queue = lock(&self.queue); if is_closed() { mutation.publish(queue.is_empty()); - return Lossy::new(Feedback::Closed); + return M::ready_feedback(Feedback::Closed); } // The fast-path push may have observed stale ready fullness. Retry @@ -303,7 +397,7 @@ impl OverflowState { match ready.push(message) { Ok(()) => { mutation.publish(queue.is_empty()); - return Lossy::new(Feedback::Ok); + return M::ready_feedback(Feedback::Ok); } Err(message) => message, } @@ -312,13 +406,9 @@ impl OverflowState { }; // Preserve overflow order, or handle a still-full ready queue. - let handled = T::handle(&mut queue, message); + let handled = M::handle(&mut queue, message); mutation.publish(queue.is_empty()); - if handled { - Lossy::new(Feedback::Backoff) - } else { - Lossy::Rejected - } + M::overflow_feedback(handled) } fn refill(&self, ready: &Ready) { @@ -386,18 +476,111 @@ impl Drop for Mutation<'_> { } } -struct State { +struct State> { ready: Ready, - overflow: OverflowState, + overflow: OverflowState, backoff: Counter, closed: AtomicBool, senders: AtomicUsize, waker: AtomicWaker, } +impl> State { + fn enqueue(&self, message: T) -> M::Feedback { + // Receiver closure makes new sends fail immediately. + if self.closed.load(Ordering::Acquire) { + return M::ready_feedback(Feedback::Closed); + } + + // Common case: publish directly to ready without taking overflow lock. + let message = match self.overflow.try_ready(&self.ready, message) { + Ok(()) => { + if self.closed.load(Ordering::Acquire) { + self.overflow.drain(&self.ready); + return M::ready_feedback(Feedback::Closed); + } + self.waker.wake(); + return M::ready_feedback(Feedback::Ok); + } + Err(message) => message, + }; + + // Slow path: serialize through overflow and apply the policy. + let feedback = self + .overflow + .enqueue_overflow(&self.ready, message, || self.closed.load(Ordering::Acquire)); + + // Record any backoff. + if M::is_backoff(&feedback) { + self.backoff.inc(); + } + + // Wake after any non-closed slow-path enqueue because a receiver may + // have skipped refill while this overflow mutation was active. By the + // time we wake, the mutation has published its overflow state. Spurious + // wakes are acceptable. + if !M::is_closed(&feedback) { + self.waker.wake(); + } + feedback + } + + fn poll_recv(&self, cx: &mut Context<'_>) -> Poll> { + // Fast path avoids waker churn when a message is already ready. + if let Some(message) = self.pop() { + return Poll::Ready(Some(message)); + } + + if self.is_disconnected() { + return Poll::Ready(self.pop()); + } + + register_waker(&self.waker, cx.waker()); + + // A sender can enqueue and wake after the first pop but before this + // waker is installed. Re-check before sleeping so the wake is not lost. + if let Some(message) = self.pop() { + return Poll::Ready(Some(message)); + } + + if self.is_disconnected() { + Poll::Ready(self.pop()) + } else { + Poll::Pending + } + } + + fn pop(&self) -> Option { + if let Some(message) = self.ready.pop() { + // A freed ready slot may let the oldest overflow message advance. + self.overflow.refill(&self.ready); + return Some(message); + } + + // Empty ready may race with stale activity, so let `refill` + // decide whether overflow is worth locking. + self.overflow.refill(&self.ready); + self.ready.pop() + } + + fn is_disconnected(&self) -> bool { + self.closed.load(Ordering::Acquire) || self.senders.load(Ordering::Acquire) == 0 + } + + fn close(&self) { + self.closed.store(true, Ordering::Release); + self.overflow.drain(&self.ready); + } +} + /// Sender half of a mailbox. pub struct Sender { - state: Arc>, + state: Arc>, +} + +/// Sender half of a lossy mailbox. +pub struct LossySender { + state: Arc>, } impl Clone for Sender { @@ -410,6 +593,16 @@ impl Clone for Sender { } } +impl Clone for LossySender { + fn clone(&self) -> Self { + // Live sender count drives receiver disconnect detection. + self.state.senders.fetch_add(1, Ordering::Relaxed); + Self { + state: self.state.clone(), + } + } +} + impl Drop for Sender { fn drop(&mut self) { let previous = self.state.senders.fetch_sub(1, Ordering::AcqRel); @@ -421,6 +614,17 @@ impl Drop for Sender { } } +impl Drop for LossySender { + fn drop(&mut self) { + let previous = self.state.senders.fetch_sub(1, Ordering::AcqRel); + assert!(previous > 0); + // Wake a receiver that is parked waiting for data or disconnect. + if previous == 1 { + self.state.waker.wake(); + } + } +} + impl fmt::Debug for Sender { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("Sender") @@ -430,62 +634,28 @@ impl fmt::Debug for Sender { } } +impl fmt::Debug for LossySender { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + f.debug_struct("LossySender") + .field("capacity", &self.state.ready.capacity()) + .field("closed", &self.state.closed.load(Ordering::Acquire)) + .finish() + } +} + impl Sender { /// Submit a message without waiting for inbox capacity. - /// - /// Use this for policies that handle all overflow messages. Use [`Sender::enqueue_lossy`] when - /// the policy may reject a message under backpressure. - /// - /// # Panics - /// - /// Panics if the overflow policy rejects the message. #[must_use = "caller must handle enqueue feedback"] pub fn enqueue(&self, message: T) -> Feedback { - self.enqueue_lossy(message).into_inner() + self.state.enqueue(message) } +} +impl LossySender { /// Submit a message without waiting for inbox capacity, allowing policy rejection. #[must_use = "caller must handle enqueue feedback"] - pub fn enqueue_lossy(&self, message: T) -> Lossy { - // Receiver closure makes new sends fail immediately. - if self.state.closed.load(Ordering::Acquire) { - return Lossy::new(Feedback::Closed); - } - - // Common case: publish directly to ready without taking overflow lock. - let message = match self.state.overflow.try_ready(&self.state.ready, message) { - Ok(()) => { - if self.state.closed.load(Ordering::Acquire) { - self.state.overflow.drain(&self.state.ready); - return Lossy::new(Feedback::Closed); - } - self.state.waker.wake(); - return Lossy::new(Feedback::Ok); - } - Err(message) => message, - }; - - // Slow path: serialize through overflow and apply the policy. - let feedback = self - .state - .overflow - .enqueue_lossy(&self.state.ready, message, || { - self.state.closed.load(Ordering::Acquire) - }); - - // Record any backoff. - if feedback == Feedback::Backoff { - self.state.backoff.inc(); - } - - // Wake after any non-closed slow-path enqueue because a receiver may - // have skipped refill while this overflow mutation was active. By the - // time we wake, the mutation has published its overflow state. Spurious - // wakes are acceptable. - if feedback != Feedback::Closed { - self.state.waker.wake(); - } - feedback + pub fn enqueue(&self, message: T) -> Lossy { + self.state.enqueue(message) } } @@ -496,50 +666,58 @@ impl Sender { /// Dropping the last sender disconnects the mailbox, but the receiver continues /// returning buffered messages until ready and overflow are empty. pub struct Receiver { - state: Arc>, + state: Arc>, +} + +/// Receiver half of a lossy mailbox. +/// +/// Dropping the receiver closes the mailbox and drains buffered messages. +/// +/// Dropping the last sender disconnects the mailbox, but the receiver continues +/// returning buffered messages until ready and overflow are empty. +pub struct LossyReceiver { + state: Arc>, } impl Receiver { fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll> { - // Fast path avoids waker churn when a message is already ready. - if let Some(message) = self.pop() { - return Poll::Ready(Some(message)); - } + self.state.poll_recv(cx) + } - if self.is_disconnected() { - return Poll::Ready(self.pop()); - } + fn pop(&mut self) -> Option { + self.state.pop() + } - register_waker(&self.state.waker, cx.waker()); + /// Receive the next message. + /// + /// Returns `None` after all senders are dropped and all buffered messages + /// have been drained. + pub async fn recv(&mut self) -> Option { + poll_fn(|cx| self.poll_recv(cx)).await + } - // A sender can enqueue and wake after the first pop but before this - // waker is installed. Re-check before sleeping so the wake is not lost. + /// Try to receive the next message without waiting. + /// + /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and + /// all buffered messages have been drained. + pub fn try_recv(&mut self) -> Result { if let Some(message) = self.pop() { - return Poll::Ready(Some(message)); + return Ok(message); } - - if self.is_disconnected() { - Poll::Ready(self.pop()) - } else { - Poll::Pending + if self.state.is_disconnected() { + return self.pop().ok_or(TryRecvError::Disconnected); } + Err(TryRecvError::Empty) } +} - fn pop(&mut self) -> Option { - if let Some(message) = self.state.ready.pop() { - // A freed ready slot may let the oldest overflow message advance. - self.state.overflow.refill(&self.state.ready); - return Some(message); - } - - // Empty ready may race with stale activity, so let `refill` - // decide whether overflow is worth locking. - self.state.overflow.refill(&self.state.ready); - self.state.ready.pop() +impl LossyReceiver { + fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll> { + self.state.poll_recv(cx) } - fn is_disconnected(&self) -> bool { - self.state.closed.load(Ordering::Acquire) || self.state.senders.load(Ordering::Acquire) == 0 + fn pop(&mut self) -> Option { + self.state.pop() } /// Receive the next message. @@ -558,7 +736,7 @@ impl Receiver { if let Some(message) = self.pop() { return Ok(message); } - if self.is_disconnected() { + if self.state.is_disconnected() { return self.pop().ok_or(TryRecvError::Disconnected); } Err(TryRecvError::Empty) @@ -567,8 +745,13 @@ impl Receiver { impl Drop for Receiver { fn drop(&mut self) { - self.state.closed.store(true, Ordering::Release); - self.state.overflow.drain(&self.state.ready); + self.state.close(); + } +} + +impl Drop for LossyReceiver { + fn drop(&mut self) { + self.state.close(); } } @@ -590,6 +773,27 @@ pub fn new(metrics: impl Metrics, capacity: NonZeroUsize) -> (Sender< ) } +/// Create a new bounded lossy mailbox. +pub fn new_lossy( + metrics: impl Metrics, + capacity: NonZeroUsize, +) -> (LossySender, LossyReceiver) { + let state = Arc::new(State { + ready: Ready::new(capacity.get()), + overflow: OverflowState::new(), + backoff: metrics.counter("backoff", "number of enqueue calls that requested backoff"), + closed: AtomicBool::new(false), + senders: AtomicUsize::new(1), + waker: AtomicWaker::new(), + }); + ( + LossySender { + state: state.clone(), + }, + LossyReceiver { state }, + ) +} + #[cfg(test)] mod mocks { use commonware_runtime::{ @@ -652,6 +856,10 @@ mod tests { super::new(mocks::Metrics, capacity) } + fn new_lossy(capacity: NonZeroUsize) -> (LossySender, LossyReceiver) { + super::new_lossy(mocks::Metrics, capacity) + } + #[derive(Debug, PartialEq, Eq)] enum Message { Update(u64), @@ -661,7 +869,7 @@ mod tests { Hint(u64), } - impl Policy for Message { + impl LossyPolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -703,9 +911,8 @@ mod tests { impl Policy for Ack { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } @@ -749,7 +956,7 @@ mod tests { #[test_async] async fn full_inbox_replaces_stale_overflow_message() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Update(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Backoff); assert_eq!(sender.enqueue(Message::Update(3)), Feedback::Backoff); @@ -760,7 +967,7 @@ mod tests { #[test_async] async fn policy_can_replace_stale_overflow_at_back() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Backoff); assert_eq!(sender.enqueue(Message::Required(3)), Feedback::Backoff); @@ -773,16 +980,16 @@ mod tests { #[test_async] async fn full_inbox_rejects_non_replaceable_message() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue_lossy(Message::Vote(2)), Lossy::Rejected); + assert_eq!(sender.enqueue(Message::Vote(2)), Lossy::Rejected); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); } #[test_async] async fn full_inbox_retains_required_message() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); @@ -792,7 +999,7 @@ mod tests { #[test] fn try_recv_refills_from_overflow() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); @@ -804,7 +1011,7 @@ mod tests { fn backoff_metric_counts_backoff_feedback() { let executor = deterministic::Runner::default(); executor.start(|context| async move { - let (sender, _receiver) = super::new(context.child("mailbox"), NZUsize!(1)); + let (sender, _receiver) = super::new_lossy(context.child("mailbox"), NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); assert_eq!(sender.enqueue(Message::Buffered(3)), Feedback::Backoff); @@ -821,9 +1028,9 @@ mod tests { fn lossy_rejected_feedback_is_not_accepted_or_counted_as_backoff() { let executor = deterministic::Runner::default(); executor.start(|context| async move { - let (sender, _receiver) = super::new(context.child("mailbox"), NZUsize!(1)); + let (sender, _receiver) = super::new_lossy(context.child("mailbox"), NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - let feedback = sender.enqueue_lossy(Message::Vote(2)); + let feedback = sender.enqueue(Message::Vote(2)); assert_eq!(feedback, Lossy::Rejected); assert!(!feedback.accepted()); @@ -838,7 +1045,7 @@ mod tests { #[test] fn try_recv_drains_buffered_messages_after_senders_drop() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); drop(sender); @@ -850,7 +1057,7 @@ mod tests { #[test] fn poll_recv_drains_buffered_messages_after_senders_drop() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -872,7 +1079,7 @@ mod tests { #[test] fn enqueue_uses_ready_capacity_after_partial_drain() { - let (sender, mut receiver) = new(NZUsize!(2)); + let (sender, mut receiver) = new_lossy(NZUsize!(2)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Vote(2)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Required(3)), Feedback::Backoff); @@ -887,7 +1094,7 @@ mod tests { #[test] fn receiver_refills_overflow_after_partial_drain() { - let (sender, mut receiver) = new(NZUsize!(3)); + let (sender, mut receiver) = new_lossy(NZUsize!(3)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Vote(2)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Vote(3)), Feedback::Ok); @@ -904,7 +1111,7 @@ mod tests { #[test_async] async fn full_inbox_retains_unmatched_replaceable_message() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Required(2)), Feedback::Backoff); @@ -914,7 +1121,7 @@ mod tests { #[test_async] async fn full_inbox_replaces_stale_overflow_after_ready_fills() { - let (sender, mut receiver) = new(NZUsize!(2)); + let (sender, mut receiver) = new_lossy(NZUsize!(2)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Update(3)), Feedback::Backoff); @@ -927,7 +1134,7 @@ mod tests { #[test_async] async fn mailbox_capacity_is_soft_limit_for_required_messages() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Required(2)), Feedback::Backoff); assert_eq!(sender.enqueue(Message::Required(3)), Feedback::Backoff); @@ -939,7 +1146,7 @@ mod tests { #[test_async] async fn full_inbox_rejects_hint() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Hint(2)), Feedback::Backoff); @@ -948,7 +1155,7 @@ mod tests { #[test_async] async fn full_inbox_can_replace_or_drop_by_message() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Backoff); assert_eq!(sender.enqueue(Message::Hint(3)), Feedback::Backoff); @@ -959,7 +1166,7 @@ mod tests { #[test_async] async fn empty_inbox_wakes_on_enqueue() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); let next = receiver.recv(); pin_mut!(next); @@ -971,7 +1178,7 @@ mod tests { #[test] fn pending_recv_wakes_when_senders_drop() { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -987,7 +1194,7 @@ mod tests { #[test] fn pending_recv_wakes_on_handled_overflow_enqueue() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -1006,7 +1213,7 @@ mod tests { #[test] fn receiver_drop_blocks_ready_fast_path_feedback() { - let (sender, mut receiver) = new(NZUsize!(1)); + let (sender, mut receiver) = new_lossy(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -1020,7 +1227,7 @@ mod tests { #[test_async] async fn empty_inbox_closes_when_senders_drop() { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); drop(sender); assert_eq!(receiver.try_recv(), Err(TryRecvError::Disconnected)); @@ -1029,7 +1236,7 @@ mod tests { #[test] fn enqueue_after_receiver_drop_returns_closed() { - let (sender, receiver) = new(NZUsize!(1)); + let (sender, receiver) = new_lossy(NZUsize!(1)); drop(receiver); assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Closed); @@ -1063,10 +1270,9 @@ mod tests { impl Policy for ClearingMessage { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); overflow.clear(); - true } } @@ -1095,9 +1301,8 @@ mod tests { impl Policy for SpillMessage { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } @@ -1141,6 +1346,10 @@ mod loom_tests { super::new(mocks::Metrics, capacity) } + fn new_lossy(capacity: NonZeroUsize) -> (LossySender, LossyReceiver) { + super::new_lossy(mocks::Metrics, capacity) + } + #[derive(Clone, Copy, Debug, PartialEq, Eq)] enum Message { Drop(u8), @@ -1186,7 +1395,7 @@ mod loom_tests { } } - impl Policy for Message { + impl LossyPolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -1203,7 +1412,7 @@ mod loom_tests { impl Policy for OrderedMessage { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { let gate = match &message { Self::Item(_) => None, Self::Coordinated(_, gate) => Some(gate.clone()), @@ -1215,11 +1424,10 @@ mod loom_tests { thread::yield_now(); } } - true } } - impl Policy for ReplacingMessage { + impl LossyPolicy for ReplacingMessage { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -1244,18 +1452,16 @@ mod loom_tests { impl Policy for TrackedMessage { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } impl Policy for CyclicMessage { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } @@ -1328,7 +1534,7 @@ mod loom_tests { #[test] fn sender_drop_racing_waker_registration_wakes_or_disconnects() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1354,7 +1560,7 @@ mod loom_tests { #[test] fn sender_enqueue_then_drop_racing_poll_recv_drains_message() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1386,7 +1592,7 @@ mod loom_tests { #[test] fn sender_enqueue_then_drop_racing_try_recv_drains_message() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let enqueue = thread::spawn(move || { assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); @@ -1413,7 +1619,7 @@ mod loom_tests { #[test] fn handled_enqueue_wakes_registered_receiver() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1434,7 +1640,7 @@ mod loom_tests { #[test] fn receiver_drop_racing_ready_fast_path_feedback_wakes_if_ready() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1586,7 +1792,7 @@ mod loom_tests { #[test] fn concurrent_close_and_ready_enqueue_remains_closed() { loom::model(|| { - let (sender, receiver) = new::(NZUsize!(1)); + let (sender, receiver) = new_lossy::(NZUsize!(1)); let enqueue_sender = sender.clone(); let enqueue = thread::spawn(move || { @@ -1606,7 +1812,7 @@ mod loom_tests { #[test] fn concurrent_close_and_overflow_enqueue_remains_closed() { loom::model(|| { - let (sender, receiver) = new::(NZUsize!(1)); + let (sender, receiver) = new_lossy::(NZUsize!(1)); assert_eq!(sender.enqueue(Message::Drop(0)), Feedback::Ok); let enqueue_sender = sender.clone(); @@ -1627,7 +1833,7 @@ mod loom_tests { #[test] fn concurrent_spill_and_refill_preserves_messages() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let idle_sender = sender.clone(); assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); @@ -1660,7 +1866,7 @@ mod loom_tests { #[test] fn concurrent_spill_senders_preserve_messages() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let idle_sender = sender.clone(); assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); @@ -1685,7 +1891,7 @@ mod loom_tests { #[test] fn concurrent_replace_keeps_one_overflow_message() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(1)); + let (sender, mut receiver) = new_lossy::(NZUsize!(1)); let idle_sender = sender.clone(); assert_eq!(sender.enqueue(ReplacingMessage::FillReady), Feedback::Ok); assert_eq!( @@ -1711,7 +1917,7 @@ mod loom_tests { #[test] fn stale_overflow_hint_retries_ready_before_policy() { loom::model(|| { - let (sender, mut receiver) = new::(NZUsize!(2)); + let (sender, mut receiver) = new_lossy::(NZUsize!(2)); assert_eq!(sender.enqueue(Message::Drop(0)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Drop(1)), Feedback::Ok); assert_eq!(sender.enqueue(Message::Spill(2)), Feedback::Backoff); diff --git a/broadcast/src/buffered/ingress.rs b/broadcast/src/buffered/ingress.rs index f53beb0c21f..e7373be96dd 100644 --- a/broadcast/src/buffered/ingress.rs +++ b/broadcast/src/buffered/ingress.rs @@ -77,13 +77,12 @@ impl Overflow> for Pending { impl Policy for Message { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { if message.response_closed() { - return true; + return; } overflow.0.push_back(message); - true } } diff --git a/broadcast/src/buffered/mod.rs b/broadcast/src/buffered/mod.rs index bd6a5a80fb6..86865aef7dc 100644 --- a/broadcast/src/buffered/mod.rs +++ b/broadcast/src/buffered/mod.rs @@ -196,13 +196,13 @@ mod tests { let (current_responder, current_receiver) = commonware_utils::channel::oneshot::channel(); drop(current_receiver); - assert!( as Policy>::handle( + as Policy>::handle( &mut overflow, Message::Get { digest: current_get.digest(), responder: current_responder, }, - )); + ); let mut drained = VecDeque::new(); overflow.drain(|message| { diff --git a/collector/src/p2p/ingress.rs b/collector/src/p2p/ingress.rs index 124b413c570..eac7d8aa0a4 100644 --- a/collector/src/p2p/ingress.rs +++ b/collector/src/p2p/ingress.rs @@ -22,7 +22,7 @@ pub enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { match message { Self::Send { request, @@ -57,7 +57,6 @@ impl Policy for Message } } } - true } } diff --git a/consensus/src/aggregation/mocks/reporter.rs b/consensus/src/aggregation/mocks/reporter.rs index 84793b09b78..b99805e4493 100644 --- a/consensus/src/aggregation/mocks/reporter.rs +++ b/consensus/src/aggregation/mocks/reporter.rs @@ -30,9 +30,8 @@ enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } diff --git a/consensus/src/marshal/coding/shards/mailbox.rs b/consensus/src/marshal/coding/shards/mailbox.rs index 0caffc91fb6..e427d5ac3c3 100644 --- a/consensus/src/marshal/coding/shards/mailbox.rs +++ b/consensus/src/marshal/coding/shards/mailbox.rs @@ -180,13 +180,12 @@ where { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { if message.response_closed() { - return true; + return; } overflow.0.push_back(message); - true } } diff --git a/consensus/src/marshal/core/mailbox.rs b/consensus/src/marshal/core/mailbox.rs index 2f850450c0d..3be619d1dd8 100644 --- a/consensus/src/marshal/core/mailbox.rs +++ b/consensus/src/marshal/core/mailbox.rs @@ -477,10 +477,10 @@ impl Overflow> for Pending { impl Policy for Message { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { // A closed responder cannot be served if message.response_closed() { - return true; + return; } match message { // Coalesce hints: a single entry per height with a unioned target set @@ -498,14 +498,13 @@ impl Policy for Message { // Queue if the new message is still useful message => { if message.stale(overflow.height()) { - return true; + return; } overflow .messages .push_back(PendingMessage::Message(message)); } } - true } } @@ -1087,12 +1086,9 @@ mod tests { }, ); - assert!(::handle(&mut overflow, wait)); - assert!(::handle(&mut overflow, by_round)); - assert!(::handle( - &mut overflow, - by_commitment - )); + ::handle(&mut overflow, wait); + ::handle(&mut overflow, by_round); + ::handle(&mut overflow, by_commitment); let drained = drain(&mut overflow); assert_eq!(drained.len(), 3); @@ -1139,10 +1135,7 @@ mod tests { let (current_closed, current_closed_rx) = subscribe_by_digest(3); drop(current_closed_rx); - assert!(::handle( - &mut overflow, - current_closed - )); + ::handle(&mut overflow, current_closed); assert!(!has_subscription(&overflow, 1)); assert!(has_subscription(&overflow, 2)); @@ -1170,10 +1163,7 @@ mod tests { let (current_closed, current_closed_rx) = get_finalization(3); drop(current_closed_rx); - assert!(::handle( - &mut overflow, - current_closed - )); + ::handle(&mut overflow, current_closed); assert!(!has_get_block(&overflow, 1)); assert!(has_get_info(&overflow, 2)); diff --git a/consensus/src/marshal/resolver/handler.rs b/consensus/src/marshal/resolver/handler.rs index 2b66b7ea6fc..669175487ee 100644 --- a/consensus/src/marshal/resolver/handler.rs +++ b/consensus/src/marshal/resolver/handler.rs @@ -82,12 +82,11 @@ impl Overflow> for Pending { impl Policy for Message { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { if message.response_closed() { - return true; + return; } overflow.0.push_back(message); - true } } diff --git a/consensus/src/ordered_broadcast/mocks/reporter.rs b/consensus/src/ordered_broadcast/mocks/reporter.rs index b2300a6f7de..d46583ca92d 100644 --- a/consensus/src/ordered_broadcast/mocks/reporter.rs +++ b/consensus/src/ordered_broadcast/mocks/reporter.rs @@ -29,9 +29,8 @@ enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } diff --git a/consensus/src/simplex/actors/batcher/ingress.rs b/consensus/src/simplex/actors/batcher/ingress.rs index f0689b72ff5..f95688711ac 100644 --- a/consensus/src/simplex/actors/batcher/ingress.rs +++ b/consensus/src/simplex/actors/batcher/ingress.rs @@ -90,7 +90,7 @@ impl Overflow> for Pending { impl Policy for Message { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { match message { update @ Self::Update { current: new_current, @@ -107,7 +107,7 @@ impl Policy for Message { let old = (*old_current, *old_finalized); let new = (new_current, new_finalized); if new <= old { - return true; + return; } } overflow.update = Some(update); @@ -124,7 +124,7 @@ impl Policy for Message { Some(Self::Update { current: old_current, finalized: old_finalized, .. }) if Self::prunes(*old_current, *old_finalized, &new_vote) ) { - return true; + return; } // Ignore the constructed vote if it is a duplicate @@ -133,12 +133,11 @@ impl Policy for Message { .iter() .any(|old_vote| Self::similar(old_vote, &new_vote)) { - return true; + return; } overflow.constructed.push_back(new_vote); } } - true } } diff --git a/consensus/src/simplex/actors/resolver/ingress.rs b/consensus/src/simplex/actors/resolver/ingress.rs index 89be27f91e5..8883433118a 100644 --- a/consensus/src/simplex/actors/resolver/ingress.rs +++ b/consensus/src/simplex/actors/resolver/ingress.rs @@ -67,7 +67,7 @@ impl Overflow> for Pending { impl Policy for MailboxMessage { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { // Ignore the message if there exists a queued finalization // with a view greater than or equal to the new view let new_view = message.view(); @@ -76,7 +76,7 @@ impl Policy for MailboxMessage { Some(Self::Certificate(Certificate::Finalization(old_finalized))) if old_finalized.view() >= new_view ) { - return true; + return; } // Retain only the highest-view finalization and any messages with a view greater than the new view @@ -85,7 +85,7 @@ impl Policy for MailboxMessage { .messages .retain(|old_message| old_message.view() > new_view); overflow.finalization = Some(message); - return true; + return; } // Ignore the message if it is a duplicate @@ -109,10 +109,9 @@ impl Policy for MailboxMessage { _ => false, }) { - return true; + return; } overflow.messages.push_back(message); - true } } @@ -194,12 +193,11 @@ impl Overflow for HandlerPending { impl Policy for HandlerMessage { type Overflow = HandlerPending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { if message.response_closed() { - return true; + return; } overflow.0.push_back(message); - true } } diff --git a/consensus/src/simplex/actors/voter/ingress.rs b/consensus/src/simplex/actors/voter/ingress.rs index 9f3784e01d5..ad25c9b353a 100644 --- a/consensus/src/simplex/actors/voter/ingress.rs +++ b/consensus/src/simplex/actors/voter/ingress.rs @@ -77,7 +77,7 @@ impl Overflow> for Pending { impl Policy for Message { type Overflow = Pending; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { // Ignore the message if there exists a queued finalization // with a view greater than or equal to the new view let new_view = message.view(); @@ -86,7 +86,7 @@ impl Policy for Message { Some(Self::Verified(Certificate::Finalization(old_finalized), _)) if old_finalized.view() >= new_view ) { - return true; + return; } // Retain only the highest-view finalization and any messages with a view greater than the new view @@ -95,7 +95,7 @@ impl Policy for Message { .messages .retain(|old_message| old_message.view() > new_view); overflow.finalization = Some(message); - return true; + return; } // Ignore the message if it is a duplicate @@ -119,10 +119,9 @@ impl Policy for Message { _ => false, }) { - return true; + return; } overflow.messages.push_back(message); - true } } diff --git a/examples/bridge/src/application/ingress.rs b/examples/bridge/src/application/ingress.rs index a711ff69044..49aa111bd5f 100644 --- a/examples/bridge/src/application/ingress.rs +++ b/examples/bridge/src/application/ingress.rs @@ -33,9 +33,8 @@ pub enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } diff --git a/examples/log/src/application/ingress.rs b/examples/log/src/application/ingress.rs index 93a9cd32465..4cb3cb2e396 100644 --- a/examples/log/src/application/ingress.rs +++ b/examples/log/src/application/ingress.rs @@ -18,9 +18,8 @@ pub enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } diff --git a/examples/reshare/src/dkg/ingress.rs b/examples/reshare/src/dkg/ingress.rs index 516898fb1e6..203bbe62644 100644 --- a/examples/reshare/src/dkg/ingress.rs +++ b/examples/reshare/src/dkg/ingress.rs @@ -47,9 +47,8 @@ where { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { overflow.push_back(message); - true } } diff --git a/examples/reshare/src/orchestrator/ingress.rs b/examples/reshare/src/orchestrator/ingress.rs index 3b2eeacff18..3f675469465 100644 --- a/examples/reshare/src/orchestrator/ingress.rs +++ b/examples/reshare/src/orchestrator/ingress.rs @@ -19,7 +19,7 @@ pub enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut VecDeque, message: Self) -> bool { + fn handle(overflow: &mut VecDeque, message: Self) { match message { Self::Enter(transition) => { let epoch = transition.epoch; @@ -42,7 +42,6 @@ impl Policy for Message { } } } - true } } diff --git a/p2p/src/authenticated/discovery/actors/peer/actor.rs b/p2p/src/authenticated/discovery/actors/peer/actor.rs index 7a3de23849b..ee9e2fa306d 100644 --- a/p2p/src/authenticated/discovery/actors/peer/actor.rs +++ b/p2p/src/authenticated/discovery/actors/peer/actor.rs @@ -34,9 +34,9 @@ pub struct Actor { max_peers: usize, mailbox: Mailbox, - control: mailbox::Receiver>, - high: mailbox::Receiver>, - low: mailbox::Receiver>, + control: mailbox::LossyReceiver>, + high: mailbox::LossyReceiver>, + low: mailbox::LossyReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, @@ -124,10 +124,10 @@ impl peer: &C, batch_size: usize, batch: &mut Vec, - control: &mut mailbox::Receiver>, + control: &mut mailbox::LossyReceiver>, pool: &commonware_runtime::BufferPool, - high: &mut mailbox::Receiver>, - low: &mut mailbox::Receiver>, + high: &mut mailbox::LossyReceiver>, + low: &mut mailbox::LossyReceiver>, rate_limits: &HashMap, sent_messages: &CounterFamily>, ) -> Result<(), Error> { @@ -363,8 +363,7 @@ impl // processing of gossip messages (BitVec, Peers), causing the // peer connection to stall and potentially disconnect. let sender = senders.get_mut(&data.channel).unwrap(); - let _ = - sender.enqueue_lossy(channels::Inbound((peer.clone(), data.message))); + let _ = sender.enqueue(channels::Inbound((peer.clone(), data.message))); } types::Payload::Greeting(_) => unreachable!(), types::Payload::BitVec(bit_vec) => { @@ -460,7 +459,7 @@ mod tests { } fn create_channels(context: impl BufferPooler + Metrics) -> Channels { - let (router_sender, _router_receiver) = commonware_actor::mailbox::new::< + let (router_sender, _router_receiver) = commonware_actor::mailbox::new_lossy::< router::Message, >( context.child("router_mailbox"), NZUsize!(10) diff --git a/p2p/src/authenticated/discovery/actors/peer/ingress.rs b/p2p/src/authenticated/discovery/actors/peer/ingress.rs index 5590f4a2b75..c7c279a7b65 100644 --- a/p2p/src/authenticated/discovery/actors/peer/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/peer/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::discovery::types; -use commonware_actor::mailbox::{self, Policy}; +use commonware_actor::mailbox::{self, LossyPolicy}; use commonware_cryptography::PublicKey; use commonware_runtime::Metrics; use std::{collections::VecDeque, fmt, num::NonZeroUsize}; @@ -17,7 +17,7 @@ pub enum Message { Kill, } -impl Policy for Message { +impl LossyPolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { @@ -31,20 +31,23 @@ impl Policy for Message { } } -pub struct Mailbox(mailbox::Sender>); +pub struct Mailbox(mailbox::LossySender>); impl Mailbox { - pub fn new(metrics: impl Metrics, size: NonZeroUsize) -> (Self, mailbox::Receiver>) { - let (sender, receiver) = mailbox::new(metrics, size); + pub fn new( + metrics: impl Metrics, + size: NonZeroUsize, + ) -> (Self, mailbox::LossyReceiver>) { + let (sender, receiver) = mailbox::new_lossy(metrics, size); (Self(sender), receiver) } pub fn bit_vec(&self, bit_vec: types::BitVec) { - let _ = self.0.enqueue_lossy(Message::BitVec(bit_vec)); + let _ = self.0.enqueue(Message::BitVec(bit_vec)); } pub fn peers(&self, peers: Vec>) { - let _ = self.0.enqueue_lossy(Message::Peers(peers)); + let _ = self.0.enqueue(Message::Peers(peers)); } pub fn kill(&self) { diff --git a/p2p/src/authenticated/discovery/actors/router/actor.rs b/p2p/src/authenticated/discovery/actors/router/actor.rs index eb031c87dbb..e1a3b85907b 100644 --- a/p2p/src/authenticated/discovery/actors/router/actor.rs +++ b/p2p/src/authenticated/discovery/actors/router/actor.rs @@ -19,7 +19,7 @@ use tracing::debug; pub struct Actor { context: ContextCell, - control: mailbox::Receiver>, + control: mailbox::LossyReceiver>, connections: BTreeMap>, open_subscriptions: Vec>>, } @@ -30,7 +30,7 @@ impl Actor { pub fn new(context: E, cfg: Config) -> (Self, Mailbox

, Messenger

) { // Create mailbox let (control_sender, control_receiver) = - mailbox::new::>(context.child("mailbox"), cfg.mailbox_size); + mailbox::new_lossy::>(context.child("mailbox"), cfg.mailbox_size); let pool = context.network_buffer_pool().clone(); // Create actor diff --git a/p2p/src/authenticated/discovery/actors/router/ingress.rs b/p2p/src/authenticated/discovery/actors/router/ingress.rs index 34c3ded99eb..93a29125140 100644 --- a/p2p/src/authenticated/discovery/actors/router/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/router/ingress.rs @@ -8,7 +8,7 @@ use crate::{ Channel, Recipients, }; use commonware_actor::{ - mailbox::{self, Policy}, + mailbox::{self, LossyPolicy}, Feedback, Lossy, }; use commonware_cryptography::PublicKey; @@ -39,7 +39,7 @@ pub enum Message { SubscribePeers { sender: ring::Sender> }, } -impl Policy for Message

{ +impl LossyPolicy for Message

{ type Overflow = VecDeque; fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { @@ -54,7 +54,7 @@ impl Policy for Message

{ } /// Mailbox for the router actor. -pub struct Mailbox(mailbox::Sender>); +pub struct Mailbox(mailbox::LossySender>); impl Clone for Mailbox

{ fn clone(&self) -> Self { @@ -70,7 +70,7 @@ impl fmt::Debug for Mailbox

{ impl Mailbox

{ /// Returns a router mailbox around the provided sender. - pub const fn new(sender: mailbox::Sender>) -> Self { + pub const fn new(sender: mailbox::LossySender>) -> Self { Self(sender) } @@ -92,7 +92,10 @@ impl Mailbox

{ /// This may fail during shutdown if the router has already exited, /// which is harmless since the router no longer tracks any peers. pub fn release(&self, peer: P) -> Feedback { - self.0.enqueue(Message::Release { peer }) + match self.0.enqueue(Message::Release { peer }) { + Lossy::Handled(feedback) => feedback, + Lossy::Rejected => unreachable!("router release cannot be rejected"), + } } } @@ -124,7 +127,7 @@ impl Messenger

{ // Build Data and encode Payload::Data once for all recipients let encoded = types::Payload::

::encode_data(&self.pool, channel, message); - self.sender.0.enqueue_lossy(Message::Content { + self.sender.0.enqueue(Message::Content { recipients, encoded, priority, @@ -157,8 +160,10 @@ mod tests { fn test_overflow_rejects_content_but_retains_control() { let executor = deterministic::Runner::default(); executor.start(|context| async move { - let (control_sender, mut receiver) = - mailbox::new::>(context.child("control_mailbox"), NZUsize!(1)); + let (control_sender, mut receiver) = mailbox::new_lossy::>( + context.child("control_mailbox"), + NZUsize!(1), + ); let mailbox = Mailbox::new(control_sender.clone()); let messenger = Messenger::new( context.network_buffer_pool().clone(), diff --git a/p2p/src/authenticated/discovery/actors/spawner/actor.rs b/p2p/src/authenticated/discovery/actors/spawner/actor.rs index deb56732fdd..a8de595474b 100644 --- a/p2p/src/authenticated/discovery/actors/spawner/actor.rs +++ b/p2p/src/authenticated/discovery/actors/spawner/actor.rs @@ -37,7 +37,7 @@ pub struct Actor< peer_gossip_max_count: usize, info_verifier: InfoVerifier, - receiver: mailbox::Receiver>, + receiver: mailbox::LossyReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, diff --git a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs index abbd262ed76..d4bb82d1a13 100644 --- a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::{discovery::actors::tracker::Reservation, Mailbox}; -use commonware_actor::{mailbox::Policy, Feedback, Lossy}; +use commonware_actor::{mailbox::LossyPolicy, Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{Sink, Stream}; use commonware_stream::encrypted::{Receiver, Sender}; @@ -18,7 +18,7 @@ pub enum Message { }, } -impl Policy for Message { +impl LossyPolicy for Message { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -39,7 +39,7 @@ impl Mailbox> { connection: (Sender, Receiver), reservation: Reservation

, ) -> Lossy { - self.0.enqueue_lossy(Message::Spawn { + self.0.enqueue(Message::Spawn { peer: reservation.metadata().public_key().clone(), connection, reservation, diff --git a/p2p/src/authenticated/discovery/actors/tracker/ingress.rs b/p2p/src/authenticated/discovery/actors/tracker/ingress.rs index 4267c28e0ed..ed34fa24da3 100644 --- a/p2p/src/authenticated/discovery/actors/tracker/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/tracker/ingress.rs @@ -143,9 +143,8 @@ pub enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { overflow.push_back(message); - true } } diff --git a/p2p/src/authenticated/discovery/channels.rs b/p2p/src/authenticated/discovery/channels.rs index a62b31f3411..b03524023a9 100644 --- a/p2p/src/authenticated/discovery/channels.rs +++ b/p2p/src/authenticated/discovery/channels.rs @@ -4,7 +4,7 @@ use crate::{ Channel, Message as NetworkMessage, Recipients, }; use commonware_actor::{ - mailbox::{self, Policy}, + mailbox::{self, LossyPolicy}, Feedback, Lossy, }; use commonware_cryptography::PublicKey; @@ -18,7 +18,7 @@ use std::{ pub(crate) struct Inbound(pub(crate) NetworkMessage

); -impl Policy for Inbound

{ +impl LossyPolicy for Inbound

{ type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -110,7 +110,7 @@ where /// Channel to asynchronously receive messages from a channel. pub struct Receiver { - receiver: mailbox::Receiver>, + receiver: mailbox::LossyReceiver>, } impl Debug for Receiver

{ @@ -120,7 +120,7 @@ impl Debug for Receiver

{ } impl Receiver

{ - pub(super) const fn new(receiver: mailbox::Receiver>) -> Self { + pub(super) const fn new(receiver: mailbox::LossyReceiver>) -> Self { Self { receiver } } } @@ -146,7 +146,7 @@ impl crate::Receiver for Receiver

{ pub struct Channels { messenger: Messenger

, max_size: u32, - receivers: BTreeMap>)>, + receivers: BTreeMap>)>, } impl Channels

{ @@ -166,7 +166,7 @@ impl Channels

{ context: C, ) -> (Sender, Receiver

) { let backlog = NonZeroUsize::new(backlog).expect("message backlog must be non-zero"); - let (sender, receiver) = mailbox::new(context.child("mailbox"), backlog); + let (sender, receiver) = mailbox::new_lossy(context.child("mailbox"), backlog); if self.receivers.insert(channel, (rate, sender)).is_some() { panic!("duplicate channel registration: {channel}"); } @@ -182,7 +182,7 @@ impl Channels

{ ) } - pub fn collect(self) -> BTreeMap>)> { + pub fn collect(self) -> BTreeMap>)> { self.receivers } } diff --git a/p2p/src/authenticated/lookup/actors/peer/actor.rs b/p2p/src/authenticated/lookup/actors/peer/actor.rs index 5d36f2a3669..e5bb0c2440d 100644 --- a/p2p/src/authenticated/lookup/actors/peer/actor.rs +++ b/p2p/src/authenticated/lookup/actors/peer/actor.rs @@ -29,8 +29,8 @@ pub struct Actor { send_batch_size: usize, control: ring::Receiver, - high: mailbox::Receiver>, - low: mailbox::Receiver>, + high: mailbox::LossyReceiver>, + low: mailbox::LossyReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, @@ -99,8 +99,8 @@ impl batch_size: usize, batch: &mut Vec, control: &mut ring::Receiver, - high: &mut mailbox::Receiver>, - low: &mut mailbox::Receiver>, + high: &mut mailbox::LossyReceiver>, + low: &mut mailbox::LossyReceiver>, rate_limits: &HashMap, sent_messages: &CounterFamily>, ) -> Result<(), Error> { @@ -127,8 +127,8 @@ impl async fn recv_prioritized( control: &mut ring::Receiver, - high: &mut mailbox::Receiver>, - low: &mut mailbox::Receiver>, + high: &mut mailbox::LossyReceiver>, + low: &mut mailbox::LossyReceiver>, ) -> Prioritized { select! { msg = control.next() => msg.map_or(Prioritized::Closed, Prioritized::Control), @@ -306,8 +306,8 @@ impl // processing of Ping messages, causing the peer connection to // stall and potentially disconnect. let sender = senders.get_mut(&data.channel).unwrap(); - let _ = sender - .enqueue_lossy(channels::Inbound((peer.clone(), data.message))); + let _ = + sender.enqueue(channels::Inbound((peer.clone(), data.message))); } types::Message::Ping => { // We ignore ping messages, they are only used to keep @@ -405,7 +405,7 @@ mod tests { } fn create_channels(context: impl BufferPooler + Metrics) -> Channels { - let (router_sender, _router_receiver) = commonware_actor::mailbox::new::< + let (router_sender, _router_receiver) = commonware_actor::mailbox::new_lossy::< router::Message, >( context.child("router_mailbox"), NZUsize!(10) diff --git a/p2p/src/authenticated/lookup/actors/router/actor.rs b/p2p/src/authenticated/lookup/actors/router/actor.rs index 108bd26913c..389ac872880 100644 --- a/p2p/src/authenticated/lookup/actors/router/actor.rs +++ b/p2p/src/authenticated/lookup/actors/router/actor.rs @@ -19,7 +19,7 @@ use tracing::debug; pub struct Actor { context: ContextCell, - control: mailbox::Receiver>, + control: mailbox::LossyReceiver>, connections: BTreeMap>, open_subscriptions: Vec>>, } @@ -30,7 +30,7 @@ impl Actor { pub fn new(context: E, cfg: Config) -> (Self, Mailbox

, Messenger

) { // Create mailbox let (control_sender, control_receiver) = - mailbox::new::>(context.child("mailbox"), cfg.mailbox_size); + mailbox::new_lossy::>(context.child("mailbox"), cfg.mailbox_size); let pool = context.network_buffer_pool().clone(); // Create actor diff --git a/p2p/src/authenticated/lookup/actors/router/ingress.rs b/p2p/src/authenticated/lookup/actors/router/ingress.rs index 937c73f8532..673e183540a 100644 --- a/p2p/src/authenticated/lookup/actors/router/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/router/ingress.rs @@ -8,7 +8,7 @@ use crate::{ Channel, Recipients, }; use commonware_actor::{ - mailbox::{self, Policy}, + mailbox::{self, LossyPolicy}, Feedback, Lossy, }; use commonware_cryptography::PublicKey; @@ -39,7 +39,7 @@ pub enum Message { SubscribePeers { sender: ring::Sender> }, } -impl Policy for Message

{ +impl LossyPolicy for Message

{ type Overflow = VecDeque; fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { @@ -54,7 +54,7 @@ impl Policy for Message

{ } /// Mailbox for the router actor. -pub struct Mailbox(mailbox::Sender>); +pub struct Mailbox(mailbox::LossySender>); impl Clone for Mailbox

{ fn clone(&self) -> Self { @@ -70,7 +70,7 @@ impl fmt::Debug for Mailbox

{ impl Mailbox

{ /// Returns a router mailbox around the provided sender. - pub const fn new(sender: mailbox::Sender>) -> Self { + pub const fn new(sender: mailbox::LossySender>) -> Self { Self(sender) } @@ -92,7 +92,10 @@ impl Mailbox

{ /// This may fail during shutdown if the router has already exited, /// which is harmless since the router no longer tracks any peers. pub fn release(&self, peer: P) -> Feedback { - self.0.enqueue(Message::Release { peer }) + match self.0.enqueue(Message::Release { peer }) { + Lossy::Handled(feedback) => feedback, + Lossy::Rejected => unreachable!("router release cannot be rejected"), + } } } @@ -124,7 +127,7 @@ impl Messenger

{ // Build Data and encode Message::Data once for all recipients let encoded = types::Message::encode_data(&self.pool, channel, message); - self.sender.0.enqueue_lossy(Message::Content { + self.sender.0.enqueue(Message::Content { recipients, encoded, priority, diff --git a/p2p/src/authenticated/lookup/actors/spawner/actor.rs b/p2p/src/authenticated/lookup/actors/spawner/actor.rs index bba49fe66dd..48635b7f532 100644 --- a/p2p/src/authenticated/lookup/actors/spawner/actor.rs +++ b/p2p/src/authenticated/lookup/actors/spawner/actor.rs @@ -30,7 +30,7 @@ pub struct Actor< send_batch_size: NonZeroUsize, ping_frequency: std::time::Duration, - receiver: mailbox::Receiver>, + receiver: mailbox::LossyReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, diff --git a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs index bba807f1353..500aa8a1cf4 100644 --- a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::{lookup::actors::tracker::Reservation, Mailbox}; -use commonware_actor::{mailbox::Policy, Feedback, Lossy}; +use commonware_actor::{mailbox::LossyPolicy, Feedback, Lossy}; use commonware_cryptography::PublicKey; use commonware_runtime::{Sink, Stream}; use commonware_stream::encrypted::{Receiver, Sender}; @@ -18,7 +18,7 @@ pub enum Message { }, } -impl Policy for Message { +impl LossyPolicy for Message { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -39,7 +39,7 @@ impl Mailbox> { connection: (Sender, Receiver), reservation: Reservation

, ) -> Lossy { - self.0.enqueue_lossy(Message::Spawn { + self.0.enqueue(Message::Spawn { peer: reservation.metadata().public_key().clone(), connection, reservation, diff --git a/p2p/src/authenticated/lookup/actors/tracker/ingress.rs b/p2p/src/authenticated/lookup/actors/tracker/ingress.rs index d1307d6bdfa..16b29b66972 100644 --- a/p2p/src/authenticated/lookup/actors/tracker/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/tracker/ingress.rs @@ -117,9 +117,8 @@ pub enum Message { impl Policy for Message { type Overflow = VecDeque; - fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { + fn handle(overflow: &mut Self::Overflow, message: Self) { overflow.push_back(message); - true } } diff --git a/p2p/src/authenticated/lookup/channels.rs b/p2p/src/authenticated/lookup/channels.rs index 5e4409f7242..b21515d249c 100644 --- a/p2p/src/authenticated/lookup/channels.rs +++ b/p2p/src/authenticated/lookup/channels.rs @@ -5,7 +5,7 @@ use crate::{ Channel, Message as NetworkMessage, Recipients, }; use commonware_actor::{ - mailbox::{self, Policy}, + mailbox::{self, LossyPolicy}, Feedback, Lossy, }; use commonware_cryptography::PublicKey; @@ -19,7 +19,7 @@ use std::{ pub(crate) struct Inbound(pub(crate) NetworkMessage

); -impl Policy for Inbound

{ +impl LossyPolicy for Inbound

{ type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -111,7 +111,7 @@ where /// Channel to asynchronously receive messages from a channel. pub struct Receiver { - receiver: mailbox::Receiver>, + receiver: mailbox::LossyReceiver>, } impl Debug for Receiver

{ @@ -121,7 +121,7 @@ impl Debug for Receiver

{ } impl Receiver

{ - pub(super) const fn new(receiver: mailbox::Receiver>) -> Self { + pub(super) const fn new(receiver: mailbox::LossyReceiver>) -> Self { Self { receiver } } } @@ -147,7 +147,7 @@ impl crate::Receiver for Receiver

{ pub struct Channels { messenger: router::Messenger

, max_size: u32, - receivers: BTreeMap>)>, + receivers: BTreeMap>)>, } impl Channels

{ @@ -167,7 +167,7 @@ impl Channels

{ context: C, ) -> (Sender, Receiver

) { let backlog = NonZeroUsize::new(backlog).expect("message backlog must be non-zero"); - let (sender, receiver) = mailbox::new(context.child("mailbox"), backlog); + let (sender, receiver) = mailbox::new_lossy(context.child("mailbox"), backlog); if self.receivers.insert(channel, (rate, sender)).is_some() { panic!("duplicate channel registration: {channel}"); } @@ -183,7 +183,7 @@ impl Channels

{ ) } - pub fn collect(self) -> BTreeMap>)> { + pub fn collect(self) -> BTreeMap>)> { self.receivers } } diff --git a/p2p/src/authenticated/mailbox.rs b/p2p/src/authenticated/mailbox.rs index c808102b105..952b71c2cc2 100644 --- a/p2p/src/authenticated/mailbox.rs +++ b/p2p/src/authenticated/mailbox.rs @@ -4,17 +4,17 @@ use std::num::NonZeroUsize; /// A mailbox wraps a sender for messages of type `T`. #[derive(Debug)] -pub struct Mailbox(pub(crate) mailbox::Sender); +pub struct Mailbox(pub(crate) mailbox::LossySender); -impl Mailbox { +impl Mailbox { /// Returns a new mailbox with the given sender. - pub fn new(metrics: impl Metrics, size: NonZeroUsize) -> (Self, mailbox::Receiver) { - let (sender, receiver) = mailbox::new(metrics, size); + pub fn new(metrics: impl Metrics, size: NonZeroUsize) -> (Self, mailbox::LossyReceiver) { + let (sender, receiver) = mailbox::new_lossy(metrics, size); (Self(sender), receiver) } } -impl Clone for Mailbox { +impl Clone for Mailbox { fn clone(&self) -> Self { Self(self.0.clone()) } diff --git a/p2p/src/authenticated/relay.rs b/p2p/src/authenticated/relay.rs index 28df25f7971..25fcec36f97 100644 --- a/p2p/src/authenticated/relay.rs +++ b/p2p/src/authenticated/relay.rs @@ -1,5 +1,5 @@ use commonware_actor::{ - mailbox::{self, Policy}, + mailbox::{self, LossyPolicy}, Feedback, Lossy, }; use commonware_macros::select; @@ -14,7 +14,7 @@ impl Message { } } -impl Policy for Message { +impl LossyPolicy for Message { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -23,21 +23,21 @@ impl Policy for Message { } pub(crate) struct Receivers { - pub(crate) low: mailbox::Receiver>, - pub(crate) high: mailbox::Receiver>, + pub(crate) low: mailbox::LossyReceiver>, + pub(crate) high: mailbox::LossyReceiver>, } #[derive(Clone, Debug)] pub struct Relay { - low: mailbox::Sender>, - high: mailbox::Sender>, + low: mailbox::LossySender>, + high: mailbox::LossySender>, } impl Relay { /// Creates a prioritized relay backed by bounded low and high priority mailboxes. pub fn new(metrics: impl Metrics, size: NonZeroUsize) -> (Self, Receivers) { - let (low_sender, low_receiver) = mailbox::new(metrics.child("low"), size); - let (high_sender, high_receiver) = mailbox::new(metrics.child("high"), size); + let (low_sender, low_receiver) = mailbox::new_lossy(metrics.child("low"), size); + let (high_sender, high_receiver) = mailbox::new_lossy(metrics.child("high"), size); ( Self { low: low_sender, @@ -56,7 +56,7 @@ impl Relay { /// and did not handle the message, and [`Feedback::Closed`] means the receiver is gone. pub fn send(&self, message: T, priority: bool) -> Lossy { let sender = if priority { &self.high } else { &self.low }; - sender.enqueue_lossy(Message(message)) + sender.enqueue(Message(message)) } } @@ -71,10 +71,10 @@ pub enum Prioritized { } /// Awaits a message from control, high, or low priority receivers. -pub async fn recv_prioritized( - control: &mut mailbox::Receiver, - high: &mut mailbox::Receiver>, - low: &mut mailbox::Receiver>, +pub async fn recv_prioritized( + control: &mut mailbox::LossyReceiver, + high: &mut mailbox::LossyReceiver>, + low: &mut mailbox::LossyReceiver>, ) -> Prioritized { select! { msg = control.recv() => msg.map_or(Prioritized::Closed, Prioritized::Control), @@ -88,7 +88,7 @@ pub async fn recv_prioritized( } /// Attempts to receive one data message from a relay receiver. -pub(crate) fn try_recv(receiver: &mut mailbox::Receiver>) -> Option { +pub(crate) fn try_recv(receiver: &mut mailbox::LossyReceiver>) -> Option { receiver.try_recv().ok().map(Message::into_inner) } diff --git a/p2p/src/utils/codec.rs b/p2p/src/utils/codec.rs index 2ad67164b40..0dbe234b7fa 100644 --- a/p2p/src/utils/codec.rs +++ b/p2p/src/utils/codec.rs @@ -134,7 +134,7 @@ impl WrappedReceiver { /// messages are dropped (they would likely no longer be useful by the time we get back to them). struct Decoded(P, V); -impl mailbox::Policy for Decoded { +impl mailbox::LossyPolicy for Decoded { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -144,7 +144,7 @@ impl mailbox::Policy for Decoded { /// Receiver half for successfully decoded messages from a [`WrappedBackgroundReceiver`]. pub struct BackgroundReceiver { - receiver: mailbox::Receiver>, + receiver: mailbox::LossyReceiver>, } impl BackgroundReceiver { @@ -169,7 +169,7 @@ where receiver: R, codec_config: V::Cfg, blocker: B, - sender: mailbox::Sender>, + sender: mailbox::LossySender>, max_concurrency: usize, } @@ -194,7 +194,7 @@ where channel_capacity: NonZeroUsize, strategy: &impl Strategy, ) -> (Self, BackgroundReceiver) { - let (tx, rx) = mailbox::new(context.child("mailbox"), channel_capacity); + let (tx, rx) = mailbox::new_lossy(context.child("mailbox"), channel_capacity); ( Self { context: ContextCell::new(context), @@ -272,13 +272,13 @@ where fn handle_decode_result( blocker: &mut B, - sender: &mut mailbox::Sender>, + sender: &mut mailbox::LossySender>, result: (P, Result), ) { let (peer, decode_result) = result; match decode_result { Ok(value) => { - let _ = sender.enqueue_lossy(Decoded(peer, value)); + let _ = sender.enqueue(Decoded(peer, value)); } Err(err) => { crate::block!(blocker, peer, ?err, "received invalid message"); diff --git a/resolver/src/p2p/ingress.rs b/resolver/src/p2p/ingress.rs index 5c0485d97b2..50e52b614b2 100644 --- a/resolver/src/p2p/ingress.rs +++ b/resolver/src/p2p/ingress.rs @@ -135,7 +135,7 @@ where { type Overflow = Pending; - fn handle(overflow: &mut Pending, message: Self) -> bool { + fn handle(overflow: &mut Pending, message: Self) { match message { Self::Fetch(keys) => { for key in keys { @@ -171,7 +171,6 @@ where overflow.modifications.push_back(predicate); } } - true } } From 99c18910e7a0b61db47de12b92af6592206313ca Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 11:59:16 -0700 Subject: [PATCH 03/13] use unreliable --- actor/src/benches/mailbox.rs | 68 ++- actor/src/lib.rs | 30 +- actor/src/mailbox.rs | 482 ++++++++++++------ collector/fuzz/fuzz_targets/collector.rs | 6 +- collector/src/p2p/mocks/sender.rs | 6 +- .../discovery/actors/peer/actor.rs | 14 +- .../discovery/actors/peer/ingress.rs | 10 +- .../discovery/actors/router/actor.rs | 4 +- .../discovery/actors/router/ingress.rs | 22 +- .../discovery/actors/spawner/actor.rs | 2 +- .../discovery/actors/spawner/ingress.rs | 13 +- p2p/src/authenticated/discovery/channels.rs | 18 +- p2p/src/authenticated/discovery/mod.rs | 8 +- .../authenticated/lookup/actors/peer/actor.rs | 14 +- .../lookup/actors/router/actor.rs | 4 +- .../lookup/actors/router/ingress.rs | 16 +- .../lookup/actors/spawner/actor.rs | 2 +- .../lookup/actors/spawner/ingress.rs | 13 +- p2p/src/authenticated/lookup/channels.rs | 18 +- p2p/src/authenticated/lookup/mod.rs | 8 +- p2p/src/authenticated/mailbox.rs | 13 +- p2p/src/authenticated/relay.rs | 40 +- p2p/src/lib.rs | 10 +- p2p/src/simulated/network.rs | 14 +- p2p/src/utils/codec.rs | 14 +- p2p/src/utils/limited.rs | 18 +- p2p/src/utils/mocks/mod.rs | 10 +- p2p/src/utils/mux.rs | 12 +- resolver/src/p2p/fetcher.rs | 18 +- 29 files changed, 568 insertions(+), 339 deletions(-) diff --git a/actor/src/benches/mailbox.rs b/actor/src/benches/mailbox.rs index 7bb49ef50f8..caa0c5f6028 100644 --- a/actor/src/benches/mailbox.rs +++ b/actor/src/benches/mailbox.rs @@ -1,4 +1,4 @@ -use commonware_actor::{mailbox, Feedback, Lossy}; +use commonware_actor::{mailbox, Feedback, Unreliable}; use commonware_runtime::{ telemetry::metrics::{Metric, Registered, Registration}, Metrics, Name, Supervisor, @@ -51,10 +51,10 @@ impl Metrics for NoopMetrics { } } -fn new( +fn new( capacity: std::num::NonZeroUsize, -) -> (mailbox::LossySender, mailbox::LossyReceiver) { - mailbox::new_lossy(NoopMetrics, capacity) +) -> (mailbox::UnreliableSender, mailbox::UnreliableReceiver) { + mailbox::new_unreliable(NoopMetrics, capacity) } #[derive(Clone, Copy, Debug, PartialEq, Eq)] @@ -89,7 +89,7 @@ impl Message { } } -impl mailbox::LossyPolicy for Message { +impl mailbox::UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -125,7 +125,7 @@ fn bench_enqueue_ready(c: &mut Criterion) { |(sender, _receiver)| { for _ in 0..MESSAGES { let result = sender.enqueue(black_box(Message::drop())); - assert_eq!(result, Feedback::Ok); + assert_eq!(result, Unreliable::new(Feedback::Ok)); black_box(result); } }, @@ -145,7 +145,10 @@ fn bench_try_recv_ready(c: &mut Criterion) { || { let (sender, receiver) = new::(NZUsize!(CAPACITY)); for _ in 0..MESSAGES { - assert_eq!(sender.enqueue(Message::drop()), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::drop()), + Unreliable::new(Feedback::Ok) + ); } receiver }, @@ -170,10 +173,16 @@ fn bench_try_recv_overflow(c: &mut Criterion) { || { let (sender, receiver) = new::(NZUsize!(CAPACITY)); for _ in 0..CAPACITY { - assert_eq!(sender.enqueue(Message::drop()), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::drop()), + Unreliable::new(Feedback::Ok) + ); } for _ in 0..MESSAGES { - assert_eq!(sender.enqueue(Message::spill()), Feedback::Backoff); + assert_eq!( + sender.enqueue(Message::spill()), + Unreliable::new(Feedback::Backoff) + ); } receiver }, @@ -199,7 +208,7 @@ fn bench_round_trip_ready(c: &mut Criterion) { |(sender, mut receiver)| { for _ in 0..MESSAGES { let result = sender.enqueue(black_box(Message::drop())); - assert_eq!(result, Feedback::Ok); + assert_eq!(result, Unreliable::new(Feedback::Ok)); black_box(result); black_box(receiver.try_recv().unwrap()); } @@ -231,7 +240,7 @@ fn bench_recv_waiting(c: &mut Criterion) { .await; let result = sender.enqueue(Message::drop()); - assert_eq!(result, Feedback::Ok); + assert_eq!(result, Unreliable::new(Feedback::Ok)); black_box(result); black_box(next.await.unwrap()); } @@ -252,13 +261,16 @@ fn bench_overflow_drop(c: &mut Criterion) { b.iter_batched( || { let (sender, receiver) = new::(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::drop()), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::drop()), + Unreliable::new(Feedback::Ok) + ); (sender, receiver) }, |(sender, _receiver)| { for _ in 0..MESSAGES { let result = sender.enqueue(black_box(Message::drop())); - assert_eq!(result, Lossy::Rejected); + assert_eq!(result, Unreliable::Rejected); black_box(result); } }, @@ -277,13 +289,16 @@ fn bench_overflow_spill(c: &mut Criterion) { b.iter_batched( || { let (sender, receiver) = new::(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::drop()), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::drop()), + Unreliable::new(Feedback::Ok) + ); (sender, receiver) }, |(sender, _receiver)| { for _ in 0..MESSAGES { let result = sender.enqueue(black_box(Message::spill())); - assert_eq!(result, Feedback::Backoff); + assert_eq!(result, Unreliable::new(Feedback::Backoff)); black_box(result); } }, @@ -297,19 +312,28 @@ fn bench_overflow_spill(c: &mut Criterion) { fn replace_queue( newest: bool, ) -> ( - mailbox::LossySender, - mailbox::LossyReceiver, + mailbox::UnreliableSender, + mailbox::UnreliableReceiver, ) { let (sender, receiver) = new::(NZUsize!(REPLACE_CAPACITY)); for _ in 0..REPLACE_CAPACITY { - assert_eq!(sender.enqueue(Message::drop()), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::drop()), + Unreliable::new(Feedback::Ok) + ); } - assert_eq!(sender.enqueue(Message::replace()), Feedback::Backoff); + assert_eq!( + sender.enqueue(Message::replace()), + Unreliable::new(Feedback::Backoff) + ); if !newest { for _ in 1..REPLACE_CAPACITY { - assert_eq!(sender.enqueue(Message::spill()), Feedback::Backoff); + assert_eq!( + sender.enqueue(Message::spill()), + Unreliable::new(Feedback::Backoff) + ); } } @@ -329,7 +353,7 @@ fn bench_overflow_replace(c: &mut Criterion) { |(sender, _receiver)| { for _ in 0..MESSAGES { let result = sender.enqueue(black_box(Message::replace())); - assert_eq!(result, Feedback::Backoff); + assert_eq!(result, Unreliable::new(Feedback::Backoff)); black_box(result); } }, @@ -357,7 +381,7 @@ fn bench_concurrent_enqueue(c: &mut Criterion) { scope.spawn(move || { for _ in 0..PRODUCER_MESSAGES { let result = sender.enqueue(Message::drop()); - assert_eq!(result, Feedback::Ok); + assert_eq!(result, Unreliable::new(Feedback::Ok)); black_box(result); } }); diff --git a/actor/src/lib.rs b/actor/src/lib.rs index 366c2e43907..ecd3d31b0e3 100644 --- a/actor/src/lib.rs +++ b/actor/src/lib.rs @@ -28,19 +28,19 @@ commonware_macros::stability_scope!(BETA { } } - /// Feedback from endpoints that may drop work under backpressure. + /// Feedback from endpoints that may reject work under backpressure. #[derive(Clone, Copy, Debug, PartialEq, Eq)] - pub enum Lossy { - /// The work was handled by the endpoint. - Handled(T), + pub enum Unreliable { + /// Feedback returned by the endpoint. + Feedback(T), /// The work was rejected by the endpoint. Rejected, } - impl Lossy { - /// Create handled feedback for an endpoint that may reject live work. + impl Unreliable { + /// Wrap endpoint feedback for an endpoint that may reject work. pub const fn new(feedback: Feedback) -> Self { - Self::Handled(feedback) + Self::Feedback(feedback) } /// Create rejected feedback. @@ -51,29 +51,17 @@ commonware_macros::stability_scope!(BETA { /// Returns `true` when the endpoint handled the submission. pub const fn accepted(self) -> bool { match self { - Self::Handled(feedback) => feedback.accepted(), + Self::Feedback(feedback) => feedback.accepted(), Self::Rejected => false, } } } - impl From for Lossy { + impl From for Unreliable { fn from(feedback: Feedback) -> Self { Self::new(feedback) } } - impl PartialEq for Lossy { - fn eq(&self, other: &Feedback) -> bool { - matches!(self, Self::Handled(feedback) if feedback == other) - } - } - - impl PartialEq> for Feedback { - fn eq(&self, other: &Lossy) -> bool { - other == self - } - } - pub mod mailbox; }); diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index cdc5736fdd6..8a75ba866bd 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -5,7 +5,8 @@ //! The mailbox is split into two queues: a bounded `ready` queue //! that producers push to and the receiver pops from, and an unbounded //! `overflow` queue that holds messages displaced when ready is full. A -//! [`Policy`] decides how overflow is updated when overflow is contended. +//! [`Policy`] or [`UnreliablePolicy`] decides how overflow is updated when +//! overflow is contended. //! //! ```text //! senders @@ -39,7 +40,7 @@ //! Enqueue calls from the same sender will be delivered in order. Concurrent enqueue calls, //! however, are not globally ordered and may be observed in any interleaving. -use crate::{Feedback, Lossy}; +use crate::{Feedback, Unreliable}; use commonware_runtime::{ telemetry::metrics::{Counter, MetricsExt as _}, Metrics, @@ -111,7 +112,7 @@ pub trait Policy: Sized { } /// Overflow behavior for actor messages that can be rejected when an inbox is full. -pub trait LossyPolicy: Sized { +pub trait UnreliablePolicy: Sized { /// Overflow storage used by this policy. type Overflow: Overflow; @@ -122,8 +123,8 @@ pub trait LossyPolicy: Sized { /// doing no work because the message is already satisfied, superseded, or no longer needed. /// /// Returns `false` only when the policy rejects the message under backpressure. This is the - /// lossy case: the submitted work was not semantically handled, and callers that care should - /// retry or treat the submission as failed. + /// unreliable case: the submitted work was not semantically handled, and callers that care + /// should retry or treat the submission as failed. /// /// # Warning /// @@ -137,9 +138,9 @@ pub trait LossyPolicy: Sized { fn handle(overflow: &mut Self::Overflow, message: Self) -> bool; } -struct Infallible; +struct ReliableMode; -struct LossyMode; +struct UnreliableMode; trait MailboxMode: Sized { type Overflow: Overflow; @@ -152,7 +153,7 @@ trait MailboxMode: Sized { fn is_closed(feedback: &Self::Feedback) -> bool; } -impl MailboxMode for Infallible { +impl MailboxMode for ReliableMode { type Overflow = T::Overflow; type Feedback = Feedback; @@ -178,32 +179,32 @@ impl MailboxMode for Infallible { } } -impl MailboxMode for LossyMode { +impl MailboxMode for UnreliableMode { type Overflow = T::Overflow; - type Feedback = Lossy; + type Feedback = Unreliable; fn handle(overflow: &mut Self::Overflow, message: T) -> bool { T::handle(overflow, message) } fn ready_feedback(feedback: Feedback) -> Self::Feedback { - Lossy::new(feedback) + Unreliable::new(feedback) } fn overflow_feedback(handled: bool) -> Self::Feedback { if handled { - Lossy::new(Feedback::Backoff) + Unreliable::new(Feedback::Backoff) } else { - Lossy::Rejected + Unreliable::Rejected } } fn is_backoff(feedback: &Self::Feedback) -> bool { - *feedback == Feedback::Backoff + *feedback == Unreliable::new(Feedback::Backoff) } fn is_closed(feedback: &Self::Feedback) -> bool { - *feedback == Feedback::Closed + *feedback == Unreliable::new(Feedback::Closed) } } @@ -575,12 +576,12 @@ impl> State { /// Sender half of a mailbox. pub struct Sender { - state: Arc>, + state: Arc>, } -/// Sender half of a lossy mailbox. -pub struct LossySender { - state: Arc>, +/// Sender half of an unreliable mailbox. +pub struct UnreliableSender { + state: Arc>, } impl Clone for Sender { @@ -593,7 +594,7 @@ impl Clone for Sender { } } -impl Clone for LossySender { +impl Clone for UnreliableSender { fn clone(&self) -> Self { // Live sender count drives receiver disconnect detection. self.state.senders.fetch_add(1, Ordering::Relaxed); @@ -614,7 +615,7 @@ impl Drop for Sender { } } -impl Drop for LossySender { +impl Drop for UnreliableSender { fn drop(&mut self) { let previous = self.state.senders.fetch_sub(1, Ordering::AcqRel); assert!(previous > 0); @@ -634,9 +635,9 @@ impl fmt::Debug for Sender { } } -impl fmt::Debug for LossySender { +impl fmt::Debug for UnreliableSender { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("LossySender") + f.debug_struct("UnreliableSender") .field("capacity", &self.state.ready.capacity()) .field("closed", &self.state.closed.load(Ordering::Acquire)) .finish() @@ -651,10 +652,10 @@ impl Sender { } } -impl LossySender { +impl UnreliableSender { /// Submit a message without waiting for inbox capacity, allowing policy rejection. #[must_use = "caller must handle enqueue feedback"] - pub fn enqueue(&self, message: T) -> Lossy { + pub fn enqueue(&self, message: T) -> Unreliable { self.state.enqueue(message) } } @@ -666,17 +667,17 @@ impl LossySender { /// Dropping the last sender disconnects the mailbox, but the receiver continues /// returning buffered messages until ready and overflow are empty. pub struct Receiver { - state: Arc>, + state: Arc>, } -/// Receiver half of a lossy mailbox. +/// Receiver half of an unreliable mailbox. /// /// Dropping the receiver closes the mailbox and drains buffered messages. /// /// Dropping the last sender disconnects the mailbox, but the receiver continues /// returning buffered messages until ready and overflow are empty. -pub struct LossyReceiver { - state: Arc>, +pub struct UnreliableReceiver { + state: Arc>, } impl Receiver { @@ -711,7 +712,7 @@ impl Receiver { } } -impl LossyReceiver { +impl UnreliableReceiver { fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll> { self.state.poll_recv(cx) } @@ -749,7 +750,7 @@ impl Drop for Receiver { } } -impl Drop for LossyReceiver { +impl Drop for UnreliableReceiver { fn drop(&mut self) { self.state.close(); } @@ -773,11 +774,11 @@ pub fn new(metrics: impl Metrics, capacity: NonZeroUsize) -> (Sender< ) } -/// Create a new bounded lossy mailbox. -pub fn new_lossy( +/// Create a new bounded unreliable mailbox. +pub fn new_unreliable( metrics: impl Metrics, capacity: NonZeroUsize, -) -> (LossySender, LossyReceiver) { +) -> (UnreliableSender, UnreliableReceiver) { let state = Arc::new(State { ready: Ready::new(capacity.get()), overflow: OverflowState::new(), @@ -787,10 +788,10 @@ pub fn new_lossy( waker: AtomicWaker::new(), }); ( - LossySender { + UnreliableSender { state: state.clone(), }, - LossyReceiver { state }, + UnreliableReceiver { state }, ) } @@ -856,8 +857,10 @@ mod tests { super::new(mocks::Metrics, capacity) } - fn new_lossy(capacity: NonZeroUsize) -> (LossySender, LossyReceiver) { - super::new_lossy(mocks::Metrics, capacity) + fn new_unreliable( + capacity: NonZeroUsize, + ) -> (UnreliableSender, UnreliableReceiver) { + super::new_unreliable(mocks::Metrics, capacity) } #[derive(Debug, PartialEq, Eq)] @@ -869,7 +872,7 @@ mod tests { Hint(u64), } - impl LossyPolicy for Message { + impl UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -956,10 +959,19 @@ mod tests { #[test_async] async fn full_inbox_replaces_stale_overflow_message() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Update(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Update(3)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Update(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Update(2)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Update(3)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Update(1))); assert_eq!(receiver.recv().await, Some(Message::Update(3))); @@ -967,11 +979,23 @@ mod tests { #[test_async] async fn policy_can_replace_stale_overflow_at_back() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Required(3)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Update(4)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Update(2)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Required(3)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Update(4)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); assert_eq!(receiver.recv().await, Some(Message::Required(3))); @@ -980,18 +1004,27 @@ mod tests { #[test_async] async fn full_inbox_rejects_non_replaceable_message() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Vote(2)), Lossy::Rejected); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!(sender.enqueue(Message::Vote(2)), Unreliable::Rejected); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); } #[test_async] async fn full_inbox_retains_required_message() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Buffered(2)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); assert_eq!(receiver.recv().await, Some(Message::Buffered(2))); @@ -999,9 +1032,15 @@ mod tests { #[test] fn try_recv_refills_from_overflow() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Buffered(2)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.try_recv(), Ok(Message::Vote(1))); assert_eq!(receiver.try_recv(), Ok(Message::Buffered(2))); @@ -1011,10 +1050,19 @@ mod tests { fn backoff_metric_counts_backoff_feedback() { let executor = deterministic::Runner::default(); executor.start(|context| async move { - let (sender, _receiver) = super::new_lossy(context.child("mailbox"), NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Buffered(3)), Feedback::Backoff); + let (sender, _receiver) = super::new_unreliable(context.child("mailbox"), NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Buffered(2)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Buffered(3)), + Unreliable::new(Feedback::Backoff) + ); let buffer = context.encode(); assert!( @@ -1025,14 +1073,17 @@ mod tests { } #[test] - fn lossy_rejected_feedback_is_not_accepted_or_counted_as_backoff() { + fn unreliable_rejected_feedback_is_not_accepted_or_counted_as_backoff() { let executor = deterministic::Runner::default(); executor.start(|context| async move { - let (sender, _receiver) = super::new_lossy(context.child("mailbox"), NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); + let (sender, _receiver) = super::new_unreliable(context.child("mailbox"), NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); let feedback = sender.enqueue(Message::Vote(2)); - assert_eq!(feedback, Lossy::Rejected); + assert_eq!(feedback, Unreliable::Rejected); assert!(!feedback.accepted()); let buffer = context.encode(); @@ -1045,9 +1096,15 @@ mod tests { #[test] fn try_recv_drains_buffered_messages_after_senders_drop() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Buffered(2)), + Unreliable::new(Feedback::Backoff) + ); drop(sender); assert_eq!(receiver.try_recv(), Ok(Message::Vote(1))); @@ -1057,13 +1114,19 @@ mod tests { #[test] fn poll_recv_drains_buffered_messages_after_senders_drop() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Buffered(2)), + Unreliable::new(Feedback::Backoff) + ); drop(sender); assert_eq!( @@ -1079,31 +1142,58 @@ mod tests { #[test] fn enqueue_uses_ready_capacity_after_partial_drain() { - let (sender, mut receiver) = new_lossy(NZUsize!(2)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Vote(2)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Required(3)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(2)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Vote(2)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Required(3)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.try_recv(), Ok(Message::Vote(1))); assert_eq!(receiver.try_recv(), Ok(Message::Vote(2))); - assert_eq!(sender.enqueue(Message::Vote(4)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Vote(4)), + Unreliable::new(Feedback::Ok) + ); assert_eq!(receiver.try_recv(), Ok(Message::Required(3))); assert_eq!(receiver.try_recv(), Ok(Message::Vote(4))); } #[test] fn receiver_refills_overflow_after_partial_drain() { - let (sender, mut receiver) = new_lossy(NZUsize!(3)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Vote(2)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Vote(3)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Required(4)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(3)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Vote(2)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Vote(3)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Required(4)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.try_recv(), Ok(Message::Vote(1))); assert_eq!(receiver.try_recv(), Ok(Message::Vote(2))); - assert_eq!(sender.enqueue(Message::Vote(5)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Vote(5)), + Unreliable::new(Feedback::Ok) + ); assert_eq!(receiver.try_recv(), Ok(Message::Vote(3))); assert_eq!(receiver.try_recv(), Ok(Message::Required(4))); assert_eq!(receiver.try_recv(), Ok(Message::Vote(5))); @@ -1111,9 +1201,15 @@ mod tests { #[test_async] async fn full_inbox_retains_unmatched_replaceable_message() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Required(2)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Required(2)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); assert_eq!(receiver.recv().await, Some(Message::Required(2))); @@ -1121,11 +1217,23 @@ mod tests { #[test_async] async fn full_inbox_replaces_stale_overflow_after_ready_fills() { - let (sender, mut receiver) = new_lossy(NZUsize!(2)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Update(3)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Update(4)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(2)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Update(2)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Update(3)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Update(4)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); assert_eq!(receiver.recv().await, Some(Message::Update(2))); @@ -1134,10 +1242,19 @@ mod tests { #[test_async] async fn mailbox_capacity_is_soft_limit_for_required_messages() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Required(2)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Required(3)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Required(2)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Required(3)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); assert_eq!(receiver.recv().await, Some(Message::Required(2))); @@ -1146,19 +1263,34 @@ mod tests { #[test_async] async fn full_inbox_rejects_hint() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Hint(2)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Hint(2)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); } #[test_async] async fn full_inbox_can_replace_or_drop_by_message() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Update(2)), Feedback::Backoff); - assert_eq!(sender.enqueue(Message::Hint(3)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Update(2)), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + sender.enqueue(Message::Hint(3)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.recv().await, Some(Message::Vote(1))); assert_eq!(receiver.recv().await, Some(Message::Hint(3))); @@ -1166,19 +1298,22 @@ mod tests { #[test_async] async fn empty_inbox_wakes_on_enqueue() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); let next = receiver.recv(); pin_mut!(next); assert!(next.as_mut().now_or_never().is_none()); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Ok) + ); assert_eq!(next.await, Some(Message::Vote(1))); } #[test] fn pending_recv_wakes_when_senders_drop() { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -1194,7 +1329,7 @@ mod tests { #[test] fn pending_recv_wakes_on_handled_overflow_enqueue() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -1204,7 +1339,10 @@ mod tests { // Prime ready directly to isolate the overflow wake after registration. assert_eq!(sender.state.ready.push(Message::Vote(1)), Ok(())); - assert_eq!(sender.enqueue(Message::Buffered(2)), Feedback::Backoff); + assert_eq!( + sender.enqueue(Message::Buffered(2)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(wakes.count(), 1); assert_eq!(receiver.try_recv(), Ok(Message::Vote(1))); @@ -1213,7 +1351,7 @@ mod tests { #[test] fn receiver_drop_blocks_ready_fast_path_feedback() { - let (sender, mut receiver) = new_lossy(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -1221,13 +1359,16 @@ mod tests { assert_eq!(receiver.poll_recv(&mut cx), Poll::Pending); drop(receiver); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Closed); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Closed) + ); assert_eq!(wakes.count(), 0); } #[test_async] async fn empty_inbox_closes_when_senders_drop() { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); drop(sender); assert_eq!(receiver.try_recv(), Err(TryRecvError::Disconnected)); @@ -1236,10 +1377,13 @@ mod tests { #[test] fn enqueue_after_receiver_drop_returns_closed() { - let (sender, receiver) = new_lossy(NZUsize!(1)); + let (sender, receiver) = new_unreliable(NZUsize!(1)); drop(receiver); - assert_eq!(sender.enqueue(Message::Vote(1)), Feedback::Closed); + assert_eq!( + sender.enqueue(Message::Vote(1)), + Unreliable::new(Feedback::Closed) + ); } #[test_async] @@ -1346,8 +1490,10 @@ mod loom_tests { super::new(mocks::Metrics, capacity) } - fn new_lossy(capacity: NonZeroUsize) -> (LossySender, LossyReceiver) { - super::new_lossy(mocks::Metrics, capacity) + fn new_unreliable( + capacity: NonZeroUsize, + ) -> (UnreliableSender, UnreliableReceiver) { + super::new_unreliable(mocks::Metrics, capacity) } #[derive(Clone, Copy, Debug, PartialEq, Eq)] @@ -1395,7 +1541,7 @@ mod loom_tests { } } - impl LossyPolicy for Message { + impl UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -1427,7 +1573,7 @@ mod loom_tests { } } - impl LossyPolicy for ReplacingMessage { + impl UnreliablePolicy for ReplacingMessage { type Overflow = VecDeque; fn handle(overflow: &mut VecDeque, message: Self) -> bool { @@ -1534,7 +1680,7 @@ mod loom_tests { #[test] fn sender_drop_racing_waker_registration_wakes_or_disconnects() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1560,13 +1706,16 @@ mod loom_tests { #[test] fn sender_enqueue_then_drop_racing_poll_recv_drains_message() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); let enqueue = thread::spawn(move || { - assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Spill(0)), + Unreliable::new(Feedback::Ok) + ); }); let poll = receiver.poll_recv(&mut cx); @@ -1592,10 +1741,13 @@ mod loom_tests { #[test] fn sender_enqueue_then_drop_racing_try_recv_drains_message() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let enqueue = thread::spawn(move || { - assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Spill(0)), + Unreliable::new(Feedback::Ok) + ); }); let result = receiver.try_recv(); @@ -1619,7 +1771,7 @@ mod loom_tests { #[test] fn handled_enqueue_wakes_registered_receiver() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1627,7 +1779,10 @@ mod loom_tests { let next = receiver.recv(); pin_mut!(next); assert!(matches!(next.as_mut().poll(&mut cx), Poll::Pending)); - assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Spill(0)), + Unreliable::new(Feedback::Ok) + ); assert_eq!(wakes.load(Ordering::Acquire), 1); assert_eq!( @@ -1640,7 +1795,7 @@ mod loom_tests { #[test] fn receiver_drop_racing_ready_fast_path_feedback_wakes_if_ready() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1656,9 +1811,12 @@ mod loom_tests { if feedback.accepted() { assert!(wakes.load(Ordering::Acquire) > 0); } else { - assert_eq!(feedback, Feedback::Closed); + assert_eq!(feedback, Unreliable::new(Feedback::Closed)); } - assert_eq!(sender.enqueue(Message::Spill(1)), Feedback::Closed); + assert_eq!( + sender.enqueue(Message::Spill(1)), + Unreliable::new(Feedback::Closed) + ); }); } @@ -1792,7 +1950,7 @@ mod loom_tests { #[test] fn concurrent_close_and_ready_enqueue_remains_closed() { loom::model(|| { - let (sender, receiver) = new_lossy::(NZUsize!(1)); + let (sender, receiver) = new_unreliable::(NZUsize!(1)); let enqueue_sender = sender.clone(); let enqueue = thread::spawn(move || { @@ -1805,15 +1963,21 @@ mod loom_tests { enqueue.join().unwrap(); close.join().unwrap(); - assert_eq!(sender.enqueue(Message::Spill(2)), Feedback::Closed); + assert_eq!( + sender.enqueue(Message::Spill(2)), + Unreliable::new(Feedback::Closed) + ); }); } #[test] fn concurrent_close_and_overflow_enqueue_remains_closed() { loom::model(|| { - let (sender, receiver) = new_lossy::(NZUsize!(1)); - assert_eq!(sender.enqueue(Message::Drop(0)), Feedback::Ok); + let (sender, receiver) = new_unreliable::(NZUsize!(1)); + assert_eq!( + sender.enqueue(Message::Drop(0)), + Unreliable::new(Feedback::Ok) + ); let enqueue_sender = sender.clone(); let enqueue = thread::spawn(move || { @@ -1826,16 +1990,22 @@ mod loom_tests { enqueue.join().unwrap(); close.join().unwrap(); - assert_eq!(sender.enqueue(Message::Spill(2)), Feedback::Closed); + assert_eq!( + sender.enqueue(Message::Spill(2)), + Unreliable::new(Feedback::Closed) + ); }); } #[test] fn concurrent_spill_and_refill_preserves_messages() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let idle_sender = sender.clone(); - assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Spill(0)), + Unreliable::new(Feedback::Ok) + ); let seen = Arc::new(AtomicUsize::new(0)); let enqueue = thread::spawn(move || { @@ -1866,9 +2036,12 @@ mod loom_tests { #[test] fn concurrent_spill_senders_preserve_messages() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let idle_sender = sender.clone(); - assert_eq!(sender.enqueue(Message::Spill(0)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Spill(0)), + Unreliable::new(Feedback::Ok) + ); let sender_1 = sender.clone(); let enqueue_1 = thread::spawn(move || sender_1.enqueue(Message::Spill(1))); @@ -1891,20 +2064,29 @@ mod loom_tests { #[test] fn concurrent_replace_keeps_one_overflow_message() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(1)); + let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); let idle_sender = sender.clone(); - assert_eq!(sender.enqueue(ReplacingMessage::FillReady), Feedback::Ok); + assert_eq!( + sender.enqueue(ReplacingMessage::FillReady), + Unreliable::new(Feedback::Ok) + ); assert_eq!( sender.enqueue(ReplacingMessage::Replace(1)), - Feedback::Backoff + Unreliable::new(Feedback::Backoff) ); let sender_1 = sender.clone(); let replace_1 = thread::spawn(move || sender_1.enqueue(ReplacingMessage::Replace(2))); let replace_2 = thread::spawn(move || sender.enqueue(ReplacingMessage::Replace(3))); - assert_eq!(replace_1.join().unwrap(), Feedback::Backoff); - assert_eq!(replace_2.join().unwrap(), Feedback::Backoff); + assert_eq!( + replace_1.join().unwrap(), + Unreliable::new(Feedback::Backoff) + ); + assert_eq!( + replace_2.join().unwrap(), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.try_recv(), Ok(ReplacingMessage::FillReady)); let retained = replacement_value(receiver.try_recv().unwrap()).unwrap(); @@ -1917,15 +2099,27 @@ mod loom_tests { #[test] fn stale_overflow_hint_retries_ready_before_policy() { loom::model(|| { - let (sender, mut receiver) = new_lossy::(NZUsize!(2)); - assert_eq!(sender.enqueue(Message::Drop(0)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Drop(1)), Feedback::Ok); - assert_eq!(sender.enqueue(Message::Spill(2)), Feedback::Backoff); + let (sender, mut receiver) = new_unreliable::(NZUsize!(2)); + assert_eq!( + sender.enqueue(Message::Drop(0)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Drop(1)), + Unreliable::new(Feedback::Ok) + ); + assert_eq!( + sender.enqueue(Message::Spill(2)), + Unreliable::new(Feedback::Backoff) + ); assert_eq!(receiver.try_recv(), Ok(Message::Drop(0))); assert_eq!(receiver.try_recv(), Ok(Message::Drop(1))); - assert_eq!(sender.enqueue(Message::Drop(3)), Feedback::Ok); + assert_eq!( + sender.enqueue(Message::Drop(3)), + Unreliable::new(Feedback::Ok) + ); assert_eq!(receiver.try_recv(), Ok(Message::Spill(2))); assert_eq!(receiver.try_recv(), Ok(Message::Drop(3))); }); diff --git a/collector/fuzz/fuzz_targets/collector.rs b/collector/fuzz/fuzz_targets/collector.rs index cf5648b4832..3f5ab2d997c 100644 --- a/collector/fuzz/fuzz_targets/collector.rs +++ b/collector/fuzz/fuzz_targets/collector.rs @@ -1,7 +1,7 @@ #![no_main] use arbitrary::Arbitrary; -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_codec::{ Encode, EncodeSize, Error as CodecError, FixedSize, RangeCfg, Read, ReadExt, ReadRangeExt, Write, @@ -231,8 +231,8 @@ impl CheckedSender for MockCheckedSender { Vec::new() } - fn send(self, _message: impl Into + Send, _priority: bool) -> Lossy { - Lossy::new(Feedback::Ok) + fn send(self, _message: impl Into + Send, _priority: bool) -> Unreliable { + Unreliable::new(Feedback::Ok) } } diff --git a/collector/src/p2p/mocks/sender.rs b/collector/src/p2p/mocks/sender.rs index 55bef1e2c54..5972619b7ee 100644 --- a/collector/src/p2p/mocks/sender.rs +++ b/collector/src/p2p/mocks/sender.rs @@ -1,6 +1,6 @@ //! Mock sender implementations for testing. -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_p2p::{CheckedSender, LimitedSender, Recipients}; use commonware_runtime::IoBufs; @@ -43,7 +43,7 @@ impl CheckedSender for CheckedFailing

{ Vec::new() } - fn send(self, _message: impl Into + Send, _priority: bool) -> Lossy { - Lossy::new(Feedback::Closed) + fn send(self, _message: impl Into + Send, _priority: bool) -> Unreliable { + Unreliable::new(Feedback::Closed) } } diff --git a/p2p/src/authenticated/discovery/actors/peer/actor.rs b/p2p/src/authenticated/discovery/actors/peer/actor.rs index ee9e2fa306d..594d553ff1f 100644 --- a/p2p/src/authenticated/discovery/actors/peer/actor.rs +++ b/p2p/src/authenticated/discovery/actors/peer/actor.rs @@ -34,9 +34,9 @@ pub struct Actor { max_peers: usize, mailbox: Mailbox, - control: mailbox::LossyReceiver>, - high: mailbox::LossyReceiver>, - low: mailbox::LossyReceiver>, + control: mailbox::UnreliableReceiver>, + high: mailbox::UnreliableReceiver>, + low: mailbox::UnreliableReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, @@ -124,10 +124,10 @@ impl peer: &C, batch_size: usize, batch: &mut Vec, - control: &mut mailbox::LossyReceiver>, + control: &mut mailbox::UnreliableReceiver>, pool: &commonware_runtime::BufferPool, - high: &mut mailbox::LossyReceiver>, - low: &mut mailbox::LossyReceiver>, + high: &mut mailbox::UnreliableReceiver>, + low: &mut mailbox::UnreliableReceiver>, rate_limits: &HashMap, sent_messages: &CounterFamily>, ) -> Result<(), Error> { @@ -459,7 +459,7 @@ mod tests { } fn create_channels(context: impl BufferPooler + Metrics) -> Channels { - let (router_sender, _router_receiver) = commonware_actor::mailbox::new_lossy::< + let (router_sender, _router_receiver) = commonware_actor::mailbox::new_unreliable::< router::Message, >( context.child("router_mailbox"), NZUsize!(10) diff --git a/p2p/src/authenticated/discovery/actors/peer/ingress.rs b/p2p/src/authenticated/discovery/actors/peer/ingress.rs index c7c279a7b65..2f44163810d 100644 --- a/p2p/src/authenticated/discovery/actors/peer/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/peer/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::discovery::types; -use commonware_actor::mailbox::{self, LossyPolicy}; +use commonware_actor::mailbox::{self, UnreliablePolicy}; use commonware_cryptography::PublicKey; use commonware_runtime::Metrics; use std::{collections::VecDeque, fmt, num::NonZeroUsize}; @@ -17,7 +17,7 @@ pub enum Message { Kill, } -impl LossyPolicy for Message { +impl UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { @@ -31,14 +31,14 @@ impl LossyPolicy for Message { } } -pub struct Mailbox(mailbox::LossySender>); +pub struct Mailbox(mailbox::UnreliableSender>); impl Mailbox { pub fn new( metrics: impl Metrics, size: NonZeroUsize, - ) -> (Self, mailbox::LossyReceiver>) { - let (sender, receiver) = mailbox::new_lossy(metrics, size); + ) -> (Self, mailbox::UnreliableReceiver>) { + let (sender, receiver) = mailbox::new_unreliable(metrics, size); (Self(sender), receiver) } diff --git a/p2p/src/authenticated/discovery/actors/router/actor.rs b/p2p/src/authenticated/discovery/actors/router/actor.rs index e1a3b85907b..b31f468c0e8 100644 --- a/p2p/src/authenticated/discovery/actors/router/actor.rs +++ b/p2p/src/authenticated/discovery/actors/router/actor.rs @@ -19,7 +19,7 @@ use tracing::debug; pub struct Actor { context: ContextCell, - control: mailbox::LossyReceiver>, + control: mailbox::UnreliableReceiver>, connections: BTreeMap>, open_subscriptions: Vec>>, } @@ -30,7 +30,7 @@ impl Actor { pub fn new(context: E, cfg: Config) -> (Self, Mailbox

, Messenger

) { // Create mailbox let (control_sender, control_receiver) = - mailbox::new_lossy::>(context.child("mailbox"), cfg.mailbox_size); + mailbox::new_unreliable::>(context.child("mailbox"), cfg.mailbox_size); let pool = context.network_buffer_pool().clone(); // Create actor diff --git a/p2p/src/authenticated/discovery/actors/router/ingress.rs b/p2p/src/authenticated/discovery/actors/router/ingress.rs index 93a29125140..e0638014694 100644 --- a/p2p/src/authenticated/discovery/actors/router/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/router/ingress.rs @@ -8,8 +8,8 @@ use crate::{ Channel, Recipients, }; use commonware_actor::{ - mailbox::{self, LossyPolicy}, - Feedback, Lossy, + mailbox::{self, UnreliablePolicy}, + Feedback, Unreliable, }; use commonware_cryptography::PublicKey; use commonware_runtime::{BufferPool, IoBufs}; @@ -39,7 +39,7 @@ pub enum Message { SubscribePeers { sender: ring::Sender> }, } -impl LossyPolicy for Message

{ +impl UnreliablePolicy for Message

{ type Overflow = VecDeque; fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { @@ -54,7 +54,7 @@ impl LossyPolicy for Message

{ } /// Mailbox for the router actor. -pub struct Mailbox(mailbox::LossySender>); +pub struct Mailbox(mailbox::UnreliableSender>); impl Clone for Mailbox

{ fn clone(&self) -> Self { @@ -70,7 +70,7 @@ impl fmt::Debug for Mailbox

{ impl Mailbox

{ /// Returns a router mailbox around the provided sender. - pub const fn new(sender: mailbox::LossySender>) -> Self { + pub const fn new(sender: mailbox::UnreliableSender>) -> Self { Self(sender) } @@ -93,8 +93,8 @@ impl Mailbox

{ /// which is harmless since the router no longer tracks any peers. pub fn release(&self, peer: P) -> Feedback { match self.0.enqueue(Message::Release { peer }) { - Lossy::Handled(feedback) => feedback, - Lossy::Rejected => unreachable!("router release cannot be rejected"), + Unreliable::Feedback(feedback) => feedback, + Unreliable::Rejected => unreachable!("router release cannot be rejected"), } } } @@ -123,7 +123,7 @@ impl Messenger

{ channel: Channel, message: IoBufs, priority: bool, - ) -> Lossy { + ) -> Unreliable { // Build Data and encode Payload::Data once for all recipients let encoded = types::Payload::

::encode_data(&self.pool, channel, message); @@ -160,7 +160,7 @@ mod tests { fn test_overflow_rejects_content_but_retains_control() { let executor = deterministic::Runner::default(); executor.start(|context| async move { - let (control_sender, mut receiver) = mailbox::new_lossy::>( + let (control_sender, mut receiver) = mailbox::new_unreliable::>( context.child("control_mailbox"), NZUsize!(1), ); @@ -178,11 +178,11 @@ mod tests { IoBuf::from(b"one").into(), false ), - Feedback::Ok + Unreliable::new(Feedback::Ok) ); assert_eq!( messenger.content(Recipients::One(peer), 7, IoBuf::from(b"two").into(), false), - Lossy::Rejected + Unreliable::Rejected ); assert_eq!( mailbox.release(PrivateKey::from_seed(2).public_key()), diff --git a/p2p/src/authenticated/discovery/actors/spawner/actor.rs b/p2p/src/authenticated/discovery/actors/spawner/actor.rs index a8de595474b..6c7f3772ae0 100644 --- a/p2p/src/authenticated/discovery/actors/spawner/actor.rs +++ b/p2p/src/authenticated/discovery/actors/spawner/actor.rs @@ -37,7 +37,7 @@ pub struct Actor< peer_gossip_max_count: usize, info_verifier: InfoVerifier, - receiver: mailbox::LossyReceiver>, + receiver: mailbox::UnreliableReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, diff --git a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs index d4bb82d1a13..a396216fda8 100644 --- a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::{discovery::actors::tracker::Reservation, Mailbox}; -use commonware_actor::{mailbox::LossyPolicy, Feedback, Lossy}; +use commonware_actor::{mailbox::UnreliablePolicy, Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_runtime::{Sink, Stream}; use commonware_stream::encrypted::{Receiver, Sender}; @@ -18,7 +18,7 @@ pub enum Message { }, } -impl LossyPolicy for Message { +impl UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -38,7 +38,7 @@ impl Mailbox> { &mut self, connection: (Sender, Receiver), reservation: Reservation

, - ) -> Lossy { + ) -> Unreliable { self.0.enqueue(Message::Spawn { peer: reservation.metadata().public_key().clone(), connection, @@ -154,10 +154,13 @@ mod tests { Reservation::new(Metadata::Listener(peer_1.clone()), releaser.clone()); let reservation_2 = Reservation::new(Metadata::Listener(peer_2.clone()), releaser); - assert_eq!(spawner.spawn(connection_1, reservation_1), Feedback::Ok); + assert_eq!( + spawner.spawn(connection_1, reservation_1), + Unreliable::new(Feedback::Ok) + ); assert_eq!( spawner.spawn(connection_2, reservation_2), - Lossy::Rejected + Unreliable::Rejected ); let release = tracker_receiver diff --git a/p2p/src/authenticated/discovery/channels.rs b/p2p/src/authenticated/discovery/channels.rs index b03524023a9..e50b49a5949 100644 --- a/p2p/src/authenticated/discovery/channels.rs +++ b/p2p/src/authenticated/discovery/channels.rs @@ -4,8 +4,8 @@ use crate::{ Channel, Message as NetworkMessage, Recipients, }; use commonware_actor::{ - mailbox::{self, LossyPolicy}, - Feedback, Lossy, + mailbox::{self, UnreliablePolicy}, + Feedback, Unreliable, }; use commonware_cryptography::PublicKey; use commonware_runtime::{Clock, IoBufs, Metrics, Quota}; @@ -18,7 +18,7 @@ use std::{ pub(crate) struct Inbound(pub(crate) NetworkMessage

); -impl LossyPolicy for Inbound

{ +impl UnreliablePolicy for Inbound

{ type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -44,7 +44,7 @@ impl crate::UnlimitedSender for UnlimitedSender

{ recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Lossy { + ) -> Unreliable { let message = message.into(); assert!( message.len() <= self.max_size as usize, @@ -110,7 +110,7 @@ where /// Channel to asynchronously receive messages from a channel. pub struct Receiver { - receiver: mailbox::LossyReceiver>, + receiver: mailbox::UnreliableReceiver>, } impl Debug for Receiver

{ @@ -120,7 +120,7 @@ impl Debug for Receiver

{ } impl Receiver

{ - pub(super) const fn new(receiver: mailbox::LossyReceiver>) -> Self { + pub(super) const fn new(receiver: mailbox::UnreliableReceiver>) -> Self { Self { receiver } } } @@ -146,7 +146,7 @@ impl crate::Receiver for Receiver

{ pub struct Channels { messenger: Messenger

, max_size: u32, - receivers: BTreeMap>)>, + receivers: BTreeMap>)>, } impl Channels

{ @@ -166,7 +166,7 @@ impl Channels

{ context: C, ) -> (Sender, Receiver

) { let backlog = NonZeroUsize::new(backlog).expect("message backlog must be non-zero"); - let (sender, receiver) = mailbox::new_lossy(context.child("mailbox"), backlog); + let (sender, receiver) = mailbox::new_unreliable(context.child("mailbox"), backlog); if self.receivers.insert(channel, (rate, sender)).is_some() { panic!("duplicate channel registration: {channel}"); } @@ -182,7 +182,7 @@ impl Channels

{ ) } - pub fn collect(self) -> BTreeMap>)> { + pub fn collect(self) -> BTreeMap>)> { self.receivers } } diff --git a/p2p/src/authenticated/discovery/mod.rs b/p2p/src/authenticated/discovery/mod.rs index e78a40461a5..e9bc6cf332e 100644 --- a/p2p/src/authenticated/discovery/mod.rs +++ b/p2p/src/authenticated/discovery/mod.rs @@ -267,7 +267,7 @@ mod tests { CheckedSender as _, Ingress, LimitedSender as _, Manager, Provider, Receiver, Recipients, Sender, }; - use commonware_actor::Feedback; + use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::{ed25519, Signer as _}; use commonware_macros::{select, select_loop, test_group, test_traced}; use commonware_runtime::{ @@ -2415,7 +2415,11 @@ mod tests { // broadcast. for i in 0..11 { let sent = messenger.content(Recipients::All, 0, message.clone().into(), false); - assert_ne!(sent, Feedback::Closed, "Broadcast {i} should be accepted"); + assert_ne!( + sent, + Unreliable::new(Feedback::Closed), + "Broadcast {i} should be accepted" + ); assert!(fast_receivers.low.recv().await.is_some()); } diff --git a/p2p/src/authenticated/lookup/actors/peer/actor.rs b/p2p/src/authenticated/lookup/actors/peer/actor.rs index e5bb0c2440d..3bf05dda3df 100644 --- a/p2p/src/authenticated/lookup/actors/peer/actor.rs +++ b/p2p/src/authenticated/lookup/actors/peer/actor.rs @@ -29,8 +29,8 @@ pub struct Actor { send_batch_size: usize, control: ring::Receiver, - high: mailbox::LossyReceiver>, - low: mailbox::LossyReceiver>, + high: mailbox::UnreliableReceiver>, + low: mailbox::UnreliableReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, @@ -99,8 +99,8 @@ impl batch_size: usize, batch: &mut Vec, control: &mut ring::Receiver, - high: &mut mailbox::LossyReceiver>, - low: &mut mailbox::LossyReceiver>, + high: &mut mailbox::UnreliableReceiver>, + low: &mut mailbox::UnreliableReceiver>, rate_limits: &HashMap, sent_messages: &CounterFamily>, ) -> Result<(), Error> { @@ -127,8 +127,8 @@ impl async fn recv_prioritized( control: &mut ring::Receiver, - high: &mut mailbox::LossyReceiver>, - low: &mut mailbox::LossyReceiver>, + high: &mut mailbox::UnreliableReceiver>, + low: &mut mailbox::UnreliableReceiver>, ) -> Prioritized { select! { msg = control.next() => msg.map_or(Prioritized::Closed, Prioritized::Control), @@ -405,7 +405,7 @@ mod tests { } fn create_channels(context: impl BufferPooler + Metrics) -> Channels { - let (router_sender, _router_receiver) = commonware_actor::mailbox::new_lossy::< + let (router_sender, _router_receiver) = commonware_actor::mailbox::new_unreliable::< router::Message, >( context.child("router_mailbox"), NZUsize!(10) diff --git a/p2p/src/authenticated/lookup/actors/router/actor.rs b/p2p/src/authenticated/lookup/actors/router/actor.rs index 389ac872880..f050b3d40b7 100644 --- a/p2p/src/authenticated/lookup/actors/router/actor.rs +++ b/p2p/src/authenticated/lookup/actors/router/actor.rs @@ -19,7 +19,7 @@ use tracing::debug; pub struct Actor { context: ContextCell, - control: mailbox::LossyReceiver>, + control: mailbox::UnreliableReceiver>, connections: BTreeMap>, open_subscriptions: Vec>>, } @@ -30,7 +30,7 @@ impl Actor { pub fn new(context: E, cfg: Config) -> (Self, Mailbox

, Messenger

) { // Create mailbox let (control_sender, control_receiver) = - mailbox::new_lossy::>(context.child("mailbox"), cfg.mailbox_size); + mailbox::new_unreliable::>(context.child("mailbox"), cfg.mailbox_size); let pool = context.network_buffer_pool().clone(); // Create actor diff --git a/p2p/src/authenticated/lookup/actors/router/ingress.rs b/p2p/src/authenticated/lookup/actors/router/ingress.rs index 673e183540a..3fa220bce69 100644 --- a/p2p/src/authenticated/lookup/actors/router/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/router/ingress.rs @@ -8,8 +8,8 @@ use crate::{ Channel, Recipients, }; use commonware_actor::{ - mailbox::{self, LossyPolicy}, - Feedback, Lossy, + mailbox::{self, UnreliablePolicy}, + Feedback, Unreliable, }; use commonware_cryptography::PublicKey; use commonware_runtime::{BufferPool, IoBufs}; @@ -39,7 +39,7 @@ pub enum Message { SubscribePeers { sender: ring::Sender> }, } -impl LossyPolicy for Message

{ +impl UnreliablePolicy for Message

{ type Overflow = VecDeque; fn handle(overflow: &mut Self::Overflow, message: Self) -> bool { @@ -54,7 +54,7 @@ impl LossyPolicy for Message

{ } /// Mailbox for the router actor. -pub struct Mailbox(mailbox::LossySender>); +pub struct Mailbox(mailbox::UnreliableSender>); impl Clone for Mailbox

{ fn clone(&self) -> Self { @@ -70,7 +70,7 @@ impl fmt::Debug for Mailbox

{ impl Mailbox

{ /// Returns a router mailbox around the provided sender. - pub const fn new(sender: mailbox::LossySender>) -> Self { + pub const fn new(sender: mailbox::UnreliableSender>) -> Self { Self(sender) } @@ -93,8 +93,8 @@ impl Mailbox

{ /// which is harmless since the router no longer tracks any peers. pub fn release(&self, peer: P) -> Feedback { match self.0.enqueue(Message::Release { peer }) { - Lossy::Handled(feedback) => feedback, - Lossy::Rejected => unreachable!("router release cannot be rejected"), + Unreliable::Feedback(feedback) => feedback, + Unreliable::Rejected => unreachable!("router release cannot be rejected"), } } } @@ -123,7 +123,7 @@ impl Messenger

{ channel: Channel, message: IoBufs, priority: bool, - ) -> Lossy { + ) -> Unreliable { // Build Data and encode Message::Data once for all recipients let encoded = types::Message::encode_data(&self.pool, channel, message); diff --git a/p2p/src/authenticated/lookup/actors/spawner/actor.rs b/p2p/src/authenticated/lookup/actors/spawner/actor.rs index 48635b7f532..72fbf331029 100644 --- a/p2p/src/authenticated/lookup/actors/spawner/actor.rs +++ b/p2p/src/authenticated/lookup/actors/spawner/actor.rs @@ -30,7 +30,7 @@ pub struct Actor< send_batch_size: NonZeroUsize, ping_frequency: std::time::Duration, - receiver: mailbox::LossyReceiver>, + receiver: mailbox::UnreliableReceiver>, sent_messages: CounterFamily>, received_messages: CounterFamily>, diff --git a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs index 500aa8a1cf4..dff94441b55 100644 --- a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs @@ -1,5 +1,5 @@ use crate::authenticated::{lookup::actors::tracker::Reservation, Mailbox}; -use commonware_actor::{mailbox::LossyPolicy, Feedback, Lossy}; +use commonware_actor::{mailbox::UnreliablePolicy, Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_runtime::{Sink, Stream}; use commonware_stream::encrypted::{Receiver, Sender}; @@ -18,7 +18,7 @@ pub enum Message { }, } -impl LossyPolicy for Message { +impl UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -38,7 +38,7 @@ impl Mailbox> { &mut self, connection: (Sender, Receiver), reservation: Reservation

, - ) -> Lossy { + ) -> Unreliable { self.0.enqueue(Message::Spawn { peer: reservation.metadata().public_key().clone(), connection, @@ -154,10 +154,13 @@ mod tests { Reservation::new(Metadata::Listener(peer_1.clone()), releaser.clone()); let reservation_2 = Reservation::new(Metadata::Listener(peer_2.clone()), releaser); - assert_eq!(spawner.spawn(connection_1, reservation_1), Feedback::Ok); + assert_eq!( + spawner.spawn(connection_1, reservation_1), + Unreliable::new(Feedback::Ok) + ); assert_eq!( spawner.spawn(connection_2, reservation_2), - Lossy::Rejected + Unreliable::Rejected ); let release = tracker_receiver diff --git a/p2p/src/authenticated/lookup/channels.rs b/p2p/src/authenticated/lookup/channels.rs index b21515d249c..a893821153f 100644 --- a/p2p/src/authenticated/lookup/channels.rs +++ b/p2p/src/authenticated/lookup/channels.rs @@ -5,8 +5,8 @@ use crate::{ Channel, Message as NetworkMessage, Recipients, }; use commonware_actor::{ - mailbox::{self, LossyPolicy}, - Feedback, Lossy, + mailbox::{self, UnreliablePolicy}, + Feedback, Unreliable, }; use commonware_cryptography::PublicKey; use commonware_runtime::{Clock, IoBufs, Metrics, Quota}; @@ -19,7 +19,7 @@ use std::{ pub(crate) struct Inbound(pub(crate) NetworkMessage

); -impl LossyPolicy for Inbound

{ +impl UnreliablePolicy for Inbound

{ type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -45,7 +45,7 @@ impl crate::UnlimitedSender for UnlimitedSender

{ recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Lossy { + ) -> Unreliable { let message = message.into(); assert!( message.len() <= self.max_size as usize, @@ -111,7 +111,7 @@ where /// Channel to asynchronously receive messages from a channel. pub struct Receiver { - receiver: mailbox::LossyReceiver>, + receiver: mailbox::UnreliableReceiver>, } impl Debug for Receiver

{ @@ -121,7 +121,7 @@ impl Debug for Receiver

{ } impl Receiver

{ - pub(super) const fn new(receiver: mailbox::LossyReceiver>) -> Self { + pub(super) const fn new(receiver: mailbox::UnreliableReceiver>) -> Self { Self { receiver } } } @@ -147,7 +147,7 @@ impl crate::Receiver for Receiver

{ pub struct Channels { messenger: router::Messenger

, max_size: u32, - receivers: BTreeMap>)>, + receivers: BTreeMap>)>, } impl Channels

{ @@ -167,7 +167,7 @@ impl Channels

{ context: C, ) -> (Sender, Receiver

) { let backlog = NonZeroUsize::new(backlog).expect("message backlog must be non-zero"); - let (sender, receiver) = mailbox::new_lossy(context.child("mailbox"), backlog); + let (sender, receiver) = mailbox::new_unreliable(context.child("mailbox"), backlog); if self.receivers.insert(channel, (rate, sender)).is_some() { panic!("duplicate channel registration: {channel}"); } @@ -183,7 +183,7 @@ impl Channels

{ ) } - pub fn collect(self) -> BTreeMap>)> { + pub fn collect(self) -> BTreeMap>)> { self.receivers } } diff --git a/p2p/src/authenticated/lookup/mod.rs b/p2p/src/authenticated/lookup/mod.rs index ac9956271b6..158ac1aa04c 100644 --- a/p2p/src/authenticated/lookup/mod.rs +++ b/p2p/src/authenticated/lookup/mod.rs @@ -219,7 +219,7 @@ mod tests { Address, AddressableManager, CheckedSender as _, Ingress, LimitedSender as _, Provider, Receiver, Recipients, Sender, }; - use commonware_actor::Feedback; + use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::{ed25519, Signer as _}; use commonware_macros::{select, test_group, test_traced}; use commonware_runtime::{ @@ -2145,7 +2145,11 @@ mod tests { let message = IoBuf::from(vec![0u8; 100]); for i in 0..11 { let sent = messenger.content(Recipients::All, 0, message.clone().into(), false); - assert_ne!(sent, Feedback::Closed, "Broadcast {i} should be accepted"); + assert_ne!( + sent, + Unreliable::new(Feedback::Closed), + "Broadcast {i} should be accepted" + ); assert!(fast_receivers.low.recv().await.is_some()); } diff --git a/p2p/src/authenticated/mailbox.rs b/p2p/src/authenticated/mailbox.rs index 952b71c2cc2..b45daf51fd5 100644 --- a/p2p/src/authenticated/mailbox.rs +++ b/p2p/src/authenticated/mailbox.rs @@ -4,17 +4,20 @@ use std::num::NonZeroUsize; /// A mailbox wraps a sender for messages of type `T`. #[derive(Debug)] -pub struct Mailbox(pub(crate) mailbox::LossySender); +pub struct Mailbox(pub(crate) mailbox::UnreliableSender); -impl Mailbox { +impl Mailbox { /// Returns a new mailbox with the given sender. - pub fn new(metrics: impl Metrics, size: NonZeroUsize) -> (Self, mailbox::LossyReceiver) { - let (sender, receiver) = mailbox::new_lossy(metrics, size); + pub fn new( + metrics: impl Metrics, + size: NonZeroUsize, + ) -> (Self, mailbox::UnreliableReceiver) { + let (sender, receiver) = mailbox::new_unreliable(metrics, size); (Self(sender), receiver) } } -impl Clone for Mailbox { +impl Clone for Mailbox { fn clone(&self) -> Self { Self(self.0.clone()) } diff --git a/p2p/src/authenticated/relay.rs b/p2p/src/authenticated/relay.rs index 25fcec36f97..ae24ffdc562 100644 --- a/p2p/src/authenticated/relay.rs +++ b/p2p/src/authenticated/relay.rs @@ -1,6 +1,6 @@ use commonware_actor::{ - mailbox::{self, LossyPolicy}, - Feedback, Lossy, + mailbox::{self, UnreliablePolicy}, + Feedback, Unreliable, }; use commonware_macros::select; use commonware_runtime::Metrics; @@ -14,7 +14,7 @@ impl Message { } } -impl LossyPolicy for Message { +impl UnreliablePolicy for Message { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -23,21 +23,21 @@ impl LossyPolicy for Message { } pub(crate) struct Receivers { - pub(crate) low: mailbox::LossyReceiver>, - pub(crate) high: mailbox::LossyReceiver>, + pub(crate) low: mailbox::UnreliableReceiver>, + pub(crate) high: mailbox::UnreliableReceiver>, } #[derive(Clone, Debug)] pub struct Relay { - low: mailbox::LossySender>, - high: mailbox::LossySender>, + low: mailbox::UnreliableSender>, + high: mailbox::UnreliableSender>, } impl Relay { /// Creates a prioritized relay backed by bounded low and high priority mailboxes. pub fn new(metrics: impl Metrics, size: NonZeroUsize) -> (Self, Receivers) { - let (low_sender, low_receiver) = mailbox::new_lossy(metrics.child("low"), size); - let (high_sender, high_receiver) = mailbox::new_lossy(metrics.child("high"), size); + let (low_sender, low_receiver) = mailbox::new_unreliable(metrics.child("low"), size); + let (high_sender, high_receiver) = mailbox::new_unreliable(metrics.child("high"), size); ( Self { low: low_sender, @@ -52,9 +52,9 @@ impl Relay { /// Submits `message` to the priority channel selected by `priority`. /// - /// This never waits for capacity. [`Lossy::Rejected`] means the selected channel was full + /// This never waits for capacity. [`Unreliable::Rejected`] means the selected channel was full /// and did not handle the message, and [`Feedback::Closed`] means the receiver is gone. - pub fn send(&self, message: T, priority: bool) -> Lossy { + pub fn send(&self, message: T, priority: bool) -> Unreliable { let sender = if priority { &self.high } else { &self.low }; sender.enqueue(Message(message)) } @@ -71,10 +71,10 @@ pub enum Prioritized { } /// Awaits a message from control, high, or low priority receivers. -pub async fn recv_prioritized( - control: &mut mailbox::LossyReceiver, - high: &mut mailbox::LossyReceiver>, - low: &mut mailbox::LossyReceiver>, +pub async fn recv_prioritized( + control: &mut mailbox::UnreliableReceiver, + high: &mut mailbox::UnreliableReceiver>, + low: &mut mailbox::UnreliableReceiver>, ) -> Prioritized { select! { msg = control.recv() => msg.map_or(Prioritized::Closed, Prioritized::Control), @@ -88,7 +88,7 @@ pub async fn recv_prioritized( } /// Attempts to receive one data message from a relay receiver. -pub(crate) fn try_recv(receiver: &mut mailbox::LossyReceiver>) -> Option { +pub(crate) fn try_recv(receiver: &mut mailbox::UnreliableReceiver>) -> Option { receiver.try_recv().ok().map(Message::into_inner) } @@ -103,7 +103,7 @@ mod tests { let (relay, mut receivers) = Relay::new(Metrics, NZUsize!(1)); let data = 123; - assert_eq!(relay.send(data, true), Feedback::Ok); + assert_eq!(relay.send(data, true), Unreliable::new(Feedback::Ok)); match receivers.high.try_recv().map(Message::into_inner) { Ok(received_data) => { assert_eq!(data, received_data); @@ -113,7 +113,7 @@ mod tests { assert!(receivers.low.try_recv().is_err()); let data = 456; - assert_eq!(relay.send(data, false), Feedback::Ok); + assert_eq!(relay.send(data, false), Unreliable::new(Feedback::Ok)); match receivers.low.try_recv().map(Message::into_inner) { Ok(received_data) => { assert_eq!(data, received_data); @@ -127,8 +127,8 @@ mod tests { fn test_relay_rejects_on_overflow() { let (relay, mut receivers) = Relay::new(Metrics, NZUsize!(1)); - assert_eq!(relay.send(1, false), Feedback::Ok); - assert_eq!(relay.send(2, false), Lossy::Rejected); + assert_eq!(relay.send(1, false), Unreliable::new(Feedback::Ok)); + assert_eq!(relay.send(2, false), Unreliable::Rejected); assert_eq!(receivers.low.try_recv().map(Message::into_inner), Ok(1)); assert!(receivers.low.try_recv().is_err()); } diff --git a/p2p/src/lib.rs b/p2p/src/lib.rs index 0b56ce3c269..71569321572 100644 --- a/p2p/src/lib.rs +++ b/p2p/src/lib.rs @@ -14,7 +14,7 @@ use commonware_macros::{stability_mod, stability_scope}; stability_mod!(ALPHA, pub mod simulated); stability_scope!(BETA { - use commonware_actor::{Feedback, Lossy}; + use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_runtime::{IoBuf, IoBufs}; use commonware_utils::{ @@ -62,14 +62,14 @@ stability_scope!(BETA { /// # Returns /// /// Feedback from submitting the message for delivery. - /// [`Lossy`] indicates that local submission may be rejected under backpressure. + /// [`Unreliable`] indicates that local submission may be rejected under backpressure. /// [`Feedback::accepted`] does not guarantee that the recipient will receive the message. fn send( &mut self, recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Lossy; + ) -> Unreliable; } /// Interface for constructing a [`CheckedSender`] from a set of [`Recipients`], @@ -121,9 +121,9 @@ stability_scope!(BETA { /// # Returns /// /// Feedback from submitting the message for delivery. - /// [`Lossy`] indicates that local submission may be rejected under backpressure. + /// [`Unreliable`] indicates that local submission may be rejected under backpressure. /// [`Feedback::accepted`] does not guarantee that the recipient will receive the message. - fn send(self, message: impl Into + Send, priority: bool) -> Lossy; + fn send(self, message: impl Into + Send, priority: bool) -> Unreliable; } /// Interface for sending messages to a set of recipients. diff --git a/p2p/src/simulated/network.rs b/p2p/src/simulated/network.rs index 633f52c63a3..9b669c36438 100644 --- a/p2p/src/simulated/network.rs +++ b/p2p/src/simulated/network.rs @@ -14,7 +14,7 @@ use crate::{ Channel, Message as NetworkMessage, PeerSetUpdate, Recipients, TrackedPeers, UnlimitedSender as _, }; -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_codec::{DecodeExt, FixedSize}; use commonware_cryptography::PublicKey; use commonware_macros::select_loop; @@ -960,7 +960,7 @@ impl crate::UnlimitedSender for UnlimitedSender { recipients: Recipients

, message: impl Into + Send, priority: bool, - ) -> Lossy { + ) -> Unreliable { let message = message.into().coalesce(); assert!( message.len() <= self.max_size as usize, @@ -970,7 +970,7 @@ impl crate::UnlimitedSender for UnlimitedSender { ); if !self.active.load(Ordering::Acquire) || self.sender.is_closed() { - return Lossy::new(Feedback::Closed); + return Unreliable::new(Feedback::Closed); } // The simulated network handles send submissions and topology updates @@ -983,9 +983,9 @@ impl crate::UnlimitedSender for UnlimitedSender { message, priority, }) { - Lossy::new(Feedback::Ok) + Unreliable::new(Feedback::Ok) } else { - Lossy::new(Feedback::Closed) + Unreliable::new(Feedback::Closed) } } } @@ -1141,13 +1141,13 @@ impl<'a, P: PublicKey, E: Clock, F: SplitForwarder

> crate::CheckedSender crate::CheckedSender::recipients(&self.checked) } - fn send(self, message: impl Into + Send, priority: bool) -> Lossy { + fn send(self, message: impl Into + Send, priority: bool) -> Unreliable { // Convert to IoBuf here since forwarder needs to inspect the message let message = message.into().coalesce(); // Determine the set of recipients that will receive the message let Some(recipients) = (self.forwarder)(self.replica, &self.recipients, &message) else { - return Lossy::Rejected; + return Unreliable::Rejected; }; // Extract the inner sender and send directly with the new recipients diff --git a/p2p/src/utils/codec.rs b/p2p/src/utils/codec.rs index 0dbe234b7fa..e525e01b279 100644 --- a/p2p/src/utils/codec.rs +++ b/p2p/src/utils/codec.rs @@ -1,7 +1,7 @@ //! Codec wrapper for [Sender] and [Receiver]. use crate::{Blocker, CheckedSender, Receiver, Recipients, Sender}; -use commonware_actor::{mailbox, Feedback, Lossy}; +use commonware_actor::{mailbox, Feedback, Unreliable}; use commonware_codec::{Codec, Error}; use commonware_cryptography::PublicKey; use commonware_macros::select_loop; @@ -86,7 +86,7 @@ impl<'a, S: Sender, V: Codec> CheckedWrappedSender<'a, S, V> { self.sender.recipients() } - pub fn send(self, message: V, priority: bool) -> Lossy { + pub fn send(self, message: V, priority: bool) -> Unreliable { let encoded = message.encode_with_pool(self.pool); self.sender.send(encoded, priority) } @@ -134,7 +134,7 @@ impl WrappedReceiver { /// messages are dropped (they would likely no longer be useful by the time we get back to them). struct Decoded(P, V); -impl mailbox::LossyPolicy for Decoded { +impl mailbox::UnreliablePolicy for Decoded { type Overflow = VecDeque; fn handle(_overflow: &mut Self::Overflow, _message: Self) -> bool { @@ -144,7 +144,7 @@ impl mailbox::LossyPolicy for Decoded { /// Receiver half for successfully decoded messages from a [`WrappedBackgroundReceiver`]. pub struct BackgroundReceiver { - receiver: mailbox::LossyReceiver>, + receiver: mailbox::UnreliableReceiver>, } impl BackgroundReceiver { @@ -169,7 +169,7 @@ where receiver: R, codec_config: V::Cfg, blocker: B, - sender: mailbox::LossySender>, + sender: mailbox::UnreliableSender>, max_concurrency: usize, } @@ -194,7 +194,7 @@ where channel_capacity: NonZeroUsize, strategy: &impl Strategy, ) -> (Self, BackgroundReceiver) { - let (tx, rx) = mailbox::new_lossy(context.child("mailbox"), channel_capacity); + let (tx, rx) = mailbox::new_unreliable(context.child("mailbox"), channel_capacity); ( Self { context: ContextCell::new(context), @@ -272,7 +272,7 @@ where fn handle_decode_result( blocker: &mut B, - sender: &mut mailbox::LossySender>, + sender: &mut mailbox::UnreliableSender>, result: (P, Result), ) { let (peer, decode_result) = result; diff --git a/p2p/src/utils/limited.rs b/p2p/src/utils/limited.rs index ec2e1d3ce0f..9b1e21b696e 100644 --- a/p2p/src/utils/limited.rs +++ b/p2p/src/utils/limited.rs @@ -1,7 +1,7 @@ //! Rate-limited [`UnlimitedSender`] wrapper. use crate::{Recipients, UnlimitedSender}; -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_runtime::{Clock, IoBufs, KeyedRateLimiter, Quota}; use commonware_utils::{channel::ring, sync::Mutex}; @@ -210,7 +210,7 @@ impl<'a, S: UnlimitedSender> crate::CheckedSender for CheckedSender<'a, S> { } } - fn send(self, message: impl Into + Send, priority: bool) -> Lossy { + fn send(self, message: impl Into + Send, priority: bool) -> Unreliable { self.sender.send(self.recipients, message, priority) } } @@ -260,10 +260,10 @@ mod tests { recipients: Recipients, message: impl Into + Send, priority: bool, - ) -> Lossy { + ) -> Unreliable { let message = message.into().coalesce(); self.sent.lock().push((recipients, message, priority)); - Lossy::new(Feedback::Ok) + Unreliable::new(Feedback::Ok) } } @@ -332,7 +332,10 @@ mod tests { let mut limited = LimitedSender::new(sender, quota_per_second(10), context, peers); let checked = limited.check(Recipients::One(key(1))).unwrap(); - assert_eq!(checked.send(IoBuf::from(b"hello"), false), Feedback::Ok); + assert_eq!( + checked.send(IoBuf::from(b"hello"), false), + Unreliable::new(Feedback::Ok) + ); }); } @@ -365,7 +368,10 @@ mod tests { let peers_list = vec![key(1), key(2), key(3)]; let checked = limited.check(Recipients::Some(peers_list)).unwrap(); - assert_eq!(checked.send(IoBuf::from(b"hello"), false), Feedback::Ok); + assert_eq!( + checked.send(IoBuf::from(b"hello"), false), + Unreliable::new(Feedback::Ok) + ); assert_sent_to(&sender, 0, &[key(1), key(2), key(3)]); }); } diff --git a/p2p/src/utils/mocks/mod.rs b/p2p/src/utils/mocks/mod.rs index 6fed5074ad7..5bb2807b1fa 100644 --- a/p2p/src/utils/mocks/mod.rs +++ b/p2p/src/utils/mocks/mod.rs @@ -1,7 +1,7 @@ //! Mock implementations for testing. use crate::{CheckedSender, LimitedSender, Receiver, Recipients}; -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_runtime::{ telemetry::metrics::{Metric, Registered, Registration}, @@ -92,8 +92,8 @@ impl CheckedSender for InertCheckedSender

{ self.recipients.clone() } - fn send(self, _: impl Into + Send, _: bool) -> Lossy { - Lossy::new(Feedback::Ok) + fn send(self, _: impl Into + Send, _: bool) -> Unreliable { + Unreliable::new(Feedback::Ok) } } @@ -153,8 +153,8 @@ mod tests { vec![self.peer.clone()] } - fn send(self, _message: impl Into + Send, _priority: bool) -> Lossy { - Lossy::Rejected + fn send(self, _message: impl Into + Send, _priority: bool) -> Unreliable { + Unreliable::Rejected } } diff --git a/p2p/src/utils/mux.rs b/p2p/src/utils/mux.rs index 327f3298244..026991a0cd2 100644 --- a/p2p/src/utils/mux.rs +++ b/p2p/src/utils/mux.rs @@ -9,7 +9,7 @@ //! even if the muxer is already running. use crate::{Channel, CheckedSender, LimitedSender, Message, Receiver, Recipients, Sender}; -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_codec::{varint::UInt, Encode, Error as CodecError, ReadExt}; use commonware_macros::select_loop; use commonware_runtime::{spawn_cell, ContextCell, Handle, IoBuf, IoBufs, Spawner}; @@ -301,9 +301,9 @@ impl GlobalSender { recipients: Recipients, payload: impl Into + Send, priority: bool, - ) -> Lossy { + ) -> Unreliable { self.check(recipients).map_or_else( - |_| Lossy::Rejected, + |_| Unreliable::Rejected, |checked| checked.with_subchannel(subchannel).send(payload, priority), ) } @@ -347,7 +347,7 @@ impl<'a, S: Sender> CheckedSender for CheckedGlobalSender<'a, S> { self.inner.recipients() } - fn send(self, message: impl Into + Send, priority: bool) -> Lossy { + fn send(self, message: impl Into + Send, priority: bool) -> Unreliable { let subchannel = UInt(self.subchannel.expect("subchannel not set")); let mut message = message.into(); message.prepend(subchannel.encode().into()); @@ -674,7 +674,7 @@ mod tests { unreachable!("rate-limited sender should not produce a checked sender"); } - fn send(self, _: impl Into + Send, _: bool) -> Lossy { + fn send(self, _: impl Into + Send, _: bool) -> Unreliable { unreachable!("rate-limited sender should not send"); } } @@ -695,7 +695,7 @@ mod tests { fn test_global_sender_rate_limited_send_rejected() { let mut sender = GlobalSender::new(RateLimitedSender); let feedback = sender.send(0, Recipients::One(pk(0)), b"rate-limited", false); - assert_eq!(feedback, Lossy::Rejected); + assert_eq!(feedback, Unreliable::Rejected); assert!(!feedback.accepted()); } diff --git a/resolver/src/p2p/fetcher.rs b/resolver/src/p2p/fetcher.rs index 585fce07057..1993d1feeb5 100644 --- a/resolver/src/p2p/fetcher.rs +++ b/resolver/src/p2p/fetcher.rs @@ -1,5 +1,5 @@ use crate::p2p::wire; -use commonware_actor::{Feedback, Lossy}; +use commonware_actor::{Feedback, Unreliable}; use commonware_cryptography::PublicKey; use commonware_p2p::{utils::codec::WrappedSender, Recipients, Sender}; use commonware_runtime::{ @@ -292,7 +292,7 @@ where payload: wire::Payload::Request(key.clone()), }; match checked.send(message, self.priority_requests) { - Lossy::Handled(Feedback::Ok | Feedback::Backoff) => { + Unreliable::Feedback(Feedback::Ok | Feedback::Backoff) => { // Success - move from pending to active self.requests_sent.inc(Status::Success); self.pending.remove(&key); @@ -310,7 +310,7 @@ where self.key_to_id.insert(key, id); return; } - feedback @ (Lossy::Rejected | Lossy::Handled(Feedback::Closed)) => { + feedback @ (Unreliable::Rejected | Unreliable::Feedback(Feedback::Closed)) => { // Send was not handled, try next peer self.requests_sent.inc(Status::Dropped); debug!(?peer, ?feedback, "send failed"); @@ -536,7 +536,7 @@ where mod tests { use super::*; use crate::p2p::mocks::Key as MockKey; - use commonware_actor::Lossy; + use commonware_actor::Unreliable; use commonware_cryptography::{ ed25519::{PrivateKey, PublicKey}, Signer, @@ -566,7 +566,7 @@ mod tests { } } - fn send(self, message: impl Into + Send, priority: bool) -> Lossy { + fn send(self, message: impl Into + Send, priority: bool) -> Unreliable { self.sender.send(self.recipients, message, priority) } } @@ -582,8 +582,8 @@ mod tests { _recipients: Recipients, _message: impl Into + Send, _priority: bool, - ) -> Lossy { - Lossy::Rejected + ) -> Unreliable { + Unreliable::Rejected } } @@ -618,9 +618,9 @@ mod tests { recipients: Recipients, _message: impl Into + Send, _priority: bool, - ) -> Lossy { + ) -> Unreliable { match recipients { - Recipients::One(_) => Lossy::new(Feedback::Ok), + Recipients::One(_) => Unreliable::new(Feedback::Ok), _ => unimplemented!(), } } From 32f2dbe98a7062e14699f12209a4525990e8b498 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 12:05:13 -0700 Subject: [PATCH 04/13] nits --- actor/src/lib.rs | 8 +------- actor/src/mailbox.rs | 7 ++++--- p2p/src/authenticated/discovery/actors/spawner/ingress.rs | 4 ++-- p2p/src/authenticated/lookup/actors/spawner/ingress.rs | 4 ++-- 4 files changed, 9 insertions(+), 14 deletions(-) diff --git a/actor/src/lib.rs b/actor/src/lib.rs index ecd3d31b0e3..a27daaac679 100644 --- a/actor/src/lib.rs +++ b/actor/src/lib.rs @@ -31,7 +31,7 @@ commonware_macros::stability_scope!(BETA { /// Feedback from endpoints that may reject work under backpressure. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum Unreliable { - /// Feedback returned by the endpoint. + /// Normal endpoint feedback from the submission attempt. Feedback(T), /// The work was rejected by the endpoint. Rejected, @@ -57,11 +57,5 @@ commonware_macros::stability_scope!(BETA { } } - impl From for Unreliable { - fn from(feedback: Feedback) -> Self { - Self::new(feedback) - } - } - pub mod mailbox; }); diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 8a75ba866bd..5373242fbb4 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -122,9 +122,10 @@ pub trait UnreliablePolicy: Sized { /// the message, coalescing it with retained work, replacing older retained work, or deliberately /// doing no work because the message is already satisfied, superseded, or no longer needed. /// - /// Returns `false` only when the policy rejects the message under backpressure. This is the - /// unreliable case: the submitted work was not semantically handled, and callers that care - /// should retry or treat the submission as failed. + /// Returns `false` only when the policy rejects the message under backpressure without + /// retaining, coalescing, replacing, or otherwise handling it. This is the unreliable case: the + /// submitted work was not semantically handled, and callers that care should retry or treat the + /// submission as failed. /// /// # Warning /// diff --git a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs index a396216fda8..344121dad92 100644 --- a/p2p/src/authenticated/discovery/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/spawner/ingress.rs @@ -32,8 +32,8 @@ impl UnreliablePolicy for Message { impl Mailbox> { /// Send a message to the actor to spawn a new task for the given peer. /// - /// This may reject when the spawner is backlogged or closed, which is harmless since stale - /// connections do not need to be spawned. + /// This may be rejected when the spawner is backlogged, or return closed after shutdown, which + /// is harmless since stale connections do not need to be spawned. pub fn spawn( &mut self, connection: (Sender, Receiver), diff --git a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs index dff94441b55..e17b72b29f0 100644 --- a/p2p/src/authenticated/lookup/actors/spawner/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/spawner/ingress.rs @@ -32,8 +32,8 @@ impl UnreliablePolicy for Message impl Mailbox> { /// Send a message to the actor to spawn a new task for the given peer. /// - /// This may reject when the spawner is backlogged or closed, which is harmless since stale - /// connections do not need to be spawned. + /// This may be rejected when the spawner is backlogged, or return closed after shutdown, which + /// is harmless since stale connections do not need to be spawned. pub fn spawn( &mut self, connection: (Sender, Receiver), From 293c7cf8c52d5dd6a72dc067d4d43eef87bfd790 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 12:21:52 -0700 Subject: [PATCH 05/13] outcome --- actor/src/lib.rs | 8 ++++---- p2p/src/authenticated/discovery/actors/router/ingress.rs | 2 +- p2p/src/authenticated/lookup/actors/router/ingress.rs | 2 +- resolver/src/p2p/fetcher.rs | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/actor/src/lib.rs b/actor/src/lib.rs index a27daaac679..e9be2f6d06f 100644 --- a/actor/src/lib.rs +++ b/actor/src/lib.rs @@ -31,8 +31,8 @@ commonware_macros::stability_scope!(BETA { /// Feedback from endpoints that may reject work under backpressure. #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum Unreliable { - /// Normal endpoint feedback from the submission attempt. - Feedback(T), + /// Endpoint outcome from the submission attempt. + Outcome(T), /// The work was rejected by the endpoint. Rejected, } @@ -40,7 +40,7 @@ commonware_macros::stability_scope!(BETA { impl Unreliable { /// Wrap endpoint feedback for an endpoint that may reject work. pub const fn new(feedback: Feedback) -> Self { - Self::Feedback(feedback) + Self::Outcome(feedback) } /// Create rejected feedback. @@ -51,7 +51,7 @@ commonware_macros::stability_scope!(BETA { /// Returns `true` when the endpoint handled the submission. pub const fn accepted(self) -> bool { match self { - Self::Feedback(feedback) => feedback.accepted(), + Self::Outcome(feedback) => feedback.accepted(), Self::Rejected => false, } } diff --git a/p2p/src/authenticated/discovery/actors/router/ingress.rs b/p2p/src/authenticated/discovery/actors/router/ingress.rs index e0638014694..ba218a7af7b 100644 --- a/p2p/src/authenticated/discovery/actors/router/ingress.rs +++ b/p2p/src/authenticated/discovery/actors/router/ingress.rs @@ -93,7 +93,7 @@ impl Mailbox

{ /// which is harmless since the router no longer tracks any peers. pub fn release(&self, peer: P) -> Feedback { match self.0.enqueue(Message::Release { peer }) { - Unreliable::Feedback(feedback) => feedback, + Unreliable::Outcome(feedback) => feedback, Unreliable::Rejected => unreachable!("router release cannot be rejected"), } } diff --git a/p2p/src/authenticated/lookup/actors/router/ingress.rs b/p2p/src/authenticated/lookup/actors/router/ingress.rs index 3fa220bce69..74674119d25 100644 --- a/p2p/src/authenticated/lookup/actors/router/ingress.rs +++ b/p2p/src/authenticated/lookup/actors/router/ingress.rs @@ -93,7 +93,7 @@ impl Mailbox

{ /// which is harmless since the router no longer tracks any peers. pub fn release(&self, peer: P) -> Feedback { match self.0.enqueue(Message::Release { peer }) { - Unreliable::Feedback(feedback) => feedback, + Unreliable::Outcome(feedback) => feedback, Unreliable::Rejected => unreachable!("router release cannot be rejected"), } } diff --git a/resolver/src/p2p/fetcher.rs b/resolver/src/p2p/fetcher.rs index 1993d1feeb5..4ce22e435f7 100644 --- a/resolver/src/p2p/fetcher.rs +++ b/resolver/src/p2p/fetcher.rs @@ -292,7 +292,7 @@ where payload: wire::Payload::Request(key.clone()), }; match checked.send(message, self.priority_requests) { - Unreliable::Feedback(Feedback::Ok | Feedback::Backoff) => { + Unreliable::Outcome(Feedback::Ok | Feedback::Backoff) => { // Success - move from pending to active self.requests_sent.inc(Status::Success); self.pending.remove(&key); @@ -310,7 +310,7 @@ where self.key_to_id.insert(key, id); return; } - feedback @ (Unreliable::Rejected | Unreliable::Feedback(Feedback::Closed)) => { + feedback @ (Unreliable::Rejected | Unreliable::Outcome(Feedback::Closed)) => { // Send was not handled, try next peer self.requests_sent.inc(Status::Dropped); debug!(?peer, ?feedback, "send failed"); From 2cd6da080bb1e4c416a3174e06bbce5c7f42f7b5 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 12:31:48 -0700 Subject: [PATCH 06/13] cleanup --- actor/src/mailbox.rs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 5373242fbb4..1ee8af78a4d 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -143,7 +143,7 @@ struct ReliableMode; struct UnreliableMode; -trait MailboxMode: Sized { +trait Mode: Sized { type Overflow: Overflow; type Feedback; @@ -154,7 +154,7 @@ trait MailboxMode: Sized { fn is_closed(feedback: &Self::Feedback) -> bool; } -impl MailboxMode for ReliableMode { +impl Mode for ReliableMode { type Overflow = T::Overflow; type Feedback = Feedback; @@ -180,7 +180,7 @@ impl MailboxMode for ReliableMode { } } -impl MailboxMode for UnreliableMode { +impl Mode for UnreliableMode { type Overflow = T::Overflow; type Feedback = Unreliable; @@ -354,13 +354,13 @@ cfg_if::cfg_if! { } } -struct OverflowState> { +struct OverflowState> { queue: Mutex, activity: AtomicUsize, _phantom: PhantomData T>, } -impl> OverflowState { +impl> OverflowState { #[allow(clippy::missing_const_for_fn)] fn new() -> Self { Self { @@ -478,7 +478,7 @@ impl Drop for Mutation<'_> { } } -struct State> { +struct State> { ready: Ready, overflow: OverflowState, backoff: Counter, @@ -487,7 +487,7 @@ struct State> { waker: AtomicWaker, } -impl> State { +impl> State { fn enqueue(&self, message: T) -> M::Feedback { // Receiver closure makes new sends fail immediately. if self.closed.load(Ordering::Acquire) { From c984571a3ffbcd5384da639eca31e53115c3db87 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 12:34:44 -0700 Subject: [PATCH 07/13] nits --- actor/src/mailbox.rs | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 1ee8af78a4d..f1ac88d1675 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -139,22 +139,33 @@ pub trait UnreliablePolicy: Sized { fn handle(overflow: &mut Self::Overflow, message: Self) -> bool; } -struct ReliableMode; +mod mode { + /// Uses a policy that always handles overflow messages. + pub(super) struct Reliable; -struct UnreliableMode; + /// Uses a policy that may reject overflow messages. + pub(super) struct Unreliable; +} trait Mode: Sized { + /// Overflow storage used by this mode. type Overflow: Overflow; + /// Feedback returned from enqueue attempts. type Feedback; + /// Updates overflow for a full inbox and reports whether the message was handled. fn handle(overflow: &mut Self::Overflow, message: T) -> bool; + /// Maps ready-path feedback into this mode's feedback type. fn ready_feedback(feedback: Feedback) -> Self::Feedback; + /// Maps overflow handling into this mode's feedback type. fn overflow_feedback(handled: bool) -> Self::Feedback; + /// Returns `true` when this feedback should count as backoff. fn is_backoff(feedback: &Self::Feedback) -> bool; + /// Returns `true` when this feedback means the receiver is closed. fn is_closed(feedback: &Self::Feedback) -> bool; } -impl Mode for ReliableMode { +impl Mode for mode::Reliable { type Overflow = T::Overflow; type Feedback = Feedback; @@ -180,7 +191,7 @@ impl Mode for ReliableMode { } } -impl Mode for UnreliableMode { +impl Mode for mode::Unreliable { type Overflow = T::Overflow; type Feedback = Unreliable; @@ -577,12 +588,12 @@ impl> State { /// Sender half of a mailbox. pub struct Sender { - state: Arc>, + state: Arc>, } /// Sender half of an unreliable mailbox. pub struct UnreliableSender { - state: Arc>, + state: Arc>, } impl Clone for Sender { @@ -668,7 +679,7 @@ impl UnreliableSender { /// Dropping the last sender disconnects the mailbox, but the receiver continues /// returning buffered messages until ready and overflow are empty. pub struct Receiver { - state: Arc>, + state: Arc>, } /// Receiver half of an unreliable mailbox. @@ -678,7 +689,7 @@ pub struct Receiver { /// Dropping the last sender disconnects the mailbox, but the receiver continues /// returning buffered messages until ready and overflow are empty. pub struct UnreliableReceiver { - state: Arc>, + state: Arc>, } impl Receiver { From e1fbdfb14fdbca5ca2c2eb889acf1bb85bc10543 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 12:35:43 -0700 Subject: [PATCH 08/13] nit --- actor/src/mailbox.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index f1ac88d1675..7175c10c1a7 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -139,6 +139,7 @@ pub trait UnreliablePolicy: Sized { fn handle(overflow: &mut Self::Overflow, message: Self) -> bool; } +// Marker types that select the mailbox overflow policy. mod mode { /// Uses a policy that always handles overflow messages. pub(super) struct Reliable; From 4ca6ab93f893ac3f1558b51200b0c4371717520a Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 13:03:28 -0700 Subject: [PATCH 09/13] dedup code --- actor/src/mailbox.rs | 171 ++++++++++++++++++++----------------------- 1 file changed, 80 insertions(+), 91 deletions(-) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 7175c10c1a7..be92c7bb378 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -587,6 +587,57 @@ impl> State { } } +fn new_state>(metrics: impl Metrics, capacity: NonZeroUsize) -> Arc> { + Arc::new(State { + ready: Ready::new(capacity.get()), + overflow: OverflowState::new(), + backoff: metrics.counter("backoff", "number of enqueue calls that requested backoff"), + closed: AtomicBool::new(false), + senders: AtomicUsize::new(1), + waker: AtomicWaker::new(), + }) +} + +fn clone_sender_state>(state: &Arc>) -> Arc> { + // Live sender count drives receiver disconnect detection. + state.senders.fetch_add(1, Ordering::Relaxed); + state.clone() +} + +fn drop_sender_state>(state: &State) { + let previous = state.senders.fetch_sub(1, Ordering::AcqRel); + assert!(previous > 0); + // Wake a receiver that is parked waiting for data or disconnect. + if previous == 1 { + state.waker.wake(); + } +} + +fn fmt_sender_state>( + name: &str, + state: &State, + f: &mut fmt::Formatter<'_>, +) -> fmt::Result { + f.debug_struct(name) + .field("capacity", &state.ready.capacity()) + .field("closed", &state.closed.load(Ordering::Acquire)) + .finish() +} + +async fn recv_from>(state: &State) -> Option { + poll_fn(|cx| state.poll_recv(cx)).await +} + +fn try_recv_from>(state: &State) -> Result { + if let Some(message) = state.pop() { + return Ok(message); + } + if state.is_disconnected() { + return state.pop().ok_or(TryRecvError::Disconnected); + } + Err(TryRecvError::Empty) +} + /// Sender half of a mailbox. pub struct Sender { state: Arc>, @@ -599,61 +650,41 @@ pub struct UnreliableSender { impl Clone for Sender { fn clone(&self) -> Self { - // Live sender count drives receiver disconnect detection. - self.state.senders.fetch_add(1, Ordering::Relaxed); Self { - state: self.state.clone(), + state: clone_sender_state(&self.state), } } } impl Clone for UnreliableSender { fn clone(&self) -> Self { - // Live sender count drives receiver disconnect detection. - self.state.senders.fetch_add(1, Ordering::Relaxed); Self { - state: self.state.clone(), + state: clone_sender_state(&self.state), } } } impl Drop for Sender { fn drop(&mut self) { - let previous = self.state.senders.fetch_sub(1, Ordering::AcqRel); - assert!(previous > 0); - // Wake a receiver that is parked waiting for data or disconnect. - if previous == 1 { - self.state.waker.wake(); - } + drop_sender_state(&self.state); } } impl Drop for UnreliableSender { fn drop(&mut self) { - let previous = self.state.senders.fetch_sub(1, Ordering::AcqRel); - assert!(previous > 0); - // Wake a receiver that is parked waiting for data or disconnect. - if previous == 1 { - self.state.waker.wake(); - } + drop_sender_state(&self.state); } } impl fmt::Debug for Sender { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("Sender") - .field("capacity", &self.state.ready.capacity()) - .field("closed", &self.state.closed.load(Ordering::Acquire)) - .finish() + fmt_sender_state("Sender", &self.state, f) } } impl fmt::Debug for UnreliableSender { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - f.debug_struct("UnreliableSender") - .field("capacity", &self.state.ready.capacity()) - .field("closed", &self.state.closed.load(Ordering::Acquire)) - .finish() + fmt_sender_state("UnreliableSender", &self.state, f) } } @@ -694,20 +725,12 @@ pub struct UnreliableReceiver { } impl Receiver { - fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll> { - self.state.poll_recv(cx) - } - - fn pop(&mut self) -> Option { - self.state.pop() - } - /// Receive the next message. /// /// Returns `None` after all senders are dropped and all buffered messages /// have been drained. pub async fn recv(&mut self) -> Option { - poll_fn(|cx| self.poll_recv(cx)).await + recv_from(&self.state).await } /// Try to receive the next message without waiting. @@ -715,31 +738,17 @@ impl Receiver { /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and /// all buffered messages have been drained. pub fn try_recv(&mut self) -> Result { - if let Some(message) = self.pop() { - return Ok(message); - } - if self.state.is_disconnected() { - return self.pop().ok_or(TryRecvError::Disconnected); - } - Err(TryRecvError::Empty) + try_recv_from(&self.state) } } impl UnreliableReceiver { - fn poll_recv(&mut self, cx: &mut Context<'_>) -> Poll> { - self.state.poll_recv(cx) - } - - fn pop(&mut self) -> Option { - self.state.pop() - } - /// Receive the next message. /// /// Returns `None` after all senders are dropped and all buffered messages /// have been drained. pub async fn recv(&mut self) -> Option { - poll_fn(|cx| self.poll_recv(cx)).await + recv_from(&self.state).await } /// Try to receive the next message without waiting. @@ -747,13 +756,7 @@ impl UnreliableReceiver { /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and /// all buffered messages have been drained. pub fn try_recv(&mut self) -> Result { - if let Some(message) = self.pop() { - return Ok(message); - } - if self.state.is_disconnected() { - return self.pop().ok_or(TryRecvError::Disconnected); - } - Err(TryRecvError::Empty) + try_recv_from(&self.state) } } @@ -771,14 +774,7 @@ impl Drop for UnreliableReceiver { /// Create a new bounded mailbox. pub fn new(metrics: impl Metrics, capacity: NonZeroUsize) -> (Sender, Receiver) { - let state = Arc::new(State { - ready: Ready::new(capacity.get()), - overflow: OverflowState::new(), - backoff: metrics.counter("backoff", "number of enqueue calls that requested backoff"), - closed: AtomicBool::new(false), - senders: AtomicUsize::new(1), - waker: AtomicWaker::new(), - }); + let state = new_state(metrics, capacity); ( Sender { state: state.clone(), @@ -792,14 +788,7 @@ pub fn new_unreliable( metrics: impl Metrics, capacity: NonZeroUsize, ) -> (UnreliableSender, UnreliableReceiver) { - let state = Arc::new(State { - ready: Ready::new(capacity.get()), - overflow: OverflowState::new(), - backoff: metrics.counter("backoff", "number of enqueue calls that requested backoff"), - closed: AtomicBool::new(false), - senders: AtomicUsize::new(1), - waker: AtomicWaker::new(), - }); + let state = new_state(metrics, capacity); ( UnreliableSender { state: state.clone(), @@ -1127,7 +1116,7 @@ mod tests { #[test] fn poll_recv_drains_buffered_messages_after_senders_drop() { - let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + let (sender, receiver) = new_unreliable(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); @@ -1143,14 +1132,14 @@ mod tests { drop(sender); assert_eq!( - receiver.poll_recv(&mut cx), + receiver.state.poll_recv(&mut cx), Poll::Ready(Some(Message::Vote(1))) ); assert_eq!( - receiver.poll_recv(&mut cx), + receiver.state.poll_recv(&mut cx), Poll::Ready(Some(Message::Buffered(2))) ); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Ready(None)); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Ready(None)); } #[test] @@ -1326,18 +1315,18 @@ mod tests { #[test] fn pending_recv_wakes_when_senders_drop() { - let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); + let (sender, receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Pending); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Pending); assert_eq!(wakes.count(), 0); drop(sender); assert_eq!(wakes.count(), 1); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Ready(None)); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Ready(None)); } #[test] @@ -1347,7 +1336,7 @@ mod tests { let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Pending); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Pending); assert_eq!(wakes.count(), 0); // Prime ready directly to isolate the overflow wake after registration. @@ -1364,12 +1353,12 @@ mod tests { #[test] fn receiver_drop_blocks_ready_fast_path_feedback() { - let (sender, mut receiver) = new_unreliable(NZUsize!(1)); + let (sender, receiver) = new_unreliable(NZUsize!(1)); let wakes = Arc::new(WakeCounter::default()); let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Pending); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Pending); drop(receiver); assert_eq!( @@ -1470,7 +1459,7 @@ mod tests { let waker = waker_ref(&wakes); let mut cx = Context::from_waker(&waker); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Pending); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Pending); assert_eq!(wakes.count(), 0); assert_eq!(sender.state.ready.push(SpillMessage::FillReady), Ok(())); @@ -1702,14 +1691,14 @@ mod loom_tests { drop(sender); }); - let poll = receiver.poll_recv(&mut cx); + let poll = receiver.state.poll_recv(&mut cx); close.join().unwrap(); match poll { Poll::Ready(None) => {} Poll::Pending => { assert!(wakes.load(Ordering::Acquire) > 0); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Ready(None)); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Ready(None)); } Poll::Ready(Some(_)) => panic!("unexpected message"), } @@ -1731,7 +1720,7 @@ mod loom_tests { ); }); - let poll = receiver.poll_recv(&mut cx); + let poll = receiver.state.poll_recv(&mut cx); enqueue.join().unwrap(); match poll { @@ -1739,7 +1728,7 @@ mod loom_tests { Poll::Pending => { assert!(wakes.load(Ordering::Acquire) > 0); assert_eq!( - receiver.poll_recv(&mut cx), + receiver.state.poll_recv(&mut cx), Poll::Ready(Some(Message::Spill(0))) ); } @@ -1747,7 +1736,7 @@ mod loom_tests { Poll::Ready(Some(message)) => panic!("unexpected message: {message:?}"), } - assert_eq!(receiver.poll_recv(&mut cx), Poll::Ready(None)); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Ready(None)); }); } @@ -1813,7 +1802,7 @@ mod loom_tests { let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); - assert_eq!(receiver.poll_recv(&mut cx), Poll::Pending); + assert_eq!(receiver.state.poll_recv(&mut cx), Poll::Pending); let close = thread::spawn(move || { drop(receiver); From 3eb4fd94c29ce6ddde2be7ebd7680ece34b2bc3e Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 13:21:19 -0700 Subject: [PATCH 10/13] loom --- actor/src/mailbox.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index be92c7bb378..fb410c2a1e6 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -1682,7 +1682,7 @@ mod loom_tests { #[test] fn sender_drop_racing_waker_registration_wakes_or_disconnects() { loom::model(|| { - let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); + let (sender, receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1708,7 +1708,7 @@ mod loom_tests { #[test] fn sender_enqueue_then_drop_racing_poll_recv_drains_message() { loom::model(|| { - let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); + let (sender, receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); @@ -1797,7 +1797,7 @@ mod loom_tests { #[test] fn receiver_drop_racing_ready_fast_path_feedback_wakes_if_ready() { loom::model(|| { - let (sender, mut receiver) = new_unreliable::(NZUsize!(1)); + let (sender, receiver) = new_unreliable::(NZUsize!(1)); let wakes = Arc::new(AtomicUsize::new(0)); let waker = counting_waker(wakes.clone()); let mut cx = Context::from_waker(&waker); From 45090b79443e7cc4d1c2b854d6d8c54e6a1df5fa Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 21:45:47 -0700 Subject: [PATCH 11/13] make more ergonomic --- actor/src/lib.rs | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/actor/src/lib.rs b/actor/src/lib.rs index e9be2f6d06f..3195779ab3c 100644 --- a/actor/src/lib.rs +++ b/actor/src/lib.rs @@ -37,17 +37,32 @@ commonware_macros::stability_scope!(BETA { Rejected, } - impl Unreliable { - /// Wrap endpoint feedback for an endpoint that may reject work. - pub const fn new(feedback: Feedback) -> Self { - Self::Outcome(feedback) + impl Unreliable { + /// Wrap an outcome for an operation that may reject work. + pub const fn new(outcome: T) -> Self { + Self::Outcome(outcome) } - /// Create rejected feedback. + /// Create a rejected result. pub const fn rejected() -> Self { Self::Rejected } + /// Returns `true` when the operation was rejected before producing an outcome. + pub const fn is_rejected(&self) -> bool { + matches!(self, Self::Rejected) + } + + /// Returns the outcome when the operation was not rejected. + pub fn outcome(self) -> Option { + match self { + Self::Outcome(outcome) => Some(outcome), + Self::Rejected => None, + } + } + } + + impl Unreliable { /// Returns `true` when the endpoint handled the submission. pub const fn accepted(self) -> bool { match self { From 5b003b885e7ae6d67d9ca51be5b3b9c2aec399e4 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 21:51:09 -0700 Subject: [PATCH 12/13] nit --- actor/src/mailbox.rs | 318 +++++++++++++++++++++---------------------- 1 file changed, 159 insertions(+), 159 deletions(-) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index fb410c2a1e6..0cece4602a9 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -221,6 +221,165 @@ impl Mode for mode::Unreliable { } } +/// Sender half of a mailbox. +pub struct Sender { + state: Arc>, +} + +/// Sender half of an unreliable mailbox. +pub struct UnreliableSender { + state: Arc>, +} + +impl Clone for Sender { + fn clone(&self) -> Self { + Self { + state: clone_sender_state(&self.state), + } + } +} + +impl Clone for UnreliableSender { + fn clone(&self) -> Self { + Self { + state: clone_sender_state(&self.state), + } + } +} + +impl Drop for Sender { + fn drop(&mut self) { + drop_sender_state(&self.state); + } +} + +impl Drop for UnreliableSender { + fn drop(&mut self) { + drop_sender_state(&self.state); + } +} + +impl fmt::Debug for Sender { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt_sender_state("Sender", &self.state, f) + } +} + +impl fmt::Debug for UnreliableSender { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + fmt_sender_state("UnreliableSender", &self.state, f) + } +} + +impl Sender { + /// Submit a message without waiting for inbox capacity. + #[must_use = "caller must handle enqueue feedback"] + pub fn enqueue(&self, message: T) -> Feedback { + self.state.enqueue(message) + } +} + +impl UnreliableSender { + /// Submit a message without waiting for inbox capacity, allowing policy rejection. + #[must_use = "caller must handle enqueue feedback"] + pub fn enqueue(&self, message: T) -> Unreliable { + self.state.enqueue(message) + } +} + +/// Receiver half of a mailbox. +/// +/// Dropping the receiver closes the mailbox and drains buffered messages. +/// +/// Dropping the last sender disconnects the mailbox, but the receiver continues +/// returning buffered messages until ready and overflow are empty. +pub struct Receiver { + state: Arc>, +} + +/// Receiver half of an unreliable mailbox. +/// +/// Dropping the receiver closes the mailbox and drains buffered messages. +/// +/// Dropping the last sender disconnects the mailbox, but the receiver continues +/// returning buffered messages until ready and overflow are empty. +pub struct UnreliableReceiver { + state: Arc>, +} + +impl Receiver { + /// Receive the next message. + /// + /// Returns `None` after all senders are dropped and all buffered messages + /// have been drained. + pub async fn recv(&mut self) -> Option { + recv_from(&self.state).await + } + + /// Try to receive the next message without waiting. + /// + /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and + /// all buffered messages have been drained. + pub fn try_recv(&mut self) -> Result { + try_recv_from(&self.state) + } +} + +impl UnreliableReceiver { + /// Receive the next message. + /// + /// Returns `None` after all senders are dropped and all buffered messages + /// have been drained. + pub async fn recv(&mut self) -> Option { + recv_from(&self.state).await + } + + /// Try to receive the next message without waiting. + /// + /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and + /// all buffered messages have been drained. + pub fn try_recv(&mut self) -> Result { + try_recv_from(&self.state) + } +} + +impl Drop for Receiver { + fn drop(&mut self) { + self.state.close(); + } +} + +impl Drop for UnreliableReceiver { + fn drop(&mut self) { + self.state.close(); + } +} + +/// Create a new bounded mailbox. +pub fn new(metrics: impl Metrics, capacity: NonZeroUsize) -> (Sender, Receiver) { + let state = new_state(metrics, capacity); + ( + Sender { + state: state.clone(), + }, + Receiver { state }, + ) +} + +/// Create a new bounded unreliable mailbox. +pub fn new_unreliable( + metrics: impl Metrics, + capacity: NonZeroUsize, +) -> (UnreliableSender, UnreliableReceiver) { + let state = new_state(metrics, capacity); + ( + UnreliableSender { + state: state.clone(), + }, + UnreliableReceiver { state }, + ) +} + // `activity` packs the published overflow state and in-flight overflow // mutations into one atomic word. The overflow lock serializes actual // overflow changes (this word lets the ready fast path avoid that lock when @@ -638,165 +797,6 @@ fn try_recv_from>(state: &State) -> Result Err(TryRecvError::Empty) } -/// Sender half of a mailbox. -pub struct Sender { - state: Arc>, -} - -/// Sender half of an unreliable mailbox. -pub struct UnreliableSender { - state: Arc>, -} - -impl Clone for Sender { - fn clone(&self) -> Self { - Self { - state: clone_sender_state(&self.state), - } - } -} - -impl Clone for UnreliableSender { - fn clone(&self) -> Self { - Self { - state: clone_sender_state(&self.state), - } - } -} - -impl Drop for Sender { - fn drop(&mut self) { - drop_sender_state(&self.state); - } -} - -impl Drop for UnreliableSender { - fn drop(&mut self) { - drop_sender_state(&self.state); - } -} - -impl fmt::Debug for Sender { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - fmt_sender_state("Sender", &self.state, f) - } -} - -impl fmt::Debug for UnreliableSender { - fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { - fmt_sender_state("UnreliableSender", &self.state, f) - } -} - -impl Sender { - /// Submit a message without waiting for inbox capacity. - #[must_use = "caller must handle enqueue feedback"] - pub fn enqueue(&self, message: T) -> Feedback { - self.state.enqueue(message) - } -} - -impl UnreliableSender { - /// Submit a message without waiting for inbox capacity, allowing policy rejection. - #[must_use = "caller must handle enqueue feedback"] - pub fn enqueue(&self, message: T) -> Unreliable { - self.state.enqueue(message) - } -} - -/// Receiver half of a mailbox. -/// -/// Dropping the receiver closes the mailbox and drains buffered messages. -/// -/// Dropping the last sender disconnects the mailbox, but the receiver continues -/// returning buffered messages until ready and overflow are empty. -pub struct Receiver { - state: Arc>, -} - -/// Receiver half of an unreliable mailbox. -/// -/// Dropping the receiver closes the mailbox and drains buffered messages. -/// -/// Dropping the last sender disconnects the mailbox, but the receiver continues -/// returning buffered messages until ready and overflow are empty. -pub struct UnreliableReceiver { - state: Arc>, -} - -impl Receiver { - /// Receive the next message. - /// - /// Returns `None` after all senders are dropped and all buffered messages - /// have been drained. - pub async fn recv(&mut self) -> Option { - recv_from(&self.state).await - } - - /// Try to receive the next message without waiting. - /// - /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and - /// all buffered messages have been drained. - pub fn try_recv(&mut self) -> Result { - try_recv_from(&self.state) - } -} - -impl UnreliableReceiver { - /// Receive the next message. - /// - /// Returns `None` after all senders are dropped and all buffered messages - /// have been drained. - pub async fn recv(&mut self) -> Option { - recv_from(&self.state).await - } - - /// Try to receive the next message without waiting. - /// - /// Returns [`TryRecvError::Disconnected`] after all senders are dropped and - /// all buffered messages have been drained. - pub fn try_recv(&mut self) -> Result { - try_recv_from(&self.state) - } -} - -impl Drop for Receiver { - fn drop(&mut self) { - self.state.close(); - } -} - -impl Drop for UnreliableReceiver { - fn drop(&mut self) { - self.state.close(); - } -} - -/// Create a new bounded mailbox. -pub fn new(metrics: impl Metrics, capacity: NonZeroUsize) -> (Sender, Receiver) { - let state = new_state(metrics, capacity); - ( - Sender { - state: state.clone(), - }, - Receiver { state }, - ) -} - -/// Create a new bounded unreliable mailbox. -pub fn new_unreliable( - metrics: impl Metrics, - capacity: NonZeroUsize, -) -> (UnreliableSender, UnreliableReceiver) { - let state = new_state(metrics, capacity); - ( - UnreliableSender { - state: state.clone(), - }, - UnreliableReceiver { state }, - ) -} - #[cfg(test)] mod mocks { use commonware_runtime::{ From cf05798093613e5c12e7eab3e95475cee8792d86 Mon Sep 17 00:00:00 2001 From: Patrick O'Grady Date: Thu, 21 May 2026 22:08:41 -0700 Subject: [PATCH 13/13] lints --- actor/src/mailbox.rs | 4 +- .../simplex/scheme/bls12381_threshold/mod.rs | 2 +- .../simplex/scheme/bls12381_threshold/vrf.rs | 164 +++++++++++++++++- 3 files changed, 159 insertions(+), 11 deletions(-) diff --git a/actor/src/mailbox.rs b/actor/src/mailbox.rs index 0cece4602a9..0471bae2aac 100644 --- a/actor/src/mailbox.rs +++ b/actor/src/mailbox.rs @@ -93,7 +93,7 @@ pub trait Policy: Sized { /// Overflow storage used by this policy. type Overflow: Overflow; - /// Handle `message` when it cannot enter the bounded ready queue immediately. + /// Reliably handle `message` when it cannot enter the bounded ready queue immediately. /// /// This may retain the message, coalesce it with retained work, replace older retained work, /// or deliberately do no work because the message is already satisfied, superseded, or no @@ -116,7 +116,7 @@ pub trait UnreliablePolicy: Sized { /// Overflow storage used by this policy. type Overflow: Overflow; - /// Handle `message` when it cannot enter the bounded ready queue immediately. + /// Unreliably handle `message` when it cannot enter the bounded ready queue immediately. /// /// Returns `true` when the policy considered the message's effects. This includes retaining /// the message, coalescing it with retained work, replacing older retained work, or deliberately diff --git a/consensus/src/simplex/scheme/bls12381_threshold/mod.rs b/consensus/src/simplex/scheme/bls12381_threshold/mod.rs index 3f77ea06c87..3c03084c1e0 100644 --- a/consensus/src/simplex/scheme/bls12381_threshold/mod.rs +++ b/consensus/src/simplex/scheme/bls12381_threshold/mod.rs @@ -5,7 +5,7 @@ //! - [`standard`]: Certificates contain only a vote signature (requires half the computation to verify //! partial signatures and recover threshold signatures as [`vrf`]). //! -//! - [`vrf`]: Certificates contain a vote signature and a view signature (a seed that can be used +//! - [`vrf`]: Certificates contain a vote signature and a round signature (a seed that can be used //! as a VRF). //! //! # Non-Attributable Signatures diff --git a/consensus/src/simplex/scheme/bls12381_threshold/vrf.rs b/consensus/src/simplex/scheme/bls12381_threshold/vrf.rs index c775876cafb..898d57fb47c 100644 --- a/consensus/src/simplex/scheme/bls12381_threshold/vrf.rs +++ b/consensus/src/simplex/scheme/bls12381_threshold/vrf.rs @@ -1,6 +1,6 @@ //! BLS12-381 threshold VRF implementation of the [`Scheme`] trait for `simplex`. //! -//! Certificates contain a vote signature and a view signature (a seed that can be used +//! Certificates contain a vote signature and a round signature (a seed that can be used //! as a VRF). //! //! # Using the VRF @@ -314,7 +314,7 @@ where pub struct Signature { /// Signature over the consensus vote message (partial or recovered aggregate). pub vote_signature: V::Signature, - /// Signature over the per-view seed (partial or recovered aggregate). + /// Signature over the per-round seed (partial or recovered aggregate). pub seed_signature: V::Signature, } @@ -833,18 +833,18 @@ impl certificate::Scheme for Scheme { let vote_message = context.message(); entries.push((vote_namespace, vote_message, cert.vote_signature)); - // Seed signatures are per-view, so multiple certificates for the same view + // Seed signatures are per-round, so multiple certificates for the same round // (e.g., notarization and finalization) share the same seed. We only include // each unique seed once in the aggregate, but verify all certificates for a - // view have matching seeds. - if let Some(previous) = seeds.get(&context.view()) { + // round have matching seeds. + let seed_message = seed_message_from_subject(&context); + if let Some(previous) = seeds.get(&seed_message) { if *previous != cert.seed_signature { return false; } } else { - let seed_message = seed_message_from_subject(&context); - entries.push((&namespace.seed, seed_message, cert.seed_signature)); - seeds.insert(context.view(), cert.seed_signature); + entries.push((&namespace.seed, seed_message.clone(), cert.seed_signature)); + seeds.insert(seed_message, cert.seed_signature); } } @@ -2027,6 +2027,154 @@ mod tests { verify_certificates_rejects_malleability::(); } + fn assemble_notarization_certificate( + schemes: &[Scheme], + proposal: &Proposal, + ) -> Certificate { + let quorum = N3f1::quorum(schemes.len()) as usize; + let votes: Vec<_> = schemes + .iter() + .take(quorum) + .map(|scheme| scheme.sign(Subject::Notarize { proposal }).unwrap()) + .collect(); + + schemes[0] + .assemble::<_, N3f1>(votes, &Sequential) + .expect("assemble notarization certificate") + } + + fn assemble_finalization_certificate( + schemes: &[Scheme], + proposal: &Proposal, + ) -> Certificate { + let quorum = N3f1::quorum(schemes.len()) as usize; + let votes: Vec<_> = schemes + .iter() + .skip(schemes.len() - quorum) + .map(|scheme| scheme.sign(Subject::Finalize { proposal }).unwrap()) + .collect(); + + schemes[0] + .assemble::<_, N3f1>(votes, &Sequential) + .expect("assemble finalization certificate") + } + + fn verify_certificates_accepts_shared_round_seed() { + let mut rng = test_rng(); + let (schemes, verifier) = setup_signers::(4, 81); + let proposal = sample_proposal(Epoch::new(1), View::new(35), 19); + let notarization_certificate = assemble_notarization_certificate(&schemes, &proposal); + let finalization_certificate = assemble_finalization_certificate(&schemes, &proposal); + + assert!(verifier.verify_certificates::<_, Sha256Digest, _, N3f1>( + &mut rng, + [ + ( + Subject::Notarize { + proposal: &proposal, + }, + ¬arization_certificate, + ), + ( + Subject::Finalize { + proposal: &proposal, + }, + &finalization_certificate, + ), + ] + .into_iter(), + &Sequential, + )); + } + + #[test] + fn test_verify_certificates_accepts_shared_round_seed() { + verify_certificates_accepts_shared_round_seed::(); + verify_certificates_accepts_shared_round_seed::(); + } + + fn verify_certificates_rejects_cross_epoch_seed_replay() { + let mut rng = test_rng(); + let (schemes, verifier) = setup_signers::(4, 83); + let view = View::new(35); + let proposal1 = sample_proposal(Epoch::new(1), view, 19); + let proposal2 = sample_proposal(Epoch::new(2), view, 20); + let certificate1 = assemble_notarization_certificate(&schemes, &proposal1); + let certificate2 = assemble_notarization_certificate(&schemes, &proposal2); + + assert!(verifier.verify_certificates::<_, Sha256Digest, _, N3f1>( + &mut rng, + [ + ( + Subject::Notarize { + proposal: &proposal1, + }, + &certificate1, + ), + ( + Subject::Notarize { + proposal: &proposal2, + }, + &certificate2, + ), + ] + .into_iter(), + &Sequential, + )); + + let cert1 = certificate1.get().unwrap(); + let cert2 = certificate2.get().unwrap(); + let forged_certificate2: Certificate = Signature { + vote_signature: cert2.vote_signature, + seed_signature: cert1.seed_signature, + } + .into(); + + assert!(!verifier.verify_certificate::<_, Sha256Digest, N3f1>( + &mut rng, + Subject::Notarize { + proposal: &proposal2, + }, + &forged_certificate2, + &Sequential, + )); + + let batch = [ + ( + Subject::Notarize { + proposal: &proposal1, + }, + &certificate1, + ), + ( + Subject::Notarize { + proposal: &proposal2, + }, + &forged_certificate2, + ), + ]; + + assert!(!verifier.verify_certificates::<_, Sha256Digest, _, N3f1>( + &mut rng, + batch.iter().copied(), + &Sequential, + )); + assert_eq!( + verifier.verify_certificates_bisect::<_, Sha256Digest, N3f1>( + &mut rng, + &batch, + &Sequential, + ), + vec![true, false], + ); + } + + #[test] + fn test_verify_certificates_rejects_cross_epoch_seed_replay() { + verify_certificates_rejects_cross_epoch_seed_replay::(); + verify_certificates_rejects_cross_epoch_seed_replay::(); + } + #[cfg(feature = "arbitrary")] mod conformance { use super::*;