Add small bench and add parity copyright header to storage

Author: rklaehn

misc/multiaddr/Cargo.toml

@@ -25,3 +25,8 @@ bincode = "1"
 quickcheck = "0.9.0"
 rand = "0.7.2"
 serde_json = "1.0"
+criterion = "0.3"
+
+[[bench]]
+name = "clone"
+harness = false

misc/multiaddr/benches/clone.rs

@@ -0,0 +1,52 @@
+// Copyright 2019 Parity Technologies (UK) Ltd.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//! This benchmark tests the speed of cloning of the largest possible inlined
+//! multiaddr vs the smalles possible heap allocated multiaddr.
+//!
+//! Note that the main point of the storage optimization is not to speed up clone
+//! but to avoid allocating on the heap at all, but still you see a nice benefit
+//! in the speed of cloning.
+use criterion::{Bencher, Criterion, criterion_main, criterion_group, black_box};
+use parity_multiaddr::Multiaddr;
+
+fn do_clone(multiaddr: &Multiaddr) -> usize {
+    let mut res = 0usize;
+    for _ in 0..10 {
+        res += multiaddr.clone().as_ref().len()
+    }
+    res
+}
+
+fn clone(bench: &mut Bencher, addr: &Multiaddr) {
+    bench.iter(|| do_clone(black_box(addr)))
+}
+
+fn criterion_benchmarks(bench: &mut Criterion) {
+    let inlined: Multiaddr = "/dns4/01234567890123456789123/tcp/80/ws".parse().unwrap();
+    let heap: Multiaddr = "/dns4/0123456789012345678901234/tcp/80/ws".parse().unwrap();
+    assert_eq!(inlined.as_ref().len(), 30);
+    assert_eq!(heap.as_ref().len(), 32);
+
+    bench.bench_function("clone 10 max inlined", |b| clone(b, &inlined));
+    bench.bench_function("clone 10 min heap", |b| clone(b, &heap));
+}
+
+criterion_group!(benches, criterion_benchmarks);
+criterion_main!(benches);

misc/multiaddr/src/storage.rs

@@ -1,3 +1,22 @@
+// Copyright 2020 Parity Technologies (UK) Ltd.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a
+// copy of this software and associated documentation files (the "Software"),
+// to deal in the Software without restriction, including without limitation
+// the rights to use, copy, modify, merge, publish, distribute, sublicense,
+// and/or sell copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
 use std::sync::Arc;
 
 /// MAX_INLINE is the maximum size of a multiaddr that can be stored inline.
@@ -41,9 +60,23 @@ impl Storage {
 
 #[cfg(test)]
 mod tests {
+    use crate::Multiaddr;
     use super::{Storage, MAX_INLINE};
     use quickcheck::quickcheck;
 
+    #[test]
+    fn multihash_size() {
+        fn assert_size(ma: &str, n: usize, inline: bool) {
+            let ma: Multiaddr = ma.parse().unwrap();
+            assert_eq!(ma.as_ref().len(), n);
+            assert_eq!(n <= MAX_INLINE, inline);
+        }
+        assert_size("/ip4/127.0.0.1", 5, true);
+        assert_size("/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/8000", 20, true);
+        assert_size("/dns4/0123456789012345678901234/tcp/8000", 30, true);
+        assert_size("/ip6/2001:8a0:7ac5:4201:3ac9:86ff:fe31:7095/tcp/8000/ws/p2p/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSupNKC", 59, false);
+    }
+
     #[test]
     fn struct_size() {
         // this should be true for both 32 and 64 bit archs