From patchwork Mon Apr 24 09:22:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 676554 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp2054433wrs; Mon, 24 Apr 2023 02:24:07 -0700 (PDT) X-Google-Smtp-Source: AKy350YGn+ORryHGrZhHL1Yi4bvaNkn7YPCCDCeNo5FeYPwUyDJ9t52nNNXKoKhvFWvlYPtGu3eA X-Received: by 2002:ad4:5bc4:0:b0:5ef:410f:88be with SMTP id t4-20020ad45bc4000000b005ef410f88bemr24808972qvt.1.1682328246893; Mon, 24 Apr 2023 02:24:06 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682328246; cv=none; d=google.com; s=arc-20160816; b=t8u4IIxZ/J8TOoZ2KFF84mQjePrfMrAJSG24ao55KGKAzmZdoBIGQLTWdO+vViAz8L g48h/R8wR+XDdoLhpta2ICXLQbHD4qu2yFumGx+HeHRTxc7TGlDFP8PyIf8w1jM1BA2E jLrCSkjpu7Ah2Kix81IRx1FnRIZRMj8jLcsfCWco7SHlNSJStd2N/nPurNge7UO8O6M6 Io4EUzm8w3ZSSmwE9XKCscBx6MxChxXgf7S6YPrJu1M9CqwErUDw1Qf8Gw7r7fOXcwKz zk5xfGVhmdaQcwJftnj41IbRXJtNf3aFG3olL+ElLtItYV527OjqE6ARG2FwFgE3mS8e RYWA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=E75ZWyiqIVTxUEOaQt09ssb12BxYvniNvmSS7shhmvE=; b=S30uo9GWiQetYrdYOKVc3wY92H6oI9k0o5yHJsTH3B9Q+I4qb4l8Tma0I6np7nzEWB 8Y0yJ13vHrmUAqNNHvsMdqBv15zMUvhwU1V2qDp7c43/cUIERYJzNoPHSD6QH27DqniP G04yNrfYaFlLYntnMYZUHW5cT3DIudwZNMB4s21T4KCPQPJNzWaod6V2x1I4cRNNnkdY Bs8mSKHmEWJI9+rXcHGXF6HmMLMfENp1DDXyZOyw/+oybbQBQiN/w5MORvvfpKG4TFSC GO0oY8H5cIYzebYb/RmGZDXvYeauV9x+39WKXcrMQ5HlMR3RSNXc1D3h3SkPCGzxQ0t2 jGZw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=MKJBRs77; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id iv15-20020ad45cef000000b0056eb019cf92si6989383qvb.118.2023.04.24.02.24.06 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 24 Apr 2023 02:24:06 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=MKJBRs77; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pqsQ5-0007eH-KP; Mon, 24 Apr 2023 05:23:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pqsPl-0007Ng-Ip for qemu-devel@nongnu.org; Mon, 24 Apr 2023 05:23:25 -0400 Received: from mail-wm1-x32a.google.com ([2a00:1450:4864:20::32a]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pqsPS-0004oY-Ee for qemu-devel@nongnu.org; Mon, 24 Apr 2023 05:23:16 -0400 Received: by mail-wm1-x32a.google.com with SMTP id 5b1f17b1804b1-3f1950f5676so29975545e9.3 for ; Mon, 24 Apr 2023 02:22:58 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682328177; x=1684920177; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=E75ZWyiqIVTxUEOaQt09ssb12BxYvniNvmSS7shhmvE=; b=MKJBRs77kBxBCvrH4zO9hHK6RV8e7Hvetk8obi8rkNcg/kd5paHhW4tXyvsoY1uq9I z+W2qFE6FYIPiJz6WvTSmEbwkiT0krFydvB78NLzVi1zFJDWt94RQeiwxoHRVKzTEnly bxbvYw7QosRy0JsHVmjyg/SSsgwyCulrsWWAMAtoMDQRPdIijq2UbjPE64YB7AL7Z+fl V56mo4NUbW6RaXYW0h/zrP5uIgeQewkouyXmEhiJR+RTBZBPM9rueKWGxyz790CUkYTb 6umdJ1pJxlySZm1unCUMsIDDyC046VKBdPkNhkamm/Bs3ZyC4gXSHL/WkR5wQbaZ6Rwy dZKg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682328177; x=1684920177; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=E75ZWyiqIVTxUEOaQt09ssb12BxYvniNvmSS7shhmvE=; b=amCU5s2+8/HE5eFr8XkilJ9DRaCD6uZT1clUxIcmZnubVGg6zTYzvknsrhZoLJ6i+o umsxjotNSWPRJicfNDjj9k2Qqf4KTSPUsW7oHm0JoNDv/ESWQfhK8L2ztb0T/RiuIjdk Od5u25xiqtV14Oh2FgSszEJ3lpRjEYX0aIIXeECNbz2i8QhPqeNai4MbMUE8EMRA/cWd mj5/npHqX7ChqLkQ+Ssvmkfzm6oAFISprIkoFcbZdfYn4c6HVqirj9+A5eobs0cevtpO y2TGK97YOlv7RhZUr6KFzPgY7Q4lmcQEYZ3l4egmPd5c43tmEeiY3WOzdifA3dbTT2TK opYg== X-Gm-Message-State: AAQBX9c/yE1/FPrPRhcx72JgP2WkBGyw0sL9DOcKUV9f5VrZMrNm/eJ4 4tvlKopDJ7i/KeXjSB5lcrTZYg== X-Received: by 2002:adf:db4e:0:b0:2f2:3dbf:6922 with SMTP id f14-20020adfdb4e000000b002f23dbf6922mr7989880wrj.22.1682328176753; Mon, 24 Apr 2023 02:22:56 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id h3-20020a5d5043000000b002c70ce264bfsm10315847wrt.76.2023.04.24.02.22.52 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Apr 2023 02:22:53 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 1E71F1FFB7; Mon, 24 Apr 2023 10:22:51 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Wainer dos Santos Moschetta , Beraldo Leal , Thomas Huth , =?utf-8?q?Alex_Benn=C3=A9e?= , "Edgar E. Iglesias" , Paolo Bonzini , Aurelien Jarno , Peter Maydell , Juan Quintela , =?utf-8?q?C=C3=A9dric_Le_Goater?= , Richard Henderson , Joel Stanley , Leif Lindholm , Markus Armbruster , Radoslaw Biernacki , Stefan Hajnoczi , =?utf-8?q?Marc-Andr=C3=A9_Lureau?= , John Snow , Andrew Jeffery , David Hildenbrand , Bastian Koppelmann , Max Filippov , qemu-s390x@nongnu.org, Cleber Rosa , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , =?utf-8?q?Dani?= =?utf-8?q?el_P=2E_Berrang=C3=A9?= , qemu-arm@nongnu.org, Eduardo Habkost , Ilya Leoshkevich , Yohei Kojima Subject: [PATCH 14/18] qemu-options.hx: Update descriptions of memory options for NUMA node Date: Mon, 24 Apr 2023 10:22:45 +0100 Message-Id: <20230424092249.58552-15-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230424092249.58552-1-alex.bennee@linaro.org> References: <20230424092249.58552-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32a; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x32a.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Yohei Kojima This commit adds the following description: 1. `memdev` option is recommended over `mem` option (see [1,2]) 2. users must specify memory for all NUMA nodes (see [2]) This commit also separates descriptions for `mem` and `memdev` into two paragraphs. The old doc describes legacy `mem` option first, and it was a bit confusing. Related documentation: [1] https://wiki.qemu.org/ChangeLog/5.1#Incompatible_changes [2] https://www.qemu.org/docs/master/about/removed-features.html Signed-off-by: Yohei Kojima Message-Id: Reviewed-by: Juan Quintela Message-Id: <20230420155723.1711048-3-alex.bennee@linaro.org> [AJB: fix documentation in commit message] Signed-off-by: Alex Bennée --- qemu-options.hx | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index baa0589733..b5efa648ba 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -405,15 +405,22 @@ SRST -numa node,nodeid=0 -numa node,nodeid=1 \ -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 - Legacy '\ ``mem``\ ' assigns a given RAM amount to a node (not supported - for 5.1 and newer machine types). '\ ``memdev``\ ' assigns RAM from - a given memory backend device to a node. If '\ ``mem``\ ' and - '\ ``memdev``\ ' are omitted in all nodes, RAM is split equally between them. - - - '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive. - Furthermore, if one node uses '\ ``memdev``\ ', all of them have to - use it. + '\ ``memdev``\ ' option assigns RAM from a given memory backend + device to a node. It is recommended to use '\ ``memdev``\ ' option + over legacy '\ ``mem``\ ' option. This is because '\ ``memdev``\ ' + option provides better performance and more control over the + backend's RAM (e.g. '\ ``prealloc``\ ' parameter of + '\ ``-memory-backend-ram``\ ' allows memory preallocation). + + For compatibility reasons, legacy '\ ``mem``\ ' option is + supported in 5.0 and older machine types. Note that '\ ``mem``\ ' + and '\ ``memdev``\ ' are mutually exclusive. If one node uses + '\ ``memdev``\ ', the rest nodes have to use '\ ``memdev``\ ' + option, and vice versa. + + Users must specify memory for all NUMA nodes by '\ ``memdev``\ ' + (or legacy '\ ``mem``\ ' if available). In QEMU 5.2, the support + for '\ ``-numa node``\ ' without memory specified was removed. '\ ``initiator``\ ' is an additional option that points to an initiator NUMA node that has best performance (the lowest latency or