sys-rs 0.1.0

ptrace-based Linux system tool reimplementations: strace, gcov, addr2line, debugger
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

[![CI](https://github.com/yrakcaz/sys-rs/actions/workflows/rust_ci.yml/badge.svg)](https://github.com/yrakcaz/sys-rs/actions/workflows/rust_ci.yml)
[![Crates.io](https://img.shields.io/crates/v/sys-rs)](https://crates.io/crates/sys-rs)
[![Documentation](https://img.shields.io/badge/docs-sys--rs-purple)](https://docs.rs/sys-rs)
[![MIT License](https://img.shields.io/github/license/yrakcaz/sys-rs?color=blue)](./LICENSE-MIT)

# sys-rs

A collection of Linux system tools reimplemented in Rust — tracing system calls,
inspecting code coverage, resolving debug symbols, and interactive debugging.
Built on `ptrace` and DWARF, targeting x86\_64 Linux with nightly Rust.

## Requirements

- **Rust nightly** — this crate uses `#![feature(trait_alias)]` and will not compile
  on stable
- **Linux x86\_64** — ptrace support is Linux-only; DWARF support is limited to
  x86\_64 and versions 2, 3, 4
- **System dependencies** — install before building:
  ```
  apt install libunwind-dev libclang-dev llvm-dev
  ```

## install

```
cargo install sys-rs
```

This installs all binaries (`strace-rs`, `gcov-rs`, `addr2line-rs`, `sscov-rs`,
`dbg-rs`) to `~/.cargo/bin`.

## build

* `cargo build` for debug mode
* `cargo build --release` for release mode

## strace-rs

This works the same way as Linux's `strace` command and can be used to trace
the system calls invoked by a process as well as the signals it received.

Usage: `strace-rs command [args]`

## sscov-rs

This is a Super Simple Coverage tool that displays all the addresses covered
by the instruction pointer during the execution of a binary, as well as the
associated disassembled instructions.

Usage: `sscov-rs command [args]`

## addr2line-rs

This tool displays all the lines of code corresponding to the addresses covered
by the instruction pointer during the execution of a binary.
The binary needs to be compiled with DWARF debug symbols.

Usage: `addr2line-rs command [args]`

## gcov-rs

This tool leverages addr2line to generate a .cov file per source file that maps
each line of the source file to its coverage count.
This works only if the binary passed as parameter has been compiled with DWARF debug
symbols. If not, gcov-rs will simply behave the same as sscov-rs.

Usage: `gcov-rs command [args]`

## dbg-rs

This is a simple debugger tool that lets you set breakpoints, step through code, and
inspect the state of a process while executing a binary. It provides essential
debugging features in both source and assembly modes.

Usage: `dbg-rs command [args]`

## Library API

The `sys_rs` library crate is an internal implementation detail of the binaries
above. It is published as part of this crate for contributor convenience but is
**not subject to semver guarantees** and is not designed for use as a dependency.