From nobody Mon May 13 05:46:20 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; 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=fail(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1610668061; cv=none; d=zohomail.com; s=zohoarc; b=H5OoF9kSBaZaIw/R2jKoDN5fE/9DUOxIYxso1AEzlKKpXBr8G9Dmyut0VXuGKC9QYugZGrhKTv2SMCrsjLLSGYGEPnuu9I/xI/5r2aRGpmOruEHE53IOTZoAnRq8ZqQnpdL/gKLIrQmafNPBoVTzq7+uYRv9DeSw0mLorpbAr7s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1610668061; 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=8Dspy5cp12GDiV3zu23e5jDiMyAfZz5XzDpKbWSyH6Q=; b=LgXtmLBrT0F+1jhmUlMtY1cVdrGMLv2s/FU5cd99JZS4GXDjWmFvi3briwMDFT13O+noqaMhITr9C1fzYDrk0zK4Ds2BV3Cv2svB/5M5hjVKQJDPOB5mfKP3VNozwJNvBk5KfPX3aqBodA6RZcuNJNsUT4SArnvF5nOQoXskJbM= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=fail; 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=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1610668061722309.04681055187746; Thu, 14 Jan 2021 15:47:41 -0800 (PST) Received: from localhost ([::1]:38116 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1l0CL4-0001Xy-BO for importer@patchew.org; Thu, 14 Jan 2021 18:47:40 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:42672) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1l0CJu-00016W-5a for qemu-devel@nongnu.org; Thu, 14 Jan 2021 18:46:26 -0500 Received: from us-smtp-delivery-124.mimecast.com ([63.128.21.124]:57980) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1l0CJq-0000IZ-UR for qemu-devel@nongnu.org; Thu, 14 Jan 2021 18:46:25 -0500 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-526-d_nkPxivPJ6yzpKyVVbwJw-1; Thu, 14 Jan 2021 18:46:18 -0500 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 A834C802B42 for ; Thu, 14 Jan 2021 23:46:17 +0000 (UTC) Received: from dell-r430-03.lab.eng.brq.redhat.com (dell-r430-03.lab.eng.brq.redhat.com [10.37.153.18]) by smtp.corp.redhat.com (Postfix) with ESMTP id A5E2B19C45; Thu, 14 Jan 2021 23:46:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1610667980; 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=8Dspy5cp12GDiV3zu23e5jDiMyAfZz5XzDpKbWSyH6Q=; b=BAYwvIe1PsJPEwqzK3TlbY0T48bykDG22h8XmSqvql9MEQLWKjM8ucW+/vfwTZAN7XyuIS /ynXcBV/n26z8Q0nhRhhONKpseB+RDxCVUNsjyrNxXGC6vLzQEfvpkBYOAMfTrIzdGbW+R kYiruY4jPQ+4q0DBAmLvbGbmPba+o4o= X-MC-Unique: d_nkPxivPJ6yzpKyVVbwJw-1 From: Igor Mammedov To: qemu-devel@nongnu.org Subject: [PATCH v2] machine: add missing doc for memory-backend option Date: Thu, 14 Jan 2021 18:46:12 -0500 Message-Id: <20210114234612.795621-1-imammedo@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=imammedo@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=63.128.21.124; envelope-from=imammedo@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -29 X-Spam_score: -3.0 X-Spam_bar: --- X-Spam_report: (-3.0 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.248, 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_H4=0.001, RCVD_IN_MSPIKE_WL=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: mprivozn@redhat.com, pkrempa@redhat.com, pbonzini@redhat.com Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) Content-Type: text/plain; charset="utf-8" Add documentation for '-machine memory-backend' CLI option and how to use it. And document that x-use-canonical-path-for-ramblock-id, is considered to be stable to make sure it won't go away by accident. Signed-off-by: Igor Mammedov --- v2: - add doc that x-use-canonical-path-for-ramblock-id is considered stable, (Peter Krempa ) --- backends/hostmem.c | 10 ++++++++++ qemu-options.hx | 28 +++++++++++++++++++++++++++- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/backends/hostmem.c b/backends/hostmem.c index 4bde00e8e7..6aaeefd0cf 100644 --- a/backends/hostmem.c +++ b/backends/hostmem.c @@ -497,6 +497,16 @@ host_memory_backend_class_init(ObjectClass *oc, void *= data) host_memory_backend_get_share, host_memory_backend_set_share); object_class_property_set_description(oc, "share", "Mark the memory as private to QEMU or shared"); + /* + * Do not delete/rename option. This option must be considered stable + * (as if it didn't have the 'x-' prefix including deprecation period)= as + * long as 4.0 and older machine types exists. + * Option will be used by upper layers to override (disable) canonical= path + * for ramblock-id set by compat properties on old machine types ( <= =3D 4.0), + * to keep migration working when backend is used for main RAM with + * -machine memory-backend=3D option (main RAM historically used prefi= x-less + * ramblock-id). + */ object_class_property_add_bool(oc, "x-use-canonical-path-for-ramblock-= id", host_memory_backend_get_use_canonical_path, host_memory_backend_set_use_canonical_path); diff --git a/qemu-options.hx b/qemu-options.hx index 459c916d3d..22aa267c30 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -35,7 +35,8 @@ DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ " suppress-vmdesc=3Don|off disables self-describing mig= ration (default=3Doff)\n" " nvdimm=3Don|off controls NVDIMM support (default=3Dof= f)\n" " memory-encryption=3D@var{} memory encryption object t= o use (default=3Dnone)\n" - " hmat=3Don|off controls ACPI HMAT support (default=3Do= ff)\n", + " hmat=3Don|off controls ACPI HMAT support (default=3Do= ff)\n" + " memory-backend=3D'backend-id' specifies explicitly pr= ovided backend for main RAM (default=3Dnone)\n", QEMU_ARCH_ALL) SRST ``-machine [type=3D]name[,prop=3Dvalue[,...]]`` @@ -96,6 +97,31 @@ SRST ``hmat=3Don|off`` Enables or disables ACPI Heterogeneous Memory Attribute Table (HMAT) support. The default is off. + + ``memory-backend=3D'id'`` + An alternative to legacy ``-mem-path`` and ``mem-prealloc`` option= s. + Allows to use a memory backend as main RAM. + + For example: + :: + -object memory-backend-file,id=3Dpc.ram,size=3D512M,mem-path=3D/hu= getlbfs,prealloc=3Don,share=3Don + -machine memory-backend=3Dpc.ram + -m 512M + + Migration compatibility note: + a) as backend id one shall use value of 'default-ram-id', advertis= ed by + machine type (available via ``query-machines`` QMP command) + b) for machine types 4.0 and older, user shall + use ``x-use-canonical-path-for-ramblock-id=3Don`` backend option + (this option must be considered stable, as if it didn't have the '= x-' + prefix including deprecation period, as long as 4.0 and older mach= ine + types exists), + if migration to/from old QEMU (<5.0) is expected. + For example: + :: + -object memory-backend-ram,id=3Dpc.ram,size=3D512M,x-use-canonical= -path-for-ramblock-id=3Don + -machine memory-backend=3Dpc.ram + -m 512M ERST =20 HXCOMM Deprecated by -machine --=20 2.27.0