Class: VagrantPlugins::SyncedFolderVirtioFS::SyncedFolder

Inherits:
Object
  • Object
show all
Includes:
Vagrant::Util, ProviderLibvirt::Util::ErbTemplate
Defined in:
lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb

Instance Method Summary collapse

Methods included from ProviderLibvirt::Util::ErbTemplate

#to_xml

Constructor Details

#initialize(*args) ⇒ SyncedFolder 



16
17
18
19
 
# File 'lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb', line 16

def initialize(*args)
  super
  @logger = Log4r::Logger.new('vagrant_libvirt::synced_folders::virtiofs')
end

Instance Method Details

#cleanup(machine, _opts) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb', line 86

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

#enable(machine, folders, _opts) ⇒ Object

once up, mount folders



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb', line 71

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

#prepare(machine, folders, _opts) ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb', line 31

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

#usable?(machine, _raise_error = false) ⇒ Boolean 



21
22
23
24
25
26
27
28
29
 
# File 'lib/vagrant-libvirt/cap/synced_folder_virtiofs.rb', line 21

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