libvirt_ffi 0.4.1 → 0.5.0

data/lib/libvirt/ffi/stream.rb

@@ -3,28 +3,31 @@
 module Libvirt
   module FFI
     module Stream
+      # https://libvirt.org/html/libvirt-libvirt-stream.html
+
       extend ::FFI::Library
+      extend Helpers
       ffi_lib Util.library_path
 
       # virStreamPtr virStreamNew (
       #   virConnectPtr conn,
-      # 	unsigned int flags
+      #   unsigned int flags
       # )
       attach_function :virStreamNew, [:pointer, :uint], :pointer
 
       # typedef void (*virStreamEventCallback) (
       #   virStreamPtr stream,
-      # 	int events,
-      # 	void * opaque
+      #   int events,
+      #   void * opaque
       # )
       callback :virStreamEventCallback, [:pointer, :int, :pointer], :void
 
-      # int	virStreamEventAddCallback	(
+      # int  virStreamEventAddCallback  (
       #   virStreamPtr stream,
-      # 	int events,
-      # 	virStreamEventCallback cb,
-      # 	void * opaque,
-      # 	virFreeCallback ff
+      #   int events,
+      #   virStreamEventCallback cb,
+      #   void * opaque,
+      #   virFreeCallback ff
       # )
       attach_function :virStreamEventAddCallback, [
           :pointer,
@@ -34,39 +37,38 @@ module Libvirt
           FFI::Common::FREE_CALLBACK
       ], :int
 
-      # int	virStreamEventRemoveCallback (
+      # int  virStreamEventRemoveCallback (
       #   virStreamPtr stream
       # )
       attach_function :virStreamEventRemoveCallback, [:pointer], :int
 
-      # int	virStreamEventUpdateCallback (
+      # int  virStreamEventUpdateCallback (
       #   virStreamPtr stream,
       #   int events
       # )
       attach_function :virStreamEventUpdateCallback, [:pointer, :int], :int
 
-      # int	virStreamFinish	(
+      # int  virStreamFinish  (
       #   virStreamPtr stream
       # )
       attach_function :virStreamFinish, [:pointer], :int
 
-      # int	virStreamFree	(
+      # int  virStreamFree  (
       #   virStreamPtr stream
       # )
       attach_function :virStreamFree, [:pointer], :int
 
-      # int	virStreamAbort (
+      # int  virStreamAbort (
       #   virStreamPtr stream
       # )
       attach_function :virStreamAbort, [:pointer], :int
 
-      # int	virStreamRecv (
+      # int  virStreamRecv (
       #   virStreamPtr stream,
-      # 	char *data,
-      # 	size_t nbytes
+      #   char *data,
+      #   size_t nbytes
       # )
       attach_function :virStreamRecv, [:pointer, :pointer, :size_t], :int
-
     end
   end
 end

data/lib/libvirt/ffi.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module FFI
+    # https://libvirt.org/html/index.html
+    # namespace for libvirt C bindings
+
+    require 'libvirt/ffi/helpers'
+    require 'libvirt/ffi/common'
+    require 'libvirt/ffi/error'
+    require 'libvirt/ffi/host'
+    require 'libvirt/ffi/domain'
+    require 'libvirt/ffi/event'
+    require 'libvirt/ffi/stream'
+    require 'libvirt/ffi/storage'
+  end
+end

data/lib/libvirt/node_info.rb

@@ -1,46 +1,7 @@
 # frozen_string_literal: true
 
 module Libvirt
-  class NodeInfo
-    def initialize(node_info_ptr)
-      @node_info_ptr = node_info_ptr
-      @node_info_struct = FFI::NodeInfo::Struct.new(node_info_ptr)
-    end
-
-    def [](attr)
-      @node_info_struct[attr]
-    end
-
-    def model
-      @node_info_struct[:model].to_s
-    end
-
-    def cpus
-      @node_info_struct[:cpus]
-    end
-
-    def mhz
-      @node_info_struct[:mhz]
-    end
-
-    def nodes
-      @node_info_struct[:nodes]
-    end
-
-    def sockets
-      @node_info_struct[:sockets]
-    end
-
-    def cores
-      @node_info_struct[:cores]
-    end
-
-    def threads
-      @node_info_struct[:threads]
-    end
-
-    def memory
-      @node_info_struct[:memory]
-    end
+  class NodeInfo < BaseInfo
+    struct_class FFI::Host::NodeInfoStruct
   end
 end

data/lib/libvirt/storage_pool.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class StoragePool
+    def self.load_ref(pointer)
+      result = FFI::Storage.virStoragePoolRef(pointer)
+      raise Errors::LibError, "Couldn't retrieve storage pool reference" if result.negative?
+
+      new(pointer)
+    end
+
+    def initialize(pointer)
+      @ptr = pointer
+
+      free = ->(obj_id) do
+        Util.log(:debug) { "Finalize Libvirt::StoragePool 0x#{obj_id.to_s(16)} @ptr=#{@ptr}," }
+        return unless @ptr
+
+        fr_result = FFI::Storage.virStoragePoolFree(@ptr)
+        warn "Couldn't free Libvirt::StoragePool (0x#{obj_id.to_s(16)}) pointer #{@ptr.address}" if fr_result.negative?
+      end
+      ObjectSpace.define_finalizer(self, free)
+    end
+
+    def to_ptr
+      @ptr
+    end
+
+    def info
+      info_ptr = ::FFI::MemoryPointer.new(FFI::Storage::PoolInfoStruct.by_value)
+      result = FFI::Storage.virStoragePoolGetInfo(@ptr, info_ptr)
+      raise Errors::LibError, "Couldn't get storage pool info" if result.negative?
+
+      StoragePoolInfo.new(info_ptr)
+    end
+
+    def xml_desc(options_or_flags = nil)
+      flags = Util.parse_flags options_or_flags, FFI::Storage.enum_type(:xml_flags)
+      result = FFI::Storage.virStoragePoolGetXMLDesc(@ptr, flags)
+      raise Errors::LibError, "Couldn't get storage pool xml desc" if result.nil?
+
+      result
+    end
+
+    def list_all_volumes_qty
+      result = FFI::Storage.virStoragePoolListAllVolumes(@ptr, nil, 0)
+      raise Errors::LibError, "Couldn't retrieve volumes qty" if result.negative?
+
+      result
+    end
+
+    def list_all_volumes
+      size = list_all_volumes_qty
+      return [] if size.zero?
+
+      storage_volumes_ptr = ::FFI::MemoryPointer.new(:pointer, size)
+      result = FFI::Storage.virStoragePoolListAllVolumes(@ptr, storage_volumes_ptr, 0)
+      raise Errors::LibError, "Couldn't retrieve volumes list" if result.negative?
+
+      ptr = storage_volumes_ptr.read_pointer
+      ptr.get_array_of_pointer(0, size).map { |stv_ptr| StorageVolume.new(stv_ptr) }
+    end
+
+    private
+
+    def dbg(&block)
+      Util.log(:debug, 'Libvirt::Domain', &block)
+    end
+  end
+end

data/lib/libvirt/storage_pool_info.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class StoragePoolInfo < BaseInfo
+    struct_class FFI::Storage::PoolInfoStruct
+  end
+end

data/lib/libvirt/storage_volume.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class StorageVolume
+    def self.load_ref(pointer)
+      result = FFI::Storage.virStorageVolRef(pointer)
+      raise Errors::LibError, "Couldn't retrieve storage volume reference" if result.negative?
+
+      new(pointer)
+    end
+
+    def initialize(pointer)
+      @ptr = pointer
+
+      free = ->(obj_id) do
+        Util.log(:debug) { "Finalize Libvirt::StorageVolume 0x#{obj_id.to_s(16)} @ptr=#{@ptr}," }
+        return unless @ptr
+
+        fr_result = FFI::Storage.virStorageVolFree(@ptr)
+        warn "Couldn't free Libvirt::StorageVolume (0x#{obj_id.to_s(16)}) pointer #{@ptr.address}" if fr_result.negative?
+      end
+      ObjectSpace.define_finalizer(self, free)
+    end
+
+    def to_ptr
+      @ptr
+    end
+
+    def info
+      info_ptr = ::FFI::MemoryPointer.new(FFI::Storage::VolumeInfoStruct.by_value)
+      result = FFI::Storage.virStorageVolGetInfo(@ptr, info_ptr)
+      raise Errors::LibError, "Couldn't get storage volume info" if result.negative?
+
+      StorageVolumeInfo.new(info_ptr)
+    end
+
+    def xml_desc(options_or_flags = nil)
+      flags = Util.parse_flags options_or_flags, FFI::Storage.enum_type(:xml_flags)
+      result = FFI::Storage.virStorageVolGetXMLDesc(@ptr, flags)
+      raise Errors::LibError, "Couldn't get storage volume xml desc" if result.nil?
+
+      result
+    end
+
+    private
+
+    def dbg(&block)
+      Util.log(:debug, 'Libvirt::Domain', &block)
+    end
+  end
+end

data/lib/libvirt/storage_volume_info.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Libvirt
+  class StorageVolumeInfo < BaseInfo
+    struct_class FFI::Storage::VolumeInfoStruct
+  end
+end

data/lib/libvirt/stream.rb

@@ -12,15 +12,17 @@ module Libvirt
       @opaque = nil
 
       free = ->(obj_id) do
+        Util.log(:debug) { "Finalize Libvirt::Stream 0x#{obj_id.to_s(16)} @stream_ptr=#{@stream_ptr}, @cb=#{@cb}, @opaque=#{@opaque}," }
         return unless @stream_ptr
+
         if @cb
           rcb_result = FFI::Stream.virStreamEventRemoveCallback(@stream_ptr)
-          STDERR.puts("Couldn't remove callback Libvirt::Stream (0x#{obj_id.to_s(16)}) pointer #{@stream_ptr.address}") if rcb_result < 0
+          warn("Couldn't remove callback Libvirt::Stream (0x#{obj_id.to_s(16)}) pointer #{@stream_ptr.address}") if rcb_result.negative?
           ab_result = FFI::Stream.virStreamAbort(@stream_ptr)
-          STDERR.puts("Couldn't abort Libvirt::Stream (0x#{obj_id.to_s(16)}) pointer #{@stream_ptr.address}") if ab_result < 0
+          warn("Couldn't abort Libvirt::Stream (0x#{obj_id.to_s(16)}) pointer #{@stream_ptr.address}") if ab_result.negative?
         end
         fr_result = FFI::Stream.virStreamFree(@stream_ptr)
-        STDERR.puts("Couldn't free Libvirt::Stream (0x#{obj_id.to_s(16)}) pointer #{@stream_ptr.address}") if fr_result < 0
+        warn("Couldn't free Libvirt::Stream (0x#{obj_id.to_s(16)}) pointer #{@stream_ptr.address}") if fr_result.negative?
       end
       ObjectSpace.define_finalizer(self, free)
     end
@@ -35,16 +37,16 @@ module Libvirt
     def event_add_callback(events, opaque, &block)
       dbg { "#event_add_callback events=#{events}, opaque=#{opaque}" }
 
-      raise Error, 'callback already added' unless @cb.nil?
+      raise Errors::LibError, 'callback already added' unless @cb.nil?
 
       @opaque = opaque
-      @cb = ::FFI::Function.new(:void, [:pointer, :int, :pointer]) do |_stream_ptr, evs, _op|
+      @cb = FFI::Stream.callback_function(:virStreamEventCallback) do |_stream_ptr, evs, _op|
         # stream = Stream.new(stream_ptr)
         block.call(self, evs, @opaque)
       end
 
       result = FFI::Stream.virStreamEventAddCallback(@stream_ptr, events, @cb, nil, nil)
-      raise Error, "Couldn't add stream event callback" if result < 0
+      raise Errors::LibError, "Couldn't add stream event callback" if result.negative?
 
       true
     end
@@ -54,7 +56,8 @@ module Libvirt
       dbg { "#event_update_callback events=#{events}" }
 
       result = FFI::Stream.virStreamEventUpdateCallback(@stream_ptr, events)
-      raise Error, "Couldn't remove stream event callback" if result < 0
+      raise Errors::LibError, "Couldn't remove stream event callback" if result.negative?
+
       true
     end
 
@@ -62,7 +65,8 @@ module Libvirt
       dbg { '#event_remove_callback' }
 
       result = FFI::Stream.virStreamEventRemoveCallback(@stream_ptr)
-      raise Error, "Couldn't remove stream event callback" if result < 0
+      raise Errors::LibError, "Couldn't remove stream event callback" if result.negative?
+
       opaque = @opaque
       @cb = nil
       @opaque = nil
@@ -71,21 +75,24 @@ module Libvirt
 
     def finish
       result = FFI::Stream.virStreamFinish(@stream_ptr)
-      raise Error, "Couldn't remove stream event callback" if result < 0
+      raise Errors::LibError, "Couldn't remove stream event callback" if result.negative?
+
       @cb = nil
       @opaque = nil
     end
 
     def abort_stream
       result = FFI::Stream.virStreamAbort(@stream_ptr)
-      raise Error, "Couldn't remove stream event callback" if result < 0
+      raise Errors::LibError, "Couldn't remove stream event callback" if result.negative?
+
       @cb = nil
       @opaque = nil
     end
 
     def free_stream
       result = FFI::Stream.virStreamFree(@stream_ptr)
-      raise Error, "Couldn't free stream event callback" if result < 0
+      raise Errors::LibError, "Couldn't free stream event callback" if result.negative?
+
       @cb = nil
       @opaque = nil
       @stream_ptr = nil
@@ -97,14 +104,14 @@ module Libvirt
       if result == -1
         abort_stream
         [-1, nil]
-      elsif result == 0
+      elsif result.zero?
         [0, nil]
       elsif result == -2
         [-2, nil]
-      elsif result > 0
+      elsif result.positive?
         [result, buffer.read_bytes(result)]
       else
-        raise Error, "Invalid response from virStreamRecv #{result.inspect}"
+        raise Errors::LibError, "Invalid response from virStreamRecv #{result.inspect}"
       end
     end
 

data/lib/libvirt/util.rb

@@ -2,23 +2,36 @@
 
 module Libvirt
   module Util
-    class << self
+    UNIT_TO_BYTES = {
+        b: 1,
+        bytes: 1,
+        KB: 1_000,
+        KiB: 1_024,
+        k: 1_024,
+        MB: 1_000_000,
+        M: 1_048_576,
+        MiB: 1_048_576,
+        GB: 1_000_000_000,
+        G: 1_073_741_824,
+        GiB: 1_073_741_824,
+        TB: 1_000_000_000_000,
+        T: 1_099_511_627_776,
+        TiB: 1_099_511_627_776
+    }.freeze
 
-      def logger=(logger)
-        @logger = logger
-      end
+    class << self
+      attr_writer :logger
 
-      def logger
-        @logger
-      end
+      attr_reader :logger
 
       def log(severity, prog = nil, &block)
         return if @logger.nil?
+
         @logger.public_send(severity, prog, &block)
       end
 
       def library_path
-        %w(libvirt libvirt.so.0)
+        %w[libvirt libvirt.so.0]
       end
 
       # @param [Integer] version_number ulong
@@ -36,13 +49,53 @@ module Libvirt
       def parse_enum(enum, value)
         if value.is_a?(Symbol)
           raise ArgumentError, 'invalid enum value' unless enum.symbols.include?(value)
+
           return [enum.find(value), value]
         end
 
         raise ArgumentError, 'invalid enum value' unless enum.symbol_map.values.include?(value)
+
         [value, enum.symbol_map[value]]
       end
 
+      # Bitwise OR integer flags calculation for C language.
+      # @param flags [Integer,Symbol,Array<Symbol>,Hash{Symbol=>Boolean},nil]
+      # @param enum [FFI::Enum]
+      # @param default [Integer] optional (default 0x0)
+      # @return [Integer] bitwise OR of keys
+      #  @example Usage:
+      #    parse_flags(nil, enum)
+      #    parse_flags({MANAGED_SAVE: true, SNAPSHOTS_METADATA: true, NVRAM: false}, enum)
+      #    parse_flags({managed_save: true, snapshots_metadata: true, keep_nvram: nil}, enum)
+      #    parse_flags(3, enum)
+      #    parse_flags([:MANAGED_SAVE, :SNAPSHOTS_METADATA], enum)
+      #    parse_flags([:managed_save, :snapshots_metadata], enum)
+      #
+      def parse_flags(flags, enum, default: 0x0)
+        flags = default if flags.nil?
+        flags = enum[flags] if flags.is_a?(Symbol)
+        return flags if flags.is_a?(Integer)
+
+        result = 0x0
+        flags = flags.select { |_, v| v }.keys if flags.is_a?(Hash)
+
+        raise ArgumentError, 'flags must be an Integer or a Hash or an Array' unless flags.is_a?(Array)
+
+        flags.each do |key|
+          result |= enum[key.to_s.upcase.to_sym]
+        end
+
+        result
+      end
+
+      # @param value [Integer,String]
+      # @param unit [String,Symbol] default 'bytes'
+      # @return [Integer] memory in bytes
+      def parse_memory(value, unit)
+        unit ||= 'bytes'
+        multiplier = UNIT_TO_BYTES.fetch(unit.to_sym)
+        Integer(value) * multiplier
+      end
     end
   end
 end

data/lib/libvirt/version.rb

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

data/lib/libvirt/xml/disk.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Xml
+    class Disk < Generic
+      # https://libvirt.org/formatdomain.html#elementsDisks
+
+      attribute :type, type: :attr
+      attribute :device, type: :attr
+      attribute :model, type: :attr
+      attribute :raw_io, type: :attr, name: :rawio, cast: :bool
+      attribute :sg_io, type: :attr, name: :sgio
+      attribute :snapshot, type: :attr
+      attribute :source_file, name: :file, path: './source', type: :attr
+      attribute :source_dev, name: :dev, path: './source', type: :attr
+      attribute :source_dir, name: :dir, path: './source', type: :attr
+      attribute :source_protocol, name: :protocol, path: './source', type: :attr
+      attribute :source_pool, name: :pool, path: './source', type: :attr
+      attribute :source_volume, name: :volume, path: './source', type: :attr
+      attribute :source_mode, name: :mode, path: './source', type: :attr
+      attribute :source_name, name: :name, path: './source', type: :attr
+      attribute :source_type, name: :type, path: './source', type: :attr
+      attribute :source_managed, name: :managed, path: './source', type: :attr, cast: :bool
+      attribute :source_namespace, name: :namespace, path: './source', type: :attr
+      attribute :source_index, name: :index, path: './source', type: :attr
+      attribute :source_host_name, name: :name, path: './source/host', type: :attr
+      attribute :source_host_port, name: :port, path: './source/host', type: :attr
+      attribute :source_host_transport, name: :transport, path: './source/host', type: :attr
+      attribute :source_host_socket, name: :socket, path: './source/host', type: :attr
+      attribute :source_snapshot_name, name: :name, path: './source/snapshot', type: :attr
+      attribute :source_config_file, name: :file, path: './source/config', type: :attr
+      # TODO: source/auth
+      # TODO: source/encryption
+      # TODO: source/reservations
+      # TODO: source/initiator
+      # TODO: source/address
+      # TODO: source/slices
+      # TODO: backingStore
+      # TODO: mirror
+      # TODO: target
+      # TODO: iotune
+      # TODO: driver
+      # TODO: backenddomain
+      # TODO: boot
+      # TODO: encryption
+      # TODO: readonly
+      # TODO: shareable
+      # TODO: transient
+      # TODO: serial
+      # TODO: wwn
+      # TODO: vendor
+      # TODO: product
+      # TODO: address
+      # TODO: auth
+      # TODO: geometry
+      # TODO: blockio
+    end
+  end
+end

data/lib/libvirt/xml/domain.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Xml
+    class Domain < Generic
+      # https://libvirt.org/formatdomain.html
+
+      root_path './domain'
+
+      attribute :name
+      attribute :uuid
+      attribute :gen_id, path: './genid'
+      attribute :title
+      attribute :description
+      attribute :metadata, type: :raw
+      attribute :vcpu, type: :struct, class: MaxVcpu
+      attribute :vcpus, type: :struct, array: true, class: Vcpu, cast: ->(objects) { objects.sort_by(&:id) }
+      attribute :memory, type: :struct, class: Memory
+      attribute :current_memory, type: :struct, class: Memory
+      attribute :max_memory, type: :struct, class: Memory
+      attribute :resource_partitions, path: './resource/partition', array: true
+      attribute :on_power_off
+      attribute :on_reboot
+      attribute :on_crash
+      attribute :on_lock_failure
+      attribute :device_graphics, type: :struct, path: './devices/graphics', class: Graphics, array: true
+      attribute :device_disks, type: :struct, path: './devices/disk', class: Disk, array: true
+      # https://libvirt.org/formatdomain.html#elementsDevices
+      # todo devices/emulator
+      # todo devices/interface
+      # todo devices/filesystem
+      # todo devices/controller
+      # todo devices/lease
+      # todo devices/hostdev
+      # todo devices/redirdev
+      # todo devices/smartcard
+      # todo devices/input
+      # todo devices/hub
+      # todo devices/video
+      # todo devices/parallel
+      # todo devices/serial
+      # todo devices/console
+      # todo devices/channel
+      # todo devices/sound
+      # todo devices/watchdog
+      # todo devices/memballoon
+      # todo devices/rng
+      # todo devices/tpm
+      # todo devices/nvram
+      # todo devices/panic
+      # todo devices/shmem
+      # todo devices/memory
+      # todo devices/iommu
+      # todo devices/vsock
+      # todo os
+      # todo bootloader
+      # todo bootloader_args
+      # todo sysinfo
+      # todo iothreads
+      # todo iothreadids
+      # todo cputune
+      # todo memoryBacking
+      # todo memtune
+      # todo numatune
+      # todo blkiotune
+      # todo cpu
+      # todo pm
+      # todo features
+      # todo clock
+      # todo perf
+      # todo seclabel
+      # todo keywrap
+      # todo launchSecurity
+    end
+  end
+end