Files
Brandyn / Techy fcc1b09210 init
2026-04-04 15:40:51 -05:00

152 lines
7.3 KiB
Objective-C

/*
* Author: Mike Ash <mikeash@plausiblelabs.com>
*
* Copyright (c) 2012-2013 Plausible Labs Cooperative, Inc.
* All rights reserved.
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use,
* copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following
* conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
* OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*/
#import "SenTestCompat.h"
#import <dlfcn.h>
#import <mach-o/dyld.h>
#import <mach-o/getsect.h>
#import "PLCrashAsyncMachOImage.h"
#import "PLCrashAsyncSymbolication.h"
@interface PLCrashAsyncSymbolicationTests : SenTestCase {
/** The image containing our class. */
plcrash_async_macho_t _image;
}
@end
@implementation PLCrashAsyncSymbolicationTests
- (void) setUp {
/* Fetch our containing image's dyld info */
Dl_info info;
STAssertTrue(dladdr((__bridge void *)([self class]), &info) > 0, @"Could not fetch dyld info for %p", [self class]);
/* Look up the vmaddr slide for our image */
pl_vm_off_t vmaddr_slide = 0;
bool found_image = false;
for (uint32_t i = 0; i < _dyld_image_count(); i++) {
if (_dyld_get_image_header(i) == info.dli_fbase) {
vmaddr_slide = _dyld_get_image_vmaddr_slide(i);
found_image = true;
break;
}
}
STAssertTrue(found_image, @"Could not find dyld image record");
plcrash_nasync_macho_init(&_image, mach_task_self(), info.dli_fname, (pl_vm_address_t) info.dli_fbase);
/* Basic test of the initializer */
STAssertEqualCStrings(_image.name, info.dli_fname, @"Incorrect name");
STAssertEquals(_image.header_addr, (pl_vm_address_t) info.dli_fbase, @"Incorrect header address");
STAssertEquals(_image.vmaddr_slide, (pl_vm_off_t) vmaddr_slide, @"Incorrect vmaddr_slide value");
unsigned long text_size;
STAssertNotNULL(getsegmentdata(info.dli_fbase, SEG_TEXT, &text_size), @"Failed to find segment");
STAssertEquals(_image.text_size, (pl_vm_size_t) text_size, @"Incorrect text segment size computed");
}
- (void) tearDown {
plcrash_nasync_macho_free(&_image);
}
/* testFindSymbol callback handling */
struct testFindSymbol_cb_ctx {
pl_vm_address_t addr;
char *name;
};
static void testFindSymbol_cb (pl_vm_address_t address, const char *name, void *ctx) {
struct testFindSymbol_cb_ctx *cb_ctx = ctx;
cb_ctx->addr = address;
cb_ctx->name = strdup(name);
}
/* For the tests below, this must be non-static. */
void PLCrashAsyncLocalSymbolicationTestsDummyFunction(void);
void PLCrashAsyncLocalSymbolicationTestsDummyFunction(void) {}
- (void) testFindSymbol {
struct testFindSymbol_cb_ctx ctx = {};
plcrash_error_t err;
plcrash_async_symbol_cache_t findContext;
err = plcrash_async_symbol_cache_init(&findContext);
STAssertEquals(err, PLCRASH_ESUCCESS, @"pl_async_local_find_symbol_context_init failed (that should not be possible, how did you do that?)");
err = plcrash_async_find_symbol(&_image, PLCRASH_ASYNC_SYMBOL_STRATEGY_ALL, &findContext, (pl_vm_address_t)PLCrashAsyncLocalSymbolicationTestsDummyFunction, testFindSymbol_cb, &ctx);
STAssertEquals(err, PLCRASH_ESUCCESS, @"Got error trying to find symbol");
STAssertEquals(ctx.addr, (pl_vm_address_t)PLCrashAsyncLocalSymbolicationTestsDummyFunction, @"Got bad address finding symbol");
STAssertEqualCStrings(ctx.name, "_PLCrashAsyncLocalSymbolicationTestsDummyFunction", @"Got wrong symbol name");
pl_vm_address_t localPC = [[[NSThread callStackReturnAddresses] objectAtIndex: 0] longLongValue];
err = plcrash_async_find_symbol(&_image, PLCRASH_ASYNC_SYMBOL_STRATEGY_ALL, &findContext, localPC, testFindSymbol_cb, &ctx);
STAssertEquals(err, PLCRASH_ESUCCESS, @"Got error trying to find symbol");
STAssertEquals(ctx.addr, (pl_vm_address_t)[self methodForSelector: _cmd], @"Got bad address finding symbol");
STAssertEqualCStrings(ctx.name, "-[PLCrashAsyncSymbolicationTests testFindSymbol]", @"Got wrong symbol name");
plcrash_async_symbol_cache_free(&findContext);
}
- (void) testStrategyFlags {
XCTSkip(@"ERROR: testStrategyFlags, ((err) equal to (PLCRASH_ESUCCESS)) failed: ('8') is not equal to ('0') - Got error trying to find symbol (line 138)");
struct testFindSymbol_cb_ctx ctx = {};
plcrash_error_t err;
plcrash_async_symbol_cache_t findContext;
err = plcrash_async_symbol_cache_init(&findContext);
STAssertEquals(err, PLCRASH_ESUCCESS, @"pl_async_local_find_symbol_context_init failed (that should not be possible, how did you do that?)");
/* Verify that C function lookup fails when only the Obj-C strategy is enabled (verifying that the symbol table strategy is disabled) */
err = plcrash_async_find_symbol(&_image, PLCRASH_ASYNC_SYMBOL_STRATEGY_OBJC, &findContext, (pl_vm_address_t)PLCrashAsyncLocalSymbolicationTestsDummyFunction, testFindSymbol_cb, &ctx);
if (err == PLCRASH_ESUCCESS) {
STAssertNotEquals(ctx.addr, (pl_vm_address_t)PLCrashAsyncLocalSymbolicationTestsDummyFunction, @"Obj-C based symblication should not have found a C function symbol");
STAssertNotEqualCStrings(ctx.name, "_PLCrashAsyncLocalSymbolicationTestsDummyFunction", @"Obj-C based symblication should not have found a C function symbol");
}
/* Verify that lookups of Obj-C methods *do* still work when the Obj-C strategy is enabled. */
pl_vm_address_t localPC = [[[NSThread callStackReturnAddresses] objectAtIndex: 0] longLongValue];
err = plcrash_async_find_symbol(&_image, PLCRASH_ASYNC_SYMBOL_STRATEGY_OBJC, &findContext, localPC, testFindSymbol_cb, &ctx);
STAssertEquals(err, PLCRASH_ESUCCESS, @"Got error trying to find symbol");
STAssertEquals(ctx.addr, (pl_vm_address_t)[self methodForSelector: _cmd], @"Got bad address finding symbol");
STAssertEqualCStrings(ctx.name, "-[PLCrashAsyncSymbolicationTests testStrategyFlags]", @"Got wrong symbol name");
/* Verify that C symbol lookup succeeds once we enable the symbol table lookup strategy. */
err = plcrash_async_find_symbol(&_image, PLCRASH_ASYNC_SYMBOL_STRATEGY_SYMBOL_TABLE, &findContext, (pl_vm_address_t)PLCrashAsyncLocalSymbolicationTestsDummyFunction, testFindSymbol_cb, &ctx);
STAssertEquals(err, PLCRASH_ESUCCESS, @"Symbol table-based symblication should have found the C function symbol");
STAssertEquals(ctx.addr, (pl_vm_address_t)PLCrashAsyncLocalSymbolicationTestsDummyFunction, @"Got bad address finding symbol");
STAssertEqualCStrings(ctx.name, "_PLCrashAsyncLocalSymbolicationTestsDummyFunction", @"Got wrong symbol name");
}
@end