aarch64 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4148547f29912a9cea29d06ba88ebafff8ffd701b187ab9aa3a0b4ee1d309b0
-  data.tar.gz: dc7b08ee7be2e57acfb2d5181d374a9baf6806be65dee0318cd95417349a2cfc
+  metadata.gz: ea2cf209e63aaf787b7a0a05f5d1788c3bfa36f1cee6fa1a812a99e2de5e42eb
+  data.tar.gz: 8d60abcae40ed475e8f3756892f432a88e99501e23f5df2d113e02b64042290f
 SHA512:
-  metadata.gz: f215a62f40c5ad36e81ec7d1d1110e21639ab0b19950283f4b5dbde46e5b26c17081a527d41dca600c4a8e8aa07eb0fc5f1f21a68d4425084c5eaf94de8baaef
-  data.tar.gz: 4d0027eeb4a45b5d77e409b2fc343d59ec19548b4874f1c2e61bfeabcecb991ee2527a0969133f1029aa13e2623361bef3e6637ed65f9617001f5709ab31b99a
+  metadata.gz: 44a6660bab9ee5db6f80b4714e8fc53d64f351f1ba2c9b2293826d83215423944fd8a2b444ea4cded815b09ed70f2bef289eb25ef5ff596dc781ceeb781a4643
+  data.tar.gz: b6e384d4d8743cd74a4324fb7e2e50f1f3317446a8d0ff2518ccecabed09634f8c0126e8831af21e5d57284254e3c9d5f83e578f924bc2e2d84b0f05b6e3ac4a

data/README.md

@@ -70,6 +70,32 @@ asm.movk X0, 0xF00D, lsl: 16
 asm.ret
 ```
 
+Here is another example of the same assembly, but using the built-in ARM64
+assembly parser:
+
+```ruby
+require "jit_buffer"
+require "aarch64/parser"
+
+parser = AArch64::Parser.new
+asm = parser.parse <<~eoasm
+  movz x0, 0xCAFE
+  movk x0, 0xF00D, lsl #16
+  ret
+eoasm
+
+# create a JIT buffer
+jit_buffer = JITBuffer.new 4096
+
+# Write the instructions to a JIT buffer
+jit_buffer.writeable!
+asm.write_to jit_buffer
+jit_buffer.executable!
+
+# Execute the JIT buffer
+p jit_buffer.to_function([], -Fiddle::TYPE_INT).call.to_s(16) # => f00dcafe
+```
+
 ## Hacking / Contributing
 
 Hacking on this gem should be similar to most.  Just do:

data/Rakefile

@@ -162,7 +162,7 @@ end
 
 rule ".tab.rb" => [".y"] do |t|
   puts "#" * 90
-  sh "gel exec racc -E -v #{t.source}"
+  sh "gel exec racc -v #{t.source}"
   puts "#" * 90
 end
 
@@ -205,3 +205,43 @@ task "autotest" do
     end
   end
 end
+
+# Make a test from the assembly in stdin.
+#   $ echo "brk #0x1" | rake make_test
+#     assert_bytes [0x20, 00, 0x20, 0xd4] do |asm|
+#       asm.brk #0x1
+#     end
+task :make_test do
+  require "odinflex/mach-o"
+  require "tempfile"
+
+  begin
+    asm = $stdin.read
+    bin = Tempfile.new("bin")
+    source = Tempfile.new("asm")
+    source.puts ".global _start"
+    source.puts ".align 2"
+    source.puts "_start:"
+    source.puts
+    source.write asm
+    source.flush
+    system("as -o #{bin.path} #{source.path}")
+
+    my_macho = OdinFlex::MachO.new bin
+    my_macho.each do |section|
+      if section.section? && section.sectname == "__text"
+        bin.seek(section.offset, IO::SEEK_SET)
+        (section.size / 4).times do
+          bytes = bin.read(4).unpack("C4").map { |x| sprintf("%#02x", x) }.join(", ")
+          puts "assert_bytes [#{bytes}] do |asm|"
+          puts "  asm.#{asm}"
+          puts "end"
+        end
+        #p section.start_pos
+      end
+    end
+  ensure
+    bin.unlink
+    source.unlink
+  end
+end

data/aarch64.gemspec

@@ -14,9 +14,10 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/tenderlove/aarch64"
   s.license     = "Apache-2.0"
 
+  s.add_runtime_dependency 'racc', '~> 1.6'
   s.add_development_dependency 'hatstone', '~> 1.0.0'
   s.add_development_dependency 'jit_buffer', '~> 1.0.0'
   s.add_development_dependency 'minitest', '~> 5.15'
   s.add_development_dependency 'rake', '~> 13.0'
-  s.add_development_dependency 'racc', '~> 1.6'
+  s.add_development_dependency 'odinflex', '~> 1.0'
 end

data/lib/aarch64/instructions/adrp.rb

@@ -10,7 +10,7 @@ module AArch64
       end
 
       def encode _
-        label = @label / 4096
+        label = unwrap_label(@label, 0) / 4096
         ADRP(label & 0x3, check_mask(label >> 2, 0x7ffff), @xd)
       end
 

data/lib/aarch64/parser.rb

@@ -152,9 +152,20 @@ module AArch64
 
     def parse str
       str += "\n" unless str.end_with?("\n")
-      @scan = StringScanner.new str
-      @asm  = AArch64::Assembler.new
-      do_parse
+      parse_states = [
+        # First pass: Label parsing
+        :first_pass,
+        # Second pass: Code generation
+        :second_pass
+      ]
+      @labels = {}
+      parse_states.each do |state|
+        @scan = StringScanner.new str
+        @asm  = AArch64::Assembler.new
+        @state = state
+        do_parse
+      end
+
       @asm
     end
 
@@ -166,12 +177,394 @@ module AArch64
     SYS_REG_MAP = Hash[AArch64::SystemRegisters.constants.map { |k|
       [k.to_s.downcase, AArch64::SystemRegisters.const_get(k)]
     }]
+    # Created with: puts File.read('./lib/aarch64/parser.y').scan(/\b[A-Z][A-Z\d]+\b/).sort.uniq - ['LABEL', 'LABEL_CREATE']
+    KEYWORDS = %w[
+      ADC
+      ADCS
+      ADD
+      ADDS
+      ADR
+      ADRP
+      ALLE1
+      ALLE1IS
+      ALLE1OS
+      ALLE2
+      ALLE2IS
+      ALLE2OS
+      ALLE3
+      ALLE3IS
+      ALLE3OS
+      AND
+      ANDS
+      ASIDE1
+      ASIDE1IS
+      ASIDE1OS
+      ASR
+      AT
+      AUTDA
+      B
+      BANG
+      BFI
+      BFXIL
+      BIC
+      BICS
+      BL
+      BLR
+      BR
+      BRK
+      CBNZ
+      CBZ
+      CCMN
+      CCMP
+      CGDSW
+      CGDVAC
+      CGDVADP
+      CGDVAP
+      CGSW
+      CGVAC
+      CGVADP
+      CGVAP
+      CIGDSW
+      CIGDVAC
+      CIGSW
+      CIGVAC
+      CINC
+      CINV
+      CISW
+      CIVAC
+      CLREX
+      CLS
+      CLZ
+      CMN
+      CMP
+      CNEG
+      COMMA
+      CRC32B
+      CRC32CB
+      CRC32CH
+      CRC32CW
+      CRC32CX
+      CRC32H
+      CRC32W
+      CRC32X
+      CSEL
+      CSET
+      CSETM
+      CSINC
+      CSINV
+      CSNEG
+      CSW
+      CVAC
+      CVADP
+      CVAP
+      CVAU
+      DC
+      DCPS1
+      DCPS2
+      DCPS3
+      DMB
+      DOT
+      DRPS
+      DSB
+      EOL
+      EON
+      EOR
+      EQ
+      ERET
+      EXTR
+      GE
+      GT
+      GVA
+      GZVA
+      HI
+      HINT
+      HLT
+      HS
+      HVC
+      IALLU
+      IALLUIS
+      IC
+      IGDSW
+      IGDVAC
+      IGSW
+      IGVAC
+      IPAS2E1
+      IPAS2E1IS
+      IPAS2E1OS
+      IPAS2LE1
+      IPAS2LE1IS
+      IPAS2LE1OS
+      ISB
+      ISH
+      ISHLD
+      ISHST
+      ISW
+      IVAC
+      IVAU
+      LD
+      LDAR
+      LDARB
+      LDARH
+      LDAXP
+      LDAXR
+      LDAXRB
+      LDAXRH
+      LDNP
+      LDP
+      LDPSW
+      LDR
+      LDRB
+      LDRH
+      LDRSB
+      LDRSH
+      LDRSW
+      LDTR
+      LDTRB
+      LDTRH
+      LDTRSB
+      LDTRSH
+      LDTRSW
+      LDUR
+      LDURB
+      LDURH
+      LDURSB
+      LDURSH
+      LDURSW
+      LDXP
+      LDXR
+      LDXRB
+      LDXRH
+      LE
+      LO
+      LS
+      LSL
+      LSQ
+      LSR
+      LT
+      MADD
+      MI
+      MNEG
+      MOV
+      MOVK
+      MOVN
+      MOVZ
+      MRS
+      MSR
+      MSUB
+      MUL
+      MVN
+      NE
+      NEG
+      NEGS
+      NGC
+      NGCS
+      NOP
+      NSH
+      NSHLD
+      NSHST
+      NUMBER
+      ORN
+      ORR
+      OSH
+      OSHLD
+      OSHST
+      PL
+      PRFM
+      PRFOP
+      PRFUM
+      PSSBB
+      RBIT
+      RET
+      REV
+      REV16
+      REV32
+      RIPAS2E1
+      RIPAS2E1IS
+      RIPAS2E1OS
+      RIPAS2LE1
+      RIPAS2LE1IS
+      RIPAS2LE1OS
+      ROR
+      RSQ
+      RVAAE1
+      RVAAE1IS
+      RVAAE1OS
+      RVAALE1
+      RVAALE1IS
+      RVAALE1OS
+      RVAE1
+      RVAE1IS
+      RVAE1OS
+      RVAE2
+      RVAE2IS
+      RVAE2OS
+      RVAE3
+      RVAE3IS
+      RVAE3OS
+      RVALE1
+      RVALE1IS
+      RVALE1OS
+      RVALE2
+      RVALE2IS
+      RVALE2OS
+      RVALE3
+      RVALE3IS
+      RVALE3OS
+      S12E0R
+      S12E0W
+      S12E1R
+      S12E1W
+      S1E0R
+      S1E0W
+      S1E1R
+      S1E1RP
+      S1E1W
+      S1E1WP
+      S1E2R
+      S1E2W
+      S1E3R
+      S1E3W
+      SBC
+      SBCS
+      SBFIZ
+      SBFX
+      SDIV
+      SEV
+      SEVL
+      SMADDL
+      SMC
+      SMNEGL
+      SMSUBL
+      SMULH
+      SMULL
+      SP
+      SSBB
+      ST
+      STLR
+      STLRB
+      STLRH
+      STLXP
+      STLXR
+      STLXRB
+      STLXRH
+      STNP
+      STP
+      STR
+      STRB
+      STRH
+      STTR
+      STTRB
+      STTRH
+      STUR
+      STURB
+      STURH
+      STXP
+      STXR
+      STXRB
+      STXRH
+      SUB
+      SUBS
+      SVC
+      SXTB
+      SXTH
+      SXTW
+      SXTX
+      SY
+      SYS
+      SYSL
+      SYSTEMREG
+      TBNZ
+      TBZ
+      TLBI
+      TST
+      UBFIZ
+      UBFX
+      UDIV
+      UMADDL
+      UMNEGL
+      UMSUBL
+      UMULH
+      UMULL
+      UXTB
+      UXTH
+      UXTW
+      UXTX
+      VAAE1
+      VAAE1IS
+      VAAE1OS
+      VAALE1
+      VAALE1IS
+      VAALE1OS
+      VAE1
+      VAE1IS
+      VAE1OS
+      VAE2
+      VAE2IS
+      VAE2OS
+      VAE3
+      VAE3IS
+      VAE3OS
+      VALE1
+      VALE1IS
+      VALE1OS
+      VALE2
+      VALE2IS
+      VALE2OS
+      VALE3
+      VALE3IS
+      VALE3OS
+      VC
+      VMALLE1
+      VMALLE1IS
+      VMALLE1OS
+      VMALLS12E1
+      VMALLS12E1IS
+      VMALLS12E1OS
+      VS
+      WFE
+      WFI
+      WSP
+      XZR
+      YIELD
+      ZVA
+    ].freeze
+    KEYWORDS_SCAN = /(#{Regexp.union(KEYWORDS.sort).source})\b/i
+    LABEL_SCAN = /[a-zA-Z_]\w+/
+    LABEL_CREATE_SCAN = /#{LABEL_SCAN}:/
+
+    def register_label str
+      return unless @state == :first_pass
+
+      if @labels.include?(str)
+        raise "symbol '#{str}' is already defined"
+      end
+
+      label = @asm.make_label(str)
+      @asm.put_label(label)
+      @labels[str] = label
+
+      nil
+    end
+
+    def label_for str
+      # In the first pass, all valid labels are not known yet i.e. forward references
+      # Return a placeholder value instead.
+      if @state == :first_pass
+        @asm.make_label(str)
+      else
+        raise("Label #{str.inspect} not defined") unless @labels.key?(str)
+        @labels[str]
+      end
+    end
 
     def _next_token
       return _next_token if @scan.scan(/[\t ]+/) # skip whitespace
+      return if @scan.eos?
 
       if str = @scan.scan(/\n/)
         return [:EOL, :EOL]
+      elsif str = @scan.scan(LABEL_CREATE_SCAN)
+        [:LABEL_CREATE, str[0...-1]]
       elsif str = @scan.scan(/x\d+/i)
         [:Xd, AArch64::Registers.const_get(str.upcase)]
       elsif str = @scan.scan(/w\d+/i)
@@ -218,10 +611,20 @@ module AArch64
         end
       elsif str = @scan.scan(SYS_REG_SCAN)
         [:SYSTEMREG, SYS_REG_MAP[str.downcase]]
-      elsif str = @scan.scan(/\w+/)
+      elsif str = @scan.scan(KEYWORDS_SCAN)
         [str.upcase.to_sym, str]
+      elsif str = @scan.scan(LABEL_SCAN)
+        [:LABEL, str]
       else
+        [:UNKNOWN_CHAR, @scan.getch]
       end
     end
+
+    def on_error(token_id, val, vstack)
+      token_str = token_to_str(token_id) || '?'
+      string = @scan.string
+      line_number = string.byteslice(0, @scan.pos).count("\n") + 1
+      raise ParseError, "parse error on value #{val.inspect} (#{token_str}) on line #{line_number} at pos #{@scan.pos}/#{string.bytesize}"
+    end
   end
 end