RustViz

RustViz is a tool that generates visualizations from simple Rust programs to assist users in better understanding the Rust Lifetime and Borrowing mechanism.

What does it look like?

RustViz generates SVG files with graphical indicators that integrate with mdbook to render visualizations of data-flow in Rust programs. Here's a sample view of what a visualization can look like:

Usage

RustViz is capable of visualizing simple Rust programs (albeit with certain limitations) via user definition. In this section, we'll showcase how to generate SVG renderings of examples provided by us.

RustViz requires Rust, Cargo and mdbook to be installed. Once you have installed all the above prerequisites, direct into /rustviz_mdbook and run the script:

~/rustviz/rustviz_mdbook$ ./view_examples.sh

You may have an output similar to this:

Generating visualizations for the following examples:
building copy...
building hatra1...
building hatra2...
building func_take_ownership...
building func_take_return_ownership...
2021-01-19 12:36:13 [INFO] (mdbook::book): Book building has started
2021-01-19 12:36:13 [INFO] (mdbook::book): Running the html backend
Serving HTTP on :: port 8000 (http://[::]:8000/) ...

If you observed this output, then you have successfully generated the Rust visualization examples! Now open your browser and navigate to http://localhost:8000/. You should be able to view the examples individually by selecting them from the left side bar. To view the visualization, click the toggle button on the top right corner of the code block.

Great, this is how you can generate and view visualizations created using RustViz. Now let's create one from scratch!

Step-By-Step Guide

In this section, we'll dive into creating an example, string_from_move_print. First, take note of the file structure we'll need to run the example:

string_from_move_print
├── input
│   └── annotated_source.rs
├── main.rs
└── source.rs

source.rs contains the untouched source code we wish to render into an image:

fn main() {
    let x = String::from("hello");
    let y = x;
    println!("{}", y);
}

In this example, String::from() moves a string ("hello") to x, then x's resource is moved to y. Subsequently, println!() outputs a message to io::stdout without moving the resource.

Next, let's familiarize ourselves with the syntax used in main.rs. The RustViz tool defines all possible owners, references or input of any memory resource as a ResourceAccessPoint. In this case, we consider the function String::from() and two variables, x and y, as Resource Access Points (RAPs). Each of String::from() and x/y corresponds to RAPs ResourceAccessPoint::Function and ResourceAccessPoint::Owner, respectively.

In main.rs, we define these RAPs between the BEGIN and END comments on lines 1 and 2:

/*--- BEGIN Variable Definitions ---
Owner x; Owner y;
Function String::from()
--- END Variable Definitions ---*/

The format for each ResourceAccessPoint enum is shown below, where fields preceded by ':' denote an optional field:

ResourceAccessPoint Usage --
    Owner <:mut> <name>
    MutRef <:mut> <name>
    StaticRef <:mut> <name>
    Struct <:mut> <name>{<:mut> <member_1>, <:mut> <member_2>, ... }
    Function <name>

Alternatively, some code let mut a = 5; and let b = &a; would correspond to Owner mut a and StaticRef b, respectively. An immutable instance of some struct with member variables x and mut y, on the other hand, may be annotated as Struct a{x, mut y}.

It is important to note:

all definitions must lie between BEGIN and END

all definitions must be defined in the same order by which they were declared in the source code

all definitions must be separated by a singular semicolon

each field within a RAP definition must be separated by a whitespace

Next, we annotate the code with the use of ExternalEvents that describe move, borrow, and drop semantics of Rust. In string_from_move_print, we have four such events:

Move of resource from String::from() to x
Move of resource from y to x
Drop of resource binded to x
Drop of resource binded to y

We can specify Events in structured comments like so:

/* --- BEGIN Variable Definitions ---
Owner x; Owner y;
Function String::from()
 --- END Variable Definitions --- */
fn main() {
    let x = String::from("hello"); // !{ Move(String::from()->x) }
    let y = x; // !{ Move(x->y) }
    println!("{}", y); // print to stdout!
} /* !{
    GoOutOfScope(x),
    GoOutOfScope(y)
} */

Each Event is defined on the line where it occurs and within delimiters !{ and }.

Events can be annotated within block comments; however, the block must start on the line in which the events occur. Additionally, all Events within a !{} delimitation must be separated by a singular comma and must each follow the format:

ExternalEvents Usage:
    Format: <event_name>(<from>-><to>)
        e.g.: // !{ PassByMutableReference(a->Some_Function()), ... }
    Note: GoOutOfScope and InitializeParam require only the <from> parameter
        e.g.: // !{ GoOutOfScope(x) }

Refer to the Appendix for a list of usable ExternalEvent's.

Phew! All that's left is running the program. Simply run:

cargo run string_from_move_print

Now your folder should look like this:

string_from_move_print
├── input
│   └── annotated_source.rs
├── main.rs
├── source.rs
├── vis_code.svg
└── vis_timeline.svg

Congratulations! You have successfully generated your first visualization! As a last step, add the name of your example to targetExamples under view_examples.sh and run the script to see it in your browser.

Appendix

ExternalEvent Usage:

Event	Usage
`Bind(a->b)`	Let binding or assignment. e.g.: `let a = 1;`
`Copy(a->b)`	Copies the resource of `a` to variable `b`. Here, `a` implements the `Copy` trait.
`Move(a->b)`	Moves the resource of `a` to variable `b`. Here, `a` implements the `Move` trait.
`StaticBorrow(a->b)`	Assigns an immutable reference of `a` to `b`. e.g.: `let b = &a;`
`MutableBorrow(a->b)`	Assigns a mutable reference of `a` to `b`. e.g.: `let b = &mut a;`
`StaticReturn(a->b)`	Ends the non-lexical lifetime of the reference variable `a` and returns the resource back to its owner `b`.
`MutableReturn(a->b)`	Ends the non-lexical lifetime of the reference variable `a` and returns the resource back to its owner `b`.
`PassByStaticReference(a->b)`	Passes an immutable reference of variable `a` to function `b`. Not to be confused with StaticBorrow.
`PassByMutableReference(a->b)`	Passes a mutable reference of variable `a` to function `b`. Not to be confused with MutableBorrow.
`StructBox(a->b)`	Creates a struct instance `a` whose last member variable is `b`. Notes: (1) This event should be specified on the same line the struct instance, `a`, goes out of lexical scope. (2) A struct's member variables should always be defined in the same order they are declared in.
`GoOutOfScope(a)`	Ends the lexical lifetime of variable `a`.
`InitializeParam(a)`	Initializes the parameter `a` of some function. e.g.: `some_fn(a: String) {..}`

Note:

GoOutOfScope and InitializeParam require a singular parameter previously defined in the Variable Definitions section. (e.g.: // !{ GoOutOfScope(x) })

All other events require two parameters, a and b, which can either be defined (e.g.: Owner a) or undefined (None). The None option is generally used for scalar types or undefined variables (e.g.: let x = 1 can be annotated as Bind(None->x)).

Visualization Limitations

Some features are still being built. As of now, we are limited to:

No branching logic
No looping
No explicit lifetime annotation

sbrichardson / rustviz