From patchwork Tue Apr 20 03:15:11 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rob Herring X-Patchwork-Id: 12213249 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.0 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,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 0B11AC433ED for ; Tue, 20 Apr 2021 03:19:01 +0000 (UTC) Received: from desiato.infradead.org (desiato.infradead.org [90.155.92.199]) (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 700D961220 for ; Tue, 20 Apr 2021 03:19:00 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 700D961220 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=desiato.20200630; 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=MDTGQQMVJqZqIvZgD06KkcG9zPZoOognkRw2qhowD/s=; b=PPaN6MRbJrf+Rw17UV/rUf3L8 PKr3ShVSUFybpUzQ05CG0BZ9je6t7x1CFh43bR+U854x8U6bc6JB61ITkOcYs7hYsL4gcW23ZLHKD 4BtVo3e1bxszri5tSZaOCwDNNXttUpU61CNFEYiUq0KerxDFaqceK4r1xcUXQHzAlBNPrcOEFmAZM 09ouvf5NHRUpTPhH/pLi9zeBmtedgegXsV2X8TR/HXn/+rioyYkb0i5unblMfON8/6beHrxxq8BKH +8r3f8shQ736+RNYqEM3EaipwFGF6wi5k+YZZgRK0CeAikEj7znzDae+tfyxOd16KdmUtEZsZZKyb 8nH+pRdcA==; Received: from localhost ([::1] helo=desiato.infradead.org) by desiato.infradead.org with esmtp (Exim 4.94 #2 (Red Hat Linux)) id 1lYgt1-00B3gb-Su; Tue, 20 Apr 2021 03:17:16 +0000 Received: from bombadil.infradead.org ([2607:7c80:54:e::133]) by desiato.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1lYgrR-00B38a-3e for linux-arm-kernel@desiato.infradead.org; Tue, 20 Apr 2021 03:15:37 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: MIME-Version:References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From:Sender :Reply-To:Content-Type:Content-ID:Content-Description; bh=LNdvbsEMRO0fI8eAuDBOQGRWp+U15lnQujv4W2LToH4=; b=zk2sj7CPhL4p58wSVLBiAkSbyN Qoq45T+3pwZv04NENpdaXNOAprmWIirMQqGJFzeuNaEs9X6bHjFIsgr/d94amgqKMmHMXyaT742Vc dC4FpZs0I/4j1f2NXBdjeqq6rJ31/xaliFux4S0xtS1h35rUoA5jNh1yJC9XxGG3z/yjlRJxzVl+z xA5/gGnN1j/Z8jI0azlanbhrddW9VyYVswyCNaD7dg4kH4oo1xpHhTKwjpjwn1YVx+Ks7dhkV7dkC V8SSd637JreQ1QHGn51MP86jFxneyktJWSi53CJvDttDKv6DWn8iyX9tGKu1tnNCq8GIpGckTMIsQ SvIRZWlQ==; Received: from mail-oo1-f47.google.com ([209.85.161.47]) by bombadil.infradead.org with esmtps (Exim 4.94 #2 (Red Hat Linux)) id 1lYgrK-00BmmA-RH for linux-arm-kernel@lists.infradead.org; Tue, 20 Apr 2021 03:15:35 +0000 Received: by mail-oo1-f47.google.com with SMTP id i25-20020a4aa1190000b02901bbd9429832so8208040ool.0 for ; Mon, 19 Apr 2021 20:15:30 -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=LNdvbsEMRO0fI8eAuDBOQGRWp+U15lnQujv4W2LToH4=; b=myPDH5vm6CcjITJbc25D7sOn2BI6uVoeBuU5lRsHJjSprvLP0ji2M5x5lLJsrMPsob ugVb/1/hSLyiw/FBmEj1ma8pyPUNNIrLlUdDpFa5uUoa1shl7Xkwd+nB/1eqFsPSbL92 0IU1/8XZv318e+6DDeYQsBOTIwo+//OCKUbkPXzHntUCM1ShRQ0SWjhdSM/1yNmDjpa5 LAIWx74kIcIQG0e2oBayaNUJoL3npr91yZv1oG0Yd5MBQDf6JCCBoOwv3BDy/KRuUKVJ 3fiPzkr4lyu7uoYkqHqfS/riZI+KzvPc2ag+U3CLRxEgZ0Eewn3Y2rJaTg9YRELgEUWn ZCsw== X-Gm-Message-State: AOAM530tEglHrYQP9JUHoKvsxHh9rxRMI6+iSe1aA/KtK1YV6EvB36Nv FPjHUSi+PjPskp54KoT1VQ== X-Google-Smtp-Source: ABdhPJwmQaQsMHpbrHoIEEqn7KRtQOxiXHAhGFQEMqx5RE7tJm6hTVC4Ogf9URq2UFwBsXqiodgnVw== X-Received: by 2002:a4a:d80e:: with SMTP id f14mr12625074oov.54.1618888529160; Mon, 19 Apr 2021 20:15:29 -0700 (PDT) Received: from xps15.herring.priv (24-155-109-49.dyn.grandenetworks.net. [24.155.109.49]) by smtp.googlemail.com with ESMTPSA id g16sm2347896oof.43.2021.04.19.20.15.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 19 Apr 2021 20:15:28 -0700 (PDT) From: Rob Herring To: Will Deacon , Catalin Marinas , Peter Zijlstra , Ingo Molnar , Arnaldo Carvalho de Melo , Jiri Olsa , Mark Rutland Cc: Alexander Shishkin , honnappa.nagarahalli@arm.com, Zachary.Leaf@arm.com, Raphael Gault , Jonathan Cameron , Namhyung Kim , Itaru Kitayama , linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org Subject: [PATCH v7 9/9] Documentation: arm64: Document PMU counters access from userspace Date: Mon, 19 Apr 2021 22:15:11 -0500 Message-Id: <20210420031511.2348977-10-robh@kernel.org> X-Mailer: git-send-email 2.27.0 In-Reply-To: <20210420031511.2348977-1-robh@kernel.org> References: <20210420031511.2348977-1-robh@kernel.org> MIME-Version: 1.0 X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20210419_201530_903285_34D8FC56 X-CRM114-Status: GOOD ( 22.81 ) 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: , 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 --- 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 | 67 +++++++++++++++++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/Documentation/arm64/perf.rst b/Documentation/arm64/perf.rst index b567f177d385..c40fc2adc451 100644 --- a/Documentation/arm64/perf.rst +++ b/Documentation/arm64/perf.rst @@ -2,7 +2,10 @@ .. _perf_index: -===================== +==== +Perf +==== + Perf Event Attributes ===================== @@ -88,3 +91,65 @@ 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: 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), then +userspace access must also be requested with attr.config1:1 set. This +will disable counter chaining. The 'pmc_width' in the user page will +indicate the actual width of the counter which could be only 32-bits +depending on 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