1 //===-- Reproducer.cpp ------------------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "lldb/Utility/Reproducer.h"
10 #include "lldb/Utility/LLDBAssert.h"
11 
12 #include "llvm/Support/FileSystem.h"
13 #include "llvm/Support/Threading.h"
14 #include "llvm/Support/raw_ostream.h"
15 
16 using namespace lldb_private;
17 using namespace lldb_private::repro;
18 using namespace llvm;
19 using namespace llvm::yaml;
20 
21 Reproducer &Reproducer::Instance() { return *InstanceImpl(); }
22 
23 llvm::Error Reproducer::Initialize(ReproducerMode mode,
24                                    llvm::Optional<FileSpec> root) {
25   lldbassert(!InstanceImpl() && "Already initialized.");
26   InstanceImpl().emplace();
27 
28   switch (mode) {
29   case ReproducerMode::Capture: {
30     if (!root) {
31       SmallString<128> repro_dir;
32       auto ec = sys::fs::createUniqueDirectory("reproducer", repro_dir);
33       if (ec)
34         return make_error<StringError>(
35             "unable to create unique reproducer directory", ec);
36       root.emplace(repro_dir);
37     } else {
38       auto ec = sys::fs::create_directory(root->GetPath());
39       if (ec)
40         return make_error<StringError>("unable to create reproducer directory",
41                                        ec);
42     }
43     return Instance().SetCapture(root);
44   } break;
45   case ReproducerMode::Replay:
46     return Instance().SetReplay(root);
47   case ReproducerMode::Off:
48     break;
49   };
50 
51   return Error::success();
52 }
53 
54 bool Reproducer::Initialized() { return InstanceImpl().operator bool(); }
55 
56 void Reproducer::Terminate() {
57   lldbassert(InstanceImpl() && "Already terminated.");
58   InstanceImpl().reset();
59 }
60 
61 Optional<Reproducer> &Reproducer::InstanceImpl() {
62   static Optional<Reproducer> g_reproducer;
63   return g_reproducer;
64 }
65 
66 const Generator *Reproducer::GetGenerator() const {
67   std::lock_guard<std::mutex> guard(m_mutex);
68   if (m_generator)
69     return &(*m_generator);
70   return nullptr;
71 }
72 
73 const Loader *Reproducer::GetLoader() const {
74   std::lock_guard<std::mutex> guard(m_mutex);
75   if (m_loader)
76     return &(*m_loader);
77   return nullptr;
78 }
79 
80 Generator *Reproducer::GetGenerator() {
81   std::lock_guard<std::mutex> guard(m_mutex);
82   if (m_generator)
83     return &(*m_generator);
84   return nullptr;
85 }
86 
87 Loader *Reproducer::GetLoader() {
88   std::lock_guard<std::mutex> guard(m_mutex);
89   if (m_loader)
90     return &(*m_loader);
91   return nullptr;
92 }
93 
94 llvm::Error Reproducer::SetCapture(llvm::Optional<FileSpec> root) {
95   std::lock_guard<std::mutex> guard(m_mutex);
96 
97   if (root && m_loader)
98     return make_error<StringError>(
99         "cannot generate a reproducer when replay one",
100         inconvertibleErrorCode());
101 
102   if (!root) {
103     m_generator.reset();
104     return Error::success();
105   }
106 
107   m_generator.emplace(*root);
108   return Error::success();
109 }
110 
111 llvm::Error Reproducer::SetReplay(llvm::Optional<FileSpec> root) {
112   std::lock_guard<std::mutex> guard(m_mutex);
113 
114   if (root && m_generator)
115     return make_error<StringError>(
116         "cannot replay a reproducer when generating one",
117         inconvertibleErrorCode());
118 
119   if (!root) {
120     m_loader.reset();
121     return Error::success();
122   }
123 
124   m_loader.emplace(*root);
125   if (auto e = m_loader->LoadIndex())
126     return e;
127 
128   return Error::success();
129 }
130 
131 FileSpec Reproducer::GetReproducerPath() const {
132   if (auto g = GetGenerator())
133     return g->GetRoot();
134   if (auto l = GetLoader())
135     return l->GetRoot();
136   return {};
137 }
138 
139 static FileSpec MakeAbsolute(FileSpec file_spec) {
140   SmallString<128> path;
141   file_spec.GetPath(path, false);
142   llvm::sys::fs::make_absolute(path);
143   return FileSpec(path, file_spec.GetPathStyle());
144 }
145 
146 Generator::Generator(FileSpec root)
147     : m_root(MakeAbsolute(std::move(root))), m_done(false) {
148   GetOrCreate<repro::WorkingDirectoryProvider>();
149 }
150 
151 Generator::~Generator() {}
152 
153 ProviderBase *Generator::Register(std::unique_ptr<ProviderBase> provider) {
154   std::lock_guard<std::mutex> lock(m_providers_mutex);
155   std::pair<const void *, std::unique_ptr<ProviderBase>> key_value(
156       provider->DynamicClassID(), std::move(provider));
157   auto e = m_providers.insert(std::move(key_value));
158   return e.first->getSecond().get();
159 }
160 
161 void Generator::Keep() {
162   assert(!m_done);
163   m_done = true;
164 
165   for (auto &provider : m_providers)
166     provider.second->Keep();
167 
168   AddProvidersToIndex();
169 }
170 
171 void Generator::Discard() {
172   assert(!m_done);
173   m_done = true;
174 
175   for (auto &provider : m_providers)
176     provider.second->Discard();
177 
178   llvm::sys::fs::remove_directories(m_root.GetPath());
179 }
180 
181 const FileSpec &Generator::GetRoot() const { return m_root; }
182 
183 void Generator::AddProvidersToIndex() {
184   FileSpec index = m_root;
185   index.AppendPathComponent("index.yaml");
186 
187   std::error_code EC;
188   auto strm = std::make_unique<raw_fd_ostream>(index.GetPath(), EC,
189                                                sys::fs::OpenFlags::OF_None);
190   yaml::Output yout(*strm);
191 
192   std::vector<std::string> files;
193   files.reserve(m_providers.size());
194   for (auto &provider : m_providers) {
195     files.emplace_back(provider.second->GetFile());
196   }
197 
198   yout << files;
199 }
200 
201 Loader::Loader(FileSpec root)
202     : m_root(MakeAbsolute(std::move(root))), m_loaded(false) {}
203 
204 llvm::Error Loader::LoadIndex() {
205   if (m_loaded)
206     return llvm::Error::success();
207 
208   FileSpec index = m_root.CopyByAppendingPathComponent("index.yaml");
209 
210   auto error_or_file = MemoryBuffer::getFile(index.GetPath());
211   if (auto err = error_or_file.getError())
212     return make_error<StringError>("unable to load reproducer index", err);
213 
214   yaml::Input yin((*error_or_file)->getBuffer());
215   yin >> m_files;
216   if (auto err = yin.error())
217     return make_error<StringError>("unable to read reproducer index", err);
218 
219   // Sort files to speed up search.
220   llvm::sort(m_files);
221 
222   // Remember that we've loaded the index.
223   m_loaded = true;
224 
225   return llvm::Error::success();
226 }
227 
228 bool Loader::HasFile(StringRef file) {
229   assert(m_loaded);
230   auto it = std::lower_bound(m_files.begin(), m_files.end(), file.str());
231   return (it != m_files.end()) && (*it == file);
232 }
233 
234 llvm::Expected<std::unique_ptr<DataRecorder>>
235 DataRecorder::Create(const FileSpec &filename) {
236   std::error_code ec;
237   auto recorder = std::make_unique<DataRecorder>(std::move(filename), ec);
238   if (ec)
239     return llvm::errorCodeToError(ec);
240   return std::move(recorder);
241 }
242 
243 DataRecorder *CommandProvider::GetNewDataRecorder() {
244   std::size_t i = m_data_recorders.size() + 1;
245   std::string filename = (llvm::Twine(Info::name) + llvm::Twine("-") +
246                           llvm::Twine(i) + llvm::Twine(".txt"))
247                              .str();
248   auto recorder_or_error =
249       DataRecorder::Create(GetRoot().CopyByAppendingPathComponent(filename));
250   if (!recorder_or_error) {
251     llvm::consumeError(recorder_or_error.takeError());
252     return nullptr;
253   }
254 
255   m_data_recorders.push_back(std::move(*recorder_or_error));
256   return m_data_recorders.back().get();
257 }
258 
259 void CommandProvider::Keep() {
260   std::vector<std::string> files;
261   for (auto &recorder : m_data_recorders) {
262     recorder->Stop();
263     files.push_back(recorder->GetFilename().GetPath());
264   }
265 
266   FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file);
267   std::error_code ec;
268   llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_Text);
269   if (ec)
270     return;
271   yaml::Output yout(os);
272   yout << files;
273 }
274 
275 void CommandProvider::Discard() { m_data_recorders.clear(); }
276 
277 void VersionProvider::Keep() {
278   FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file);
279   std::error_code ec;
280   llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_Text);
281   if (ec)
282     return;
283   os << m_version << "\n";
284 }
285 
286 void WorkingDirectoryProvider::Keep() {
287   FileSpec file = GetRoot().CopyByAppendingPathComponent(Info::file);
288   std::error_code ec;
289   llvm::raw_fd_ostream os(file.GetPath(), ec, llvm::sys::fs::OF_Text);
290   if (ec)
291     return;
292   os << m_cwd << "\n";
293 }
294 
295 llvm::raw_ostream *ProcessGDBRemoteProvider::GetHistoryStream() {
296   FileSpec history_file = GetRoot().CopyByAppendingPathComponent(Info::file);
297 
298   std::error_code EC;
299   m_stream_up = std::make_unique<raw_fd_ostream>(history_file.GetPath(), EC,
300                                                  sys::fs::OpenFlags::OF_Text);
301   return m_stream_up.get();
302 }
303 
304 std::unique_ptr<CommandLoader> CommandLoader::Create(Loader *loader) {
305   if (!loader)
306     return {};
307 
308   FileSpec file = loader->GetFile<repro::CommandProvider::Info>();
309   if (!file)
310     return {};
311 
312   auto error_or_file = llvm::MemoryBuffer::getFile(file.GetPath());
313   if (auto err = error_or_file.getError())
314     return {};
315 
316   std::vector<std::string> files;
317   llvm::yaml::Input yin((*error_or_file)->getBuffer());
318   yin >> files;
319 
320   if (auto err = yin.error())
321     return {};
322 
323   for (auto &file : files) {
324     FileSpec absolute_path =
325         loader->GetRoot().CopyByAppendingPathComponent(file);
326     file = absolute_path.GetPath();
327   }
328 
329   return std::make_unique<CommandLoader>(std::move(files));
330 }
331 
332 llvm::Optional<std::string> CommandLoader::GetNextFile() {
333   if (m_index >= m_files.size())
334     return {};
335   return m_files[m_index++];
336 }
337 
338 void ProviderBase::anchor() {}
339 char CommandProvider::ID = 0;
340 char FileProvider::ID = 0;
341 char ProcessGDBRemoteProvider::ID = 0;
342 char ProviderBase::ID = 0;
343 char VersionProvider::ID = 0;
344 char WorkingDirectoryProvider::ID = 0;
345 const char *CommandProvider::Info::file = "command-interpreter.yaml";
346 const char *CommandProvider::Info::name = "command-interpreter";
347 const char *FileProvider::Info::file = "files.yaml";
348 const char *FileProvider::Info::name = "files";
349 const char *ProcessGDBRemoteProvider::Info::file = "gdb-remote.yaml";
350 const char *ProcessGDBRemoteProvider::Info::name = "gdb-remote";
351 const char *VersionProvider::Info::file = "version.txt";
352 const char *VersionProvider::Info::name = "version";
353 const char *WorkingDirectoryProvider::Info::file = "cwd.txt";
354 const char *WorkingDirectoryProvider::Info::name = "cwd";
355