Static bin speed warning

entropic-security · Nov 16, 2020 · 0948f6a · 0948f6a
1 parent ae00528
commit 0948f6a
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -94,9 +94,9 @@ ARGS:
     <FILE(S)>...    1+ binaries to gadget search. If > 1: gadgets common to all
 ```
 
-### CLI Build and Install
+### CLI Build and Install (Recommended)
 
-Build from source and install locally:
+Build a dynamically-linked binary from source and install it locally:
 
 ```bash
 cargo install xgadget --features cli-bin    # Build on host (pre-req: https://www.rust-lang.org/tools/install)
@@ -108,6 +108,9 @@ Commits to this repo's `master` branch automatically run integration tests and b
 You can [download it here](https://github.com/entropic-security/xgadget/releases) and use the CLI immediately, instead of building from source.
 Static binaries for Windows may also be supported in the future.
 
+The statically-linked binary is about 8x slower, presumably due to the built-in memory allocator for target `x86_64-unknown-linux-musl`.
+Building a dynamically-linked binary from source with the above `cargo install` command is *highly* recommended.
+
 ### ~~Yeah, but can it do 10 OS kernels under 10 seconds?!~~ Repeatable Benchmark Harness
 
 ```bash

diff --git a/src/lib.rs b/src/lib.rs
@@ -91,9 +91,9 @@
 //!    <FILE(S)>...    1+ binaries to gadget search. If > 1: gadgets common to all
 //!```
 //!
-//!### CLI Build and Install
+//!### CLI Build and Install (Recommended)
 //!
-//!Build from source and install locally:
+//!Build a dynamically-linked binary from source and install it locally:
 //!
 //!```bash
 //!cargo install xgadget --features cli-bin    # Build on host (pre-req: https://www.rust-lang.org/tools/install)
@@ -105,6 +105,9 @@
 //!You can [download it here](https://github.com/entropic-security/xgadget/releases) and use the CLI immediately, instead of building from source.
 //!Static binaries for Windows may also be supported in the future.
 //!
+//!The statically-linked binary is about 8x slower, presumably due to the built-in memory allocator for target `x86_64-unknown-linux-musl`.
+//!Building a dynamically-linked binary from source with the above `cargo install` command is *highly* recommended.
+//!
 //!### ~~Yeah, but can it do 10 OS kernels under 10 seconds?!~~ Repeatable Benchmark Harness
 //!
 //!```bash