From patchwork Mon Jun 14 09:01:16 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Alexandre IOOSS X-Patchwork-Id: 12318427 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 0F0A4C48BE8 for ; Mon, 14 Jun 2021 09:13:29 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 972F76128B for ; Mon, 14 Jun 2021 09:13:28 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 972F76128B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=crans.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Received: from localhost ([::1]:49252 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lsiet-0008RA-Mb for qemu-devel@archiver.kernel.org; Mon, 14 Jun 2021 05:13:27 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50134) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lsiUg-0005IC-D5 for qemu-devel@nongnu.org; Mon, 14 Jun 2021 05:02:54 -0400 Received: from zamok.crans.org ([2a0c:700:2:0:ec4:7aff:fe59:a1ad]:57066) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lsiUa-0003vz-GA for qemu-devel@nongnu.org; Mon, 14 Jun 2021 05:02:53 -0400 Received: by zamok.crans.org (Postfix, from userid 11692) id 820FEE0080; Mon, 14 Jun 2021 11:02:36 +0200 (CEST) From: Alexandre Iooss To: qemu-devel@nongnu.org (open list:All patches CC here) Subject: [PATCH] contrib/plugins: add execlog to log instruction execution and memory access Date: Mon, 14 Jun 2021 11:01:16 +0200 Message-Id: <20210614090116.816833-1-erdnaxe@crans.org> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Received-SPF: pass client-ip=2a0c:700:2:0:ec4:7aff:fe59:a1ad; envelope-from=erdnaxe@crans.org; helo=zamok.crans.org 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, 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: Alexandre Iooss , =?utf-8?q?Alex_Benn=C3=A9e?= Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" 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 --- MAINTAINERS | 1 + contrib/plugins/Makefile | 1 + contrib/plugins/execlog.c | 112 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 114 insertions(+) create mode 100644 contrib/plugins/execlog.c diff --git a/MAINTAINERS b/MAINTAINERS index 7d9cd29042..65942d5802 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -2974,6 +2974,7 @@ F: include/tcg/ TCG Plugins M: Alex Bennée +R: Alexandre Iooss S: Maintained F: docs/devel/tcg-plugins.rst F: plugins/ diff --git a/contrib/plugins/Makefile b/contrib/plugins/Makefile index b9d7935e5e..51093acd17 100644 --- a/contrib/plugins/Makefile +++ b/contrib/plugins/Makefile @@ -13,6 +13,7 @@ include $(BUILD_DIR)/config-host.mak VPATH += $(SRC_PATH)/contrib/plugins NAMES := +NAMES += execlog NAMES += hotblocks NAMES += hotpages NAMES += howvec diff --git a/contrib/plugins/execlog.c b/contrib/plugins/execlog.c new file mode 100644 index 0000000000..80716e8eed --- /dev/null +++ b/contrib/plugins/execlog.c @@ -0,0 +1,112 @@ +/* + * Copyright (C) 2021, Alexandre Iooss + * + * Log instruction execution and memory access to a file. + * You may pass the output filename as argument. + * + * 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 = QEMU_PLUGIN_VERSION; + +/* Execution trace buffer */ +FILE *output; + +/** + * Log memory read or write + */ +static void vcpu_mem(unsigned int vcpu_index, qemu_plugin_meminfo_t info, + uint64_t vaddr, void *udata) +{ + struct qemu_plugin_hwaddr *hwaddr = qemu_plugin_get_hwaddr(info, vaddr); + if (!hwaddr) { + return; + } + + /* Add data to execution log */ + const char *name = qemu_plugin_hwaddr_device_name(hwaddr); + uint64_t addr = qemu_plugin_hwaddr_phys_addr(hwaddr); + if (qemu_plugin_mem_is_store(info)) { + fprintf(output, "mem: %s store at 0x%08lx\n", name, addr); + } else { + fprintf(output, "mem: %s load at 0x%08lx\n", name, addr); + } +} + +/** + * Log instruction execution + */ +static void vcpu_insn_exec(unsigned int cpu_index, void *udata) +{ + char *insn_disas = (char *)udata; + + /* Add data to execution log */ + fprintf(output, "insn: %s\n", insn_disas); +} + +/** + * On translation block new translation + * + * QEMU convert code by translation block (TB). By hooking here we can then hook + * a callback on each instruction and memory access. + */ +static void vcpu_tb_trans(qemu_plugin_id_t id, struct qemu_plugin_tb *tb) +{ + size_t n = qemu_plugin_tb_n_insns(tb); + for (size_t i = 0; i < n; i++) { + /* insn is shared between translations in QEMU, copy needed data here */ + struct qemu_plugin_insn *insn = qemu_plugin_tb_get_insn(tb, i); + char *insn_disas = qemu_plugin_insn_disas(insn); + + /* 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_R_REGS, insn_disas); + } +} + +/** + * On plugin exit, close output file + */ +static void plugin_exit(qemu_plugin_id_t id, void *p) +{ + fclose(output); +} + +/** + * Install the plugin + */ +QEMU_PLUGIN_EXPORT int qemu_plugin_install(qemu_plugin_id_t id, + const qemu_info_t *info, int argc, + char **argv) +{ + /* Parse arguments to get output name and open for writing */ + char *filename = "execution.log"; + if (argc > 0) { + filename = argv[0]; + } + output = fopen(filename, "w"); + if (output == NULL) { + qemu_plugin_outs("Cannot open output file for writing.\n"); + return -1; + } + + /* 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; +}