From nobody Fri May 17 07:55:51 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1629286219; cv=none; d=zohomail.com; s=zohoarc; b=EEKRZEvlZnHhuYsCGXyQY6LU8WaAkzChys3YW756SGWlQKHZmtFxh55SdLCffjwxMsZ9beenluhfzzCcW8cpyp8pkd19KgL+40KDYGzpT8VdRjKfgcBQaRRqo7fIruCWJbMFBo5mFeVK0Iw5KHjiXiYVqItIupUT3phQbrVJ7dY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629286219; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Sender:Subject:To; bh=kqRYvlEJzFexAHHfD88+SXVkezxYieOn0iYqvz7Cc7w=; b=Tw+OMq4JJeGgtt4WMPOXwpgtMXYnscTRwF5CHkKRPvuUmKdrSoPG4qzQeXPaoOGunBc5Zq4NrqTVDedHElFp7ay0OUPfhdpKfN0wiI9LM/8NvSDum/MAK/RufgaBT/LcozuvXPUUaxlmceUNtblDRbrS66JMXWno2bA+Yg8lW9I= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1629286219479322.43340854902294; Wed, 18 Aug 2021 04:30:19 -0700 (PDT) Received: from localhost ([::1]:40098 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mGJlv-0002wS-B1 for importer@patchew.org; Wed, 18 Aug 2021 07:30:15 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:58866) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mGJl5-00024o-Nq for qemu-devel@nongnu.org; Wed, 18 Aug 2021 07:29:23 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:49344) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mGJl2-0005op-Cb for qemu-devel@nongnu.org; Wed, 18 Aug 2021 07:29:22 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-584-sEvWfv0wNd6QU-cUlycLVQ-1; Wed, 18 Aug 2021 07:29:17 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 0A8971082921; Wed, 18 Aug 2021 11:29:17 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.132]) by smtp.corp.redhat.com (Postfix) with ESMTP id F14AF19D9B; Wed, 18 Aug 2021 11:29:15 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629286159; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=kqRYvlEJzFexAHHfD88+SXVkezxYieOn0iYqvz7Cc7w=; b=d8FVxyYmhm6dSINGUgnCXFrWj47JNS2nuEk+fNoVItNhVC1q3RXamXmHGcPMN7AYj19PUn FQUMgu7sE8okji/nGk5WAk2OwZ1Vzusosiv6Y636WPH0i1M/1UDPb398hW+/8kCo+f7gfL 4H/TL72KC5xezMxh87TbPaAkG90KiFI= X-MC-Unique: sEvWfv0wNd6QU-cUlycLVQ-1 From: Thomas Huth To: qemu-devel@nongnu.org Subject: [PATCH for-6.2] docs/about/removed-features: Move some CLI options to the right location Date: Wed, 18 Aug 2021 13:29:08 +0200 Message-Id: <20210818112908.102205-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.84 on 10.5.11.23 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.7, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: qemu-trivial@nongnu.org, Igor Mammedov Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629286221921100001 Content-Type: text/plain; charset="utf-8" Some of the removed CLI options have been added to the wrong section in the "Removed features" chapter - they've been put into the "Related binaries" section instead. Move them now into the correct "System emulator command line arguments" section. Signed-off-by: Thomas Huth --- docs/about/removed-features.rst | 137 ++++++++++++++------------------ 1 file changed, 61 insertions(+), 76 deletions(-) diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.= rst index cbfa1a8e31..032d68d141 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -146,12 +146,73 @@ Replaced by ``-rtc base=3Ddate``. The "tls-creds" option should be used instead to point to a "tls-creds-x50= 9" object created using "-object". =20 +``-mem-path`` fallback to RAM (removed in 5.0) +'''''''''''''''''''''''''''''''''''''''''''''' + +If guest RAM allocation from file pointed by ``mem-path`` failed, +QEMU was falling back to allocating from RAM, which might have resulted +in unpredictable behavior since the backing file specified by the user +as ignored. Currently, users are responsible for making sure the backing s= torage +specified with ``-mem-path`` can actually provide the guest RAM configured= with +``-m`` and QEMU fails to start up if RAM allocation is unsuccessful. + ``-net ...,name=3D...`` (removed in 5.1) '''''''''''''''''''''''''''''''''''''' =20 The ``name`` parameter of the ``-net`` option was a synonym for the ``id`` parameter, which should now be used instead. =20 +``-numa node,mem=3D...`` (removed in 5.1) +''''''''''''''''''''''''''''''''''''''' + +The parameter ``mem`` of ``-numa node`` was used to assign a part of guest= RAM +to a NUMA node. But when using it, it's impossible to manage a specified R= AM +chunk on the host side (like bind it to a host node, setting bind policy, = ...), +so the guest ends up with the fake NUMA configuration with suboptiomal +performance. +However since 2014 there is an alternative way to assign RAM to a NUMA node +using parameter ``memdev``, which does the same as ``mem`` and adds +means to actually manage node RAM on the host side. Use parameter ``memdev= `` +with *memory-backend-ram* backend as replacement for parameter ``mem`` +to achieve the same fake NUMA effect or a properly configured +*memory-backend-file* backend to actually benefit from NUMA configuration. +New machine versions (since 5.1) will not accept the option but it will st= ill +work with old machine types. User can check the QAPI schema to see if the = legacy +option is supported by looking at MachineInfo::numa-mem-supported property. + +``-numa`` node (without memory specified) (removed 5.2) +''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Splitting RAM by default between NUMA nodes had the same issues as ``mem`` +parameter with the difference that the role of the user plays QEMU using +implicit generic or board specific splitting rule. +Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if +it's supported by used machine type) to define mapping explicitly instead. +Users of existing VMs, wishing to preserve the same RAM distribution, shou= ld +configure it explicitly using ``-numa node,memdev`` options. Current RAM +distribution can be retrieved using HMP command ``info numa`` and if separ= ate +memory devices (pc|nv-dimm) are present use ``info memory-device`` and sub= tract +device memory from output of ``info numa``. + +``-smp`` (invalid topologies) (removed 5.2) +''''''''''''''''''''''''''''''''''''''''''' + +CPU topology properties should describe whole machine topology including +possible CPUs. + +However, historically it was possible to start QEMU with an incorrect topo= logy +where *n* <=3D *sockets* * *cores* * *threads* < *maxcpus*, +which could lead to an incorrect topology enumeration by the guest. +Support for invalid topologies is removed, the user must ensure +topologies described with -smp include all possible cpus, i.e. +*sockets* * *cores* * *threads* =3D *maxcpus*. + +``-machine enforce-config-section=3Don|off`` (removed 5.2) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``enforce-config-section`` property was replaced by the +``-global migration.send-configuration=3D{on|off}`` option. + ``-no-kvm`` (removed in 5.2) '''''''''''''''''''''''''''' =20 @@ -590,82 +651,6 @@ enforce that any failure to open the backing image (in= cluding if the backing file is missing or an incorrect format was specified) is an error when ``-u`` is not used. =20 -Command line options --------------------- - -``-smp`` (invalid topologies) (removed 5.2) -''''''''''''''''''''''''''''''''''''''''''' - -CPU topology properties should describe whole machine topology including -possible CPUs. - -However, historically it was possible to start QEMU with an incorrect topo= logy -where *n* <=3D *sockets* * *cores* * *threads* < *maxcpus*, -which could lead to an incorrect topology enumeration by the guest. -Support for invalid topologies is removed, the user must ensure -topologies described with -smp include all possible cpus, i.e. -*sockets* * *cores* * *threads* =3D *maxcpus*. - -``-numa`` node (without memory specified) (removed 5.2) -''''''''''''''''''''''''''''''''''''''''''''''''''''''' - -Splitting RAM by default between NUMA nodes had the same issues as ``mem`` -parameter with the difference that the role of the user plays QEMU using -implicit generic or board specific splitting rule. -Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if -it's supported by used machine type) to define mapping explicitly instead. -Users of existing VMs, wishing to preserve the same RAM distribution, shou= ld -configure it explicitly using ``-numa node,memdev`` options. Current RAM -distribution can be retrieved using HMP command ``info numa`` and if separ= ate -memory devices (pc|nv-dimm) are present use ``info memory-device`` and sub= tract -device memory from output of ``info numa``. - -``-numa node,mem=3D``\ *size* (removed in 5.1) -'''''''''''''''''''''''''''''''''''''''''''' - -The parameter ``mem`` of ``-numa node`` was used to assign a part of -guest RAM to a NUMA node. But when using it, it's impossible to manage a s= pecified -RAM chunk on the host side (like bind it to a host node, setting bind poli= cy, ...), -so the guest ends up with the fake NUMA configuration with suboptiomal per= formance. -However since 2014 there is an alternative way to assign RAM to a NUMA node -using parameter ``memdev``, which does the same as ``mem`` and adds -means to actually manage node RAM on the host side. Use parameter ``memdev= `` -with *memory-backend-ram* backend as replacement for parameter ``mem`` -to achieve the same fake NUMA effect or a properly configured -*memory-backend-file* backend to actually benefit from NUMA configuration. -New machine versions (since 5.1) will not accept the option but it will st= ill -work with old machine types. User can check the QAPI schema to see if the = legacy -option is supported by looking at MachineInfo::numa-mem-supported property. - -``-mem-path`` fallback to RAM (removed in 5.0) -'''''''''''''''''''''''''''''''''''''''''''''' - -If guest RAM allocation from file pointed by ``mem-path`` failed, -QEMU was falling back to allocating from RAM, which might have resulted -in unpredictable behavior since the backing file specified by the user -as ignored. Currently, users are responsible for making sure the backing s= torage -specified with ``-mem-path`` can actually provide the guest RAM configured= with -``-m`` and QEMU fails to start up if RAM allocation is unsuccessful. - -``-smp`` (invalid topologies) (removed 5.2) -''''''''''''''''''''''''''''''''''''''''''' - -CPU topology properties should describe whole machine topology including -possible CPUs. - -However, historically it was possible to start QEMU with an incorrect topo= logy -where *n* <=3D *sockets* * *cores* * *threads* < *maxcpus*, -which could lead to an incorrect topology enumeration by the guest. -Support for invalid topologies is removed, the user must ensure -topologies described with -smp include all possible cpus, i.e. -*sockets* * *cores* * *threads* =3D *maxcpus*. - -``-machine enforce-config-section=3Don|off`` (removed 5.2) -'''''''''''''''''''''''''''''''''''''''''''''''''''''''' - -The ``enforce-config-section`` property was replaced by the -``-global migration.send-configuration=3D{on|off}`` option. - qemu-img amend to adjust backing file (removed in 6.1) '''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 --=20 2.27.0