libvirt_ffi 0.5.6 → 0.8.0

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,22 +23,30 @@ 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]
     end
 
-    def store_struct(cb_data, connection_pointer:, callback_id:, cb:, opaque:)
+    def store_struct(cb_data, options)
       dbg { '#store_struct' }
 
+      options.assert_valid_keys(:connection_pointer, :callback_id, :cb, :opaque, :free_func)
+      connection_pointer = options.fetch(:connection_pointer)
+      callback_id = options.fetch(:callback_id)
+      cb = options.fetch(:cb)
+      opaque = options.fetch(:opaque)
+      free_func = options.fetch(:free_func)
       cb_data[:connection_pointer] = connection_pointer
       cb_data[:callback_id] = callback_id
-      @inner_storage[connection_pointer.address][callback_id] = { cb: cb, opaque: opaque, pointer: cb_data.pointer }
+      @inner_storage[connection_pointer.address][callback_id] = {
+          cb: cb, opaque: opaque, pointer: cb_data.pointer, free_func: free_func
+      }
     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 +74,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/interface.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class Interface
+    # @param pointer [FFI::Pointer]
+    def self.load_ref(pointer)
+      result = FFI::Interface.virInterfaceRef(pointer)
+      raise Errors::LibError, "Couldn't retrieve interface reference" if result.negative?
+
+      new(pointer)
+    end
+
+    # @param pointer [FFI::Pointer]
+    def initialize(pointer)
+      @ptr = pointer
+
+      free = ->(obj_id) do
+        dbg { "Finalize Libvirt::Interface object_id=0x#{obj_id.to_s(16)}, pointer=0x#{@ptr.address.to_s(16)}" }
+        return unless @ptr
+
+        warn "Couldn't free Libvirt::Interface object_id=0x#{obj_id.to_s(16)}, pointer=0x#{@ptr.address.to_s(16)}" if FFI::Interface.virInterfaceFree(@ptr).negative?
+      end
+      ObjectSpace.define_finalizer(self, free)
+    end
+
+    # @return [FFI::Pointer]
+    def to_ptr
+      @ptr
+    end
+
+    # @return [String]
+    # @raise [Libvirt::Errors::LibError]
+    def name
+      result = FFI::Interface.virInterfaceGetName(@ptr)
+      raise Errors::LibError, "Couldn't get interface name" if result.nil?
+
+      result
+    end
+
+    # @return [String]
+    # @raise [Libvirt::Errors::LibError]
+    def mac
+      result = FFI::Interface.virInterfaceGetMACString(@ptr)
+      raise Errors::LibError, "Couldn't get interface mac" if result.nil?
+
+      result
+    end
+
+    # @param options_or_flags [Array<Symbol>,Hash{Symbol=>Boolean},Integer,Symbol,nil]
+    # @raise [Libvirt::Errors::LibError]
+    def xml_desc(options_or_flags = nil)
+      flags = Util.parse_flags options_or_flags, FFI::Interface.enum_type(:xml_flags)
+      result = FFI::Interface.virInterfaceGetXMLDesc(@ptr, flags)
+      raise Errors::LibError, "Couldn't get interface xml desc" if result.nil?
+
+      result
+    end
+
+    # @return [Boolean]
+    # @raise [Libvirt::Errors::LibError]
+    def active?
+      result = FFI::Interface.virInterfaceIsActive(@ptr)
+      raise Errors::LibError, "Couldn't get interface is active" if result.nil?
+
+      result == 1
+    end
+
+    # @raise [Libvirt::Errors::LibError]
+    def start
+      result = FFI::Interface.virInterfaceCreate(@ptr, 0)
+      raise Errors::LibError, "Couldn't start interface" if result.negative?
+    end
+
+    # @raise [Libvirt::Errors::LibError]
+    def destroy
+      result = FFI::Interface.virInterfaceDestroy(@ptr, 0)
+      raise Errors::LibError, "Couldn't destroy interface" if result.negative?
+    end
+
+    # @raise [Libvirt::Errors::LibError]
+    def undefine
+      result = FFI::Interface.virInterfaceUndefine(@ptr)
+      raise Errors::LibError, "Couldn't undefine interface" if result.negative?
+    end
+
+    private
+
+    def dbg(&block)
+      Util.log(:debug, 'Libvirt::Network', &block)
+    end
+  end
+end

data/lib/libvirt/network.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class Network
+    # @param pointer [FFI::Pointer]
+    def self.load_ref(pointer)
+      result = FFI::Network.virNetworkRef(pointer)
+      raise Errors::LibError, "Couldn't retrieve network reference" if result.negative?
+
+      new(pointer)
+    end
+
+    # @param pointer [FFI::Pointer]
+    def initialize(pointer)
+      @ptr = pointer
+
+      free = ->(obj_id) do
+        dbg { "Finalize Libvirt::Network object_id=0x#{obj_id.to_s(16)}, pointer=0x#{@ptr.address.to_s(16)}" }
+        return unless @ptr
+
+        warn "Couldn't free Libvirt::Network object_id=0x#{obj_id.to_s(16)}, pointer=0x#{@ptr.address.to_s(16)}" if FFI::Network.virNetworkFree(@ptr).negative?
+      end
+      ObjectSpace.define_finalizer(self, free)
+    end
+
+    # @return [FFI::Pointer]
+    def to_ptr
+      @ptr
+    end
+
+    # @return [String]
+    # @raise [Libvirt::Errors::LibError]
+    def uuid
+      buff = ::FFI::MemoryPointer.new(:char, Util::UUID_STRING_BUFLEN)
+      result = FFI::Network.virNetworkGetUUIDString(@ptr, buff)
+      raise Errors::LibError, "Couldn't get network uuid" if result.negative?
+
+      buff.read_string
+    end
+
+    # @return [String]
+    # @raise [Libvirt::Errors::LibError]
+    def name
+      result = FFI::Network.virNetworkGetName(@ptr)
+      raise Errors::LibError, "Couldn't get network name" if result.nil?
+
+      result
+    end
+
+    # @param options_or_flags [Array<Symbol>,Hash{Symbol=>Boolean},Integer,Symbol,nil]
+    # @raise [Libvirt::Errors::LibError]
+    def xml_desc(options_or_flags = nil)
+      flags = Util.parse_flags options_or_flags, FFI::Network.enum_type(:xml_flags)
+      result = FFI::Network.virNetworkGetXMLDesc(@ptr, flags)
+      raise Errors::LibError, "Couldn't get network xml_desc" if result.nil?
+
+      result
+    end
+
+    # @return [Boolean]
+    # @raise [Libvirt::Errors::LibError]
+    def active?
+      result = FFI::Network.virNetworkIsActive(@ptr)
+      raise Errors::LibError, "Couldn't get network is active" if result.nil?
+
+      result == 1
+    end
+
+    # @return [Boolean]
+    # @raise [Libvirt::Errors::LibError]
+    def persistent?
+      result = FFI::Network.virNetworkIsPersistent(@ptr)
+      raise Errors::LibError, "Couldn't get network is persistent" if result.nil?
+
+      result == 1
+    end
+
+    # @return [String]
+    # @raise [Libvirt::Errors::LibError]
+    def bridge_name
+      result = FFI::Network.virNetworkGetBridgeName(@ptr)
+      raise Errors::LibError, "Couldn't get network bridge_name" if result.nil?
+
+      result
+    end
+
+    # @return [Boolean]
+    # @raise [Libvirt::Errors::LibError]
+    def auto_start?
+      value = ::FFI::MemoryPointer.new(:int)
+      result = FFI::Network.virNetworkGetAutostart(@ptr, value)
+      raise Errors::LibError, "Couldn't get network auto_start" if result.negative?
+
+      value.read_int == 1
+    end
+
+    # @param value [Boolean]
+    # @raise [Libvirt::Errors::LibError]
+    def set_auto_start(value)
+      value = value ? 1 : 0
+      result = FFI::Network.virNetworkSetAutostart(@ptr, value)
+      raise Errors::LibError, "Couldn't set network auto_start" if result.negative?
+    end
+
+    # @param mac [String]
+    # @return [Integer]
+    # @raise [Libvirt::Errors::LibError]
+    def dhcp_leases_qty(mac = nil)
+      result = FFI::Network.virNetworkGetDHCPLeases(@ptr, mac, nil, 0)
+      raise Errors::LibError, "Couldn't get network dhcp leases qty" if result.nil?
+
+      result
+    end
+
+    # @param mac [String]
+    # @return [Array<Libvirt::NetworkDhcpLease>, Array]
+    # @raise [Libvirt::Errors::LibError]
+    def dhcp_leases(mac = nil)
+      size = dhcp_leases_qty(mac)
+      return [] if size.zero?
+
+      dhcp_leases_ptr = ::FFI::MemoryPointer.new(:pointer, size)
+      result = FFI::Network.virNetworkGetDHCPLeases(@ptr, mac, dhcp_leases_ptr, 0)
+      raise Errors::LibError, "Couldn't retrieve network dhcp leases" if result.negative?
+
+      ptr = dhcp_leases_ptr.read_pointer
+      ptr.get_array_of_pointer(0, size).map { |dhcpl_ptr| NetworkDhcpLease.new(dhcpl_ptr) }
+    end
+
+    # @raise [Libvirt::Errors::LibError]
+    def start
+      result = FFI::Network.virNetworkCreate(@ptr)
+      raise Errors::LibError, "Couldn't start network" if result.negative?
+    end
+
+    # @raise [Libvirt::Errors::LibError]
+    def destroy
+      result = FFI::Network.virNetworkDestroy(@ptr)
+      raise Errors::LibError, "Couldn't destroy network" if result.negative?
+    end
+
+    # @raise [Libvirt::Errors::LibError]
+    def undefine
+      result = FFI::Network.virNetworkUndefine(@ptr)
+      raise Errors::LibError, "Couldn't undefine network" if result.negative?
+    end
+
+    # @param xml [String]
+    # @param command [Integer, Symbol]
+    # @param section [Integer, Symbol]
+    # @param flags [Integer, Symbol]
+    # @param parent_index [Integer] default -1 (means don't care)
+    # @raise [Libvirt::Errors::LibError]
+    def update(xml, command, section, flags, parent_index = -1)
+      command = Util.parse_flags command, FFI::Network.enum_type(:update_command)
+      section = Util.parse_flags section, FFI::Network.enum_type(:update_section)
+      flags = Util.parse_flags flags, FFI::Network.enum_type(:update_flags)
+
+      result = FFI::Network.virNetworkUpdate(
+          @ptr,
+          command,
+          section,
+          parent_index,
+          xml,
+          flags
+      )
+      raise Errors::LibError, "Couldn't update network" if result.negative?
+    end
+
+    private
+
+    def dbg(&block)
+      Util.log(:debug, 'Libvirt::Network', &block)
+    end
+  end
+end

data/lib/libvirt/network_dhcp_lease.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class NetworkDhcpLease < BaseInfo
+    struct_class FFI::Network::DhcpLeaseStruct
+
+    # @param pointer [FFI::Pointer]
+    def initialize(pointer)
+      super
+
+      free = ->(obj_id) do
+        dbg { "Finalize Libvirt::NetworkDhcpLease object_id=0x#{obj_id.to_s(16)}, pointer=0x#{@ptr.address.to_s(16)}" }
+        return unless @ptr
+
+        warn "Couldn't free Libvirt::NetworkDhcpLease object_id=0x#{obj_id.to_s(16)}, pointer=0x#{@ptr.address.to_s(16)}" if FFI::Storage.virNetworkDHCPLeaseFree(@ptr).negative?
+      end
+      ObjectSpace.define_finalizer(self, free)
+    end
+  end
+end

data/lib/libvirt/storage_pool.rb

@@ -13,7 +13,7 @@ module Libvirt
       @ptr = pointer
 
       free = ->(obj_id) do
-        Util.log(:debug) { "Finalize Libvirt::StoragePool 0x#{obj_id.to_s(16)} @ptr=#{@ptr}," }
+        dbg { "Finalize Libvirt::StoragePool 0x#{obj_id.to_s(16)} @ptr=#{@ptr}," }
         return unless @ptr
 
         fr_result = FFI::Storage.virStoragePoolFree(@ptr)
@@ -61,10 +61,25 @@ 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)
-      Util.log(:debug, 'Libvirt::Domain', &block)
+      Util.log(:debug, 'Libvirt::StoragePool', &block)
     end
   end
 end

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.6'
+  VERSION = '0.8.0'
 end

data/lib/libvirt/xml.rb

@@ -13,6 +13,9 @@ module Libvirt
     require 'libvirt/xml/generic'
     require 'libvirt/xml/storage_pool'
     require 'libvirt/xml/storage_volume'
+    require 'libvirt/xml/interface'
+    require 'libvirt/xml/ip_address'
+    require 'libvirt/xml/network'
     require 'libvirt/xml/memory'
     require 'libvirt/xml/graphics'
     require 'libvirt/xml/disk'

data/lib/libvirt/xml/generic.rb

@@ -3,6 +3,9 @@
 module Libvirt
   module Xml
     class Generic
+      TRUE_VALUES = %w[yes on].freeze
+      FALSE_VALUES = %w[no off].freeze
+
       class_attribute :_root_path, instance_writer: false, default: '.'
       class_attribute :_attributes_opts, instance_writer: false, default: {}
 
@@ -111,7 +114,7 @@ module Libvirt
       # @param opts [Hash{Symbol=>Object}]
       # @return [Object, nil]
       def decode(value, opts)
-        return if value.nil?
+        return opts[:default] if value.nil?
 
         cast = opts[:cast]
         return value if cast.nil?
@@ -144,9 +147,9 @@ module Libvirt
       def decode_bool(value, _opts)
         return value if value.is_a?(TrueClass) || value.is_a?(FalseClass)
 
-        return true if value == 'yes'
+        return true if TRUE_VALUES.include?(value)
 
-        return false if value == 'no'
+        return false if FALSE_VALUES.include?(value)
 
         nil
       end