From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id EA639C61CE7 for ; Sun, 8 Jun 2025 22:52:55 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uOOrh-00058D-UG; Sun, 08 Jun 2025 18:51:46 -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 1uOOrf-00057T-7I for qemu-devel@nongnu.org; Sun, 08 Jun 2025 18:51:43 -0400 Received: from mail-pg1-x533.google.com ([2607:f8b0:4864:20::533]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1uOOrc-000307-H3 for qemu-devel@nongnu.org; Sun, 08 Jun 2025 18:51:42 -0400 Received: by mail-pg1-x533.google.com with SMTP id 41be03b00d2f7-b2f62bbb5d6so1431837a12.0 for ; Sun, 08 Jun 2025 15:51:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1749423098; x=1750027898; darn=nongnu.org; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=wK2hm3ApSt7J5Cm2cd5SCgqF8ZdrraNEuFOEFuj/8LM=; b=kX3tThDQbIuZxTqKscKhAW6l/McbzqVSSsOH+9GFvAxxW+kcU7EX48MsCFdGpRdqv7 D5WfPRwtofM/yCElM2E7tNky5I7ZQvrZSOK8gOD5iQp11ssphyIxiVHrM+ISv1BNnged +QAYwEnn6CfzNQAkcLIaLVBxosCbwMlZtAJaBTiC+EHB/d99W3Jm1SzLM4x32Cx75XyR 9Y/4AseaP59q7Y1TKeRXC0cLiuhLDn4rUbzuWYNgWJbL3qh6lGDlctlfsS0V19Ch3rtT mmHExRhmG/XFSAyqHqJy6cINXYtQYJdm2/s32oZfjOB99a2jR7cvoZxGJ5EeqdmK4NJX oauw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1749423098; x=1750027898; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=wK2hm3ApSt7J5Cm2cd5SCgqF8ZdrraNEuFOEFuj/8LM=; b=jbviA3fOHH1yERjixCU08DAuUa2bNHAd0pXdzdoBr7durMwCStw03FjyDmhD3rGq8q lUF3a5Q8hBJ4bKJVP19qwW9OAswvIleB3L2IEagk1HAzqXncwMzdmV2mp3LmIBUCLhvW GXhilnnoMj0RXWJrSNLfFE6yuwbv4tfjWDuEjuLlmwz7AMPFJL21AI6b+yQeNnk7nGLe v8WQzD3pv1ocx6oQ3UP6cFkVrtJu3SOPNeZ2LyTz+0KEF+1wlcoakxNMaIpKohjdqc7X tz07FNaHrRxr8cYqZmY/vyLxmFFyIIcjCZGZdkE0JHHO2DAlDgDqE7CtGP2s0kM8HIdD i6LA== X-Gm-Message-State: AOJu0YylaAFlnh2ypn+OVFlzPd3ZDalFcCFcNSImGTJJB+2aqs8lDPyS 1E0cE8bI2x5p0wWALHvnkMvzr2ZWrPcfXmf4sFzgMzjejZA3Tjk+etiBxVVRbELn1Zk= X-Gm-Gg: ASbGncuICOZ4hCGPWFB+cGIcC7cOPmuIHdd8x6FB4dF/FBGbAn/ybmZaxeS9oisQP1G mFptHkcqILlCA+Qg6l4UZ5XcA2G/lkajSyjKnpK7f7ZXop/yQv3BWtgsY9yPGdH4k6U+xMHzFsF YIbKeha2XQ2Fiyvr5lzplJv2KAL7Ij2BrWdXq2e7EmtE8vbTeHsdAMNn+1eyp7oa5MMA6GKPL/e jE3JfxBkeR4NCJVSKsu7RCH8QjNDhy1aHrcOwxyQUBWelP7t35ndpo9rAgBpWcH0yQcUF02P71W wkKmPpLsDn3JUO47/7C+enU7bZJZ2hGndQqNGd9xzKdCt5tnuyP7GSZzGE23C5NYRMaaaMYN X-Google-Smtp-Source: AGHT+IE5Zgj9irgywKVrAt3sSyLWOZUlH0Xjazt+CmzUg54wi84l4810pBxCov2PGccUbyLMVpSyKA== X-Received: by 2002:a17:90a:dfcb:b0:312:959:dc4f with SMTP id 98e67ed59e1d1-313472b6a6dmr14869308a91.5.1749423098162; Sun, 08 Jun 2025 15:51:38 -0700 (PDT) Received: from shemhazi.lan ([50.46.174.34]) by smtp.gmail.com with ESMTPSA id 98e67ed59e1d1-3134b128012sm4395970a91.32.2025.06.08.15.51.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 08 Jun 2025 15:51:37 -0700 (PDT) From: Rowan Hart To: qemu-devel@nongnu.org Cc: Yanan Wang , Alexandre Iooss , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Mahmoud Mandour , Eduardo Habkost , Pierrick Bouvier , =?UTF-8?q?Alex=20Benn=C3=A9e?= , Marcel Apfelbaum , Zhao Liu , Richard Henderson , Paolo Bonzini , Rowan Hart Subject: [PATCH v8 0/9] Add additional plugin API functions to read and write memory and registers Date: Sun, 8 Jun 2025 15:51:27 -0700 Message-ID: <20250608225136.3340370-1-rowanbhart@gmail.com> X-Mailer: git-send-email 2.49.0 MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Received-SPF: pass client-ip=2607:f8b0:4864:20::533; envelope-from=rowanbhart@gmail.com; helo=mail-pg1-x533.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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, 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.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org This patch series adds several new API functions focused on enabling use cases around reading and writing guest memory from QEMU plugins. To support these new APIs, some utility functionality around retrieving information about address spaces is added as well. The new qemu_plugin_write_register utilizes gdb_write_register, which is now declared in gdbstub.h for this purpose instead of being static. qemu_plugin_write_memory_vaddr utilizes cpu_memory_rw_debug much the same as the existing read_memory_vaddr function does. The read and write_hwaddr functions are the most different. These functions use address_space_rw, which works well in most cases. There is an important caveat that for writes, the page being written will be set dirty by the write operation. This dirty setting requires locking the page range, which can contend with an already held lock in page_collection_lock when called in a tb translate callback with a write to the instruction memory in the tb. The doc comments warn against doing this, and it's unlikely anyone would want to do this. I've also added two test plugins: one that implements a simple hypercall interface that guest code can use to communicate with the plugin in a structured way with a test to ensure that this hypercall works and writing virtual memory works. And one that implements a simple patch utility to patch memory at runtime. The test for the second plugin ensures the patch applies successfully to instruction memory, and can use both hw and vaddr methods. For v3, I've had a few comments from the last submission that I've addressed, and some that I haven't for one reason or another: - Enforce QEMU_PLUGIN_CB_ flags in register read/write operations: done! - Fix my commit messages and add long messages describing commits: done! - Un-expose AS internals: done! Functions operate on current vCPU, current AS. - Clean up use of current_cpu: done! - Make functions take a vcpu_idx: not done. May revisit but it allows footguns. Even for translation, seems best to not do this now. We can easily add _vcpu versions of these functions in the future if we change our minds! For v5, I've just updated the enforcement of the QEMU_PLUGIN_CB_ flags to just use immediate stores, which simplifies the implementation quite a lot and should be more efficient too. Thanks Pierrick for the suggestion! v6 is a formatting pass, I left some whitespace that needed removal, some license text was wrong, and so forth. v8 reverts a mistake I made extending the size of arrays of TCGHelperInfo structs, as I misunderstood their sizes. It preserves adding an explicit zero as the last entry for clarity, however. Rowan Hart (2): plugins: Add enforcement of QEMU_PLUGIN_CB flags in register R/W callbacks plugins: Remove use of qemu_plugin_read_register where it is not permitted novafacing (7): gdbstub: Expose gdb_write_register function to consumers of gdbstub plugins: Add register write API plugins: Add memory virtual address write API plugins: Add memory hardware address read/write API plugins: Add patcher plugin and test plugins: Add hypercalls plugin and test plugins: Update plugin version and add notes accel/tcg/plugin-gen.c | 30 + gdbstub/gdbstub.c | 2 +- include/exec/gdbstub.h | 14 + include/hw/core/cpu.h | 1 + include/qemu/plugin.h | 4 + include/qemu/qemu-plugin.h | 166 +++++- plugins/api.c | 135 ++++- plugins/core.c | 20 + tests/tcg/Makefile.target | 2 + tests/tcg/plugins/hypercalls.c | 547 ++++++++++++++++++ tests/tcg/plugins/insn.c | 22 +- tests/tcg/plugins/meson.build | 2 +- tests/tcg/plugins/patch.c | 297 ++++++++++ tests/tcg/x86_64/Makefile.softmmu-target | 36 +- tests/tcg/x86_64/system/hypercalls-target.c | 40 ++ tests/tcg/x86_64/system/patch-target.c | 27 + .../tcg/x86_64/system/validate-hypercalls.py | 40 ++ tests/tcg/x86_64/system/validate-patch.py | 39 ++ 18 files changed, 1380 insertions(+), 44 deletions(-) create mode 100644 tests/tcg/plugins/hypercalls.c create mode 100644 tests/tcg/plugins/patch.c create mode 100644 tests/tcg/x86_64/system/hypercalls-target.c create mode 100644 tests/tcg/x86_64/system/patch-target.c create mode 100755 tests/tcg/x86_64/system/validate-hypercalls.py create mode 100755 tests/tcg/x86_64/system/validate-patch.py -- 2.49.0