From patchwork Mon Jul 12 12:26:47 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 473094 Delivered-To: patch@linaro.org Received: by 2002:a02:c94a:0:0:0:0:0 with SMTP id u10csp2899908jao; Mon, 12 Jul 2021 05:38:15 -0700 (PDT) X-Google-Smtp-Source: ABdhPJwq/xhZnfL5WuIW1vh7o7KjWRUgpxwo+AEHmcLnXfLJ4m5z6eiRQ1Rrb6/UxOSY1KsWIVxn X-Received: by 2002:a17:907:214c:: with SMTP id rk12mr1168898ejb.70.1626093495553; Mon, 12 Jul 2021 05:38:15 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1626093495; cv=none; d=google.com; s=arc-20160816; b=H+G2yUd0cFDL2YkBOlhmFEVYz9Qu1HvXbKpfuOcyrHfBSZmKGMv6AoPNQCEx7Q56KK cNTt/0hWz7CMy2F0lEw6IBQndZnEsEkyuBJF40//KCiWsYryYesE2qilLfLLmixWPWts iuZ/mcCdkyBGwQ7T4jsGgCjBO7V27Q6HH9vzoIpKp+6mok2mr8oaRQoFdQQ8uqHPmp4O buzVEJeaLQBh+M+EoyPeKlVszBxLrcENxV0b817999k4PDPhxsAiYMRhd8927PIufOxg 1JXYHBl5yP//2+lGheNk/GPC1ovyk8VQufY+t1Zqzs4B8i6JoqqJSDqhxZdnPdNLipNl gP6Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :dkim-signature; bh=XvvAfutC3LYsNNeDs/S59h7kOZpMUoub8RYnuaoGrPM=; b=WAVzJhw5QzMrUxEq83clLFmUqxSC3tct0KfOgu+vKqqgS+Y3yUmslo3l4QL/uiTANS cOfMsPJOmVcizmhuSiWinTdrsh+cYM1YDYFbk1GYmRtj2HZ7yv1slrShWRBmwTuQRANl xnPwjqAv1nxAmnHJrv9EXTdeFn0Yrhl5RdsXL/L7NqY6sfLm1cNFWsOrQ4b0pCIG29IO 0lZmqXisOGewIZhubmIVKk+T2C7SLSynMb0h5yW0NL4Rc3vcsOd/J7RWdsBgozxDu4/K 5njrN5gLDr4EBiRurUIqdyVLyjldnUxJxqv/gdjbnwYPrLcyBLbGrBzIt3OdtzIs6F7p QUcQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=pnx0py5N; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id de54si17045310ejc.99.2021.07.12.05.38.15 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 12 Jul 2021 05:38:15 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=pnx0py5N; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:47230 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1m2vCQ-0006CV-EE for patch@linaro.org; Mon, 12 Jul 2021 08:38:14 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:41154) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1m2v7M-0004nY-JM for qemu-devel@nongnu.org; Mon, 12 Jul 2021 08:33:01 -0400 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]:44756) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1m2v7J-0002Jq-Ef for qemu-devel@nongnu.org; Mon, 12 Jul 2021 08:33:00 -0400 Received: by mail-wr1-x42f.google.com with SMTP id f9so19714763wrq.11 for ; Mon, 12 Jul 2021 05:32:57 -0700 (PDT) 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=XvvAfutC3LYsNNeDs/S59h7kOZpMUoub8RYnuaoGrPM=; b=pnx0py5NHOdmQhI4Z0I4c2zQzH6dWbSEVZr56/qF6qV4Es+NCrpcmY1+j304niRMkA Zr7nSy9Ge/QNbPxxJH0oipdtZzbsERwNVXjHj8dKmp0lWxKfSwjf/A/fOSDbnU8+kagf /DEC+lD5GUgdYY6rjABI1zY7CZJvWelo2SfEmmbOpXQbEz5A3rrFdBWO83hHfj6zA2i4 6Nhbr+h3Owycg1ckZrEMvSZBIs+Jm1dtC+SMnT+qbYn/X8GRqVuabuadlBj9rG77p+2B fOrmGvXimbeRNd460e+gXCiPZrrt2Gw8tQg4fl3fQtr8CyF4qvQiWMuIeYJadg93VReX lKdg== 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=XvvAfutC3LYsNNeDs/S59h7kOZpMUoub8RYnuaoGrPM=; b=Rgg2s/A9T7d22w4WLiGZs8Tm/GyubpFqPdmhZ7jLcOKQmDJ2OOSLQnpG0YrPPS9wYJ HFLvRRvVGNA4l9dP7Eh50IExw0DP9vVsmiTvYXQruSItptCYTf9l/94stydweGxpoemM 31exW1P2mASadiiZMzepQj7X9D+5fswLeOvHDP+hhC6NDvMwyP168sU+/BzXMEEVVcQ2 gKlKzyd1UApxY0iRDKw9mLOZn6xxNPW8OjJ+iLLgDoDXIdlXZCPIgJ6458dzDHtWUDMS mvUfNJVcjQpmDQiSWYSfimz9DUtiiAZAWKUyaE7c/8bQf7EmDrxTPZysNpyIV3FR70Qp cIEQ== X-Gm-Message-State: AOAM533i3Mju4+rTwuUB4EbblHhEOCIejfS0mIwraS8uyFK/klh/iGYe a0yOCPFihrMtXzBcRscDwe/EDQ== X-Received: by 2002:adf:de84:: with SMTP id w4mr27509972wrl.104.1626093176222; Mon, 12 Jul 2021 05:32:56 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id o17sm11255782wms.32.2021.07.12.05.32.49 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 12 Jul 2021 05:32:49 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 6B0571FFBC; Mon, 12 Jul 2021 13:26:57 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: peter.maydell@linaro.org Subject: [PULL 34/40] contrib/plugins: add execlog to log instruction execution and memory access Date: Mon, 12 Jul 2021 13:26:47 +0100 Message-Id: <20210712122653.11354-35-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210712122653.11354-1-alex.bennee@linaro.org> References: <20210712122653.11354-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42f; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42f.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: Alexandre Iooss , Mahmoud Mandour , =?utf-8?q?Alex_Benn=C3=A9e?= , qemu-devel@nongnu.org Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" 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 Signed-off-by: Alex Bennée Reviewed-by: Alex Bennée Message-Id: <20210702081307.1653644-2-erdnaxe@crans.org> Message-Id: <20210709143005.1554-35-alex.bennee@linaro.org> -- 2.20.1 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 = 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 = 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 = qemu_plugin_get_hwaddr(info, vaddr); + if (hwaddr) { + uint64_t addr = qemu_plugin_hwaddr_phys_addr(hwaddr); + const char *name = 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 >= last_exec->len) { + s = g_string_new(NULL); + g_array_append_val(last_exec, s); + } + s = 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 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) +{ + struct qemu_plugin_insn *insn; + uint64_t insn_vaddr; + uint32_t insn_opcode; + char *insn_disas; + + 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. + * `output` is never freed as it might be used multiple times during + * the emulation lifetime. + * We only consider the first 32 bits of the instruction, this may be + * a limitation for CISC architectures. + */ + insn = qemu_plugin_tb_get_insn(tb, i); + insn_vaddr = qemu_plugin_insn_vaddr(insn); + insn_opcode = *((uint32_t *)qemu_plugin_insn_data(insn)); + insn_disas = qemu_plugin_insn_disas(insn); + char *output = 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, output); + } +} + +/** + * 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 = 0; i < last_exec->len; i++) { + s = 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 argc, + char **argv) +{ + /* + * Initialize dynamic array to cache vCPU instruction. In user mode + * we don't know the size before emulation. + */ + last_exec = 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 40d095dbbd..97ad270762 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3018,6 +3018,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 3431bc1ce9..3c9209b6b0 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