From patchwork Mon Mar 27 17:02:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Cameron X-Patchwork-Id: 75587 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp1672821vqo; Mon, 27 Mar 2023 10:25:42 -0700 (PDT) X-Google-Smtp-Source: AKy350Zit1djNdzsqSPT58Wt0CxxweU8uQUzj14yLPf7qNIY+p/tv46VJEtEE+OTphPdYMgv479h X-Received: by 2002:a17:90b:314c:b0:23f:b609:e704 with SMTP id ip12-20020a17090b314c00b0023fb609e704mr12773247pjb.1.1679937942669; Mon, 27 Mar 2023 10:25:42 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1679937942; cv=none; d=google.com; s=arc-20160816; b=qIRqxk0yjokIcLuv4t0DC2C4zQHodYGyePiHjjIvy4eccFOGRtlY28o0gagJrlNHoH WDuhiu0O4vs+S2tGIYs5eyuObz+QmZIIVoI6QB5Tqj9++S8DJHu4KeFOAYBmfpLpYChQ 9SkDaJRfF1oj+JfndviLwLMPmx/+C18OGp/cJZuisybmvG/2mL1b7aQ3dduNP+sklN+m KFKUr/SQ51uI8maYK6scG+aWRnGj1dzdRVUK4ikQbrxmvKuuAZN9lM+dtQRZN8xH28CM qN/onWHpej3mMUIjn0RzkoVQmNLoyzbrduzmXNG5uDPRdwRNqnKmuiFX2Qmnn8XObEqt Aawg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from; bh=b22eoPiY1aMaY2nizE1YAzbssEu3CsJyGyUwQOC+UQ4=; b=02Z7fs3vPDuCGmGDTikI6NLCmJ/Ptn/37Qt5oHWKVdOj6SA5k8is8McId4V6LXoCJA ke15KWw0yQqfccQB9n2YuzLwaphrDQl5QTc1J3HdN5BUwcL3oKhzaG8na4F6Iucx9Q+t /jL1ZU3VMgvZLLzCDIFMcQ56fu6U27tdHehpbICkLOCTYrCjC9XTYA//E3MbV5A7qfk5 wEJfBEIdx9EClOge8ts+QFO1jltJbc0NLex/KQT12hblwjsPi71ZZdGfCeqw/D401I3y w7s6a4v0/h4Mb1H3JZvAS17gbnjTMTuhCLkB5zttXssvzt7XAOMkgV35ZVyzjvIJxN35 hlfQ== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=huawei.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id n11-20020a170902e54b00b001a1be5ca65asi11356704plf.528.2023.03.27.10.25.28; Mon, 27 Mar 2023 10:25:42 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=fail (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=huawei.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232475AbjC0RJf (ORCPT + 99 others); Mon, 27 Mar 2023 13:09:35 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37344 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S232719AbjC0RJQ (ORCPT ); Mon, 27 Mar 2023 13:09:16 -0400 Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id EC06710E2; Mon, 27 Mar 2023 10:08:17 -0700 (PDT) Received: from lhrpeml500005.china.huawei.com (unknown [172.18.147.201]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4PlfH40rlJz6SKS8; Tue, 28 Mar 2023 01:01:36 +0800 (CST) Received: from SecurePC-101-06.china.huawei.com (10.122.247.231) by lhrpeml500005.china.huawei.com (7.191.163.240) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.21; Mon, 27 Mar 2023 18:05:12 +0100 From: Jonathan Cameron To: Liang Kan , , CC: , , , , , , , , Davidlohr Bueso , Dave Jiang Subject: [PATCH v3 5/5] docs: perf: Minimal introduction the the CXL PMU device and driver Date: Mon, 27 Mar 2023 18:02:47 +0100 Message-ID: <20230327170247.6968-6-Jonathan.Cameron@huawei.com> X-Mailer: git-send-email 2.37.2 In-Reply-To: <20230327170247.6968-1-Jonathan.Cameron@huawei.com> References: <20230327170247.6968-1-Jonathan.Cameron@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.122.247.231] X-ClientProxiedBy: lhrpeml500004.china.huawei.com (7.191.163.9) To lhrpeml500005.china.huawei.com (7.191.163.240) X-CFilter-Loop: Reflected X-Spam-Status: No, score=-2.3 required=5.0 tests=RCVD_IN_DNSWL_MED, RCVD_IN_MSPIKE_H2,SPF_HELO_NONE,SPF_PASS autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1761542608476399516?= X-GMAIL-MSGID: =?utf-8?q?1761542608476399516?= Very basic introduction to the device and the current driver support provided. I expect to expand on this in future versions of this patch set. Reviewed-by: Dave Jiang Signed-off-by: Jonathan Cameron --- v3: No change --- Documentation/admin-guide/perf/cxl.rst | 65 ++++++++++++++++++++++++ Documentation/admin-guide/perf/index.rst | 1 + 2 files changed, 66 insertions(+) diff --git a/Documentation/admin-guide/perf/cxl.rst b/Documentation/admin-guide/perf/cxl.rst new file mode 100644 index 000000000000..46235dff4b21 --- /dev/null +++ b/Documentation/admin-guide/perf/cxl.rst @@ -0,0 +1,65 @@ +.. SPDX-License-Identifier: GPL-2.0 + +====================================== +CXL Performance Monitoring Unit (CPMU) +====================================== + +The CXL rev 3.0 specification provides a definition of CXL Performance +Monitoring Unit in section 13.2: Performance Monitoring. + +CXL components (e.g. Root Port, Switch Upstream Port, End Point) may have +any number of CPMU instances. CPMU capabilities are fully discoverable from +the devices. The specification provides event definitions for all CXL protocol +message types and a set of additional events for things commonly counted on +CXL devices (e.g. DRAM events). + +CPMU driver +=========== + +The CPMU driver register a perf PMU with the name cpmu on the CXL bus. + + /sys/bus/cxl/device/cpmu + +The associated PMU is registered as + + /sys/bus/event_sources/devices/cpmu + +In common with other CXL bus devices, the id has no specific meaning and the +relationship to specific CXL device should be established via the device parent +of the device on the CXL bus. + +PMU driver provides description of available events and filter options in sysfs. + +The "format" directory describes all formats of the config (event vendor id, +group id and mask) config1 (threshold, filter enables) and config2 (filter +parameters) fields of the perf_event_attr structure. The "events" directory +describes all documented events show in perf list. + +The events shown in perf list are the most fine grained events with a single +bit of the event mask set. More general events may be enable by setting +multiple mask bits in config. For example, all Device to Host Read Requests +may be captured on a single counter by setting the bits for all of + +* d2h_req_rdcurr +* d2h_req_rdown +* d2h_req_rdshared +* d2h_req_rdany +* d2h_req_rdownnodata + +Example of usage:: + + $#perf list + cpmu0/clock_ticks/ [Kernel PMU event] + cpmu0/d2h_req_itomwr/ [Kernel PMU event] + cpmu0/d2h_req_rdany/ [Kernel PMU event] + cpmu0/d2h_req_rdcurr/ [Kernel PMU event] + ----------------------------------------------------------- + + $# perf stat -e cpmu0/clock_ticks/ -e cpmu0/d2h_req_itowrm/ + +Vendor specific events may also be available and if so can be used via + + $# perf stat -e cpmu0/vid=VID,gid=GID,mask=MASK/ + +The driver does not support sampling. So "perf record" and attaching to +a task are unsupported. diff --git a/Documentation/admin-guide/perf/index.rst b/Documentation/admin-guide/perf/index.rst index 9de64a40adab..f60be04e4e33 100644 --- a/Documentation/admin-guide/perf/index.rst +++ b/Documentation/admin-guide/perf/index.rst @@ -21,3 +21,4 @@ Performance monitor support alibaba_pmu nvidia-pmu meson-ddr-pmu + cxl