33#include "llvm/ADT/SmallSet.h"
34#include "llvm/Support/FileSystem.h"
35#include "llvm/Support/ThreadPool.h"
42#include "mach/machine.h"
44#include <CoreFoundation/CoreFoundation.h>
57 CFUUIDRef uuid, CFURLRef exec_url) =
nullptr;
77 return "DebugSymbols symbol locator.";
88 LLDB_LOGF(log,
"Spotlight lookup for .dSYM bundles is disabled.");
92 return_module_spec = module_spec;
103 void *handle = dlopen(
104 "/System/Library/PrivateFrameworks/DebugSymbols.framework/DebugSymbols",
105 RTLD_LAZY | RTLD_LOCAL);
108 (CFURLRef(*)(CFUUIDRef, CFURLRef))dlsym(handle,
109 "DBGCopyFullDSYMURLForUUID");
111 handle,
"DBGCopyDSYMPropertyLists");
122 llvm::ArrayRef<uint8_t> module_uuid = uuid->
GetBytes();
123 if (module_uuid.size() == 16) {
125 NULL, module_uuid[0], module_uuid[1], module_uuid[2], module_uuid[3],
126 module_uuid[4], module_uuid[5], module_uuid[6], module_uuid[7],
127 module_uuid[8], module_uuid[9], module_uuid[10], module_uuid[11],
128 module_uuid[12], module_uuid[13], module_uuid[14], module_uuid[15]));
130 if (module_uuid_ref.
get()) {
135 if (exec_fspec->
GetPath(exec_cf_path,
sizeof(exec_cf_path)))
136 exec_url.
reset(::CFURLCreateFromFileSystemRepresentation(
137 NULL, (
const UInt8 *)exec_cf_path, strlen(exec_cf_path),
142 module_uuid_ref.
get(), exec_url.
get()));
145 if (dsym_url.
get()) {
146 if (::CFURLGetFileSystemRepresentation(
147 dsym_url.
get(),
true, (UInt8 *)path,
sizeof(path) - 1)) {
149 "DebugSymbols framework returned dSYM path of %s for "
150 "UUID %s -- looking for the dSYM",
158 dsym_filespec, uuid, arch);
166 bool success =
false;
168 if (::CFURLGetFileSystemRepresentation(
169 dsym_url.
get(),
true, (UInt8 *)path,
sizeof(path) - 1)) {
171 "DebugSymbols framework returned dSYM path of %s for "
172 "UUID %s -- looking for an exec file",
179 CFDictionaryRef uuid_dict = NULL;
182 uuid_dict =
static_cast<CFDictionaryRef
>(
183 ::CFDictionaryGetValue(dict.
get(), uuid_cfstr.
get()));
192 module_sp = std::make_shared<Module>(exe_spec);
193 if (module_sp && module_sp->GetObjectFile() &&
194 module_sp->MatchesModuleSpec(exe_spec)) {
197 LLDB_LOGF(log,
"using original binary filepath %s for UUID %s",
216 "using binary from shared cache for filepath %s for "
225 if (!success && uuid_dict) {
228 uuid_dict, CFSTR(
"DBGSymbolRichExecutable")));
229 if (exec_cf_path && ::CFStringGetFileSystemRepresentation(
230 exec_cf_path, path,
sizeof(path))) {
231 LLDB_LOGF(log,
"plist bundle has exec path of %s for UUID %s",
246 if (::CFURLGetFileSystemRepresentation(
247 dsym_url.
get(),
true, (UInt8 *)path,
sizeof(path) - 1)) {
248 char *dsym_extension_pos = ::strstr(path,
".dSYM");
249 if (dsym_extension_pos) {
250 *dsym_extension_pos =
'\0';
252 "Looking for executable binary next to dSYM "
253 "bundle with name with name %s",
259 using namespace llvm::sys::fs;
260 switch (get_file_type(file_spec.
GetPath())) {
262 case file_type::directory_file:
267 if (bundle_exe_url.
get()) {
268 if (::CFURLGetFileSystemRepresentation(bundle_exe_url.
get(),
271 FileSpec bundle_exe_file_spec(path);
274 bundle_exe_file_spec, 0, 0, module_specs) &&
276 module_spec, matched_module_spec))
280 return_module_spec.
GetFileSpec() = bundle_exe_file_spec;
282 "Executable binary %s next to dSYM is "
290 case file_type::fifo_file:
291 case file_type::socket_file:
292 case file_type::file_not_found:
293 case file_type::status_error:
296 case file_type::type_unknown:
297 case file_type::regular_file:
298 case file_type::symlink_file:
299 case file_type::block_file:
300 case file_type::character_file:
304 matched_module_spec))
310 "Executable binary %s next to dSYM is "
325 return return_module_spec;
332 std::string dsym_bundle_path = dsym_bundle_fspec.
GetPath();
333 llvm::SmallString<128> buffer(dsym_bundle_path);
334 llvm::sys::path::append(buffer,
"Contents",
"Resources",
"DWARF");
337 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> vfs =
339 llvm::vfs::recursive_directory_iterator Iter(*vfs, buffer.str(), EC);
340 llvm::vfs::recursive_directory_iterator End;
341 for (; Iter != End && !EC; Iter.increment(EC)) {
342 llvm::ErrorOr<llvm::vfs::Status>
Status = vfs->status(Iter->path());
343 if (
Status->isDirectory())
350 for (
size_t i = 0; i < module_specs.
GetSize(); ++i) {
354 if ((uuid ==
nullptr ||
374 for (
size_t i = 0; i < module_specs.
GetSize(); ++i) {
399 FileSpec dsym_directory = exec_fspec;
402 std::string dsym_filename = filename.
AsCString();
403 dsym_filename +=
".dSYM";
413 dsym_fspec = dsym_directory;
425 std::string binary_name(filename.
AsCString());
426 auto last_dot = binary_name.find_last_of(
'.');
427 if (last_dot != std::string::npos) {
428 binary_name.erase(last_dot);
429 dsym_fspec = dsym_directory;
441 FileSpec dsym_yaa_fspec = exec_fspec;
443 std::string dsym_yaa_filename = filename.
AsCString();
444 dsym_yaa_filename +=
".dSYM.yaa";
480 LLDB_LOGF(log,
"dSYM with matching UUID & arch found at %s",
502 for (
int i = 0; i < 4; i++) {
508 if (::strchr(fn,
'.') !=
nullptr) {
512 LLDB_LOGF(log,
"dSYM with matching UUID & arch found at %s",
530 LLDB_LOGF(log,
"Spotlight lookup for .dSYM bundles is disabled.");
534 return_module_spec = module_spec;
545 void *handle = dlopen(
546 "/System/Library/PrivateFrameworks/DebugSymbols.framework/DebugSymbols",
547 RTLD_LAZY | RTLD_LOCAL);
550 (CFURLRef(*)(CFUUIDRef, CFURLRef))dlsym(handle,
551 "DBGCopyFullDSYMURLForUUID");
553 handle,
"DBGCopyDSYMPropertyLists");
564 llvm::ArrayRef<uint8_t> module_uuid = uuid->
GetBytes();
565 if (module_uuid.size() == 16) {
567 NULL, module_uuid[0], module_uuid[1], module_uuid[2], module_uuid[3],
568 module_uuid[4], module_uuid[5], module_uuid[6], module_uuid[7],
569 module_uuid[8], module_uuid[9], module_uuid[10], module_uuid[11],
570 module_uuid[12], module_uuid[13], module_uuid[14], module_uuid[15]));
572 if (module_uuid_ref.
get()) {
577 if (exec_fspec->
GetPath(exec_cf_path,
sizeof(exec_cf_path)))
578 exec_url.
reset(::CFURLCreateFromFileSystemRepresentation(
579 NULL, (
const UInt8 *)exec_cf_path, strlen(exec_cf_path),
584 module_uuid_ref.
get(), exec_url.
get()));
587 if (dsym_url.
get()) {
588 if (::CFURLGetFileSystemRepresentation(
589 dsym_url.
get(),
true, (UInt8 *)path,
sizeof(path) - 1)) {
591 "DebugSymbols framework returned dSYM path of %s for "
592 "UUID %s -- looking for the dSYM",
600 dsym_filespec, uuid, arch);
608 bool success =
false;
610 if (::CFURLGetFileSystemRepresentation(
611 dsym_url.
get(),
true, (UInt8 *)path,
sizeof(path) - 1)) {
613 "DebugSymbols framework returned dSYM path of %s for "
614 "UUID %s -- looking for an exec file",
621 CFDictionaryRef uuid_dict = NULL;
624 uuid_dict =
static_cast<CFDictionaryRef
>(
625 ::CFDictionaryGetValue(dict.
get(), uuid_cfstr.
get()));
634 module_sp = std::make_shared<Module>(exe_spec);
635 if (module_sp && module_sp->GetObjectFile() &&
636 module_sp->MatchesModuleSpec(exe_spec)) {
639 LLDB_LOGF(log,
"using original binary filepath %s for UUID %s",
658 "using binary from shared cache for filepath %s for "
667 if (!success && uuid_dict) {
670 uuid_dict, CFSTR(
"DBGSymbolRichExecutable")));
671 if (exec_cf_path && ::CFStringGetFileSystemRepresentation(
672 exec_cf_path, path,
sizeof(path))) {
673 LLDB_LOGF(log,
"plist bundle has exec path of %s for UUID %s",
688 if (::CFURLGetFileSystemRepresentation(
689 dsym_url.
get(),
true, (UInt8 *)path,
sizeof(path) - 1)) {
690 char *dsym_extension_pos = ::strstr(path,
".dSYM");
691 if (dsym_extension_pos) {
692 *dsym_extension_pos =
'\0';
694 "Looking for executable binary next to dSYM "
695 "bundle with name with name %s",
701 using namespace llvm::sys::fs;
702 switch (get_file_type(file_spec.
GetPath())) {
704 case file_type::directory_file:
709 if (bundle_exe_url.
get()) {
710 if (::CFURLGetFileSystemRepresentation(bundle_exe_url.
get(),
713 FileSpec bundle_exe_file_spec(path);
716 bundle_exe_file_spec, 0, 0, module_specs) &&
718 module_spec, matched_module_spec))
722 return_module_spec.
GetFileSpec() = bundle_exe_file_spec;
724 "Executable binary %s next to dSYM is "
732 case file_type::fifo_file:
733 case file_type::socket_file:
734 case file_type::file_not_found:
735 case file_type::status_error:
738 case file_type::type_unknown:
739 case file_type::regular_file:
740 case file_type::symlink_file:
741 case file_type::block_file:
742 case file_type::character_file:
746 matched_module_spec))
752 "Executable binary %s next to dSYM is "
776 "LocateExecutableSymbolFileDsym (file = %s, arch = %s, uuid = %p)",
781 "Locating external symbol file",
801 const std::string &command) {
803 bool success =
false;
804 if (uuid_dict != NULL && CFGetTypeID(uuid_dict) == CFDictionaryGetTypeID()) {
807 CFDictionaryRef cf_dict;
809 cf_str = (
CFStringRef)CFDictionaryGetValue((CFDictionaryRef)uuid_dict,
811 if (cf_str && CFGetTypeID(cf_str) == CFStringGetTypeID()) {
813 std::string errorstr = command;
821 (CFDictionaryRef)uuid_dict, CFSTR(
"DBGSymbolRichExecutable"));
822 if (cf_str && CFGetTypeID(cf_str) == CFStringGetTypeID()) {
827 "From dsymForUUID plist: Symbol rich executable is at '%s'",
832 cf_str = (
CFStringRef)CFDictionaryGetValue((CFDictionaryRef)uuid_dict,
833 CFSTR(
"DBGDSYMPath"));
834 if (cf_str && CFGetTypeID(cf_str) == CFStringGetTypeID()) {
837 FileSpec::Style::native);
840 LLDB_LOGF(log,
"From dsymForUUID plist: dSYM is at '%s'", str.c_str());
844 std::string DBGBuildSourcePath;
845 std::string DBGSourcePath;
854 cf_dict = (CFDictionaryRef)CFDictionaryGetValue(
855 (CFDictionaryRef)uuid_dict, CFSTR(
"DBGSourcePathRemapping"));
856 if (cf_dict && CFGetTypeID(cf_dict) == CFDictionaryGetTypeID()) {
859 bool new_style_source_remapping_dictionary =
false;
860 bool do_truncate_remapping_names =
false;
861 std::string original_DBGSourcePath_value = DBGSourcePath;
862 cf_str = (
CFStringRef)CFDictionaryGetValue((CFDictionaryRef)uuid_dict,
863 CFSTR(
"DBGVersion"));
864 if (cf_str && CFGetTypeID(cf_str) == CFStringGetTypeID()) {
867 if (!version.empty() && isdigit(version[0])) {
868 int version_number = atoi(version.c_str());
869 if (version_number > 1) {
870 new_style_source_remapping_dictionary =
true;
872 if (version_number == 2) {
873 do_truncate_remapping_names =
true;
878 CFIndex kv_pair_count = CFDictionaryGetCount((CFDictionaryRef)uuid_dict);
879 if (kv_pair_count > 0) {
884 if (keys !=
nullptr && values !=
nullptr) {
885 CFDictionaryGetKeysAndValues((CFDictionaryRef)uuid_dict,
887 (
const void **)values);
889 for (CFIndex i = 0; i < kv_pair_count; i++) {
890 DBGBuildSourcePath.clear();
891 DBGSourcePath.clear();
892 if (keys[i] && CFGetTypeID(keys[i]) == CFStringGetTypeID()) {
895 if (values[i] && CFGetTypeID(values[i]) == CFStringGetTypeID()) {
898 if (!DBGBuildSourcePath.empty() && !DBGSourcePath.empty()) {
903 if (new_style_source_remapping_dictionary &&
904 !original_DBGSourcePath_value.empty()) {
905 DBGSourcePath = original_DBGSourcePath_value;
907 if (DBGSourcePath[0] ==
'~') {
908 FileSpec resolved_source_path(DBGSourcePath.c_str());
910 DBGSourcePath = resolved_source_path.
GetPath();
917 DBGSourcePath,
true);
918 if (do_truncate_remapping_names) {
919 FileSpec build_path(DBGBuildSourcePath.c_str());
920 FileSpec source_path(DBGSourcePath.c_str());
940 cf_str = (
CFStringRef)CFDictionaryGetValue((CFDictionaryRef)uuid_dict,
941 CFSTR(
"DBGBuildSourcePath"));
942 if (cf_str && CFGetTypeID(cf_str) == CFStringGetTypeID()) {
946 cf_str = (
CFStringRef)CFDictionaryGetValue((CFDictionaryRef)uuid_dict,
947 CFSTR(
"DBGSourcePath"));
948 if (cf_str && CFGetTypeID(cf_str) == CFStringGetTypeID()) {
952 if (!DBGBuildSourcePath.empty() && !DBGSourcePath.empty()) {
953 if (DBGSourcePath[0] ==
'~') {
954 FileSpec resolved_source_path(DBGSourcePath.c_str());
956 DBGSourcePath = resolved_source_path.
GetPath();
959 DBGSourcePath,
true);
968 static std::once_flag g_once_flag;
969 static std::string g_dbgshell_command;
970 std::call_once(g_once_flag, [&]() {
971 CFTypeRef defaults_setting = CFPreferencesCopyAppValue(
972 CFSTR(
"DBGShellCommands"), CFSTR(
"com.apple.DebugSymbols"));
973 if (defaults_setting &&
974 CFGetTypeID(defaults_setting) == CFStringGetTypeID()) {
976 if (CFStringGetCString((
CFStringRef)defaults_setting, buffer,
977 sizeof(buffer), kCFStringEncodingUTF8)) {
978 g_dbgshell_command = buffer;
981 if (defaults_setting) {
982 CFRelease(defaults_setting);
985 return g_dbgshell_command;
994 if (
const char *dsymForUUID_env =
995 getenv(
"LLDB_APPLE_DSYMFORUUID_EXECUTABLE")) {
996 FileSpec dsymForUUID_executable(dsymForUUID_env);
999 return dsymForUUID_executable;
1002 static std::once_flag g_once_flag;
1003 static FileSpec g_dsymForUUID_executable;
1004 std::call_once(g_once_flag, [&]() {
1007 if (!dbgshell_command.empty()) {
1008 g_dsymForUUID_executable =
FileSpec(dbgshell_command);
1016 g_dsymForUUID_executable =
FileSpec(
"/usr/local/bin/dsymForUUID");
1022 g_dsymForUUID_executable = {};
1024 return g_dsymForUUID_executable;
1029 bool copy_executable) {
1040 if (!force_lookup && dbgshell_command.empty())
1050 if (!dsymForUUID_exe_spec)
1054 const std::string dsymForUUID_exe_path = dsymForUUID_exe_spec.
GetPath();
1055 const std::string uuid_str = uuid_ptr ? uuid_ptr->
GetAsString() :
"";
1057 std::string lookup_arg = uuid_str;
1058 if (lookup_arg.empty())
1059 lookup_arg = file_spec_ptr ? file_spec_ptr->
GetPath() :
"";
1060 if (lookup_arg.empty())
1064 command << dsymForUUID_exe_path <<
" --ignoreNegativeCache ";
1065 if (copy_executable)
1066 command <<
"--copyExecutable ";
1067 command << lookup_arg;
1070 std::string lookup_desc;
1071 if (uuid_ptr && file_spec_ptr)
1077 else if (file_spec_ptr)
1081 LLDB_LOG(log,
"Calling {0} for {1} to find dSYM: {2}", dsymForUUID_exe_path,
1084 Progress progress(
"Downloading symbol file for", lookup_desc);
1087 int exit_status = -1;
1089 std::string command_output;
1096 std::chrono::seconds(
1100 if (
error.Fail() || exit_status != 0 || command_output.empty()) {
1101 LLDB_LOGF(log,
"'%s' failed (exit status: %d, error: '%s', output: '%s')",
1103 command_output.c_str());
1108 CFDataCreateWithBytesNoCopy(NULL, (
const UInt8 *)command_output.data(),
1109 command_output.size(), kCFAllocatorNull));
1112 (CFDictionaryRef)::CFPropertyListCreateWithData(
1113 NULL, data.
get(), kCFPropertyListImmutable, NULL, NULL));
1116 LLDB_LOGF(log,
"'%s' failed: output is not a valid plist",
1121 if (CFGetTypeID(plist.
get()) != CFDictionaryGetTypeID()) {
1122 LLDB_LOGF(log,
"'%s' failed: output plist is not a valid CFDictionary",
1127 if (!uuid_str.empty()) {
1129 CFDictionaryRef uuid_dict =
1130 (CFDictionaryRef)CFDictionaryGetValue(plist.
get(), uuid_cfstr.
get());
1135 if (
const CFIndex num_values = ::CFDictionaryGetCount(plist.
get())) {
1136 std::vector<CFStringRef> keys(num_values, NULL);
1137 std::vector<CFDictionaryRef> values(num_values, NULL);
1138 ::CFDictionaryGetKeysAndValues(plist.
get(), NULL,
1139 (
const void **)&values[0]);
1140 if (num_values == 1) {
1145 for (CFIndex i = 0; i < num_values; ++i) {
1151 module_spec = curr_module_spec;
static llvm::raw_ostream & error(Stream &strm)
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
#define LLDB_LOGF(log,...)
#define LLDB_PLUGIN_DEFINE(PluginName)
static llvm::StringRef GetDbgShellCommand()
It's expensive to check for the DBGShellCommands defaults setting.
static CFDictionaryRef(* g_dlsym_DBGCopyDSYMPropertyLists)(CFURLRef dsym_url)
static bool LocateDSYMInVincinityOfExecutable(const ModuleSpec &module_spec, FileSpec &dsym_fspec)
static int LocateMacOSXFilesUsingDebugSymbols(const ModuleSpec &module_spec, ModuleSpec &return_module_spec)
static bool FileAtPathContainsArchAndUUID(const FileSpec &file_fspec, const ArchSpec *arch, const lldb_private::UUID *uuid)
static bool LookForDsymNextToExecutablePath(const ModuleSpec &mod_spec, const FileSpec &exec_fspec, FileSpec &dsym_fspec)
static CFURLRef(* g_dlsym_DBGCopyFullDSYMURLForUUID)(CFUUIDRef uuid, CFURLRef exec_url)
static FileSpec GetDsymForUUIDExecutable()
Get the dsymForUUID executable and cache the result so we don't end up stat'ing the binary over and o...
static bool GetModuleSpecInfoFromUUIDDictionary(CFDictionaryRef uuid_dict, ModuleSpec &module_spec, Status &error, const std::string &command)
#define LLDB_SCOPED_TIMERF(...)
CFURLRef CopyExecutableURL() const
static const char * FileSystemRepresentation(CFStringRef cf_str, std::string &str)
An architecture specification class.
bool IsCompatibleMatch(const ArchSpec &rhs) const
Shorthand for IsMatch(rhs, CompatibleMatch).
const char * GetArchitectureName() const
Returns a static string representing the current architecture.
A uniqued constant string class.
std::string GetString() const
Get the string value as a std::string.
const char * AsCString(const char *value_if_empty=nullptr) const
Get the string value as a C string.
void SetFile(llvm::StringRef path, Style style)
Change the file specified with a new path.
void AppendPathComponent(llvm::StringRef component)
const ConstString & GetFilename() const
Filename string const get accessor.
bool RemoveLastPathComponent()
Removes the last path component by replacing the current path with its parent.
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
void Clear()
Clears the object state.
void Resolve(llvm::SmallVectorImpl< char > &path)
Resolve path to make it canonical.
llvm::IntrusiveRefCntPtr< llvm::vfs::FileSystem > GetVirtualFileSystem()
static FileSystem & Instance()
static Status RunShellCommand(llvm::StringRef command, const FileSpec &working_dir, int *status_ptr, int *signo_ptr, std::string *command_output, const Timeout< std::micro > &timeout, bool run_in_shell=true, bool hide_stderr=false)
Run a shell command.
static ModuleListProperties & GetGlobalModuleListProperties()
bool GetModuleSpecAtIndex(size_t i, ModuleSpec &module_spec) const
bool FindMatchingModuleSpec(const ModuleSpec &module_spec, ModuleSpec &match_module_spec) const
PathMappingList & GetSourceMappingList() const
ArchSpec & GetArchitecture()
FileSpec * GetFileSpecPtr()
FileSpec & GetSymbolFileSpec()
ArchSpec * GetArchitecturePtr()
static size_t GetModuleSpecifications(const FileSpec &file, lldb::offset_t file_offset, lldb::offset_t file_size, ModuleSpecList &specs, lldb::DataBufferSP data_sp=lldb::DataBufferSP())
void Append(llvm::StringRef path, llvm::StringRef replacement, bool notify)
static bool DownloadObjectAndSymbolFile(ModuleSpec &module_spec, Status &error, bool force_lookup=true, bool copy_executable=true)
static bool RegisterPlugin(llvm::StringRef name, llvm::StringRef description, ABICreateInstance create_callback)
static bool UnregisterPlugin(ABICreateInstance create_callback)
static FileSpec FindSymbolFileInBundle(const FileSpec &dsym_bundle_fspec, const UUID *uuid, const ArchSpec *arch)
A Progress indicator helper class.
const char * GetData() const
llvm::StringRef GetString() const
SymbolLocatorDebugSymbols()
static llvm::StringRef GetPluginNameStatic()
static std::optional< ModuleSpec > LocateExecutableObjectFile(const ModuleSpec &module_spec)
static lldb_private::SymbolLocator * CreateInstance()
static llvm::StringRef GetPluginDescriptionStatic()
static std::optional< FileSpec > LocateExecutableSymbolFile(const ModuleSpec &module_spec, const FileSpecList &default_search_paths)
static bool DownloadObjectAndSymbolFile(ModuleSpec &module_spec, Status &error, bool force_lookup, bool copy_executable)
static std::optional< FileSpec > FindSymbolFileInBundle(const FileSpec &dsym_bundle_fspec, const UUID *uuid, const ArchSpec *arch)
Represents UUID's of various sizes.
llvm::ArrayRef< uint8_t > GetBytes() const
std::string GetAsString(llvm::StringRef separator="-") const
#define UNUSED_IF_ASSERT_DISABLED(x)
A class that represents a running process on the host machine.
Log * GetLog(Cat mask)
Retrieve the Log object for the channel associated with the given log enum.
std::shared_ptr< lldb_private::Module > ModuleSP