twib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be083ce5e43cdb183a7548ce6ad0b2eabc77e425
+  data.tar.gz: 58e462f9150b324ac65acdaa12dbc1fb10dc4df9
+SHA512:
+  metadata.gz: a58ca6fa102c71854d30b3b2bb4338e6425f59fd05be3392ad660816a617fb82866a5508ff3b50c542b29125ff1c1d76b6a67cee14f8d1e737780304e2835d5a
+  data.tar.gz: f77ef0b936b82b29b2d5e48bc803b85d37e077a7222118ee4d2c6b070f0368331744ce6ef862525b8f7746cb5a1cc75d654f606674959ec9e49cc48906c581a2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in twib.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    twib (0.1.0)
+      msgpack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    msgpack (1.2.4)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  twib!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,51 @@
+# ruby-twib
+
+[Twili](https://github.com/misson20000/twili) bridge client for Ruby, providing a way for Ruby applications to send requests to a Twili device via twibd.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twib'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twib
+
+## Usage
+
+See the instructions on the [Twili repository](https://github.com/misson20000/twili#twili) for how to set up Twili and twibd.
+
+First, create a Twib::TwibConnection. There is a convenience method `Twib::TwibConnection::connect_unix`
+```ruby
+> tc = Twib::TwibConnection.connect_unix
+ => #<Twib::TwibConnection:...>
+```
+
+After that, you can list the available devices with `TwibConnection#list_devices`, which returns an array of hashes identifying each device.
+```ruby
+> tc.list_devices
+[{"device_id"=>507914862, ...}, ...]
+```
+
+Use `TwibConnection#open_device` to get a device's `ITwibDeviceInterface`.
+```ruby
+> tc.open_device(507914862)
+ => #<Twib::Interfaces::ITwibDeviceInterface:...>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/misson20000/ruby-twib.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "twib"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/twib.rb

@@ -0,0 +1,152 @@
+require "socket"
+require "thread"
+
+require "twib/version"
+require "twib/interfaces/ITwibMetaInterface"
+require "twib/interfaces/ITwibDeviceInterface"
+
+module Twib
+  class Error < RuntimeError
+  end
+  
+  class ResultError < Error
+    def initialize(code)
+      super("0x#{code.to_s(16)}")
+      @code = code
+    end
+    attr_reader :code
+  end
+  
+  class Response
+    def initialize(device_id, object_id, result_code, tag, payload, object_ids)
+      @device_id = device_id
+      @object_id = object_id
+      @result_code = result_code
+      @tag = tag
+      @payload = payload
+      @object_ids = object_ids
+    end
+
+    attr_reader :device_id, :object_id, :result_code, :tag, :payload, :object_ids
+    
+    def assert_ok
+      if @result_code != 0 then
+        raise ResultError.new(@result_code)
+      end
+      return self
+    end
+  end
+  
+  class ActiveRequest
+    def initialize(tc, device_id, object_id, command_id, tag, payload, &block)
+      @tc = tc
+      @device_id = device_id
+      @object_id = object_id
+      @command_id = command_id
+      @tag = tag
+      @payload = payload
+      @condvar = ConditionVariable.new
+      @cb = block
+      @response = nil
+    end
+
+    def respond(response) # expects to be synchronized by @tc.mutex
+      @response = response
+      @condvar.broadcast
+      if @cb then
+        @tc.cb_queue.push([@cb, response])
+      end
+    end
+
+    def wait
+      @tc.mutex.synchronize do
+        while @response == nil do
+          @condvar.wait(@tc.mutex)
+        end
+      end
+      return @response
+    end
+
+    def wait_ok
+      wait.assert_ok
+    end
+  end
+  
+  class TwibConnection
+    def self.connect_unix
+      return self.new(UNIXSocket.new("/var/run/twibd.sock"))
+    end
+    
+    def initialize(socket)
+      @socket = socket
+      @itmi = Interfaces::ITwibMetaInterface.new(self, 0, 0)
+      @alive = true
+      @active_requests = {}
+      @mutex = Mutex.new
+      @thread = Thread.new do
+        loop do
+          header = @socket.recv(32)
+          header = header.unpack("L<L<L<L<Q<L<")
+          
+          payload = String.new
+          object_ids = []
+          if header[4] > 0 then
+            payload = @socket.recv(header[4]) # payload size
+          end
+          if header[5] > 0 then
+            object_ids = @socket.recv(header[5] * 4).unpack("L<*") # object IDs
+          end
+
+          rs = Response.new(header[0], header[1], header[2], header[3], payload, object_ids)
+          @mutex.synchronize do
+            rq = @active_requests.delete(rs.tag)
+            if !rq then
+              puts "WARNING: got response for bad tag"
+            end
+            rq.respond(rs)
+          end
+        end
+      end
+
+      @cb_queue = Queue.new
+      @cb_thread = Thread.new do # to avoid deadlocks on I/O thread, we execute callbacks here
+        while @alive do
+          cb, response = @cb_queue.pop
+          cb.call(response)
+        end
+      end
+    end
+
+    attr_reader :mutex
+    attr_reader :cb_queue
+    
+    def close
+      @alive = false
+      @socket.close
+      @thread.join
+    end
+
+    def send(device_id, object_id, command_id, payload, &block)
+      tag = rand(0xffffffff)
+
+      rq = ActiveRequest.new(self, device_id, object_id, command_id, tag, payload, &block)
+      @active_requests[tag] = rq
+      
+      message = [device_id, object_id, command_id, tag, payload.size, 0, 0].pack("L<L<L<L<Q<L<L<") + payload
+      sz = @socket.send(message, 0)
+      if sz < message.size then
+        raise "couldn't send entire message"
+      end
+
+      return rq
+    end
+    
+    def list_devices
+      @itmi.list_devices
+    end
+
+    def open_device(device_id)
+      return Interfaces::ITwibDeviceInterface.new(self, device_id, 0)
+    end
+  end
+end

data/lib/twib/interface.rb

@@ -0,0 +1,23 @@
+module Twib
+  class Interface
+    def initialize(connection, device_id, object_id)
+      @connection = connection
+      @device_id = device_id
+      @object_id = object_id
+
+      # object id 0 is special
+      #if @object_id != 0 then
+      #  ObjectSpace.define_finalizer(self, self.class.finalize(connection, device_id, object_id))
+      #end
+    end
+
+    def self.finalize(connection, device_id, object_id)
+      # send close request
+      #connection.send_sync(device_id, object_id, 0xffffffff, String.new)
+    end
+
+    def send(command_id, payload=String.new, &block)
+      @connection.send(@device_id, @object_id, command_id, payload, &block)
+    end
+  end
+end

data/lib/twib/interfaces/ITwibDebugger.rb

@@ -0,0 +1,83 @@
+require "twib/interface.rb"
+require "twib/switch/debug.rb"
+
+module Twib
+  module Interfaces
+    class ITwibDebugger < Interface
+      module Command
+        QUERY_MEMORY = 10
+        READ_MEMORY = 11
+        WRITE_MEMORY = 12
+        LIST_THREADS = 13
+        GET_DEBUG_EVENT = 14
+        GET_THREAD_CONTEXT = 15
+        BREAK_PROCESS = 16
+        CONTINUE_DEBUG_EVENT = 17
+        SET_THREAD_CONTEXT = 18
+        GET_NSO_INFOS = 19
+        WAIT_EVENT = 20
+      end
+      
+      def query_memory(addr)
+        Hash[
+          [:base, :size, :memory_type, :memory_attribute,
+           :permission, :device_ref_count, :ipc_ref_count].zip(
+            send(Command::QUERY_MEMORY, [addr].pack("Q<")).wait_ok.payload.unpack("Q<Q<L<L<L<L<L<"))]
+      end
+      
+      def read_memory(addr, size)
+        send(Command::READ_MEMORY, [addr, size].pack("Q<Q<")).wait_ok.payload
+      end
+      
+      def write_memory(addr, string)
+        send(Command::WRITE_MEMORY, [addr].pack("Q<") + string).wait_ok
+      end
+      
+      def list_threads
+        raise "nyi"
+      end
+      
+      def get_debug_event
+        rs = send(Command::GET_DEBUG_EVENT).wait
+        if rs.result_code == 0x8c01 then # no debug events left
+          return nil
+        end
+        return Switch::Debug::Event::Event.unpack(rs.payload)
+      end
+      
+      def get_thread_context(thread_id)
+        raise "nyi"
+      end
+      
+      def break_process
+        raise "nyi"
+      end
+      
+      def continue_debug_event(flags, thread_ids=[])
+        send(Command::CONTINUE_DEBUG_EVENT, ([flags] + thread_ids).pack("L<Q<*")).wait_ok
+        nil
+      end
+      
+      def set_thread_context(thread_id)
+        raise "nyi"
+      end
+      
+      def get_nso_infos
+        response = send(Command::GET_NSO_INFOS).wait_ok.payload
+        count = response.unpack("Q<")[0]
+        count.times.map do |i|
+          Hash[
+            [:base, :size, :build_id].zip(response[8 + 0x30 * i, 0x30].unpack("Q<Q<a32"))]
+        end
+      end
+      
+      def wait_event_async(&block)
+        send(Command::WAIT_EVENT, String.new, &block)
+      end
+      
+      def wait_event
+        send(Command::WAIT_EVENT).wait_ok
+      end
+    end
+  end
+end

data/lib/twib/interfaces/ITwibDeviceInterface.rb

@@ -0,0 +1,25 @@
+require "twib/interface.rb"
+
+require "twib/interfaces/ITwibDebugger.rb"
+
+module Twib
+  module Interfaces
+    class ITwibDeviceInterface < Interface
+      module Command
+        RUN = 10
+        REBOOT = 11
+        COREDUMP = 12
+        TERMINATE = 13
+        LIST_PROCESSES = 14
+        UPGRADE_TWILI = 15
+        IDENTIFY = 16
+        LIST_NAMED_PIPES = 17
+        OPEN_NAMED_PIPE = 18
+        OPEN_ACTIVE_DEBUGGER = 19
+      end
+      def open_active_debugger(pid)
+        ITwibDebugger.new(@connection, @device_id, send(Command::OPEN_ACTIVE_DEBUGGER, [pid].pack("Q<")).wait_ok.object_ids[0])
+      end
+    end
+  end
+end

data/lib/twib/interfaces/ITwibMetaInterface.rb

@@ -0,0 +1,16 @@
+require "msgpack"
+
+require "twib/interface.rb"
+
+module Twib
+  module Interfaces
+    class ITwibMetaInterface < Interface
+      module Command
+        LIST_DEVICES = 10
+      end
+      def list_devices
+        MessagePack.unpack(send(Command::LIST_DEVICES).wait_ok.payload)
+      end
+    end
+  end
+end

data/lib/twib/switch/debug.rb

@@ -0,0 +1,89 @@
+module Twib
+  module Switch
+    module Debug
+      module Event
+        class Event
+          def self.unpack(pack)
+            event_type, flags, thread_id, specific = pack.unpack("L<L<Q<a*")
+            case event_type
+            when AttachProcess::TYPE
+              return AttachProcess.new(flags, thread_id, specific)
+            when AttachThread::TYPE
+              return AttachThread.new(flags, thread_id, specific)
+            when ExitProcess::TYPE
+              return ExitProcess.new(flags, thread_id, specific)
+            when ExitThread::TYPE
+              return ExitThread.new(flags, thread_id, specific)
+            when Exception::TYPE
+              return Exception.new(flags, thread_id, specific)
+            else
+              raise "unknown debug event type: #{event_type}"
+            end
+          end
+          def initialize(flags, thread_id, specific)
+            @flags = flags
+            @thread_id = thread_id
+            unpack_specific(specific)
+          end
+          attr_reader :flags
+          attr_reader :thread_id
+        end
+        
+        class AttachProcess < Event
+          TYPE = 0
+          def unpack_specific(pack)
+            @title_id, @process_id, @process_name, @mmu_flags = pack.unpack("Q<Q<Z12L<")
+          end
+          def event_type
+            :attach_process
+          end
+          attr_reader :title_id, :process_id, :process_name, :mmu_flags
+        end
+        
+        class AttachThread < Event
+          TYPE = 1
+          def unpack_specific(pack)
+            @thread_id, @tls, @entrypoint = pack.unpack("Q<Q<Q<")
+          end
+          def event_type
+            :attach_thread
+          end
+          attr_reader :thread_id, :tls, :entrypoint
+        end
+        
+        class ExitProcess < Event
+          TYPE = 2
+          def unpack_specific(pack)
+            @type = pack.unpack("L<")
+          end
+          def event_type
+            :exit_process
+          end
+          attr_reader :type
+        end
+        
+        class ExitThread < Event
+          TYPE = 3
+          def unpack_specific(pack)
+            @type = pack.unpack("L<")
+          end
+          def event_type
+            :exit_thread
+          end
+          attr_reader :type
+        end
+        
+        class Exception < Event
+          TYPE = 4
+          def unpack_specific(pack)
+            @type, @fault_register, @specific = pack.unpack("L<Q<a*")
+          end
+          def event_type
+            :exception
+          end
+          attr_reader :type, :fault_register, :specific
+        end
+      end
+    end
+  end
+end

data/lib/twib/version.rb

@@ -0,0 +1,3 @@
+module Twib
+  VERSION = "0.1.0"
+end

data/twib.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "twib/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "twib"
+  spec.version       = Twib::VERSION
+  spec.authors       = ["misson20000"]
+  spec.email         = ["xenotoad@xenotoad.net"]
+
+  spec.summary       = "Twili bridge client for Ruby"
+  spec.homepage      = "https://github.com/misson20000/ruby-twib/"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "msgpack"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: twib
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- misson20000
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- xenotoad@xenotoad.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twib.rb
+- lib/twib/interface.rb
+- lib/twib/interfaces/ITwibDebugger.rb
+- lib/twib/interfaces/ITwibDeviceInterface.rb
+- lib/twib/interfaces/ITwibMetaInterface.rb
+- lib/twib/switch/debug.rb
+- lib/twib/version.rb
+- twib.gemspec
+homepage: https://github.com/misson20000/ruby-twib/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Twili bridge client for Ruby
+test_files: []