aarch64 2.0.1 → 2.1.0

data/lib/aarch64/parser.y

@@ -14,8 +14,8 @@ rule
     | adcs
     | ADD add_body { val[1].apply(@asm, val[0]) }
     | ADDS add_body { val[1].apply(@asm, val[0]) }
-    | ADR Xd COMMA imm { @asm.adr(val[1], val[3]) }
-    | ADRP Xd COMMA imm { @asm.adrp(val[1], val[3]) }
+    | ADR Xd COMMA imm_or_label { @asm.adr(val[1], val[3]) }
+    | ADRP Xd COMMA imm_or_label { @asm.adrp(val[1], val[3]) }
     | AND and_body { val[1].apply(@asm, val[0]) }
     | ANDS and_body { val[1].apply(@asm, val[0]) }
     | asr  { val[0].apply(@asm, :asr) }
@@ -30,8 +30,8 @@ rule
     | blr
     | br
     | BRK imm { @asm.brk(val[1]) }
-    | CBNZ reg_imm { val[1].apply(@asm, val[0]) }
-    | CBZ reg_imm { val[1].apply(@asm, val[0]) }
+    | CBNZ reg_imm_or_label { val[1].apply(@asm, val[0]) }
+    | CBZ reg_imm_or_label { val[1].apply(@asm, val[0]) }
     | cinc
     | cinv
     | clrex
@@ -133,8 +133,8 @@ rule
     | SXTW xd_wd { val[1].apply(@asm, :sxtw) }
     | sys
     | sysl
-    | TBZ reg_imm_imm { val[1].apply(@asm, val[0]) }
-    | TBNZ reg_imm_imm { val[1].apply(@asm, val[0]) }
+    | TBZ reg_imm_imm_or_label { val[1].apply(@asm, val[0]) }
+    | TBNZ reg_imm_imm_or_label { val[1].apply(@asm, val[0]) }
     | tlbi
     | tst
     | UBFIZ ubfiz_body { val[1].apply(@asm, val[0]) }
@@ -150,6 +150,7 @@ rule
     | WFE { @asm.wfe }
     | WFI { @asm.wfi }
     | YIELD { @asm.yield }
+    | LABEL_CREATE { register_label(val[0]) }
     ;
 
   adc
@@ -280,8 +281,8 @@ rule
   at: AT at_op COMMA Xd { @asm.at(val[1].to_sym, val[3]) };
 
   b
-    : B imm { @asm.b(val[1]) }
-    | B DOT cond imm { @asm.b(val[3], cond: val[2]) }
+    : B imm_or_label { @asm.b(val[1]) }
+    | B DOT cond imm_or_label { @asm.b(val[3], cond: val[2]) }
     ;
 
   bfi
@@ -313,7 +314,7 @@ rule
     | AUTDA Xd COMMA SP { @asm.autda(val[1], val[3]) }
     ;
 
-  bl : BL imm { @asm.bl(val[1]) } ;
+  bl : BL imm_or_label { @asm.bl(val[1]) } ;
   blr : BLR Xd { @asm.blr(val[1]) } ;
   br : BR Xd { @asm.br(val[1]) } ;
 
@@ -1048,11 +1049,11 @@ rule
       }
     ;
 
-  reg_imm_imm
-    : Xd COMMA imm COMMA imm {
+  reg_imm_imm_or_label
+    : Xd COMMA imm COMMA imm_or_label {
         result = ThreeArg.new(val[0], val[2], val[4])
       }
-    | Wd COMMA imm COMMA imm {
+    | Wd COMMA imm COMMA imm_or_label {
         result = ThreeArg.new(val[0], val[2], val[4])
       }
     ;
@@ -1194,6 +1195,11 @@ rule
     | Xd COMMA imm { result = TwoArg.new(val[0], val[2]) }
     ;
 
+  reg_imm_or_label
+    : Wd COMMA imm_or_label { result = TwoArg.new(val[0], val[2]) }
+    | Xd COMMA imm_or_label { result = TwoArg.new(val[0], val[2]) }
+    ;
+
   reg_reg_imm
     : Wd COMMA Wd COMMA imm {
         result = ThreeArg.new(val[0], val[2], val[4])
@@ -1232,6 +1238,11 @@ rule
     | NUMBER     { result = val[0] }
     ;
 
+  imm_or_label
+    : LABEL { result = label_for(val[0]) }
+    | imm
+    ;
+
   xt: Xd | XZR;
 
   cond : EQ | LO | LT | HS | GT | LE | NE | MI | GE | PL | LS | HI | VC | VS;

data/lib/aarch64/version.rb

@@ -1,3 +1,3 @@
 module AArch64
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/lib/aarch64.rb

@@ -10,6 +10,7 @@ module AArch64
       alias sp? sp
       alias zr? zr
       def integer?; false; end
+      def register?; true; end
     end
 
     class XRegister < Register
@@ -22,6 +23,7 @@ module AArch64
       def opc; 0b10; end
       def opc2; 0b11; end
       def opc3; 0b10; end
+      def name; "X#{to_i}"; end
     end
 
     class WRegister < Register
@@ -34,6 +36,7 @@ module AArch64
       def opc; 0b11; end
       def opc2; 0b10; end
       def opc3; 0b00; end
+      def name; "W#{to_i}"; end
     end
 
     31.times { |i|
@@ -285,6 +288,7 @@ module AArch64
     end
 
     def adrp xd, label
+      label = Immediate.new(label) if label.integer?
       a ADRP.new(xd, label)
     end
 
@@ -2715,14 +2719,26 @@ module AArch64
       if label.integer?
         label = wrap_offset_with_label label
       end
-      a TBNZ.new(rt, imm, label, rt.sf)
+
+      sf = 0
+      if imm > 31
+        sf = 1
+        imm -= 32
+      end
+      a TBNZ.new(rt, imm, label, sf)
     end
 
     def tbz rt, imm, label
       if label.integer?
         label = wrap_offset_with_label label
       end
-      a TBZ.new(rt, imm, label, rt.sf)
+
+      sf = 0
+      if imm > 31
+        sf = 1
+        imm -= 32
+      end
+      a TBZ.new(rt, imm, label, sf)
     end
 
     def tlbi tlbi_op, xt = XZR
@@ -2827,6 +2843,12 @@ module AArch64
       a YIELD.new
     end
 
+    ##
+    # Yields the offset in the instructions
+    def patch_location
+      yield @insns.length * 4
+    end
+
     def write_to io
       io.write to_binary
     end

data/test/base_instructions_test.rb

@@ -287,7 +287,7 @@ class BaseInstructionsTest < AArch64::Test
     end
 
     # SYS #<op1>, C7, <Cm>, #<op2>, <Xt>
-    assert_one_insn "sys #0, c7, c9, #0, x1" do |asm|
+    assert_bytes [0x1, 0x79, 0x8, 0xd5] do |asm|
       asm.at :s1e1rp, X1
     end
   end
@@ -326,17 +326,17 @@ class BaseInstructionsTest < AArch64::Test
       asm.autiza X1
     end
     # AUTIA1716
-    assert_one_insn "hint #0xc" do |asm|
+    assert_one_insn "autia1716" do |asm|
       asm.autia1716
     end
 
     # AUTIASP
-    assert_one_insn "hint #0x1d" do |asm|
+    assert_one_insn "autiasp" do |asm|
       asm.autiasp
     end
 
     # AUTIAZ
-    assert_one_insn "hint #0x1c" do |asm|
+    assert_one_insn "autiaz" do |asm|
       asm.autiaz
     end
   end
@@ -360,17 +360,17 @@ class BaseInstructionsTest < AArch64::Test
     end
 
     # AUTIB1716
-    assert_one_insn "hint #0xe" do |asm|
+    assert_one_insn "autib1716" do |asm|
       asm.autib1716
     end
 
     # AUTIBSP
-    assert_one_insn "hint #0x1f" do |asm|
+    assert_one_insn "autibsp" do |asm|
       asm.autibsp
     end
 
     # AUTIBZ
-    assert_one_insn "hint #0x1e" do |asm|
+    assert_one_insn "autibz" do |asm|
       asm.autibz
     end
   end
@@ -711,13 +711,14 @@ class BaseInstructionsTest < AArch64::Test
 
   def test_BRK
     # BRK  #<imm>
-    asm.brk 1
-    assert_one_insn "brk #0x1"
+    assert_bytes [0x20, 00, 0x20, 0xd4] do |asm|
+      asm.brk 0x1
+    end
   end
 
   def test_BTI
     # BTI  {<targets>}
-    assert_one_insn "hint #0x20" do |asm|
+    assert_one_insn "bti" do |asm|
       asm.bti :c
     end
   end
@@ -2774,6 +2775,12 @@ class BaseInstructionsTest < AArch64::Test
     end
   end
 
+  def test_ldb_x30
+    assert_bytes [0xfe,0x7b,0xc1,0xa8] do |asm|
+      asm.ldp  x30, x30, [sp], 16
+    end
+  end
+
   def test_LDP_gen
     # LDP  <Wt1>, <Wt2>, [<Xn|SP>], #<imm>
     # LDP  <Xt1>, <Xt2>, [<Xn|SP>], #<imm>
@@ -4649,22 +4656,21 @@ class BaseInstructionsTest < AArch64::Test
   end
 
   def test_MOVZ
-    asm.movz X0, 0x2a
-    assert_one_insn "movz x0, #0x2a"
-    # MOVZ
-    assert_bytes [0x02,0x00,0xa0,0x52] do |asm|
-      asm.movz     w2, 0, lsl(16)
+    assert_bytes [0x40, 0x5, 0x80, 0xd2] do |asm|
+      asm.movz X0, 0x2a
     end
   end
 
   def test_movz_shift
-    asm.movz X0, 0x2a, lsl: 16
-    assert_one_insn "movz x0, #0x2a, lsl #16"
+    assert_bytes [0x40, 0x5, 0xa0, 0xd2] do |asm|
+      asm.movz X0, 0x2a, lsl: 16
+    end
   end
 
   def test_movz_with_w
-    asm.movz W0, 0x2a
-    assert_one_insn "movz w0, #0x2a"
+    assert_bytes [0x40, 0x5, 0x80, 82] do |asm|
+      asm.movz W0, 0x2a
+    end
   end
 
   def test_MRS
@@ -8866,6 +8872,18 @@ class BaseInstructionsTest < AArch64::Test
       asm.tbnz w3, 5, label
       asm.put_label label
     end
+
+    assert_one_insn "tbnz x0, #0x20, #4" do |asm|
+      label = asm.make_label :foo
+      asm.tbnz x0, 32, label
+      asm.put_label label
+    end
+
+    assert_one_insn "tbnz w0, #0, #4" do |asm|
+      label = asm.make_label :foo
+      asm.tbnz x0, 0, label
+      asm.put_label label
+    end
   end
 
   def test_TBZ
@@ -8878,6 +8896,12 @@ class BaseInstructionsTest < AArch64::Test
       asm.tbz w3, 5, label
       asm.put_label label
     end
+
+    assert_one_insn "tbz x0, #0x20, #4" do |asm|
+      label = asm.make_label :foo
+      asm.tbz x0, 32, label
+      asm.put_label label
+    end
   end
 
   def test_TLBI_SYS

data/test/dsl_test.rb

@@ -1,6 +1,20 @@
 require "helper"
 
 class DSLTest < AArch64::Test
+  def test_patch_location
+    asm = AArch64::Assembler.new
+    found = nil
+    asm.pretty do
+      asm.mov x0, x1
+      asm.patch_location { |loc| found = loc }
+      asm.movz x2, 5
+    end
+
+    bytes = asm.to_binary
+    assert_equal 8, bytes.bytesize
+    assert_equal 4, found
+  end
+
   def test_dsl_has_methods
     assert_bytes [0x9f,0x08,0x25,0xab] do |asm|
       asm.pretty do

data/test/parser_test.rb

@@ -2,12 +2,20 @@ require "helper"
 require "aarch64/parser"
 
 class ParserTest < AArch64::Test
+
+  def test_parse_error
+    error = assert_raises(Racc::ParseError) do
+      parse "mov x1, x0\nmov x1, #2 // comments not supported"
+    end
+    assert_equal 'parse error on value "/" (error) on line 2 at pos 23/48', error.message
+  end
+
   def test_parse
-    assert_round_trip "movz x0, 0xCAFE", output: ["movz x0, #0xcafe"]
-    assert_round_trip "movz x0, #0xcafe"
-    assert_round_trip "movz x0, #0xcafe, lsl #16"
-    assert_round_trip "movz w0, #0xcafe"
-    assert_round_trip "movz w0, #0xcafe, lsl #16"
+    assert_bytes "movz x0, 0xCAFE", [0xc0, 0x5f, 0x99, 0xd2]
+    assert_bytes "movz x0, #0xcafe", [0xc0, 0x5f, 0x99, 0xd2]
+    assert_bytes "movz x0, #0xcafe, lsl #16", [0xc0, 0x5f, 0xb9, 0xd2]
+    assert_bytes "movz w0, #0xcafe", [0xc0, 0x5f, 0x99, 0x52]
+    assert_bytes "movz w0, #0xcafe, lsl #16", [0xc0, 0x5f, 0xb9, 0x52]
   end
 
   def test_autda
@@ -16,16 +24,20 @@ class ParserTest < AArch64::Test
     assert_bytes "autda x1, x2", [0x41, 0x18, 0xc1, 0xda]
   end
 
-  def assert_bytes input, bytes
+  def parse input
     parser = AArch64::Parser.new
     begin
       asm = parser.parse input
     rescue Racc::ParseError
-      puts input
       raise
     end
     io = StringIO.new
     asm.write_to io
+    io
+  end
+
+  def assert_bytes input, bytes
+    io = parse input
     assert_equal bytes, io.string.bytes, ->() {
       pos          = 32.times.map { |i| (i % 0x10).to_s(16) }.join.reverse
       actual_bin   = sprintf("%032b", io.string.unpack1("L<"))
@@ -42,10 +54,7 @@ class ParserTest < AArch64::Test
   end
 
   def assert_round_trip input, output: [input]
-    parser = AArch64::Parser.new
-    asm = parser.parse input
-    io = StringIO.new
-    asm.write_to io
+    io = parse input
     assert_equal output, disasm(io.string).map { |x|
       "#{x.mnemonic} #{x.op_str}"
     }
@@ -58,6 +67,85 @@ class ParserTest < AArch64::Test
     assert_bytes "add x8, x10, #1", [0x48, 0x5, 00, 0x91]
   end
 
+  def test_labels_already_defined
+    error = assert_raises(RuntimeError) do
+      parse "start:\nstart:\n"
+    end
+    assert_equal "symbol 'start' is already defined", error.message
+  end
+
+  def test_labels_empty
+    assert_bytes "start:\n", []
+    assert_bytes <<~ASM, []
+      start:
+      end:
+    ASM
+  end
+
+  def test_labels_not_defined
+    examples = [
+      "b label",
+      "b.eq label",
+      "b.lo label",
+      "b.lt label",
+      "b.hs label",
+      "b.gt label",
+      "b.le label",
+      "b.ne label",
+      "b.mi label",
+      "b.ge label",
+      "b.pl label",
+      "b.ls label",
+      "b.hi label",
+      "b.vc label",
+      "b.vs label",
+      "cbz x0, label",
+      "cbz w0, label",
+      "cbnz w0, label",
+      "cbnz x0, label",
+      "tbz w1, #1, label",
+      "tbz x1, #1, label",
+      "tbnz w1, #1, label",
+      "tbnz x1, #1, label",
+      "bl label",
+    ]
+    examples.each do |instruction|
+      error = assert_raises(RuntimeError) do
+        parse instruction
+      end
+      assert_match 'Label "label" not defined', error.message
+    end
+  end
+
+  def test_labels_branch
+    assert_bytes <<~ASM, [0x00, 0x04, 0x00, 0x91, 0xff, 0xff, 0xff, 0x17]
+      loop:
+        add x0, x0, #1
+        b loop
+    ASM
+    assert_bytes <<~ASM, [0x20, 0x00, 0x80, 0xd2, 0xe0, 0xff, 0xff, 0x10]
+      label:
+        mov x0, #1
+        adr x0, label
+    ASM
+  end
+
+  def test_labels_forward_reference
+    assert_bytes "b label\nlabel:", [0x01, 0x00, 0x00, 0x14]
+    assert_bytes "b.eq label\nlabel:", [0x20, 0x00, 0x00, 0x54]
+    assert_bytes "cbz w1, label\nlabel:", [0x21, 0x00, 0x00, 0x34]
+    assert_bytes "cbz x1, label\nlabel:", [0x21, 0x00, 0x00, 0xb4]
+    assert_bytes "cbnz w1, label\nlabel:", [0x21, 0x00, 0x00, 0x35]
+    assert_bytes "cbnz x1, label\nlabel:", [0x21, 0x00, 0x00, 0xb5]
+    assert_bytes "tbz w1, #1, label\nlabel:", [0x21, 0x00, 0x08, 0x36]
+    assert_bytes "tbz x1, #1, label\nlabel:", [0x21, 0x00, 0x08, 0x36]
+    assert_bytes "tbnz w1, #1, label\nlabel:", [0x21, 0x00, 0x08, 0x37]
+    assert_bytes "tbnz x1, #1, label\nlabel:", [0x21, 0x00, 0x08, 0x37]
+    assert_bytes "bl label\nlabel:", [0x01, 0x00, 0x00, 0x94]
+    assert_bytes "adr x0, label\nlabel:", [0x20, 0x00, 0x00, 0x10]
+    assert_bytes "adrp x0, label\nlabel:", [0x00, 0x00, 0x00, 0x90]
+  end
+
   def test_bls
     assert_bytes "b.ls #0x10", [0x89, 0x00, 0000, 0x54]
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: aarch64
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Aaron Patterson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2024-04-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: racc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: hatstone
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: racc
+  name: odinflex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.0'
 description: Tired of writing Ruby in Ruby? Now you can write ARM64 assembly in Ruby!
 email: tenderlove@ruby-lang.org
 executables: []
@@ -380,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.0.dev
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Write ARM64 assembly in Ruby!