BadBoy-ruby-hackvm 0.1.0

data/README.textile

@@ -0,0 +1,61 @@
+h1. Ruby Hack VM
+
+h2. Information
+
+h3. The Hack VM is a tiny, trivial, virtual machine.
+
+Its purpose is to be used as a simple execution engine that can run very simple programs.
+
+more Information on <a href="http://www.hacker.org/hvm/">http://www.hacker.org/hvm/</a>
+
+The virtual machine executes a single program and terminates, either by reaching the end of the code, an '!' instruction, or because an exception was thrown during execution.
+A program is represented by a string of single-character instructions.
+The virtual machine starts with the first instruction, executes it, and moves on to the next instruction, etc... 
+
+The index of the current instruction is called the program counter.
+The execution model is simple: the virtual machine has an operand stack, a memory buffer, and a call stack.
+
+Each item on the operand stack or in memory is a cell that can hold a signed integer. 
+For implementation reasons, those integers are currently limited to 32 bits, but do not count on it, they could be large in future implementations. 
+The call stack is used to push the value of the program counter when jumping to a routine from which we want to return.
+
+h2. Instructions
+
+<pre>
+Instruction		Description
+' '		Do Nothing 
+'p'		Print S0 interpreted as an integer 
+'P'		Print S0 interpreted as an ASCII character (only the least significant 7 bits of the value are used) 
+'0'		Push the value 0 on the stack 
+'1'		Push the value 1 on the stack 
+'2'		Push the value 2 on the stack 
+'3'		Push the value 3 on the stack 
+'4'		Push the value 4 on the stack 
+'5'		Push the value 5 on the stack 
+'6'		Push the value 6 on the stack 
+'7'		Push the value 7 on the stack 
+'8'		Push the value 8 on the stack 
+'9'		Push the value 9 on the stack 
+'+'		Push S1+S0 
+'-'		Push S1-S0 
+'*'		Push S1*S0 
+'/'		Push S1/S0 
+':'		Push -1 if S1<S0, 0 if S1=S0, or 1 S1>S0
+'g'		Add S0 to the program counter 
+'?'		Add S0 to the program counter if S1 is 0 
+'c'		Push the program counter on the call stack and set the program counter to S0 
+'$'		Set the program counter to the value pop'ed from the call stack 
+'<'		Push the value of memory cell S0 
+'>'		Store S1 into memory cell S0 
+'^'		Push a copy of S<S0+1> (ex: 0^ duplicates S0) 
+'v'		Remove S<S0+1> from the stack and push it on top (ex: 1v swaps S0 and S1) 
+'d'		Drop S0 
+'!'		Terminate the program 
+</pre>
+
+
+h2. Examples
+
+Input: "78*p" Output: 56
+
+Input: "123451^2v5:4?9p2g8pppppp" Output: 945321

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'echoe'
+
+Echoe.new('ruby-hackvm', '0.1.0') do |p|
+  p.description    = "a virtual machine for hackers."
+  p.url            = "http://github.com/BadBoy/ruby-hackvm"
+  p.author         = "BadBoy_"
+  p.email          = ""
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+

data/bin/hackvm.rb

@@ -0,0 +1,245 @@
+#!/usr/bin/env ruby
+
+# http://www.hacker.org/hvm/
+
+class HackVM
+  class StackUnderFlow < Exception; end
+  class IntegerOverflow < Exception; end
+  class InitMemoryToBig < Exception; end
+  class OutOfStackException < Exception; end
+  class OutOfCodeBoundsException < Exception; end
+  class TooManyCyclesException < Exception; end
+  class WrongOpCode < Exception; end
+  class MemoryReadAccessViolation < Exception; end
+  class MemoryWriteAccessViolation < Exception; end
+  
+  MAX_CYCLES=10000
+  MIN_INT=-(1<<63)
+  MAX_INT=(1<<63)-1
+
+  OPS = {
+	' ' => lambda {},
+	"\n" => lambda {},
+	'p' => :printi,
+	'P' => :printc,
+	'0' => [:push, 0],
+	'1' => [:push, 1],
+	'2' => [:push, 2],
+	'3' => [:push, 3],
+	'4' => [:push, 4],
+	'5' => [:push, 5],
+	'6' => [:push, 6],
+	'7' => [:push, 7],
+	'8' => [:push, 8],
+	'9' => [:push, 9],
+	'+' => :add,
+	'-' => :sub,
+	'*' => :mul,
+	'/' => :div,
+	':' => :cmp,
+	'g' => :goto,
+	'?' => :goto_if_zero,
+	'c' => :call,
+	'$' => :doreturn,
+	'<' => :peek,
+	'>' => :poke,
+	'^' => :pick,
+	'v' => :roll,
+	'd' => :drop,
+	'!' => :exit
+  }
+
+  def initialize
+    @memory = [0]*16384
+    @callstack = []
+    @operandstack = []
+    @programcounter = 0
+    @cyclecounter = 0
+  end
+  
+  def init(memory)
+    if memory.size > 16384
+      raise InitMemoryToBig
+    end
+    memory.each_with_index do |e, i|
+      @memory[i] = e
+    end
+  end
+  
+  def execute(code, trace)
+    codel = code.size
+    @codel = codel
+    while @programcounter != codel
+      op_code = code[@programcounter, 1]
+      STDERR.print('@'+@programcounter.to_s+' '+op_code) if trace
+      @programcounter += 1
+      @cyclecounter += 1
+      if @cyclecounter > MAX_CYCLES
+        raise TooManyCyclesException, 'too many cycles'
+      end
+      if OPS[op_code]
+        if OPS[op_code].kind_of? Symbol
+          method(OPS[op_code]).call
+        elsif OPS[op_code].kind_of? Proc
+          OPS[op_code].call
+        elsif OPS[op_code].kind_of? Array
+          m = method(OPS[op_code][0])
+          m.call(OPS[op_code][1])
+        else
+          raise WrongOpCode, "wrong op-code '#{op_code}'"
+        end
+      else
+        raise WrongOpCode, "wrong op-code '#{op_code}'"
+      end
+      if @programcounter < 0 || @programcounter > codel
+        raise OutOfCodeBoundsException, 'out of code bounds'
+      end
+      STDERR.puts(' ['+@operandstack.join(',')+']') if trace
+    end
+    puts
+    
+    rescue Exception => e
+      STDERR.puts("!ERROR: exception while executing I=#{op_code} PC=#{@programcounter-1} STACK_SIZE=#{@operandstack.size}")
+      puts e
+      Kernel.exit(1)
+  end
+
+  private
+  def push(v)
+    if v < MIN_INT || v > MAX_INT
+      raise IntegerOverflow
+    end
+    @operandstack.push(v)
+  end
+    
+  def pop
+    if @operandstack.size == 0
+      raise StackUnderFlow
+    end
+    @operandstack.pop
+  end
+  
+  def printc
+    print( pop.chr )
+  end
+
+  def printi
+    print pop
+  end
+  
+  def add
+    push(pop+pop)
+  end
+    
+  def sub
+    a = pop
+    b = pop
+    push(b-a)
+  end
+
+  def mul
+    push(pop*pop)
+  end
+  
+  def div
+    a = pop
+    b = pop
+    push(b/a)
+  end
+  
+  def cmp
+    a = pop
+    b = pop
+    push( b<=>a )
+  end
+  
+  def goto
+    @programcounter += pop
+  end
+
+  def goto_if_zero
+    offset = pop
+    @programcounter += offset if pop == 0
+  end
+
+  def call
+    @callstack.push(@programcounter)
+    @programcounter = pop
+  end
+
+  def doreturn
+    @programcounter = @callstack.pop
+  end
+  
+  def peek
+    addr = pop
+    if addr < 0 || addr >= @memory.size
+      raise MemoryReadAccessViolation, 'memory read access violation @'+addr.to_s
+    end
+    push(@memory[addr])
+  end
+  
+  def poke
+    addr = pop
+    if addr < 0 || addr >= @memory.size
+      raise MemoryWriteAccessViolation, 'memory write access violation @'+addr.to_s
+    end
+    @memory[addr] = pop
+  end
+
+  def pick
+    where = pop
+    if where < 0 || where >= @operandstack.size
+      raise OutOfStackException, 'out of stack @'+where.to_s
+    end
+    push(@operandstack[-1-where])
+  end
+
+  def roll
+    where = pop
+    if where < 0 || where >= @operandstack.size
+      raise OutOfStackException, 'out of stack @'+where.to_s
+    end
+    v = @perandstack[-1-where]
+    @perandStack.delete_at(-1-where)
+    push(v)
+  end
+    
+  def drop
+    pop
+  end
+    
+  def exit
+    @programcounter = @codel
+  end
+end
+
+require 'optparse'
+
+trace = false
+memory = []
+ARGV.options do |o|
+  o.banner = "hackvm.rb [--init <init-mem-filename>] [--trace] <code-filename>\n"
+  o.banner += "The format for the initial memory file is: cell0,cell1,...\n"
+  o.banner += "More on http://www.hacker.org/hvm/"
+  o.separator('')
+
+  o.on('-t', '--trace', 'trace commands') do |t|
+    trace = t
+  end
+  
+  o.on('-i', '--init FILE', 'init-mem-filename') do |i|
+    f = File.read(i)
+    memory = f.chomp.split(',').map{|e|Integer(e)}
+  end
+end
+begin
+  ARGV.parse!
+rescue OptionParser::InvalidOption => e
+  STDERR.puts "!ERROR: #{e}"
+  exit 1
+end
+
+raise "not enough arguments" if ARGV.size < 1
+hvm = HackVM.new
+hvm.execute(File.read(ARGV[0]), trace)

data/ruby-hackvm.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |s|
+  s.name = %q{ruby-hackvm}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["BadBoy_"]
+  s.date = %q{2008-11-13}
+  s.default_executable = %q{hackvm.rb}
+  s.description = %q{a virtual machine for hackers.}
+  s.email = %q{}
+  s.executables = ["hackvm.rb"]
+  s.extra_rdoc_files = ["bin/hackvm.rb", "README.textile"]
+  s.files = ["samples/helloworld.hvm", "Rakefile", "ruby-hackvm.gemspec", "bin/hackvm.rb", "Manifest", "README.textile"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/BadBoy/ruby-hackvm}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ruby-hackvm", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ruby-hackvm}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{a virtual machine for hackers.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+    else
+    end
+  else
+  end
+end

data/samples/helloworld.hvm

@@ -0,0 +1,14 @@
+98*P
+99*29*2++P
+99*39*+P
+99*39*+P
+99*47*2++P
+48*52*+2+P
+48*P
+99*6+P
+99*47*2++P
+99*47*5++P
+99*39*+P
+99*29*1++P
+65+3*P
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: BadBoy-ruby-hackvm
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- BadBoy_
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-13 00:00:00 -08:00
+default_executable: hackvm.rb
+dependencies: []
+
+description: a virtual machine for hackers.
+email: ""
+executables: 
+- hackvm.rb
+extensions: []
+
+extra_rdoc_files: 
+- bin/hackvm.rb
+- README.textile
+files: 
+- samples/helloworld.hvm
+- Rakefile
+- ruby-hackvm.gemspec
+- bin/hackvm.rb
+- Manifest
+- README.textile
+has_rdoc: true
+homepage: http://github.com/BadBoy/ruby-hackvm
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ruby-hackvm
+- --main
+- README.textile
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ruby-hackvm
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: a virtual machine for hackers.
+test_files: []
+