xref: /llvm-project/llvm/lib/ToolDrivers/llvm-lib/LibDriver.cpp (revision 264b5d9e8817fce8c47d2b06aba2d9244e426794)
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) 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, X6, X7, X8, X9, X10)    \
45   {                                                                    \
46     X1, X2, X9, X10, OPT_##ID, llvm::opt::Option::KIND##Class, X8, X7, \
47     OPT_##GROUP, OPT_##ALIAS, X6                                       \
48   },
49 #include "Options.inc"
50 #undef OPTION
51 };
52 
53 class LibOptTable : public llvm::opt::OptTable {
54 public:
55   LibOptTable() : OptTable(infoTable, true) {}
56 };
57 
58 }
59 
60 static std::string getOutputPath(llvm::opt::InputArgList *Args,
61                                  const llvm::NewArchiveMember &FirstMember) {
62   if (auto *Arg = Args->getLastArg(OPT_out))
63     return Arg->getValue();
64   SmallString<128> Val = StringRef(FirstMember.Buf->getBufferIdentifier());
65   llvm::sys::path::replace_extension(Val, ".lib");
66   return Val.str();
67 }
68 
69 static std::vector<StringRef> getSearchPaths(llvm::opt::InputArgList *Args,
70                                              StringSaver &Saver) {
71   std::vector<StringRef> Ret;
72   // Add current directory as first item of the search path.
73   Ret.push_back("");
74 
75   // Add /libpath flags.
76   for (auto *Arg : Args->filtered(OPT_libpath))
77     Ret.push_back(Arg->getValue());
78 
79   // Add $LIB.
80   Optional<std::string> EnvOpt = sys::Process::GetEnv("LIB");
81   if (!EnvOpt.hasValue())
82     return Ret;
83   StringRef Env = Saver.save(*EnvOpt);
84   while (!Env.empty()) {
85     StringRef Path;
86     std::tie(Path, Env) = Env.split(';');
87     Ret.push_back(Path);
88   }
89   return Ret;
90 }
91 
92 static Optional<std::string> findInputFile(StringRef File,
93                                            ArrayRef<StringRef> Paths) {
94   for (auto Dir : Paths) {
95     SmallString<128> Path = Dir;
96     sys::path::append(Path, File);
97     if (sys::fs::exists(Path))
98       return Path.str().str();
99   }
100   return Optional<std::string>();
101 }
102 
103 int llvm::libDriverMain(llvm::ArrayRef<const char*> ArgsArr) {
104   SmallVector<const char *, 20> NewArgs(ArgsArr.begin(), ArgsArr.end());
105   BumpPtrAllocator Alloc;
106   StringSaver Saver(Alloc);
107   cl::ExpandResponseFiles(Saver, cl::TokenizeWindowsCommandLine, NewArgs);
108   ArgsArr = NewArgs;
109 
110   LibOptTable Table;
111   unsigned MissingIndex;
112   unsigned MissingCount;
113   llvm::opt::InputArgList Args =
114       Table.ParseArgs(ArgsArr.slice(1), MissingIndex, MissingCount);
115   if (MissingCount) {
116     llvm::errs() << "missing arg value for \""
117                  << Args.getArgString(MissingIndex) << "\", expected "
118                  << MissingCount
119                  << (MissingCount == 1 ? " argument.\n" : " arguments.\n");
120     return 1;
121   }
122   for (auto *Arg : Args.filtered(OPT_UNKNOWN))
123     llvm::errs() << "ignoring unknown argument: " << Arg->getSpelling() << "\n";
124 
125   if (!Args.hasArgNoClaim(OPT_INPUT)) {
126     // No input files.  To match lib.exe, silently do nothing.
127     return 0;
128   }
129 
130   std::vector<StringRef> SearchPaths = getSearchPaths(&Args, Saver);
131 
132   std::vector<llvm::NewArchiveMember> Members;
133   for (auto *Arg : Args.filtered(OPT_INPUT)) {
134     Optional<std::string> Path = findInputFile(Arg->getValue(), SearchPaths);
135     if (!Path.hasValue()) {
136       llvm::errs() << Arg->getValue() << ": no such file or directory\n";
137       return 1;
138     }
139     Expected<NewArchiveMember> MOrErr =
140         NewArchiveMember::getFile(Saver.save(*Path), /*Deterministic=*/true);
141     if (!MOrErr) {
142       handleAllErrors(MOrErr.takeError(), [&](const llvm::ErrorInfoBase &EIB) {
143         llvm::errs() << Arg->getValue() << ": " << EIB.message() << "\n";
144       });
145       return 1;
146     }
147     llvm::file_magic Magic = llvm::identify_magic(MOrErr->Buf->getBuffer());
148     if (Magic != llvm::file_magic::coff_object &&
149         Magic != llvm::file_magic::bitcode &&
150         Magic != llvm::file_magic::windows_resource) {
151       llvm::errs() << Arg->getValue()
152                    << ": not a COFF object, bitcode or resource file\n";
153       return 1;
154     }
155     Members.emplace_back(std::move(*MOrErr));
156   }
157 
158   std::pair<StringRef, std::error_code> Result =
159       llvm::writeArchive(getOutputPath(&Args, Members[0]), Members,
160                          /*WriteSymtab=*/true, object::Archive::K_GNU,
161                          /*Deterministic*/ true, Args.hasArg(OPT_llvmlibthin));
162 
163   if (Result.second) {
164     if (Result.first.empty())
165       Result.first = ArgsArr[0];
166     llvm::errs() << Result.first << ": " << Result.second.message() << "\n";
167     return 1;
168   }
169 
170   return 0;
171 }
172