libvirt_ffi 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54cfaffc6e2d9a5efb229e0c47cf0222fd99521ff5fa5ec0af12fdcffe338248
+  data.tar.gz: 46b545e97737a7c189a601939d211107a77adc92c197e163f6fa3066930b71a4
+SHA512:
+  metadata.gz: e0f41521b95ae1c940b4da9bd2ebc229d86b220afc508b66bb74de8cdc7404a7078559d3f4d3a9fdae9cf30c67c402557e811b353d91fc34f6e4465aeb1eb3cd
+  data.tar.gz: 45e726be8f9049df8e87bfb768b60058bbd4dd3be55b1808e0a4a60fb9014188853d4af5f123de6baeded56006e371e863e11e7fe38b9ad3ef4643b27829d0b1

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+before_install: gem install bundler -v 2.1.4 --no-doc

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at senid231@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in libvirt.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'minitest', '~> 5.0'
+
+group :development do
+  gem 'async', '~> 1.24'
+  gem 'activesupport'
+  gem 'get_process_mem'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Denis Talakevich
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Libvirt
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/libvirt`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'libvirt'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install libvirt
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `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 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/[USERNAME]/libvirt. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/libvirt/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Libvirt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/libvirt/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'libvirt'
+
+# 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/exe/libvirt

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'libvirt'

data/lib/libvirt/connection.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'objspace'
+require 'libvirt/ffi/connection'
+require 'libvirt/ffi/domain'
+require 'libvirt/util'
+
+module Libvirt
+  class Connection
+    def initialize(uri)
+      @uri = uri
+      @conn_ptr = ::FFI::Pointer.new(0)
+      @cb_data = {}
+      ObjectSpace.define_finalizer(self, proc { |obj_id|
+        STDOUT.puts("finalized Libvirt::Connection #{obj_id.to_s(16)}")
+      })
+    end
+
+    def open
+      @conn_ptr = FFI::Connection.virConnectOpen(@uri)
+      raise Error, "Couldn't connect to #{@uri.inspect}" if @conn_ptr.null?
+      true
+    end
+
+    def opened?
+      !@conn_ptr.null?
+    end
+
+    def to_ptr
+      @conn_ptr
+    end
+
+    def version
+      check_open!
+
+      version_ptr = ::FFI::MemoryPointer.new(:ulong)
+      result = FFI::Connection.virConnectGetVersion(@conn_ptr, version_ptr)
+      raise Error, "Couldn't retrieve connection version" if result < 0
+      version_number = version_ptr.get_ulong(0)
+      Libvirt::Util::parse_version(version_number)
+    end
+
+    def set_keep_alive(interval, count)
+      result = FFI::Connection.virConnectSetKeepAlive(@conn_ptr, interval, count)
+      raise Error, "Couldn't set connection keep_alive" if result < 0
+      result == 0
+    end
+
+    def to_s
+      "#<#{self.class}:0x#{object_id.to_s(16)} @uri=#{@uri.inspect} @conn_ptr=0x#{@conn_ptr.address.to_s(16)}>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def list_all_domains_qty(flags = 0)
+      result = FFI::Domain.virConnectListAllDomains(@conn_ptr, nil, flags)
+      raise Error, "Couldn't retrieve domains qty with flags #{flags.to_s(16)}" if result < 0
+      result
+    end
+
+    def list_all_domains(flags = 0)
+      size = list_all_domains_qty(flags)
+      domains_ptr = ::FFI::MemoryPointer.new(:pointer, size)
+      result = FFI::Domain.virConnectListAllDomains(@conn_ptr, domains_ptr, flags)
+      raise Error, "Couldn't retrieve domains list with flags #{flags.to_s(16)}" if result < 0
+      ptr = domains_ptr.read_pointer
+      ptr.get_array_of_pointer(0, size).map { |dom_ptr| Libvirt::Domain.new(dom_ptr, self) }
+    end
+
+    # @yield conn, dom
+    def register_domain_event_callback(event_id, domain = nil, opaque = nil, &block)
+      if event_id == Libvirt::DOMAIN_EVENT_ID_LIFECYCLE
+        cb = FFI::Domain::domain_event_id_lifecycle_callback(&block)
+      else
+        raise Error, "not supported event_id #{event_id.inspect}"
+      end
+
+      result = FFI::Domain.virConnectDomainEventRegisterAny(
+          @conn_ptr,
+          domain&.to_ptr,
+          event_id,
+          cb,
+          opaque&.to_ptr,
+          nil # free_opaque
+      )
+      raise Error, "Couldn't register domain event callback" if result < 0
+
+      @cb_data[result] = { event_id: event_id, cb: cb, opaque: opaque }
+      result
+    end
+
+    def deregister_domain_event_callback(callback_id)
+      @cb_data.delete(callback_id)
+      result = FFI::Domain.virConnectDomainEventDeregisterAny(@conn_ptr, callback_id)
+      raise Error, "Couldn't deregister domain event callback" if result < 0
+      true
+    end
+
+    private
+
+    def check_open!
+      raise Error, "Connection to #{@uri.inspect} is not open" if @conn_ptr.null?
+    end
+  end
+end

data/lib/libvirt/domain.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'objspace'
+require 'libvirt/ffi/domain'
+require 'libvirt/util'
+
+module Libvirt
+  class Domain
+    def initialize(dom_ptr, conn)
+      @dom_ptr = dom_ptr
+      @conn = conn
+      ObjectSpace.define_finalizer(self, proc { |obj_id|
+        STDOUT.puts("finalized Libvirt::Domain #{obj_id.to_s(16)}")
+      })
+    end
+
+    def get_state
+      state = ::FFI::MemoryPointer.new(:int)
+      reason = ::FFI::MemoryPointer.new(:int)
+      result = FFI::Domain.virDomainGetState(@dom_ptr, state, reason, 0)
+      raise Error, "Couldn't get domain state" if result < 0
+      [state.read_int, reason.read_int]
+    end
+
+    def to_ptr
+      @dom_ptr
+    end
+  end
+end

data/lib/libvirt/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class Error < StandardError
+  end
+end

data/lib/libvirt/event.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'forwardable'
+require 'libvirt/ffi/event'
+
+module Libvirt
+  class Event
+    include Singleton
+    extend Forwardable
+    extend SingleForwardable
+
+    single_delegate [:register, :unregister, :registered?] => :instance
+
+    Opaque = Struct.new(:cb, :opaque, :ff)
+
+    class << self
+      def invoke_handle_callback(watch, fd, events, opaque)
+        cb = opaque.cb
+        op = opaque.opaque
+        Util.log(:debug) { "Libvirt::Event INVOKE_HANDLE_CALLBACK watch=#{watch} fd=#{fd} events=#{events} op=#{op}" }
+        cb.call(watch, fd, events, op)
+      end
+
+      def invoke_timeout_callback(timer, opaque)
+        cb = opaque.cb
+        op = opaque.opaque
+        Util.log(:debug) { "Libvirt::Event INVOKE_TIMEOUT_CALLBACK timer=#{timer} op=#{op}" }
+        cb.call(timer, op)
+      end
+    end
+
+    def registered?
+      @registered || false
+    end
+
+    def unregister
+      @add_handle_cb = nil
+      @update_handle_cb = nil
+      @remove_handle_cb = nil
+      @add_timer_cb = nil
+      @update_timer_cb = nil
+      @remove_timer_cb = nil
+      @add_handle = nil
+      @update_handle = nil
+      @remove_handle = nil
+      @add_timer = nil
+      @update_timer = nil
+      @remove_timer = nil
+
+      @registered = false
+      true
+    end
+
+    def register(add_handle:, update_handle:, remove_handle:, add_timer:, update_timer:, remove_timer:)
+      @add_handle = add_handle
+      @update_handle = update_handle
+      @remove_handle = remove_handle
+      @add_timer = add_timer
+      @update_timer = update_timer
+      @remove_timer = remove_timer
+
+      @add_handle_cb = FFI::Event.event_add_handle_func(&method(:_add_handle).to_proc)
+      @update_handle_cb = ::FFI::Function.new(:void, [:int, :int], &method(:_update_handle).to_proc)
+      @remove_handle_cb = ::FFI::Function.new(:int, [:int], &method(:_remove_handle).to_proc)
+      @add_timer_cb = FFI::Event.event_add_timeout_func(&method(:_add_timer).to_proc)
+      @update_timer_cb = ::FFI::Function.new(:void, [:int, :int], &method(:_update_timer).to_proc)
+      @remove_timer_cb = ::FFI::Function.new(:int, [:int], &method(:_remove_timer).to_proc)
+
+      FFI::Event.virEventRegisterImpl(
+          @add_handle_cb,
+          @update_handle_cb,
+          @remove_handle_cb,
+          @add_timer_cb,
+          @update_timer_cb,
+          @remove_timer_cb
+      )
+      @registered = true
+    end
+
+    private
+
+    def _add_handle(fd, event, cb, opaque, ff)
+      Util.log(:debug) { "Libvirt::Event ADD_HANDLE fd=#{fd}, #{event}=event, cb=#{cb}, opaque=#{opaque}, ff=#{ff}" }
+      op = Opaque.new(cb, opaque, ff)
+      @add_handle.call(fd, event, op)
+    end
+
+    def _update_handle(watch, event)
+      Util.log(:debug) { "Libvirt::Event UPDATE_HANDLE watch=#{watch}, event=#{event}" }
+      @update_handle.call(watch, event)
+    end
+
+    def _remove_handle(watch)
+      Util.log(:debug) { "Libvirt::Event REMOVE_HANDLE watch=#{watch}" }
+      op = @remove_handle.call(watch)
+      free_func = op.ff
+      opaque = op.opaque
+      free_func.call(opaque) unless free_func.null?
+      0
+    end
+
+    def _add_timer(timeout, cb, opaque, ff)
+      Util.log(:debug) { "Libvirt::Event ADD_TIMER timeout=#{timeout}, cb=#{cb}, opaque=#{opaque}, ff=#{ff}" }
+      op = Opaque.new(cb, opaque, ff)
+      @add_timer.call(timeout, op)
+    end
+
+    def _update_timer(timer, timeout)
+      Util.log(:debug) { "Libvirt::Event UPDATE_TIMER timer=#{timer}, timeout=#{timeout}" }
+      @update_timer.call(timer, timeout)
+    end
+
+    def _remove_timer(timer)
+      Util.log(:debug) { "Libvirt::Event REMOVE_TIMER timer=#{timer}" }
+      op = @remove_timer.call(timer)
+      free_func = op.ff
+      opaque = op.opaque
+      free_func.call(opaque) unless free_func.null?
+      0
+    end
+
+  end
+end

data/lib/libvirt/ffi/common.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module FFI
+    module Common
+      extend ::FFI::Library
+      ffi_lib Util.library_path
+
+      # typedef void (*virFreeCallback)	(
+      #   void * opaque
+      # )
+      FREE_CALLBACK = callback :virFreeCallback, [:pointer], :void
+    end
+  end
+end

data/lib/libvirt/ffi/connection.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'ffi'
+require 'libvirt/util'
+
+module Libvirt
+  module FFI
+    module Connection
+      extend ::FFI::Library
+      ffi_lib Util.library_path
+
+      # virConnectPtr	virConnectOpen (const char * name)
+      attach_function :virConnectOpen, [:string], :pointer
+
+      # int	virConnectGetVersion (virConnectPtr conn, unsigned long *hvVer)
+      attach_function :virConnectGetVersion, [:pointer, :pointer], :int
+
+      # int	virConnectSetKeepAlive (
+      #   virConnectPtr conn,
+      # 	int interval,
+      # 	unsigned int count
+      # )
+      attach_function :virConnectSetKeepAlive, [:pointer, :int, :uint], :int
+    end
+  end
+end

data/lib/libvirt/ffi/domain.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'ffi'
+require 'libvirt/util'
+require 'libvirt/ffi/common'
+
+module Libvirt
+  module FFI
+    module Domain
+      extend ::FFI::Library
+      ffi_lib Util.library_path
+
+      # int	virConnectDomainEventRegisterAny(
+      #   virConnectPtr conn,
+      # 	virDomainPtr dom,
+      # 	int eventID,
+      # 	virConnectDomainEventGenericCallback cb,
+      # 	void * opaque,
+      # 	virFreeCallback freecb
+      # )
+      attach_function :virConnectDomainEventRegisterAny, [
+          :pointer,
+          :pointer,
+          :int,
+          :pointer,
+          :pointer,
+          :pointer
+      ], :int
+
+      # int	virConnectListAllDomains (
+      #   virConnectPtr conn,
+      # 	virDomainPtr **domains,
+      # 	unsigned int flags
+      # )
+      attach_function :virConnectListAllDomains, [:pointer, :pointer, :uint], :int
+
+      # enum virDomainState {
+      #   VIR_DOMAIN_NOSTATE 	= 	0 (0x0)
+      #   no state
+      #   VIR_DOMAIN_RUNNING 	= 	1 (0x1)
+      #   the domain is running
+      #   VIR_DOMAIN_BLOCKED 	= 	2 (0x2)
+      #   the domain is blocked on resource
+      #   VIR_DOMAIN_PAUSED 	= 	3 (0x3)
+      #   the domain is paused by user
+      #   VIR_DOMAIN_SHUTDOWN 	= 	4 (0x4)
+      #   the domain is being shut down
+      #   VIR_DOMAIN_SHUTOFF 	= 	5 (0x5)
+      #   the domain is shut off
+      #   VIR_DOMAIN_CRASHED 	= 	6 (0x6)
+      #   the domain is crashed
+      #   VIR_DOMAIN_PMSUSPENDED 	= 	7 (0x7)
+      #   the domain is suspended by guest power management
+      #   VIR_DOMAIN_LAST 	= 	8 (0x8)
+      # NB: this enum value will increase over time as new events are added to the libvirt API.
+      # It reflects the last state supported by this version of the libvirt API.
+      # }
+      enum :states, [
+          :no_state, 0x0,
+          :running, 0x1,
+          :blocked, 0x2,
+          :paused, 0x3,
+          :shutdown, 0x4,
+          :shutoff, 0x5,
+          :crashed, 0x6,
+          :pm_suspended, 0x7,
+          :last, 0x8
+      ]
+
+      # int	virDomainGetState	(
+      #   virDomainPtr domain,
+      # 	int *state,
+      # 	int *reason,
+      # 	unsigned int flags
+      # )
+      attach_function :virDomainGetState, [:pointer, :pointer, :pointer, :uint], :int
+
+      # typedef int	(*virConnectDomainEventCallback) (
+      #   virConnectPtr conn,
+      # 	virDomainPtr dom,
+      # 	int event,
+      # 	int detail,
+      # 	void * opaque
+      # )
+      def self.domain_event_id_lifecycle_callback(&block)
+        ::FFI::Function.new(:int, [:pointer, :pointer, :int, :int]) do |_conn, dom, event, detail, op|
+          Util.log(:debug) { "DOMAIN_EVENT_CALLBACK LIFECYCLE dom=#{dom}, event=#{event}, detail=#{detail}, op=#{op}" }
+          block.call(dom, event, detail, op)
+          0
+        end
+      end
+
+    end
+  end
+end