libvirt_ffi 0.5.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a2337cfa3a044b561ab70fe277e7fafff9f39919c494edc64e0f24dabce256d
-  data.tar.gz: a2dbb17ebb8eca45d0336293da344f1b6959f5afdbcee394d87ad5c103a9406a
+  metadata.gz: 43c4cf7b7fa510b96605a9f05e8f04680280459d48572085740a71f145ce1442
+  data.tar.gz: a3ca5f72fdeb7de0cc95b440f58c5b894970add2cb746c12e3191d12269dcc42
 SHA512:
-  metadata.gz: 3e1354133c74a9fe27affc1414f2e8a466fd1c97664e3ed365736c7f3c574d9e7e1530bd15af5d229442437e33cfcf4f18d48b8e538af7e62a49975d92d7b591
-  data.tar.gz: 57d42fe97ad18a5827710d63eec68d0681ec1282d97168a71f1ce27263cc69c8f0063c4374543bb8baf0ff707a587080f23530b0fbc1d7ce8f158a46f57f62a4
+  metadata.gz: f1b7448f8ebd67349c59a365d1b30072bf99d5f78ffc1b07c87f99a312365f4d42474e62886c71e797fd0deab4c6f726af6440d6c4bb350fb8a65ee751b68ed5
+  data.tar.gz: 24056f945020275a102517bd6f4fba560be15c0f4fea7725b9c4b9b6032a1e94695b1520094c4027bf4ea0e34291e00148efefbb60d114640980e6c69e9f6cae

data/lib/libvirt.rb

@@ -2,7 +2,7 @@
 
 require 'ffi'
 require 'objspace'
-require 'libvirt/domain_callback_storage'
+require 'libvirt/host_callback_storage'
 require 'libvirt/util'
 require 'libvirt/errors'
 require 'libvirt/ffi'

data/lib/libvirt/connection.rb

@@ -3,19 +3,45 @@
 module Libvirt
   class Connection
     DOMAIN_EVENT_IDS = FFI::Domain.enum_type(:event_id).symbols.dup.freeze
+    POOL_EVENT_IDS = FFI::Storage.enum_type(:event_id).symbols.dup.freeze
 
-    STORAGE = DomainCallbackStorage.new
+    DOMAIN_STORAGE = HostCallbackStorage.new(:domain_event)
+    POOL_STORAGE = HostCallbackStorage.new(:storage_pool_event)
+    CLOSE_STORAGE = HostCallbackStorage.new(:close)
 
     DOMAIN_EVENT_CALLBACKS = DOMAIN_EVENT_IDS.map do |event_id_sym|
       func = FFI::Domain.event_callback_for(event_id_sym) do |conn_ptr, dom_ptr, *args, op_ptr|
+        Util.log(:debug, "DOMAIN_EVENT_CALLBACKS[#{event_id_sym}]") do
+          "inside callback conn_ptr=#{conn_ptr}, pool_ptr=#{dom_ptr}, args=#{args}, op_ptr=#{op_ptr}"
+        end
         connection = Connection.load_ref(conn_ptr)
         domain = Domain.load_ref(dom_ptr)
-        block, opaque = STORAGE.retrieve_from_pointer(op_ptr)
+        block, opaque = DOMAIN_STORAGE.retrieve_from_pointer(op_ptr)
         block.call(connection, domain, *args, opaque)
       end
       [event_id_sym, func]
     end.to_h.freeze
 
+    POOL_EVENT_CALLBACKS = POOL_EVENT_IDS.map do |event_id_sym|
+      func = FFI::Storage.event_callback_for(event_id_sym) do |conn_ptr, pool_ptr, *args, op_ptr|
+        Util.log(:debug, "POOL_EVENT_CALLBACKS[#{event_id_sym}]") do
+          "inside callback conn_ptr=#{conn_ptr}, pool_ptr=#{pool_ptr}, args=#{args}, op_ptr=#{op_ptr}"
+        end
+        connection = Connection.load_ref(conn_ptr)
+        pool = StoragePool.load_ref(pool_ptr)
+        block, opaque = POOL_STORAGE.retrieve_from_pointer(op_ptr)
+        block.call(connection, pool, *args, opaque)
+      end
+      [event_id_sym, func]
+    end.to_h.freeze
+
+    CLOSE_CALLBACK = FFI::Host.callback_function(:virConnectCloseFunc) do |conn_ptr, reason, op_ptr|
+      Util.log(:debug, 'CLOSE_CALLBACK') { "inside callback conn_ptr=#{conn_ptr}, reason=#{reason}, op_ptr=#{op_ptr}" }
+      connection = Connection.load_ref(conn_ptr)
+      block, opaque = CLOSE_STORAGE.retrieve_from_pointer(op_ptr)
+      block.call(connection, reason, opaque)
+    end
+
     def self.load_ref(conn_ptr)
       ref_result = FFI::Host.virConnectRef(conn_ptr)
       raise Errors::LibError, "Couldn't retrieve connection reference" if ref_result.negative?
@@ -136,18 +162,27 @@ module Libvirt
 
     def register_close_callback(opaque = nil, &block)
       dbg { "#register_close_callback opaque=#{opaque}" }
-      raise ArgumentError, 'close function already registered' if @close_data
 
-      @close_data = { opaque: opaque, block: block }
-      @close_cb = FFI::Host.callback_function(:virConnectCloseFunc) do |_conn, reason, _op|
-        dbg { "CONNECTION CLOSED @conn_ptr=#{@conn_ptr} reason=#{reason}" }
-        @close_data[:block].call(self, reason, @close_data[:opaque])
-      end
-      @close_free_func = FFI::Common.free_function do
-        dbg { "CONNECTION CLOSED FREE FUNC @conn_ptr=#{@conn_ptr}" }
-        @close_cb = @close_free_func = @close_data = nil
+      cb_data, cb_data_free_func = CLOSE_STORAGE.allocate_struct
+      result = FFI::Host.virConnectRegisterCloseCallback(
+          @conn_ptr,
+          CLOSE_CALLBACK,
+          cb_data.pointer,
+          cb_data_free_func
+      )
+      if result.negative?
+        cb_data.pointer.free
+        raise Errors::LibError, "Couldn't register connection close callback"
       end
-      FFI::Host.virConnectRegisterCloseCallback(@conn_ptr, @close_cb, nil, @close_free_func)
+
+      CLOSE_STORAGE.store_struct(
+          cb_data,
+          connection_pointer: @conn_ptr,
+          callback_id: result,
+          cb: block,
+          opaque: opaque
+      )
+      result
     end
 
     # @yield conn, dom, *args
@@ -158,7 +193,7 @@ module Libvirt
       event_id, event_id_sym = Util.parse_enum(enum, event_id)
       cb = DOMAIN_EVENT_CALLBACKS.fetch(event_id_sym)
 
-      cb_data, cb_data_free_func = STORAGE.allocate_struct
+      cb_data, cb_data_free_func = DOMAIN_STORAGE.allocate_struct
 
       result = FFI::Domain.virConnectDomainEventRegisterAny(
           @conn_ptr,
@@ -173,7 +208,7 @@ module Libvirt
         raise Errors::LibError, "Couldn't register domain event callback"
       end
 
-      STORAGE.store_struct(
+      DOMAIN_STORAGE.store_struct(
           cb_data,
           connection_pointer: @conn_ptr,
           callback_id: result,
@@ -190,7 +225,61 @@ module Libvirt
       raise Errors::LibError, "Couldn't deregister domain event callback" if result.negative?
 
       # virConnectDomainEventDeregisterAny will call free func
-      # So we don't need to remove object from STORAGE here.
+      # So we don't need to remove object from DOMAIN_STORAGE here.
+      true
+    end
+
+    def register_storage_pool_event_callback(event_id, storage_pool = nil, opaque = nil, &block)
+      dbg { "#register_storage_pool_event_callback event_id=#{event_id}" }
+
+      enum = FFI::Storage.enum_type(:event_id)
+      event_id, event_id_sym = Util.parse_enum(enum, event_id)
+      cb = POOL_EVENT_CALLBACKS.fetch(event_id_sym)
+
+      cb_data, cb_data_free_func = POOL_STORAGE.allocate_struct
+
+      result = FFI::Storage.virConnectStoragePoolEventRegisterAny(
+          @conn_ptr,
+          storage_pool&.to_ptr,
+          event_id,
+          cb,
+          cb_data.pointer,
+          cb_data_free_func
+      )
+      if result.negative?
+        cb_data.pointer.free
+        raise Errors::LibError, "Couldn't register storage pool event callback"
+      end
+
+      POOL_STORAGE.store_struct(
+          cb_data,
+          connection_pointer: @conn_ptr,
+          callback_id: result,
+          cb: block,
+          opaque: opaque
+      )
+      result
+    end
+
+    def deregister_storage_pool_event_callback(callback_id)
+      dbg { "#deregister_storage_pool_event_callback callback_id=#{callback_id}" }
+
+      result = FFI::Storage.virConnectStoragePoolEventDeregisterAny(@conn_ptr, callback_id)
+      raise Errors::LibError, "Couldn't deregister storage pool event callback" if result.negative?
+
+      # virConnectStoragePoolEventDeregisterAny will call free func
+      # So we don't need to remove object from POOL_STORAGE here.
+      true
+    end
+
+    def deregister_close_callback
+      dbg { '#deregister_close_callback' }
+
+      result = FFI::Host.virConnectUnregisterCloseCallback(@conn_ptr, CLOSE_CALLBACK)
+      raise Errors::LibError, "Couldn't deregister close callback" if result.negative?
+
+      # virConnectUnregisterCloseCallback will call free func
+      # So we don't need to remove object from CLOSE_STORAGE here.
       true
     end
 

data/lib/libvirt/domain.rb

@@ -38,7 +38,7 @@ module Libvirt
     end
 
     def uuid
-      buff = ::FFI::MemoryPointer.new(:char, FFI::Domain::UUID_STRING_BUFLEN)
+      buff = ::FFI::MemoryPointer.new(:char, Util::UUID_STRING_BUFLEN)
       result = FFI::Domain.virDomainGetUUIDString(@dom_ptr, buff)
       raise Errors::LibError, "Couldn't get domain uuid" if result.negative?
 
@@ -46,7 +46,10 @@ module Libvirt
     end
 
     def name
-      FFI::Domain.virDomainGetName(@dom_ptr)
+      result = FFI::Domain.virDomainGetName(@dom_ptr)
+      raise Errors::LibError, "Couldn't retrieve storage pool name" if result.nil?
+
+      result
     end
 
     def max_vcpus
@@ -179,6 +182,13 @@ module Libvirt
       result
     end
 
+    def persistent?
+      result = FFI::Domain.virDomainIsPersistent(@dom_ptr)
+      raise Errors::LibError, "Couldn't set domain metadata" if result.negative?
+
+      result == 1
+    end
+
     private
 
     def dbg(&block)

data/lib/libvirt/ffi/domain.rb

@@ -9,8 +9,6 @@ module Libvirt
       extend Helpers
       ffi_lib Util.library_path
 
-      UUID_STRING_BUFLEN = 0x80 # RFC4122
-
       EVENT_ID_TO_CALLBACK = {
           LIFECYCLE: :virConnectDomainEventCallback,
           REBOOT: :virConnectDomainEventGenericCallback,
@@ -798,6 +796,11 @@ module Libvirt
                       [:pointer, :metadata_type, :string, :modification_impact],
                       :string
 
+      # int virDomainIsPersistent (
+      #   virDomainPtr dom
+      # )
+      attach_function :virDomainIsPersistent, [:pointer], :int
+
       # Converts detail from lifecycle callback from integer to symbol name.
       # @param event [Symbol] enum :event_type (virDomainEventType)
       # @param detail [Integer]
@@ -807,6 +810,10 @@ module Libvirt
         detail_enum[detail]
       end
 
+      # Converts state reason of domain from integer to symbol name.
+      # @param state [Symbol] enum :state (virDomainState)
+      # @param reason [Integer]
+      # @return [Symbol]
       def self.state_reason(state, reason)
         reason_enum = enum_type(:"#{state.to_s.downcase}_reason")
         reason_enum[reason]

data/lib/libvirt/ffi/host.rb

@@ -31,6 +31,14 @@ module Libvirt
                :threads, :uint
       end
 
+      # enum virConnectCloseReason
+      enum :close_reason, [
+        :ERROR, 0x0, # Misc I/O error
+        :EOF, 0x1, # End-of-file from server
+        :KEEPALIVE, 0x2, # Keepalive timer triggered
+        :CLIENT, 0x3 # Client requested it
+      ]
+
       # int  virGetVersion  (
       #   unsigned long *libVer,
       #   const char *type,
@@ -49,7 +57,7 @@ module Libvirt
       #   int reason,
       #   void * opaque
       # )
-      callback :virConnectCloseFunc, [:pointer, :int, :pointer], :void
+      callback :virConnectCloseFunc, [:pointer, :close_reason, :pointer], :void
 
       # virConnectPtr  virConnectOpen (const char * name)
       attach_function :virConnectOpen, [:string], :pointer
@@ -121,7 +129,7 @@ module Libvirt
       # unsigned long long virNodeGetFreeMemory (
       #   virConnectPtr conn
       # )
-      attach_function :virNodeGetFreeMemory, [:pointer], :u_long_long
+      attach_function :virNodeGetFreeMemory, [:pointer], :ulong_long
     end
   end
 end

data/lib/libvirt/ffi/storage.rb

@@ -9,6 +9,11 @@ module Libvirt
       extend Helpers
       ffi_lib Util.library_path
 
+      EVENT_ID_TO_CALLBACK = {
+          LIFECYCLE: :virConnectStoragePoolEventLifecycleCallback,
+          REFRESH: :virConnectStoragePoolEventGenericCallback
+      }.freeze
+
       # enum virStoragePoolState
       enum :pool_state, [
           :INACTIVE, 0x0, # Not running
@@ -63,6 +68,23 @@ module Libvirt
           :INACTIVE, 0x1 # dump inactive pool/volume information
       ]
 
+      # enum virStoragePoolEventID
+      enum :event_id, [
+          :LIFECYCLE, 0x0, # virConnectStoragePoolEventLifecycleCallback
+          :REFRESH, 0x1 # virConnectStoragePoolEventGenericCallback
+      ]
+
+      # enum virStoragePoolEventLifecycleType
+      enum :event_lifecycle_type, [
+          :DEFINED, 0x0,
+          :UNDEFINED, 0x1,
+          :STARTED, 0x2,
+          :STOPPED, 0x3,
+          :CREATED, 0x4,
+          :DELETED, 0x5,
+          :LAST, 0x6
+      ]
+
       # struct virStoragePoolInfo {
       #   int   state #   virStoragePoolState flags
       #   unsigned long long   capacity #   Logical size bytes
@@ -87,6 +109,26 @@ module Libvirt
                :allocation, :ulong_long
       end
 
+      # typedef void (*virConnectStoragePoolEventGenericCallback) (
+      #   virConnectPtr conn,
+      #   virStoragePoolPtr pool,
+      #   void * opaque
+      # )
+      callback :virConnectStoragePoolEventGenericCallback,
+               [:pointer, :pointer, :pointer],
+               :void
+
+      # typedef void (*virConnectStoragePoolEventLifecycleCallback) (
+      #   virConnectPtr conn,
+      #   virStoragePoolPtr pool,
+      #   int event,
+      #   int detail,
+      #   void * opaque
+      # )
+      callback :virConnectStoragePoolEventLifecycleCallback,
+               [:pointer, :pointer, :event_lifecycle_type, :int, :pointer],
+               :void
+
       # int  virConnectListAllStoragePools (
       #   virConnectPtr conn,
       #   virStoragePoolPtr ** pools,
@@ -144,6 +186,49 @@ module Libvirt
       #   unsigned int flags
       # )
       attach_function :virStorageVolGetXMLDesc, [:pointer, :xml_flags], :string
+
+      # int  virConnectStoragePoolEventRegisterAny (
+      #   virConnectPtr conn,
+      #   virStoragePoolPtr pool,
+      #   int eventID,
+      #   virConnectStoragePoolEventGenericCallback cb,
+      #   void * opaque,
+      #   virFreeCallback freecb
+      # )
+      attach_function :virConnectStoragePoolEventRegisterAny,
+                      [:pointer, :pointer, :event_id, :pointer, :pointer, FFI::Common::FREE_CALLBACK],
+                      :int
+
+      # int  virConnectStoragePoolEventDeregisterAny (
+      #   virConnectPtr conn,
+      #   int callbackID
+      # )
+      attach_function :virConnectStoragePoolEventDeregisterAny,
+                      [:pointer, :int],
+                      :int
+
+      # int  virStoragePoolGetUUIDString  (virStoragePoolPtr pool,
+      #            char * buf)
+      attach_function :virStoragePoolGetUUIDString, [:pointer, :pointer], :int
+
+      # const char *  virStoragePoolGetName  (virStoragePoolPtr pool)
+      attach_function :virStoragePoolGetName, [:pointer], :string
+
+      module_function
+
+      # Creates event callback function for provided event_id
+      # @param event_id [Integer,Symbol]
+      # @yield connect_ptr, domain_ptr, *args, opaque_ptr
+      # @return [FFI::Function]
+      def event_callback_for(event_id, &block)
+        event_id_sym = event_id.is_a?(Symbol) ? event_id : enum_type(:event_id)[event_id]
+
+        callback_name = EVENT_ID_TO_CALLBACK.fetch(event_id_sym)
+        callback_function(callback_name) do |*args|
+          Util.log(:debug, name) { ".event_callback_for #{event_id_sym} CALLBACK #{args.map(&:to_s).join(', ')}," }
+          block.call(*args)
+        end
+      end
     end
   end
 end

data/lib/libvirt/{domain_callback_storage.rb → host_callback_storage.rb}

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
 
 module Libvirt
-  class DomainCallbackStorage
+  class HostCallbackStorage
     class CallbackDataStruct < ::FFI::Struct
       layout :connection_pointer, :pointer,
              :callback_id, :int
     end
 
-    def initialize
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
       @inner_storage = Hash.new { |h, key| h[key] = {} }
     end
 
     # @return [Array<2>]
-    #   cb_data [Libvirt::DomainCallbackStorage::CallbackDataStruct],
+    #   cb_data [Libvirt::HostCallbackStorage::CallbackDataStruct],
     #   cb_data_free_func [FFI::Function]
     def allocate_struct
       dbg { '#allocate_struct' }
@@ -20,7 +23,7 @@ module Libvirt
       cb_data_ptr = ::FFI::MemoryPointer.new(:char, CallbackDataStruct.size, false)
       cb_data = CallbackDataStruct.new(cb_data_ptr)
       cb_data_free_func = FFI::Common.free_function do |pointer|
-        dbg { 'Libvirt::DomainCallbackStorage cb_data_free_func triggered' }
+        dbg { "cb_data_free_func triggered pointer=#{pointer}" }
         remove_struct(pointer)
       end
       [cb_data, cb_data_free_func]
@@ -35,7 +38,7 @@ module Libvirt
     end
 
     def remove_struct(pointer)
-      dbg { "#remove_struct pointer=#{pointer}" }
+      dbg { "#remove_struct pointer=#{pointer}," }
 
       cb_data_struct = CallbackDataStruct.new(pointer)
       connection_pointer = cb_data_struct[:connection_pointer]
@@ -63,7 +66,7 @@ module Libvirt
     private
 
     def dbg(&block)
-      Util.log(:debug, 'Libvirt::DomainCallbackStorage', &block)
+      Util.log(:debug, "Libvirt::HostCallbackStorage(#{name})", &block)
     end
   end
 end

data/lib/libvirt/storage_pool.rb

@@ -61,6 +61,21 @@ module Libvirt
       ptr.get_array_of_pointer(0, size).map { |stv_ptr| StorageVolume.new(stv_ptr) }
     end
 
+    def uuid
+      buff = ::FFI::MemoryPointer.new(:char, Util::UUID_STRING_BUFLEN)
+      result = FFI::Storage.virStoragePoolGetUUIDString(@ptr, buff)
+      raise Errors::LibError, "Couldn't get storage pool uuid" if result.negative?
+
+      buff.read_string
+    end
+
+    def name
+      result = FFI::Storage.virStoragePoolGetName(@ptr)
+      raise Errors::LibError, "Couldn't retrieve storage pool name" if result.nil?
+
+      result
+    end
+
     private
 
     def dbg(&block)

data/lib/libvirt/util.rb

@@ -19,6 +19,8 @@ module Libvirt
         TiB: 1_099_511_627_776
     }.freeze
 
+    UUID_STRING_BUFLEN = 0x80 # RFC4122
+
     class << self
       attr_writer :logger
 

data/lib/libvirt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Libvirt
-  VERSION = '0.5.3'
+  VERSION = '0.6.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libvirt_ffi
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Denis Talakevich
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-23 00:00:00.000000000 Z
+date: 2020-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -61,7 +61,6 @@ files:
 - lib/libvirt/base_info.rb
 - lib/libvirt/connection.rb
 - lib/libvirt/domain.rb
-- lib/libvirt/domain_callback_storage.rb
 - lib/libvirt/errors.rb
 - lib/libvirt/event.rb
 - lib/libvirt/ffi.rb
@@ -73,6 +72,7 @@ files:
 - lib/libvirt/ffi/host.rb
 - lib/libvirt/ffi/storage.rb
 - lib/libvirt/ffi/stream.rb
+- lib/libvirt/host_callback_storage.rb
 - lib/libvirt/node_info.rb
 - lib/libvirt/storage_pool.rb
 - lib/libvirt/storage_pool_info.rb