xref: /openbsd-src/gnu/llvm/llvm/tools/dsymutil/Reproducer.cpp (revision d415bd752c734aee168c4ee86ff32e8cc249eb16)
1 //===- Reproducer.cpp -----------------------------------------------------===//
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 "Reproducer.h"
10 #include "llvm/Support/Path.h"
11 
12 using namespace llvm;
13 using namespace llvm::dsymutil;
14 
createReproducerDir(std::error_code & EC)15 static std::string createReproducerDir(std::error_code &EC) {
16   SmallString<128> Root;
17   if (const char *Path = getenv("DSYMUTIL_REPRODUCER_PATH")) {
18     Root.assign(Path);
19     EC = sys::fs::create_directory(Root);
20   } else {
21     EC = sys::fs::createUniqueDirectory("dsymutil", Root);
22   }
23   sys::fs::make_absolute(Root);
24   return EC ? "" : std::string(Root);
25 }
26 
Reproducer()27 Reproducer::Reproducer() : VFS(vfs::getRealFileSystem()) {}
28 Reproducer::~Reproducer() = default;
29 
ReproducerGenerate(std::error_code & EC,int Argc,char ** Argv,bool GenerateOnExit)30 ReproducerGenerate::ReproducerGenerate(std::error_code &EC, int Argc,
31                                        char **Argv, bool GenerateOnExit)
32     : Root(createReproducerDir(EC)), GenerateOnExit(GenerateOnExit) {
33   for (int I = 0; I < Argc; ++I)
34     Args.push_back(Argv[I]);
35   if (!Root.empty())
36     FC = std::make_shared<FileCollector>(Root, Root);
37   VFS = FileCollector::createCollectorVFS(vfs::getRealFileSystem(), FC);
38 }
39 
~ReproducerGenerate()40 ReproducerGenerate::~ReproducerGenerate() {
41   if (GenerateOnExit && !Generated)
42     generate();
43 }
44 
generate()45 void ReproducerGenerate::generate() {
46   if (!FC)
47     return;
48   Generated = true;
49   FC->copyFiles(false);
50   SmallString<128> Mapping(Root);
51   sys::path::append(Mapping, "mapping.yaml");
52   FC->writeMapping(Mapping.str());
53   errs() << "********************\n";
54   errs() << "Reproducer written to " << Root << '\n';
55   errs() << "Please include the reproducer and the following invocation in "
56             "your bug report:\n";
57   for (llvm::StringRef Arg : Args)
58     errs() << Arg << ' ';
59   errs() << "--use-reproducer " << Root << '\n';
60   errs() << "********************\n";
61 }
62 
63 ReproducerUse::~ReproducerUse() = default;
64 
ReproducerUse(StringRef Root,std::error_code & EC)65 ReproducerUse::ReproducerUse(StringRef Root, std::error_code &EC) {
66   SmallString<128> Mapping(Root);
67   sys::path::append(Mapping, "mapping.yaml");
68   ErrorOr<std::unique_ptr<MemoryBuffer>> Buffer =
69       vfs::getRealFileSystem()->getBufferForFile(Mapping.str());
70 
71   if (!Buffer) {
72     EC = Buffer.getError();
73     return;
74   }
75 
76   VFS = llvm::vfs::getVFSFromYAML(std::move(Buffer.get()), nullptr, Mapping);
77 }
78 
79 llvm::Expected<std::unique_ptr<Reproducer>>
createReproducer(ReproducerMode Mode,StringRef Root,int Argc,char ** Argv)80 Reproducer::createReproducer(ReproducerMode Mode, StringRef Root, int Argc,
81                              char **Argv) {
82 
83   std::error_code EC;
84   std::unique_ptr<Reproducer> Repro;
85   switch (Mode) {
86   case ReproducerMode::GenerateOnExit:
87     Repro = std::make_unique<ReproducerGenerate>(EC, Argc, Argv, true);
88     break;
89   case ReproducerMode::GenerateOnCrash:
90     Repro = std::make_unique<ReproducerGenerate>(EC, Argc, Argv, false);
91     break;
92   case ReproducerMode::Use:
93     Repro = std::make_unique<ReproducerUse>(Root, EC);
94     break;
95   case ReproducerMode::Off:
96     Repro = std::make_unique<Reproducer>();
97     break;
98   }
99   if (EC)
100     return errorCodeToError(EC);
101   return {std::move(Repro)};
102 }
103