From patchwork Wed Jun 20 01:12:10 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rajat Jain X-Patchwork-Id: 10475757 X-Patchwork-Delegate: bhelgaas@google.com Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 4A9B3603B5 for ; Wed, 20 Jun 2018 01:13:07 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 3B360287FA for ; Wed, 20 Jun 2018 01:13:07 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2E9222887F; Wed, 20 Jun 2018 01:13:07 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-15.5 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, USER_IN_DEF_DKIM_WL autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 9719E287FA for ; Wed, 20 Jun 2018 01:13:06 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753896AbeFTBNF (ORCPT ); Tue, 19 Jun 2018 21:13:05 -0400 Received: from mail-qk0-f202.google.com ([209.85.220.202]:42261 "EHLO mail-qk0-f202.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753879AbeFTBMc (ORCPT ); Tue, 19 Jun 2018 21:12:32 -0400 Received: by mail-qk0-f202.google.com with SMTP id h4-v6so1430904qkm.9 for ; Tue, 19 Jun 2018 18:12:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=mime-version:date:in-reply-to:message-id:references:subject:from:to :cc; bh=IU0qiFbshDMkhEWSuAz7QUUDqEE8BqN5PAyO7a+4oWE=; b=POfd/5b7m5Fqo5J7Wc6eotqbAdEq7kjghp4Dvuut3zp4zzPza8A4s/WN9B3K3Li1/0 YLURlvARQmMzz0TD5RysEvp3UACPs9X+hTonZ0eqqRdoc++V5yLdkPiciQqlQ3wTRzr8 Sgd+F0/ruSqfZX+i1H/QbrCmrXsnEFOh5kTOKYWIaqIK+qipS9Laf7UVUOK0S7pDYMQX mEgH4fH6+DJjeZkwLoYVcKMRPGujCHXNoli73XD9FZOcVRyVT29NJpyjlNVoXRGHV7+E P+ebXdXrRZfm+XjUNdG9cE3WCibBEz3MEhH1LmijHJvYXDJi2MCkirHRSngZd6lGUdDs BsuA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:date:in-reply-to:message-id :references:subject:from:to:cc; bh=IU0qiFbshDMkhEWSuAz7QUUDqEE8BqN5PAyO7a+4oWE=; b=t5hAJDew4Yg5ZgZKJ+oiHeuMDwGxLdnkr7wHChTJJoZrI4RcafHdotZRwQyFMqsdY4 Sk8hX4CmbNNCjJqIFY13y891BoL6d9LXpTVrq25M0LdTrqqgRkiyPvE3kFySv7Oh7FL6 /ZvExHNI9DKgzyxp6YKuxUBwHVjAmZmXcgr/s7omcjqprK5afO1w+1zg5BdwrX0uAueT VeN3CUiEv0gyKBxA8NcBq8g3sqkGs2yjZcaRTSUSGi+QQwJ6gw4yMTfgkl/UdzDfSJYG ct/mqCxohxCvHqzm2+4qWtowVcpHHZKD2qiJ3iKyyyG7EbGd5zteAMML2nLLqGi/I1/X RS/w== X-Gm-Message-State: APt69E0e+5zBIrOSM6OAafL0dd/PV6u8hY8cQBD+BeG5WGfdE1+x23Zf FD0ZDqbFVHsmpw0rMqxE8/B90sy6RTNT X-Google-Smtp-Source: ADUXVKLp6TDBco2Ge5W3CPvC7Jj3PkfzmybyfeGg1MRQIjghQEyKGmwGZw6OLxk9fegFeJnUCBBH3i2u2w2E MIME-Version: 1.0 X-Received: by 2002:a0c:8b4a:: with SMTP id d10-v6mr10458257qvc.14.1529457151447; Tue, 19 Jun 2018 18:12:31 -0700 (PDT) Date: Tue, 19 Jun 2018 18:12:10 -0700 In-Reply-To: <20180620011210.254601-1-rajatja@google.com> Message-Id: <20180620011210.254601-5-rajatja@google.com> References: <20180619221651.GH33049@bhelgaas-glaptop.roam.corp.google.com> <20180620011210.254601-1-rajatja@google.com> X-Mailer: git-send-email 2.18.0.rc1.244.gcf134e6275-goog Subject: [PATCH v3 5/5] Documentation/ABI: Add details of PCI AER statistics From: Rajat Jain To: Bjorn Helgaas , Jonathan Corbet , Philippe Ombredanne , Kate Stewart , Thomas Gleixner , Greg Kroah-Hartman , Frederick Lawler , Oza Pawandeep , Keith Busch , Alexandru Gagniuc , Thomas Tai , "Steven Rostedt (VMware)" , linux-pci@vger.kernel.org, linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org, Jes Sorensen , Kyle McMartin , rajatxjain@gmail.com, helgaas@kernel.org Cc: Rajat Jain Sender: linux-pci-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add the PCI AER statistics details to Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats and provide a pointer to it in Documentation/PCI/pcieaer-howto.txt Signed-off-by: Rajat Jain --- v3: Add some more details, use decimal instead of hex .../testing/sysfs-bus-pci-devices-aer_stats | 111 ++++++++++++++++++ Documentation/PCI/pcieaer-howto.txt | 5 + 2 files changed, 116 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats diff --git a/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats new file mode 100644 index 000000000000..3ed5a682be87 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats @@ -0,0 +1,111 @@ +========================== +PCIe Device AER statistics +========================== +These attributes show up under all the devices that are AER capable. These +statistical counters indicate the errors "as seen/reported by the device". +Note that this may mean that if an end point is causing problems, the AER +counters may increment at its link partner (e.g. root port) because the +errors will be "seen" / reported by the link partner and not the the +problematic end point itself (which may report all counters as 0 as it never +saw any problems). + +Where: /sys/bus/pci/devices//aer_stats/dev_total_cor_errs +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Total number of correctable errors seen and reported by this + PCI device using ERR_COR. + +Where: /sys/bus/pci/devices//aer_stats/dev_total_fatal_errs +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Total number of uncorrectable fatal errors seen and reported + by this PCI device using ERR_FATAL. + +Where: /sys/bus/pci/devices//aer_stats/dev_total_nonfatal_errs +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Total number of uncorrectable non-fatal errors seen and reported + by this PCI device using ERR_NONFATAL. + +Where: /sys/bus/pci/devices//aer_stats/dev_breakdown_correctable +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Breakdown of correctable errors seen and reported by this + PCI device using ERR_COR. Note that the sum total of all errors + in dev_breakdown_correctable may exceed dev_total_cor_errs + because a device is allowed to merge multiple correctable and + send a single ERR_COR for them (which is what dev_total_cor_errs + counts). A sample output for this attribute looks like this: +----------------------------------------- +Receiver Error = 174 +Bad TLP = 19 +Bad DLLP = 3 +RELAY_NUM Rollover = 0 +Replay Timer Timeout = 1 +Advisory Non-Fatal = 0 +Corrected Internal Error = 0 +Header Log Overflow = 0 +----------------------------------------- + +Where: /sys/bus/pci/devices//aer_stats/dev_breakdown_uncorrectable +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Breakdown of of correctable errors seen and reported by this + PCI device using ERR_FATAL or ERR_NONFATAL. Note that the sum + total of all errors in dev_breakdown_uncorrectable may exceed + (dev_total_fatal_errs + dev_total_nonfatal_errs) because a + device is allowed to merge multiple errors at the same severity + and send a single ERR_FATAL/ERR_NON_FATAL for them. + A sample output for this attribute looks like this: +----------------------------------------- +Undefined = 0 +Data Link Protocol = 0 +Surprise Down Error = 0 +Poisoned TLP = 0 +Flow Control Protocol = 0 +Completion Timeout = 0 +Completer Abort = 0 +Unexpected Completion = 0 +Receiver Overflow = 0 +Malformed TLP = 0 +ECRC = 0 +Unsupported Request = 0 +ACS Violation = 0 +Uncorrectable Internal Error = 0 +MC Blocked TLP = 0 +AtomicOp Egress Blocked = 0 +TLP Prefix Blocked Error = 0 +----------------------------------------- + +============================ +PCIe Rootport AER statistics +============================ +These attributes showup under only the rootports that are AER capable. These +indicate the number of error messages as "reported to" the rootport. Please note +that the rootports also transmit (internally) the ERR_* messages for errors seen +by the internal rootport PCI device, so these counters includes them and are +thus cumulative of all the error messages on the PCI hierarchy originating +at that root port. + +Where: /sys/bus/pci/devices//aer_stats/rootport_total_cor_errs +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Total number of ERR_COR messages reported to rootport. + +Where: /sys/bus/pci/devices//aer_stats/rootport_total_fatal_errs +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Total number of ERR_FATAL messages reported to rootport. + +Where: /sys/bus/pci/devices//aer_stats/rootport_total_nonfatal_errs +Date: May 2018 +Kernel Version: 4.17.0 +Contact: linux-pci@vger.kernel.org, rajatja@google.com +Description: Total number of ERR_NONFATAL messages reported to rootport. diff --git a/Documentation/PCI/pcieaer-howto.txt b/Documentation/PCI/pcieaer-howto.txt index acd0dddd6bb8..91b6e677cb8c 100644 --- a/Documentation/PCI/pcieaer-howto.txt +++ b/Documentation/PCI/pcieaer-howto.txt @@ -73,6 +73,11 @@ In the example, 'Requester ID' means the ID of the device who sends the error message to root port. Pls. refer to pci express specs for other fields. +2.4 AER Statistics / Counters + +When PCIe AER errors are captured, the counters / statistics are also exposed +in form of sysfs attributes which are documented at +Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats 3. Developer Guide