From 792d3a4d1a8fe8a7d71ad995c537f2097d8b9508 Mon Sep 17 00:00:00 2001
From: Wu Zhou <wu.zhou@intel.com>
Date: Tue, 31 May 2022 10:51:18 +0800
Subject: [PATCH] config-tools: refine vsock UI

1. One VM can have multi vsock. Changed vsock UI to multi line.
2. Add verification that no repeated CID is allowed.
3. Refine the tooltip text.

Tracked-On: #7637
Signed-off-by: Wu Zhou <wu.zhou@intel.com>
---
 misc/config_tools/schema/VMtypes.xsd          |  8 +++++++
 .../schema/checks/virtio_devices.xsd          | 17 ++++++++++++++
 misc/config_tools/schema/config.xsd           | 23 ++++++-------------
 misc/config_tools/schema/datachecks.xsd       |  1 +
 4 files changed, 33 insertions(+), 16 deletions(-)
 create mode 100644 misc/config_tools/schema/checks/virtio_devices.xsd

diff --git a/misc/config_tools/schema/VMtypes.xsd b/misc/config_tools/schema/VMtypes.xsd
index 6746ef41a..a14c89caa 100644
--- a/misc/config_tools/schema/VMtypes.xsd
+++ b/misc/config_tools/schema/VMtypes.xsd
@@ -411,6 +411,14 @@ device file when user config it as virtio serial port, which can be read and wri
   </xs:sequence>
 </xs:complexType>
 
+<xs:simpleType name="vsockCIDType">
+    <xs:annotation acrn:widget-options="'placeholder': 'integer greater than 2'" />
+    <xs:restriction base="xs:integer">
+      <xs:minInclusive value="3" />
+      <xs:maxInclusive value="4294967294" />
+    </xs:restriction>
+</xs:simpleType>
+
 <xs:simpleType name="OSType">
   <xs:annotation>
     <xs:documentation>A string with either ``Non-Windows OS`` or  ``Windows OS``.</xs:documentation>
diff --git a/misc/config_tools/schema/checks/virtio_devices.xsd b/misc/config_tools/schema/checks/virtio_devices.xsd
new file mode 100644
index 000000000..87556cc24
--- /dev/null
+++ b/misc/config_tools/schema/checks/virtio_devices.xsd
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<!-- Copyright (C) 2022 Intel Corporation. -->
+<!-- SPDX-License-Identifier: BSD-3-Clause -->
+<xs:schema xml:id="root"
+           xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns:acrn="https://projectacrn.org">
+
+  <xs:assert test="every $vm in /acrn-config/vm satisfies
+                   every $vsock in $vm/virtio_devices/vsock satisfies
+                   count(//virtio_devices/vsock[text()=$vsock]) = 1
+                   ">
+    <xs:annotation acrn:severity="error" acrn:report-on="$vm">
+      <xs:documentation>"{$vm/name}" repeats a vsock CID assignment: {$vsock}, either with this VM or with other VMs. Remove the duplicates.</xs:documentation>
+    </xs:annotation>
+  </xs:assert>
+
+</xs:schema>
diff --git a/misc/config_tools/schema/config.xsd b/misc/config_tools/schema/config.xsd
index 07777522e..4847cf553 100644
--- a/misc/config_tools/schema/config.xsd
+++ b/misc/config_tools/schema/config.xsd
@@ -444,22 +444,6 @@ argument and memory.</xs:documentation>
 This feature enables you to view the VM's GPU output in the Service VM.</xs:documentation>
             </xs:annotation>
           </xs:element>
-          <xs:element name="vsock" minOccurs="0">
-            <xs:annotation acrn:title="Virtio vsock CID" acrn:views="basic"
-                          acrn:widget-options="'placeholder': '3 ~ (-2U)'">
-              <xs:documentation>vsock is the new socket address family for host/guest communication.
-CID is the identifier for this VM.</xs:documentation>
-            </xs:annotation>
-            <xs:simpleType>
-              <xs:restriction base="xs:integer">
-                <xs:annotation>
-                  <xs:documentation>Integer between 3 ~ (-2U).</xs:documentation>
-                </xs:annotation>
-                <xs:minInclusive value="3" />
-                <xs:maxInclusive value="4294967294" />
-              </xs:restriction>
-            </xs:simpleType>
-          </xs:element>
           <xs:element name="console" type="VirtioConsoleConfiguration" minOccurs="0" maxOccurs="unbounded">
             <xs:annotation acrn:title="Virtio console device" acrn:views="basic">
               <xs:documentation>Virtio console device for data input and output.
@@ -491,6 +475,13 @@ mouse, and tablet.  It sends Linux input layer events over virtio.</xs:documenta
                 <xs:restriction base="xs:string" />
               </xs:simpleType>
           </xs:element>
+          <xs:element name="vsock" type="vsockCIDType" minOccurs="0" maxOccurs="unbounded">
+            <xs:annotation acrn:title="Virtio vsock Context ID (CID)" acrn:views="basic">
+              <xs:documentation>Specify the post-launched VM's unique Context ID (CID) used by vsock (integer greater than 2).
+vsock provides a way for the host system and applications running in a user VM to communicate with each other using the standard socket interface.
+vsock uses a (context id, port) pair of integers for identifying processes. The host system CID is always 2. The port is hardcoded in our implementation.</xs:documentation>
+            </xs:annotation>
+          </xs:element>
         </xs:all>
       </xs:complexType>
     </xs:element>
diff --git a/misc/config_tools/schema/datachecks.xsd b/misc/config_tools/schema/datachecks.xsd
index fc9badf53..8f6e34102 100644
--- a/misc/config_tools/schema/datachecks.xsd
+++ b/misc/config_tools/schema/datachecks.xsd
@@ -14,6 +14,7 @@
       <xi:include href="checks/vbdf_assignment.xsd" xpointer="xpointer(id('root')/*)" />
       <xi:include href="checks/vm_types.xsd" xpointer="xpointer(id('root')/*)" />
       <xi:include href="checks/passthrough_devices.xsd" xpointer="xpointer(id('root')/*)" />
+      <xi:include href="checks/virtio_devices.xsd" xpointer="xpointer(id('root')/*)" />
       <xi:include href="checks/vuart_config.xsd" xpointer="xpointer(id('root')/*)" />
 
     </xs:complexType>