From mboxrd@z Thu Jan 1 00:00:00 1970 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=-22.7 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable 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 51884C4338F for ; Fri, 6 Aug 2021 22:53:52 +0000 (UTC) Received: from bombadil.infradead.org (bombadil.infradead.org [198.137.202.133]) (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 0065F60EE9 for ; Fri, 6 Aug 2021 22:53:51 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0065F60EE9 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=bombadil.20210309; h=Sender: Content-Transfer-Encoding:Content-Type:List-Subscribe:List-Help:List-Post: List-Archive:List-Unsubscribe:List-Id:MIME-Version:References:In-Reply-To: Message-Id:Date:Subject:Cc:To:From:Reply-To:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: List-Owner; bh=Buv2R2x5mBy/XUZZauxunl48oZOTr31HF0vHDq+QBDk=; b=rIjZbBj37PXuuB hM9nshSBtEitRdAQuX7XZ1nkjimjS36lspgNNZjRF8QUQSsPxJTdJ83AfNv7i3JVbvu7tpc7coZuE 60EFGfjS9+bkuhmZKMHiy/f8NfRywJJORIhD1mUGnMyQm1NNw/J/te30MnCfId+7rMMc3hjApMFRO yWiSYLYSZF/0dUeffqvdNmMonZIK8uNPiA/aUm0YoznpYHWLxphv2AScbK+rpYeuPR5uCxifa5uQi L8YCaSFq0LGg9NdStzcCmeJzxLZr/kTZcywfrSPP+yh3QPqOg0LYQWcmjvmQkG2Mmi2Lts+RGlMDZ PYixaJq2XffrEqzrrS4Q==; Received: from localhost ([::1] helo=bombadil.infradead.org) by bombadil.infradead.org with esmtp (Exim 4.94.2 #2 (Red Hat Linux)) id 1mC8hB-00DlkI-GF; Fri, 06 Aug 2021 22:52:05 +0000 Received: from mail-io1-f53.google.com ([209.85.166.53]) by bombadil.infradead.org with esmtps (Exim 4.94.2 #2 (Red Hat Linux)) id 1mC8gg-00Dlea-OR for linux-arm-kernel@lists.infradead.org; Fri, 06 Aug 2021 22:51:38 +0000 Received: by mail-io1-f53.google.com with SMTP id h1so14471559iol.9 for ; Fri, 06 Aug 2021 15:51:33 -0700 (PDT) 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=9Hgxz19RdIXBXlB6JUJjJ2L0EQ+QiZ5LkbfFS3m/GYk=; b=Ny3w4K675yl985y5omhiaEMJ9kkq1dx91bdnftyjrfyTHYKqz7gn9/p/c3gAengS9h w/PpkurZJclD5tAutjAOHGryrC94FxyeeCG/WLTd2AA7Q/HES5ByRmkj/CWPM+jHwrDY qTDsjDp0z525Gnn3clJh/MVAmOwFC0f2EZ0cdCO0fhy/FDvNK5zpGM728PpNkgt9o19c VxanydWFh7E6FueNhvlLHxOYcKIoopLkrF0Hy5UMa2o7AFEfByXKHvc1nA2kXXlkSrLy WvrMP5rZIfPaq0dWkyE6MeBb5+jRCi+uFZ7bgm6Pr9k9Wk8IURA/xC74Tn+b2NKb+my2 vpKg== X-Gm-Message-State: AOAM531gdejjSjBuWzmOZ+3zMJb4IEt5uEvSy9NU+TEtHy6j3ya1arVw +DsQfi85HP6YknXx+ybDlQ== X-Google-Smtp-Source: ABdhPJybqm/xp7N1NbKP6o213fl3HnTmjQCNX5M7YLK2eyLxm2rPTJks5eQ7ZIRUluTW84b4OKwFVg== X-Received: by 2002:a6b:b502:: with SMTP id e2mr734725iof.152.1628290293125; Fri, 06 Aug 2021 15:51:33 -0700 (PDT) Received: from xps15.herring.priv ([64.188.179.248]) by smtp.googlemail.com with ESMTPSA id x11sm5670338ilu.3.2021.08.06.15.51.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 06 Aug 2021 15:51:32 -0700 (PDT) From: Rob Herring To: Will Deacon , Mark Rutland , Catalin Marinas , Peter Zijlstra , Ingo Molnar Cc: linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org, Arnaldo Carvalho de Melo , Jiri Olsa , Kan Liang , Ian Rogers , Alexander Shishkin , honnappa.nagarahalli@arm.com, Zachary.Leaf@arm.com, Raphael Gault , Jonathan Cameron , Namhyung Kim , Itaru Kitayama , linux-perf-users@vger.kernel.org Subject: [PATCH v9 3/3] Documentation: arm64: Document PMU counters access from userspace Date: Fri, 6 Aug 2021 16:51:23 -0600 Message-Id: <20210806225123.1958497-4-robh@kernel.org> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210806225123.1958497-1-robh@kernel.org> References: <20210806225123.1958497-1-robh@kernel.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210806_155134_861236_2A06B8FF X-CRM114-Status: GOOD ( 23.82 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org From: Raphael Gault Add documentation to describe the access to the pmu hardware counters from userspace. Signed-off-by: Raphael Gault Signed-off-by: Rob Herring --- v9: - No change v8: - Reword that config1:1 must always be set to request user access v7: - Merge into existing arm64 perf.rst v6: - Update the chained event section with attr.config1 details v2: - Update links to test examples Changes from Raphael's v4: - Convert to rSt - Update chained event status - Add section for heterogeneous systems --- Documentation/arm64/perf.rst | 68 +++++++++++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/Documentation/arm64/perf.rst b/Documentation/arm64/perf.rst index b567f177d385..fa8706df2281 100644 --- a/Documentation/arm64/perf.rst +++ b/Documentation/arm64/perf.rst @@ -2,7 +2,10 @@ .. _perf_index: -===================== +==== +Perf +==== + Perf Event Attributes ===================== @@ -88,3 +91,66 @@ exclude_host. However when using !exclude_hv there is a small blackout window at the guest entry/exit where host events are not captured. On VHE systems there are no blackout windows. + +Perf Userspace PMU Hardware Counter Access +========================================== + +Overview +-------- +The perf userspace tool relies on the PMU to monitor events. It offers an +abstraction layer over the hardware counters since the underlying +implementation is cpu-dependent. +Arm64 allows userspace tools to have access to the registers storing the +hardware counters' values directly. + +This targets specifically self-monitoring tasks in order to reduce the overhead +by directly accessing the registers without having to go through the kernel. + +How-to +------ +The focus is set on the armv8 PMUv3 which makes sure that the access to the pmu +registers is enabled and that the userspace has access to the relevant +information in order to use them. + +In order to have access to the hardware counter it is necessary to open the +event using the perf tool interface with config1:1 attr bit set: the +sys_perf_event_open syscall returns a fd which can subsequently be used +with the mmap syscall in order to retrieve a page of memory containing +information about the event. The PMU driver uses this page to expose to +the user the hardware counter's index and other necessary data. Using +this index enables the user to access the PMU registers using the `mrs` +instruction. + +The userspace access is supported in libperf using the perf_evsel__mmap() +and perf_evsel__read() functions. See `tools/lib/perf/tests/test-evsel.c`_ for +an example. + +About heterogeneous systems +--------------------------- +On heterogeneous systems such as big.LITTLE, userspace PMU counter access can +only be enabled when the tasks are pinned to a homogeneous subset of cores and +the corresponding PMU instance is opened by specifying the 'type' attribute. +The use of generic event types is not supported in this case. + +Have a look at `tools/perf/arch/arm64/tests/user-events.c`_ for an example. It +can be run using the perf tool to check that the access to the registers works +correctly from userspace: + +.. code-block:: sh + + perf test -v user + +About chained events and 64-bit counters +---------------------------------------- +Chained events are not supported in conjunction with userspace counter +access. If a 64-bit counter is requested (attr.config1:0) with userspace +access (attr.config1:1 set), then counter chaining will be disabled. The +'pmc_width' in the user page will indicate the actual width of the +counter which could be only 32-bits depending on the event and PMU +features. + +.. Links +.. _tools/perf/arch/arm64/tests/user-events.c: + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/perf/arch/arm64/tests/user-events.c +.. _tools/lib/perf/tests/test-evsel.c: + https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/tools/lib/perf/tests/test-evsel.c -- 2.30.2 _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel