From patchwork Thu Jul 9 14:13:16 2020 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: 235148 Delivered-To: patch@linaro.org Received: by 2002:a92:d244:0:0:0:0:0 with SMTP id v4csp1452507ilg; Thu, 9 Jul 2020 07:14:26 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxYPOYjMvlsifzuUWHTn35vE2+cQ9jdGYKatF16dJAb622om3AuhqtuLL2XzjDnSLmtq117 X-Received: by 2002:ac8:178b:: with SMTP id o11mr30393571qtj.320.1594304065717; Thu, 09 Jul 2020 07:14:25 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1594304065; cv=none; d=google.com; s=arc-20160816; b=Pj6gf/0gyHSaMG/DRxWS1d7H1XM4+jXu2+/rMxtmmU0xV29olTCmagyYHxDzWtEEvs o7JycrXckLPG5MopUhzu/oRzKcmj3au8JF946bullxIgggIqu23W7Fuf3/5SCI6ldPIP RSD8EloOjuGP8rWURN4+0jq6QBJfBZSPxMzQDCByDmMcnpCJh0j14ek53G9M2YpRl9W5 gZ1dsod1aLggwL2BixYlBp2Q0aQOOiG1lzx+rSPxS25iy4EYcNBYg0T5KYOJQosH+Mot oIGhdQ7Cj/e98gvynZhdnIbjbsxurmIxSn1TvHbBtBrwwUfv7y/QQd4yk81euLtOfSv8 +T4w== 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=Nm8CLC7O4HQxtuuQtcA9m1t+foBk/FQkRZdS8Q7AlJQ=; b=OFS3dWCwo7qPvKm5Wk6iTu0/2IIkdRn2uZFDKNcEgmwz3erqHx8V9ruyhg82K0yjq/ E5XfroCyHb+Icl1oK9kYYj1pgm4cMQjPmfvlYHIhyVrGZ3UdIQ7eQgQ5lr7lRoE38iJW XnG7fxAlHkeCQJRDlkuYpuYZRfTi3dEo6qCYsVn0SdtG+hYfDF2Wt3j28I83jPs8mg0w wLP+k8slruNEIiAI/VM0Lm9h6P+Q2HfBnCQrTyW46hZHsQGTzvXeuhZ7V9121G0xn5LZ YEiJ8NA5ZvvdsVo3Arktw7VLWt9yfyYUO8DC3OTEjKYwjeqwUV+Oqh0/KILv8s7VJi6L +w/Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=XCyk0Ovi; 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 95si1725897qta.340.2020.07.09.07.14.25 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 09 Jul 2020 07:14:25 -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=XCyk0Ovi; 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]:36730 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jtXJh-0000Cn-2F for patch@linaro.org; Thu, 09 Jul 2020 10:14:25 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50808) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jtXIt-0000BX-2g for qemu-devel@nongnu.org; Thu, 09 Jul 2020 10:13:35 -0400 Received: from mail-wr1-x443.google.com ([2a00:1450:4864:20::443]:36838) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1jtXIq-0001K2-LJ for qemu-devel@nongnu.org; Thu, 09 Jul 2020 10:13:34 -0400 Received: by mail-wr1-x443.google.com with SMTP id k6so2561898wrn.3 for ; Thu, 09 Jul 2020 07:13:32 -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=Nm8CLC7O4HQxtuuQtcA9m1t+foBk/FQkRZdS8Q7AlJQ=; b=XCyk0Ovif5U0sSesiyXMl1+eA0ZbZS39glLQJjh267Iuri8ehd7gVhH8+ExUvE05TL 32Q8SA6KIQmDfpeWIJABWGRe9IJCDOyI2a7VkGYApWSqgb6y/1VBwgSAiHb94VFxmS0i +XHyKrM7j8m4PhWmpalHtSH6BdDMIbJwdFQ+d6RdRZja74DxZICkA0e2N6Moeevmwo7p hYRLXu0qkOXv9H4RNXi8fGn+Nin4KBBC0+UBfS832n1w/I6iVOqZnSAEzagoban++liB 2e400zC3XK7Rx9UUs3guwxLCnqquZ5hp1NSb80TgKU/rVC6OjXnlmAu2CC0i1U1oL8PW FtTw== 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=Nm8CLC7O4HQxtuuQtcA9m1t+foBk/FQkRZdS8Q7AlJQ=; b=dYJ6m+UxpzXPrliQFhHZ/mg4KwLs9zEtCCBOraOmN56zqxxIa6NWvW/vY7CIJeHjEp rxhe2juQzqpmCnkSOjmK/aJMFf/yFjL+LpRwZKCsPydreVSDw2tRFz1+lt/fsKBuApW3 UGOgdHWT1luV6QoT+xRD/Zv2M1Ik86EPN+Q+0DLWs9i95syRynZHCkxDK2jPn8wCaANb pCOWqd8AtXxrMa/Al2WRb8ZtL8+YenueXTMx0910v3L0mxo0POGd42WTMx9/MG4Xa1FO jS1bdB6ssvpH5AKX3MmqRzHBrHPwRtibUAi7nXlP+BbdSHQHjPO3k9TDeXjQmZD/Xe+T qZTg== X-Gm-Message-State: AOAM5303hwJzrF2wUu7rS5QRbEhoTrKQbmGNniNEQ2hNDVoG8mhjdapy ecsxAelI+U5L/XUod7d0Fj+RQA== X-Received: by 2002:adf:dd81:: with SMTP id x1mr63116515wrl.7.1594304010865; Thu, 09 Jul 2020 07:13:30 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id f12sm5629079wrw.53.2020.07.09.07.13.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 09 Jul 2020 07:13:28 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 8E10B1FF8C; Thu, 9 Jul 2020 15:13:27 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 02/13] docs/devel: add some notes on tcg-icount for developers Date: Thu, 9 Jul 2020 15:13:16 +0100 Message-Id: <20200709141327.14631-3-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200709141327.14631-1-alex.bennee@linaro.org> References: <20200709141327.14631-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::443; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x443.google.com X-detected-operating-system: by eggs.gnu.org: No matching host in p0f cache. That's all we know. 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, Peter Maydell , berrange@redhat.com, robert.foley@linaro.org, Paolo Bonzini , =?utf-8?q?Alex_Benn=C3=A9e?= , richard.henderson@linaro.org, f4bug@amsat.org, robhenry@microsoft.com, aaron@os.amperecomputing.com, cota@braap.org, Pavel Dovgalyuk , kuhn.chenqun@huawei.com, peter.puhov@linaro.org, aurelien@aurel32.net Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" This attempts to bring together my understanding of the requirements for icount behaviour into one reference document for our developer notes. Signed-off-by: Alex Bennée Reviewed-by: Richard Henderson Cc: Paolo Bonzini Cc: Pavel Dovgalyuk Cc: Peter Maydell Message-Id: <20200619135844.23307-1-alex.bennee@linaro.org> --- v2 - fix copyright date - it's -> its - drop mentioned of gen_io_end() - remove and correct original conjecture v3 - include link in index v4 - Grammar fixes from Peter - re-worded final section --- docs/devel/index.rst | 1 + docs/devel/tcg-icount.rst | 97 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 docs/devel/tcg-icount.rst -- 2.20.1 Reviewed-by: Emilio G. Cota diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 4ecaea3643fb..ae6eac7c9c66 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -23,6 +23,7 @@ Contents: decodetree secure-coding-practices tcg + tcg-icount multi-thread-tcg tcg-plugins bitops diff --git a/docs/devel/tcg-icount.rst b/docs/devel/tcg-icount.rst new file mode 100644 index 000000000000..8d67b6c076a7 --- /dev/null +++ b/docs/devel/tcg-icount.rst @@ -0,0 +1,97 @@ +.. + Copyright (c) 2020, Linaro Limited + Written by Alex Bennée + + +======================== +TCG Instruction Counting +======================== + +TCG has long supported a feature known as icount which allows for +instruction counting during execution. This should not be confused +with cycle accurate emulation - QEMU does not attempt to emulate how +long an instruction would take on real hardware. That is a job for +other more detailed (and slower) tools that simulate the rest of a +micro-architecture. + +This feature is only available for system emulation and is +incompatible with multi-threaded TCG. It can be used to better align +execution time with wall-clock time so a "slow" device doesn't run too +fast on modern hardware. It can also provides for a degree of +deterministic execution and is an essential part of the record/replay +support in QEMU. + +Core Concepts +============= + +At its heart icount is simply a count of executed instructions which +is stored in the TimersState of QEMU's timer sub-system. The number of +executed instructions can then be used to calculate QEMU_CLOCK_VIRTUAL +which represents the amount of elapsed time in the system since +execution started. Depending on the icount mode this may either be a +fixed number of ns per instruction or adjusted as execution continues +to keep wall clock time and virtual time in sync. + +To be able to calculate the number of executed instructions the +translator starts by allocating a budget of instructions to be +executed. The budget of instructions is limited by how long it will be +until the next timer will expire. We store this budget as part of a +vCPU icount_decr field which shared with the machinery for handling +cpu_exit(). The whole field is checked at the start of every +translated block and will cause a return to the outer loop to deal +with whatever caused the exit. + +In the case of icount, before the flag is checked we subtract the +number of instructions the translation block would execute. If this +would cause the instruction budget to go negative we exit the main +loop and regenerate a new translation block with exactly the right +number of instructions to take the budget to 0 meaning whatever timer +was due to expire will expire exactly when we exit the main run loop. + +Dealing with MMIO +----------------- + +While we can adjust the instruction budget for known events like timer +expiry we cannot do the same for MMIO. Every load/store we execute +might potentially trigger an I/O event, at which point we will need an +up to date and accurate reading of the icount number. + +To deal with this case, when an I/O access is made we: + + - restore un-executed instructions to the icount budget + - re-compile a single [1]_ instruction block for the current PC + - exit the cpu loop and execute the re-compiled block + +The new block is created with the CF_LAST_IO compile flag which +ensures the final instruction translation starts with a call to +gen_io_start() so we don't enter a perpetual loop constantly +recompiling a single instruction block. For translators using the +common translator_loop this is done automatically. + +.. [1] sometimes two instructions if dealing with delay slots + +Other I/O operations +-------------------- + +MMIO isn't the only type of operation for which we might need a +correct and accurate clock. IO port instructions and accesses to +system registers are the common examples here. These instructions have +to be handled by the individual translators which have the knowledge +of which operations are I/O operations. + +When the translator is handling an instruction of this kind: + +* it must call gen_io_start() if icount is enabled, at some + point before the generation of the code which actually does + the I/O, using a code fragment similar to: + +.. code:: c + + if (tb_cflags(s->base.tb) & CF_USE_ICOUNT) { + gen_io_start(); + } + +* it must end the TB immediately after this instruction + +Note that some older front-ends call a "gen_io_end()" function: +this is obsolete and should not be used.