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 ED0C6C5478C for ; Tue, 27 Feb 2024 07:48:48 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1resBo-0004cB-GP; Tue, 27 Feb 2024 02:47:48 -0500 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 1resBi-0004ZG-QF for qemu-devel@nongnu.org; Tue, 27 Feb 2024 02:47:44 -0500 Received: from mail-pl1-x633.google.com ([2607:f8b0:4864:20::633]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1resBd-0003an-SF for qemu-devel@nongnu.org; Tue, 27 Feb 2024 02:47:41 -0500 Received: by mail-pl1-x633.google.com with SMTP id d9443c01a7336-1d93edfa76dso34049945ad.1 for ; Mon, 26 Feb 2024 23:47:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=daynix-com.20230601.gappssmtp.com; s=20230601; t=1709020055; x=1709624855; darn=nongnu.org; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :from:to:cc:subject:date:message-id:reply-to; bh=5Va+9CpvBWB277k7Vk/5Lq5SeV6/w0TKZhR5/P0tOS8=; b=XE5D407Ti789ZRTKtrPJ5Xq/wW5hvcivpjrWLiqvwYisNjJWr0hfT3xyijAIKxUw7y nOLAtzr/StgFR6Q9Kpsx0+NTC54BtmQjU7kyqyWR3X6K8XzmGhvqmfP9AK8A+/yXkVb5 AX9Tw3hpvsLCCYFbkWdwLoC0Iux2uify+SgbqQBYnjEB5NT9tYEqMhxf6kEyLWmnsxN7 ooIyqGCZ+IT9ZOc7f8bGb+inb2CpD4vPqxr34NGZyVJz4h5b77lkhA32YUytddfLTnXf /bQYJ9wsv6A0wmH3V18xs6k71o+AZf25LUF2ZcEunagp7So8hIKZgpQCktzd7VtcAqZu 2bLg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1709020055; x=1709624855; h=content-transfer-encoding:in-reply-to:from:content-language :references:cc:to:subject:user-agent:mime-version:date:message-id :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=5Va+9CpvBWB277k7Vk/5Lq5SeV6/w0TKZhR5/P0tOS8=; b=O/6f5+rrd75WsQsyq3J8GAz9N+WOCkbHThY3JbIpjrPG9WX2p1AQ/F30hsV+rEw/28 3qBioQTviAI0oTts0Z3pzYxgc85tiFGpG3qafMzdyQLlI48BZ6L3Pgj8weNCbgVFp7pI Oi0J17WSOe018OBtS8pM4XZFuTc576XCj5mXSL0h1qfINnFPR7LmMF7VJCdXft9E3Ghc sOvM91+58L+R3UsVlJSP+3QFEGzFGb+QkbN+MSxX3vyy+f/D11le/bh6KcjmNU6i1/3U CKZqwf9U9uiQQssmMa4+bltu87uCpRoiWzoIMjd6oajYA98dOOyX+u+Y1kEpSLp8N+zy Pn1A== X-Forwarded-Encrypted: i=1; AJvYcCWeQ7bYF4LMpAXou8pajMhUbT7SfmeQAAltIw2KunhY1ycT+9zKt7OOhXfewTdYAvoL+Y2Y3jcarWVVe09D6GU1pbISLX8= X-Gm-Message-State: AOJu0YzdFyTgHK8/xTOH4rzihAbNnQqKi7NBhw7ivcrju+mgrY2HobGA FG6yHQ6+7zKe9HF1pvgbS5AHwpNCeZ164isrkCAUaSLneA51T/Guzt18meqqCGQ= X-Google-Smtp-Source: AGHT+IHa5GPNZQyrh4lPjtiCaHfY4JaLVAhx3qAa4gyn6vwaRY7nzPSNlOoJIGtj3YT9SHvapxuPpQ== X-Received: by 2002:a17:903:244d:b0:1dc:93b:8981 with SMTP id l13-20020a170903244d00b001dc093b8981mr14131905pls.14.1709020055516; Mon, 26 Feb 2024 23:47:35 -0800 (PST) Received: from [157.82.203.206] ([157.82.203.206]) by smtp.gmail.com with ESMTPSA id l21-20020a170903005500b001db82fdc89asm880947pla.305.2024.02.26.23.47.28 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Mon, 26 Feb 2024 23:47:35 -0800 (PST) Message-ID: Date: Tue, 27 Feb 2024 16:47:26 +0900 MIME-Version: 1.0 User-Agent: Mozilla Thunderbird Subject: Re: [PATCH v3 21/27] plugins: add an API to read registers To: =?UTF-8?Q?Alex_Benn=C3=A9e?= , qemu-devel@nongnu.org Cc: Nicholas Piggin , Liu Zhiwei , =?UTF-8?Q?C=C3=A9dric_Le_Goater?= , Peter Maydell , qemu-riscv@nongnu.org, Michael Rolnik , Song Gao , Alexandre Iooss , Marcel Apfelbaum , David Hildenbrand , Pierrick Bouvier , John Snow , Eduardo Habkost , Mahmoud Mandour , qemu-arm@nongnu.org, =?UTF-8?Q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Cleber Rosa , qemu-ppc@nongnu.org, Richard Henderson , qemu-s390x@nongnu.org, Daniel Henrique Barboza , Thomas Huth , Yoshinori Sato , Yanan Wang , Brian Cain , Ilya Leoshkevich , Weiwei Li , "Edgar E. Iglesias" , Bin Meng , Laurent Vivier , Palmer Dabbelt , Daniel Henrique Barboza , Alistair Francis References: <20240226165646.425600-1-alex.bennee@linaro.org> <20240226165646.425600-22-alex.bennee@linaro.org> Content-Language: en-US From: Akihiko Odaki In-Reply-To: <20240226165646.425600-22-alex.bennee@linaro.org> Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit Received-SPF: none client-ip=2607:f8b0:4864:20::633; envelope-from=akihiko.odaki@daynix.com; helo=mail-pl1-x633.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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org On 2024/02/27 1:56, Alex Bennée wrote: > We can only request a list of registers once the vCPU has been > initialised so the user needs to use either call the get function on > vCPU initialisation or during the translation phase. > > We don't expose the reg number to the plugin instead hiding it behind > an opaque handle. For now this is just the gdb_regnum encapsulated in > an anonymous GPOINTER but in future as we add more state for plugins > to track we can expand it. > > Resolves: https://gitlab.com/qemu-project/qemu/-/issues/1706 > Cc: Akihiko Odaki > Message-Id: <20240103173349.398526-39-alex.bennee@linaro.org> > Based-on: <20231025093128.33116-18-akihiko.odaki@daynix.com> > Signed-off-by: Alex Bennée > Reviewed-by: Pierrick Bouvier Hi, Mostly looks good. I have a few trivial comments so please have a look at them. > > --- > v4 > - the get/read_registers functions are now implicitly for current > vCPU only to accidental cpu != current_cpu uses. > v5 > - make reg_handles as per-CPUPluginState variable. > v6 > - for now just wrap gdb_regnum > --- > include/qemu/qemu-plugin.h | 48 +++++++++++++++++++++++++++++-- > plugins/api.c | 56 ++++++++++++++++++++++++++++++++++++ > plugins/qemu-plugins.symbols | 2 ++ > 3 files changed, 104 insertions(+), 2 deletions(-) > > diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h > index 93981f8f89f..3b6b18058d2 100644 > --- a/include/qemu/qemu-plugin.h > +++ b/include/qemu/qemu-plugin.h > @@ -11,6 +11,7 @@ > #ifndef QEMU_QEMU_PLUGIN_H > #define QEMU_QEMU_PLUGIN_H > > +#include > #include > #include > #include > @@ -229,8 +230,8 @@ struct qemu_plugin_insn; > * @QEMU_PLUGIN_CB_R_REGS: callback reads the CPU's regs > * @QEMU_PLUGIN_CB_RW_REGS: callback reads and writes the CPU's regs > * > - * Note: currently unused, plugins cannot read or change system > - * register state. > + * Note: currently QEMU_PLUGIN_CB_RW_REGS is unused, plugins cannot change > + * system register state. > */ > enum qemu_plugin_cb_flags { > QEMU_PLUGIN_CB_NO_REGS, > @@ -707,4 +708,47 @@ uint64_t qemu_plugin_end_code(void); > QEMU_PLUGIN_API > uint64_t qemu_plugin_entry_code(void); > > +/** struct qemu_plugin_register - Opaque handle for register access */ > +struct qemu_plugin_register; > + > +/** > + * typedef qemu_plugin_reg_descriptor - register descriptions > + * > + * @handle: opaque handle for retrieving value with qemu_plugin_read_register > + * @name: register name > + * @feature: optional feature descriptor, can be NULL > + */ > +typedef struct { > + struct qemu_plugin_register *handle; > + const char *name; > + const char *feature; > +} qemu_plugin_reg_descriptor; > + > +/** > + * qemu_plugin_get_registers() - return register list for current vCPU > + * > + * Returns a GArray of qemu_plugin_reg_descriptor or NULL. Caller > + * frees the array (but not the const strings). > + * > + * Should be used from a qemu_plugin_register_vcpu_init_cb() callback > + * after the vCPU is initialised, i.e. in the vCPU context. > + */ > +GArray *qemu_plugin_get_registers(void); > + > +/** > + * qemu_plugin_read_register() - read register for current vCPU > + * > + * @handle: a @qemu_plugin_reg_handle handle > + * @buf: A GByteArray for the data owned by the plugin > + * > + * This function is only available in a context that register read access is > + * explicitly requested via the QEMU_PLUGIN_CB_R_REGS flag. > + * > + * Returns the size of the read register. The content of @buf is in target byte > + * order. On failure returns -1 > + */ > +int qemu_plugin_read_register(struct qemu_plugin_register *handle, > + GByteArray *buf); > + > + > #endif /* QEMU_QEMU_PLUGIN_H */ > diff --git a/plugins/api.c b/plugins/api.c > index 54df72c1c00..03412598047 100644 > --- a/plugins/api.c > +++ b/plugins/api.c > @@ -8,6 +8,7 @@ > * > * qemu_plugin_tb > * qemu_plugin_insn > + * qemu_plugin_register > * > * Which can then be passed back into the API to do additional things. > * As such all the public functions in here are exported in > @@ -35,10 +36,12 @@ > */ > > #include "qemu/osdep.h" > +#include "qemu/main-loop.h" > #include "qemu/plugin.h" > #include "qemu/log.h" > #include "tcg/tcg.h" > #include "exec/exec-all.h" > +#include "exec/gdbstub.h" > #include "exec/ram_addr.h" > #include "disas/disas.h" > #include "plugin.h" > @@ -410,3 +413,56 @@ uint64_t qemu_plugin_entry_code(void) > #endif > return entry; > } > + > +/* > + * Create register handles. > + * > + * We need to create a handle for each register so the plugin > + * infrastructure can call gdbstub to read a register. They are > + * currently just a pointer encapsulation of the gdb_regnum but in > + * future may hold internal plugin state so its important plugin > + * authors are not tempted to treat them as numbers. > + * > + * We also construct a result array with those handles and some > + * ancillary data the plugin might find useful. > + */ > + > +static GArray *create_register_handles(CPUState *cs, GArray *gdbstub_regs) > +{ cs is unused. > + GArray *find_data = g_array_new(true, true, > + sizeof(qemu_plugin_reg_descriptor)); > + > + for (int i = 0; i < gdbstub_regs->len; i++) { > + GDBRegDesc *grd = &g_array_index(gdbstub_regs, GDBRegDesc, i); > + > + /* skip "un-named" regs */ > + if (!grd->name) { > + continue; > + } > + > + /* Create a record for the plugin */ > + qemu_plugin_reg_descriptor desc = { > + .handle = GINT_TO_POINTER(grd->gdb_reg), > + .name = g_intern_string(grd->name), > + .feature = g_intern_string(grd->feature_name) > + }; Please remove a mixed declaration; see: docs/devel/style.rst > + g_array_append_val(find_data, desc); > + } > + > + return find_data; > +} > + > +GArray *qemu_plugin_get_registers(void) > +{ > + g_assert(current_cpu); > + > + g_autoptr(GArray) regs = gdb_get_register_list(current_cpu); > + return regs->len ? create_register_handles(current_cpu, regs) : NULL; Why do you need regs->len check? > +} > + > +int qemu_plugin_read_register(struct qemu_plugin_register *reg, GByteArray *buf) > +{ > + g_assert(current_cpu); > + > + return gdb_read_register(current_cpu, buf, GPOINTER_TO_INT(reg)); > +} > diff --git a/plugins/qemu-plugins.symbols b/plugins/qemu-plugins.symbols > index adb67608598..27fe97239be 100644 > --- a/plugins/qemu-plugins.symbols > +++ b/plugins/qemu-plugins.symbols > @@ -3,6 +3,7 @@ > qemu_plugin_end_code; > qemu_plugin_entry_code; > qemu_plugin_get_hwaddr; > + qemu_plugin_get_registers; > qemu_plugin_hwaddr_device_name; > qemu_plugin_hwaddr_is_io; > qemu_plugin_hwaddr_phys_addr; > @@ -19,6 +20,7 @@ > qemu_plugin_num_vcpus; > qemu_plugin_outs; > qemu_plugin_path_to_binary; > + qemu_plugin_read_register; > qemu_plugin_register_atexit_cb; > qemu_plugin_register_flush_cb; > qemu_plugin_register_vcpu_exit_cb;