1044d5b5dSValentin Clement //===-- CodeGen.cpp -- bridge to lower to LLVM ----------------------------===// 2044d5b5dSValentin Clement // 3044d5b5dSValentin Clement // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4044d5b5dSValentin Clement // See https://llvm.org/LICENSE.txt for license information. 5044d5b5dSValentin Clement // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6044d5b5dSValentin Clement // 7044d5b5dSValentin Clement //===----------------------------------------------------------------------===// 8044d5b5dSValentin Clement // 9044d5b5dSValentin Clement // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/ 10044d5b5dSValentin Clement // 11044d5b5dSValentin Clement //===----------------------------------------------------------------------===// 12044d5b5dSValentin Clement 13044d5b5dSValentin Clement #include "flang/Optimizer/CodeGen/CodeGen.h" 141f551032SValentin Clement #include "CGOps.h" 15044d5b5dSValentin Clement #include "PassDetail.h" 16b6e44ecdSValentin Clement #include "flang/ISO_Fortran_binding.h" 1739f4ef81SValentin Clement #include "flang/Optimizer/Dialect/FIRAttr.h" 18044d5b5dSValentin Clement #include "flang/Optimizer/Dialect/FIROps.h" 197dd7ccd2SJean Perier #include "flang/Optimizer/Support/InternalNames.h" 20af6ee580SValentin Clement #include "flang/Optimizer/Support/TypeCode.h" 217dd7ccd2SJean Perier #include "flang/Semantics/runtime-type-info.h" 22044d5b5dSValentin Clement #include "mlir/Conversion/ArithmeticToLLVM/ArithmeticToLLVM.h" 23ace01605SRiver Riddle #include "mlir/Conversion/ControlFlowToLLVM/ControlFlowToLLVM.h" 245a7b9194SRiver Riddle #include "mlir/Conversion/FuncToLLVM/ConvertFuncToLLVM.h" 25044d5b5dSValentin Clement #include "mlir/Conversion/LLVMCommon/Pattern.h" 26044d5b5dSValentin Clement #include "mlir/IR/BuiltinTypes.h" 273ae8e442SValentin Clement #include "mlir/IR/Matchers.h" 28044d5b5dSValentin Clement #include "mlir/Pass/Pass.h" 29853e79d8SValentin Clement #include "mlir/Target/LLVMIR/ModuleTranslation.h" 30044d5b5dSValentin Clement #include "llvm/ADT/ArrayRef.h" 31044d5b5dSValentin Clement 32044d5b5dSValentin Clement #define DEBUG_TYPE "flang-codegen" 33044d5b5dSValentin Clement 34092601d4SAndrzej Warzynski using namespace mlir; 35092601d4SAndrzej Warzynski 36044d5b5dSValentin Clement // fir::LLVMTypeConverter for converting to LLVM IR dialect types. 37044d5b5dSValentin Clement #include "TypeConverter.h" 38044d5b5dSValentin Clement 39af6ee580SValentin Clement // TODO: This should really be recovered from the specified target. 40af6ee580SValentin Clement static constexpr unsigned defaultAlign = 8; 41af6ee580SValentin Clement 42b6e44ecdSValentin Clement /// `fir.box` attribute values as defined for CFI_attribute_t in 43b6e44ecdSValentin Clement /// flang/ISO_Fortran_binding.h. 44b6e44ecdSValentin Clement static constexpr unsigned kAttrPointer = CFI_attribute_pointer; 45b6e44ecdSValentin Clement static constexpr unsigned kAttrAllocatable = CFI_attribute_allocatable; 46b6e44ecdSValentin Clement 47135d5d4aSKiran Chandramohan static inline mlir::Type getVoidPtrType(mlir::MLIRContext *context) { 48fa517555SKiran Chandramohan return mlir::LLVM::LLVMPointerType::get(mlir::IntegerType::get(context, 8)); 49fa517555SKiran Chandramohan } 50fa517555SKiran Chandramohan 511e6d9c06SDiana Picus static mlir::LLVM::ConstantOp 521e6d9c06SDiana Picus genConstantIndex(mlir::Location loc, mlir::Type ity, 531e6d9c06SDiana Picus mlir::ConversionPatternRewriter &rewriter, 541e6d9c06SDiana Picus std::int64_t offset) { 551e6d9c06SDiana Picus auto cattr = rewriter.getI64IntegerAttr(offset); 561e6d9c06SDiana Picus return rewriter.create<mlir::LLVM::ConstantOp>(loc, ity, cattr); 571e6d9c06SDiana Picus } 581e6d9c06SDiana Picus 5939f4ef81SValentin Clement static Block *createBlock(mlir::ConversionPatternRewriter &rewriter, 6039f4ef81SValentin Clement mlir::Block *insertBefore) { 6139f4ef81SValentin Clement assert(insertBefore && "expected valid insertion block"); 6239f4ef81SValentin Clement return rewriter.createBlock(insertBefore->getParent(), 6339f4ef81SValentin Clement mlir::Region::iterator(insertBefore)); 6439f4ef81SValentin Clement } 6539f4ef81SValentin Clement 66044d5b5dSValentin Clement namespace { 67044d5b5dSValentin Clement /// FIR conversion pattern template 68044d5b5dSValentin Clement template <typename FromOp> 69044d5b5dSValentin Clement class FIROpConversion : public mlir::ConvertOpToLLVMPattern<FromOp> { 70044d5b5dSValentin Clement public: 71013160f6SJean Perier explicit FIROpConversion(fir::LLVMTypeConverter &lowering, 72013160f6SJean Perier const fir::FIRToLLVMPassOptions &options) 73013160f6SJean Perier : mlir::ConvertOpToLLVMPattern<FromOp>(lowering), options(options) {} 74044d5b5dSValentin Clement 75044d5b5dSValentin Clement protected: 76044d5b5dSValentin Clement mlir::Type convertType(mlir::Type ty) const { 77044d5b5dSValentin Clement return lowerTy().convertType(ty); 78044d5b5dSValentin Clement } 79c2acd453SAlexisPerry mlir::Type voidPtrTy() const { return getVoidPtrType(); } 80044d5b5dSValentin Clement 815d27abe6SValentin Clement mlir::Type getVoidPtrType() const { 825d27abe6SValentin Clement return mlir::LLVM::LLVMPointerType::get( 835d27abe6SValentin Clement mlir::IntegerType::get(&lowerTy().getContext(), 8)); 845d27abe6SValentin Clement } 855d27abe6SValentin Clement 86df3b9810SValentin Clement mlir::LLVM::ConstantOp 87af6ee580SValentin Clement genI32Constant(mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, 88af6ee580SValentin Clement int value) const { 89af6ee580SValentin Clement mlir::Type i32Ty = rewriter.getI32Type(); 90af6ee580SValentin Clement mlir::IntegerAttr attr = rewriter.getI32IntegerAttr(value); 91af6ee580SValentin Clement return rewriter.create<mlir::LLVM::ConstantOp>(loc, i32Ty, attr); 92af6ee580SValentin Clement } 93af6ee580SValentin Clement 94af6ee580SValentin Clement mlir::LLVM::ConstantOp 95df3b9810SValentin Clement genConstantOffset(mlir::Location loc, 96df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter, 97df3b9810SValentin Clement int offset) const { 98af6ee580SValentin Clement mlir::Type ity = lowerTy().offsetType(); 99af6ee580SValentin Clement mlir::IntegerAttr cattr = rewriter.getI32IntegerAttr(offset); 100df3b9810SValentin Clement return rewriter.create<mlir::LLVM::ConstantOp>(loc, ity, cattr); 101df3b9810SValentin Clement } 102df3b9810SValentin Clement 103dc48849fSKiran Chandramohan /// Perform an extension or truncation as needed on an integer value. Lowering 104dc48849fSKiran Chandramohan /// to the specific target may involve some sign-extending or truncation of 105dc48849fSKiran Chandramohan /// values, particularly to fit them from abstract box types to the 106dc48849fSKiran Chandramohan /// appropriate reified structures. 107dc48849fSKiran Chandramohan mlir::Value integerCast(mlir::Location loc, 108dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter, 109dc48849fSKiran Chandramohan mlir::Type ty, mlir::Value val) const { 110dc48849fSKiran Chandramohan auto valTy = val.getType(); 111dc48849fSKiran Chandramohan // If the value was not yet lowered, lower its type so that it can 112dc48849fSKiran Chandramohan // be used in getPrimitiveTypeSizeInBits. 113dc48849fSKiran Chandramohan if (!valTy.isa<mlir::IntegerType>()) 114dc48849fSKiran Chandramohan valTy = convertType(valTy); 115dc48849fSKiran Chandramohan auto toSize = mlir::LLVM::getPrimitiveTypeSizeInBits(ty); 116dc48849fSKiran Chandramohan auto fromSize = mlir::LLVM::getPrimitiveTypeSizeInBits(valTy); 117dc48849fSKiran Chandramohan if (toSize < fromSize) 118dc48849fSKiran Chandramohan return rewriter.create<mlir::LLVM::TruncOp>(loc, ty, val); 119dc48849fSKiran Chandramohan if (toSize > fromSize) 120dc48849fSKiran Chandramohan return rewriter.create<mlir::LLVM::SExtOp>(loc, ty, val); 121dc48849fSKiran Chandramohan return val; 122dc48849fSKiran Chandramohan } 123dc48849fSKiran Chandramohan 124b6e44ecdSValentin Clement /// Construct code sequence to extract the specifc value from a `fir.box`. 125b6e44ecdSValentin Clement mlir::Value getValueFromBox(mlir::Location loc, mlir::Value box, 126df3b9810SValentin Clement mlir::Type resultTy, 127b6e44ecdSValentin Clement mlir::ConversionPatternRewriter &rewriter, 128b6e44ecdSValentin Clement unsigned boxValue) const { 129df3b9810SValentin Clement mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); 130b6e44ecdSValentin Clement mlir::LLVM::ConstantOp cValuePos = 131b6e44ecdSValentin Clement genConstantOffset(loc, rewriter, boxValue); 132df3b9810SValentin Clement auto pty = mlir::LLVM::LLVMPointerType::get(resultTy); 133df3b9810SValentin Clement auto p = rewriter.create<mlir::LLVM::GEPOp>( 13430122656SAlex Zinenko loc, pty, box, mlir::ValueRange{c0, cValuePos}); 135df3b9810SValentin Clement return rewriter.create<mlir::LLVM::LoadOp>(loc, resultTy, p); 136df3b9810SValentin Clement } 137df3b9810SValentin Clement 138df3b9810SValentin Clement /// Method to construct code sequence to get the triple for dimension `dim` 139df3b9810SValentin Clement /// from a box. 140df3b9810SValentin Clement SmallVector<mlir::Value, 3> 141df3b9810SValentin Clement getDimsFromBox(mlir::Location loc, ArrayRef<mlir::Type> retTys, 142df3b9810SValentin Clement mlir::Value box, mlir::Value dim, 143df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const { 144df3b9810SValentin Clement mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); 145df3b9810SValentin Clement mlir::LLVM::ConstantOp cDims = 146df3b9810SValentin Clement genConstantOffset(loc, rewriter, kDimsPosInBox); 147df3b9810SValentin Clement mlir::LLVM::LoadOp l0 = 148df3b9810SValentin Clement loadFromOffset(loc, box, c0, cDims, dim, 0, retTys[0], rewriter); 149df3b9810SValentin Clement mlir::LLVM::LoadOp l1 = 150df3b9810SValentin Clement loadFromOffset(loc, box, c0, cDims, dim, 1, retTys[1], rewriter); 151df3b9810SValentin Clement mlir::LLVM::LoadOp l2 = 152df3b9810SValentin Clement loadFromOffset(loc, box, c0, cDims, dim, 2, retTys[2], rewriter); 153df3b9810SValentin Clement return {l0.getResult(), l1.getResult(), l2.getResult()}; 154df3b9810SValentin Clement } 155df3b9810SValentin Clement 156df3b9810SValentin Clement mlir::LLVM::LoadOp 157df3b9810SValentin Clement loadFromOffset(mlir::Location loc, mlir::Value a, mlir::LLVM::ConstantOp c0, 158df3b9810SValentin Clement mlir::LLVM::ConstantOp cDims, mlir::Value dim, int off, 159df3b9810SValentin Clement mlir::Type ty, 160df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const { 161df3b9810SValentin Clement auto pty = mlir::LLVM::LLVMPointerType::get(ty); 162df3b9810SValentin Clement mlir::LLVM::ConstantOp c = genConstantOffset(loc, rewriter, off); 163df3b9810SValentin Clement mlir::LLVM::GEPOp p = genGEP(loc, pty, rewriter, a, c0, cDims, dim, c); 164df3b9810SValentin Clement return rewriter.create<mlir::LLVM::LoadOp>(loc, ty, p); 165df3b9810SValentin Clement } 166df3b9810SValentin Clement 1675d27abe6SValentin Clement mlir::Value 1685d27abe6SValentin Clement loadStrideFromBox(mlir::Location loc, mlir::Value box, unsigned dim, 1695d27abe6SValentin Clement mlir::ConversionPatternRewriter &rewriter) const { 1705d27abe6SValentin Clement auto idxTy = lowerTy().indexType(); 1715d27abe6SValentin Clement auto c0 = genConstantOffset(loc, rewriter, 0); 1725d27abe6SValentin Clement auto cDims = genConstantOffset(loc, rewriter, kDimsPosInBox); 1735d27abe6SValentin Clement auto dimValue = genConstantIndex(loc, idxTy, rewriter, dim); 1745d27abe6SValentin Clement return loadFromOffset(loc, box, c0, cDims, dimValue, kDimStridePos, idxTy, 1755d27abe6SValentin Clement rewriter); 1765d27abe6SValentin Clement } 1775d27abe6SValentin Clement 178df3b9810SValentin Clement /// Read base address from a fir.box. Returned address has type ty. 179df3b9810SValentin Clement mlir::Value 180df3b9810SValentin Clement loadBaseAddrFromBox(mlir::Location loc, mlir::Type ty, mlir::Value box, 181df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const { 182df3b9810SValentin Clement mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); 183df3b9810SValentin Clement mlir::LLVM::ConstantOp cAddr = 184df3b9810SValentin Clement genConstantOffset(loc, rewriter, kAddrPosInBox); 185df3b9810SValentin Clement auto pty = mlir::LLVM::LLVMPointerType::get(ty); 186df3b9810SValentin Clement mlir::LLVM::GEPOp p = genGEP(loc, pty, rewriter, box, c0, cAddr); 187df3b9810SValentin Clement return rewriter.create<mlir::LLVM::LoadOp>(loc, ty, p); 188df3b9810SValentin Clement } 189df3b9810SValentin Clement 190df3b9810SValentin Clement mlir::Value 191df3b9810SValentin Clement loadElementSizeFromBox(mlir::Location loc, mlir::Type ty, mlir::Value box, 192df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const { 193df3b9810SValentin Clement mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); 194df3b9810SValentin Clement mlir::LLVM::ConstantOp cElemLen = 195df3b9810SValentin Clement genConstantOffset(loc, rewriter, kElemLenPosInBox); 196df3b9810SValentin Clement auto pty = mlir::LLVM::LLVMPointerType::get(ty); 197df3b9810SValentin Clement mlir::LLVM::GEPOp p = genGEP(loc, pty, rewriter, box, c0, cElemLen); 198df3b9810SValentin Clement return rewriter.create<mlir::LLVM::LoadOp>(loc, ty, p); 199df3b9810SValentin Clement } 200df3b9810SValentin Clement 201af6ee580SValentin Clement // Get the element type given an LLVM type that is of the form 202af6ee580SValentin Clement // [llvm.ptr](array|struct|vector)+ and the provided indexes. 203af6ee580SValentin Clement static mlir::Type getBoxEleTy(mlir::Type type, 204af6ee580SValentin Clement llvm::ArrayRef<unsigned> indexes) { 205af6ee580SValentin Clement if (auto t = type.dyn_cast<mlir::LLVM::LLVMPointerType>()) 206af6ee580SValentin Clement type = t.getElementType(); 207af6ee580SValentin Clement for (auto i : indexes) { 208af6ee580SValentin Clement if (auto t = type.dyn_cast<mlir::LLVM::LLVMStructType>()) { 209af6ee580SValentin Clement assert(!t.isOpaque() && i < t.getBody().size()); 210af6ee580SValentin Clement type = t.getBody()[i]; 211af6ee580SValentin Clement } else if (auto t = type.dyn_cast<mlir::LLVM::LLVMArrayType>()) { 212af6ee580SValentin Clement type = t.getElementType(); 213af6ee580SValentin Clement } else if (auto t = type.dyn_cast<mlir::VectorType>()) { 214af6ee580SValentin Clement type = t.getElementType(); 215af6ee580SValentin Clement } else { 216af6ee580SValentin Clement fir::emitFatalError(mlir::UnknownLoc::get(type.getContext()), 217af6ee580SValentin Clement "request for invalid box element type"); 218af6ee580SValentin Clement } 219af6ee580SValentin Clement } 220af6ee580SValentin Clement return type; 221af6ee580SValentin Clement } 222af6ee580SValentin Clement 2235d27abe6SValentin Clement // Return LLVM type of the base address given the LLVM type 2245d27abe6SValentin Clement // of the related descriptor (lowered fir.box type). 2255d27abe6SValentin Clement static mlir::Type getBaseAddrTypeFromBox(mlir::Type type) { 2265d27abe6SValentin Clement return getBoxEleTy(type, {kAddrPosInBox}); 2275d27abe6SValentin Clement } 2285d27abe6SValentin Clement 229dc48849fSKiran Chandramohan // Load the attribute from the \p box and perform a check against \p maskValue 230dc48849fSKiran Chandramohan // The final comparison is implemented as `(attribute & maskValue) != 0`. 231dc48849fSKiran Chandramohan mlir::Value genBoxAttributeCheck(mlir::Location loc, mlir::Value box, 232dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter, 233dc48849fSKiran Chandramohan unsigned maskValue) const { 234dc48849fSKiran Chandramohan mlir::Type attrTy = rewriter.getI32Type(); 235dc48849fSKiran Chandramohan mlir::Value attribute = 236dc48849fSKiran Chandramohan getValueFromBox(loc, box, attrTy, rewriter, kAttributePosInBox); 237dc48849fSKiran Chandramohan mlir::LLVM::ConstantOp attrMask = 238dc48849fSKiran Chandramohan genConstantOffset(loc, rewriter, maskValue); 239dc48849fSKiran Chandramohan auto maskRes = 240dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::AndOp>(loc, attrTy, attribute, attrMask); 241dc48849fSKiran Chandramohan mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); 242dc48849fSKiran Chandramohan return rewriter.create<mlir::LLVM::ICmpOp>( 243dc48849fSKiran Chandramohan loc, mlir::LLVM::ICmpPredicate::ne, maskRes, c0); 244dc48849fSKiran Chandramohan } 245dc48849fSKiran Chandramohan 246df3b9810SValentin Clement template <typename... ARGS> 247df3b9810SValentin Clement mlir::LLVM::GEPOp genGEP(mlir::Location loc, mlir::Type ty, 248df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter, 249df3b9810SValentin Clement mlir::Value base, ARGS... args) const { 250df3b9810SValentin Clement SmallVector<mlir::Value> cv{args...}; 251df3b9810SValentin Clement return rewriter.create<mlir::LLVM::GEPOp>(loc, ty, base, cv); 252df3b9810SValentin Clement } 253df3b9810SValentin Clement 254044d5b5dSValentin Clement fir::LLVMTypeConverter &lowerTy() const { 255044d5b5dSValentin Clement return *static_cast<fir::LLVMTypeConverter *>(this->getTypeConverter()); 256044d5b5dSValentin Clement } 257013160f6SJean Perier 258013160f6SJean Perier const fir::FIRToLLVMPassOptions &options; 259044d5b5dSValentin Clement }; 260044d5b5dSValentin Clement 2613ae8e442SValentin Clement /// FIR conversion pattern template 2623ae8e442SValentin Clement template <typename FromOp> 2633ae8e442SValentin Clement class FIROpAndTypeConversion : public FIROpConversion<FromOp> { 2643ae8e442SValentin Clement public: 2653ae8e442SValentin Clement using FIROpConversion<FromOp>::FIROpConversion; 2663ae8e442SValentin Clement using OpAdaptor = typename FromOp::Adaptor; 2673ae8e442SValentin Clement 2683ae8e442SValentin Clement mlir::LogicalResult 2693ae8e442SValentin Clement matchAndRewrite(FromOp op, OpAdaptor adaptor, 2703ae8e442SValentin Clement mlir::ConversionPatternRewriter &rewriter) const final { 2713ae8e442SValentin Clement mlir::Type ty = this->convertType(op.getType()); 2723ae8e442SValentin Clement return doRewrite(op, ty, adaptor, rewriter); 2733ae8e442SValentin Clement } 2743ae8e442SValentin Clement 2753ae8e442SValentin Clement virtual mlir::LogicalResult 2763ae8e442SValentin Clement doRewrite(FromOp addr, mlir::Type ty, OpAdaptor adaptor, 2773ae8e442SValentin Clement mlir::ConversionPatternRewriter &rewriter) const = 0; 2783ae8e442SValentin Clement }; 2793ae8e442SValentin Clement 2800c4a7a52SValentin Clement // Lower `fir.address_of` operation to `llvm.address_of` operation. 281044d5b5dSValentin Clement struct AddrOfOpConversion : public FIROpConversion<fir::AddrOfOp> { 282044d5b5dSValentin Clement using FIROpConversion::FIROpConversion; 283044d5b5dSValentin Clement 284044d5b5dSValentin Clement mlir::LogicalResult 285044d5b5dSValentin Clement matchAndRewrite(fir::AddrOfOp addr, OpAdaptor adaptor, 286044d5b5dSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 287044d5b5dSValentin Clement auto ty = convertType(addr.getType()); 288044d5b5dSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::AddressOfOp>( 289149ad3d5SShraiysh Vaishay addr, ty, addr.getSymbol().getRootReference().getValue()); 290044d5b5dSValentin Clement return success(); 291044d5b5dSValentin Clement } 292044d5b5dSValentin Clement }; 2931e6d9c06SDiana Picus } // namespace 2941e6d9c06SDiana Picus 2951e6d9c06SDiana Picus /// Lookup the function to compute the memory size of this parametric derived 2961e6d9c06SDiana Picus /// type. The size of the object may depend on the LEN type parameters of the 2971e6d9c06SDiana Picus /// derived type. 2981e6d9c06SDiana Picus static mlir::LLVM::LLVMFuncOp 2991e6d9c06SDiana Picus getDependentTypeMemSizeFn(fir::RecordType recTy, fir::AllocaOp op, 3001e6d9c06SDiana Picus mlir::ConversionPatternRewriter &rewriter) { 3011e6d9c06SDiana Picus auto module = op->getParentOfType<mlir::ModuleOp>(); 3021e6d9c06SDiana Picus std::string name = recTy.getName().str() + "P.mem.size"; 3031e6d9c06SDiana Picus return module.lookupSymbol<mlir::LLVM::LLVMFuncOp>(name); 3041e6d9c06SDiana Picus } 3051e6d9c06SDiana Picus 3061e6d9c06SDiana Picus namespace { 3071e6d9c06SDiana Picus /// convert to LLVM IR dialect `alloca` 3081e6d9c06SDiana Picus struct AllocaOpConversion : public FIROpConversion<fir::AllocaOp> { 3091e6d9c06SDiana Picus using FIROpConversion::FIROpConversion; 3101e6d9c06SDiana Picus 3111e6d9c06SDiana Picus mlir::LogicalResult 3121e6d9c06SDiana Picus matchAndRewrite(fir::AllocaOp alloc, OpAdaptor adaptor, 3131e6d9c06SDiana Picus mlir::ConversionPatternRewriter &rewriter) const override { 3141e6d9c06SDiana Picus mlir::ValueRange operands = adaptor.getOperands(); 3151e6d9c06SDiana Picus auto loc = alloc.getLoc(); 3161e6d9c06SDiana Picus mlir::Type ity = lowerTy().indexType(); 3171e6d9c06SDiana Picus unsigned i = 0; 3181e6d9c06SDiana Picus mlir::Value size = genConstantIndex(loc, ity, rewriter, 1).getResult(); 3191e6d9c06SDiana Picus mlir::Type ty = convertType(alloc.getType()); 3201e6d9c06SDiana Picus mlir::Type resultTy = ty; 3211e6d9c06SDiana Picus if (alloc.hasLenParams()) { 3221e6d9c06SDiana Picus unsigned end = alloc.numLenParams(); 3231e6d9c06SDiana Picus llvm::SmallVector<mlir::Value> lenParams; 3241e6d9c06SDiana Picus for (; i < end; ++i) 3251e6d9c06SDiana Picus lenParams.push_back(operands[i]); 3261e6d9c06SDiana Picus mlir::Type scalarType = fir::unwrapSequenceType(alloc.getInType()); 3271e6d9c06SDiana Picus if (auto chrTy = scalarType.dyn_cast<fir::CharacterType>()) { 3281e6d9c06SDiana Picus fir::CharacterType rawCharTy = fir::CharacterType::getUnknownLen( 3291e6d9c06SDiana Picus chrTy.getContext(), chrTy.getFKind()); 3301e6d9c06SDiana Picus ty = mlir::LLVM::LLVMPointerType::get(convertType(rawCharTy)); 3311e6d9c06SDiana Picus assert(end == 1); 3321e6d9c06SDiana Picus size = integerCast(loc, rewriter, ity, lenParams[0]); 3331e6d9c06SDiana Picus } else if (auto recTy = scalarType.dyn_cast<fir::RecordType>()) { 3341e6d9c06SDiana Picus mlir::LLVM::LLVMFuncOp memSizeFn = 3351e6d9c06SDiana Picus getDependentTypeMemSizeFn(recTy, alloc, rewriter); 3361e6d9c06SDiana Picus if (!memSizeFn) 3371e6d9c06SDiana Picus emitError(loc, "did not find allocation function"); 3381e6d9c06SDiana Picus mlir::NamedAttribute attr = rewriter.getNamedAttr( 3391e6d9c06SDiana Picus "callee", mlir::SymbolRefAttr::get(memSizeFn)); 3401e6d9c06SDiana Picus auto call = rewriter.create<mlir::LLVM::CallOp>( 3411e6d9c06SDiana Picus loc, ity, lenParams, llvm::ArrayRef<mlir::NamedAttribute>{attr}); 3421e6d9c06SDiana Picus size = call.getResult(0); 3431e6d9c06SDiana Picus ty = mlir::LLVM::LLVMPointerType::get( 3441e6d9c06SDiana Picus mlir::IntegerType::get(alloc.getContext(), 8)); 3451e6d9c06SDiana Picus } else { 3461e6d9c06SDiana Picus return emitError(loc, "unexpected type ") 3471e6d9c06SDiana Picus << scalarType << " with type parameters"; 3481e6d9c06SDiana Picus } 3491e6d9c06SDiana Picus } 3501e6d9c06SDiana Picus if (alloc.hasShapeOperands()) { 3511e6d9c06SDiana Picus mlir::Type allocEleTy = fir::unwrapRefType(alloc.getType()); 3521e6d9c06SDiana Picus // Scale the size by constant factors encoded in the array type. 353776d0ed6SDiana Picus // We only do this for arrays that don't have a constant interior, since 354776d0ed6SDiana Picus // those are the only ones that get decayed to a pointer to the element 355776d0ed6SDiana Picus // type. 3561e6d9c06SDiana Picus if (auto seqTy = allocEleTy.dyn_cast<fir::SequenceType>()) { 357776d0ed6SDiana Picus if (!seqTy.hasConstantInterior()) { 3581e6d9c06SDiana Picus fir::SequenceType::Extent constSize = 1; 3591e6d9c06SDiana Picus for (auto extent : seqTy.getShape()) 3601e6d9c06SDiana Picus if (extent != fir::SequenceType::getUnknownExtent()) 3611e6d9c06SDiana Picus constSize *= extent; 3621e6d9c06SDiana Picus mlir::Value constVal{ 3631e6d9c06SDiana Picus genConstantIndex(loc, ity, rewriter, constSize).getResult()}; 3641e6d9c06SDiana Picus size = rewriter.create<mlir::LLVM::MulOp>(loc, ity, size, constVal); 3651e6d9c06SDiana Picus } 366776d0ed6SDiana Picus } 3671e6d9c06SDiana Picus unsigned end = operands.size(); 3681e6d9c06SDiana Picus for (; i < end; ++i) 3691e6d9c06SDiana Picus size = rewriter.create<mlir::LLVM::MulOp>( 3701e6d9c06SDiana Picus loc, ity, size, integerCast(loc, rewriter, ity, operands[i])); 3711e6d9c06SDiana Picus } 3721e6d9c06SDiana Picus if (ty == resultTy) { 3731e6d9c06SDiana Picus // Do not emit the bitcast if ty and resultTy are the same. 3741e6d9c06SDiana Picus rewriter.replaceOpWithNewOp<mlir::LLVM::AllocaOp>(alloc, ty, size, 3751e6d9c06SDiana Picus alloc->getAttrs()); 3761e6d9c06SDiana Picus } else { 3771e6d9c06SDiana Picus auto al = rewriter.create<mlir::LLVM::AllocaOp>(loc, ty, size, 3781e6d9c06SDiana Picus alloc->getAttrs()); 3791e6d9c06SDiana Picus rewriter.replaceOpWithNewOp<mlir::LLVM::BitcastOp>(alloc, resultTy, al); 3801e6d9c06SDiana Picus } 3811e6d9c06SDiana Picus return success(); 3821e6d9c06SDiana Picus } 3831e6d9c06SDiana Picus }; 384dc48849fSKiran Chandramohan } // namespace 385044d5b5dSValentin Clement 386dc48849fSKiran Chandramohan /// Construct an `llvm.extractvalue` instruction. It will return value at 387dc48849fSKiran Chandramohan /// element \p x from \p tuple. 388dc48849fSKiran Chandramohan static mlir::LLVM::ExtractValueOp 389dc48849fSKiran Chandramohan genExtractValueWithIndex(mlir::Location loc, mlir::Value tuple, mlir::Type ty, 390dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter, 391dc48849fSKiran Chandramohan mlir::MLIRContext *ctx, int x) { 392dc48849fSKiran Chandramohan auto cx = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(x)); 393dc48849fSKiran Chandramohan auto xty = ty.cast<mlir::LLVM::LLVMStructType>().getBody()[x]; 394dc48849fSKiran Chandramohan return rewriter.create<mlir::LLVM::ExtractValueOp>(loc, xty, tuple, cx); 395dc48849fSKiran Chandramohan } 396dc48849fSKiran Chandramohan 397dc48849fSKiran Chandramohan namespace { 398df3b9810SValentin Clement /// Lower `fir.box_addr` to the sequence of operations to extract the first 399df3b9810SValentin Clement /// element of the box. 400df3b9810SValentin Clement struct BoxAddrOpConversion : public FIROpConversion<fir::BoxAddrOp> { 401df3b9810SValentin Clement using FIROpConversion::FIROpConversion; 402df3b9810SValentin Clement 403df3b9810SValentin Clement mlir::LogicalResult 404df3b9810SValentin Clement matchAndRewrite(fir::BoxAddrOp boxaddr, OpAdaptor adaptor, 405df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 406df3b9810SValentin Clement mlir::Value a = adaptor.getOperands()[0]; 407df3b9810SValentin Clement auto loc = boxaddr.getLoc(); 408df3b9810SValentin Clement mlir::Type ty = convertType(boxaddr.getType()); 409149ad3d5SShraiysh Vaishay if (auto argty = boxaddr.getVal().getType().dyn_cast<fir::BoxType>()) { 410df3b9810SValentin Clement rewriter.replaceOp(boxaddr, loadBaseAddrFromBox(loc, ty, a, rewriter)); 411df3b9810SValentin Clement } else { 412df3b9810SValentin Clement auto c0attr = rewriter.getI32IntegerAttr(0); 413df3b9810SValentin Clement auto c0 = mlir::ArrayAttr::get(boxaddr.getContext(), c0attr); 414df3b9810SValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::ExtractValueOp>(boxaddr, ty, a, 415df3b9810SValentin Clement c0); 416df3b9810SValentin Clement } 417df3b9810SValentin Clement return success(); 418df3b9810SValentin Clement } 419df3b9810SValentin Clement }; 420df3b9810SValentin Clement 421dc48849fSKiran Chandramohan /// Convert `!fir.boxchar_len` to `!llvm.extractvalue` for the 2nd part of the 422dc48849fSKiran Chandramohan /// boxchar. 423dc48849fSKiran Chandramohan struct BoxCharLenOpConversion : public FIROpConversion<fir::BoxCharLenOp> { 424dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 425dc48849fSKiran Chandramohan 426dc48849fSKiran Chandramohan mlir::LogicalResult 427dc48849fSKiran Chandramohan matchAndRewrite(fir::BoxCharLenOp boxCharLen, OpAdaptor adaptor, 428dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 429dc48849fSKiran Chandramohan mlir::Value boxChar = adaptor.getOperands()[0]; 430dc48849fSKiran Chandramohan mlir::Location loc = boxChar.getLoc(); 431dc48849fSKiran Chandramohan mlir::MLIRContext *ctx = boxChar.getContext(); 432dc48849fSKiran Chandramohan mlir::Type returnValTy = boxCharLen.getResult().getType(); 433dc48849fSKiran Chandramohan 434dc48849fSKiran Chandramohan constexpr int boxcharLenIdx = 1; 435dc48849fSKiran Chandramohan mlir::LLVM::ExtractValueOp len = genExtractValueWithIndex( 436dc48849fSKiran Chandramohan loc, boxChar, boxChar.getType(), rewriter, ctx, boxcharLenIdx); 437dc48849fSKiran Chandramohan mlir::Value lenAfterCast = integerCast(loc, rewriter, returnValTy, len); 438dc48849fSKiran Chandramohan rewriter.replaceOp(boxCharLen, lenAfterCast); 439dc48849fSKiran Chandramohan 440dc48849fSKiran Chandramohan return success(); 441dc48849fSKiran Chandramohan } 442dc48849fSKiran Chandramohan }; 443dc48849fSKiran Chandramohan 444df3b9810SValentin Clement /// Lower `fir.box_dims` to a sequence of operations to extract the requested 445df3b9810SValentin Clement /// dimension infomartion from the boxed value. 446df3b9810SValentin Clement /// Result in a triple set of GEPs and loads. 447df3b9810SValentin Clement struct BoxDimsOpConversion : public FIROpConversion<fir::BoxDimsOp> { 448df3b9810SValentin Clement using FIROpConversion::FIROpConversion; 449df3b9810SValentin Clement 450df3b9810SValentin Clement mlir::LogicalResult 451df3b9810SValentin Clement matchAndRewrite(fir::BoxDimsOp boxdims, OpAdaptor adaptor, 452df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 453df3b9810SValentin Clement SmallVector<mlir::Type, 3> resultTypes = { 454df3b9810SValentin Clement convertType(boxdims.getResult(0).getType()), 455df3b9810SValentin Clement convertType(boxdims.getResult(1).getType()), 456df3b9810SValentin Clement convertType(boxdims.getResult(2).getType()), 457df3b9810SValentin Clement }; 458df3b9810SValentin Clement auto results = 459df3b9810SValentin Clement getDimsFromBox(boxdims.getLoc(), resultTypes, adaptor.getOperands()[0], 460df3b9810SValentin Clement adaptor.getOperands()[1], rewriter); 461df3b9810SValentin Clement rewriter.replaceOp(boxdims, results); 462df3b9810SValentin Clement return success(); 463df3b9810SValentin Clement } 464df3b9810SValentin Clement }; 465df3b9810SValentin Clement 466df3b9810SValentin Clement /// Lower `fir.box_elesize` to a sequence of operations ro extract the size of 467df3b9810SValentin Clement /// an element in the boxed value. 468df3b9810SValentin Clement struct BoxEleSizeOpConversion : public FIROpConversion<fir::BoxEleSizeOp> { 469df3b9810SValentin Clement using FIROpConversion::FIROpConversion; 470df3b9810SValentin Clement 471df3b9810SValentin Clement mlir::LogicalResult 472df3b9810SValentin Clement matchAndRewrite(fir::BoxEleSizeOp boxelesz, OpAdaptor adaptor, 473df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 474df3b9810SValentin Clement mlir::Value a = adaptor.getOperands()[0]; 475df3b9810SValentin Clement auto loc = boxelesz.getLoc(); 476df3b9810SValentin Clement auto ty = convertType(boxelesz.getType()); 477b6e44ecdSValentin Clement auto elemSize = getValueFromBox(loc, a, ty, rewriter, kElemLenPosInBox); 478b6e44ecdSValentin Clement rewriter.replaceOp(boxelesz, elemSize); 479b6e44ecdSValentin Clement return success(); 480b6e44ecdSValentin Clement } 481b6e44ecdSValentin Clement }; 482b6e44ecdSValentin Clement 483b6e44ecdSValentin Clement /// Lower `fir.box_isalloc` to a sequence of operations to determine if the 484b6e44ecdSValentin Clement /// boxed value was from an ALLOCATABLE entity. 485b6e44ecdSValentin Clement struct BoxIsAllocOpConversion : public FIROpConversion<fir::BoxIsAllocOp> { 486b6e44ecdSValentin Clement using FIROpConversion::FIROpConversion; 487b6e44ecdSValentin Clement 488b6e44ecdSValentin Clement mlir::LogicalResult 489b6e44ecdSValentin Clement matchAndRewrite(fir::BoxIsAllocOp boxisalloc, OpAdaptor adaptor, 490b6e44ecdSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 491b6e44ecdSValentin Clement mlir::Value box = adaptor.getOperands()[0]; 492b6e44ecdSValentin Clement auto loc = boxisalloc.getLoc(); 493b6e44ecdSValentin Clement mlir::Value check = 494b6e44ecdSValentin Clement genBoxAttributeCheck(loc, box, rewriter, kAttrAllocatable); 495b6e44ecdSValentin Clement rewriter.replaceOp(boxisalloc, check); 496b6e44ecdSValentin Clement return success(); 497b6e44ecdSValentin Clement } 498b6e44ecdSValentin Clement }; 499b6e44ecdSValentin Clement 500b6e44ecdSValentin Clement /// Lower `fir.box_isarray` to a sequence of operations to determine if the 501b6e44ecdSValentin Clement /// boxed is an array. 502b6e44ecdSValentin Clement struct BoxIsArrayOpConversion : public FIROpConversion<fir::BoxIsArrayOp> { 503b6e44ecdSValentin Clement using FIROpConversion::FIROpConversion; 504b6e44ecdSValentin Clement 505b6e44ecdSValentin Clement mlir::LogicalResult 506b6e44ecdSValentin Clement matchAndRewrite(fir::BoxIsArrayOp boxisarray, OpAdaptor adaptor, 507b6e44ecdSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 508b6e44ecdSValentin Clement mlir::Value a = adaptor.getOperands()[0]; 509b6e44ecdSValentin Clement auto loc = boxisarray.getLoc(); 510b6e44ecdSValentin Clement auto rank = 511b6e44ecdSValentin Clement getValueFromBox(loc, a, rewriter.getI32Type(), rewriter, kRankPosInBox); 512b6e44ecdSValentin Clement auto c0 = genConstantOffset(loc, rewriter, 0); 513b6e44ecdSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::ICmpOp>( 514b6e44ecdSValentin Clement boxisarray, mlir::LLVM::ICmpPredicate::ne, rank, c0); 515b6e44ecdSValentin Clement return success(); 516b6e44ecdSValentin Clement } 517b6e44ecdSValentin Clement }; 518b6e44ecdSValentin Clement 519b6e44ecdSValentin Clement /// Lower `fir.box_isptr` to a sequence of operations to determined if the 520b6e44ecdSValentin Clement /// boxed value was from a POINTER entity. 521b6e44ecdSValentin Clement struct BoxIsPtrOpConversion : public FIROpConversion<fir::BoxIsPtrOp> { 522b6e44ecdSValentin Clement using FIROpConversion::FIROpConversion; 523b6e44ecdSValentin Clement 524b6e44ecdSValentin Clement mlir::LogicalResult 525b6e44ecdSValentin Clement matchAndRewrite(fir::BoxIsPtrOp boxisptr, OpAdaptor adaptor, 526b6e44ecdSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 527b6e44ecdSValentin Clement mlir::Value box = adaptor.getOperands()[0]; 528b6e44ecdSValentin Clement auto loc = boxisptr.getLoc(); 529b6e44ecdSValentin Clement mlir::Value check = genBoxAttributeCheck(loc, box, rewriter, kAttrPointer); 530b6e44ecdSValentin Clement rewriter.replaceOp(boxisptr, check); 531df3b9810SValentin Clement return success(); 532df3b9810SValentin Clement } 533df3b9810SValentin Clement }; 534df3b9810SValentin Clement 535df3b9810SValentin Clement /// Lower `fir.box_rank` to the sequence of operation to extract the rank from 536df3b9810SValentin Clement /// the box. 537df3b9810SValentin Clement struct BoxRankOpConversion : public FIROpConversion<fir::BoxRankOp> { 538df3b9810SValentin Clement using FIROpConversion::FIROpConversion; 539df3b9810SValentin Clement 540df3b9810SValentin Clement mlir::LogicalResult 541df3b9810SValentin Clement matchAndRewrite(fir::BoxRankOp boxrank, OpAdaptor adaptor, 542df3b9810SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 543df3b9810SValentin Clement mlir::Value a = adaptor.getOperands()[0]; 544df3b9810SValentin Clement auto loc = boxrank.getLoc(); 545df3b9810SValentin Clement mlir::Type ty = convertType(boxrank.getType()); 546b6e44ecdSValentin Clement auto result = getValueFromBox(loc, a, ty, rewriter, kRankPosInBox); 547df3b9810SValentin Clement rewriter.replaceOp(boxrank, result); 548df3b9810SValentin Clement return success(); 549df3b9810SValentin Clement } 550df3b9810SValentin Clement }; 551df3b9810SValentin Clement 552cc505c0bSKiran Chandramohan /// Lower `fir.boxproc_host` operation. Extracts the host pointer from the 553cc505c0bSKiran Chandramohan /// boxproc. 554cc505c0bSKiran Chandramohan /// TODO: Part of supporting Fortran 2003 procedure pointers. 555cc505c0bSKiran Chandramohan struct BoxProcHostOpConversion : public FIROpConversion<fir::BoxProcHostOp> { 556cc505c0bSKiran Chandramohan using FIROpConversion::FIROpConversion; 557cc505c0bSKiran Chandramohan 558cc505c0bSKiran Chandramohan mlir::LogicalResult 559cc505c0bSKiran Chandramohan matchAndRewrite(fir::BoxProcHostOp boxprochost, OpAdaptor adaptor, 560cc505c0bSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 5617ce8c6fcSKiran Chandramohan TODO(boxprochost.getLoc(), "fir.boxproc_host codegen"); 5627ce8c6fcSKiran Chandramohan return failure(); 563cc505c0bSKiran Chandramohan } 564cc505c0bSKiran Chandramohan }; 565cc505c0bSKiran Chandramohan 566e38ef2ffSValentin Clement /// Lower `fir.box_tdesc` to the sequence of operations to extract the type 567e38ef2ffSValentin Clement /// descriptor from the box. 568e38ef2ffSValentin Clement struct BoxTypeDescOpConversion : public FIROpConversion<fir::BoxTypeDescOp> { 569e38ef2ffSValentin Clement using FIROpConversion::FIROpConversion; 570e38ef2ffSValentin Clement 571e38ef2ffSValentin Clement mlir::LogicalResult 572e38ef2ffSValentin Clement matchAndRewrite(fir::BoxTypeDescOp boxtypedesc, OpAdaptor adaptor, 573e38ef2ffSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 574e38ef2ffSValentin Clement mlir::Value box = adaptor.getOperands()[0]; 575e38ef2ffSValentin Clement auto loc = boxtypedesc.getLoc(); 576e38ef2ffSValentin Clement mlir::Type typeTy = 577e38ef2ffSValentin Clement fir::getDescFieldTypeModel<kTypePosInBox>()(boxtypedesc.getContext()); 578e38ef2ffSValentin Clement auto result = getValueFromBox(loc, box, typeTy, rewriter, kTypePosInBox); 579e38ef2ffSValentin Clement auto typePtrTy = mlir::LLVM::LLVMPointerType::get(typeTy); 580e38ef2ffSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::IntToPtrOp>(boxtypedesc, typePtrTy, 581e38ef2ffSValentin Clement result); 582e38ef2ffSValentin Clement return success(); 583e38ef2ffSValentin Clement } 584e38ef2ffSValentin Clement }; 585e38ef2ffSValentin Clement 586dc48849fSKiran Chandramohan /// Lower `fir.string_lit` to LLVM IR dialect operation. 587dc48849fSKiran Chandramohan struct StringLitOpConversion : public FIROpConversion<fir::StringLitOp> { 588dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 589dc48849fSKiran Chandramohan 590dc48849fSKiran Chandramohan mlir::LogicalResult 591dc48849fSKiran Chandramohan matchAndRewrite(fir::StringLitOp constop, OpAdaptor adaptor, 592dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 593dc48849fSKiran Chandramohan auto ty = convertType(constop.getType()); 594dc48849fSKiran Chandramohan auto attr = constop.getValue(); 595dc48849fSKiran Chandramohan if (attr.isa<mlir::StringAttr>()) { 596dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::ConstantOp>(constop, ty, attr); 597dc48849fSKiran Chandramohan return success(); 598dc48849fSKiran Chandramohan } 599dc48849fSKiran Chandramohan 600dc48849fSKiran Chandramohan auto arr = attr.cast<mlir::ArrayAttr>(); 601dc48849fSKiran Chandramohan auto charTy = constop.getType().cast<fir::CharacterType>(); 602dc48849fSKiran Chandramohan unsigned bits = lowerTy().characterBitsize(charTy); 603dc48849fSKiran Chandramohan mlir::Type intTy = rewriter.getIntegerType(bits); 604dc48849fSKiran Chandramohan auto attrs = llvm::map_range( 605dc48849fSKiran Chandramohan arr.getValue(), [intTy, bits](mlir::Attribute attr) -> Attribute { 606dc48849fSKiran Chandramohan return mlir::IntegerAttr::get( 607dc48849fSKiran Chandramohan intTy, 608dc48849fSKiran Chandramohan attr.cast<mlir::IntegerAttr>().getValue().sextOrTrunc(bits)); 609dc48849fSKiran Chandramohan }); 610dc48849fSKiran Chandramohan mlir::Type vecType = mlir::VectorType::get(arr.size(), intTy); 611dc48849fSKiran Chandramohan auto denseAttr = mlir::DenseElementsAttr::get( 612dc48849fSKiran Chandramohan vecType.cast<mlir::ShapedType>(), llvm::to_vector<8>(attrs)); 613dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::arith::ConstantOp>(constop, ty, 614dc48849fSKiran Chandramohan denseAttr); 615dc48849fSKiran Chandramohan return success(); 616dc48849fSKiran Chandramohan } 617dc48849fSKiran Chandramohan }; 618dc48849fSKiran Chandramohan 619ddd11b9aSAndrzej Warzynski // `fir.call` -> `llvm.call` 620ddd11b9aSAndrzej Warzynski struct CallOpConversion : public FIROpConversion<fir::CallOp> { 621ddd11b9aSAndrzej Warzynski using FIROpConversion::FIROpConversion; 622ddd11b9aSAndrzej Warzynski 623ddd11b9aSAndrzej Warzynski mlir::LogicalResult 624ddd11b9aSAndrzej Warzynski matchAndRewrite(fir::CallOp call, OpAdaptor adaptor, 625ddd11b9aSAndrzej Warzynski mlir::ConversionPatternRewriter &rewriter) const override { 626ddd11b9aSAndrzej Warzynski SmallVector<mlir::Type> resultTys; 627ddd11b9aSAndrzej Warzynski for (auto r : call.getResults()) 628ddd11b9aSAndrzej Warzynski resultTys.push_back(convertType(r.getType())); 629ddd11b9aSAndrzej Warzynski rewriter.replaceOpWithNewOp<mlir::LLVM::CallOp>( 630ddd11b9aSAndrzej Warzynski call, resultTys, adaptor.getOperands(), call->getAttrs()); 631ddd11b9aSAndrzej Warzynski return success(); 632ddd11b9aSAndrzej Warzynski } 633ddd11b9aSAndrzej Warzynski }; 634c2acd453SAlexisPerry } // namespace 635ddd11b9aSAndrzej Warzynski 636092cee5fSValentin Clement static mlir::Type getComplexEleTy(mlir::Type complex) { 637092cee5fSValentin Clement if (auto cc = complex.dyn_cast<mlir::ComplexType>()) 638092cee5fSValentin Clement return cc.getElementType(); 639092cee5fSValentin Clement return complex.cast<fir::ComplexType>().getElementType(); 640092cee5fSValentin Clement } 641092cee5fSValentin Clement 642c2acd453SAlexisPerry namespace { 643f1dfc027SDiana Picus /// Compare complex values 644f1dfc027SDiana Picus /// 645f1dfc027SDiana Picus /// Per 10.1, the only comparisons available are .EQ. (oeq) and .NE. (une). 646f1dfc027SDiana Picus /// 647f1dfc027SDiana Picus /// For completeness, all other comparison are done on the real component only. 648f1dfc027SDiana Picus struct CmpcOpConversion : public FIROpConversion<fir::CmpcOp> { 649f1dfc027SDiana Picus using FIROpConversion::FIROpConversion; 650f1dfc027SDiana Picus 651f1dfc027SDiana Picus mlir::LogicalResult 652f1dfc027SDiana Picus matchAndRewrite(fir::CmpcOp cmp, OpAdaptor adaptor, 653f1dfc027SDiana Picus mlir::ConversionPatternRewriter &rewriter) const override { 654f1dfc027SDiana Picus mlir::ValueRange operands = adaptor.getOperands(); 655f1dfc027SDiana Picus mlir::MLIRContext *ctxt = cmp.getContext(); 656149ad3d5SShraiysh Vaishay mlir::Type eleTy = convertType(getComplexEleTy(cmp.getLhs().getType())); 657f1dfc027SDiana Picus mlir::Type resTy = convertType(cmp.getType()); 658f1dfc027SDiana Picus mlir::Location loc = cmp.getLoc(); 659f1dfc027SDiana Picus auto pos0 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(0)); 660f1dfc027SDiana Picus SmallVector<mlir::Value, 2> rp{rewriter.create<mlir::LLVM::ExtractValueOp>( 661f1dfc027SDiana Picus loc, eleTy, operands[0], pos0), 662f1dfc027SDiana Picus rewriter.create<mlir::LLVM::ExtractValueOp>( 663f1dfc027SDiana Picus loc, eleTy, operands[1], pos0)}; 664f1dfc027SDiana Picus auto rcp = 665f1dfc027SDiana Picus rewriter.create<mlir::LLVM::FCmpOp>(loc, resTy, rp, cmp->getAttrs()); 666f1dfc027SDiana Picus auto pos1 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(1)); 667f1dfc027SDiana Picus SmallVector<mlir::Value, 2> ip{rewriter.create<mlir::LLVM::ExtractValueOp>( 668f1dfc027SDiana Picus loc, eleTy, operands[0], pos1), 669f1dfc027SDiana Picus rewriter.create<mlir::LLVM::ExtractValueOp>( 670f1dfc027SDiana Picus loc, eleTy, operands[1], pos1)}; 671f1dfc027SDiana Picus auto icp = 672f1dfc027SDiana Picus rewriter.create<mlir::LLVM::FCmpOp>(loc, resTy, ip, cmp->getAttrs()); 673f1dfc027SDiana Picus SmallVector<mlir::Value, 2> cp{rcp, icp}; 674f1dfc027SDiana Picus switch (cmp.getPredicate()) { 675f1dfc027SDiana Picus case mlir::arith::CmpFPredicate::OEQ: // .EQ. 676f1dfc027SDiana Picus rewriter.replaceOpWithNewOp<mlir::LLVM::AndOp>(cmp, resTy, cp); 677f1dfc027SDiana Picus break; 678f1dfc027SDiana Picus case mlir::arith::CmpFPredicate::UNE: // .NE. 679f1dfc027SDiana Picus rewriter.replaceOpWithNewOp<mlir::LLVM::OrOp>(cmp, resTy, cp); 680f1dfc027SDiana Picus break; 681f1dfc027SDiana Picus default: 682f1dfc027SDiana Picus rewriter.replaceOp(cmp, rcp.getResult()); 683f1dfc027SDiana Picus break; 684f1dfc027SDiana Picus } 685f1dfc027SDiana Picus return success(); 686f1dfc027SDiana Picus } 687f1dfc027SDiana Picus }; 688f1dfc027SDiana Picus 689e81d73edSDiana Picus /// Lower complex constants 690e81d73edSDiana Picus struct ConstcOpConversion : public FIROpConversion<fir::ConstcOp> { 691e81d73edSDiana Picus using FIROpConversion::FIROpConversion; 692e81d73edSDiana Picus 693e81d73edSDiana Picus mlir::LogicalResult 694e81d73edSDiana Picus matchAndRewrite(fir::ConstcOp conc, OpAdaptor, 695e81d73edSDiana Picus mlir::ConversionPatternRewriter &rewriter) const override { 696e81d73edSDiana Picus mlir::Location loc = conc.getLoc(); 697e81d73edSDiana Picus mlir::MLIRContext *ctx = conc.getContext(); 698e81d73edSDiana Picus mlir::Type ty = convertType(conc.getType()); 699e81d73edSDiana Picus mlir::Type ety = convertType(getComplexEleTy(conc.getType())); 700e81d73edSDiana Picus auto realFloatAttr = mlir::FloatAttr::get(ety, getValue(conc.getReal())); 701e81d73edSDiana Picus auto realPart = 702e81d73edSDiana Picus rewriter.create<mlir::LLVM::ConstantOp>(loc, ety, realFloatAttr); 703e81d73edSDiana Picus auto imFloatAttr = mlir::FloatAttr::get(ety, getValue(conc.getImaginary())); 704e81d73edSDiana Picus auto imPart = 705e81d73edSDiana Picus rewriter.create<mlir::LLVM::ConstantOp>(loc, ety, imFloatAttr); 706e81d73edSDiana Picus auto realIndex = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 707e81d73edSDiana Picus auto imIndex = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); 708e81d73edSDiana Picus auto undef = rewriter.create<mlir::LLVM::UndefOp>(loc, ty); 709e81d73edSDiana Picus auto setReal = rewriter.create<mlir::LLVM::InsertValueOp>( 710e81d73edSDiana Picus loc, ty, undef, realPart, realIndex); 711e81d73edSDiana Picus rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>(conc, ty, setReal, 712e81d73edSDiana Picus imPart, imIndex); 713e81d73edSDiana Picus return success(); 714e81d73edSDiana Picus } 715e81d73edSDiana Picus 716e81d73edSDiana Picus inline APFloat getValue(mlir::Attribute attr) const { 717e81d73edSDiana Picus return attr.cast<fir::RealAttr>().getValue(); 718e81d73edSDiana Picus } 719e81d73edSDiana Picus }; 720e81d73edSDiana Picus 721092cee5fSValentin Clement /// convert value of from-type to value of to-type 722092cee5fSValentin Clement struct ConvertOpConversion : public FIROpConversion<fir::ConvertOp> { 723092cee5fSValentin Clement using FIROpConversion::FIROpConversion; 724092cee5fSValentin Clement 725092cee5fSValentin Clement static bool isFloatingPointTy(mlir::Type ty) { 726092cee5fSValentin Clement return ty.isa<mlir::FloatType>(); 727092cee5fSValentin Clement } 728092cee5fSValentin Clement 729092cee5fSValentin Clement mlir::LogicalResult 730092cee5fSValentin Clement matchAndRewrite(fir::ConvertOp convert, OpAdaptor adaptor, 731092cee5fSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 7323b7ec85aSJean Perier auto fromFirTy = convert.getValue().getType(); 7333b7ec85aSJean Perier auto toFirTy = convert.getRes().getType(); 7343b7ec85aSJean Perier auto fromTy = convertType(fromFirTy); 7353b7ec85aSJean Perier auto toTy = convertType(toFirTy); 736092cee5fSValentin Clement mlir::Value op0 = adaptor.getOperands()[0]; 737092cee5fSValentin Clement if (fromTy == toTy) { 738092cee5fSValentin Clement rewriter.replaceOp(convert, op0); 739092cee5fSValentin Clement return success(); 740092cee5fSValentin Clement } 741092cee5fSValentin Clement auto loc = convert.getLoc(); 742092cee5fSValentin Clement auto convertFpToFp = [&](mlir::Value val, unsigned fromBits, 743092cee5fSValentin Clement unsigned toBits, mlir::Type toTy) -> mlir::Value { 744092cee5fSValentin Clement if (fromBits == toBits) { 745092cee5fSValentin Clement // TODO: Converting between two floating-point representations with the 746092cee5fSValentin Clement // same bitwidth is not allowed for now. 747092cee5fSValentin Clement mlir::emitError(loc, 748092cee5fSValentin Clement "cannot implicitly convert between two floating-point " 749092cee5fSValentin Clement "representations of the same bitwidth"); 750092cee5fSValentin Clement return {}; 751092cee5fSValentin Clement } 752092cee5fSValentin Clement if (fromBits > toBits) 753092cee5fSValentin Clement return rewriter.create<mlir::LLVM::FPTruncOp>(loc, toTy, val); 754092cee5fSValentin Clement return rewriter.create<mlir::LLVM::FPExtOp>(loc, toTy, val); 755092cee5fSValentin Clement }; 756092cee5fSValentin Clement // Complex to complex conversion. 7573b7ec85aSJean Perier if (fir::isa_complex(fromFirTy) && fir::isa_complex(toFirTy)) { 758092cee5fSValentin Clement // Special case: handle the conversion of a complex such that both the 759092cee5fSValentin Clement // real and imaginary parts are converted together. 760092cee5fSValentin Clement auto zero = mlir::ArrayAttr::get(convert.getContext(), 761092cee5fSValentin Clement rewriter.getI32IntegerAttr(0)); 762092cee5fSValentin Clement auto one = mlir::ArrayAttr::get(convert.getContext(), 763092cee5fSValentin Clement rewriter.getI32IntegerAttr(1)); 764149ad3d5SShraiysh Vaishay auto ty = convertType(getComplexEleTy(convert.getValue().getType())); 765092cee5fSValentin Clement auto rp = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, ty, op0, zero); 766092cee5fSValentin Clement auto ip = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, ty, op0, one); 767149ad3d5SShraiysh Vaishay auto nt = convertType(getComplexEleTy(convert.getRes().getType())); 768092cee5fSValentin Clement auto fromBits = mlir::LLVM::getPrimitiveTypeSizeInBits(ty); 769092cee5fSValentin Clement auto toBits = mlir::LLVM::getPrimitiveTypeSizeInBits(nt); 770092cee5fSValentin Clement auto rc = convertFpToFp(rp, fromBits, toBits, nt); 771092cee5fSValentin Clement auto ic = convertFpToFp(ip, fromBits, toBits, nt); 772092cee5fSValentin Clement auto un = rewriter.create<mlir::LLVM::UndefOp>(loc, toTy); 773092cee5fSValentin Clement auto i1 = 774092cee5fSValentin Clement rewriter.create<mlir::LLVM::InsertValueOp>(loc, toTy, un, rc, zero); 775092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>(convert, toTy, i1, 776092cee5fSValentin Clement ic, one); 777092cee5fSValentin Clement return mlir::success(); 778092cee5fSValentin Clement } 7793b7ec85aSJean Perier 7803b7ec85aSJean Perier // Follow UNIX F77 convention for logicals: 7813b7ec85aSJean Perier // 1. underlying integer is not zero => logical is .TRUE. 7823b7ec85aSJean Perier // 2. logical is .TRUE. => set underlying integer to 1. 7833b7ec85aSJean Perier auto i1Type = mlir::IntegerType::get(convert.getContext(), 1); 7843b7ec85aSJean Perier if (fromFirTy.isa<fir::LogicalType>() && toFirTy == i1Type) { 7853b7ec85aSJean Perier mlir::Value zero = genConstantIndex(loc, fromTy, rewriter, 0); 7863b7ec85aSJean Perier rewriter.replaceOpWithNewOp<mlir::LLVM::ICmpOp>( 7873b7ec85aSJean Perier convert, mlir::LLVM::ICmpPredicate::ne, op0, zero); 7883b7ec85aSJean Perier return mlir::success(); 7893b7ec85aSJean Perier } 7903b7ec85aSJean Perier if (fromFirTy == i1Type && toFirTy.isa<fir::LogicalType>()) { 7913b7ec85aSJean Perier rewriter.replaceOpWithNewOp<mlir::LLVM::ZExtOp>(convert, toTy, op0); 7923b7ec85aSJean Perier return mlir::success(); 7933b7ec85aSJean Perier } 7943b7ec85aSJean Perier 795092cee5fSValentin Clement // Floating point to floating point conversion. 796092cee5fSValentin Clement if (isFloatingPointTy(fromTy)) { 797092cee5fSValentin Clement if (isFloatingPointTy(toTy)) { 798092cee5fSValentin Clement auto fromBits = mlir::LLVM::getPrimitiveTypeSizeInBits(fromTy); 799092cee5fSValentin Clement auto toBits = mlir::LLVM::getPrimitiveTypeSizeInBits(toTy); 800092cee5fSValentin Clement auto v = convertFpToFp(op0, fromBits, toBits, toTy); 801092cee5fSValentin Clement rewriter.replaceOp(convert, v); 802092cee5fSValentin Clement return mlir::success(); 803092cee5fSValentin Clement } 804092cee5fSValentin Clement if (toTy.isa<mlir::IntegerType>()) { 805092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::FPToSIOp>(convert, toTy, op0); 806092cee5fSValentin Clement return mlir::success(); 807092cee5fSValentin Clement } 808092cee5fSValentin Clement } else if (fromTy.isa<mlir::IntegerType>()) { 809092cee5fSValentin Clement // Integer to integer conversion. 810092cee5fSValentin Clement if (toTy.isa<mlir::IntegerType>()) { 811092cee5fSValentin Clement auto fromBits = mlir::LLVM::getPrimitiveTypeSizeInBits(fromTy); 812092cee5fSValentin Clement auto toBits = mlir::LLVM::getPrimitiveTypeSizeInBits(toTy); 813092cee5fSValentin Clement assert(fromBits != toBits); 814092cee5fSValentin Clement if (fromBits > toBits) { 815092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::TruncOp>(convert, toTy, op0); 816092cee5fSValentin Clement return mlir::success(); 817092cee5fSValentin Clement } 818092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::SExtOp>(convert, toTy, op0); 819092cee5fSValentin Clement return mlir::success(); 820092cee5fSValentin Clement } 821092cee5fSValentin Clement // Integer to floating point conversion. 822092cee5fSValentin Clement if (isFloatingPointTy(toTy)) { 823092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::SIToFPOp>(convert, toTy, op0); 824092cee5fSValentin Clement return mlir::success(); 825092cee5fSValentin Clement } 826092cee5fSValentin Clement // Integer to pointer conversion. 827092cee5fSValentin Clement if (toTy.isa<mlir::LLVM::LLVMPointerType>()) { 828092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::IntToPtrOp>(convert, toTy, op0); 829092cee5fSValentin Clement return mlir::success(); 830092cee5fSValentin Clement } 831092cee5fSValentin Clement } else if (fromTy.isa<mlir::LLVM::LLVMPointerType>()) { 832092cee5fSValentin Clement // Pointer to integer conversion. 833092cee5fSValentin Clement if (toTy.isa<mlir::IntegerType>()) { 834092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::PtrToIntOp>(convert, toTy, op0); 835092cee5fSValentin Clement return mlir::success(); 836092cee5fSValentin Clement } 837092cee5fSValentin Clement // Pointer to pointer conversion. 838092cee5fSValentin Clement if (toTy.isa<mlir::LLVM::LLVMPointerType>()) { 839092cee5fSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::BitcastOp>(convert, toTy, op0); 840092cee5fSValentin Clement return mlir::success(); 841092cee5fSValentin Clement } 842092cee5fSValentin Clement } 843092cee5fSValentin Clement return emitError(loc) << "cannot convert " << fromTy << " to " << toTy; 844092cee5fSValentin Clement } 845092cee5fSValentin Clement }; 846092cee5fSValentin Clement 8479534e361SValentin Clement /// Lower `fir.dispatch` operation. A virtual call to a method in a dispatch 8489534e361SValentin Clement /// table. 8499534e361SValentin Clement struct DispatchOpConversion : public FIROpConversion<fir::DispatchOp> { 8509534e361SValentin Clement using FIROpConversion::FIROpConversion; 8519534e361SValentin Clement 8529534e361SValentin Clement mlir::LogicalResult 8539534e361SValentin Clement matchAndRewrite(fir::DispatchOp dispatch, OpAdaptor adaptor, 8549534e361SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 8557ce8c6fcSKiran Chandramohan TODO(dispatch.getLoc(), "fir.dispatch codegen"); 8567ce8c6fcSKiran Chandramohan return failure(); 8579534e361SValentin Clement } 8589534e361SValentin Clement }; 8599534e361SValentin Clement 8609534e361SValentin Clement /// Lower `fir.dispatch_table` operation. The dispatch table for a Fortran 8619534e361SValentin Clement /// derived type. 8629534e361SValentin Clement struct DispatchTableOpConversion 8639534e361SValentin Clement : public FIROpConversion<fir::DispatchTableOp> { 8649534e361SValentin Clement using FIROpConversion::FIROpConversion; 8659534e361SValentin Clement 8669534e361SValentin Clement mlir::LogicalResult 8679534e361SValentin Clement matchAndRewrite(fir::DispatchTableOp dispTab, OpAdaptor adaptor, 8689534e361SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 8697ce8c6fcSKiran Chandramohan TODO(dispTab.getLoc(), "fir.dispatch_table codegen"); 8707ce8c6fcSKiran Chandramohan return failure(); 8719534e361SValentin Clement } 8729534e361SValentin Clement }; 8739534e361SValentin Clement 8749534e361SValentin Clement /// Lower `fir.dt_entry` operation. An entry in a dispatch table; binds a 8759534e361SValentin Clement /// method-name to a function. 8769534e361SValentin Clement struct DTEntryOpConversion : public FIROpConversion<fir::DTEntryOp> { 8779534e361SValentin Clement using FIROpConversion::FIROpConversion; 8789534e361SValentin Clement 8799534e361SValentin Clement mlir::LogicalResult 8809534e361SValentin Clement matchAndRewrite(fir::DTEntryOp dtEnt, OpAdaptor adaptor, 8819534e361SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 8827ce8c6fcSKiran Chandramohan TODO(dtEnt.getLoc(), "fir.dt_entry codegen"); 8837ce8c6fcSKiran Chandramohan return failure(); 8849534e361SValentin Clement } 8859534e361SValentin Clement }; 8869534e361SValentin Clement 887677df8c7SValentin Clement /// Lower `fir.global_len` operation. 888677df8c7SValentin Clement struct GlobalLenOpConversion : public FIROpConversion<fir::GlobalLenOp> { 889677df8c7SValentin Clement using FIROpConversion::FIROpConversion; 890677df8c7SValentin Clement 891677df8c7SValentin Clement mlir::LogicalResult 892677df8c7SValentin Clement matchAndRewrite(fir::GlobalLenOp globalLen, OpAdaptor adaptor, 893677df8c7SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 8947ce8c6fcSKiran Chandramohan TODO(globalLen.getLoc(), "fir.global_len codegen"); 8957ce8c6fcSKiran Chandramohan return failure(); 896677df8c7SValentin Clement } 897677df8c7SValentin Clement }; 898677df8c7SValentin Clement 899cdc476abSDiana Picus /// Lower fir.len_param_index 900cdc476abSDiana Picus struct LenParamIndexOpConversion 901cdc476abSDiana Picus : public FIROpConversion<fir::LenParamIndexOp> { 902cdc476abSDiana Picus using FIROpConversion::FIROpConversion; 903cdc476abSDiana Picus 904cdc476abSDiana Picus // FIXME: this should be specialized by the runtime target 905cdc476abSDiana Picus mlir::LogicalResult 906cdc476abSDiana Picus matchAndRewrite(fir::LenParamIndexOp lenp, OpAdaptor, 907cdc476abSDiana Picus mlir::ConversionPatternRewriter &rewriter) const override { 9087ce8c6fcSKiran Chandramohan TODO(lenp.getLoc(), "fir.len_param_index codegen"); 909cdc476abSDiana Picus } 910cdc476abSDiana Picus }; 911cdc476abSDiana Picus 912dc48849fSKiran Chandramohan /// Convert `!fir.emboxchar<!fir.char<KIND, ?>, #n>` into a sequence of 913dc48849fSKiran Chandramohan /// instructions that generate `!llvm.struct<(ptr<ik>, i64)>`. The 1st element 914dc48849fSKiran Chandramohan /// in this struct is a pointer. Its type is determined from `KIND`. The 2nd 915dc48849fSKiran Chandramohan /// element is the length of the character buffer (`#n`). 916dc48849fSKiran Chandramohan struct EmboxCharOpConversion : public FIROpConversion<fir::EmboxCharOp> { 91731246187SValentin Clement using FIROpConversion::FIROpConversion; 91831246187SValentin Clement 91931246187SValentin Clement mlir::LogicalResult 920dc48849fSKiran Chandramohan matchAndRewrite(fir::EmboxCharOp emboxChar, OpAdaptor adaptor, 92131246187SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 922dc48849fSKiran Chandramohan mlir::ValueRange operands = adaptor.getOperands(); 923dc48849fSKiran Chandramohan MLIRContext *ctx = emboxChar.getContext(); 924dc48849fSKiran Chandramohan 925dc48849fSKiran Chandramohan mlir::Value charBuffer = operands[0]; 926dc48849fSKiran Chandramohan mlir::Value charBufferLen = operands[1]; 927dc48849fSKiran Chandramohan 928dc48849fSKiran Chandramohan mlir::Location loc = emboxChar.getLoc(); 929dc48849fSKiran Chandramohan mlir::Type llvmStructTy = convertType(emboxChar.getType()); 930dc48849fSKiran Chandramohan auto llvmStruct = rewriter.create<mlir::LLVM::UndefOp>(loc, llvmStructTy); 931dc48849fSKiran Chandramohan 932dc48849fSKiran Chandramohan mlir::Type lenTy = 933dc48849fSKiran Chandramohan llvmStructTy.cast<mlir::LLVM::LLVMStructType>().getBody()[1]; 934dc48849fSKiran Chandramohan mlir::Value lenAfterCast = integerCast(loc, rewriter, lenTy, charBufferLen); 935dc48849fSKiran Chandramohan 936dc48849fSKiran Chandramohan auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 937dc48849fSKiran Chandramohan auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); 938dc48849fSKiran Chandramohan auto insertBufferOp = rewriter.create<mlir::LLVM::InsertValueOp>( 939dc48849fSKiran Chandramohan loc, llvmStructTy, llvmStruct, charBuffer, c0); 940dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>( 941dc48849fSKiran Chandramohan emboxChar, llvmStructTy, insertBufferOp, lenAfterCast, c1); 942dc48849fSKiran Chandramohan 943dc48849fSKiran Chandramohan return success(); 94431246187SValentin Clement } 94531246187SValentin Clement }; 946c2acd453SAlexisPerry } // namespace 947c2acd453SAlexisPerry 948c2acd453SAlexisPerry /// Return the LLVMFuncOp corresponding to the standard malloc call. 949c2acd453SAlexisPerry static mlir::LLVM::LLVMFuncOp 950c2acd453SAlexisPerry getMalloc(fir::AllocMemOp op, mlir::ConversionPatternRewriter &rewriter) { 951c2acd453SAlexisPerry auto module = op->getParentOfType<mlir::ModuleOp>(); 952c2acd453SAlexisPerry if (mlir::LLVM::LLVMFuncOp mallocFunc = 953c2acd453SAlexisPerry module.lookupSymbol<mlir::LLVM::LLVMFuncOp>("malloc")) 954c2acd453SAlexisPerry return mallocFunc; 955c2acd453SAlexisPerry mlir::OpBuilder moduleBuilder( 956c2acd453SAlexisPerry op->getParentOfType<mlir::ModuleOp>().getBodyRegion()); 957c2acd453SAlexisPerry auto indexType = mlir::IntegerType::get(op.getContext(), 64); 958c2acd453SAlexisPerry return moduleBuilder.create<mlir::LLVM::LLVMFuncOp>( 959c2acd453SAlexisPerry rewriter.getUnknownLoc(), "malloc", 960c2acd453SAlexisPerry mlir::LLVM::LLVMFunctionType::get(getVoidPtrType(op.getContext()), 961c2acd453SAlexisPerry indexType, 962c2acd453SAlexisPerry /*isVarArg=*/false)); 963c2acd453SAlexisPerry } 964c2acd453SAlexisPerry 965c2acd453SAlexisPerry /// Helper function for generating the LLVM IR that computes the size 966c2acd453SAlexisPerry /// in bytes for a derived type. 967c2acd453SAlexisPerry static mlir::Value 968c2acd453SAlexisPerry computeDerivedTypeSize(mlir::Location loc, mlir::Type ptrTy, mlir::Type idxTy, 969c2acd453SAlexisPerry mlir::ConversionPatternRewriter &rewriter) { 970c2acd453SAlexisPerry auto nullPtr = rewriter.create<mlir::LLVM::NullOp>(loc, ptrTy); 971c2acd453SAlexisPerry mlir::Value one = genConstantIndex(loc, idxTy, rewriter, 1); 97230122656SAlex Zinenko llvm::SmallVector<mlir::Value> args{one}; 97330122656SAlex Zinenko auto gep = rewriter.create<mlir::LLVM::GEPOp>(loc, ptrTy, nullPtr, args); 974c2acd453SAlexisPerry return rewriter.create<mlir::LLVM::PtrToIntOp>(loc, idxTy, gep); 975c2acd453SAlexisPerry } 976c2acd453SAlexisPerry 977c2acd453SAlexisPerry namespace { 978c2acd453SAlexisPerry /// Lower a `fir.allocmem` instruction into `llvm.call @malloc` 979c2acd453SAlexisPerry struct AllocMemOpConversion : public FIROpConversion<fir::AllocMemOp> { 980c2acd453SAlexisPerry using FIROpConversion::FIROpConversion; 981c2acd453SAlexisPerry 982c2acd453SAlexisPerry mlir::LogicalResult 983c2acd453SAlexisPerry matchAndRewrite(fir::AllocMemOp heap, OpAdaptor adaptor, 984c2acd453SAlexisPerry mlir::ConversionPatternRewriter &rewriter) const override { 985c45bd4b9SEric Schweitz auto heapTy = heap.getType(); 986c45bd4b9SEric Schweitz auto ty = convertType(heapTy); 987c2acd453SAlexisPerry mlir::LLVM::LLVMFuncOp mallocFunc = getMalloc(heap, rewriter); 988c2acd453SAlexisPerry mlir::Location loc = heap.getLoc(); 989c2acd453SAlexisPerry auto ity = lowerTy().indexType(); 990c45bd4b9SEric Schweitz auto dataTy = fir::unwrapRefType(heapTy); 991c45bd4b9SEric Schweitz if (fir::isRecordWithTypeParameters(fir::unwrapSequenceType(dataTy))) 992c45bd4b9SEric Schweitz TODO(loc, "fir.allocmem codegen of derived type with length parameters"); 993c2acd453SAlexisPerry mlir::Value size = genTypeSizeInBytes(loc, ity, rewriter, ty); 994c45bd4b9SEric Schweitz // !fir.array<NxMx!fir.char<K,?>> sets `size` to the width of !fir.char<K>. 995c45bd4b9SEric Schweitz // So multiply the constant dimensions here. 996c45bd4b9SEric Schweitz if (fir::hasDynamicSize(dataTy)) 997c45bd4b9SEric Schweitz if (auto seqTy = dataTy.dyn_cast<fir::SequenceType>()) 998c45bd4b9SEric Schweitz if (fir::characterWithDynamicLen(seqTy.getEleTy())) { 999c45bd4b9SEric Schweitz fir::SequenceType::Extent arrSize = 1; 1000c45bd4b9SEric Schweitz for (auto d : seqTy.getShape()) 1001c45bd4b9SEric Schweitz if (d != fir::SequenceType::getUnknownExtent()) 1002c45bd4b9SEric Schweitz arrSize *= d; 1003c45bd4b9SEric Schweitz size = rewriter.create<mlir::LLVM::MulOp>( 1004c45bd4b9SEric Schweitz loc, ity, size, genConstantIndex(loc, ity, rewriter, arrSize)); 1005c45bd4b9SEric Schweitz } 1006c2acd453SAlexisPerry for (mlir::Value opnd : adaptor.getOperands()) 1007c2acd453SAlexisPerry size = rewriter.create<mlir::LLVM::MulOp>( 1008c2acd453SAlexisPerry loc, ity, size, integerCast(loc, rewriter, ity, opnd)); 1009c2acd453SAlexisPerry heap->setAttr("callee", mlir::SymbolRefAttr::get(mallocFunc)); 1010c2acd453SAlexisPerry auto malloc = rewriter.create<mlir::LLVM::CallOp>( 1011c2acd453SAlexisPerry loc, ::getVoidPtrType(heap.getContext()), size, heap->getAttrs()); 1012c2acd453SAlexisPerry rewriter.replaceOpWithNewOp<mlir::LLVM::BitcastOp>(heap, ty, 1013c2acd453SAlexisPerry malloc.getResult(0)); 1014c2acd453SAlexisPerry return success(); 1015c2acd453SAlexisPerry } 1016c2acd453SAlexisPerry 1017c2acd453SAlexisPerry // Compute the (allocation) size of the allocmem type in bytes. 1018c2acd453SAlexisPerry mlir::Value genTypeSizeInBytes(mlir::Location loc, mlir::Type idxTy, 1019c2acd453SAlexisPerry mlir::ConversionPatternRewriter &rewriter, 1020c2acd453SAlexisPerry mlir::Type llTy) const { 1021c2acd453SAlexisPerry // Use the primitive size, if available. 1022c2acd453SAlexisPerry auto ptrTy = llTy.dyn_cast<mlir::LLVM::LLVMPointerType>(); 1023c2acd453SAlexisPerry if (auto size = 1024c2acd453SAlexisPerry mlir::LLVM::getPrimitiveTypeSizeInBits(ptrTy.getElementType())) 1025c2acd453SAlexisPerry return genConstantIndex(loc, idxTy, rewriter, size / 8); 1026c2acd453SAlexisPerry 1027c2acd453SAlexisPerry // Otherwise, generate the GEP trick in LLVM IR to compute the size. 1028c2acd453SAlexisPerry return computeDerivedTypeSize(loc, ptrTy, idxTy, rewriter); 1029c2acd453SAlexisPerry } 1030c2acd453SAlexisPerry }; 1031c2acd453SAlexisPerry } // namespace 1032c2acd453SAlexisPerry 1033c2acd453SAlexisPerry /// Return the LLVMFuncOp corresponding to the standard free call. 1034c2acd453SAlexisPerry static mlir::LLVM::LLVMFuncOp 1035c2acd453SAlexisPerry getFree(fir::FreeMemOp op, mlir::ConversionPatternRewriter &rewriter) { 1036c2acd453SAlexisPerry auto module = op->getParentOfType<mlir::ModuleOp>(); 1037c2acd453SAlexisPerry if (mlir::LLVM::LLVMFuncOp freeFunc = 1038c2acd453SAlexisPerry module.lookupSymbol<mlir::LLVM::LLVMFuncOp>("free")) 1039c2acd453SAlexisPerry return freeFunc; 1040c2acd453SAlexisPerry mlir::OpBuilder moduleBuilder(module.getBodyRegion()); 1041c2acd453SAlexisPerry auto voidType = mlir::LLVM::LLVMVoidType::get(op.getContext()); 1042c2acd453SAlexisPerry return moduleBuilder.create<mlir::LLVM::LLVMFuncOp>( 1043c2acd453SAlexisPerry rewriter.getUnknownLoc(), "free", 1044c2acd453SAlexisPerry mlir::LLVM::LLVMFunctionType::get(voidType, 1045c2acd453SAlexisPerry getVoidPtrType(op.getContext()), 1046c2acd453SAlexisPerry /*isVarArg=*/false)); 1047c2acd453SAlexisPerry } 1048c2acd453SAlexisPerry 1049c2acd453SAlexisPerry namespace { 1050c2acd453SAlexisPerry /// Lower a `fir.freemem` instruction into `llvm.call @free` 1051c2acd453SAlexisPerry struct FreeMemOpConversion : public FIROpConversion<fir::FreeMemOp> { 1052c2acd453SAlexisPerry using FIROpConversion::FIROpConversion; 1053c2acd453SAlexisPerry 1054c2acd453SAlexisPerry mlir::LogicalResult 1055c2acd453SAlexisPerry matchAndRewrite(fir::FreeMemOp freemem, OpAdaptor adaptor, 1056c2acd453SAlexisPerry mlir::ConversionPatternRewriter &rewriter) const override { 1057c2acd453SAlexisPerry mlir::LLVM::LLVMFuncOp freeFunc = getFree(freemem, rewriter); 1058c2acd453SAlexisPerry mlir::Location loc = freemem.getLoc(); 1059c2acd453SAlexisPerry auto bitcast = rewriter.create<mlir::LLVM::BitcastOp>( 1060c2acd453SAlexisPerry freemem.getLoc(), voidPtrTy(), adaptor.getOperands()[0]); 1061c2acd453SAlexisPerry freemem->setAttr("callee", mlir::SymbolRefAttr::get(freeFunc)); 1062c2acd453SAlexisPerry rewriter.create<mlir::LLVM::CallOp>( 1063c2acd453SAlexisPerry loc, mlir::TypeRange{}, mlir::ValueRange{bitcast}, freemem->getAttrs()); 1064c2acd453SAlexisPerry rewriter.eraseOp(freemem); 1065c2acd453SAlexisPerry return success(); 1066c2acd453SAlexisPerry } 1067c2acd453SAlexisPerry }; 1068c2acd453SAlexisPerry } // namespace 1069044d5b5dSValentin Clement 1070dc48849fSKiran Chandramohan namespace {} // namespace 107132e08248SAndrzej Warzynski 1072af6ee580SValentin Clement /// Common base class for embox to descriptor conversion. 1073af6ee580SValentin Clement template <typename OP> 1074af6ee580SValentin Clement struct EmboxCommonConversion : public FIROpConversion<OP> { 1075af6ee580SValentin Clement using FIROpConversion<OP>::FIROpConversion; 1076af6ee580SValentin Clement 1077af6ee580SValentin Clement // Find the LLVMFuncOp in whose entry block the alloca should be inserted. 1078af6ee580SValentin Clement // The order to find the LLVMFuncOp is as follows: 1079af6ee580SValentin Clement // 1. The parent operation of the current block if it is a LLVMFuncOp. 1080af6ee580SValentin Clement // 2. The first ancestor that is a LLVMFuncOp. 1081af6ee580SValentin Clement mlir::LLVM::LLVMFuncOp 1082af6ee580SValentin Clement getFuncForAllocaInsert(mlir::ConversionPatternRewriter &rewriter) const { 1083af6ee580SValentin Clement mlir::Operation *parentOp = rewriter.getInsertionBlock()->getParentOp(); 1084af6ee580SValentin Clement return mlir::isa<mlir::LLVM::LLVMFuncOp>(parentOp) 1085af6ee580SValentin Clement ? mlir::cast<mlir::LLVM::LLVMFuncOp>(parentOp) 1086af6ee580SValentin Clement : parentOp->getParentOfType<mlir::LLVM::LLVMFuncOp>(); 1087af6ee580SValentin Clement } 1088af6ee580SValentin Clement 1089af6ee580SValentin Clement // Generate an alloca of size 1 and type \p toTy. 1090af6ee580SValentin Clement mlir::LLVM::AllocaOp 1091af6ee580SValentin Clement genAllocaWithType(mlir::Location loc, mlir::Type toTy, unsigned alignment, 1092af6ee580SValentin Clement mlir::ConversionPatternRewriter &rewriter) const { 1093af6ee580SValentin Clement auto thisPt = rewriter.saveInsertionPoint(); 1094af6ee580SValentin Clement mlir::LLVM::LLVMFuncOp func = getFuncForAllocaInsert(rewriter); 1095af6ee580SValentin Clement rewriter.setInsertionPointToStart(&func.front()); 1096af6ee580SValentin Clement auto size = this->genI32Constant(loc, rewriter, 1); 1097af6ee580SValentin Clement auto al = rewriter.create<mlir::LLVM::AllocaOp>(loc, toTy, size, alignment); 1098af6ee580SValentin Clement rewriter.restoreInsertionPoint(thisPt); 1099af6ee580SValentin Clement return al; 1100af6ee580SValentin Clement } 1101af6ee580SValentin Clement 1102af6ee580SValentin Clement static int getCFIAttr(fir::BoxType boxTy) { 1103af6ee580SValentin Clement auto eleTy = boxTy.getEleTy(); 1104af6ee580SValentin Clement if (eleTy.isa<fir::PointerType>()) 1105af6ee580SValentin Clement return CFI_attribute_pointer; 1106af6ee580SValentin Clement if (eleTy.isa<fir::HeapType>()) 1107af6ee580SValentin Clement return CFI_attribute_allocatable; 1108af6ee580SValentin Clement return CFI_attribute_other; 1109af6ee580SValentin Clement } 1110af6ee580SValentin Clement 1111af6ee580SValentin Clement static fir::RecordType unwrapIfDerived(fir::BoxType boxTy) { 1112af6ee580SValentin Clement return fir::unwrapSequenceType(fir::dyn_cast_ptrOrBoxEleTy(boxTy)) 1113af6ee580SValentin Clement .template dyn_cast<fir::RecordType>(); 1114af6ee580SValentin Clement } 1115af6ee580SValentin Clement static bool isDerivedTypeWithLenParams(fir::BoxType boxTy) { 1116af6ee580SValentin Clement auto recTy = unwrapIfDerived(boxTy); 1117af6ee580SValentin Clement return recTy && recTy.getNumLenParams() > 0; 1118af6ee580SValentin Clement } 1119af6ee580SValentin Clement static bool isDerivedType(fir::BoxType boxTy) { 1120af6ee580SValentin Clement return unwrapIfDerived(boxTy) != nullptr; 1121af6ee580SValentin Clement } 1122af6ee580SValentin Clement 1123af6ee580SValentin Clement // Get the element size and CFI type code of the boxed value. 1124af6ee580SValentin Clement std::tuple<mlir::Value, mlir::Value> getSizeAndTypeCode( 1125af6ee580SValentin Clement mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, 1126af6ee580SValentin Clement mlir::Type boxEleTy, mlir::ValueRange lenParams = {}) const { 1127af6ee580SValentin Clement auto doInteger = 1128af6ee580SValentin Clement [&](unsigned width) -> std::tuple<mlir::Value, mlir::Value> { 1129af6ee580SValentin Clement int typeCode = fir::integerBitsToTypeCode(width); 1130af6ee580SValentin Clement return {this->genConstantOffset(loc, rewriter, width / 8), 1131af6ee580SValentin Clement this->genConstantOffset(loc, rewriter, typeCode)}; 1132af6ee580SValentin Clement }; 1133af6ee580SValentin Clement auto doLogical = 1134af6ee580SValentin Clement [&](unsigned width) -> std::tuple<mlir::Value, mlir::Value> { 1135af6ee580SValentin Clement int typeCode = fir::logicalBitsToTypeCode(width); 1136af6ee580SValentin Clement return {this->genConstantOffset(loc, rewriter, width / 8), 1137af6ee580SValentin Clement this->genConstantOffset(loc, rewriter, typeCode)}; 1138af6ee580SValentin Clement }; 1139af6ee580SValentin Clement auto doFloat = [&](unsigned width) -> std::tuple<mlir::Value, mlir::Value> { 1140af6ee580SValentin Clement int typeCode = fir::realBitsToTypeCode(width); 1141af6ee580SValentin Clement return {this->genConstantOffset(loc, rewriter, width / 8), 1142af6ee580SValentin Clement this->genConstantOffset(loc, rewriter, typeCode)}; 1143af6ee580SValentin Clement }; 1144af6ee580SValentin Clement auto doComplex = 1145af6ee580SValentin Clement [&](unsigned width) -> std::tuple<mlir::Value, mlir::Value> { 1146af6ee580SValentin Clement auto typeCode = fir::complexBitsToTypeCode(width); 1147af6ee580SValentin Clement return {this->genConstantOffset(loc, rewriter, width / 8 * 2), 1148af6ee580SValentin Clement this->genConstantOffset(loc, rewriter, typeCode)}; 1149af6ee580SValentin Clement }; 1150af6ee580SValentin Clement auto doCharacter = 1151af6ee580SValentin Clement [&](unsigned width, 1152af6ee580SValentin Clement mlir::Value len) -> std::tuple<mlir::Value, mlir::Value> { 1153af6ee580SValentin Clement auto typeCode = fir::characterBitsToTypeCode(width); 1154af6ee580SValentin Clement auto typeCodeVal = this->genConstantOffset(loc, rewriter, typeCode); 1155af6ee580SValentin Clement if (width == 8) 1156af6ee580SValentin Clement return {len, typeCodeVal}; 1157af6ee580SValentin Clement auto byteWidth = this->genConstantOffset(loc, rewriter, width / 8); 1158af6ee580SValentin Clement auto i64Ty = mlir::IntegerType::get(&this->lowerTy().getContext(), 64); 1159af6ee580SValentin Clement auto size = 1160af6ee580SValentin Clement rewriter.create<mlir::LLVM::MulOp>(loc, i64Ty, byteWidth, len); 1161af6ee580SValentin Clement return {size, typeCodeVal}; 1162af6ee580SValentin Clement }; 1163af6ee580SValentin Clement auto getKindMap = [&]() -> fir::KindMapping & { 1164af6ee580SValentin Clement return this->lowerTy().getKindMap(); 1165af6ee580SValentin Clement }; 1166af6ee580SValentin Clement // Pointer-like types. 1167af6ee580SValentin Clement if (auto eleTy = fir::dyn_cast_ptrEleTy(boxEleTy)) 1168af6ee580SValentin Clement boxEleTy = eleTy; 1169af6ee580SValentin Clement // Integer types. 1170af6ee580SValentin Clement if (fir::isa_integer(boxEleTy)) { 1171af6ee580SValentin Clement if (auto ty = boxEleTy.dyn_cast<mlir::IntegerType>()) 1172af6ee580SValentin Clement return doInteger(ty.getWidth()); 1173af6ee580SValentin Clement auto ty = boxEleTy.cast<fir::IntegerType>(); 1174af6ee580SValentin Clement return doInteger(getKindMap().getIntegerBitsize(ty.getFKind())); 1175af6ee580SValentin Clement } 1176af6ee580SValentin Clement // Floating point types. 1177af6ee580SValentin Clement if (fir::isa_real(boxEleTy)) { 1178af6ee580SValentin Clement if (auto ty = boxEleTy.dyn_cast<mlir::FloatType>()) 1179af6ee580SValentin Clement return doFloat(ty.getWidth()); 1180af6ee580SValentin Clement auto ty = boxEleTy.cast<fir::RealType>(); 1181af6ee580SValentin Clement return doFloat(getKindMap().getRealBitsize(ty.getFKind())); 1182af6ee580SValentin Clement } 1183af6ee580SValentin Clement // Complex types. 1184af6ee580SValentin Clement if (fir::isa_complex(boxEleTy)) { 1185af6ee580SValentin Clement if (auto ty = boxEleTy.dyn_cast<mlir::ComplexType>()) 1186af6ee580SValentin Clement return doComplex( 1187af6ee580SValentin Clement ty.getElementType().cast<mlir::FloatType>().getWidth()); 1188af6ee580SValentin Clement auto ty = boxEleTy.cast<fir::ComplexType>(); 1189af6ee580SValentin Clement return doComplex(getKindMap().getRealBitsize(ty.getFKind())); 1190af6ee580SValentin Clement } 1191af6ee580SValentin Clement // Character types. 1192af6ee580SValentin Clement if (auto ty = boxEleTy.dyn_cast<fir::CharacterType>()) { 1193af6ee580SValentin Clement auto charWidth = getKindMap().getCharacterBitsize(ty.getFKind()); 1194af6ee580SValentin Clement if (ty.getLen() != fir::CharacterType::unknownLen()) { 1195af6ee580SValentin Clement auto len = this->genConstantOffset(loc, rewriter, ty.getLen()); 1196af6ee580SValentin Clement return doCharacter(charWidth, len); 1197af6ee580SValentin Clement } 1198af6ee580SValentin Clement assert(!lenParams.empty()); 1199af6ee580SValentin Clement return doCharacter(charWidth, lenParams.back()); 1200af6ee580SValentin Clement } 1201af6ee580SValentin Clement // Logical type. 1202af6ee580SValentin Clement if (auto ty = boxEleTy.dyn_cast<fir::LogicalType>()) 1203af6ee580SValentin Clement return doLogical(getKindMap().getLogicalBitsize(ty.getFKind())); 1204af6ee580SValentin Clement // Array types. 1205af6ee580SValentin Clement if (auto seqTy = boxEleTy.dyn_cast<fir::SequenceType>()) 1206af6ee580SValentin Clement return getSizeAndTypeCode(loc, rewriter, seqTy.getEleTy(), lenParams); 1207af6ee580SValentin Clement // Derived-type types. 1208af6ee580SValentin Clement if (boxEleTy.isa<fir::RecordType>()) { 1209af6ee580SValentin Clement auto ptrTy = mlir::LLVM::LLVMPointerType::get( 1210af6ee580SValentin Clement this->lowerTy().convertType(boxEleTy)); 1211af6ee580SValentin Clement auto nullPtr = rewriter.create<mlir::LLVM::NullOp>(loc, ptrTy); 1212af6ee580SValentin Clement auto one = 1213af6ee580SValentin Clement genConstantIndex(loc, this->lowerTy().offsetType(), rewriter, 1); 121430122656SAlex Zinenko auto gep = rewriter.create<mlir::LLVM::GEPOp>(loc, ptrTy, nullPtr, 121530122656SAlex Zinenko mlir::ValueRange{one}); 1216af6ee580SValentin Clement auto eleSize = rewriter.create<mlir::LLVM::PtrToIntOp>( 1217af6ee580SValentin Clement loc, this->lowerTy().indexType(), gep); 1218af6ee580SValentin Clement return {eleSize, 1219af6ee580SValentin Clement this->genConstantOffset(loc, rewriter, fir::derivedToTypeCode())}; 1220af6ee580SValentin Clement } 1221af6ee580SValentin Clement // Reference type. 1222af6ee580SValentin Clement if (fir::isa_ref_type(boxEleTy)) { 1223af6ee580SValentin Clement // FIXME: use the target pointer size rather than sizeof(void*) 1224af6ee580SValentin Clement return {this->genConstantOffset(loc, rewriter, sizeof(void *)), 1225af6ee580SValentin Clement this->genConstantOffset(loc, rewriter, CFI_type_cptr)}; 1226af6ee580SValentin Clement } 1227af6ee580SValentin Clement fir::emitFatalError(loc, "unhandled type in fir.box code generation"); 1228af6ee580SValentin Clement } 1229af6ee580SValentin Clement 1230af6ee580SValentin Clement /// Basic pattern to write a field in the descriptor 1231af6ee580SValentin Clement mlir::Value insertField(mlir::ConversionPatternRewriter &rewriter, 1232af6ee580SValentin Clement mlir::Location loc, mlir::Value dest, 1233af6ee580SValentin Clement ArrayRef<unsigned> fldIndexes, mlir::Value value, 1234af6ee580SValentin Clement bool bitcast = false) const { 1235af6ee580SValentin Clement auto boxTy = dest.getType(); 1236af6ee580SValentin Clement auto fldTy = this->getBoxEleTy(boxTy, fldIndexes); 1237af6ee580SValentin Clement if (bitcast) 1238af6ee580SValentin Clement value = rewriter.create<mlir::LLVM::BitcastOp>(loc, fldTy, value); 1239af6ee580SValentin Clement else 1240af6ee580SValentin Clement value = this->integerCast(loc, rewriter, fldTy, value); 1241af6ee580SValentin Clement SmallVector<mlir::Attribute, 2> attrs; 1242af6ee580SValentin Clement for (auto i : fldIndexes) 1243af6ee580SValentin Clement attrs.push_back(rewriter.getI32IntegerAttr(i)); 1244af6ee580SValentin Clement auto indexesAttr = mlir::ArrayAttr::get(rewriter.getContext(), attrs); 1245af6ee580SValentin Clement return rewriter.create<mlir::LLVM::InsertValueOp>(loc, boxTy, dest, value, 1246af6ee580SValentin Clement indexesAttr); 1247af6ee580SValentin Clement } 1248af6ee580SValentin Clement 1249af6ee580SValentin Clement inline mlir::Value 1250af6ee580SValentin Clement insertBaseAddress(mlir::ConversionPatternRewriter &rewriter, 1251af6ee580SValentin Clement mlir::Location loc, mlir::Value dest, 1252af6ee580SValentin Clement mlir::Value base) const { 12531f551032SValentin Clement return insertField(rewriter, loc, dest, {kAddrPosInBox}, base, 12541f551032SValentin Clement /*bitCast=*/true); 12551f551032SValentin Clement } 12561f551032SValentin Clement 12571f551032SValentin Clement inline mlir::Value insertLowerBound(mlir::ConversionPatternRewriter &rewriter, 12581f551032SValentin Clement mlir::Location loc, mlir::Value dest, 12591f551032SValentin Clement unsigned dim, mlir::Value lb) const { 12601f551032SValentin Clement return insertField(rewriter, loc, dest, 12611f551032SValentin Clement {kDimsPosInBox, dim, kDimLowerBoundPos}, lb); 12621f551032SValentin Clement } 12631f551032SValentin Clement 12641f551032SValentin Clement inline mlir::Value insertExtent(mlir::ConversionPatternRewriter &rewriter, 12651f551032SValentin Clement mlir::Location loc, mlir::Value dest, 12661f551032SValentin Clement unsigned dim, mlir::Value extent) const { 12671f551032SValentin Clement return insertField(rewriter, loc, dest, {kDimsPosInBox, dim, kDimExtentPos}, 12681f551032SValentin Clement extent); 12691f551032SValentin Clement } 12701f551032SValentin Clement 12711f551032SValentin Clement inline mlir::Value insertStride(mlir::ConversionPatternRewriter &rewriter, 12721f551032SValentin Clement mlir::Location loc, mlir::Value dest, 12731f551032SValentin Clement unsigned dim, mlir::Value stride) const { 12741f551032SValentin Clement return insertField(rewriter, loc, dest, {kDimsPosInBox, dim, kDimStridePos}, 12751f551032SValentin Clement stride); 1276af6ee580SValentin Clement } 1277af6ee580SValentin Clement 1278af6ee580SValentin Clement /// Get the address of the type descriptor global variable that was created by 1279af6ee580SValentin Clement /// lowering for derived type \p recType. 1280af6ee580SValentin Clement template <typename BOX> 1281af6ee580SValentin Clement mlir::Value 1282af6ee580SValentin Clement getTypeDescriptor(BOX box, mlir::ConversionPatternRewriter &rewriter, 1283af6ee580SValentin Clement mlir::Location loc, fir::RecordType recType) const { 1284013160f6SJean Perier std::string name = 1285013160f6SJean Perier fir::NameUniquer::getTypeDescriptorName(recType.getName()); 1286af6ee580SValentin Clement auto module = box->template getParentOfType<mlir::ModuleOp>(); 1287af6ee580SValentin Clement if (auto global = module.template lookupSymbol<fir::GlobalOp>(name)) { 1288af6ee580SValentin Clement auto ty = mlir::LLVM::LLVMPointerType::get( 1289af6ee580SValentin Clement this->lowerTy().convertType(global.getType())); 1290af6ee580SValentin Clement return rewriter.create<mlir::LLVM::AddressOfOp>(loc, ty, 1291feeee78aSJacques Pienaar global.getSymName()); 1292af6ee580SValentin Clement } 1293af6ee580SValentin Clement if (auto global = 1294af6ee580SValentin Clement module.template lookupSymbol<mlir::LLVM::GlobalOp>(name)) { 1295af6ee580SValentin Clement // The global may have already been translated to LLVM. 1296af6ee580SValentin Clement auto ty = mlir::LLVM::LLVMPointerType::get(global.getType()); 1297af6ee580SValentin Clement return rewriter.create<mlir::LLVM::AddressOfOp>(loc, ty, 1298feeee78aSJacques Pienaar global.getSymName()); 1299af6ee580SValentin Clement } 13007dd7ccd2SJean Perier // Type info derived types do not have type descriptors since they are the 13017dd7ccd2SJean Perier // types defining type descriptors. 1302013160f6SJean Perier if (!this->options.ignoreMissingTypeDescriptors && 1303013160f6SJean Perier !fir::NameUniquer::belongsToModule( 1304013160f6SJean Perier name, Fortran::semantics::typeInfoBuiltinModule)) 1305013160f6SJean Perier fir::emitFatalError( 1306013160f6SJean Perier loc, "runtime derived type info descriptor was not generated"); 13075bde97b1SJean Perier return rewriter.create<mlir::LLVM::NullOp>( 13085bde97b1SJean Perier loc, ::getVoidPtrType(box.getContext())); 13097dd7ccd2SJean Perier } 1310af6ee580SValentin Clement 1311af6ee580SValentin Clement template <typename BOX> 1312af6ee580SValentin Clement std::tuple<fir::BoxType, mlir::Value, mlir::Value> 1313af6ee580SValentin Clement consDescriptorPrefix(BOX box, mlir::ConversionPatternRewriter &rewriter, 1314af6ee580SValentin Clement unsigned rank, mlir::ValueRange lenParams) const { 1315af6ee580SValentin Clement auto loc = box.getLoc(); 1316af6ee580SValentin Clement auto boxTy = box.getType().template dyn_cast<fir::BoxType>(); 1317af6ee580SValentin Clement auto convTy = this->lowerTy().convertBoxType(boxTy, rank); 1318af6ee580SValentin Clement auto llvmBoxPtrTy = convTy.template cast<mlir::LLVM::LLVMPointerType>(); 1319af6ee580SValentin Clement auto llvmBoxTy = llvmBoxPtrTy.getElementType(); 1320af6ee580SValentin Clement mlir::Value descriptor = 1321af6ee580SValentin Clement rewriter.create<mlir::LLVM::UndefOp>(loc, llvmBoxTy); 1322af6ee580SValentin Clement 1323af6ee580SValentin Clement llvm::SmallVector<mlir::Value> typeparams = lenParams; 1324af6ee580SValentin Clement if constexpr (!std::is_same_v<BOX, fir::EmboxOp>) { 1325af6ee580SValentin Clement if (!box.substr().empty() && fir::hasDynamicSize(boxTy.getEleTy())) 1326af6ee580SValentin Clement typeparams.push_back(box.substr()[1]); 1327af6ee580SValentin Clement } 1328af6ee580SValentin Clement 1329af6ee580SValentin Clement // Write each of the fields with the appropriate values 1330af6ee580SValentin Clement auto [eleSize, cfiTy] = 1331af6ee580SValentin Clement getSizeAndTypeCode(loc, rewriter, boxTy.getEleTy(), typeparams); 1332af6ee580SValentin Clement descriptor = 1333af6ee580SValentin Clement insertField(rewriter, loc, descriptor, {kElemLenPosInBox}, eleSize); 1334af6ee580SValentin Clement descriptor = insertField(rewriter, loc, descriptor, {kVersionPosInBox}, 1335af6ee580SValentin Clement this->genI32Constant(loc, rewriter, CFI_VERSION)); 1336af6ee580SValentin Clement descriptor = insertField(rewriter, loc, descriptor, {kRankPosInBox}, 1337af6ee580SValentin Clement this->genI32Constant(loc, rewriter, rank)); 1338af6ee580SValentin Clement descriptor = insertField(rewriter, loc, descriptor, {kTypePosInBox}, cfiTy); 1339af6ee580SValentin Clement descriptor = 1340af6ee580SValentin Clement insertField(rewriter, loc, descriptor, {kAttributePosInBox}, 1341af6ee580SValentin Clement this->genI32Constant(loc, rewriter, getCFIAttr(boxTy))); 1342af6ee580SValentin Clement const bool hasAddendum = isDerivedType(boxTy); 1343af6ee580SValentin Clement descriptor = 1344af6ee580SValentin Clement insertField(rewriter, loc, descriptor, {kF18AddendumPosInBox}, 1345af6ee580SValentin Clement this->genI32Constant(loc, rewriter, hasAddendum ? 1 : 0)); 1346af6ee580SValentin Clement 1347af6ee580SValentin Clement if (hasAddendum) { 1348af6ee580SValentin Clement auto isArray = 1349af6ee580SValentin Clement fir::dyn_cast_ptrOrBoxEleTy(boxTy).template isa<fir::SequenceType>(); 1350af6ee580SValentin Clement unsigned typeDescFieldId = isArray ? kOptTypePtrPosInBox : kDimsPosInBox; 1351af6ee580SValentin Clement auto typeDesc = 1352af6ee580SValentin Clement getTypeDescriptor(box, rewriter, loc, unwrapIfDerived(boxTy)); 1353af6ee580SValentin Clement descriptor = 1354af6ee580SValentin Clement insertField(rewriter, loc, descriptor, {typeDescFieldId}, typeDesc, 1355af6ee580SValentin Clement /*bitCast=*/true); 1356af6ee580SValentin Clement } 1357af6ee580SValentin Clement 1358af6ee580SValentin Clement return {boxTy, descriptor, eleSize}; 1359af6ee580SValentin Clement } 1360af6ee580SValentin Clement 13611f551032SValentin Clement /// Compute the base address of a substring given the base address of a scalar 13621f551032SValentin Clement /// string and the zero based string lower bound. 13631f551032SValentin Clement mlir::Value shiftSubstringBase(mlir::ConversionPatternRewriter &rewriter, 13641f551032SValentin Clement mlir::Location loc, mlir::Value base, 13651f551032SValentin Clement mlir::Value lowerBound) const { 13661f551032SValentin Clement llvm::SmallVector<mlir::Value> gepOperands; 13671f551032SValentin Clement auto baseType = 13681f551032SValentin Clement base.getType().cast<mlir::LLVM::LLVMPointerType>().getElementType(); 13691f551032SValentin Clement if (baseType.isa<mlir::LLVM::LLVMArrayType>()) { 13701f551032SValentin Clement auto idxTy = this->lowerTy().indexType(); 13711f551032SValentin Clement mlir::Value zero = genConstantIndex(loc, idxTy, rewriter, 0); 13721f551032SValentin Clement gepOperands.push_back(zero); 13731f551032SValentin Clement } 13741f551032SValentin Clement gepOperands.push_back(lowerBound); 13751f551032SValentin Clement return this->genGEP(loc, base.getType(), rewriter, base, gepOperands); 13761f551032SValentin Clement } 13771f551032SValentin Clement 1378af6ee580SValentin Clement /// If the embox is not in a globalOp body, allocate storage for the box; 1379af6ee580SValentin Clement /// store the value inside and return the generated alloca. Return the input 1380af6ee580SValentin Clement /// value otherwise. 1381af6ee580SValentin Clement mlir::Value 1382af6ee580SValentin Clement placeInMemoryIfNotGlobalInit(mlir::ConversionPatternRewriter &rewriter, 1383af6ee580SValentin Clement mlir::Location loc, mlir::Value boxValue) const { 1384af6ee580SValentin Clement auto *thisBlock = rewriter.getInsertionBlock(); 1385af6ee580SValentin Clement if (thisBlock && mlir::isa<mlir::LLVM::GlobalOp>(thisBlock->getParentOp())) 1386af6ee580SValentin Clement return boxValue; 1387af6ee580SValentin Clement auto boxPtrTy = mlir::LLVM::LLVMPointerType::get(boxValue.getType()); 1388af6ee580SValentin Clement auto alloca = genAllocaWithType(loc, boxPtrTy, defaultAlign, rewriter); 1389af6ee580SValentin Clement rewriter.create<mlir::LLVM::StoreOp>(loc, boxValue, alloca); 1390af6ee580SValentin Clement return alloca; 1391af6ee580SValentin Clement } 1392af6ee580SValentin Clement }; 1393af6ee580SValentin Clement 13941f551032SValentin Clement /// Compute the extent of a triplet slice (lb:ub:step). 13951f551032SValentin Clement static mlir::Value 13961f551032SValentin Clement computeTripletExtent(mlir::ConversionPatternRewriter &rewriter, 13971f551032SValentin Clement mlir::Location loc, mlir::Value lb, mlir::Value ub, 13981f551032SValentin Clement mlir::Value step, mlir::Value zero, mlir::Type type) { 13991f551032SValentin Clement mlir::Value extent = rewriter.create<mlir::LLVM::SubOp>(loc, type, ub, lb); 14001f551032SValentin Clement extent = rewriter.create<mlir::LLVM::AddOp>(loc, type, extent, step); 14011f551032SValentin Clement extent = rewriter.create<mlir::LLVM::SDivOp>(loc, type, extent, step); 14021f551032SValentin Clement // If the resulting extent is negative (`ub-lb` and `step` have different 14031f551032SValentin Clement // signs), zero must be returned instead. 14041f551032SValentin Clement auto cmp = rewriter.create<mlir::LLVM::ICmpOp>( 14051f551032SValentin Clement loc, mlir::LLVM::ICmpPredicate::sgt, extent, zero); 14061f551032SValentin Clement return rewriter.create<mlir::LLVM::SelectOp>(loc, cmp, extent, zero); 14071f551032SValentin Clement } 14081f551032SValentin Clement 1409af6ee580SValentin Clement /// Create a generic box on a memory reference. This conversions lowers the 1410af6ee580SValentin Clement /// abstract box to the appropriate, initialized descriptor. 1411af6ee580SValentin Clement struct EmboxOpConversion : public EmboxCommonConversion<fir::EmboxOp> { 1412af6ee580SValentin Clement using EmboxCommonConversion::EmboxCommonConversion; 1413af6ee580SValentin Clement 1414af6ee580SValentin Clement mlir::LogicalResult 1415af6ee580SValentin Clement matchAndRewrite(fir::EmboxOp embox, OpAdaptor adaptor, 1416af6ee580SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 1417af6ee580SValentin Clement assert(!embox.getShape() && "There should be no dims on this embox op"); 1418af6ee580SValentin Clement auto [boxTy, dest, eleSize] = 1419af6ee580SValentin Clement consDescriptorPrefix(embox, rewriter, /*rank=*/0, 1420af6ee580SValentin Clement /*lenParams=*/adaptor.getOperands().drop_front(1)); 1421af6ee580SValentin Clement dest = insertBaseAddress(rewriter, embox.getLoc(), dest, 1422af6ee580SValentin Clement adaptor.getOperands()[0]); 14237ce8c6fcSKiran Chandramohan if (isDerivedTypeWithLenParams(boxTy)) { 14247ce8c6fcSKiran Chandramohan TODO(embox.getLoc(), 14257ce8c6fcSKiran Chandramohan "fir.embox codegen of derived with length parameters"); 14267ce8c6fcSKiran Chandramohan return failure(); 14277ce8c6fcSKiran Chandramohan } 1428af6ee580SValentin Clement auto result = placeInMemoryIfNotGlobalInit(rewriter, embox.getLoc(), dest); 1429af6ee580SValentin Clement rewriter.replaceOp(embox, result); 1430af6ee580SValentin Clement return success(); 1431af6ee580SValentin Clement } 1432af6ee580SValentin Clement }; 1433af6ee580SValentin Clement 14341f551032SValentin Clement /// Create a generic box on a memory reference. 14351f551032SValentin Clement struct XEmboxOpConversion : public EmboxCommonConversion<fir::cg::XEmboxOp> { 14361f551032SValentin Clement using EmboxCommonConversion::EmboxCommonConversion; 14371f551032SValentin Clement 14381f551032SValentin Clement mlir::LogicalResult 14391f551032SValentin Clement matchAndRewrite(fir::cg::XEmboxOp xbox, OpAdaptor adaptor, 14401f551032SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 14411f551032SValentin Clement auto [boxTy, dest, eleSize] = consDescriptorPrefix( 14421f551032SValentin Clement xbox, rewriter, xbox.getOutRank(), 14431f551032SValentin Clement adaptor.getOperands().drop_front(xbox.lenParamOffset())); 14441f551032SValentin Clement // Generate the triples in the dims field of the descriptor 14451f551032SValentin Clement mlir::ValueRange operands = adaptor.getOperands(); 14461f551032SValentin Clement auto i64Ty = mlir::IntegerType::get(xbox.getContext(), 64); 14471f551032SValentin Clement mlir::Value base = operands[0]; 14481f551032SValentin Clement assert(!xbox.shape().empty() && "must have a shape"); 14491f551032SValentin Clement unsigned shapeOffset = xbox.shapeOffset(); 14501f551032SValentin Clement bool hasShift = !xbox.shift().empty(); 14511f551032SValentin Clement unsigned shiftOffset = xbox.shiftOffset(); 14521f551032SValentin Clement bool hasSlice = !xbox.slice().empty(); 14531f551032SValentin Clement unsigned sliceOffset = xbox.sliceOffset(); 14541f551032SValentin Clement mlir::Location loc = xbox.getLoc(); 14551f551032SValentin Clement mlir::Value zero = genConstantIndex(loc, i64Ty, rewriter, 0); 14561f551032SValentin Clement mlir::Value one = genConstantIndex(loc, i64Ty, rewriter, 1); 14571f551032SValentin Clement mlir::Value prevDim = integerCast(loc, rewriter, i64Ty, eleSize); 14581f551032SValentin Clement mlir::Value prevPtrOff = one; 14591f551032SValentin Clement mlir::Type eleTy = boxTy.getEleTy(); 14601f551032SValentin Clement const unsigned rank = xbox.getRank(); 14611f551032SValentin Clement llvm::SmallVector<mlir::Value> gepArgs; 14621f551032SValentin Clement unsigned constRows = 0; 14631f551032SValentin Clement mlir::Value ptrOffset = zero; 14641f551032SValentin Clement if (auto memEleTy = fir::dyn_cast_ptrEleTy(xbox.memref().getType())) 14651f551032SValentin Clement if (auto seqTy = memEleTy.dyn_cast<fir::SequenceType>()) { 14661f551032SValentin Clement mlir::Type seqEleTy = seqTy.getEleTy(); 14671f551032SValentin Clement // Adjust the element scaling factor if the element is a dependent type. 14681f551032SValentin Clement if (fir::hasDynamicSize(seqEleTy)) { 14691f551032SValentin Clement if (fir::isa_char(seqEleTy)) { 14701f551032SValentin Clement assert(xbox.lenParams().size() == 1); 14711f551032SValentin Clement prevPtrOff = integerCast(loc, rewriter, i64Ty, 14721f551032SValentin Clement operands[xbox.lenParamOffset()]); 14731f551032SValentin Clement } else if (seqEleTy.isa<fir::RecordType>()) { 14741f551032SValentin Clement TODO(loc, "generate call to calculate size of PDT"); 14751f551032SValentin Clement } else { 14761f551032SValentin Clement return rewriter.notifyMatchFailure(xbox, "unexpected dynamic type"); 14771f551032SValentin Clement } 14781f551032SValentin Clement } else { 14791f551032SValentin Clement constRows = seqTy.getConstantRows(); 14801f551032SValentin Clement } 14811f551032SValentin Clement } 14821f551032SValentin Clement 14831f551032SValentin Clement bool hasSubcomp = !xbox.subcomponent().empty(); 14841f551032SValentin Clement mlir::Value stepExpr; 14851f551032SValentin Clement if (hasSubcomp) { 14861f551032SValentin Clement // We have a subcomponent. The step value needs to be the number of 14871f551032SValentin Clement // bytes per element (which is a derived type). 14881f551032SValentin Clement mlir::Type ty0 = base.getType(); 14891f551032SValentin Clement [[maybe_unused]] auto ptrTy = ty0.dyn_cast<mlir::LLVM::LLVMPointerType>(); 14901f551032SValentin Clement assert(ptrTy && "expected pointer type"); 14911f551032SValentin Clement mlir::Type memEleTy = fir::dyn_cast_ptrEleTy(xbox.memref().getType()); 14921f551032SValentin Clement assert(memEleTy && "expected fir pointer type"); 14931f551032SValentin Clement auto seqTy = memEleTy.dyn_cast<fir::SequenceType>(); 14941f551032SValentin Clement assert(seqTy && "expected sequence type"); 14951f551032SValentin Clement mlir::Type seqEleTy = seqTy.getEleTy(); 14961f551032SValentin Clement auto eleTy = mlir::LLVM::LLVMPointerType::get(convertType(seqEleTy)); 14971f551032SValentin Clement stepExpr = computeDerivedTypeSize(loc, eleTy, i64Ty, rewriter); 14981f551032SValentin Clement } 14991f551032SValentin Clement 15001f551032SValentin Clement // Process the array subspace arguments (shape, shift, etc.), if any, 15011f551032SValentin Clement // translating everything to values in the descriptor wherever the entity 15021f551032SValentin Clement // has a dynamic array dimension. 15031f551032SValentin Clement for (unsigned di = 0, descIdx = 0; di < rank; ++di) { 15041f551032SValentin Clement mlir::Value extent = operands[shapeOffset]; 15051f551032SValentin Clement mlir::Value outerExtent = extent; 15061f551032SValentin Clement bool skipNext = false; 15071f551032SValentin Clement if (hasSlice) { 15081f551032SValentin Clement mlir::Value off = operands[sliceOffset]; 15091f551032SValentin Clement mlir::Value adj = one; 15101f551032SValentin Clement if (hasShift) 15111f551032SValentin Clement adj = operands[shiftOffset]; 15121f551032SValentin Clement auto ao = rewriter.create<mlir::LLVM::SubOp>(loc, i64Ty, off, adj); 15131f551032SValentin Clement if (constRows > 0) { 15141f551032SValentin Clement gepArgs.push_back(ao); 15151f551032SValentin Clement --constRows; 15161f551032SValentin Clement } else { 15171f551032SValentin Clement auto dimOff = 15181f551032SValentin Clement rewriter.create<mlir::LLVM::MulOp>(loc, i64Ty, ao, prevPtrOff); 15191f551032SValentin Clement ptrOffset = 15201f551032SValentin Clement rewriter.create<mlir::LLVM::AddOp>(loc, i64Ty, dimOff, ptrOffset); 15211f551032SValentin Clement } 15221f551032SValentin Clement if (mlir::isa_and_nonnull<fir::UndefOp>( 15231f551032SValentin Clement xbox.slice()[3 * di + 1].getDefiningOp())) { 15241f551032SValentin Clement // This dimension contains a scalar expression in the array slice op. 15251f551032SValentin Clement // The dimension is loop invariant, will be dropped, and will not 15261f551032SValentin Clement // appear in the descriptor. 15271f551032SValentin Clement skipNext = true; 15281f551032SValentin Clement } 15291f551032SValentin Clement } 15301f551032SValentin Clement if (!skipNext) { 15311f551032SValentin Clement // store lower bound (normally 0) 15321f551032SValentin Clement mlir::Value lb = zero; 15331f551032SValentin Clement if (eleTy.isa<fir::PointerType>() || eleTy.isa<fir::HeapType>()) { 15341f551032SValentin Clement lb = one; 15351f551032SValentin Clement if (hasShift) 15361f551032SValentin Clement lb = operands[shiftOffset]; 15371f551032SValentin Clement } 15381f551032SValentin Clement dest = insertLowerBound(rewriter, loc, dest, descIdx, lb); 15391f551032SValentin Clement 15401f551032SValentin Clement // store extent 15411f551032SValentin Clement if (hasSlice) 15421f551032SValentin Clement extent = computeTripletExtent(rewriter, loc, operands[sliceOffset], 15431f551032SValentin Clement operands[sliceOffset + 1], 15441f551032SValentin Clement operands[sliceOffset + 2], zero, i64Ty); 15451f551032SValentin Clement dest = insertExtent(rewriter, loc, dest, descIdx, extent); 15461f551032SValentin Clement 15471f551032SValentin Clement // store step (scaled by shaped extent) 15481f551032SValentin Clement 15491f551032SValentin Clement mlir::Value step = hasSubcomp ? stepExpr : prevDim; 15501f551032SValentin Clement if (hasSlice) 15511f551032SValentin Clement step = rewriter.create<mlir::LLVM::MulOp>(loc, i64Ty, step, 15521f551032SValentin Clement operands[sliceOffset + 2]); 15531f551032SValentin Clement dest = insertStride(rewriter, loc, dest, descIdx, step); 15541f551032SValentin Clement ++descIdx; 15551f551032SValentin Clement } 15561f551032SValentin Clement 15571f551032SValentin Clement // compute the stride and offset for the next natural dimension 15581f551032SValentin Clement prevDim = 15591f551032SValentin Clement rewriter.create<mlir::LLVM::MulOp>(loc, i64Ty, prevDim, outerExtent); 15601f551032SValentin Clement if (constRows == 0) 15611f551032SValentin Clement prevPtrOff = rewriter.create<mlir::LLVM::MulOp>(loc, i64Ty, prevPtrOff, 15621f551032SValentin Clement outerExtent); 15631f551032SValentin Clement 15641f551032SValentin Clement // increment iterators 15651f551032SValentin Clement ++shapeOffset; 15661f551032SValentin Clement if (hasShift) 15671f551032SValentin Clement ++shiftOffset; 15681f551032SValentin Clement if (hasSlice) 15691f551032SValentin Clement sliceOffset += 3; 15701f551032SValentin Clement } 15711f551032SValentin Clement if (hasSlice || hasSubcomp || !xbox.substr().empty()) { 157230122656SAlex Zinenko llvm::SmallVector<mlir::Value> args = {ptrOffset}; 15731f551032SValentin Clement args.append(gepArgs.rbegin(), gepArgs.rend()); 15741f551032SValentin Clement if (hasSubcomp) { 15751f551032SValentin Clement // For each field in the path add the offset to base via the args list. 15761f551032SValentin Clement // In the most general case, some offsets must be computed since 15771f551032SValentin Clement // they are not be known until runtime. 15781f551032SValentin Clement if (fir::hasDynamicSize(fir::unwrapSequenceType( 15791f551032SValentin Clement fir::unwrapPassByRefType(xbox.memref().getType())))) 15801f551032SValentin Clement TODO(loc, "fir.embox codegen dynamic size component in derived type"); 15811f551032SValentin Clement args.append(operands.begin() + xbox.subcomponentOffset(), 15821f551032SValentin Clement operands.begin() + xbox.subcomponentOffset() + 15831f551032SValentin Clement xbox.subcomponent().size()); 15841f551032SValentin Clement } 158530122656SAlex Zinenko base = 158630122656SAlex Zinenko rewriter.create<mlir::LLVM::GEPOp>(loc, base.getType(), base, args); 15871f551032SValentin Clement if (!xbox.substr().empty()) 15881f551032SValentin Clement base = shiftSubstringBase(rewriter, loc, base, 15891f551032SValentin Clement operands[xbox.substrOffset()]); 15901f551032SValentin Clement } 15911f551032SValentin Clement dest = insertBaseAddress(rewriter, loc, dest, base); 15921f551032SValentin Clement if (isDerivedTypeWithLenParams(boxTy)) 15931f551032SValentin Clement TODO(loc, "fir.embox codegen of derived with length parameters"); 15941f551032SValentin Clement 15951f551032SValentin Clement mlir::Value result = placeInMemoryIfNotGlobalInit(rewriter, loc, dest); 15961f551032SValentin Clement rewriter.replaceOp(xbox, result); 15971f551032SValentin Clement return success(); 15981f551032SValentin Clement } 15991f551032SValentin Clement }; 16001f551032SValentin Clement 1601fa517555SKiran Chandramohan /// Create a new box given a box reference. 1602fa517555SKiran Chandramohan struct XReboxOpConversion : public EmboxCommonConversion<fir::cg::XReboxOp> { 1603fa517555SKiran Chandramohan using EmboxCommonConversion::EmboxCommonConversion; 1604fa517555SKiran Chandramohan 1605fa517555SKiran Chandramohan mlir::LogicalResult 1606fa517555SKiran Chandramohan matchAndRewrite(fir::cg::XReboxOp rebox, OpAdaptor adaptor, 1607fa517555SKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 1608fa517555SKiran Chandramohan mlir::Location loc = rebox.getLoc(); 1609fa517555SKiran Chandramohan mlir::Type idxTy = lowerTy().indexType(); 1610fa517555SKiran Chandramohan mlir::Value loweredBox = adaptor.getOperands()[0]; 1611fa517555SKiran Chandramohan mlir::ValueRange operands = adaptor.getOperands(); 1612fa517555SKiran Chandramohan 1613fa517555SKiran Chandramohan // Create new descriptor and fill its non-shape related data. 1614fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value, 2> lenParams; 1615fa517555SKiran Chandramohan mlir::Type inputEleTy = getInputEleTy(rebox); 1616fa517555SKiran Chandramohan if (auto charTy = inputEleTy.dyn_cast<fir::CharacterType>()) { 1617fa517555SKiran Chandramohan mlir::Value len = 1618fa517555SKiran Chandramohan loadElementSizeFromBox(loc, idxTy, loweredBox, rewriter); 1619fa517555SKiran Chandramohan if (charTy.getFKind() != 1) { 1620fa517555SKiran Chandramohan mlir::Value width = 1621fa517555SKiran Chandramohan genConstantIndex(loc, idxTy, rewriter, charTy.getFKind()); 1622fa517555SKiran Chandramohan len = rewriter.create<mlir::LLVM::SDivOp>(loc, idxTy, len, width); 1623fa517555SKiran Chandramohan } 1624fa517555SKiran Chandramohan lenParams.emplace_back(len); 1625fa517555SKiran Chandramohan } else if (auto recTy = inputEleTy.dyn_cast<fir::RecordType>()) { 1626fa517555SKiran Chandramohan if (recTy.getNumLenParams() != 0) 1627fa517555SKiran Chandramohan TODO(loc, "reboxing descriptor of derived type with length parameters"); 1628fa517555SKiran Chandramohan } 1629fa517555SKiran Chandramohan auto [boxTy, dest, eleSize] = 1630fa517555SKiran Chandramohan consDescriptorPrefix(rebox, rewriter, rebox.getOutRank(), lenParams); 1631fa517555SKiran Chandramohan 1632fa517555SKiran Chandramohan // Read input extents, strides, and base address 1633fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> inputExtents; 1634fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> inputStrides; 1635fa517555SKiran Chandramohan const unsigned inputRank = rebox.getRank(); 1636fa517555SKiran Chandramohan for (unsigned i = 0; i < inputRank; ++i) { 1637fa517555SKiran Chandramohan mlir::Value dim = genConstantIndex(loc, idxTy, rewriter, i); 1638fa517555SKiran Chandramohan SmallVector<mlir::Value, 3> dimInfo = 1639fa517555SKiran Chandramohan getDimsFromBox(loc, {idxTy, idxTy, idxTy}, loweredBox, dim, rewriter); 1640fa517555SKiran Chandramohan inputExtents.emplace_back(dimInfo[1]); 1641fa517555SKiran Chandramohan inputStrides.emplace_back(dimInfo[2]); 1642fa517555SKiran Chandramohan } 1643fa517555SKiran Chandramohan 1644fa517555SKiran Chandramohan mlir::Type baseTy = getBaseAddrTypeFromBox(loweredBox.getType()); 1645fa517555SKiran Chandramohan mlir::Value baseAddr = 1646fa517555SKiran Chandramohan loadBaseAddrFromBox(loc, baseTy, loweredBox, rewriter); 1647fa517555SKiran Chandramohan 1648fa517555SKiran Chandramohan if (!rebox.slice().empty() || !rebox.subcomponent().empty()) 1649fa517555SKiran Chandramohan return sliceBox(rebox, dest, baseAddr, inputExtents, inputStrides, 1650fa517555SKiran Chandramohan operands, rewriter); 1651fa517555SKiran Chandramohan return reshapeBox(rebox, dest, baseAddr, inputExtents, inputStrides, 1652fa517555SKiran Chandramohan operands, rewriter); 1653fa517555SKiran Chandramohan } 1654fa517555SKiran Chandramohan 1655fa517555SKiran Chandramohan private: 1656fa517555SKiran Chandramohan /// Write resulting shape and base address in descriptor, and replace rebox 1657fa517555SKiran Chandramohan /// op. 1658fa517555SKiran Chandramohan mlir::LogicalResult 1659fa517555SKiran Chandramohan finalizeRebox(fir::cg::XReboxOp rebox, mlir::Value dest, mlir::Value base, 1660fa517555SKiran Chandramohan mlir::ValueRange lbounds, mlir::ValueRange extents, 1661fa517555SKiran Chandramohan mlir::ValueRange strides, 1662fa517555SKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const { 1663fa517555SKiran Chandramohan mlir::Location loc = rebox.getLoc(); 1664fa517555SKiran Chandramohan mlir::Value one = genConstantIndex(loc, lowerTy().indexType(), rewriter, 1); 1665fa517555SKiran Chandramohan for (auto iter : llvm::enumerate(llvm::zip(extents, strides))) { 1666fa517555SKiran Chandramohan unsigned dim = iter.index(); 1667fa517555SKiran Chandramohan mlir::Value lb = lbounds.empty() ? one : lbounds[dim]; 1668fa517555SKiran Chandramohan dest = insertLowerBound(rewriter, loc, dest, dim, lb); 1669fa517555SKiran Chandramohan dest = insertExtent(rewriter, loc, dest, dim, std::get<0>(iter.value())); 1670fa517555SKiran Chandramohan dest = insertStride(rewriter, loc, dest, dim, std::get<1>(iter.value())); 1671fa517555SKiran Chandramohan } 1672fa517555SKiran Chandramohan dest = insertBaseAddress(rewriter, loc, dest, base); 1673fa517555SKiran Chandramohan mlir::Value result = 1674fa517555SKiran Chandramohan placeInMemoryIfNotGlobalInit(rewriter, rebox.getLoc(), dest); 1675fa517555SKiran Chandramohan rewriter.replaceOp(rebox, result); 1676fa517555SKiran Chandramohan return success(); 1677fa517555SKiran Chandramohan } 1678fa517555SKiran Chandramohan 1679fa517555SKiran Chandramohan // Apply slice given the base address, extents and strides of the input box. 1680fa517555SKiran Chandramohan mlir::LogicalResult 1681fa517555SKiran Chandramohan sliceBox(fir::cg::XReboxOp rebox, mlir::Value dest, mlir::Value base, 1682fa517555SKiran Chandramohan mlir::ValueRange inputExtents, mlir::ValueRange inputStrides, 1683fa517555SKiran Chandramohan mlir::ValueRange operands, 1684fa517555SKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const { 1685fa517555SKiran Chandramohan mlir::Location loc = rebox.getLoc(); 1686fa517555SKiran Chandramohan mlir::Type voidPtrTy = ::getVoidPtrType(rebox.getContext()); 1687fa517555SKiran Chandramohan mlir::Type idxTy = lowerTy().indexType(); 1688fa517555SKiran Chandramohan mlir::Value zero = genConstantIndex(loc, idxTy, rewriter, 0); 1689fa517555SKiran Chandramohan // Apply subcomponent and substring shift on base address. 1690fa517555SKiran Chandramohan if (!rebox.subcomponent().empty() || !rebox.substr().empty()) { 1691fa517555SKiran Chandramohan // Cast to inputEleTy* so that a GEP can be used. 1692fa517555SKiran Chandramohan mlir::Type inputEleTy = getInputEleTy(rebox); 1693fa517555SKiran Chandramohan auto llvmElePtrTy = 1694fa517555SKiran Chandramohan mlir::LLVM::LLVMPointerType::get(convertType(inputEleTy)); 1695fa517555SKiran Chandramohan base = rewriter.create<mlir::LLVM::BitcastOp>(loc, llvmElePtrTy, base); 1696fa517555SKiran Chandramohan 1697fa517555SKiran Chandramohan if (!rebox.subcomponent().empty()) { 1698fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> gepOperands = {zero}; 1699fa517555SKiran Chandramohan for (unsigned i = 0; i < rebox.subcomponent().size(); ++i) 1700fa517555SKiran Chandramohan gepOperands.push_back(operands[rebox.subcomponentOffset() + i]); 1701fa517555SKiran Chandramohan base = genGEP(loc, llvmElePtrTy, rewriter, base, gepOperands); 1702fa517555SKiran Chandramohan } 1703fa517555SKiran Chandramohan if (!rebox.substr().empty()) 1704fa517555SKiran Chandramohan base = shiftSubstringBase(rewriter, loc, base, 1705fa517555SKiran Chandramohan operands[rebox.substrOffset()]); 1706fa517555SKiran Chandramohan } 1707fa517555SKiran Chandramohan 1708fa517555SKiran Chandramohan if (rebox.slice().empty()) 1709fa517555SKiran Chandramohan // The array section is of the form array[%component][substring], keep 1710fa517555SKiran Chandramohan // the input array extents and strides. 1711fa517555SKiran Chandramohan return finalizeRebox(rebox, dest, base, /*lbounds*/ llvm::None, 1712fa517555SKiran Chandramohan inputExtents, inputStrides, rewriter); 1713fa517555SKiran Chandramohan 1714fa517555SKiran Chandramohan // Strides from the fir.box are in bytes. 1715fa517555SKiran Chandramohan base = rewriter.create<mlir::LLVM::BitcastOp>(loc, voidPtrTy, base); 1716fa517555SKiran Chandramohan 1717fa517555SKiran Chandramohan // The slice is of the form array(i:j:k)[%component]. Compute new extents 1718fa517555SKiran Chandramohan // and strides. 1719fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> slicedExtents; 1720fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> slicedStrides; 1721fa517555SKiran Chandramohan mlir::Value one = genConstantIndex(loc, idxTy, rewriter, 1); 1722fa517555SKiran Chandramohan const bool sliceHasOrigins = !rebox.shift().empty(); 1723fa517555SKiran Chandramohan unsigned sliceOps = rebox.sliceOffset(); 1724fa517555SKiran Chandramohan unsigned shiftOps = rebox.shiftOffset(); 1725fa517555SKiran Chandramohan auto strideOps = inputStrides.begin(); 1726fa517555SKiran Chandramohan const unsigned inputRank = inputStrides.size(); 1727fa517555SKiran Chandramohan for (unsigned i = 0; i < inputRank; 1728fa517555SKiran Chandramohan ++i, ++strideOps, ++shiftOps, sliceOps += 3) { 1729fa517555SKiran Chandramohan mlir::Value sliceLb = 1730fa517555SKiran Chandramohan integerCast(loc, rewriter, idxTy, operands[sliceOps]); 1731fa517555SKiran Chandramohan mlir::Value inputStride = *strideOps; // already idxTy 1732fa517555SKiran Chandramohan // Apply origin shift: base += (lb-shift)*input_stride 1733fa517555SKiran Chandramohan mlir::Value sliceOrigin = 1734fa517555SKiran Chandramohan sliceHasOrigins 1735fa517555SKiran Chandramohan ? integerCast(loc, rewriter, idxTy, operands[shiftOps]) 1736fa517555SKiran Chandramohan : one; 1737fa517555SKiran Chandramohan mlir::Value diff = 1738fa517555SKiran Chandramohan rewriter.create<mlir::LLVM::SubOp>(loc, idxTy, sliceLb, sliceOrigin); 1739fa517555SKiran Chandramohan mlir::Value offset = 1740fa517555SKiran Chandramohan rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, diff, inputStride); 1741fa517555SKiran Chandramohan base = genGEP(loc, voidPtrTy, rewriter, base, offset); 1742fa517555SKiran Chandramohan // Apply upper bound and step if this is a triplet. Otherwise, the 1743fa517555SKiran Chandramohan // dimension is dropped and no extents/strides are computed. 1744fa517555SKiran Chandramohan mlir::Value upper = operands[sliceOps + 1]; 1745fa517555SKiran Chandramohan const bool isTripletSlice = 1746fa517555SKiran Chandramohan !mlir::isa_and_nonnull<mlir::LLVM::UndefOp>(upper.getDefiningOp()); 1747fa517555SKiran Chandramohan if (isTripletSlice) { 1748fa517555SKiran Chandramohan mlir::Value step = 1749fa517555SKiran Chandramohan integerCast(loc, rewriter, idxTy, operands[sliceOps + 2]); 1750fa517555SKiran Chandramohan // extent = ub-lb+step/step 1751fa517555SKiran Chandramohan mlir::Value sliceUb = integerCast(loc, rewriter, idxTy, upper); 1752fa517555SKiran Chandramohan mlir::Value extent = computeTripletExtent(rewriter, loc, sliceLb, 1753fa517555SKiran Chandramohan sliceUb, step, zero, idxTy); 1754fa517555SKiran Chandramohan slicedExtents.emplace_back(extent); 1755fa517555SKiran Chandramohan // stride = step*input_stride 1756fa517555SKiran Chandramohan mlir::Value stride = 1757fa517555SKiran Chandramohan rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, step, inputStride); 1758fa517555SKiran Chandramohan slicedStrides.emplace_back(stride); 1759fa517555SKiran Chandramohan } 1760fa517555SKiran Chandramohan } 1761fa517555SKiran Chandramohan return finalizeRebox(rebox, dest, base, /*lbounds*/ llvm::None, 1762fa517555SKiran Chandramohan slicedExtents, slicedStrides, rewriter); 1763fa517555SKiran Chandramohan } 1764fa517555SKiran Chandramohan 1765fa517555SKiran Chandramohan /// Apply a new shape to the data described by a box given the base address, 1766fa517555SKiran Chandramohan /// extents and strides of the box. 1767fa517555SKiran Chandramohan mlir::LogicalResult 1768fa517555SKiran Chandramohan reshapeBox(fir::cg::XReboxOp rebox, mlir::Value dest, mlir::Value base, 1769fa517555SKiran Chandramohan mlir::ValueRange inputExtents, mlir::ValueRange inputStrides, 1770fa517555SKiran Chandramohan mlir::ValueRange operands, 1771fa517555SKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const { 1772fa517555SKiran Chandramohan mlir::ValueRange reboxShifts{operands.begin() + rebox.shiftOffset(), 1773fa517555SKiran Chandramohan operands.begin() + rebox.shiftOffset() + 1774fa517555SKiran Chandramohan rebox.shift().size()}; 1775fa517555SKiran Chandramohan if (rebox.shape().empty()) { 1776fa517555SKiran Chandramohan // Only setting new lower bounds. 1777fa517555SKiran Chandramohan return finalizeRebox(rebox, dest, base, reboxShifts, inputExtents, 1778fa517555SKiran Chandramohan inputStrides, rewriter); 1779fa517555SKiran Chandramohan } 1780fa517555SKiran Chandramohan 1781fa517555SKiran Chandramohan mlir::Location loc = rebox.getLoc(); 1782fa517555SKiran Chandramohan // Strides from the fir.box are in bytes. 1783fa517555SKiran Chandramohan mlir::Type voidPtrTy = ::getVoidPtrType(rebox.getContext()); 1784fa517555SKiran Chandramohan base = rewriter.create<mlir::LLVM::BitcastOp>(loc, voidPtrTy, base); 1785fa517555SKiran Chandramohan 1786fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> newStrides; 1787fa517555SKiran Chandramohan llvm::SmallVector<mlir::Value> newExtents; 1788fa517555SKiran Chandramohan mlir::Type idxTy = lowerTy().indexType(); 1789fa517555SKiran Chandramohan // First stride from input box is kept. The rest is assumed contiguous 1790fa517555SKiran Chandramohan // (it is not possible to reshape otherwise). If the input is scalar, 1791fa517555SKiran Chandramohan // which may be OK if all new extents are ones, the stride does not 1792fa517555SKiran Chandramohan // matter, use one. 1793fa517555SKiran Chandramohan mlir::Value stride = inputStrides.empty() 1794fa517555SKiran Chandramohan ? genConstantIndex(loc, idxTy, rewriter, 1) 1795fa517555SKiran Chandramohan : inputStrides[0]; 1796fa517555SKiran Chandramohan for (unsigned i = 0; i < rebox.shape().size(); ++i) { 1797fa517555SKiran Chandramohan mlir::Value rawExtent = operands[rebox.shapeOffset() + i]; 1798fa517555SKiran Chandramohan mlir::Value extent = integerCast(loc, rewriter, idxTy, rawExtent); 1799fa517555SKiran Chandramohan newExtents.emplace_back(extent); 1800fa517555SKiran Chandramohan newStrides.emplace_back(stride); 1801fa517555SKiran Chandramohan // nextStride = extent * stride; 1802fa517555SKiran Chandramohan stride = rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, extent, stride); 1803fa517555SKiran Chandramohan } 1804fa517555SKiran Chandramohan return finalizeRebox(rebox, dest, base, reboxShifts, newExtents, newStrides, 1805fa517555SKiran Chandramohan rewriter); 1806fa517555SKiran Chandramohan } 1807fa517555SKiran Chandramohan 1808fa517555SKiran Chandramohan /// Return scalar element type of the input box. 1809fa517555SKiran Chandramohan static mlir::Type getInputEleTy(fir::cg::XReboxOp rebox) { 1810fa517555SKiran Chandramohan auto ty = fir::dyn_cast_ptrOrBoxEleTy(rebox.box().getType()); 1811fa517555SKiran Chandramohan if (auto seqTy = ty.dyn_cast<fir::SequenceType>()) 1812fa517555SKiran Chandramohan return seqTy.getEleTy(); 1813fa517555SKiran Chandramohan return ty; 1814fa517555SKiran Chandramohan } 1815fa517555SKiran Chandramohan }; 1816fa517555SKiran Chandramohan 1817dc48849fSKiran Chandramohan /// Lower `fir.emboxproc` operation. Creates a procedure box. 1818dc48849fSKiran Chandramohan /// TODO: Part of supporting Fortran 2003 procedure pointers. 1819dc48849fSKiran Chandramohan struct EmboxProcOpConversion : public FIROpConversion<fir::EmboxProcOp> { 1820dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 1821dc48849fSKiran Chandramohan 1822dc48849fSKiran Chandramohan mlir::LogicalResult 1823dc48849fSKiran Chandramohan matchAndRewrite(fir::EmboxProcOp emboxproc, OpAdaptor adaptor, 1824dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 1825dc48849fSKiran Chandramohan TODO(emboxproc.getLoc(), "fir.emboxproc codegen"); 1826dc48849fSKiran Chandramohan return failure(); 1827dc48849fSKiran Chandramohan } 1828dc48849fSKiran Chandramohan }; 1829dc48849fSKiran Chandramohan 183054c56347SValentin Clement // Code shared between insert_value and extract_value Ops. 183154c56347SValentin Clement struct ValueOpCommon { 183254c56347SValentin Clement // Translate the arguments pertaining to any multidimensional array to 183354c56347SValentin Clement // row-major order for LLVM-IR. 183454c56347SValentin Clement static void toRowMajor(SmallVectorImpl<mlir::Attribute> &attrs, 183554c56347SValentin Clement mlir::Type ty) { 183654c56347SValentin Clement assert(ty && "type is null"); 183754c56347SValentin Clement const auto end = attrs.size(); 183854c56347SValentin Clement for (std::remove_const_t<decltype(end)> i = 0; i < end; ++i) { 183954c56347SValentin Clement if (auto seq = ty.dyn_cast<mlir::LLVM::LLVMArrayType>()) { 184054c56347SValentin Clement const auto dim = getDimension(seq); 184154c56347SValentin Clement if (dim > 1) { 184254c56347SValentin Clement auto ub = std::min(i + dim, end); 184354c56347SValentin Clement std::reverse(attrs.begin() + i, attrs.begin() + ub); 184454c56347SValentin Clement i += dim - 1; 184554c56347SValentin Clement } 184654c56347SValentin Clement ty = getArrayElementType(seq); 184754c56347SValentin Clement } else if (auto st = ty.dyn_cast<mlir::LLVM::LLVMStructType>()) { 184854c56347SValentin Clement ty = st.getBody()[attrs[i].cast<mlir::IntegerAttr>().getInt()]; 184954c56347SValentin Clement } else { 185054c56347SValentin Clement llvm_unreachable("index into invalid type"); 185154c56347SValentin Clement } 185254c56347SValentin Clement } 185354c56347SValentin Clement } 185454c56347SValentin Clement 185554c56347SValentin Clement static llvm::SmallVector<mlir::Attribute> 185654c56347SValentin Clement collectIndices(mlir::ConversionPatternRewriter &rewriter, 185754c56347SValentin Clement mlir::ArrayAttr arrAttr) { 185854c56347SValentin Clement llvm::SmallVector<mlir::Attribute> attrs; 185954c56347SValentin Clement for (auto i = arrAttr.begin(), e = arrAttr.end(); i != e; ++i) { 186054c56347SValentin Clement if (i->isa<mlir::IntegerAttr>()) { 186154c56347SValentin Clement attrs.push_back(*i); 186254c56347SValentin Clement } else { 186354c56347SValentin Clement auto fieldName = i->cast<mlir::StringAttr>().getValue(); 186454c56347SValentin Clement ++i; 186554c56347SValentin Clement auto ty = i->cast<mlir::TypeAttr>().getValue(); 186654c56347SValentin Clement auto index = ty.cast<fir::RecordType>().getFieldIndex(fieldName); 186754c56347SValentin Clement attrs.push_back(mlir::IntegerAttr::get(rewriter.getI32Type(), index)); 186854c56347SValentin Clement } 186954c56347SValentin Clement } 187054c56347SValentin Clement return attrs; 187154c56347SValentin Clement } 187254c56347SValentin Clement 187354c56347SValentin Clement private: 187454c56347SValentin Clement static unsigned getDimension(mlir::LLVM::LLVMArrayType ty) { 187554c56347SValentin Clement unsigned result = 1; 187654c56347SValentin Clement for (auto eleTy = ty.getElementType().dyn_cast<mlir::LLVM::LLVMArrayType>(); 187754c56347SValentin Clement eleTy; 187854c56347SValentin Clement eleTy = eleTy.getElementType().dyn_cast<mlir::LLVM::LLVMArrayType>()) 187954c56347SValentin Clement ++result; 188054c56347SValentin Clement return result; 188154c56347SValentin Clement } 188254c56347SValentin Clement 188354c56347SValentin Clement static mlir::Type getArrayElementType(mlir::LLVM::LLVMArrayType ty) { 188454c56347SValentin Clement auto eleTy = ty.getElementType(); 188554c56347SValentin Clement while (auto arrTy = eleTy.dyn_cast<mlir::LLVM::LLVMArrayType>()) 188654c56347SValentin Clement eleTy = arrTy.getElementType(); 188754c56347SValentin Clement return eleTy; 188854c56347SValentin Clement } 188954c56347SValentin Clement }; 189054c56347SValentin Clement 1891c2acd453SAlexisPerry namespace { 189254c56347SValentin Clement /// Extract a subobject value from an ssa-value of aggregate type 189354c56347SValentin Clement struct ExtractValueOpConversion 189454c56347SValentin Clement : public FIROpAndTypeConversion<fir::ExtractValueOp>, 189554c56347SValentin Clement public ValueOpCommon { 189654c56347SValentin Clement using FIROpAndTypeConversion::FIROpAndTypeConversion; 189754c56347SValentin Clement 189854c56347SValentin Clement mlir::LogicalResult 189954c56347SValentin Clement doRewrite(fir::ExtractValueOp extractVal, mlir::Type ty, OpAdaptor adaptor, 190054c56347SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 1901149ad3d5SShraiysh Vaishay auto attrs = collectIndices(rewriter, extractVal.getCoor()); 190254c56347SValentin Clement toRowMajor(attrs, adaptor.getOperands()[0].getType()); 190354c56347SValentin Clement auto position = mlir::ArrayAttr::get(extractVal.getContext(), attrs); 190454c56347SValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::ExtractValueOp>( 190554c56347SValentin Clement extractVal, ty, adaptor.getOperands()[0], position); 190654c56347SValentin Clement return success(); 190754c56347SValentin Clement } 190854c56347SValentin Clement }; 190954c56347SValentin Clement 191054c56347SValentin Clement /// InsertValue is the generalized instruction for the composition of new 191154c56347SValentin Clement /// aggregate type values. 191254c56347SValentin Clement struct InsertValueOpConversion 191354c56347SValentin Clement : public FIROpAndTypeConversion<fir::InsertValueOp>, 191454c56347SValentin Clement public ValueOpCommon { 191554c56347SValentin Clement using FIROpAndTypeConversion::FIROpAndTypeConversion; 191654c56347SValentin Clement 191754c56347SValentin Clement mlir::LogicalResult 191854c56347SValentin Clement doRewrite(fir::InsertValueOp insertVal, mlir::Type ty, OpAdaptor adaptor, 191954c56347SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 1920149ad3d5SShraiysh Vaishay auto attrs = collectIndices(rewriter, insertVal.getCoor()); 192154c56347SValentin Clement toRowMajor(attrs, adaptor.getOperands()[0].getType()); 192254c56347SValentin Clement auto position = mlir::ArrayAttr::get(insertVal.getContext(), attrs); 192354c56347SValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>( 192454c56347SValentin Clement insertVal, ty, adaptor.getOperands()[0], adaptor.getOperands()[1], 192554c56347SValentin Clement position); 192654c56347SValentin Clement return success(); 192754c56347SValentin Clement } 192854c56347SValentin Clement }; 192954c56347SValentin Clement 19303ae8e442SValentin Clement /// InsertOnRange inserts a value into a sequence over a range of offsets. 19313ae8e442SValentin Clement struct InsertOnRangeOpConversion 19323ae8e442SValentin Clement : public FIROpAndTypeConversion<fir::InsertOnRangeOp> { 19333ae8e442SValentin Clement using FIROpAndTypeConversion::FIROpAndTypeConversion; 19343ae8e442SValentin Clement 19353ae8e442SValentin Clement // Increments an array of subscripts in a row major fasion. 19363ae8e442SValentin Clement void incrementSubscripts(const SmallVector<uint64_t> &dims, 19373ae8e442SValentin Clement SmallVector<uint64_t> &subscripts) const { 19383ae8e442SValentin Clement for (size_t i = dims.size(); i > 0; --i) { 19393ae8e442SValentin Clement if (++subscripts[i - 1] < dims[i - 1]) { 19403ae8e442SValentin Clement return; 19413ae8e442SValentin Clement } 19423ae8e442SValentin Clement subscripts[i - 1] = 0; 19433ae8e442SValentin Clement } 19443ae8e442SValentin Clement } 19453ae8e442SValentin Clement 19463ae8e442SValentin Clement mlir::LogicalResult 19473ae8e442SValentin Clement doRewrite(fir::InsertOnRangeOp range, mlir::Type ty, OpAdaptor adaptor, 19483ae8e442SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 19493ae8e442SValentin Clement 19503ae8e442SValentin Clement llvm::SmallVector<uint64_t> dims; 19513ae8e442SValentin Clement auto type = adaptor.getOperands()[0].getType(); 19523ae8e442SValentin Clement 19533ae8e442SValentin Clement // Iteratively extract the array dimensions from the type. 19543ae8e442SValentin Clement while (auto t = type.dyn_cast<mlir::LLVM::LLVMArrayType>()) { 19553ae8e442SValentin Clement dims.push_back(t.getNumElements()); 19563ae8e442SValentin Clement type = t.getElementType(); 19573ae8e442SValentin Clement } 19583ae8e442SValentin Clement 19593ae8e442SValentin Clement SmallVector<uint64_t> lBounds; 19603ae8e442SValentin Clement SmallVector<uint64_t> uBounds; 19613ae8e442SValentin Clement 19623ae8e442SValentin Clement // Unzip the upper and lower bound and convert to a row major format. 1963149ad3d5SShraiysh Vaishay mlir::DenseIntElementsAttr coor = range.getCoor(); 19648ec0f221SMehdi Amini auto reversedCoor = llvm::reverse(coor.getValues<int64_t>()); 19658ec0f221SMehdi Amini for (auto i = reversedCoor.begin(), e = reversedCoor.end(); i != e; ++i) { 19663ae8e442SValentin Clement uBounds.push_back(*i++); 19673ae8e442SValentin Clement lBounds.push_back(*i); 19683ae8e442SValentin Clement } 19693ae8e442SValentin Clement 19703ae8e442SValentin Clement auto &subscripts = lBounds; 19713ae8e442SValentin Clement auto loc = range.getLoc(); 19723ae8e442SValentin Clement mlir::Value lastOp = adaptor.getOperands()[0]; 19733ae8e442SValentin Clement mlir::Value insertVal = adaptor.getOperands()[1]; 19743ae8e442SValentin Clement 19753ae8e442SValentin Clement auto i64Ty = rewriter.getI64Type(); 19763ae8e442SValentin Clement while (subscripts != uBounds) { 19773ae8e442SValentin Clement // Convert uint64_t's to Attribute's. 19783ae8e442SValentin Clement SmallVector<mlir::Attribute> subscriptAttrs; 19793ae8e442SValentin Clement for (const auto &subscript : subscripts) 19803ae8e442SValentin Clement subscriptAttrs.push_back(IntegerAttr::get(i64Ty, subscript)); 19813ae8e442SValentin Clement lastOp = rewriter.create<mlir::LLVM::InsertValueOp>( 19823ae8e442SValentin Clement loc, ty, lastOp, insertVal, 19833ae8e442SValentin Clement ArrayAttr::get(range.getContext(), subscriptAttrs)); 19843ae8e442SValentin Clement 19853ae8e442SValentin Clement incrementSubscripts(dims, subscripts); 19863ae8e442SValentin Clement } 19873ae8e442SValentin Clement 19883ae8e442SValentin Clement // Convert uint64_t's to Attribute's. 19893ae8e442SValentin Clement SmallVector<mlir::Attribute> subscriptAttrs; 19903ae8e442SValentin Clement for (const auto &subscript : subscripts) 19913ae8e442SValentin Clement subscriptAttrs.push_back( 19923ae8e442SValentin Clement IntegerAttr::get(rewriter.getI64Type(), subscript)); 19933ae8e442SValentin Clement mlir::ArrayRef<mlir::Attribute> arrayRef(subscriptAttrs); 19943ae8e442SValentin Clement 19953ae8e442SValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>( 19963ae8e442SValentin Clement range, ty, lastOp, insertVal, 19973ae8e442SValentin Clement ArrayAttr::get(range.getContext(), arrayRef)); 19983ae8e442SValentin Clement 19993ae8e442SValentin Clement return success(); 20003ae8e442SValentin Clement } 20013ae8e442SValentin Clement }; 2002c2acd453SAlexisPerry } // namespace 20037b5132daSValentin Clement 2004dc48849fSKiran Chandramohan namespace { 20055d27abe6SValentin Clement /// XArrayCoor is the address arithmetic on a dynamically shaped, sliced, 20065d27abe6SValentin Clement /// shifted etc. array. 20075d27abe6SValentin Clement /// (See the static restriction on coordinate_of.) array_coor determines the 20085d27abe6SValentin Clement /// coordinate (location) of a specific element. 20095d27abe6SValentin Clement struct XArrayCoorOpConversion 20105d27abe6SValentin Clement : public FIROpAndTypeConversion<fir::cg::XArrayCoorOp> { 20115d27abe6SValentin Clement using FIROpAndTypeConversion::FIROpAndTypeConversion; 20125d27abe6SValentin Clement 20135d27abe6SValentin Clement mlir::LogicalResult 20145d27abe6SValentin Clement doRewrite(fir::cg::XArrayCoorOp coor, mlir::Type ty, OpAdaptor adaptor, 20155d27abe6SValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 20165d27abe6SValentin Clement auto loc = coor.getLoc(); 20175d27abe6SValentin Clement mlir::ValueRange operands = adaptor.getOperands(); 20185d27abe6SValentin Clement unsigned rank = coor.getRank(); 20195d27abe6SValentin Clement assert(coor.indices().size() == rank); 20205d27abe6SValentin Clement assert(coor.shape().empty() || coor.shape().size() == rank); 20215d27abe6SValentin Clement assert(coor.shift().empty() || coor.shift().size() == rank); 20225d27abe6SValentin Clement assert(coor.slice().empty() || coor.slice().size() == 3 * rank); 20235d27abe6SValentin Clement mlir::Type idxTy = lowerTy().indexType(); 20245d27abe6SValentin Clement mlir::Value one = genConstantIndex(loc, idxTy, rewriter, 1); 20255d27abe6SValentin Clement mlir::Value prevExt = one; 20265d27abe6SValentin Clement mlir::Value zero = genConstantIndex(loc, idxTy, rewriter, 0); 20275d27abe6SValentin Clement mlir::Value offset = zero; 20285d27abe6SValentin Clement const bool isShifted = !coor.shift().empty(); 20295d27abe6SValentin Clement const bool isSliced = !coor.slice().empty(); 20305d27abe6SValentin Clement const bool baseIsBoxed = coor.memref().getType().isa<fir::BoxType>(); 20315d27abe6SValentin Clement 20325d27abe6SValentin Clement auto indexOps = coor.indices().begin(); 20335d27abe6SValentin Clement auto shapeOps = coor.shape().begin(); 20345d27abe6SValentin Clement auto shiftOps = coor.shift().begin(); 20355d27abe6SValentin Clement auto sliceOps = coor.slice().begin(); 20365d27abe6SValentin Clement // For each dimension of the array, generate the offset calculation. 20375d27abe6SValentin Clement for (unsigned i = 0; i < rank; 20385d27abe6SValentin Clement ++i, ++indexOps, ++shapeOps, ++shiftOps, sliceOps += 3) { 20395d27abe6SValentin Clement mlir::Value index = 20405d27abe6SValentin Clement integerCast(loc, rewriter, idxTy, operands[coor.indicesOffset() + i]); 20415d27abe6SValentin Clement mlir::Value lb = isShifted ? integerCast(loc, rewriter, idxTy, 20425d27abe6SValentin Clement operands[coor.shiftOffset() + i]) 20435d27abe6SValentin Clement : one; 20445d27abe6SValentin Clement mlir::Value step = one; 20455d27abe6SValentin Clement bool normalSlice = isSliced; 20465d27abe6SValentin Clement // Compute zero based index in dimension i of the element, applying 20475d27abe6SValentin Clement // potential triplets and lower bounds. 20485d27abe6SValentin Clement if (isSliced) { 20495d27abe6SValentin Clement mlir::Value ub = *(sliceOps + 1); 20505d27abe6SValentin Clement normalSlice = !mlir::isa_and_nonnull<fir::UndefOp>(ub.getDefiningOp()); 20515d27abe6SValentin Clement if (normalSlice) 20525d27abe6SValentin Clement step = integerCast(loc, rewriter, idxTy, *(sliceOps + 2)); 20535d27abe6SValentin Clement } 20545d27abe6SValentin Clement auto idx = rewriter.create<mlir::LLVM::SubOp>(loc, idxTy, index, lb); 20555d27abe6SValentin Clement mlir::Value diff = 20565d27abe6SValentin Clement rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, idx, step); 20575d27abe6SValentin Clement if (normalSlice) { 20585d27abe6SValentin Clement mlir::Value sliceLb = 20595d27abe6SValentin Clement integerCast(loc, rewriter, idxTy, operands[coor.sliceOffset() + i]); 20605d27abe6SValentin Clement auto adj = rewriter.create<mlir::LLVM::SubOp>(loc, idxTy, sliceLb, lb); 20615d27abe6SValentin Clement diff = rewriter.create<mlir::LLVM::AddOp>(loc, idxTy, diff, adj); 20625d27abe6SValentin Clement } 20635d27abe6SValentin Clement // Update the offset given the stride and the zero based index `diff` 20645d27abe6SValentin Clement // that was just computed. 20655d27abe6SValentin Clement if (baseIsBoxed) { 20665d27abe6SValentin Clement // Use stride in bytes from the descriptor. 20675d27abe6SValentin Clement mlir::Value stride = 20685d27abe6SValentin Clement loadStrideFromBox(loc, adaptor.getOperands()[0], i, rewriter); 20695d27abe6SValentin Clement auto sc = rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, diff, stride); 20705d27abe6SValentin Clement offset = rewriter.create<mlir::LLVM::AddOp>(loc, idxTy, sc, offset); 20715d27abe6SValentin Clement } else { 20725d27abe6SValentin Clement // Use stride computed at last iteration. 20735d27abe6SValentin Clement auto sc = rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, diff, prevExt); 20745d27abe6SValentin Clement offset = rewriter.create<mlir::LLVM::AddOp>(loc, idxTy, sc, offset); 20755d27abe6SValentin Clement // Compute next stride assuming contiguity of the base array 20765d27abe6SValentin Clement // (in element number). 20775d27abe6SValentin Clement auto nextExt = 20785d27abe6SValentin Clement integerCast(loc, rewriter, idxTy, operands[coor.shapeOffset() + i]); 20795d27abe6SValentin Clement prevExt = 20805d27abe6SValentin Clement rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, prevExt, nextExt); 20815d27abe6SValentin Clement } 20825d27abe6SValentin Clement } 20835d27abe6SValentin Clement 20845d27abe6SValentin Clement // Add computed offset to the base address. 20855d27abe6SValentin Clement if (baseIsBoxed) { 20865d27abe6SValentin Clement // Working with byte offsets. The base address is read from the fir.box. 20875d27abe6SValentin Clement // and need to be casted to i8* to do the pointer arithmetic. 20885d27abe6SValentin Clement mlir::Type baseTy = 20895d27abe6SValentin Clement getBaseAddrTypeFromBox(adaptor.getOperands()[0].getType()); 20905d27abe6SValentin Clement mlir::Value base = 20915d27abe6SValentin Clement loadBaseAddrFromBox(loc, baseTy, adaptor.getOperands()[0], rewriter); 20925d27abe6SValentin Clement mlir::Type voidPtrTy = getVoidPtrType(); 20935d27abe6SValentin Clement base = rewriter.create<mlir::LLVM::BitcastOp>(loc, voidPtrTy, base); 209430122656SAlex Zinenko llvm::SmallVector<mlir::Value> args{offset}; 209530122656SAlex Zinenko auto addr = 209630122656SAlex Zinenko rewriter.create<mlir::LLVM::GEPOp>(loc, voidPtrTy, base, args); 20975d27abe6SValentin Clement if (coor.subcomponent().empty()) { 20985d27abe6SValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::BitcastOp>(coor, baseTy, addr); 20995d27abe6SValentin Clement return success(); 21005d27abe6SValentin Clement } 21015d27abe6SValentin Clement auto casted = rewriter.create<mlir::LLVM::BitcastOp>(loc, baseTy, addr); 21025d27abe6SValentin Clement args.clear(); 21035d27abe6SValentin Clement args.push_back(zero); 21045d27abe6SValentin Clement if (!coor.lenParams().empty()) { 21055d27abe6SValentin Clement // If type parameters are present, then we don't want to use a GEPOp 21065d27abe6SValentin Clement // as below, as the LLVM struct type cannot be statically defined. 21075d27abe6SValentin Clement TODO(loc, "derived type with type parameters"); 21085d27abe6SValentin Clement } 21095d27abe6SValentin Clement // TODO: array offset subcomponents must be converted to LLVM's 21105d27abe6SValentin Clement // row-major layout here. 21115d27abe6SValentin Clement for (auto i = coor.subcomponentOffset(); i != coor.indicesOffset(); ++i) 21125d27abe6SValentin Clement args.push_back(operands[i]); 211330122656SAlex Zinenko rewriter.replaceOpWithNewOp<mlir::LLVM::GEPOp>(coor, baseTy, casted, 211430122656SAlex Zinenko args); 21155d27abe6SValentin Clement return success(); 21165d27abe6SValentin Clement } 21175d27abe6SValentin Clement 21185d27abe6SValentin Clement // The array was not boxed, so it must be contiguous. offset is therefore an 21195d27abe6SValentin Clement // element offset and the base type is kept in the GEP unless the element 21205d27abe6SValentin Clement // type size is itself dynamic. 21215d27abe6SValentin Clement mlir::Value base; 21225d27abe6SValentin Clement if (coor.subcomponent().empty()) { 21235d27abe6SValentin Clement // No subcomponent. 21245d27abe6SValentin Clement if (!coor.lenParams().empty()) { 21255d27abe6SValentin Clement // Type parameters. Adjust element size explicitly. 21265d27abe6SValentin Clement auto eleTy = fir::dyn_cast_ptrEleTy(coor.getType()); 21275d27abe6SValentin Clement assert(eleTy && "result must be a reference-like type"); 21285d27abe6SValentin Clement if (fir::characterWithDynamicLen(eleTy)) { 21295d27abe6SValentin Clement assert(coor.lenParams().size() == 1); 21305d27abe6SValentin Clement auto bitsInChar = lowerTy().getKindMap().getCharacterBitsize( 21315d27abe6SValentin Clement eleTy.cast<fir::CharacterType>().getFKind()); 21325d27abe6SValentin Clement auto scaling = genConstantIndex(loc, idxTy, rewriter, bitsInChar / 8); 21335d27abe6SValentin Clement auto scaledBySize = 21345d27abe6SValentin Clement rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, offset, scaling); 21355d27abe6SValentin Clement auto length = 21365d27abe6SValentin Clement integerCast(loc, rewriter, idxTy, 21375d27abe6SValentin Clement adaptor.getOperands()[coor.lenParamsOffset()]); 21385d27abe6SValentin Clement offset = rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, scaledBySize, 21395d27abe6SValentin Clement length); 21405d27abe6SValentin Clement } else { 21415d27abe6SValentin Clement TODO(loc, "compute size of derived type with type parameters"); 21425d27abe6SValentin Clement } 21435d27abe6SValentin Clement } 21445d27abe6SValentin Clement // Cast the base address to a pointer to T. 21455d27abe6SValentin Clement base = rewriter.create<mlir::LLVM::BitcastOp>(loc, ty, 21465d27abe6SValentin Clement adaptor.getOperands()[0]); 21475d27abe6SValentin Clement } else { 21485d27abe6SValentin Clement // Operand #0 must have a pointer type. For subcomponent slicing, we 21495d27abe6SValentin Clement // want to cast away the array type and have a plain struct type. 21505d27abe6SValentin Clement mlir::Type ty0 = adaptor.getOperands()[0].getType(); 21515d27abe6SValentin Clement auto ptrTy = ty0.dyn_cast<mlir::LLVM::LLVMPointerType>(); 21525d27abe6SValentin Clement assert(ptrTy && "expected pointer type"); 21535d27abe6SValentin Clement mlir::Type eleTy = ptrTy.getElementType(); 21545d27abe6SValentin Clement while (auto arrTy = eleTy.dyn_cast<mlir::LLVM::LLVMArrayType>()) 21555d27abe6SValentin Clement eleTy = arrTy.getElementType(); 21565d27abe6SValentin Clement auto newTy = mlir::LLVM::LLVMPointerType::get(eleTy); 21575d27abe6SValentin Clement base = rewriter.create<mlir::LLVM::BitcastOp>(loc, newTy, 21585d27abe6SValentin Clement adaptor.getOperands()[0]); 21595d27abe6SValentin Clement } 216030122656SAlex Zinenko SmallVector<mlir::Value> args = {offset}; 21615d27abe6SValentin Clement for (auto i = coor.subcomponentOffset(); i != coor.indicesOffset(); ++i) 21625d27abe6SValentin Clement args.push_back(operands[i]); 216330122656SAlex Zinenko rewriter.replaceOpWithNewOp<mlir::LLVM::GEPOp>(coor, ty, base, args); 21645d27abe6SValentin Clement return success(); 21655d27abe6SValentin Clement } 21665d27abe6SValentin Clement }; 2167dc48849fSKiran Chandramohan } // namespace 2168dc48849fSKiran Chandramohan 2169dc48849fSKiran Chandramohan /// Convert to (memory) reference to a reference to a subobject. 2170dc48849fSKiran Chandramohan /// The coordinate_of op is a Swiss army knife operation that can be used on 2171dc48849fSKiran Chandramohan /// (memory) references to records, arrays, complex, etc. as well as boxes. 2172dc48849fSKiran Chandramohan /// With unboxed arrays, there is the restriction that the array have a static 2173dc48849fSKiran Chandramohan /// shape in all but the last column. 2174dc48849fSKiran Chandramohan struct CoordinateOpConversion 2175dc48849fSKiran Chandramohan : public FIROpAndTypeConversion<fir::CoordinateOp> { 2176dc48849fSKiran Chandramohan using FIROpAndTypeConversion::FIROpAndTypeConversion; 2177dc48849fSKiran Chandramohan 2178dc48849fSKiran Chandramohan mlir::LogicalResult 2179dc48849fSKiran Chandramohan doRewrite(fir::CoordinateOp coor, mlir::Type ty, OpAdaptor adaptor, 2180dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2181dc48849fSKiran Chandramohan mlir::ValueRange operands = adaptor.getOperands(); 2182dc48849fSKiran Chandramohan 2183dc48849fSKiran Chandramohan mlir::Location loc = coor.getLoc(); 2184dc48849fSKiran Chandramohan mlir::Value base = operands[0]; 2185dc48849fSKiran Chandramohan mlir::Type baseObjectTy = coor.getBaseType(); 2186dc48849fSKiran Chandramohan mlir::Type objectTy = fir::dyn_cast_ptrOrBoxEleTy(baseObjectTy); 2187dc48849fSKiran Chandramohan assert(objectTy && "fir.coordinate_of expects a reference type"); 2188dc48849fSKiran Chandramohan 2189dc48849fSKiran Chandramohan // Complex type - basically, extract the real or imaginary part 2190dc48849fSKiran Chandramohan if (fir::isa_complex(objectTy)) { 2191dc48849fSKiran Chandramohan mlir::LLVM::ConstantOp c0 = 2192dc48849fSKiran Chandramohan genConstantIndex(loc, lowerTy().indexType(), rewriter, 0); 2193dc48849fSKiran Chandramohan SmallVector<mlir::Value> offs = {c0, operands[1]}; 2194dc48849fSKiran Chandramohan mlir::Value gep = genGEP(loc, ty, rewriter, base, offs); 2195dc48849fSKiran Chandramohan rewriter.replaceOp(coor, gep); 2196dc48849fSKiran Chandramohan return success(); 2197dc48849fSKiran Chandramohan } 2198dc48849fSKiran Chandramohan 2199dc48849fSKiran Chandramohan // Boxed type - get the base pointer from the box 2200dc48849fSKiran Chandramohan if (baseObjectTy.dyn_cast<fir::BoxType>()) 2201dc48849fSKiran Chandramohan return doRewriteBox(coor, ty, operands, loc, rewriter); 2202dc48849fSKiran Chandramohan 2203dc48849fSKiran Chandramohan // Reference or pointer type 2204dc48849fSKiran Chandramohan if (baseObjectTy.isa<fir::ReferenceType, fir::PointerType>()) 2205dc48849fSKiran Chandramohan return doRewriteRefOrPtr(coor, ty, operands, loc, rewriter); 2206dc48849fSKiran Chandramohan 2207dc48849fSKiran Chandramohan return rewriter.notifyMatchFailure( 2208dc48849fSKiran Chandramohan coor, "fir.coordinate_of base operand has unsupported type"); 2209dc48849fSKiran Chandramohan } 2210dc48849fSKiran Chandramohan 2211dc48849fSKiran Chandramohan unsigned getFieldNumber(fir::RecordType ty, mlir::Value op) const { 2212dc48849fSKiran Chandramohan return fir::hasDynamicSize(ty) 2213dc48849fSKiran Chandramohan ? op.getDefiningOp() 2214dc48849fSKiran Chandramohan ->getAttrOfType<mlir::IntegerAttr>("field") 2215dc48849fSKiran Chandramohan .getInt() 2216dc48849fSKiran Chandramohan : getIntValue(op); 2217dc48849fSKiran Chandramohan } 2218dc48849fSKiran Chandramohan 2219dc48849fSKiran Chandramohan int64_t getIntValue(mlir::Value val) const { 2220dc48849fSKiran Chandramohan assert(val && val.dyn_cast<mlir::OpResult>() && "must not be null value"); 2221dc48849fSKiran Chandramohan mlir::Operation *defop = val.getDefiningOp(); 2222dc48849fSKiran Chandramohan 2223dc48849fSKiran Chandramohan if (auto constOp = dyn_cast<mlir::arith::ConstantIntOp>(defop)) 2224dc48849fSKiran Chandramohan return constOp.value(); 2225dc48849fSKiran Chandramohan if (auto llConstOp = dyn_cast<mlir::LLVM::ConstantOp>(defop)) 2226dc48849fSKiran Chandramohan if (auto attr = llConstOp.getValue().dyn_cast<mlir::IntegerAttr>()) 2227dc48849fSKiran Chandramohan return attr.getValue().getSExtValue(); 2228dc48849fSKiran Chandramohan fir::emitFatalError(val.getLoc(), "must be a constant"); 2229dc48849fSKiran Chandramohan } 2230dc48849fSKiran Chandramohan 2231dc48849fSKiran Chandramohan bool hasSubDimensions(mlir::Type type) const { 2232dc48849fSKiran Chandramohan return type.isa<fir::SequenceType, fir::RecordType, mlir::TupleType>(); 2233dc48849fSKiran Chandramohan } 2234dc48849fSKiran Chandramohan 2235dc48849fSKiran Chandramohan /// Check whether this form of `!fir.coordinate_of` is supported. These 2236dc48849fSKiran Chandramohan /// additional checks are required, because we are not yet able to convert 2237dc48849fSKiran Chandramohan /// all valid forms of `!fir.coordinate_of`. 2238dc48849fSKiran Chandramohan /// TODO: Either implement the unsupported cases or extend the verifier 2239dc48849fSKiran Chandramohan /// in FIROps.cpp instead. 2240dc48849fSKiran Chandramohan bool supportedCoordinate(mlir::Type type, mlir::ValueRange coors) const { 2241dc48849fSKiran Chandramohan const std::size_t numOfCoors = coors.size(); 2242dc48849fSKiran Chandramohan std::size_t i = 0; 2243dc48849fSKiran Chandramohan bool subEle = false; 2244dc48849fSKiran Chandramohan bool ptrEle = false; 2245dc48849fSKiran Chandramohan for (; i < numOfCoors; ++i) { 2246dc48849fSKiran Chandramohan mlir::Value nxtOpnd = coors[i]; 2247dc48849fSKiran Chandramohan if (auto arrTy = type.dyn_cast<fir::SequenceType>()) { 2248dc48849fSKiran Chandramohan subEle = true; 2249dc48849fSKiran Chandramohan i += arrTy.getDimension() - 1; 2250dc48849fSKiran Chandramohan type = arrTy.getEleTy(); 2251dc48849fSKiran Chandramohan } else if (auto recTy = type.dyn_cast<fir::RecordType>()) { 2252dc48849fSKiran Chandramohan subEle = true; 2253dc48849fSKiran Chandramohan type = recTy.getType(getFieldNumber(recTy, nxtOpnd)); 2254dc48849fSKiran Chandramohan } else if (auto tupTy = type.dyn_cast<mlir::TupleType>()) { 2255dc48849fSKiran Chandramohan subEle = true; 2256dc48849fSKiran Chandramohan type = tupTy.getType(getIntValue(nxtOpnd)); 2257dc48849fSKiran Chandramohan } else { 2258dc48849fSKiran Chandramohan ptrEle = true; 2259dc48849fSKiran Chandramohan } 2260dc48849fSKiran Chandramohan } 2261dc48849fSKiran Chandramohan if (ptrEle) 2262dc48849fSKiran Chandramohan return (!subEle) && (numOfCoors == 1); 2263dc48849fSKiran Chandramohan return subEle && (i >= numOfCoors); 2264dc48849fSKiran Chandramohan } 2265dc48849fSKiran Chandramohan 2266dc48849fSKiran Chandramohan /// Walk the abstract memory layout and determine if the path traverses any 2267dc48849fSKiran Chandramohan /// array types with unknown shape. Return true iff all the array types have a 2268dc48849fSKiran Chandramohan /// constant shape along the path. 2269dc48849fSKiran Chandramohan bool arraysHaveKnownShape(mlir::Type type, mlir::ValueRange coors) const { 2270dc48849fSKiran Chandramohan const std::size_t sz = coors.size(); 2271dc48849fSKiran Chandramohan std::size_t i = 0; 2272dc48849fSKiran Chandramohan for (; i < sz; ++i) { 2273dc48849fSKiran Chandramohan mlir::Value nxtOpnd = coors[i]; 2274dc48849fSKiran Chandramohan if (auto arrTy = type.dyn_cast<fir::SequenceType>()) { 2275dc48849fSKiran Chandramohan if (fir::sequenceWithNonConstantShape(arrTy)) 2276dc48849fSKiran Chandramohan return false; 2277dc48849fSKiran Chandramohan i += arrTy.getDimension() - 1; 2278dc48849fSKiran Chandramohan type = arrTy.getEleTy(); 2279dc48849fSKiran Chandramohan } else if (auto strTy = type.dyn_cast<fir::RecordType>()) { 2280dc48849fSKiran Chandramohan type = strTy.getType(getFieldNumber(strTy, nxtOpnd)); 2281dc48849fSKiran Chandramohan } else if (auto strTy = type.dyn_cast<mlir::TupleType>()) { 2282dc48849fSKiran Chandramohan type = strTy.getType(getIntValue(nxtOpnd)); 2283dc48849fSKiran Chandramohan } else { 2284dc48849fSKiran Chandramohan return true; 2285dc48849fSKiran Chandramohan } 2286dc48849fSKiran Chandramohan } 2287dc48849fSKiran Chandramohan return true; 2288dc48849fSKiran Chandramohan } 2289dc48849fSKiran Chandramohan 2290dc48849fSKiran Chandramohan private: 2291dc48849fSKiran Chandramohan mlir::LogicalResult 2292dc48849fSKiran Chandramohan doRewriteBox(fir::CoordinateOp coor, mlir::Type ty, mlir::ValueRange operands, 2293dc48849fSKiran Chandramohan mlir::Location loc, 2294dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const { 2295dc48849fSKiran Chandramohan mlir::Type boxObjTy = coor.getBaseType(); 2296dc48849fSKiran Chandramohan assert(boxObjTy.dyn_cast<fir::BoxType>() && "This is not a `fir.box`"); 2297dc48849fSKiran Chandramohan 2298dc48849fSKiran Chandramohan mlir::Value boxBaseAddr = operands[0]; 2299dc48849fSKiran Chandramohan 2300dc48849fSKiran Chandramohan // 1. SPECIAL CASE (uses `fir.len_param_index`): 2301dc48849fSKiran Chandramohan // %box = ... : !fir.box<!fir.type<derived{len1:i32}>> 2302dc48849fSKiran Chandramohan // %lenp = fir.len_param_index len1, !fir.type<derived{len1:i32}> 2303dc48849fSKiran Chandramohan // %addr = coordinate_of %box, %lenp 2304dc48849fSKiran Chandramohan if (coor.getNumOperands() == 2) { 2305dc48849fSKiran Chandramohan mlir::Operation *coordinateDef = 2306dc48849fSKiran Chandramohan (*coor.getCoor().begin()).getDefiningOp(); 2307dc48849fSKiran Chandramohan if (isa_and_nonnull<fir::LenParamIndexOp>(coordinateDef)) { 2308dc48849fSKiran Chandramohan TODO(loc, 2309dc48849fSKiran Chandramohan "fir.coordinate_of - fir.len_param_index is not supported yet"); 2310dc48849fSKiran Chandramohan } 2311dc48849fSKiran Chandramohan } 2312dc48849fSKiran Chandramohan 2313dc48849fSKiran Chandramohan // 2. GENERAL CASE: 2314dc48849fSKiran Chandramohan // 2.1. (`fir.array`) 2315dc48849fSKiran Chandramohan // %box = ... : !fix.box<!fir.array<?xU>> 2316dc48849fSKiran Chandramohan // %idx = ... : index 2317dc48849fSKiran Chandramohan // %resultAddr = coordinate_of %box, %idx : !fir.ref<U> 2318dc48849fSKiran Chandramohan // 2.2 (`fir.derived`) 2319dc48849fSKiran Chandramohan // %box = ... : !fix.box<!fir.type<derived_type{field_1:i32}>> 2320dc48849fSKiran Chandramohan // %idx = ... : i32 2321dc48849fSKiran Chandramohan // %resultAddr = coordinate_of %box, %idx : !fir.ref<i32> 2322dc48849fSKiran Chandramohan // 2.3 (`fir.derived` inside `fir.array`) 2323dc48849fSKiran Chandramohan // %box = ... : !fir.box<!fir.array<10 x !fir.type<derived_1{field_1:f32, 2324dc48849fSKiran Chandramohan // field_2:f32}>>> %idx1 = ... : index %idx2 = ... : i32 %resultAddr = 2325dc48849fSKiran Chandramohan // coordinate_of %box, %idx1, %idx2 : !fir.ref<f32> 2326dc48849fSKiran Chandramohan // 2.4. TODO: Either document or disable any other case that the following 2327dc48849fSKiran Chandramohan // implementation might convert. 2328dc48849fSKiran Chandramohan mlir::LLVM::ConstantOp c0 = 2329dc48849fSKiran Chandramohan genConstantIndex(loc, lowerTy().indexType(), rewriter, 0); 2330dc48849fSKiran Chandramohan mlir::Value resultAddr = 2331dc48849fSKiran Chandramohan loadBaseAddrFromBox(loc, getBaseAddrTypeFromBox(boxBaseAddr.getType()), 2332dc48849fSKiran Chandramohan boxBaseAddr, rewriter); 2333dc48849fSKiran Chandramohan auto currentObjTy = fir::dyn_cast_ptrOrBoxEleTy(boxObjTy); 2334dc48849fSKiran Chandramohan mlir::Type voidPtrTy = ::getVoidPtrType(coor.getContext()); 2335dc48849fSKiran Chandramohan 2336dc48849fSKiran Chandramohan for (unsigned i = 1, last = operands.size(); i < last; ++i) { 2337dc48849fSKiran Chandramohan if (auto arrTy = currentObjTy.dyn_cast<fir::SequenceType>()) { 2338dc48849fSKiran Chandramohan if (i != 1) 2339dc48849fSKiran Chandramohan TODO(loc, "fir.array nested inside other array and/or derived type"); 2340dc48849fSKiran Chandramohan // Applies byte strides from the box. Ignore lower bound from box 2341dc48849fSKiran Chandramohan // since fir.coordinate_of indexes are zero based. Lowering takes care 2342dc48849fSKiran Chandramohan // of lower bound aspects. This both accounts for dynamically sized 2343dc48849fSKiran Chandramohan // types and non contiguous arrays. 2344dc48849fSKiran Chandramohan auto idxTy = lowerTy().indexType(); 2345dc48849fSKiran Chandramohan mlir::Value off = genConstantIndex(loc, idxTy, rewriter, 0); 2346dc48849fSKiran Chandramohan for (unsigned index = i, lastIndex = i + arrTy.getDimension(); 2347dc48849fSKiran Chandramohan index < lastIndex; ++index) { 2348dc48849fSKiran Chandramohan mlir::Value stride = 2349dc48849fSKiran Chandramohan loadStrideFromBox(loc, operands[0], index - i, rewriter); 2350dc48849fSKiran Chandramohan auto sc = rewriter.create<mlir::LLVM::MulOp>(loc, idxTy, 2351dc48849fSKiran Chandramohan operands[index], stride); 2352dc48849fSKiran Chandramohan off = rewriter.create<mlir::LLVM::AddOp>(loc, idxTy, sc, off); 2353dc48849fSKiran Chandramohan } 2354dc48849fSKiran Chandramohan auto voidPtrBase = 2355dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::BitcastOp>(loc, voidPtrTy, resultAddr); 2356dc48849fSKiran Chandramohan SmallVector<mlir::Value> args{off}; 2357dc48849fSKiran Chandramohan resultAddr = rewriter.create<mlir::LLVM::GEPOp>(loc, voidPtrTy, 2358dc48849fSKiran Chandramohan voidPtrBase, args); 2359dc48849fSKiran Chandramohan i += arrTy.getDimension() - 1; 2360dc48849fSKiran Chandramohan currentObjTy = arrTy.getEleTy(); 2361dc48849fSKiran Chandramohan } else if (auto recTy = currentObjTy.dyn_cast<fir::RecordType>()) { 2362dc48849fSKiran Chandramohan auto recRefTy = 2363dc48849fSKiran Chandramohan mlir::LLVM::LLVMPointerType::get(lowerTy().convertType(recTy)); 2364dc48849fSKiran Chandramohan mlir::Value nxtOpnd = operands[i]; 2365dc48849fSKiran Chandramohan auto memObj = 2366dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::BitcastOp>(loc, recRefTy, resultAddr); 2367dc48849fSKiran Chandramohan llvm::SmallVector<mlir::Value> args = {c0, nxtOpnd}; 2368dc48849fSKiran Chandramohan currentObjTy = recTy.getType(getFieldNumber(recTy, nxtOpnd)); 2369dc48849fSKiran Chandramohan auto llvmCurrentObjTy = lowerTy().convertType(currentObjTy); 2370dc48849fSKiran Chandramohan auto gep = rewriter.create<mlir::LLVM::GEPOp>( 2371dc48849fSKiran Chandramohan loc, mlir::LLVM::LLVMPointerType::get(llvmCurrentObjTy), memObj, 2372dc48849fSKiran Chandramohan args); 2373dc48849fSKiran Chandramohan resultAddr = 2374dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::BitcastOp>(loc, voidPtrTy, gep); 2375dc48849fSKiran Chandramohan } else { 2376dc48849fSKiran Chandramohan fir::emitFatalError(loc, "unexpected type in coordinate_of"); 2377dc48849fSKiran Chandramohan } 2378dc48849fSKiran Chandramohan } 2379dc48849fSKiran Chandramohan 2380dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::BitcastOp>(coor, ty, resultAddr); 2381dc48849fSKiran Chandramohan return success(); 2382dc48849fSKiran Chandramohan } 2383dc48849fSKiran Chandramohan 2384dc48849fSKiran Chandramohan mlir::LogicalResult 2385dc48849fSKiran Chandramohan doRewriteRefOrPtr(fir::CoordinateOp coor, mlir::Type ty, 2386dc48849fSKiran Chandramohan mlir::ValueRange operands, mlir::Location loc, 2387dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const { 2388dc48849fSKiran Chandramohan mlir::Type baseObjectTy = coor.getBaseType(); 2389dc48849fSKiran Chandramohan 2390dc48849fSKiran Chandramohan mlir::Type currentObjTy = fir::dyn_cast_ptrOrBoxEleTy(baseObjectTy); 2391dc48849fSKiran Chandramohan bool hasSubdimension = hasSubDimensions(currentObjTy); 2392dc48849fSKiran Chandramohan bool columnIsDeferred = !hasSubdimension; 2393dc48849fSKiran Chandramohan 2394dc48849fSKiran Chandramohan if (!supportedCoordinate(currentObjTy, operands.drop_front(1))) { 2395dc48849fSKiran Chandramohan TODO(loc, "unsupported combination of coordinate operands"); 2396dc48849fSKiran Chandramohan } 2397dc48849fSKiran Chandramohan 2398dc48849fSKiran Chandramohan const bool hasKnownShape = 2399dc48849fSKiran Chandramohan arraysHaveKnownShape(currentObjTy, operands.drop_front(1)); 2400dc48849fSKiran Chandramohan 2401dc48849fSKiran Chandramohan // If only the column is `?`, then we can simply place the column value in 2402dc48849fSKiran Chandramohan // the 0-th GEP position. 2403dc48849fSKiran Chandramohan if (auto arrTy = currentObjTy.dyn_cast<fir::SequenceType>()) { 2404dc48849fSKiran Chandramohan if (!hasKnownShape) { 2405dc48849fSKiran Chandramohan const unsigned sz = arrTy.getDimension(); 2406dc48849fSKiran Chandramohan if (arraysHaveKnownShape(arrTy.getEleTy(), 2407dc48849fSKiran Chandramohan operands.drop_front(1 + sz))) { 2408dc48849fSKiran Chandramohan llvm::ArrayRef<int64_t> shape = arrTy.getShape(); 2409dc48849fSKiran Chandramohan bool allConst = true; 2410dc48849fSKiran Chandramohan for (unsigned i = 0; i < sz - 1; ++i) { 2411dc48849fSKiran Chandramohan if (shape[i] < 0) { 2412dc48849fSKiran Chandramohan allConst = false; 2413dc48849fSKiran Chandramohan break; 2414dc48849fSKiran Chandramohan } 2415dc48849fSKiran Chandramohan } 2416dc48849fSKiran Chandramohan if (allConst) 2417dc48849fSKiran Chandramohan columnIsDeferred = true; 2418dc48849fSKiran Chandramohan } 2419dc48849fSKiran Chandramohan } 2420dc48849fSKiran Chandramohan } 2421dc48849fSKiran Chandramohan 2422dc48849fSKiran Chandramohan if (fir::hasDynamicSize(fir::unwrapSequenceType(currentObjTy))) { 2423dc48849fSKiran Chandramohan mlir::emitError( 2424dc48849fSKiran Chandramohan loc, "fir.coordinate_of with a dynamic element size is unsupported"); 2425dc48849fSKiran Chandramohan return failure(); 2426dc48849fSKiran Chandramohan } 2427dc48849fSKiran Chandramohan 2428dc48849fSKiran Chandramohan if (hasKnownShape || columnIsDeferred) { 2429dc48849fSKiran Chandramohan SmallVector<mlir::Value> offs; 2430dc48849fSKiran Chandramohan if (hasKnownShape && hasSubdimension) { 2431dc48849fSKiran Chandramohan mlir::LLVM::ConstantOp c0 = 2432dc48849fSKiran Chandramohan genConstantIndex(loc, lowerTy().indexType(), rewriter, 0); 2433dc48849fSKiran Chandramohan offs.push_back(c0); 2434dc48849fSKiran Chandramohan } 2435dc48849fSKiran Chandramohan const std::size_t sz = operands.size(); 2436dc48849fSKiran Chandramohan Optional<int> dims; 2437dc48849fSKiran Chandramohan SmallVector<mlir::Value> arrIdx; 2438dc48849fSKiran Chandramohan for (std::size_t i = 1; i < sz; ++i) { 2439dc48849fSKiran Chandramohan mlir::Value nxtOpnd = operands[i]; 2440dc48849fSKiran Chandramohan 2441dc48849fSKiran Chandramohan if (!currentObjTy) { 2442dc48849fSKiran Chandramohan mlir::emitError(loc, "invalid coordinate/check failed"); 2443dc48849fSKiran Chandramohan return failure(); 2444dc48849fSKiran Chandramohan } 2445dc48849fSKiran Chandramohan 2446dc48849fSKiran Chandramohan // check if the i-th coordinate relates to an array 2447dc48849fSKiran Chandramohan if (dims.hasValue()) { 2448dc48849fSKiran Chandramohan arrIdx.push_back(nxtOpnd); 2449dc48849fSKiran Chandramohan int dimsLeft = *dims; 2450dc48849fSKiran Chandramohan if (dimsLeft > 1) { 2451dc48849fSKiran Chandramohan dims = dimsLeft - 1; 2452dc48849fSKiran Chandramohan continue; 2453dc48849fSKiran Chandramohan } 2454dc48849fSKiran Chandramohan currentObjTy = currentObjTy.cast<fir::SequenceType>().getEleTy(); 2455dc48849fSKiran Chandramohan // append array range in reverse (FIR arrays are column-major) 2456dc48849fSKiran Chandramohan offs.append(arrIdx.rbegin(), arrIdx.rend()); 2457dc48849fSKiran Chandramohan arrIdx.clear(); 2458dc48849fSKiran Chandramohan dims.reset(); 2459dc48849fSKiran Chandramohan continue; 2460dc48849fSKiran Chandramohan } 2461dc48849fSKiran Chandramohan if (auto arrTy = currentObjTy.dyn_cast<fir::SequenceType>()) { 2462dc48849fSKiran Chandramohan int d = arrTy.getDimension() - 1; 2463dc48849fSKiran Chandramohan if (d > 0) { 2464dc48849fSKiran Chandramohan dims = d; 2465dc48849fSKiran Chandramohan arrIdx.push_back(nxtOpnd); 2466dc48849fSKiran Chandramohan continue; 2467dc48849fSKiran Chandramohan } 2468dc48849fSKiran Chandramohan currentObjTy = currentObjTy.cast<fir::SequenceType>().getEleTy(); 2469dc48849fSKiran Chandramohan offs.push_back(nxtOpnd); 2470dc48849fSKiran Chandramohan continue; 2471dc48849fSKiran Chandramohan } 2472dc48849fSKiran Chandramohan 2473dc48849fSKiran Chandramohan // check if the i-th coordinate relates to a field 2474dc48849fSKiran Chandramohan if (auto recTy = currentObjTy.dyn_cast<fir::RecordType>()) 2475dc48849fSKiran Chandramohan currentObjTy = recTy.getType(getFieldNumber(recTy, nxtOpnd)); 2476dc48849fSKiran Chandramohan else if (auto tupTy = currentObjTy.dyn_cast<mlir::TupleType>()) 2477dc48849fSKiran Chandramohan currentObjTy = tupTy.getType(getIntValue(nxtOpnd)); 2478dc48849fSKiran Chandramohan else 2479dc48849fSKiran Chandramohan currentObjTy = nullptr; 2480dc48849fSKiran Chandramohan 2481dc48849fSKiran Chandramohan offs.push_back(nxtOpnd); 2482dc48849fSKiran Chandramohan } 2483dc48849fSKiran Chandramohan if (dims.hasValue()) 2484dc48849fSKiran Chandramohan offs.append(arrIdx.rbegin(), arrIdx.rend()); 2485dc48849fSKiran Chandramohan mlir::Value base = operands[0]; 2486dc48849fSKiran Chandramohan mlir::Value retval = genGEP(loc, ty, rewriter, base, offs); 2487dc48849fSKiran Chandramohan rewriter.replaceOp(coor, retval); 2488dc48849fSKiran Chandramohan return success(); 2489dc48849fSKiran Chandramohan } 2490dc48849fSKiran Chandramohan 2491dc48849fSKiran Chandramohan mlir::emitError(loc, "fir.coordinate_of base operand has unsupported type"); 2492dc48849fSKiran Chandramohan return failure(); 2493dc48849fSKiran Chandramohan } 2494dc48849fSKiran Chandramohan }; 2495dc48849fSKiran Chandramohan 2496dc48849fSKiran Chandramohan /// Convert `fir.field_index`. The conversion depends on whether the size of 2497dc48849fSKiran Chandramohan /// the record is static or dynamic. 2498dc48849fSKiran Chandramohan struct FieldIndexOpConversion : public FIROpConversion<fir::FieldIndexOp> { 2499dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2500dc48849fSKiran Chandramohan 2501dc48849fSKiran Chandramohan // NB: most field references should be resolved by this point 2502dc48849fSKiran Chandramohan mlir::LogicalResult 2503dc48849fSKiran Chandramohan matchAndRewrite(fir::FieldIndexOp field, OpAdaptor adaptor, 2504dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2505dc48849fSKiran Chandramohan auto recTy = field.getOnType().cast<fir::RecordType>(); 2506dc48849fSKiran Chandramohan unsigned index = recTy.getFieldIndex(field.getFieldId()); 2507dc48849fSKiran Chandramohan 2508dc48849fSKiran Chandramohan if (!fir::hasDynamicSize(recTy)) { 2509dc48849fSKiran Chandramohan // Derived type has compile-time constant layout. Return index of the 2510dc48849fSKiran Chandramohan // component type in the parent type (to be used in GEP). 2511dc48849fSKiran Chandramohan rewriter.replaceOp(field, mlir::ValueRange{genConstantOffset( 2512dc48849fSKiran Chandramohan field.getLoc(), rewriter, index)}); 2513dc48849fSKiran Chandramohan return success(); 2514dc48849fSKiran Chandramohan } 2515dc48849fSKiran Chandramohan 2516dc48849fSKiran Chandramohan // Derived type has compile-time constant layout. Call the compiler 2517dc48849fSKiran Chandramohan // generated function to determine the byte offset of the field at runtime. 2518dc48849fSKiran Chandramohan // This returns a non-constant. 2519dc48849fSKiran Chandramohan FlatSymbolRefAttr symAttr = mlir::SymbolRefAttr::get( 2520dc48849fSKiran Chandramohan field.getContext(), getOffsetMethodName(recTy, field.getFieldId())); 2521dc48849fSKiran Chandramohan NamedAttribute callAttr = rewriter.getNamedAttr("callee", symAttr); 2522dc48849fSKiran Chandramohan NamedAttribute fieldAttr = rewriter.getNamedAttr( 2523dc48849fSKiran Chandramohan "field", mlir::IntegerAttr::get(lowerTy().indexType(), index)); 2524dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::CallOp>( 2525dc48849fSKiran Chandramohan field, lowerTy().offsetType(), adaptor.getOperands(), 2526dc48849fSKiran Chandramohan llvm::ArrayRef<mlir::NamedAttribute>{callAttr, fieldAttr}); 2527dc48849fSKiran Chandramohan return success(); 2528dc48849fSKiran Chandramohan } 2529dc48849fSKiran Chandramohan 2530dc48849fSKiran Chandramohan // Re-Construct the name of the compiler generated method that calculates the 2531dc48849fSKiran Chandramohan // offset 2532dc48849fSKiran Chandramohan inline static std::string getOffsetMethodName(fir::RecordType recTy, 2533dc48849fSKiran Chandramohan llvm::StringRef field) { 2534dc48849fSKiran Chandramohan return recTy.getName().str() + "P." + field.str() + ".offset"; 2535dc48849fSKiran Chandramohan } 2536dc48849fSKiran Chandramohan }; 2537dc48849fSKiran Chandramohan 2538dc48849fSKiran Chandramohan /// Convert `fir.end` 2539dc48849fSKiran Chandramohan struct FirEndOpConversion : public FIROpConversion<fir::FirEndOp> { 2540dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2541dc48849fSKiran Chandramohan 2542dc48849fSKiran Chandramohan mlir::LogicalResult 2543dc48849fSKiran Chandramohan matchAndRewrite(fir::FirEndOp firEnd, OpAdaptor, 2544dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2545dc48849fSKiran Chandramohan TODO(firEnd.getLoc(), "fir.end codegen"); 2546dc48849fSKiran Chandramohan return failure(); 2547dc48849fSKiran Chandramohan } 2548dc48849fSKiran Chandramohan }; 2549dc48849fSKiran Chandramohan 2550dc48849fSKiran Chandramohan /// Lower `fir.gentypedesc` to a global constant. 2551dc48849fSKiran Chandramohan struct GenTypeDescOpConversion : public FIROpConversion<fir::GenTypeDescOp> { 2552dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2553dc48849fSKiran Chandramohan 2554dc48849fSKiran Chandramohan mlir::LogicalResult 2555dc48849fSKiran Chandramohan matchAndRewrite(fir::GenTypeDescOp gentypedesc, OpAdaptor adaptor, 2556dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2557dc48849fSKiran Chandramohan TODO(gentypedesc.getLoc(), "fir.gentypedesc codegen"); 2558dc48849fSKiran Chandramohan return failure(); 2559dc48849fSKiran Chandramohan } 2560dc48849fSKiran Chandramohan }; 2561dc48849fSKiran Chandramohan 2562dc48849fSKiran Chandramohan /// Lower `fir.has_value` operation to `llvm.return` operation. 2563dc48849fSKiran Chandramohan struct HasValueOpConversion : public FIROpConversion<fir::HasValueOp> { 2564dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2565dc48849fSKiran Chandramohan 2566dc48849fSKiran Chandramohan mlir::LogicalResult 2567dc48849fSKiran Chandramohan matchAndRewrite(fir::HasValueOp op, OpAdaptor adaptor, 2568dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2569dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<LLVM::ReturnOp>(op, adaptor.getOperands()); 2570dc48849fSKiran Chandramohan return success(); 2571dc48849fSKiran Chandramohan } 2572dc48849fSKiran Chandramohan }; 2573dc48849fSKiran Chandramohan 2574dc48849fSKiran Chandramohan /// Lower `fir.global` operation to `llvm.global` operation. 2575dc48849fSKiran Chandramohan /// `fir.insert_on_range` operations are replaced with constant dense attribute 2576dc48849fSKiran Chandramohan /// if they are applied on the full range. 2577dc48849fSKiran Chandramohan struct GlobalOpConversion : public FIROpConversion<fir::GlobalOp> { 2578dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2579dc48849fSKiran Chandramohan 2580dc48849fSKiran Chandramohan mlir::LogicalResult 2581dc48849fSKiran Chandramohan matchAndRewrite(fir::GlobalOp global, OpAdaptor adaptor, 2582dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2583dc48849fSKiran Chandramohan auto tyAttr = convertType(global.getType()); 2584dc48849fSKiran Chandramohan if (global.getType().isa<fir::BoxType>()) 2585dc48849fSKiran Chandramohan tyAttr = tyAttr.cast<mlir::LLVM::LLVMPointerType>().getElementType(); 2586dc48849fSKiran Chandramohan auto loc = global.getLoc(); 2587dc48849fSKiran Chandramohan mlir::Attribute initAttr{}; 2588dc48849fSKiran Chandramohan if (global.getInitVal()) 2589dc48849fSKiran Chandramohan initAttr = global.getInitVal().getValue(); 2590dc48849fSKiran Chandramohan auto linkage = convertLinkage(global.getLinkName()); 2591dc48849fSKiran Chandramohan auto isConst = global.getConstant().hasValue(); 2592dc48849fSKiran Chandramohan auto g = rewriter.create<mlir::LLVM::GlobalOp>( 2593dc48849fSKiran Chandramohan loc, tyAttr, isConst, linkage, global.getSymName(), initAttr); 2594dc48849fSKiran Chandramohan auto &gr = g.getInitializerRegion(); 2595dc48849fSKiran Chandramohan rewriter.inlineRegionBefore(global.getRegion(), gr, gr.end()); 2596dc48849fSKiran Chandramohan if (!gr.empty()) { 2597dc48849fSKiran Chandramohan // Replace insert_on_range with a constant dense attribute if the 2598dc48849fSKiran Chandramohan // initialization is on the full range. 2599dc48849fSKiran Chandramohan auto insertOnRangeOps = gr.front().getOps<fir::InsertOnRangeOp>(); 2600dc48849fSKiran Chandramohan for (auto insertOp : insertOnRangeOps) { 2601dc48849fSKiran Chandramohan if (isFullRange(insertOp.getCoor(), insertOp.getType())) { 2602dc48849fSKiran Chandramohan auto seqTyAttr = convertType(insertOp.getType()); 2603dc48849fSKiran Chandramohan auto *op = insertOp.getVal().getDefiningOp(); 2604dc48849fSKiran Chandramohan auto constant = mlir::dyn_cast<mlir::arith::ConstantOp>(op); 2605dc48849fSKiran Chandramohan if (!constant) { 2606dc48849fSKiran Chandramohan auto convertOp = mlir::dyn_cast<fir::ConvertOp>(op); 2607dc48849fSKiran Chandramohan if (!convertOp) 2608dc48849fSKiran Chandramohan continue; 2609dc48849fSKiran Chandramohan constant = cast<mlir::arith::ConstantOp>( 2610dc48849fSKiran Chandramohan convertOp.getValue().getDefiningOp()); 2611dc48849fSKiran Chandramohan } 2612dc48849fSKiran Chandramohan mlir::Type vecType = mlir::VectorType::get( 2613dc48849fSKiran Chandramohan insertOp.getType().getShape(), constant.getType()); 2614dc48849fSKiran Chandramohan auto denseAttr = mlir::DenseElementsAttr::get( 2615dc48849fSKiran Chandramohan vecType.cast<ShapedType>(), constant.getValue()); 2616dc48849fSKiran Chandramohan rewriter.setInsertionPointAfter(insertOp); 2617dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::arith::ConstantOp>( 2618dc48849fSKiran Chandramohan insertOp, seqTyAttr, denseAttr); 2619dc48849fSKiran Chandramohan } 2620dc48849fSKiran Chandramohan } 2621dc48849fSKiran Chandramohan } 2622dc48849fSKiran Chandramohan rewriter.eraseOp(global); 2623dc48849fSKiran Chandramohan return success(); 2624dc48849fSKiran Chandramohan } 2625dc48849fSKiran Chandramohan 2626dc48849fSKiran Chandramohan bool isFullRange(mlir::DenseIntElementsAttr indexes, 2627dc48849fSKiran Chandramohan fir::SequenceType seqTy) const { 2628dc48849fSKiran Chandramohan auto extents = seqTy.getShape(); 2629dc48849fSKiran Chandramohan if (indexes.size() / 2 != static_cast<int64_t>(extents.size())) 2630dc48849fSKiran Chandramohan return false; 2631dc48849fSKiran Chandramohan auto cur_index = indexes.value_begin<int64_t>(); 2632dc48849fSKiran Chandramohan for (unsigned i = 0; i < indexes.size(); i += 2) { 2633dc48849fSKiran Chandramohan if (*(cur_index++) != 0) 2634dc48849fSKiran Chandramohan return false; 2635dc48849fSKiran Chandramohan if (*(cur_index++) != extents[i / 2] - 1) 2636dc48849fSKiran Chandramohan return false; 2637dc48849fSKiran Chandramohan } 2638dc48849fSKiran Chandramohan return true; 2639dc48849fSKiran Chandramohan } 2640dc48849fSKiran Chandramohan 2641dc48849fSKiran Chandramohan // TODO: String comparaison should be avoided. Replace linkName with an 2642dc48849fSKiran Chandramohan // enumeration. 2643dc48849fSKiran Chandramohan mlir::LLVM::Linkage convertLinkage(Optional<StringRef> optLinkage) const { 2644dc48849fSKiran Chandramohan if (optLinkage.hasValue()) { 2645dc48849fSKiran Chandramohan auto name = optLinkage.getValue(); 2646dc48849fSKiran Chandramohan if (name == "internal") 2647dc48849fSKiran Chandramohan return mlir::LLVM::Linkage::Internal; 2648dc48849fSKiran Chandramohan if (name == "linkonce") 2649dc48849fSKiran Chandramohan return mlir::LLVM::Linkage::Linkonce; 2650*30a0fbf5SJean Perier if (name == "linkonce_odr") 2651*30a0fbf5SJean Perier return mlir::LLVM::Linkage::LinkonceODR; 2652dc48849fSKiran Chandramohan if (name == "common") 2653dc48849fSKiran Chandramohan return mlir::LLVM::Linkage::Common; 2654dc48849fSKiran Chandramohan if (name == "weak") 2655dc48849fSKiran Chandramohan return mlir::LLVM::Linkage::Weak; 2656dc48849fSKiran Chandramohan } 2657dc48849fSKiran Chandramohan return mlir::LLVM::Linkage::External; 2658dc48849fSKiran Chandramohan } 2659dc48849fSKiran Chandramohan }; 2660dc48849fSKiran Chandramohan 2661dc48849fSKiran Chandramohan /// `fir.load` --> `llvm.load` 2662dc48849fSKiran Chandramohan struct LoadOpConversion : public FIROpConversion<fir::LoadOp> { 2663dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2664dc48849fSKiran Chandramohan 2665dc48849fSKiran Chandramohan mlir::LogicalResult 2666dc48849fSKiran Chandramohan matchAndRewrite(fir::LoadOp load, OpAdaptor adaptor, 2667dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2668dc48849fSKiran Chandramohan // fir.box is a special case because it is considered as an ssa values in 2669dc48849fSKiran Chandramohan // fir, but it is lowered as a pointer to a descriptor. So fir.ref<fir.box> 2670dc48849fSKiran Chandramohan // and fir.box end up being the same llvm types and loading a 2671dc48849fSKiran Chandramohan // fir.ref<fir.box> is actually a no op in LLVM. 2672dc48849fSKiran Chandramohan if (load.getType().isa<fir::BoxType>()) { 2673dc48849fSKiran Chandramohan rewriter.replaceOp(load, adaptor.getOperands()[0]); 2674dc48849fSKiran Chandramohan } else { 2675dc48849fSKiran Chandramohan mlir::Type ty = convertType(load.getType()); 2676dc48849fSKiran Chandramohan ArrayRef<NamedAttribute> at = load->getAttrs(); 2677dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::LoadOp>( 2678dc48849fSKiran Chandramohan load, ty, adaptor.getOperands(), at); 2679dc48849fSKiran Chandramohan } 2680dc48849fSKiran Chandramohan return success(); 2681dc48849fSKiran Chandramohan } 2682dc48849fSKiran Chandramohan }; 2683dc48849fSKiran Chandramohan 2684dc48849fSKiran Chandramohan /// Lower `fir.no_reassoc` to LLVM IR dialect. 2685dc48849fSKiran Chandramohan /// TODO: how do we want to enforce this in LLVM-IR? Can we manipulate the fast 2686dc48849fSKiran Chandramohan /// math flags? 2687dc48849fSKiran Chandramohan struct NoReassocOpConversion : public FIROpConversion<fir::NoReassocOp> { 2688dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2689dc48849fSKiran Chandramohan 2690dc48849fSKiran Chandramohan mlir::LogicalResult 2691dc48849fSKiran Chandramohan matchAndRewrite(fir::NoReassocOp noreassoc, OpAdaptor adaptor, 2692dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2693dc48849fSKiran Chandramohan rewriter.replaceOp(noreassoc, adaptor.getOperands()[0]); 2694dc48849fSKiran Chandramohan return success(); 2695dc48849fSKiran Chandramohan } 2696dc48849fSKiran Chandramohan }; 2697dc48849fSKiran Chandramohan 2698dc48849fSKiran Chandramohan static void genCondBrOp(mlir::Location loc, mlir::Value cmp, mlir::Block *dest, 2699dc48849fSKiran Chandramohan Optional<mlir::ValueRange> destOps, 2700dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter, 2701dc48849fSKiran Chandramohan mlir::Block *newBlock) { 2702dc48849fSKiran Chandramohan if (destOps.hasValue()) 2703dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::CondBrOp>(loc, cmp, dest, destOps.getValue(), 2704dc48849fSKiran Chandramohan newBlock, mlir::ValueRange()); 2705dc48849fSKiran Chandramohan else 2706dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::CondBrOp>(loc, cmp, dest, newBlock); 2707dc48849fSKiran Chandramohan } 2708dc48849fSKiran Chandramohan 2709dc48849fSKiran Chandramohan template <typename A, typename B> 2710dc48849fSKiran Chandramohan static void genBrOp(A caseOp, mlir::Block *dest, Optional<B> destOps, 2711dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) { 2712dc48849fSKiran Chandramohan if (destOps.hasValue()) 2713dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::BrOp>(caseOp, destOps.getValue(), 2714dc48849fSKiran Chandramohan dest); 2715dc48849fSKiran Chandramohan else 2716dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::BrOp>(caseOp, llvm::None, dest); 2717dc48849fSKiran Chandramohan } 2718dc48849fSKiran Chandramohan 2719dc48849fSKiran Chandramohan static void genCaseLadderStep(mlir::Location loc, mlir::Value cmp, 2720dc48849fSKiran Chandramohan mlir::Block *dest, 2721dc48849fSKiran Chandramohan Optional<mlir::ValueRange> destOps, 2722dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) { 2723dc48849fSKiran Chandramohan auto *thisBlock = rewriter.getInsertionBlock(); 2724dc48849fSKiran Chandramohan auto *newBlock = createBlock(rewriter, dest); 2725dc48849fSKiran Chandramohan rewriter.setInsertionPointToEnd(thisBlock); 2726dc48849fSKiran Chandramohan genCondBrOp(loc, cmp, dest, destOps, rewriter, newBlock); 2727dc48849fSKiran Chandramohan rewriter.setInsertionPointToEnd(newBlock); 2728dc48849fSKiran Chandramohan } 2729dc48849fSKiran Chandramohan 2730dc48849fSKiran Chandramohan /// Conversion of `fir.select_case` 2731dc48849fSKiran Chandramohan /// 2732dc48849fSKiran Chandramohan /// The `fir.select_case` operation is converted to a if-then-else ladder. 2733dc48849fSKiran Chandramohan /// Depending on the case condition type, one or several comparison and 2734dc48849fSKiran Chandramohan /// conditional branching can be generated. 2735dc48849fSKiran Chandramohan /// 2736dc48849fSKiran Chandramohan /// A a point value case such as `case(4)`, a lower bound case such as 2737dc48849fSKiran Chandramohan /// `case(5:)` or an upper bound case such as `case(:3)` are converted to a 2738dc48849fSKiran Chandramohan /// simple comparison between the selector value and the constant value in the 2739dc48849fSKiran Chandramohan /// case. The block associated with the case condition is then executed if 2740dc48849fSKiran Chandramohan /// the comparison succeed otherwise it branch to the next block with the 2741dc48849fSKiran Chandramohan /// comparison for the the next case conditon. 2742dc48849fSKiran Chandramohan /// 2743dc48849fSKiran Chandramohan /// A closed interval case condition such as `case(7:10)` is converted with a 2744dc48849fSKiran Chandramohan /// first comparison and conditional branching for the lower bound. If 2745dc48849fSKiran Chandramohan /// successful, it branch to a second block with the comparison for the 2746dc48849fSKiran Chandramohan /// upper bound in the same case condition. 2747dc48849fSKiran Chandramohan /// 2748dc48849fSKiran Chandramohan /// TODO: lowering of CHARACTER type cases is not handled yet. 2749dc48849fSKiran Chandramohan struct SelectCaseOpConversion : public FIROpConversion<fir::SelectCaseOp> { 2750dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2751dc48849fSKiran Chandramohan 2752dc48849fSKiran Chandramohan mlir::LogicalResult 2753dc48849fSKiran Chandramohan matchAndRewrite(fir::SelectCaseOp caseOp, OpAdaptor adaptor, 2754dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2755dc48849fSKiran Chandramohan unsigned conds = caseOp.getNumConditions(); 2756dc48849fSKiran Chandramohan llvm::ArrayRef<mlir::Attribute> cases = caseOp.getCases().getValue(); 2757dc48849fSKiran Chandramohan // Type can be CHARACTER, INTEGER, or LOGICAL (C1145) 2758dc48849fSKiran Chandramohan auto ty = caseOp.getSelector().getType(); 2759dc48849fSKiran Chandramohan if (ty.isa<fir::CharacterType>()) { 2760dc48849fSKiran Chandramohan TODO(caseOp.getLoc(), "fir.select_case codegen with character type"); 2761dc48849fSKiran Chandramohan return failure(); 2762dc48849fSKiran Chandramohan } 2763dc48849fSKiran Chandramohan mlir::Value selector = caseOp.getSelector(adaptor.getOperands()); 2764dc48849fSKiran Chandramohan auto loc = caseOp.getLoc(); 2765dc48849fSKiran Chandramohan for (unsigned t = 0; t != conds; ++t) { 2766dc48849fSKiran Chandramohan mlir::Block *dest = caseOp.getSuccessor(t); 2767dc48849fSKiran Chandramohan llvm::Optional<mlir::ValueRange> destOps = 2768dc48849fSKiran Chandramohan caseOp.getSuccessorOperands(adaptor.getOperands(), t); 2769dc48849fSKiran Chandramohan llvm::Optional<mlir::ValueRange> cmpOps = 2770dc48849fSKiran Chandramohan *caseOp.getCompareOperands(adaptor.getOperands(), t); 2771dc48849fSKiran Chandramohan mlir::Value caseArg = *(cmpOps.getValue().begin()); 2772dc48849fSKiran Chandramohan mlir::Attribute attr = cases[t]; 2773dc48849fSKiran Chandramohan if (attr.isa<fir::PointIntervalAttr>()) { 2774dc48849fSKiran Chandramohan auto cmp = rewriter.create<mlir::LLVM::ICmpOp>( 2775dc48849fSKiran Chandramohan loc, mlir::LLVM::ICmpPredicate::eq, selector, caseArg); 2776dc48849fSKiran Chandramohan genCaseLadderStep(loc, cmp, dest, destOps, rewriter); 2777dc48849fSKiran Chandramohan continue; 2778dc48849fSKiran Chandramohan } 2779dc48849fSKiran Chandramohan if (attr.isa<fir::LowerBoundAttr>()) { 2780dc48849fSKiran Chandramohan auto cmp = rewriter.create<mlir::LLVM::ICmpOp>( 2781dc48849fSKiran Chandramohan loc, mlir::LLVM::ICmpPredicate::sle, caseArg, selector); 2782dc48849fSKiran Chandramohan genCaseLadderStep(loc, cmp, dest, destOps, rewriter); 2783dc48849fSKiran Chandramohan continue; 2784dc48849fSKiran Chandramohan } 2785dc48849fSKiran Chandramohan if (attr.isa<fir::UpperBoundAttr>()) { 2786dc48849fSKiran Chandramohan auto cmp = rewriter.create<mlir::LLVM::ICmpOp>( 2787dc48849fSKiran Chandramohan loc, mlir::LLVM::ICmpPredicate::sle, selector, caseArg); 2788dc48849fSKiran Chandramohan genCaseLadderStep(loc, cmp, dest, destOps, rewriter); 2789dc48849fSKiran Chandramohan continue; 2790dc48849fSKiran Chandramohan } 2791dc48849fSKiran Chandramohan if (attr.isa<fir::ClosedIntervalAttr>()) { 2792dc48849fSKiran Chandramohan auto cmp = rewriter.create<mlir::LLVM::ICmpOp>( 2793dc48849fSKiran Chandramohan loc, mlir::LLVM::ICmpPredicate::sle, caseArg, selector); 2794dc48849fSKiran Chandramohan auto *thisBlock = rewriter.getInsertionBlock(); 2795dc48849fSKiran Chandramohan auto *newBlock1 = createBlock(rewriter, dest); 2796dc48849fSKiran Chandramohan auto *newBlock2 = createBlock(rewriter, dest); 2797dc48849fSKiran Chandramohan rewriter.setInsertionPointToEnd(thisBlock); 2798dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::CondBrOp>(loc, cmp, newBlock1, newBlock2); 2799dc48849fSKiran Chandramohan rewriter.setInsertionPointToEnd(newBlock1); 2800dc48849fSKiran Chandramohan mlir::Value caseArg0 = *(cmpOps.getValue().begin() + 1); 2801dc48849fSKiran Chandramohan auto cmp0 = rewriter.create<mlir::LLVM::ICmpOp>( 2802dc48849fSKiran Chandramohan loc, mlir::LLVM::ICmpPredicate::sle, selector, caseArg0); 2803dc48849fSKiran Chandramohan genCondBrOp(loc, cmp0, dest, destOps, rewriter, newBlock2); 2804dc48849fSKiran Chandramohan rewriter.setInsertionPointToEnd(newBlock2); 2805dc48849fSKiran Chandramohan continue; 2806dc48849fSKiran Chandramohan } 2807dc48849fSKiran Chandramohan assert(attr.isa<mlir::UnitAttr>()); 2808dc48849fSKiran Chandramohan assert((t + 1 == conds) && "unit must be last"); 2809dc48849fSKiran Chandramohan genBrOp(caseOp, dest, destOps, rewriter); 2810dc48849fSKiran Chandramohan } 2811dc48849fSKiran Chandramohan return success(); 2812dc48849fSKiran Chandramohan } 2813dc48849fSKiran Chandramohan }; 2814dc48849fSKiran Chandramohan 2815dc48849fSKiran Chandramohan template <typename OP> 2816dc48849fSKiran Chandramohan static void selectMatchAndRewrite(fir::LLVMTypeConverter &lowering, OP select, 2817dc48849fSKiran Chandramohan typename OP::Adaptor adaptor, 2818dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) { 2819dc48849fSKiran Chandramohan unsigned conds = select.getNumConditions(); 2820dc48849fSKiran Chandramohan auto cases = select.getCases().getValue(); 2821dc48849fSKiran Chandramohan mlir::Value selector = adaptor.getSelector(); 2822dc48849fSKiran Chandramohan auto loc = select.getLoc(); 2823dc48849fSKiran Chandramohan assert(conds > 0 && "select must have cases"); 2824dc48849fSKiran Chandramohan 2825dc48849fSKiran Chandramohan llvm::SmallVector<mlir::Block *> destinations; 2826dc48849fSKiran Chandramohan llvm::SmallVector<mlir::ValueRange> destinationsOperands; 2827dc48849fSKiran Chandramohan mlir::Block *defaultDestination; 2828dc48849fSKiran Chandramohan mlir::ValueRange defaultOperands; 2829dc48849fSKiran Chandramohan llvm::SmallVector<int32_t> caseValues; 2830dc48849fSKiran Chandramohan 2831dc48849fSKiran Chandramohan for (unsigned t = 0; t != conds; ++t) { 2832dc48849fSKiran Chandramohan mlir::Block *dest = select.getSuccessor(t); 2833dc48849fSKiran Chandramohan auto destOps = select.getSuccessorOperands(adaptor.getOperands(), t); 2834dc48849fSKiran Chandramohan const mlir::Attribute &attr = cases[t]; 2835dc48849fSKiran Chandramohan if (auto intAttr = attr.template dyn_cast<mlir::IntegerAttr>()) { 2836dc48849fSKiran Chandramohan destinations.push_back(dest); 2837dc48849fSKiran Chandramohan destinationsOperands.push_back(destOps.hasValue() ? *destOps 2838dc48849fSKiran Chandramohan : ValueRange()); 2839dc48849fSKiran Chandramohan caseValues.push_back(intAttr.getInt()); 2840dc48849fSKiran Chandramohan continue; 2841dc48849fSKiran Chandramohan } 2842dc48849fSKiran Chandramohan assert(attr.template dyn_cast_or_null<mlir::UnitAttr>()); 2843dc48849fSKiran Chandramohan assert((t + 1 == conds) && "unit must be last"); 2844dc48849fSKiran Chandramohan defaultDestination = dest; 2845dc48849fSKiran Chandramohan defaultOperands = destOps.hasValue() ? *destOps : ValueRange(); 2846dc48849fSKiran Chandramohan } 2847dc48849fSKiran Chandramohan 2848dc48849fSKiran Chandramohan // LLVM::SwitchOp takes a i32 type for the selector. 2849dc48849fSKiran Chandramohan if (select.getSelector().getType() != rewriter.getI32Type()) 2850dc48849fSKiran Chandramohan selector = 2851dc48849fSKiran Chandramohan rewriter.create<LLVM::TruncOp>(loc, rewriter.getI32Type(), selector); 2852dc48849fSKiran Chandramohan 2853dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::SwitchOp>( 2854dc48849fSKiran Chandramohan select, selector, 2855dc48849fSKiran Chandramohan /*defaultDestination=*/defaultDestination, 2856dc48849fSKiran Chandramohan /*defaultOperands=*/defaultOperands, 2857dc48849fSKiran Chandramohan /*caseValues=*/caseValues, 2858dc48849fSKiran Chandramohan /*caseDestinations=*/destinations, 2859dc48849fSKiran Chandramohan /*caseOperands=*/destinationsOperands, 2860dc48849fSKiran Chandramohan /*branchWeights=*/ArrayRef<int32_t>()); 2861dc48849fSKiran Chandramohan } 2862dc48849fSKiran Chandramohan 2863dc48849fSKiran Chandramohan /// conversion of fir::SelectOp to an if-then-else ladder 2864dc48849fSKiran Chandramohan struct SelectOpConversion : public FIROpConversion<fir::SelectOp> { 2865dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2866dc48849fSKiran Chandramohan 2867dc48849fSKiran Chandramohan mlir::LogicalResult 2868dc48849fSKiran Chandramohan matchAndRewrite(fir::SelectOp op, OpAdaptor adaptor, 2869dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2870dc48849fSKiran Chandramohan selectMatchAndRewrite<fir::SelectOp>(lowerTy(), op, adaptor, rewriter); 2871dc48849fSKiran Chandramohan return success(); 2872dc48849fSKiran Chandramohan } 2873dc48849fSKiran Chandramohan }; 2874dc48849fSKiran Chandramohan 2875dc48849fSKiran Chandramohan /// conversion of fir::SelectRankOp to an if-then-else ladder 2876dc48849fSKiran Chandramohan struct SelectRankOpConversion : public FIROpConversion<fir::SelectRankOp> { 2877dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2878dc48849fSKiran Chandramohan 2879dc48849fSKiran Chandramohan mlir::LogicalResult 2880dc48849fSKiran Chandramohan matchAndRewrite(fir::SelectRankOp op, OpAdaptor adaptor, 2881dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2882dc48849fSKiran Chandramohan selectMatchAndRewrite<fir::SelectRankOp>(lowerTy(), op, adaptor, rewriter); 2883dc48849fSKiran Chandramohan return success(); 2884dc48849fSKiran Chandramohan } 2885dc48849fSKiran Chandramohan }; 2886dc48849fSKiran Chandramohan 2887dc48849fSKiran Chandramohan /// Lower `fir.select_type` to LLVM IR dialect. 2888dc48849fSKiran Chandramohan struct SelectTypeOpConversion : public FIROpConversion<fir::SelectTypeOp> { 2889dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2890dc48849fSKiran Chandramohan 2891dc48849fSKiran Chandramohan mlir::LogicalResult 2892dc48849fSKiran Chandramohan matchAndRewrite(fir::SelectTypeOp select, OpAdaptor adaptor, 2893dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2894dc48849fSKiran Chandramohan mlir::emitError(select.getLoc(), 2895dc48849fSKiran Chandramohan "fir.select_type should have already been converted"); 2896dc48849fSKiran Chandramohan return failure(); 2897dc48849fSKiran Chandramohan } 2898dc48849fSKiran Chandramohan }; 2899dc48849fSKiran Chandramohan 2900dc48849fSKiran Chandramohan /// `fir.store` --> `llvm.store` 2901dc48849fSKiran Chandramohan struct StoreOpConversion : public FIROpConversion<fir::StoreOp> { 2902dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2903dc48849fSKiran Chandramohan 2904dc48849fSKiran Chandramohan mlir::LogicalResult 2905dc48849fSKiran Chandramohan matchAndRewrite(fir::StoreOp store, OpAdaptor adaptor, 2906dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2907dc48849fSKiran Chandramohan if (store.getValue().getType().isa<fir::BoxType>()) { 2908dc48849fSKiran Chandramohan // fir.box value is actually in memory, load it first before storing it. 2909dc48849fSKiran Chandramohan mlir::Location loc = store.getLoc(); 2910dc48849fSKiran Chandramohan mlir::Type boxPtrTy = adaptor.getOperands()[0].getType(); 2911dc48849fSKiran Chandramohan auto val = rewriter.create<mlir::LLVM::LoadOp>( 2912dc48849fSKiran Chandramohan loc, boxPtrTy.cast<mlir::LLVM::LLVMPointerType>().getElementType(), 2913dc48849fSKiran Chandramohan adaptor.getOperands()[0]); 2914dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::StoreOp>( 2915dc48849fSKiran Chandramohan store, val, adaptor.getOperands()[1]); 2916dc48849fSKiran Chandramohan } else { 2917dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::StoreOp>( 2918dc48849fSKiran Chandramohan store, adaptor.getOperands()[0], adaptor.getOperands()[1]); 2919dc48849fSKiran Chandramohan } 2920dc48849fSKiran Chandramohan return success(); 2921dc48849fSKiran Chandramohan } 2922dc48849fSKiran Chandramohan }; 2923dc48849fSKiran Chandramohan 2924dc48849fSKiran Chandramohan namespace { 2925dc48849fSKiran Chandramohan 2926dc48849fSKiran Chandramohan /// Convert `fir.unboxchar` into two `llvm.extractvalue` instructions. One for 2927dc48849fSKiran Chandramohan /// the character buffer and one for the buffer length. 2928dc48849fSKiran Chandramohan struct UnboxCharOpConversion : public FIROpConversion<fir::UnboxCharOp> { 2929dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2930dc48849fSKiran Chandramohan 2931dc48849fSKiran Chandramohan mlir::LogicalResult 2932dc48849fSKiran Chandramohan matchAndRewrite(fir::UnboxCharOp unboxchar, OpAdaptor adaptor, 2933dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2934dc48849fSKiran Chandramohan MLIRContext *ctx = unboxchar.getContext(); 2935dc48849fSKiran Chandramohan 2936dc48849fSKiran Chandramohan mlir::Type lenTy = convertType(unboxchar.getType(1)); 2937dc48849fSKiran Chandramohan mlir::Value tuple = adaptor.getOperands()[0]; 2938dc48849fSKiran Chandramohan mlir::Type tupleTy = tuple.getType(); 2939dc48849fSKiran Chandramohan 2940dc48849fSKiran Chandramohan mlir::Location loc = unboxchar.getLoc(); 2941dc48849fSKiran Chandramohan mlir::Value ptrToBuffer = 2942dc48849fSKiran Chandramohan genExtractValueWithIndex(loc, tuple, tupleTy, rewriter, ctx, 0); 2943dc48849fSKiran Chandramohan 2944dc48849fSKiran Chandramohan mlir::LLVM::ExtractValueOp len = 2945dc48849fSKiran Chandramohan genExtractValueWithIndex(loc, tuple, tupleTy, rewriter, ctx, 1); 2946dc48849fSKiran Chandramohan mlir::Value lenAfterCast = integerCast(loc, rewriter, lenTy, len); 2947dc48849fSKiran Chandramohan 2948dc48849fSKiran Chandramohan rewriter.replaceOp(unboxchar, 2949dc48849fSKiran Chandramohan ArrayRef<mlir::Value>{ptrToBuffer, lenAfterCast}); 2950dc48849fSKiran Chandramohan return success(); 2951dc48849fSKiran Chandramohan } 2952dc48849fSKiran Chandramohan }; 2953dc48849fSKiran Chandramohan 2954dc48849fSKiran Chandramohan /// Lower `fir.unboxproc` operation. Unbox a procedure box value, yielding its 2955dc48849fSKiran Chandramohan /// components. 2956dc48849fSKiran Chandramohan /// TODO: Part of supporting Fortran 2003 procedure pointers. 2957dc48849fSKiran Chandramohan struct UnboxProcOpConversion : public FIROpConversion<fir::UnboxProcOp> { 2958dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2959dc48849fSKiran Chandramohan 2960dc48849fSKiran Chandramohan mlir::LogicalResult 2961dc48849fSKiran Chandramohan matchAndRewrite(fir::UnboxProcOp unboxproc, OpAdaptor adaptor, 2962dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2963dc48849fSKiran Chandramohan TODO(unboxproc.getLoc(), "fir.unboxproc codegen"); 2964dc48849fSKiran Chandramohan return failure(); 2965dc48849fSKiran Chandramohan } 2966dc48849fSKiran Chandramohan }; 2967dc48849fSKiran Chandramohan 2968dc48849fSKiran Chandramohan /// convert to LLVM IR dialect `undef` 2969dc48849fSKiran Chandramohan struct UndefOpConversion : public FIROpConversion<fir::UndefOp> { 2970dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2971dc48849fSKiran Chandramohan 2972dc48849fSKiran Chandramohan mlir::LogicalResult 2973dc48849fSKiran Chandramohan matchAndRewrite(fir::UndefOp undef, OpAdaptor, 2974dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2975dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::UndefOp>( 2976dc48849fSKiran Chandramohan undef, convertType(undef.getType())); 2977dc48849fSKiran Chandramohan return success(); 2978dc48849fSKiran Chandramohan } 2979dc48849fSKiran Chandramohan }; 2980dc48849fSKiran Chandramohan 2981dc48849fSKiran Chandramohan struct ZeroOpConversion : public FIROpConversion<fir::ZeroOp> { 2982dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 2983dc48849fSKiran Chandramohan 2984dc48849fSKiran Chandramohan mlir::LogicalResult 2985dc48849fSKiran Chandramohan matchAndRewrite(fir::ZeroOp zero, OpAdaptor, 2986dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 2987dc48849fSKiran Chandramohan mlir::Type ty = convertType(zero.getType()); 2988dc48849fSKiran Chandramohan if (ty.isa<mlir::LLVM::LLVMPointerType>()) { 2989dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::NullOp>(zero, ty); 2990dc48849fSKiran Chandramohan } else if (ty.isa<mlir::IntegerType>()) { 2991dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::ConstantOp>( 2992dc48849fSKiran Chandramohan zero, ty, mlir::IntegerAttr::get(zero.getType(), 0)); 2993dc48849fSKiran Chandramohan } else if (mlir::LLVM::isCompatibleFloatingPointType(ty)) { 2994dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::ConstantOp>( 2995dc48849fSKiran Chandramohan zero, ty, mlir::FloatAttr::get(zero.getType(), 0.0)); 2996dc48849fSKiran Chandramohan } else { 2997dc48849fSKiran Chandramohan // TODO: create ConstantAggregateZero for FIR aggregate/array types. 2998dc48849fSKiran Chandramohan return rewriter.notifyMatchFailure( 2999dc48849fSKiran Chandramohan zero, 3000dc48849fSKiran Chandramohan "conversion of fir.zero with aggregate type not implemented yet"); 3001dc48849fSKiran Chandramohan } 3002dc48849fSKiran Chandramohan return success(); 3003dc48849fSKiran Chandramohan } 3004dc48849fSKiran Chandramohan }; 3005dc48849fSKiran Chandramohan 3006dc48849fSKiran Chandramohan /// `fir.unreachable` --> `llvm.unreachable` 3007dc48849fSKiran Chandramohan struct UnreachableOpConversion : public FIROpConversion<fir::UnreachableOp> { 3008dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 3009dc48849fSKiran Chandramohan 3010dc48849fSKiran Chandramohan mlir::LogicalResult 3011dc48849fSKiran Chandramohan matchAndRewrite(fir::UnreachableOp unreach, OpAdaptor adaptor, 3012dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 3013dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::UnreachableOp>(unreach); 3014dc48849fSKiran Chandramohan return success(); 3015dc48849fSKiran Chandramohan } 3016dc48849fSKiran Chandramohan }; 3017dc48849fSKiran Chandramohan 3018dc48849fSKiran Chandramohan /// `fir.is_present` --> 3019dc48849fSKiran Chandramohan /// ``` 3020dc48849fSKiran Chandramohan /// %0 = llvm.mlir.constant(0 : i64) 3021dc48849fSKiran Chandramohan /// %1 = llvm.ptrtoint %0 3022dc48849fSKiran Chandramohan /// %2 = llvm.icmp "ne" %1, %0 : i64 3023dc48849fSKiran Chandramohan /// ``` 3024dc48849fSKiran Chandramohan struct IsPresentOpConversion : public FIROpConversion<fir::IsPresentOp> { 3025dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 3026dc48849fSKiran Chandramohan 3027dc48849fSKiran Chandramohan mlir::LogicalResult 3028dc48849fSKiran Chandramohan matchAndRewrite(fir::IsPresentOp isPresent, OpAdaptor adaptor, 3029dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 3030dc48849fSKiran Chandramohan mlir::Type idxTy = lowerTy().indexType(); 3031dc48849fSKiran Chandramohan mlir::Location loc = isPresent.getLoc(); 3032dc48849fSKiran Chandramohan auto ptr = adaptor.getOperands()[0]; 3033dc48849fSKiran Chandramohan 3034dc48849fSKiran Chandramohan if (isPresent.getVal().getType().isa<fir::BoxCharType>()) { 3035dc48849fSKiran Chandramohan auto structTy = ptr.getType().cast<mlir::LLVM::LLVMStructType>(); 3036dc48849fSKiran Chandramohan assert(!structTy.isOpaque() && !structTy.getBody().empty()); 3037dc48849fSKiran Chandramohan 3038dc48849fSKiran Chandramohan mlir::Type ty = structTy.getBody()[0]; 3039dc48849fSKiran Chandramohan mlir::MLIRContext *ctx = isPresent.getContext(); 3040dc48849fSKiran Chandramohan auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 3041dc48849fSKiran Chandramohan ptr = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, ty, ptr, c0); 3042dc48849fSKiran Chandramohan } 3043dc48849fSKiran Chandramohan mlir::LLVM::ConstantOp c0 = 3044dc48849fSKiran Chandramohan genConstantIndex(isPresent.getLoc(), idxTy, rewriter, 0); 3045dc48849fSKiran Chandramohan auto addr = rewriter.create<mlir::LLVM::PtrToIntOp>(loc, idxTy, ptr); 3046dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::ICmpOp>( 3047dc48849fSKiran Chandramohan isPresent, mlir::LLVM::ICmpPredicate::ne, addr, c0); 3048dc48849fSKiran Chandramohan 3049dc48849fSKiran Chandramohan return success(); 3050dc48849fSKiran Chandramohan } 3051dc48849fSKiran Chandramohan }; 3052dc48849fSKiran Chandramohan 3053dc48849fSKiran Chandramohan /// Create value signaling an absent optional argument in a call, e.g. 3054dc48849fSKiran Chandramohan /// `fir.absent !fir.ref<i64>` --> `llvm.mlir.null : !llvm.ptr<i64>` 3055dc48849fSKiran Chandramohan struct AbsentOpConversion : public FIROpConversion<fir::AbsentOp> { 3056dc48849fSKiran Chandramohan using FIROpConversion::FIROpConversion; 3057dc48849fSKiran Chandramohan 3058dc48849fSKiran Chandramohan mlir::LogicalResult 3059dc48849fSKiran Chandramohan matchAndRewrite(fir::AbsentOp absent, OpAdaptor, 3060dc48849fSKiran Chandramohan mlir::ConversionPatternRewriter &rewriter) const override { 3061dc48849fSKiran Chandramohan mlir::Type ty = convertType(absent.getType()); 3062dc48849fSKiran Chandramohan mlir::Location loc = absent.getLoc(); 3063dc48849fSKiran Chandramohan 3064dc48849fSKiran Chandramohan if (absent.getType().isa<fir::BoxCharType>()) { 3065dc48849fSKiran Chandramohan auto structTy = ty.cast<mlir::LLVM::LLVMStructType>(); 3066dc48849fSKiran Chandramohan assert(!structTy.isOpaque() && !structTy.getBody().empty()); 3067dc48849fSKiran Chandramohan auto undefStruct = rewriter.create<mlir::LLVM::UndefOp>(loc, ty); 3068dc48849fSKiran Chandramohan auto nullField = 3069dc48849fSKiran Chandramohan rewriter.create<mlir::LLVM::NullOp>(loc, structTy.getBody()[0]); 3070dc48849fSKiran Chandramohan mlir::MLIRContext *ctx = absent.getContext(); 3071dc48849fSKiran Chandramohan auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 3072dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>( 3073dc48849fSKiran Chandramohan absent, ty, undefStruct, nullField, c0); 3074dc48849fSKiran Chandramohan } else { 3075dc48849fSKiran Chandramohan rewriter.replaceOpWithNewOp<mlir::LLVM::NullOp>(absent, ty); 3076dc48849fSKiran Chandramohan } 3077dc48849fSKiran Chandramohan return success(); 3078dc48849fSKiran Chandramohan } 3079dc48849fSKiran Chandramohan }; 30805d27abe6SValentin Clement 30817b5132daSValentin Clement // 30827b5132daSValentin Clement // Primitive operations on Complex types 30837b5132daSValentin Clement // 30847b5132daSValentin Clement 30857b5132daSValentin Clement /// Generate inline code for complex addition/subtraction 30867b5132daSValentin Clement template <typename LLVMOP, typename OPTY> 3087c2acd453SAlexisPerry static mlir::LLVM::InsertValueOp 3088c2acd453SAlexisPerry complexSum(OPTY sumop, mlir::ValueRange opnds, 30897b5132daSValentin Clement mlir::ConversionPatternRewriter &rewriter, 30907b5132daSValentin Clement fir::LLVMTypeConverter &lowering) { 30917b5132daSValentin Clement mlir::Value a = opnds[0]; 30927b5132daSValentin Clement mlir::Value b = opnds[1]; 30937b5132daSValentin Clement auto loc = sumop.getLoc(); 30947b5132daSValentin Clement auto ctx = sumop.getContext(); 30957b5132daSValentin Clement auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 30967b5132daSValentin Clement auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); 30977b5132daSValentin Clement mlir::Type eleTy = lowering.convertType(getComplexEleTy(sumop.getType())); 30987b5132daSValentin Clement mlir::Type ty = lowering.convertType(sumop.getType()); 30997b5132daSValentin Clement auto x0 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, a, c0); 31007b5132daSValentin Clement auto y0 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, a, c1); 31017b5132daSValentin Clement auto x1 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, b, c0); 31027b5132daSValentin Clement auto y1 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, b, c1); 31037b5132daSValentin Clement auto rx = rewriter.create<LLVMOP>(loc, eleTy, x0, x1); 31047b5132daSValentin Clement auto ry = rewriter.create<LLVMOP>(loc, eleTy, y0, y1); 31057b5132daSValentin Clement auto r0 = rewriter.create<mlir::LLVM::UndefOp>(loc, ty); 31067b5132daSValentin Clement auto r1 = rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, r0, rx, c0); 31077b5132daSValentin Clement return rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, r1, ry, c1); 31087b5132daSValentin Clement } 3109dc48849fSKiran Chandramohan } // namespace 31107b5132daSValentin Clement 3111c2acd453SAlexisPerry namespace { 31127b5132daSValentin Clement struct AddcOpConversion : public FIROpConversion<fir::AddcOp> { 31137b5132daSValentin Clement using FIROpConversion::FIROpConversion; 31147b5132daSValentin Clement 31157b5132daSValentin Clement mlir::LogicalResult 31167b5132daSValentin Clement matchAndRewrite(fir::AddcOp addc, OpAdaptor adaptor, 31177b5132daSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 31187b5132daSValentin Clement // given: (x + iy) + (x' + iy') 31197b5132daSValentin Clement // result: (x + x') + i(y + y') 31207b5132daSValentin Clement auto r = complexSum<mlir::LLVM::FAddOp>(addc, adaptor.getOperands(), 31217b5132daSValentin Clement rewriter, lowerTy()); 31227b5132daSValentin Clement rewriter.replaceOp(addc, r.getResult()); 31237b5132daSValentin Clement return success(); 31247b5132daSValentin Clement } 31257b5132daSValentin Clement }; 31267b5132daSValentin Clement 31277b5132daSValentin Clement struct SubcOpConversion : public FIROpConversion<fir::SubcOp> { 31287b5132daSValentin Clement using FIROpConversion::FIROpConversion; 31297b5132daSValentin Clement 31307b5132daSValentin Clement mlir::LogicalResult 31317b5132daSValentin Clement matchAndRewrite(fir::SubcOp subc, OpAdaptor adaptor, 31327b5132daSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 31337b5132daSValentin Clement // given: (x + iy) - (x' + iy') 31347b5132daSValentin Clement // result: (x - x') + i(y - y') 31357b5132daSValentin Clement auto r = complexSum<mlir::LLVM::FSubOp>(subc, adaptor.getOperands(), 31367b5132daSValentin Clement rewriter, lowerTy()); 31377b5132daSValentin Clement rewriter.replaceOp(subc, r.getResult()); 31387b5132daSValentin Clement return success(); 31397b5132daSValentin Clement } 31407b5132daSValentin Clement }; 31417b5132daSValentin Clement 31427b5132daSValentin Clement /// Inlined complex multiply 31437b5132daSValentin Clement struct MulcOpConversion : public FIROpConversion<fir::MulcOp> { 31447b5132daSValentin Clement using FIROpConversion::FIROpConversion; 31457b5132daSValentin Clement 31467b5132daSValentin Clement mlir::LogicalResult 31477b5132daSValentin Clement matchAndRewrite(fir::MulcOp mulc, OpAdaptor adaptor, 31487b5132daSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 31497b5132daSValentin Clement // TODO: Can we use a call to __muldc3 ? 31507b5132daSValentin Clement // given: (x + iy) * (x' + iy') 31517b5132daSValentin Clement // result: (xx'-yy')+i(xy'+yx') 31527b5132daSValentin Clement mlir::Value a = adaptor.getOperands()[0]; 31537b5132daSValentin Clement mlir::Value b = adaptor.getOperands()[1]; 31547b5132daSValentin Clement auto loc = mulc.getLoc(); 31557b5132daSValentin Clement auto *ctx = mulc.getContext(); 31567b5132daSValentin Clement auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 31577b5132daSValentin Clement auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); 31587b5132daSValentin Clement mlir::Type eleTy = convertType(getComplexEleTy(mulc.getType())); 31597b5132daSValentin Clement mlir::Type ty = convertType(mulc.getType()); 31607b5132daSValentin Clement auto x0 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, a, c0); 31617b5132daSValentin Clement auto y0 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, a, c1); 31627b5132daSValentin Clement auto x1 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, b, c0); 31637b5132daSValentin Clement auto y1 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, b, c1); 31647b5132daSValentin Clement auto xx = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, x0, x1); 31657b5132daSValentin Clement auto yx = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, y0, x1); 31667b5132daSValentin Clement auto xy = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, x0, y1); 31677b5132daSValentin Clement auto ri = rewriter.create<mlir::LLVM::FAddOp>(loc, eleTy, xy, yx); 31687b5132daSValentin Clement auto yy = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, y0, y1); 31697b5132daSValentin Clement auto rr = rewriter.create<mlir::LLVM::FSubOp>(loc, eleTy, xx, yy); 31707b5132daSValentin Clement auto ra = rewriter.create<mlir::LLVM::UndefOp>(loc, ty); 31717b5132daSValentin Clement auto r1 = rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, ra, rr, c0); 31727b5132daSValentin Clement auto r0 = rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, r1, ri, c1); 31737b5132daSValentin Clement rewriter.replaceOp(mulc, r0.getResult()); 31747b5132daSValentin Clement return success(); 31757b5132daSValentin Clement } 31767b5132daSValentin Clement }; 31777b5132daSValentin Clement 31787b5132daSValentin Clement /// Inlined complex division 31797b5132daSValentin Clement struct DivcOpConversion : public FIROpConversion<fir::DivcOp> { 31807b5132daSValentin Clement using FIROpConversion::FIROpConversion; 31817b5132daSValentin Clement 31827b5132daSValentin Clement mlir::LogicalResult 31837b5132daSValentin Clement matchAndRewrite(fir::DivcOp divc, OpAdaptor adaptor, 31847b5132daSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 31857b5132daSValentin Clement // TODO: Can we use a call to __divdc3 instead? 31867b5132daSValentin Clement // Just generate inline code for now. 31877b5132daSValentin Clement // given: (x + iy) / (x' + iy') 31887b5132daSValentin Clement // result: ((xx'+yy')/d) + i((yx'-xy')/d) where d = x'x' + y'y' 31897b5132daSValentin Clement mlir::Value a = adaptor.getOperands()[0]; 31907b5132daSValentin Clement mlir::Value b = adaptor.getOperands()[1]; 31917b5132daSValentin Clement auto loc = divc.getLoc(); 31927b5132daSValentin Clement auto *ctx = divc.getContext(); 31937b5132daSValentin Clement auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); 31947b5132daSValentin Clement auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); 31957b5132daSValentin Clement mlir::Type eleTy = convertType(getComplexEleTy(divc.getType())); 31967b5132daSValentin Clement mlir::Type ty = convertType(divc.getType()); 31977b5132daSValentin Clement auto x0 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, a, c0); 31987b5132daSValentin Clement auto y0 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, a, c1); 31997b5132daSValentin Clement auto x1 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, b, c0); 32007b5132daSValentin Clement auto y1 = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, b, c1); 32017b5132daSValentin Clement auto xx = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, x0, x1); 32027b5132daSValentin Clement auto x1x1 = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, x1, x1); 32037b5132daSValentin Clement auto yx = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, y0, x1); 32047b5132daSValentin Clement auto xy = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, x0, y1); 32057b5132daSValentin Clement auto yy = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, y0, y1); 32067b5132daSValentin Clement auto y1y1 = rewriter.create<mlir::LLVM::FMulOp>(loc, eleTy, y1, y1); 32077b5132daSValentin Clement auto d = rewriter.create<mlir::LLVM::FAddOp>(loc, eleTy, x1x1, y1y1); 32087b5132daSValentin Clement auto rrn = rewriter.create<mlir::LLVM::FAddOp>(loc, eleTy, xx, yy); 32097b5132daSValentin Clement auto rin = rewriter.create<mlir::LLVM::FSubOp>(loc, eleTy, yx, xy); 32107b5132daSValentin Clement auto rr = rewriter.create<mlir::LLVM::FDivOp>(loc, eleTy, rrn, d); 32117b5132daSValentin Clement auto ri = rewriter.create<mlir::LLVM::FDivOp>(loc, eleTy, rin, d); 32127b5132daSValentin Clement auto ra = rewriter.create<mlir::LLVM::UndefOp>(loc, ty); 32137b5132daSValentin Clement auto r1 = rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, ra, rr, c0); 32147b5132daSValentin Clement auto r0 = rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, r1, ri, c1); 32157b5132daSValentin Clement rewriter.replaceOp(divc, r0.getResult()); 32167b5132daSValentin Clement return success(); 32177b5132daSValentin Clement } 32187b5132daSValentin Clement }; 32197b5132daSValentin Clement 32207b5132daSValentin Clement /// Inlined complex negation 32217b5132daSValentin Clement struct NegcOpConversion : public FIROpConversion<fir::NegcOp> { 32227b5132daSValentin Clement using FIROpConversion::FIROpConversion; 32237b5132daSValentin Clement 32247b5132daSValentin Clement mlir::LogicalResult 32257b5132daSValentin Clement matchAndRewrite(fir::NegcOp neg, OpAdaptor adaptor, 32267b5132daSValentin Clement mlir::ConversionPatternRewriter &rewriter) const override { 32277b5132daSValentin Clement // given: -(x + iy) 32287b5132daSValentin Clement // result: -x - iy 32297b5132daSValentin Clement auto *ctxt = neg.getContext(); 32307b5132daSValentin Clement auto eleTy = convertType(getComplexEleTy(neg.getType())); 32317b5132daSValentin Clement auto ty = convertType(neg.getType()); 32327b5132daSValentin Clement auto loc = neg.getLoc(); 32337b5132daSValentin Clement mlir::Value o0 = adaptor.getOperands()[0]; 32347b5132daSValentin Clement auto c0 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(0)); 32357b5132daSValentin Clement auto c1 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(1)); 32367b5132daSValentin Clement auto rp = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, o0, c0); 32377b5132daSValentin Clement auto ip = rewriter.create<mlir::LLVM::ExtractValueOp>(loc, eleTy, o0, c1); 32387b5132daSValentin Clement auto nrp = rewriter.create<mlir::LLVM::FNegOp>(loc, eleTy, rp); 32397b5132daSValentin Clement auto nip = rewriter.create<mlir::LLVM::FNegOp>(loc, eleTy, ip); 32407b5132daSValentin Clement auto r = rewriter.create<mlir::LLVM::InsertValueOp>(loc, ty, o0, nrp, c0); 32417b5132daSValentin Clement rewriter.replaceOpWithNewOp<mlir::LLVM::InsertValueOp>(neg, ty, r, nip, c1); 32427b5132daSValentin Clement return success(); 32437b5132daSValentin Clement } 32447b5132daSValentin Clement }; 32457b5132daSValentin Clement 32461ed5a90fSValentin Clement /// Conversion pattern for operation that must be dead. The information in these 32471ed5a90fSValentin Clement /// operations is used by other operation. At this point they should not have 32481ed5a90fSValentin Clement /// anymore uses. 32491ed5a90fSValentin Clement /// These operations are normally dead after the pre-codegen pass. 32501ed5a90fSValentin Clement template <typename FromOp> 32511ed5a90fSValentin Clement struct MustBeDeadConversion : public FIROpConversion<FromOp> { 3252013160f6SJean Perier explicit MustBeDeadConversion(fir::LLVMTypeConverter &lowering, 3253013160f6SJean Perier const fir::FIRToLLVMPassOptions &options) 3254013160f6SJean Perier : FIROpConversion<FromOp>(lowering, options) {} 32551ed5a90fSValentin Clement using OpAdaptor = typename FromOp::Adaptor; 32561ed5a90fSValentin Clement 32571ed5a90fSValentin Clement mlir::LogicalResult 32581ed5a90fSValentin Clement matchAndRewrite(FromOp op, OpAdaptor adaptor, 32591ed5a90fSValentin Clement mlir::ConversionPatternRewriter &rewriter) const final { 32601ed5a90fSValentin Clement if (!op->getUses().empty()) 32611ed5a90fSValentin Clement return rewriter.notifyMatchFailure(op, "op must be dead"); 32621ed5a90fSValentin Clement rewriter.eraseOp(op); 32631ed5a90fSValentin Clement return success(); 32641ed5a90fSValentin Clement } 32651ed5a90fSValentin Clement }; 32661ed5a90fSValentin Clement 32671ed5a90fSValentin Clement struct ShapeOpConversion : public MustBeDeadConversion<fir::ShapeOp> { 32681ed5a90fSValentin Clement using MustBeDeadConversion::MustBeDeadConversion; 32691ed5a90fSValentin Clement }; 32701ed5a90fSValentin Clement 32711ed5a90fSValentin Clement struct ShapeShiftOpConversion : public MustBeDeadConversion<fir::ShapeShiftOp> { 32721ed5a90fSValentin Clement using MustBeDeadConversion::MustBeDeadConversion; 32731ed5a90fSValentin Clement }; 32741ed5a90fSValentin Clement 32751ed5a90fSValentin Clement struct ShiftOpConversion : public MustBeDeadConversion<fir::ShiftOp> { 32761ed5a90fSValentin Clement using MustBeDeadConversion::MustBeDeadConversion; 32771ed5a90fSValentin Clement }; 32781ed5a90fSValentin Clement 32791ed5a90fSValentin Clement struct SliceOpConversion : public MustBeDeadConversion<fir::SliceOp> { 32801ed5a90fSValentin Clement using MustBeDeadConversion::MustBeDeadConversion; 32811ed5a90fSValentin Clement }; 32821ed5a90fSValentin Clement 3283044d5b5dSValentin Clement } // namespace 3284044d5b5dSValentin Clement 3285044d5b5dSValentin Clement namespace { 3286044d5b5dSValentin Clement /// Convert FIR dialect to LLVM dialect 3287044d5b5dSValentin Clement /// 3288044d5b5dSValentin Clement /// This pass lowers all FIR dialect operations to LLVM IR dialect. An 3289044d5b5dSValentin Clement /// MLIR pass is used to lower residual Std dialect to LLVM IR dialect. 3290044d5b5dSValentin Clement /// 3291044d5b5dSValentin Clement /// This pass is not complete yet. We are upstreaming it in small patches. 3292044d5b5dSValentin Clement class FIRToLLVMLowering : public fir::FIRToLLVMLoweringBase<FIRToLLVMLowering> { 3293044d5b5dSValentin Clement public: 3294013160f6SJean Perier FIRToLLVMLowering() = default; 3295013160f6SJean Perier FIRToLLVMLowering(fir::FIRToLLVMPassOptions options) : options{options} {} 3296044d5b5dSValentin Clement mlir::ModuleOp getModule() { return getOperation(); } 3297044d5b5dSValentin Clement 3298044d5b5dSValentin Clement void runOnOperation() override final { 32997b5132daSValentin Clement auto mod = getModule(); 33007b5132daSValentin Clement if (!forcedTargetTriple.empty()) { 33017b5132daSValentin Clement fir::setTargetTriple(mod, forcedTargetTriple); 33027b5132daSValentin Clement } 33037b5132daSValentin Clement 3304044d5b5dSValentin Clement auto *context = getModule().getContext(); 3305044d5b5dSValentin Clement fir::LLVMTypeConverter typeConverter{getModule()}; 33069f85c198SRiver Riddle mlir::RewritePatternSet pattern(context); 3307df3b9810SValentin Clement pattern.insert< 3308420ad7ceSAndrzej Warzynski AbsentOpConversion, AddcOpConversion, AddrOfOpConversion, 3309c2acd453SAlexisPerry AllocaOpConversion, AllocMemOpConversion, BoxAddrOpConversion, 3310c2acd453SAlexisPerry BoxCharLenOpConversion, BoxDimsOpConversion, BoxEleSizeOpConversion, 3311c2acd453SAlexisPerry BoxIsAllocOpConversion, BoxIsArrayOpConversion, BoxIsPtrOpConversion, 3312c2acd453SAlexisPerry BoxProcHostOpConversion, BoxRankOpConversion, BoxTypeDescOpConversion, 3313c2acd453SAlexisPerry CallOpConversion, CmpcOpConversion, ConstcOpConversion, 3314e6e7da55SAndrzej Warzynski ConvertOpConversion, CoordinateOpConversion, DispatchOpConversion, 3315e6e7da55SAndrzej Warzynski DispatchTableOpConversion, DTEntryOpConversion, DivcOpConversion, 3316e6e7da55SAndrzej Warzynski EmboxOpConversion, EmboxCharOpConversion, EmboxProcOpConversion, 3317e6e7da55SAndrzej Warzynski ExtractValueOpConversion, FieldIndexOpConversion, FirEndOpConversion, 3318dc48849fSKiran Chandramohan FreeMemOpConversion, GenTypeDescOpConversion, GlobalLenOpConversion, 3319dc48849fSKiran Chandramohan GlobalOpConversion, HasValueOpConversion, InsertOnRangeOpConversion, 3320e6e7da55SAndrzej Warzynski InsertValueOpConversion, IsPresentOpConversion, 3321dc48849fSKiran Chandramohan LenParamIndexOpConversion, LoadOpConversion, MulcOpConversion, 3322dc48849fSKiran Chandramohan NegcOpConversion, NoReassocOpConversion, SelectCaseOpConversion, 3323e6e7da55SAndrzej Warzynski SelectOpConversion, SelectRankOpConversion, SelectTypeOpConversion, 3324e6e7da55SAndrzej Warzynski ShapeOpConversion, ShapeShiftOpConversion, ShiftOpConversion, 3325e6e7da55SAndrzej Warzynski SliceOpConversion, StoreOpConversion, StringLitOpConversion, 3326e6e7da55SAndrzej Warzynski SubcOpConversion, UnboxCharOpConversion, UnboxProcOpConversion, 3327e6e7da55SAndrzej Warzynski UndefOpConversion, UnreachableOpConversion, XArrayCoorOpConversion, 3328013160f6SJean Perier XEmboxOpConversion, XReboxOpConversion, ZeroOpConversion>(typeConverter, 3329013160f6SJean Perier options); 33305a7b9194SRiver Riddle mlir::populateFuncToLLVMConversionPatterns(typeConverter, pattern); 3331044d5b5dSValentin Clement mlir::arith::populateArithmeticToLLVMConversionPatterns(typeConverter, 3332044d5b5dSValentin Clement pattern); 3333ace01605SRiver Riddle mlir::cf::populateControlFlowToLLVMConversionPatterns(typeConverter, 3334ace01605SRiver Riddle pattern); 3335044d5b5dSValentin Clement mlir::ConversionTarget target{*context}; 3336044d5b5dSValentin Clement target.addLegalDialect<mlir::LLVM::LLVMDialect>(); 3337044d5b5dSValentin Clement 3338044d5b5dSValentin Clement // required NOPs for applying a full conversion 3339044d5b5dSValentin Clement target.addLegalOp<mlir::ModuleOp>(); 3340044d5b5dSValentin Clement 3341044d5b5dSValentin Clement // apply the patterns 3342044d5b5dSValentin Clement if (mlir::failed(mlir::applyFullConversion(getModule(), target, 3343044d5b5dSValentin Clement std::move(pattern)))) { 3344044d5b5dSValentin Clement signalPassFailure(); 3345044d5b5dSValentin Clement } 3346044d5b5dSValentin Clement } 3347013160f6SJean Perier 3348013160f6SJean Perier private: 3349013160f6SJean Perier fir::FIRToLLVMPassOptions options; 3350044d5b5dSValentin Clement }; 3351853e79d8SValentin Clement 3352853e79d8SValentin Clement /// Lower from LLVM IR dialect to proper LLVM-IR and dump the module 3353853e79d8SValentin Clement struct LLVMIRLoweringPass 3354853e79d8SValentin Clement : public mlir::PassWrapper<LLVMIRLoweringPass, 3355853e79d8SValentin Clement mlir::OperationPass<mlir::ModuleOp>> { 3356853e79d8SValentin Clement using Printer = fir::LLVMIRLoweringPrinter; 3357853e79d8SValentin Clement LLVMIRLoweringPass(raw_ostream &output, Printer p) 3358853e79d8SValentin Clement : output{output}, printer{p} {} 3359853e79d8SValentin Clement 3360853e79d8SValentin Clement mlir::ModuleOp getModule() { return getOperation(); } 3361853e79d8SValentin Clement 3362853e79d8SValentin Clement void runOnOperation() override final { 3363853e79d8SValentin Clement auto *ctx = getModule().getContext(); 3364853e79d8SValentin Clement auto optName = getModule().getName(); 3365853e79d8SValentin Clement llvm::LLVMContext llvmCtx; 3366853e79d8SValentin Clement if (auto llvmModule = mlir::translateModuleToLLVMIR( 3367853e79d8SValentin Clement getModule(), llvmCtx, optName ? *optName : "FIRModule")) { 3368853e79d8SValentin Clement printer(*llvmModule, output); 3369853e79d8SValentin Clement return; 3370853e79d8SValentin Clement } 3371853e79d8SValentin Clement 3372853e79d8SValentin Clement mlir::emitError(mlir::UnknownLoc::get(ctx), "could not emit LLVM-IR\n"); 3373853e79d8SValentin Clement signalPassFailure(); 3374853e79d8SValentin Clement } 3375853e79d8SValentin Clement 3376853e79d8SValentin Clement private: 3377853e79d8SValentin Clement raw_ostream &output; 3378853e79d8SValentin Clement Printer printer; 3379853e79d8SValentin Clement }; 3380853e79d8SValentin Clement 3381044d5b5dSValentin Clement } // namespace 3382044d5b5dSValentin Clement 3383044d5b5dSValentin Clement std::unique_ptr<mlir::Pass> fir::createFIRToLLVMPass() { 3384044d5b5dSValentin Clement return std::make_unique<FIRToLLVMLowering>(); 3385044d5b5dSValentin Clement } 3386853e79d8SValentin Clement 3387853e79d8SValentin Clement std::unique_ptr<mlir::Pass> 3388013160f6SJean Perier fir::createFIRToLLVMPass(FIRToLLVMPassOptions options) { 3389013160f6SJean Perier return std::make_unique<FIRToLLVMLowering>(options); 3390013160f6SJean Perier } 3391013160f6SJean Perier 3392013160f6SJean Perier std::unique_ptr<mlir::Pass> 3393853e79d8SValentin Clement fir::createLLVMDialectToLLVMPass(raw_ostream &output, 3394853e79d8SValentin Clement fir::LLVMIRLoweringPrinter printer) { 3395853e79d8SValentin Clement return std::make_unique<LLVMIRLoweringPass>(output, printer); 3396853e79d8SValentin Clement } 3397