From 6df8b363f751ec75c305602a4ef0a77b261b1384 Mon Sep 17 00:00:00 2001
From: Jiri Denemark <jdenemar@redhat.com>
Date: Fri, 18 Dec 2009 14:37:09 +0100
Subject: [PATCH] XML schema for CPU flags

XML schema for CPU flags

Firstly, CPU topology and model with optional features have to be
advertised in host capabilities:

    <host>
        <cpu>
            <arch>ARCHITECTURE</arch>
            <features>
                <!-- old-style features are here -->
            </features>
            <model>NAME</model>
            <topology sockets="S" cores="C" threads="T"/>
            <feature name="NAME"/>
        </cpu>
        ...
    </host>

Secondly, drivers which support detailed CPU specification have to
advertise
it in guest capabilities:

    <guest>
    ...
    <features>
            <cpuselection/>
        </features>
    </guest>

And finally, CPU may be configured in domain XML configuration:

<domain>
    ...
    <cpu match="MATCH">
        <model>NAME</model>
        <topology sockets="S" cores="C" threads="T"/>
        <feature policy="POLICY" name="NAME"/>
    </cpu>
</domain>

Where MATCH can be one of:
    - 'minimum'     specified CPU is the minimum requested CPU
    - 'exact'       disable all additional features provided by host CPU
    - 'strict'      fail if host CPU doesn't exactly match

POLICY can be one of:
    - 'force'       turn on the feature, even if host doesn't have it
    - 'require'     fail if host doesn't have the feature
    - 'optional'    match host
    - 'disable'     turn off the feature, even if host has it
    - 'forbid'      fail if host has the feature

'force' and 'disable' policies turn on/off the feature regardless of its
availability on host. 'force' is unlikely to be used but its there for
completeness since Xen and VMWare allow it.

'require' and 'forbid' policies prevent a guest from being started on a host
which doesn't/does have the feature. 'forbid' is for cases where you disable
the feature but a guest may still try to access it anyway and you don't want
it to succeed.

'optional' policy sets the feature according to its availability on host.
When a guest is booted on a host that has the feature and then migrated to
another host, the policy changes to 'require' as we can't take the feature
away from a running guest.

Default policy for features provided by host CPU but not specified in domain
configuration is set using match attribute of cpu tag. If 'minimum' match is
requested, additional features will be treated as if they were specified
with 'optional' policy. 'exact' match implies 'disable' policy and 'strict'
match stands for 'forbid' policy.

* docs/schemas/capability.rng docs/schemas/domain.rng: extend the
  RelaxNG schemas to add CPU flags support
---
 docs/schemas/capability.rng | 46 ++++++++++++++++++++++++++-
 docs/schemas/domain.rng     | 62 +++++++++++++++++++++++++++++++++++++
 2 files changed, 107 insertions(+), 1 deletion(-)

diff --git a/docs/schemas/capability.rng b/docs/schemas/capability.rng
index 3e8944c392..378652e5ad 100644
--- a/docs/schemas/capability.rng
+++ b/docs/schemas/capability.rng
@@ -25,6 +25,9 @@
 	<optional>
 	  <ref name='cpufeatures'/>
 	</optional>
+	<optional>
+	  <ref name='cpuspec'/>
+	</optional>
       </element>
       <optional>
 	<ref name='migration'/>
@@ -67,6 +70,31 @@
     </element>
   </define>
 
+  <define name='cpuspec'>
+    <element name='model'>
+      <text/>
+    </element>
+    <element name='topology'>
+      <attribute name='sockets'>
+        <ref name='positiveInteger'/>
+      </attribute>
+      <attribute name='cores'>
+        <ref name='positiveInteger'/>
+      </attribute>
+      <attribute name='threads'>
+        <ref name='positiveInteger'/>
+      </attribute>
+    </element>
+    <zeroOrMore>
+      <element name='feature'>
+        <attribute name='name'>
+          <ref name='featureName'/>
+        </attribute>
+        <empty/>
+      </element>
+    </zeroOrMore>
+  </define>
+
   <define name='migration'>
     <element name='migration_features'>
       <optional>
@@ -259,6 +287,11 @@
 	  <empty/>
 	</element>
       </optional>
+      <optional>
+        <element name='cpuselection'>
+          <empty/>
+        </element>
+      </optional>
     </element>
   </define>
 
@@ -293,8 +326,14 @@
   </define>
 
 
+  <define name='positiveInteger'>
+    <data type='positiveInteger'>
+      <param name="pattern">[0-9]+</param>
+    </data>
+  </define>
+
   <define name='uint'>
-    <data type='string'>
+    <data type='unsignedInt'>
       <param name="pattern">[0-9]+</param>
     </data>
   </define>
@@ -305,4 +344,9 @@
     </data>
   </define>
 
+  <define name='featureName'>
+    <data type='string'>
+      <param name='pattern'>[a-zA-Z0-9\-_]+</param>
+    </data>
+  </define>
 </grammar>
diff --git a/docs/schemas/domain.rng b/docs/schemas/domain.rng
index 784f9b1a55..566b11753c 100644
--- a/docs/schemas/domain.rng
+++ b/docs/schemas/domain.rng
@@ -27,6 +27,9 @@
         <optional>
           <ref name="description"/>
         </optional>
+        <optional>
+          <ref name="cpu"/>
+        </optional>
         <ref name="os"/>
         <ref name="clock"/>
         <ref name="resources"/>
@@ -1234,6 +1237,55 @@
       </element>
     </optional>
   </define>
+  <!--
+      CPU specification
+      -->
+  <define name="cpu">
+    <element name="cpu">
+      <attribute name="match">
+        <choice>
+          <value>minimum</value>
+          <value>exact</value>
+          <value>strict</value>
+        </choice>
+      </attribute>
+      <interleave>
+        <element name="model">
+          <text/>
+        </element>
+        <optional>
+          <element name="topology">
+            <attribute name="sockets">
+              <ref name="positiveInteger"/>
+            </attribute>
+            <attribute name="cores">
+              <ref name="positiveInteger"/>
+            </attribute>
+            <attribute name="threads">
+              <ref name="positiveInteger"/>
+            </attribute>
+          </element>
+        </optional>
+        <zeroOrMore>
+          <element name="feature">
+            <attribute name="policy">
+              <choice>
+                <value>force</value>
+                <value>require</value>
+                <value>optional</value>
+                <value>disable</value>
+                <value>forbid</value>
+              </choice>
+            </attribute>
+            <attribute name="name">
+              <ref name="featureName"/>
+            </attribute>
+            <empty/>
+          </element>
+        </zeroOrMore>
+      </interleave>
+    </element>
+  </define>
   <!--
        Type library
 
@@ -1247,6 +1299,11 @@
       <param name="pattern">[0-9]+</param>
     </data>
   </define>
+  <define name='positiveInteger'>
+    <data type='positiveInteger'>
+      <param name="pattern">[0-9]+</param>
+    </data>
+  </define>
   <define name="countCPU">
     <data type="unsignedShort">
       <param name="pattern">[0-9]+</param>
@@ -1354,4 +1411,9 @@
       <param name="pattern">(0x)?[0-7]</param>
     </data>
   </define>
+  <define name="featureName">
+    <data type="string">
+      <param name='pattern'>[a-zA-Z0-9\-_]+</param>
+    </data>
+  </define>
 </grammar>