From patchwork Wed Aug 2 08:45:48 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akihiko Odaki X-Patchwork-Id: 1815860 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org 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=) Authentication-Results: legolas.ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=daynix-com.20221208.gappssmtp.com header.i=@daynix-com.20221208.gappssmtp.com header.a=rsa-sha256 header.s=20221208 header.b=A8q2HByu; dkim-atps=neutral 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 4RG5Fq68Drz1yZl for ; Wed, 2 Aug 2023 18:47:25 +1000 (AEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qR7VC-0005lW-JL; Wed, 02 Aug 2023 04:46:42 -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 1qR7VB-0005lC-AB for qemu-devel@nongnu.org; Wed, 02 Aug 2023 04:46:41 -0400 Received: from mail-pf1-x42f.google.com ([2607:f8b0:4864:20::42f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qR7V9-0005Nx-Az for qemu-devel@nongnu.org; Wed, 02 Aug 2023 04:46:41 -0400 Received: by mail-pf1-x42f.google.com with SMTP id d2e1a72fcca58-6877eb31261so10070b3a.1 for ; Wed, 02 Aug 2023 01:46:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=daynix-com.20221208.gappssmtp.com; s=20221208; t=1690965998; x=1691570798; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=hZOMuO3rhFRWQN0XLBRdhTTdxZDt1LzSnd4CLS3vr3w=; b=A8q2HByuW5srAU7i1rcsWieYkLXuX7hCOlNugUHyw/n0ZepSb4NaYWmI8BDn4u0BH1 gRJbtrZo4MRQjy4hqGEXGPeoLK9kUV5W9Yyvmm8eiPzR8jWqLcWgvGWrQGYfdRMgpYfB xJS6iFaO8g/RcT3rJrAwnVQT2Vs2Pm6VIxVImA8ErjPekfqFSWekmJy8jUIiOaaVTTId I/rHblno7BiUyEk8AgBlF1n4DQLAYgFt9hdq4TPMYYnD06AYfhAeF9bii8Qy5ESeTReP PdcOFhr2E+H+/VH92gr7DRK68YiB9tpTS7u9o4U99RlGBtaMmw8ZGv5zxSrEd0co977l 7FNg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1690965998; x=1691570798; 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=hZOMuO3rhFRWQN0XLBRdhTTdxZDt1LzSnd4CLS3vr3w=; b=ckSkjpHBAtT7bNtUi3aknmK5C3XcMZQKmtaeHozyeeC38PcRUY6W4R8LE5MkWoFoWK R4sJ7zS7S8PCA9plXZNQus4+/pKv7cjgbv58dTWCoF+dUqCZnunUSOzhrMJGs+vsYzoS 4iA6rA47fpB6KXVIJh/KniAjAf7ldgvSGwArqKzowQ1oRok9a9boavj6L8yupeLwDvFt 3nride4on4o3chErbZ+izaG96JxxQudbSNR3kd5Z4mzNKS76xW7FadhqbuHcf2ZaohVs yDrg/H2d6L38nkGIrmW+7bKcygXzQW8jZKfOXWNaz6Ssd0kJe/So7plsGGwoaI7M7w9P TRsA== X-Gm-Message-State: ABy/qLZWzztxmsoAKkqRo92gmKeNdxJpniFJqdo/cAei+x77h/Psp9QG Jvj/2R/T7Rj2HuyYIKYXJhebwg== X-Google-Smtp-Source: APBJJlFi9Q9SFTPgm/rIiS6+HzOSG57M2ioiVuiuH1ZPp7jBzIwfQSvSQABez7mEqW30Ykp93KUeSQ== X-Received: by 2002:a05:6a21:71c1:b0:13d:f217:d318 with SMTP id ay1-20020a056a2171c100b0013df217d318mr7519878pzc.49.1690965997824; Wed, 02 Aug 2023 01:46:37 -0700 (PDT) Received: from alarm.flets-east.jp ([2400:4050:a840:1e00:78d2:b862:10a7:d486]) by smtp.gmail.com with ESMTPSA id j22-20020aa79296000000b00659b8313d08sm10592860pfa.78.2023.08.02.01.46.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 02 Aug 2023 01:46:37 -0700 (PDT) From: Akihiko Odaki To: Cc: Paolo Bonzini , =?utf-8?q?Alex_Benn=C3=A9e?= , Thomas Huth , Alexandre Iooss , Mahmoud Mandour , Eduardo Habkost , Marcel Apfelbaum , =?utf-8?q?Philippe_Mathieu-D?= =?utf-8?q?aud=C3=A9?= , Yanan Wang , Richard Henderson , =?utf-8?q?Marc-Andr=C3=A9?= =?utf-8?q?_Lureau?= , =?utf-8?q?Daniel_P_=2E_B?= =?utf-8?q?errang=C3=A9?= , John Snow , Cleber Rosa , Peter Maydell , Michael Rolnik , "Edgar E . Iglesias" , Brian Cain , Song Gao , Xiaojuan Yang , Laurent Vivier , Aurelien Jarno , Jiaxun Yang , Aleksandar Rikalo , Chris Wulff , Marek Vasut , Stafford Horne , Daniel Henrique Barboza , =?utf-8?q?C=C3=A9dric_Le_G?= =?utf-8?q?oater?= , David Gibson , Greg Kurz , Nicholas Piggin , Palmer Dabbelt , Alistair Francis , Bin Meng , Weiwei Li , Liu Zhiwei , Yoshinori Sato , David Hildenbrand , Ilya Leoshkevich , Mark Cave-Ayland , Artyom Tarasenko , Bastian Koppelmann , Max Filippov , qemu-devel@nongnu.org, qemu-arm@nongnu.org, qemu-ppc@nongnu.org, qemu-riscv@nongnu.org, qemu-s390x@nongnu.org, Anton Kochkov , Akihiko Odaki Subject: [PATCH v2 00/24] plugins: Allow to read registers Date: Wed, 2 Aug 2023 17:45:48 +0900 Message-ID: <20230802084614.23619-1-akihiko.odaki@daynix.com> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Received-SPF: none client-ip=2607:f8b0:4864:20::42f; envelope-from=akihiko.odaki@daynix.com; helo=mail-pf1-x42f.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, T_SCC_BODY_TEXT_LINE=-0.01 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 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 last one is to allow to implement a QEMU plugin in C++. A plugin that I'll describe later is written in C++. The below is a summary of patches: Patch 01 fixes a bug in execlog plugin. Patch [02, 13] introduces GDBFeature. Patch [14, 17] adds information useful for plugins to GDBFeature. Patch [18, 20] makes registers readable outside of gdbstub context. Patch [21, 22] adds the feature to read registers from plugins. Patch [23, 24] makes it possible to write plugins in C++. 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 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 (24): contrib/plugins: Use GRWLock in execlog gdbstub: Introduce GDBFeature structure gdbstub: Add num_regs member to GDBFeature gdbstub: Introduce gdb_find_static_feature() target/arm: Move the reference to arm-core.xml hw/core/cpu: Replace gdb_core_xml_file with gdb_core_feature 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: Simplify XML lookup hw/core/cpu: Remove gdb_get_dynamic_xml member gdbstub: Add members to identify registers to GDBFeature target/arm: Fill new members of GDBFeature target/ppc: Fill new members of GDBFeature target/riscv: Fill new members of GDBFeature hw/core/cpu: Add a parameter to gdb_read_register/gdb_write_register gdbstub: Hide gdb_has_xml gdbstub: Expose functions to read registers plugins: Allow to read registers contrib/plugins: Allow to log registers plugins: Support C++ contrib/plugins: Add cc plugin MAINTAINERS | 2 +- docs/devel/tcg-plugins.rst | 18 +++- configure | 15 ++- meson.build | 2 +- gdbstub/internals.h | 8 ++ include/exec/gdbstub.h | 30 +++--- include/hw/core/cpu.h | 15 ++- include/qemu/qemu-plugin.h | 69 +++++++++++++- target/alpha/cpu.h | 6 +- target/arm/cpu.h | 37 ++++---- target/arm/internals.h | 2 +- target/avr/cpu.h | 6 +- target/cris/cpu.h | 9 +- target/hexagon/internal.h | 6 +- target/hppa/cpu.h | 6 +- target/i386/cpu.h | 6 +- target/loongarch/internals.h | 6 +- target/m68k/cpu.h | 6 +- target/microblaze/cpu.h | 6 +- target/mips/internal.h | 6 +- target/openrisc/cpu.h | 6 +- target/ppc/cpu-qom.h | 3 +- target/ppc/cpu.h | 15 +-- target/riscv/cpu.h | 10 +- target/rx/cpu.h | 6 +- target/s390x/cpu.h | 2 - target/s390x/s390x-internal.h | 6 +- target/sh4/cpu.h | 6 +- target/sparc/cpu.h | 6 +- target/tricore/cpu.h | 6 +- target/xtensa/cpu.h | 6 +- contrib/plugins/execlog.c | 140 ++++++++++++++++++++------- cpu.c | 11 --- gdbstub/gdbstub.c | 100 ++++++++++++-------- hw/core/cpu-common.c | 16 +++- plugins/api.c | 40 ++++++++ stubs/gdbstub.c | 6 +- target/alpha/gdbstub.c | 6 +- target/arm/cpu.c | 6 +- target/arm/cpu64.c | 4 +- target/arm/gdbstub.c | 172 ++++++++++++++++++---------------- target/arm/gdbstub64.c | 55 +++++++---- target/arm/tcg/cpu32.c | 3 +- target/avr/cpu.c | 4 +- target/avr/gdbstub.c | 6 +- target/cris/gdbstub.c | 9 +- target/hexagon/cpu.c | 5 +- target/hexagon/gdbstub.c | 6 +- target/hppa/gdbstub.c | 6 +- target/i386/cpu.c | 7 +- target/i386/gdbstub.c | 10 +- target/loongarch/cpu.c | 4 +- target/loongarch/gdbstub.c | 8 +- target/m68k/cpu.c | 7 +- target/m68k/gdbstub.c | 6 +- target/m68k/helper.c | 6 +- target/microblaze/cpu.c | 9 +- target/microblaze/gdbstub.c | 6 +- target/mips/gdbstub.c | 6 +- target/nios2/cpu.c | 6 +- target/openrisc/gdbstub.c | 6 +- target/ppc/cpu_init.c | 9 +- target/ppc/gdbstub.c | 62 ++++++------ target/riscv/cpu.c | 21 +---- target/riscv/gdbstub.c | 68 +++++++++----- target/rx/cpu.c | 4 +- target/rx/gdbstub.c | 6 +- target/s390x/cpu.c | 4 +- target/s390x/gdbstub.c | 34 +++---- target/sh4/gdbstub.c | 6 +- target/sparc/gdbstub.c | 6 +- target/tricore/gdbstub.c | 6 +- target/xtensa/gdbstub.c | 6 +- contrib/plugins/Makefile | 5 + contrib/plugins/cc.cc | 17 ++++ plugins/qemu-plugins.symbols | 2 + scripts/feature_to_c.py | 102 ++++++++++++++++++++ scripts/feature_to_c.sh | 69 -------------- tests/tcg/Makefile.target | 3 + 79 files changed, 910 insertions(+), 529 deletions(-) create mode 100644 contrib/plugins/cc.cc create mode 100755 scripts/feature_to_c.py delete mode 100644 scripts/feature_to_c.sh