1 //===-- cc1as_main.cpp - Clang Assembler ---------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This is the entry point to the clang -cc1as functionality, which implements
11 // the direct interface to the LLVM MC based assembler.
13 //===----------------------------------------------------------------------===//
15 #include "clang/Basic/Diagnostic.h"
16 #include "clang/Basic/DiagnosticOptions.h"
17 #include "clang/Driver/DriverDiagnostic.h"
18 #include "clang/Driver/Options.h"
19 #include "clang/Frontend/FrontendDiagnostic.h"
20 #include "clang/Frontend/TextDiagnosticPrinter.h"
21 #include "clang/Frontend/Utils.h"
22 #include "llvm/ADT/STLExtras.h"
23 #include "llvm/ADT/StringSwitch.h"
24 #include "llvm/ADT/Triple.h"
25 #include "llvm/IR/DataLayout.h"
26 #include "llvm/MC/MCAsmBackend.h"
27 #include "llvm/MC/MCAsmInfo.h"
28 #include "llvm/MC/MCCodeEmitter.h"
29 #include "llvm/MC/MCContext.h"
30 #include "llvm/MC/MCInstrInfo.h"
31 #include "llvm/MC/MCObjectFileInfo.h"
32 #include "llvm/MC/MCParser/MCAsmParser.h"
33 #include "llvm/MC/MCRegisterInfo.h"
34 #include "llvm/MC/MCStreamer.h"
35 #include "llvm/MC/MCSubtargetInfo.h"
36 #include "llvm/MC/MCTargetAsmParser.h"
37 #include "llvm/MC/MCTargetOptions.h"
38 #include "llvm/Option/Arg.h"
39 #include "llvm/Option/ArgList.h"
40 #include "llvm/Option/OptTable.h"
41 #include "llvm/Support/CommandLine.h"
42 #include "llvm/Support/ErrorHandling.h"
43 #include "llvm/Support/FileSystem.h"
44 #include "llvm/Support/FormattedStream.h"
45 #include "llvm/Support/Host.h"
46 #include "llvm/Support/ManagedStatic.h"
47 #include "llvm/Support/MemoryBuffer.h"
48 #include "llvm/Support/Path.h"
49 #include "llvm/Support/PrettyStackTrace.h"
50 #include "llvm/Support/Signals.h"
51 #include "llvm/Support/SourceMgr.h"
52 #include "llvm/Support/TargetRegistry.h"
53 #include "llvm/Support/TargetSelect.h"
54 #include "llvm/Support/Timer.h"
55 #include "llvm/Support/raw_ostream.h"
57 #include <system_error>
58 using namespace clang;
59 using namespace clang::driver;
60 using namespace clang::driver::options;
62 using namespace llvm::opt;
66 /// \brief Helper class for representing a single invocation of the assembler.
67 struct AssemblerInvocation {
68 /// @name Target Options
71 /// The name of the target triple to assemble for.
74 /// If given, the name of the target CPU to determine which instructions
78 /// The list of target specific features to enable or disable -- this should
79 /// be a list of strings starting with '+' or '-'.
80 std::vector<std::string> Features;
83 /// @name Language Options
86 std::vector<std::string> IncludePaths;
87 unsigned NoInitialTextSection : 1;
88 unsigned SaveTemporaryLabels : 1;
89 unsigned GenDwarfForAssembly : 1;
90 unsigned CompressDebugSections : 1;
91 unsigned DwarfVersion;
92 std::string DwarfDebugFlags;
93 std::string DwarfDebugProducer;
94 std::string DebugCompilationDir;
95 std::string MainFileName;
98 /// @name Frontend Options
101 std::string InputFile;
102 std::vector<std::string> LLVMArgs;
103 std::string OutputPath;
105 FT_Asm, ///< Assembly (.s) output, transliterate mode.
106 FT_Null, ///< No output, for timing purposes.
107 FT_Obj ///< Object file output.
110 unsigned ShowHelp : 1;
111 unsigned ShowVersion : 1;
114 /// @name Transliterate Options
117 unsigned OutputAsmVariant;
118 unsigned ShowEncoding : 1;
119 unsigned ShowInst : 1;
122 /// @name Assembler Options
125 unsigned RelaxAll : 1;
126 unsigned NoExecStack : 1;
127 unsigned FatalWarnings : 1;
132 AssemblerInvocation() {
134 NoInitialTextSection = 0;
138 OutputAsmVariant = 0;
147 static bool CreateFromArgs(AssemblerInvocation &Res,
148 ArrayRef<const char *> Argv,
149 DiagnosticsEngine &Diags);
154 bool AssemblerInvocation::CreateFromArgs(AssemblerInvocation &Opts,
155 ArrayRef<const char *> Argv,
156 DiagnosticsEngine &Diags) {
159 // Parse the arguments.
160 std::unique_ptr<OptTable> OptTbl(createDriverOptTable());
162 const unsigned IncludedFlagsBitmask = options::CC1AsOption;
163 unsigned MissingArgIndex, MissingArgCount;
164 InputArgList Args = OptTbl->ParseArgs(Argv, MissingArgIndex, MissingArgCount,
165 IncludedFlagsBitmask);
167 // Check for missing argument error.
168 if (MissingArgCount) {
169 Diags.Report(diag::err_drv_missing_argument)
170 << Args.getArgString(MissingArgIndex) << MissingArgCount;
174 // Issue errors on unknown arguments.
175 for (const Arg *A : Args.filtered(OPT_UNKNOWN)) {
176 Diags.Report(diag::err_drv_unknown_argument) << A->getAsString(Args);
180 // Construct the invocation.
183 Opts.Triple = llvm::Triple::normalize(Args.getLastArgValue(OPT_triple));
184 Opts.CPU = Args.getLastArgValue(OPT_target_cpu);
185 Opts.Features = Args.getAllArgValues(OPT_target_feature);
187 // Use the default target triple if unspecified.
188 if (Opts.Triple.empty())
189 Opts.Triple = llvm::sys::getDefaultTargetTriple();
192 Opts.IncludePaths = Args.getAllArgValues(OPT_I);
193 Opts.NoInitialTextSection = Args.hasArg(OPT_n);
194 Opts.SaveTemporaryLabels = Args.hasArg(OPT_msave_temp_labels);
195 Opts.GenDwarfForAssembly = Args.hasArg(OPT_g_Flag);
196 Opts.CompressDebugSections = Args.hasArg(OPT_compress_debug_sections);
197 if (Args.hasArg(OPT_gdwarf_2))
198 Opts.DwarfVersion = 2;
199 if (Args.hasArg(OPT_gdwarf_3))
200 Opts.DwarfVersion = 3;
201 if (Args.hasArg(OPT_gdwarf_4))
202 Opts.DwarfVersion = 4;
203 Opts.DwarfDebugFlags = Args.getLastArgValue(OPT_dwarf_debug_flags);
204 Opts.DwarfDebugProducer = Args.getLastArgValue(OPT_dwarf_debug_producer);
205 Opts.DebugCompilationDir = Args.getLastArgValue(OPT_fdebug_compilation_dir);
206 Opts.MainFileName = Args.getLastArgValue(OPT_main_file_name);
209 if (Args.hasArg(OPT_INPUT)) {
211 for (arg_iterator it = Args.filtered_begin(OPT_INPUT),
212 ie = Args.filtered_end();
213 it != ie; ++it, First = false) {
216 Opts.InputFile = A->getValue();
218 Diags.Report(diag::err_drv_unknown_argument) << A->getAsString(Args);
223 Opts.LLVMArgs = Args.getAllArgValues(OPT_mllvm);
224 Opts.OutputPath = Args.getLastArgValue(OPT_o);
225 if (Arg *A = Args.getLastArg(OPT_filetype)) {
226 StringRef Name = A->getValue();
227 unsigned OutputType = StringSwitch<unsigned>(Name)
229 .Case("null", FT_Null)
232 if (OutputType == ~0U) {
233 Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << Name;
236 Opts.OutputType = FileType(OutputType);
238 Opts.ShowHelp = Args.hasArg(OPT_help);
239 Opts.ShowVersion = Args.hasArg(OPT_version);
241 // Transliterate Options
242 Opts.OutputAsmVariant =
243 getLastArgIntValue(Args, OPT_output_asm_variant, 0, Diags);
244 Opts.ShowEncoding = Args.hasArg(OPT_show_encoding);
245 Opts.ShowInst = Args.hasArg(OPT_show_inst);
248 Opts.RelaxAll = Args.hasArg(OPT_mrelax_all);
249 Opts.NoExecStack = Args.hasArg(OPT_mno_exec_stack);
250 Opts.FatalWarnings = Args.hasArg(OPT_massembler_fatal_warnings);
255 static std::unique_ptr<raw_fd_ostream>
256 getOutputStream(AssemblerInvocation &Opts, DiagnosticsEngine &Diags,
258 if (Opts.OutputPath.empty())
259 Opts.OutputPath = "-";
261 // Make sure that the Out file gets unlinked from the disk if we get a
263 if (Opts.OutputPath != "-")
264 sys::RemoveFileOnSignal(Opts.OutputPath);
267 auto Out = llvm::make_unique<raw_fd_ostream>(
268 Opts.OutputPath, EC, (Binary ? sys::fs::F_None : sys::fs::F_Text));
270 Diags.Report(diag::err_fe_unable_to_open_output) << Opts.OutputPath
278 static bool ExecuteAssembler(AssemblerInvocation &Opts,
279 DiagnosticsEngine &Diags) {
280 // Get the target specific parser.
282 const Target *TheTarget = TargetRegistry::lookupTarget(Opts.Triple, Error);
284 return Diags.Report(diag::err_target_unknown_triple) << Opts.Triple;
286 ErrorOr<std::unique_ptr<MemoryBuffer>> Buffer =
287 MemoryBuffer::getFileOrSTDIN(Opts.InputFile);
289 if (std::error_code EC = Buffer.getError()) {
290 Error = EC.message();
291 return Diags.Report(diag::err_fe_error_reading) << Opts.InputFile;
296 // Tell SrcMgr about this buffer, which is what the parser will pick up.
297 SrcMgr.AddNewSourceBuffer(std::move(*Buffer), SMLoc());
299 // Record the location of the include directories so that the lexer can find
301 SrcMgr.setIncludeDirs(Opts.IncludePaths);
303 std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(Opts.Triple));
304 assert(MRI && "Unable to create target register info!");
306 std::unique_ptr<MCAsmInfo> MAI(TheTarget->createMCAsmInfo(*MRI, Opts.Triple));
307 assert(MAI && "Unable to create target asm info!");
309 // Ensure MCAsmInfo initialization occurs before any use, otherwise sections
310 // may be created with a combination of default and explicit settings.
311 if (Opts.CompressDebugSections)
312 MAI->setCompressDebugSections(true);
314 bool IsBinary = Opts.OutputType == AssemblerInvocation::FT_Obj;
315 std::unique_ptr<raw_fd_ostream> FDOS = getOutputStream(Opts, Diags, IsBinary);
319 // FIXME: This is not pretty. MCContext has a ptr to MCObjectFileInfo and
320 // MCObjectFileInfo needs a MCContext reference in order to initialize itself.
321 std::unique_ptr<MCObjectFileInfo> MOFI(new MCObjectFileInfo());
323 MCContext Ctx(MAI.get(), MRI.get(), MOFI.get(), &SrcMgr);
324 // FIXME: Assembler behavior can change with -static.
325 MOFI->InitMCObjectFileInfo(Triple(Opts.Triple), Reloc::Default,
326 CodeModel::Default, Ctx);
327 if (Opts.SaveTemporaryLabels)
328 Ctx.setAllowTemporaryLabels(false);
329 if (Opts.GenDwarfForAssembly)
330 Ctx.setGenDwarfForAssembly(true);
331 if (!Opts.DwarfDebugFlags.empty())
332 Ctx.setDwarfDebugFlags(StringRef(Opts.DwarfDebugFlags));
333 if (!Opts.DwarfDebugProducer.empty())
334 Ctx.setDwarfDebugProducer(StringRef(Opts.DwarfDebugProducer));
335 if (!Opts.DebugCompilationDir.empty())
336 Ctx.setCompilationDir(Opts.DebugCompilationDir);
337 if (!Opts.MainFileName.empty())
338 Ctx.setMainFileName(StringRef(Opts.MainFileName));
339 Ctx.setDwarfVersion(Opts.DwarfVersion);
341 // Build up the feature string from the target feature list.
343 if (!Opts.Features.empty()) {
344 FS = Opts.Features[0];
345 for (unsigned i = 1, e = Opts.Features.size(); i != e; ++i)
346 FS += "," + Opts.Features[i];
349 std::unique_ptr<MCStreamer> Str;
351 std::unique_ptr<MCInstrInfo> MCII(TheTarget->createMCInstrInfo());
352 std::unique_ptr<MCSubtargetInfo> STI(
353 TheTarget->createMCSubtargetInfo(Opts.Triple, Opts.CPU, FS));
355 raw_pwrite_stream *Out = FDOS.get();
356 std::unique_ptr<buffer_ostream> BOS;
358 // FIXME: There is a bit of code duplication with addPassesToEmitFile.
359 if (Opts.OutputType == AssemblerInvocation::FT_Asm) {
360 MCInstPrinter *IP = TheTarget->createMCInstPrinter(
361 llvm::Triple(Opts.Triple), Opts.OutputAsmVariant, *MAI, *MCII, *MRI);
362 MCCodeEmitter *CE = nullptr;
363 MCAsmBackend *MAB = nullptr;
364 if (Opts.ShowEncoding) {
365 CE = TheTarget->createMCCodeEmitter(*MCII, *MRI, Ctx);
366 MAB = TheTarget->createMCAsmBackend(*MRI, Opts.Triple, Opts.CPU);
368 auto FOut = llvm::make_unique<formatted_raw_ostream>(*Out);
369 Str.reset(TheTarget->createAsmStreamer(
370 Ctx, std::move(FOut), /*asmverbose*/ true,
371 /*useDwarfDirectory*/ true, IP, CE, MAB, Opts.ShowInst));
372 } else if (Opts.OutputType == AssemblerInvocation::FT_Null) {
373 Str.reset(createNullStreamer(Ctx));
375 assert(Opts.OutputType == AssemblerInvocation::FT_Obj &&
376 "Invalid file type!");
377 if (!FDOS->supportsSeeking()) {
378 BOS = make_unique<buffer_ostream>(*FDOS);
382 MCCodeEmitter *CE = TheTarget->createMCCodeEmitter(*MCII, *MRI, Ctx);
383 MCAsmBackend *MAB = TheTarget->createMCAsmBackend(*MRI, Opts.Triple,
385 Triple T(Opts.Triple);
386 Str.reset(TheTarget->createMCObjectStreamer(T, Ctx, *MAB, *Out, CE, *STI,
388 /*DWARFMustBeAtTheEnd*/ true));
389 Str.get()->InitSections(Opts.NoExecStack);
394 std::unique_ptr<MCAsmParser> Parser(
395 createMCAsmParser(SrcMgr, Ctx, *Str.get(), *MAI));
397 // FIXME: init MCTargetOptions from sanitizer flags here.
398 MCTargetOptions Options;
399 std::unique_ptr<MCTargetAsmParser> TAP(
400 TheTarget->createMCAsmParser(*STI, *Parser, *MCII, Options));
402 Failed = Diags.Report(diag::err_target_unknown_triple) << Opts.Triple;
405 Parser->setTargetParser(*TAP.get());
406 Failed = Parser->Run(Opts.NoInitialTextSection);
409 // Close Streamer first.
410 // It might have a reference to the output stream.
412 // Close the output stream early.
416 // Delete output file if there were errors.
417 if (Failed && Opts.OutputPath != "-")
418 sys::fs::remove(Opts.OutputPath);
423 static void LLVMErrorHandler(void *UserData, const std::string &Message,
425 DiagnosticsEngine &Diags = *static_cast<DiagnosticsEngine*>(UserData);
427 Diags.Report(diag::err_fe_error_backend) << Message;
429 // We cannot recover from llvm errors.
433 int cc1as_main(ArrayRef<const char *> Argv, const char *Argv0, void *MainAddr) {
434 // Print a stack trace if we signal out.
435 sys::PrintStackTraceOnErrorSignal();
436 PrettyStackTraceProgram X(Argv.size(), Argv.data());
437 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
439 // Initialize targets and assembly printers/parsers.
440 InitializeAllTargetInfos();
441 InitializeAllTargetMCs();
442 InitializeAllAsmParsers();
444 // Construct our diagnostic client.
445 IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
446 TextDiagnosticPrinter *DiagClient
447 = new TextDiagnosticPrinter(errs(), &*DiagOpts);
448 DiagClient->setPrefix("clang -cc1as");
449 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
450 DiagnosticsEngine Diags(DiagID, &*DiagOpts, DiagClient);
452 // Set an error handler, so that any LLVM backend diagnostics go through our
454 ScopedFatalErrorHandler FatalErrorHandler
455 (LLVMErrorHandler, static_cast<void*>(&Diags));
457 // Parse the arguments.
458 AssemblerInvocation Asm;
459 if (!AssemblerInvocation::CreateFromArgs(Asm, Argv, Diags))
463 std::unique_ptr<OptTable> Opts(driver::createDriverOptTable());
464 Opts->PrintHelp(llvm::outs(), "clang -cc1as", "Clang Integrated Assembler",
465 /*Include=*/driver::options::CC1AsOption, /*Exclude=*/0);
471 // FIXME: Use a better -version message?
472 if (Asm.ShowVersion) {
473 llvm::cl::PrintVersionMessage();
479 // FIXME: Remove this, one day.
480 if (!Asm.LLVMArgs.empty()) {
481 unsigned NumArgs = Asm.LLVMArgs.size();
482 const char **Args = new const char*[NumArgs + 2];
483 Args[0] = "clang (LLVM option parsing)";
484 for (unsigned i = 0; i != NumArgs; ++i)
485 Args[i + 1] = Asm.LLVMArgs[i].c_str();
486 Args[NumArgs + 1] = nullptr;
487 llvm::cl::ParseCommandLineOptions(NumArgs + 1, Args);
490 // Execute the invocation, unless there were parsing errors.
491 bool Failed = Diags.hasErrorOccurred() || ExecuteAssembler(Asm, Diags);
493 // If any timers were active but haven't been destroyed yet, print their
495 TimerGroup::printAll(errs());