vagrant-libvirt 0.4.0 → 0.5.3

data/lib/vagrant-libvirt/cap/mount_virtiofs.rb

@@ -0,0 +1,37 @@
+require 'digest/md5'
+require 'vagrant/util/retryable'
+
+module VagrantPlugins
+  module ProviderLibvirt
+    module Cap
+      class MountVirtioFS
+        extend Vagrant::Util::Retryable
+
+        def self.mount_virtiofs_shared_folder(machine, folders)
+          folders.each do |_name, opts|
+            # Expand the guest path so we can handle things like "~/vagrant"
+            expanded_guest_path = machine.guest.capability(
+              :shell_expand_guest_path, opts[:guestpath]
+            )
+
+            # Do the actual creating and mounting
+            machine.communicate.sudo("mkdir -p #{expanded_guest_path}")
+
+            # Mount
+            mount_tag = Digest::MD5.new.update(opts[:hostpath]).to_s[0, 31]
+
+            mount_opts = "-o #{opts[:mount_opts]}" if opts[:mount_opts]
+
+            mount_command = "mount -t virtiofs #{mount_opts} '#{mount_tag}' #{expanded_guest_path}"
+            retryable(on: Vagrant::Errors::LinuxMountFailed,
+                      tries: 5,
+                      sleep: 3) do
+              machine.communicate.sudo(mount_command,
+                                       error_class: Vagrant::Errors::LinuxMountFailed)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/cap/{synced_folder.rb → synced_folder_9p.rb}

@@ -6,10 +6,9 @@ require 'digest/md5'
 require 'vagrant/util/subprocess'
 require 'vagrant/errors'
 require 'vagrant-libvirt/errors'
-# require_relative "helper"
 
 module VagrantPlugins
-  module SyncedFolder9p
+  module SyncedFolder9P
     class SyncedFolder < Vagrant.plugin('2', :synced_folder)
       include Vagrant::Util
       include VagrantPlugins::ProviderLibvirt::Util::ErbTemplate
@@ -69,10 +68,10 @@ module VagrantPlugins
         end
       end
 
-      # TODO: once up, mount folders
+      # once up, mount folders
       def enable(machine, folders, _opts)
         # Go through each folder and mount
-        machine.ui.info('mounting p9 share in guest')
+        machine.ui.info('mounting 9p share in guest')
         # Only mount folders that have a guest path specified.
         mount_folders = {}
         folders.each do |id, opts|
@@ -83,7 +82,7 @@ module VagrantPlugins
         end
         # Mount the actual folder
         machine.guest.capability(
-          :mount_p9_shared_folder, mount_folders
+          :mount_9p_shared_folder, mount_folders
         )
       end
 

data/lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb

@@ -0,0 +1,109 @@
+require 'log4r'
+require 'ostruct'
+require 'nokogiri'
+require 'digest/md5'
+
+require 'vagrant/util/subprocess'
+require 'vagrant/errors'
+require 'vagrant-libvirt/errors'
+
+module VagrantPlugins
+  module SyncedFolderVirtioFS
+    class SyncedFolder < Vagrant.plugin('2', :synced_folder)
+      include Vagrant::Util
+      include VagrantPlugins::ProviderLibvirt::Util::ErbTemplate
+
+      def initialize(*args)
+        super
+        @logger = Log4r::Logger.new('vagrant_libvirt::synced_folders::virtiofs')
+      end
+
+      def usable?(machine, _raise_error = false)
+        # bail now if not using Libvirt since checking version would throw error
+        return false unless machine.provider_name == :libvirt
+
+        # virtiofs support introduced since 6.2.0
+        # version number format is major * 1,000,000 + minor * 1,000 + release
+        libvirt_version = machine.provider.driver.connection.client.libversion
+        libvirt_version >= 6_002_000
+      end
+
+      def prepare(machine, folders, _opts)
+        raise Vagrant::Errors::Error('No Libvirt connection') if machine.provider.driver.connection.nil?
+        @conn = machine.provider.driver.connection.client
+
+        begin
+          # loop through folders
+          folders.each do |id, folder_opts|
+            folder_opts.merge!(target: id,
+                               mount: true,
+                               readonly: nil) { |_k, ov, _nv| ov }
+
+            mount_tag = Digest::MD5.new.update(folder_opts[:hostpath]).to_s[0, 31]
+            folder_opts[:mount_tag] = mount_tag
+
+            machine.ui.info "================\nMachine id: #{machine.id}\nShould be mounting folders\n #{id}, opts: #{folder_opts}"
+
+            #xml = to_xml('filesystem', folder_opts)
+            xml = Nokogiri::XML::Builder.new do |xml|
+              xml.filesystem(type: 'mount', accessmode: 'passthrough') do
+                xml.driver(type: 'virtiofs')
+                xml.source(dir: folder_opts[:hostpath])
+                xml.target(dir: mount_tag)
+                xml.readonly unless folder_opts[:readonly].nil?
+              end
+            end.to_xml(
+              save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION |
+                         Nokogiri::XML::Node::SaveOptions::NO_EMPTY_TAGS |
+                         Nokogiri::XML::Node::SaveOptions::FORMAT
+            )
+            # puts "<<<<< XML:\n #{xml}\n >>>>>"
+            @conn.lookup_domain_by_uuid(machine.id).attach_device(xml, 0)
+          end
+        rescue => e
+          machine.ui.error("could not attach device because: #{e}")
+          raise VagrantPlugins::ProviderLibvirt::Errors::AttachDeviceError,
+                error_message: e.message
+        end
+      end
+
+      # once up, mount folders
+      def enable(machine, folders, _opts)
+        # Go through each folder and mount
+        machine.ui.info('mounting virtiofs share in guest')
+        # Only mount folders that have a guest path specified.
+        mount_folders = {}
+        folders.each do |id, opts|
+          next unless opts[:mount] && opts[:guestpath] && !opts[:guestpath].empty?
+          mount_folders[id] = opts.dup
+        end
+        # Mount the actual folder
+        machine.guest.capability(
+          :mount_virtiofs_shared_folder, mount_folders
+        )
+      end
+
+      def cleanup(machine, _opts)
+        if machine.provider.driver.connection.nil?
+          raise Vagrant::Errors::Error('No Libvirt connection')
+        end
+        @conn = machine.provider.driver.connection.client
+        begin
+          if machine.id && machine.id != ''
+            dom = @conn.lookup_domain_by_uuid(machine.id)
+            Nokogiri::XML(dom.xml_desc).xpath(
+              '/domain/devices/filesystem'
+            ).each do |xml|
+              dom.detach_device(xml.to_s)
+              machine.ui.info 'Cleaned up shared folders'
+            end
+          end
+        rescue => e
+          machine.ui.error("could not detach device because: #{e}")
+          raise VagrantPlugins::ProviderLibvirt::Errors::DetachDeviceError,
+                error_message: e.message
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-libvirt/config.rb

@@ -1,3 +1,5 @@
+require 'cgi'
+
 require 'vagrant'
 
 class Numeric
@@ -39,6 +41,9 @@ module VagrantPlugins
 
       attr_accessor :proxy_command
 
+      # Forward port with id 'ssh'
+      attr_accessor :forward_ssh_port
+
       # Libvirt storage pool name, where box image and instance snapshots will
       # be stored.
       attr_accessor :storage_pool_name
@@ -61,6 +66,7 @@ module VagrantPlugins
       attr_accessor :management_network_pci_bus
       attr_accessor :management_network_pci_slot
       attr_accessor :management_network_domain
+      attr_accessor :management_network_mtu
 
       # System connection information
       attr_accessor :system_uri
@@ -189,12 +195,14 @@ module VagrantPlugins
         @uri               = UNSET_VALUE
         @driver            = UNSET_VALUE
         @host              = UNSET_VALUE
+        @port              = UNSET_VALUE
         @connect_via_ssh   = UNSET_VALUE
         @username          = UNSET_VALUE
         @password          = UNSET_VALUE
         @id_ssh_key_file   = UNSET_VALUE
         @socket            = UNSET_VALUE
         @proxy_command     = UNSET_VALUE
+        @forward_ssh_port  = UNSET_VALUE # forward port with id 'ssh'
         @storage_pool_name = UNSET_VALUE
         @snapshot_pool_name = UNSET_VALUE
         @random_hostname   = UNSET_VALUE
@@ -208,6 +216,7 @@ module VagrantPlugins
         @management_network_pci_slot = UNSET_VALUE
         @management_network_pci_bus = UNSET_VALUE
         @management_network_domain = UNSET_VALUE
+        @management_network_mtu = UNSET_VALUE
 
         # System connection information
         @system_uri      = UNSET_VALUE
@@ -396,10 +405,20 @@ module VagrantPlugins
           raise 'Feature name AND state must be specified'
         end
 
+        if options[:name] == 'spinlocks' && options[:retries].nil?
+          raise 'Feature spinlocks requires retries parameter'
+        end
+
         @features_hyperv = []  if @features_hyperv == UNSET_VALUE
 
-        @features_hyperv.push(name: options[:name],
-                              state: options[:state])
+        if options[:name] == 'spinlocks'
+          @features_hyperv.push(name:   options[:name],
+                             state: options[:state],
+                             retries: options[:retries])
+        else
+          @features_hyperv.push(name:   options[:name],
+                             state: options[:state])
+        end
       end
 
       def clock_timer(options = {})
@@ -622,11 +641,13 @@ module VagrantPlugins
         # as will the address unit number (unit=0, unit=1, etc)
 
         options = {
+          type: 'raw',
           bus: 'ide',
           path: nil
         }.merge(options)
 
         cdrom = {
+          type: options[:type],
           dev: options[:dev],
           bus: options[:bus],
           path: options[:path]
@@ -770,6 +791,9 @@ module VagrantPlugins
         finalize_from_uri
         finalize_proxy_command
 
+        # forward port with id 'ssh'
+        @forward_ssh_port = false if @forward_ssh_port == UNSET_VALUE
+
         @storage_pool_name = 'default' if @storage_pool_name == UNSET_VALUE
         @snapshot_pool_name = @storage_pool_name if @snapshot_pool_name == UNSET_VALUE
         @storage_pool_path = nil if @storage_pool_path == UNSET_VALUE
@@ -784,6 +808,7 @@ module VagrantPlugins
         @management_network_pci_bus = nil if @management_network_pci_bus == UNSET_VALUE
         @management_network_pci_slot = nil if @management_network_pci_slot == UNSET_VALUE
         @management_network_domain = nil if @management_network_domain == UNSET_VALUE
+        @management_network_mtu = nil if @management_network_mtu == UNSET_VALUE
         @system_uri      = 'qemu:///system' if @system_uri == UNSET_VALUE
 
         # Domain specific settings.
@@ -994,7 +1019,12 @@ module VagrantPlugins
 
         # Extract host and username values from uri if provided, otherwise nil
         @host = uri.host
+        @port = uri.port
         @username = uri.user
+        if uri.query
+          params = CGI.parse(uri.query)
+          @id_ssh_key_file = params['keyfile'].first if params.has_key?('keyfile')
+        end
 
         finalize_id_ssh_key_file
       end
@@ -1031,11 +1061,13 @@ module VagrantPlugins
         if @connect_via_ssh
           if @proxy_command == UNSET_VALUE
             proxy_command = "ssh '#{@host}' "
+            proxy_command << "-p #{@port} " if @port
             proxy_command << "-l '#{@username}' " if @username
             proxy_command << "-i '#{@id_ssh_key_file}' " if @id_ssh_key_file
             proxy_command << '-W %h:%p'
           else
             inputs = { host: @host }
+            inputs << { port: @port } if @port
             inputs[:username] = @username if @username
             inputs[:id_ssh_key_file] = @id_ssh_key_file if @id_ssh_key_file
 

data/lib/vagrant-libvirt/driver.rb

@@ -97,11 +97,13 @@ module VagrantPlugins
           return get_ipaddress_from_system domain.mac
         end
 
-        # Get IP address from arp table
+        # Get IP address from dhcp leases table
         begin
           ip_address = get_ipaddress_from_domain(domain)
         rescue Fog::Errors::TimeoutError
           @logger.info('Timeout at waiting for an ip address for machine %s' % machine.name)
+
+          raise
         end
 
         unless ip_address

data/lib/vagrant-libvirt/errors.rb

@@ -37,7 +37,22 @@ module VagrantPlugins
         error_key(:image_download_error)
       end
 
-      # Box exceptions
+      # Box exceptions, capture all under one
+      class BoxError < VagrantLibvirtError
+      end
+
+      class BoxFormatMissingAttribute < BoxError
+        error_key(:box_format_missing_attribute)
+      end
+
+      class BoxFormatDuplicateVolume < BoxError
+        error_key(:box_format_duplicate_volume)
+      end
+
+      class BadBoxImage < VagrantLibvirtError
+        error_key(:bad_box_image)
+      end
+
       class NoBoxVolume < VagrantLibvirtError
         error_key(:no_box_volume)
       end
@@ -46,6 +61,10 @@ module VagrantPlugins
         error_key(:no_box_virtual_size)
       end
 
+      class NoDiskVirtualSizeSet < VagrantLibvirtError
+        error_key(:no_disk_virtual_size)
+      end
+
       class NoBoxFormatSet < VagrantLibvirtError
         error_key(:no_box_format)
       end
@@ -54,6 +73,10 @@ module VagrantPlugins
         error_key(:wrong_box_format)
       end
 
+      class WrongDiskFormatSet < VagrantLibvirtError
+        error_key(:wrong_disk_format)
+      end
+
       # Fog Libvirt exceptions
       class FogError < VagrantLibvirtError
         error_key(:fog_error)

data/lib/vagrant-libvirt/plugin.rb

@@ -26,12 +26,17 @@ module VagrantPlugins
       end
 
       action_hook(:remove_libvirt_image) do |hook|
+        require_relative 'action'
         hook.after Vagrant::Action::Builtin::BoxRemove, Action.remove_libvirt_image
       end
 
-      guest_capability('linux', 'mount_p9_shared_folder') do
-        require_relative 'cap/mount_p9'
-        Cap::MountP9
+      guest_capability('linux', 'mount_9p_shared_folder') do
+        require_relative 'cap/mount_9p'
+        Cap::Mount9P
+      end
+      guest_capability('linux', 'mount_virtiofs_shared_folder') do
+        require_relative 'cap/mount_virtiofs'
+        Cap::MountVirtioFS
       end
 
       provider_capability(:libvirt, :nic_mac_addresses) do
@@ -47,8 +52,12 @@ module VagrantPlugins
       # lower priority than nfs or rsync
       # https://github.com/vagrant-libvirt/vagrant-libvirt/pull/170
       synced_folder('9p', 4) do
-        require_relative 'cap/synced_folder'
-        VagrantPlugins::SyncedFolder9p::SyncedFolder
+        require_relative 'cap/synced_folder_9p'
+        VagrantPlugins::SyncedFolder9P::SyncedFolder
+      end
+      synced_folder('virtiofs', 5) do
+        require_relative 'cap/synced_folder_virtiofs'
+        VagrantPlugins::SyncedFolderVirtioFS::SyncedFolder
       end
 
       # This initializes the internationalization strings.

data/lib/vagrant-libvirt/templates/domain.xml.erb

@@ -99,7 +99,7 @@
     <% if !@features_hyperv.empty? %>
     <hyperv>
       <% @features_hyperv.each do |feature| %>
-      <<%= feature[:name] %> state='<%= feature[:state] %>' />
+      <<%= feature[:name] %> state='<%= feature[:state] %>'<% if feature[:name] == 'spinlocks' %> retries='<%= feature[:retries] %>'<% end %> />
       <% end %>
     </hyperv>
     <% end %>
@@ -113,18 +113,18 @@
     <% if @emulator_path %>
     <emulator><%= @emulator_path %></emulator>
     <% end %>
-    <% if @domain_volume_path %>
+<% @domain_volumes.each do |volume| -%>
     <disk type='file' device='disk'>
       <driver name='qemu' type='qcow2' <%=
-        @disk_driver_opts.empty? ? "cache='#{@domain_volume_cache}'" :
+        @disk_driver_opts.empty? ? "cache='#{volume[:cache]}'" :
             @disk_driver_opts.reject { |k,v| v.nil? }
                              .map { |k,v| "#{k}='#{v}'"}
                              .join(' ') -%>/>
-      <source file='<%= @domain_volume_path %>'/>
+      <source file='<%= volume[:path] %>'/>
       <%# we need to ensure a unique target dev -%>
-      <target dev='<%= @disk_device %>' bus='<%= @disk_bus %>'/>
+      <target dev='<%= volume[:dev] %>' bus='<%= volume[:bus] %>'/>
     </disk>
-    <% end %>
+<% end -%>
 <%# additional disks -%>
 <% @disks.each do |d| -%>
     <disk type='file' device='disk'>
@@ -153,6 +153,7 @@
 
 <% @cdroms.each do |c| %>
     <disk type='file' device='cdrom'>
+      <driver name='qemu' type='<%= c[:type] %>' />
       <source file='<%= c[:path] %>'/>
       <target dev='<%= c[:dev] %>' bus='<%= c[:bus] %>'/>
       <readonly/>

data/lib/vagrant-libvirt/templates/private_network.xml.erb

@@ -1,6 +1,6 @@
 <network ipv6='<%= @guest_ipv6 %>'>
   <name><%= @network_name %></name>
-  <bridge name="<%= @network_bridge_name %>" />
+  <bridge name="<%= @network_bridge_name %>" stp="<%= @network_bridge_stp %>" delay="<%= @network_bridge_delay %>" />
 
   <% if @network_domain_name %>
     <domain name="<%= @network_domain_name %>" localOnly="yes" />