1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
|
//===-- ClangHost.cpp -----------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "ClangHost.h"
#include "clang/Basic/Version.h"
#include "clang/Config/config.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/Twine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Threading.h"
#include "lldb/Host/Config.h"
#include "lldb/Host/FileSystem.h"
#include "lldb/Host/HostInfo.h"
#include "lldb/Utility/FileSpec.h"
#include "lldb/Utility/Log.h"
#include <string>
using namespace lldb_private;
static bool VerifyClangPath(const llvm::Twine &clang_path) {
if (FileSystem::Instance().IsDirectory(clang_path))
return true;
Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
LLDB_LOGF(log,
"VerifyClangPath(): "
"failed to stat clang resource directory at \"%s\"",
clang_path.str().c_str());
return false;
}
///
/// This will compute the clang resource directory assuming that clang was
/// installed with the same prefix as lldb.
///
/// If verify is true, the first candidate resource directory will be returned.
/// This mode is only used for testing.
///
static bool DefaultComputeClangResourceDirectory(FileSpec &lldb_shlib_spec,
FileSpec &file_spec,
bool verify) {
Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
std::string raw_path = lldb_shlib_spec.GetPath();
llvm::StringRef parent_dir = llvm::sys::path::parent_path(raw_path);
static const llvm::StringRef kResourceDirSuffixes[] = {
// LLVM.org's build of LLDB uses the clang resource directory placed
// in $install_dir/lib{,64}/clang/$clang_version.
"lib" CLANG_LIBDIR_SUFFIX "/clang/" CLANG_VERSION_STRING,
// swift-lldb uses the clang resource directory copied from swift, which
// by default is placed in $install_dir/lib{,64}/lldb/clang. LLDB places
// it there, so we use LLDB_LIBDIR_SUFFIX.
"lib" LLDB_LIBDIR_SUFFIX "/lldb/clang",
};
for (const auto &Suffix : kResourceDirSuffixes) {
llvm::SmallString<256> clang_dir(parent_dir);
llvm::SmallString<32> relative_path(Suffix);
llvm::sys::path::native(relative_path);
llvm::sys::path::append(clang_dir, relative_path);
if (!verify || VerifyClangPath(clang_dir)) {
LLDB_LOG(log,
"DefaultComputeClangResourceDir: Setting ClangResourceDir "
"to \"{0}\", verify = {1}",
clang_dir.str(), verify ? "true" : "false");
file_spec.GetDirectory().SetString(clang_dir);
FileSystem::Instance().Resolve(file_spec);
return true;
}
}
return false;
}
bool lldb_private::ComputeClangResourceDirectory(FileSpec &lldb_shlib_spec,
FileSpec &file_spec, bool verify) {
#if !defined(__APPLE__)
return DefaultComputeClangResourceDirectory(lldb_shlib_spec, file_spec,
verify);
#else
std::string raw_path = lldb_shlib_spec.GetPath();
auto rev_it = llvm::sys::path::rbegin(raw_path);
auto r_end = llvm::sys::path::rend(raw_path);
// Check for a Posix-style build of LLDB.
while (rev_it != r_end) {
if (*rev_it == "LLDB.framework")
break;
++rev_it;
}
// We found a non-framework build of LLDB
if (rev_it == r_end)
return DefaultComputeClangResourceDirectory(lldb_shlib_spec, file_spec,
verify);
// Inside Xcode and in Xcode toolchains LLDB is always in lockstep
// with the Swift compiler, so it can reuse its Clang resource
// directory. This allows LLDB and the Swift compiler to share the
// same Clang module cache.
llvm::SmallString<256> clang_path;
const char *swift_clang_resource_dir = "usr/lib/swift/clang";
auto parent = std::next(rev_it);
if (parent != r_end && *parent == "SharedFrameworks") {
// This is the top-level LLDB in the Xcode.app bundle.
// E.g., "Xcode.app/Contents/SharedFrameworks/LLDB.framework/Versions/A"
raw_path.resize(parent - r_end);
llvm::sys::path::append(clang_path, raw_path,
"Developer/Toolchains/XcodeDefault.xctoolchain",
swift_clang_resource_dir);
if (!verify || VerifyClangPath(clang_path)) {
file_spec.GetDirectory().SetString(clang_path.c_str());
FileSystem::Instance().Resolve(file_spec);
return true;
}
} else if (parent != r_end && *parent == "PrivateFrameworks" &&
std::distance(parent, r_end) > 2) {
++parent;
++parent;
if (*parent == "System") {
// This is LLDB inside an Xcode toolchain.
// E.g., "Xcode.app/Contents/Developer/Toolchains/" \
// "My.xctoolchain/System/Library/PrivateFrameworks/LLDB.framework"
raw_path.resize(parent - r_end);
llvm::sys::path::append(clang_path, raw_path, swift_clang_resource_dir);
if (!verify || VerifyClangPath(clang_path)) {
file_spec.GetDirectory().SetString(clang_path.c_str());
FileSystem::Instance().Resolve(file_spec);
return true;
}
raw_path = lldb_shlib_spec.GetPath();
}
raw_path.resize(rev_it - r_end);
} else {
raw_path.resize(rev_it - r_end);
}
// Fall back to the Clang resource directory inside the framework.
raw_path.append("LLDB.framework/Resources/Clang");
file_spec.GetDirectory().SetString(raw_path.c_str());
FileSystem::Instance().Resolve(file_spec);
return true;
#endif // __APPLE__
}
FileSpec lldb_private::GetClangResourceDir() {
static FileSpec g_cached_resource_dir;
static llvm::once_flag g_once_flag;
llvm::call_once(g_once_flag, []() {
if (FileSpec lldb_file_spec = HostInfo::GetShlibDir())
ComputeClangResourceDirectory(lldb_file_spec, g_cached_resource_dir,
true);
Log *log = lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_HOST);
LLDB_LOGF(log, "GetClangResourceDir() => '%s'",
g_cached_resource_dir.GetPath().c_str());
});
return g_cached_resource_dir;
}
|