Output to file, JSON output draft

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "hstrace"
-version = "0.0.4"
+version = "0.0.5"
 authors = ["Mika Vatanen <blaind@blaind.net>"]
 repository = "https://github.com/blaind/hstrace"
 documentation = "https://docs.rs/hstrace"
@@ -38,6 +38,8 @@ bitflags = "1.2.1"
 crossbeam-utils = "0.8.3"
 ctrlc = "3.1.8"
 lazy_static = "1.4.0"
+serde = { version = "1.0.125", features = ["derive"] }
+serde_json = "1.0.64"
 
 [build-dependencies]
 bindgen = "0.58.1"

README.md

@@ -36,6 +36,8 @@ FLAGS:
 OPTIONS:
     -e <expr>           Expression
     -m <mode>           Run mode [default: strace]
+    -o <file>           Save output to a file instead of stderr. If suffix is `.json`, will be stored in JSON-format
+                        (format subject to change)
     -p <pid>            PID to trace
     -s <strsize>        Maximum length of printable strings [default: 32]
 

src/call/fncntl.rs

@@ -1,4 +1,5 @@
 use super::prelude::*;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -16,7 +17,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
     );
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Open a file (dirfd: {}) {} with flags {:?}", self.dirfd, self.pathname, self.flags))]
 pub struct Openat {
     #[hstrace]
@@ -31,6 +32,7 @@ pub struct Openat {
 }
 
 bitflags! {
+    #[derive(Serialize)]
     pub struct OpenatMode: isize {
         const O_ACCMODE = 0o0003;
         const O_RDONLY = 0o0;

src/call/mman.rs

@@ -1,4 +1,5 @@
 use super::prelude::*;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -42,7 +43,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
     );
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Protect memory {:?} - {:?} (len {}) with flags {:?}",
     self.addr,
     MemoryAddress(self.addr.0 + self.len),
@@ -61,6 +62,7 @@ pub struct Mprotect {
 }
 
 bitflags! {
+    #[derive(Serialize)]
     pub struct Prot: isize {
         const PROT_READ = 0x1;
         const PROT_WRITE = 0x2;

src/call/mod.rs

@@ -9,6 +9,7 @@
 //! Use this [GitHub issue 3](https://github.com/blaind/hstrace/issues/3) to request a new syscall implementation
 
 use num_traits::FromPrimitive;
+use serde::Serialize;
 use std::fmt;
 
 use crate::syscall::{Definition, Direction};

src/call/sendfile.rs

@@ -1,4 +1,5 @@
 use super::prelude::*;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -15,7 +16,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
 }
 
 /// Syscall: Transfer data between file descriptors
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Transfer data to fd {:?} from fd {:?} offset {:?} len {:?}", self.out_fd, self.in_fd, self.offset, self.count))]
 pub struct Sendfile {
     /// FD where data is sent

src/call/socket.rs

@@ -1,4 +1,5 @@
 use super::prelude::*;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -17,7 +18,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
 }
 
 /// Syscall: Create an endpoint for communication
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Open {:?} domain socket with type {:?} and protocol {:?}", self.domain, self.socket_type, self.protocol))]
 pub struct Socket {
     #[hstrace]
@@ -41,7 +42,7 @@ pub enum SockAddr {
 
 /// Argument: Communication domain / protocol family used
 #[allow(dead_code, non_camel_case_types)]
-#[derive(Debug, Clone, FromPrimitive, PartialEq)]
+#[derive(Debug, Clone, FromPrimitive, PartialEq, Serialize)]
 #[repr(isize)]
 pub enum AddressFamily {
     AF_UNSPEC = libc::AF_UNSPEC as isize,
@@ -53,6 +54,7 @@ pub enum AddressFamily {
 
 bitflags! {
     /// Argument: Socket communication semantics
+    #[derive(Serialize)]
     pub struct SocketType: isize {
         const SOCK_STREAM = libc::SOCK_STREAM as isize;
         const SOCK_DGRAM = libc::SOCK_DGRAM as isize;

src/call/stat.rs

@@ -1,5 +1,6 @@
 use super::prelude::*;
 use crate::from_c::stat as sys_stat;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -17,7 +18,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
     );
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Stat path {:?} returned {:?}", self.pathname, self.stat))]
 pub struct Stat {
     #[hstrace]
@@ -27,7 +28,7 @@ pub struct Stat {
     pub stat: StatResult,
 }
 
-#[derive(Debug, Clone, PartialEq, FromCStruct)]
+#[derive(Debug, Clone, PartialEq, FromCStruct, Serialize)]
 #[hstrace(c_struct = sys_stat)]
 pub struct StatResult {
     // st_dev=makedev(0xfd, 0),

src/call/swap.rs

@@ -1,4 +1,5 @@
 use super::prelude::*;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -17,7 +18,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
 }
 
 /// Syscall: Start swapping to file/device
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Enable swap for path {:?} with flags {:?}", self.path, self.swapflags))]
 pub struct Swapon {
     #[hstrace]
@@ -28,7 +29,7 @@ pub struct Swapon {
 }
 
 /// Syscall: Stop swap on file/device
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Disable swap path {}", self.path))]
 pub struct Swapoff {
     #[hstrace]

src/call/unistd.rs

@@ -1,4 +1,5 @@
 use super::prelude::*;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -75,7 +76,7 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
 }
 
 /// Syscall: Read value of a symbolic link
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("{:?} symlink points to {:?}", self.src, self.dst))]
 pub struct Readlink {
     /// Source file
@@ -87,7 +88,7 @@ pub struct Readlink {
     pub dst: Option<String>,
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Check path {:?} permissions for mode {:?}", self.pathname, self.mode))]
 pub struct Access {
     #[hstrace]
@@ -97,30 +98,30 @@ pub struct Access {
     pub mode: AccessMode,
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Resolved current path to {:?}", self.pathname))]
 pub struct Getcwd {
     #[hstrace]
     pub pathname: Option<String>,
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Closed file descriptor {:?}", self.fd))]
 pub struct Close {
     /// File descriptor
     #[hstrace]
     pub fd: isize,
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Request memory address expansion to {:?}", self.addr))]
 pub struct Brk {
     /// Expand to memory address
     #[hstrace]
     pub addr: MemoryAddress,
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Change working directory to {:?}", self.path))]
 pub struct Chdir {
     /// Working directory
@@ -129,6 +130,7 @@ pub struct Chdir {
 }
 
 bitflags! {
+    #[derive(Serialize)]
     pub struct AccessMode: isize {
         const R_OK = 4;
         const W_OK = 2;

src/call/utsname.rs

@@ -1,5 +1,6 @@
 use super::prelude::*;
 use crate::from_c::utsname as sys_utsname;
+use serde::Serialize;
 
 pub(crate) fn get_definitions(inp: &mut Definitions) {
     inp.add(
@@ -10,14 +11,14 @@ pub(crate) fn get_definitions(inp: &mut Definitions) {
     );
 }
 
-#[derive(Debug, PartialEq, FromPtrace)]
+#[derive(Debug, PartialEq, FromPtrace, Serialize)]
 #[hstrace(hmz("Detected uname to be {:?}", self.utsname))]
 pub struct Uname {
     #[hstrace(c_struct = sys_utsname)]
     pub utsname: Utsname,
 }
 
-#[derive(Debug, Clone, PartialEq, FromCStruct)]
+#[derive(Debug, Clone, PartialEq, FromCStruct, Serialize)]
 #[hstrace(c_struct = sys_utsname)]
 pub struct Utsname {
     #[hstrace(c_char)]

src/clap.yml

@@ -15,6 +15,11 @@ args:
       help: Run mode
       short: m
       default_value: strace
+  - output_file:
+      help: Save output to a file instead of stderr. If suffix is `.json`, will be stored in JSON-format (format subject to change)
+      value_name: file
+      short: o
+      takes_value: true
   - pid:
       help: PID to trace
       short: p