//! The state column (design/README.md, "3. Panels"): `registers`, all //! seventeen, each followed as far as it points; `stack`, the words from //! rsp with the frames they belong to as `call` spans down its right edge //! and the registers that point at a word as `pin`s in its lane; and //! `backtrace`, the call chain as rows, a panel of its own only in the //! `none` split. Ink says what a thing is, paper what happened to it. //! Reads `Moment.regs`, `Moment.read`, the mappings (through //! `zt.telescope`), and the names the debugger recorded. const std = @import("std"); const sk = @import("sketch"); const anim = @import("anim"); const zt = @import("ztrace"); const ui = @import("ui.zig"); const rows = @import("rows.zig"); const cursors = @import("cursor.zig"); const Recording = @import("Recording.zig"); const syscalls = @import("syscalls.zig"); const ties = @import("ties.zig"); const hexdump = @import("hexdump.zig"); const map = @import("map.zig"); const Stage = @import("stage.zig").Stage; const theme = ui.theme; const time = theme.time; const Rect = ui.Rect; const t = theme.color.text; const m = theme.metric.context; pub const ink = rows.ink; pub const regionOf = rows.regionOf; /// The registers' tag: the legend of what an address's ink says, always on screen, as pwndbg's is. pub const legend = blk: { const c = theme.color.region; break :blk [_]ui.Legend{ .{ .text = "stack", .ink = ui.rgb(c.stack) }, .{ .text = "heap", .ink = ui.rgb(c.heap) }, .{ .text = "code", .ink = ui.rgb(c.code_) }, .{ .text = "data", .ink = ui.rgb(c.data) }, .{ .text = "rwx", .ink = ui.rgb(c.data), .under = true }, .{ .text = "read-only", .ink = ui.rgb(c.rodata) }, }; }; /// While a `dive` or a `surface` plays (`map.Map`): each working panel's /// box, and the rect it is drawn into instead, on its way between its /// window on the map and its place; its tags, rules and lanes how much shown. pub const Zoom = struct { box: Rect, to: Rect, chrome: f32, shows: f32 = 1 }; pub var zoomed: [8]?Zoom = @splat(null); /// How much the thread shows: it fades in (12 f) once a dive has landed, never in a frame. pub var thread_shows: f32 = 1; /// A panel's `Ui`, moved to where the stage has its box now (or, in a /// dive, scaled into the rect it is on its way through). pub fn at(f: *sk.Frame, placed: anim.Placed, box: Rect) ui.Ui { var p = placed; ui.chrome = 1; if (!ui.mapping) for (zoomed) |z| if (z) |zz| if (@abs(zz.box.x - box.x) < 0.5 and @abs(zz.box.y - box.y) < 0.5 and @abs(zz.box.h - box.h) < 0.5) { const k = zz.to.w / box.w; p.xf = p.xf.mul(.translate(zz.to.x, zz.to.y)).mul(.scale(k, k)).mul(.translate(-box.x, -box.y)); p.scale *= k; p.pose.opacity *= zz.shows; // On its way it is opaque, over the panels that set off before it; its tag and rules come in at the end. const u = (ui.Ui{ .f = f, .at = p }).moved(box.x, box.y); u.fill(.{ .x = 0, .y = m.tag, .w = box.w, .h = box.h - m.tag }, theme.color.page); ui.chrome = zz.chrome; return u; }; // Looking at the map alone (`map.looking`): the working panels stand aside. if (!ui.mapping and map.looking(f)) p.pose.opacity = 0; return (ui.Ui{ .f = f, .at = p }).moved(box.x, box.y); } pub fn veiled(u: ui.Ui, box: Rect, amount: f32) void { // Staging: what cannot be read at a sprint is dimmed, not removed. u.veil(.{ .x = theme.stroke.rule, .y = m.tag, .w = box.w - 2 * theme.stroke.rule, .h = box.h - m.tag - theme.stroke.rule }, amount); } /// The rows a panel `box` shows: while a relayout moves it, one more, cut by its edge. pub fn rowsOf(box: Rect) usize { return @intFromFloat(@max(@ceil((box.h - m.tag - 2 * m.pad) / m.row), 0)); } pub fn clipBody(u: ui.Ui, box: Rect) void { u.clip(.{ .x = theme.stroke.rule, .y = m.tag + m.pad - 1, .w = box.w - 2 * theme.stroke.rule, .h = box.h - m.tag - 2 * m.pad + 2 }); } pub const Registers = struct { cursor: cursors.Cursor, stage: *const Stage, /// A step that makes a system call frames, as read, the registers /// that carry it, one at a time; and rax is struck when it returns. syscalls: bool = false, /// No strikes: for a program whose instrumentation uses the registers /// between any two lines, so that nearly all of them change at every one. quiet: bool = false, focus: bool = false, const Shown = struct { regs: zt.Regs, moment: Recording.Moment }; pub fn draw(r: *const Registers, f: *sk.Frame, placed: anim.Placed) void { const box = r.stage.box(placed, .registers); const u = at(f, placed, box); const now = r.cursor.now(placed); const rec = r.cursor.rec; const is: Shown = .{ .regs = (now.moment().regs(rec.tid) catch null) orelse zt.Regs{}, .moment = now.moment() }; const was: Shown = .{ .regs = (now.before().regs(rec.tid) catch null) orelse is.regs, .moment = now.before() }; const body = u.panel(box.w, box.h, "registers", .{ .focus = r.focus, .legend = &legend }); // A link leaves from the panel's edge, not through a name. ties.anchor(u, .registers, .{ .x = 0, .y = 0, .w = box.w, .h = box.h }); clipBody(u, box); defer u.unclip(); const shown = @min(rowsOf(box), theme.metric.all_registers.len); // Overlapping action: of the registers one step wrote, each strikes 2 f after the one above it. for (theme.metric.all_registers[0..shown], 0..) |name, i| { const y = body.y + m.pad + @as(f32, @floatFromInt(i)) * m.row; if (std.mem.eql(u8, name, "rip")) { r.rip(u, now, y, box.w, is, was); continue; } r.row(u, now, is, was, name, y, box.w); } veiled(u, box, now.veil); } fn shownAt(rec: *const Recording, i: u64) ?Shown { const moment = rec.moment(i); return .{ .regs = (moment.regs(rec.tid) catch return null) orelse return null, .moment = moment }; } /// rip: where execution is, a current mark like the source's and the /// disassembly's; it moves with them, at the advance. fn rip(r: *const Registers, u: ui.Ui, now: cursors.Now, y: f32, w: f32, is: Shown, was: Shown) void { const rec = r.cursor.rec; // The flags' corners are secondary: 6 f after the registers strike, // not with them; in a continue's wave, in its place after r15. const delay = if (now.plan.wave) ties.strikeDelay(now, index("eflags").?) else cursors.write_apart; const landed = now.landed(.cpu, delay); // The flags a step changed have a turned corner, for three steps. const eflags_index = comptime index("eflags").?; // Until this step's change lands, the corners are the last one's: no effect before its cause. const age = if (landed) now.registerAge(eflags_index) else now.registerAgeFrom(eflags_index, 1); var changed: u64 = 0; if (age) |a| changed = rec.register(now.stops[a], "eflags") ^ rec.register(now.stops[a + 1], "eflags"); const heat = now.register(eflags_index, delay); const held = if (r.quiet) 0 else heat.level * heat.corner; // While a conditional jump runs, the flags it reads are framed (an echo of the row that set them). const reads: u64 = if (now.resting() or now.advancing() >= 0.5) 0 else @import("disasm.zig").readsFlags(rec, now.stops[1]); // rip crossfades with the advance; a flag set or cleared, over the 6 f it lands in. const flip = std.math.clamp(now.since(.cpu, delay) / time.strike.in, 0, 1); rows.rip(u, y, w, rec.moment(now.marks[1]), rec.register(now.marks[1], "rip"), is.regs.eflags, changed, held, 0, reads, now.reading(.cpu, 0), .{ .moment = rec.moment(now.marks[0]), .pc = rec.register(now.marks[0], "rip"), .eflags = was.regs.eflags, .going = now.advancing(), .flip = if (now.resting()) 1 else flip }); } fn row(r: *const Registers, u: ui.Ui, now: cursors.Now, line_is: Shown, line_was: Shown, name: []const u8, y: f32, w: f32) void { const rec = r.cursor.rec; const i = index(name) orelse return; // Every register is the program's, at its line stops, as every // other panel is: what crossed into the kernel is the crossing's // to show, and a register is framed as carrying it only where it // still holds what crossed. const is = line_is; const was = line_was; const value_now = is.regs.named(name) orelse return; const value_was = was.regs.named(name) orelse value_now; var marks: rows.Marks = .{}; var landed = now.landed(.cpu, 0); var note: []const u8 = ""; var note_shows: f32 = 1; const crossing: ?Recording.Syscall = if (r.syscalls) syscalls.inStep(now) else null; // A register is framed as carrying the call only while it holds the // argument in the moment shown: the stop before the call, until the // call is back. (Set by the wrapper, between the stops, it carried // it where no stop saw it: the kernel's rows say it.) const carrier: ?usize = if (crossing) |made| for (syscalls.carried(made), 1..) |carried, k| { if (std.mem.eql(u8, carried, name) and value_was == made.args[k - 1]) break k; } else null else null; if (carrier) |k| if (crossing) |made| { const framed = now.time - syscalls.Plan.in(now, made).registers - @as(f32, @floatFromInt(k - 1)) * time.flight.second; marks.read = 0; marks.read_shows = @min(std.math.clamp(framed / time.read.in, 0, 1), now.reading(.cpu, 0)); // A descriptor says what it is open on: the `value` class `fd`. const names = zt.syscalls.names(made.nr); if (k <= names.len and std.mem.endsWith(u8, names[k - 1], "fd")) note = rec.openOn(u.f.scratch, value_was, made.enter); // In with its framing, over 12 f, and out with it: never in a frame. note_shows = @min(std.math.clamp(framed / time.quick, 0, 1), now.reading(.cpu, 0)); }; if (if (std.mem.eql(u8, name, "rax")) crossing else null) |made| { // rax: what was there, then the result, once the kernel's rows // have said it (the call's number went in at the wrapper). const back = now.time - syscalls.Plan.in(now, made).struck; const result = back >= time.strike.in / 2.0; const value: u64 = if (result) value_now else value_was; if (back >= -time.strike.arm) { marks = .{ .first = now.heat(0, null, back) }; if (back >= 0 and now.walking()) marks.extend = back; } const hops = rows.reg(u, y, w, name, if (result) is.moment else was.moment, value, marks); // What `open` gave back is a descriptor: the `value` class // `fd`, this call's once it is back, the last one's before. const gave = if (result) made else if (syscalls.latest(rec, now.stops[1])) |n| rec.syscalls[n] else null; if (gave) |g| if (g.exit != null and g.result == value and std.mem.eql(u8, zt.syscalls.name(g.nr) orelse "", "open")) fdNote(u, hops, y, rec.openOn(u.f.scratch, value, g.exit.? + 1)); return anchor(u, i, hops, y); } else if (r.quiet) { // Unmarked: the values change as the mark moves on. landed = now.advancing() >= 0.5; } else { const age = now.registerAge(i); // (In a step that crosses into the kernel, what else the line // changed is seen after the call is back, after rax: `strikeDelay`.) const delay = if (age == 0) ties.strikeDelay(now, i) else 0; landed = now.landed(.cpu, delay); marks.first = now.register(i, delay); // A register written: the rest of its chain is followed again. const since = now.since(.cpu, delay); if (age == 0 and now.walking() and since >= 0) marks.extend = since; } // At a run a value changes in place under an 8 f crossfade, unmarked, never in a frame. const ran = runFade(now, .cpu); if (ran < 1 and value_was != value_now) _ = rows.reg(u.faded(1 - ran), y, w, name, was.moment, value_was, marks); // Its chain reads memory as the panels show it: what the step writes // there is followed again (`extend`) once the bytes have landed, never before. var memory = if (landed or ran < 1) is.moment else was.moment; if (ran >= 1 and landed and !r.quiet) { memory, const again, marks.hops = now.following(value_now); if (again) |ago| marks.extend = @min(marks.extend orelse ago, ago); } const hops = rows.reg(if (ran < 1 and value_was != value_now) u.faded(ran) else u, y, w, name, memory, if (landed or ran < 1) value_now else value_was, marks); fdNote(u.faded(note_shows), hops, y, note); anchor(u, i, hops, y); } /// The `fd` class's note after a register's value: faint, what it is open on. fn fdNote(u: ui.Ui, hops: rows.Hops, y: f32, on: []const u8) void { if (hops.n > 0 and on.len > 0) u.text(.mono, theme.size.mono.context, hops.end + 8, rows.baseline(y), on, t.faint); } fn anchor(u: ui.Ui, i: usize, hops: rows.Hops, y: f32) void { if (hops.n > 0) ties.anchor(u, .{ .register = i }, .{ .x = hops.x[0], .y = y, .w = hops.w[0], .h = m.row }); } }; /// How far (0 to 1) a run's step has crossfaded its values at `level` (8 f from it); 1 at any other pace. fn runFade(now: cursors.Now, level: cursors.Level) f32 { if (now.plan.gait != .run or now.resting()) return 1; return std.math.clamp(now.since(level, 0) / time.run_ease, 0, 1); } /// A register's place in `Regs.names`. pub fn index(name: []const u8) ?usize { for (zt.Regs.names, 0..) |known, i| if (std.mem.eql(u8, known, name)) return i; return null; } /// One frame of the call chain, on the stack: its function's pc, and the /// slots that are the frame, from `lo` to `hi` (the last; null: its end is /// not known, past what the recording holds). pub const Frame = struct { pc: u64, lo: u64, hi: ?u64 }; /// The frames at moment `i`, newest first, with their extents, as the /// tracer reads them off the frame-pointer chain. pub fn frames(rec: *const Recording, i: u64, out: []Frame) []Frame { const moment = rec.moment(i); const regs = (moment.regs(rec.tid) catch return out[0..0]) orelse return out[0..0]; var buf: [24]zt.Debugger.Frame = undefined; const found = zt.telescope.frames(moment, ®s, buf[0..@min(buf.len, out.len)]) catch return out[0..0]; for (found, out[0..found.len]) |f, *o| o.* = .{ .pc = f.pc, .lo = f.low, .hi = if (f.high > f.low) f.high - 8 else null }; return out[0..found.len]; } /// A frame's span on the stack: its function's name, and as a call its /// argument where it takes one (`fib(4)`): the digits on its node. fn spanName(u: ui.Ui, rec: *const Recording, open: []const Recording.Call, i: usize, pc: u64) []const u8 { const name = frameName(u, rec, pc); if (i >= open.len) return name; const call = open[open.len - 1 - i]; if (!std.mem.eql(u8, rec.name(call.function), name)) return name; const takes = for (rec.functions) |f| { if (std.mem.eql(u8, f.name, name)) break f.takes; } else false; const arg = call.arg orelse return name; if (!takes) return name; const v = ui.Value.of(arg, rows.regionOf(rec.moment(call.enter), arg) != .none); // A small number in decimal, as on the node; anything else as its class has it. return if (v.decimal) u.print("{s}({d})", .{ name, arg }) else u.print("{s}({s}{s})", .{ name, v.prefix, v.digits() }); } /// Frame `i`'s arguments, from the call the recording knows it to be /// (the `i`th open call from the newest, when it is of this frame's /// function): "" where it knows none. pub fn callArguments(u: ui.Ui, rec: *const Recording, open: []const Recording.Call, i: usize, pc: u64) []const u8 { if (i >= open.len) return ""; const call = open[open.len - 1 - i]; if (!std.mem.eql(u8, rec.name(call.function), frameName(u, rec, pc))) return ""; return @import("calls.zig").arguments(u, rec, call); } /// Where frame `i` is in the program's source, `file:line`: the newest at /// the moment's own line, when the moment is on one (in a library it is /// not); an older one on its call's line, or where the recording only /// knows a line near its return address, that one. pub fn frameWhere(u: ui.Ui, rec: *const Recording, moment: u64, i: usize, pc: u64) []const u8 { const place = if (i == 0) rec.where(moment, pc) else rec.where(moment, callOf(rec, moment, pc) orelse pc); return if (place) |l| u.print("{s}:{d}", .{ l.file, l.line }) else ""; } /// The call that returns to `ret`, where the recording has it: an outer /// frame is on its call's line, not on the one it returns to. fn callOf(rec: *const Recording, moment: u64, ret: u64) ?u64 { var buf: [256]u8 = undefined; const after = rec.instruction(moment, ret, &buf) orelse return null; if (after.back == 0) return null; return ret - after.back; } /// A frame's name: its function's (no offset), or its module's and offset where there is no symbol. pub fn frameName(u: ui.Ui, rec: *const Recording, pc: u64) []const u8 { const name = rec.strings.get(pc) orelse return u.print("{x}", .{pc}); const shown = ui.symbol(u, name); // A library's symbol (`libc.so.6!open+0`) by its name alone; one with none, `libc+27781`. if (std.mem.indexOfScalar(u8, name, '!') != null and shown.ptr != name.ptr + std.mem.indexOfScalar(u8, name, '!').? + 1) return shown; return shown[0 .. std.mem.lastIndexOfScalar(u8, shown, '+') orelse shown.len]; } /// The registers (of the sixteen) that hold `addr` in `regs`. fn pointing(u: ui.Ui, regs: zt.Regs, addr: u64) []const []const u8 { var out: std.ArrayList([]const u8) = .empty; for (theme.metric.all_registers[0..16]) |name| { if (regs.named(name) == addr) out.append(u.f.scratch, name) catch break; } return out.items; } pub const Stack = struct { cursor: cursors.Cursor, stage: *const Stage, focus: bool = false, /// On the map: the window from this many words above rsp, not scrolled /// (negative: below it, the stack going on in another column's rest). above: i32 = 0, /// Which box of its stage it is in: the map's `more` holds the stack continued. part: @import("stage.zig").Part = .stack, pub fn draw(k: *const Stack, f: *sk.Frame, placed: anim.Placed) void { const box = k.stage.box(placed, k.part); if (box.h < m.tag + m.row) return; const u = at(f, placed, box); const now = k.cursor.now(placed); const rec = k.cursor.rec; const slots = rowsOf(box); const is = (now.moment().regs(rec.tid) catch null) orelse return; const was = (now.before().regs(rec.tid) catch null) orelse is; // The window: from rsp, or further into the frame ([rsp, rbp+16)) // when that is longer than the panel, so that the word the last // steps touched is in its middle. When a step moves it the rows // slide, with the stack's words, a level after the registers. // Under the camera the window holds still, `free` words above the // rsp it was held at: pushes fill them, and rsp's pin climbs. const hold = placed.value(k.stage.hold); const held = hold >= 0; const held_at: u64 = if (held) rec.register(@intFromFloat(hold), "rsp") -% 8 * @as(u64, @intFromFloat(placed.value(k.stage.hold_free))) else 0; var window = if (held) [2]u64{ held_at, held_at } else if (k.above != 0) [2]u64{ is.rsp -% @as(u64, @bitCast(@as(i64, 8 * k.above))), was.rsp -% @as(u64, @bitCast(@as(i64, 8 * k.above))) } else [2]u64{ windowAt(now, is, slots, 0), windowAt(now, was, slots, 1) }; // A window that goes farther than its own height (a continue to a // stop deeper or shallower than a call is) does not scroll: the old // rows fade out before memory strikes and the new ones in after, // each with the memory of its own stop. const jumped = far(window[0], window[1], slots); // Out over 12 f to memory's landing and in over 12 f (at a run, half // its step each, the turn no sooner than that): never in a frame. const fade = @min(time.quick, now.plan.total / 2.0); const turn = @max(now.plan.at[1] + time.strike.in / 2.0, fade); const landed = if (jumped and !now.resting()) now.time >= turn else now.landed(.memory, 0); // On the minimap the window glides there, whether it scrolls or fades here. const ways = window; const since_memory = now.since(.memory, 0); const jump_shows: f32 = if (!jumped or now.resting()) 1 else if (!landed) 1 - std.math.clamp((now.time - turn + fade) / fade, 0, 1) else std.math.clamp((now.time - turn) / fade, 0, 1); if (jumped) window = if (landed) .{ window[0], window[0] } else .{ window[1], window[1] }; const v = u.faded(jump_shows); // Going to the hold and coming from it, the rows scroll: the // remaining way, in rows, from where the window would be. const natural = windowAt(now, is, slots, 0); const hold_scroll: f32 = if (held) @as(f32, @floatFromInt(@as(i64, @bitCast(held_at -% natural)))) / 8 * (1 - cursors.glide(placed.value(k.stage.hold_in))) else 0; // From rsp, or the range shown when the window is elsewhere: in // bytes from rsp, as the catalogue writes it (`rsp+20 to rsp+48`). const offset = struct { fn of(u_: ui.Ui, d: i64) []const u8 { return if (d == 0) "rsp" else if (d > 0) u_.print("rsp+{x}", .{@as(u64, @intCast(d))}) else u_.print("rsp-{x}", .{@as(u64, @intCast(-d))}); } }.of; const words = switch (slots) { 4 => "four", 6 => "six", 8 => "eight", else => u.print("{d}", .{slots}), }; // The first word shown and the last. // The range before memory lands and after: one that changes crossfades (12 f), as a role does. const recast = if (now.resting()) 1 else std.math.clamp(since_memory / time.quick, 0, 1); const ranges = [2]i64{ @bitCast(ways[1] -% was.rsp), @bitCast(ways[0] -% is.rsp) }; var notes: [2][]const u8 = undefined; for (ranges, ¬es) |r_, *note| { const range = if (r_ == 0) u.print("{s} words from rsp", .{words}) else u.print("{s} to {s}", .{ offset(u, r_), offset(u, r_ + 8 * (@as(i64, @intCast(slots)) - 1)) }); note.* = u.print("{s} \u{00b7} the frames they belong to", .{range}); } const renote = !std.mem.eql(u8, notes[0], notes[1]) and recast < 1; const body = u.panel(box.w, box.h, if (k.part == .more) "stack, continued" else "stack", .{ .focus = k.focus, .note = if (renote) "" else notes[1] }); if (renote) { u.faded(1 - recast).tagNote(box.w, notes[0]); u.faded(recast).tagNote(box.w, notes[1]); } const p = cursors.glide(now.moving(.memory, 0, time.move)); const moved = @as(f32, @floatFromInt(@as(i64, @bitCast(window[0] -% window[1])))) / 8; const slide: f32 = (if (jumped) 0 else moved * (1 - p)) + hold_scroll; const top = body.y + m.pad; clipBody(u, box); defer u.unclip(); // The addresses' shared digits: the rows read by their ends, of the // window shown (it changes with the slide, not before it). const shown_at = if (landed) window[0] else window[1]; const lead = ui.shared(&.{ shown_at, shown_at + 8 * @as(u64, slots) }); const memory = now.shown(.memory); // Marks only for what the viewer saw change: the steps since the // window last faded to its place (none on a window that has just // faded in; the ticks it had on its way out). const watched_from: usize = if (jumped and !landed) 1 else 0; const watched_to = if (held) now.stops.len else watched(now, slots, watched_from); // rsp and rbp, moved by the step with no link to land: their tags // travel down the lane from the old word to the new, with the slide. var travel_buf: [2][]const u8 = undefined; var travelling: usize = 0; for ([_][]const u8{ "rsp", "rbp" }) |name| if (!now.resting() and !jumped and was.named(name) != is.named(name)) { travel_buf[travelling] = name; travelling += 1; }; const travel = travel_buf[0..travelling]; // The backtrace, drawn on the words that are each frame: each span // glides from the frame's old extent to its new one with the slide. // Worked out first: a name longer than the spans' room takes room // from the chains of the rows beside it, which end before it. var buf: [16]Frame = undefined; var old_buf: [16]Frame = undefined; const chain = frames(rec, now.stops[if (jumped and !landed) 1 else 0], &buf); const old_chain = frames(rec, now.stops[if (jumped and landed) 0 else 1], &old_buf); // Placed as the rows are: against the window after the step, and slid. const open_calls = rec.stack(u.f.scratch, if (landed) now.stops[0] else now.stops[1]); const named = if (landed) chain else old_chain; const rows_of = struct { fn at(addr: u64, base: u64) f32 { return @as(f32, @floatFromInt(@as(i64, @bitCast(addr -% base)))) / 8; } }.at; const Span = struct { y0: f32, y1: f32, name: []const u8, newest: bool, open: bool, was: ?[]const u8 = null }; // A frame whose name changes in place (on through a stub) crossfades over the 12 f before the advance. const renamed = now.renaming(); const calls_was = rec.stack(u.f.scratch, now.stops[1]); const calls_is = rec.stack(u.f.scratch, now.stops[0]); var spans: [16]Span = undefined; var n_spans: usize = 0; for (chain, 0..) |frame, i| { const old_frame = if (i < old_chain.len) old_chain[i] else frame; const first = std.math.lerp(rows_of(old_frame.lo, window[0]), rows_of(frame.lo, window[0]), p) + slide; if (first >= @as(f32, @floatFromInt(slots))) break; const last = if (frame.hi) |hi| std.math.lerp(if (old_frame.hi) |oh| rows_of(oh, window[0]) else rows_of(hi, window[0]), rows_of(hi, window[0]), p) + slide else std.math.inf(f32); if (last < 0) continue; const open = last >= @as(f32, @floatFromInt(slots)); const y1 = top + (@min(last, @as(f32, @floatFromInt(slots)) - 1) + 1) * m.row; spans[n_spans] = .{ .y0 = top + @max(first, 0) * m.row, .y1 = y1, .name = spanName(u, rec, open_calls, i, if (i < named.len) named[i].pc else frame.pc), .newest = i == 0, .open = open }; if (now.walking() and !jumped and i < old_chain.len and old_chain[i].lo == frame.lo) { const was_name = spanName(u, rec, calls_was, i, old_chain[i].pc); const is_name = spanName(u, rec, calls_is, i, frame.pc); if (!std.mem.eql(u8, was_name, is_name)) { spans[n_spans].name = is_name; spans[n_spans].was = was_name; } } n_spans += 1; } // rsp or rbp travelling alone keeps its place in the pin it leaves and // the one it joins: room there, closing and opening as it goes. It // sets off 18 f after rsp's strike (`time.pin`): 24 f to the next // row, 2 f a further row, 36 f at most. const goes = struct { fn of(n: cursors.Now, a: zt.Regs, b: zt.Regs, name: []const u8) f32 { if (n.resting()) return 1; const pin = time.pin; const rows_far: f32 = @floatFromInt(@abs(@as(i64, @bitCast((b.named(name) orelse 0) -% (a.named(name) orelse 0)))) / 8); const takes = @min(pin.row + pin.step_per_row * @max(rows_far - 1, 0), pin.row_max); // rsp's strike sets both off: rbp, struck first, goes with it. return cursors.standard(std.math.clamp((n.since(.cpu, ties.strikeDelay(n, index("rsp").?)) - pin.after) / takes, 0, 1)); } }.of; const size = theme.size.mono.context; const lone: ?[]const u8 = if (travel.len == 1) travel[0] else null; // The offsets are from the rsp of the rows shown: they change with the slide, not before it. const rsp_shown = if (landed) is.rsp else was.rsp; // What each word is, where the recording says (`zt.telescope.slots`): // a register saved for the caller, a local, the process's first stack. // Of the rows of both windows: those sliding out keep theirs as they go. const roles_from = @min(window[0], window[1]) -% 16; const roles_n = slots + 4 + @abs(@as(i64, @bitCast(window[0] -% window[1]))) / 8; // Before the step and after it: a role that changes crossfades as memory strikes (12 f). var roles_buf: [2][80]zt.telescope.Slot = undefined; const roles = [2][]zt.telescope.Slot{ zt.telescope.slots(now.before(), &was, roles_from, roles_buf[0][0..@min(roles_n, roles_buf[0].len)]) catch roles_buf[0][0..0], zt.telescope.slots(now.moment(), &is, roles_from, roles_buf[1][0..@min(roles_n, roles_buf[1].len)]) catch roles_buf[1][0..0], }; // The words that point at other words of the window: `arc`s. var at_rows: std.ArrayList(hexdump.RowAt) = .empty; // Each with whether it is a saved rbp before the step and after it. var pointers: std.ArrayList(struct { hexdump.RowAt, [2]bool }) = .empty; var n: i64 = @as(i64, @intFromFloat(@floor(-slide))) - 1; while (n <= @as(i64, @intCast(slots)) - @as(i64, @intFromFloat(@floor(slide)))) : (n += 1) { const y = top + (@as(f32, @floatFromInt(n)) + slide) * m.row; if (y + m.row < body.y or y > box.h) continue; const addr = window[0] +% @as(u64, @bitCast(n * 8)); // Who points here: a pin in the lane, landing with its link. const names = pins(u, now, is, was, addr, travel); var marks: rows.Marks = .{ .lead = lead, .first = now.writtenWatched(addr, 8, .memory, 0, watched_from, watched_to) }; if (watched_from == 0 and watched_to > 0 and now.wasRead(addr, 8) and now.writeAge(addr, 8) != 0) { marks.read = 0; marks.read_shows = now.reading(.memory, 0); } const below_rsp: i64 = @bitCast(addr -% if (held) rsp_shown else is.rsp); map.row(.stack, addr, u, .{ .x = 0, .y = y, .w = box.w, .h = m.row }); // `free`: above rsp, not yet reached: its address at 60%, its word faint. // A free word rsp reaches (a push, `sub rsp`) becomes a slot as memory strikes (12 f), never in a frame. const free_was = held and addr < was.rsp; const free_is = held and addr < is.rsp; const slot_shows: f32 = if (free_was == free_is or now.resting()) @as(f32, if (free_is) 0 else 1) else if (free_is) 1 - recast else recast; if (slot_shows < 1) rows.free(v.faded(1 - slot_shows), y, memory, addr, below_rsp, lead); if (slot_shows <= 0) continue; const vs = v.faded(slot_shows); // A frame's name beside this row: the chain ends a character before it. var room_w = map.content(box.w); for (spans[0..n_spans]) |sp| { const mid = (sp.y0 + sp.y1) / 2; if (mid + m.row / 2 > y and mid - m.row / 2 < y + m.row) room_w = @min(room_w, rows.spanNameX(u, map.content(box.w), sp.name) - ui.advance(theme.size.mono.context) + theme.metric.slot.room); } var gap: f32 = 0; if (lone) |name| { const going = goes(now, was, is, name); const share: f32 = if (was.named(name) == addr) 1 - going else if (is.named(name) == addr) going else 0; gap = share * (u.width(.mono, size, name) + ui.advance(size)); } const gapped = gap > 0 and names.names.len > 0 and names.shows > 0; if (gapped) pinGap(vs.faded(names.shows), y, names.names, lone.?, gap); const k_role = (addr -% roles_from) / 8; var role_at: [2]@TypeOf(roleName(u, .none, 0)) = undefined; for (&role_at, roles, [2]Recording.Moment{ now.before(), now.moment() }) |*r, of, mem| { const what: zt.telescope.Role = if (k_role < of.len) of[k_role].role else .none; r.* = roleName(u, what, (Recording.word(mem, addr, 8) catch null) orelse 1); } const what: zt.telescope.Role = if (k_role < roles[1].len) roles[1][k_role].role else .none; const role = role_at[1]; const role_was: rows.Role = .{ .name = role_at[0].name, .local = role_at[0].local, .going = recast, .from_rsp = @bitCast(addr -% was.rsp) }; // At a run a word changes in place under an 8 f crossfade, as a register does. const ran = runFade(now, .memory); const word_was = Recording.word(now.before(), addr, 8) catch null; const word_is = Recording.word(now.moment(), addr, 8) catch null; const fades = ran < 1 and !std.meta.eql(word_was, word_is); if (fades) _ = rows.slot(vs.faded(1 - ran), y, room_w, now.before(), addr, below_rsp, &.{}, 0, marks, role.name, role.local, role_was); const hops = rows.slot(if (fades) vs.faded(ran) else vs, y, room_w, if (fades) now.moment() else now.shownAt(addr, 8), addr, below_rsp, if (gapped) &.{} else names.names, names.shows, marks, role.name, role.local, role_was); // An arc's ends are rows on show (the row above the window, there for a slide, is not). if (y + m.row > top + 1 and y < box.h - m.pad - 1) at_rows.append(u.f.scratch, .{ .addr = addr, .y = y }) catch {}; const what_was: zt.telescope.Role = if (k_role < roles[0].len) roles[0][k_role].role else .none; if (y + m.row > top + 1 and y < box.h - m.pad - 1) pointers.append(u.f.scratch, .{ .{ .addr = addr, .y = y }, .{ what_was == .saved and std.mem.eql(u8, what_was.saved, "rbp"), what == .saved and std.mem.eql(u8, what.saved, "rbp") } }) catch {}; // Only a row on show is a place a tie can land. if (y >= top - 1 and y + m.row <= box.h - m.pad + 1) { ties.anchor(u, .{ .word = addr }, .{ .x = theme.metric.slot.address, .y = y, .w = if (hops.n > 0) hops.x[0] + hops.w[0] - theme.metric.slot.address else 120, .h = m.row }); ties.anchor(u, .{ .slot_pin = addr }, .{ .x = theme.metric.slot.lane, .y = y, .w = theme.metric.slot.lane_end - theme.metric.slot.lane, .h = m.row }); } } if (k.part == .stack) map.window(.stack, .{ ways[0], ways[0] + 8 * (@as(u64, slots) -| 1) }, .{ ways[1], ways[1] + 8 * (@as(u64, slots) -| 1) }, p); // A frame's saved rbp is drawn by its span: its arc only in a step that touches it. var arcs: rows.Arcs = .{}; for (pointers.items) |p_| { const word, const saved_was = p_; const saved = saved_was[1]; const touched = now.writeAge(word.addr, 8) == 0 or now.wasRead(word.addr, 8); if (saved and saved_was[0] and !touched) continue; const before = arcs.n; hexdump.pointerArcs(&arcs, now, word.addr, word.y, at_rows.items, 8, .{ top - m.pad, box.h - m.pad }, false, false); if (arcs.n == before) continue; // Its step's alone: it goes with the advance (18 f), not in the next step's first frame. if (saved and touched) arcs.items[before].shows *= 1 - std.math.clamp((now.time - now.plan.advance) / time.read.out, 0, 1); // A word becoming a saved rbp, or no longer one, with the step: its arc goes or comes as its role does (12 f). if (!touched and saved != saved_was[0]) arcs.items[before].shows *= if (saved) 1 - recast else recast; } arcs.draw(v, theme.metric.arc.stack_lanes); // Where the window is, for a link to a word outside it. const lane_at = u.at.xf.apply(.{ theme.metric.slot.lane, top }); const row_px = u.at.xf.apply(.{ 0, top + m.row })[1] - lane_at[1]; if (!ui.mapping) ties.stack_window = .{ .first = window[0], .slots = slots, .x = lane_at[0], .top = lane_at[1], .row = row_px }; // The travelling tags: both of them at one word share a pin. var places: [2]f32 = undefined; for (travel, places[0..travel.len]) |name, *place| { const at_old = @as(f32, @floatFromInt(@as(i64, @bitCast((was.named(name) orelse 0) -% window[0])))) / 8 + slide; const at_new = @as(f32, @floatFromInt(@as(i64, @bitCast((is.named(name) orelse 0) -% window[0])))) / 8 + slide; place.* = std.math.lerp(at_old, at_new, goes(now, was, is, name)); } for (travel, places[0..travel.len], 0..) |name, place, i| { if (i == 1 and @abs(places[0] - place) < 0.05) continue; if (place < -0.5 or place > @as(f32, @floatFromInt(slots)) - 0.5) continue; const both = i == 0 and travel.len == 2 and @abs(places[1] - place) < 0.05; // Alone, from its place among the names it leaves to its place among those it joins. const x = if (lone != null) std.math.lerp(pinPlace(u, pins(u, now, is, was, was.named(name) orelse 0, travel).names, name), pinPlace(u, pins(u, now, is, was, is.named(name) orelse 0, travel).names, name), goes(now, was, is, name)) else theme.metric.slot.lane; u.pinRow(x, top + place * m.row, if (both) &.{ "rsp", "rbp" } else &.{name}, theme.color.region.stack); } for (spans[0..n_spans]) |sp| if (sp.was) |was_name| { rows.span(v.faded(1 - renamed), map.content(box.w), sp.y0, sp.y1, was_name, sp.newest, sp.open); rows.span(v.faded(renamed), map.content(box.w), sp.y0, sp.y1, sp.name, sp.newest, sp.open); } else rows.span(v, map.content(box.w), sp.y0, sp.y1, sp.name, sp.newest, sp.open); veiled(u, box, now.veil); if (k.part == .stack) map.strip(.stack, u, box); } /// A slot's role as the catalogue writes it: `saved rbx` (dim); a /// local's name (primary, `+8` a word into it); `argc`, `argv[0]`, /// `argv end`, `envp end`, `auxv` (dim). A return address needs none: /// its chain is code, named. `word`: what the slot holds (0 ends argv and envp). fn roleName(u: ui.Ui, role: zt.telescope.Role, word: u64) struct { name: []const u8, local: bool = false } { return switch (role) { .none, .return_address => .{ .name = "" }, .saved => |r| .{ .name = u.print("saved {s}", .{r}) }, .local => |l| .{ .name = if (l.offset > 0) u.print("{s}+{x}", .{ l.name, @as(u32, @intCast(l.offset)) }) else if (l.offset == -4 and l.size == 4) u.print("{s}, high half", .{l.name}) else if (l.offset < 0) u.print("{s}, from byte {d}", .{ l.name, -l.offset }) else l.name, .local = true }, .argc => .{ .name = "argc" }, .argv => |i| .{ .name = if (word == 0) "argv end" else u.print("argv[{d}]", .{i}) }, .envp => |i| .{ .name = if (word == 0) "envp end" else u.print("envp[{d}]", .{i}) }, .auxv => |i| .{ .name = if (i == 0) "auxv" else "" }, }; } /// Where `name` goes in a row pin of `others` and it, in the registers' order. fn pinPlace(u: ui.Ui, others: []const []const u8, name: []const u8) f32 { const size = theme.size.mono.context; var x: f32 = theme.metric.slot.lane; for (others) |o| if (index(o).? < index(name).?) { x += u.width(.mono, size, o) + ui.advance(size); }; return x; } /// A row pin of `names` with room `gap` wide where `name` goes in it. fn pinGap(u: ui.Ui, y: f32, names: []const []const u8, name: []const u8, gap: f32) void { const size = theme.size.mono.context; const p = theme.metric.pin; var x: f32 = theme.metric.slot.lane; var gapped = false; for (names) |o| { if (!gapped and index(o).? > index(name).?) { x += gap; gapped = true; } u.text(.mono_bold, size, x, theme.baseline(y, m.row, size), o, t.primary); x += u.width(.mono, size, o) + ui.advance(size); } if (!gapped) x += gap; const hx = x - ui.advance(size) + p.row_gap; const mid = y + m.row / 2; sk.draw.polygon(u.f, &.{ .{ hx + p.row_head[0], mid }, .{ hx, mid - p.row_head[1] / 2 }, .{ hx, mid + p.row_head[1] / 2 } }, u.at.pen(.{ .fill = ui.rgb(theme.color.region.stack) })); } /// Whether a window of `slots` going from word `a` to word `b` goes /// farther than its own height: it fades, and does not scroll. fn far(a: u64, b: u64, slots: usize) bool { return @abs(@as(i64, @bitCast(a -% b))) > 8 * @as(u64, slots); } /// The first step, from `age` steps ago back, in which the window faded /// to a new place (as many as the cursor remembers when none did). fn watched(now: cursors.Now, slots: usize, age: usize) usize { const rec = now.rec; for (age..now.stops.len - 1) |a| { // The index's registers: reading them from the trace was most of a frame's time. const to = rec.registers[@min(now.stops[a], rec.end())]; const from = rec.registers[@min(now.stops[a + 1], rec.end())]; if (far(windowAt(now, to, slots, a), windowAt(now, from, slots, a + 1), slots)) return a; } return now.stops.len; } /// The first word a window of `slots` shows, `skip` steps back: rsp, /// or within [rsp, rbp+16) (the frame, with its saved rbp and its way /// back) so that the word the newest of the last three steps wrote or /// read there is in the window's middle. fn windowAt(now: cursors.Now, regs: zt.Regs, slots: usize, skip: usize) u64 { const frame_end = regs.rbp +% 16; if (frame_end <= regs.rsp or frame_end - regs.rsp > 8 * 64) return regs.rsp; const words = (frame_end - regs.rsp) / 8; if (words <= slots) return regs.rsp; for (skip..skip + 3) |age| { if (age + 1 >= now.stops.len) break; for ([_][]const Recording.Span{ now.rec.written(now.stops[age + 1], now.stops[age]), now.rec.read(now.stops[age + 1], now.stops[age]) }) |spans| { var k = spans.len; while (k > 0) { k -= 1; const a = spans[k].addr; if (a < regs.rsp or a >= frame_end) continue; const word = (a - regs.rsp) / 8; const first = @min(word -| (slots - 1) / 2, words - slots); return regs.rsp + 8 * first; } } } return regs.rsp; } const Pins = struct { names: []const []const u8, shows: f32 }; /// The registers whose value is `addr`: before the step, and after it /// once their link has landed (`ties.pinShows`). fn pins(u: ui.Ui, now: cursors.Now, is: zt.Regs, was: zt.Regs, addr: u64, apart: []const []const u8) Pins { var out: std.ArrayList([]const u8) = .empty; var shows: f32 = 0; for (theme.metric.all_registers[0..16]) |name| { // Those drawn apart, travelling. if (for (apart) |a| { if (std.mem.eql(u8, a, name)) break true; } else false) continue; const i = index(name).?; const before = was.named(name) == addr; const after = is.named(name) == addr; if (!before and !after) continue; const s = ties.pinShows(now, i, .slot); const this = if (before and after) 1 else if (after) s.new else s.old; if (this < 0.5) continue; out.append(u.f.scratch, name) catch break; shows = @max(shows, this); } return .{ .names = out.items, .shows = shows }; } }; pub const Backtrace = struct { cursor: cursors.Cursor, stage: *const Stage, focus: bool = false, /// The `backtrace` lens: in the band, as its drawing. lens: bool = false, pub fn draw(b: *const Backtrace, f: *sk.Frame, placed: anim.Placed) void { const box = b.stage.box(placed, if (b.lens) .band else .backtrace); if (box.h < m.tag) return; const u = if (b.lens) at(f, placed, box).faded(placed.value(b.stage.drawing)) else at(f, placed, box); const now = b.cursor.now(placed); backtraceRows(u, now, b.cursor.rec, box, b.focus, ""); veiled(u, box, now.veil); } }; /// A backtrace's panel and rows in `u`'s `box` (the panel, a lens's /// drawing, the calls lens's view: its tag's note after `prefix`). /// A frame is its words on the stack: the chain changes with memory. The /// frames both chains have (the same way back, counted from the oldest) /// slide to their new depth, as rows making room; those that end fade out /// first, those that begin fade in after. What a kept row says that /// changes (its depth, its pc's offset, its line) crossfades over the 12 f /// before the advance, as a stack span's name does; the newest's wash goes /// from one row to the other the same way. Nothing changes in a frame. pub fn backtraceRows(u: ui.Ui, now: cursors.Now, rec: *const Recording, box: Rect, focus: bool, prefix: []const u8) void { var new_buf: [24]Frame = undefined; var old_buf: [24]Frame = undefined; const chains = [2][]Frame{ frames(rec, now.stops[1], &old_buf), frames(rec, now.stops[0], &new_buf) }; var shared: usize = 0; while (shared < @min(chains[0].len, chains[1].len) and chains[0][chains[0].len - 1 - shared].pc == chains[1][chains[1].len - 1 - shared].pc) shared += 1; // The newest frame's pc is the step's: it is the same frame whatever its offset. if (shared < @min(chains[0].len, chains[1].len) and chains[0].len == chains[1].len and shared + 1 == chains[0].len) shared += 1; const since = if (now.walking()) now.since(.memory, 0) else if (now.landed(.memory, 0)) std.math.inf(f32) else -std.math.inf(f32); const leave = std.math.clamp(since / time.quick, 0, 1); const slide = cursors.glide(std.math.clamp((since - time.quick / 2.0) / time.move, 0, 1)); const arrive = std.math.clamp((since - time.quick / 2.0 - time.move) / time.quick, 0, 1); const renamed = now.renaming(); const room = rowsOf(box); map.measure(.backtrace, @max(chains[0].len, chains[1].len)); const notes = [2][]const u8{ u.print("{s}{s}", .{ prefix, newestAtBottom(u, chains[0].len, room) }), u.print("{s}{s}", .{ prefix, newestAtBottom(u, chains[1].len, room) }) }; const renote = !std.mem.eql(u8, notes[0], notes[1]); const body = u.panel(box.w, box.h, "backtrace", .{ .focus = focus, .note = if (renote) "" else notes[1] }); if (renote) { u.faded(1 - slide).tagNote(box.w, notes[0]); u.faded(slide).tagNote(box.w, notes[1]); } clipBody(u, box); defer u.unclip(); const opens = [2][]const Recording.Call{ rec.stack(u.f.scratch, now.stops[1]), rec.stack(u.f.scratch, now.stops[0]) }; const top = body.y + m.pad; // Newest at the bottom, `#0` last: a frame's row is its place from // the oldest, less the oldest that do not fit (dropped from the top). const dropped = [2]usize{ chains[0].len -| room, chains[1].len -| room }; const Row = struct { depth: usize, name: []const u8, args: []const u8, where: []const u8 }; for (chains, 0..) |chain, side| { const shows = if (side == 0) 1 - leave else arrive; for (chain, 0..) |frame, i| { const from_end = chain.len - 1 - i; const kept = from_end < shared; // A frame both have is drawn once, from the old chain to its place in the new. if (kept and side == 1) continue; var at_row = @as(f32, @floatFromInt(from_end)) - @as(f32, @floatFromInt(dropped[side])); const here: Row = .{ .depth = i, .name = ui.symbol(u, rec.strings.get(frame.pc) orelse u.print("{x}", .{frame.pc})), .args = callArguments(u, rec, opens[side], i, frame.pc), .where = frameWhere(u, rec, now.marks[side], i, frame.pc) }; if (!kept) { if (shows <= 0 or at_row <= -1 or at_row >= @as(f32, @floatFromInt(room))) continue; rows.callRow(u.faded(shows), top + at_row * m.row, box.w, here.depth, here.name, here.args, here.where, here.depth == 0); continue; } const to = chains[1].len - 1 - from_end; const next = chains[1][to]; const there: Row = .{ .depth = to, .name = ui.symbol(u, rec.strings.get(next.pc) orelse u.print("{x}", .{next.pc})), .args = callArguments(u, rec, opens[1], to, next.pc), .where = frameWhere(u, rec, now.marks[1], to, next.pc) }; at_row = std.math.lerp(at_row, @as(f32, @floatFromInt(from_end)) - @as(f32, @floatFromInt(dropped[1])), slide); if (at_row <= -1 or at_row >= @as(f32, @floatFromInt(room))) continue; const y = top + at_row * m.row; // The wash where the row is the newest, going and coming with the words. const washed = @as(f32, if (here.depth == 0) 1 - renamed else 0) + @as(f32, if (there.depth == 0) renamed else 0); if (washed > 0) rows.callCurrent(u.faded(washed), y, box.w); const same = here.depth == there.depth and std.mem.eql(u8, here.name, there.name) and std.mem.eql(u8, here.args, there.args) and std.mem.eql(u8, here.where, there.where); if (same) { rows.callLabels(u, y, box.w, there.depth, there.name, there.args, there.where, there.depth == 0); } else { rows.callLabels(u.faded(1 - renamed), y, box.w, here.depth, here.name, here.args, here.where, here.depth == 0); rows.callLabels(u.faded(renamed), y, box.w, there.depth, there.name, there.args, there.where, there.depth == 0); } } } } /// A backtrace's tag note: `newest at the bottom`, and how many of the /// oldest a panel of `room` rows leaves out above. pub fn newestAtBottom(u: ui.Ui, total: usize, room: usize) []const u8 { return if (total > room) u.print("newest at the bottom \u{00b7} {d} more above", .{total - room}) else "newest at the bottom"; } test "the flags' bits" { try std.testing.expectEqual(@as(?usize, 17), index("eflags")); }