libvirt_ffi 0.5.6 → 0.8.0

data/lib/libvirt/xml/interface.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Xml
+    class Interface < Generic
+      # no official doc found
+      #
+      # <interface type='ethernet' name='lo'>
+      #   <protocol family='ipv4'>
+      #     <ip address='127.0.0.1' prefix='8'/>
+      #   </protocol>
+      #   <protocol family='ipv6'>
+      #     <ip address='::1' prefix='128'/>
+      #   </protocol>
+      #   <link state='unknown'/>
+      # </interface>
+      #
+      # <interface type='bridge'>
+      #   <mac address='52:54:00:4f:7e:b2'/>
+      #   <source bridge='vbr107'/>
+      #   <target dev='vnet4'/>
+      #   <model type='virtio'/>
+      #   <alias name='net0'/>
+      #   <address type='pci' domain='0x0000' bus='0x00' slot='0x03' function='0x0'/>
+      # </interface>
+
+      root_path './interface'
+
+      attribute :type, type: :attr
+
+      attribute :name, type: :attr
+      attribute :link_state, type: :attr, path: './link', name: 'state'
+      attribute :ip_addresses, type: :ip_addresses
+
+      attribute :mac_address, type: :attr, path: './mac', name: 'address'
+      attribute :source_bridge, type: :attr, path: './source', name: 'bridge'
+      attribute :target_dev, type: :attr, path: './target', name: 'dev'
+      attribute :model_type, type: :attr, path: './model', name: 'type'
+      attribute :alias_names, type: :attr, path: './alias', name: 'name', array: true
+      attribute :addresses, type: :addresses
+
+      private
+
+      def parse_node_addresses(_, _opts)
+        nodes = find_nodes(nil, path: './address')
+
+        nodes.map do |node|
+          {
+              type: node['type'],
+              domain: node['domain'],
+              bus: node['bus'],
+              slot: node['slot'],
+              function: node['function']
+          }
+        end
+      end
+
+      def parse_node_ip_addresses(_, _opts)
+        protocols = find_nodes(nil, path: './protocol')
+        ip_addresses = []
+
+        protocols.each do |protocol|
+          family = protocol['family']
+
+          protocol.xpath('./ip').each do |ip|
+            # ip['netmask'], ip['localPtr']
+            ip_addresses.push(
+                address: ip['address'],
+                prefix: ip['prefix'],
+                family: family
+            )
+          end
+        end
+
+        ip_addresses
+      end
+    end
+  end
+end

data/lib/libvirt/xml/ip_address.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Xml
+    class IpAddress < Generic
+      # https://libvirt.org/formatnetwork.html#elementsAddress
+
+      # <ip address="192.168.122.1" netmask="255.255.255.0" localPtr="yes">
+      #   <dhcp>
+      #     <range start="192.168.122.100" end="192.168.122.254"/>
+      #     <host mac="00:16:3e:77:e2:ed" name="foo.example.com" ip="192.168.122.10"/>
+      #     <host mac="00:16:3e:3e:a9:1a" name="bar.example.com" ip="192.168.122.11"/>
+      #   </dhcp>
+      # </ip>
+      # <ip family="ipv6" address="2001:db8:ca2:2::1" prefix="64" localPtr="yes"/>
+      attribute :address, type: :attr
+      attribute :netmask, type: :attr
+      attribute :prefix, type: :attr
+      attribute :local_ptr, type: :attr, name: 'localPtr', cast: :bool, default: false
+      attribute :family, type: :attr, default: 'ipv4'
+      attribute :tftp_root, type: :attr, path: './tftp', name: 'root'
+      attribute :dhcp_ranges, type: :dhcp_ranges
+      attribute :dhcp_hosts, type: :dhcp_hosts
+      attribute :dhcp_bootp_file, type: :attr, path: './dhcp/bootp', name: 'file'
+      attribute :dhcp_bootp_server, type: :attr, path: './dhcp/bootp', name: 'server'
+
+      private
+
+      def parse_node_dhcp_ranges(_, _opts)
+        nodes = find_nodes(nil, path: './dhcp/range')
+
+        nodes.map do |node|
+          [node['start'], node['end']]
+        end
+      end
+
+      def parse_node_dhcp_hosts(_, _opts)
+        nodes = find_nodes(nil, path: './dhcp/host')
+
+        nodes.map do |node|
+          {
+              mac: node['mac'],
+              ip: node['ip'],
+              name: node['name'],
+              host: node['host']
+          }
+        end
+      end
+    end
+  end
+end

data/lib/libvirt/xml/network.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+module Libvirt
+  module Xml
+    class Network < Generic
+      # https://libvirt.org/formatnetwork.html
+
+      root_path './network'
+
+      # <network ipv6='yes' trustGuestRxFilters='no'>
+      #   ...
+      attribute :ipv6, type: :attr, cast: :bool, default: false
+
+      attribute :trust_guest_rx_filters,
+                type: :attr,
+                name: 'trustGuestRxFilters',
+                cast: :bool,
+                default: false
+
+      # <name>default</name>
+      # <uuid>3e3fce45-4f53-4fa7-bb32-11f34168b82b</uuid>
+      attribute :name
+      attribute :uuid
+
+      # <metadata>
+      #   <app1:foo xmlns:app1="http://app1.org/app1/">..</app1:foo>
+      #   <app2:bar xmlns:app2="http://app1.org/app2/">..</app2:bar>
+      # </metadata>
+      attribute :metadata, type: :raw
+
+      # <bridge name="virbr0" stp="on" delay="5" macTableManager="libvirt"/>
+      attribute :bridge_name,
+                type: :attr,
+                name: 'name',
+                path: './bridge'
+
+      attribute :bridge_stp,
+                type: :attr,
+                name: 'stp',
+                cast: :bool,
+                path: './bridge'
+
+      attribute :bridge_delay,
+                type: :attr,
+                name: 'delay',
+                cast: :int,
+                path: './bridge'
+
+      attribute :bridge_mac_table_manager,
+                type: :attr,
+                name: 'macTableManager',
+                path: './bridge'
+
+      # <mtu size="9000"/>
+      attribute :mtu_size, type: :attr, path: './mtu', name: 'size', cast: :int
+
+      # <domain name="example.com" localOnly="no"/>
+      attribute :domain_name, type: :attr, path: './domain', name: 'name'
+      attribute :domain_local_only, type: :attr, path: './domain', name: 'localOnly', cast: :bool
+
+      # <forward mode='nat' dev='eth0'>
+      #     <nat>
+      #       <address start='1.2.3.4' end='1.2.3.10'/>
+      #     </nat>
+      #   </forward>
+      attribute :forward_mode, type: :attr, path: './forward', name: 'mode'
+      attribute :forward_dev, type: :attr, path: './forward', name: 'dev'
+      attribute :forward_nat_address, type: :forward_nat, node_name: :address
+      attribute :forward_nat_port, type: :forward_nat, node_name: :port
+
+      # <forward mode='passthrough'>
+      #   <interface dev='eth10'/>
+      #   <interface dev='eth11'/>
+      #   <interface dev='eth12'/>
+      #   <interface dev='eth13'/>
+      #   <interface dev='eth14'/>
+      # </forward>
+      attribute :forward_interfaces,
+                type: :attr,
+                path: './forward/interface',
+                name: 'dev',
+                array: true
+
+      # <forward mode='passthrough'>
+      #   <pf dev='eth0'/>
+      # </forward>
+      attribute :forward_pf,
+                type: :attr,
+                path: './forward/pf',
+                name: 'dev',
+                array: true
+
+      # <forward mode='hostdev' managed='yes'>
+      #     <driver name='vfio'/>
+      #     <address type='pci' domain='0' bus='4' slot='0' function='1'/>
+      #     <address type='pci' domain='0' bus='4' slot='0' function='2'/>
+      #     <address type='pci' domain='0' bus='4' slot='0' function='3'/>
+      #   </forward>
+      attribute :forward_manager,
+                type: :attr,
+                path: './forward',
+                name: 'managed',
+                cast: :bool,
+                default: false
+
+      attribute :forward_driver,
+                type: :attr,
+                path: './forward/driver',
+                name: 'name'
+
+      attribute :forward_addresses, type: :forward_hostdev_address
+
+      attribute :mac_address,
+                type: :attr,
+                path: './mac',
+                name: 'address'
+
+      # <dns>
+      #   <txt name="example" value="example value"/>
+      #   <forwarder addr="8.8.8.8"/>
+      #   <forwarder domain='example.com' addr="8.8.4.4"/>
+      #   <forwarder domain='www.example.com'/>
+      #   <srv service='name' protocol='tcp' domain='test-domain-name' target='.'
+      #     port='1024' priority='10' weight='10'/>
+      #   <host ip='192.168.122.2'>
+      #     <hostname>myhost</hostname>
+      #     <hostname>myhostalias</hostname>
+      #   </host>
+      # </dns>
+      attribute :dns_forwarder, type: :dns_forwarder
+      attribute :dns_txt, type: :dns_txt
+      attribute :dns_host_ip, type: :attr, path: './dns/host', name: 'ip'
+      attribute :dns_hostnames, path: './dns/host/hostname', array: true
+      attribute :dns_srv, type: :dns_txt
+
+      attribute :ip_addresses, type: :struct, path: './ip', class: IpAddress, array: true
+
+      # https://libvirt.org/formatnetwork.html#elementQoS
+      # TODO continue from <bandwidth>
+
+      private
+
+      def parse_node_forward_nat(_, opts)
+        nodes = find_nodes(nil, path: "./forward/nat/#{opts[:node_name]}")
+
+        nodes.map do |node|
+          [node['start'], node['stop']]
+        end
+      end
+
+      def parse_node_forward_hostdev_address(_, _opts)
+        nodes = find_nodes(nil, path: './forward/address')
+
+        nodes.map do |node|
+          {
+              type: node['type'],
+              domain: node['domain'],
+              bus: node['bus'],
+              slot: node['slot'],
+              function: node['function']
+          }
+        end
+      end
+
+      def parse_node_dns_forwarder(_, _opts)
+        nodes = find_nodes(nil, path: './dns/forwarder')
+
+        nodes.map do |node|
+          {
+              domain: node['domain'],
+              addr: node['addr']
+          }
+        end
+      end
+
+      def parse_node_dns_txt(_, _opts)
+        nodes = find_nodes(nil, path: './dns/txt')
+
+        nodes.map do |node|
+          {
+              name: node['name'],
+              value: node['value']
+          }
+        end
+      end
+
+      def parse_node_dns_srv(_, _opts)
+        nodes = find_nodes(nil, path: './dns/srv')
+
+        nodes.map do |node|
+          {
+              name: node['name'],
+              protocol: node['protocol'],
+              target: node['target'],
+              port: node['port'],
+              priority: node['priority'],
+              weight: node['weight'],
+              domain: node['domain']
+          }
+        end
+      end
+    end
+  end
+end

data/test_usage/test_interface.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'libvirt'
+require 'logger'
+require 'active_support/all'
+require 'async'
+require 'json'
+
+require_relative 'support/libvirt_async'
+require_relative 'support/log_formatter'
+
+require 'libvirt/xml'
+
+Libvirt.logger = Logger.new(STDOUT, formatter: LogFormatter.new)
+Libvirt.logger.level = ENV['DEBUG'] ? :debug : :info
+
+IMPL = LibvirtAsync::Implementations.new
+
+Async do
+  ASYNC_REACTOR = Async::Task.current.reactor
+
+  puts "Lib version #{Libvirt.lib_version}"
+  puts "Gem version #{Libvirt::VERSION}"
+
+  IMPL.start
+
+  conn = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
+  conn.open
+
+  puts "Connection version #{conn.version.inspect}"
+  puts "Connection lib_version #{conn.lib_version.inspect}"
+  puts "Connection hostname #{conn.hostname.inspect}"
+
+  interfaces = conn.list_all_interfaces
+  puts "Connection interfaces qty #{interfaces.size}"
+
+  interfaces.each.with_index do |interface, i|
+    puts "Interface #{i} name=#{interface.name}"
+    puts "Interface #{i} active?=#{interface.active?}"
+    puts "Interface #{i} mac=#{interface.mac}"
+    puts "Interface #{i} xml_desc", interface.xml_desc
+    puts "Interface #{i} xml", JSON.pretty_generate(Libvirt::Xml::Interface.load(interface.xml_desc).to_h)
+  end
+
+end

data/test_usage/test_network.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'libvirt'
+require 'logger'
+require 'active_support/all'
+require 'async'
+require 'json'
+
+require_relative 'support/libvirt_async'
+require_relative 'support/log_formatter'
+
+require 'libvirt/xml'
+
+Libvirt.logger = Logger.new(STDOUT, formatter: LogFormatter.new)
+Libvirt.logger.level = ENV['DEBUG'] ? :debug : :info
+
+IMPL = LibvirtAsync::Implementations.new
+
+Async do
+  ASYNC_REACTOR = Async::Task.current.reactor
+
+  puts "Lib version #{Libvirt.lib_version}"
+  puts "Gem version #{Libvirt::VERSION}"
+
+  IMPL.start
+
+  conn = Libvirt::Connection.new('qemu+tcp://localhost:16510/system')
+  conn.open
+
+  puts "Connection version #{conn.version.inspect}"
+  puts "Connection lib_version #{conn.lib_version.inspect}"
+  puts "Connection hostname #{conn.hostname.inspect}"
+
+  networks = conn.list_all_networks
+  puts "Connection networks qty #{networks.size}"
+
+  networks.each.with_index do |network, i|
+    puts "Network #{i} uuid=#{network.uuid}"
+    puts "Network #{i} name=#{network.name}"
+    puts "Network #{i} active?=#{network.active?}"
+    puts "Network #{i} persistent?=#{network.persistent?}"
+    puts "Network #{i} auto_start=#{network.auto_start?}"
+    puts "Network #{i} bridge_name=#{network.bridge_name}"
+    puts "Network #{i} xml_desc", network.xml_desc
+    puts "Network #{i} xml", JSON.pretty_generate(Libvirt::Xml::Network.load(network.xml_desc).to_h)
+  end
+
+  networks.each.with_index do |network, i|
+    dhcp_leases = network.dhcp_leases
+    puts "Network #{i} DHCP Leases size=#{dhcp_leases.size}"
+
+    dhcp_leases.each.with_index do |dhcp, j|
+      puts "Network #{i} DHCP Lease #{j} name=#{dhcp.name}"
+      puts "Network #{i} DHCP Lease #{j} iface=#{dhcp.iface}"
+      puts "Network #{i} DHCP Lease #{j} expirytime=#{dhcp.expirytime}"
+      puts "Network #{i} DHCP Lease #{j} type=#{dhcp.type}"
+      puts "Network #{i} DHCP Lease #{j} mac=#{dhcp.mac}"
+      puts "Network #{i} DHCP Lease #{j} iaid=#{dhcp.iaid}"
+      puts "Network #{i} DHCP Lease #{j} ipaddr=#{dhcp.ipaddr}"
+      puts "Network #{i} DHCP Lease #{j} prefix=#{dhcp.prefix}"
+      puts "Network #{i} DHCP Lease #{j} hostname=#{dhcp.hostname}"
+      puts "Network #{i} DHCP Lease #{j} clientid=#{dhcp.clientid}"
+    end
+  end
+
+  puts 'register_network_event_callback'
+  conn.register_network_event_callback(:LIFECYCLE) do |_c, net, event, detail, opaque|
+    puts "NETWORK LIFECYCLE EVENT name=#{net.name}, event=#{event}, detail=#{detail}, opaque=#{opaque}"
+  end
+
+end