From nobody Tue Feb 10 02:55:21 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=fail(p=none dis=none) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1625774813366207.38759251538454; Thu, 8 Jul 2021 13:06:53 -0700 (PDT) Received: from localhost ([::1]:52464 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m1aIO-0000xZ-4O for importer@patchew.org; Thu, 08 Jul 2021 16:06:52 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53360) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m1ZgG-0005bH-Le for qemu-devel@nongnu.org; Thu, 08 Jul 2021 15:27:29 -0400 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:36690) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m1ZgD-00020X-6T for qemu-devel@nongnu.org; Thu, 08 Jul 2021 15:27:27 -0400 Received: by mail-wr1-x435.google.com with SMTP id v5so8929515wrt.3 for ; Thu, 08 Jul 2021 12:27:24 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id p16sm3145650wrs.52.2021.07.08.12.27.14 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 08 Jul 2021 12:27:19 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 82D831FFBA; Thu, 8 Jul 2021 20:09:45 +0100 (BST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=4FTfkZOV5J8pPR8DrVAy9dNoascCzZiPQY9J5eWzkN0=; b=lPQoL2LiKpwTtjEti3idT6Dm0GQcMHIWjjihOqwohN2sJ4yy6F5WVrnKUr8mncpo5n SKTYTrICzLS0au9Li5/CusVv8dIgbRtbVKDX8OS0wEghkE1CZ4LpPM8YwG2bM2gYOhYM +ElGrrpofoFcZ9kW63P6CyF97dixb1uaSMy2ZSRZR4wn0OQk/XSKskSMVQnooqTd0ntN kLsFyrKsGuA5msn5XJi7MlWgD67s8HFjiMqbxXAOz+bNWx3mURAfeOrymuE44B354J4F L0FIlaEg7Fl/Xt72Najf0gsmAuEyJAgeiql24Ld7atILqKL/WVUee4bUt8uZxYYydcHY ljOw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=4FTfkZOV5J8pPR8DrVAy9dNoascCzZiPQY9J5eWzkN0=; b=mNR/YzVPSgUg2mtqbxCLvW4jDjgh97Z+X2GQuh7sPCYMgpDMSbrVVrk1JBOIdy1n0/ xZhq7LgiJinU4TFJ6qrGBEZvUr1PJrquypiVG8yO3LV9W9y5aCQuV/Cpu42/aZRXBn0s w7NFvHNMZwd2ziQLhMX79xfUduJccXhNMV+UpjWB/n5EzOSOoL9r/6oe/I4rYCkjaMl7 8Kr1AdrRnnv6Ech8iHKhkrosHeV1zxIg3MiiknddMnFZ4ppe+5sEwPrCsuJJGyEJW+qf eAtqYhOjgfEZd1icECWlWaS9ZAMwQicZCf9RsjYrAC6MLK0ktSMLxl/YlTQBYSJZWxiH Fnbg== X-Gm-Message-State: AOAM532gedblYcaAG8QlI39RiQ63gV092VDJH9y4f6j/pgSsjUeaY50D eum0L+sUy9L5iRVs2ZlcmKAW3Q== X-Google-Smtp-Source: ABdhPJxTMdwa2MZSe++WFxZAr0AMWmh1SwYhIyORpQAqWJ6d7AxDjq2wT0U4toJSo2bznECtmOWQNg== X-Received: by 2002:a5d:4686:: with SMTP id u6mr35478049wrq.78.1625772443408; Thu, 08 Jul 2021 12:27:23 -0700 (PDT) From: =?UTF-8?q?Alex=20Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v2 33/39] contrib/plugins: add execlog to log instruction execution and memory access Date: Thu, 8 Jul 2021 20:09:35 +0100 Message-Id: <20210708190941.16980-34-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210708190941.16980-1-alex.bennee@linaro.org> References: <20210708190941.16980-1-alex.bennee@linaro.org> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::435; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x435.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, 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: fam@euphon.net, minyihh@uci.edu, berrange@redhat.com, kuhn.chenqun@huawei.com, f4bug@amsat.org, robhenry@microsoft.com, mahmoudabdalghany@outlook.com, aaron@os.amperecomputing.com, cota@braap.org, stefanha@redhat.com, crosa@redhat.com, pbonzini@redhat.com, ma.mandourr@gmail.com, Alexandre Iooss , =?UTF-8?q?Alex=20Benn=C3=A9e?= , aurelien@aurel32.net Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: "Qemu-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) X-ZM-MESSAGEID: 1625774815134100001 From: Alexandre Iooss Log instruction execution and memory access to a file. This plugin can be used for reverse engineering or for side-channel analysis using QEMU. Signed-off-by: Alexandre Iooss Reviewed-by: Alex Benn=C3=A9e Message-Id: <20210702081307.1653644-2-erdnaxe@crans.org> Signed-off-by: Alex Benn=C3=A9e --- contrib/plugins/execlog.c | 153 ++++++++++++++++++++++++++++++++++++++ MAINTAINERS | 1 + contrib/plugins/Makefile | 1 + 3 files changed, 155 insertions(+) create mode 100644 contrib/plugins/execlog.c diff --git a/contrib/plugins/execlog.c b/contrib/plugins/execlog.c new file mode 100644 index 0000000000..2de9f0d7d4 --- /dev/null +++ b/contrib/plugins/execlog.c @@ -0,0 +1,153 @@ +/* + * Copyright (C) 2021, Alexandre Iooss + * + * Log instruction execution with memory access. + * + * License: GNU GPL, version 2 or later. + * See the COPYING file in the top-level directory. + */ +#include +#include +#include +#include +#include +#include + +#include + +QEMU_PLUGIN_EXPORT int qemu_plugin_version =3D QEMU_PLUGIN_VERSION; + +/* Store last executed instruction on each vCPU as a GString */ +GArray *last_exec; + +/** + * Add memory read or write information to current instruction log + */ +static void vcpu_mem(unsigned int cpu_index, qemu_plugin_meminfo_t info, + uint64_t vaddr, void *udata) +{ + GString *s; + + /* Find vCPU in array */ + g_assert(cpu_index < last_exec->len); + s =3D g_array_index(last_exec, GString *, cpu_index); + + /* Indicate type of memory access */ + if (qemu_plugin_mem_is_store(info)) { + g_string_append(s, ", store"); + } else { + g_string_append(s, ", load"); + } + + /* If full system emulation log physical address and device name */ + struct qemu_plugin_hwaddr *hwaddr =3D qemu_plugin_get_hwaddr(info, vad= dr); + if (hwaddr) { + uint64_t addr =3D qemu_plugin_hwaddr_phys_addr(hwaddr); + const char *name =3D qemu_plugin_hwaddr_device_name(hwaddr); + g_string_append_printf(s, ", 0x%08"PRIx64", %s", addr, name); + } else { + g_string_append_printf(s, ", 0x%08"PRIx64, vaddr); + } +} + +/** + * Log instruction execution + */ +static void vcpu_insn_exec(unsigned int cpu_index, void *udata) +{ + GString *s; + + /* Find or create vCPU in array */ + while (cpu_index >=3D last_exec->len) { + s =3D g_string_new(NULL); + g_array_append_val(last_exec, s); + } + s =3D g_array_index(last_exec, GString *, cpu_index); + + /* Print previous instruction in cache */ + if (s->len) { + qemu_plugin_outs(s->str); + qemu_plugin_outs("s\n"); + } + + /* Store new instruction in cache */ + /* vcpu_mem will add memory access information to last_exec */ + g_string_printf(s, "%u, ", cpu_index); + g_string_append(s, (char *)udata); +} + +/** + * On translation block new translation + * + * QEMU convert code by translation block (TB). By hooking here we can the= n hook + * a callback on each instruction and memory access. + */ +static void vcpu_tb_trans(qemu_plugin_id_t id, struct qemu_plugin_tb *tb) +{ + struct qemu_plugin_insn *insn; + uint64_t insn_vaddr; + uint32_t insn_opcode; + char *insn_disas; + + size_t n =3D qemu_plugin_tb_n_insns(tb); + for (size_t i =3D 0; i < n; i++) { + /* + * `insn` is shared between translations in QEMU, copy needed data= here. + * `output` is never freed as it might be used multiple times duri= ng + * the emulation lifetime. + * We only consider the first 32 bits of the instruction, this may= be + * a limitation for CISC architectures. + */ + insn =3D qemu_plugin_tb_get_insn(tb, i); + insn_vaddr =3D qemu_plugin_insn_vaddr(insn); + insn_opcode =3D *((uint32_t *)qemu_plugin_insn_data(insn)); + insn_disas =3D qemu_plugin_insn_disas(insn); + char *output =3D g_strdup_printf("0x%"PRIx64", 0x%"PRIx32", \"%s\"= ", + insn_vaddr, insn_opcode, insn_disas= ); + + /* Register callback on memory read or write */ + qemu_plugin_register_vcpu_mem_cb(insn, vcpu_mem, + QEMU_PLUGIN_CB_NO_REGS, + QEMU_PLUGIN_MEM_RW, NULL); + + /* Register callback on instruction */ + qemu_plugin_register_vcpu_insn_exec_cb(insn, vcpu_insn_exec, + QEMU_PLUGIN_CB_NO_REGS, out= put); + } +} + +/** + * On plugin exit, print last instruction in cache + */ +static void plugin_exit(qemu_plugin_id_t id, void *p) +{ + guint i; + GString *s; + for (i =3D 0; i < last_exec->len; i++) { + s =3D g_array_index(last_exec, GString *, i); + if (s->str) { + qemu_plugin_outs(s->str); + qemu_plugin_outs("\n"); + } + } +} + +/** + * Install the plugin + */ +QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id, + const qemu_info_t *info, int ar= gc, + char **argv) +{ + /* + * Initialize dynamic array to cache vCPU instruction. In user mode + * we don't know the size before emulation. + */ + last_exec =3D g_array_new(FALSE, FALSE, sizeof(GString *)); + + /* Register translation block and exit callbacks */ + qemu_plugin_register_vcpu_tb_trans_cb(id, vcpu_tb_trans); + qemu_plugin_register_atexit_cb(id, plugin_exit, NULL); + + return 0; +} diff --git a/MAINTAINERS b/MAINTAINERS index 684142e12e..ee456e5fb4 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2981,6 +2981,7 @@ F: include/tcg/ =20 TCG Plugins M: Alex Benn=C3=A9e +R: Alexandre Iooss S: Maintained F: docs/devel/tcg-plugins.rst F: plugins/ diff --git a/contrib/plugins/Makefile b/contrib/plugins/Makefile index 3431bc1ce9..3c9209b6b0 100644 --- a/contrib/plugins/Makefile +++ b/contrib/plugins/Makefile @@ -13,6 +13,7 @@ include $(BUILD_DIR)/config-host.mak VPATH +=3D $(SRC_PATH)/contrib/plugins =20 NAMES :=3D +NAMES +=3D execlog NAMES +=3D hotblocks NAMES +=3D hotpages NAMES +=3D howvec --=20 2.20.1