From patchwork Fri Feb 7 15:01:14 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: 183203 Delivered-To: patch@linaro.org Received: by 2002:a92:1f12:0:0:0:0:0 with SMTP id i18csp852226ile; Fri, 7 Feb 2020 07:13:46 -0800 (PST) X-Google-Smtp-Source: APXvYqyMpcUXT9fCV78i+2wQ8hEYPmPlMRQD1WoyAiB3vHwintAx3rGmJh043xa5u92QUmBWmion X-Received: by 2002:a05:620a:557:: with SMTP id o23mr7937235qko.246.1581088425911; Fri, 07 Feb 2020 07:13:45 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1581088425; cv=none; d=google.com; s=arc-20160816; b=QMLNcE69BoLYHu452WUvcHmNNxys/RoGPwSpNVWqvu1NCOm6dVJComREzu9BPNWgxW Ew8rjVRb6Su/2sT9dZ/YLeWuCb8REo4wenqJVHp6v2935xzKsSkn88N/kb3gYGynP3IA HT6ZgByqTAT0ZPYxbzcfUKB5w54nfyDTrpjjF5pcwMgHy+YFj9EtHqk1/JDt2Lg7nA3X Ozy9+MkC3T89y4Bw8VpQBVQ2ESnBQwJAtJe4PDMjhrYMBOFyUvbYYmM4FOb9pvKITNSo uEJ8wY2a22YHY3VfT0WU8ZrVopz2IqIe1L0irr9ierWTwnVxqIgYf6Cs/HyLHKl+sEC4 rppg== 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=/ZswA9Otu9vtfPLtWP689YkHSf+JvE188+hies8lU5M=; b=lBCq+o28uUjaWKved1YEUV9R8D/dXEtmxfJ5KqyfowxjBeTXAMkT7gv+e1Nrux4a+9 4+RWQU+EUfwCf0rZHBPsT4KbcP+sV4CGm9fEnlvmGENNfb2r8XZeTnkSqb+lIUluI5pn k1sxw8p7Qgy4//5rfmcduZBrbiRwVtncUFNywvp2gva9dsiHIgLHLca/Dw/jCTXs7fQZ IYY25txFZAVBp6fHZWR0lk82VxDTjMFr2j0zjIF1j4TrjvLqac9vEeMNVJnrkcQcvH1+ 8oiXQnF6J9FOxgKwzxzpAG5cNvJBsF0MsmIyPBS2g10Ifgj2EdcuXVvBAHtA7xvZrlNg q/Ng== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=ncgrbPZh; 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 r23si1543831qtn.80.2020.02.07.07.13.45 for (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 07 Feb 2020 07:13:45 -0800 (PST) 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=ncgrbPZh; 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]:59156 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j05KD-0005s3-Dy for patch@linaro.org; Fri, 07 Feb 2020 10:13:45 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:60353) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j058L-0000zO-VN for qemu-devel@nongnu.org; Fri, 07 Feb 2020 10:01:31 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j058H-0003yA-0P for qemu-devel@nongnu.org; Fri, 07 Feb 2020 10:01:29 -0500 Received: from mail-wr1-x441.google.com ([2a00:1450:4864:20::441]:40209) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j058G-0003tK-Pp for qemu-devel@nongnu.org; Fri, 07 Feb 2020 10:01:24 -0500 Received: by mail-wr1-x441.google.com with SMTP id t3so3050146wru.7 for ; Fri, 07 Feb 2020 07:01:24 -0800 (PST) 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=/ZswA9Otu9vtfPLtWP689YkHSf+JvE188+hies8lU5M=; b=ncgrbPZhSiBQ/R5Vkz0ucSHt+Y6ZL1DKItYxxKSCAY1OrG7J9mSyFjzO6CLX/7hagI f+9tyPzRLU0pHlBuFLMlRa0E7/tD9RyRQZ8WK2+EZiU/GPJ70jbBJSJz3ZD79TcwvVgI I5LNMRXIOi9C44YyNDnZhrxo7ZaBDZtKR47dXRBJzNVDQcY7u5aCWiD1ft5maLVRwL/3 dI8UHnl7YimIhYMjvrEi7Foeli7NCsdjRAclY+UlKzlAMYStTwFbz5dwCm2RIuEx3/h6 NnHXifni6JuBfLhb/is3SBSc54N7R1Ib1tEx4R+9PluCt8Zp2NHXf6NzORnz35UlsO/U A7hA== 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=/ZswA9Otu9vtfPLtWP689YkHSf+JvE188+hies8lU5M=; b=DHYSXQVZ/mHzrhTza4LHhQN55fS5CDGwUhhYDAokBwMHx62pi5Uou9tOvkM2SYcrBi 2nx2hY4YazGdSe5PlGD2MJEPbZgf5eFwP7/M0YDy9CYaKUSJmchukrhb1AJW0CkgQN49 yzVdPpgIeAV9eKh7+4xlOVjIHUSW6rJt+iBJtFO9xcMWzpFa7NAMih0tXu7iTuoYHc6D JG75EvtjqRCSaA+5gkB/0AGTfkgWhM8JHKcQEsP7mnrSn4A2JK9zCD2fCOnHq0EwKrhW 0h982SwgeCHwFIn8eX/cbC1EL1DTAbJYP0h1Lqo4hXas81Iqa8z3j+CROEnIKWO/4vJH EepQ== X-Gm-Message-State: APjAAAUebOudGfMLhBKVJUJskuT7CJaultjAW/mjHP36V9lEKWbUEi77 Ru2Al020KkwU3h4L7Oy6zl3dTQ== X-Received: by 2002:a5d:40d1:: with SMTP id b17mr4958979wrq.93.1581087682781; Fri, 07 Feb 2020 07:01:22 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id r14sm3595073wrj.26.2020.02.07.07.01.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 07 Feb 2020 07:01:19 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 033271FF8C; Fri, 7 Feb 2020 15:01:19 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 1/5] docs/devel: document query handle lifetimes Date: Fri, 7 Feb 2020 15:01:14 +0000 Message-Id: <20200207150118.23007-2-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200207150118.23007-1-alex.bennee@linaro.org> References: <20200207150118.23007-1-alex.bennee@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::441 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: robert.foley@linaro.org, robhenry@microsoft.com, aaron@os.amperecomputing.com, cota@braap.org, kuhn.chenqun@huawei.com, peter.puhov@linaro.org, =?utf-8?q?Alex_Benn=C3=A9e?= Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" I forgot to document the lifetime of handles in the developer documentation. Do so now. Signed-off-by: Alex Bennée --- docs/devel/tcg-plugins.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) -- 2.20.1 Reviewed-by: Robert Foley Reviewed-by: Richard Henderson diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 718eef00f22..a05990906cc 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -51,8 +51,17 @@ about how QEMU's translation works to the plugins. While there are conceptions such as translation time and translation blocks the details are opaque to plugins. The plugin is able to query select details of instructions and system configuration only through the -exported *qemu_plugin* functions. The types used to describe -instructions and events are opaque to the plugins themselves. +exported *qemu_plugin* functions. + +Query Handle Lifetime +--------------------- + +Each callback provides an opaque anonymous information handle which +can usually be further queried to find out information about a +translation, instruction or operation. The handles themselves are only +valid during the lifetime of the callback so it is important that any +information that is needed is extracted during the callback and saved +by the plugin. Usage =====