1 //===-- llc.cpp - Implement the LLVM Native Code Generator ----------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the llc code generator driver. It provides a convenient
11 // command-line interface for generating native assembly-language code
12 // or C code, given LLVM bytecode.
14 //===----------------------------------------------------------------------===//
16 #include "llvm/Bitcode/ReaderWriter.h"
17 #include "llvm/CodeGen/FileWriters.h"
18 #include "llvm/CodeGen/LinkAllCodegenComponents.h"
19 #include "llvm/Target/SubtargetFeature.h"
20 #include "llvm/Target/TargetData.h"
21 #include "llvm/Target/TargetMachine.h"
22 #include "llvm/Target/TargetMachineRegistry.h"
23 #include "llvm/Transforms/Scalar.h"
24 #include "llvm/Module.h"
25 #include "llvm/ModuleProvider.h"
26 #include "llvm/PassManager.h"
27 #include "llvm/Pass.h"
28 #include "llvm/Support/CommandLine.h"
29 #include "llvm/Support/ManagedStatic.h"
30 #include "llvm/Support/MemoryBuffer.h"
31 #include "llvm/Support/PluginLoader.h"
32 #include "llvm/Support/FileUtilities.h"
33 #include "llvm/Analysis/Verifier.h"
34 #include "llvm/System/Signals.h"
35 #include "llvm/Config/config.h"
36 #include "llvm/LinkAllVMCore.h"
42 // General options for llc. Other pass-specific options are specified
43 // within the corresponding llc passes, and target-specific options
44 // and back-end code generation options are specified with the target machine.
46 static cl::opt<std::string>
47 InputFilename(cl::Positional, cl::desc("<input bytecode>"), cl::init("-"));
49 static cl::opt<std::string>
50 OutputFilename("o", cl::desc("Output filename"), cl::value_desc("filename"));
52 static cl::opt<bool> Force("f", cl::desc("Overwrite output files"));
54 static cl::opt<bool> Fast("fast",
55 cl::desc("Generate code quickly, potentially sacrificing code quality"));
57 static cl::opt<std::string>
58 TargetTriple("mtriple", cl::desc("Override target triple for module"));
60 static cl::opt<const TargetMachineRegistry::Entry*, false, TargetNameParser>
61 MArch("march", cl::desc("Architecture to generate code for:"));
63 static cl::opt<std::string>
65 cl::desc("Target a specific cpu type (-mcpu=help for details)"),
66 cl::value_desc("cpu-name"),
69 static cl::list<std::string>
72 cl::desc("Target specific attributes (-mattr=help for details)"),
73 cl::value_desc("a1,+a2,-a3,..."));
75 cl::opt<TargetMachine::CodeGenFileType>
76 FileType("filetype", cl::init(TargetMachine::AssemblyFile),
77 cl::desc("Choose a file type (not all types are supported by all targets):"),
79 clEnumValN(TargetMachine::AssemblyFile, "asm",
80 " Emit an assembly ('.s') file"),
81 clEnumValN(TargetMachine::ObjectFile, "obj",
82 " Emit a native object ('.o') file [experimental]"),
83 clEnumValN(TargetMachine::DynamicLibrary, "dynlib",
84 " Emit a native dynamic library ('.so') file"
88 cl::opt<bool> NoVerify("disable-verify", cl::Hidden,
89 cl::desc("Do not verify input module"));
92 // GetFileNameRoot - Helper function to get the basename of a filename.
93 static inline std::string
94 GetFileNameRoot(const std::string &InputFilename) {
95 std::string IFN = InputFilename;
96 std::string outputFilename;
97 int Len = IFN.length();
99 IFN[Len-3] == '.' && IFN[Len-2] == 'b' && IFN[Len-1] == 'c') {
100 outputFilename = std::string(IFN.begin(), IFN.end()-3); // s/.bc/.s/
102 outputFilename = IFN;
104 return outputFilename;
107 static std::ostream *GetOutputStream(const char *ProgName) {
108 if (OutputFilename != "") {
109 if (OutputFilename == "-")
112 // Specified an output filename?
113 if (!Force && std::ifstream(OutputFilename.c_str())) {
114 // If force is not specified, make sure not to overwrite a file!
115 std::cerr << ProgName << ": error opening '" << OutputFilename
116 << "': file exists!\n"
117 << "Use -f command line argument to force output\n";
120 // Make sure that the Out file gets unlinked from the disk if we get a
122 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
124 return new std::ofstream(OutputFilename.c_str());
127 if (InputFilename == "-") {
128 OutputFilename = "-";
132 OutputFilename = GetFileNameRoot(InputFilename);
135 case TargetMachine::AssemblyFile:
136 if (MArch->Name[0] != 'c' || MArch->Name[1] != 0) // not CBE
137 OutputFilename += ".s";
139 OutputFilename += ".cbe.c";
141 case TargetMachine::ObjectFile:
142 OutputFilename += ".o";
144 case TargetMachine::DynamicLibrary:
145 OutputFilename += LTDL_SHLIB_EXT;
149 if (!Force && std::ifstream(OutputFilename.c_str())) {
150 // If force is not specified, make sure not to overwrite a file!
151 std::cerr << ProgName << ": error opening '" << OutputFilename
152 << "': file exists!\n"
153 << "Use -f command line argument to force output\n";
157 // Make sure that the Out file gets unlinked from the disk if we get a
159 sys::RemoveFileOnSignal(sys::Path(OutputFilename));
161 std::ostream *Out = new std::ofstream(OutputFilename.c_str());
163 std::cerr << ProgName << ": error opening " << OutputFilename << "!\n";
171 // main - Entry point for the llc compiler.
173 int main(int argc, char **argv) {
174 llvm_shutdown_obj X; // Call llvm_shutdown() on exit.
175 cl::ParseCommandLineOptions(argc, argv, " llvm system compiler\n");
176 sys::PrintStackTraceOnErrorSignal();
178 // Load the module to be compiled...
179 std::string ErrorMessage;
180 std::auto_ptr<Module> M;
183 std::auto_ptr<MemoryBuffer> Buffer(
184 MemoryBuffer::getFileOrSTDIN(&InputFilename[0], InputFilename.size()));
186 M.reset(ParseBitcodeFile(Buffer.get(), &ErrorMessage));
188 ErrorMessage = "Error reading file '" + InputFilename + "'";
191 std::cerr << argv[0] << ": bytecode didn't read correctly.\n";
192 std::cerr << "Reason: " << ErrorMessage << "\n";
195 Module &mod = *M.get();
197 // If we are supposed to override the target triple, do so now.
198 if (!TargetTriple.empty())
199 mod.setTargetTriple(TargetTriple);
201 // Allocate target machine. First, check whether the user has
202 // explicitly specified an architecture to compile for.
205 MArch = TargetMachineRegistry::getClosestStaticTargetForModule(mod, Err);
207 std::cerr << argv[0] << ": error auto-selecting target for module '"
208 << Err << "'. Please use the -march option to explicitly "
209 << "pick a target.\n";
214 // Package up features to be passed to target/subtarget
215 std::string FeaturesStr;
216 if (MCPU.size() || MAttrs.size()) {
217 SubtargetFeatures Features;
218 Features.setCPU(MCPU);
219 for (unsigned i = 0; i != MAttrs.size(); ++i)
220 Features.AddFeature(MAttrs[i]);
221 FeaturesStr = Features.getString();
224 std::auto_ptr<TargetMachine> target(MArch->CtorFn(mod, FeaturesStr));
225 assert(target.get() && "Could not allocate target machine!");
226 TargetMachine &Target = *target.get();
228 // Figure out where we are going to send the output...
229 std::ostream *Out = GetOutputStream(argv[0]);
230 if (Out == 0) return 1;
232 // If this target requires addPassesToEmitWholeFile, do it now. This is
233 // used by strange things like the C backend.
234 if (Target.WantsWholeFile()) {
236 PM.add(new TargetData(*Target.getTargetData()));
238 PM.add(createVerifierPass());
240 // Ask the target to add backend passes as necessary.
241 if (Target.addPassesToEmitWholeFile(PM, *Out, FileType, Fast)) {
242 std::cerr << argv[0] << ": target does not support generation of this"
244 if (Out != &std::cout) delete Out;
245 // And the Out file is empty and useless, so remove it now.
246 sys::Path(OutputFilename).eraseFromDisk();
251 // Build up all of the passes that we want to do to the module.
252 FunctionPassManager Passes(new ExistingModuleProvider(M.get()));
253 Passes.add(new TargetData(*Target.getTargetData()));
257 Passes.add(createVerifierPass());
260 // Ask the target to add backend passes as necessary.
261 MachineCodeEmitter *MCE = 0;
263 switch (Target.addPassesToEmitFile(Passes, *Out, FileType, Fast)) {
265 assert(0 && "Invalid file model!");
267 case FileModel::Error:
268 std::cerr << argv[0] << ": target does not support generation of this"
270 if (Out != &std::cout) delete Out;
271 // And the Out file is empty and useless, so remove it now.
272 sys::Path(OutputFilename).eraseFromDisk();
274 case FileModel::AsmFile:
276 case FileModel::MachOFile:
277 MCE = AddMachOWriter(Passes, *Out, Target);
279 case FileModel::ElfFile:
280 MCE = AddELFWriter(Passes, *Out, Target);
284 if (Target.addPassesToEmitFileFinish(Passes, MCE, Fast)) {
285 std::cerr << argv[0] << ": target does not support generation of this"
287 if (Out != &std::cout) delete Out;
288 // And the Out file is empty and useless, so remove it now.
289 sys::Path(OutputFilename).eraseFromDisk();
293 Passes.doInitialization();
295 // Run our queue of passes all at once now, efficiently.
296 // TODO: this could lazily stream functions out of the module.
297 for (Module::iterator I = mod.begin(), E = mod.end(); I != E; ++I)
298 if (!I->isDeclaration())
301 Passes.doFinalization();
304 // Delete the ostream if it's not a stdout stream
305 if (Out != &std::cout) delete Out;