sfackler / rstack Goto Github PK

View Code? Open in Web Editor NEW

32.0 4.0 14.0 1.28 MB

License: Apache License 2.0

Rust 100.00%

rstack's Introduction

rstack

Documentation

Remote stack tracing.

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

rstack's People

Contributors

Stargazers

Watchers

Forkers

gilescope mikailbag mjkoo greenbeard eliageretto s1341 jasonwhite jswrenn trevor-gitgoat-dev tthebst isgasho zcl fluxie hack3ric

rstack's Issues

Use libthread_db instead of /proc?

This avoids depending on the existence of /proc but involves interacting with a weird and obscure library.

New rstack release?

The cfg-if dependency was bumped here but no new release was made. Could one be created?

libunwind-sys fails to compile on macOS

Output of cargo build:

error: failed to run custom build command for `unwind-sys v0.1.3`

Caused by:
  process didn't exit successfully: `/Users/jordydickinson/Documents/Projects/geode/runtime/target/debug/build/unwind-sys-5d5614cc26fe5642/build-script-build` (exit status: 101)
  --- stdout
  cargo:rerun-if-env-changed=LIBUNWIND_GENERIC_NO_PKG_CONFIG
  cargo:rerun-if-env-changed=PKG_CONFIG_x86_64-apple-darwin
  cargo:rerun-if-env-changed=PKG_CONFIG_x86_64_apple_darwin
  cargo:rerun-if-env-changed=HOST_PKG_CONFIG
  cargo:rerun-if-env-changed=PKG_CONFIG
  cargo:rerun-if-env-changed=LIBUNWIND_GENERIC_STATIC
  cargo:rerun-if-env-changed=LIBUNWIND_GENERIC_DYNAMIC
  cargo:rerun-if-env-changed=PKG_CONFIG_ALL_STATIC
  cargo:rerun-if-env-changed=PKG_CONFIG_ALL_DYNAMIC
  cargo:rerun-if-env-changed=PKG_CONFIG_PATH_x86_64-apple-darwin
  cargo:rerun-if-env-changed=PKG_CONFIG_PATH_x86_64_apple_darwin
  cargo:rerun-if-env-changed=HOST_PKG_CONFIG_PATH
  cargo:rerun-if-env-changed=PKG_CONFIG_PATH
  cargo:rerun-if-env-changed=PKG_CONFIG_LIBDIR_x86_64-apple-darwin
  cargo:rerun-if-env-changed=PKG_CONFIG_LIBDIR_x86_64_apple_darwin
  cargo:rerun-if-env-changed=HOST_PKG_CONFIG_LIBDIR
  cargo:rerun-if-env-changed=PKG_CONFIG_LIBDIR
  cargo:rerun-if-env-changed=PKG_CONFIG_SYSROOT_DIR_x86_64-apple-darwin
  cargo:rerun-if-env-changed=PKG_CONFIG_SYSROOT_DIR_x86_64_apple_darwin
  cargo:rerun-if-env-changed=HOST_PKG_CONFIG_SYSROOT_DIR
  cargo:rerun-if-env-changed=PKG_CONFIG_SYSROOT_DIR

  --- stderr
  thread 'main' panicked at /Users/jordydickinson/.cargo/registry/src/index.crates.io-6f17d22bba15001f/unwind-sys-0.1.3/build.rs:11:50:
  called `Result::unwrap()` on an `Err` value: `PKG_CONFIG_ALLOW_SYSTEM_CFLAGS="1" PKG_CONFIG_ALLOW_SYSTEM_LIBS="1" "pkg-config" "--libs" "--cflags" "libunwind-generic"` did not exit successfully: exit status: 1
  error: could not find system library 'libunwind-generic' required by the 'unwind-sys' crate

  --- stderr
  Package libunwind-generic was not found in the pkg-config search path.
  Perhaps you should add the directory containing `libunwind-generic.pc'
  to the PKG_CONFIG_PATH environment variable
  No package 'libunwind-generic' found

  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

x86_64 `unw_cursor_t` is self-referential but `Cursor` is not pinned

For x86_64, unw_cursor_t is self-referential. This can be observed in the following line:
https://github.com/libunwind/libunwind/blob/v1.5/src/x86_64/Ginit_local.c#L52

Cursor contains an unw_cursor_t, but it is not marked as pinned. As a consequence, the reference in dwarf.as_arg will be invalidated on the first move. For the same reason, it should also not derive Clone, I believe.

I am not sure if this is a bug in libunwind, since they state in the documentation that:

The former would be used as the
current cursor and prev would be maintained as the ``previous frame'' cursor by copying
the contents of curr to prev right before calling unw_step()

This means that cursors are meant to be copiable, but the x86_64 one is obviously not. Still, I thought it was worth reporting.

Fails to build when linking with `lld`

The unwind-sys crate fails to build when using lld as the linker:

RUSTFLAGS='-Clink-args=-fuse-ld=lld' cargo t --all-features produces a linker error:

          ld.lld: error: /usr/lib/x86_64-linux-gnu/libunwind-ptrace.so: undefined reference to lzma_stream_buffer_decode [--no-allow-shlib-undefined]
          ld.lld: error: /usr/lib/x86_64-linux-gnu/libunwind-ptrace.so: undefined reference to lzma_index_uncompressed_size [--no-allow-shlib-undefined]
          ld.lld: error: /usr/lib/x86_64-linux-gnu/libunwind-ptrace.so: undefined reference to lzma_index_end [--no-allow-shlib-undefined]
          ld.lld: error: /usr/lib/x86_64-linux-gnu/libunwind-ptrace.so: undefined reference to lzma_index_buffer_decode [--no-allow-shlib-undefined]
          ld.lld: error: /usr/lib/x86_64-linux-gnu/libunwind-ptrace.so: undefined reference to lzma_stream_footer_decode [--no-allow-shlib-undefined]
          ld.lld: error: /usr/lib/x86_64-linux-gnu/libunwind-ptrace.so: undefined reference to lzma_index_size [--no-allow-shlib-undefined]
          collect2: error: ld returned 1 exit status
          
  = help: some `extern` functions couldn't be found; some native libraries may need to be installed or have their path specified
  = note: use the `-l` flag to specify native libraries to link
  = note: use the `cargo:rustc-link-lib` directive to specify the native libraries to link with Cargo (see https://doc.rust-lang.org/cargo/reference/build-scripts.html#cargorustc-link-libkindname)

error: could not compile `unwind-sys` due to previous error

Your crate seems to rely on some GNU ld behaviour that the lld team are unwilling to replicate (llvm/llvm-project#54700).

I suggest this can be fixed by adding a cargo:rustc-link-lib=lzma directive to your build.rs build script.

Request for release

Do you mind publishing new release?

unwind-sys fails to build with RC pkg-config

When building with pkg-config 1.7-rc1, we end up trying to cast the string 7-rc1 to a u32 here:

https://github.com/sfackler/rstack/blob/master/unwind-sys/build.rs#L16

Simply adding .replace("-rc","") seems to work around the issue for now but does screw up the minor version

Might make a PR myself but I haven't looked closely enough to determine the most reasonable way to solve this

Preconditions of rstack

Hello!
Could you please clarify, what conditions my application must meet so that rstack will work successfully?

As far as I undertood, child must be in paused state. Does ptrace's syscall-enter-stop suffice?
Does tracer need root?
Maybe, child must be spawned by tracer directly?

I ask this, because I have Operation not permitted (os error 1) error when using your library, and it is quite hard to debug this error, because strace doesn't work on other tracer.

Coredump files support

Hello!
Is it possible to use your crate to get stack frames from coredumps?