From patchwork Wed Jun 20 23:41:47 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rajat Jain X-Patchwork-Id: 10478877 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 47C9A60210 for ; Wed, 20 Jun 2018 23:42:30 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 39F4028CD7 for ; Wed, 20 Jun 2018 23:42:30 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2E60D28CE8; Wed, 20 Jun 2018 23:42:30 +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 92EB428CD7 for ; Wed, 20 Jun 2018 23:42:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933229AbeFTXmO (ORCPT ); Wed, 20 Jun 2018 19:42:14 -0400 Received: from mail-ua0-f202.google.com ([209.85.217.202]:51921 "EHLO mail-ua0-f202.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S932795AbeFTXmL (ORCPT ); Wed, 20 Jun 2018 19:42:11 -0400 Received: by mail-ua0-f202.google.com with SMTP id f7-v6so407994uam.18 for ; Wed, 20 Jun 2018 16:42:11 -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=kW/g+FWkJYWvtkgkIduENAfIL+FpZoPExCg7OlubknY=; b=o2+3gh5wQIUQXaRT6FFcQTU9zzbFimmoD6ku2Lf7CjXr1qD+1OmvBo+drVsLCenJr7 Yfx3QTRDK8qmvBlyUo8fxOZhlcUgqym2LiB3Jr0vg00Idw5zIeuVjYVkMn3ycX9reOea x7MAMPi3LRSVfypYOML6BXQnjqTGhP0/wKp2SILXOAF1eodKYo1zWYWdxnxv/B6SUQFE B+liuUgHyqnXhyjEtFu+UOVzsADXSKddKbHyFJVdFbrlvT3XQgGDb3FNfdFzPCDWqH4y bQbsd8kAKFpmxf2wexqPdGe4HC8heii+tyfxJsooDHJSSDbY2+GHqpygdQHEb+aUbDRT G9eQ== 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=kW/g+FWkJYWvtkgkIduENAfIL+FpZoPExCg7OlubknY=; b=bI2xTQpZ0obJ+cgoxtnkETy4ft9UXIuvFWDi/BE3vquAEbwpqyC/dO/FtxlQFdAw+F MnXBe9TXn1bUMfcwMK6A0/1e5F+D2qmvqENsGVPizGep0zHKU8VeWeX5uXnUh8lXY1iA A+2c10xf84WJTSaImnxuGIQbrSUuJTxNKykIZ4MPfGz9u8OzF97uNB5vJ9UHAGsE1N0K uHFJ0bqZBsbeMNl+PtYK6oA/+ZdD2/0kaai5dy1Nu/T7MAYp635b9LRa+9wBbxNXlemo 37a0AL420FQ8CVozpxJZpoF5Mymvc6nTxqpW92Y7+fySeDI6vImQEPp8eXMUS+pE26MW B27g== X-Gm-Message-State: APt69E0aeLPWx7U5/IVA7LSQFv2ETTbto4jPWwYKAUHmkBY61b5Dn/AO M/uJk2DX5QtdYLu14dQDY0vghAasvYqt X-Google-Smtp-Source: ADUXVKLWgIuEjcF1qEcwgyG2tNc+wtiJcO6wSKVOOB9BrqwVL3IxsM27ngHGxpR6/W64gmq0JcaOtjCSONJA MIME-Version: 1.0 X-Received: by 2002:ab0:15a5:: with SMTP id i34-v6mr10232641uae.22.1529538130519; Wed, 20 Jun 2018 16:42:10 -0700 (PDT) Date: Wed, 20 Jun 2018 16:41:47 -0700 In-Reply-To: <20180620234147.48438-1-rajatja@google.com> Message-Id: <20180620234147.48438-5-rajatja@google.com> References: <20180522222805.80314-1-rajatja@google.com> <20180620234147.48438-1-rajatja@google.com> X-Mailer: git-send-email 2.18.0.rc1.244.gcf134e6275-goog Subject: [PATCH v5 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 --- v5: Same as v4 v4: Same as v3 v3: Add some more details .../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