1 //===--------------------- ModuleCache.cpp ----------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "lldb/Target/ModuleCache.h"
12 #include "lldb/Core/Module.h"
13 #include "lldb/Core/ModuleList.h"
14 #include "lldb/Core/ModuleSpec.h"
15 #include "lldb/Host/File.h"
16 #include "lldb/Host/LockFile.h"
17 #include "lldb/Utility/Log.h"
18 #include "llvm/Support/FileSystem.h"
19 #include "llvm/Support/FileUtilities.h"
26 using namespace lldb_private;
30 const char *kModulesSubdir = ".cache";
31 const char *kLockDirName = ".lock";
32 const char *kTempFileName = ".temp";
33 const char *kTempSymFileName = ".symtemp";
34 const char *kSymFileExtension = ".sym";
35 const char *kFSIllegalChars = "\\/:*?\"<>|";
37 std::string GetEscapedHostname(const char *hostname) {
38 if (hostname == nullptr)
40 std::string result(hostname);
41 size_t size = result.size();
42 for (size_t i = 0; i < size; ++i) {
43 if ((result[i] >= 1 && result[i] <= 31) ||
44 strchr(kFSIllegalChars, result[i]) != nullptr)
53 std::unique_ptr<lldb_private::LockFile> m_lock;
57 ModuleLock(const FileSpec &root_dir_spec, const UUID &uuid, Status &error);
61 static FileSpec JoinPath(const FileSpec &path1, const char *path2) {
62 FileSpec result_spec(path1);
63 result_spec.AppendPathComponent(path2);
67 static Status MakeDirectory(const FileSpec &dir_path) {
68 namespace fs = llvm::sys::fs;
70 return fs::create_directories(dir_path.GetPath(), true, fs::perms::owner_all);
73 FileSpec GetModuleDirectory(const FileSpec &root_dir_spec, const UUID &uuid) {
74 const auto modules_dir_spec = JoinPath(root_dir_spec, kModulesSubdir);
75 return JoinPath(modules_dir_spec, uuid.GetAsString().c_str());
78 FileSpec GetSymbolFileSpec(const FileSpec &module_file_spec) {
79 return FileSpec(module_file_spec.GetPath() + kSymFileExtension, false);
82 void DeleteExistingModule(const FileSpec &root_dir_spec,
83 const FileSpec &sysroot_module_path_spec) {
84 Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_MODULES));
88 std::make_shared<Module>(ModuleSpec(sysroot_module_path_spec));
89 module_uuid = module_sp->GetUUID();
92 if (!module_uuid.IsValid())
96 ModuleLock lock(root_dir_spec, module_uuid, error);
99 log->Printf("Failed to lock module %s: %s",
100 module_uuid.GetAsString().c_str(), error.AsCString());
103 namespace fs = llvm::sys::fs;
105 if (status(sysroot_module_path_spec.GetPath(), st))
108 if (st.getLinkCount() > 2) // module is referred by other hosts.
111 const auto module_spec_dir = GetModuleDirectory(root_dir_spec, module_uuid);
112 llvm::sys::fs::remove_directories(module_spec_dir.GetPath());
116 void DecrementRefExistingModule(const FileSpec &root_dir_spec,
117 const FileSpec &sysroot_module_path_spec) {
118 // Remove $platform/.cache/$uuid folder if nobody else references it.
119 DeleteExistingModule(root_dir_spec, sysroot_module_path_spec);
121 // Remove sysroot link.
122 llvm::sys::fs::remove(sysroot_module_path_spec.GetPath());
124 FileSpec symfile_spec = GetSymbolFileSpec(sysroot_module_path_spec);
125 llvm::sys::fs::remove(symfile_spec.GetPath());
128 Status CreateHostSysRootModuleLink(const FileSpec &root_dir_spec,
129 const char *hostname,
130 const FileSpec &platform_module_spec,
131 const FileSpec &local_module_spec,
132 bool delete_existing) {
133 const auto sysroot_module_path_spec =
134 JoinPath(JoinPath(root_dir_spec, hostname),
135 platform_module_spec.GetPath().c_str());
136 if (sysroot_module_path_spec.Exists()) {
137 if (!delete_existing)
140 DecrementRefExistingModule(root_dir_spec, sysroot_module_path_spec);
143 const auto error = MakeDirectory(
144 FileSpec(sysroot_module_path_spec.GetDirectory().AsCString(), false));
148 return llvm::sys::fs::create_hard_link(local_module_spec.GetPath(),
149 sysroot_module_path_spec.GetPath());
154 ModuleLock::ModuleLock(const FileSpec &root_dir_spec, const UUID &uuid,
156 const auto lock_dir_spec = JoinPath(root_dir_spec, kLockDirName);
157 error = MakeDirectory(lock_dir_spec);
161 m_file_spec = JoinPath(lock_dir_spec, uuid.GetAsString().c_str());
162 m_file.Open(m_file_spec.GetCString(), File::eOpenOptionWrite |
163 File::eOpenOptionCanCreate |
164 File::eOpenOptionCloseOnExec);
166 error.SetErrorToErrno();
170 m_lock.reset(new lldb_private::LockFile(m_file.GetDescriptor()));
171 error = m_lock->WriteLock(0, 1);
173 error.SetErrorStringWithFormat("Failed to lock file: %s",
177 void ModuleLock::Delete() {
182 llvm::sys::fs::remove(m_file_spec.GetPath());
185 /////////////////////////////////////////////////////////////////////////
187 Status ModuleCache::Put(const FileSpec &root_dir_spec, const char *hostname,
188 const ModuleSpec &module_spec, const FileSpec &tmp_file,
189 const FileSpec &target_file) {
190 const auto module_spec_dir =
191 GetModuleDirectory(root_dir_spec, module_spec.GetUUID());
192 const auto module_file_path =
193 JoinPath(module_spec_dir, target_file.GetFilename().AsCString());
195 const auto tmp_file_path = tmp_file.GetPath();
196 const auto err_code =
197 llvm::sys::fs::rename(tmp_file_path, module_file_path.GetPath());
199 return Status("Failed to rename file %s to %s: %s", tmp_file_path.c_str(),
200 module_file_path.GetPath().c_str(),
201 err_code.message().c_str());
203 const auto error = CreateHostSysRootModuleLink(
204 root_dir_spec, hostname, target_file, module_file_path, true);
206 return Status("Failed to create link to %s: %s",
207 module_file_path.GetPath().c_str(), error.AsCString());
211 Status ModuleCache::Get(const FileSpec &root_dir_spec, const char *hostname,
212 const ModuleSpec &module_spec,
213 ModuleSP &cached_module_sp, bool *did_create_ptr) {
215 m_loaded_modules.find(module_spec.GetUUID().GetAsString());
216 if (find_it != m_loaded_modules.end()) {
217 cached_module_sp = (*find_it).second.lock();
218 if (cached_module_sp)
220 m_loaded_modules.erase(find_it);
223 const auto module_spec_dir =
224 GetModuleDirectory(root_dir_spec, module_spec.GetUUID());
225 const auto module_file_path = JoinPath(
226 module_spec_dir, module_spec.GetFileSpec().GetFilename().AsCString());
228 if (!module_file_path.Exists())
229 return Status("Module %s not found", module_file_path.GetPath().c_str());
230 if (module_file_path.GetByteSize() != module_spec.GetObjectSize())
231 return Status("Module %s has invalid file size",
232 module_file_path.GetPath().c_str());
234 // We may have already cached module but downloaded from an another host - in
235 // this case let's create a link to it.
236 auto error = CreateHostSysRootModuleLink(root_dir_spec, hostname,
237 module_spec.GetFileSpec(),
238 module_file_path, false);
240 return Status("Failed to create link to %s: %s",
241 module_file_path.GetPath().c_str(), error.AsCString());
243 auto cached_module_spec(module_spec);
244 cached_module_spec.GetUUID().Clear(); // Clear UUID since it may contain md5
245 // content hash instead of real UUID.
246 cached_module_spec.GetFileSpec() = module_file_path;
247 cached_module_spec.GetPlatformFileSpec() = module_spec.GetFileSpec();
249 error = ModuleList::GetSharedModule(cached_module_spec, cached_module_sp,
250 nullptr, nullptr, did_create_ptr, false);
254 FileSpec symfile_spec = GetSymbolFileSpec(cached_module_sp->GetFileSpec());
255 if (symfile_spec.Exists())
256 cached_module_sp->SetSymbolFileFileSpec(symfile_spec);
258 m_loaded_modules.insert(
259 std::make_pair(module_spec.GetUUID().GetAsString(), cached_module_sp));
264 Status ModuleCache::GetAndPut(const FileSpec &root_dir_spec,
265 const char *hostname,
266 const ModuleSpec &module_spec,
267 const ModuleDownloader &module_downloader,
268 const SymfileDownloader &symfile_downloader,
269 lldb::ModuleSP &cached_module_sp,
270 bool *did_create_ptr) {
271 const auto module_spec_dir =
272 GetModuleDirectory(root_dir_spec, module_spec.GetUUID());
273 auto error = MakeDirectory(module_spec_dir);
277 ModuleLock lock(root_dir_spec, module_spec.GetUUID(), error);
279 return Status("Failed to lock module %s: %s",
280 module_spec.GetUUID().GetAsString().c_str(),
283 const auto escaped_hostname(GetEscapedHostname(hostname));
284 // Check local cache for a module.
285 error = Get(root_dir_spec, escaped_hostname.c_str(), module_spec,
286 cached_module_sp, did_create_ptr);
290 const auto tmp_download_file_spec = JoinPath(module_spec_dir, kTempFileName);
291 error = module_downloader(module_spec, tmp_download_file_spec);
292 llvm::FileRemover tmp_file_remover(tmp_download_file_spec.GetPath());
294 return Status("Failed to download module: %s", error.AsCString());
296 // Put downloaded file into local module cache.
297 error = Put(root_dir_spec, escaped_hostname.c_str(), module_spec,
298 tmp_download_file_spec, module_spec.GetFileSpec());
300 return Status("Failed to put module into cache: %s", error.AsCString());
302 tmp_file_remover.releaseFile();
303 error = Get(root_dir_spec, escaped_hostname.c_str(), module_spec,
304 cached_module_sp, did_create_ptr);
308 // Fetching a symbol file for the module
309 const auto tmp_download_sym_file_spec =
310 JoinPath(module_spec_dir, kTempSymFileName);
311 error = symfile_downloader(cached_module_sp, tmp_download_sym_file_spec);
312 llvm::FileRemover tmp_symfile_remover(tmp_download_sym_file_spec.GetPath());
314 // Failed to download a symfile but fetching the module was successful. The
316 // contain the necessary symbols and the debugging is also possible without
320 error = Put(root_dir_spec, escaped_hostname.c_str(), module_spec,
321 tmp_download_sym_file_spec,
322 GetSymbolFileSpec(module_spec.GetFileSpec()));
324 return Status("Failed to put symbol file into cache: %s",
327 tmp_symfile_remover.releaseFile();
329 FileSpec symfile_spec = GetSymbolFileSpec(cached_module_sp->GetFileSpec());
330 cached_module_sp->SetSymbolFileFileSpec(symfile_spec);