From patchwork Fri Mar 12 17:28:17 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: 398696 Delivered-To: patch@linaro.org Received: by 2002:a02:8562:0:0:0:0:0 with SMTP id g89csp1430336jai; Fri, 12 Mar 2021 10:32:54 -0800 (PST) X-Google-Smtp-Source: ABdhPJwrDhaSIkV+5We3BAVHobaaLG7F6g9accK4wjj0gNS6Wpy97l2ZPPmz6+QILuSNjesGk4Vt X-Received: by 2002:a92:cb49:: with SMTP id f9mr3618705ilq.0.1615573974326; Fri, 12 Mar 2021 10:32:54 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615573974; cv=none; d=google.com; s=arc-20160816; b=x7Z995WX9lMNuU/fq4ivUTQWfRczt7XuQRz4l/KnlDTX2cI453nZ7if18Fjgerc50v jkQF/9sj143Qu5NvOsptLT1HElyvLyTb5qhVP+0DomjBc894HCQbEk0pI7V27BZSf5vi YOrQD6R57YbUJcJEmn6ueufHfEAl80SgTSccUdOZZ1Qlc7it+YgoqC2hDEdfraC696Ac b6bE59j2K/mQy6HLzzER/VfAeyer2utmMaeZeeFYrap7suL5/G5JqgSXz5kB/YvQ3FGv rF3VGgrE33MBFlWtccDpzneDpgjs1E+DL3SWnd+j38GPXtEuXYrNtfOXZvRri+CS0pF0 T1lA== 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=/pMpGpLT9W1qrJCRw98saFflQK12KM24W0ofyXVsY7Q=; b=v9ciY462E3vrWDzP82rLJ8kN9fgJ5Fd58LjyjFaQPL/o+eZZ/+LqWRHu+L8mrOYoLG 3R9Z9Yqf5rM6Zro15mTp6ce41VAJ7223Vu1ocHbEsSbXlx3xh6OOu5bHaIOgW48mxwLQ 1fHiHEWsIho2d9qoNSJOVTv2OQS8NtZekyuz8MWO3YVhOB+YHnG8F0ykVaQxf9CxhyYj /tRXZnLLcOjE8x2APZZz2vTq8vF+uuZY/+y+/dbXMjKRH6Ns3snsqcosLf+pwXbvh310 J95T4Q34HfsS5R3RqGgtqeTBYrZ4uvtsLnwhJlbNCRbowJrBn0kwPcTa8J4/ap04wIQX zZMA== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=OGkDWIiD; 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 z15si5330815iob.21.2021.03.12.10.32.54 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 12 Mar 2021 10:32:54 -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=OGkDWIiD; 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]:56024 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lKmaj-0000QS-Ph for patch@linaro.org; Fri, 12 Mar 2021 13:32:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]:59438) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lKlah-00049e-H7 for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:47 -0500 Received: from mail-ej1-x62b.google.com ([2a00:1450:4864:20::62b]:35419) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lKlaV-0002DA-D8 for qemu-devel@nongnu.org; Fri, 12 Mar 2021 12:28:47 -0500 Received: by mail-ej1-x62b.google.com with SMTP id dx17so54855240ejb.2 for ; Fri, 12 Mar 2021 09:28:34 -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=/pMpGpLT9W1qrJCRw98saFflQK12KM24W0ofyXVsY7Q=; b=OGkDWIiDe+j+SqQDaj4KVbLJ4PneKy9xx9z91VNkZLRkCkxoZUns2FP3ULhJ72sxWp 7oAejT8Q8PNStBlgmuNsj2OMJDPlPRoIk7LoLAnNeOuMOKW0rlQiFHfhBduxx4FcF7y3 HXx0V9r0I1KDTL6VSxmRakrK192NPTeRLViwscJDOm7bEnGYELANHZNCSTX4XG3lcxt5 BgzxMBUmuHEIl7EohqVqAR/vVU0hcfLaqj0uq5rsoUKV0iRYTDmBtxKl1zI+nFhS4dkF UFKT2cZcYf0iEC3KyrMU8i3HJKJuEkCmA7Ldhld5QAyAZZQ5GjCpZWai4SMkPKITq2lf Xp1g== 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=/pMpGpLT9W1qrJCRw98saFflQK12KM24W0ofyXVsY7Q=; b=Bif2NNU8PwXOqr443EYQxF0NHshiCoRwuyy7Hd7TdubzXZnLIixWiz20wOfywbOHFS zM1Ds0EHe3d7roKpOwAM3QBKUxXjzeW8G+w5j8pYRay3oUZloPUELayF7Xd2RzJUCSK0 bjraeTjltF5iAn1CRIUxNSRd3d71RgqxhlamNiKnFQNYIKGmZInFKQkAa46/u/C9nT5f 6pmqX3BZwavIIAxsBoKwGis+rW/9vqN6F0kQq2ArvTJv8dyXVfAUeUDJ1MbSERcmLtaW 1blWGe/0rlRmX+Ps/Vbe0uSKFyl//D5iFK0syhrcaYnWqQi9wGRXvk51qEa8JipdqraJ u+KA== X-Gm-Message-State: AOAM533A+j0t7yLpwFucBDEt82E9aPdB8OTnXO7CvM76N3qNueOOfphu cJSmuxjW5yy7HpIWTJB43vNw4A== X-Received: by 2002:a17:906:7102:: with SMTP id x2mr9842502ejj.355.1615570114031; Fri, 12 Mar 2021 09:28:34 -0800 (PST) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id fw3sm3055570ejb.82.2021.03.12.09.28.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 12 Mar 2021 09:28:28 -0800 (PST) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id A00E31FF99; Fri, 12 Mar 2021 17:28:22 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Subject: [PATCH v1 10/14] plugins: expand inline exec kernel-doc documentation. Date: Fri, 12 Mar 2021 17:28:17 +0000 Message-Id: <20210312172821.31647-11-alex.bennee@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210312172821.31647-1-alex.bennee@linaro.org> References: <20210312172821.31647-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::62b; envelope-from=alex.bennee@linaro.org; helo=mail-ej1-x62b.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: robhenry@microsoft.com, mahmoudabdalghany@outlook.com, aaron@os.amperecomputing.com, cota@braap.org, kuhn.chenqun@huawei.com, =?utf-8?q?Alex_Benn=C3=A9e?= Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" Remove the extraneous @cb parameter and document the non-atomic nature of the INLINE_ADD_U64 operation. Signed-off-by: Alex Bennée --- include/qemu/qemu-plugin.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) -- 2.20.1 Reviewed-by: Aaron Lindsay diff --git a/include/qemu/qemu-plugin.h b/include/qemu/qemu-plugin.h index 5ac6fe5f02..dc05fc1932 100644 --- a/include/qemu/qemu-plugin.h +++ b/include/qemu/qemu-plugin.h @@ -269,6 +269,14 @@ void qemu_plugin_register_vcpu_tb_exec_cb(struct qemu_plugin_tb *tb, enum qemu_plugin_cb_flags flags, void *userdata); +/** + * enum qemu_plugin_op - describes an inline op + * + * @QEMU_PLUGIN_INLINE_ADD_U64: add an immediate value uint64_t + * + * Note: currently only a single inline op is supported. + */ + enum qemu_plugin_op { QEMU_PLUGIN_INLINE_ADD_U64, }; @@ -283,6 +291,9 @@ enum qemu_plugin_op { * Insert an inline op to every time a translated unit executes. * Useful if you just want to increment a single counter somewhere in * memory. + * + * Note: ops are not atomic so in multi-threaded/multi-smp situations + * you will get inexact results. */ void qemu_plugin_register_vcpu_tb_exec_inline(struct qemu_plugin_tb *tb, enum qemu_plugin_op op, @@ -305,7 +316,6 @@ void qemu_plugin_register_vcpu_insn_exec_cb(struct qemu_plugin_insn *insn, /** * qemu_plugin_register_vcpu_insn_exec_inline() - insn execution inline op * @insn: the opaque qemu_plugin_insn handle for an instruction - * @cb: callback function * @op: the type of qemu_plugin_op (e.g. ADD_U64) * @ptr: the target memory location for the op * @imm: the op data (e.g. 1)