contrib/llvm/tools/lld/COFF/Driver.h

   1 //===- Driver.h -------------------------------------------------*- C++ -*-===//
   2 //
   3 //                             The LLVM Linker
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLD_COFF_DRIVER_H
  11 #define LLD_COFF_DRIVER_H
  12
  13 #include "Config.h"
  14 #include "SymbolTable.h"
  15 #include "lld/Common/LLVM.h"
  16 #include "lld/Common/Reproduce.h"
  17 #include "llvm/ADT/Optional.h"
  18 #include "llvm/ADT/StringRef.h"
  19 #include "llvm/ADT/StringSet.h"
  20 #include "llvm/Object/Archive.h"
  21 #include "llvm/Object/COFF.h"
  22 #include "llvm/Option/Arg.h"
  23 #include "llvm/Option/ArgList.h"
  24 #include "llvm/Support/TarWriter.h"
  25 #include <memory>
  26 #include <set>
  27 #include <vector>
  28
  29 namespace lld {
  30 namespace coff {
  31
  32 class LinkerDriver;
  33 extern LinkerDriver *Driver;
  34
  35 using llvm::COFF::MachineTypes;
  36 using llvm::COFF::WindowsSubsystem;
  37 using llvm::Optional;
  38
  39 // Implemented in MarkLive.cpp.
  40 void markLive(ArrayRef<Chunk *> Chunks);
  41
  42 // Implemented in ICF.cpp.
  43 void doICF(ArrayRef<Chunk *> Chunks);
  44
  45 class COFFOptTable : public llvm::opt::OptTable {
  46 public:
  47   COFFOptTable();
  48 };
  49
  50 class ArgParser {
  51 public:
  52   // Concatenate LINK environment variable and given arguments and parse them.
  53   llvm::opt::InputArgList parseLINK(std::vector<const char *> Args);
  54
  55   // Tokenizes a given string and then parses as command line options.
  56   llvm::opt::InputArgList parse(StringRef S) { return parse(tokenize(S)); }
  57
  58   // Tokenizes a given string and then parses as command line options in
  59   // .drectve section.
  60   llvm::opt::InputArgList parseDirectives(StringRef S);
  61
  62 private:
  63   // Parses command line options.
  64   llvm::opt::InputArgList parse(llvm::ArrayRef<const char *> Args);
  65
  66   std::vector<const char *> tokenize(StringRef S);
  67
  68   COFFOptTable Table;
  69 };
  70
  71 class LinkerDriver {
  72 public:
  73   void link(llvm::ArrayRef<const char *> Args);
  74
  75   // Used by the resolver to parse .drectve section contents.
  76   void parseDirectives(StringRef S);
  77
  78   // Used by ArchiveFile to enqueue members.
  79   void enqueueArchiveMember(const Archive::Child &C, StringRef SymName,
  80                             StringRef ParentName);
  81
  82   MemoryBufferRef takeBuffer(std::unique_ptr<MemoryBuffer> MB);
  83
  84 private:
  85   std::unique_ptr<llvm::TarWriter> Tar; // for /linkrepro
  86
  87   // Opens a file. Path has to be resolved already.
  88   MemoryBufferRef openFile(StringRef Path);
  89
  90   // Searches a file from search paths.
  91   Optional<StringRef> findFile(StringRef Filename);
  92   Optional<StringRef> findLib(StringRef Filename);
  93   StringRef doFindFile(StringRef Filename);
  94   StringRef doFindLib(StringRef Filename);
  95
  96   // Parses LIB environment which contains a list of search paths.
  97   void addLibSearchPaths();
  98
  99   // Library search path. The first element is always "" (current directory).
 100   std::vector<StringRef> SearchPaths;
 101   std::set<std::string> VisitedFiles;
 102   std::set<std::string> VisitedLibs;
 103
 104   Symbol *addUndefined(StringRef Sym);
 105   StringRef mangle(StringRef Sym);
 106
 107   // Windows specific -- "main" is not the only main function in Windows.
 108   // You can choose one from these four -- {w,}{WinMain,main}.
 109   // There are four different entry point functions for them,
 110   // {w,}{WinMain,main}CRTStartup, respectively. The linker needs to
 111   // choose the right one depending on which "main" function is defined.
 112   // This function looks up the symbol table and resolve corresponding
 113   // entry point name.
 114   StringRef findDefaultEntry();
 115   WindowsSubsystem inferSubsystem();
 116
 117   void invokeMSVC(llvm::opt::InputArgList &Args);
 118
 119   void addBuffer(std::unique_ptr<MemoryBuffer> MB, bool WholeArchive);
 120   void addArchiveBuffer(MemoryBufferRef MBRef, StringRef SymName,
 121                         StringRef ParentName);
 122
 123   void enqueuePath(StringRef Path, bool WholeArchive);
 124
 125   void enqueueTask(std::function<void()> Task);
 126   bool run();
 127
 128   std::list<std::function<void()>> TaskQueue;
 129   std::vector<StringRef> FilePaths;
 130   std::vector<MemoryBufferRef> Resources;
 131
 132   llvm::StringSet<> DirectivesExports;
 133 };
 134
 135 // Functions below this line are defined in DriverUtils.cpp.
 136
 137 void printHelp(const char *Argv0);
 138
 139 // For /machine option.
 140 MachineTypes getMachineType(StringRef Arg);
 141 StringRef machineToStr(MachineTypes MT);
 142
 143 // Parses a string in the form of "<integer>[,<integer>]".
 144 void parseNumbers(StringRef Arg, uint64_t *Addr, uint64_t *Size = nullptr);
 145
 146 // Parses a string in the form of "<integer>[.<integer>]".
 147 // Minor's default value is 0.
 148 void parseVersion(StringRef Arg, uint32_t *Major, uint32_t *Minor);
 149
 150 // Parses a string in the form of "<subsystem>[,<integer>[.<integer>]]".
 151 void parseSubsystem(StringRef Arg, WindowsSubsystem *Sys, uint32_t *Major,
 152                     uint32_t *Minor);
 153
 154 void parseAlternateName(StringRef);
 155 void parseMerge(StringRef);
 156 void parseSection(StringRef);
 157 void parseAligncomm(StringRef);
 158
 159 // Parses a string in the form of "EMBED[,=<integer>]|NO".
 160 void parseManifest(StringRef Arg);
 161
 162 // Parses a string in the form of "level=<string>|uiAccess=<string>"
 163 void parseManifestUAC(StringRef Arg);
 164
 165 // Create a resource file containing a manifest XML.
 166 std::unique_ptr<MemoryBuffer> createManifestRes();
 167 void createSideBySideManifest();
 168
 169 // Used for dllexported symbols.
 170 Export parseExport(StringRef Arg);
 171 void fixupExports();
 172 void assignExportOrdinals();
 173
 174 // Parses a string in the form of "key=value" and check
 175 // if value matches previous values for the key.
 176 // This feature used in the directive section to reject
 177 // incompatible objects.
 178 void checkFailIfMismatch(StringRef Arg);
 179
 180 // Convert Windows resource files (.res files) to a .obj file.
 181 MemoryBufferRef convertResToCOFF(ArrayRef<MemoryBufferRef> MBs);
 182
 183 void runMSVCLinker(std::string Rsp, ArrayRef<StringRef> Objects);
 184
 185 // Create enum with OPT_xxx values for each option in Options.td
 186 enum {
 187   OPT_INVALID = 0,
 188 #define OPTION(_1, _2, ID, _4, _5, _6, _7, _8, _9, _10, _11, _12) OPT_##ID,
 189 #include "Options.inc"
 190 #undef OPTION
 191 };
 192
 193 } // namespace coff
 194 } // namespace lld
 195
 196 #endif