1e5dd7070Spatrick //===-- cc1as_main.cpp - Clang Assembler ---------------------------------===//
2e5dd7070Spatrick //
3e5dd7070Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4e5dd7070Spatrick // See https://llvm.org/LICENSE.txt for license information.
5e5dd7070Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6e5dd7070Spatrick //
7e5dd7070Spatrick //===----------------------------------------------------------------------===//
8e5dd7070Spatrick //
9e5dd7070Spatrick // This is the entry point to the clang -cc1as functionality, which implements
10e5dd7070Spatrick // the direct interface to the LLVM MC based assembler.
11e5dd7070Spatrick //
12e5dd7070Spatrick //===----------------------------------------------------------------------===//
13e5dd7070Spatrick
14e5dd7070Spatrick #include "clang/Basic/Diagnostic.h"
15e5dd7070Spatrick #include "clang/Basic/DiagnosticOptions.h"
16e5dd7070Spatrick #include "clang/Driver/DriverDiagnostic.h"
17e5dd7070Spatrick #include "clang/Driver/Options.h"
18e5dd7070Spatrick #include "clang/Frontend/FrontendDiagnostic.h"
19e5dd7070Spatrick #include "clang/Frontend/TextDiagnosticPrinter.h"
20e5dd7070Spatrick #include "clang/Frontend/Utils.h"
21e5dd7070Spatrick #include "llvm/ADT/STLExtras.h"
22e5dd7070Spatrick #include "llvm/ADT/StringSwitch.h"
23e5dd7070Spatrick #include "llvm/ADT/Triple.h"
24e5dd7070Spatrick #include "llvm/IR/DataLayout.h"
25e5dd7070Spatrick #include "llvm/MC/MCAsmBackend.h"
26e5dd7070Spatrick #include "llvm/MC/MCAsmInfo.h"
27e5dd7070Spatrick #include "llvm/MC/MCCodeEmitter.h"
28e5dd7070Spatrick #include "llvm/MC/MCContext.h"
29e5dd7070Spatrick #include "llvm/MC/MCInstrInfo.h"
30e5dd7070Spatrick #include "llvm/MC/MCObjectFileInfo.h"
31e5dd7070Spatrick #include "llvm/MC/MCObjectWriter.h"
32e5dd7070Spatrick #include "llvm/MC/MCParser/MCAsmParser.h"
33e5dd7070Spatrick #include "llvm/MC/MCParser/MCTargetAsmParser.h"
34e5dd7070Spatrick #include "llvm/MC/MCRegisterInfo.h"
35e5dd7070Spatrick #include "llvm/MC/MCSectionMachO.h"
36e5dd7070Spatrick #include "llvm/MC/MCStreamer.h"
37e5dd7070Spatrick #include "llvm/MC/MCSubtargetInfo.h"
38e5dd7070Spatrick #include "llvm/MC/MCTargetOptions.h"
39*12c85518Srobert #include "llvm/MC/TargetRegistry.h"
40e5dd7070Spatrick #include "llvm/Option/Arg.h"
41e5dd7070Spatrick #include "llvm/Option/ArgList.h"
42e5dd7070Spatrick #include "llvm/Option/OptTable.h"
43e5dd7070Spatrick #include "llvm/Support/CommandLine.h"
44e5dd7070Spatrick #include "llvm/Support/ErrorHandling.h"
45e5dd7070Spatrick #include "llvm/Support/FileSystem.h"
46e5dd7070Spatrick #include "llvm/Support/FormattedStream.h"
47e5dd7070Spatrick #include "llvm/Support/Host.h"
48e5dd7070Spatrick #include "llvm/Support/MemoryBuffer.h"
49e5dd7070Spatrick #include "llvm/Support/Path.h"
50e5dd7070Spatrick #include "llvm/Support/Process.h"
51e5dd7070Spatrick #include "llvm/Support/Signals.h"
52e5dd7070Spatrick #include "llvm/Support/SourceMgr.h"
53e5dd7070Spatrick #include "llvm/Support/TargetSelect.h"
54e5dd7070Spatrick #include "llvm/Support/Timer.h"
55e5dd7070Spatrick #include "llvm/Support/raw_ostream.h"
56e5dd7070Spatrick #include <memory>
57*12c85518Srobert #include <optional>
58e5dd7070Spatrick #include <system_error>
59e5dd7070Spatrick using namespace clang;
60e5dd7070Spatrick using namespace clang::driver;
61e5dd7070Spatrick using namespace clang::driver::options;
62e5dd7070Spatrick using namespace llvm;
63e5dd7070Spatrick using namespace llvm::opt;
64e5dd7070Spatrick
65e5dd7070Spatrick namespace {
66e5dd7070Spatrick
67e5dd7070Spatrick /// Helper class for representing a single invocation of the assembler.
68e5dd7070Spatrick struct AssemblerInvocation {
69e5dd7070Spatrick /// @name Target Options
70e5dd7070Spatrick /// @{
71e5dd7070Spatrick
72e5dd7070Spatrick /// The name of the target triple to assemble for.
73e5dd7070Spatrick std::string Triple;
74e5dd7070Spatrick
75e5dd7070Spatrick /// If given, the name of the target CPU to determine which instructions
76e5dd7070Spatrick /// are legal.
77e5dd7070Spatrick std::string CPU;
78e5dd7070Spatrick
79e5dd7070Spatrick /// The list of target specific features to enable or disable -- this should
80e5dd7070Spatrick /// be a list of strings starting with '+' or '-'.
81e5dd7070Spatrick std::vector<std::string> Features;
82e5dd7070Spatrick
83e5dd7070Spatrick /// The list of symbol definitions.
84e5dd7070Spatrick std::vector<std::string> SymbolDefs;
85e5dd7070Spatrick
86e5dd7070Spatrick /// @}
87e5dd7070Spatrick /// @name Language Options
88e5dd7070Spatrick /// @{
89e5dd7070Spatrick
90e5dd7070Spatrick std::vector<std::string> IncludePaths;
91e5dd7070Spatrick unsigned NoInitialTextSection : 1;
92e5dd7070Spatrick unsigned SaveTemporaryLabels : 1;
93e5dd7070Spatrick unsigned GenDwarfForAssembly : 1;
94e5dd7070Spatrick unsigned RelaxELFRelocations : 1;
95a9ac8606Spatrick unsigned Dwarf64 : 1;
96e5dd7070Spatrick unsigned DwarfVersion;
97e5dd7070Spatrick std::string DwarfDebugFlags;
98e5dd7070Spatrick std::string DwarfDebugProducer;
99e5dd7070Spatrick std::string DebugCompilationDir;
100e5dd7070Spatrick std::map<const std::string, const std::string> DebugPrefixMap;
101e5dd7070Spatrick llvm::DebugCompressionType CompressDebugSections =
102e5dd7070Spatrick llvm::DebugCompressionType::None;
103e5dd7070Spatrick std::string MainFileName;
104e5dd7070Spatrick std::string SplitDwarfOutput;
105e5dd7070Spatrick
106e5dd7070Spatrick /// @}
107e5dd7070Spatrick /// @name Frontend Options
108e5dd7070Spatrick /// @{
109e5dd7070Spatrick
110e5dd7070Spatrick std::string InputFile;
111e5dd7070Spatrick std::vector<std::string> LLVMArgs;
112e5dd7070Spatrick std::string OutputPath;
113e5dd7070Spatrick enum FileType {
114e5dd7070Spatrick FT_Asm, ///< Assembly (.s) output, transliterate mode.
115e5dd7070Spatrick FT_Null, ///< No output, for timing purposes.
116e5dd7070Spatrick FT_Obj ///< Object file output.
117e5dd7070Spatrick };
118e5dd7070Spatrick FileType OutputType;
119e5dd7070Spatrick unsigned ShowHelp : 1;
120e5dd7070Spatrick unsigned ShowVersion : 1;
121e5dd7070Spatrick
122e5dd7070Spatrick /// @}
123e5dd7070Spatrick /// @name Transliterate Options
124e5dd7070Spatrick /// @{
125e5dd7070Spatrick
126e5dd7070Spatrick unsigned OutputAsmVariant;
127e5dd7070Spatrick unsigned ShowEncoding : 1;
128e5dd7070Spatrick unsigned ShowInst : 1;
129e5dd7070Spatrick
130e5dd7070Spatrick /// @}
131e5dd7070Spatrick /// @name Assembler Options
132e5dd7070Spatrick /// @{
133e5dd7070Spatrick
134e5dd7070Spatrick unsigned RelaxAll : 1;
135e5dd7070Spatrick unsigned NoExecStack : 1;
136e5dd7070Spatrick unsigned FatalWarnings : 1;
137e5dd7070Spatrick unsigned NoWarn : 1;
138*12c85518Srobert unsigned NoTypeCheck : 1;
139e5dd7070Spatrick unsigned IncrementalLinkerCompatible : 1;
140e5dd7070Spatrick unsigned EmbedBitcode : 1;
141e5dd7070Spatrick
142*12c85518Srobert /// Whether to emit DWARF unwind info.
143*12c85518Srobert EmitDwarfUnwindType EmitDwarfUnwind;
144*12c85518Srobert
145e5dd7070Spatrick /// The name of the relocation model to use.
146e5dd7070Spatrick std::string RelocationModel;
147e5dd7070Spatrick
148e5dd7070Spatrick /// The ABI targeted by the backend. Specified using -target-abi. Empty
149e5dd7070Spatrick /// otherwise.
150e5dd7070Spatrick std::string TargetABI;
151e5dd7070Spatrick
152*12c85518Srobert /// Darwin target variant triple, the variant of the deployment target
153*12c85518Srobert /// for which the code is being compiled.
154*12c85518Srobert std::optional<llvm::Triple> DarwinTargetVariantTriple;
155*12c85518Srobert
156*12c85518Srobert /// The version of the darwin target variant SDK which was used during the
157*12c85518Srobert /// compilation
158*12c85518Srobert llvm::VersionTuple DarwinTargetVariantSDKVersion;
159*12c85518Srobert
160*12c85518Srobert /// The name of a file to use with \c .secure_log_unique directives.
161*12c85518Srobert std::string AsSecureLogFile;
162e5dd7070Spatrick /// @}
163e5dd7070Spatrick
164e5dd7070Spatrick public:
AssemblerInvocation__anonb145aa350111::AssemblerInvocation165e5dd7070Spatrick AssemblerInvocation() {
166e5dd7070Spatrick Triple = "";
167e5dd7070Spatrick NoInitialTextSection = 0;
168e5dd7070Spatrick InputFile = "-";
169e5dd7070Spatrick OutputPath = "-";
170e5dd7070Spatrick OutputType = FT_Asm;
171e5dd7070Spatrick OutputAsmVariant = 0;
172e5dd7070Spatrick ShowInst = 0;
173e5dd7070Spatrick ShowEncoding = 0;
174e5dd7070Spatrick RelaxAll = 0;
175e5dd7070Spatrick NoExecStack = 0;
176e5dd7070Spatrick FatalWarnings = 0;
177e5dd7070Spatrick NoWarn = 0;
178*12c85518Srobert NoTypeCheck = 0;
179e5dd7070Spatrick IncrementalLinkerCompatible = 0;
180a9ac8606Spatrick Dwarf64 = 0;
181e5dd7070Spatrick DwarfVersion = 0;
182e5dd7070Spatrick EmbedBitcode = 0;
183*12c85518Srobert EmitDwarfUnwind = EmitDwarfUnwindType::Default;
184e5dd7070Spatrick }
185e5dd7070Spatrick
186e5dd7070Spatrick static bool CreateFromArgs(AssemblerInvocation &Res,
187e5dd7070Spatrick ArrayRef<const char *> Argv,
188e5dd7070Spatrick DiagnosticsEngine &Diags);
189e5dd7070Spatrick };
190e5dd7070Spatrick
191e5dd7070Spatrick }
192e5dd7070Spatrick
CreateFromArgs(AssemblerInvocation & Opts,ArrayRef<const char * > Argv,DiagnosticsEngine & Diags)193e5dd7070Spatrick bool AssemblerInvocation::CreateFromArgs(AssemblerInvocation &Opts,
194e5dd7070Spatrick ArrayRef<const char *> Argv,
195e5dd7070Spatrick DiagnosticsEngine &Diags) {
196e5dd7070Spatrick bool Success = true;
197e5dd7070Spatrick
198e5dd7070Spatrick // Parse the arguments.
199e5dd7070Spatrick const OptTable &OptTbl = getDriverOptTable();
200e5dd7070Spatrick
201e5dd7070Spatrick const unsigned IncludedFlagsBitmask = options::CC1AsOption;
202e5dd7070Spatrick unsigned MissingArgIndex, MissingArgCount;
203e5dd7070Spatrick InputArgList Args = OptTbl.ParseArgs(Argv, MissingArgIndex, MissingArgCount,
204e5dd7070Spatrick IncludedFlagsBitmask);
205e5dd7070Spatrick
206e5dd7070Spatrick // Check for missing argument error.
207e5dd7070Spatrick if (MissingArgCount) {
208e5dd7070Spatrick Diags.Report(diag::err_drv_missing_argument)
209e5dd7070Spatrick << Args.getArgString(MissingArgIndex) << MissingArgCount;
210e5dd7070Spatrick Success = false;
211e5dd7070Spatrick }
212e5dd7070Spatrick
213e5dd7070Spatrick // Issue errors on unknown arguments.
214e5dd7070Spatrick for (const Arg *A : Args.filtered(OPT_UNKNOWN)) {
215e5dd7070Spatrick auto ArgString = A->getAsString(Args);
216e5dd7070Spatrick std::string Nearest;
217e5dd7070Spatrick if (OptTbl.findNearest(ArgString, Nearest, IncludedFlagsBitmask) > 1)
218e5dd7070Spatrick Diags.Report(diag::err_drv_unknown_argument) << ArgString;
219e5dd7070Spatrick else
220e5dd7070Spatrick Diags.Report(diag::err_drv_unknown_argument_with_suggestion)
221e5dd7070Spatrick << ArgString << Nearest;
222e5dd7070Spatrick Success = false;
223e5dd7070Spatrick }
224e5dd7070Spatrick
225e5dd7070Spatrick // Construct the invocation.
226e5dd7070Spatrick
227e5dd7070Spatrick // Target Options
228e5dd7070Spatrick Opts.Triple = llvm::Triple::normalize(Args.getLastArgValue(OPT_triple));
229*12c85518Srobert if (Arg *A = Args.getLastArg(options::OPT_darwin_target_variant_triple))
230*12c85518Srobert Opts.DarwinTargetVariantTriple = llvm::Triple(A->getValue());
231*12c85518Srobert if (Arg *A = Args.getLastArg(OPT_darwin_target_variant_sdk_version_EQ)) {
232*12c85518Srobert VersionTuple Version;
233*12c85518Srobert if (Version.tryParse(A->getValue()))
234*12c85518Srobert Diags.Report(diag::err_drv_invalid_value)
235*12c85518Srobert << A->getAsString(Args) << A->getValue();
236*12c85518Srobert else
237*12c85518Srobert Opts.DarwinTargetVariantSDKVersion = Version;
238*12c85518Srobert }
239*12c85518Srobert
240ec727ea7Spatrick Opts.CPU = std::string(Args.getLastArgValue(OPT_target_cpu));
241e5dd7070Spatrick Opts.Features = Args.getAllArgValues(OPT_target_feature);
242e5dd7070Spatrick
243e5dd7070Spatrick // Use the default target triple if unspecified.
244e5dd7070Spatrick if (Opts.Triple.empty())
245e5dd7070Spatrick Opts.Triple = llvm::sys::getDefaultTargetTriple();
246e5dd7070Spatrick
247e5dd7070Spatrick // Language Options
248e5dd7070Spatrick Opts.IncludePaths = Args.getAllArgValues(OPT_I);
249e5dd7070Spatrick Opts.NoInitialTextSection = Args.hasArg(OPT_n);
250e5dd7070Spatrick Opts.SaveTemporaryLabels = Args.hasArg(OPT_msave_temp_labels);
251e5dd7070Spatrick // Any DebugInfoKind implies GenDwarfForAssembly.
252e5dd7070Spatrick Opts.GenDwarfForAssembly = Args.hasArg(OPT_debug_info_kind_EQ);
253e5dd7070Spatrick
254a9ac8606Spatrick if (const Arg *A = Args.getLastArg(OPT_compress_debug_sections_EQ)) {
255e5dd7070Spatrick Opts.CompressDebugSections =
256e5dd7070Spatrick llvm::StringSwitch<llvm::DebugCompressionType>(A->getValue())
257e5dd7070Spatrick .Case("none", llvm::DebugCompressionType::None)
258*12c85518Srobert .Case("zlib", llvm::DebugCompressionType::Zlib)
259*12c85518Srobert .Case("zstd", llvm::DebugCompressionType::Zstd)
260e5dd7070Spatrick .Default(llvm::DebugCompressionType::None);
261e5dd7070Spatrick }
262e5dd7070Spatrick
263*12c85518Srobert Opts.RelaxELFRelocations = !Args.hasArg(OPT_mrelax_relocations_no);
264a9ac8606Spatrick if (auto *DwarfFormatArg = Args.getLastArg(OPT_gdwarf64, OPT_gdwarf32))
265a9ac8606Spatrick Opts.Dwarf64 = DwarfFormatArg->getOption().matches(OPT_gdwarf64);
266e5dd7070Spatrick Opts.DwarfVersion = getLastArgIntValue(Args, OPT_dwarf_version_EQ, 2, Diags);
267ec727ea7Spatrick Opts.DwarfDebugFlags =
268ec727ea7Spatrick std::string(Args.getLastArgValue(OPT_dwarf_debug_flags));
269ec727ea7Spatrick Opts.DwarfDebugProducer =
270ec727ea7Spatrick std::string(Args.getLastArgValue(OPT_dwarf_debug_producer));
271a9ac8606Spatrick if (const Arg *A = Args.getLastArg(options::OPT_ffile_compilation_dir_EQ,
272a9ac8606Spatrick options::OPT_fdebug_compilation_dir_EQ))
273a9ac8606Spatrick Opts.DebugCompilationDir = A->getValue();
274ec727ea7Spatrick Opts.MainFileName = std::string(Args.getLastArgValue(OPT_main_file_name));
275e5dd7070Spatrick
276ec727ea7Spatrick for (const auto &Arg : Args.getAllArgValues(OPT_fdebug_prefix_map_EQ)) {
277ec727ea7Spatrick auto Split = StringRef(Arg).split('=');
278ec727ea7Spatrick Opts.DebugPrefixMap.insert(
279ec727ea7Spatrick {std::string(Split.first), std::string(Split.second)});
280ec727ea7Spatrick }
281e5dd7070Spatrick
282e5dd7070Spatrick // Frontend Options
283e5dd7070Spatrick if (Args.hasArg(OPT_INPUT)) {
284e5dd7070Spatrick bool First = true;
285e5dd7070Spatrick for (const Arg *A : Args.filtered(OPT_INPUT)) {
286e5dd7070Spatrick if (First) {
287e5dd7070Spatrick Opts.InputFile = A->getValue();
288e5dd7070Spatrick First = false;
289e5dd7070Spatrick } else {
290e5dd7070Spatrick Diags.Report(diag::err_drv_unknown_argument) << A->getAsString(Args);
291e5dd7070Spatrick Success = false;
292e5dd7070Spatrick }
293e5dd7070Spatrick }
294e5dd7070Spatrick }
295e5dd7070Spatrick Opts.LLVMArgs = Args.getAllArgValues(OPT_mllvm);
296ec727ea7Spatrick Opts.OutputPath = std::string(Args.getLastArgValue(OPT_o));
297ec727ea7Spatrick Opts.SplitDwarfOutput =
298ec727ea7Spatrick std::string(Args.getLastArgValue(OPT_split_dwarf_output));
299e5dd7070Spatrick if (Arg *A = Args.getLastArg(OPT_filetype)) {
300e5dd7070Spatrick StringRef Name = A->getValue();
301e5dd7070Spatrick unsigned OutputType = StringSwitch<unsigned>(Name)
302e5dd7070Spatrick .Case("asm", FT_Asm)
303e5dd7070Spatrick .Case("null", FT_Null)
304e5dd7070Spatrick .Case("obj", FT_Obj)
305e5dd7070Spatrick .Default(~0U);
306e5dd7070Spatrick if (OutputType == ~0U) {
307e5dd7070Spatrick Diags.Report(diag::err_drv_invalid_value) << A->getAsString(Args) << Name;
308e5dd7070Spatrick Success = false;
309e5dd7070Spatrick } else
310e5dd7070Spatrick Opts.OutputType = FileType(OutputType);
311e5dd7070Spatrick }
312e5dd7070Spatrick Opts.ShowHelp = Args.hasArg(OPT_help);
313e5dd7070Spatrick Opts.ShowVersion = Args.hasArg(OPT_version);
314e5dd7070Spatrick
315e5dd7070Spatrick // Transliterate Options
316e5dd7070Spatrick Opts.OutputAsmVariant =
317e5dd7070Spatrick getLastArgIntValue(Args, OPT_output_asm_variant, 0, Diags);
318e5dd7070Spatrick Opts.ShowEncoding = Args.hasArg(OPT_show_encoding);
319e5dd7070Spatrick Opts.ShowInst = Args.hasArg(OPT_show_inst);
320e5dd7070Spatrick
321e5dd7070Spatrick // Assemble Options
322e5dd7070Spatrick Opts.RelaxAll = Args.hasArg(OPT_mrelax_all);
323e5dd7070Spatrick Opts.NoExecStack = Args.hasArg(OPT_mno_exec_stack);
324e5dd7070Spatrick Opts.FatalWarnings = Args.hasArg(OPT_massembler_fatal_warnings);
325e5dd7070Spatrick Opts.NoWarn = Args.hasArg(OPT_massembler_no_warn);
326*12c85518Srobert Opts.NoTypeCheck = Args.hasArg(OPT_mno_type_check);
327ec727ea7Spatrick Opts.RelocationModel =
328ec727ea7Spatrick std::string(Args.getLastArgValue(OPT_mrelocation_model, "pic"));
329ec727ea7Spatrick Opts.TargetABI = std::string(Args.getLastArgValue(OPT_target_abi));
330e5dd7070Spatrick Opts.IncrementalLinkerCompatible =
331e5dd7070Spatrick Args.hasArg(OPT_mincremental_linker_compatible);
332e5dd7070Spatrick Opts.SymbolDefs = Args.getAllArgValues(OPT_defsym);
333e5dd7070Spatrick
334e5dd7070Spatrick // EmbedBitcode Option. If -fembed-bitcode is enabled, set the flag.
335e5dd7070Spatrick // EmbedBitcode behaves the same for all embed options for assembly files.
336e5dd7070Spatrick if (auto *A = Args.getLastArg(OPT_fembed_bitcode_EQ)) {
337e5dd7070Spatrick Opts.EmbedBitcode = llvm::StringSwitch<unsigned>(A->getValue())
338e5dd7070Spatrick .Case("all", 1)
339e5dd7070Spatrick .Case("bitcode", 1)
340e5dd7070Spatrick .Case("marker", 1)
341e5dd7070Spatrick .Default(0);
342e5dd7070Spatrick }
343e5dd7070Spatrick
344*12c85518Srobert if (auto *A = Args.getLastArg(OPT_femit_dwarf_unwind_EQ)) {
345*12c85518Srobert Opts.EmitDwarfUnwind =
346*12c85518Srobert llvm::StringSwitch<EmitDwarfUnwindType>(A->getValue())
347*12c85518Srobert .Case("always", EmitDwarfUnwindType::Always)
348*12c85518Srobert .Case("no-compact-unwind", EmitDwarfUnwindType::NoCompactUnwind)
349*12c85518Srobert .Case("default", EmitDwarfUnwindType::Default);
350*12c85518Srobert }
351*12c85518Srobert
352*12c85518Srobert Opts.AsSecureLogFile = Args.getLastArgValue(OPT_as_secure_log_file);
353*12c85518Srobert
354e5dd7070Spatrick return Success;
355e5dd7070Spatrick }
356e5dd7070Spatrick
357e5dd7070Spatrick static std::unique_ptr<raw_fd_ostream>
getOutputStream(StringRef Path,DiagnosticsEngine & Diags,bool Binary)358e5dd7070Spatrick getOutputStream(StringRef Path, DiagnosticsEngine &Diags, bool Binary) {
359e5dd7070Spatrick // Make sure that the Out file gets unlinked from the disk if we get a
360e5dd7070Spatrick // SIGINT.
361e5dd7070Spatrick if (Path != "-")
362e5dd7070Spatrick sys::RemoveFileOnSignal(Path);
363e5dd7070Spatrick
364e5dd7070Spatrick std::error_code EC;
365e5dd7070Spatrick auto Out = std::make_unique<raw_fd_ostream>(
366a9ac8606Spatrick Path, EC, (Binary ? sys::fs::OF_None : sys::fs::OF_TextWithCRLF));
367e5dd7070Spatrick if (EC) {
368e5dd7070Spatrick Diags.Report(diag::err_fe_unable_to_open_output) << Path << EC.message();
369e5dd7070Spatrick return nullptr;
370e5dd7070Spatrick }
371e5dd7070Spatrick
372e5dd7070Spatrick return Out;
373e5dd7070Spatrick }
374e5dd7070Spatrick
ExecuteAssemblerImpl(AssemblerInvocation & Opts,DiagnosticsEngine & Diags)375a9ac8606Spatrick static bool ExecuteAssemblerImpl(AssemblerInvocation &Opts,
376e5dd7070Spatrick DiagnosticsEngine &Diags) {
377e5dd7070Spatrick // Get the target specific parser.
378e5dd7070Spatrick std::string Error;
379e5dd7070Spatrick const Target *TheTarget = TargetRegistry::lookupTarget(Opts.Triple, Error);
380e5dd7070Spatrick if (!TheTarget)
381e5dd7070Spatrick return Diags.Report(diag::err_target_unknown_triple) << Opts.Triple;
382e5dd7070Spatrick
383e5dd7070Spatrick ErrorOr<std::unique_ptr<MemoryBuffer>> Buffer =
384a9ac8606Spatrick MemoryBuffer::getFileOrSTDIN(Opts.InputFile, /*IsText=*/true);
385e5dd7070Spatrick
386e5dd7070Spatrick if (std::error_code EC = Buffer.getError()) {
387e5dd7070Spatrick Error = EC.message();
388e5dd7070Spatrick return Diags.Report(diag::err_fe_error_reading) << Opts.InputFile;
389e5dd7070Spatrick }
390e5dd7070Spatrick
391e5dd7070Spatrick SourceMgr SrcMgr;
392e5dd7070Spatrick
393e5dd7070Spatrick // Tell SrcMgr about this buffer, which is what the parser will pick up.
394e5dd7070Spatrick unsigned BufferIndex = SrcMgr.AddNewSourceBuffer(std::move(*Buffer), SMLoc());
395e5dd7070Spatrick
396e5dd7070Spatrick // Record the location of the include directories so that the lexer can find
397e5dd7070Spatrick // it later.
398e5dd7070Spatrick SrcMgr.setIncludeDirs(Opts.IncludePaths);
399e5dd7070Spatrick
400e5dd7070Spatrick std::unique_ptr<MCRegisterInfo> MRI(TheTarget->createMCRegInfo(Opts.Triple));
401e5dd7070Spatrick assert(MRI && "Unable to create target register info!");
402e5dd7070Spatrick
403e5dd7070Spatrick MCTargetOptions MCOptions;
404*12c85518Srobert MCOptions.EmitDwarfUnwind = Opts.EmitDwarfUnwind;
405*12c85518Srobert MCOptions.AsSecureLogFile = Opts.AsSecureLogFile;
406*12c85518Srobert
407e5dd7070Spatrick std::unique_ptr<MCAsmInfo> MAI(
408e5dd7070Spatrick TheTarget->createMCAsmInfo(*MRI, Opts.Triple, MCOptions));
409e5dd7070Spatrick assert(MAI && "Unable to create target asm info!");
410e5dd7070Spatrick
411e5dd7070Spatrick // Ensure MCAsmInfo initialization occurs before any use, otherwise sections
412e5dd7070Spatrick // may be created with a combination of default and explicit settings.
413e5dd7070Spatrick MAI->setCompressDebugSections(Opts.CompressDebugSections);
414e5dd7070Spatrick
415e5dd7070Spatrick MAI->setRelaxELFRelocations(Opts.RelaxELFRelocations);
416e5dd7070Spatrick
417e5dd7070Spatrick bool IsBinary = Opts.OutputType == AssemblerInvocation::FT_Obj;
418e5dd7070Spatrick if (Opts.OutputPath.empty())
419e5dd7070Spatrick Opts.OutputPath = "-";
420e5dd7070Spatrick std::unique_ptr<raw_fd_ostream> FDOS =
421e5dd7070Spatrick getOutputStream(Opts.OutputPath, Diags, IsBinary);
422e5dd7070Spatrick if (!FDOS)
423e5dd7070Spatrick return true;
424e5dd7070Spatrick std::unique_ptr<raw_fd_ostream> DwoOS;
425e5dd7070Spatrick if (!Opts.SplitDwarfOutput.empty())
426e5dd7070Spatrick DwoOS = getOutputStream(Opts.SplitDwarfOutput, Diags, IsBinary);
427e5dd7070Spatrick
428a9ac8606Spatrick // Build up the feature string from the target feature list.
429a9ac8606Spatrick std::string FS = llvm::join(Opts.Features, ",");
430e5dd7070Spatrick
431a9ac8606Spatrick std::unique_ptr<MCSubtargetInfo> STI(
432a9ac8606Spatrick TheTarget->createMCSubtargetInfo(Opts.Triple, Opts.CPU, FS));
433a9ac8606Spatrick assert(STI && "Unable to create subtarget info!");
434a9ac8606Spatrick
435a9ac8606Spatrick MCContext Ctx(Triple(Opts.Triple), MAI.get(), MRI.get(), STI.get(), &SrcMgr,
436a9ac8606Spatrick &MCOptions);
437e5dd7070Spatrick
438e5dd7070Spatrick bool PIC = false;
439e5dd7070Spatrick if (Opts.RelocationModel == "static") {
440e5dd7070Spatrick PIC = false;
441e5dd7070Spatrick } else if (Opts.RelocationModel == "pic") {
442e5dd7070Spatrick PIC = true;
443e5dd7070Spatrick } else {
444e5dd7070Spatrick assert(Opts.RelocationModel == "dynamic-no-pic" &&
445e5dd7070Spatrick "Invalid PIC model!");
446e5dd7070Spatrick PIC = false;
447e5dd7070Spatrick }
448e5dd7070Spatrick
449a9ac8606Spatrick // FIXME: This is not pretty. MCContext has a ptr to MCObjectFileInfo and
450a9ac8606Spatrick // MCObjectFileInfo needs a MCContext reference in order to initialize itself.
451a9ac8606Spatrick std::unique_ptr<MCObjectFileInfo> MOFI(
452a9ac8606Spatrick TheTarget->createMCObjectFileInfo(Ctx, PIC));
453*12c85518Srobert if (Opts.DarwinTargetVariantTriple)
454*12c85518Srobert MOFI->setDarwinTargetVariantTriple(*Opts.DarwinTargetVariantTriple);
455*12c85518Srobert if (!Opts.DarwinTargetVariantSDKVersion.empty())
456*12c85518Srobert MOFI->setDarwinTargetVariantSDKVersion(Opts.DarwinTargetVariantSDKVersion);
457a9ac8606Spatrick Ctx.setObjectFileInfo(MOFI.get());
458a9ac8606Spatrick
459e5dd7070Spatrick if (Opts.SaveTemporaryLabels)
460e5dd7070Spatrick Ctx.setAllowTemporaryLabels(false);
461e5dd7070Spatrick if (Opts.GenDwarfForAssembly)
462e5dd7070Spatrick Ctx.setGenDwarfForAssembly(true);
463e5dd7070Spatrick if (!Opts.DwarfDebugFlags.empty())
464e5dd7070Spatrick Ctx.setDwarfDebugFlags(StringRef(Opts.DwarfDebugFlags));
465e5dd7070Spatrick if (!Opts.DwarfDebugProducer.empty())
466e5dd7070Spatrick Ctx.setDwarfDebugProducer(StringRef(Opts.DwarfDebugProducer));
467e5dd7070Spatrick if (!Opts.DebugCompilationDir.empty())
468e5dd7070Spatrick Ctx.setCompilationDir(Opts.DebugCompilationDir);
469e5dd7070Spatrick else {
470e5dd7070Spatrick // If no compilation dir is set, try to use the current directory.
471e5dd7070Spatrick SmallString<128> CWD;
472e5dd7070Spatrick if (!sys::fs::current_path(CWD))
473e5dd7070Spatrick Ctx.setCompilationDir(CWD);
474e5dd7070Spatrick }
475e5dd7070Spatrick if (!Opts.DebugPrefixMap.empty())
476e5dd7070Spatrick for (const auto &KV : Opts.DebugPrefixMap)
477e5dd7070Spatrick Ctx.addDebugPrefixMapEntry(KV.first, KV.second);
478e5dd7070Spatrick if (!Opts.MainFileName.empty())
479e5dd7070Spatrick Ctx.setMainFileName(StringRef(Opts.MainFileName));
480a9ac8606Spatrick Ctx.setDwarfFormat(Opts.Dwarf64 ? dwarf::DWARF64 : dwarf::DWARF32);
481e5dd7070Spatrick Ctx.setDwarfVersion(Opts.DwarfVersion);
482e5dd7070Spatrick if (Opts.GenDwarfForAssembly)
483e5dd7070Spatrick Ctx.setGenDwarfRootFile(Opts.InputFile,
484e5dd7070Spatrick SrcMgr.getMemoryBuffer(BufferIndex)->getBuffer());
485e5dd7070Spatrick
486e5dd7070Spatrick std::unique_ptr<MCStreamer> Str;
487e5dd7070Spatrick
488e5dd7070Spatrick std::unique_ptr<MCInstrInfo> MCII(TheTarget->createMCInstrInfo());
489a9ac8606Spatrick assert(MCII && "Unable to create instruction info!");
490e5dd7070Spatrick
491e5dd7070Spatrick raw_pwrite_stream *Out = FDOS.get();
492e5dd7070Spatrick std::unique_ptr<buffer_ostream> BOS;
493e5dd7070Spatrick
494e5dd7070Spatrick MCOptions.MCNoWarn = Opts.NoWarn;
495e5dd7070Spatrick MCOptions.MCFatalWarnings = Opts.FatalWarnings;
496*12c85518Srobert MCOptions.MCNoTypeCheck = Opts.NoTypeCheck;
497e5dd7070Spatrick MCOptions.ABIName = Opts.TargetABI;
498e5dd7070Spatrick
499e5dd7070Spatrick // FIXME: There is a bit of code duplication with addPassesToEmitFile.
500e5dd7070Spatrick if (Opts.OutputType == AssemblerInvocation::FT_Asm) {
501e5dd7070Spatrick MCInstPrinter *IP = TheTarget->createMCInstPrinter(
502e5dd7070Spatrick llvm::Triple(Opts.Triple), Opts.OutputAsmVariant, *MAI, *MCII, *MRI);
503e5dd7070Spatrick
504e5dd7070Spatrick std::unique_ptr<MCCodeEmitter> CE;
505e5dd7070Spatrick if (Opts.ShowEncoding)
506*12c85518Srobert CE.reset(TheTarget->createMCCodeEmitter(*MCII, Ctx));
507e5dd7070Spatrick std::unique_ptr<MCAsmBackend> MAB(
508e5dd7070Spatrick TheTarget->createMCAsmBackend(*STI, *MRI, MCOptions));
509e5dd7070Spatrick
510e5dd7070Spatrick auto FOut = std::make_unique<formatted_raw_ostream>(*Out);
511e5dd7070Spatrick Str.reset(TheTarget->createAsmStreamer(
512e5dd7070Spatrick Ctx, std::move(FOut), /*asmverbose*/ true,
513e5dd7070Spatrick /*useDwarfDirectory*/ true, IP, std::move(CE), std::move(MAB),
514e5dd7070Spatrick Opts.ShowInst));
515e5dd7070Spatrick } else if (Opts.OutputType == AssemblerInvocation::FT_Null) {
516e5dd7070Spatrick Str.reset(createNullStreamer(Ctx));
517e5dd7070Spatrick } else {
518e5dd7070Spatrick assert(Opts.OutputType == AssemblerInvocation::FT_Obj &&
519e5dd7070Spatrick "Invalid file type!");
520e5dd7070Spatrick if (!FDOS->supportsSeeking()) {
521e5dd7070Spatrick BOS = std::make_unique<buffer_ostream>(*FDOS);
522e5dd7070Spatrick Out = BOS.get();
523e5dd7070Spatrick }
524e5dd7070Spatrick
525e5dd7070Spatrick std::unique_ptr<MCCodeEmitter> CE(
526*12c85518Srobert TheTarget->createMCCodeEmitter(*MCII, Ctx));
527e5dd7070Spatrick std::unique_ptr<MCAsmBackend> MAB(
528e5dd7070Spatrick TheTarget->createMCAsmBackend(*STI, *MRI, MCOptions));
529a9ac8606Spatrick assert(MAB && "Unable to create asm backend!");
530a9ac8606Spatrick
531e5dd7070Spatrick std::unique_ptr<MCObjectWriter> OW =
532e5dd7070Spatrick DwoOS ? MAB->createDwoObjectWriter(*Out, *DwoOS)
533e5dd7070Spatrick : MAB->createObjectWriter(*Out);
534e5dd7070Spatrick
535e5dd7070Spatrick Triple T(Opts.Triple);
536e5dd7070Spatrick Str.reset(TheTarget->createMCObjectStreamer(
537e5dd7070Spatrick T, Ctx, std::move(MAB), std::move(OW), std::move(CE), *STI,
538e5dd7070Spatrick Opts.RelaxAll, Opts.IncrementalLinkerCompatible,
539e5dd7070Spatrick /*DWARFMustBeAtTheEnd*/ true));
540*12c85518Srobert Str.get()->initSections(Opts.NoExecStack, *STI);
541e5dd7070Spatrick }
542e5dd7070Spatrick
543e5dd7070Spatrick // When -fembed-bitcode is passed to clang_as, a 1-byte marker
544e5dd7070Spatrick // is emitted in __LLVM,__asm section if the object file is MachO format.
545a9ac8606Spatrick if (Opts.EmbedBitcode && Ctx.getObjectFileType() == MCContext::IsMachO) {
546e5dd7070Spatrick MCSection *AsmLabel = Ctx.getMachOSection(
547e5dd7070Spatrick "__LLVM", "__asm", MachO::S_REGULAR, 4, SectionKind::getReadOnly());
548*12c85518Srobert Str.get()->switchSection(AsmLabel);
549ec727ea7Spatrick Str.get()->emitZeros(1);
550e5dd7070Spatrick }
551e5dd7070Spatrick
552e5dd7070Spatrick // Assembly to object compilation should leverage assembly info.
553e5dd7070Spatrick Str->setUseAssemblerInfoForParsing(true);
554e5dd7070Spatrick
555e5dd7070Spatrick bool Failed = false;
556e5dd7070Spatrick
557e5dd7070Spatrick std::unique_ptr<MCAsmParser> Parser(
558e5dd7070Spatrick createMCAsmParser(SrcMgr, Ctx, *Str.get(), *MAI));
559e5dd7070Spatrick
560e5dd7070Spatrick // FIXME: init MCTargetOptions from sanitizer flags here.
561e5dd7070Spatrick std::unique_ptr<MCTargetAsmParser> TAP(
562e5dd7070Spatrick TheTarget->createMCAsmParser(*STI, *Parser, *MCII, MCOptions));
563e5dd7070Spatrick if (!TAP)
564e5dd7070Spatrick Failed = Diags.Report(diag::err_target_unknown_triple) << Opts.Triple;
565e5dd7070Spatrick
566e5dd7070Spatrick // Set values for symbols, if any.
567e5dd7070Spatrick for (auto &S : Opts.SymbolDefs) {
568e5dd7070Spatrick auto Pair = StringRef(S).split('=');
569e5dd7070Spatrick auto Sym = Pair.first;
570e5dd7070Spatrick auto Val = Pair.second;
571e5dd7070Spatrick int64_t Value;
572e5dd7070Spatrick // We have already error checked this in the driver.
573e5dd7070Spatrick Val.getAsInteger(0, Value);
574e5dd7070Spatrick Ctx.setSymbolValue(Parser->getStreamer(), Sym, Value);
575e5dd7070Spatrick }
576e5dd7070Spatrick
577e5dd7070Spatrick if (!Failed) {
578e5dd7070Spatrick Parser->setTargetParser(*TAP.get());
579e5dd7070Spatrick Failed = Parser->Run(Opts.NoInitialTextSection);
580e5dd7070Spatrick }
581e5dd7070Spatrick
582a9ac8606Spatrick return Failed;
583a9ac8606Spatrick }
584a9ac8606Spatrick
ExecuteAssembler(AssemblerInvocation & Opts,DiagnosticsEngine & Diags)585a9ac8606Spatrick static bool ExecuteAssembler(AssemblerInvocation &Opts,
586a9ac8606Spatrick DiagnosticsEngine &Diags) {
587a9ac8606Spatrick bool Failed = ExecuteAssemblerImpl(Opts, Diags);
588e5dd7070Spatrick
589e5dd7070Spatrick // Delete output file if there were errors.
590e5dd7070Spatrick if (Failed) {
591e5dd7070Spatrick if (Opts.OutputPath != "-")
592e5dd7070Spatrick sys::fs::remove(Opts.OutputPath);
593e5dd7070Spatrick if (!Opts.SplitDwarfOutput.empty() && Opts.SplitDwarfOutput != "-")
594e5dd7070Spatrick sys::fs::remove(Opts.SplitDwarfOutput);
595e5dd7070Spatrick }
596e5dd7070Spatrick
597e5dd7070Spatrick return Failed;
598e5dd7070Spatrick }
599e5dd7070Spatrick
LLVMErrorHandler(void * UserData,const char * Message,bool GenCrashDiag)600*12c85518Srobert static void LLVMErrorHandler(void *UserData, const char *Message,
601e5dd7070Spatrick bool GenCrashDiag) {
602e5dd7070Spatrick DiagnosticsEngine &Diags = *static_cast<DiagnosticsEngine*>(UserData);
603e5dd7070Spatrick
604e5dd7070Spatrick Diags.Report(diag::err_fe_error_backend) << Message;
605e5dd7070Spatrick
606e5dd7070Spatrick // We cannot recover from llvm errors.
607e5dd7070Spatrick sys::Process::Exit(1);
608e5dd7070Spatrick }
609e5dd7070Spatrick
cc1as_main(ArrayRef<const char * > Argv,const char * Argv0,void * MainAddr)610e5dd7070Spatrick int cc1as_main(ArrayRef<const char *> Argv, const char *Argv0, void *MainAddr) {
611e5dd7070Spatrick // Initialize targets and assembly printers/parsers.
612e5dd7070Spatrick InitializeAllTargetInfos();
613e5dd7070Spatrick InitializeAllTargetMCs();
614e5dd7070Spatrick InitializeAllAsmParsers();
615e5dd7070Spatrick
616e5dd7070Spatrick // Construct our diagnostic client.
617e5dd7070Spatrick IntrusiveRefCntPtr<DiagnosticOptions> DiagOpts = new DiagnosticOptions();
618e5dd7070Spatrick TextDiagnosticPrinter *DiagClient
619e5dd7070Spatrick = new TextDiagnosticPrinter(errs(), &*DiagOpts);
620e5dd7070Spatrick DiagClient->setPrefix("clang -cc1as");
621e5dd7070Spatrick IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
622e5dd7070Spatrick DiagnosticsEngine Diags(DiagID, &*DiagOpts, DiagClient);
623e5dd7070Spatrick
624e5dd7070Spatrick // Set an error handler, so that any LLVM backend diagnostics go through our
625e5dd7070Spatrick // error handler.
626e5dd7070Spatrick ScopedFatalErrorHandler FatalErrorHandler
627e5dd7070Spatrick (LLVMErrorHandler, static_cast<void*>(&Diags));
628e5dd7070Spatrick
629e5dd7070Spatrick // Parse the arguments.
630e5dd7070Spatrick AssemblerInvocation Asm;
631e5dd7070Spatrick if (!AssemblerInvocation::CreateFromArgs(Asm, Argv, Diags))
632e5dd7070Spatrick return 1;
633e5dd7070Spatrick
634e5dd7070Spatrick if (Asm.ShowHelp) {
635a9ac8606Spatrick getDriverOptTable().printHelp(
636e5dd7070Spatrick llvm::outs(), "clang -cc1as [options] file...",
637e5dd7070Spatrick "Clang Integrated Assembler",
638e5dd7070Spatrick /*Include=*/driver::options::CC1AsOption, /*Exclude=*/0,
639e5dd7070Spatrick /*ShowAllAliases=*/false);
640e5dd7070Spatrick return 0;
641e5dd7070Spatrick }
642e5dd7070Spatrick
643e5dd7070Spatrick // Honor -version.
644e5dd7070Spatrick //
645e5dd7070Spatrick // FIXME: Use a better -version message?
646e5dd7070Spatrick if (Asm.ShowVersion) {
647e5dd7070Spatrick llvm::cl::PrintVersionMessage();
648e5dd7070Spatrick return 0;
649e5dd7070Spatrick }
650e5dd7070Spatrick
651e5dd7070Spatrick // Honor -mllvm.
652e5dd7070Spatrick //
653e5dd7070Spatrick // FIXME: Remove this, one day.
654e5dd7070Spatrick if (!Asm.LLVMArgs.empty()) {
655e5dd7070Spatrick unsigned NumArgs = Asm.LLVMArgs.size();
656e5dd7070Spatrick auto Args = std::make_unique<const char*[]>(NumArgs + 2);
657e5dd7070Spatrick Args[0] = "clang (LLVM option parsing)";
658e5dd7070Spatrick for (unsigned i = 0; i != NumArgs; ++i)
659e5dd7070Spatrick Args[i + 1] = Asm.LLVMArgs[i].c_str();
660e5dd7070Spatrick Args[NumArgs + 1] = nullptr;
661e5dd7070Spatrick llvm::cl::ParseCommandLineOptions(NumArgs + 1, Args.get());
662e5dd7070Spatrick }
663e5dd7070Spatrick
664e5dd7070Spatrick // Execute the invocation, unless there were parsing errors.
665e5dd7070Spatrick bool Failed = Diags.hasErrorOccurred() || ExecuteAssembler(Asm, Diags);
666e5dd7070Spatrick
667e5dd7070Spatrick // If any timers were active but haven't been destroyed yet, print their
668e5dd7070Spatrick // results now.
669e5dd7070Spatrick TimerGroup::printAll(errs());
670e5dd7070Spatrick TimerGroup::clearAll();
671e5dd7070Spatrick
672e5dd7070Spatrick return !!Failed;
673e5dd7070Spatrick }
674