From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mx.groups.io with SMTP id smtpd.web09.7189.1646227974640882148 for ; Wed, 02 Mar 2022 05:32:54 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="unable to parse pub key" header.i=@intel.com header.s=intel header.b=gKYg9t8l; spf=pass (domain: intel.com, ip: 134.134.136.65, mailfrom: sebastien.boeuf@intel.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646227974; x=1677763974; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=PCWPLD1+DG6eiAWsWBGlRI4uEXfRymW6WdM3t01YiUs=; b=gKYg9t8lEaD7LrnOKlHWOIgLwgMiHub+lGC6xIzbeLsmDFtDirJZIaqr 6ZmQOfI/r48aaWQznuCnIZZodCDA7NF2MdlWcfGg+2voIInT0b0mjIO7I jFqROwfeREqNAnfCYvSGid4oJuckdchhajCKEznKKcViz7A6VzNu/I0TK V60OunAy9Le+7cg31vgl+o01EhTjdA2RYXhqHjkmp5BvTVO22/VZZsv5V htURbmjATqA0SWIXAXgrQaq4pxKQZTSYXgJ9PxDkR4fSWcM97n4HCdTJF tQQ3P0x2iCbSko/EKzblQPLpmUYFtTfsG6HZW5SEf6/twrzL4rQs4KGhM A==; X-IronPort-AV: E=McAfee;i="6200,9189,10273"; a="253325447" X-IronPort-AV: E=Sophos;i="5.90,149,1643702400"; d="scan'208";a="253325447" Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Mar 2022 05:32:53 -0800 X-IronPort-AV: E=Sophos;i="5.90,149,1643702400"; d="scan'208";a="535389598" Received: from spearce-mobl1.amr.corp.intel.com (HELO sboeuf-mobl.home) ([10.252.27.130]) by orsmga007-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Mar 2022 05:32:52 -0800 From: "Boeuf, Sebastien" To: devel@edk2.groups.io Cc: jiewen.yao@intel.com, jordan.l.justen@intel.com, kraxel@redhat.com, sebastien.boeuf@intel.com Subject: [PATCH v6 8/8] OvmfPkg: CloudHv: Add README Date: Wed, 2 Mar 2022 14:31:37 +0100 Message-Id: <9d6446b2eac74d6c5332990929650052454d90a2.1646227817.git.sebastien.boeuf@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: References: MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable From: Sebastien Boeuf Add some documentation to the CloudHv target in order to clarify how to use it and what to expect from it. Signed-off-by: Sebastien Boeuf --- OvmfPkg/CloudHv/README | 67 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 OvmfPkg/CloudHv/README diff --git a/OvmfPkg/CloudHv/README b/OvmfPkg/CloudHv/README new file mode 100644 index 0000000000..63e28860e0 --- /dev/null +++ b/OvmfPkg/CloudHv/README @@ -0,0 +1,67 @@ + +CloudHv is a port of OVMF for the Cloud Hypervisor project. + +The Cloud Hypervisor project +---------------------------- + +Cloud Hypervisor is a Virtual Machine Monitor that runs on top of KVM. The +project focuses on exclusively running modern, cloud workloads, on top of a +limited set of hardware architectures and platforms. Cloud workloads refer= s to +those that are usually run by customers inside a cloud provider. This means +modern operating systems with most I/O handled by paravirtualised devices +(i.e. virtio), no requirement for legacy devices, and 64-bit CPUs. + +https://github.com/cloud-hypervisor/cloud-hypervisor + +Design +------ + +Based on Cloud Hypervisor's motto to reduce the emulation as much as possi= ble, +the project logically decided to support the PVH boot specification as the= only +way of booting virtual machines. That includes both direct kernel boot and= OVMF +firmware which must be generated as PVH ELF binaries. +PVH allows information like location of ACPI tables and location of guest = RAM +ranges to be shared without the need of an extra emulated device like a CM= OS. + +Features +-------- + +* Serial console +* EFI shell +* virtio-pci + +Build +----- + +The way to build the CloudHv target is as follows: + +OvmfPkg/build.sh -p OvmfPkg/CloudHv/CloudHvX64.dsc -a X64 -b DEBUG + +Usage +----- + +Assuming Cloud Hypervisor is already built, one can start a virtual machin= e as +follows: + +./cloud-hypervisor \ + --cpus boot=3D1 \ + --memory size=3D1G \ + --kernel Build/CloudHvX64/DEBUG_GCC5/FV/CLOUDHV.fd \ + --disk path=3D/path/to/disk.raw + +Releases +-------- + +In edk2-stable202202, CloudHv is generated as data-only binary. +Starting with edk2-stable202205, CloudHv is generated as a PVH ELF binary = to +reduce the amount of emulation needed from Cloud Hypervisor. +For TDX, things are handled differently and PVH is not used, which is why = the +firmware is always generated as a data-only binary. + ++-------------------+----------------+ +| | CloudHv | ++-------------------+----------------+ +| edk2-stable202202 | Data binary | ++-------------------+----------------+ +| edk2-stable202205 | PVH ELF binary | ++-------------------+----------------+ -- = 2.32.0 --------------------------------------------------------------------- Intel Corporation SAS (French simplified joint stock company) Registered headquarters: "Les Montalets"- 2, rue de Paris, = 92196 Meudon Cedex, France Registration Number: 302 456 199 R.C.S. NANTERRE Capital: 4,572,000 Euros This e-mail and any attachments may contain confidential material for the sole use of the intended recipient(s). Any review or distribution by others is strictly prohibited. If you are not the intended recipient, please contact the sender and delete all copies.