Skip to content

Commit e76a37f

Browse files
committed
Use hashbrown replacements for std equivalents
1 parent 4d1c1a3 commit e76a37f

17 files changed

+52
-20
lines changed

.github/workflows/build.yml

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,21 +14,34 @@ jobs:
1414
# 1.41.0 is Debian stable
1515
1.41.0,
1616
# 1.45.2 is MSRV for lightning-net-tokio, lightning-block-sync, and coverage generation
17-
1.45.2]
17+
1.45.2,
18+
# 1.49.0 is MSRV for no_std builds using hashbrown
19+
1.49.0]
1820
include:
1921
- toolchain: stable
2022
build-net-tokio: true
23+
build-no-std: true
2124
- toolchain: stable
2225
platform: macos-latest
2326
build-net-tokio: true
27+
build-no-std: true
2428
- toolchain: stable
2529
platform: windows-latest
2630
build-net-tokio: true
31+
build-no-std: true
2732
- toolchain: beta
2833
build-net-tokio: true
34+
build-no-std: true
35+
- toolchain: 1.36.0
36+
build-no-std: false
37+
- toolchain: 1.41.0
38+
build-no-std: false
2939
- toolchain: 1.45.2
3040
build-net-tokio: true
41+
build-no-std: false
3142
coverage: true
43+
- toolchain: 1.49.0
44+
build-no-std: true
3245
runs-on: ${{ matrix.platform }}
3346
steps:
3447
- name: Checkout source code
@@ -47,7 +60,13 @@ jobs:
4760
run: RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always
4861
- name: Build on Rust ${{ matrix.toolchain }}
4962
if: "! matrix.build-net-tokio"
50-
run: cargo build --verbose --color always -p lightning && cargo build --verbose --color always -p lightning-invoice && cargo build --verbose --color always -p lightning-persister
63+
run: |
64+
cargo build --verbose --color always -p lightning
65+
cargo build --verbose --color always -p lightning-invoice
66+
cargo build --verbose --color always -p lightning-persister
67+
cd lightning
68+
cargo build --verbose --color always --features hashbrown
69+
cd ..
5170
- name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features
5271
if: "matrix.build-net-tokio && !matrix.coverage"
5372
run: |
@@ -56,6 +75,8 @@ jobs:
5675
cargo build --verbose --color always --features rpc-client
5776
cargo build --verbose --color always --features rpc-client,rest-client
5877
cargo build --verbose --color always --features rpc-client,rest-client,tokio
78+
cd ../lightning
79+
cargo build --verbose --color always --features hashbrown
5980
cd ..
6081
- name: Build Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
6182
if: matrix.coverage
@@ -65,13 +86,21 @@ jobs:
6586
RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client
6687
RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client
6788
RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features rpc-client,rest-client,tokio
89+
cd ../lightning
90+
RUSTFLAGS="-C link-dead-code" cargo build --verbose --color always --features hashbrown
6891
cd ..
6992
- name: Test on Rust ${{ matrix.toolchain }} with net-tokio
7093
if: "matrix.build-net-tokio && !matrix.coverage"
7194
run: cargo test --verbose --color always
7295
- name: Test on Rust ${{ matrix.toolchain }} with net-tokio and full code-linking for coverage generation
7396
if: matrix.coverage
7497
run: RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always
98+
- name: Test on no_std bullds Rust ${{ matrix.toolchain }}
99+
if: "matrix.build-no-std"
100+
run: |
101+
cd lightning
102+
RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features hashbrown
103+
cd ..
75104
- name: Test on Rust ${{ matrix.toolchain }}
76105
if: "! matrix.build-net-tokio"
77106
run: cargo test --verbose --color always -p lightning && cargo test --verbose --color always -p lightning-invoice && cargo build --verbose --color always -p lightning-persister
@@ -83,6 +112,8 @@ jobs:
83112
cargo test --verbose --color always --features rpc-client
84113
cargo test --verbose --color always --features rpc-client,rest-client
85114
cargo test --verbose --color always --features rpc-client,rest-client,tokio
115+
cd ../lightning
116+
cargo test --verbose --color always --features hashbrown
86117
cd ..
87118
- name: Test Block Sync Clients on Rust ${{ matrix.toolchain }} with features and full code-linking for coverage generation
88119
if: matrix.coverage
@@ -92,7 +123,6 @@ jobs:
92123
RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client
93124
RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client
94125
RUSTFLAGS="-C link-dead-code" cargo test --verbose --color always --features rpc-client,rest-client,tokio
95-
cd ..
96126
- name: Install deps for kcov
97127
if: matrix.coverage
98128
run: |
@@ -157,6 +187,7 @@ jobs:
157187
run: |
158188
cd lightning
159189
RUSTFLAGS="--cfg=require_route_graph_test" cargo test
190+
RUSTFLAGS="--cfg=require_route_graph_test" cargo test --features hashbrown
160191
cd ..
161192
- name: Run benchmarks on Rust ${{ matrix.toolchain }}
162193
run: |

ci/check-compiles.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ cargo check
66
cargo doc
77
cargo doc --document-private-items
88
cd fuzz && cargo check --features=stdin_fuzz
9+
cd ../lightning && cargo check --no-default-features --features=no_std

lightning/Cargo.toml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,12 @@ max_level_debug = []
2525
# This is unsafe to use in production because it may result in the counterparty publishing taking our funds.
2626
unsafe_revoked_tx_signing = []
2727
unstable = []
28+
no_std = ["hashbrown"]
2829

2930
[dependencies]
3031
bitcoin = "0.26"
3132

33+
hashbrown = { version = "0.11", optional = true }
3234
hex = { version = "0.3", optional = true }
3335
regex = { version = "0.1.80", optional = true }
3436

lightning/src/chain/chainmonitor.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ use util::events;
3838
use util::events::EventHandler;
3939

4040
use prelude::*;
41-
use std::collections::{HashMap, hash_map};
4241
use std::sync::RwLock;
4342
use core::ops::Deref;
4443

lightning/src/chain/channelmonitor.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ use util::byte_utils;
5252
use util::events::Event;
5353

5454
use prelude::*;
55-
use std::collections::{HashMap, HashSet};
5655
use core::{cmp, mem};
5756
use std::io::Error;
5857
use core::ops::Deref;

lightning/src/chain/keysinterface.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,6 @@ use ln::chan_utils::{HTLCOutputInCommitment, make_funding_redeemscript, ChannelP
3838
use ln::msgs::UnsignedChannelAnnouncement;
3939

4040
use prelude::*;
41-
use std::collections::HashSet;
4241
use core::sync::atomic::{AtomicUsize, Ordering};
4342
use std::io::Error;
4443
use ln::msgs::{DecodeError, MAX_VALUE_MSAT};

lightning/src/chain/onchaintx.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ use util::byte_utils;
3434

3535
use prelude::*;
3636
use alloc::collections::BTreeMap;
37-
use std::collections::HashMap;
3837
use core::cmp;
3938
use core::ops::Deref;
4039
use core::mem::replace;

lightning/src/lib.rs

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,5 +44,12 @@ pub mod ln;
4444
pub mod routing;
4545

4646
mod prelude {
47-
pub use alloc::{vec, vec::Vec, string::String};
48-
}
47+
#[cfg(feature = "hashbrown")]
48+
extern crate hashbrown;
49+
50+
pub use alloc::{vec, vec::Vec, string::String, collections::VecDeque};
51+
#[cfg(not(feature = "hashbrown"))]
52+
pub use std::collections::{HashMap, HashSet, hash_map};
53+
#[cfg(feature = "hashbrown")]
54+
pub use self::hashbrown::{HashMap, HashSet, hash_map};
55+
}

lightning/src/ln/chanmon_update_fail_tests.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ use ln::functional_test_utils::*;
4141
use util::test_utils;
4242

4343
use prelude::*;
44-
use std::collections::HashMap;
4544
use std::sync::{Arc, Mutex};
4645

4746
// If persister_fail is true, we have the persister return a PermanentFailure

lightning/src/ln/channelmanager.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ use util::errors::APIError;
6464
use prelude::*;
6565
use core::{cmp, mem};
6666
use core::cell::RefCell;
67-
use std::collections::{HashMap, hash_map, HashSet};
6867
use std::io::{Cursor, Read};
6968
use std::sync::{Arc, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard};
7069
use core::sync::atomic::{AtomicUsize, Ordering};

lightning/src/ln/functional_test_utils.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ use core::cell::RefCell;
4444
use std::rc::Rc;
4545
use std::sync::{Arc, Mutex};
4646
use core::mem;
47-
use std::collections::HashMap;
4847

4948
pub const CHAN_CONFIRM_DEPTH: u32 = 10;
5049

lightning/src/ln/functional_tests.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ use regex;
5252

5353
use prelude::*;
5454
use alloc::collections::BTreeSet;
55-
use std::collections::{HashMap, HashSet};
5655
use core::default::Default;
5756
use std::sync::{Arc, Mutex};
5857

lightning/src/ln/peer_handler.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,6 @@ use routing::network_graph::NetGraphMsgHandler;
3232

3333
use prelude::*;
3434
use alloc::collections::LinkedList;
35-
use std::collections::{HashMap,hash_map,HashSet};
3635
use std::sync::{Arc, Mutex};
3736
use core::sync::atomic::{AtomicUsize, Ordering};
3837
use core::{cmp, hash, fmt, mem};

lightning/src/ln/reorg_tests.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ use bitcoin::blockdata::block::{Block, BlockHeader};
2323
use bitcoin::hash_types::BlockHash;
2424

2525
use prelude::*;
26-
use std::collections::HashMap;
2726
use core::mem;
2827

2928
use ln::functional_test_utils::*;

lightning/src/routing/router.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,6 @@ use util::logger::Logger;
2424
use prelude::*;
2525
use alloc::collections::BinaryHeap;
2626
use core::cmp;
27-
use std::collections::HashMap;
2827
use core::ops::Deref;
2928

3029
/// A hop in a route
@@ -3843,16 +3842,19 @@ mod tests {
38433842
}
38443843
}
38453844

3845+
#[cfg(not(feature = "no_std"))]
38463846
pub(super) fn random_init_seed() -> u64 {
38473847
// Because the default HashMap in std pulls OS randomness, we can use it as a (bad) RNG.
38483848
use core::hash::{BuildHasher, Hasher};
38493849
let seed = std::collections::hash_map::RandomState::new().build_hasher().finish();
38503850
println!("Using seed of {}", seed);
38513851
seed
38523852
}
3853+
#[cfg(not(feature = "no_std"))]
38533854
use util::ser::Readable;
38543855

38553856
#[test]
3857+
#[cfg(not(feature = "no_std"))]
38563858
fn generate_routes() {
38573859
let mut d = match super::test_utils::get_route_file() {
38583860
Ok(f) => f,
@@ -3880,6 +3882,7 @@ mod tests {
38803882
}
38813883

38823884
#[test]
3885+
#[cfg(not(feature = "no_std"))]
38833886
fn generate_routes_mpp() {
38843887
let mut d = match super::test_utils::get_route_file() {
38853888
Ok(f) => f,
@@ -3907,7 +3910,7 @@ mod tests {
39073910
}
39083911
}
39093912

3910-
#[cfg(test)]
3913+
#[cfg(all(test, not(feature = "no_std")))]
39113914
pub(crate) mod test_utils {
39123915
use std::fs::File;
39133916
/// Tries to open a network graph file, or panics with a URL to fetch it.
@@ -3934,7 +3937,7 @@ pub(crate) mod test_utils {
39343937
}
39353938
}
39363939

3937-
#[cfg(all(test, feature = "unstable"))]
3940+
#[cfg(all(test, feature = "unstable", not(feature = "no_std")))]
39383941
mod benches {
39393942
use super::*;
39403943
use util::logger::{Logger, Record};

lightning/src/util/ser.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@
1212
1313
use prelude::*;
1414
use std::io::{Read, Write};
15-
use std::collections::HashMap;
1615
use core::hash::Hash;
1716
use std::sync::Mutex;
1817
use core::cmp;

lightning/src/util/test_utils.rs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ use core::time::Duration;
4242
use std::sync::{Mutex, Arc};
4343
use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
4444
use core::{cmp, mem};
45-
use std::collections::{HashMap, HashSet, VecDeque};
4645
use chain::keysinterface::InMemorySigner;
4746

4847
pub struct TestVecWriter(pub Vec<u8>);

0 commit comments

Comments
 (0)