From patchwork Tue Oct 17 19:09:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akihiko Odaki X-Patchwork-Id: 1850398 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=daynix-com.20230601.gappssmtp.com header.i=@daynix-com.20230601.gappssmtp.com header.a=rsa-sha256 header.s=20230601 header.b=BXfzLRpO; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=patchwork.ozlabs.org) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4S93Sw2h89z20Vq for ; Wed, 18 Oct 2023 06:09:52 +1100 (AEDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qspRq-00042F-1N; Tue, 17 Oct 2023 15:09: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 1qspRl-00040r-QQ for qemu-devel@nongnu.org; Tue, 17 Oct 2023 15:09:41 -0400 Received: from mail-pl1-x631.google.com ([2607:f8b0:4864:20::631]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qspRi-0001aM-7C for qemu-devel@nongnu.org; Tue, 17 Oct 2023 15:09:41 -0400 Received: by mail-pl1-x631.google.com with SMTP id d9443c01a7336-1c77449a6daso48785335ad.0 for ; Tue, 17 Oct 2023 12:09:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=daynix-com.20230601.gappssmtp.com; s=20230601; t=1697569777; x=1698174577; 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=2B16Z9CkRVnpeqt50Vdmh9S3LzVFKLHJ1nwUCjkTEac=; b=BXfzLRpOuGxq6ibhIjJNKp8HKadms8eP04WU7C5+bNreGbqING13H/IgjNzYNeN9BR r/R+cbKZQFKe9qkyxfJNga7d10Kl1GjE4HnwkTRY+b1cGTUJuFhMBqiB9wBwf0xE+yIu 0daGf7K3XI6hbMc8yFI6SM1aqCUcuZNTEfxW2++JF5UExdZNpO5JyQzNkrYOz1hAorZa u34GhWbSUgxDFY2fjO41lOKgZQ0+rCc0ygNRNSOlLA7UwXw53cIBoWgeEMnfR+01RWXN FcV61vowXJqsEPThM9K3K1rjW0yClw26hUCRhMi6t+wPkm8YfR4vxmgMX6WFNE24ywfL yhEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697569777; x=1698174577; 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=2B16Z9CkRVnpeqt50Vdmh9S3LzVFKLHJ1nwUCjkTEac=; b=hsk2dQwULVsz7ZNcNGG6bLB5QL1gtVYkGW4K5aqLYDfvV1co47V7ChgnE7RYX/rh5F SeVlhClet+00L6WqsX6x7kWtXf0ChivTsrzVuVsYkK4pToYTCKthxEIvqPTWxVetNQfu qUtHEUY+gIN/lgcAy1+H+f8vFRdG3P7gjOGsK1Ksry00OQeV673qPCuqkScRcz9HfpZP 02RBynBjCij48vMEeAP8mGotHhFnDl3HMl422eUZmVTdYGDLiWfPJWBAtgiPEvAjI46O vq6rGV+NWzJn4MBmvxvOfq8JQNibdt8L6UG9R4f8cgEUhtynBwYPZOjKOO7cL47c4Vnn lSTQ== X-Gm-Message-State: AOJu0YyKyXZt1XQaPx6U6Jijhg17il8bAH7yV8pjEq2c2YSoWoTTlxde XX+FGs8OwZ/yWAtfhfmj6bp8amUohvFcu4pZRQ332g== X-Google-Smtp-Source: AGHT+IFV0rGZpD2eAqR6S3H3AnrOK8FuwweTNCF26+zQQnPXRWnXsXZor+8nmnOQ6QWket7p8I9mbQ== X-Received: by 2002:a17:902:ea0e:b0:1c9:e774:58dc with SMTP id s14-20020a170902ea0e00b001c9e77458dcmr3418253plg.7.1697569776666; Tue, 17 Oct 2023 12:09:36 -0700 (PDT) Received: from localhost ([2400:4050:a840:1e00:78d2:b862:10a7:d486]) by smtp.gmail.com with UTF8SMTPSA id l4-20020a170902eb0400b001c1f0b3e900sm1935249plb.229.2023.10.17.12.09.34 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 17 Oct 2023 12:09:36 -0700 (PDT) From: Akihiko Odaki To: Cc: =?utf-8?q?Alex_Benn=C3=A9e?= , Mikhail Tyutin , Aleksandr Anenkov , qemu-devel@nongnu.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Akihiko Odaki Subject: [PATCH v13 00/18] plugins: Allow to read registers Date: Wed, 18 Oct 2023 04:09:10 +0900 Message-ID: <20231017190931.16211-1-akihiko.odaki@daynix.com> X-Mailer: git-send-email 2.42.0 MIME-Version: 1.0 Received-SPF: none client-ip=2607:f8b0:4864:20::631; envelope-from=akihiko.odaki@daynix.com; helo=mail-pl1-x631.google.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_NONE=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+incoming=patchwork.ozlabs.org@nongnu.org Sender: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Based-on: <20231017185406.13381-1-akihiko.odaki@daynix.com> ("[PATCH v4 0/5] gdbstub and TCG plugin improvements") I and other people in the University of Tokyo, where I research processor design, found TCG plugins are very useful for processor design exploration. The feature we find missing is the capability to read registers from plugins. In this series, I propose to add such a capability by reusing gdbstub code. The reuse of gdbstub code ensures the long-term stability of the TCG plugin interface for register access without incurring a burden to maintain yet another interface for register access. This process to add TCG plugin involves four major changes. The first one is to add GDBFeature structure that represents a GDB feature, which usually includes registers. GDBFeature can be generated from static XML files or dynamically generated by architecture-specific code. In fact, this is a refactoring independent of the feature this series adds, and potentially it's benefitial even without the plugin feature. The plugin feature will utilize this new structure to describe registers exposed to plugins. The second one is to make gdb_read_register/gdb_write_register usable outside of gdbstub context. The third one is to actually make registers readable for plugins. The execlog plugin will have new options to demonstrate the new feature. I also have a plugin that uses this new feature to generate execution traces for Sniper processor simulator, which is available at: https://github.com/shioya-lab/sniper/tree/akihikodaki/bb The below is a summary of patches: Patch [01, 12] introduces num_regs member to GDBFeature. Patch 13 adds members useful to identify registers to GDBFeature. Patch 14 makes registers readable outside of gdbstub context. Patch [15, 18] add the feature to read registers from plugins. V12 -> V13: Rebased to "[PATCH v4 0/5] gdbstub and TCG plugin improvements". V11 -> V12: Rebased to "[PATCH v2 0/3] gdbstub and TCG plugin improvements". V10 -> V11: Fixed QEMU_PLUGIN_CB_RW_REGS. V9 -> V10: Rebased to "[PATCH 0/4] gdbstub and TCG plugin improvements". Dropped patch "plugins: Support C++". Removed the unnecessary QEMU_PLUGIN_VERSION change. V8 -> V9: Rebased to "[PATCH 00/25] October maintainer omnibus pre-PR (tests, gdbstub, plugins)". Added patch "target/riscv: Move MISA limits to class". Added patch "target/riscv: Remove misa_mxl validation". Added patch "target/riscv: Validate misa_mxl_max only once". Added patch "plugins: Use different helpers when reading". Moved contrib/plugins/cc.cc to tests/plugin/cc.cc. V7 -> V8: Rebased to "[PATCH v3 00/12] gdbstub and TCG plugin improvements". Clarified that initialization and exit hooks affect TCG state. Simplified by adding the core feature to gdb_regs. V6 -> V7: Rebased to "[PATCH v2 00/11] gdbstub and TCG plugin improvements". Replaced functions to get register identifiers. V5 -> V6: Rebased to "[PATCH 0/8] gdbstub and TCG plugin improvements". V4 -> V5: Corrected g_rw_lock_writer_lock() call. (Richard Henderson) Replaced abort() with g_assert_not_reached(). (Richard Henderson) Fixed CSR name leak in target/riscv. (Richard Henderson) Removed gdb_has_xml variable. V3 -> V4: Added execlog changes I forgot to include in the last version. V2 -> V3: Added patch "hw/core/cpu: Return static value with gdb_arch_name()". Added patch "gdbstub: Dynamically allocate target.xml buffer". (Alex Bennée) Added patch "gdbstub: Introduce GDBFeatureBuilder". (Alex Bennée) Dropped Reviewed-by tags for "target/*: Use GDBFeature for dynamic XML". Changed gdb_find_static_feature() to abort on failure. (Alex Bennée) Changed the execlog plugin to log the register value only when changed. (Alex Bennée) Dropped 0x prefixes for register value logs for conciseness. V1 -> V2: Added SPDX-License-Identifier: GPL-2.0-or-later. (Philippe Mathieu-Daudé) Split long lines. (Philippe Mathieu-Daudé) Renamed gdb_features to gdb_static_features (Philippe Mathieu-Daudé) Dropped RFC. Akihiko Odaki (18): gdbstub: Add num_regs member to GDBFeature gdbstub: Introduce gdb_find_static_feature() gdbstub: Introduce GDBFeatureBuilder target/arm: Use GDBFeature for dynamic XML target/ppc: Use GDBFeature for dynamic XML target/riscv: Use GDBFeature for dynamic XML gdbstub: Use GDBFeature for gdb_register_coprocessor gdbstub: Use GDBFeature for GDBRegisterState gdbstub: Change gdb_get_reg_cb and gdb_set_reg_cb gdbstub: Simplify XML lookup gdbstub: Infer number of core registers from XML hw/core/cpu: Remove gdb_get_dynamic_xml member gdbstub: Add members to identify registers to GDBFeature gdbstub: Expose functions to read registers cpu: Call plugin hooks only when ready plugins: Use different helpers when reading registers plugins: Allow to read registers contrib/plugins: Allow to log registers docs/devel/tcg-plugins.rst | 10 +- accel/tcg/plugin-helpers.h | 3 +- include/exec/gdbstub.h | 39 +++++- include/exec/plugin-gen.h | 4 +- include/hw/core/cpu.h | 11 +- include/qemu/plugin.h | 3 + include/qemu/qemu-plugin.h | 50 +++++++- plugins/plugin.h | 5 +- target/arm/cpu.h | 27 ++-- target/arm/internals.h | 14 +- target/hexagon/internal.h | 4 +- target/microblaze/cpu.h | 4 +- target/ppc/cpu-qom.h | 4 +- target/ppc/cpu.h | 3 +- target/riscv/cpu.h | 5 +- target/s390x/cpu.h | 2 - accel/tcg/plugin-gen.c | 41 ++++-- accel/tcg/translator.c | 2 +- contrib/plugins/execlog.c | 120 +++++++++++++----- cpu-target.c | 11 -- gdbstub/gdbstub.c | 240 +++++++++++++++++++++++++---------- hw/core/cpu-common.c | 15 ++- plugins/api.c | 34 ++++- plugins/core.c | 28 ++-- target/arm/cpu.c | 2 - target/arm/cpu64.c | 1 - target/arm/gdbstub.c | 221 ++++++++++++++++---------------- target/arm/gdbstub64.c | 117 +++++++++-------- target/avr/cpu.c | 1 - target/hexagon/cpu.c | 4 +- target/hexagon/gdbstub.c | 10 +- target/i386/cpu.c | 2 - target/loongarch/cpu.c | 2 - target/loongarch/gdbstub.c | 13 +- target/m68k/cpu.c | 1 - target/m68k/helper.c | 26 +++- target/microblaze/cpu.c | 6 +- target/microblaze/gdbstub.c | 9 +- target/ppc/cpu_init.c | 5 +- target/ppc/gdbstub.c | 108 ++++++++-------- target/riscv/cpu.c | 15 --- target/riscv/gdbstub.c | 135 +++++++++++--------- target/rx/cpu.c | 1 - target/s390x/cpu.c | 1 - target/s390x/gdbstub.c | 105 +++++++++------ plugins/qemu-plugins.symbols | 3 + scripts/feature_to_c.py | 58 ++++++++- 47 files changed, 952 insertions(+), 573 deletions(-)