Add support for GDB JIT debugging

ATTRIBUTIONS.md

@@ -1,21 +1,30 @@
 # Wasmer Attributions
 
-Wasmer is a community effort.
-In order to build the best WebAssembly runtime it's our duty to see how other runtimes are approaching the same space
-and get inspired from them on the things that they got right, so Wasmer and its community can benefit from a solid
-foundation.
+Wasmer is a community effort and makes use of code from various other
+projects. Listed below are notable sections of code that are licensed
+from other projects and the relevant license of those projects.
 
-These are the different project that we used as inspiration:
+These are the projects that were used as inspiration and/or that we are using code from:
 
 - [Nebulet](https://github.com/nebulet/nebulet): as the base for creating a great Rust WebAssembly runtime
 - [WAVM](https://github.com/wavm/wavm): for their great integration and testing framework
 - [greenwasm](https://github.com/Kimundi/greenwasm): for their [spectests framework](https://github.com/Kimundi/greenwasm/tree/master/greenwasm-spectest)
-- [wasmtime](https://github.com/CraneStation/wasmtime): for their [mmap implementation](https://github.com/CraneStation/wasmtime/blob/3f24098edc81cd9bf0f877fb7fba018cad0f039e/lib/runtime/src/mmap.rs)
+- [wasmtime](https://github.com/CraneStation/wasmtime):
+  - For their [mmap implementation](https://github.com/CraneStation/wasmtime/blob/3f24098edc81cd9bf0f877fb7fba018cad0f039e/lib/runtime/src/mmap.rs)
+  - For the implementation of the `__jit_debug_register_code` function
+    in Rust, the structure of using Cranelift with the GDB JIT
+    interface including implementation details regarding the structure
+    of generating debug information for each function with Cranelift
+    (for example, the sorting of the extended basic blocks before
+    processing the instructions), and the API for transforming DWARF
+    see wasm-debug's attribution file for more information (TODO: link
+    and update here).
 - [stackoverflow](https://stackoverflow.com/a/45795699/1072990): to create an efficient HashMap with pair keys
 - [Emscripten](https://github.com/kripken/emscripten): for emtests test sources to ensure compatibility
+- [The WebAssembly spec](https://github.com/WebAssembly/spec/tree/master/test): for implementation details of WebAssembly and spectests
 
-We would love to hear from you if you think we can take inspiration from other projects that we haven't covered here.
-😊
+Please let us know if you believe there is an error or omission in
+this list and we will do our best to correct it.
 
 ## Licenses
 

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## **[Unreleased]**
 
 - [#1216](https://github.com/wasmerio/wasmer/pull/1216) `wasmer-interface-types` receives a binary encoder.
+- [#1212](https://github.com/wasmerio/wasmer/pull/1212) Add `--generate-debug-info` and `-g` flags to `wasmer run` to generate debug information during compilation that is passed via the GDB JIT interface to a debugger to allow source-level debugging of Wasm files.  Currently only available on clif-backend, see PR for more information on its implementation.
 - [#1228](https://github.com/wasmerio/wasmer/pull/1228) Singlepass cleanup: Resolve several FIXMEs and remove protect_unix.
 - [#1218](https://github.com/wasmerio/wasmer/pull/1218) Enable Cranelift verifier in debug mode. Fix bug with table indices being the wrong type.
 - [#787](https://github.com/wasmerio/wasmer/pull/787) New crate `wasmer-interface-types` to implement WebAssembly Interface Types.

Cargo.toml

@@ -80,7 +80,7 @@ serde = { version = "1", features = ["derive"] } # used by the plugin example
 typetag = "0.1" # used by the plugin example
 
 [features]
-default = ["fast-tests", "wasi", "backend-cranelift", "wabt"]
+default = ["fast-tests", "wasi", "backend-cranelift", "wabt", "wasmer-runtime-core/generate-debug-information"]
 "loader-kernel" = ["wasmer-kernel-loader"]
 debug = ["fern", "log/max_level_debug", "log/release_max_level_debug"]
 trace = ["fern", "log/max_level_trace", "log/release_max_level_trace"]
@@ -89,6 +89,7 @@ docs = ["wasmer-runtime/docs"]
 fast-tests = []
 backend-cranelift = [
     "wasmer-clif-backend",
+    "wasmer-clif-backend/generate-debug-information",
     "wasmer-runtime/cranelift",
     "wasmer-middleware-common-tests/clif",
 ]

Makefile

@@ -219,6 +219,7 @@ check: check-bench
 	# builds, test as many combined features as possible with each backend
 	# as default, and test a minimal set of features with only one backend
 	# at a time.
+	cargo check --manifest-path lib/runtime-core/Cargo.toml
 	cargo check --manifest-path lib/runtime/Cargo.toml
 	# Check some of the cases where deterministic execution could matter
 	cargo check --manifest-path lib/runtime/Cargo.toml --features "deterministic-execution"

lib/clif-backend/Cargo.toml

@@ -23,6 +23,7 @@ byteorder = "1.3.2"
 nix = "0.15.0"
 libc = "0.2.60"
 rayon = "1.1"
+wasm-debug = { optional = true, version = "0.1" }
 
 # Dependencies for caching.
 [dependencies.serde]
@@ -38,3 +39,6 @@ version = "0.0.7"
 [target.'cfg(windows)'.dependencies]
 winapi = { version = "0.3", features = ["errhandlingapi", "minwindef", "minwinbase", "winnt"] }
 wasmer-win-exception-handler = { path = "../win-exception-handler", version = "0.13.1" }
+
+[features]
+generate-debug-information = ["wasm-debug"]