xref: /freebsd/contrib/llvm-project/llvm/lib/Target/PowerPC/PPC.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 //===-- PPC.h - Top-level interface for PowerPC Target ----------*- 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 LLVM
10 // PowerPC back-end.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_LIB_TARGET_POWERPC_PPC_H
15 #define LLVM_LIB_TARGET_POWERPC_PPC_H
16 
17 #include "llvm/Support/CodeGen.h"
18 
19 // GCC #defines PPC on Linux but we use it as our namespace name
20 #undef PPC
21 
22 namespace llvm {
23 class PPCRegisterBankInfo;
24 class PPCSubtarget;
25 class PPCTargetMachine;
26 class PassRegistry;
27 class FunctionPass;
28 class InstructionSelector;
29 class MachineInstr;
30 class MachineOperand;
31 class AsmPrinter;
32 class MCInst;
33 class MCOperand;
34 class ModulePass;
35 
36 #ifndef NDEBUG
37   FunctionPass *createPPCCTRLoopsVerify();
38 #endif
39   FunctionPass *createPPCLoopInstrFormPrepPass(PPCTargetMachine &TM);
40   FunctionPass *createPPCTOCRegDepsPass();
41   FunctionPass *createPPCEarlyReturnPass();
42   FunctionPass *createPPCVSXCopyPass();
43   FunctionPass *createPPCVSXFMAMutatePass();
44   FunctionPass *createPPCVSXSwapRemovalPass();
45   FunctionPass *createPPCReduceCRLogicalsPass();
46   FunctionPass *createPPCMIPeepholePass();
47   FunctionPass *createPPCBranchSelectionPass();
48   FunctionPass *createPPCBranchCoalescingPass();
49   FunctionPass *createPPCISelDag(PPCTargetMachine &TM, CodeGenOpt::Level OL);
50   FunctionPass *createPPCTLSDynamicCallPass();
51   FunctionPass *createPPCBoolRetToIntPass();
52   FunctionPass *createPPCExpandISELPass();
53   FunctionPass *createPPCPreEmitPeepholePass();
54   FunctionPass *createPPCExpandAtomicPseudoPass();
55   FunctionPass *createPPCCTRLoopsPass();
56   void LowerPPCMachineInstrToMCInst(const MachineInstr *MI, MCInst &OutMI,
57                                     AsmPrinter &AP);
58   bool LowerPPCMachineOperandToMCOperand(const MachineOperand &MO,
59                                          MCOperand &OutMO, AsmPrinter &AP);
60 
61 #ifndef NDEBUG
62   void initializePPCCTRLoopsVerifyPass(PassRegistry&);
63 #endif
64   void initializePPCLoopInstrFormPrepPass(PassRegistry&);
65   void initializePPCTOCRegDepsPass(PassRegistry&);
66   void initializePPCEarlyReturnPass(PassRegistry&);
67   void initializePPCVSXCopyPass(PassRegistry&);
68   void initializePPCVSXFMAMutatePass(PassRegistry&);
69   void initializePPCVSXSwapRemovalPass(PassRegistry&);
70   void initializePPCReduceCRLogicalsPass(PassRegistry&);
71   void initializePPCBSelPass(PassRegistry&);
72   void initializePPCBranchCoalescingPass(PassRegistry&);
73   void initializePPCBoolRetToIntPass(PassRegistry&);
74   void initializePPCExpandISELPass(PassRegistry &);
75   void initializePPCPreEmitPeepholePass(PassRegistry &);
76   void initializePPCTLSDynamicCallPass(PassRegistry &);
77   void initializePPCMIPeepholePass(PassRegistry&);
78   void initializePPCExpandAtomicPseudoPass(PassRegistry &);
79   void initializePPCCTRLoopsPass(PassRegistry &);
80   void initializePPCDAGToDAGISelPass(PassRegistry &);
81 
82   extern char &PPCVSXFMAMutateID;
83 
84   ModulePass *createPPCLowerMASSVEntriesPass();
85   void initializePPCLowerMASSVEntriesPass(PassRegistry &);
86   extern char &PPCLowerMASSVEntriesID;
87 
88   ModulePass *createPPCGenScalarMASSEntriesPass();
89   void initializePPCGenScalarMASSEntriesPass(PassRegistry &);
90   extern char &PPCGenScalarMASSEntriesID;
91 
92   InstructionSelector *
93   createPPCInstructionSelector(const PPCTargetMachine &, const PPCSubtarget &,
94                                const PPCRegisterBankInfo &);
95   namespace PPCII {
96 
97   /// Target Operand Flag enum.
98   enum TOF {
99     //===------------------------------------------------------------------===//
100     // PPC Specific MachineOperand flags.
101     MO_NO_FLAG,
102 
103     /// On a symbol operand "FOO", this indicates that the reference is actually
104     /// to "FOO@plt".  This is used for calls and jumps to external functions
105     /// and for PIC calls on 32-bit ELF systems.
106     MO_PLT = 1,
107 
108     /// MO_PIC_FLAG - If this bit is set, the symbol reference is relative to
109     /// the function's picbase, e.g. lo16(symbol-picbase).
110     MO_PIC_FLAG = 2,
111 
112     /// MO_PCREL_FLAG - If this bit is set, the symbol reference is relative to
113     /// the current instruction address(pc), e.g., var@pcrel. Fixup is VK_PCREL.
114     MO_PCREL_FLAG = 4,
115 
116     /// MO_GOT_FLAG - If this bit is set the symbol reference is to be computed
117     /// via the GOT. For example when combined with the MO_PCREL_FLAG it should
118     /// produce the relocation @got@pcrel. Fixup is VK_PPC_GOT_PCREL.
119     MO_GOT_FLAG = 8,
120 
121     // MO_PCREL_OPT_FLAG - If this bit is set the operand is part of a
122     // PC Relative linker optimization.
123     MO_PCREL_OPT_FLAG = 16,
124 
125     /// MO_TLSGD_FLAG - If this bit is set the symbol reference is relative to
126     /// TLS General Dynamic model for Linux and the variable offset of TLS
127     /// General Dynamic model for AIX.
128     MO_TLSGD_FLAG = 32,
129 
130     /// MO_TPREL_FLAG - If this bit is set, the symbol reference is relative to
131     /// the thread pointer and the symbol can be used for the TLS Initial Exec
132     /// and Local Exec models.
133     MO_TPREL_FLAG = 64,
134 
135     /// MO_TLSLD_FLAG - If this bit is set the symbol reference is relative to
136     /// TLS Local Dynamic model.
137     MO_TLSLD_FLAG = 128,
138 
139     /// MO_TLSGDM_FLAG - If this bit is set the symbol reference is relative
140     /// to the region handle of TLS General Dynamic model for AIX.
141     MO_TLSGDM_FLAG = 256,
142 
143     /// MO_GOT_TLSGD_PCREL_FLAG - A combintaion of flags, if these bits are set
144     /// they should produce the relocation @got@tlsgd@pcrel.
145     /// Fix up is VK_PPC_GOT_TLSGD_PCREL
146     MO_GOT_TLSGD_PCREL_FLAG = MO_PCREL_FLAG | MO_GOT_FLAG | MO_TLSGD_FLAG,
147 
148     /// MO_GOT_TLSLD_PCREL_FLAG - A combintaion of flags, if these bits are set
149     /// they should produce the relocation @got@tlsld@pcrel.
150     /// Fix up is VK_PPC_GOT_TLSLD_PCREL
151     MO_GOT_TLSLD_PCREL_FLAG = MO_PCREL_FLAG | MO_GOT_FLAG | MO_TLSLD_FLAG,
152 
153     /// MO_GOT_TPREL_PCREL_FLAG - A combintaion of flags, if these bits are set
154     /// they should produce the relocation @got@tprel@pcrel.
155     /// Fix up is VK_PPC_GOT_TPREL_PCREL
156     MO_GOT_TPREL_PCREL_FLAG = MO_GOT_FLAG | MO_TPREL_FLAG | MO_PCREL_FLAG,
157 
158     /// The next are not flags but distinct values.
159     MO_ACCESS_MASK = 0xf00,
160 
161     /// MO_LO, MO_HA - lo16(symbol) and ha16(symbol)
162     MO_LO = 1 << 8,
163     MO_HA = 2 << 8,
164 
165     MO_TPREL_LO = 4 << 8,
166     MO_TPREL_HA = 3 << 8,
167 
168     /// These values identify relocations on immediates folded
169     /// into memory operations.
170     MO_DTPREL_LO = 5 << 8,
171     MO_TLSLD_LO = 6 << 8,
172     MO_TOC_LO = 7 << 8,
173 
174     // Symbol for VK_PPC_TLS fixup attached to an ADD instruction
175     MO_TLS = 8 << 8
176   };
177   } // end namespace PPCII
178 
179 } // end namespace llvm;
180 
181 #endif
182