109467b48Spatrick //===- llvm-ifs.cpp -------------------------------------------------------===//
209467b48Spatrick //
309467b48Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
409467b48Spatrick // See https://llvm.org/LICENSE.txt for license information.
509467b48Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
609467b48Spatrick //
709467b48Spatrick //===-----------------------------------------------------------------------===/
809467b48Spatrick
973471bf0Spatrick #include "ErrorCollector.h"
1009467b48Spatrick #include "llvm/ADT/StringRef.h"
1109467b48Spatrick #include "llvm/ADT/StringSwitch.h"
1209467b48Spatrick #include "llvm/ADT/Triple.h"
13*d415bd75Srobert #include "llvm/BinaryFormat/ELF.h"
1473471bf0Spatrick #include "llvm/InterfaceStub/ELFObjHandler.h"
1573471bf0Spatrick #include "llvm/InterfaceStub/IFSHandler.h"
1673471bf0Spatrick #include "llvm/InterfaceStub/IFSStub.h"
1709467b48Spatrick #include "llvm/ObjectYAML/yaml2obj.h"
18*d415bd75Srobert #include "llvm/Option/Arg.h"
19*d415bd75Srobert #include "llvm/Option/ArgList.h"
20*d415bd75Srobert #include "llvm/Option/Option.h"
2109467b48Spatrick #include "llvm/Support/CommandLine.h"
2209467b48Spatrick #include "llvm/Support/Debug.h"
2309467b48Spatrick #include "llvm/Support/Errc.h"
2409467b48Spatrick #include "llvm/Support/Error.h"
2509467b48Spatrick #include "llvm/Support/FileOutputBuffer.h"
2609467b48Spatrick #include "llvm/Support/MemoryBuffer.h"
2709467b48Spatrick #include "llvm/Support/Path.h"
2809467b48Spatrick #include "llvm/Support/VersionTuple.h"
2909467b48Spatrick #include "llvm/Support/WithColor.h"
3009467b48Spatrick #include "llvm/Support/YAMLTraits.h"
3109467b48Spatrick #include "llvm/Support/raw_ostream.h"
3273471bf0Spatrick #include "llvm/TextAPI/InterfaceFile.h"
3373471bf0Spatrick #include "llvm/TextAPI/TextAPIReader.h"
3473471bf0Spatrick #include "llvm/TextAPI/TextAPIWriter.h"
35*d415bd75Srobert #include <optional>
3609467b48Spatrick #include <set>
3709467b48Spatrick #include <string>
38097a140dSpatrick #include <vector>
3909467b48Spatrick
4009467b48Spatrick using namespace llvm;
4109467b48Spatrick using namespace llvm::yaml;
4209467b48Spatrick using namespace llvm::MachO;
4373471bf0Spatrick using namespace llvm::ifs;
4409467b48Spatrick
4509467b48Spatrick #define DEBUG_TYPE "llvm-ifs"
4609467b48Spatrick
4709467b48Spatrick namespace {
4873471bf0Spatrick const VersionTuple IfsVersionCurrent(3, 0);
4973471bf0Spatrick
5073471bf0Spatrick enum class FileFormat { IFS, ELF, TBD };
51097a140dSpatrick } // end anonymous namespace
5209467b48Spatrick
53*d415bd75Srobert using namespace llvm::opt;
54*d415bd75Srobert enum ID {
55*d415bd75Srobert OPT_INVALID = 0, // This is not an option ID.
56*d415bd75Srobert #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
57*d415bd75Srobert HELPTEXT, METAVAR, VALUES) \
58*d415bd75Srobert OPT_##ID,
59*d415bd75Srobert #include "Opts.inc"
60*d415bd75Srobert #undef OPTION
61*d415bd75Srobert };
6209467b48Spatrick
63*d415bd75Srobert #define PREFIX(NAME, VALUE) \
64*d415bd75Srobert static constexpr StringLiteral NAME##_init[] = VALUE; \
65*d415bd75Srobert static constexpr ArrayRef<StringLiteral> NAME(NAME##_init, \
66*d415bd75Srobert std::size(NAME##_init) - 1);
67*d415bd75Srobert #include "Opts.inc"
68*d415bd75Srobert #undef PREFIX
69*d415bd75Srobert
70*d415bd75Srobert static constexpr opt::OptTable::Info InfoTable[] = {
71*d415bd75Srobert #define OPTION(PREFIX, NAME, ID, KIND, GROUP, ALIAS, ALIASARGS, FLAGS, PARAM, \
72*d415bd75Srobert HELPTEXT, METAVAR, VALUES) \
73*d415bd75Srobert { \
74*d415bd75Srobert PREFIX, NAME, HELPTEXT, \
75*d415bd75Srobert METAVAR, OPT_##ID, opt::Option::KIND##Class, \
76*d415bd75Srobert PARAM, FLAGS, OPT_##GROUP, \
77*d415bd75Srobert OPT_##ALIAS, ALIASARGS, VALUES},
78*d415bd75Srobert #include "Opts.inc"
79*d415bd75Srobert #undef OPTION
80*d415bd75Srobert };
81*d415bd75Srobert
82*d415bd75Srobert class IFSOptTable : public opt::GenericOptTable {
83*d415bd75Srobert public:
IFSOptTable()84*d415bd75Srobert IFSOptTable() : opt::GenericOptTable(InfoTable) {
85*d415bd75Srobert setGroupedShortOptions(true);
86*d415bd75Srobert }
87*d415bd75Srobert };
88*d415bd75Srobert
89*d415bd75Srobert struct DriverConfig {
90*d415bd75Srobert std::vector<std::string> InputFilePaths;
91*d415bd75Srobert
92*d415bd75Srobert std::optional<FileFormat> InputFormat;
93*d415bd75Srobert std::optional<FileFormat> OutputFormat;
94*d415bd75Srobert
95*d415bd75Srobert std::optional<std::string> HintIfsTarget;
96*d415bd75Srobert std::optional<std::string> OptTargetTriple;
97*d415bd75Srobert std::optional<IFSArch> OverrideArch;
98*d415bd75Srobert std::optional<IFSBitWidthType> OverrideBitWidth;
99*d415bd75Srobert std::optional<IFSEndiannessType> OverrideEndianness;
100*d415bd75Srobert
101*d415bd75Srobert bool StripIfsArch = false;
102*d415bd75Srobert bool StripIfsBitwidth = false;
103*d415bd75Srobert bool StripIfsEndianness = false;
104*d415bd75Srobert bool StripIfsTarget = false;
105*d415bd75Srobert bool StripNeeded = false;
106*d415bd75Srobert bool StripSize = false;
107*d415bd75Srobert bool StripUndefined = false;
108*d415bd75Srobert
109*d415bd75Srobert std::vector<std::string> Exclude;
110*d415bd75Srobert
111*d415bd75Srobert std::optional<std::string> SoName;
112*d415bd75Srobert
113*d415bd75Srobert std::optional<std::string> Output;
114*d415bd75Srobert std::optional<std::string> OutputElf;
115*d415bd75Srobert std::optional<std::string> OutputIfs;
116*d415bd75Srobert std::optional<std::string> OutputTbd;
117*d415bd75Srobert
118*d415bd75Srobert bool WriteIfChanged = false;
119*d415bd75Srobert };
12009467b48Spatrick
getTypeName(IFSSymbolType Type)12173471bf0Spatrick static std::string getTypeName(IFSSymbolType Type) {
12209467b48Spatrick switch (Type) {
12309467b48Spatrick case IFSSymbolType::NoType:
12409467b48Spatrick return "NoType";
12509467b48Spatrick case IFSSymbolType::Func:
12609467b48Spatrick return "Func";
12709467b48Spatrick case IFSSymbolType::Object:
12809467b48Spatrick return "Object";
12973471bf0Spatrick case IFSSymbolType::TLS:
13073471bf0Spatrick return "TLS";
13109467b48Spatrick case IFSSymbolType::Unknown:
13209467b48Spatrick return "Unknown";
13309467b48Spatrick }
13409467b48Spatrick llvm_unreachable("Unexpected ifs symbol type.");
13509467b48Spatrick }
13609467b48Spatrick
137*d415bd75Srobert static Expected<std::unique_ptr<IFSStub>>
readInputFile(std::optional<FileFormat> & InputFormat,StringRef FilePath)138*d415bd75Srobert readInputFile(std::optional<FileFormat> &InputFormat, StringRef FilePath) {
13909467b48Spatrick // Read in file.
14009467b48Spatrick ErrorOr<std::unique_ptr<MemoryBuffer>> BufOrError =
14173471bf0Spatrick MemoryBuffer::getFileOrSTDIN(FilePath, /*IsText=*/true);
14209467b48Spatrick if (!BufOrError)
14309467b48Spatrick return createStringError(BufOrError.getError(), "Could not open `%s`",
14409467b48Spatrick FilePath.data());
14509467b48Spatrick
14609467b48Spatrick std::unique_ptr<MemoryBuffer> FileReadBuffer = std::move(*BufOrError);
14773471bf0Spatrick ErrorCollector EC(/*UseFatalErrors=*/false);
14809467b48Spatrick
14973471bf0Spatrick // First try to read as a binary (fails fast if not binary).
150*d415bd75Srobert if (!InputFormat || *InputFormat == FileFormat::ELF) {
15173471bf0Spatrick Expected<std::unique_ptr<IFSStub>> StubFromELF =
15273471bf0Spatrick readELFFile(FileReadBuffer->getMemBufferRef());
15373471bf0Spatrick if (StubFromELF) {
154*d415bd75Srobert InputFormat = FileFormat::ELF;
15573471bf0Spatrick (*StubFromELF)->IfsVersion = IfsVersionCurrent;
15673471bf0Spatrick return std::move(*StubFromELF);
15773471bf0Spatrick }
15873471bf0Spatrick EC.addError(StubFromELF.takeError(), "BinaryRead");
15909467b48Spatrick }
16009467b48Spatrick
16173471bf0Spatrick // Fall back to reading as a ifs.
162*d415bd75Srobert if (!InputFormat || *InputFormat == FileFormat::IFS) {
16373471bf0Spatrick Expected<std::unique_ptr<IFSStub>> StubFromIFS =
16473471bf0Spatrick readIFSFromBuffer(FileReadBuffer->getBuffer());
16573471bf0Spatrick if (StubFromIFS) {
166*d415bd75Srobert InputFormat = FileFormat::IFS;
16773471bf0Spatrick if ((*StubFromIFS)->IfsVersion > IfsVersionCurrent)
16873471bf0Spatrick EC.addError(
16973471bf0Spatrick createStringError(errc::not_supported,
17073471bf0Spatrick "IFS version " +
17173471bf0Spatrick (*StubFromIFS)->IfsVersion.getAsString() +
17273471bf0Spatrick " is unsupported."),
17373471bf0Spatrick "ReadInputFile");
17473471bf0Spatrick else
17573471bf0Spatrick return std::move(*StubFromIFS);
17673471bf0Spatrick } else {
17773471bf0Spatrick EC.addError(StubFromIFS.takeError(), "YamlParse");
17873471bf0Spatrick }
17973471bf0Spatrick }
18073471bf0Spatrick
18173471bf0Spatrick // If both readers fail, build a new error that includes all information.
18273471bf0Spatrick EC.addError(createStringError(errc::not_supported,
18373471bf0Spatrick "No file readers succeeded reading `%s` "
18473471bf0Spatrick "(unsupported/malformed file?)",
18573471bf0Spatrick FilePath.data()),
18673471bf0Spatrick "ReadInputFile");
18773471bf0Spatrick EC.escalateToFatal();
18873471bf0Spatrick return EC.makeError();
18973471bf0Spatrick }
19073471bf0Spatrick
writeTbdStub(const Triple & T,const std::vector<IFSSymbol> & Symbols,const StringRef Format,raw_ostream & Out)19173471bf0Spatrick static int writeTbdStub(const Triple &T, const std::vector<IFSSymbol> &Symbols,
19209467b48Spatrick const StringRef Format, raw_ostream &Out) {
19309467b48Spatrick
194*d415bd75Srobert auto PlatformTypeOrError =
195*d415bd75Srobert [](const llvm::Triple &T) -> llvm::Expected<llvm::MachO::PlatformType> {
19609467b48Spatrick if (T.isMacOSX())
197*d415bd75Srobert return llvm::MachO::PLATFORM_MACOS;
19809467b48Spatrick if (T.isTvOS())
199*d415bd75Srobert return llvm::MachO::PLATFORM_TVOS;
20009467b48Spatrick if (T.isWatchOS())
201*d415bd75Srobert return llvm::MachO::PLATFORM_WATCHOS;
20209467b48Spatrick // Note: put isiOS last because tvOS and watchOS are also iOS according
20309467b48Spatrick // to the Triple.
20409467b48Spatrick if (T.isiOS())
205*d415bd75Srobert return llvm::MachO::PLATFORM_IOS;
20609467b48Spatrick
20709467b48Spatrick return createStringError(errc::not_supported, "Invalid Platform.\n");
20809467b48Spatrick }(T);
20909467b48Spatrick
210*d415bd75Srobert if (!PlatformTypeOrError)
21109467b48Spatrick return -1;
21209467b48Spatrick
213*d415bd75Srobert PlatformType Plat = PlatformTypeOrError.get();
21409467b48Spatrick TargetList Targets({Target(llvm::MachO::mapToArchitecture(T), Plat)});
21509467b48Spatrick
21609467b48Spatrick InterfaceFile File;
21709467b48Spatrick File.setFileType(FileType::TBD_V3); // Only supporting v3 for now.
21809467b48Spatrick File.addTargets(Targets);
21909467b48Spatrick
22009467b48Spatrick for (const auto &Symbol : Symbols) {
22109467b48Spatrick auto Name = Symbol.Name;
22209467b48Spatrick auto Kind = SymbolKind::GlobalSymbol;
22309467b48Spatrick switch (Symbol.Type) {
22409467b48Spatrick default:
22509467b48Spatrick case IFSSymbolType::NoType:
22609467b48Spatrick Kind = SymbolKind::GlobalSymbol;
22709467b48Spatrick break;
22809467b48Spatrick case IFSSymbolType::Object:
22909467b48Spatrick Kind = SymbolKind::GlobalSymbol;
23009467b48Spatrick break;
23109467b48Spatrick case IFSSymbolType::Func:
23209467b48Spatrick Kind = SymbolKind::GlobalSymbol;
23309467b48Spatrick break;
23409467b48Spatrick }
23509467b48Spatrick if (Symbol.Weak)
23609467b48Spatrick File.addSymbol(Kind, Name, Targets, SymbolFlags::WeakDefined);
23709467b48Spatrick else
23809467b48Spatrick File.addSymbol(Kind, Name, Targets);
23909467b48Spatrick }
24009467b48Spatrick
24109467b48Spatrick SmallString<4096> Buffer;
24209467b48Spatrick raw_svector_ostream OS(Buffer);
24309467b48Spatrick if (Error Result = TextAPIWriter::writeToStream(OS, File))
24409467b48Spatrick return -1;
24509467b48Spatrick Out << OS.str();
24609467b48Spatrick return 0;
24709467b48Spatrick }
24809467b48Spatrick
fatalError(Error Err)24973471bf0Spatrick static void fatalError(Error Err) {
25073471bf0Spatrick WithColor::defaultErrorHandler(std::move(Err));
25173471bf0Spatrick exit(1);
25209467b48Spatrick }
25309467b48Spatrick
fatalError(Twine T)254*d415bd75Srobert static void fatalError(Twine T) {
255*d415bd75Srobert WithColor::error() << T.str() << '\n';
256*d415bd75Srobert exit(1);
257*d415bd75Srobert }
258*d415bd75Srobert
25973471bf0Spatrick /// writeIFS() writes a Text-Based ELF stub to a file using the latest version
26073471bf0Spatrick /// of the YAML parser.
writeIFS(StringRef FilePath,IFSStub & Stub,bool WriteIfChanged)261*d415bd75Srobert static Error writeIFS(StringRef FilePath, IFSStub &Stub, bool WriteIfChanged) {
26273471bf0Spatrick // Write IFS to memory first.
26373471bf0Spatrick std::string IFSStr;
26473471bf0Spatrick raw_string_ostream OutStr(IFSStr);
26573471bf0Spatrick Error YAMLErr = writeIFSToOutputStream(OutStr, Stub);
26673471bf0Spatrick if (YAMLErr)
26773471bf0Spatrick return YAMLErr;
26873471bf0Spatrick OutStr.flush();
26973471bf0Spatrick
27073471bf0Spatrick if (WriteIfChanged) {
27173471bf0Spatrick if (ErrorOr<std::unique_ptr<MemoryBuffer>> BufOrError =
27273471bf0Spatrick MemoryBuffer::getFile(FilePath)) {
273*d415bd75Srobert // Compare IFS output with the existing IFS file. If unchanged, avoid
274*d415bd75Srobert // changing the file.
27573471bf0Spatrick if ((*BufOrError)->getBuffer() == IFSStr)
27673471bf0Spatrick return Error::success();
27709467b48Spatrick }
27809467b48Spatrick }
27973471bf0Spatrick // Open IFS file for writing.
28073471bf0Spatrick std::error_code SysErr;
28173471bf0Spatrick raw_fd_ostream Out(FilePath, SysErr);
28273471bf0Spatrick if (SysErr)
28373471bf0Spatrick return createStringError(SysErr, "Couldn't open `%s` for writing",
28473471bf0Spatrick FilePath.data());
28573471bf0Spatrick Out << IFSStr;
28673471bf0Spatrick return Error::success();
28773471bf0Spatrick }
28809467b48Spatrick
parseArgs(int argc,char * const * argv)289*d415bd75Srobert static DriverConfig parseArgs(int argc, char *const *argv) {
290*d415bd75Srobert BumpPtrAllocator A;
291*d415bd75Srobert StringSaver Saver(A);
292*d415bd75Srobert IFSOptTable Tbl;
293*d415bd75Srobert StringRef ToolName = argv[0];
294*d415bd75Srobert llvm::opt::InputArgList Args = Tbl.parseArgs(
295*d415bd75Srobert argc, argv, OPT_UNKNOWN, Saver, [&](StringRef Msg) { fatalError(Msg); });
296*d415bd75Srobert if (Args.hasArg(OPT_help)) {
297*d415bd75Srobert Tbl.printHelp(llvm::outs(),
298*d415bd75Srobert (Twine(ToolName) + " <input_file> <output_file> [options]")
299*d415bd75Srobert .str()
300*d415bd75Srobert .c_str(),
301*d415bd75Srobert "shared object stubbing tool");
302*d415bd75Srobert std::exit(0);
303*d415bd75Srobert }
304*d415bd75Srobert if (Args.hasArg(OPT_version)) {
305*d415bd75Srobert llvm::outs() << ToolName << '\n';
306*d415bd75Srobert cl::PrintVersionMessage();
307*d415bd75Srobert std::exit(0);
308*d415bd75Srobert }
30909467b48Spatrick
310*d415bd75Srobert DriverConfig Config;
311*d415bd75Srobert for (const opt::Arg *A : Args.filtered(OPT_INPUT))
312*d415bd75Srobert Config.InputFilePaths.push_back(A->getValue());
313*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_input_format_EQ)) {
314*d415bd75Srobert Config.InputFormat = StringSwitch<std::optional<FileFormat>>(A->getValue())
315*d415bd75Srobert .Case("IFS", FileFormat::IFS)
316*d415bd75Srobert .Case("ELF", FileFormat::ELF)
317*d415bd75Srobert .Default(std::nullopt);
318*d415bd75Srobert if (!Config.InputFormat)
319*d415bd75Srobert fatalError(Twine("invalid argument '") + A->getValue());
320*d415bd75Srobert }
321*d415bd75Srobert
322*d415bd75Srobert auto OptionNotFound = [ToolName](StringRef FlagName, StringRef OptionName) {
323*d415bd75Srobert fatalError(Twine(ToolName) + ": for the " + FlagName +
324*d415bd75Srobert " option: Cannot find option named '" + OptionName + "'!");
325*d415bd75Srobert };
326*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_output_format_EQ)) {
327*d415bd75Srobert Config.OutputFormat = StringSwitch<std::optional<FileFormat>>(A->getValue())
328*d415bd75Srobert .Case("IFS", FileFormat::IFS)
329*d415bd75Srobert .Case("ELF", FileFormat::ELF)
330*d415bd75Srobert .Case("TBD", FileFormat::TBD)
331*d415bd75Srobert .Default(std::nullopt);
332*d415bd75Srobert if (!Config.OutputFormat)
333*d415bd75Srobert OptionNotFound("--output-format", A->getValue());
334*d415bd75Srobert }
335*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_arch_EQ))
336*d415bd75Srobert Config.OverrideArch = ELF::convertArchNameToEMachine(A->getValue());
337*d415bd75Srobert
338*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_bitwidth_EQ)) {
339*d415bd75Srobert size_t Width;
340*d415bd75Srobert llvm::StringRef S(A->getValue());
341*d415bd75Srobert if (!S.getAsInteger<size_t>(10, Width) || Width == 64 || Width == 32)
342*d415bd75Srobert Config.OverrideBitWidth =
343*d415bd75Srobert Width == 64 ? IFSBitWidthType::IFS64 : IFSBitWidthType::IFS32;
344*d415bd75Srobert else
345*d415bd75Srobert OptionNotFound("--bitwidth", A->getValue());
346*d415bd75Srobert }
347*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_endianness_EQ)) {
348*d415bd75Srobert Config.OverrideEndianness =
349*d415bd75Srobert StringSwitch<std::optional<IFSEndiannessType>>(A->getValue())
350*d415bd75Srobert .Case("little", IFSEndiannessType::Little)
351*d415bd75Srobert .Case("big", IFSEndiannessType::Big)
352*d415bd75Srobert .Default(std::nullopt);
353*d415bd75Srobert if (!Config.OverrideEndianness)
354*d415bd75Srobert OptionNotFound("--endianness", A->getValue());
355*d415bd75Srobert }
356*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_target_EQ))
357*d415bd75Srobert Config.OptTargetTriple = A->getValue();
358*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_hint_ifs_target_EQ))
359*d415bd75Srobert Config.HintIfsTarget = A->getValue();
360*d415bd75Srobert
361*d415bd75Srobert Config.StripIfsArch = Args.hasArg(OPT_strip_ifs_arch);
362*d415bd75Srobert Config.StripIfsBitwidth = Args.hasArg(OPT_strip_ifs_bitwidth);
363*d415bd75Srobert Config.StripIfsEndianness = Args.hasArg(OPT_strip_ifs_endianness);
364*d415bd75Srobert Config.StripIfsTarget = Args.hasArg(OPT_strip_ifs_target);
365*d415bd75Srobert Config.StripUndefined = Args.hasArg(OPT_strip_undefined);
366*d415bd75Srobert Config.StripNeeded = Args.hasArg(OPT_strip_needed);
367*d415bd75Srobert Config.StripSize = Args.hasArg(OPT_strip_size);
368*d415bd75Srobert
369*d415bd75Srobert for (const opt::Arg *A : Args.filtered(OPT_exclude_EQ))
370*d415bd75Srobert Config.Exclude.push_back(A->getValue());
371*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_soname_EQ))
372*d415bd75Srobert Config.SoName = A->getValue();
373*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_output_EQ))
374*d415bd75Srobert Config.Output = A->getValue();
375*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_output_elf_EQ))
376*d415bd75Srobert Config.OutputElf = A->getValue();
377*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_output_ifs_EQ))
378*d415bd75Srobert Config.OutputIfs = A->getValue();
379*d415bd75Srobert if (const opt::Arg *A = Args.getLastArg(OPT_output_tbd_EQ))
380*d415bd75Srobert Config.OutputTbd = A->getValue();
381*d415bd75Srobert Config.WriteIfChanged = Args.hasArg(OPT_write_if_changed);
382*d415bd75Srobert return Config;
383*d415bd75Srobert }
384*d415bd75Srobert
llvm_ifs_main(int argc,char ** argv)385*d415bd75Srobert int llvm_ifs_main(int argc, char **argv) {
386*d415bd75Srobert DriverConfig Config = parseArgs(argc, argv);
387*d415bd75Srobert
388*d415bd75Srobert if (Config.InputFilePaths.empty())
389*d415bd75Srobert Config.InputFilePaths.push_back("-");
39009467b48Spatrick
39173471bf0Spatrick // If input files are more than one, they can only be IFS files.
392*d415bd75Srobert if (Config.InputFilePaths.size() > 1)
393*d415bd75Srobert Config.InputFormat = FileFormat::IFS;
39473471bf0Spatrick
39573471bf0Spatrick // Attempt to merge input.
39609467b48Spatrick IFSStub Stub;
39709467b48Spatrick std::map<std::string, IFSSymbol> SymbolMap;
39873471bf0Spatrick std::string PreviousInputFilePath;
399*d415bd75Srobert for (const std::string &InputFilePath : Config.InputFilePaths) {
400*d415bd75Srobert Expected<std::unique_ptr<IFSStub>> StubOrErr =
401*d415bd75Srobert readInputFile(Config.InputFormat, InputFilePath);
40273471bf0Spatrick if (!StubOrErr)
40373471bf0Spatrick fatalError(StubOrErr.takeError());
40409467b48Spatrick
40573471bf0Spatrick std::unique_ptr<IFSStub> TargetStub = std::move(StubOrErr.get());
40673471bf0Spatrick if (PreviousInputFilePath.empty()) {
40709467b48Spatrick Stub.IfsVersion = TargetStub->IfsVersion;
40873471bf0Spatrick Stub.Target = TargetStub->Target;
40973471bf0Spatrick Stub.SoName = TargetStub->SoName;
41009467b48Spatrick Stub.NeededLibs = TargetStub->NeededLibs;
41109467b48Spatrick } else {
41209467b48Spatrick if (Stub.IfsVersion != TargetStub->IfsVersion) {
41373471bf0Spatrick if (Stub.IfsVersion.getMajor() != IfsVersionCurrent.getMajor()) {
41409467b48Spatrick WithColor::error()
41509467b48Spatrick << "Interface Stub: IfsVersion Mismatch."
41609467b48Spatrick << "\nFilenames: " << PreviousInputFilePath << " "
41709467b48Spatrick << InputFilePath << "\nIfsVersion Values: " << Stub.IfsVersion
41809467b48Spatrick << " " << TargetStub->IfsVersion << "\n";
41909467b48Spatrick return -1;
42009467b48Spatrick }
42109467b48Spatrick if (TargetStub->IfsVersion > Stub.IfsVersion)
42209467b48Spatrick Stub.IfsVersion = TargetStub->IfsVersion;
42309467b48Spatrick }
42473471bf0Spatrick if (Stub.Target != TargetStub->Target && !TargetStub->Target.empty()) {
42573471bf0Spatrick WithColor::error() << "Interface Stub: Target Mismatch."
42609467b48Spatrick << "\nFilenames: " << PreviousInputFilePath << " "
42773471bf0Spatrick << InputFilePath;
42809467b48Spatrick return -1;
42909467b48Spatrick }
43073471bf0Spatrick if (Stub.SoName != TargetStub->SoName) {
43173471bf0Spatrick WithColor::error() << "Interface Stub: SoName Mismatch."
43209467b48Spatrick << "\nFilenames: " << PreviousInputFilePath << " "
43309467b48Spatrick << InputFilePath
43473471bf0Spatrick << "\nSoName Values: " << Stub.SoName << " "
43573471bf0Spatrick << TargetStub->SoName << "\n";
43609467b48Spatrick return -1;
43709467b48Spatrick }
43809467b48Spatrick if (Stub.NeededLibs != TargetStub->NeededLibs) {
43909467b48Spatrick WithColor::error() << "Interface Stub: NeededLibs Mismatch."
44009467b48Spatrick << "\nFilenames: " << PreviousInputFilePath << " "
44109467b48Spatrick << InputFilePath << "\n";
44209467b48Spatrick return -1;
44309467b48Spatrick }
44409467b48Spatrick }
44509467b48Spatrick
44609467b48Spatrick for (auto Symbol : TargetStub->Symbols) {
44709467b48Spatrick auto SI = SymbolMap.find(Symbol.Name);
44809467b48Spatrick if (SI == SymbolMap.end()) {
44909467b48Spatrick SymbolMap.insert(
45009467b48Spatrick std::pair<std::string, IFSSymbol>(Symbol.Name, Symbol));
45109467b48Spatrick continue;
45209467b48Spatrick }
45309467b48Spatrick
45409467b48Spatrick assert(Symbol.Name == SI->second.Name && "Symbol Names Must Match.");
45509467b48Spatrick
45609467b48Spatrick // Check conflicts:
45709467b48Spatrick if (Symbol.Type != SI->second.Type) {
45809467b48Spatrick WithColor::error() << "Interface Stub: Type Mismatch for "
45909467b48Spatrick << Symbol.Name << ".\nFilename: " << InputFilePath
46009467b48Spatrick << "\nType Values: " << getTypeName(SI->second.Type)
46109467b48Spatrick << " " << getTypeName(Symbol.Type) << "\n";
46209467b48Spatrick
46309467b48Spatrick return -1;
46409467b48Spatrick }
46509467b48Spatrick if (Symbol.Size != SI->second.Size) {
46609467b48Spatrick WithColor::error() << "Interface Stub: Size Mismatch for "
46709467b48Spatrick << Symbol.Name << ".\nFilename: " << InputFilePath
46809467b48Spatrick << "\nSize Values: " << SI->second.Size << " "
46909467b48Spatrick << Symbol.Size << "\n";
47009467b48Spatrick
47109467b48Spatrick return -1;
47209467b48Spatrick }
47309467b48Spatrick if (Symbol.Weak != SI->second.Weak) {
47409467b48Spatrick Symbol.Weak = false;
47509467b48Spatrick continue;
47609467b48Spatrick }
47709467b48Spatrick // TODO: Not checking Warning. Will be dropped.
47809467b48Spatrick }
47909467b48Spatrick
48009467b48Spatrick PreviousInputFilePath = InputFilePath;
48109467b48Spatrick }
48209467b48Spatrick
48373471bf0Spatrick if (Stub.IfsVersion != IfsVersionCurrent)
48473471bf0Spatrick if (Stub.IfsVersion.getMajor() != IfsVersionCurrent.getMajor()) {
48509467b48Spatrick WithColor::error() << "Interface Stub: Bad IfsVersion: "
48609467b48Spatrick << Stub.IfsVersion << ", llvm-ifs supported version: "
48773471bf0Spatrick << IfsVersionCurrent << ".\n";
48809467b48Spatrick return -1;
48909467b48Spatrick }
49009467b48Spatrick
49109467b48Spatrick for (auto &Entry : SymbolMap)
492097a140dSpatrick Stub.Symbols.push_back(Entry.second);
49309467b48Spatrick
49473471bf0Spatrick // Change SoName before emitting stubs.
495*d415bd75Srobert if (Config.SoName)
496*d415bd75Srobert Stub.SoName = *Config.SoName;
497*d415bd75Srobert
498*d415bd75Srobert Error OverrideError =
499*d415bd75Srobert overrideIFSTarget(Stub, Config.OverrideArch, Config.OverrideEndianness,
500*d415bd75Srobert Config.OverrideBitWidth, Config.OptTargetTriple);
50173471bf0Spatrick if (OverrideError)
50273471bf0Spatrick fatalError(std::move(OverrideError));
50309467b48Spatrick
504*d415bd75Srobert if (Config.StripNeeded)
505*d415bd75Srobert Stub.NeededLibs.clear();
506*d415bd75Srobert
507*d415bd75Srobert if (Error E = filterIFSSyms(Stub, Config.StripUndefined, Config.Exclude))
508*d415bd75Srobert fatalError(std::move(E));
509*d415bd75Srobert
510*d415bd75Srobert if (Config.StripSize)
511*d415bd75Srobert for (IFSSymbol &Sym : Stub.Symbols)
512*d415bd75Srobert Sym.Size.reset();
513*d415bd75Srobert
514*d415bd75Srobert if (!Config.OutputElf && !Config.OutputIfs && !Config.OutputTbd) {
515*d415bd75Srobert if (!Config.OutputFormat) {
516*d415bd75Srobert WithColor::error() << "at least one output should be specified.";
517*d415bd75Srobert return -1;
518*d415bd75Srobert }
519*d415bd75Srobert } else if (Config.OutputFormat) {
520*d415bd75Srobert WithColor::error() << "'--output-format' cannot be used with "
521*d415bd75Srobert "'--output-{FILE_FORMAT}' options at the same time";
522*d415bd75Srobert return -1;
523*d415bd75Srobert }
524*d415bd75Srobert if (Config.OutputFormat) {
525*d415bd75Srobert // TODO: Remove OutputFormat flag in the next revision.
526*d415bd75Srobert WithColor::warning() << "--output-format option is deprecated, please use "
527*d415bd75Srobert "--output-{FILE_FORMAT} options instead\n";
528*d415bd75Srobert switch (*Config.OutputFormat) {
52973471bf0Spatrick case FileFormat::TBD: {
53073471bf0Spatrick std::error_code SysErr;
531*d415bd75Srobert raw_fd_ostream Out(*Config.Output, SysErr);
53209467b48Spatrick if (SysErr) {
533*d415bd75Srobert WithColor::error() << "Couldn't open " << *Config.Output
53409467b48Spatrick << " for writing.\n";
53509467b48Spatrick return -1;
53609467b48Spatrick }
53773471bf0Spatrick if (!Stub.Target.Triple) {
53873471bf0Spatrick WithColor::error()
53973471bf0Spatrick << "Triple should be defined when output format is TBD";
54073471bf0Spatrick return -1;
54173471bf0Spatrick }
542*d415bd75Srobert return writeTbdStub(llvm::Triple(*Stub.Target.Triple), Stub.Symbols,
543*d415bd75Srobert "TBD", Out);
54473471bf0Spatrick }
54573471bf0Spatrick case FileFormat::IFS: {
54673471bf0Spatrick Stub.IfsVersion = IfsVersionCurrent;
547*d415bd75Srobert if (*Config.InputFormat == FileFormat::ELF && Config.HintIfsTarget) {
54873471bf0Spatrick std::error_code HintEC(1, std::generic_category());
549*d415bd75Srobert IFSTarget HintTarget = parseTriple(*Config.HintIfsTarget);
550*d415bd75Srobert if (*Stub.Target.Arch != *HintTarget.Arch)
55173471bf0Spatrick fatalError(make_error<StringError>(
55273471bf0Spatrick "Triple hint does not match the actual architecture", HintEC));
553*d415bd75Srobert if (*Stub.Target.Endianness != *HintTarget.Endianness)
55473471bf0Spatrick fatalError(make_error<StringError>(
55573471bf0Spatrick "Triple hint does not match the actual endianness", HintEC));
556*d415bd75Srobert if (*Stub.Target.BitWidth != *HintTarget.BitWidth)
55773471bf0Spatrick fatalError(make_error<StringError>(
55873471bf0Spatrick "Triple hint does not match the actual bit width", HintEC));
55909467b48Spatrick
56073471bf0Spatrick stripIFSTarget(Stub, true, false, false, false);
561*d415bd75Srobert Stub.Target.Triple = *Config.HintIfsTarget;
56273471bf0Spatrick } else {
563*d415bd75Srobert stripIFSTarget(Stub, Config.StripIfsTarget, Config.StripIfsArch,
564*d415bd75Srobert Config.StripIfsEndianness, Config.StripIfsBitwidth);
56573471bf0Spatrick }
566*d415bd75Srobert Error IFSWriteError =
567*d415bd75Srobert writeIFS(*Config.Output, Stub, Config.WriteIfChanged);
56873471bf0Spatrick if (IFSWriteError)
56973471bf0Spatrick fatalError(std::move(IFSWriteError));
57073471bf0Spatrick break;
57173471bf0Spatrick }
57273471bf0Spatrick case FileFormat::ELF: {
57373471bf0Spatrick Error TargetError = validateIFSTarget(Stub, true);
57473471bf0Spatrick if (TargetError)
57573471bf0Spatrick fatalError(std::move(TargetError));
57673471bf0Spatrick Error BinaryWriteError =
577*d415bd75Srobert writeBinaryStub(*Config.Output, Stub, Config.WriteIfChanged);
57873471bf0Spatrick if (BinaryWriteError)
57973471bf0Spatrick fatalError(std::move(BinaryWriteError));
58073471bf0Spatrick break;
58173471bf0Spatrick }
58273471bf0Spatrick }
583*d415bd75Srobert } else {
584*d415bd75Srobert // Check if output path for individual format.
585*d415bd75Srobert if (Config.OutputElf) {
586*d415bd75Srobert Error TargetError = validateIFSTarget(Stub, true);
587*d415bd75Srobert if (TargetError)
588*d415bd75Srobert fatalError(std::move(TargetError));
589*d415bd75Srobert Error BinaryWriteError =
590*d415bd75Srobert writeBinaryStub(*Config.OutputElf, Stub, Config.WriteIfChanged);
591*d415bd75Srobert if (BinaryWriteError)
592*d415bd75Srobert fatalError(std::move(BinaryWriteError));
593*d415bd75Srobert }
594*d415bd75Srobert if (Config.OutputIfs) {
595*d415bd75Srobert Stub.IfsVersion = IfsVersionCurrent;
596*d415bd75Srobert if (*Config.InputFormat == FileFormat::ELF && Config.HintIfsTarget) {
597*d415bd75Srobert std::error_code HintEC(1, std::generic_category());
598*d415bd75Srobert IFSTarget HintTarget = parseTriple(*Config.HintIfsTarget);
599*d415bd75Srobert if (*Stub.Target.Arch != *HintTarget.Arch)
600*d415bd75Srobert fatalError(make_error<StringError>(
601*d415bd75Srobert "Triple hint does not match the actual architecture", HintEC));
602*d415bd75Srobert if (*Stub.Target.Endianness != *HintTarget.Endianness)
603*d415bd75Srobert fatalError(make_error<StringError>(
604*d415bd75Srobert "Triple hint does not match the actual endianness", HintEC));
605*d415bd75Srobert if (*Stub.Target.BitWidth != *HintTarget.BitWidth)
606*d415bd75Srobert fatalError(make_error<StringError>(
607*d415bd75Srobert "Triple hint does not match the actual bit width", HintEC));
608*d415bd75Srobert
609*d415bd75Srobert stripIFSTarget(Stub, true, false, false, false);
610*d415bd75Srobert Stub.Target.Triple = *Config.HintIfsTarget;
611*d415bd75Srobert } else {
612*d415bd75Srobert stripIFSTarget(Stub, Config.StripIfsTarget, Config.StripIfsArch,
613*d415bd75Srobert Config.StripIfsEndianness, Config.StripIfsBitwidth);
614*d415bd75Srobert }
615*d415bd75Srobert Error IFSWriteError =
616*d415bd75Srobert writeIFS(*Config.OutputIfs, Stub, Config.WriteIfChanged);
617*d415bd75Srobert if (IFSWriteError)
618*d415bd75Srobert fatalError(std::move(IFSWriteError));
619*d415bd75Srobert }
620*d415bd75Srobert if (Config.OutputTbd) {
621*d415bd75Srobert std::error_code SysErr;
622*d415bd75Srobert raw_fd_ostream Out(*Config.OutputTbd, SysErr);
623*d415bd75Srobert if (SysErr) {
624*d415bd75Srobert WithColor::error() << "Couldn't open " << *Config.OutputTbd
625*d415bd75Srobert << " for writing.\n";
626*d415bd75Srobert return -1;
627*d415bd75Srobert }
628*d415bd75Srobert if (!Stub.Target.Triple) {
629*d415bd75Srobert WithColor::error()
630*d415bd75Srobert << "Triple should be defined when output format is TBD";
631*d415bd75Srobert return -1;
632*d415bd75Srobert }
633*d415bd75Srobert return writeTbdStub(llvm::Triple(*Stub.Target.Triple), Stub.Symbols,
634*d415bd75Srobert "TBD", Out);
635*d415bd75Srobert }
636*d415bd75Srobert }
63773471bf0Spatrick return 0;
63809467b48Spatrick }
639