vagrant-qemu 0.3.11 → 0.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65b2cb386bb53bca93a879047e5b6a61ac690fd63a55e785b719b2b5379fb678
-  data.tar.gz: b3b4b879c90d4b7df411019f6fe8c80ea572f4751887444fc8e9e041e634ea38
+  metadata.gz: 22e76d0b973e4e459a0780c79265d30b6cd0b48d4e94d28fdc82ef9cccfca37f
+  data.tar.gz: '049fb94522b7197b4d77975da222b033755761d0db699d90c6a98cb1fe49cd33'
 SHA512:
-  metadata.gz: e825fc1bee4029c89a1a0acc9af2b4a2ee1f646976ac64234ef19b57078a43dd32a7330aee2c1da7b63582a3f1358fbe17e0e632e1a5337d9387be5d810ab551
-  data.tar.gz: c989f426b5232f93ca87a5f4564e36c32f42b906ff8dbe3e11f671312535993b85ac888f3a1d823f7cbb4e2c1308c733e66d33e08032a0fe2c16819bd218e5fd
+  metadata.gz: '06901f39eac546967a57ca981739ca160caae09ec28ae9ade2c809bae6862bdeaf61ec8ac8f8cea6fbaba37146323ca08f1bb60bab53433381ac5619bf9f3517'
+  data.tar.gz: c815fe0029b54a7e092543fddbb5769add49393ef5fdd4e84584b8c893a164f88e1d56aebe5251b891dac7bee4a13037366988e22abdbb3189f96b979f338680

data/CHANGELOG.md

@@ -93,3 +93,10 @@
 # 0.3.11 (2025-05-06)
 
 * Re-publish with repacked gem
+
+# 0.3.22 (2025-05-19)
+
+* Add support for extra `-drive` arguments
+* Add `extra_image_opts` to customize image creation
+* Add support for cloud-init and disks
+* Add support for resizing disk on vm setup

data/README.md

@@ -37,6 +37,8 @@ Others:
 * Synced folder support via SMB
 * Basic operation: up, ssh, halt, destroy
 * Basic suport to forwarded ports, see [vagrant doc](https://www.vagrantup.com/docs/networking/forwarded_ports) for details
+* Support Cloud-init, see [vagrant doc](https://developer.hashicorp.com/vagrant/docs/cloud-init/usage) for details
+* Support Disks, see [vagrant doc](https://developer.hashicorp.com/vagrant/docs/disks/usage) for details
 
 ## Usage
 
@@ -84,6 +86,7 @@ This provider exposes a few provider-specific configuration options:
   * `cpu` - The cpu model of VM, default: `cortex-a72`
   * `smp` - The smp setting (Simulate an SMP system with n CPUs) of VM, default: `2`
   * `memory` - The memory setting of VM, default: `4G`
+  * `disk_resize` - The target disk size of the primary disk, requires resizing of filesystem inside of VM, default: `nil`.
 * 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`
@@ -94,11 +97,13 @@ This provider exposes a few provider-specific configuration options:
   * `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)
+  * `extra_drive_args` - Add optional extra arguments to each drive attached, default: `[]`
   * `control_port` - The port number used to control vm from vagrant, default is nil value. (nil means use unix socket)
   * `debug_port` - The port number used to export serial port of the vm for debug, default is nil value. (nil means use unix socket, see "Debug" below for details)
   * `no_daemonize` - Disable the "daemonize" mode of QEMU, default is false. (see "Windows host" below as example)
   * `firmware_format` - The format of aarch64 firmware images (`edk2-aarch64-code.fd` and `edk2-arm-vars.fd`) loaded from `qemu_dir`, default: `raw`
   * `other_default` - The other default arguments used by this plugin, default: `%W(-parallel null -monitor none -display none -vga none)`
+  * `extra_image_opts` - Options passed via `-o` to `qemu-img` when the base qcow2 images are created, default: `[]`
 
 ### Usage
 
@@ -273,6 +278,32 @@ Thanks example from @Leandros.
 
 See [pr#73](https://github.com/ppggff/vagrant-qemu/pull/73) for details.
 
+11. Improved VM I/O performance
+
+When creating the disks that are attached, each disk is an id assign in order
+they appear in the `Vagrantfile`. The primary disk has the `id` of `disk0`.
+
+```ruby
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider "qemu" do |qe|
+    # Use a `none` drive interface.
+    qe.drive_interface = "none"
+    qe.extra_drive_args = "cache=none,aio=threads"
+
+    # To improve I/O performance, create a separate I/O thread.
+    # We refer to the primary disk as `disk0`.
+    qe.extra_qemu_args = %w(
+        -object iothread,id=io1
+        -device virtio-blk-pci,drive=disk0,iothread=io1
+    )
+  end
+end
+```
+
+See the [QEMU Documentation](https://www.qemu.org/docs/master/devel/multiple-iothreads.html) and [heiko-sieger.info/tuning-vm-disk-performance/](https://www.heiko-sieger.info/tuning-vm-disk-performance/) for more details.
+
 ## Debug
 
 Serial port is exported to unix socket: `<user_home>/.vagrant.d/tmp/vagrant-qemu/<id>/qemu_socket_serial`, or `debug_port`.

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

@@ -75,7 +75,9 @@ module VagrantPlugins
             :image_path => image_path,
             :qemu_dir => qemu_dir,
             :arch => env[:machine].provider_config.arch,
-            :firmware_format => env[:machine].provider_config.firmware_format
+            :firmware_format => env[:machine].provider_config.firmware_format,
+            :extra_image_opts => env[:machine].provider_config.extra_image_opts,
+            :disk_resize => env[:machine].provider_config.disk_resize,
           }
 
           env[:ui].detail("Creating and registering the VM...")

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

@@ -25,12 +25,14 @@ module VagrantPlugins
             :qemu_bin => env[:machine].provider_config.qemu_bin,
             :extra_qemu_args => env[:machine].provider_config.extra_qemu_args,
             :extra_netdev_args => env[:machine].provider_config.extra_netdev_args,
+            :extra_drive_args => env[:machine].provider_config.extra_drive_args,
             :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,
             :firmware_format => env[:machine].provider_config.firmware_format,
-            :other_default => env[:machine].provider_config.other_default
+            :other_default => env[:machine].provider_config.other_default,
+            :extra_image_opts => env[:machine].provider_config.extra_image_opts,
           }
 
           env[:ui].output(I18n.t("vagrant_qemu.starting"))

data/lib/vagrant-qemu/action.rb

@@ -115,6 +115,9 @@ module VagrantPlugins
               next
             end
 
+            b1.use CloudInitSetup
+            b1.use CleanupDisks
+            b1.use Disk
             b1.use Provision
             b1.use EnvSet, port_collision_repair: true
             b1.use PrepareForwardedPortCollisionParams

data/lib/vagrant-qemu/cap/disk.rb

@@ -0,0 +1,104 @@
+require "log4r"
+
+module VagrantPlugins
+  module QEMU
+    module Cap
+      module Disk
+        @@logger = Log4r::Logger.new("vagrant_qemu::cap::disk")
+
+        DEFAULT_DISK_EXT_LIST = ["qcow2", "iso"].map(&:freeze).freeze
+        DEFAULT_DISK_EXT = "qcow2".freeze
+
+        # @param [Vagrant::Machine] machine
+        # @return [String]
+        def self.set_default_disk_ext(machine)
+          DEFAULT_DISK_EXT
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @return [Array]
+        def self.default_disk_exts(machine)
+          DEFAULT_DISK_EXT_LIST
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @param [String] disk_ext
+        # @return [Bool]
+        def self.validate_disk_ext(machine, disk_ext)
+          DEFAULT_DISK_EXT_LIST.include?(disk_ext)
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @param [VagrantPlugins::Kernel_V2::VagrantConfigDisk] defined_disks
+        # @return [Hash] configured_disks - A hash of all the current configured disks
+        def self.configure_disks(machine, defined_disks)
+          return {} if defined_disks.empty?
+
+          configured_disks = {disk: [], floppy: [], dvd: []}
+          defined_disks.each do |disk|
+            @@logger.info("Disk: #{disk.to_yaml}")
+            case disk.type
+            when :disk
+              disk_data = setup_disk(machine, disk)
+              if !disk_data.empty?
+                configured_disks[:disk] << disk_data
+                machine.provider.driver.attach_disk(disk_data)
+              end
+            when :floppy
+              machine.ui.info(I18n.t("vagrant_qemu.errors.floppy_unsupported"))
+            when :dvd
+              disk_data = setup_dvd(machine, disk)
+              if !disk_data.empty?
+                configured_disks[:dvd] << disk_data
+                machine.provider.driver.attach_dvd(disk_data)
+              end
+            else
+              @@logger.info("unsupported disk type: #{disk.type}")
+            end
+          end
+
+          configured_disks
+        end
+
+        # @param [Vagrant::Machine] machine
+        # @param [VagrantPlugins::Kernel_V2::VagrantConfigDisk] defined_disks
+        # @param [Hash] disk_meta - A hash of all the previously defined disks
+        #                           from the last configure_disk action
+        # @return [nil]
+        def self.cleanup_disks(machine, defined_disks, disk_meta)
+          return if disk_meta.values.flatten.empty?
+        end
+
+        protected
+
+        # Sets up all disk configs of type `:disk`
+        #
+        # @param [Vagrant::Machine] machine - the current machine
+        # @param [Config::Disk] disk - the current disk to configure
+        # @return [Hash] - disk_metadata
+        def self.setup_disk(machine, disk)
+          disk_dir = machine.provider.driver.disk_dir
+          disk_path = disk_dir.join("#{disk.name}.#{disk.disk_ext}")
+          args = ["create", "-f", "qcow2"]
+
+          disk_provider_config = disk.provider_config[:qemu] if disk.provider_config
+          args.push(disk_path.to_s)
+          args.push("#{disk.size}")
+          machine.provider.driver.execute("qemu-img", *args)
+
+          {UUID: disk.id, Name: disk.name, Path: disk_path.to_s, primary: !!disk.primary}
+        end
+
+        # Sets up all disk configs of type `:dvd`
+        #
+        # @param [Vagrant::Machine] machine - the current machine
+        # @param [Config::Disk] disk - the current disk to configure
+        # @return [Hash] - disk_metadata
+        def self.setup_dvd(machine, disk)
+          {UUID: disk.id, Name: disk.name, Path: disk.file, primary: !!disk.primary}
+        end
+
+      end
+    end
+  end
+end

data/lib/vagrant-qemu/cap.rb

@@ -0,0 +1,8 @@
+
+module VagrantPlugins
+  module QEMU
+    module Cap
+      autoload :Disk, "vagrant-qemu/cap/disk"
+    end
+  end
+end

data/lib/vagrant-qemu/config.rb

@@ -16,13 +16,16 @@ module VagrantPlugins
       attr_accessor :image_path
       attr_accessor :qemu_bin
       attr_accessor :qemu_dir
+      attr_accessor :disk_resize
       attr_accessor :extra_qemu_args
       attr_accessor :extra_netdev_args
+      attr_accessor :extra_drive_args
       attr_accessor :control_port
       attr_accessor :debug_port
       attr_accessor :no_daemonize
       attr_accessor :firmware_format
       attr_accessor :other_default
+      attr_accessor :extra_image_opts
 
       def initialize
         @ssh_host = UNSET_VALUE
@@ -38,13 +41,16 @@ module VagrantPlugins
         @image_path = UNSET_VALUE
         @qemu_bin = UNSET_VALUE
         @qemu_dir = UNSET_VALUE
+        @disk_resize = UNSET_VALUE
         @extra_qemu_args = UNSET_VALUE
         @extra_netdev_args = UNSET_VALUE
+        @extra_drive_args = UNSET_VALUE
         @control_port = UNSET_VALUE
         @debug_port = UNSET_VALUE
         @no_daemonize = UNSET_VALUE
         @firmware_format = UNSET_VALUE
         @other_default = UNSET_VALUE
+        @extra_image_opts = UNSET_VALUE
       end
 
       #-------------------------------------------------------------------
@@ -70,13 +76,16 @@ module VagrantPlugins
         @image_path = nil if @image_path == UNSET_VALUE
         @qemu_bin = nil if @qemu_bin == UNSET_VALUE
         @qemu_dir = "/opt/homebrew/share/qemu" if @qemu_dir == UNSET_VALUE
+        @disk_resize = nil if @disk_resize == UNSET_VALUE
         @extra_qemu_args = [] if @extra_qemu_args == UNSET_VALUE
         @extra_netdev_args = nil if @extra_netdev_args == UNSET_VALUE
+        @extra_drive_args = nil if @extra_drive_args == UNSET_VALUE
         @control_port = nil if @control_port == UNSET_VALUE
         @debug_port = nil if @debug_port == UNSET_VALUE
         @no_daemonize = false if @no_daemonize == UNSET_VALUE
         @firmware_format = "raw" if @firmware_format == UNSET_VALUE
         @other_default = %W(-parallel null -monitor none -display none -vga none) if @other_default == UNSET_VALUE
+        @extra_image_opts = nil if @extra_image_opts == UNSET_VALUE
 
         # TODO better error msg
         @ssh_port = Integer(@ssh_port)

data/lib/vagrant-qemu/driver.rb

@@ -1,3 +1,4 @@
+require 'log4r'
 require 'childprocess'
 require 'securerandom'
 require 'yaml'
@@ -16,11 +17,14 @@ module VagrantPlugins
       attr_reader :vm_id
       attr_reader :data_dir
       attr_reader :tmp_dir
+      attr_reader :attached_drives
 
       def initialize(id, dir, tmp)
         @vm_id = id
         @data_dir = dir
         @tmp_dir = tmp.join("vagrant-qemu")
+        @attached_drives = {disk: [], floppy: [], dvd: []}
+        @logger = Log4r::Logger.new("vagrant_qemu::driver")
       end
 
       def get_current_state
@@ -112,9 +116,16 @@ module VagrantPlugins
           end
 
           # drive
+          diskid = 0
+          extra_drive_args = ""
+          if !options[:extra_drive_args].nil?
+            extra_drive_args = ",#{options[:extra_drive_args]}"
+          end
+
           if !options[:drive_interface].nil?
             image_path.each do |img|
-              cmd += %W(-drive if=#{options[:drive_interface]},format=qcow2,file=#{img})
+              cmd += %W(-drive if=#{options[:drive_interface]},id=disk#{diskid},format=qcow2,file=#{img}#{extra_drive_args})
+              diskid += 1
             end
           end
           if options[:arch] == "aarch64" && !options[:firmware_format].nil?
@@ -124,6 +135,18 @@ module VagrantPlugins
             cmd += %W(-drive if=pflash,format=#{options[:firmware_format]},file=#{fm2_path})
           end
 
+          dvd_index = 1
+          @attached_drives[:dvd].each do |disk|
+            cmd += %W(-drive file=#{disk[:Path]},index=#{dvd_index},media=cdrom)
+            dvd_index += 1
+          end
+          if !options[:drive_interface].nil?
+            @attached_drives[:disk].each do |disk|
+              cmd += %W(-drive if=#{options[:drive_interface]},id=disk#{diskid},format=qcow2,file=#{disk[:Path]}#{extra_drive_args})
+              diskid += 1
+            end
+          end
+
           # control
           pid_file = id_tmp_dir.join("qemu.pid").to_s
           cmd += %W(-chardev socket,id=mon0,#{control_socket},server=on,wait=off)
@@ -197,7 +220,26 @@ module VagrantPlugins
         # Create image
         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)
+
+          linked_image = id_dir.join("linked-box#{suffix_index}.img").to_s
+          args = ["create", "-f", "qcow2", "-F", "qcow2", "-b", img.to_s]
+
+          if !options[:extra_image_opts].nil?
+            options[:extra_image_opts].each do |opt|
+              args.push("-o")
+              args.push(opt)
+            end
+          end
+
+          args.push(linked_image)
+
+          if i == 0
+            if !options[:disk_resize].nil?
+              args.push(options[:disk_resize])
+            end
+          end
+
+          execute("qemu-img",  *args)
         end
 
         server = {
@@ -309,6 +351,18 @@ module VagrantPlugins
           end
         end
       end
+
+      def attach_dvd(disk)
+        @attached_drives[:dvd] << disk
+      end
+
+      def attach_disk(disk)
+        @attached_drives[:disk] << disk
+      end
+
+      def disk_dir
+          @data_dir.join(@vm_id)
+      end
     end
   end
 end

data/lib/vagrant-qemu/plugin.rb

@@ -24,6 +24,31 @@ module VagrantPlugins
         Config
       end
 
+      provider_capability(:qemu, :set_default_disk_ext) do
+        require File.expand_path("../cap/disk", __FILE__)
+        Cap::Disk
+      end
+
+      provider_capability(:qemu, :default_disk_exts) do
+        require File.expand_path("../cap/disk", __FILE__)
+        Cap::Disk
+      end
+
+      provider_capability(:qemu, :configure_disks) do
+        require File.expand_path("../cap/disk", __FILE__)
+        Cap::Disk
+      end
+
+      provider_capability(:qemu, :cleanup_disks) do
+        require File.expand_path("../cap/disk", __FILE__)
+        Cap::Disk
+      end
+
+      provider_capability(:qemu, :validate_disk_ext) do
+        require File.expand_path("../cap/disk", __FILE__)
+        Cap::Disk
+      end
+
       provider(:qemu, box_format: "libvirt", box_optional: true, parallel: true) do
         # Setup logging and i18n
         setup_logging

data/lib/vagrant-qemu/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module QEMU
-    VERSION = '0.3.11'
+    VERSION = '0.3.12'
   end
 end

data/lib/vagrant-qemu.rb

@@ -6,6 +6,7 @@ module VagrantPlugins
   module QEMU
     lib_path = Pathname.new(File.expand_path("../vagrant-qemu", __FILE__))
     autoload :Action, lib_path.join("action")
+    autoload :Cap, lib_path.join("cap")
     autoload :Errors, lib_path.join("errors")
 
     # This returns the path to the source of this plugin.

data/locales/en.yml

@@ -58,3 +58,5 @@ en:
         Invalid config.
 
         Error: %{err}
+      floppy_unsupported: |-
+        Floppy disks not supported

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-qemu
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.3.12
 platform: ruby
 authors:
 - ppggff
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-05-06 00:00:00.000000000 Z
+date: 2025-05-20 00:00:00.000000000 Z
 dependencies: []
 description: Enables Vagrant to manage machines with QEMU.
 email: pgf00a@gmail.com
@@ -34,6 +34,8 @@ files:
 - lib/vagrant-qemu/action/start_instance.rb
 - lib/vagrant-qemu/action/stop_instance.rb
 - lib/vagrant-qemu/action/warn_networks.rb
+- lib/vagrant-qemu/cap.rb
+- lib/vagrant-qemu/cap/disk.rb
 - lib/vagrant-qemu/config.rb
 - lib/vagrant-qemu/driver.rb
 - lib/vagrant-qemu/errors.rb