qemu-toolkit 0.3.5 → 0.5.0

data/doc/README.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "QEMU\-TOOLKIT" "7" "December 2012" "" "qemu-toolkit"
+.TH "QEMU\-TOOLKIT" "7" "April 2013" "" "qemu-toolkit"
 .
 .SH "NAME"
 \fBqemu\-toolkit\fR \- A toolkit for running qemu on Illumos / OmniOS

data/doc/qemu-toolkit-configuration.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "QEMU\-TOOLKIT\-CONFIGURATION" "7" "December 2012" "" "qemu-toolkit"
+.TH "QEMU\-TOOLKIT\-CONFIGURATION" "7" "April 2013" "" "qemu-toolkit"
 .
 .SH "NAME"
 \fBqemu\-toolkit\-configuration\fR \- configuration for qemu\-toolkit
@@ -46,6 +46,25 @@ lan \'vm1\', \'1:8:20:52:a6:7e\'
 .
 .SS "available options"
 Here\'s a list of configuration options within the virtual_machine declaration:
+.
+.TP
+boot \fIOPTIONS\fR
+Configures the boot order of the virtual machine\. Use the \'order\' option to configure boot order; use the \'once\' option to configure the first boot of the machine\. For more options, please see the QEMU documentation on \'\-boot\'\.
+.
+.IP "" 4
+.
+.nf
+
+# Boot off the CDROM device, alyways
+boot order: \'d\'
+
+# Boot off the CDROM the next time, otherwise from harddisk first
+boot order: \'c\', once: \'dc\'
+.
+.fi
+.
+.IP "" 0
+
 .
 .TP
 cpus \fINUMBER\fR
@@ -155,7 +174,13 @@ Add a virtual network card to the guest\. Virtual network cards are made to corr
 The \fBvia:\fR option takes either physical links or etherstub switches as value\. You can also specify a VLAN tag, separated by a colon\. (ie: e1000g0:4)
 .
 .IP
-nic \fBmodel:\fR will default to \fBvirtio\fR\.
+You \fImust\fR specify a \fBmacaddr:\fR option using an address that is unique on your network\. No checking is done for this in qemu\-toolkit\. This is a limitation that will be lifted in future versions\.
+.
+.IP
+nic \fBmodel:\fR will default to \fBvirtio\fR\. The \fBvirtio\fR driver will be configured for maximum throughput by setting driver options directly as smartos does\. This optimisation may change over time, but will always try to optimise throughput and availability\.
+.
+.IP
+To configure the DHCP server that kvm has built in, use \fBip:\fR, \fBnetmask:\fR, \fBgateway:\fR, \fBhostname:\fR and \fBdns_ip:\fR options\. Please see the example below\.
 .
 .IP
 NOTE: QEMU/kvm on Illumos will default to providing a single pseudo\-nic that has a DHCP server attached to it by default\. If you do not specify a \fBnic\fR, this is what you\'ll get\.
@@ -166,6 +191,11 @@ NOTE: QEMU/kvm on Illumos will default to providing a single pseudo\-nic that ha
 
 # Create eth0 interface with given mac address via \'igb1\'\.
 nic \'eth0\', macaddr: \'2:8:20:52:a6:7e\', via: \'igb1\'
+
+# Create an interface and provide the IP address by built\-in DHCP
+nic \'eth1\', macaddr: \'\.\.\.\', via: \'igb2\',
+  ip: \'10\.0\.0\.2\', netmask: \'255\.255\.255\.0\', gateway: \'10\.0\.0\.1\',
+  hostname: \'test\', dns_ip0: \'8\.8\.8\.8\', dns_ip1: \'8\.8\.4\.4\'
 .
 .fi
 .

data/doc/qemu-toolkit-configuration.7.ronn

@@ -31,6 +31,18 @@ calls. Here's an example we've used in the wild:
 
 Here's a list of configuration options within the virtual_machine declaration:
 
+  * boot <OPTIONS>: 
+    Configures the boot order of the virtual machine. Use the 'order' option 
+    to configure boot order; use the 'once' option to configure the first
+    boot of the machine. For more options, please see the QEMU documentation 
+    on '-boot'.
+
+        # Boot off the CDROM device, alyways
+        boot order: 'd'
+
+        # Boot off the CDROM the next time, otherwise from harddisk first
+        boot order: 'c', once: 'dc'
+
   * cpus <NUMBER>: 
     Configures the number of SMP cpus simulated to the guest system. 
     You should not configure more SMP cpus than you have physical CPU cores
@@ -91,10 +103,21 @@ Here's a list of configuration options within the virtual_machine declaration:
     option here. 
     
     The `via:` option takes either physical links or etherstub switches as 
-    value. 
-    You can also specify a VLAN tag, separated by a colon. (ie: e1000g0:4)
+    value. You can also specify a VLAN tag, separated by a colon. 
+    (ie: e1000g0:4)
+
+    You *must* specify a `macaddr:` option using an address that is unique
+    on your network. No checking is done for this in qemu-toolkit. This is 
+    a limitation that will be lifted in future versions.
     
-    nic `model:` will default to `virtio`.
+    nic `model:` will default to `virtio`. The `virtio` driver will be 
+    configured for maximum throughput by setting driver options directly 
+    as smartos does. This optimisation may change over time, but will always
+    try to optimise throughput and availability. 
+
+    To configure the DHCP server that kvm has built in, use `ip:`, 
+    `netmask:`, `gateway:`, `hostname:` and `dns_ip:` options. Please see the
+    example below.
     
     NOTE: QEMU/kvm on Illumos will default to providing a single pseudo-nic
     that has a DHCP server attached to it by default. If you do not specify
@@ -103,6 +126,11 @@ Here's a list of configuration options within the virtual_machine declaration:
         # Create eth0 interface with given mac address via 'igb1'.
         nic 'eth0', macaddr: '2:8:20:52:a6:7e', via: 'igb1'
 
+        # Create an interface and provide the IP address by built-in DHCP
+        nic 'eth1', macaddr: '...', via: 'igb2', 
+          ip: '10.0.0.2', netmask: '255.255.255.0', gateway: '10.0.0.1', 
+          hostname: 'test', dns_ip0: '8.8.8.8', dns_ip1: '8.8.4.4'
+
   * ram <MEGABYTES>: 
     Configures the amount of RAM the guest system sees. Note that the qemu 
     on Illumos locks memory down for the guest and never swaps it out. This

data/doc/qemu-toolkit-install.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "QEMU\-TOOLKIT\-INSTALL" "7" "November 2012" "" "qemu-toolkit"
+.TH "QEMU\-TOOLKIT\-INSTALL" "7" "March 2013" "" "qemu-toolkit"
 .
 .SH "NAME"
 \fBqemu\-toolkit\-install\fR \- installations instructions for the qemu\-toolkit

data/doc/qemu-toolkit-overview.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "QEMU\-TOOLKIT\-OVERVIEW" "7" "November 2012" "" "qemu-toolkit"
+.TH "QEMU\-TOOLKIT\-OVERVIEW" "7" "March 2013" "" "qemu-toolkit"
 .
 .SH "NAME"
 \fBqemu\-toolkit\-overview\fR \- architecture and philosophy of qemu\-toolkit

data/doc/storadm.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "STORADM" "1" "November 2012" "" "qemu-toolkit"
+.TH "STORADM" "1" "March 2013" "" "qemu-toolkit"
 .
 .SH "NAME"
 \fBstoradm\fR \- manages virtual machine storage

data/doc/vmadm.1

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "VMADM" "1" "November 2012" "" "qemu-toolkit"
+.TH "VMADM" "1" "March 2013" "" "qemu-toolkit"
 .
 .SH "NAME"
 \fBvmadm\fR \- manages qemu\-toolkit virtual machines

data/lib/qemu-toolkit/network/mac_address.rb

@@ -0,0 +1,34 @@
+module QemuToolkit::Network
+  class MacAddress
+    def initialize address
+      @address = normalize(address)
+    end
+
+    def normalize str
+      elements = str.split(':')
+
+      fail "Malformed MAC address: not enough or too many elements (should == 6, was #{elements.size})." \
+        unless elements.size == 6
+
+      elements.map { |n|
+        n.downcase!
+        case n.size
+          when 1
+            '0' + n
+          when 2
+            n
+        else
+          fail "Malformed MAC address: #{str}; should have 6 elements with max. 2 digits."
+        end
+      }.join(':')
+    end
+
+    def == other
+      self.to_s == other.to_s
+    end
+
+    def to_s
+      @address
+    end
+  end
+end

data/lib/qemu-toolkit/vm.rb

@@ -60,6 +60,10 @@ module QemuToolkit
     attr_accessor :vnc_display
     # Keyboard layout
     attr_accessor :keyboard_layout
+    # Other devices
+    attr_reader :devices
+    # Boot order (if set)
+    attr_accessor :boot
     
     def initialize(backend)
       @disks = []
@@ -71,8 +75,13 @@ module QemuToolkit
       @backend = backend
       @vnc_display = nil
       @extra_args = []
+      # TODO document
+      @devices = []
     end
         
+    def add_device(driver, parameters)
+      @devices << [driver, parameters]
+    end
     def add_drive(parameters)
       @drives << parameters
     end    
@@ -156,29 +165,65 @@ module QemuToolkit
         cmd << "-vnc #{vnc_display}"
       end
       
+      # Other devices
+      devices.each do |driver, parameters| 
+        cmd << "-device #{driver}," + 
+          parameter_list(parameters)
+      end
+
+      # Boot order
+      if boot
+        cmd << "-boot " + parameter_list(boot)
+      end
+
+      cmd += network_options      
+      
+      # Extra arguments
+      cmd += @extra_args
+      
+      return cmd
+    end
+    def network_options
+      cmd = []
+
       # networking: nic
       vlan = 0
       # Look up all existing vnics for this virtual machine
       vnics = Vnic.for_prefix(name, @backend)
       
       nics.each do |nic_name, parameters|
-        # All vnics that travel via the given interface (:via)
-        vnics_for_interface = vnics[parameters[:via]] || []
-        
-        # Get a vnic that travels via the given interface.
-        vnic = vnics_for_interface.shift ||
-          Vnic.create(name, parameters[:via], @backend)
+        via = parameters.delete(:via)
+        model = parameters.delete(:model) || 'virtio'
+        macaddr = parameters.delete(:macaddr)
+
+        # All vnics that travel via the given interface (via)
+        vnic = vnics.allocate(via, macaddr)
+
+        # If no vnic has been found, create a new one. 
+        unless vnic
+          vnic = Vnic.create(name, via, @backend, macaddr)
+        end
         
         cmd << "-net vnic,"+
           parameter_list(
-            vlan: vlan, name: nic_name, 
-            ifname: vnic.vnic_name, 
-            macaddr: parameters[:macaddr])
-        cmd << "-net nic,"+
-          parameter_list(
-            vlan: vlan, name: nic_name, 
-            model: parameters[:model] || 'virtio', 
-            macaddr: parameters[:macaddr])
+            parameters.merge(
+              vlan: vlan, name: nic_name, 
+              ifname: vnic.vnic_name, 
+            ))
+
+        if model == 'virtio'
+          cmd << '-device virtio-net-pci,'+
+            parameter_list(
+              mac: macaddr, 
+              tx: 'timer', x_txtimer: 200000, x_txburst: 128, 
+              vlan: vlan) 
+        else
+          cmd << "-net nic,"+
+            parameter_list(
+              vlan: vlan, name: nic_name, 
+              model: model,
+              macaddr: macaddr)
+        end
 
         vlan += 1
       end
@@ -188,11 +233,8 @@ module QemuToolkit
         cmd << "-net #{type},"+
           parameter_list(parameters)
       end
-      
-      # Extra arguments
-      cmd += @extra_args
-      
-      return cmd
+
+      cmd
     end
     def disk_options
       cmd = []
@@ -303,8 +345,13 @@ module QemuToolkit
     # Formats a parameter list as key=value,key=value
     #
     def parameter_list(parameters)
+      key_translator = Hash.new { |h,k| k }
+      key_translator.update(
+        x_txtimer: 'x-txtimer', 
+        x_txburst: 'x-txburst')
+      
       parameters.
-        map { |k,v| "#{k}=#{v}" }.
+        map { |k,v| "#{key_translator[k]}=#{v}" }.
         join(',')
     end
     

data/lib/qemu-toolkit/vmadm.rb

@@ -41,10 +41,14 @@ module QemuToolkit
     
     subcommand('list', 
       'Lists all virtual machines on this system') do
+
+        option %w(-o --fields), 'FIELDLIST', "Only outputs fields given; default is all fields (name, pid)"
+
         def _execute
+          output_fields = (fields || 'name,pid').split(/,/)
           VM.all(backend).each do |vm|
-            printf "%-20s", vm.name
-            printf " %5s", vm.running? ? vm.pid : 'off'
+            printf "%-20s", vm.name if output_fields.include?('name')
+            printf " %5s", vm.running? ? vm.pid : 'off' if output_fields.include?('pid')
             puts
           end
         end

data/lib/qemu-toolkit/vnic.rb

@@ -1,57 +1,92 @@
+
+require 'set'
+
+require 'qemu-toolkit/network/mac_address'
+
 module QemuToolkit
   class Vnic
     class << self
       def for_prefix(prefix, background)
-        vnics = Hash.new { |h,k| h[k] = Array.new; }
-        links = background.dladm 'show-vnic', '-po link,over,vid'
+        vnics = VnicCollection.new
+        links = background.dladm 'show-vnic', '-po link,over,vid,macaddress'
+
+        re_separator = /(?<!\\):/
         
         links.each_line do |line|
           next unless line.start_with?(prefix)
-          link, over, vid = line.chomp.split(':')
+          link, over, vid, macaddr = line.chomp.split(re_separator)
+
+          # macaddr being the only place escaping takes place, unescape it
+          # by replacing \: -> :
+          macaddr.gsub!(/\\:/, ':')
           
           # Assumes that vid 0 is always the 'no vlan' VLAN
           over = "#{over}:#{vid}" if vid.to_i > 0
           
           if md=link.match(/^(?<vm>.*)_(?<link_no>\d+)$/)
-            vnics[over] << Vnic.new(md[:vm], Integer(md[:link_no]), over)
+            vnics << Vnic.new(md[:vm], Integer(md[:link_no]), over, macaddr)
           end
         end
         
         vnics
       end
       
-      def create(prefix, over, backend)
+      def create(prefix, over, backend, macaddr=nil)
         # Retrieve links that exist for this prefix and this over interface
-        vnics = for_prefix(prefix, backend).values.flatten
+        vnics = for_prefix(prefix, backend)
         next_vnic_number = (vnics.map(&:number).max || 0) + 1
 
-        new(prefix, next_vnic_number, over).tap { |o|
+        new(prefix, next_vnic_number, over, macaddr).tap { |o|
           o.create(backend) }
       end
       
     end
     
-    def initialize(prefix, number, over)
+    def initialize(prefix, number, over, macaddr=nil)
       @prefix, @number, @over = prefix, number, over
+      @macaddr = macaddr && Network::MacAddress.new(macaddr)
+
+      if vlan_tagged?
+        @interface, @vlan = @over.split(':')
+      else
+        @interface = @over
+        @vlan = nil
+      end
     end
     
     attr_reader :prefix
     attr_reader :number
     attr_reader :over
+    attr_reader :macaddr
+
+    attr_reader :interface
+    attr_reader :vlan
     
     def ==(other)
       self.prefix == other.prefix && 
         self.number == other.number && 
-        self.over == other.over
+        self.over == other.over && 
+        self.macaddr == other.macaddr
+    end
+
+    def to_s
+      "#{vnic_name} (#{vlan || 'g'}/#{macaddr})"
+    end
+
+    def vlan_tagged?
+      @over.index(':')
+    end
+    def mac_address?
+      @macaddr
     end
     
     def create backend
-      if over.index(':')
-        iface, vlan = over.split(':')
-        backend.dladm 'create-vnic', "-l #{iface} -v #{vlan}", vnic_name
-      else
-        backend.dladm 'create-vnic', "-l #{over}", vnic_name
-      end
+      opts = ["-l #{interface}"]
+
+      opts << "-v #{vlan}" if vlan_tagged?
+      opts << "--mac-address #{macaddr}" if mac_address?
+
+      backend.dladm 'create-vnic', *opts, vnic_name
     end
     
     def vnic_name

data/lib/qemu-toolkit/vnic_collection.rb

@@ -0,0 +1,46 @@
+
+require 'qemu-toolkit/network/mac_address'
+
+module QemuToolkit
+
+  # A collection of vnics. This class keeps track of vnic allocations to 
+  # devices, so that no vnic will be used twice. 
+  #
+  class VnicCollection
+    def initialize(vnics=[])
+      @vnics = Set.new(vnics)
+      @used = Set.new
+    end
+
+    def << vnic
+      @vnics << vnic
+    end
+
+    def map &block
+      unused.map(&block)
+    end
+
+    def unused
+      @vnics - @used
+    end
+
+    def allocate(via, mac_address=nil)
+      vnic=unused.find { |vnic| 
+        (!mac_address || 
+          (normalize_mac_address(mac_address) == vnic.macaddr)) && 
+        via == vnic.over }
+
+      @used << vnic
+      vnic
+    end
+
+    def empty?
+      @used.size == @vnics.size
+    end
+
+    def normalize_mac_address mac_address
+      Network::MacAddress.new(mac_address)
+    end
+  end
+end
+    

data/lib/qemu-toolkit.rb

@@ -9,4 +9,5 @@ require 'qemu-toolkit/config'
 require 'qemu-toolkit/vm'
 require 'qemu-toolkit/vm_storage'
 require 'qemu-toolkit/backend/illumos'
-require 'qemu-toolkit/vnic'
+require 'qemu-toolkit/vnic'
+require 'qemu-toolkit/vnic_collection'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qemu-toolkit
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-23 00:00:00.000000000 Z
+date: 2013-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: clamp
@@ -45,11 +45,13 @@ files:
 - lib/qemu-toolkit/dsl.rb
 - lib/qemu-toolkit/iscsi_target.rb
 - lib/qemu-toolkit/local_disk_set.rb
+- lib/qemu-toolkit/network/mac_address.rb
 - lib/qemu-toolkit/storadm.rb
 - lib/qemu-toolkit/vm.rb
 - lib/qemu-toolkit/vm_storage.rb
 - lib/qemu-toolkit/vmadm.rb
 - lib/qemu-toolkit/vnic.rb
+- lib/qemu-toolkit/vnic_collection.rb
 - lib/qemu-toolkit.rb
 - bin/storadm
 - bin/vmadm
@@ -95,3 +97,4 @@ signing_key:
 specification_version: 3
 summary: Manages QEMU kvm virtual machines on Illumos hosts.
 test_files: []
+has_rdoc: