vagrant-qemu 0.3.5 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c30b268793fc83d9e8f8e87c6a8f4bcee6b918bc93e290fca5d7fa5bbf997fb8
-  data.tar.gz: 0f4601e7634001be4f8073587dd695dacac7c5ff6822c06530d8b09cae4f19e2
+  metadata.gz: aa6a7877a0f30cbe820b09bfb481863f115758c542c92f02570641c3057983de
+  data.tar.gz: 74151d323890fcf318b74af5c251ae9413f8089429a700ac51e1e3f57d0e693f
 SHA512:
-  metadata.gz: c0799387634f0395de31a58e7e94b2e5668527b4a1f02e793d7bc0efdfc8b44879146a6e5a714866e99a8447ffd4ac23985efac9ca3d4d05462a217d3ae88a6b
-  data.tar.gz: 9ca32661b5d7078e9e4641d2acb3c131686b9e52458405618bfe0074abc77829d36f9b858c24202f9cd01fe96793a4e5595e39dc8eecb6678c1ad38f8cfcd2e4
+  metadata.gz: e0bc88d099f46ce974eb217025108e86d6ab14ca7efe199450e7ddf1e9364ebe24d466175067f3cf30f470864981251cecb46b3bffdfa070f6e7caf67906249b
+  data.tar.gz: 3d7e6b3486b69cf0a7ff5ebdcd536bda37ea5f733e6eb89677746d27b3e6169f12e369ce31d6b02dfacb7e6145719c656afed238796bba8338b8f11fc69deacb

data/CHANGELOG.md

@@ -66,3 +66,14 @@
 * Allow no cpu for riscv64.
 * Allow more config options to be nil.
 * Let id start with "vq_".
+
+# 0.3.6 (2024-02-27)
+
+* Config 'image_path' support array type
+* Try to support libvirt box v2 format
+
+# 0.3.7 (2025-02-02)
+
+* Ignore exception after sending 'system_powerdown' cmd, fix windows halt error
+* Move pid file to tmp dir
+* Be able to auto correct ssh port collisions, new config: ssh_auto_correct

data/README.md

@@ -30,6 +30,7 @@ Others:
 
 * Import from a Libvirt vagrant box or qcow2 image
   * To use box for **Paralles or VMware Fusion**, see [Wiki](https://github.com/ppggff/vagrant-qemu/wiki) for details
+  * Libvirt box v2 format support is experimental
 * Start VM without GUI
 * SSH into VM
 * Provision the instances with any built-in Vagrant provisioner
@@ -85,9 +86,10 @@ This provider exposes a few provider-specific configuration options:
   * `memory` - The memory setting of VM, default: `4G`
 * debug/expert
   * `ssh_host` - The SSH IP used to access VM, default: `127.0.0.1`
+  * `ssh_auto_correct` - Auto correct port collisions for ssh port, default: `false`
   * `net_device` - The network device, default: `virtio-net-device`
   * `drive_interface` - The interface type for the main drive, default `virtio`
-  * `image_path` - The path to qcow2 image for box-less VM, default is nil value
+  * `image_path` - The path (or array of paths) to qcow2 image for box-less VM, default is nil value
   * `qemu_dir` - The path to QEMU's install dir, default: `/opt/homebrew/share/qemu`
   * `extra_qemu_args` - The raw list of additional arguments to pass to QEMU. Use with extreme caution. (see "Force Multicore" below as example)
   * `extra_netdev_args` - extra, comma-separated arguments to pass to the -netdev parameter. Use with caution. (see "Force Local IP" below as example)
@@ -225,7 +227,6 @@ end
 8. Windows host
 
 Windows version QEMU doesn't support `daemonize` mode and unix socket
-(Notes: not tested)
 
 ```
 Vagrant.configure("2") do |config|
@@ -239,6 +240,32 @@ Vagrant.configure("2") do |config|
 end
 ```
 
+9. Auto port collisions for ssh port (multiple machine)
+
+```
+Vagrant.configure("2") do |config|
+
+  config.vm.define "vm1" do |c|
+    c.vm.box = "ppggff/centos-7-aarch64-2009-4K"
+    c.vm.provider "qemu" do |qe|
+      qe.memory = "2G"
+      qe.ssh_auto_correct = true
+    end
+    c.vm.synced_folder ".", "/vagrant", disabled: true
+  end
+
+  config.vm.define "vm2" do |c|
+    c.vm.box = "ppggff/centos-7-aarch64-2009-4K"
+    c.vm.provider "qemu" do |qe|
+      qe.memory = "2G"
+      qe.ssh_auto_correct = true
+    end
+    c.vm.synced_folder ".", "/vagrant", disabled: true
+  end
+
+end
+```
+
 ## Debug
 
 Serial port is exported to unix socket: `<user_home>/.vagrant.d/tmp/vagrant-qemu/<id>/qemu_socket_serial`, or `debug_port`.
@@ -298,6 +325,21 @@ Vagrant.configure("2") do |config|
 end
 ```
 
+As an alternative solution(helpful for macOS) it is possible to use 9p file system via virtio. 
+
+```
+config.vm.synced_folder ".", "/vagrant", disabled: true
+config.vm.provider "qemu" do |qe|
+    qe.extra_qemu_args = %w(-virtfs local,path=.,mount_tag=shared,security_model=mapped)
+end
+```
+This will pass "current directory" to mount point tagged "shared"
+Use the following /etc/fstab entry on the vagrant vm to mount the shared directory into /home/vagrant/shared
+```
+shared /home/vagrant/shared 9p _netdev,trans=virtio,msize=524288 0
+```
+Please keep in mind that the guest OS will need to install 9p dependencies to handle the 9p filestystem.
+
 ### 2. netcat does not support the -U parameter
 
 I had netcat installed through home brew and it does not support the -U parameter.

data/lib/vagrant-qemu/action/import.rb

@@ -1,4 +1,5 @@
 require "log4r"
+require "open3"
 require "pathname"
 
 module VagrantPlugins
@@ -12,18 +13,52 @@ module VagrantPlugins
         end
 
         def call(env)
-          image_path = nil
+          image_path = Array.new
           if env[:machine].provider_config.image_path
-            image_path = Pathname.new(env[:machine].provider_config.image_path)
-          elsif env[:machine].box
-            image_path = env[:machine].box.directory.join("box.img")
+            paths = env[:machine].provider_config.image_path
+            paths = [paths] if !paths.kind_of?(Array)
+            paths.each do |p|
+              image_path.append(Pathname.new(p))
+            end
+          else
+            disks = env[:machine].box.metadata.fetch('disks', [])
+            if disks.empty?
+              # box v1 format
+              image_path.append(env[:machine].box.directory.join("box.img"))
+            else
+              # box v2 format
+              disks.each_with_index do |d, i|
+                if d['path'].nil?
+                  @logger.error("Missing box image path for disk #{i}")
+                  raise Errors::BoxInvalid, name: env[:machine].name, err: "Missing box image path for disk #{i}"
+                end
+                image_path.append(env[:machine].box.directory.join(d['path']))
+              end
+            end
           end
 
-          if !image_path || !image_path.file?
-            @logger.error("Invalid box image path: #{image_path}")
-            raise Errors::BoxInvalid, name: env[:machine].name, err: "Invalid box image path: #{image_path}"
-          else
-            @logger.info("Found box image path: #{image_path}")
+          if image_path.empty?
+            @logger.error("Empty box image path")
+            raise Errors::BoxInvalid, name: env[:machine].name, err: "Empty box image path"
+          end
+          image_path.each do |img|
+            if !img.file?
+              @logger.error("Invalid box image path: #{img}")
+              raise Errors::BoxInvalid, name: env[:machine].name, err: "Invalid box image path: #{img}"
+            end
+            img_str = img.to_s
+            stdout, stderr, status = Open3.capture3('qemu-img', 'info', '--output=json', img_str)
+            if !status.success?
+              @logger.error("Run qemu-img info failed, #{img_str}, out: #{stdout}, err: #{stderr}")
+              raise Errors::BoxInvalid, name: env[:machine].name, err: "Run qemu-img info failed, #{img_str}, out: #{stdout}, err: #{stderr}"
+            end
+            img_info = JSON.parse(stdout)
+            format = img_info['format']
+            if format != 'qcow2'
+              @logger.error("Invalid box image format, #{img_str}, format: #{format}")
+              raise Errors::BoxInvalid, name: env[:machine].name, err: "Invalid box image format, #{img_str}, format: #{format}"
+            end
+            @logger.info("Found box image path: #{img_info}")
           end
 
           qemu_dir = Pathname.new(env[:machine].provider_config.qemu_dir)

data/lib/vagrant-qemu/action/prepare_forwarded_port_collision_params.rb

@@ -16,16 +16,23 @@ module VagrantPlugins
       # Build the remap for any existing collision detections
       remap = {}
       env[:port_collision_remap] = remap
+
+      has_ssh_forward = false
       machine.config.vm.networks.each do |type, options|
         next if type != :forwarded_port
 
         # remap ssh.host to ssh_port
         if options[:id] == "ssh"
           remap[options[:host]] = machine.provider_config.ssh_port
+          has_ssh_forward = true
           break
         end
       end
 
+      if !has_ssh_forward
+        machine.config.vm.networks.forward_port(22, machine.provider_config.ssh_port, [id: "ssh", auto_correct: machine.provider_config.ssh_auto_correct])
+      end
+
       @app.call(env)
       end
     end

data/lib/vagrant-qemu/action/read_state.rb

@@ -23,6 +23,11 @@ module VagrantPlugins
           else
             env[:machine_state_id] = :not_created
           end
+
+          # Update ssh_port if needed
+          if env[:machine_state_id] != :not_created
+            env[:machine].provider_config.ssh_port = env[:machine].provider.driver.get_ssh_port(env[:machine].provider_config.ssh_port)
+          end
           @app.call(env)
         end
       end

data/lib/vagrant-qemu/action/start_instance.rb

@@ -11,6 +11,7 @@ module VagrantPlugins
         end
 
         def call(env)
+          fwPorts = forwarded_ports(env)
           options = {
             :ssh_host => env[:machine].provider_config.ssh_host,
             :ssh_port => env[:machine].provider_config.ssh_port,
@@ -23,7 +24,7 @@ module VagrantPlugins
             :drive_interface => env[:machine].provider_config.drive_interface,
             :extra_qemu_args => env[:machine].provider_config.extra_qemu_args,
             :extra_netdev_args => env[:machine].provider_config.extra_netdev_args,
-            :ports => forwarded_ports(env),
+            :ports => fwPorts,
             :control_port => env[:machine].provider_config.control_port,
             :debug_port => env[:machine].provider_config.debug_port,
             :no_daemonize => env[:machine].provider_config.no_daemonize,
@@ -43,7 +44,12 @@ module VagrantPlugins
             next if type != :forwarded_port
 
             # Don't include SSH
-            next if options[:id] == "ssh"
+            if options[:id] == "ssh"
+              if options[:host] != env[:machine].provider_config.ssh_port
+                  env[:machine].provider_config.ssh_port = options[:host]
+              end
+              next
+            end
 
             # Skip port if it is disabled
             next if options[:disabled]

data/lib/vagrant-qemu/action.rb

@@ -116,7 +116,7 @@ module VagrantPlugins
             end
 
             b1.use Provision
-            b1.use EnvSet, port_collision_repair: false
+            b1.use EnvSet, port_collision_repair: true
             b1.use PrepareForwardedPortCollisionParams
             b1.use HandleForwardedPortCollisions
             b1.use SyncedFolderCleanup

data/lib/vagrant-qemu/config.rb

@@ -5,6 +5,7 @@ module VagrantPlugins
     class Config < Vagrant.plugin("2", :config)
       attr_accessor :ssh_host
       attr_accessor :ssh_port
+      attr_accessor :ssh_auto_correct
       attr_accessor :arch
       attr_accessor :machine
       attr_accessor :cpu
@@ -25,6 +26,7 @@ module VagrantPlugins
       def initialize
         @ssh_host = UNSET_VALUE
         @ssh_port = UNSET_VALUE
+        @ssh_auto_correct = UNSET_VALUE
         @arch = UNSET_VALUE
         @machine = UNSET_VALUE
         @cpu = UNSET_VALUE
@@ -55,6 +57,7 @@ module VagrantPlugins
       def finalize!
         @ssh_host = "127.0.0.1" if @ssh_host == UNSET_VALUE
         @ssh_port = 50022 if @ssh_port == UNSET_VALUE
+        @ssh_auto_correct = false if @ssh_auto_correct == UNSET_VALUE
         @arch = "aarch64" if @arch == UNSET_VALUE
         @machine = "virt,accel=hvf,highmem=on" if @machine == UNSET_VALUE
         @cpu = "host" if @cpu == UNSET_VALUE

data/lib/vagrant-qemu/driver.rb

@@ -1,5 +1,6 @@
 require 'childprocess'
 require 'securerandom'
+require 'yaml'
 
 require "vagrant/util/busy"
 require 'vagrant/util/io'
@@ -10,7 +11,7 @@ require_relative "plugin"
 
 module VagrantPlugins
   module QEMU
-	  class Driver
+    class Driver
       # @return [String] VM ID
       attr_reader :vm_id
       attr_reader :data_dir
@@ -45,12 +46,21 @@ module VagrantPlugins
       def start(options)
         if !running?
           id_dir = @data_dir.join(@vm_id)
-          image_path = id_dir.join("linked-box.img").to_s
-          pid_file = id_dir.join("qemu.pid").to_s
+
+          image_path = Array.new
+          image_count = id_dir.glob("linked-box*.img").count
+          for i in 0..image_count-1 do
+            suffix_index = i > 0 ? "-#{i}" : ''
+            image_path.append(id_dir.join("linked-box#{suffix_index}.img").to_s)
+          end
 
           id_tmp_dir = @tmp_dir.join(@vm_id)
           FileUtils.mkdir_p(id_tmp_dir)
 
+          # dump options
+          options_file = id_tmp_dir.join("options.yml")
+          File.write(options_file, options.to_yaml)
+
           control_socket = ""
           if !options[:control_port].nil?
             control_socket = "port=#{options[:control_port]},host=localhost,ipv4=on"
@@ -95,7 +105,9 @@ module VagrantPlugins
 
           # drive
           if !options[:drive_interface].nil?
-            cmd += %W(-drive if=#{options[:drive_interface]},format=qcow2,file=#{image_path})
+            image_path.each do |img|
+              cmd += %W(-drive if=#{options[:drive_interface]},format=qcow2,file=#{img})
+            end
           end
           if options[:arch] == "aarch64" && !options[:firmware_format].nil?
             fm1_path = id_dir.join("edk2-aarch64-code.fd").to_s
@@ -105,6 +117,7 @@ module VagrantPlugins
           end
 
           # control
+          pid_file = id_tmp_dir.join("qemu.pid").to_s
           cmd += %W(-chardev socket,id=mon0,#{control_socket},server=on,wait=off)
           cmd += %W(-mon chardev=mon0,mode=readline)
           cmd += %W(-chardev socket,id=ser0,#{debug_socket},server=on,wait=off)
@@ -131,7 +144,7 @@ module VagrantPlugins
             Socket.tcp("localhost", options[:control_port], connect_timeout: 5) do |sock|
               sock.print "system_powerdown\n"
               sock.close_write
-              sock.read
+              sock.read rescue nil
             end
           else
             id_tmp_dir = @tmp_dir.join(@vm_id)
@@ -139,12 +152,24 @@ module VagrantPlugins
             Socket.unix(unix_socket_path) do |sock|
               sock.print "system_powerdown\n"
               sock.close_write
-              sock.read
+              sock.read rescue nil
             end
-         end
+          end
         end
       end
 
+      def get_ssh_port(ssh_port)
+        id_tmp_dir = @tmp_dir.join(@vm_id)
+        options_file = id_tmp_dir.join("options.yml")
+
+        if options_file.file?
+          options = YAML.load_file(options_file) rescue nil
+          ssh_port = options[:ssh_port] if !options.nil? && options.key?(:ssh_port)
+        end
+
+        ssh_port
+      end
+
       def import(options)
         new_id = "vq_" + SecureRandom.urlsafe_base64(8)
 
@@ -162,7 +187,10 @@ module VagrantPlugins
         end
 
         # Create image
-        execute("qemu-img", "create", "-f", "qcow2", "-F", "qcow2", "-b", options[:image_path].to_s, id_dir.join("linked-box.img").to_s)
+        options[:image_path].each_with_index do |img, i|
+          suffix_index = i > 0 ? "-#{i}" : ''
+          execute("qemu-img", "create", "-f", "qcow2", "-F", "qcow2", "-b", img.to_s, id_dir.join("linked-box#{suffix_index}.img").to_s)
+        end
 
         server = {
           :id => new_id,
@@ -174,7 +202,7 @@ module VagrantPlugins
       end
 
       def running?
-        pid_file = @data_dir.join(@vm_id).join("qemu.pid")
+        pid_file = @tmp_dir.join(@vm_id).join("qemu.pid")
         return false if !pid_file.file?
 
         begin

data/lib/vagrant-qemu/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module QEMU
-    VERSION = '0.3.5'
+    VERSION = '0.3.7'
   end
 end

data/x

@@ -0,0 +1,76 @@
+diff --git a/lib/vagrant-qemu/action.rb b/lib/vagrant-qemu/action.rb
+index bb87e38..8818aa9 100644
+--- a/lib/vagrant-qemu/action.rb
++++ b/lib/vagrant-qemu/action.rb
+@@ -116,7 +116,7 @@ module VagrantPlugins
+             end
+ 
+             b1.use Provision
+-            b1.use EnvSet, port_collision_repair: false
++            b1.use EnvSet, port_collision_repair: true
+             b1.use PrepareForwardedPortCollisionParams
+             b1.use HandleForwardedPortCollisions
+             b1.use SyncedFolderCleanup
+diff --git a/lib/vagrant-qemu/action/prepare_forwarded_port_collision_params.rb b/lib/vagrant-qemu/action/prepare_forwarded_port_collision_params.rb
+index 159a785..b7c93a3 100644
+--- a/lib/vagrant-qemu/action/prepare_forwarded_port_collision_params.rb
++++ b/lib/vagrant-qemu/action/prepare_forwarded_port_collision_params.rb
+@@ -16,16 +16,23 @@ module VagrantPlugins
+       # Build the remap for any existing collision detections
+       remap = {}
+       env[:port_collision_remap] = remap
++
++      has_ssh_forward = false
+       machine.config.vm.networks.each do |type, options|
+         next if type != :forwarded_port
+ 
+         # remap ssh.host to ssh_port
+         if options[:id] == "ssh"
+           remap[options[:host]] = machine.provider_config.ssh_port
++          has_ssh_forward = true
+           break
+         end
+       end
+ 
++      if !has_ssh_forward
++        machine.config.vm.networks.forward_port(22, machine.provider_config.ssh_port, [id: "ssh", auto_correct: true])
++      end
++
+       @app.call(env)
+       end
+     end
+diff --git a/lib/vagrant-qemu/action/start_instance.rb b/lib/vagrant-qemu/action/start_instance.rb
+index 13c1d9d..b434bb3 100644
+--- a/lib/vagrant-qemu/action/start_instance.rb
++++ b/lib/vagrant-qemu/action/start_instance.rb
+@@ -11,6 +11,7 @@ module VagrantPlugins
+         end
+ 
+         def call(env)
++          fwPorts = forwarded_ports(env)
+           options = {
+             :ssh_host => env[:machine].provider_config.ssh_host,
+             :ssh_port => env[:machine].provider_config.ssh_port,
+@@ -23,7 +24,7 @@ module VagrantPlugins
+             :drive_interface => env[:machine].provider_config.drive_interface,
+             :extra_qemu_args => env[:machine].provider_config.extra_qemu_args,
+             :extra_netdev_args => env[:machine].provider_config.extra_netdev_args,
+-            :ports => forwarded_ports(env),
++            :ports => fwPorts,
+             :control_port => env[:machine].provider_config.control_port,
+             :debug_port => env[:machine].provider_config.debug_port,
+             :no_daemonize => env[:machine].provider_config.no_daemonize,
+@@ -43,7 +44,12 @@ module VagrantPlugins
+             next if type != :forwarded_port
+ 
+             # Don't include SSH
+-            next if options[:id] == "ssh"
++            if options[:id] == "ssh"
++              if options[:host] != env[:machine].provider_config.ssh_port
++                  env[:machine].provider_config.ssh_port = options[:host]
++              end
++              next
++            end
+ 
+             # Skip port if it is disabled
+             next if options[:disabled]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-qemu
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.7
 platform: ruby
 authors:
 - ppggff
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2025-02-02 00:00:00.000000000 Z
 dependencies: []
 description: Enables Vagrant to manage machines with QEMU.
 email: pgf00a@gmail.com
@@ -43,6 +43,7 @@ files:
 - lib/vagrant-qemu/version.rb
 - locales/en.yml
 - vagrant-qemu.gemspec
+- x
 homepage: https://github.com/ppggff/vagrant-qemu
 licenses:
 - MIT