Define cross-driver standardized vm_mode values

Currently the XenAPI driver allows for a 'vm_mode' parameter to
be set against an instance to determine whether it is launched
a paravirt or fullvirt domain. This allows the values 'pv', 'hv'
and 'hvm'.

The libvirt driver also needs to be extended to allow a 'vm_mode'
parameter, and to facilitate deployment of heterogeneous Nova
compute farms, it is desirable to have standardization of the
VM mode values across all drivers.

To address this, the nova.compute.vm_mode module is introduced
which defines a set of constants. The constants provide four
possible vm modes:

 - vm_mode.XEN = 'xen' - for Xen 3.0 paravirt ABI
 - vm_mode.HVM = 'hvm' - for native ABI
 - vm_mode.UML = 'uml' - for User Mode Linux paravirt ABI
 - vm_mode.EXE = 'exe' - for container virt executable ABI

The existing 'pv' value from XenAPI is deprecated, because it
is ambiguous - both Xen and UML are paravirt, and other
paravirt hypervisor ABIs also exist

The existing 'hv' value is also deprecated since it duplicates
the other existing 'hvm' value.

The 'vm_mode.get_from_instance' method will extract the
vm_mode value for an instance. It normalizes the value to
all lower case, translates 'hv' and 'pv' into the new
values for back compat, and validates that the value
matches one of the defined constants

The XenAPI and libvirt drivers are then updated to use the
nova.compute.vm_mode constants instead of bare strings.
The test_xenapi.py test case is updated to set 'vm_mode'
to exercise the new codepaths. A new test_vmmode.py
case is also written to fully exercise the logic

NB, previously the libvirt driver would set 'guest.os_type'
to 'linux' to request Xen paravirt. This is a legacy value,
with libvirt preferring the string 'xen'. So although the
new code sets a different value for Xen paravirt os_type,
the functional result is unchanged.

DocImpact
blueprint hypervisor-code-consolidation
Change-Id: I23efc5dc1528b0d8472d752a8a30f55c85310b21
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

1 files changed, 58 insertions, 0 deletions

diff --git a/nova/compute/vm_mode.py b/nova/compute/vm_mode.py
new file mode 100644
index 000000000..a380511a9
--- /dev/null
+++ b/nova/compute/vm_mode.py
@@ -0,0 +1,58 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2012 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+"""Possible vm modes for instances.
+
+Compute instance vm modes represent the host/guest ABI used for the
+virtual machine / container. Individual hypervisors may support
+multiple different vm modes per host. Available vm modes for a hypervisor
+driver may also vary according to the architecture it is running on.
+
+The 'vm_mode' parameter can be set against an instance to
+choose what sort of VM to boot.
+
+"""
+
+from nova import exception
+
+HVM = "hvm"  # Fully virtualizated
+XEN = "xen"  # Xen 3.0 paravirtualized
+UML = "uml"  # User Mode Linux paravirtualized
+EXE = "exe"  # Executables in containers
+
+ALL = [HVM, XEN, UML, EXE]
+
+
+def get_from_instance(instance):
+    mode = instance.vm_mode
+
+    if mode is None:
+        return None
+
+    mode = mode.lower()
+
+    # For compatibility with pre-Folsom deployments
+    if mode == "pv":
+        mode = XEN
+
+    if mode == "hv":
+        mode = HVM
+
+    if not mode in ALL:
+        raise exception.Invalid("Unknown vm mode '%s'" % mode)
+
+    return mode