Init Terminal User Interface

author: Santo Cariotti <santo@dcariotti.me> 2023-10-15 20:06:41 +0200
committer: Santo Cariotti <santo@dcariotti.me> 2023-10-15 20:06:41 +0200
commit: 2f282d100fca3d8aa09d7802c1c38d61ec92b5ae (patch)
tree: f58ffc728765390632b4ed84b35de15452800718
parent: 72664d87d2fb0782ca49a5f2118c64d0cf58e3f7 (diff)
4 files changed, 366 insertions, 11 deletions
diff --git a/Cargo.lock b/Cargo.lock
index e82261e..b8ee60e 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -57,12 +57,30 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a4668cab20f66d8d020e1fbc0ebe47217433c1b6c8f2040faf858554e394ace6"
 
 [[package]]
+name = "autocfg"
+version = "1.1.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa"
+
+[[package]]
+name = "bitflags"
+version = "1.3.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
+
+[[package]]
 name = "bitflags"
 version = "2.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b4682ae6287fcf752ecaabbfcc7b6f9b72aa33933dc23a554d853aea8eea8635"
 
 [[package]]
+name = "cassowary"
+version = "0.3.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "df8670b8c7b9dae1793364eafadf7239c40d669904660c5960d74cfd80b46a53"
+
+[[package]]
 name = "cfg-if"
 version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -115,6 +133,37 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "acbf1af155f9b9ef647e42cdc158db4b64a1b61f743629225fde6f3e0be2a7c7"
 
 [[package]]
+name = "crossterm"
+version = "0.27.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "f476fe445d41c9e991fd07515a6f463074b782242ccf4a5b7b1d1012e70824df"
+dependencies = [
+ "bitflags 2.4.0",
+ "crossterm_winapi",
+ "libc",
+ "mio",
+ "parking_lot",
+ "signal-hook",
+ "signal-hook-mio",
+ "winapi",
+]
+
+[[package]]
+name = "crossterm_winapi"
+version = "0.9.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "acdd7c62a3665c7f6830a51635d9ac9b23ed385797f70a83bb8bafe9c572ab2b"
+dependencies = [
+ "winapi",
+]
+
+[[package]]
+name = "either"
+version = "1.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07"
+
+[[package]]
 name = "fork"
 version = "0.1.22"
 source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -130,23 +179,95 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"
 
 [[package]]
+name = "indoc"
+version = "2.0.4"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1e186cfbae8084e513daff4240b4797e342f988cecda4fb6c939150f96315fd8"
+
+[[package]]
+name = "itertools"
+version = "0.11.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b1c173a5686ce8bfa551b3563d0c2170bf24ca44da99c7ca4bfdab5418c3fe57"
+dependencies = [
+ "either",
+]
+
+[[package]]
 name = "libc"
 version = "0.2.149"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "a08173bc88b7955d1b3145aa561539096c421ac8debde8cbc3612ec635fee29b"
 
 [[package]]
+name = "lock_api"
+version = "0.4.10"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "c1cc9717a20b1bb222f333e6a92fd32f7d8a18ddc5a3191a11af45dcbf4dcd16"
+dependencies = [
+ "autocfg",
+ "scopeguard",
+]
+
+[[package]]
+name = "log"
+version = "0.4.20"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "b5e6163cb8c49088c2c36f57875e58ccd8c87c7427f7fbd50ea6710b2f3f2e8f"
+
+[[package]]
+name = "mio"
+version = "0.8.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "927a765cd3fc26206e66b296465fa9d3e5ab003e651c1b3c060e7956d96b19d2"
+dependencies = [
+ "libc",
+ "log",
+ "wasi",
+ "windows-sys",
+]
+
+[[package]]
 name = "nix"
 version = "0.27.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "2eb04e9c688eff1c89d72b407f168cf79bb9e867a9d3323ed6c01519eb9cc053"
 dependencies = [
- "bitflags",
+ "bitflags 2.4.0",
  "cfg-if",
  "libc",
 ]
 
 [[package]]
+name = "parking_lot"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "3742b2c103b9f06bc9fff0a37ff4912935851bee6d36f3c02bcc755bcfec228f"
+dependencies = [
+ "lock_api",
+ "parking_lot_core",
+]
+
+[[package]]
+name = "parking_lot_core"
+version = "0.9.8"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "93f00c865fe7cabf650081affecd3871070f26767e7b2070a3ffae14c654b447"
+dependencies = [
+ "cfg-if",
+ "libc",
+ "redox_syscall",
+ "smallvec",
+ "windows-targets",
+]
+
+[[package]]
+name = "paste"
+version = "1.0.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "de3145af08024dea9fa9914f381a17b8fc6034dfb00f3a84013f7ff43f29ed4c"
+
+[[package]]
 name = "proc-macro2"
 version = "1.0.69"
 source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -165,22 +286,120 @@ dependencies = [
 ]
 
 [[package]]
+name = "ratatui"
+version = "0.23.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "2e2e4cd95294a85c3b4446e63ef054eea43e0205b1fd60120c16b74ff7ff96ad"
+dependencies = [
+ "bitflags 2.4.0",
+ "cassowary",
+ "crossterm",
+ "indoc",
+ "itertools",
+ "paste",
+ "strum",
+ "unicode-segmentation",
+ "unicode-width",
+]
+
+[[package]]
+name = "redox_syscall"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "567664f262709473930a4bf9e51bf2ebf3348f2e748ccc50dea20646858f8f29"
+dependencies = [
+ "bitflags 1.3.2",
+]
+
+[[package]]
+name = "rustversion"
+version = "1.0.14"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "7ffc183a10b4478d04cbbbfc96d0873219d962dd5accaff2ffbd4ceb7df837f4"
+
+[[package]]
+name = "scopeguard"
+version = "1.2.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
+
+[[package]]
 name = "sigma"
 version = "0.0.1"
 dependencies = [
  "anyhow",
  "clap",
+ "crossterm",
  "fork",
  "nix",
+ "ratatui",
+]
+
+[[package]]
+name = "signal-hook"
+version = "0.3.17"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8621587d4798caf8eb44879d42e56b9a93ea5dcd315a6487c357130095b62801"
+dependencies = [
+ "libc",
+ "signal-hook-registry",
 ]
 
 [[package]]
+name = "signal-hook-mio"
+version = "0.2.3"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "29ad2e15f37ec9a6cc544097b78a1ec90001e9f71b81338ca39f430adaca99af"
+dependencies = [
+ "libc",
+ "mio",
+ "signal-hook",
+]
+
+[[package]]
+name = "signal-hook-registry"
+version = "1.4.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "d8229b473baa5980ac72ef434c4415e70c4b5e71b423043adb4ba059f89c99a1"
+dependencies = [
+ "libc",
+]
+
+[[package]]
+name = "smallvec"
+version = "1.11.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "942b4a808e05215192e39f4ab80813e599068285906cc91aa64f923db842bd5a"
+
+[[package]]
 name = "strsim"
 version = "0.10.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "73473c0e59e6d5812c5dfe2a064a6444949f089e20eec9a2e5506596494e4623"
 
 [[package]]
+name = "strum"
+version = "0.25.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "290d54ea6f91c969195bdbcd7442c8c2a2ba87da8bf60a7ee86a235d4bc1e125"
+dependencies = [
+ "strum_macros",
+]
+
+[[package]]
+name = "strum_macros"
+version = "0.25.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ad8d03b598d3d0fff69bf533ee3ef19b8eeb342729596df84bcc7e1f96ec4059"
+dependencies = [
+ "heck",
+ "proc-macro2",
+ "quote",
+ "rustversion",
+ "syn",
+]
+
+[[package]]
 name = "syn"
 version = "2.0.38"
 source = "registry+https://github.com/rust-lang/crates.io-index"
@@ -198,12 +417,52 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b"
 
 [[package]]
+name = "unicode-segmentation"
+version = "1.10.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "1dd624098567895118886609431a7c3b8f516e41d30e0643f03d94592a147e36"
+
+[[package]]
+name = "unicode-width"
+version = "0.1.11"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e51733f11c9c4f72aa0c160008246859e340b00807569a0da0e7a1079b27ba85"
+
+[[package]]
 name = "utf8parse"
 version = "0.2.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "711b9620af191e0cdc7468a8d14e709c3dcdb115b36f838e601583af800a370a"
 
 [[package]]
+name = "wasi"
+version = "0.11.0+wasi-snapshot-preview1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
+
+[[package]]
+name = "winapi"
+version = "0.3.9"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5c839a674fcd7a98952e593242ea400abe93992746761e38641405d28b00f419"
+dependencies = [
+ "winapi-i686-pc-windows-gnu",
+ "winapi-x86_64-pc-windows-gnu",
+]
+
+[[package]]
+name = "winapi-i686-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6"
+
+[[package]]
+name = "winapi-x86_64-pc-windows-gnu"
+version = "0.4.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f"
+
+[[package]]
 name = "windows-sys"
 version = "0.48.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
diff --git a/Cargo.toml b/Cargo.toml
index 290d613..5babd0c 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -9,5 +9,7 @@ authors = ["Santo Cariotti <santo@dcariotti.me>"]
 [dependencies]
 anyhow = "1.0.75"
 clap = { version = "4.4.6", features = ["derive"] }
+crossterm = "0.27.0"
 fork = "0.1.22"
 nix = { version = "0.27.1", features = ["ptrace"] }
+ratatui = "0.23.0"
diff --git a/src/main.rs b/src/main.rs
index 1a93aef..9b45fca 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -1,4 +1,14 @@
 mod trace;
+use crossterm::{
+    event::{self, Event, KeyCode},
+    terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
+    ExecutableCommand,
+};
+use ratatui::{prelude::*, widgets::*};
+use std::{
+    io::{self, stdout},
+    str,
+};
 
 use crate::trace::{exec, trace};
 use clap::Parser;
@@ -15,9 +25,31 @@ struct Args {
     file_to_print: Option<String>,
 }
 
+struct UI {
+    height: usize,
+    max_lines: usize,
+    scroll: usize,
+}
+
+impl UI {
+    fn new() -> UI {
+        UI {
+            height: 0,
+            max_lines: 0,
+            scroll: 0,
+        }
+    }
+}
+
 /// Create a fork of the program and execute the process in the child. Parent gets the pid
 /// value and trace it.
 fn main() -> anyhow::Result<()> {
+    enable_raw_mode()?;
+    stdout().execute(EnterAlternateScreen)?;
+    let mut terminal = Terminal::new(CrosstermBackend::new(stdout()))?;
+
+    let mut ui = UI::new();
+
     let args = Args::parse();
 
     let pid = match fork() {
@@ -25,8 +57,73 @@ fn main() -> anyhow::Result<()> {
         Ok(Fork::Parent(child)) => Pid::from_raw(child as i32),
         Err(err) => panic!("fork() failed: {err}"),
     };
+    let output = trace(pid, args.file_to_print)?;
+    let lines = str::from_utf8(&output)?;
+    ui.max_lines = lines.split('\n').count();
+
+    let mut should_quit = false;
+    while !should_quit {
+        ui.height = terminal.get_frame().size().height as usize;
+        terminal.draw(move |frame| {
+            let size = frame.size();
+            frame.render_widget(
+                Paragraph::new(lines)
+                    .block(
+                        Block::default()
+                            .border_style(Style::default().fg(Color::Yellow))
+                            .title(format!("[{pid}]"))
+                            .title(
+                                block::Title::from(format!(
+                                    "[lines {}-{}]",
+                                    ui.scroll,
+                                    ui.scroll + ui.height
+                                ))
+                                .position(block::Position::Bottom)
+                                .alignment(Alignment::Right),
+                            )
+                            .borders(Borders::ALL),
+                    )
+                    .scroll((ui.scroll as u16, 0)),
+                size,
+            );
+        })?;
+        should_quit = handle_events(&mut ui)?;
+    }
 
-    trace(pid, args.file_to_print)?;
+    disable_raw_mode()?;
+    stdout().execute(LeaveAlternateScreen)?;
 
     Ok(())
 }
+
+fn handle_events(ui: &mut UI) -> io::Result<bool> {
+    if event::poll(std::time::Duration::from_millis(50))? {
+        if let Event::Key(key) = event::read()? {
+            if key.kind == event::KeyEventKind::Press {
+                match key.code {
+                    KeyCode::Char('q') => {
+                        return Ok(true);
+                    }
+                    KeyCode::Char('j') => {
+                        if ui.scroll < (ui.max_lines - ui.height + 1) {
+                            ui.scroll += 1;
+                        }
+                    }
+                    KeyCode::Char('J') => {
+                        ui.scroll = ui.max_lines - ui.height + 1;
+                    }
+                    KeyCode::Char('k') => {
+                        if ui.scroll > 1 {
+                            ui.scroll -= 1;
+                        }
+                    }
+                    KeyCode::Char('K') => {
+                        ui.scroll = ui.height;
+                    }
+                    _ => {}
+                }
+            }
+        }
+    }
+    Ok(false)
+}
diff --git a/src/trace.rs b/src/trace.rs
index e826c53..b2880d5 100644
--- a/src/trace.rs
+++ b/src/trace.rs
@@ -6,12 +6,7 @@ use nix::{
     },
     unistd::Pid,
 };
-use std::{
-    fs::File,
-    io::{self, Write},
-    os::unix::process::CommandExt,
-    process::Command,
-};
+use std::{fs::File, io::Write, os::unix::process::CommandExt, process::Command};
 
 /// Exec the `command` value tracing it with `ptrace` lib
 pub fn exec(command: &String) -> anyhow::Result<()> {
@@ -30,7 +25,7 @@ pub fn exec(command: &String) -> anyhow::Result<()> {
 }
 
 /// Trace a process with `pid` ID
-pub fn trace(pid: Pid, file_to_print: Option<String>) -> anyhow::Result<()> {
+pub fn trace(pid: Pid, file_to_print: Option<String>) -> anyhow::Result<Vec<u8>> {
     // Since you have to do 2 syscalls (start and end) you have to alternate the print value,
     // because it could be equals except for the `rax` register.
     let mut have_to_print = true;
@@ -45,6 +40,8 @@ pub fn trace(pid: Pid, file_to_print: Option<String>) -> anyhow::Result<()> {
         f = Some(File::create(filename)?);
     }
 
+    let mut lines = Vec::new();
+
     loop {
         have_to_print ^= true;
         ptrace::syscall(pid, None)?;
@@ -65,7 +62,7 @@ pub fn trace(pid: Pid, file_to_print: Option<String>) -> anyhow::Result<()> {
                                 "{}({:x}, {:x}, {:x}, ...) = {:x}",
                                 regs.orig_rax, regs.rdi, regs.rsi, regs.rdx, regs.rax
                             );
-                            writeln!(io::stdout(), "{output}")?;
+                            writeln!(lines, "{output}")?;
 
                             if let Some(ref mut f) = f {
                                 writeln!(f, "{output}")?;
@@ -79,5 +76,5 @@ pub fn trace(pid: Pid, file_to_print: Option<String>) -> anyhow::Result<()> {
         };
     }
 
-    Ok(())
+    Ok(lines)
 }
author	Santo Cariotti <santo@dcariotti.me>	2023-10-15 20:06:41 +0200
committer	Santo Cariotti <santo@dcariotti.me>	2023-10-15 20:06:41 +0200
commit	2f282d100fca3d8aa09d7802c1c38d61ec92b5ae (patch)
tree	f58ffc728765390632b4ed84b35de15452800718
parent	72664d87d2fb0782ca49a5f2118c64d0cf58e3f7 (diff)