Initialize a crate for memory related tools (#89)

Initialize a crate for memory related tools. Mainly heapsize measurement through malloc_size_of traits.

Author: cheme

.travis.yml

@@ -24,3 +24,4 @@ script:
   - cd uint/ && cargo test --features=std,quickcheck --release && cd ..
   - cd hashdb/ && cargo test --no-default-features && cd ..
   - cd plain_hasher/ && cargo test --no-default-features && cd ..
+  - cd parity-util-mem/ && cargo test --features=estimate-heapsize && cd ..

Cargo.toml

@@ -18,5 +18,6 @@ members = [
 	"trie-standardmap",
 	"triehash",
 	"uint",
+	"parity-util-mem",
 	"primitive-types",
 ]

parity-util-mem/Cargo.toml

@@ -0,0 +1,38 @@
+[package]
+name = "parity-util-mem"
+version = "0.1.0"
+authors = ["Parity Technologies <[email protected]>"]
+repository = "https://github.com/paritytech/parity-common"
+description = "Collection of memory related utilities"
+license = "GPL-3.0"
+
+[dependencies]
+clear_on_drop = "0.2"
+cfg-if = "0.1.6"
+malloc_size_of_derive = "0.1.0"
+dlmalloc = { version = "0.1", features = ["global"], optional = true }
+wee_alloc = { version = "0.4", optional = true }
+jemallocator = { version = "0.1", optional = true }
+
+elastic-array = { version = "*", optional = true }
+ethereum-types = { version = "*", optional = true }
+parking_lot = { version = "*", optional = true }
+
+[target."cfg(windows)".dependencies.winapi]
+version = "0.3.4"
+
+[features]
+default = ["std", "ethereum-impls"]
+std = []
+# when activated mem is removed through volatile primitive instead of clear_on_drop crate
+volatile-erase = []
+# use dlmalloc as global allocator
+dlmalloc-global = ["dlmalloc", "estimate-heapsize"]
+# use wee_alloc as global allocator
+weealloc-global = ["wee_alloc", "estimate-heapsize"]
+# use jemalloc as global allocator
+jemalloc-global = ["jemallocator"]
+# implement additional types
+ethereum-impls = ["ethereum-types", "elastic-array", "parking_lot"]
+# Full estimate: no call to allocator
+estimate-heapsize = []

parity-util-mem/README.md

@@ -0,0 +1,16 @@
+# parity-util-mem
+
+Collection of memory related utilities.
+
+## Features
+
+- volatile-erase : Not set by default, `Memzero` struct will be erasing memory through a simple [`write_volatile`](https://doc.rust-lang.org/std/ptr/fn.write_volatile.html) call.
+- estimate-heapsize : Do not use allocator, but `size_of` or `size_of_val`.
+
+Others features define global allocator, see `src/alloc.rs`.
+
+## Dependency
+
+This crate groups common dependency, [`clear_on_drop`](https://crates.io/crates/clear_on_drop) is reexported, and a patched copy of unpublished [`malloc_size_of`](https://github.com/servo/servo/tree/master/components/malloc_size_of) from servo project is copied and partially reexported.
+
+`Malloc_size_of` code is used internally as a module with a few modification to be able to implement type locally.

parity-util-mem/get_malloc_size_src.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# script/process to update code from servo project (malloc_size_of)
+# untested, note that we do not use submodule due to size of git repo
+git clone https://github.com/servo/servo.git
+cd servo
+git checkout 5bdea7dc1c80790a852a3fb03edfb2b8fbd403dc
+git apply ../slim_malloc_size_of.patch
+#git merge master
+#cp components/malloc_size_of/lib.rs ../src/malloc_size.rs
+#cd ..
+#rm -rf ./servo