mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-05-30 10:55:27 +00:00
This patch introduces a schema (in XSD 1.1) for the scenario XML of ACRN hypervisor for validation and documentation. An XML schema defines the expected layout and value ranges of an XML document. It allows a concise way to define our expectation on the information in a scenario XML, including: * structure of elements * number of occurrences of elements with the same tags * element data types and default values * element descriptions * any further properties such as readonly and configurable Multiple XSD-based validators are available in the open source community. A Python-based apporach will be introduced in a later patch and integrated into the build system to ensure the integrity of the scenario XML before we process it further. A reference of the configuration data will be generated from the <xs:documentation> blocks. Format for <xs:documentation> blocks will properly output multiple text lines so features such as lists can be used. All multi-line content must be left-aligned unless indentation is specifically required by rst syntax. The trailing </xs:documentation> tag should be on the same line as the last text line. For example: <xs:simpleType name="SchedulerType"> <xs:annotation> <xs:documentation>Three scheduler options are supported: - ``SCHED_NOOP``: The NOOP (No-Operation) scheduler means there is a strict 1 to 1 mapping between vCPUs and pCPUs. - ``SCHED_IORR``: The IORR (IO sensitive Round Robin) scheduler supports multipule vCPUs running on on one pCPU, scheduled by a IO sensitive round robin policy. ``SCHED_BVT``: The BVT (Borrowed Virtual time) scheduler is a virtual time based scheduling algorithm, it dispatchs the runnable thread with the earliest effective virtual time. *TODO: BVT scheduler will be built on top of a prioritized scheduling mechanism, i.e. higher priority threads get scheduled first, and same priority tasks are scheduled per BVT.* Read more about the available scheduling options in :ref:`cpu_sharing`.</xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:enumeration value="SCHED_NOOP" /> <xs:enumeration value="SCHED_IORR" /> <xs:enumeration value="SCHED_BVT" /> </xs:restriction> </xs:simpleType> Tracked-On: #5672 Signed-off-by: Yang, Yu-chu <yu-chu.yang@intel.com> Signed-off-by: David B. Kinder <david.b.kinder@intel.com> |
||
---|---|---|
.. | ||
config_tools | ||
debug_tools | ||
hv_prebuild | ||
packaging | ||
services | ||
Makefile | ||
README.rst |
ACRN tools ########## The open source `Project ACRN`_ defines a device hypervisor reference stack and an architecture for running multiple software subsystems, managed securely, on a consolidated system by means of a virtual machine manager. It also defines a reference framework implementation for virtual device emulation, called the "ACRN Device Model". This folder holds the source to a number of tools that facilitate the management, debugging, profiling, and logging of multi-OS systems based on ACRN. You can find out more about Project ACRN and its set of tools on the `Project ACRN documentation`_ website. .. _`Project ACRN`: https://projectacrn.org .. _`Project ACRN documentation`: https://projectacrn.github.io/