xref: /llvm-project/llvm/lib/ToolDrivers/llvm-lib/LibDriver.cpp (revision cc82cdfffcbc007c377778c87e690d630b8520d9)
1 //===- LibDriver.cpp - lib.exe-compatible driver --------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // Defines an interface to a lib.exe-compatible driver that also understands
11 // bitcode files. Used by llvm-lib and lld-link /lib.
12 //
13 //===----------------------------------------------------------------------===//
14 
15 #include "llvm/ToolDrivers/llvm-lib/LibDriver.h"
16 #include "llvm/ADT/STLExtras.h"
17 #include "llvm/BinaryFormat/Magic.h"
18 #include "llvm/Object/ArchiveWriter.h"
19 #include "llvm/Option/Arg.h"
20 #include "llvm/Option/ArgList.h"
21 #include "llvm/Option/Option.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/Path.h"
24 #include "llvm/Support/Process.h"
25 #include "llvm/Support/StringSaver.h"
26 #include "llvm/Support/raw_ostream.h"
27 
28 using namespace llvm;
29 
30 namespace {
31 
32 enum {
33   OPT_INVALID = 0,
34 #define OPTION(_1, _2, ID, _4, _5, _6, _7, _8, _9, _10, _11, _12) OPT_##ID,
35 #include "Options.inc"
36 #undef OPTION
37 };
38 
39 #define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE;
40 #include "Options.inc"
41 #undef PREFIX
42 
43 static const llvm::opt::OptTable::Info InfoTable[] = {
44 #define OPTION(X1, X2, ID, KIND, GROUP, ALIAS, X7, X8, X9, X10, X11, X12)      \
45   {X1, X2, X10,         X11,         OPT_##ID, llvm::opt::Option::KIND##Class, \
46    X9, X8, OPT_##GROUP, OPT_##ALIAS, X7,       X12},
47 #include "Options.inc"
48 #undef OPTION
49 };
50 
51 class LibOptTable : public llvm::opt::OptTable {
52 public:
53   LibOptTable() : OptTable(InfoTable, true) {}
54 };
55 
56 }
57 
58 static std::string getOutputPath(llvm::opt::InputArgList *Args,
59                                  const llvm::NewArchiveMember &FirstMember) {
60   if (auto *Arg = Args->getLastArg(OPT_out))
61     return Arg->getValue();
62   SmallString<128> Val = StringRef(FirstMember.Buf->getBufferIdentifier());
63   llvm::sys::path::replace_extension(Val, ".lib");
64   return Val.str();
65 }
66 
67 static std::vector<StringRef> getSearchPaths(llvm::opt::InputArgList *Args,
68                                              StringSaver &Saver) {
69   std::vector<StringRef> Ret;
70   // Add current directory as first item of the search path.
71   Ret.push_back("");
72 
73   // Add /libpath flags.
74   for (auto *Arg : Args->filtered(OPT_libpath))
75     Ret.push_back(Arg->getValue());
76 
77   // Add $LIB.
78   Optional<std::string> EnvOpt = sys::Process::GetEnv("LIB");
79   if (!EnvOpt.hasValue())
80     return Ret;
81   StringRef Env = Saver.save(*EnvOpt);
82   while (!Env.empty()) {
83     StringRef Path;
84     std::tie(Path, Env) = Env.split(';');
85     Ret.push_back(Path);
86   }
87   return Ret;
88 }
89 
90 static Optional<std::string> findInputFile(StringRef File,
91                                            ArrayRef<StringRef> Paths) {
92   for (auto Dir : Paths) {
93     SmallString<128> Path = Dir;
94     sys::path::append(Path, File);
95     if (sys::fs::exists(Path))
96       return Path.str().str();
97   }
98   return Optional<std::string>();
99 }
100 
101 int llvm::libDriverMain(llvm::ArrayRef<const char*> ArgsArr) {
102   SmallVector<const char *, 20> NewArgs(ArgsArr.begin(), ArgsArr.end());
103   BumpPtrAllocator Alloc;
104   StringSaver Saver(Alloc);
105   cl::ExpandResponseFiles(Saver, cl::TokenizeWindowsCommandLine, NewArgs);
106   ArgsArr = NewArgs;
107 
108   LibOptTable Table;
109   unsigned MissingIndex;
110   unsigned MissingCount;
111   llvm::opt::InputArgList Args =
112       Table.ParseArgs(ArgsArr.slice(1), MissingIndex, MissingCount);
113   if (MissingCount) {
114     llvm::errs() << "missing arg value for \""
115                  << Args.getArgString(MissingIndex) << "\", expected "
116                  << MissingCount
117                  << (MissingCount == 1 ? " argument.\n" : " arguments.\n");
118     return 1;
119   }
120   for (auto *Arg : Args.filtered(OPT_UNKNOWN))
121     llvm::errs() << "ignoring unknown argument: " << Arg->getSpelling() << "\n";
122 
123   if (!Args.hasArgNoClaim(OPT_INPUT)) {
124     // No input files.  To match lib.exe, silently do nothing.
125     return 0;
126   }
127 
128   std::vector<StringRef> SearchPaths = getSearchPaths(&Args, Saver);
129 
130   std::vector<llvm::NewArchiveMember> Members;
131   for (auto *Arg : Args.filtered(OPT_INPUT)) {
132     Optional<std::string> Path = findInputFile(Arg->getValue(), SearchPaths);
133     if (!Path.hasValue()) {
134       llvm::errs() << Arg->getValue() << ": no such file or directory\n";
135       return 1;
136     }
137     Expected<NewArchiveMember> MOrErr =
138         NewArchiveMember::getFile(Saver.save(*Path), /*Deterministic=*/true);
139     if (!MOrErr) {
140       handleAllErrors(MOrErr.takeError(), [&](const llvm::ErrorInfoBase &EIB) {
141         llvm::errs() << Arg->getValue() << ": " << EIB.message() << "\n";
142       });
143       return 1;
144     }
145     llvm::file_magic Magic = llvm::identify_magic(MOrErr->Buf->getBuffer());
146     if (Magic != llvm::file_magic::coff_object &&
147         Magic != llvm::file_magic::bitcode &&
148         Magic != llvm::file_magic::windows_resource) {
149       llvm::errs() << Arg->getValue()
150                    << ": not a COFF object, bitcode or resource file\n";
151       return 1;
152     }
153     Members.emplace_back(std::move(*MOrErr));
154   }
155 
156   std::pair<StringRef, std::error_code> Result =
157       llvm::writeArchive(getOutputPath(&Args, Members[0]), Members,
158                          /*WriteSymtab=*/true, object::Archive::K_GNU,
159                          /*Deterministic*/ true, Args.hasArg(OPT_llvmlibthin));
160 
161   if (Result.second) {
162     if (Result.first.empty())
163       Result.first = ArgsArr[0];
164     llvm::errs() << Result.first << ": " << Result.second.message() << "\n";
165     return 1;
166   }
167 
168   return 0;
169 }
170