Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[dsymutil] Upstream getBundleInfo implementation
This patch implements `getBundleInfo`, which uses CoreFoundation to obtain information about the CFBundle. This information is needed to populate the Plist in the dSYM bundle. This change only applies to darwin and is an NFC as far as other platforms are concerned. Differential revision: https://reviews.llvm.org/D40244 llvm-svn: 319416
- Loading branch information
1 parent
27b6603
commit c635376
Showing
6 changed files
with
305 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>CFBundleDevelopmentRegion</key> | ||
| <string>English</string> | ||
| <key>CFBundleIdentifier</key> | ||
| <string>custom</string> | ||
| <key>CFBundleInfoDictionaryVersion</key> | ||
| <string>6.0</string> | ||
| <key>CFBundlePackageType</key> | ||
| <string>dSYM</string> | ||
| <key>CFBundleSignature</key> | ||
| <string>????</string> | ||
| <key>CFBundleShortVersionString</key> | ||
| <string>2.0</string> | ||
| <key>CFBundleVersion</key> | ||
| <string>2</string> | ||
| </dict> | ||
| </plist> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| REQUIRES: system-darwin | ||
|
|
||
| RUN: rm -rf %t | ||
| RUN: mkdir -p %t/dsymdest | ||
| RUN: cat %p/../Inputs/basic.macho.x86_64 > %t/basic.macho.x86_64 | ||
| RUN: cat %p/../Inputs/Info.plist > %t/Info.plist | ||
|
|
||
| RUN: llvm-dsymutil -oso-prepend-path=%p/.. %t/basic.macho.x86_64 -o %t/dsymdest/basic.macho.x86_64.dSYM | ||
| RUN: FileCheck %s --input-file %t/dsymdest/basic.macho.x86_64.dSYM/Contents/Info.plist | ||
|
|
||
| CHECK: <?xml version="1.0" encoding="UTF-8"?> | ||
| CHECK-NEXT: <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| CHECK-NEXT: <plist version="1.0"> | ||
| CHECK-NEXT: <dict> | ||
| CHECK-NEXT: <key>CFBundleDevelopmentRegion</key> | ||
| CHECK-NEXT: <string>English</string> | ||
| CHECK-NEXT: <key>CFBundleIdentifier</key> | ||
| CHECK-NEXT: <string>com.apple.xcode.dsym.custom</string> | ||
| CHECK-NEXT: <key>CFBundleInfoDictionaryVersion</key> | ||
| CHECK-NEXT: <string>6.0</string> | ||
| CHECK-NEXT: <key>CFBundlePackageType</key> | ||
| CHECK-NEXT: <string>dSYM</string> | ||
| CHECK-NEXT: <key>CFBundleSignature</key> | ||
| CHECK-NEXT: <string>????</string> | ||
| CHECK-NEXT: <key>CFBundleShortVersionString</key> | ||
| CHECK-NEXT: <string>2.0</string> | ||
| CHECK-NEXT: <key>CFBundleVersion</key> | ||
| CHECK-NEXT: <string>2</string> | ||
| CHECK-NEXT: </dict> | ||
| CHECK-NEXT: </plist> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| //===- tools/dsymutil/CFBundle.cpp - CFBundle helper ------------*- C++ -*-===// | ||
| // | ||
| // The LLVM Compiler Infrastructure | ||
| // | ||
| // This file is distributed under the University of Illinois Open Source | ||
| // License. See LICENSE.TXT for details. | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #include "CFBundle.h" | ||
|
|
||
| #ifdef __APPLE__ | ||
| #include "llvm/Support/FileSystem.h" | ||
| #include "llvm/Support/raw_ostream.h" | ||
| #include <CoreFoundation/CoreFoundation.h> | ||
| #include <assert.h> | ||
| #include <glob.h> | ||
| #include <memory> | ||
|
|
||
| namespace llvm { | ||
| namespace dsymutil { | ||
|
|
||
| /// Deleter that calls CFRelease rather than deleting the pointer. | ||
| template <typename T> struct CFDeleter { | ||
| void operator()(T *P) { | ||
| if (P) | ||
| ::CFRelease(P); | ||
| } | ||
| }; | ||
|
|
||
| /// This helper owns any CoreFoundation pointer and will call CFRelease() on | ||
| /// any valid pointer it owns unless that pointer is explicitly released using | ||
| /// the release() member function. | ||
| template <typename T> | ||
| using CFReleaser = | ||
| std::unique_ptr<typename std::remove_pointer<T>::type, | ||
| CFDeleter<typename std::remove_pointer<T>::type>>; | ||
|
|
||
| /// RAII wrapper around CFBundleRef. | ||
| class CFString : public CFReleaser<CFStringRef> { | ||
| public: | ||
| CFString(CFStringRef CFStr = nullptr) : CFReleaser<CFStringRef>(CFStr) {} | ||
|
|
||
| const char *UTF8(std::string &Str) const { | ||
| return CFString::UTF8(get(), Str); | ||
| } | ||
|
|
||
| CFIndex GetLength() const { | ||
| if (CFStringRef Str = get()) | ||
| return CFStringGetLength(Str); | ||
| return 0; | ||
| } | ||
|
|
||
| static const char *UTF8(CFStringRef CFStr, std::string &Str); | ||
| }; | ||
|
|
||
| /// Static function that puts a copy of the UTF8 contents of CFStringRef into | ||
| /// std::string and returns the C string pointer that is contained in the | ||
| /// std::string when successful, nullptr otherwise. | ||
| /// | ||
| /// This allows the std::string parameter to own the extracted string, and also | ||
| /// allows that string to be returned as a C string pointer that can be used. | ||
| const char *CFString::UTF8(CFStringRef CFStr, std::string &Str) { | ||
| if (!CFStr) | ||
| return nullptr; | ||
|
|
||
| const CFStringEncoding Encoding = kCFStringEncodingUTF8; | ||
| CFIndex MaxUTF8StrLength = CFStringGetLength(CFStr); | ||
| MaxUTF8StrLength = | ||
| CFStringGetMaximumSizeForEncoding(MaxUTF8StrLength, Encoding); | ||
| if (MaxUTF8StrLength > 0) { | ||
| Str.resize(MaxUTF8StrLength); | ||
| if (!Str.empty() && | ||
| CFStringGetCString(CFStr, &Str[0], Str.size(), Encoding)) { | ||
| Str.resize(strlen(Str.c_str())); | ||
| return Str.c_str(); | ||
| } | ||
| } | ||
|
|
||
| return nullptr; | ||
| } | ||
|
|
||
| /// RAII wrapper around CFBundleRef. | ||
| class CFBundle : public CFReleaser<CFBundleRef> { | ||
| public: | ||
| CFBundle(const char *Path = nullptr) : CFReleaser<CFBundleRef>() { | ||
| if (Path && Path[0]) | ||
| SetFromPath(Path); | ||
| } | ||
|
|
||
| CFBundle(CFURLRef url) | ||
| : CFReleaser<CFBundleRef>(url ? ::CFBundleCreate(nullptr, url) | ||
| : nullptr) {} | ||
|
|
||
| /// Return the bundle identifier. | ||
| CFStringRef GetIdentifier() const { | ||
| if (CFBundleRef bundle = get()) | ||
| return ::CFBundleGetIdentifier(bundle); | ||
| return nullptr; | ||
| } | ||
|
|
||
| /// Return value for key. | ||
| CFTypeRef GetValueForInfoDictionaryKey(CFStringRef key) const { | ||
| if (CFBundleRef bundle = get()) | ||
| return ::CFBundleGetValueForInfoDictionaryKey(bundle, key); | ||
| return nullptr; | ||
| } | ||
|
|
||
| private: | ||
| /// Update this instance with a new bundle created from the given path. | ||
| bool SetFromPath(const char *Path); | ||
| }; | ||
|
|
||
| bool CFBundle::SetFromPath(const char *InPath) { | ||
| // Release our old bundle and URL. | ||
| reset(); | ||
|
|
||
| if (InPath && InPath[0]) { | ||
| char ResolvedPath[PATH_MAX]; | ||
| const char *Path = ::realpath(InPath, ResolvedPath); | ||
| if (Path == nullptr) | ||
| Path = InPath; | ||
|
|
||
| CFAllocatorRef Allocator = kCFAllocatorDefault; | ||
| // Make our Bundle URL. | ||
| CFReleaser<CFURLRef> BundleURL(::CFURLCreateFromFileSystemRepresentation( | ||
| Allocator, (const UInt8 *)Path, strlen(Path), false)); | ||
| if (BundleURL.get()) { | ||
| CFIndex LastLength = LONG_MAX; | ||
|
|
||
| while (BundleURL.get() != nullptr) { | ||
| // Check the Path range and make sure we didn't make it to just "/", | ||
| // ".", or "..". | ||
| CFRange rangeIncludingSeparators; | ||
| CFRange range = ::CFURLGetByteRangeForComponent( | ||
| BundleURL.get(), kCFURLComponentPath, &rangeIncludingSeparators); | ||
| if (range.length > LastLength) | ||
| break; | ||
|
|
||
| reset(::CFBundleCreate(Allocator, BundleURL.get())); | ||
| if (get() != nullptr) { | ||
| if (GetIdentifier() != nullptr) | ||
| break; | ||
| reset(); | ||
| } | ||
| BundleURL.reset(::CFURLCreateCopyDeletingLastPathComponent( | ||
| Allocator, BundleURL.get())); | ||
|
|
||
| LastLength = range.length; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return get() != nullptr; | ||
| } | ||
|
|
||
| #endif | ||
|
|
||
| /// On Darwin, try and find the original executable's Info.plist information | ||
| /// using CoreFoundation calls by creating a URL for the executable and | ||
| /// chopping off the last Path component. The CFBundle can then get the | ||
| /// identifier and grab any needed information from it directly. Return default | ||
| /// CFBundleInfo on other platforms. | ||
| CFBundleInfo getBundleInfo(StringRef ExePath) { | ||
| CFBundleInfo BundleInfo; | ||
|
|
||
| #ifdef __APPLE__ | ||
| if (ExePath.empty() || !sys::fs::exists(ExePath)) | ||
| return BundleInfo; | ||
|
|
||
| auto PrintError = [&](CFTypeID TypeID) { | ||
| CFString TypeIDCFStr(::CFCopyTypeIDDescription(TypeID)); | ||
| std::string TypeIDStr; | ||
| errs() << "The Info.plist key \"CFBundleShortVersionString\" is" | ||
| << "a " << TypeIDCFStr.UTF8(TypeIDStr) | ||
| << ", but it should be a string in: " << ExePath << ".\n"; | ||
| }; | ||
|
|
||
| CFBundle Bundle(ExePath.data()); | ||
| if (CFStringRef BundleID = Bundle.GetIdentifier()) { | ||
| CFString::UTF8(BundleID, BundleInfo.IDStr); | ||
| if (CFTypeRef TypeRef = | ||
| Bundle.GetValueForInfoDictionaryKey(CFSTR("CFBundleVersion"))) { | ||
| CFTypeID TypeID = ::CFGetTypeID(TypeRef); | ||
| if (TypeID == ::CFStringGetTypeID()) | ||
| CFString::UTF8((CFStringRef)TypeRef, BundleInfo.VersionStr); | ||
| else | ||
| PrintError(TypeID); | ||
| } | ||
| if (CFTypeRef TypeRef = Bundle.GetValueForInfoDictionaryKey( | ||
| CFSTR("CFBundleShortVersionString"))) { | ||
| CFTypeID TypeID = ::CFGetTypeID(TypeRef); | ||
| if (TypeID == ::CFStringGetTypeID()) | ||
| CFString::UTF8((CFStringRef)TypeRef, BundleInfo.ShortVersionStr); | ||
| else | ||
| PrintError(TypeID); | ||
| } | ||
| } | ||
| #endif | ||
|
|
||
| return BundleInfo; | ||
| } | ||
|
|
||
| } // end namespace dsymutil | ||
| } // end namespace llvm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| //===- tools/dsymutil/CFBundle.h - CFBundle helper --------------*- C++ -*-===// | ||
| // | ||
| // The LLVM Compiler Infrastructure | ||
| // | ||
| // This file is distributed under the University of Illinois Open Source | ||
| // License. See LICENSE.TXT for details. | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| #include "llvm/ADT/StringRef.h" | ||
| #include <string> | ||
|
|
||
| namespace llvm { | ||
| namespace dsymutil { | ||
|
|
||
| struct CFBundleInfo { | ||
| std::string VersionStr = "1"; | ||
| std::string ShortVersionStr = "1.0"; | ||
| std::string IDStr; | ||
| bool OmitShortVersion() const { return ShortVersionStr.empty(); } | ||
| }; | ||
|
|
||
| CFBundleInfo getBundleInfo(llvm::StringRef ExePath); | ||
|
|
||
| } // end namespace dsymutil | ||
| } // end namespace llvm |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters