From nobody Sun May 19 00:43:00 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=1611245904; cv=none; d=zohomail.com; s=zohoarc; b=Ltw7niNdd9OF/eIQ8u7NJJYKjXU0674tieeeglHN7iq0Au7Y5Mnk0wzq6+20Jj6ZTNOelf/UsKAugSjrTo09WYwE0aEyiQ4hPKXj4OlghcoUisWWPz3Xn0pq6ew1ihl1AzVBJc3ZFNekidgkCXfPtWLOXNItkMRwouBawLpaQGo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1611245904; 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=expx/yH7rLnCgpdu5NCfs5+DOoqpSf10cfqxc5toEjY=; b=EoqqmdXGpUyp4fgKjksJsX+au6k9I0nB5A2q63YlrPRNJYrfQnN90h/rseFprtnDZvA1z0nX+wQ/iFVrOq/uimwqgeRi4I7jyEp9Rk3PiHuRqzHuSkTKPVv8J5D9m2WCAy04+LHgLat+XnoA23eM+HILfZ0u6IkVRRhioJPYPgM= 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 1611245904974717.5018408570896; Thu, 21 Jan 2021 08:18:24 -0800 (PST) Received: from localhost ([::1]:43650 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1l2cfA-0004lM-0b for importer@patchew.org; Thu, 21 Jan 2021 11:18:24 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:39174) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1l2ccf-0003Hq-B5 for qemu-devel@nongnu.org; Thu, 21 Jan 2021 11:15:49 -0500 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:23535) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_CBC_SHA1:256) (Exim 4.90_1) (envelope-from ) id 1l2cc7-00034q-9j for qemu-devel@nongnu.org; Thu, 21 Jan 2021 11:15:48 -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-565-QbftkLEBP-KDqTKH6Llt_w-1; Thu, 21 Jan 2021 11:15:08 -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 4207F1800D41; Thu, 21 Jan 2021 16:15:07 +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 1A7001A3D8; Thu, 21 Jan 2021 16:15:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1611245711; 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=expx/yH7rLnCgpdu5NCfs5+DOoqpSf10cfqxc5toEjY=; b=XlX9Ic5VIiSu528TDtqrbcGhhAYWRaXLfK55zDXVacupxIkNhlhnKqbIdsyz3bWLvNARKe /TqGCecg92xlo4sZeq5G7D7l1tZmRI0qm8tD/Ml3htahianosGFUxm6U9mK2orYAE9adSo H3kD4spSOzyfOH/Chd2DrxHbttRrZN0= X-MC-Unique: QbftkLEBP-KDqTKH6Llt_w-1 From: Igor Mammedov To: qemu-devel@nongnu.org Subject: [PATCH v3] machine: add missing doc for memory-backend option Date: Thu, 21 Jan 2021 11:15:04 -0500 Message-Id: <20210121161504.1007247-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=216.205.24.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.168, 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_H3=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: peter.maydell@linaro.org, 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. x- was intended for unstable/iternal properties, and not supposed to be stable option. However it's too late to rename (drop x-) it as it would mean that users will have to mantain both x-use-canonical-path-for-ramblock-id (for QEMU 5.0-5.2) versions and prefix-less for later versions. Signed-off-by: Igor Mammedov Reviewed-by: Michal Privoznik --- v2: - add doc that x-use-canonical-path-for-ramblock-id is considered stable, (Peter Krempa ) v3: - s/x-use-canonical-path-for-ramblock-id=3Don/x-use-canonical-path-for-ram= block-id=3Doff/ (Michal Privoznik ) - add to commit message why x- prefix is preserved - drop clause about x-use-canonical-path-for-ramblock-id being stable from help section, but keep it in code comment above x-use-canonical-path-for-ramblock-id property. It's sufficient to prevent option being changed/removed by accident. (Peter Maydell ) --- backends/hostmem.c | 10 ++++++++++ qemu-options.hx | 26 +++++++++++++++++++++++++- 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/backends/hostmem.c b/backends/hostmem.c index 9f9ac95edd..813aeb83c9 100644 --- a/backends/hostmem.c +++ b/backends/hostmem.c @@ -498,6 +498,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 62791f56d8..059b1a1d14 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,29 @@ 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), if mi= gration + to/from old QEMU (<5.0) is expected. + b) for machine types 4.0 and older, user shall + use ``x-use-canonical-path-for-ramblock-id=3Doff`` backend option + 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=3Doff + -machine memory-backend=3Dpc.ram + -m 512M ERST =20 HXCOMM Deprecated by -machine --=20 2.27.0