From nobody Sat Nov 23 17:14:25 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass(p=reject dis=none) header.from=lists.libvirt.org ARC-Seal: i=1; a=rsa-sha256; t=1723828882; cv=none; d=zohomail.com; s=zohoarc; b=NEPyuGGsi9WEw26FSRvvySiHH4DuHpnyYJy+OJLSPrqfaEq/bD0bpdksOrbeFbxSjEcnGrWPRIqmy2MRZ9Mcvr/7kqYVlcZdBUWB0xmhZz+4qG/jQEum54Bqp7qd1kwPU6IpdTyoKUxgi/o3IK+WUPj5dge5rR1vOfdWV3i2MEY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723828882; h=Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=R9UI+oIpi9BEcnuTx6YnuAsZz3/58GP0KfzE1106ktc=; b=lPGxwYh/NIEI24U91v6fPj9Hl8Mv0y48ellbsde13yg9SBrcZjNJcXWmd1GvcI41CdMv9X9NQoPUXLgjpOVehmv7OtVKBaNC9p+GD+nQfrjYlHBlV8J+8e+XMbRINxl2dMVs5l9qQ2QHWIlRUI4dJifjOz9d18FvuN2jLKnh+vE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of lists.libvirt.org designates 8.43.85.245 as permitted sender) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1723828882962674.7756740727573; Fri, 16 Aug 2024 10:21:22 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id A6EA613F1; Fri, 16 Aug 2024 13:21:21 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 417F813EF; Fri, 16 Aug 2024 13:20:37 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 2DF9B1278; Fri, 16 Aug 2024 13:20:33 -0400 (EDT) Received: from mail-lj1-f177.google.com (mail-lj1-f177.google.com [209.85.208.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id 495B61274 for ; Fri, 16 Aug 2024 13:20:32 -0400 (EDT) Received: by mail-lj1-f177.google.com with SMTP id 38308e7fff4ca-2ef2fccca2cso25133911fa.1 for ; Fri, 16 Aug 2024 10:20:32 -0700 (PDT) Received: from localhost ([69.51.98.148]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-4ccd6f3dc71sm1342408173.119.2024.08.16.10.20.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 16 Aug 2024 10:20:30 -0700 (PDT) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=DKIM_INVALID,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_NONE, T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.4 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=suse.com; s=google; t=1723828831; x=1724433631; darn=lists.libvirt.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=BJJtyOMDVndbb4akxg9qFEbis6n9OPQMiIFMGbnuOBg=; b=KV+ZTf7pRrLcnNOgCxisBbMMpazTaZ0Vggq/xybngeorZNsA857wEPn2M5k0NPmWBD jYM6xc/3rGbTnOXaiUUi97ucK5ocANaSd/64iylyvsntUpl+RlcnZLAqdqrinTcFVUis SVXtbKUYnmEk6/px04Fr+JRwuMDw7tQxwyto8qKO4zJdHo2xbEUV4EM1fmuiyNvk5HW9 mLbtalZrio6CTfa+vSVZokqambhtWcApsfXqgzYinm0UvfjR6Gt3ZlH6pNyGo6//4PFt qD8/11si278aPHEyBscxU4qHrzvlvnK1TB7NgjKCdbc+7x7mdXQo1dNJR5PaNZyH7S/G /+4Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723828831; x=1724433631; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=BJJtyOMDVndbb4akxg9qFEbis6n9OPQMiIFMGbnuOBg=; b=aAbi06GtcbE2+37IF+mG9SfAzPrkwan6rummA7/7zPuol1Yz0tFN81oIvZMiCGUgcu 52nk11HFyHPnW4jq1o4CGC2LLqpWF7Bq/SWs+qKnfsOqYmDm34bT3xisyg3/TSgly18y 3VvWSch66mILWqzFzDM+GCT6MiI6VUwwU5VjvmL12nHGJKNQcL4Nv2Y/JTd0BEYa6Lfz OpGJU6+AS1iktmzd3KgyVws8NTTqW2/sl8dhKUwg1EvtGYROsLp1Lt38uja2TQf/IOOs s6Q1Z5ClEPyKoeoauQLJ1EQdYxhX+5LxSS7/4yh/XruE1zv6arH63ncbX1VSmwju+wD0 rIXw== X-Gm-Message-State: AOJu0YzYW9bNf8Y9vmLA9jFHYwxwnyNnOVCplavMbZRFg9LEKmVIFu6T eryc4l8CjheN0nLwVNMTaJhTGnDw/a/8ZOwVXvCn+V1+nQoRyXw0FTFE8O51BPVe1pfoEQzteaS 5 X-Google-Smtp-Source: AGHT+IG3Qkz0u5PG03f0YWSqMuB6n5nu4KojslzirQOed2SR/TyYsPoWQvfCXtCX+oCdpp6lJ1N56g== X-Received: by 2002:a2e:b4a6:0:b0:2ef:2b08:1747 with SMTP id 38308e7fff4ca-2f3c8ec7dfbmr1467771fa.13.1723828830665; Fri, 16 Aug 2024 10:20:30 -0700 (PDT) To: devel@lists.libvirt.org Subject: [PATCH 1/2] qemu: conf: Improve the foo_image_format setting descriptions Date: Fri, 16 Aug 2024 11:20:25 -0600 Message-Id: <20240816172026.3742-2-jfehlig@suse.com> X-Mailer: git-send-email 2.35.3 In-Reply-To: <20240816172026.3742-1-jfehlig@suse.com> References: <20240816172026.3742-1-jfehlig@suse.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Message-ID-Hash: R6JOQ6J3GOCIQMJRD6GANPPX64MYHOOZ X-Message-ID-Hash: R6JOQ6J3GOCIQMJRD6GANPPX64MYHOOZ X-MailFrom: jfehlig@suse.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: From: Jim Fehlig via Devel Reply-To: Jim Fehlig X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1723828884365116600 Content-Type: text/plain; charset="utf-8" The current description of the various foo_image_format settings can be construded to imply the setting is only used to control compression of the image. Improve the documentation to clarify that format describes the representation of guest memory blocks on disk, which includes compression among other possible layouts. Signed-off-by: Jim Fehlig --- If something like this is agreeable, I'd remove the sentences about 'mapped' format and include those in the mapped-ram work. src/qemu/qemu.conf.in | 46 ++++++++++++++++++++++++++++--------------- 1 file changed, 30 insertions(+), 16 deletions(-) diff --git a/src/qemu/qemu.conf.in b/src/qemu/qemu.conf.in index 6bc2140dcb..3e221048ef 100644 --- a/src/qemu/qemu.conf.in +++ b/src/qemu/qemu.conf.in @@ -578,27 +578,41 @@ # "/dev/infiniband/uverbs0" =20 =20 -# The default format for QEMU/KVM guest save images is raw; that is, the -# memory from the domain is dumped out directly to a file. If you have -# guests with a large amount of memory, however, this can take up quite -# a bit of space. If you would like to compress the images while they -# are being saved to disk, you can also set "zstd", "lzop", "gzip", "bzip2= ", -# or "xz" for save_image_format. Note that this means you slow down the pr= ocess -# of saving a domain in order to save disk space. +# The libvirt QEMU driver supports serveral different save image formats. +# The term "format" is used loosely to describe how the save image data is +# represented on disk. It could be a continguous stream of guest memory bl= ocks, +# a stream of compressed memory blocks, or memory blocks mapped to fixed +# locations in the save image file. # -# save_image_format is used when you use 'virsh save' or 'virsh managedsav= e' -# at scheduled saving, and it is an error if the specified save_image_form= at -# is not valid, or the requested compression program can't be found. +# A continguous stream of guest memory blocks is the default format for QE= MU/KVM +# guest save images and is termed "raw". The raw format can consume consid= erable +# disk space when saving large memory guests. Various compression formats = are +# available for specifying a save image compressed by the named algorithm. +# Supported compression formats are "zstd", "lzop", "gzip", "bzip2", and "= xz". +# The "mapped" format supports efficient direct and multithreaded I/O to t= he +# save image file. + +# save_image_format can be used to select the desired save format. "raw" is +# the traditional format used by libvirt and is also the default. The +# compression formats can be used to save disk space, although this typica= lly +# results in longer save and restore times. The "mapped" format is preferr= ed +# when doing direct and parallel I/O to the save image file, but can result +# in sparse save image files due to mapping of guest memory blocks to file +# offsets. # -# dump_image_format is used when you use 'virsh dump' at emergency -# crashdump, and if the specified dump_image_format is not valid, or -# the requested compression program can't be found, this falls -# back to "raw" compression. +# save_image_format is used with 'virsh save' or 'virsh managedsave'. It is +# an error if the specified save_image_format is not valid, or cannot be +# supported by the system. # -# snapshot_image_format specifies the compression algorithm of the memory = save +# dump_image_format is analogous to save_image_format and is used with +# 'virsh dump' at emergency crashdump. If the specified dump_image_format = is +# not valid or cannot be supported by the system, this falls back to the +# "raw" format. +# +# Likewise, snapshot_image_format specifies the format of the memory save # image when an external snapshot of a domain is taken. This does not apply # on disk image format. It is an error if the specified format isn't valid, -# or the requested compression program can't be found. +# or the system cannot support the requested format. # #save_image_format =3D "raw" #dump_image_format =3D "raw" --=20 2.35.3