wardite 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13e64d51eb1befe294c1ffe57e53b85cbeac7015c989e9fa88d7e3528f55c6df
-  data.tar.gz: ae6a11d049b3970b6f8f8f87a7fd07f1c69a367afe706296413797075c9b4c12
+  metadata.gz: a5f1ce687265ea33d718ed38618cdba69873acabbd241515ef941f7a226672d0
+  data.tar.gz: a8a2cef102636f2fdfb9dc530bd268a6e8eb754bc2da9af882acd0b60e4c47f8
 SHA512:
-  metadata.gz: 8696f7f48858528a7b8d5ba524cdeada76ffde6fad9cd9009b8e1246ab51f0be5c6b0de511d4af29eef17a211d24602977fabe4bed31f63df925368317f664c6
-  data.tar.gz: 8d4e5e7b2931c2e04176099ad27b6d8bb65937cdada6abaaf7827674f83800373461344c4d8c9971e8f43b65abcf785466c88034331026c96d2139b8258b85d0
+  metadata.gz: b0e1f8005b1b96f7f2f34d32b1ddf97dde71577791a91d5a3309c9c83bf46e25e0d41f25d5859a94d4fec8714f4b7a42700756f8d6fae87c7e32b5d97e265e87
+  data.tar.gz: c6e9f7333baf51b2a08f0944beae0095a430c32a151c317e17d0becccf337724b86a0f214697e203cfbfbc251ee974230a211cc130ff2ff8cf95eabf09a47de6

data/README.md

@@ -1,28 +1,53 @@
 # Wardite
 
+[![workflow](https://github.com/udzura/wardite/actions/workflows/main.yml/badge.svg)](https://github.com/udzura/wardite/actions) [![gem version](https://badge.fury.io/rb/wardite.svg)](https://rubygems.org/gems/wardite)
+
 A pure-ruby webassembly runtime.
 
-## Installation
+- [x] Fully typed by RBS (with the aid of [rbs-inline](https://github.com/soutaro/rbs-inline))
+- [ ] WASI (p1) support
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add wardite
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install wardite
 
 ## Usage
 
-TODO: Write usage instructions here
+- In your ruby code, instanciate Wardite runtime:
+
+```ruby
+require "wardite"
+
+path = ARGV[0]
+method = ARGV[1]
+args = ARGV[2..-1] || []
+
+instance = Wardite::new(path: path);
+if !method && instance.runtime.respond_to?(:_start)
+  instance.runtime._start
+else
+  instance.runtime.call(method, args)
+end
+```
+
+- Wardite bundles `wardite` cli command:
+
+```console
+$ wardite examples/test.wasm
+#=> Test!
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Additionaly, you can run `bundle exec rake check` to generate rbs files from annotations and run `steep check`.
 
 ## Contributing
 
@@ -32,4 +57,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/udzura
 
 - https://github.com/technohippy/wasmrb?tab=readme-ov-file
   - Referencial implementation but no support with WASI
-  - Wardite aims to support full WASI (previwe 1)
+  - Wardite aims to support full WASI (previwe 1)
+- https://github.com/skanehira/chibiwasm
+  - Small and consise implementation in Rust
+  - Wardite was first built upon [its development tutorial](https://skanehira.github.io/writing-a-wasm-runtime-in-rust/). Thanks!
+  - Many of test wat files under [`examples/`](./examples/) are borrowed from chibiwasm project

data/examples/fib.wat

@@ -0,0 +1,14 @@
+(module
+  (func $fib (export "fib") (param $n i32) (result i32)
+    (if
+      (i32.lt_s (local.get $n) (i32.const 2))
+      (then (return (i32.const 1)))
+    )
+    (return
+      (i32.add
+        (call $fib (i32.sub (local.get $n) (i32.const 2)))
+        (call $fib (i32.sub (local.get $n) (i32.const 1)))
+      )
+    )
+  )
+)

data/examples/fib2.wat

@@ -0,0 +1,13 @@
+(module
+  (func $fib (export "fib") (param i32) (result i32)
+    (if (result i32) (i32.le_u (local.get 0) (i32.const 1))
+      (then (i32.const 1))
+      (else
+        (i32.add
+          (call $fib (i32.sub (local.get 0) (i32.const 2)))
+          (call $fib (i32.sub (local.get 0) (i32.const 1)))
+        )
+      )
+    )
+  )
+)

data/exe/wardite

@@ -11,5 +11,6 @@ instance = Wardite::BinaryLoader::load_from_buffer(f);
 if !method && instance.runtime.respond_to?(:_start)
   instance.runtime._start
 else
-  instance.runtime.call(method, args)
+  ret = instance.runtime.call(method, args)
+  $stderr.puts "return value: #{ret.inspect}"
 end

data/lib/wardite/instruction.rb

@@ -16,8 +16,12 @@ module Wardite
     # @rbs return: Symbol
     def self.to_sym(chr)
       case chr
+      when "\u0004"
+        :if
       when "\u000b"
         :end
+      when "\u000f"
+        :return
       when "\u0010"
         :call
       when "\u0020"
@@ -28,10 +32,16 @@ module Wardite
         :i32_store
       when "\u0041"
         :i32_const
+      when "\u0048"
+        :i32_lts
+      when "\u004d"
+        :i32_leu
       when "\u006a"
         :i32_add
+      when "\u006b"
+        :i32_sub
       else
-        raise NotImplementedError, "unimplemented: #{chr.inspect}"
+        raise NotImplementedError, "unimplemented: #{"%04x" % chr.ord}"
       end
     end
 
@@ -45,6 +55,8 @@ module Wardite
         [:i32]
       when :i32_store
         [:u32, :u32]
+      when :if
+        [:u8_block]
       else
         []
       end

data/lib/wardite/version.rb

@@ -2,5 +2,5 @@
 # rbs_inline: enabled
 
 module Wardite
-  VERSION = "0.1.0" #: String
+  VERSION = "0.1.1" #: String
 end

data/lib/wardite/wasi.rb

@@ -34,6 +34,7 @@ module Wardite
         iovs += 4
         slen = unpack_le_int(memory.data[iovs...(iovs+4)])
         iovs += 4
+        # TODO: parallel write?
         nwritten += file.write(memory.data[start...(start+slen)])
       end
 
@@ -42,7 +43,6 @@ module Wardite
       0
     end
 
-
     # @rbs return: Hash[Symbol, Proc]
     def to_module
       {

data/lib/wardite.rb

@@ -419,13 +419,23 @@ module Wardite
       while c = buf.read(1)
         code = Op.to_sym(c)
         operand_types = Op.operand_of(code)
-        operand = []
+        operand = [] #: Array[Object]
         operand_types.each do |typ|
           case typ
           when :u32
             operand << fetch_uleb128(buf)
           when :i32
             operand << fetch_sleb128(buf)
+          when :u8_block # :if specific
+            block_ope = buf.read 1
+            if ! block_ope
+              raise "buffer too short for if"
+            end
+            if block_ope.ord == 0x40
+              operand << Block.void
+            else
+              operand << Block.new([block_ope.ord])
+            end
           else
             $stderr.puts "warning: unknown type #{typ.inspect}. defaulting to u32"
             operand << fetch_uleb128(buf)
@@ -820,6 +830,19 @@ module Wardite
     # @rbs return: void
     def eval_insn(frame, insn)
       case insn.code
+      when :if
+        block = insn.operand[0]
+        raise EvalError, "if op without block" if !block.is_a?(Block)
+        cond = stack.pop 
+        raise EvalError, "cond not found" if !cond.is_a?(Integer)
+        next_pc = fetch_ops_while_end(frame.body, frame.pc)
+        if cond.zero?
+          frame.pc = next_pc
+        end
+
+        label = Label.new(:if, next_pc, stack.size, block.result_size)
+        frame.labels.push(label)
+        
       when :local_get
         idx = insn.operand[0]
         if !idx.is_a?(Integer)
@@ -841,12 +864,32 @@ module Wardite
         end
         frame.locals[idx] = value
 
+      when :i32_lts
+        right, left = stack.pop, stack.pop
+        if !right.is_a?(Integer) || !left.is_a?(Integer)
+          raise EvalError, "maybe empty stack"
+        end
+        value = (left < right) ? 1 : 0
+        stack.push(value)
+      when :i32_leu
+        right, left = stack.pop, stack.pop
+        if !right.is_a?(Integer) || !left.is_a?(Integer)
+          raise EvalError, "maybe empty stack"
+        end
+        value = (left >= right) ? 1 : 0
+        stack.push(value)
       when :i32_add
         right, left = stack.pop, stack.pop
         if !right.is_a?(Integer) || !left.is_a?(Integer)
           raise EvalError, "maybe empty stack"
         end
         stack.push(left + right)
+      when :i32_sub
+        right, left = stack.pop, stack.pop
+        if !right.is_a?(Integer) || !left.is_a?(Integer)
+          raise EvalError, "maybe empty stack"
+        end
+        stack.push(left - right)
       when :i32_const
         const = insn.operand[0]
         if !const.is_a?(Integer)
@@ -883,26 +926,72 @@ module Wardite
           raise GenericError, "got a non-function pointer"
         end
 
-      when :end
+      when :return
         old_frame = call_stack.pop
         if !old_frame
           raise EvalError, "maybe empty call stack"
         end
 
-        # unwind the stacks
-        if old_frame.arity > 0
-          if old_frame.arity > 1
-            raise ::NotImplementedError, "return artiy >= 2 not yet supported ;;"
+        stack_unwind(old_frame.sp, old_frame.arity)
+
+      when :end
+        if old_label = frame.labels.pop
+          frame.pc = old_label.pc
+          stack_unwind(old_label.sp, old_label.arity)
+        else
+          old_frame = call_stack.pop
+          if !old_frame
+            raise EvalError, "maybe empty call stack"
           end
-          value = stack.pop
-          if !value
-            raise EvalError, "cannot obtain return value"
+          stack_unwind(old_frame.sp, old_frame.arity)
+        end
+      end
+    end
+
+    # @rbs ops: Array[Op]
+    # @rbs pc_start: Integer
+    # @rbs return: Integer
+    def fetch_ops_while_end(ops, pc_start)
+      cursor = pc_start
+      depth = 0
+      loop {
+        cursor += 1
+        inst = ops[cursor]
+        case inst&.code
+        when nil
+          raise EvalError, "end op not found"
+        when :i
+          depth += 1
+        when :end
+          if depth == 0
+            return cursor
+          else
+            depth -= 1
           end
-          self.stack = drained_stack(old_frame.sp)
-          stack.push value
         else
-          self.stack = drained_stack(old_frame.sp)
+          # nop
+        end
+      }
+      raise "[BUG] unreachable"
+    end
+
+    # unwind the stack and put return value if exists
+    # @rbs sp: Integer
+    # @rbs arity: Integer
+    # @rbs return: void
+    def stack_unwind(sp, arity)
+      if arity > 0
+        if arity > 1
+          raise ::NotImplementedError, "return artiy >= 2 not yet supported ;;"
         end
+        value = stack.pop
+        if !value
+          raise EvalError, "cannot obtain return value"
+        end
+        self.stack = drained_stack(sp)
+        stack.push value
+      else
+        self.stack = drained_stack(sp)
       end
     end
 
@@ -943,6 +1032,8 @@ module Wardite
 
     attr_accessor :arity #: Integer
 
+    attr_accessor :labels #: Array[Label]
+
     attr_accessor :locals #: Array[Object]
 
     # @rbs pc: Integer
@@ -957,6 +1048,28 @@ module Wardite
       @body = body
       @arity = arity
       @locals = locals
+      @labels = []
+    end
+  end
+
+  class Label
+    attr_accessor :kind #: (:if|:loop|:block)
+
+    attr_accessor :pc #: Integer
+    attr_accessor :sp #: Integer
+
+    attr_accessor :arity #: Integer
+
+    # @rbs kind: (:if|:loop|:block)
+    # @rbs pc: Integer
+    # @rbs sp: Integer
+    # @rbs arity: Integer
+    # @rbs returb: void
+    def initialize(kind, pc, sp, arity)
+      @kind = kind
+      @pc = pc
+      @sp = sp
+      @arity = arity
     end
   end
 
@@ -1068,6 +1181,37 @@ module Wardite
     end
   end
 
+  class Block
+    VOID = nil #: nil
+
+    attr_accessor :block_types #: nil|Array[Integer]
+
+    # @rbs return: Block
+    def self.void
+      new(VOID)
+    end
+
+    # @rbs block_types: nil|Array[Integer]
+    # @rbs return: void
+    def initialize(block_types=VOID)
+      @block_types = block_types
+    end
+
+    # @rbs return: bool
+    def void?
+      !!block_types
+    end
+
+    # @rbs return: Integer
+    def result_size
+      if block_types # !void?
+        block_types.size
+      else
+        0
+      end
+    end
+  end
+
   class Exports
     attr_accessor :mappings #: Hash[String, [Integer, WasmFunction|ExternalFunction]]
 
@@ -1146,4 +1290,18 @@ module Wardite
   class LoadError < StandardError; end
   class ArgumentError < StandardError; end
   class EvalError < StandardError; end
+
+  # @rbs path: String|nil
+  # @rbs buffer: File|StringIO|nil
+  # @rbs **options: Hash[Symbol, Object]
+  # @rbs return: Instance
+  def self.new(path: nil, buffer: nil, **options)
+    if path
+      buffer = File.open(path)
+    end
+    if !buffer
+      raise ::ArgumentError, "nil buffer passed"
+    end
+    Wardite::BinaryLoader::load_from_buffer(buffer, **options);
+  end
 end

data/sig/generated/wardite.rbs

@@ -247,6 +247,17 @@ module Wardite
     # @rbs return: void
     def eval_insn: (Frame frame, Op insn) -> void
 
+    # @rbs ops: Array[Op]
+    # @rbs pc_start: Integer
+    # @rbs return: Integer
+    def fetch_ops_while_end: (Array[Op] ops, Integer pc_start) -> Integer
+
+    # unwind the stack and put return value if exists
+    # @rbs sp: Integer
+    # @rbs arity: Integer
+    # @rbs return: void
+    def stack_unwind: (Integer sp, Integer arity) -> void
+
     # @rbs finish: Integer
     # @rbs return: Array[Object]
     def drained_stack: (Integer finish) -> Array[Object]
@@ -270,6 +281,8 @@ module Wardite
 
     attr_accessor arity: Integer
 
+    attr_accessor labels: Array[Label]
+
     attr_accessor locals: Array[Object]
 
     # @rbs pc: Integer
@@ -281,6 +294,23 @@ module Wardite
     def initialize: (Integer pc, Integer sp, Array[Op] body, Integer arity, Array[Object] locals) -> untyped
   end
 
+  class Label
+    attr_accessor kind: :if | :loop | :block
+
+    attr_accessor pc: Integer
+
+    attr_accessor sp: Integer
+
+    attr_accessor arity: Integer
+
+    # @rbs kind: (:if|:loop|:block)
+    # @rbs pc: Integer
+    # @rbs sp: Integer
+    # @rbs arity: Integer
+    # @rbs returb: void
+    def initialize: (:if | :loop | :block kind, Integer pc, Integer sp, Integer arity) -> untyped
+  end
+
   class Store
     attr_accessor funcs: Array[WasmFunction | ExternalFunction]
 
@@ -319,6 +349,25 @@ module Wardite
     def initialize: () { (WasmData) -> void } -> void
   end
 
+  class Block
+    VOID: nil
+
+    attr_accessor block_types: nil | Array[Integer]
+
+    # @rbs return: Block
+    def self.void: () -> Block
+
+    # @rbs block_types: nil|Array[Integer]
+    # @rbs return: void
+    def initialize: (?nil | Array[Integer] block_types) -> void
+
+    # @rbs return: bool
+    def void?: () -> bool
+
+    # @rbs return: Integer
+    def result_size: () -> Integer
+  end
+
   class Exports
     attr_accessor mappings: Hash[String, [ Integer, WasmFunction | ExternalFunction ]]
 
@@ -381,4 +430,10 @@ module Wardite
 
   class EvalError < StandardError
   end
+
+  # @rbs path: String|nil
+  # @rbs buffer: File|StringIO|nil
+  # @rbs **options: Hash[Symbol, Object]
+  # @rbs return: Instance
+  def self.new: (?path: String | nil, ?buffer: File | StringIO | nil, **Hash[Symbol, Object] options) -> Instance
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wardite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Uchio Kondo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-10-28 00:00:00.000000000 Z
 dependencies: []
 description: A pure-ruby webassembly runtime
 email:
@@ -25,6 +25,8 @@ files:
 - examples/add.wasm
 - examples/add.wat
 - examples/call.wat
+- examples/fib.wat
+- examples/fib2.wat
 - examples/helloworld.wat
 - examples/i32_const.wat
 - examples/i32_store.wat