https://github.com/quic/crash-plugins
The plugins of crash-utility
https://github.com/quic/crash-plugins
binder coredump crash-utility dts kernel logcat memory property ramdump slub vmcore
Last synced: 3 months ago
JSON representation
The plugins of crash-utility
- Host: GitHub
- URL: https://github.com/quic/crash-plugins
- Owner: quic
- License: gpl-2.0
- Created: 2024-11-19T05:55:21.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-02T02:15:40.000Z (3 months ago)
- Last Synced: 2025-07-02T03:25:04.496Z (3 months ago)
- Topics: binder, coredump, crash-utility, dts, kernel, logcat, memory, property, ramdump, slub, vmcore
- Language: C++
- Homepage: https://github.com/quic/crash-plugins
- Size: 861 KB
- Stars: 31
- Watchers: 1
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
# Overall
We've developed plugins based on crash-utility that can collect more information, covering both kernel space and user space. This improves our debugging efficiency.
# How to start
```
sudo apt-get install cmake // cmake >= 3.21.1
```
```
sudo dpkg --add-architecture i386
```
```
sudo apt-get update
```
```
sudo apt install gcc-multilib g++-multilib libzstd-dev libzstd-dev:i386 libelf-dev libelf-dev:i386 pkg-config
```
# How to build
We can compile each plugin into a separate SO library or we can compile all plugins together.You can choose how to compile by configuring the macro BUILD_TARGET_TOGETHER in build.sh.
## single-module (by defalut)
```
cmake -DCMAKE_C_COMPILER="/usr/bin/gcc" \
-DCMAKE_CXX_COMPILER="/usr/bin/g++" \
-DCMAKE_BUILD_TYPE="Debug" \
-DCMAKE_BUILD_TARGET_ARCH="arm64" \
-DBUILD_TARGET_TOGETHER="1" \
CMakeLists.txt \
-B output/arm64
```
## multi-module
```
cmake -DCMAKE_C_COMPILER="/usr/bin/gcc" \
-DCMAKE_CXX_COMPILER="/usr/bin/g++" \
-DCMAKE_BUILD_TYPE="Debug" \
-DCMAKE_BUILD_TARGET_ARCH="arm64" \
CMakeLists.txt \
-B output/arm64
```
## Build
```
$ ./build.sh
```
# How to use
To load the module's commands to a running crash-8.0.6+ session, enter:
```
crash> extend /output/arm64/plugins.so or extend /output/arm64/${module}.so
```
Support module:
| module | arm64 | arm | comment |
| -------- | -------- | -------- | -------- |
| binder | √ | √ | parser binder log/node/ref/thread/proc/buffer info |
| slub info | √ | √ | parser slub detail memory info |
| slub poison | √ | √ | check slub object memory poison |
| slub trace | √ | √ | parser slub object trace |
| procrank | √ | √ | parser vss/rss/pss/uss of process |
| cma | √ | √ | parser cma info |
| device tree | √ | √ | parser device tree |
| memblock | √ | √ | parser memblock info |
| device driver | √ | √ | parser device driver/char/block device |
| dmabuf | √ | √ | parser dma-buf info |
| workqueue | √ | √ | parser workqueue info |
| reserved mem | √ | √ | parser reserved memory info |
| iomem | √ | √ | parser memory layout info |
| vmalloc | √ | √ | parser vmalloc info |
| partition | √ | √ | parser partition info |
| pageowner | √ | √ | parser pageowner info |
| buddy | √ | √ | parser memory node/zone/buddy info |
| zram | √ | √ | parser zram detail info |
| swap | √ | √ | parser swap info and provider API to userspace parser|
| rtb | √ | √ | parser rtb log |
| cpu | √ | √ | parser cpu freq and policy info |
| coredump | √ | √ | dump the coredump info |
| thermal | √ | √ | parser all thermal zone temperature info |
| meminfo | √ | √ | parser meminfo |
| watchdog | √ | √ | parser watchdog info |
| pagecache | √ | √ | parser pagecache for every file |
| debugimage | √ | √ | parser debug image info |
| ipc log | √ | √ | parser ipc log |
| regulator | √ | √ | parser regulator info |
| icc | √ | √ | parser icc info |
| clock | √ | √ | parser clock info |
| pstore | √ | √ | parser pstore log |
| boot | √ | √ | parser pmic and boot log |
| socinfo | √ | √ | parser socinfo and commandline |
| sched | √ | √ | parser task sched info |
| module | Android-11.0(30) | >Android-12.0(31) | comment |
| -------- | ------------------- | ------------------- | ------------------- |
| property | √ | √ | parser property info |
| logcat | √ | √ | parser logcat log |
| surfaceflinger| √ | √ | parser the layer info |
## usage
See [USAGE.md](USAGE.md)
```
crash> help binder
NAME
binder - dump binder log information
SYNOPSIS
binder -a
binder -p [pid]
binder -l
binder -f
binder -n
binder -b
binder -t
binder -r
DESCRIPTION
This command dumps the binder log information of a specified process.
-p pid argument.
EXAMPLES
Display all binder proc states:
crash> binder -a
proc 7312
context hwbinder
thread 7335: l 00 need_return 0 tr 0
Display specific process binder states:
crash> binder -p 7312
proc 7312
context hwbinder
thread 7335: l 00 need_return 0 tr 0
```
```
crash> binder -r
binder_proc:0xffffff801a432c00 ndroid.contacts [4346] binder dead:0 frozen:0 sr:0 ar:0 max:15 total:6 requested:0 started:2 ready:3
binder_ref:0xffffff806c9b0c00 id:117829 desc:7 s:1 w:1 death:0x0 -> node_id:6183 binder_proc:0xffffff80195ed000 system_server[1047]
binder_ref:0xffffff806883a180 id:117825 desc:3 s:1 w:1 death:0x0 -> node_id:4022 binder_proc:0xffffff80195ed000 system_server[1047]
binder_ref:0xffffff8067788000 id:117799 desc:1 s:1 w:1 death:0x0 -> node_id:5525 binder_proc:0xffffff80195ed000 system_server[1047]
binder_ref:0xffffff805a317000 id:117762 desc:0 s:1 w:1 death:0x0 -> node_id:1 binder_proc:0xffffff801de62800 servicemanager[446]
binder_ref:0xffffff806883ad00 id:117824 desc:2 s:1 w:1 death:0x0 -> node_id:4413 binder_proc:0xffffff80195ed000 system_server[1047]
binder_ref:0xffffff8046048400 id:117827 desc:5 s:1 w:1 death:0x0 -> node_id:8305 binder_proc:0xffffff80195ed000 system_server[1047]
binder_ref:0xffffff8066a2b700 id:117826 desc:4 s:1 w:1 death:0x0 -> node_id:5906 binder_proc:0xffffff80195ed000 system_server[1047]
```
# How to develop
1. Add the header file: demo.h
```
/**
* Copyright (c) 2024-2025 Qualcomm Innovation Center, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 and
* only version 2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* SPDX-License-Identifier: GPL-2.0-only
*/
#ifndef DEMO_DEFS_H_
#define DEMO_DEFS_H_
#include "plugin.h"
class Demo: public ParserPlugin {
public:
Demo();
void cmd_main(void) override;
DEFINE_PLUGIN_INSTANCE(Demo)
};
#endif // DEMO_DEFS_H_
```
2. Add the Demo.cpp file
```
/**
* Copyright (c) 2024-2025 Qualcomm Innovation Center, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 and
* only version 2 as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* SPDX-License-Identifier: GPL-2.0-only
*/
#include "demo.h"
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wpointer-arith"
#ifndef BUILD_TARGET_TOGETHER
DEFINE_PLUGIN_COMMAND(Demo)
#endif
void Demo::cmd_main(void) {
int c;
if (argcnt < 2) cmd_usage(pc->curcmd, SYNOPSIS);
while ((c = getopt(argcnt, args, "a")) != EOF) {
switch(c) {
case 'a':
do_somethings();
break;
default:
argerrs++;
break;
}
}
if (argerrs)
cmd_usage(pc->curcmd, SYNOPSIS);
}
Demo::Demo(){
cmd_name = "demo";
help_str_list={
"demo", /* command name */
"your description", /* short description */
};
initialize();
}
#pragma GCC diagnostic pop
```
3. Add the build rule in CMakeLists.txt, it will output the demo.so, now you can use it.
```
add_library(demo SHARED
${PLUGIN_SOURCES}
demo.cpp)
set_target_properties(demo PROPERTIES PREFIX "")
```
4. if you want to add the module to single-module. please follow the steps in plugins.cpp
- include your header file
```
#include "demo.h"
```
- Add the shared_ptr
```
std::shared_ptr Demo::instance = nullptr;
```
- register your module in function plugin_init
```
{ &Demo::instance->cmd_name[0], &Demo::wrapper_func, Demo::instance->cmd_help, 0 },
```
- Destory your module in function plugin_fini
```
Demo::instance.reset();
```
- Add the build rule in CMakeLists.txt
```
list(APPEND PLUGIN_SOURCES
...
demo.cpp)
```
# Tested Kernels
- 5.4 to 6.6
# Related Links
- https://github.com/quic/crash-plugins.git
- https://crash-utility.github.io/
# Author
- quic_wya@quicinc.com
# License
- This project is licensed under the [GPL v2 License](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). See [LICENSE.txt](LICENSE.txt) for the full license text.