Skip to content

Minor dot graph fixes #149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
dkcumming wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Minor dot graph fixes #149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9789549
Stricter match for `Str`, `contains(str)` is too broad. Matches `&str`
dkcumming May 1, 2026
de1b566
Adding escape chars for dot rendering
dkcumming May 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/mk_graph/index.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ impl AllocEntry {
let (kind, description) = match info.global_alloc() {
GlobalAlloc::Memory(alloc) => {
let bytes = &alloc.bytes;
let is_str = ty_name.contains("str");
let is_str = ty_name == "Str";

// Convert Option<u8> bytes to actual bytes for display
let concrete_bytes: Vec<u8> = bytes.iter().filter_map(|&b| b).collect();
Expand Down
26 changes: 17 additions & 9 deletions src/mk_graph/output/dot.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ use crate::printer::SmirJson;
use crate::MonoItemKind;

use crate::mk_graph::context::GraphContext;
use crate::mk_graph::util::{block_name, is_unqualified, name_lines, short_name, GraphLabelString};
use crate::mk_graph::util::{
block_name, escape_dot, is_unqualified, name_lines, short_name, GraphLabelString,
};

impl SmirJson {
/// Convert the MIR to DOT (Graphviz) format
Expand All @@ -36,7 +38,11 @@ impl SmirJson {
// Add allocs legend node if there are any allocs
if !ctx.allocs.by_id.is_empty() {
let mut alloc_node = graph.node_auto();
let mut lines = ctx.allocs_legend_lines();
let mut lines: Vec<String> = ctx
.allocs_legend_lines()
.iter()
.map(|s| escape_dot(s))
.collect();
lines.push("".to_string());
alloc_node.set_label(&lines.join("\\l"));
alloc_node.set_style(Style::Filled);
Expand All @@ -48,7 +54,7 @@ impl SmirJson {
if type_lines.len() > 1 {
// Only show if there are actual types (more than just "TYPES" header)
let mut type_node = graph.node_auto();
let mut lines = type_lines;
let mut lines: Vec<String> = type_lines.iter().map(|s| escape_dot(s)).collect();
lines.push("".to_string());
type_node.set_label(&lines.join("\\l"));
type_node.set_style(Style::Filled);
Expand Down Expand Up @@ -83,7 +89,7 @@ impl SmirJson {
vector.push(String::from("LOCALS"));
for (index, decl) in body.clone().unwrap().local_decls() {
let ty_with_layout = ctx.render_type_with_layout(decl.ty);
vector.push(format!("{index} = {}", ty_with_layout));
vector.push(escape_dot(&format!("{index} = {}", ty_with_layout)));
}
vector.push("".to_string());
local_node.set_label(vector.join("\\l").to_string().as_str());
Expand Down Expand Up @@ -170,7 +176,7 @@ impl SmirJson {
cluster
.edge(&this_block, block_name(name, *t))
.attributes()
.set_label(&dest);
.set_label(&escape_dot(&dest));
}

// The call edge has to be drawn outside the cluster, outside this function (cluster borrows &mut graph)!
Expand Down Expand Up @@ -215,7 +221,9 @@ impl SmirJson {
}
let mut n = cluster.node_named(&this_block);
label_strs.push("".to_string());
n.set_label(&label_strs.join("\\l"));
let escaped: Vec<String> =
label_strs.iter().map(|s| escape_dot(s)).collect();
n.set_label(&escaped.join("\\l"));
};

let process_blocks =
Expand Down Expand Up @@ -278,7 +286,7 @@ impl SmirJson {
.map(|op| ctx.render_operand(op))
.collect::<Vec<String>>()
.join(",");
e.attributes().set_label(&arg_str);
e.attributes().set_label(&escape_dot(&arg_str));
}
_other => {
// nothing to do
Expand All @@ -293,11 +301,11 @@ impl SmirJson {
}
MonoItemKind::MonoItemGlobalAsm { asm } => {
let mut n = graph.node_named(short_name(&asm));
n.set_label(&asm.lines().collect::<String>()[..]);
n.set_label(&escape_dot(&asm.lines().collect::<String>()));
}
MonoItemKind::MonoItemStatic { name, .. } => {
let mut n = graph.node_named(short_name(&name));
n.set_label(&name[..]);
n.set_label(&escape_dot(&name));
}
}
}
Expand Down
7 changes: 7 additions & 0 deletions src/mk_graph/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,13 @@ pub fn escape_d2(s: &str) -> String {
.replace('$', "\\$")
}

/// Escape special characters for a DOT label's per-line content. Apply to each
/// line BEFORE joining with the `\l` line separator, otherwise the separators
/// themselves get escaped.
pub fn escape_dot(s: &str) -> String {
s.replace('\\', "\\\\").replace('"', "\\\"")
}

// =============================================================================
// Byte Helpers
// =============================================================================
Expand Down
Loading