1//===-- CommandFlags.cpp - Command Line Flags Interface ---------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file contains codegen-specific flags that are shared between different
10// command line tools. The tools "llc" and "opt" both use this file to prevent
11// flag duplication.
12//
13//===----------------------------------------------------------------------===//
14
15#include "llvm/CodeGen/CommandFlags.h"
16#include "llvm/ADT/SmallString.h"
17#include "llvm/ADT/Statistic.h"
18#include "llvm/ADT/StringExtras.h"
19#include "llvm/ADT/StringRef.h"
20#include "llvm/IR/Instructions.h"
21#include "llvm/IR/Intrinsics.h"
22#include "llvm/IR/Module.h"
23#include "llvm/MC/MCTargetOptionsCommandFlags.h"
24#include "llvm/MC/TargetRegistry.h"
25#include "llvm/Support/CommandLine.h"
26#include "llvm/Support/FileSystem.h"
27#include "llvm/Support/MemoryBuffer.h"
28#include "llvm/Support/Path.h"
29#include "llvm/Support/WithColor.h"
30#include "llvm/Support/raw_ostream.h"
31#include "llvm/Target/TargetMachine.h"
32#include "llvm/TargetParser/Host.h"
33#include "llvm/TargetParser/SubtargetFeature.h"
34#include "llvm/TargetParser/Triple.h"
35#include <cassert>
36#include <memory>
37#include <optional>
38#include <system_error>
39
40using namespace llvm;
41
42#define CGOPT(TY, NAME) \
43 static cl::opt<TY> *NAME##View; \
44 TY codegen::get##NAME() { \
45 assert(NAME##View && "Flag not registered."); \
46 return *NAME##View; \
47 }
48
49#define CGLIST(TY, NAME) \
50 static cl::list<TY> *NAME##View; \
51 std::vector<TY> codegen::get##NAME() { \
52 assert(NAME##View && "Flag not registered."); \
53 return *NAME##View; \
54 }
55
56// Temporary macro for incremental transition to std::optional.
57#define CGOPT_EXP(TY, NAME) \
58 CGOPT(TY, NAME) \
59 std::optional<TY> codegen::getExplicit##NAME() { \
60 if (NAME##View->getNumOccurrences()) { \
61 TY res = *NAME##View; \
62 return res; \
63 } \
64 return std::nullopt; \
65 }
66
67CGOPT(std::string, MArch)
68CGOPT(std::string, MCPU)
69CGLIST(std::string, MAttrs)
70CGOPT_EXP(Reloc::Model, RelocModel)
71CGOPT(ThreadModel::Model, ThreadModel)
72CGOPT_EXP(CodeModel::Model, CodeModel)
73CGOPT_EXP(uint64_t, LargeDataThreshold)
74CGOPT(ExceptionHandling, ExceptionModel)
75CGOPT_EXP(CodeGenFileType, FileType)
76CGOPT(FramePointerKind, FramePointerUsage)
77CGOPT(bool, EnableNoInfsFPMath)
78CGOPT(bool, EnableNoNaNsFPMath)
79CGOPT(bool, EnableNoSignedZerosFPMath)
80CGOPT(bool, EnableNoTrappingFPMath)
81CGOPT(bool, EnableAIXExtendedAltivecABI)
82CGOPT(DenormalMode::DenormalModeKind, DenormalFPMath)
83CGOPT(DenormalMode::DenormalModeKind, DenormalFP32Math)
84CGOPT(bool, EnableHonorSignDependentRoundingFPMath)
85CGOPT(FloatABI::ABIType, FloatABIForCalls)
86CGOPT(FPOpFusion::FPOpFusionMode, FuseFPOps)
87CGOPT(SwiftAsyncFramePointerMode, SwiftAsyncFramePointer)
88CGOPT(bool, DontPlaceZerosInBSS)
89CGOPT(bool, EnableGuaranteedTailCallOpt)
90CGOPT(bool, DisableTailCalls)
91CGOPT(bool, StackSymbolOrdering)
92CGOPT(bool, StackRealign)
93CGOPT(std::string, TrapFuncName)
94CGOPT(bool, UseCtors)
95CGOPT(bool, DisableIntegratedAS)
96CGOPT_EXP(bool, DataSections)
97CGOPT_EXP(bool, FunctionSections)
98CGOPT(bool, IgnoreXCOFFVisibility)
99CGOPT(bool, XCOFFTracebackTable)
100CGOPT(bool, EnableBBAddrMap)
101CGOPT(std::string, BBSections)
102CGOPT(unsigned, TLSSize)
103CGOPT_EXP(bool, EmulatedTLS)
104CGOPT_EXP(bool, EnableTLSDESC)
105CGOPT(bool, UniqueSectionNames)
106CGOPT(bool, UniqueBasicBlockSectionNames)
107CGOPT(bool, SeparateNamedSections)
108CGOPT(EABI, EABIVersion)
109CGOPT(DebuggerKind, DebuggerTuningOpt)
110CGOPT(VectorLibrary, VectorLibrary)
111CGOPT(bool, EnableStackSizeSection)
112CGOPT(bool, EnableAddrsig)
113CGOPT(bool, EnableCallGraphSection)
114CGOPT(bool, EmitCallSiteInfo)
115CGOPT(bool, EnableMachineFunctionSplitter)
116CGOPT(bool, EnableStaticDataPartitioning)
117CGOPT(bool, EnableDebugEntryValues)
118CGOPT(bool, ForceDwarfFrameSection)
119CGOPT(bool, XRayFunctionIndex)
120CGOPT(bool, DebugStrictDwarf)
121CGOPT(unsigned, AlignLoops)
122CGOPT(bool, JMCInstrument)
123CGOPT(bool, XCOFFReadOnlyPointers)
124CGOPT(codegen::SaveStatsMode, SaveStats)
125
126#define CGBINDOPT(NAME) \
127 do { \
128 NAME##View = std::addressof(NAME); \
129 } while (0)
130
131codegen::RegisterCodeGenFlags::RegisterCodeGenFlags() {
132 static cl::opt<std::string> MArch(
133 "march", cl::desc("Architecture to generate code for (see --version)"));
134 CGBINDOPT(MArch);
135
136 static cl::opt<std::string> MCPU(
137 "mcpu", cl::desc("Target a specific cpu type (-mcpu=help for details)"),
138 cl::value_desc("cpu-name"), cl::init(Val: ""));
139 CGBINDOPT(MCPU);
140
141 static cl::list<std::string> MAttrs(
142 "mattr", cl::CommaSeparated,
143 cl::desc("Target specific attributes (-mattr=help for details)"),
144 cl::value_desc("a1,+a2,-a3,..."));
145 CGBINDOPT(MAttrs);
146
147 static cl::opt<Reloc::Model> RelocModel(
148 "relocation-model", cl::desc("Choose relocation model"),
149 cl::values(
150 clEnumValN(Reloc::Static, "static", "Non-relocatable code"),
151 clEnumValN(Reloc::PIC_, "pic",
152 "Fully relocatable, position independent code"),
153 clEnumValN(Reloc::DynamicNoPIC, "dynamic-no-pic",
154 "Relocatable external references, non-relocatable code"),
155 clEnumValN(
156 Reloc::ROPI, "ropi",
157 "Code and read-only data relocatable, accessed PC-relative"),
158 clEnumValN(
159 Reloc::RWPI, "rwpi",
160 "Read-write data relocatable, accessed relative to static base"),
161 clEnumValN(Reloc::ROPI_RWPI, "ropi-rwpi",
162 "Combination of ropi and rwpi")));
163 CGBINDOPT(RelocModel);
164
165 static cl::opt<ThreadModel::Model> ThreadModel(
166 "thread-model", cl::desc("Choose threading model"),
167 cl::init(Val: ThreadModel::POSIX),
168 cl::values(
169 clEnumValN(ThreadModel::POSIX, "posix", "POSIX thread model"),
170 clEnumValN(ThreadModel::Single, "single", "Single thread model")));
171 CGBINDOPT(ThreadModel);
172
173 static cl::opt<CodeModel::Model> CodeModel(
174 "code-model", cl::desc("Choose code model"),
175 cl::values(clEnumValN(CodeModel::Tiny, "tiny", "Tiny code model"),
176 clEnumValN(CodeModel::Small, "small", "Small code model"),
177 clEnumValN(CodeModel::Kernel, "kernel", "Kernel code model"),
178 clEnumValN(CodeModel::Medium, "medium", "Medium code model"),
179 clEnumValN(CodeModel::Large, "large", "Large code model")));
180 CGBINDOPT(CodeModel);
181
182 static cl::opt<uint64_t> LargeDataThreshold(
183 "large-data-threshold",
184 cl::desc("Choose large data threshold for x86_64 medium code model"),
185 cl::init(Val: 0));
186 CGBINDOPT(LargeDataThreshold);
187
188 static cl::opt<ExceptionHandling> ExceptionModel(
189 "exception-model", cl::desc("exception model"),
190 cl::init(Val: ExceptionHandling::None),
191 cl::values(
192 clEnumValN(ExceptionHandling::None, "default",
193 "default exception handling model"),
194 clEnumValN(ExceptionHandling::DwarfCFI, "dwarf",
195 "DWARF-like CFI based exception handling"),
196 clEnumValN(ExceptionHandling::SjLj, "sjlj",
197 "SjLj exception handling"),
198 clEnumValN(ExceptionHandling::ARM, "arm", "ARM EHABI exceptions"),
199 clEnumValN(ExceptionHandling::WinEH, "wineh",
200 "Windows exception model"),
201 clEnumValN(ExceptionHandling::Wasm, "wasm",
202 "WebAssembly exception handling")));
203 CGBINDOPT(ExceptionModel);
204
205 static cl::opt<CodeGenFileType> FileType(
206 "filetype", cl::init(Val: CodeGenFileType::AssemblyFile),
207 cl::desc(
208 "Choose a file type (not all types are supported by all targets):"),
209 cl::values(clEnumValN(CodeGenFileType::AssemblyFile, "asm",
210 "Emit an assembly ('.s') file"),
211 clEnumValN(CodeGenFileType::ObjectFile, "obj",
212 "Emit a native object ('.o') file"),
213 clEnumValN(CodeGenFileType::Null, "null",
214 "Emit nothing, for performance testing")));
215 CGBINDOPT(FileType);
216
217 static cl::opt<FramePointerKind> FramePointerUsage(
218 "frame-pointer",
219 cl::desc("Specify frame pointer elimination optimization"),
220 cl::init(Val: FramePointerKind::None),
221 cl::values(
222 clEnumValN(FramePointerKind::All, "all",
223 "Disable frame pointer elimination"),
224 clEnumValN(FramePointerKind::NonLeaf, "non-leaf",
225 "Disable frame pointer elimination for non-leaf frame but "
226 "reserve the register in leaf functions"),
227 clEnumValN(FramePointerKind::NonLeafNoReserve, "non-leaf-no-reserve",
228 "Disable frame pointer elimination for non-leaf frame"),
229 clEnumValN(FramePointerKind::Reserved, "reserved",
230 "Enable frame pointer elimination, but reserve the frame "
231 "pointer register"),
232 clEnumValN(FramePointerKind::None, "none",
233 "Enable frame pointer elimination")));
234 CGBINDOPT(FramePointerUsage);
235
236 static cl::opt<bool> EnableNoInfsFPMath(
237 "enable-no-infs-fp-math",
238 cl::desc("Enable FP math optimizations that assume no +-Infs"),
239 cl::init(Val: false));
240 CGBINDOPT(EnableNoInfsFPMath);
241
242 static cl::opt<bool> EnableNoNaNsFPMath(
243 "enable-no-nans-fp-math",
244 cl::desc("Enable FP math optimizations that assume no NaNs"),
245 cl::init(Val: false));
246 CGBINDOPT(EnableNoNaNsFPMath);
247
248 static cl::opt<bool> EnableNoSignedZerosFPMath(
249 "enable-no-signed-zeros-fp-math",
250 cl::desc("Enable FP math optimizations that assume "
251 "the sign of 0 is insignificant"),
252 cl::init(Val: false));
253 CGBINDOPT(EnableNoSignedZerosFPMath);
254
255 static cl::opt<bool> EnableNoTrappingFPMath(
256 "enable-no-trapping-fp-math",
257 cl::desc("Enable setting the FP exceptions build "
258 "attribute not to use exceptions"),
259 cl::init(Val: false));
260 CGBINDOPT(EnableNoTrappingFPMath);
261
262 static const auto DenormFlagEnumOptions = cl::values(
263 clEnumValN(DenormalMode::IEEE, "ieee", "IEEE 754 denormal numbers"),
264 clEnumValN(DenormalMode::PreserveSign, "preserve-sign",
265 "the sign of a flushed-to-zero number is preserved "
266 "in the sign of 0"),
267 clEnumValN(DenormalMode::PositiveZero, "positive-zero",
268 "denormals are flushed to positive zero"),
269 clEnumValN(DenormalMode::Dynamic, "dynamic",
270 "denormals have unknown treatment"));
271
272 // FIXME: Doesn't have way to specify separate input and output modes.
273 static cl::opt<DenormalMode::DenormalModeKind> DenormalFPMath(
274 "denormal-fp-math",
275 cl::desc("Select which denormal numbers the code is permitted to require"),
276 cl::init(Val: DenormalMode::IEEE),
277 DenormFlagEnumOptions);
278 CGBINDOPT(DenormalFPMath);
279
280 static cl::opt<DenormalMode::DenormalModeKind> DenormalFP32Math(
281 "denormal-fp-math-f32",
282 cl::desc("Select which denormal numbers the code is permitted to require for float"),
283 cl::init(Val: DenormalMode::Invalid),
284 DenormFlagEnumOptions);
285 CGBINDOPT(DenormalFP32Math);
286
287 static cl::opt<bool> EnableHonorSignDependentRoundingFPMath(
288 "enable-sign-dependent-rounding-fp-math", cl::Hidden,
289 cl::desc("Force codegen to assume rounding mode can change dynamically"),
290 cl::init(Val: false));
291 CGBINDOPT(EnableHonorSignDependentRoundingFPMath);
292
293 static cl::opt<FloatABI::ABIType> FloatABIForCalls(
294 "float-abi", cl::desc("Choose float ABI type"),
295 cl::init(Val: FloatABI::Default),
296 cl::values(clEnumValN(FloatABI::Default, "default",
297 "Target default float ABI type"),
298 clEnumValN(FloatABI::Soft, "soft",
299 "Soft float ABI (implied by -soft-float)"),
300 clEnumValN(FloatABI::Hard, "hard",
301 "Hard float ABI (uses FP registers)")));
302 CGBINDOPT(FloatABIForCalls);
303
304 static cl::opt<FPOpFusion::FPOpFusionMode> FuseFPOps(
305 "fp-contract", cl::desc("Enable aggressive formation of fused FP ops"),
306 cl::init(Val: FPOpFusion::Standard),
307 cl::values(
308 clEnumValN(FPOpFusion::Fast, "fast",
309 "Fuse FP ops whenever profitable"),
310 clEnumValN(FPOpFusion::Standard, "on", "Only fuse 'blessed' FP ops."),
311 clEnumValN(FPOpFusion::Strict, "off",
312 "Only fuse FP ops when the result won't be affected.")));
313 CGBINDOPT(FuseFPOps);
314
315 static cl::opt<SwiftAsyncFramePointerMode> SwiftAsyncFramePointer(
316 "swift-async-fp",
317 cl::desc("Determine when the Swift async frame pointer should be set"),
318 cl::init(Val: SwiftAsyncFramePointerMode::Always),
319 cl::values(clEnumValN(SwiftAsyncFramePointerMode::DeploymentBased, "auto",
320 "Determine based on deployment target"),
321 clEnumValN(SwiftAsyncFramePointerMode::Always, "always",
322 "Always set the bit"),
323 clEnumValN(SwiftAsyncFramePointerMode::Never, "never",
324 "Never set the bit")));
325 CGBINDOPT(SwiftAsyncFramePointer);
326
327 static cl::opt<bool> DontPlaceZerosInBSS(
328 "nozero-initialized-in-bss",
329 cl::desc("Don't place zero-initialized symbols into bss section"),
330 cl::init(Val: false));
331 CGBINDOPT(DontPlaceZerosInBSS);
332
333 static cl::opt<bool> EnableAIXExtendedAltivecABI(
334 "vec-extabi", cl::desc("Enable the AIX Extended Altivec ABI."),
335 cl::init(Val: false));
336 CGBINDOPT(EnableAIXExtendedAltivecABI);
337
338 static cl::opt<bool> EnableGuaranteedTailCallOpt(
339 "tailcallopt",
340 cl::desc(
341 "Turn fastcc calls into tail calls by (potentially) changing ABI."),
342 cl::init(Val: false));
343 CGBINDOPT(EnableGuaranteedTailCallOpt);
344
345 static cl::opt<bool> DisableTailCalls(
346 "disable-tail-calls", cl::desc("Never emit tail calls"), cl::init(Val: false));
347 CGBINDOPT(DisableTailCalls);
348
349 static cl::opt<bool> StackSymbolOrdering(
350 "stack-symbol-ordering", cl::desc("Order local stack symbols."),
351 cl::init(Val: true));
352 CGBINDOPT(StackSymbolOrdering);
353
354 static cl::opt<bool> StackRealign(
355 "stackrealign",
356 cl::desc("Force align the stack to the minimum alignment"),
357 cl::init(Val: false));
358 CGBINDOPT(StackRealign);
359
360 static cl::opt<std::string> TrapFuncName(
361 "trap-func", cl::Hidden,
362 cl::desc("Emit a call to trap function rather than a trap instruction"),
363 cl::init(Val: ""));
364 CGBINDOPT(TrapFuncName);
365
366 static cl::opt<bool> UseCtors("use-ctors",
367 cl::desc("Use .ctors instead of .init_array."),
368 cl::init(Val: false));
369 CGBINDOPT(UseCtors);
370
371 static cl::opt<bool> DataSections(
372 "data-sections", cl::desc("Emit data into separate sections"),
373 cl::init(Val: false));
374 CGBINDOPT(DataSections);
375
376 static cl::opt<bool> FunctionSections(
377 "function-sections", cl::desc("Emit functions into separate sections"),
378 cl::init(Val: false));
379 CGBINDOPT(FunctionSections);
380
381 static cl::opt<bool> IgnoreXCOFFVisibility(
382 "ignore-xcoff-visibility",
383 cl::desc("Not emit the visibility attribute for asm in AIX OS or give "
384 "all symbols 'unspecified' visibility in XCOFF object file"),
385 cl::init(Val: false));
386 CGBINDOPT(IgnoreXCOFFVisibility);
387
388 static cl::opt<bool> XCOFFTracebackTable(
389 "xcoff-traceback-table", cl::desc("Emit the XCOFF traceback table"),
390 cl::init(Val: true));
391 CGBINDOPT(XCOFFTracebackTable);
392
393 static cl::opt<bool> EnableBBAddrMap(
394 "basic-block-address-map",
395 cl::desc("Emit the basic block address map section"), cl::init(Val: false));
396 CGBINDOPT(EnableBBAddrMap);
397
398 static cl::opt<std::string> BBSections(
399 "basic-block-sections",
400 cl::desc("Emit basic blocks into separate sections"),
401 cl::value_desc("all | <function list (file)> | labels | none"),
402 cl::init(Val: "none"));
403 CGBINDOPT(BBSections);
404
405 static cl::opt<unsigned> TLSSize(
406 "tls-size", cl::desc("Bit size of immediate TLS offsets"), cl::init(Val: 0));
407 CGBINDOPT(TLSSize);
408
409 static cl::opt<bool> EmulatedTLS(
410 "emulated-tls", cl::desc("Use emulated TLS model"), cl::init(Val: false));
411 CGBINDOPT(EmulatedTLS);
412
413 static cl::opt<bool> EnableTLSDESC(
414 "enable-tlsdesc", cl::desc("Enable the use of TLS Descriptors"),
415 cl::init(Val: false));
416 CGBINDOPT(EnableTLSDESC);
417
418 static cl::opt<bool> UniqueSectionNames(
419 "unique-section-names", cl::desc("Give unique names to every section"),
420 cl::init(Val: true));
421 CGBINDOPT(UniqueSectionNames);
422
423 static cl::opt<bool> UniqueBasicBlockSectionNames(
424 "unique-basic-block-section-names",
425 cl::desc("Give unique names to every basic block section"),
426 cl::init(Val: false));
427 CGBINDOPT(UniqueBasicBlockSectionNames);
428
429 static cl::opt<bool> SeparateNamedSections(
430 "separate-named-sections",
431 cl::desc("Use separate unique sections for named sections"),
432 cl::init(Val: false));
433 CGBINDOPT(SeparateNamedSections);
434
435 static cl::opt<EABI> EABIVersion(
436 "meabi", cl::desc("Set EABI type (default depends on triple):"),
437 cl::init(Val: EABI::Default),
438 cl::values(
439 clEnumValN(EABI::Default, "default", "Triple default EABI version"),
440 clEnumValN(EABI::EABI4, "4", "EABI version 4"),
441 clEnumValN(EABI::EABI5, "5", "EABI version 5"),
442 clEnumValN(EABI::GNU, "gnu", "EABI GNU")));
443 CGBINDOPT(EABIVersion);
444
445 static cl::opt<DebuggerKind> DebuggerTuningOpt(
446 "debugger-tune", cl::desc("Tune debug info for a particular debugger"),
447 cl::init(Val: DebuggerKind::Default),
448 cl::values(
449 clEnumValN(DebuggerKind::GDB, "gdb", "gdb"),
450 clEnumValN(DebuggerKind::LLDB, "lldb", "lldb"),
451 clEnumValN(DebuggerKind::DBX, "dbx", "dbx"),
452 clEnumValN(DebuggerKind::SCE, "sce", "SCE targets (e.g. PS4)")));
453 CGBINDOPT(DebuggerTuningOpt);
454
455 static cl::opt<VectorLibrary> VectorLibrary(
456 "vector-library", cl::Hidden, cl::desc("Vector functions library"),
457 cl::init(Val: VectorLibrary::NoLibrary),
458 cl::values(
459 clEnumValN(VectorLibrary::NoLibrary, "none",
460 "No vector functions library"),
461 clEnumValN(VectorLibrary::Accelerate, "Accelerate",
462 "Accelerate framework"),
463 clEnumValN(VectorLibrary::DarwinLibSystemM, "Darwin_libsystem_m",
464 "Darwin libsystem_m"),
465 clEnumValN(VectorLibrary::LIBMVEC, "LIBMVEC",
466 "GLIBC Vector Math library"),
467 clEnumValN(VectorLibrary::MASSV, "MASSV", "IBM MASS vector library"),
468 clEnumValN(VectorLibrary::SVML, "SVML", "Intel SVML library"),
469 clEnumValN(VectorLibrary::SLEEFGNUABI, "sleefgnuabi",
470 "SIMD Library for Evaluating Elementary Functions"),
471 clEnumValN(VectorLibrary::ArmPL, "ArmPL",
472 "Arm Performance Libraries"),
473 clEnumValN(VectorLibrary::AMDLIBM, "AMDLIBM",
474 "AMD vector math library")));
475 CGBINDOPT(VectorLibrary);
476
477 static cl::opt<bool> EnableStackSizeSection(
478 "stack-size-section",
479 cl::desc("Emit a section containing stack size metadata"),
480 cl::init(Val: false));
481 CGBINDOPT(EnableStackSizeSection);
482
483 static cl::opt<bool> EnableAddrsig(
484 "addrsig", cl::desc("Emit an address-significance table"),
485 cl::init(Val: false));
486 CGBINDOPT(EnableAddrsig);
487
488 static cl::opt<bool> EnableCallGraphSection(
489 "call-graph-section", cl::desc("Emit a call graph section"),
490 cl::init(Val: false));
491 CGBINDOPT(EnableCallGraphSection);
492
493 static cl::opt<bool> EmitCallSiteInfo(
494 "emit-call-site-info",
495 cl::desc(
496 "Emit call site debug information, if debug information is enabled."),
497 cl::init(Val: false));
498 CGBINDOPT(EmitCallSiteInfo);
499
500 static cl::opt<bool> EnableDebugEntryValues(
501 "debug-entry-values",
502 cl::desc("Enable debug info for the debug entry values."),
503 cl::init(Val: false));
504 CGBINDOPT(EnableDebugEntryValues);
505
506 static cl::opt<bool> EnableMachineFunctionSplitter(
507 "split-machine-functions",
508 cl::desc("Split out cold basic blocks from machine functions based on "
509 "profile information"),
510 cl::init(Val: false));
511 CGBINDOPT(EnableMachineFunctionSplitter);
512
513 static cl::opt<bool> EnableStaticDataPartitioning(
514 "partition-static-data-sections",
515 cl::desc("Partition data sections using profile information."),
516 cl::init(Val: false));
517 CGBINDOPT(EnableStaticDataPartitioning);
518
519 static cl::opt<bool> ForceDwarfFrameSection(
520 "force-dwarf-frame-section",
521 cl::desc("Always emit a debug frame section."), cl::init(Val: false));
522 CGBINDOPT(ForceDwarfFrameSection);
523
524 static cl::opt<bool> XRayFunctionIndex("xray-function-index",
525 cl::desc("Emit xray_fn_idx section"),
526 cl::init(Val: true));
527 CGBINDOPT(XRayFunctionIndex);
528
529 static cl::opt<bool> DebugStrictDwarf(
530 "strict-dwarf", cl::desc("use strict dwarf"), cl::init(Val: false));
531 CGBINDOPT(DebugStrictDwarf);
532
533 static cl::opt<unsigned> AlignLoops("align-loops",
534 cl::desc("Default alignment for loops"));
535 CGBINDOPT(AlignLoops);
536
537 static cl::opt<bool> JMCInstrument(
538 "enable-jmc-instrument",
539 cl::desc("Instrument functions with a call to __CheckForDebuggerJustMyCode"),
540 cl::init(Val: false));
541 CGBINDOPT(JMCInstrument);
542
543 static cl::opt<bool> XCOFFReadOnlyPointers(
544 "mxcoff-roptr",
545 cl::desc("When set to true, const objects with relocatable address "
546 "values are put into the RO data section."),
547 cl::init(Val: false));
548 CGBINDOPT(XCOFFReadOnlyPointers);
549
550 static cl::opt<bool> DisableIntegratedAS(
551 "no-integrated-as", cl::desc("Disable integrated assembler"),
552 cl::init(Val: false));
553 CGBINDOPT(DisableIntegratedAS);
554
555 mc::RegisterMCTargetOptionsFlags();
556}
557
558codegen::RegisterSaveStatsFlag::RegisterSaveStatsFlag() {
559 static cl::opt<SaveStatsMode> SaveStats(
560 "save-stats",
561 cl::desc(
562 "Save LLVM statistics to a file in the current directory"
563 "(`-save-stats`/`-save-stats=cwd`) or the directory of the output"
564 "file (`-save-stats=obj`). (default: cwd)"),
565 cl::values(clEnumValN(SaveStatsMode::Cwd, "cwd",
566 "Save to the current working directory"),
567 clEnumValN(SaveStatsMode::Cwd, "", ""),
568 clEnumValN(SaveStatsMode::Obj, "obj",
569 "Save to the output file directory")),
570 cl::init(Val: SaveStatsMode::None), cl::ValueOptional);
571 CGBINDOPT(SaveStats);
572}
573
574llvm::BasicBlockSection
575codegen::getBBSectionsMode(llvm::TargetOptions &Options) {
576 if (getBBSections() == "all")
577 return BasicBlockSection::All;
578 else if (getBBSections() == "none")
579 return BasicBlockSection::None;
580 else {
581 ErrorOr<std::unique_ptr<MemoryBuffer>> MBOrErr =
582 MemoryBuffer::getFile(Filename: getBBSections());
583 if (!MBOrErr) {
584 errs() << "Error loading basic block sections function list file: "
585 << MBOrErr.getError().message() << "\n";
586 } else {
587 Options.BBSectionsFuncListBuf = std::move(*MBOrErr);
588 }
589 return BasicBlockSection::List;
590 }
591}
592
593// Common utility function tightly tied to the options listed here. Initializes
594// a TargetOptions object with CodeGen flags and returns it.
595TargetOptions
596codegen::InitTargetOptionsFromCodeGenFlags(const Triple &TheTriple) {
597 TargetOptions Options;
598 Options.AllowFPOpFusion = getFuseFPOps();
599 Options.NoInfsFPMath = getEnableNoInfsFPMath();
600 Options.NoNaNsFPMath = getEnableNoNaNsFPMath();
601 Options.NoSignedZerosFPMath = getEnableNoSignedZerosFPMath();
602 Options.NoTrappingFPMath = getEnableNoTrappingFPMath();
603
604 Options.HonorSignDependentRoundingFPMathOption =
605 getEnableHonorSignDependentRoundingFPMath();
606 if (getFloatABIForCalls() != FloatABI::Default)
607 Options.FloatABIType = getFloatABIForCalls();
608 Options.EnableAIXExtendedAltivecABI = getEnableAIXExtendedAltivecABI();
609 Options.NoZerosInBSS = getDontPlaceZerosInBSS();
610 Options.GuaranteedTailCallOpt = getEnableGuaranteedTailCallOpt();
611 Options.StackSymbolOrdering = getStackSymbolOrdering();
612 Options.UseInitArray = !getUseCtors();
613 Options.DisableIntegratedAS = getDisableIntegratedAS();
614 Options.DataSections =
615 getExplicitDataSections().value_or(u: TheTriple.hasDefaultDataSections());
616 Options.FunctionSections = getFunctionSections();
617 Options.IgnoreXCOFFVisibility = getIgnoreXCOFFVisibility();
618 Options.XCOFFTracebackTable = getXCOFFTracebackTable();
619 Options.BBAddrMap = getEnableBBAddrMap();
620 Options.BBSections = getBBSectionsMode(Options);
621 Options.UniqueSectionNames = getUniqueSectionNames();
622 Options.UniqueBasicBlockSectionNames = getUniqueBasicBlockSectionNames();
623 Options.SeparateNamedSections = getSeparateNamedSections();
624 Options.TLSSize = getTLSSize();
625 Options.EmulatedTLS =
626 getExplicitEmulatedTLS().value_or(u: TheTriple.hasDefaultEmulatedTLS());
627 Options.EnableTLSDESC =
628 getExplicitEnableTLSDESC().value_or(u: TheTriple.hasDefaultTLSDESC());
629 Options.ExceptionModel = getExceptionModel();
630 Options.VecLib = getVectorLibrary();
631 Options.EmitStackSizeSection = getEnableStackSizeSection();
632 Options.EnableMachineFunctionSplitter = getEnableMachineFunctionSplitter();
633 Options.EnableStaticDataPartitioning = getEnableStaticDataPartitioning();
634 Options.EmitAddrsig = getEnableAddrsig();
635 Options.EmitCallGraphSection = getEnableCallGraphSection();
636 Options.EmitCallSiteInfo = getEmitCallSiteInfo();
637 Options.EnableDebugEntryValues = getEnableDebugEntryValues();
638 Options.ForceDwarfFrameSection = getForceDwarfFrameSection();
639 Options.XRayFunctionIndex = getXRayFunctionIndex();
640 Options.DebugStrictDwarf = getDebugStrictDwarf();
641 Options.LoopAlignment = getAlignLoops();
642 Options.JMCInstrument = getJMCInstrument();
643 Options.XCOFFReadOnlyPointers = getXCOFFReadOnlyPointers();
644
645 Options.MCOptions = mc::InitMCTargetOptionsFromFlags();
646
647 Options.ThreadModel = getThreadModel();
648 Options.EABIVersion = getEABIVersion();
649 Options.DebuggerTuning = getDebuggerTuningOpt();
650 Options.SwiftAsyncFramePointer = getSwiftAsyncFramePointer();
651 return Options;
652}
653
654std::string codegen::getCPUStr() {
655 // If user asked for the 'native' CPU, autodetect here. If autodection fails,
656 // this will set the CPU to an empty string which tells the target to
657 // pick a basic default.
658 if (getMCPU() == "native")
659 return std::string(sys::getHostCPUName());
660
661 return getMCPU();
662}
663
664std::string codegen::getFeaturesStr() {
665 SubtargetFeatures Features;
666
667 // If user asked for the 'native' CPU, we need to autodetect features.
668 // This is necessary for x86 where the CPU might not support all the
669 // features the autodetected CPU name lists in the target. For example,
670 // not all Sandybridge processors support AVX.
671 if (getMCPU() == "native")
672 for (const auto &[Feature, IsEnabled] : sys::getHostCPUFeatures())
673 Features.AddFeature(String: Feature, Enable: IsEnabled);
674
675 for (auto const &MAttr : getMAttrs())
676 Features.AddFeature(String: MAttr);
677
678 return Features.getString();
679}
680
681std::vector<std::string> codegen::getFeatureList() {
682 SubtargetFeatures Features;
683
684 // If user asked for the 'native' CPU, we need to autodetect features.
685 // This is necessary for x86 where the CPU might not support all the
686 // features the autodetected CPU name lists in the target. For example,
687 // not all Sandybridge processors support AVX.
688 if (getMCPU() == "native")
689 for (const auto &[Feature, IsEnabled] : sys::getHostCPUFeatures())
690 Features.AddFeature(String: Feature, Enable: IsEnabled);
691
692 for (auto const &MAttr : getMAttrs())
693 Features.AddFeature(String: MAttr);
694
695 return Features.getFeatures();
696}
697
698void codegen::renderBoolStringAttr(AttrBuilder &B, StringRef Name, bool Val) {
699 B.addAttribute(A: Name, V: Val ? "true" : "false");
700}
701
702#define HANDLE_BOOL_ATTR(CL, AttrName) \
703 do { \
704 if (CL->getNumOccurrences() > 0 && !F.hasFnAttribute(AttrName)) \
705 renderBoolStringAttr(NewAttrs, AttrName, *CL); \
706 } while (0)
707
708/// Set function attributes of function \p F based on CPU, Features, and command
709/// line flags.
710void codegen::setFunctionAttributes(StringRef CPU, StringRef Features,
711 Function &F) {
712 auto &Ctx = F.getContext();
713 AttributeList Attrs = F.getAttributes();
714 AttrBuilder NewAttrs(Ctx);
715
716 if (!CPU.empty() && !F.hasFnAttribute(Kind: "target-cpu"))
717 NewAttrs.addAttribute(A: "target-cpu", V: CPU);
718 if (!Features.empty()) {
719 // Append the command line features to any that are already on the function.
720 StringRef OldFeatures =
721 F.getFnAttribute(Kind: "target-features").getValueAsString();
722 if (OldFeatures.empty())
723 NewAttrs.addAttribute(A: "target-features", V: Features);
724 else {
725 SmallString<256> Appended(OldFeatures);
726 Appended.push_back(Elt: ',');
727 Appended.append(RHS: Features);
728 NewAttrs.addAttribute(A: "target-features", V: Appended);
729 }
730 }
731 if (FramePointerUsageView->getNumOccurrences() > 0 &&
732 !F.hasFnAttribute(Kind: "frame-pointer")) {
733 if (getFramePointerUsage() == FramePointerKind::All)
734 NewAttrs.addAttribute(A: "frame-pointer", V: "all");
735 else if (getFramePointerUsage() == FramePointerKind::NonLeaf)
736 NewAttrs.addAttribute(A: "frame-pointer", V: "non-leaf");
737 else if (getFramePointerUsage() == FramePointerKind::NonLeafNoReserve)
738 NewAttrs.addAttribute(A: "frame-pointer", V: "non-leaf-no-reserve");
739 else if (getFramePointerUsage() == FramePointerKind::Reserved)
740 NewAttrs.addAttribute(A: "frame-pointer", V: "reserved");
741 else if (getFramePointerUsage() == FramePointerKind::None)
742 NewAttrs.addAttribute(A: "frame-pointer", V: "none");
743 }
744 if (DisableTailCallsView->getNumOccurrences() > 0)
745 NewAttrs.addAttribute(A: "disable-tail-calls",
746 V: toStringRef(B: getDisableTailCalls()));
747 if (getStackRealign())
748 NewAttrs.addAttribute(A: "stackrealign");
749
750 HANDLE_BOOL_ATTR(EnableNoInfsFPMathView, "no-infs-fp-math");
751 HANDLE_BOOL_ATTR(EnableNoNaNsFPMathView, "no-nans-fp-math");
752 HANDLE_BOOL_ATTR(EnableNoSignedZerosFPMathView, "no-signed-zeros-fp-math");
753
754 if (DenormalFPMathView->getNumOccurrences() > 0 &&
755 !F.hasFnAttribute(Kind: "denormal-fp-math")) {
756 DenormalMode::DenormalModeKind DenormKind = getDenormalFPMath();
757
758 // FIXME: Command line flag should expose separate input/output modes.
759 NewAttrs.addAttribute(A: "denormal-fp-math",
760 V: DenormalMode(DenormKind, DenormKind).str());
761 }
762
763 if (DenormalFP32MathView->getNumOccurrences() > 0 &&
764 !F.hasFnAttribute(Kind: "denormal-fp-math-f32")) {
765 // FIXME: Command line flag should expose separate input/output modes.
766 DenormalMode::DenormalModeKind DenormKind = getDenormalFP32Math();
767
768 NewAttrs.addAttribute(
769 A: "denormal-fp-math-f32",
770 V: DenormalMode(DenormKind, DenormKind).str());
771 }
772
773 if (TrapFuncNameView->getNumOccurrences() > 0)
774 for (auto &B : F)
775 for (auto &I : B)
776 if (auto *Call = dyn_cast<CallInst>(Val: &I))
777 if (const auto *F = Call->getCalledFunction())
778 if (F->getIntrinsicID() == Intrinsic::debugtrap ||
779 F->getIntrinsicID() == Intrinsic::trap)
780 Call->addFnAttr(
781 Attr: Attribute::get(Context&: Ctx, Kind: "trap-func-name", Val: getTrapFuncName()));
782
783 // Let NewAttrs override Attrs.
784 F.setAttributes(Attrs.addFnAttributes(C&: Ctx, B: NewAttrs));
785}
786
787/// Set function attributes of functions in Module M based on CPU,
788/// Features, and command line flags.
789void codegen::setFunctionAttributes(StringRef CPU, StringRef Features,
790 Module &M) {
791 for (Function &F : M)
792 setFunctionAttributes(CPU, Features, F);
793}
794
795Expected<std::unique_ptr<TargetMachine>>
796codegen::createTargetMachineForTriple(StringRef TargetTriple,
797 CodeGenOptLevel OptLevel) {
798 Triple TheTriple(TargetTriple);
799 std::string Error;
800 const auto *TheTarget =
801 TargetRegistry::lookupTarget(ArchName: codegen::getMArch(), TheTriple, Error);
802 if (!TheTarget)
803 return createStringError(EC: inconvertibleErrorCode(), S: Error);
804 auto *Target = TheTarget->createTargetMachine(
805 TT: TheTriple, CPU: codegen::getCPUStr(), Features: codegen::getFeaturesStr(),
806 Options: codegen::InitTargetOptionsFromCodeGenFlags(TheTriple),
807 RM: codegen::getExplicitRelocModel(), CM: codegen::getExplicitCodeModel(),
808 OL: OptLevel);
809 if (!Target)
810 return createStringError(EC: inconvertibleErrorCode(),
811 S: Twine("could not allocate target machine for ") +
812 TargetTriple);
813 return std::unique_ptr<TargetMachine>(Target);
814}
815
816void codegen::MaybeEnableStatistics() {
817 if (getSaveStats() == SaveStatsMode::None)
818 return;
819
820 llvm::EnableStatistics(DoPrintOnExit: false);
821}
822
823int codegen::MaybeSaveStatistics(StringRef OutputFilename, StringRef ToolName) {
824 auto SaveStatsValue = getSaveStats();
825 if (SaveStatsValue == codegen::SaveStatsMode::None)
826 return 0;
827
828 SmallString<128> StatsFilename;
829 if (SaveStatsValue == codegen::SaveStatsMode::Obj) {
830 StatsFilename = OutputFilename;
831 llvm::sys::path::remove_filename(path&: StatsFilename);
832 } else {
833 assert(SaveStatsValue == codegen::SaveStatsMode::Cwd &&
834 "Should have been a valid --save-stats value");
835 }
836
837 auto BaseName = llvm::sys::path::filename(path: OutputFilename);
838 llvm::sys::path::append(path&: StatsFilename, a: BaseName);
839 llvm::sys::path::replace_extension(path&: StatsFilename, extension: "stats");
840
841 auto FileFlags = llvm::sys::fs::OF_TextWithCRLF;
842 std::error_code EC;
843 auto StatsOS =
844 std::make_unique<llvm::raw_fd_ostream>(args&: StatsFilename, args&: EC, args&: FileFlags);
845 if (EC) {
846 WithColor::error(OS&: errs(), Prefix: ToolName)
847 << "Unable to open statistics file: " << EC.message() << "\n";
848 return 1;
849 }
850
851 llvm::PrintStatisticsJSON(OS&: *StatsOS);
852 return 0;
853}
854