vagrant-qemu 0.1.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b46cfaa2964de5f308d27d5547506b100bb794ab6bbf24be6cd9cef45af02079
-  data.tar.gz: a94f3b9be8cec1a6bc0834bee7db2818a233678a6281dba2b3b62272b8618749
+  metadata.gz: d41d79a9352f176fa81c510f886f0ed1df1ca82d57d1956ee5f39b5a7e88cd4f
+  data.tar.gz: 27fa931a926e246aa8235ccb45b984603b103d9a0e3a8d098bb0a95be094057c
 SHA512:
-  metadata.gz: a5b9b84028dc8625e775fb058ed25bbe19f1eb5d0f12b3c2ba3ad65a35310305ac2ebe6ee4129ca1b1db7d548f3ecf25f14e0893a161be06167f29635530ad4d
-  data.tar.gz: d203be0515807c605c83e0206f4fcadbc9550455de9cea4554f4e8948fc57601e25aa9eb75fc3532909c885f39522d35f7de443d2af49e59da6847a043ecd61e
+  metadata.gz: 6e5034e4bfae98b9e28a456b4c83e8bb3180681eb44239caa1ff95b38d4abd535a299b2db4ce8c47005b764479d201abf4277561562a671651f3619cf6ed9279
+  data.tar.gz: 1f5e62e279fa5a751980d5d9038fe0a1521e6b8acf5862f28e3b3d471baf8107e7510957303755c96996a5111568585ab913766b30c7c0875218b928d14a68d2

data/CHANGELOG.md

@@ -30,3 +30,19 @@
 # 0.1.9 (2022-08-01)
 
 * Set default config for newer qemu (>=7.0.0)
+
+# 0.2.0 (2022-08-31)
+
+* Add config extra_qemu_args'.
+* Refine error message, such as 'Invalid qemu dir'.
+* Add a 'Force Multicore' to Readme.
+
+# 0.3.0 (2022-09-16)
+
+* Add config extra_netdev_args.
+* Replace `nc` with ruby's socket
+* Add config control_port, debug_port, no_daemonize config for window host
+
+# 0.3.1 (2022-09-16)
+
+* Fix missing :arch for driver.import(options)

data/README.md

@@ -73,16 +73,23 @@ Same as [vagrant-libvirt version-1](https://github.com/vagrant-libvirt/vagrant-l
 
 This provider exposes a few provider-specific configuration options:
 
-* `ssh_port` - The SSH port number used to access VM (IP is 127.0.0.1),
+* basic
+  * `ssh_port` - The SSH port number used to access VM (IP is 127.0.0.1),
   default: `50022`
-* `arch` - The architecture of VM, default: `aarch64`
-* `machine` - The machine type of VM, default: `virt,accel=hvf,highmem=off`
-* `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`
-* `net_device` - The network device, default: `virtio-net-device`
-* `image_path` - The path 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`
+  * `arch` - The architecture of VM, default: `aarch64`
+  * `machine` - The machine type of VM, default: `virt,accel=hvf,highmem=off`
+  * `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`
+* debug/expert
+  * `net_device` - The network device, default: `virtio-net-device`
+  * `image_path` - The path 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)
+  * `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)
 
 These can be set like typical provider-specific configuration:
 
@@ -157,16 +164,73 @@ Vagrant.configure(2) do |config|
 end
 ```
 
+6. Force Multicore (x86)
+
+Thanks to [taraszka](https://github.com/taraszka) for providing this config.
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "centos/7"
+
+  config.vm.provider "qemu" do |qe|
+    qe.arch = "x86_64"
+    qe.machine = "q35"
+    qe.cpu = "max"
+    qe.smp = "cpus=2,sockets=1,cores=2,threads=1"
+    qe.net_device = "virtio-net-pci"
+    qe.extra_qemu_args = %w(-accel tcg,thread=multi,tb-size=512)
+    qe.qemu_dir = "/usr/local/share/qemu"
+  end
+end
+```
+
+7. Force Local IP
+
+```
+Vagrant.configure("2") do |config|
+  config.vm.box = "debian/bullseye64"
+
+  config.vm.provider "qemu" do |qe|
+    qe.extra_netdev_args = "net=192.168.51.0/24,dhcpstart=192.168.51.10"
+  end
+end
+```
+
+8. Windows host
+
+Windows version QEMU doesn't support `daemonize` mode and unix socket
+(Notes: not tested)
+
+```
+Vagrant.configure("2") do |config|
+  # ... other stuff
+
+  config.vm.provider "qemu" do |qe|
+    qe.no_daemonize = true
+    qe.control_port = 33333
+    qe.debug_port = 33334
+  end
+end
+```
+
 ## Debug
 
-Serial port is exported to unix socket: `<user_home>/.vagrant.d/tmp/vagrant-qemu/<id>/qemu_socket_serial`.
+Serial port is exported to unix socket: `<user_home>/.vagrant.d/tmp/vagrant-qemu/<id>/qemu_socket_serial`, or `debug_port`.
+
 To debug and login to the GuestOS from serial port:
 
-1. Get the id: `.vagrant/machines/default/qemu/id` in same directory with `Vagrantfile`
-2. Get the path to `qemu_socket_serial`
-3. Use `nc` to connect: `nc -U /Users/.../qemu_socket_serial`
+* unix socket
+  1. Get the id: `.vagrant/machines/default/qemu/id` in same directory with `Vagrantfile`
+  2. Get the path to `qemu_socket_serial`
+  3. Use `nc` to connect: `nc -U /Users/.../qemu_socket_serial`
+* `debug_port` (for example: 33334)
+  * Use `nc` to connect: `nc localhost 33334`
 
-To send ctrl+c to GuestOS from `nc`, try `echo 03 | xxd -r -p | nc -U /Users/.../qemu_socket_serial`
+To send ctrl+c to GuestOS from `nc`, try:
+* unix socket
+  * `echo 03 | xxd -r -p | nc -U /Users/.../qemu_socket_serial`
+* `debug_port` (for example: 33334)
+  * `echo 03 | xxd -r -p | nc localhost 33334`
 
 ## Build
 
@@ -226,6 +290,22 @@ If you get this error when running `vagrant up`
 4. Click Done
 5. Run `vagrant up` again
 
+### 4. The box you're using with the QEMU provider ('default') is invalid
+
+This may cause by invalid default qemu dir (`/opt/homebrew/share/qemu`).
+
+You can find the correct one by:
+```
+echo `brew --prefix`/share/qemu
+```
+
+And then set it (for example `/usr/local/share/qemu`) in the `Vagrantfile` as:
+```
+config.vm.provider "qemu" do |qe|
+  qe.qemu_dir = "/usr/local/share/qemu"
+end
+```
+
 ## TODO
 
 * Support NFS shared folder

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

@@ -21,7 +21,7 @@ module VagrantPlugins
 
           if !image_path || !image_path.file?
             @logger.error("Invalid box image path: #{image_path}")
-            raise Errors::BoxInvalid, name: env[:machine].name
+            raise Errors::BoxInvalid, name: env[:machine].name, err: "Invalid box image path: #{image_path}"
           else
             @logger.info("Found box image path: #{image_path}")
           end
@@ -29,7 +29,7 @@ module VagrantPlugins
           qemu_dir = Pathname.new(env[:machine].provider_config.qemu_dir)
           if !qemu_dir.directory?
             @logger.error("Invalid qemu dir: #{qemu_dir}")
-            raise Errors::BoxInvalid, name: env[:machine].name
+            raise Errors::ConfigError, err: "Invalid qemu dir: #{qemu_dir}"
           else
             @logger.info("Found qemu dir: #{qemu_dir}")
           end
@@ -39,6 +39,7 @@ module VagrantPlugins
           options = {
             :image_path => image_path,
             :qemu_dir => qemu_dir,
+            :arch => env[:machine].provider_config.arch,
           }
 
           env[:ui].detail("Creating and registering the VM...")

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

@@ -19,7 +19,12 @@ module VagrantPlugins
             :smp => env[:machine].provider_config.smp,
             :memory => env[:machine].provider_config.memory,
             :net_device => env[:machine].provider_config.net_device,
-            :ports => forwarded_ports(env)
+            :extra_qemu_args => env[:machine].provider_config.extra_qemu_args,
+            :extra_netdev_args => env[:machine].provider_config.extra_netdev_args,
+            :ports => forwarded_ports(env),
+            :control_port => env[:machine].provider_config.control_port,
+            :debug_port => env[:machine].provider_config.debug_port,
+            :no_daemonize => env[:machine].provider_config.no_daemonize
           }
 
           env[:ui].output(I18n.t("vagrant_qemu.starting"))

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

@@ -8,8 +8,12 @@ module VagrantPlugins
         end
 
         def call(env)
+          options = {
+            :control_port => env[:machine].provider_config.control_port
+          }
+
           env[:ui].info(I18n.t("vagrant_qemu.stopping"))
-          env[:machine].provider.driver.stop
+          env[:machine].provider.driver.stop(options)
           @app.call(env)
         end
       end

data/lib/vagrant-qemu/config.rb

@@ -12,6 +12,11 @@ module VagrantPlugins
       attr_accessor :net_device
       attr_accessor :image_path
       attr_accessor :qemu_dir
+      attr_accessor :extra_qemu_args
+      attr_accessor :extra_netdev_args
+      attr_accessor :control_port
+      attr_accessor :debug_port
+      attr_accessor :no_daemonize
 
       def initialize
         @ssh_port = UNSET_VALUE
@@ -23,6 +28,11 @@ module VagrantPlugins
         @net_device = UNSET_VALUE
         @image_path = UNSET_VALUE
         @qemu_dir = UNSET_VALUE
+        @extra_qemu_args = UNSET_VALUE
+        @extra_netdev_args = UNSET_VALUE
+        @control_port = UNSET_VALUE
+        @debug_port = UNSET_VALUE
+        @no_daemonize = UNSET_VALUE
       end
 
       #-------------------------------------------------------------------
@@ -44,6 +54,11 @@ module VagrantPlugins
         @net_device = "virtio-net-device" if @net_device == UNSET_VALUE
         @image_path = nil if @image_path == UNSET_VALUE
         @qemu_dir = "/opt/homebrew/share/qemu" if @qemu_dir == UNSET_VALUE
+        @extra_qemu_args = [] if @extra_qemu_args == UNSET_VALUE
+        @extra_netdev_args = nil if @extra_netdev_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
       end
 
       def validate(machine)

data/lib/vagrant-qemu/driver.rb

@@ -1,6 +1,9 @@
+require 'childprocess'
 require 'securerandom'
 
 require "vagrant/util/busy"
+require 'vagrant/util/io'
+require "vagrant/util/safe_chdir"
 require "vagrant/util/subprocess"
 
 require_relative "plugin"
@@ -47,8 +50,22 @@ module VagrantPlugins
 
           id_tmp_dir = @tmp_dir.join(@vm_id)
           FileUtils.mkdir_p(id_tmp_dir)
-          unix_socket_path = id_tmp_dir.join("qemu_socket").to_s
-          unix_socket_serial_path = id_tmp_dir.join("qemu_socket_serial").to_s
+
+          control_socket = ""
+          if !options[:control_port].nil?
+            control_socket = "port=#{options[:control_port]},host=localhost,ipv4=on"
+          else
+            unix_socket_path = id_tmp_dir.join("qemu_socket").to_s
+            control_socket = "path=#{unix_socket_path}"
+          end
+
+          debug_socket = ""
+          if !options[:debug_port].nil?
+            debug_socket = "port=#{options[:debug_port]},host=localhost,ipv4=on"
+          else
+            unix_socket_serial_path = id_tmp_dir.join("qemu_socket_serial").to_s
+            debug_socket = "path=#{unix_socket_serial_path}"
+          end
 
           cmd = []
           cmd += %W(qemu-system-#{options[:arch]})
@@ -65,7 +82,11 @@ module VagrantPlugins
           options[:ports].each do |v|
             hostfwd += ",hostfwd=#{v}"
           end
-          cmd += %W(-netdev user,id=net0,#{hostfwd})
+          extra_netdev = ""
+          if !options[:extra_netdev_args].nil?
+            extra_netdev = ",#{options[:extra_netdev_args]}"
+          end
+          cmd += %W(-netdev user,id=net0,#{hostfwd}#{extra_netdev})
 
           # drive
           cmd += %W(-drive if=virtio,format=qcow2,file=#{image_path})
@@ -77,32 +98,40 @@ module VagrantPlugins
           end
 
           # control
-          cmd += %W(-chardev socket,id=mon0,path=#{unix_socket_path},server=on,wait=off)
+          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,path=#{unix_socket_serial_path},server=on,wait=off)
+          cmd += %W(-chardev socket,id=ser0,#{debug_socket},server=on,wait=off)
           cmd += %W(-serial chardev:ser0)
           cmd += %W(-pidfile #{pid_file})
           cmd += %W(-parallel null -monitor none -display none -vga none)
-          cmd += %W(-daemonize)
+          if !options[:no_daemonize]
+            cmd += %W(-daemonize)
+          end
 
-          execute(*cmd)
+          # user-defined
+          cmd += options[:extra_qemu_args]
+
+          execute(*cmd, {:detach => options[:no_daemonize]})
         end
       end
 
-      def stop
+      def stop(options)
         if running?
-          id_tmp_dir = @tmp_dir.join(@vm_id)
-          unix_socket_path = id_tmp_dir.join("qemu_socket").to_s
-          sent = false
-          execute("nc", "-w", "5", "-U", unix_socket_path) do |type, data|
-            case type
-            when :stdin
-              if !sent
-                data.write("system_powerdown\n")
-                sent = true
-              end
+          if !options[:control_port].nil?
+            Socket.tcp("localhost", options[:control_port], connect_timeout: 5) do |sock|
+              sock.print "system_powerdown\n"
+              sock.close_write
+              sock.read
             end
-          end
+          else
+            id_tmp_dir = @tmp_dir.join(@vm_id)
+            unix_socket_path = id_tmp_dir.join("qemu_socket").to_s
+            Socket.unix(unix_socket_path) do |sock|
+              sock.print "system_powerdown\n"
+              sock.close_write
+              sock.read
+            end
+         end
         end
       end
 
@@ -116,8 +145,10 @@ module VagrantPlugins
         FileUtils.mkdir_p(id_tmp_dir)
 
         # Prepare firmware
-        execute("cp", options[:qemu_dir].join("edk2-aarch64-code.fd").to_s, id_dir.join("edk2-aarch64-code.fd").to_s)
-        execute("cp", options[:qemu_dir].join("edk2-arm-vars.fd").to_s, id_dir.join("edk2-arm-vars.fd").to_s)
+        if options[:arch] == "aarch64"
+          execute("cp", options[:qemu_dir].join("edk2-aarch64-code.fd").to_s, id_dir.join("edk2-aarch64-code.fd").to_s)
+          execute("cp", options[:qemu_dir].join("edk2-arm-vars.fd").to_s, id_dir.join("edk2-arm-vars.fd").to_s)
+        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)
@@ -144,13 +175,73 @@ module VagrantPlugins
       end
 
       def execute(*cmd, **opts, &block)
-        # Append in the options for subprocess
-        cmd << { notify: [:stdout, :stderr, :stdin] }
+        result = nil
+
+        if opts && opts[:detach]
+          # give it some time to startup
+          timeout = 5
+
+          # edit version of "Subprocess.execute" for detach
+          workdir = Dir.pwd
+          process = ChildProcess.build(*cmd)
+
+          stdout, stdout_writer = ::IO.pipe
+          stderr, stderr_writer = ::IO.pipe
+          process.io.stdout = stdout_writer
+          process.io.stderr = stderr_writer
+
+          process.leader = true
+          process.detach = true
 
-        interrupted  = false
-        int_callback = ->{ interrupted = true }
-        result = ::Vagrant::Util::Busy.busy(int_callback) do
-          ::Vagrant::Util::Subprocess.execute(*cmd, &block)
+          ::Vagrant::Util::SafeChdir.safe_chdir(workdir) do
+            process.start
+          end
+
+          if RUBY_PLATFORM != "java"
+            stdout_writer.close
+            stderr_writer.close
+          end
+
+          io_data = { stdout: "", stderr: "" }
+          start_time = Time.now.to_i
+          open_readers = [stdout, stderr]
+
+          while true
+            results = ::IO.select(open_readers, nil, nil, 0.1)
+            results ||= []
+            readers = results[0]
+
+            # Check if we have exceeded our timeout
+            return if (Time.now.to_i - start_time) > timeout
+
+            if readers && !readers.empty?
+              readers.each do |r|
+                data = ::Vagrant::Util::IO.read_until_block(r)
+                next if data.empty?
+
+                io_name = r == stdout ? :stdout : :stderr
+                io_data[io_name] += data
+              end
+            end
+
+            break if process.exited?
+          end
+
+          if RUBY_PLATFORM == "java"
+            stdout_writer.close
+            stderr_writer.close
+          end
+
+          result = ::Vagrant::Util::Subprocess::Result.new(process.exit_code, io_data[:stdout], io_data[:stderr])
+        else
+          # Append in the options for subprocess
+          cmd << { notify: [:stdout, :stderr, :stdin] }
+
+          interrupted  = false
+          int_callback = ->{ interrupted = true }
+          result = ::Vagrant::Util::Busy.busy(int_callback) do
+            ::Vagrant::Util::Subprocess.execute(*cmd, &block)
+          end
         end
 
         result.stderr.gsub!("\r\n", "\n")

data/lib/vagrant-qemu/errors.rb

@@ -26,6 +26,10 @@ module VagrantPlugins
       class ExecuteError < VagrantQEMUError
         error_key(:execute_error)
       end
+
+      class ConfigError < VagrantQEMUError
+        error_key(:config_error)
+      end
     end
   end
 end

data/lib/vagrant-qemu/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module QEMU
-    VERSION = '0.1.9'
+    VERSION = '0.3.1'
   end
 end

data/locales/en.yml

@@ -42,6 +42,8 @@ en:
       box_invalid: |-
         The box you're using with the QEMU provider ('%{name}')
         is invalid.
+
+        Error: %{err}
       execute_error: |-
         A command executed by Vagrant didn't complete successfully!
         The command run along with the output from the command is shown
@@ -52,3 +54,7 @@ en:
         Stderr: %{stderr}
 
         Stdout: %{stdout}
+      config_error: |-
+        Invalid config.
+
+        Error: %{err}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-qemu
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.3.1
 platform: ruby
 authors:
 - ppggff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies: []
 description: Enables Vagrant to manage machines with QEMU.
 email: pgf00a@gmail.com