From: Alexander Potapenko <glider@google.com>
To: linux-kernel@vger.kernel.org, akpm@linux-foundation.org
Cc: andreyknvl@google.com, dvyukov@google.com, mingo@redhat.com,
elver@google.com, pmladek@suse.com, rostedt@goodmis.org,
sergey.senozhatsky@gmail.com, glider@google.com,
linux-mm@kvack.org
Subject: [PATCH v2 3/5] docs: ABI: add /sys/kernel/error_report/ documentation
Date: Fri, 15 Jan 2021 14:03:34 +0100 [thread overview]
Message-ID: <20210115130336.2520663-4-glider@google.com> (raw)
In-Reply-To: <20210115130336.2520663-1-glider@google.com>
Add ABI documentation for files in /sys/kernel/error_report/
Requested-by: Andrew Morton <akpm@linux-foundation.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Andrey Konovalov <andreyknvl@google.com>
Cc: Dmitry Vyukov <dvyukov@google.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Marco Elver <elver@google.com>
Cc: Petr Mladek <pmladek@suse.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>
Cc: linux-mm@kvack.org
Signed-off-by: Alexander Potapenko <glider@google.com>
---
.../ABI/testing/sysfs-kernel-error_report | 41 +++++++++++++++++++
1 file changed, 41 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-kernel-error_report
diff --git a/Documentation/ABI/testing/sysfs-kernel-error_report b/Documentation/ABI/testing/sysfs-kernel-error_report
new file mode 100644
index 000000000000..666d039f93a9
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-kernel-error_report
@@ -0,0 +1,41 @@
+What: /sys/kernel/error_report/
+Date: January 2021
+Contact: Alexander Potapenko <glider@google.com>,
+ Marco Elver <elver@google.com>
+Description:
+ /sys/kernel/error_report/ contains two files: "report_count"
+ and "last_report". These files are used to notify userspace
+ about error reports from the enrolled kernel subsystems (those
+ that use error_report_start/error_report_end tracepoints).
+
+ "report_count" contains the current number of reported errors.
+ This number is incremented every time the error_report_end
+ trace event occurs in the kernel.
+
+ "last_report" contains the most recent error report; concurrent
+ report generation results in collection of any one report
+ ("last_report" may not be the last shown on the console).
+ A "report" is everything the task had printed to the console
+ between issuing the error_report_start and error_report_end
+ trace events.
+
+ Due to sysfs limitations, the report size is truncated at
+ PAGE_SIZE. To save space, the leading info in square brackets
+ printed by CONFIG_PRINTK_TIME and CONFIG_PRINTK_CALLER is
+ trimmed from the output lines.
+
+ Both files use sysfs_notify() to notify userspace about
+ changes. Userspace programs can use poll() to block until an
+ error is reported:
+
+ pfd.fd = fd;
+ pfd.events = POLLPRI;
+ while (1) {
+ lseek(pfd.fd, 0, SEEK_SET);
+ poll(&pfd, 1, -1);
+ read(pfd.fd, buffer, PAGE_SIZE);
+ /* Process the report in @buffer. */
+ }
+
+ Files in /sys/kernel/error_report/ are available when
+ CONFIG_ERROR_REPORT_NOTIFY is enabled.
--
2.30.0.284.gd98b1dd5eaa7-goog
next prev parent reply other threads:[~2021-01-15 13:03 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-15 13:03 [PATCH v2 0/5] Add sysfs interface to collect reports from debugging tools Alexander Potapenko
2021-01-15 13:03 ` [PATCH v2 1/5] tracing: add error_report trace points Alexander Potapenko
2021-01-15 13:03 ` [PATCH v2 2/5] lib: add error_report_notify to collect debugging tools' reports Alexander Potapenko
2021-01-15 13:50 ` Greg KH
2021-01-15 17:17 ` Alexander Potapenko
2021-01-18 11:38 ` Petr Mladek
2021-01-18 13:08 ` Alexander Potapenko
2021-01-18 13:14 ` Alexander Potapenko
2021-01-18 16:43 ` Petr Mladek
2021-01-21 13:13 ` Alexander Potapenko
2021-01-15 13:03 ` Alexander Potapenko [this message]
2021-01-15 13:45 ` [PATCH v2 3/5] docs: ABI: add /sys/kernel/error_report/ documentation Greg KH
2021-01-15 15:26 ` Alexander Potapenko
2021-01-15 15:45 ` Greg KH
2021-01-15 16:52 ` Steven Rostedt
2021-01-18 10:22 ` Alexander Potapenko
2021-01-18 14:52 ` Steven Rostedt
2021-01-15 13:03 ` [PATCH v2 4/5] kfence: use error_report_start and error_report_end tracepoints Alexander Potapenko
2021-01-15 13:03 ` [PATCH v2 5/5] kasan: " Alexander Potapenko
2021-01-15 13:06 ` [PATCH v2 0/5] Add sysfs interface to collect reports from debugging tools Vlastimil Babka
2021-01-15 13:09 ` Alexander Potapenko
2021-01-21 12:56 ` Alexander Potapenko
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210115130336.2520663-4-glider@google.com \
--to=glider@google.com \
--cc=akpm@linux-foundation.org \
--cc=andreyknvl@google.com \
--cc=dvyukov@google.com \
--cc=elver@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=mingo@redhat.com \
--cc=pmladek@suse.com \
--cc=rostedt@goodmis.org \
--cc=sergey.senozhatsky@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).