si_trace_print

A rust library to print messages indented to stack depth optionally preceded by the function name.

Useful for trace printing function flows.

• Use
  • Trace-printing example
  • Manually setting the indentation
• Shortcomings
  • Slow
  • Release builds

Use

Add si_trace_print entry to the project Cargo.toml section [dependencies].

Trace-printing example

use si_trace_print::{
    p, pn, po, px, pfn, pfñ, pfo, pfx,
};

fn main() {
    pn!("hello from main");
    po!("main will be doing stuff...");
    my_func1(3);
    po!("main is done doing stuff...");
    px!("goodbye from main");
}

fn my_func1(var: usize) {
    pfn!("({:?})", var);
    my_func2(var + 1);
    pfx!("({:?})", var);
}

fn my_func2(var: usize) {
    pfn!("({:?})", var);
    pfo!("calling func3...");
    my_func3();
    pfx!("({:?})", var);
}

fn my_func3() {
    pfn!();
    my_func4();
    pfo!("almost complete...");
    pfx!();
}

fn my_func4() {
    pfñ!("func4 is a short function.");
}

should print

→hello from main
 main will be doing stuff...
    →my_func1: (3)
        →my_func2: (4)
         my_func2: calling func3...
            →my_func3:
                ↔my_func4: func4 is a short function.
             my_func3: almost complete...
            ←my_func3:
        ←my_func2: (4)
    ←my_func1: (3)
 main is done doing stuff...
←goodbye from main

Most users will want to use the debug-only printing to stderr.

use si_trace_print::{
    den, deo, dex, defn, defx,
};

fn main() {
    den!("hello from main");
    deo!("main will be doing stuff...");
    my_func1(3);
    deo!("main is done doing stuff...");
    dex!("goodbye from main");
}

fn my_func1(_var: usize) {
    defn!("({:?})", _var);
    defx!("({:?})", _var);
}

This printed

$ cargo run
→hello from main
 main will be doing stuff...
    →my_func1: (3)
    ←my_func1: (3)
 main is done doing stuff...
←goodbye from main

If built with --release then the statements are not compiled and nothing would be printed.

Manually setting the indentation

The first use of a library macro will set the "original" stack depth. This is later used to calculate indentation offsets. If the first use of this library is several functions into a program then later printing may be lose indentation.

use si_trace_print::{
    pfo, pfn, pfx, pfñ,
};

fn main() {
    my_func1(3);
    pfx!("goodbye from main (this is not indented!)");
}

fn my_func1(var: usize) {
    my_func2(var);
    pfñ!("({:?}) (this is not indented!)", var);
}

fn my_func2(var: usize) {
    // this is the first call to a si_trace_print function
    // the "original" stack offset will be set from here
    pfn!("({:?})", var);
    pfo!("stack_depth {:?}, stack_offset {:?}", stack_depth(), stack_offset());
    pfx!("({:?})", var);
}

prints poorly indented output

→my_func2: (3)
 my_func2: stack_depth 15, stack_offset 0
←my_func2: (3)
↔my_func1: (3) (this is not indented!)
←main: goodbye from main (this is not indented!)

Explictly call stack_offset_set near the beginning of the thread.

use si_trace_print::{
    pfo, pfn, pfx, pfñ,
};

fn main() {
    // the "original" stack offset will be set from here
    stack_offset_set(None);
    my_func1(3);
    pfx!("goodbye from main");
}

fn my_func1(var: usize) {
    my_func2(var);
    pfñ!("stack_depth {:?}, stack_offset {:?}", stack_depth(), stack_offset());
}

fn my_func2(var: usize) {
    pfn!("({:?})", var);
    pfo!("stack_depth {:?}, stack_offset {:?}", stack_depth(), stack_offset());
    pfx!("({:?})", var);
}

this printed

            →my_func2: (3)
             my_func2: stack_depth 15, stack_offset 2
            ←my_func2: (3)
        ↔my_func1: stack_depth 14, stack_offset 1
    ←main: goodbye from main

The indentation is improved but is too far indented. The indentation amount to pass to stack_offset_set can be somewhat unpredictable. It depends on build settings and which thread is running, among other things. In this case, experimentation revealed value -1 to be best:

// ...
fn main() {
    stack_offset_set(Some(-1));
// ...

this printed

        →my_func2: (3)
         my_func2: stack_depth 15, stack_offset 1
        ←my_func2: (3)
    ↔my_func1: stack_depth 14, stack_offset 0
←main: goodbye from main

Shortcomings

Slow

This trace function may significantly slow a program. It is recommended to use the debug version of provided macros.

Release builds

The calculation of function depth depends on stack frames counted by backtrace::trace. In --release builds or under other optimization profiles, some functions may be optimized inline. The count of stack frames may not change among function calls. This means the printed indentation will not reflect function call depth. This can be forcibly avoided by adding attribute #[inline(never)] to such functions.