From patchwork Wed May 23 17:58:08 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rajat Jain X-Patchwork-Id: 919257 X-Patchwork-Delegate: bhelgaas@google.com Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=none (mailfrom) smtp.mailfrom=vger.kernel.org (client-ip=209.132.180.67; helo=vger.kernel.org; envelope-from=linux-pci-owner@vger.kernel.org; receiver=) Authentication-Results: ozlabs.org; dmarc=pass (p=reject dis=none) header.from=google.com Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=google.com header.i=@google.com header.b="PB0Ho++U"; dkim-atps=neutral Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 40rgJl3W0Bz9s15 for ; Thu, 24 May 2018 03:59:51 +1000 (AEST) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S933907AbeEWR7A (ORCPT ); Wed, 23 May 2018 13:59:00 -0400 Received: from mail-pg0-f65.google.com ([74.125.83.65]:42255 "EHLO mail-pg0-f65.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933891AbeEWR6z (ORCPT ); Wed, 23 May 2018 13:58:55 -0400 Received: by mail-pg0-f65.google.com with SMTP id p9-v6so9746667pgc.9 for ; Wed, 23 May 2018 10:58:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=2EJ4D+L/5H9znFFvXT8cS2yNFydduxQdfWP8MkCCpCY=; b=PB0Ho++UDSX86btyoWRXqC1Djl9bfLrR7i3orXdiboy4BkwUN8Q/NGNhOZT5yD1E6f XezwC/7BrycTX4uwMFDZ2PUGPU3oPcdAEltyCYn5NnS0Jm+eiA6u9dxb1HpEHmX3hoHu NteX6WMFSjQU8hhRPXZK9eibRDrsNJbQJRJM5qCckdEy1ZMi8q53f8guer5ML3MhW95x fWcgqk2/4NXTGnI+tq4zbX873lRMnTfDoMJH5vlb17gVf4+2NQzVypgIQOfN5/NA4bmj Oi4mqys6sQZusMcJCSGi5jcXbUGuQxuxIfiX0doNIzQHv1lRwRolRr9REsAF+wLPV0Lc 5+Pg== 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; bh=2EJ4D+L/5H9znFFvXT8cS2yNFydduxQdfWP8MkCCpCY=; b=Q51434UlN5nCa1tjVIYWbYSr6bbMmNhC71JvbC0pkgUW8vbkvEqySgbCTeh+UyUsPG URIxnEX0ACzsk3lJ3x4v9+ygrMdUFY+sOfoH5JalTWlcqMQWtnZICCGdyHzfIBW46r4r O6EoG/esZMwV5FZr6YF8EUYPfqNCHxaiFM+hEsJxxGNYwi+uXG1NP2oX7uO1avdcmZrO i1q5PItxGgphur5vGiJ1XIGagrPOEB9hvUfxjcx3UcSqTpA2V3A3xVON+lPBSyqC3eAu TPmHec983nLjBe/t1DLzhkDLG2vgYOtunXUpL+LKaVubgjTEAlwWXDSkImTHah+Zgayg p0Dg== X-Gm-Message-State: ALKqPwelayu3wHhPKsLQG8BDTstksODIiiIW2IYEdX9ZE11EIv9ad1gd 7IKUkBPwLbHvmDB9lOhaTyivHQ== X-Google-Smtp-Source: AB8JxZomxsrEJinog35+5xAo3ZeUIpJNr3Xq4Si+cwbjBhi7QbK75AGd3dqLdO+Ysk/Lt5/jLRH0qQ== X-Received: by 2002:a63:a743:: with SMTP id w3-v6mr3085079pgo.374.1527098334165; Wed, 23 May 2018 10:58:54 -0700 (PDT) Received: from rajat.mtv.corp.google.com ([2620:0:1000:1501:dc81:9a9e:fdee:decf]) by smtp.gmail.com with ESMTPSA id k186-v6sm41433025pfc.142.2018.05.23.10.58.52 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 23 May 2018 10:58:53 -0700 (PDT) From: Rajat Jain To: Bjorn Helgaas , Jonathan Corbet , Philippe Ombredanne , Kate Stewart , Thomas Gleixner , Greg Kroah-Hartman , Rajat Jain , Frederick Lawler , Oza Pawandeep , Keith Busch , Gabriele Paoloni , 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 Cc: rajatxjain@gmail.com Subject: [PATCH v2 5/5] Documentation/ABI: Add details of PCI AER statistics Date: Wed, 23 May 2018 10:58:08 -0700 Message-Id: <20180523175808.28030-6-rajatja@google.com> X-Mailer: git-send-email 2.17.0.441.gb46fe60e1d-goog In-Reply-To: <20180523175808.28030-1-rajatja@google.com> References: <20180522222805.80314-1-rajatja@google.com> <20180523175808.28030-1-rajatja@google.com> Sender: linux-pci-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-pci@vger.kernel.org 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 --- v2: Move the documentation to Documentation/ABI/ .../testing/sysfs-bus-pci-devices-aer_stats | 103 ++++++++++++++++++ Documentation/PCI/pcieaer-howto.txt | 5 + 2 files changed, 108 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..f55c389290ac --- /dev/null +++ b/Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats @@ -0,0 +1,103 @@ +========================== +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 of correctable errors seen and reported by this + PCI device using ERR_COR. A sample result looks like this: +----------------------------------------- +Receiver Error = 0x174 +Bad TLP = 0x19 +Bad DLLP = 0x3 +RELAY_NUM Rollover = 0x0 +Replay Timer Timeout = 0x1 +Advisory Non-Fatal = 0x0 +Corrected Internal Error = 0x0 +Header Log Overflow = 0x0 +----------------------------------------- + +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. A sample result + looks like this: +----------------------------------------- +Undefined = 0x0 +Data Link Protocol = 0x0 +Surprise Down Error = 0x0 +Poisoned TLP = 0x0 +Flow Control Protocol = 0x0 +Completion Timeout = 0x0 +Completer Abort = 0x0 +Unexpected Completion = 0x0 +Receiver Overflow = 0x0 +Malformed TLP = 0x0 +ECRC = 0x0 +Unsupported Request = 0x0 +ACS Violation = 0x0 +Uncorrectable Internal Error = 0x0 +MC Blocked TLP = 0x0 +AtomicOp Egress Blocked = 0x0 +TLP Prefix Blocked Error = 0x0 +----------------------------------------- + +============================ +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