iOS 如何獲取 Mach-O 的 UUID

Joy_xx發表於2017-11-06
iOSMacUI

LC_UUID 一般簡稱為 UUID，是用來標示 Mach-O 檔案的，做過崩潰堆疊符號化還原的同學應該都知道有 UUID 這個東西，你在進行符號解析的時候，就需要找到與系統庫和你 APP 的 UUID 相同的 dSYM 檔案來進行堆疊地址還原。

獲取 dSYM 檔案的 UUID 比較簡單，隨便用一個工具就能檢視 UUID，那麼如何獲取 APP 及其動態庫的 UUID 呢？

$ xcrun dwarfdump --uuid <PATH_TO_APP_EXECUTABLE>

UUID: E73A4300-F6E5-3124-98DF-1578B8D4F96A (armv7) GYMonitorExample.app.dSYM/Contents/Resources/DWARF/GYMonitorExample
UUID: 44E27054-508E-37EF-9296-44400C5F19E1 (arm64) GYMonitorExample.app.dSYM/Contents/Resources/DWARF/GYMonitorExample複製程式碼

獲取 APP 的 UUID

當初想只獲取 APP 的 dSYM 檔案的 UUID 和堆疊發生時對應裝置的 APP UUID，所以直接 Google 一搜就有答案：stackoverflow.com/questions/1…

#import <mach-o/ldsyms.h>

NSString *executableUUID()
{
    const uint8_t *command = (const uint8_t *)(&_mh_execute_header + 1);
    for (uint32_t idx = 0; idx < _mh_execute_header.ncmds; ++idx) {
        if (((const struct load_command *)command)->cmd == LC_UUID) {
            command += sizeof(struct load_command);
            return [NSString stringWithFormat:@"%02X%02X%02X%02X-%02X%02X-%02X%02X-%02X%02X-%02X%02X%02X%02X%02X%02X",
                    command[0], command[1], command[2], command[3],
                    command[4], command[5],
                    command[6], command[7],
                    command[8], command[9],
                    command[10], command[11], command[12], command[13], command[14], command[15]];
        } else {
            command += ((const struct load_command *)command)->cmdsize;
        }
    }
    return nil;
}複製程式碼

把上述方法放在 AppDelegate 中進行測試，測試結果完全正確，喜出望外。上述程式碼的大概意思是獲取 MH_EXECUTE （可執行的主 image ）檔案的 Load Command，並且利用 For 迴圈遍歷所有的 Load Command，找到型別為 LC_UUID 的 Load Command，進而獲取 UUID。

在 Pod 中獲取 APP 的 UUID

因為崩潰採集是在一個獨立的庫中進行的，在崩潰時想要採集 UUID 的話也應該在當前庫中獲取 UUID，因為 Pod 使用了 use_frameworks ，所以問題就變成了如何在一個動態庫中獲取 APP 的 UUID，靜態庫會把程式碼複製到主 APP 中，而動態庫是一個獨立的 Mach-O 檔案。把上面程式碼直接丟在 Pod 中使用是行不通的，因為 _mh_execute_header 在 MH_DYLIB 中無法使用。

可以獲取主 image 檔案的路徑，然後根據路徑去獲取 image 的 index，然後根據這個 index 去獲取對應 image 的header，通過 header 找到 image 的 Load Commands，遍歷找到型別為 LC_UUID 的 Load Command 即可獲取 UUID。下面給出一部分程式碼，這個其實相當於第三個例子的一部分，所以可以從第三個中提煉出這部分程式碼。

// 獲取主 image 的路徑
static NSString* getExecutablePath()
{
    NSBundle* mainBundle = [NSBundle mainBundle];
    NSDictionary* infoDict = [mainBundle infoDictionary];
    NSString* bundlePath = [mainBundle bundlePath];
    NSString* executableName = infoDict[@"CFBundleExecutable"];
    return [bundlePath stringByAppendingPathComponent:executableName];
}
// 獲取 image 的 index
const uint32_t imageCount = _dyld_image_count();

for(uint32_t iImg = 0; iImg < imageCount; iImg++) {
    const char* name = _dyld_get_image_name(iImg);
    if (name == getExecutablePath()) return iImg;
}

// 根據 index 獲取 header
const struct mach_header* header = _dyld_get_image_header(iImg);

// 獲取 Load Command
static uintptr_t firstCmdAfterHeader(const struct mach_header* const header) {
    switch(header->magic)
    {
        case MH_MAGIC:
        case MH_CIGAM:
            return (uintptr_t)(header + 1);
        case MH_MAGIC_64:
        case MH_CIGAM_64:
            return (uintptr_t)(((struct mach_header_64*)header) + 1);
        default:
            // Header is corrupt
            return 0;
    }
}
// 遍歷 Load Command即可複製程式碼

從上面程式碼中可以發現App image 的路徑是在 mainBundle 中的，其實我們所依賴的自己的動態庫也都在這個路徑下，同時由於 Swift ABI 不穩定，它所依賴的系統動態庫打包的時候也會放在這個路徑之下，有興趣的可以測試下。當然，如果你想，你也可以通過這種方式獲取 APP 以及自己動態庫的 UUID。

如何獲取所有 Mach-O 的 UUID

當我們寫完一個 APP，打包上架後，如果遇到崩潰就需要收集堆疊資訊進行符號化還原，這時候每個動態庫的 UUID 我們都需要，系統庫的 UUID 也是需要的，這樣可以提供給更多的資訊，有利於我們迅速排查問題。如何獲取 APP 以及所有動態庫的 UUID 呢？

其實也很簡單，就是獲取到 APP 中所有的 image count，然後一個個遍歷獲取header、Load Command，進而找到所有 Mach-O 的 UUID，這裡直接上程式碼

//
//  LDAPMUUIDTool.m
//  Pods
//
//  Created by wangjiale on 2017/9/7.
//
//

#import "LDAPMUUIDTool.h"
#import <mach-o/ldsyms.h>
#include <limits.h>
#include <mach-o/dyld.h>
#include <mach-o/nlist.h>
#include <string.h>

static NSMutableArray *_UUIDRecordArray;

@implementation LDAPMUUIDTool

+ (NSDictionary *)getUUIDDictionary {
    NSDictionary *uuidDic = [[NSDictionary alloc] init];

    int imageCount = (int)_dyld_image_count();

    for(int iImg = 0; iImg < imageCount; iImg++) {

        JYGetBinaryImage(iImg);
    }

    return uuidDic;
}
// 獲取 Load Command, 會根據 header 的 magic 來判斷是 64 位 還是 32 位
static uintptr_t firstCmdAfterHeader(const struct mach_header* const header) {
    switch(header->magic) {
        case MH_MAGIC:
        case MH_CIGAM:
            return (uintptr_t)(header + 1);
        case MH_MAGIC_64:
        case MH_CIGAM_64:
            return (uintptr_t)(((struct mach_header_64*)header) + 1);
        default:
            return 0;
    }
}

bool JYGetBinaryImage(int index) {
    const struct mach_header* header = _dyld_get_image_header((unsigned)index);
    if(header == NULL) {
        return false;
    }

    uintptr_t cmdPtr = firstCmdAfterHeader(header);
    if(cmdPtr == 0) {
        return false;
    }

    uint8_t* uuid = NULL;

    for(uint32_t iCmd = 0; iCmd < header->ncmds; iCmd++)
    {
        struct load_command* loadCmd = (struct load_command*)cmdPtr;

        if (loadCmd->cmd == LC_UUID) {
            struct uuid_command* uuidCmd = (struct uuid_command*)cmdPtr;
            uuid = uuidCmd->uuid;
            break;
        }
        cmdPtr += loadCmd->cmdsize;
    }

    const char* path = _dyld_get_image_name((unsigned)index);
    NSString *imagePath = [NSString stringWithUTF8String:path];
    NSArray *array = [imagePath componentsSeparatedByString:@"/"];
    NSString *imageName = array[array.count - 1];

    NSLog(@"buffer->name:%@",imageName);

    const char* result = nil;

    if(uuid != NULL)
    {
        result = uuidBytesToString(uuid);
        NSString *lduuid = [NSString stringWithUTF8String:result];
        NSLog(@"buffer->uuid:%@",lduuid);
    }

    return true;
}
static const char* uuidBytesToString(const uint8_t* uuidBytes) {
    CFUUIDRef uuidRef = CFUUIDCreateFromUUIDBytes(NULL, *((CFUUIDBytes*)uuidBytes));
    NSString* str = (__bridge_transfer NSString*)CFUUIDCreateString(NULL, uuidRef);
    CFRelease(uuidRef);

    return cString(str);
}
const char* cString(NSString* str) {
    return str == NULL ? NULL : strdup(str.UTF8String);
}
@end複製程式碼

相關文章