LLVM  14.0.0git
X86.h
Go to the documentation of this file.
1 //===-- X86.h - Top-level interface for X86 representation ------*- 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 the entry points for global functions defined in the x86
10 // target library, as used by the LLVM JIT.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_TARGET_X86_X86_H
15 #define LLVM_LIB_TARGET_X86_X86_H
16 
17 #include "llvm/Support/CodeGen.h"
18 
19 namespace llvm {
20 
21 class FunctionPass;
22 class InstructionSelector;
23 class PassRegistry;
24 class X86RegisterBankInfo;
25 class X86Subtarget;
26 class X86TargetMachine;
27 
28 /// This pass converts a legalized DAG into a X86-specific DAG, ready for
29 /// instruction scheduling.
30 FunctionPass *createX86ISelDag(X86TargetMachine &TM,
31  CodeGenOpt::Level OptLevel);
32 
33 /// This pass initializes a global base register for PIC on x86-32.
34 FunctionPass *createX86GlobalBaseRegPass();
35 
36 /// This pass combines multiple accesses to local-dynamic TLS variables so that
37 /// the TLS base address for the module is only fetched once per execution path
38 /// through the function.
39 FunctionPass *createCleanupLocalDynamicTLSPass();
40 
41 /// This function returns a pass which converts floating-point register
42 /// references and pseudo instructions into floating-point stack references and
43 /// physical instructions.
45 
46 /// This pass inserts AVX vzeroupper instructions before each call to avoid
47 /// transition penalty between functions encoded with AVX and SSE.
48 FunctionPass *createX86IssueVZeroUpperPass();
49 
50 /// This pass inserts ENDBR instructions before indirect jump/call
51 /// destinations as part of CET IBT mechanism.
53 
54 /// Return a pass that pads short functions with NOOPs.
55 /// This will prevent a stall when returning on the Atom.
56 FunctionPass *createX86PadShortFunctions();
57 
58 /// Return a pass that selectively replaces certain instructions (like add,
59 /// sub, inc, dec, some shifts, and some multiplies) by equivalent LEA
60 /// instructions, in order to eliminate execution delays in some processors.
61 FunctionPass *createX86FixupLEAs();
62 
63 /// Return a pass that removes redundant LEA instructions and redundant address
64 /// recalculations.
65 FunctionPass *createX86OptimizeLEAs();
66 
67 /// Return a pass that transforms setcc + movzx pairs into xor + setcc.
68 FunctionPass *createX86FixupSetCC();
69 
70 /// Return a pass that avoids creating store forward block issues in the hardware.
72 
73 /// Return a pass that lowers EFLAGS copy pseudo instructions.
74 FunctionPass *createX86FlagsCopyLoweringPass();
75 
76 /// Return a pass that expands WinAlloca pseudo-instructions.
77 FunctionPass *createX86WinAllocaExpander();
78 
79 /// Return a pass that config the tile registers.
80 FunctionPass *createX86TileConfigPass();
81 
82 /// Return a pass that config the tile registers after fast reg allocation.
83 FunctionPass *createX86FastTileConfigPass();
84 
85 /// Return a pass that insert pseudo tile config instruction.
86 FunctionPass *createX86PreTileConfigPass();
87 
88 /// Return a pass that lower the tile copy instruction.
89 FunctionPass *createX86LowerTileCopyPass();
90 
91 /// Return a pass that inserts int3 at the end of the function if it ends with a
92 /// CALL instruction. The pass does the same for each funclet as well. This
93 /// ensures that the open interval of function start and end PCs contains all
94 /// return addresses for the benefit of the Windows x64 unwinder.
95 FunctionPass *createX86AvoidTrailingCallPass();
96 
97 /// Return a pass that optimizes the code-size of x86 call sequences. This is
98 /// done by replacing esp-relative movs with pushes.
99 FunctionPass *createX86CallFrameOptimization();
100 
101 /// Return an IR pass that inserts EH registration stack objects and explicit
102 /// EH state updates. This pass must run after EH preparation, which does
103 /// Windows-specific but architecture-neutral preparation.
104 FunctionPass *createX86WinEHStatePass();
105 
106 /// Return a Machine IR pass that expands X86-specific pseudo
107 /// instructions into a sequence of actual instructions. This pass
108 /// must run after prologue/epilogue insertion and before lowering
109 /// the MachineInstr to MC.
110 FunctionPass *createX86ExpandPseudoPass();
111 
112 /// This pass converts X86 cmov instructions into branch when profitable.
113 FunctionPass *createX86CmovConverterPass();
114 
115 /// Return a Machine IR pass that selectively replaces
116 /// certain byte and word instructions by equivalent 32 bit instructions,
117 /// in order to eliminate partial register usage, false dependences on
118 /// the upper portions of registers, and to save code size.
119 FunctionPass *createX86FixupBWInsts();
120 
121 /// Return a Machine IR pass that reassigns instruction chains from one domain
122 /// to another, when profitable.
123 FunctionPass *createX86DomainReassignmentPass();
124 
125 /// This pass replaces EVEX encoded of AVX-512 instructiosn by VEX
126 /// encoding when possible in order to reduce code size.
127 FunctionPass *createX86EvexToVexInsts();
128 
129 /// This pass creates the thunks for the retpoline feature.
130 FunctionPass *createX86IndirectThunksPass();
131 
132 /// This pass ensures instructions featuring a memory operand
133 /// have distinctive <LineNumber, Discriminator> (with respect to eachother)
134 FunctionPass *createX86DiscriminateMemOpsPass();
135 
136 /// This pass applies profiling information to insert cache prefetches.
137 FunctionPass *createX86InsertPrefetchPass();
138 
139 /// This pass insert wait instruction after X87 instructions which could raise
140 /// fp exceptions when strict-fp enabled.
141 FunctionPass *createX86InsertX87waitPass();
142 
143 /// This pass optimizes arithmetic based on knowledge that is only used by
144 /// a reduction sequence and is therefore safe to reassociate in interesting
145 /// ways.
146 FunctionPass *createX86PartialReductionPass();
147 
148 InstructionSelector *createX86InstructionSelector(const X86TargetMachine &TM,
149  X86Subtarget &,
150  X86RegisterBankInfo &);
151 
156 
157 void initializeEvexToVexInstPassPass(PassRegistry &);
158 void initializeFixupBWInstPassPass(PassRegistry &);
159 void initializeFixupLEAPassPass(PassRegistry &);
160 void initializeFPSPass(PassRegistry &);
161 void initializeWinEHStatePassPass(PassRegistry &);
162 void initializeX86AvoidSFBPassPass(PassRegistry &);
163 void initializeX86AvoidTrailingCallPassPass(PassRegistry &);
164 void initializeX86CallFrameOptimizationPass(PassRegistry &);
165 void initializeX86CmovConverterPassPass(PassRegistry &);
166 void initializeX86DomainReassignmentPass(PassRegistry &);
167 void initializeX86ExecutionDomainFixPass(PassRegistry &);
168 void initializeX86ExpandPseudoPass(PassRegistry &);
169 void initializeX86FixupSetCCPassPass(PassRegistry &);
170 void initializeX86FlagsCopyLoweringPassPass(PassRegistry &);
173 void initializeX86OptimizeLEAPassPass(PassRegistry &);
174 void initializeX86PartialReductionPass(PassRegistry &);
177 void initializeX86PreTileConfigPass(PassRegistry &);
178 void initializeX86FastTileConfigPass(PassRegistry &);
179 void initializeX86TileConfigPass(PassRegistry &);
180 void initializeX86LowerAMXTypeLegacyPassPass(PassRegistry &);
181 void initializeX86PreAMXConfigPassPass(PassRegistry &);
182 void initializeX86LowerTileCopyPass(PassRegistry &);
184 
185 namespace X86AS {
186 enum : unsigned {
187  GS = 256,
188  FS = 257,
189  SS = 258,
190  PTR32_SPTR = 270,
191  PTR32_UPTR = 271,
192  PTR64 = 272
193 };
194 } // End X86AS namespace
195 
196 } // End llvm namespace
197 
198 #endif
llvm::X86AS::PTR32_UPTR
@ PTR32_UPTR
Definition: X86.h:191
llvm::createX86FlagsCopyLoweringPass
FunctionPass * createX86FlagsCopyLoweringPass()
Return a pass that lowers EFLAGS copy pseudo instructions.
Definition: X86FlagsCopyLowering.cpp:140
llvm::createX86FixupLEAs
FunctionPass * createX86FixupLEAs()
Return a pass that selectively replaces certain instructions (like add, sub, inc, dec,...
Definition: X86FixupLEAs.cpp:219
llvm::createX86PadShortFunctions
FunctionPass * createX86PadShortFunctions()
Return a pass that pads short functions with NOOPs.
Definition: X86PadShortFunction.cpp:100
llvm
---------------------— PointerInfo ------------------------------------—
Definition: AllocatorList.h:23
llvm::createX86AvoidTrailingCallPass
FunctionPass * createX86AvoidTrailingCallPass()
Return a pass that inserts int3 at the end of the function if it ends with a CALL instruction.
Definition: X86AvoidTrailingCall.cpp:63
llvm::createX86WinAllocaExpander
FunctionPass * createX86WinAllocaExpander()
Return a pass that expands WinAlloca pseudo-instructions.
Definition: X86WinAllocaExpander.cpp:75
llvm::X86AS::PTR64
@ PTR64
Definition: X86.h:192
llvm::initializeX86FastTileConfigPass
void initializeX86FastTileConfigPass(PassRegistry &)
llvm::createX86PreTileConfigPass
FunctionPass * createX86PreTileConfigPass()
Return a pass that insert pseudo tile config instruction.
Definition: X86PreTileConfig.cpp:402
llvm::createX86InstructionSelector
InstructionSelector * createX86InstructionSelector(const X86TargetMachine &TM, X86Subtarget &, X86RegisterBankInfo &)
Definition: X86InstructionSelector.cpp:1689
llvm::initializeEvexToVexInstPassPass
void initializeEvexToVexInstPassPass(PassRegistry &)
llvm::createX86IndirectThunksPass
FunctionPass * createX86IndirectThunksPass()
This pass creates the thunks for the retpoline feature.
Definition: X86IndirectThunks.cpp:254
llvm::initializeX86ExpandPseudoPass
void initializeX86ExpandPseudoPass(PassRegistry &)
llvm::createCleanupLocalDynamicTLSPass
FunctionPass * createCleanupLocalDynamicTLSPass()
This pass combines multiple accesses to local-dynamic TLS variables so that the TLS base address for ...
Definition: X86InstrInfo.cpp:8914
llvm::createX86TileConfigPass
FunctionPass * createX86TileConfigPass()
Return a pass that config the tile registers.
Definition: X86TileConfig.cpp:196
llvm::createX86FixupSetCC
FunctionPass * createX86FixupSetCC()
Return a pass that transforms setcc + movzx pairs into xor + setcc.
Definition: X86FixupSetCC.cpp:59
llvm::createX86FastTileConfigPass
FunctionPass * createX86FastTileConfigPass()
Return a pass that config the tile registers after fast reg allocation.
Definition: X86FastTileConfig.cpp:305
llvm::X86AS::GS
@ GS
Definition: X86.h:187
llvm::createX86CallFrameOptimization
FunctionPass * createX86CallFrameOptimization()
Return a pass that optimizes the code-size of x86 call sequences.
Definition: X86CallFrameOptimization.cpp:638
llvm::createX86FloatingPointStackifierPass
FunctionPass * createX86FloatingPointStackifierPass()
This function returns a pass which converts floating-point register references and pseudo instruction...
Definition: X86FloatingPoint.cpp:311
llvm::createX86SpeculativeLoadHardeningPass
FunctionPass * createX86SpeculativeLoadHardeningPass()
Definition: X86SpeculativeLoadHardening.cpp:2277
llvm::createX86PartialReductionPass
FunctionPass * createX86PartialReductionPass()
This pass optimizes arithmetic based on knowledge that is only used by a reduction sequence and is th...
Definition: X86PartialReduction.cpp:57
llvm::initializeX86SpeculativeLoadHardeningPassPass
void initializeX86SpeculativeLoadHardeningPassPass(PassRegistry &)
llvm::initializeWinEHStatePassPass
void initializeWinEHStatePassPass(PassRegistry &)
llvm::createX86LowerTileCopyPass
FunctionPass * createX86LowerTileCopyPass()
Return a pass that lower the tile copy instruction.
Definition: X86LowerTileCopy.cpp:68
llvm::createX86LoadValueInjectionRetHardeningPass
FunctionPass * createX86LoadValueInjectionRetHardeningPass()
llvm::createX86SpeculativeExecutionSideEffectSuppression
FunctionPass * createX86SpeculativeExecutionSideEffectSuppression()
Definition: X86SpeculativeExecutionSideEffectSuppression.cpp:176
llvm::initializeX86LoadValueInjectionRetHardeningPassPass
void initializeX86LoadValueInjectionRetHardeningPassPass(PassRegistry &)
llvm::createX86DiscriminateMemOpsPass
FunctionPass * createX86DiscriminateMemOpsPass()
This pass ensures instructions featuring a memory operand have distinctive <LineNumber,...
Definition: X86DiscriminateMemOps.cpp:182
llvm::createX86WinEHStatePass
FunctionPass * createX86WinEHStatePass()
Return an IR pass that inserts EH registration stack objects and explicit EH state updates.
Definition: X86WinEHState.cpp:114
llvm::initializeFPSPass
void initializeFPSPass(PassRegistry &)
llvm::createX86DomainReassignmentPass
FunctionPass * createX86DomainReassignmentPass()
Return a Machine IR pass that reassigns instruction chains from one domain to another,...
llvm::X86AS::PTR32_SPTR
@ PTR32_SPTR
Definition: X86.h:190
llvm::X86AS::FS
@ FS
Definition: X86.h:188
llvm::createX86InsertPrefetchPass
FunctionPass * createX86InsertPrefetchPass()
This pass applies profiling information to insert cache prefetches.
Definition: X86InsertPrefetch.cpp:251
llvm::createX86AvoidStoreForwardingBlocks
FunctionPass * createX86AvoidStoreForwardingBlocks()
Return a pass that avoids creating store forward block issues in the hardware.
Definition: X86AvoidStoreForwardingBlocks.cpp:129
llvm::createX86ISelDag
FunctionPass * createX86ISelDag(X86TargetMachine &TM, CodeGenOpt::Level OptLevel)
This pass converts a legalized DAG into a X86-specific DAG, ready for instruction scheduling.
Definition: X86ISelDAGToDAG.cpp:6003
llvm::initializeX86LowerAMXTypeLegacyPassPass
void initializeX86LowerAMXTypeLegacyPassPass(PassRegistry &)
llvm::initializeX86AvoidTrailingCallPassPass
void initializeX86AvoidTrailingCallPassPass(PassRegistry &)
llvm::createX86ExpandPseudoPass
FunctionPass * createX86ExpandPseudoPass()
Return a Machine IR pass that expands X86-specific pseudo instructions into a sequence of actual inst...
Definition: X86ExpandPseudo.cpp:762
llvm::createX86FixupBWInsts
FunctionPass * createX86FixupBWInsts()
Return a Machine IR pass that selectively replaces certain byte and word instructions by equivalent 3...
Definition: X86FixupBWInsts.cpp:159
llvm::initializeX86LowerTileCopyPass
void initializeX86LowerTileCopyPass(PassRegistry &)
llvm::CodeGenOpt::Level
Level
Definition: CodeGen.h:52
llvm::createX86LoadValueInjectionLoadHardeningPass
FunctionPass * createX86LoadValueInjectionLoadHardeningPass()
Definition: X86LoadValueInjectionLoadHardening.cpp:814
llvm::createX86EvexToVexInsts
FunctionPass * createX86EvexToVexInsts()
This pass replaces EVEX encoded of AVX-512 instructiosn by VEX encoding when possible in order to red...
Definition: X86EvexToVex.cpp:278
llvm::initializeFixupBWInstPassPass
void initializeFixupBWInstPassPass(PassRegistry &)
llvm::initializeFixupLEAPassPass
void initializeFixupLEAPassPass(PassRegistry &)
llvm::initializeX86LowerAMXIntrinsicsLegacyPassPass
void initializeX86LowerAMXIntrinsicsLegacyPassPass(PassRegistry &)
llvm::initializeX86PreTileConfigPass
void initializeX86PreTileConfigPass(PassRegistry &)
llvm::createX86InsertX87waitPass
FunctionPass * createX86InsertX87waitPass()
This pass insert wait instruction after X87 instructions which could raise fp exceptions when strict-...
Definition: X86InsertWait.cpp:56
llvm::initializeX86SpeculativeExecutionSideEffectSuppressionPass
void initializeX86SpeculativeExecutionSideEffectSuppressionPass(PassRegistry &)
llvm::initializeX86TileConfigPass
void initializeX86TileConfigPass(PassRegistry &)
llvm::initializeX86LoadValueInjectionLoadHardeningPassPass
void initializeX86LoadValueInjectionLoadHardeningPassPass(PassRegistry &)
llvm::initializeX86CallFrameOptimizationPass
void initializeX86CallFrameOptimizationPass(PassRegistry &)
CodeGen.h
llvm::initializeX86PartialReductionPass
void initializeX86PartialReductionPass(PassRegistry &)
llvm::initializeX86FixupSetCCPassPass
void initializeX86FixupSetCCPassPass(PassRegistry &)
llvm::createX86CmovConverterPass
FunctionPass * createX86CmovConverterPass()
This pass converts X86 cmov instructions into branch when profitable.
Definition: X86CmovConversion.cpp:866
llvm::createX86IndirectBranchTrackingPass
FunctionPass * createX86IndirectBranchTrackingPass()
This pass inserts ENDBR instructions before indirect jump/call destinations as part of CET IBT mechan...
Definition: X86IndirectBranchTracking.cpp:68
llvm::initializeX86AvoidSFBPassPass
void initializeX86AvoidSFBPassPass(PassRegistry &)
llvm::initializeX86OptimizeLEAPassPass
void initializeX86OptimizeLEAPassPass(PassRegistry &)
llvm::initializeX86ExecutionDomainFixPass
void initializeX86ExecutionDomainFixPass(PassRegistry &)
TM
const char LLVMTargetMachineRef TM
Definition: PassBuilderBindings.cpp:47
llvm::createX86GlobalBaseRegPass
FunctionPass * createX86GlobalBaseRegPass()
This pass initializes a global base register for PIC on x86-32.
Definition: X86InstrInfo.cpp:8800
llvm::createX86OptimizeLEAs
FunctionPass * createX86OptimizeLEAs()
Return a pass that removes redundant LEA instructions and redundant address recalculations.
Definition: X86OptimizeLEAs.cpp:315
llvm::X86AS::SS
@ SS
Definition: X86.h:189
llvm::initializeX86DomainReassignmentPass
void initializeX86DomainReassignmentPass(PassRegistry &)
llvm::initializeX86FlagsCopyLoweringPassPass
void initializeX86FlagsCopyLoweringPassPass(PassRegistry &)
llvm::createX86IssueVZeroUpperPass
FunctionPass * createX86IssueVZeroUpperPass()
This pass inserts AVX vzeroupper instructions before each call to avoid transition penalty between fu...
Definition: X86VZeroUpper.cpp:116
llvm::initializeX86PreAMXConfigPassPass
void initializeX86PreAMXConfigPassPass(PassRegistry &)
llvm::initializeX86CmovConverterPassPass
void initializeX86CmovConverterPassPass(PassRegistry &)