9#ifndef FORTRAN_OPTIMIZER_CODEGEN_FIROPPATTERNS_H
10#define FORTRAN_OPTIMIZER_CODEGEN_FIROPPATTERNS_H
12#include "flang/Optimizer/CodeGen/TypeConverter.h"
13#include "mlir/Conversion/LLVMCommon/Pattern.h"
14#include "mlir/Dialect/LLVMIR/LLVMMemoryOps.h"
15#include "mlir/IR/SymbolTable.h"
26static constexpr unsigned defaultAddressSpace = 0u;
74template <
typename OpTy,
typename NameT>
76 mlir::SymbolTableCollection *symbolTables) {
78 return mlir::dyn_cast_or_null<OpTy>(
79 mlir::SymbolTable::lookupSymbolIn(symbolTableOp, name));
81 if constexpr (std::is_same_v<NameT, mlir::SymbolRefAttr>)
82 op = symbolTables->lookupSymbolIn<OpTy>(symbolTableOp, name);
84 op = symbolTables->getSymbolTable(symbolTableOp).lookup<OpTy>(name);
85#ifdef EXPENSIVE_CHECKS
89 op == mlir::dyn_cast_or_null<OpTy>(
90 mlir::SymbolTable::lookupSymbolIn(symbolTableOp, name))) &&
91 "symbol tables and module out of sync");
99 mlir::Operation *symbolTableOp, mlir::Operation *symbol);
105 mlir::Operation *symbolTableOp, mlir::Operation *oldSymbol,
106 mlir::Operation *newSymbol);
110 mlir::Operation *symbolTableOp, mlir::Operation *symbol);
118 mlir::Operation *root);
120class ConvertFIRToLLVMPattern :
public mlir::ConvertToLLVMPattern {
122 ConvertFIRToLLVMPattern(llvm::StringRef rootOpName,
123 mlir::MLIRContext *context,
127 mlir::PatternBenefit benefit = 1);
130 mlir::Type convertType(mlir::Type ty)
const {
131 return lowerTy().convertType(ty);
136 mlir::Type convertObjectType(mlir::Type firType)
const;
138 mlir::LLVM::ConstantOp
139 genI32Constant(mlir::Location loc, mlir::ConversionPatternRewriter &rewriter,
142 mlir::LLVM::ConstantOp
143 genConstantOffset(mlir::Location loc,
144 mlir::ConversionPatternRewriter &rewriter,
152 mlir::ConversionPatternRewriter &rewriter,
153 mlir::Type ty, mlir::Value val,
154 bool fold =
false)
const;
161 TypePair getBoxTypePair(mlir::Type firBoxTy)
const;
165 mlir::Value box, mlir::Type resultTy,
166 mlir::ConversionPatternRewriter &rewriter,
173 TypePair boxTy, mlir::Value box, mlir::Value dim,
174 mlir::ConversionPatternRewriter &rewriter)
const;
178 TypePair boxTy, mlir::Value box,
int dim,
179 mlir::ConversionPatternRewriter &rewriter)
const;
182 loadDimFieldFromBox(mlir::Location loc,
TypePair boxTy, mlir::Value box,
183 mlir::Value dim,
int off, mlir::Type ty,
184 mlir::ConversionPatternRewriter &rewriter)
const;
187 getDimFieldFromBox(mlir::Location loc,
TypePair boxTy, mlir::Value box,
188 int dim,
int off, mlir::Type ty,
189 mlir::ConversionPatternRewriter &rewriter)
const;
191 mlir::Value getStrideFromBox(mlir::Location loc,
TypePair boxTy,
192 mlir::Value box,
unsigned dim,
193 mlir::ConversionPatternRewriter &rewriter)
const;
198 mlir::ConversionPatternRewriter &rewriter)
const;
201 getElementSizeFromBox(mlir::Location loc, mlir::Type resultTy,
TypePair boxTy,
203 mlir::ConversionPatternRewriter &rewriter)
const;
207 mlir::ConversionPatternRewriter &rewriter)
const;
211 mlir::ConversionPatternRewriter &rewriter)
const;
215 mlir::Type getBoxEleTy(mlir::Type type,
219 mlir::Type getLlvmObjectTypeFromBoxType(mlir::Type boxType)
const;
224 mlir::ConversionPatternRewriter &rewriter)
const;
228 mlir::Value genBoxAttributeCheck(mlir::Location loc,
TypePair boxTy,
230 mlir::ConversionPatternRewriter &rewriter,
231 unsigned maskValue)
const;
237 mlir::ConversionPatternRewriter &rewriter)
const;
239 template <
typename... ARGS>
240 mlir::LLVM::GEPOp genGEP(mlir::Location loc, mlir::Type ty,
241 mlir::ConversionPatternRewriter &rewriter,
242 mlir::Value base, ARGS... args)
const {
245 mlir::LLVM::LLVMPointerType::get(ty.getContext(), 0);
246 return mlir::LLVM::GEPOp::create(rewriter, loc, llvmPtrTy, ty, base, cv);
256 mlir::Block *getBlockForAllocaInsert(mlir::Operation *op,
257 mlir::Region *parentRegion)
const;
266 genAllocaAndAddrCastWithType(mlir::Type llvmObjectTy,
unsigned alignment,
267 mlir::ConversionPatternRewriter &rewriter)
const;
271 this->getTypeConverter());
274 const mlir::DataLayout &getDataLayout()
const {
275 return lowerTy().getDataLayout();
278 void attachTBAATag(mlir::LLVM::AliasAnalysisOpInterface op,
279 mlir::Type baseFIRType, mlir::Type accessFIRType,
280 mlir::LLVM::GEPOp gep)
const {
281 lowerTy().attachTBAATag(op, baseFIRType, accessFIRType, gep);
285 getAllocaAddressSpace(mlir::ConversionPatternRewriter &rewriter)
const;
288 getProgramAddressSpace(mlir::ConversionPatternRewriter &rewriter)
const;
291 getGlobalAddressSpace(mlir::ConversionPatternRewriter &rewriter)
const;
293 const fir::FIRToLLVMPassOptions &options;
300 using ConvertToLLVMPattern::matchAndRewrite;
303template <
typename SourceOp>
304class FIROpConversion :
public ConvertFIRToLLVMPattern {
306 using OpAdaptor =
typename SourceOp::Adaptor;
307 using OneToNOpAdaptor =
typename SourceOp::template GenericAdaptor<
308 mlir::ArrayRef<mlir::ValueRange>>;
313 mlir::PatternBenefit benefit = 1)
314 : ConvertFIRToLLVMPattern(SourceOp::getOperationName(),
315 &typeConverter.getContext(), typeConverter,
321 mlir::ConversionPatternRewriter &rewriter)
const final {
323 OpAdaptor(operands, mlir::cast<SourceOp>(op)),
328 mlir::ArrayRef<mlir::ValueRange> operands,
329 mlir::ConversionPatternRewriter &rewriter)
const final {
330 auto sourceOp = mlir::cast<SourceOp>(op);
336 virtual llvm::LogicalResult
338 mlir::ConversionPatternRewriter &rewriter)
const {
339 llvm_unreachable(
"matchAndRewrite is not implemented");
341 virtual llvm::LogicalResult
343 mlir::ConversionPatternRewriter &rewriter)
const {
344 return dispatchTo1To1(*
this, op, adaptor, rewriter);
348 using ConvertFIRToLLVMPattern::matchAndRewrite;
352template <
typename FromOp>
355 using FIROpConversion<FromOp>::FIROpConversion;
356 using OpAdaptor =
typename FromOp::Adaptor;
359 matchAndRewrite(FromOp op, OpAdaptor adaptor,
360 mlir::ConversionPatternRewriter &rewriter)
const final {
361 mlir::Type ty = this->convertType(op.getType());
362 return doRewrite(op, ty, adaptor, rewriter);
365 virtual llvm::LogicalResult
366 doRewrite(FromOp addr, mlir::Type ty, OpAdaptor adaptor,
367 mlir::ConversionPatternRewriter &rewriter)
const = 0;
llvm::SmallVector< mlir::Value, 3 > getDimsFromBox(mlir::Location loc, llvm::ArrayRef< mlir::Type > retTys, TypePair boxTy, mlir::Value box, mlir::Value dim, mlir::ConversionPatternRewriter &rewriter) const
Definition FIROpPatterns.cpp:160
mlir::Value computeBoxSize(mlir::Location, TypePair boxTy, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const
Definition FIROpPatterns.cpp:304
mlir::SymbolTableCollection * symbolTables
Definition FIROpPatterns.h:298
mlir::Value getRankFromBox(mlir::Location loc, TypePair boxTy, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const
Read base address from a fir.box. Returned address has type ty.
Definition FIROpPatterns.cpp:236
mlir::Value getBaseAddrFromBox(mlir::Location loc, TypePair boxTy, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const
Read base address from a fir.box. Returned address has type ty.
Definition FIROpPatterns.cpp:222
mlir::Value integerCast(mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, mlir::Type ty, mlir::Value val, bool fold=false) const
Definition FIROpPatterns.cpp:109
mlir::Value getExtraFromBox(mlir::Location loc, TypePair boxTy, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const
Read the extra field from a fir.box.
Definition FIROpPatterns.cpp:244
mlir::Value loadTypeDescAddress(mlir::Location loc, TypePair boxTy, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const
Read the address of the type descriptor from a box.
Definition FIROpPatterns.cpp:280
mlir::Value getValueFromBox(mlir::Location loc, TypePair boxTy, mlir::Value box, mlir::Type resultTy, mlir::ConversionPatternRewriter &rewriter, int boxValue) const
Construct code sequence to extract the specific value from a fir.box.
Definition FIROpPatterns.cpp:141
FIR conversion pattern template.
Definition FIROpPatterns.h:353
virtual llvm::LogicalResult matchAndRewrite(SourceOp op, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const
Definition FIROpPatterns.h:337
llvm::LogicalResult matchAndRewrite(mlir::Operation *op, mlir::ArrayRef< mlir::Value > operands, mlir::ConversionPatternRewriter &rewriter) const final
Wrappers around the RewritePattern methods that pass the derived op type.
Definition FIROpPatterns.h:320
Definition TypeConverter.h:49
Definition AbstractConverter.h:37
void buildSymbolTables(mlir::SymbolTableCollection &symbolTables, mlir::Operation *root)
Definition FIROpPatterns.cpp:72
void replaceSymbol(mlir::SymbolTableCollection *symbolTables, mlir::Operation *symbolTableOp, mlir::Operation *oldSymbol, mlir::Operation *newSymbol)
Definition FIROpPatterns.cpp:57
OpTy lookupSymbolIn(mlir::Operation *symbolTableOp, NameT name, mlir::SymbolTableCollection *symbolTables)
Definition FIROpPatterns.h:75
void registerSymbol(mlir::SymbolTableCollection *symbolTables, mlir::Operation *symbolTableOp, mlir::Operation *symbol)
Definition FIROpPatterns.cpp:42
void unregisterSymbol(mlir::SymbolTableCollection *symbolTables, mlir::Operation *symbolTableOp, mlir::Operation *symbol)
Forget symbol, which is about to be erased. No-op without a collection.
Definition FIROpPatterns.cpp:66
Definition FIROpPatterns.h:156
FIR to LLVM translation pass options.
Definition CodeGen.h:40