kernel: add support to collect hardware logs in crash recovery kernel
Subsystems (6)
v2 cover kernel: add support to collect hardware logs in crash recovery kernel
On production servers running variety of workloads over time, kernel panic can happen sporadically after days or even months. It is important to collect as much debug logs as possible to root cause and fix the problem, that may not be easy to reproduce. Snapshot of underlying hardware/firmware state (like register dump, firmware logs, adapter memory, etc.), at the time of kernel panic will be very helpful while debugging the culprit device driver.
This series of patches add new generic framework that enable device drivers to collect device specific snapshot of the hardware/firmware state of the underlying device in the crash recovery kernel. In crash recovery kernel, the collected logs are exposed via /sys/kernel/crashdd/ directory, which is copied by user space scripts for post-analysis.
A kernel module crashdd is newly added. In crash recovery kernel, crashdd exposes /sys/kernel/crashdd/ directory containing device specific hardware/firmware logs.
The sequence of actions done by device drivers to append their device specific hardware/firmware logs to /sys/kernel/crashdd/ directory are as follows:
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via crashdd_add_dump()), with callback function, along with buffer size and log name needed for firmware/hardware log collection.
2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with requested size and invokes the device driver's registered callback function.
3. Device driver collects all hardware/firmware logs into the buffer and returns control back to crashdd.
4. Crashdd exposes the buffer as a file via
/sys/kernel/crashdd/<driver>/<dump_file>.
5. User space script (/usr/lib/kdump/kdump-lib-initramfs.sh) copies the entire /sys/kernel/crashdd/ directory to /var/crash/ directory.
Patch 1 adds crashdd module to allow drivers to register callback to collect the device specific hardware/firmware logs. The module also exports /sys/kernel/crashdd/ directory containing the hardware/firmware logs.
Patch 2 shows a cxgb4 driver example using the API to collect hardware/firmware logs in crash recovery kernel, before hardware is initialized. The logs for the devices are made available under /sys/kernel/crashdd/cxgb4/ directory.
Thanks,
Rahul
RFC v1: https://lkml.org/lkml/2018/3/2/542
RFC v2: https://lkml.org/lkml/2018/3/16/326
---
v2:
- Added ABI Documentation for crashdd.
- Directly use octal permission instead of macro.
Changes since rfc v2:
- Moved exporting crashdd from procfs to sysfs. Suggested by Stephen Hemminger <[email protected]>
- Moved code from fs/proc/crashdd.c to fs/crashdd/ directory.
- Replaced all proc API with sysfs API and updated comments.
- Calling driver callback before creating the binary file under crashdd sysfs.
- Changed binary dump file permission from S_IRUSR to S_IRUGO.
- Changed module name from CRASH_DRIVER_DUMP to CRASH_DEVICE_DUMP.
rfc v2:
- Collecting logs in 2nd kernel instead of during kernel panic. Suggested by Eric Biederman <[email protected]>.
- Added new crashdd module that exports /proc/crashdd/ containing driver's registered hardware/firmware logs in patch 1.
- Replaced the API to allow drivers to register their hardware/firmware log collect routine in crash recovery kernel in patch 1.
- Updated patch 2 to use the new API in patch 1.
Rahul Lakkireddy (2):
fs/crashdd: add API to collect hardware dump in second kernel
cxgb4: collect hardware dump in second kernel
Documentation/ABI/testing/sysfs-kernel-crashdd | 34 ++++ drivers/net/ethernet/chelsio/cxgb4/cxgb4.h | 4 + drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.c | 25 +++ drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.h | 3 + drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c | 12 ++ fs/Kconfig | 1 + fs/Makefile | 1 + fs/crashdd/Kconfig | 10 + fs/crashdd/Makefile | 3 + fs/crashdd/crashdd.c | 233 +++++++++++++++++++++++ fs/crashdd/crashdd_internal.h | 24 +++ include/linux/crashdd.h | 24 +++ 12 files changed, 374 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-kernel-crashdd create mode 100644 fs/crashdd/Kconfig create mode 100644 fs/crashdd/Makefile create mode 100644 fs/crashdd/crashdd.c create mode 100644 fs/crashdd/crashdd_internal.h create mode 100644 include/linux/crashdd.h
Signature · 1 line
2.14.1
PATCH v2 1/2 fs/crashdd: add API to collect hardware dump in second kernel
Add a new module crashdd that exports the /sys/kernel/crashdd/ directory in second kernel, containing collected hardware/firmware dumps.
The sequence of actions done by device drivers to append their device specific hardware/firmware logs to /sys/kernel/crashdd/ directory are as follows:
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via crashdd_add_dump()), with callback function, along with buffer size and log name needed for firmware/hardware log collection.
2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with requested size and invokes the device driver's registered callback function.
3. Device driver collects all hardware/firmware logs into the buffer and returns control back to crashdd.
4. Crashdd exposes the buffer as a binary file via /sys/kernel/crashdd/<driver>/<dump_file>.
---
v2:
- Added ABI Documentation for crashdd.
- Directly use octal permission instead of macro.
Changes since rfc v2:
- Moved exporting crashdd from procfs to sysfs. Suggested by Stephen Hemminger <[email protected]>
- Moved code from fs/proc/crashdd.c to fs/crashdd/ directory.
- Replaced all proc API with sysfs API and updated comments.
- Calling driver callback before creating the binary file under crashdd sysfs.
- Changed binary dump file permission from S_IRUSR to S_IRUGO.
- Changed module name from CRASH_DRIVER_DUMP to CRASH_DEVICE_DUMP.
rfc v2:
- Collecting logs in 2nd kernel instead of during kernel panic. Suggested by Eric Biederman <ebiederm-aS9lmoZGLiVWk0Htik3J/[email protected]>.
- Patch added in this series.
Documentation/ABI/testing/sysfs-kernel-crashdd | 34 ++++ fs/Kconfig | 1 + fs/Makefile | 1 + fs/crashdd/Kconfig | 10 ++ fs/crashdd/Makefile | 3 + fs/crashdd/crashdd.c | 233 +++++++++++++++++++++++++ fs/crashdd/crashdd_internal.h | 24 +++ include/linux/crashdd.h | 24 +++ 8 files changed, 330 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-kernel-crashdd create mode 100644 fs/crashdd/Kconfig create mode 100644 fs/crashdd/Makefile create mode 100644 fs/crashdd/crashdd.c create mode 100644 fs/crashdd/crashdd_internal.h create mode 100644 include/linux/crashdd.h
Documentation/ABI/testing/sysfs-kernel-crashdd new file +34 -0
@@ -0,0 +1,34 @@ +What: /sys/kernel/crashdd +Date: March 2018 +KernelVersion: 4.16 +Contact: Rahul Lakkireddy <[email protected]> + Ganesh Goudar <[email protected]> +Description: + Snapshot of underlying hardware/firmware state (like register + dump, firmware logs, adapter memory, etc.), at the time of + kernel panic will be very helpful while debugging the culprit + device driver. Thus, Crash Device Dump (crashdd) module exports + API to allow device drivers to collect the device specific + snapshot of their hardware or firmware in crash recovery kernel. + The collected dumps will be exported under /sys/kernel/crashdd/ + directory in crash recovery kernel. + + The sequence of actions done by device drivers to append their + device specific hardware/firmware logs to /sys/kernel/crashdd/ + directory are as follows: + + 1. During probe (before hardware is initialized), device drivers + register to the crashdd module (via crashdd_add_dump()), with + callback function, along with buffer size and log name needed for + firmware/hardware log collection. + + 2. Crashdd creates a driver's directory under + /sys/kernel/crashdd/<driver>. Then, it allocates the buffer + with requested size and invokes the device driver's registered + callback function. + + 3. Device driver collects all hardware/firmware logs into the buffer + and returns control back to crashdd. + + 4. Crashdd exposes the buffer as a file via + /sys/kernel/crashdd/<driver>/<dump_file>.
fs/Kconfig +1 -0
@@ -208,6 +208,7 @@ config ARCH_HAS_GIGANTIC_PAGE source "fs/configfs/Kconfig" source "fs/efivarfs/Kconfig" +source "fs/crashdd/Kconfig" endmenu
fs/Makefile +1 -0
@@ -128,3 +128,4 @@ obj-y += exofs/ # Multiple modules obj-$(CONFIG_CEPH_FS) += ceph/ obj-$(CONFIG_PSTORE) += pstore/ obj-$(CONFIG_EFIVAR_FS) += efivarfs/ +obj-$(CONFIG_CRASH_DEVICE_DUMP) += crashdd/
fs/crashdd/Kconfig new file +10 -0
@@ -0,0 +1,10 @@ +config CRASH_DEVICE_DUMP + bool "Crash Kernel Device Hardware/Firmware Logs" + depends on SYSFS && CRASH_DUMP + default y + ---help--- + Device drivers can collect the device specific snapshot of + their hardware or firmware before they are initialized in + crash recovery kernel. If you say Y here a tree of device + specific dumps will be made available under /sys/kernel/crashdd/ + directory.
fs/crashdd/Makefile new file +3 -0
@@ -0,0 +1,3 @@ +# SPDX-License-Identifier: GPL-2.0 + +obj-y := crashdd.o
fs/crashdd/crashdd.c new file +233 -0
233 lines not on this page · raw message
fs/crashdd/crashdd_internal.h new file +24 -0
@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright (c) 2018 Chelsio Communications, Inc. All rights reserved. */ + +#ifndef CRASH_DEVICE_DUMP_INTERNAL_H +#define CRASH_DEVICE_DUMP_INTERNAL_H + +/* Binary dump file's context internal to crashdd */ +struct crashdd_dump_node { +/* Pointer to list of dumps under the driver sysfs entry */ +struct list_head list; +void *buf;/* Buffer containing device's dump */ +unsigned long size;/* Size of the buffer */ +struct bin_attribute bin_attr;/* Binary dump file's attributes */ +}; + +/* Driver sysfs entry internal to crashdd */ +struct crashdd_driver_node { +/* Pointer to global list of driver sysfs entries */ +struct list_head list; +struct list_head dump_list;/* List of dumps under this driver */ +atomic_t refcnt;/* Number of dumps under this directory */ +struct kobject *kobj;/* Pointer to driver sysfs kobject */ +}; +#endif /* CRASH_DEVICE_DUMP_INTERNAL_H */
include/linux/crashdd.h new file +24 -0
@@ -0,0 +1,24 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright (c) 2018 Chelsio Communications, Inc. All rights reserved. */ + +#ifndef CRASH_DEVICE_DUMP_H +#define CRASH_DEVICE_DUMP_H + +/* Max dump name length */ +#define CRASHDD_NAME_LENGTH 32 + +/* Device Dump information to be filled by drivers */ +struct crashdd_data { +char name[CRASHDD_NAME_LENGTH ];/* Unique name of the dump */ +unsigned long size;/* Size of the dump */ +/* Driver's registered callback to be invoked to collect dump */ +int (*crashdd_callback)(struct crashdd_data *data,void *buf); +}; + +#ifdef CONFIG_CRASH_DEVICE_DUMP +int crashdd_add_dump (const char *driver_name,struct crashdd_data *data); +#else +#define crashdd_add_dump (x, y) 0 +#endif /* CONFIG_CRASH_DEVICE_DUMP */ + +#endif /* CRASH_DEVICE_DUMP_H */
Signature · 1 line
2.14.1
kbuild test robot
build botRe: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Thank you for the patch! Perhaps something to improve:
Hi Rahul,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on net-next/master]
url: https://github.com/0day-ci/linux/commits/Rahul-Lakkireddy/fs-crashdd-add-API-to-collect-hardware-dump-in-second-kernel/20180325-191308
config: i386-randconfig-s0-03251817 (attached as .config)
compiler: gcc-6 (Debian 6.4.0-9) 6.4.0 20171026 reproduce:
# save the attached .config to linux build tree
make ARCH=i386 All warnings (new ones prefixed by >>):
In file included from fs//crashdd/crashdd.c:8:0:
fs//crashdd/crashdd_internal.h:13:23: error: field 'bin_attr' has incomplete type
struct bin_attribute bin_attr; /* Binary dump file's attributes */
^~~~~~~~
fs//crashdd/crashdd.c: In function 'crashdd_read':
fs//crashdd/crashdd.c:19:43: error: dereferencing pointer to incomplete type 'struct bin_attribute'
struct crashdd_dump_node *dump = bin_attr->private;
^~
fs//crashdd/crashdd.c: In function 'crashdd_mkdir':
fs//crashdd/crashdd.c:27:9: error: implicit declaration of function 'kobject_create_and_add' [-Werror=implicit-function-declaration]
return kobject_create_and_add(name, crashdd_kobj);
^~~~~~~~~~~~~~~~~~~~~~
fs//crashdd/crashdd.c:27:9: warning: return makes pointer from integer without a cast [-Wint-conversion]
return kobject_create_and_add(name, crashdd_kobj);
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
fs//crashdd/crashdd.c: In function 'crashdd_add_file':
fs//crashdd/crashdd.c:39:9: error: implicit declaration of function 'sysfs_create_bin_file' [-Werror=implicit-function-declaration]
return sysfs_create_bin_file(kobj, &dump->bin_attr);
^~~~~~~~~~~~~~~~~~~~~
fs//crashdd/crashdd.c: In function 'crashdd_rmdir':
fs//crashdd/crashdd.c:44:2: error: implicit declaration of function 'kobject_put' [-Werror=implicit-function-declaration]
kobject_put(kobj);
^~~~~~~~~~~
In file included from include/linux/kernel.h:10:0,
from include/linux/list.h:9,
from include/linux/preempt.h:11,
from include/linux/spinlock.h:51,
from include/linux/vmalloc.h:5,
from fs//crashdd/crashdd.c:4:
fs//crashdd/crashdd.c: In function 'crashdd_get_driver':
fs//crashdd/crashdd.c:101:25: error: dereferencing pointer to incomplete type 'struct kobject'
if (!strcmp(node->kobj->name, name)) {
^
include/linux/compiler.h:58:30: note: in definition of macro '__trace_if'
if (__builtin_constant_p(!!(cond)) ? !!(cond) : \
^~~~
>> fs//crashdd/crashdd.c:101:3: note: in expansion of macro 'if'
if (!strcmp(node->kobj->name, name)) {
^~
fs//crashdd/crashdd.c: In function 'crashdd_init':
fs//crashdd/crashdd.c:227:51: error: 'kernel_kobj' undeclared (first use in this function)
crashdd_kobj = kobject_create_and_add("crashdd", kernel_kobj);
^~~~~~~~~~~
fs//crashdd/crashdd.c:227:51: note: each undeclared identifier is reported only once for each function it appears in
fs//crashdd/crashdd.c: In function 'crashdd_add_file':
fs//crashdd/crashdd.c:40:1: warning: control reaches end of non-void function [-Wreturn-type]
}
^cc1: some warnings being treated as errors
vim +/if +101 fs//crashdd/crashdd.c
3
> 4 #include <linux/vmalloc.h>
5 #include <linux/crash_dump.h>
6 #include <linux/crashdd.h>
7
8 #include "crashdd_internal.h"
9
10 static LIST_HEAD(crashdd_list);
11 static DEFINE_MUTEX(crashdd_mutex);
12
13 static struct kobject *crashdd_kobj;
14
15 static ssize_t crashdd_read(struct file *filp, struct kobject *kobj,
16 struct bin_attribute *bin_attr,
17 char *buf, loff_t fpos, size_t count)
18 {
19 struct crashdd_dump_node *dump = bin_attr->private;
20
21 memcpy(buf, dump->buf + fpos, count);
22 return count;
23 }
24
25 static struct kobject *crashdd_mkdir(const char *name)
26 {
27 return kobject_create_and_add(name, crashdd_kobj);
28 }
29
30 static int crashdd_add_file(struct kobject *kobj, const char *name,
31 struct crashdd_dump_node *dump)
32 {
33 dump->bin_attr.attr.name = name;
34 dump->bin_attr.attr.mode = 0444;
35 dump->bin_attr.size = dump->size;
36 dump->bin_attr.read = crashdd_read;
37 dump->bin_attr.private = dump;
38
39 return sysfs_create_bin_file(kobj, &dump->bin_attr);
40 }
41
42 static void crashdd_rmdir(struct kobject *kobj)
43 {
44 kobject_put(kobj);
45 }
46
47 /**
48 * crashdd_init_driver - create a sysfs driver entry.
49 * @name: Name of the directory.
50 *
51 * Creates a directory under /sys/kernel/crashdd/ with @name. Allocates
52 * and saves the sysfs entry. The sysfs entry is added to the global
53 * list and then returned to the caller. On failure, returns NULL.
54 */
55 static struct crashdd_driver_node *crashdd_init_driver(const char *name)
56 {
57 struct crashdd_driver_node *node;
58
59 node = vzalloc(sizeof(*node));
60 if (!node)
61 return NULL;
62
63 /* Create a driver's directory under /sys/kernel/crashdd/ */
64 node->kobj = crashdd_mkdir(name);
65 if (!node->kobj) {
66 vfree(node);
67 return NULL;
68 }
69
70 atomic_set(&node->refcnt, 1);
71
72 /* Initialize the list of dumps that go under this driver's
73 * directory.
74 */
75 INIT_LIST_HEAD(&node->dump_list);
76
77 /* Add the driver's entry to global list */
78 mutex_lock(&crashdd_mutex);
79 list_add_tail(&node->list, &crashdd_list);
80 mutex_unlock(&crashdd_mutex);
81
82 return node;
83 }
84
85 /**
86 * crashdd_get_driver - get an exisiting sysfs driver entry.
87 * @name: Name of the directory.
88 *
89 * Searches and fetches a sysfs entry having @name. If @name is
90 * found, then the reference count is incremented and the entry
91 * is returned. If @name is not found, NULL is returned.
92 */
93 static struct crashdd_driver_node *crashdd_get_driver(const char *name)
94 {
95 struct crashdd_driver_node *node;
96 int found = 0;
97
98 /* Search for an existing driver sysfs entry having @name */
99 mutex_lock(&crashdd_mutex);
100 list_for_each_entry(node, &crashdd_list, list) {
> 101 if (!strcmp(node->kobj->name, name)) { 102 atomic_inc(&node->refcnt);
103 found = 1;
104 break;
105 }
106 }
107 mutex_unlock(&crashdd_mutex);
108
109 if (found)
110 return node;
111
112 /* No driver with @name found */
113 return NULL;
114 }
115
---
0-DAY kernel test infrastructure Open Source Technology Center
https://lists.01.org/pipermail/kbuild-all Intel Corporation
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
In reply to Rahul LakkireddyQuoted 8 lines · Sat, Mar 24, 2018 at 11:56:33AM CET, [email protected] wrote:
Add a new module crashdd that exports the
/sys/kernel/crashdd/directory in second kernel, containing collected hardware/firmware dumps.The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:
Quoted 7 lines
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with
This smells. I need to identify the exact ASIC instance that produced the dump. To identify by driver name does not help me if I have multiple instances of the same driver. This looks wrong to me. This looks like a job for devlink where you have 1 devlink instance per 1 ASIC instance.
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524
I bevieve that the solution in the patchset could be used for your usecase too.
Quoted 9 lines
requested size and invokes the device driver's registered callback function.
3. Device driver collects all hardware/firmware logs into the buffer and returns control back to crashdd.
4. Crashdd exposes the buffer as a binary file via /sys/kernel/crashdd/<driver>/<dump_file>.
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 22 lines · Jiri Pirko
Quoted 8 lines · Sat, Mar 24, 2018 at 11:56:33AM CET, rahul.lakkireddy-ut6Up61K2wZBDgjK7y7TUQ@pu…
Add a new module crashdd that exports the
/sys/kernel/crashdd/directory in second kernel, containing collected hardware/firmware dumps.The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:Quoted 7 lines
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with
This smells. I need to identify the exact ASIC instance that produced the dump. To identify by driver name does not help me if I have multiple instances of the same driver. This looks wrong to me. This looks like a job for devlink where you have 1 devlink instance per 1 ASIC instance.
Quoted 7 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
The sysfs approach proposed here had been dropped in favour exporting the dumps as ELF notes in /proc/vmcore.
Will be posting the new patches soon.
Quoted 9 lines
Quoted 9 lines
requested size and invokes the device driver's registered callback function.
3. Device driver collects all hardware/firmware logs into the buffer and returns control back to crashdd.
4. Crashdd exposes the buffer as a binary file via /sys/kernel/crashdd/<driver>/<dump_file>.
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 31 lines · Rahul Lakkireddy
Quoted 22 lines · Jiri Pirko
Quoted 8 lines · Sat, Mar 24, 2018 at 11:56:33AM CET, [email protected] wrote:
Add a new module crashdd that exports the
/sys/kernel/crashdd/directory in second kernel, containing collected hardware/firmware dumps.The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:Quoted 7 lines
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with
This smells. I need to identify the exact ASIC instance that produced the dump. To identify by driver name does not help me if I have multiple instances of the same driver. This looks wrong to me. This looks like a job for devlink where you have 1 devlink instance per 1 ASIC instance.
Quoted 7 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
Quoted 4 lines
The sysfs approach proposed here had been dropped in favour exporting the dumps as ELF notes in
/proc/vmcore.Will be posting the new patches soon.
The concern was actually how you identify which device that came from. Where you read the identifier changes but sysfs or /proc/vmcore the change remains valid.
Eric
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 33 lines · Fri, Mar 30, 2018 at 08:42:00PM CEST, [email protected] wrote:
Quoted 31 lines · Rahul Lakkireddy
Quoted 29 lines · Jiri Pirko
Quoted 8 lines · Sat, Mar 24, 2018 at 11:56:33AM CET, [email protected] wrote:
Add a new module crashdd that exports the
/sys/kernel/crashdd/directory in second kernel, containing collected hardware/firmware dumps.The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:Quoted 7 lines
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with
This smells. I need to identify the exact ASIC instance that produced the dump. To identify by driver name does not help me if I have multiple instances of the same driver. This looks wrong to me. This looks like a job for devlink where you have 1 devlink instance per 1 ASIC instance.
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
Quoted 8 lines
Quoted 4 lines
The sysfs approach proposed here had been dropped in favour exporting the dumps as ELF notes in
/proc/vmcore.Will be posting the new patches soon.
The concern was actually how you identify which device that came from. Where you read the identifier changes but sysfs or
/proc/vmcorethe change remains valid.
Yeah. I still don't see how you link the dump and the device. Rahul, did you look at the patchset I pointed out?
Thanks!
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 10 lines
Quoted 8 lines
Quoted 4 lines
The sysfs approach proposed here had been dropped in favour exporting the dumps as ELF notes in
/proc/vmcore.Will be posting the new patches soon.
The concern was actually how you identify which device that came from. Where you read the identifier changes but sysfs or
/proc/vmcorethe change remains valid.Yeah. I still don't see how you link the dump and the device.
Hi Jiri
You can see in the third version the core code accept a free form name. The driver builds a name using the driver name and the adaptor name.
What i think would be good is to try to have one API to the driver that can be used for both crash dumps and devlink snapshots. These are used at different times, but have basically the same purpose, get state from the device.
Andrew
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
In reply to Jiri PirkoQuoted 37 lines · Jiri Pirko
Quoted 36 lines · Fri, Mar 30, 2018 at 08:42:00PM CEST, [email protected] wrote:
Quoted 34 lines · Rahul Lakkireddy
Quoted 22 lines · Jiri Pirko
Quoted 8 lines · Sat, Mar 24, 2018 at 11:56:33AM CET, [email protected] wrote:
Add a new module crashdd that exports the
/sys/kernel/crashdd/directory in second kernel, containing collected hardware/firmware dumps.The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:Quoted 7 lines
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with
This smells. I need to identify the exact ASIC instance that produced the dump. To identify by driver name does not help me if I have multiple instances of the same driver. This looks wrong to me. This looks like a job for devlink where you have 1 devlink instance per 1 ASIC instance.
Quoted 7 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
The sysfs approach proposed here had been dropped in favour exporting the dumps as ELF notes in
/proc/vmcore.
Quoted 7 lines
Quoted 5 lines
Quoted 1 line
Will be posting the new patches soon.
The concern was actually how you identify which device that came from. Where you read the identifier changes but sysfs or
/proc/vmcorethe change remains valid.Yeah. I still don't see how you link the dump and the device.
In our case, the dump and the device are being identified by the driver’s name followed by its corresponding pci bus id. I’ve posted an example in my v3 series:
https://www.spinics.net/lists/netdev/msg493781.html
Here’s an extract from the link above:
# readelf -n /proc/vmcore
Displaying notes found at file offset 0x00001000 with length 0x04003288:
Owner Data size Description
VMCOREDD_cxgb4_0000:02:00.4 0x02000fd8 Unknown note type:(0x00000700)
VMCOREDD_cxgb4_0000:04:00.4 0x02000fd8 Unknown note type:(0x00000700)
CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) VMCOREINFO 0x0000074f Unknown note type: (0x00000000)
Here, for my two devices, the dump’s names are VMCOREDD_cxgb4_0000:02:00.4 and VMCOREDD_cxgb4_0000:04:00.4.
It’s really up to the callers to write their own unique name for the dump. The name is appended to “VMCOREDD_” string.
Quoted 1 line
Rahul, did you look at the patchset I pointed out?
For devlink, I think the dump name would be identified by bus_type/device_name; i.e. “pci/0000:02:00.4” for my example. Is my understanding correct?
Thanks,
Rahul
_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 73 lines · Mon, Apr 02, 2018 at 02:30:45PM CEST, [email protected] wrote:
Quoted 37 lines · Jiri Pirko
Quoted 36 lines · Fri, Mar 30, 2018 at 08:42:00PM CEST, [email protected] wrote:
Quoted 34 lines · Rahul Lakkireddy
Quoted 22 lines · Jiri Pirko
Quoted 8 lines · Sat, Mar 24, 2018 at 11:56:33AM CET, [email protected] wrote:
Add a new module crashdd that exports the
/sys/kernel/crashdd/directory in second kernel, containing collected hardware/firmware dumps.The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:Quoted 7 lines
1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with
This smells. I need to identify the exact ASIC instance that produced the dump. To identify by driver name does not help me if I have multiple instances of the same driver. This looks wrong to me. This looks like a job for devlink where you have 1 devlink instance per 1 ASIC instance.
Quoted 7 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
The sysfs approach proposed here had been dropped in favour exporting the dumps as ELF notes in
/proc/vmcore.Quoted 7 lines
Quoted 5 lines
Quoted 1 line
Will be posting the new patches soon.
The concern was actually how you identify which device that came from. Where you read the identifier changes but sysfs or
/proc/vmcorethe change remains valid.Yeah. I still don't see how you link the dump and the device.
In our case, the dump and the device are being identified by the driver’s name followed by its corresponding pci bus id. I’ve posted an example in my v3 series:
https://www.spinics.net/lists/netdev/msg493781.html
Here’s an extract from the link above:
# readelf -n /proc/vmcoreDisplaying notes found at file offset
0x00001000with length0x04003288:
Owner Data size Description
VMCOREDD_cxgb4_0000:02:00.40x02000fd8Unknown note type:(0x00000700)
VMCOREDD_cxgb4_0000:04:00.40x02000fd8Unknown note type:(0x00000700)CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) CORE 0x00000150 NT_PRSTATUS (prstatus structure) VMCOREINFO 0x0000074f Unknown note type: (0x00000000)Here, for my two devices, the dump’s names are VMCOREDD_cxgb4_0000:02:00.4 and VMCOREDD_cxgb4_0000:04:00.4.
Quoted 8 lines
It’s really up to the callers to write their own unique name for the dump. The name is appended to “VMCOREDD_” string.
Quoted 1 line
Rahul, did you look at the patchset I pointed out?
For devlink, I think the dump name would be identified by bus_type/device_name; i.e. “pci/0000:02:00.4” for my example. Is my understanding correct?
Yes.
Quoted 3 lines
Thanks,
Rahul
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
In reply to Jiri PirkoQuoted 5 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
Hi Jiri
https://lkml.org/lkml/2018/3/20/436
How well does this API work for a 2Gbyte snapshot?
Andrew
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 11 lines · Fri, Mar 30, 2018 at 05:11:29PM CEST, [email protected] wrote:
Quoted 5 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
Hi Jiri
https://lkml.org/lkml/2018/3/20/436
How well does this API work for a 2Gbyte snapshot?
Ccing Alex who did the tests.
Quoted 2 lines
Andrew
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 4 lines · Jiri Pirko
Quoted 3 lines · Fri, Mar 30, 2018 at 05:11:29PM CEST, [email protected] wrote:
Quoted 3 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524
Quoted 8 lines
Quoted 7 lines
Quoted 2 lines
I bevieve that the solution in the patchset could be used for your usecase too.
Hi Jiri
https://lkml.org/lkml/2018/3/20/436
How well does this API work for a 2Gbyte snapshot?
Ccing Alex who did the tests.
I didn't check the performance for such a large snapshot. From my measurement it takes 0.09s for 1 MB of data this means about ~3m.
This can be tuned and improved since this is a socket application.
Quoted 1 line
Quoted 1 line
Andrew
Re: [PATCH net-next v2 1/2] fs/crashdd: add API to collect hardware dump in second kernel
Quoted 11 lines · Alex Vesker
Quoted 8 lines · Jiri Pirko
Quoted 7 lines · Fri, Mar 30, 2018 at 05:11:29PM CEST, [email protected] wrote:
Quoted 5 lines
Please see:
http://patchwork.ozlabs.org/project/netdev/list/?series=36524I bevieve that the solution in the patchset could be used for your usecase too.
Hi Jiri
Quoted 8 lines
Quoted 4 lines
Quoted 3 lines
https://lkml.org/lkml/2018/3/20/436
How well does this API work for a 2Gbyte snapshot?
Ccing Alex who did the tests.
I didn't check the performance for such a large snapshot. From my measurement it takes 0.09s for 1 MB of data this means about ~3m.
I was not really thinking about performance. More about how well does the system work when you ask the kernel for 2GB of RAM to put a snapshot into? And given your current design, you need another 2GB buffer for the driver to use before calling this new API.
So i'm asking, how well does this API scale?
I think you need to remove the need for a second buffer in the driver. Either the driver allocates the buffer and hands it over, or your core code allocates the buffer and gives it to the driver to fill. Maybe look at what makes most sense for the crash dump code?
Andrew
PATCH v2 2/2 cxgb4: collect hardware dump in second kernel
In reply to Rahul LakkireddyRegister callback to collect hardware/firmware dumps in second kernel before hardware/firmware is initialized. The dumps for each device will be available under /sys/kernel/crashdd/cxgb4/ directory in second kernel.
---
v2:
- No Changes.
Changes since rfc v2:
- Update comments and commit message for sysfs change.
rfc v2:
- Updated dump registration to the new API in patch 1.
drivers/net/ethernet/chelsio/cxgb4/cxgb4.h | 4 ++++ drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.c | 25 ++++++++++++++++++++++++ drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.h | 3 +++ drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c | 12 ++++++++++++ 4 files changed, 44 insertions(+)
drivers/net/ethernet/chelsio/cxgb4/cxgb4.h +4 -0
@@ -50,6 +50,7 @@#include <linux/net_tstamp.h> #include <linux/ptp_clock_kernel.h> #include <linux/ptp_classify.h> +#include <linux/crashdd.h> #include <asm/io.h> #include "t4_chip_type.h" #include "cxgb4_uld.h"
@@ -964,6 +965,9 @@ struct adapter {struct hma_data hma;struct srq_data *srq; + +/* Dump buffer for collecting logs in kdump kernel */ +struct crashdd_data crashdd_buf; };/* Support for "sched-class" command to allow a TX Scheduling Class to be
drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.c +25 -0
@@ -488,3 +488,28 @@ void cxgb4_init_ethtool_dump(struct adapter *adapter) adapter->eth_dump.version = adapter->params.fw_vers; adapter->eth_dump.len =0 ; } + +static int cxgb4_cudbg_crashdd_collect (struct crashdd_data *data,void *buf) +{ + struct adapter *adap = container_of(data, struct adapter, crashdd_buf); +u32 len = data->size; + +return cxgb4_cudbg_collect (adap, buf, &len,CXGB4_ETH_DUMP_ALL ); +} + +int cxgb4_cudbg_crashdd_add_dump (struct adapter *adap) +{ +struct crashdd_data *data = &adap->crashdd_buf; +u32 len; + + len =sizeof (struct cudbg_hdr ) + +sizeof (struct cudbg_entity_hdr ) *CUDBG_MAX_ENTITY ; + len +=CUDBG_DUMP_BUFF_SIZE ; + + data->size = len; +snprintf (data->name,sizeof (data->name),"%s_%s" , cxgb4_driver_name, + adap->name); + data->crashdd_callback = cxgb4_cudbg_crashdd_collect; + +return crashdd_add_dump (cxgb4_driver_name, data); +}
drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.h +3 -0
@@ -41,8 +41,11 @@ enum CXGB4_ETHTOOL_DUMP_FLAGS { CXGB4_ETH_DUMP_HW = (1 << 1), /* various FW and HW dumps */ }; +#define CXGB4_ETH_DUMP_ALL (CXGB4_ETH_DUMP_MEM | CXGB4_ETH_DUMP_HW) +u32 cxgb4_get_dump_length (struct adapter *adap,u32 flag);int cxgb4_cudbg_collect (struct adapter *adap,void *buf,u32 *buf_size,u32 flag);void cxgb4_init_ethtool_dump (struct adapter *adapter); +int cxgb4_cudbg_crashdd_add_dump (struct adapter *adap);#endif /* __CXGB4_CUDBG_H__ */
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c +12 -0
@@ -5527,6 +5527,18 @@ static int init_one(struct pci_dev *pdev, const struct pci_device_id *ent)if (err) goto out_free_adapter; +if (is_kdump_kernel ()) { +/* Collect hardware state and append to +* /sys/kernel/crashdd/cxgb4/ directory +*/ + err =cxgb4_cudbg_crashdd_add_dump (adapter); +if (err) { +dev_warn (adapter->pdev_dev, +"Fail collecting crash device dump, err: %d. Continuing\n" , + err); + err =0 ; + } + }if (!is_t4 (adapter->params.chip)) { s_qpp = (QUEUESPERPAGEPF0_S +
Signature · 1 line
2.14.1
Re: [PATCH net-next v2 2/2] cxgb4: collect hardware dump in second kernel
Quoted 7 lines · Rahul Lakkireddy
Register callback to collect hardware/firmware dumps in second kernel before hardware/firmware is initialized. The dumps for each device will be available under
/sys/kernel/crashdd/cxgb4/directory in second kernel.Signed-off-by Rahul Lakkireddy <[email protected]>Signed-off-by Ganesh Goudar <[email protected]>
Thanks for adding generic documentation about the files in sysfs.
However, you don't add any specific documentation here about the cxgb4 crash dump. How am i supposed to interpret it? Does it follow any of the standard core dump formats? How do i use gdb with it? Are there some specific tools i should use to analyse it?
Thanks
Andrew
Re: [PATCH net-next v2 2/2] cxgb4: collect hardware dump in second kernel
In reply to Rahul LakkireddyQuoted 16 lines · Rahul Lakkireddy
Register callback to collect hardware/firmware dumps in second kernel before hardware/firmware is initialized. The dumps for each device will be available under
/sys/kernel/crashdd/cxgb4/directory in second kernel.Signed-off-by Rahul Lakkireddy <[email protected]>Signed-off-by Ganesh Goudar <[email protected]>---
v2:
- No Changes.Changes since rfc v2:
- Update comments and commit message for sysfs change.rfc v2:
- Updated dump registration to the new API in patch 1.
[...]
Quoted 11 lines
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c +3
-0@@ -5527,6 +5527,18 @@ static int init_one(struct pci_dev *pdev, const struct pci_device_id *ent)if (err) goto out_free_adapter; +if (is_kdump_kernel ()) { +/* Collect hardware state and append to +* /sys/kernel/crashdd/cxgb4/ directory
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c static int init_one(struct pci_dev *pdev, const struct pci_device_id *ent) · line 5542
Quoted 10 lines
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c +9
-0+*/ + err =cxgb4_cudbg_crashdd_add_dump (adapter); +if (err) { +dev_warn (adapter->pdev_dev, +"Fail collecting crash device dump, err: %d. Continuing\n" , + err); + err =0 ; + } + }
The problem I see with this approach is that you require that the driver is built into the kdump kernel (or present as a module in the kdump initramfs), and that you will probe the device during the collection of the dumps.
IMHO, if you are going to require the device to be probed by the same driver during kdump, you might just as well use the device object itself to present the crash data. I think that's what Stephen Hemminger meant when he said to use sysfs. No need at all for any special crashdd. Just add an attribute or attribute group to the device object.
Otherwise, as Eric Biederman pointed out, you should just add that data into the vmcore before you kexec, so you don't even need to look at a different file, and the driver does not even need to be present in the kdump kernel.
Cascardo.
Quoted 4 lines
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c +0
-0if (!is_t4 (adapter->params.chip)) { s_qpp = (QUEUESPERPAGEPF0_S +Signature · 1 line
2.14.1
Re: [PATCH net-next v2 2/2] cxgb4: collect hardware dump in second kernel
Quoted 36 lines · Thadeu Lima de Souza Cascardo
Quoted 16 lines · Rahul Lakkireddy
Register callback to collect hardware/firmware dumps in second kernel before hardware/firmware is initialized. The dumps for each device will be available under
/sys/kernel/crashdd/cxgb4/directory in second kernel.Signed-off-by Rahul Lakkireddy <[email protected]>Signed-off-by Ganesh Goudar <[email protected]>---
v2:
- No Changes.Changes since rfc v2:
- Update comments and commit message for sysfs change.rfc v2:
- Updated dump registration to the new API in patch 1.[...]
Quoted 18 lines
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c +10
-0@@ -5527,6 +5527,18 @@ static int init_one(struct pci_dev *pdev, const struct pci_device_id *ent)if (err) goto out_free_adapter; +if (is_kdump_kernel ()) { +/* Collect hardware state and append to +* /sys/kernel/crashdd/cxgb4/ directory +*/ + err =cxgb4_cudbg_crashdd_add_dump (adapter); +if (err) { +dev_warn (adapter->pdev_dev, +"Fail collecting crash device dump, err: %d. Continuing\n" , + err); + err =0 ;
Quoted 8 lines
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c static int init_one(struct pci_dev *pdev, const struct pci_device_id *ent) · line 5542
Quoted 3 lines
drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c +2
-0+ } + }The problem I see with this approach is that you require that the driver is built into the kdump kernel (or present as a module in the kdump initramfs), and that you will probe the device during the collection of the dumps.
Compared to doing something in a crashing kernel anything in the kdump kernel is a walk in the park. Nothing is trustable in a crashing kernel.
Quoted 5 lines
IMHO, if you are going to require the device to be probed by the same driver during kdump, you might just as well use the device object itself to present the crash data. I think that's what Stephen Hemminger meant when he said to use sysfs. No need at all for any special crashdd. Just add an attribute or attribute group to the device object.
Doing something with the device model might make sense. I am not certain it does. It is quite possible the device is in such a weird state that the device driver fails to initialize. That doesn't mean the device driver can't scrape the registers and present meaningful information to the rest of the system.
Whatever you do with capturing the state needs to happen early before the driver initializes and stomps on the relevant state.
I don't expect there is much for the driver model to do, unless we wish to do something explicitly before the normal device probe methods happen. What we need is the infrastructure for catching what gets read from the driver and placing it in the core dump.
Quoted 4 lines
Otherwise, as Eric Biederman pointed out, you should just add that data into the vmcore before you kexec, so you don't even need to look at a different file, and the driver does not even need to be present in the kdump kernel.
No. I do mean before a kexec on panic happens. Doing anything with gathering this kind of information before kexec on panic is a very very very very bad idea that will almost certainly make crash dumps less reliable. Don't even think about doing extra work on the crash dump path. Not ever. No. No. No. No.
The reason we use kexec on panic instead just creating a core dump in the kernel is that many have tried and no one has gotten the kernel to create crash dumps when things go wrong and it matters. Meanwhile kexec on panic works more often than not.
I mean that /proc/vmcore is a device that is used to gather up the bits of the crashing kernel and to present it in a format that is easy to read/save. The tools read /proc/vmcore.
The driver or whatever is gathering this information absolutely needs to be in the kdump kernel.
Eric
Quoted 14 lines · Rahul Lakkireddy
On production servers running variety of workloads over time, kernel panic can happen sporadically after days or even months. It is important to collect as much debug logs as possible to root cause and fix the problem, that may not be easy to reproduce. Snapshot of underlying hardware/firmware state (like register dump, firmware logs, adapter memory, etc.), at the time of kernel panic will be very helpful while debugging the culprit device driver.
This series of patches add new generic framework that enable device drivers to collect device specific snapshot of the hardware/firmware state of the underlying device in the crash recovery kernel. In crash recovery kernel, the collected logs are exposed via
/sys/kernel/crashdd/directory, which is copied by user space scripts for post-analysis.
Quoted 3 lines
A kernel module crashdd is newly added. In crash recovery kernel, crashdd exposes
/sys/kernel/crashdd/directory containing device specific hardware/firmware logs.
Have you looked at instead of adding a sysfs file adding the dumps as additional elf notes in /proc/vmcore?
That should allow existing tools to capture your extended dump information with no code changes, and it will allow having a single file core dump for storing the information.
Both of which should mean something that will integrate better into existing flows.
The interface logic of the driver should be essentially the same.
Also have you tested this and seen how well your current logic captures the device information?
Quoted 87 lines
The sequence of actions done by device drivers to append their device specific hardware/firmware logs to
/sys/kernel/crashdd/directory are as follows:1. During probe (before hardware is initialized), device drivers register to the crashdd module (via
crashdd_add_dump()), with callback function, along with buffer size and log name needed forfirmware/hardwarelog collection.2. Crashdd creates a driver's directory under /sys/kernel/crashdd/<driver>. Then, it allocates the buffer with requested size and invokes the device driver's registered callback function.
3. Device driver collects all hardware/firmware logs into the buffer and returns control back to crashdd.
4. Crashdd exposes the buffer as a file via
/sys/kernel/crashdd/<driver>/<dump_file>.5. User space script (
/usr/lib/kdump/kdump-lib-initramfs.sh) copies the entire/sys/kernel/crashdd/directory to/var/crash/directory.Patch 1 adds crashdd module to allow drivers to register callback to collect the device specific hardware/firmware logs. The module also exports
/sys/kernel/crashdd/directory containing the hardware/firmware logs.Patch 2 shows a cxgb4 driver example using the API to collect hardware/firmware logs in crash recovery kernel, before hardware is initialized. The logs for the devices are made available under
/sys/kernel/crashdd/cxgb4/directory.Thanks,
RahulRFC v1: https://lkml.org/lkml/2018/3/2/542
RFC v2: https://lkml.org/lkml/2018/3/16/326---
v2:
- Added ABI Documentation for crashdd.
- Directly use octal permission instead of macro.Changes since rfc v2:
- Moved exporting crashdd from procfs to sysfs. Suggested by Stephen Hemminger <[email protected]>
- Moved code fromfs/proc/crashdd.ctofs/crashdd/directory.
- Replaced all proc API with sysfs API and updated comments.
- Calling driver callback before creating the binary file under crashdd sysfs.
- Changed binary dump file permission fromS_IRUSRtoS_IRUGO.
- Changed module name fromCRASH_DRIVER_DUMPtoCRASH_DEVICE_DUMP.rfc v2:
- Collecting logs in 2nd kernel instead of during kernel panic. Suggested by Eric Biederman <[email protected]>.
- Added new crashdd module that exports/proc/crashdd/containing driver's registered hardware/firmware logs in patch 1.
- Replaced the API to allow drivers to register their hardware/firmware log collect routine in crash recovery kernel in patch 1.
- Updated patch 2 to use the new API in patch 1.Rahul Lakkireddy (2):
fs/crashdd: add API to collect hardware dump in second kernel
cxgb4: collect hardware dump in second kernelDocumentation/ABI/testing/sysfs-kernel-crashdd | 34 ++++ drivers/net/ethernet/chelsio/cxgb4/cxgb4.h | 4 + drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.c | 25 +++ drivers/net/ethernet/chelsio/cxgb4/cxgb4_cudbg.h | 3 + drivers/net/ethernet/chelsio/cxgb4/cxgb4_main.c | 12 ++ fs/Kconfig | 1 + fs/Makefile | 1 + fs/crashdd/Kconfig | 10 + fs/crashdd/Makefile | 3 + fs/crashdd/crashdd.c | 233 +++++++++++++++++++++++ fs/crashdd/crashdd_internal.h | 24 +++ include/linux/crashdd.h | 24 +++ 12 files changed, 374 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-kernel-crashdd create mode 100644 fs/crashdd/Kconfig create mode 100644 fs/crashdd/Makefile create mode 100644 fs/crashdd/crashdd.c create mode 100644 fs/crashdd/crashdd_internal.h create mode 100644 include/linux/crashdd.h
Quoted 17 lines · Eric W. Biederman
Quoted 14 lines · Rahul Lakkireddy
On production servers running variety of workloads over time, kernel panic can happen sporadically after days or even months. It is important to collect as much debug logs as possible to root cause and fix the problem, that may not be easy to reproduce. Snapshot of underlying hardware/firmware state (like register dump, firmware logs, adapter memory, etc.), at the time of kernel panic will be very helpful while debugging the culprit device driver.
This series of patches add new generic framework that enable device drivers to collect device specific snapshot of the hardware/firmware state of the underlying device in the crash recovery kernel. In crash recovery kernel, the collected logs are exposed via
/sys/kernel/crashdd/directory, which is copied by user space scripts for post-analysis.
Quoted 7 lines
Quoted 3 lines
A kernel module crashdd is newly added. In crash recovery kernel, crashdd exposes
/sys/kernel/crashdd/directory containing device specific hardware/firmware logs.Have you looked at instead of adding a sysfs file adding the dumps as additional elf notes in
/proc/vmcore?
I see the crash recovery kernel's memory is not present in any of the the PT_LOAD headers. So, makedumpfile is not collecting the dumps that are in crash recovery kernel's memory.
Also, are you suggesting exporting the dumps themselves as PT_NOTE instead? I'll look into doing it this way.
Quoted 4 lines
That should allow existing tools to capture your extended dump information with no code changes, and it will allow having a single file core dump for storing the information.
Quoted 9 lines
Both of which should mean something that will integrate better into existing flows.
The interface logic of the driver should be essentially the same.
Also have you tested this and seen how well your current logic captures the device information?
Yes, the hardware snapshot is pretty close to the state during kernel panic. It is better than risking not being able to collect anything at all during kernel panic.
Thanks,
Rahul
Quoted 26 lines · Rahul Lakkireddy
Quoted 17 lines · Eric W. Biederman
Quoted 14 lines · Rahul Lakkireddy
On production servers running variety of workloads over time, kernel panic can happen sporadically after days or even months. It is important to collect as much debug logs as possible to root cause and fix the problem, that may not be easy to reproduce. Snapshot of underlying hardware/firmware state (like register dump, firmware logs, adapter memory, etc.), at the time of kernel panic will be very helpful while debugging the culprit device driver.
This series of patches add new generic framework that enable device drivers to collect device specific snapshot of the hardware/firmware state of the underlying device in the crash recovery kernel. In crash recovery kernel, the collected logs are exposed via
/sys/kernel/crashdd/directory, which is copied by user space scripts for post-analysis.Quoted 7 lines
Quoted 3 lines
A kernel module crashdd is newly added. In crash recovery kernel, crashdd exposes
/sys/kernel/crashdd/directory containing device specific hardware/firmware logs.Have you looked at instead of adding a sysfs file adding the dumps as additional elf notes in
/proc/vmcore?
Quoted 6 lines
I see the crash recovery kernel's memory is not present in any of the the
PT_LOADheaders. So, makedumpfile is not collecting the dumps that are in crash recovery kernel's memory.Also, are you suggesting exporting the dumps themselves as
PT_NOTEinstead? I'll look into doing it this way.
Yes. I was suggesting exporting the dumps themselves as PT_NOTE in /proc/vmcore. I think that will allow makedumpfile to collect your new information without modification.
Eric
Quoted 32 lines · Eric W. Biederman
Quoted 30 lines · Rahul Lakkireddy
Quoted 17 lines · Eric W. Biederman
Quoted 14 lines · Rahul Lakkireddy
On production servers running variety of workloads over time, kernel panic can happen sporadically after days or even months. It is important to collect as much debug logs as possible to root cause and fix the problem, that may not be easy to reproduce. Snapshot of underlying hardware/firmware state (like register dump, firmware logs, adapter memory, etc.), at the time of kernel panic will be very helpful while debugging the culprit device driver.
This series of patches add new generic framework that enable device drivers to collect device specific snapshot of the hardware/firmware state of the underlying device in the crash recovery kernel. In crash recovery kernel, the collected logs are exposed via
/sys/kernel/crashdd/directory, which is copied by user space scripts for post-analysis.Quoted 7 lines
Quoted 3 lines
A kernel module crashdd is newly added. In crash recovery kernel, crashdd exposes
/sys/kernel/crashdd/directory containing device specific hardware/firmware logs.Have you looked at instead of adding a sysfs file adding the dumps as additional elf notes in
/proc/vmcore?I see the crash recovery kernel's memory is not present in any of the the
PT_LOADheaders. So, makedumpfile is not collecting the dumps that are in crash recovery kernel's memory.
Quoted 7 lines
Quoted 2 lines
Also, are you suggesting exporting the dumps themselves as
PT_NOTEinstead? I'll look into doing it this way.Yes. I was suggesting exporting the dumps themselves as
PT_NOTEin/proc/vmcore. I think that will allow makedumpfile to collect your new information without modification.
If I export the dumps themselves as PT_NOTE in /proc/vmcore, can the crash tool work without modification; i.e can crash tool extract these notes?
Thanks,
Rahul
Quoted 36 lines · Rahul Lakkireddy
Quoted 35 lines · Eric W. Biederman
Quoted 32 lines · Rahul Lakkireddy
Quoted 17 lines · Eric W. Biederman
Quoted 14 lines · Rahul Lakkireddy
On production servers running variety of workloads over time, kernel panic can happen sporadically after days or even months. It is important to collect as much debug logs as possible to root cause and fix the problem, that may not be easy to reproduce. Snapshot of underlying hardware/firmware state (like register dump, firmware logs, adapter memory, etc.), at the time of kernel panic will be very helpful while debugging the culprit device driver.
This series of patches add new generic framework that enable device drivers to collect device specific snapshot of the hardware/firmware state of the underlying device in the crash recovery kernel. In crash recovery kernel, the collected logs are exposed via
/sys/kernel/crashdd/directory, which is copied by user space scripts for post-analysis.Quoted 7 lines
Quoted 3 lines
A kernel module crashdd is newly added. In crash recovery kernel, crashdd exposes
/sys/kernel/crashdd/directory containing device specific hardware/firmware logs.Have you looked at instead of adding a sysfs file adding the dumps as additional elf notes in
/proc/vmcore?I see the crash recovery kernel's memory is not present in any of the the
PT_LOADheaders. So, makedumpfile is not collecting the dumps that are in crash recovery kernel's memory.Also, are you suggesting exporting the dumps themselves as
PT_NOTEinstead? I'll look into doing it this way.
Quoted 8 lines
Quoted 4 lines
Yes. I was suggesting exporting the dumps themselves as
PT_NOTEin/proc/vmcore. I think that will allow makedumpfile to collect your new information without modification.If I export the dumps themselves as
PT_NOTEin/proc/vmcore, can the crash tool work without modification; i.e can crash tool extract these notes?
I believe crash would need to be taught about these notes. This is
something new.
However "readelf -a random_elf_file" does display elf notes, and elf notes in general are not hard to extract.
What I expect from an enconding in ELF core dump format is a way to captuer the data, a way to encode the data, and a way to transport the data to the people who care. Analysis tools are easy enough after the fact.
Eric