libvirt_ffi 0.4.1 → 0.5.0

data/lib/libvirt/errors.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Errors
+    class Error < StandardError
+      # Generic error
+    end
+
+    class LibError < Error
+      # Object contains detailed error information retrieved from libvirt.
+
+      ERROR_FIELDS = [:code, :domain, :message, :level].freeze
+
+      attr_reader :client_message,
+                  :error_data,
+                  :error_code,
+                  :error_domain,
+                  :error_message,
+                  :error_level
+
+      # @param client_message [String, nil] optional client message
+      # When client_message ommited and virGetLastError return error
+      # message will be following: "ERROR_LEVEL: ERROR_NUMBER (ERROR_DOMAIN) ERROR_MESSAGE".
+      # When client message provided and virGetLastError return error
+      # message will be following: "CLIENT_MESSAGE\nERROR_LEVEL: ERROR_NUMBER (ERROR_DOMAIN) ERROR_MESSAGE".
+      # When client message is provided and virGetLastError return no error
+      # message will be following: "CLIENT_MESSAGE".
+      def initialize(client_message = nil)
+        @client_message = client_message
+        ptr = FFI::Error.virGetLastError
+        unless ptr.null?
+          struct = FFI::Error::Struct.new(ptr)
+          @error_data = struct.members.map { |m| [m, struct[m]] }.to_h
+          @error_code = error_data[:code]
+          @error_domain = error_data[:domain]
+          @error_message = error_data[:message]
+          @error_level = error_data[:level]
+        end
+
+        super(build_message)
+      end
+
+      private
+
+      def build_message
+        if error_data.nil?
+          client_message
+        elsif client_message.nil?
+          format '%<level>s: %<code>s (%<domain>s) %<message>s',
+                 level: error_level,
+                 code: error_code,
+                 domain: error_domain,
+                 message: error_message
+        else
+          format "%<client_message>s\n%<level>s: %<code>s (%<domain>s) %<message>s",
+                 client_message: client_message,
+                 level: error_level,
+                 code: error_code,
+                 domain: error_domain,
+                 message: error_message
+        end
+      end
+    end
+  end
+end

data/lib/libvirt/event.rb

@@ -21,7 +21,7 @@ module Libvirt
 
     attr_accessor :debug
 
-    Opaque = Struct.new(:cb, :opaque, :ff)
+    Opaque = Struct.new(:cb, :opaque, :free_func)
 
     def invoke_handle_callback(watch, fd, events, opaque)
       cb = opaque.cb
@@ -59,20 +59,25 @@ module Libvirt
       true
     end
 
-    def register(add_handle:, update_handle:, remove_handle:, add_timer:, update_timer:, remove_timer:)
+    def schedule_operation(&block)
+      @schedule.call(&block)
+    end
+
+    def register(add_handle:, update_handle:, remove_handle:, add_timer:, update_timer:, remove_timer:, schedule:) # rubocop:disable Metrics/ParameterLists
       @add_handle = add_handle
       @update_handle = update_handle
       @remove_handle = remove_handle
       @add_timer = add_timer
       @update_timer = update_timer
       @remove_timer = remove_timer
+      @schedule = schedule
 
-      @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)
+      @add_handle_cb = FFI::Event.callback_function(:virEventAddHandleFunc, &method(:_add_handle))
+      @update_handle_cb = FFI::Event.callback_function(:virEventUpdateHandleFunc, &method(:_update_handle))
+      @remove_handle_cb = FFI::Event.callback_function(:virEventRemoveHandleFunc, &method(:_remove_handle))
+      @add_timer_cb = FFI::Event.callback_function(:virEventAddTimeoutFunc, &method(:_add_timer))
+      @update_timer_cb = FFI::Event.callback_function(:virEventUpdateTimeoutFunc, &method(:_update_timer))
+      @remove_timer_cb = FFI::Event.callback_function(:virEventRemoveTimeoutFunc, &method(:_remove_timer))
 
       FFI::Event.virEventRegisterImpl(
           @add_handle_cb,
@@ -87,9 +92,9 @@ module Libvirt
 
     private
 
-    def _add_handle(fd, event, cb, opaque, ff)
-      dbg { "ADD_HANDLE fd=#{fd}, #{event}=event, cb=#{cb}, opaque=#{opaque}, ff=#{ff}" }
-      op = Opaque.new(cb, opaque, ff)
+    def _add_handle(fd, event, cb, opaque, free_func)
+      dbg { "ADD_HANDLE fd=#{fd}, #{event}=event, cb=#{cb}, opaque=#{opaque}, free_func=#{free_func}" }
+      op = Opaque.new(cb, opaque, free_func)
       @add_handle.call(fd, event, op)
     end
 
@@ -101,15 +106,18 @@ module Libvirt
     def _remove_handle(watch)
       dbg { "REMOVE_HANDLE watch=#{watch}" }
       op = @remove_handle.call(watch)
-      free_func = op.ff
+      free_func = op.free_func
       opaque = op.opaque
-      free_func.call(opaque) unless free_func.null?
+      schedule_operation do
+        dbg { "REMOVE_HANDLE delayed free_func watch=#{watch}" }
+        free_func.call(opaque) unless free_func.null?
+      end
       0
     end
 
-    def _add_timer(timeout, cb, opaque, ff)
-      dbg { "ADD_TIMER timeout=#{timeout}, cb=#{cb}, opaque=#{opaque}, ff=#{ff}" }
-      op = Opaque.new(cb, opaque, ff)
+    def _add_timer(timeout, cb, opaque, free_func)
+      dbg { "ADD_TIMER timeout=#{timeout}, cb=#{cb}, opaque=#{opaque}, free_func=#{free_func}" }
+      op = Opaque.new(cb, opaque, free_func)
       @add_timer.call(timeout, op)
     end
 
@@ -121,15 +129,17 @@ module Libvirt
     def _remove_timer(timer)
       dbg { "REMOVE_TIMER timer=#{timer}" }
       op = @remove_timer.call(timer)
-      free_func = op.ff
+      free_func = op.free_func
       opaque = op.opaque
-      free_func.call(opaque) unless free_func.null?
+      schedule_operation do
+        dbg { "REMOVE_TIMER async free_func timer=#{timer}" }
+        free_func.call(opaque) unless free_func.null?
+      end
       0
     end
 
     def dbg(&block)
       Util.log(:debug, 'Libvirt::Event', &block)
     end
-
   end
 end

data/lib/libvirt/ffi/common.rb

@@ -3,13 +3,20 @@
 module Libvirt
   module FFI
     module Common
+      # https://libvirt.org/html/libvirt-libvirt-common.html
+
       extend ::FFI::Library
+      extend Helpers
       ffi_lib Util.library_path
 
-      # typedef void (*virFreeCallback)	(
+      # typedef void (*virFreeCallback)  (
       #   void * opaque
       # )
       FREE_CALLBACK = callback :virFreeCallback, [:pointer], :void
+
+      def self.free_function(*args, &block)
+        callback_function(FREE_CALLBACK, *args, &block)
+      end
     end
   end
 end