1//==- SystemZ.h - Top-Level Interface for SystemZ 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
10// the LLVM SystemZ backend.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_LIB_TARGET_SYSTEMZ_SYSTEMZ_H
15#define LLVM_LIB_TARGET_SYSTEMZ_SYSTEMZ_H
16
17#include "MCTargetDesc/SystemZMCTargetDesc.h"
18#include "llvm/Support/CodeGen.h"
19
20namespace llvm {
21class FunctionPass;
22class PassRegistry;
23class SystemZTargetMachine;
24
25namespace SystemZ {
26// Condition-code mask values.
27const unsigned CCMASK_NONE = 0;
28const unsigned CCMASK_0 = 1 << 3;
29const unsigned CCMASK_1 = 1 << 2;
30const unsigned CCMASK_2 = 1 << 1;
31const unsigned CCMASK_3 = 1 << 0;
32const unsigned CCMASK_ANY = CCMASK_0 | CCMASK_1 | CCMASK_2 | CCMASK_3;
33
34// Condition-code mask assignments for integer and floating-point
35// comparisons.
36const unsigned CCMASK_CMP_EQ = CCMASK_0;
37const unsigned CCMASK_CMP_LT = CCMASK_1;
38const unsigned CCMASK_CMP_GT = CCMASK_2;
39const unsigned CCMASK_CMP_NE = CCMASK_CMP_LT | CCMASK_CMP_GT;
40const unsigned CCMASK_CMP_LE = CCMASK_CMP_EQ | CCMASK_CMP_LT;
41const unsigned CCMASK_CMP_GE = CCMASK_CMP_EQ | CCMASK_CMP_GT;
42
43// Condition-code mask assignments for floating-point comparisons only.
44const unsigned CCMASK_CMP_UO = CCMASK_3;
45const unsigned CCMASK_CMP_O = CCMASK_ANY ^ CCMASK_CMP_UO;
46
47// All condition-code values produced by comparisons.
48const unsigned CCMASK_ICMP = CCMASK_0 | CCMASK_1 | CCMASK_2;
49const unsigned CCMASK_FCMP = CCMASK_0 | CCMASK_1 | CCMASK_2 | CCMASK_3;
50
51// Condition-code mask assignments for arithmetical operations.
52const unsigned CCMASK_ARITH_EQ = CCMASK_0;
53const unsigned CCMASK_ARITH_LT = CCMASK_1;
54const unsigned CCMASK_ARITH_GT = CCMASK_2;
55const unsigned CCMASK_ARITH_OVERFLOW = CCMASK_3;
56const unsigned CCMASK_ARITH = CCMASK_ANY;
57
58// Condition-code mask assignments for logical operations.
59const unsigned CCMASK_LOGICAL_ZERO = CCMASK_0 | CCMASK_2;
60const unsigned CCMASK_LOGICAL_NONZERO = CCMASK_1 | CCMASK_3;
61const unsigned CCMASK_LOGICAL_CARRY = CCMASK_2 | CCMASK_3;
62const unsigned CCMASK_LOGICAL_NOCARRY = CCMASK_0 | CCMASK_1;
63const unsigned CCMASK_LOGICAL_BORROW = CCMASK_LOGICAL_NOCARRY;
64const unsigned CCMASK_LOGICAL_NOBORROW = CCMASK_LOGICAL_CARRY;
65const unsigned CCMASK_LOGICAL = CCMASK_ANY;
66
67// Condition-code mask assignments for CS.
68const unsigned CCMASK_CS_EQ = CCMASK_0;
69const unsigned CCMASK_CS_NE = CCMASK_1;
70const unsigned CCMASK_CS = CCMASK_0 | CCMASK_1;
71
72// Condition-code mask assignments for a completed SRST loop.
73const unsigned CCMASK_SRST_FOUND = CCMASK_1;
74const unsigned CCMASK_SRST_NOTFOUND = CCMASK_2;
75const unsigned CCMASK_SRST = CCMASK_1 | CCMASK_2;
76
77// Condition-code mask assignments for TEST UNDER MASK.
78const unsigned CCMASK_TM_ALL_0 = CCMASK_0;
79const unsigned CCMASK_TM_MIXED_MSB_0 = CCMASK_1;
80const unsigned CCMASK_TM_MIXED_MSB_1 = CCMASK_2;
81const unsigned CCMASK_TM_ALL_1 = CCMASK_3;
82const unsigned CCMASK_TM_SOME_0 = CCMASK_TM_ALL_1 ^ CCMASK_ANY;
83const unsigned CCMASK_TM_SOME_1 = CCMASK_TM_ALL_0 ^ CCMASK_ANY;
84const unsigned CCMASK_TM_MSB_0 = CCMASK_0 | CCMASK_1;
85const unsigned CCMASK_TM_MSB_1 = CCMASK_2 | CCMASK_3;
86const unsigned CCMASK_TM = CCMASK_ANY;
87
88// Condition-code mask assignments for TRANSACTION_BEGIN.
89const unsigned CCMASK_TBEGIN_STARTED = CCMASK_0;
90const unsigned CCMASK_TBEGIN_INDETERMINATE = CCMASK_1;
91const unsigned CCMASK_TBEGIN_TRANSIENT = CCMASK_2;
92const unsigned CCMASK_TBEGIN_PERSISTENT = CCMASK_3;
93const unsigned CCMASK_TBEGIN = CCMASK_ANY;
94
95// Condition-code mask assignments for TRANSACTION_END.
96const unsigned CCMASK_TEND_TX = CCMASK_0;
97const unsigned CCMASK_TEND_NOTX = CCMASK_2;
98const unsigned CCMASK_TEND = CCMASK_TEND_TX | CCMASK_TEND_NOTX;
99
100// Condition-code mask assignments for vector comparisons (and similar
101// operations).
102const unsigned CCMASK_VCMP_ALL = CCMASK_0;
103const unsigned CCMASK_VCMP_MIXED = CCMASK_1;
104const unsigned CCMASK_VCMP_NONE = CCMASK_3;
105const unsigned CCMASK_VCMP = CCMASK_0 | CCMASK_1 | CCMASK_3;
106
107// Condition-code mask assignments for Test Data Class.
108const unsigned CCMASK_TDC_NOMATCH = CCMASK_0;
109const unsigned CCMASK_TDC_MATCH = CCMASK_1;
110const unsigned CCMASK_TDC = CCMASK_TDC_NOMATCH | CCMASK_TDC_MATCH;
111
112// The position of the low CC bit in an IPM result.
113const unsigned IPM_CC = 28;
114
115// Mask assignments for PFD.
116const unsigned PFD_READ = 1;
117const unsigned PFD_WRITE = 2;
118
119// Mask assignments for TDC
120const unsigned TDCMASK_ZERO_PLUS = 0x800;
121const unsigned TDCMASK_ZERO_MINUS = 0x400;
122const unsigned TDCMASK_NORMAL_PLUS = 0x200;
123const unsigned TDCMASK_NORMAL_MINUS = 0x100;
124const unsigned TDCMASK_SUBNORMAL_PLUS = 0x080;
125const unsigned TDCMASK_SUBNORMAL_MINUS = 0x040;
126const unsigned TDCMASK_INFINITY_PLUS = 0x020;
127const unsigned TDCMASK_INFINITY_MINUS = 0x010;
128const unsigned TDCMASK_QNAN_PLUS = 0x008;
129const unsigned TDCMASK_QNAN_MINUS = 0x004;
130const unsigned TDCMASK_SNAN_PLUS = 0x002;
131const unsigned TDCMASK_SNAN_MINUS = 0x001;
132
133const unsigned TDCMASK_ZERO = TDCMASK_ZERO_PLUS | TDCMASK_ZERO_MINUS;
134const unsigned TDCMASK_POSITIVE = TDCMASK_NORMAL_PLUS |
135 TDCMASK_SUBNORMAL_PLUS |
136 TDCMASK_INFINITY_PLUS;
137const unsigned TDCMASK_NEGATIVE = TDCMASK_NORMAL_MINUS |
138 TDCMASK_SUBNORMAL_MINUS |
139 TDCMASK_INFINITY_MINUS;
140const unsigned TDCMASK_NAN = TDCMASK_QNAN_PLUS |
141 TDCMASK_QNAN_MINUS |
142 TDCMASK_SNAN_PLUS |
143 TDCMASK_SNAN_MINUS;
144const unsigned TDCMASK_PLUS = TDCMASK_POSITIVE |
145 TDCMASK_ZERO_PLUS |
146 TDCMASK_QNAN_PLUS |
147 TDCMASK_SNAN_PLUS;
148const unsigned TDCMASK_MINUS = TDCMASK_NEGATIVE |
149 TDCMASK_ZERO_MINUS |
150 TDCMASK_QNAN_MINUS |
151 TDCMASK_SNAN_MINUS;
152const unsigned TDCMASK_ALL = TDCMASK_PLUS | TDCMASK_MINUS;
153
154// Number of bits in a vector register.
155const unsigned VectorBits = 128;
156
157// Number of bytes in a vector register (and consequently the number of
158// bytes in a general permute vector).
159const unsigned VectorBytes = VectorBits / 8;
160
161// Return true if Val fits an LLILL operand.
162static inline bool isImmLL(uint64_t Val) {
163 return (Val & ~0x000000000000ffffULL) == 0;
164}
165
166// Return true if Val fits an LLILH operand.
167static inline bool isImmLH(uint64_t Val) {
168 return (Val & ~0x00000000ffff0000ULL) == 0;
169}
170
171// Return true if Val fits an LLIHL operand.
172static inline bool isImmHL(uint64_t Val) {
173 return (Val & ~0x00000ffff00000000ULL) == 0;
174}
175
176// Return true if Val fits an LLIHH operand.
177static inline bool isImmHH(uint64_t Val) {
178 return (Val & ~0xffff000000000000ULL) == 0;
179}
180
181// Return true if Val fits an LLILF operand.
182static inline bool isImmLF(uint64_t Val) {
183 return (Val & ~0x00000000ffffffffULL) == 0;
184}
185
186// Return true if Val fits an LLIHF operand.
187static inline bool isImmHF(uint64_t Val) {
188 return (Val & ~0xffffffff00000000ULL) == 0;
189}
190} // end namespace SystemZ
191
192FunctionPass *createSystemZISelDag(SystemZTargetMachine &TM,
193 CodeGenOptLevel OptLevel);
194FunctionPass *createSystemZElimComparePass(SystemZTargetMachine &TM);
195FunctionPass *createSystemZShortenInstPass(SystemZTargetMachine &TM);
196FunctionPass *createSystemZLongBranchPass(SystemZTargetMachine &TM);
197FunctionPass *createSystemZLDCleanupPass(SystemZTargetMachine &TM);
198FunctionPass *createSystemZCopyPhysRegsPass(SystemZTargetMachine &TM);
199FunctionPass *createSystemZPostRewritePass(SystemZTargetMachine &TM);
200FunctionPass *createSystemZTDCPass();
201
202void initializeSystemZAsmPrinterPass(PassRegistry &);
203void initializeSystemZCopyPhysRegsPass(PassRegistry &);
204void initializeSystemZDAGToDAGISelLegacyPass(PassRegistry &);
205void initializeSystemZElimComparePass(PassRegistry &);
206void initializeSystemZLDCleanupPass(PassRegistry &);
207void initializeSystemZLongBranchPass(PassRegistry &);
208void initializeSystemZPostRewritePass(PassRegistry &);
209void initializeSystemZShortenInstPass(PassRegistry &);
210void initializeSystemZTDCPassPass(PassRegistry &);
211
212namespace SYSTEMZAS {
213enum : unsigned { PTR32 = 1 };
214} // namespace SYSTEMZAS
215
216} // end namespace llvm
217
218#endif
219