From df5f63a608b791d6c1bfb9f0951010e892bf7d2b Mon Sep 17 00:00:00 2001 Message-Id: In-Reply-To: References: From: Luiz Capitulino Date: Fri, 5 Oct 2012 17:46:31 +0200 Subject: [PATCH 19/21] qmp: dump-guest-memory: improve schema doc (again) RH-Author: Luiz Capitulino Message-id: <1349459193-18226-18-git-send-email-lcapitulino@redhat.com> Patchwork-id: 42765 O-Subject: [RHEL6.4 qemu-kvm PATCH 17/19] qmp: dump-guest-memory: improve schema doc (again) Bugzilla: 832458 RH-Acked-by: Marcelo Tosatti RH-Acked-by: Markus Armbruster RH-Acked-by: Paolo Bonzini o Add a note about memory allocation with paging=true o Fix indentation Signed-off-by: Luiz Capitulino Reviewed-by: Eric Blake Reviewed-by: Markus Armbruster (cherry picked from commit d691180e41f58cc3c1f9fa848c2ab89193503160) Conflicts: qapi-schema.json Signed-off-by: Luiz Capitulino --- qapi-schema.json | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) Signed-off-by: Michal Novotny --- qapi-schema.json | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index d06b57b..e529c51 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -196,26 +196,33 @@ # supported on i386 and x86_64. # # @paging: if true, do paging to get guest's memory mapping. This allows -# using gdb to process the core file. However, setting @paging to false -# may be desirable because of two reasons: +# using gdb to process the core file. # -# 1. The guest may be in a catastrophic state or can have corrupted -# memory, which cannot be trusted -# 2. The guest can be in real-mode even if paging is enabled. For example, -# the guest uses ACPI to sleep, and ACPI sleep state goes in real-mode +# IMPORTANT: this option can make QEMU allocate several gigabytes +# of RAM. This can happen for a large guest, or a +# malicious guest pretending to be large. +# +# Also, paging=true has the following limitations: +# +# 1. The guest may be in a catastrophic state or can have corrupted +# memory, which cannot be trusted +# 2. The guest can be in real-mode even if paging is enabled. For +# example, the guest uses ACPI to sleep, and ACPI sleep state +# goes in real-mode # # @protocol: the filename or file descriptor of the vmcore. The supported -# protocols are: +# protocols are: # -# 1. file: the protocol starts with "file:", and the following string is -# the file's path. -# 2. fd: the protocol starts with "fd:", and the following string is the -# fd's name. +# 1. file: the protocol starts with "file:", and the following +# string is the file's path. +# 2. fd: the protocol starts with "fd:", and the following string +# is the fd's name. # # @begin: #optional if specified, the starting physical address. # # @length: #optional if specified, the memory size, in bytes. If you don't -# want to dump all guest's memory, please specify the start @begin and @length +# want to dump all guest's memory, please specify the start @begin +# and @length # # Returns: nothing on success # If @begin contains an invalid address, InvalidParameter -- 1.7.11.4