https://github.com/wujingcheng7/zombiehunter
Find wild pointer / dangling pointer / zombie object in iOS; 发现 iOS 的野指针/悬垂指针/僵尸对象
https://github.com/wujingcheng7/zombiehunter
cocoapod dangling-pointers ios objective-c pod zombie
Last synced: 2 months ago
JSON representation
Find wild pointer / dangling pointer / zombie object in iOS; 发现 iOS 的野指针/悬垂指针/僵尸对象
- Host: GitHub
- URL: https://github.com/wujingcheng7/zombiehunter
- Owner: wujingcheng7
- License: mit
- Created: 2025-07-09T11:03:16.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-08-01T03:28:19.000Z (11 months ago)
- Last Synced: 2025-08-01T03:49:33.418Z (11 months ago)
- Topics: cocoapod, dangling-pointers, ios, objective-c, pod, zombie
- Language: C
- Homepage:
- Size: 67.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZombieHunter
| Helps detect wild pointers/zombie objects/dangling references in iOS projects early, supports OC/C
## [中文介绍](README_CN.md)
## Features
### Objective-C Objects
- Expose OC zombie objects early
- Provide detailed information when exposed:
- Class name
- Method name
- Object address
- Stack trace when object was deallocated
- Stack trace when object was called
- Offers 4 monitoring strategies:
- Monitor all objects (with mandatory class filtering) (default strategy)
- Monitor only custom objects
- Use blacklist
- Use whitelist
- Configurable maximum memory usage (default: 10MB)
- Configurable whether to record deallocation stack (default: YES)
- Configurable whether to crash when zombie is detected (default: YES)
- Can use Symbolicating.py file to symbolize stack traces
### C Pointers
- Expose wild pointers early
- Configurable maximum memory usage (default: 10MB)
## Usage
### Podfile Code
```ruby
pod 'ZombieHunter'
# If you only want to use in Debug mode:
# pod 'ZombieHunter', :configurations => ['Debug', 'Inhouse', 'Dev']
```
### Starting and Stopping Monitoring
```Objective-C
@import ZombieHunter; // import pod
- (void)whenEverYourWantToStartMonitorZombie {
// Create default config with separate settings for cConfig and ocConfig
WJCZombieHunterConfig *config = [WJCZombieHunterConfig new];
// Custom NSObject wild pointer settings
config.ocConfig.shouldWork = YES; // Whether to detect NSObject objects
config.ocConfig.crashWhenDetectedZombie = YES; // Whether to crash immediately when wild pointer is detected
config.ocConfig.detectStrategy = WJCZombieOCDetectStrategyAll; // Custom monitoring strategy
config.ocConfig.traceDeallocStack = YES; // Whether to record call stack when object is first deallocated
config.ocConfig.whiteList = nil; // Custom whitelist (requires config.ocConfig.detectStrategy = .whitelist)
config.ocConfig.blackList = nil; // Custom blacklist (requires config.ocConfig.detectStrategy = .blacklist)
config.ocConfig.filterList = nil; // Custom filter list
config.ocConfig.maxOccupyMemorySizeBytes = 50 * 1024 * 1024; // Custom max memory cache
config.ocConfig.handler = ^(WJCZombieInfo * _Nonnull zombieInfo) {
// First, zombieInfo provides comprehensive details. You can customize how to use this information
// Additionally, zombieInfo offers a jsonFileText string for detailed diagnostics. Usage:
// Step 1: Save jsonFileText string as xxx.json file
// Step 2: Obtain dsym.zip file
// Step 3: Execute: python3 symbolicate_zombie.py {json_path} {dsym_zip_path} {output_dir}
// Step 4: Read the .log files in {output_dir}
};
// Custom C wild pointer settings (completely independent from NSObject settings)
config.cConfig.shouldWork = YES; // Whether to detect C wild pointers
config.cConfig.crashWhenDetectedZombie; // Always YES. Set config.cConfig.shouldWork = NO if you don't want immediate crash
config.cConfig.maxStealMemorySizeBytes = 50 * 1024 * 1024; // Custom max memory cache
[WJCZombieHunter startWorkWithConfig:config]; // Start monitoring
}
- (void)whenEverYourWantToStopMonitorZombie {
[WJCZombieHunter stopWork]; // Stop monitoring
}
- (void)testZombieWithAccidentalCoverage {
/*
If ZombieHunter OC monitoring is NOT enabled:
Output: [ZombieHunter]-accidentalCoverage[YES]-correct[19450815]-result[19310918]❌
This indicates your program isn't crashing yet, but producing uncontrolled incorrect results
If ZombieHunter OC monitoring is enabled:
The ocConfig.handler will provide detailed information, allowing you to take any desired action
(e.g., upload logs/force quit the app/etc.)
*/
[WJCZombieTest testOCZombieWithAccidentalCoverage:YES];
}
- (void)testZombieWithoutAccidentalCoverage {
/*
If ZombieHunter OC monitoring is NOT enabled:
Immediate crash: Thread 1: EXC_BAD_ACCESS
If ZombieHunter OC monitoring is enabled:
The ocConfig.handler will provide detailed information, allowing you to take any desired action
(e.g., upload logs/prevent immediate crash/etc.)
*/
[WJCZombieTest testOCZombieWithAccidentalCoverage:NO];
}
```
### Code Notes
```Objective-C
// Please only use classes and methods with WJC prefix, do not use other classes/methods directly
```
### How to Symbolize zombieInfo
```Objective-C
[WJCZombieTest testOCZombieWithAccidentalCoverage:YES]; // Execute this method after monitoring is enabled for testing
```
#### Step 1: Save JSON File
Save the zombieInfo.jsonFileText string as an xxx.json file
#### Step 2: Obtain dsym.zip File
Acquire the dsym.zip file
#### Step 3: Execute symbolicate_zombie.py
python3 symbolicate_zombie.py
#### Step 4: Obtain zombie.log File (Example)
```log
ClassName: UIView
ZombieObjectAddress: 0x1259588c0
SelectorName: tag
ZombieStack:
tid: 259
[0] 0x00000001891de338 -> CoreFoundation + 0x21338
[1] 0x00000001891de1b0 -> CoreFoundation + 0x211b0
[2] 0x00000001018082dc -> +[WJCZombieTest testOCZombieWithAccidentalCoverage:] (in Demo) (WJCZombieTest.m:39)
...
DeallocStack:
tid: 259
[0] 0x00000001018072a4 -> -[NSObject(DDZombieDetector) hy_newDealloc] (in Demo) (NSObject+DDZombieDetector.m:20)
[1] 0x000000018ba5c21c -> UIKitCore + 0xd421c
[2] 0x000000018ba5c114 -> UIKitCore + 0xd4114
[3] 0x0000000101808248 -> +[WJCZombieTest testOCZombieWithAccidentalCoverage:] (in Demo) (WJCZombieTest.m:25)
...
```
## Contributions
### Contribution Summary
- Core code for OC zombie objects comes from AlexTing0's open source library
- Core concept for C wild pointers comes from TencentBuglyTeam/Chen Qifeng's technical articles
- C wild pointer code depends on Facebook's fishhook (using latest code due to bug in fishhook 0.2)
- Current fishhook version: aadc161ac3b80db07a9908851839a17ba63a9eb1
- wujingcheng7 integrated these components:
- Created pod version for easy integration and direct use
### Contribution Links
- AlexTing0
- homepage:
- article:
- repo:
- TencentBuglyTeam/Chen Qifeng
- homepage:
- article1:
- article2:
- article3:
- FacebookTeam
- homepage:
- repo:
- repoVersion: aadc161ac3b80db07a9908851839a17ba63a9eb1
## License
ZombieHunter uses MIT license, free to use