1//===- LibDriver.cpp - lib.exe-compatible driver --------------------------===//
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// Defines an interface to a lib.exe-compatible driver that also understands
10// bitcode files. Used by llvm-lib and lld-link /lib.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/ToolDrivers/llvm-lib/LibDriver.h"
15#include "llvm/ADT/STLExtras.h"
16#include "llvm/ADT/StringSet.h"
17#include "llvm/BinaryFormat/COFF.h"
18#include "llvm/BinaryFormat/Magic.h"
19#include "llvm/Bitcode/BitcodeReader.h"
20#include "llvm/Object/ArchiveWriter.h"
21#include "llvm/Object/COFF.h"
22#include "llvm/Object/COFFModuleDefinition.h"
23#include "llvm/Object/WindowsMachineFlag.h"
24#include "llvm/Option/Arg.h"
25#include "llvm/Option/ArgList.h"
26#include "llvm/Option/OptTable.h"
27#include "llvm/Option/Option.h"
28#include "llvm/Support/CommandLine.h"
29#include "llvm/Support/Path.h"
30#include "llvm/Support/Process.h"
31#include "llvm/Support/StringSaver.h"
32#include "llvm/Support/raw_ostream.h"
33#include <optional>
34
35using namespace llvm;
36using namespace llvm::object;
37
38namespace {
39
40enum {
41 OPT_INVALID = 0,
42#define OPTION(...) LLVM_MAKE_OPT_ID(__VA_ARGS__),
43#include "Options.inc"
44#undef OPTION
45};
46
47using namespace llvm::opt;
48#define OPTTABLE_CODE
49#include "Options.inc"
50
51class LibOptTable : public opt::OptTable {
52public:
53 LibOptTable() : opt::OptTable(optionTables(), true) {}
54};
55} // namespace
56
57static std::string getDefaultOutputPath(const NewArchiveMember &FirstMember) {
58 SmallString<128> Val = StringRef(FirstMember.Buf->getBufferIdentifier());
59 sys::path::replace_extension(path&: Val, extension: ".lib");
60 return std::string(Val);
61}
62
63static std::vector<StringRef> getSearchPaths(opt::InputArgList *Args,
64 StringSaver &Saver) {
65 std::vector<StringRef> Ret;
66 // Add current directory as first item of the search path.
67 Ret.push_back(x: "");
68
69 // Add /libpath flags.
70 for (auto *Arg : Args->filtered(Ids: OPT_libpath))
71 Ret.push_back(x: Arg->getValue());
72
73 // Add $LIB.
74 std::optional<std::string> EnvOpt = sys::Process::GetEnv(name: "LIB");
75 if (!EnvOpt)
76 return Ret;
77 StringRef Env = Saver.save(S: *EnvOpt);
78 while (!Env.empty()) {
79 StringRef Path;
80 std::tie(args&: Path, args&: Env) = Env.split(Separator: ';');
81 Ret.push_back(x: Path);
82 }
83 return Ret;
84}
85
86// Opens a file. Path has to be resolved already. (used for def file)
87std::unique_ptr<MemoryBuffer> openFile(const Twine &Path) {
88 ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> MB =
89 MemoryBuffer::getFile(Filename: Path, /*IsText=*/true);
90
91 if (std::error_code EC = MB.getError()) {
92 llvm::errs() << "cannot open file " << Path << ": " << EC.message() << "\n";
93 return nullptr;
94 }
95
96 return std::move(*MB);
97}
98
99static std::string findInputFile(StringRef File, ArrayRef<StringRef> Paths) {
100 for (StringRef Dir : Paths) {
101 SmallString<128> Path = Dir;
102 sys::path::append(path&: Path, a: File);
103 if (sys::fs::exists(Path))
104 return std::string(Path);
105 }
106 return "";
107}
108
109static void fatalOpenError(llvm::Error E, Twine File) {
110 if (!E)
111 return;
112 handleAllErrors(E: std::move(E), Handlers: [&](const llvm::ErrorInfoBase &EIB) {
113 llvm::errs() << "error opening '" << File << "': " << EIB.message() << '\n';
114 exit(status: 1);
115 });
116}
117
118static void doList(opt::InputArgList &Args) {
119 // lib.exe prints the contents of the first archive file.
120 std::unique_ptr<MemoryBuffer> B;
121 for (auto *Arg : Args.filtered(Ids: OPT_INPUT)) {
122 // Create or open the archive object.
123 ErrorOr<std::unique_ptr<MemoryBuffer>> MaybeBuf = MemoryBuffer::getFile(
124 Filename: Arg->getValue(), /*IsText=*/false, /*RequiresNullTerminator=*/false);
125 fatalOpenError(E: errorCodeToError(EC: MaybeBuf.getError()), File: Arg->getValue());
126
127 if (identify_magic(magic: MaybeBuf.get()->getBuffer()) == file_magic::archive) {
128 B = std::move(MaybeBuf.get());
129 break;
130 }
131 }
132
133 // lib.exe doesn't print an error if no .lib files are passed.
134 if (!B)
135 return;
136
137 Error Err = Error::success();
138 object::Archive Archive(B->getMemBufferRef(), Err);
139 fatalOpenError(E: std::move(Err), File: B->getBufferIdentifier());
140
141 std::vector<StringRef> Names;
142 for (auto &C : Archive.children(Err)) {
143 Expected<StringRef> NameOrErr = C.getName();
144 fatalOpenError(E: NameOrErr.takeError(), File: B->getBufferIdentifier());
145 Names.push_back(x: NameOrErr.get());
146 }
147 for (auto Name : reverse(C&: Names))
148 llvm::outs() << Name << '\n';
149 fatalOpenError(E: std::move(Err), File: B->getBufferIdentifier());
150}
151
152static Expected<COFF::MachineTypes> getCOFFFileMachine(MemoryBufferRef MB) {
153 std::error_code EC;
154 auto Obj = object::COFFObjectFile::create(Object: MB);
155 if (!Obj)
156 return Obj.takeError();
157
158 uint16_t Machine = (*Obj)->getMachine();
159 if (Machine != COFF::IMAGE_FILE_MACHINE_I386 &&
160 Machine != COFF::IMAGE_FILE_MACHINE_AMD64 &&
161 Machine != COFF::IMAGE_FILE_MACHINE_R4000 &&
162 Machine != COFF::IMAGE_FILE_MACHINE_ARMNT && !COFF::isAnyArm64(Machine)) {
163 return createStringError(EC: inconvertibleErrorCode(),
164 S: "unknown machine: " + std::to_string(val: Machine));
165 }
166
167 return static_cast<COFF::MachineTypes>(Machine);
168}
169
170static Expected<COFF::MachineTypes> getBitcodeFileMachine(MemoryBufferRef MB) {
171 Expected<std::string> TripleStr = getBitcodeTargetTriple(Buffer: MB);
172 if (!TripleStr)
173 return TripleStr.takeError();
174
175 Triple T(*TripleStr);
176 switch (T.getArch()) {
177 case Triple::x86:
178 return COFF::IMAGE_FILE_MACHINE_I386;
179 case Triple::x86_64:
180 return COFF::IMAGE_FILE_MACHINE_AMD64;
181 case Triple::arm:
182 return COFF::IMAGE_FILE_MACHINE_ARMNT;
183 case Triple::aarch64:
184 return T.isWindowsArm64EC() ? COFF::IMAGE_FILE_MACHINE_ARM64EC
185 : COFF::IMAGE_FILE_MACHINE_ARM64;
186 case Triple::mipsel:
187 return COFF::IMAGE_FILE_MACHINE_R4000;
188 default:
189 return createStringError(EC: inconvertibleErrorCode(),
190 S: "unknown arch in target triple: " + *TripleStr);
191 }
192}
193
194static bool machineMatches(COFF::MachineTypes LibMachine,
195 COFF::MachineTypes FileMachine) {
196 if (LibMachine == FileMachine)
197 return true;
198 // ARM64EC mode allows both pure ARM64, ARM64EC and X64 objects to be mixed in
199 // the archive.
200 switch (LibMachine) {
201 case COFF::IMAGE_FILE_MACHINE_ARM64:
202 return FileMachine == COFF::IMAGE_FILE_MACHINE_ARM64X;
203 case COFF::IMAGE_FILE_MACHINE_ARM64EC:
204 case COFF::IMAGE_FILE_MACHINE_ARM64X:
205 return COFF::isAnyArm64(Machine: FileMachine) ||
206 FileMachine == COFF::IMAGE_FILE_MACHINE_AMD64;
207 default:
208 return false;
209 }
210}
211
212static void appendFile(std::vector<NewArchiveMember> &Members,
213 COFF::MachineTypes &LibMachine,
214 std::string &LibMachineSource, MemoryBufferRef MB) {
215 file_magic Magic = identify_magic(magic: MB.getBuffer());
216
217 if (Magic != file_magic::coff_object && Magic != file_magic::bitcode &&
218 Magic != file_magic::archive && Magic != file_magic::windows_resource &&
219 Magic != file_magic::coff_import_library) {
220 llvm::errs() << MB.getBufferIdentifier()
221 << ": not a COFF object, bitcode, archive, import library or "
222 "resource file\n";
223 exit(status: 1);
224 }
225
226 // If a user attempts to add an archive to another archive, llvm-lib doesn't
227 // handle the first archive file as a single file. Instead, it extracts all
228 // members from the archive and add them to the second archive. This behavior
229 // is for compatibility with Microsoft's lib command.
230 if (Magic == file_magic::archive) {
231 Error Err = Error::success();
232 object::Archive Archive(MB, Err);
233 fatalOpenError(E: std::move(Err), File: MB.getBufferIdentifier());
234
235 for (auto &C : Archive.children(Err)) {
236 Expected<MemoryBufferRef> ChildMB = C.getMemoryBufferRef();
237 if (!ChildMB) {
238 handleAllErrors(E: ChildMB.takeError(), Handlers: [&](const ErrorInfoBase &EIB) {
239 llvm::errs() << MB.getBufferIdentifier() << ": " << EIB.message()
240 << "\n";
241 });
242 exit(status: 1);
243 }
244
245 appendFile(Members, LibMachine, LibMachineSource, MB: *ChildMB);
246 }
247
248 fatalOpenError(E: std::move(Err), File: MB.getBufferIdentifier());
249 return;
250 }
251
252 // Check that all input files have the same machine type.
253 // Mixing normal objects and LTO bitcode files is fine as long as they
254 // have the same machine type.
255 // Doing this here duplicates the header parsing work that writeArchive()
256 // below does, but it's not a lot of work and it's a bit awkward to do
257 // in writeArchive() which needs to support many tools, can't assume the
258 // input is COFF, and doesn't have a good way to report errors.
259 if (Magic == file_magic::coff_object || Magic == file_magic::bitcode) {
260 Expected<COFF::MachineTypes> MaybeFileMachine =
261 (Magic == file_magic::coff_object) ? getCOFFFileMachine(MB)
262 : getBitcodeFileMachine(MB);
263 if (!MaybeFileMachine) {
264 handleAllErrors(E: MaybeFileMachine.takeError(),
265 Handlers: [&](const ErrorInfoBase &EIB) {
266 llvm::errs() << MB.getBufferIdentifier() << ": "
267 << EIB.message() << "\n";
268 });
269 exit(status: 1);
270 }
271 COFF::MachineTypes FileMachine = *MaybeFileMachine;
272
273 // FIXME: Once lld-link rejects multiple resource .obj files:
274 // Call convertResToCOFF() on .res files and add the resulting
275 // COFF file to the .lib output instead of adding the .res file, and remove
276 // this check. See PR42180.
277 if (FileMachine != COFF::IMAGE_FILE_MACHINE_UNKNOWN) {
278 if (LibMachine == COFF::IMAGE_FILE_MACHINE_UNKNOWN) {
279 if (FileMachine == COFF::IMAGE_FILE_MACHINE_ARM64EC) {
280 llvm::errs() << MB.getBufferIdentifier() << ": file machine type "
281 << machineToStr(MT: FileMachine)
282 << " conflicts with inferred library machine type,"
283 << " use /machine:arm64ec or /machine:arm64x\n";
284 exit(status: 1);
285 }
286 LibMachine = FileMachine;
287 LibMachineSource =
288 (" (inferred from earlier file '" + MB.getBufferIdentifier() + "')")
289 .str();
290 } else if (!machineMatches(LibMachine, FileMachine)) {
291 llvm::errs() << MB.getBufferIdentifier() << ": file machine type "
292 << machineToStr(MT: FileMachine)
293 << " conflicts with library machine type "
294 << machineToStr(MT: LibMachine) << LibMachineSource << '\n';
295 exit(status: 1);
296 }
297 }
298 }
299
300 Members.emplace_back(args&: MB);
301}
302
303int llvm::libDriverMain(ArrayRef<const char *> ArgsArr) {
304 BumpPtrAllocator Alloc;
305 StringSaver Saver(Alloc);
306
307 // Parse command line arguments.
308 SmallVector<const char *, 20> NewArgs(ArgsArr);
309 cl::ExpandResponseFiles(Saver, Tokenizer: cl::TokenizeWindowsCommandLine, Argv&: NewArgs);
310 ArgsArr = NewArgs;
311
312 LibOptTable Table;
313 unsigned MissingIndex;
314 unsigned MissingCount;
315 opt::InputArgList Args =
316 Table.ParseArgs(Args: ArgsArr.slice(N: 1), MissingArgIndex&: MissingIndex, MissingArgCount&: MissingCount);
317 if (MissingCount) {
318 llvm::errs() << "missing arg value for \""
319 << Args.getArgString(Index: MissingIndex) << "\", expected "
320 << MissingCount
321 << (MissingCount == 1 ? " argument.\n" : " arguments.\n");
322 return 1;
323 }
324 for (auto *Arg : Args.filtered(Ids: OPT_UNKNOWN))
325 llvm::errs() << "ignoring unknown argument: " << Arg->getAsString(Args)
326 << "\n";
327
328 // Handle /help
329 if (Args.hasArg(Ids: OPT_help)) {
330 Table.printHelp(OS&: outs(), Usage: "llvm-lib [options] file...", Title: "LLVM Lib");
331 return 0;
332 }
333
334 // Parse /ignore:
335 llvm::StringSet<> IgnoredWarnings;
336 for (auto *Arg : Args.filtered(Ids: OPT_ignore))
337 IgnoredWarnings.insert(key: Arg->getValue());
338
339 // get output library path, if any
340 std::string OutputPath;
341 if (auto *Arg = Args.getLastArg(Ids: OPT_out)) {
342 OutputPath = Arg->getValue();
343 }
344
345 COFF::MachineTypes LibMachine = COFF::IMAGE_FILE_MACHINE_UNKNOWN;
346 std::string LibMachineSource;
347 if (auto *Arg = Args.getLastArg(Ids: OPT_machine)) {
348 LibMachine = getMachineType(S: Arg->getValue());
349 if (LibMachine == COFF::IMAGE_FILE_MACHINE_UNKNOWN) {
350 llvm::errs() << "unknown /machine: arg " << Arg->getValue() << '\n';
351 return 1;
352 }
353 LibMachineSource =
354 std::string(" (from '/machine:") + Arg->getValue() + "' flag)";
355 }
356
357 // create an import library
358 if (Args.hasArg(Ids: OPT_deffile)) {
359
360 if (OutputPath.empty()) {
361 llvm::errs() << "no output path given\n";
362 return 1;
363 }
364
365 if (LibMachine == COFF::IMAGE_FILE_MACHINE_UNKNOWN) {
366 llvm::errs() << "/def option requires /machine to be specified" << '\n';
367 return 1;
368 }
369
370 std::unique_ptr<MemoryBuffer> MB =
371 openFile(Path: Args.getLastArg(Ids: OPT_deffile)->getValue());
372 if (!MB)
373 return 1;
374
375 if (!MB->getBufferSize()) {
376 llvm::errs() << "definition file empty\n";
377 return 1;
378 }
379
380 Expected<COFFModuleDefinition> Def =
381 parseCOFFModuleDefinition(MB: *MB, Machine: LibMachine, /*MingwDef=*/false);
382
383 if (!Def) {
384 llvm::errs() << "error parsing definition\n"
385 << errorToErrorCode(Err: Def.takeError()).message();
386 return 1;
387 }
388
389 std::vector<COFFShortExport> NativeExports;
390 std::string OutputFile = Def->OutputFile;
391
392 if (isArm64EC(Machine: LibMachine) && Args.hasArg(Ids: OPT_nativedeffile)) {
393 std::unique_ptr<MemoryBuffer> NativeMB =
394 openFile(Path: Args.getLastArg(Ids: OPT_nativedeffile)->getValue());
395 if (!NativeMB)
396 return 1;
397
398 if (!NativeMB->getBufferSize()) {
399 llvm::errs() << "native definition file empty\n";
400 return 1;
401 }
402
403 Expected<COFFModuleDefinition> NativeDef =
404 parseCOFFModuleDefinition(MB: *NativeMB, Machine: COFF::IMAGE_FILE_MACHINE_ARM64);
405
406 if (!NativeDef) {
407 llvm::errs() << "error parsing native definition\n"
408 << errorToErrorCode(Err: NativeDef.takeError()).message();
409 return 1;
410 }
411 NativeExports = std::move(NativeDef->Exports);
412 OutputFile = std::move(NativeDef->OutputFile);
413 }
414
415 if (Error E =
416 writeImportLibrary(ImportName: OutputFile, Path: OutputPath, Exports: Def->Exports, Machine: LibMachine,
417 /*MinGW=*/false, NativeExports)) {
418 handleAllErrors(E: std::move(E), Handlers: [&](const ErrorInfoBase &EI) {
419 llvm::errs() << OutputPath << ": " << EI.message() << "\n";
420 });
421 return 1;
422 }
423 return 0;
424 }
425
426 // If no input files and not told otherwise, silently do nothing to match
427 // lib.exe
428 if (!Args.hasArgNoClaim(Ids: OPT_INPUT) && !Args.hasArg(Ids: OPT_llvmlibempty)) {
429 if (!IgnoredWarnings.contains(key: "emptyoutput")) {
430 llvm::errs() << "warning: no input files, not writing output file\n";
431 llvm::errs() << " pass /llvmlibempty to write empty .lib file,\n";
432 llvm::errs() << " pass /ignore:emptyoutput to suppress warning\n";
433 if (Args.hasFlag(Pos: OPT_WX, Neg: OPT_WX_no, Default: false)) {
434 llvm::errs() << "treating warning as error due to /WX\n";
435 return 1;
436 }
437 }
438 return 0;
439 }
440
441 if (Args.hasArg(Ids: OPT_lst)) {
442 doList(Args);
443 return 0;
444 }
445
446 std::vector<StringRef> SearchPaths = getSearchPaths(Args: &Args, Saver);
447
448 std::vector<std::unique_ptr<MemoryBuffer>> MBs;
449 StringSet<> Seen;
450 std::vector<NewArchiveMember> Members;
451
452 // Create a NewArchiveMember for each input file.
453 for (auto *Arg : Args.filtered(Ids: OPT_INPUT)) {
454 // Find a file
455 std::string Path = findInputFile(File: Arg->getValue(), Paths: SearchPaths);
456 if (Path.empty()) {
457 llvm::errs() << Arg->getValue() << ": no such file or directory\n";
458 return 1;
459 }
460
461 // Input files are uniquified by pathname. If you specify the exact same
462 // path more than once, all but the first one are ignored.
463 //
464 // Note that there's a loophole in the rule; you can prepend `.\` or
465 // something like that to a path to make it look different, and they are
466 // handled as if they were different files. This behavior is compatible with
467 // Microsoft lib.exe.
468 if (!Seen.insert(key: Path).second)
469 continue;
470
471 // Open a file.
472 ErrorOr<std::unique_ptr<MemoryBuffer>> MOrErr = MemoryBuffer::getFile(
473 Filename: Path, /*IsText=*/false, /*RequiresNullTerminator=*/false);
474 fatalOpenError(E: errorCodeToError(EC: MOrErr.getError()), File: Path);
475 MemoryBufferRef MBRef = (*MOrErr)->getMemBufferRef();
476
477 // Append a file.
478 appendFile(Members, LibMachine, LibMachineSource, MB: MBRef);
479
480 // Take the ownership of the file buffer to keep the file open.
481 MBs.push_back(x: std::move(*MOrErr));
482 }
483
484 // Create an archive file.
485 if (OutputPath.empty()) {
486 if (!Members.empty()) {
487 OutputPath = getDefaultOutputPath(FirstMember: Members[0]);
488 } else {
489 llvm::errs() << "no output path given, and cannot infer with no inputs\n";
490 return 1;
491 }
492 }
493
494 bool Thin = Args.hasArg(Ids: OPT_llvmlibthin);
495 if (Thin) {
496 for (NewArchiveMember &Member : Members) {
497 if (sys::path::is_relative(path: Member.MemberName)) {
498 Expected<std::string> PathOrErr =
499 computeArchiveRelativePath(From: OutputPath, To: Member.MemberName);
500 if (PathOrErr)
501 Member.MemberName = Saver.save(S: *PathOrErr);
502 }
503 }
504 }
505
506 // For compatibility with MSVC, reverse member vector after de-duplication.
507 std::reverse(first: Members.begin(), last: Members.end());
508
509 auto Symtab = Args.hasFlag(Pos: OPT_llvmlibindex, Neg: OPT_llvmlibindex_no,
510 /*default=*/Default: true)
511 ? SymtabWritingMode::NormalSymtab
512 : SymtabWritingMode::NoSymtab;
513
514 if (Error E = writeArchive(
515 ArcName: OutputPath, NewMembers: Members, WriteSymtab: Symtab,
516 Kind: Thin ? object::Archive::K_GNU : object::Archive::K_COFF,
517 /*Deterministic=*/true, Thin, OldArchiveBuf: nullptr, IsEC: COFF::isArm64EC(Machine: LibMachine))) {
518 handleAllErrors(E: std::move(E), Handlers: [&](const ErrorInfoBase &EI) {
519 llvm::errs() << OutputPath << ": " << EI.message() << "\n";
520 });
521 return 1;
522 }
523
524 return 0;
525}
526