improve bytecode printing w/ padding and AST locations

Summary:
In developing D73038348, it was helpful to have the annotated source locations displayed in the bytecode dumps.

This also computes the maximum length used to display an `IP` value, and padds all such values so that all of the `:` for a particular loop depth are aligned.

Reviewed By: cjhopman

Differential Revision: D73038341

fbshipit-source-id: 914e044a014fb19859f5c1817d94a1a57b2dca38

Author: Jeremy Braun

starlark/src/eval/bc/instrs.rs

@@ -218,6 +218,12 @@ impl BcInstrs {
 
     pub(crate) fn fmt_impl(&self, f: &mut dyn Write, newline: bool) -> fmt::Result {
         let end_arg = self.end_arg();
+        let ip_pad = if newline {
+            let max_ip = self.iter().map(|(_, ip)| ip).max().unwrap_or(BcAddr(0));
+            format!("{}", (max_ip).0).len()
+        } else {
+            0
+        };
 
         let mut loop_ends = Vec::new();
         let mut jump_targets = HashSet::new();
@@ -227,13 +233,21 @@ impl BcInstrs {
             });
         }
         for (ptr, ip) in self.iter() {
-            if ptr != self.start_ptr() && !newline {
-                write!(f, "; ")?;
-            }
-
             if loop_ends.last() == Some(&ip) {
                 loop_ends.pop().unwrap();
             }
+            let loop_pad = loop_ends.len() * 2;
+
+            if newline {
+                if let Some(loc) = self.stmt_locs.stmt_at(ip) {
+                    writeln!(f, "{:loop_pad$} {:ip_pad$}  # {}", "", "", loc.span.span)?;
+                }
+            } else {
+                if ptr != self.start_ptr() {
+                    write!(f, "; ")?;
+                }
+            }
+
             let opcode = ptr.get_opcode();
             if !jump_targets.is_empty() {
                 if jump_targets.contains(&ip) {
@@ -243,11 +257,9 @@ impl BcInstrs {
                 }
             }
             if newline {
-                for _ in &loop_ends {
-                    write!(f, "  ")?;
-                }
+                write!(f, "{:loop_pad$}", "")?;
             }
-            write!(f, "{}: {:?}", ip.0, opcode)?;
+            write!(f, "{:ip_pad$}: {:?}", ip.0, opcode)?;
             if opcode != BcOpcode::End {
                 // `End` args are too verbose and not really instruction args.
                 opcode.fmt_append_arg(ptr, ip, end_arg, f)?;
@@ -402,7 +414,7 @@ mod tests {
                 bc.to_string()
             );
             assert_eq!(
-                "0: Const True ->&abc\n24: Return &abc\n32: End\n",
+                " 0: Const True ->&abc\n24: Return &abc\n32: End\n",
                 bc.dump_debug()
             );
         } else if mem::size_of::<usize>() == 4 {

starlark/src/tests/bc/golden/and_or_false_and_x.golden

@@ -10,5 +10,6 @@ def test(x): return False and x
 
 Max stack size: 0
 Instructions:
-  0: ReturnConst False
+       # instrs.star.bzl:1:14-32
+   0: ReturnConst False
   16: End

starlark/src/tests/bc/golden/and_or_false_or_x.golden

@@ -10,5 +10,6 @@ def test(x): return False or x
 
 Max stack size: 0
 Instructions:
+      # instrs.star.bzl:1:14-31
   0: Return &x
   8: End

starlark/src/tests/bc/golden/and_or_true_and_x.golden

@@ -10,5 +10,6 @@ def test(x): return True and x
 
 Max stack size: 0
 Instructions:
+      # instrs.star.bzl:1:14-31
   0: Return &x
   8: End

starlark/src/tests/bc/golden/and_or_true_or_x.golden

@@ -10,5 +10,6 @@ def test(x): return True or x
 
 Max stack size: 0
 Instructions:
-  0: ReturnConst True
+       # instrs.star.bzl:1:14-30
+   0: ReturnConst True
   16: End

starlark/src/tests/bc/golden/and_or_x_and_false.golden

@@ -10,7 +10,8 @@ def test(x): return x and False
 
 Max stack size: 1
 Instructions:
-   0: IfNotBr &x 48
+       # instrs.star.bzl:1:14-32
+    0: IfNotBr &x 48
    16: Const False ->&1
    40: Br 64
   >48: Mov &x ->&1

starlark/src/tests/bc/golden/and_or_x_and_true.golden

@@ -10,7 +10,8 @@ def test(x): return x and True
 
 Max stack size: 1
 Instructions:
-   0: IfNotBr &x 48
+       # instrs.star.bzl:1:14-31
+    0: IfNotBr &x 48
    16: Const True ->&1
    40: Br 64
   >48: Mov &x ->&1

starlark/src/tests/bc/golden/and_or_x_or_false.golden

@@ -10,7 +10,8 @@ def test(x): return x or False
 
 Max stack size: 1
 Instructions:
-   0: IfNotBr &x 40
+       # instrs.star.bzl:1:14-31
+    0: IfNotBr &x 40
    16: Mov &x ->&1
    32: Br 64
   >40: Const False ->&1

starlark/src/tests/bc/golden/and_or_x_or_true.golden

@@ -10,7 +10,8 @@ def test(x): return x or True
 
 Max stack size: 1
 Instructions:
-   0: IfNotBr &x 40
+       # instrs.star.bzl:1:14-30
+    0: IfNotBr &x 40
    16: Mov &x ->&1
    32: Br 64
   >40: Const True ->&1

starlark/src/tests/bc/golden/call.golden

@@ -19,11 +19,12 @@ def test(a, k):
 
 Max stack size: 6
 Instructions:
-  0: Const 10 ->&3
-  24: Const 20 ->&4
-  48: Const 30 ->&5
-  72: Const 40 ->&6
-  96: Const 50 ->&7
+        # instrs.star.bzl:2:5-10:6
+    0: Const 10 ->&3
+   24: Const 20 ->&4
+   48: Const 30 ->&5
+   72: Const 40 ->&6
+   96: Const 50 ->&7
   120: CallFrozenNative noop {&3..&8 2 p q r *&0 **&1} instrs.star.bzl:2:5-10:6 ->&2
   208: ReturnConst None
   224: End

starlark/src/tests/bc/golden/compr_if_true_clause.golden

@@ -10,8 +10,9 @@ def test(y): return [x for x in y if True]
 
 Max stack size: 3
 Instructions:
-   0: ListNew ->&3
-   8: Iter &y 0 ->&4 ->&x 72
+       # instrs.star.bzl:1:14-43
+    0: ListNew ->&3
+    8: Iter &y 0 ->&4 ->&x 72
   >  32: ComprListAppend &3 &x
      48: Continue &4 0 ->&x 32 72
   >72: Mov &3 ->&2

starlark/src/tests/bc/golden/compr_if_true_clause_on_freeze.golden

@@ -12,8 +12,9 @@ C = True
 
 Max stack size: 3
 Instructions:
-   0: ListNew ->&3
-   8: Iter &y 0 ->&4 ->&x 72
+       # instrs.star.bzl:1:14-40
+    0: ListNew ->&3
+    8: Iter &y 0 ->&4 ->&x 72
   >  32: ComprListAppend &3 &x
      48: Continue &4 0 ->&x 32 72
   >72: Mov &3 ->&2

starlark/src/tests/bc/golden/compr_no_loop_if_top_collection_is_empty.golden

@@ -10,6 +10,7 @@ def test(): return [x for x in []]
 
 Max stack size: 1
 Instructions:
-  0: ListNew ->&1
-  8: Return &1
+       # instrs.star.bzl:1:13-35
+   0: ListNew ->&1
+   8: Return &1
   16: End

starlark/src/tests/bc/golden/compr_no_loop_if_top_collection_is_empty_on_freeze.golden

@@ -11,6 +11,7 @@ D = {}
 
 Max stack size: 1
 Instructions:
-  0: ListNew ->&1
-  8: Return &1
+       # instrs.star.bzl:1:13-34
+   0: ListNew ->&1
+   8: Return &1
   16: End

starlark/src/tests/bc/golden/constant_folding_list_add.golden

@@ -10,6 +10,7 @@ def test(): return [1] + [2]
 
 Max stack size: 1
 Instructions:
-  0: ListOfConsts [1, 2] ->&0
+       # instrs.star.bzl:1:13-29
+   0: ListOfConsts [1, 2] ->&0
   32: Return &0
   40: End

starlark/src/tests/bc/golden/def_inline_const_args_inlined.golden

@@ -15,8 +15,9 @@ def test():
 
 Max stack size: 3
 Instructions:
-  0: Const True ->&1
-  24: Const 10 ->&2
-  48: CallFrozenNativePos noop &1..&3 instrs.star.bzl:2:12-22 ->&0
+        # instrs.star.bzl:6:5-25
+    0: Const True ->&1
+   24: Const 10 ->&2
+   48: CallFrozenNativePos noop &1..&3 instrs.star.bzl:2:12-22 ->&0
   104: Return &0
   112: End

starlark/src/tests/bc/golden/def_inline_const_inlined.golden

@@ -14,5 +14,6 @@ def test():
 
 Max stack size: 0
 Instructions:
-  0: ReturnConst 10
+       # instrs.star.bzl:5:5-21
+   0: ReturnConst 10
   16: End

starlark/src/tests/bc/golden/def_inline_dict_inlined.golden

@@ -15,8 +15,9 @@ def test():
 
 Max stack size: 3
 Instructions:
-  0: ListNew ->&1
-  8: Const 10 ->&2
+       # instrs.star.bzl:6:5-26
+   0: ListNew ->&1
+   8: Const 10 ->&2
   32: DictNPop [&1, &2] ->&0
   48: Return &0
   56: End

starlark/src/tests/bc/golden/def_inline_list_inlined.golden

@@ -15,6 +15,7 @@ def returns_list():
 
 Max stack size: 1
 Instructions:
-  0: ListOfConsts [10, True] ->&0
+       # instrs.star.bzl:2:5-26
+   0: ListOfConsts [10, True] ->&0
   32: Return &0
   40: End

starlark/src/tests/bc/golden/def_inline_locals_inlined.golden

@@ -15,6 +15,7 @@ def test(x, y):
 
 Max stack size: 1
 Instructions:
-  0: CallFrozenNativePos noop &0..&2 instrs.star.bzl:2:12-22 ->&2
+       # instrs.star.bzl:6:5-21
+   0: CallFrozenNativePos noop &0..&2 instrs.star.bzl:2:12-22 ->&2
   56: Return &2
   64: End

starlark/src/tests/bc/golden/def_inline_return_type_inlined.golden

@@ -15,6 +15,7 @@ def test():
 
 Max stack size: 1
 Instructions:
-  0: CallFrozenDefPos instrs.star.bzl.smth &0..&0 instrs.star.bzl:6:12-18 ->&0
+       # instrs.star.bzl:6:5-18
+   0: CallFrozenDefPos instrs.star.bzl.smth &0..&0 instrs.star.bzl:6:12-18 ->&0
   40: Return &0
   48: End

starlark/src/tests/bc/golden/definitely_assigned_mov_is_used.golden

@@ -10,8 +10,9 @@ def test(x, y): noop(y, x)
 
 Max stack size: 3
 Instructions:
-  0: Mov &y ->&3
-  16: Mov &x ->&4
-  32: CallFrozenNativePos noop &3..&5 instrs.star.bzl:1:17-27 ->&2
-  88: ReturnConst None
+        # instrs.star.bzl:1:17-27
+    0: Mov &y ->&3
+   16: Mov &x ->&4
+   32: CallFrozenNativePos noop &3..&5 instrs.star.bzl:1:17-27 ->&2
+   88: ReturnConst None
   104: End

starlark/src/tests/bc/golden/definitely_assigned_no_op_movs.golden

@@ -10,5 +10,6 @@ def test(x): x = x
 
 Max stack size: 0
 Instructions:
-  0: ReturnConst None
+       # instrs.star.bzl:1:14-19
+   0: ReturnConst None
   16: End

starlark/src/tests/bc/golden/definitely_assigned_slot_range_in_call.golden

@@ -10,6 +10,7 @@ def test(x, y): noop(x, y)
 
 Max stack size: 1
 Instructions:
-  0: CallFrozenNativePos noop &0..&2 instrs.star.bzl:1:17-27 ->&2
+       # instrs.star.bzl:1:17-27
+   0: CallFrozenNativePos noop &0..&2 instrs.star.bzl:1:17-27 ->&2
   56: ReturnConst None
   72: End

starlark/src/tests/bc/golden/definitely_assigned_slot_range_in_list.golden

@@ -10,6 +10,7 @@ def test(x, y): return [x, y]
 
 Max stack size: 1
 Instructions:
-  0: ListNPop [&x, &y] ->&2
+       # instrs.star.bzl:1:17-30
+   0: ListNPop [&x, &y] ->&2
   16: Return &2
   24: End

starlark/src/tests/bc/golden/eq_bool.golden

@@ -11,6 +11,7 @@ def test(x):
 
 Max stack size: 1
 Instructions:
-  0: EqPtr &x True ->&1
+       # instrs.star.bzl:2:5-21
+   0: EqPtr &x True ->&1
   24: Return &1
   32: End

starlark/src/tests/bc/golden/eq_const.golden

@@ -13,6 +13,7 @@ def test(x):
 
 Max stack size: 1
 Instructions:
-  0: EqConst &x struct(a=2) ->&1
+       # instrs.star.bzl:4:5-18
+   0: EqConst &x struct(a=2) ->&1
   24: Return &1
   32: End

starlark/src/tests/bc/golden/eq_enum.golden

@@ -13,6 +13,7 @@ def test(x):
 
 Max stack size: 1
 Instructions:
-  0: EqPtr &x Color("RED") ->&1
+       # instrs.star.bzl:4:5-29
+   0: EqPtr &x Color("RED") ->&1
   24: Return &1
   32: End

starlark/src/tests/bc/golden/eq_int.golden

@@ -11,6 +11,7 @@ def test(x):
 
 Max stack size: 1
 Instructions:
-  0: EqInt &x 10 ->&1
+       # instrs.star.bzl:2:5-19
+   0: EqInt &x 10 ->&1
   24: Return &1
   32: End

starlark/src/tests/bc/golden/eq_short_str.golden

@@ -11,6 +11,7 @@ def test(x):
 
 Max stack size: 1
 Instructions:
-  0: EqPtr &x "a" ->&1
+       # instrs.star.bzl:2:5-20
+   0: EqPtr &x "a" ->&1
   24: Return &1
   32: End

starlark/src/tests/bc/golden/eq_str.golden

@@ -11,6 +11,7 @@ def test(x):
 
 Max stack size: 1
 Instructions:
-  0: EqStr &x "hello" ->&1
+       # instrs.star.bzl:2:5-24
+   0: EqStr &x "hello" ->&1
   24: Return &1
   32: End

starlark/src/tests/bc/golden/expr_call_maybe_known_method.golden

@@ -10,7 +10,8 @@ def test(x): x.append(1)
 
 Max stack size: 2
 Instructions:
-  0: Const 1 ->&2
-  24: CallMaybeKnownMethodPos &x append <m> &2..&3 instrs.star.bzl:1:14-25 ->&1
+        # instrs.star.bzl:1:14-25
+    0: Const 1 ->&2
+   24: CallMaybeKnownMethodPos &x append <m> &2..&3 instrs.star.bzl:1:14-25 ->&1
   120: ReturnConst None
   136: End

starlark/src/tests/bc/golden/expr_format_one.golden

@@ -10,6 +10,7 @@ def test(x): return '(({}))'.format(x)
 
 Max stack size: 1
 Instructions:
-  0: FormatOne "((" &x "))" ->&1
+       # instrs.star.bzl:1:14-39
+   0: FormatOne "((" &x "))" ->&1
   32: Return &1
   40: End

starlark/src/tests/bc/golden/expr_fstring.golden

@@ -10,6 +10,7 @@ def test(x): return f'test: {x}'
 
 Max stack size: 1
 Instructions:
-  0: FormatOne "test: " &x "" ->&1
+       # instrs.star.bzl:1:14-33
+   0: FormatOne "test: " &x "" ->&1
   32: Return &1
   40: End

starlark/src/tests/bc/golden/expr_percent_s_one.golden

@@ -10,6 +10,7 @@ def test(x): return '((%s))' % x
 
 Max stack size: 1
 Instructions:
-  0: PercentSOne "((" &x "))" ->&1
+       # instrs.star.bzl:1:14-33
+   0: PercentSOne "((" &x "))" ->&1
   32: Return &1
   40: End