//===-- CodeGen.cpp -- bridge to lower to LLVM ----------------------------===// // // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // See https://llvm.org/LICENSE.txt for license information. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // //===----------------------------------------------------------------------===// // // Coding style: https://mlir.llvm.org/getting_started/DeveloperGuide/ // //===----------------------------------------------------------------------===// #include "flang/Optimizer/CodeGen/CodeGen.h" #include "CGOps.h" #include "PassDetail.h" #include "flang/ISO_Fortran_binding.h" #include "flang/Optimizer/Dialect/FIRAttr.h" #include "flang/Optimizer/Dialect/FIROps.h" #include "flang/Optimizer/Support/TypeCode.h" #include "mlir/Conversion/ArithmeticToLLVM/ArithmeticToLLVM.h" #include "mlir/Conversion/ControlFlowToLLVM/ControlFlowToLLVM.h" #include "mlir/Conversion/LLVMCommon/Pattern.h" #include "mlir/Conversion/StandardToLLVM/ConvertStandardToLLVM.h" #include "mlir/IR/BuiltinTypes.h" #include "mlir/IR/Matchers.h" #include "mlir/Pass/Pass.h" #include "mlir/Target/LLVMIR/ModuleTranslation.h" #include "llvm/ADT/ArrayRef.h" #define DEBUG_TYPE "flang-codegen" // fir::LLVMTypeConverter for converting to LLVM IR dialect types. #include "TypeConverter.h" // TODO: This should really be recovered from the specified target. static constexpr unsigned defaultAlign = 8; /// `fir.box` attribute values as defined for CFI_attribute_t in /// flang/ISO_Fortran_binding.h. static constexpr unsigned kAttrPointer = CFI_attribute_pointer; static constexpr unsigned kAttrAllocatable = CFI_attribute_allocatable; static inline mlir::Type getVoidPtrType(mlir::MLIRContext *context) { return mlir::LLVM::LLVMPointerType::get(mlir::IntegerType::get(context, 8)); } static mlir::LLVM::ConstantOp genConstantIndex(mlir::Location loc, mlir::Type ity, mlir::ConversionPatternRewriter &rewriter, std::int64_t offset) { auto cattr = rewriter.getI64IntegerAttr(offset); return rewriter.create(loc, ity, cattr); } static Block *createBlock(mlir::ConversionPatternRewriter &rewriter, mlir::Block *insertBefore) { assert(insertBefore && "expected valid insertion block"); return rewriter.createBlock(insertBefore->getParent(), mlir::Region::iterator(insertBefore)); } namespace { /// FIR conversion pattern template template class FIROpConversion : public mlir::ConvertOpToLLVMPattern { public: explicit FIROpConversion(fir::LLVMTypeConverter &lowering) : mlir::ConvertOpToLLVMPattern(lowering) {} protected: mlir::Type convertType(mlir::Type ty) const { return lowerTy().convertType(ty); } mlir::Type voidPtrTy() const { return getVoidPtrType(); } mlir::Type getVoidPtrType() const { return mlir::LLVM::LLVMPointerType::get( mlir::IntegerType::get(&lowerTy().getContext(), 8)); } mlir::LLVM::ConstantOp genI32Constant(mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, int value) const { mlir::Type i32Ty = rewriter.getI32Type(); mlir::IntegerAttr attr = rewriter.getI32IntegerAttr(value); return rewriter.create(loc, i32Ty, attr); } mlir::LLVM::ConstantOp genConstantOffset(mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, int offset) const { mlir::Type ity = lowerTy().offsetType(); mlir::IntegerAttr cattr = rewriter.getI32IntegerAttr(offset); return rewriter.create(loc, ity, cattr); } /// Construct code sequence to extract the specifc value from a `fir.box`. mlir::Value getValueFromBox(mlir::Location loc, mlir::Value box, mlir::Type resultTy, mlir::ConversionPatternRewriter &rewriter, unsigned boxValue) const { mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); mlir::LLVM::ConstantOp cValuePos = genConstantOffset(loc, rewriter, boxValue); auto pty = mlir::LLVM::LLVMPointerType::get(resultTy); auto p = rewriter.create( loc, pty, box, mlir::ValueRange{c0, cValuePos}); return rewriter.create(loc, resultTy, p); } /// Method to construct code sequence to get the triple for dimension `dim` /// from a box. SmallVector getDimsFromBox(mlir::Location loc, ArrayRef retTys, mlir::Value box, mlir::Value dim, mlir::ConversionPatternRewriter &rewriter) const { mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); mlir::LLVM::ConstantOp cDims = genConstantOffset(loc, rewriter, kDimsPosInBox); mlir::LLVM::LoadOp l0 = loadFromOffset(loc, box, c0, cDims, dim, 0, retTys[0], rewriter); mlir::LLVM::LoadOp l1 = loadFromOffset(loc, box, c0, cDims, dim, 1, retTys[1], rewriter); mlir::LLVM::LoadOp l2 = loadFromOffset(loc, box, c0, cDims, dim, 2, retTys[2], rewriter); return {l0.getResult(), l1.getResult(), l2.getResult()}; } mlir::LLVM::LoadOp loadFromOffset(mlir::Location loc, mlir::Value a, mlir::LLVM::ConstantOp c0, mlir::LLVM::ConstantOp cDims, mlir::Value dim, int off, mlir::Type ty, mlir::ConversionPatternRewriter &rewriter) const { auto pty = mlir::LLVM::LLVMPointerType::get(ty); mlir::LLVM::ConstantOp c = genConstantOffset(loc, rewriter, off); mlir::LLVM::GEPOp p = genGEP(loc, pty, rewriter, a, c0, cDims, dim, c); return rewriter.create(loc, ty, p); } mlir::Value loadStrideFromBox(mlir::Location loc, mlir::Value box, unsigned dim, mlir::ConversionPatternRewriter &rewriter) const { auto idxTy = lowerTy().indexType(); auto c0 = genConstantOffset(loc, rewriter, 0); auto cDims = genConstantOffset(loc, rewriter, kDimsPosInBox); auto dimValue = genConstantIndex(loc, idxTy, rewriter, dim); return loadFromOffset(loc, box, c0, cDims, dimValue, kDimStridePos, idxTy, rewriter); } /// Read base address from a fir.box. Returned address has type ty. mlir::Value loadBaseAddrFromBox(mlir::Location loc, mlir::Type ty, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const { mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); mlir::LLVM::ConstantOp cAddr = genConstantOffset(loc, rewriter, kAddrPosInBox); auto pty = mlir::LLVM::LLVMPointerType::get(ty); mlir::LLVM::GEPOp p = genGEP(loc, pty, rewriter, box, c0, cAddr); return rewriter.create(loc, ty, p); } mlir::Value loadElementSizeFromBox(mlir::Location loc, mlir::Type ty, mlir::Value box, mlir::ConversionPatternRewriter &rewriter) const { mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); mlir::LLVM::ConstantOp cElemLen = genConstantOffset(loc, rewriter, kElemLenPosInBox); auto pty = mlir::LLVM::LLVMPointerType::get(ty); mlir::LLVM::GEPOp p = genGEP(loc, pty, rewriter, box, c0, cElemLen); return rewriter.create(loc, ty, p); } // Load the attribute from the \p box and perform a check against \p maskValue // The final comparison is implemented as `(attribute & maskValue) != 0`. mlir::Value genBoxAttributeCheck(mlir::Location loc, mlir::Value box, mlir::ConversionPatternRewriter &rewriter, unsigned maskValue) const { mlir::Type attrTy = rewriter.getI32Type(); mlir::Value attribute = getValueFromBox(loc, box, attrTy, rewriter, kAttributePosInBox); mlir::LLVM::ConstantOp attrMask = genConstantOffset(loc, rewriter, maskValue); auto maskRes = rewriter.create(loc, attrTy, attribute, attrMask); mlir::LLVM::ConstantOp c0 = genConstantOffset(loc, rewriter, 0); return rewriter.create( loc, mlir::LLVM::ICmpPredicate::ne, maskRes, c0); } // Get the element type given an LLVM type that is of the form // [llvm.ptr](array|struct|vector)+ and the provided indexes. static mlir::Type getBoxEleTy(mlir::Type type, llvm::ArrayRef indexes) { if (auto t = type.dyn_cast()) type = t.getElementType(); for (auto i : indexes) { if (auto t = type.dyn_cast()) { assert(!t.isOpaque() && i < t.getBody().size()); type = t.getBody()[i]; } else if (auto t = type.dyn_cast()) { type = t.getElementType(); } else if (auto t = type.dyn_cast()) { type = t.getElementType(); } else { fir::emitFatalError(mlir::UnknownLoc::get(type.getContext()), "request for invalid box element type"); } } return type; } // Return LLVM type of the base address given the LLVM type // of the related descriptor (lowered fir.box type). static mlir::Type getBaseAddrTypeFromBox(mlir::Type type) { return getBoxEleTy(type, {kAddrPosInBox}); } template mlir::LLVM::GEPOp genGEP(mlir::Location loc, mlir::Type ty, mlir::ConversionPatternRewriter &rewriter, mlir::Value base, ARGS... args) const { SmallVector cv{args...}; return rewriter.create(loc, ty, base, cv); } /// Perform an extension or truncation as needed on an integer value. Lowering /// to the specific target may involve some sign-extending or truncation of /// values, particularly to fit them from abstract box types to the /// appropriate reified structures. mlir::Value integerCast(mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, mlir::Type ty, mlir::Value val) const { auto valTy = val.getType(); // If the value was not yet lowered, lower its type so that it can // be used in getPrimitiveTypeSizeInBits. if (!valTy.isa()) valTy = convertType(valTy); auto toSize = mlir::LLVM::getPrimitiveTypeSizeInBits(ty); auto fromSize = mlir::LLVM::getPrimitiveTypeSizeInBits(valTy); if (toSize < fromSize) return rewriter.create(loc, ty, val); if (toSize > fromSize) return rewriter.create(loc, ty, val); return val; } fir::LLVMTypeConverter &lowerTy() const { return *static_cast(this->getTypeConverter()); } }; /// FIR conversion pattern template template class FIROpAndTypeConversion : public FIROpConversion { public: using FIROpConversion::FIROpConversion; using OpAdaptor = typename FromOp::Adaptor; mlir::LogicalResult matchAndRewrite(FromOp op, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const final { mlir::Type ty = this->convertType(op.getType()); return doRewrite(op, ty, adaptor, rewriter); } virtual mlir::LogicalResult doRewrite(FromOp addr, mlir::Type ty, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const = 0; }; /// Create value signaling an absent optional argument in a call, e.g. /// `fir.absent !fir.ref` --> `llvm.mlir.null : !llvm.ptr` struct AbsentOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::AbsentOp absent, OpAdaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Type ty = convertType(absent.getType()); mlir::Location loc = absent.getLoc(); if (absent.getType().isa()) { auto structTy = ty.cast(); assert(!structTy.isOpaque() && !structTy.getBody().empty()); auto undefStruct = rewriter.create(loc, ty); auto nullField = rewriter.create(loc, structTy.getBody()[0]); mlir::MLIRContext *ctx = absent.getContext(); auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); rewriter.replaceOpWithNewOp( absent, ty, undefStruct, nullField, c0); } else { rewriter.replaceOpWithNewOp(absent, ty); } return success(); } }; // Lower `fir.address_of` operation to `llvm.address_of` operation. struct AddrOfOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::AddrOfOp addr, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto ty = convertType(addr.getType()); rewriter.replaceOpWithNewOp( addr, ty, addr.symbol().getRootReference().getValue()); return success(); } }; } // namespace /// Lookup the function to compute the memory size of this parametric derived /// type. The size of the object may depend on the LEN type parameters of the /// derived type. static mlir::LLVM::LLVMFuncOp getDependentTypeMemSizeFn(fir::RecordType recTy, fir::AllocaOp op, mlir::ConversionPatternRewriter &rewriter) { auto module = op->getParentOfType(); std::string name = recTy.getName().str() + "P.mem.size"; return module.lookupSymbol(name); } namespace { /// convert to LLVM IR dialect `alloca` struct AllocaOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::AllocaOp alloc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::ValueRange operands = adaptor.getOperands(); auto loc = alloc.getLoc(); mlir::Type ity = lowerTy().indexType(); unsigned i = 0; mlir::Value size = genConstantIndex(loc, ity, rewriter, 1).getResult(); mlir::Type ty = convertType(alloc.getType()); mlir::Type resultTy = ty; if (alloc.hasLenParams()) { unsigned end = alloc.numLenParams(); llvm::SmallVector lenParams; for (; i < end; ++i) lenParams.push_back(operands[i]); mlir::Type scalarType = fir::unwrapSequenceType(alloc.getInType()); if (auto chrTy = scalarType.dyn_cast()) { fir::CharacterType rawCharTy = fir::CharacterType::getUnknownLen( chrTy.getContext(), chrTy.getFKind()); ty = mlir::LLVM::LLVMPointerType::get(convertType(rawCharTy)); assert(end == 1); size = integerCast(loc, rewriter, ity, lenParams[0]); } else if (auto recTy = scalarType.dyn_cast()) { mlir::LLVM::LLVMFuncOp memSizeFn = getDependentTypeMemSizeFn(recTy, alloc, rewriter); if (!memSizeFn) emitError(loc, "did not find allocation function"); mlir::NamedAttribute attr = rewriter.getNamedAttr( "callee", mlir::SymbolRefAttr::get(memSizeFn)); auto call = rewriter.create( loc, ity, lenParams, llvm::ArrayRef{attr}); size = call.getResult(0); ty = mlir::LLVM::LLVMPointerType::get( mlir::IntegerType::get(alloc.getContext(), 8)); } else { return emitError(loc, "unexpected type ") << scalarType << " with type parameters"; } } if (alloc.hasShapeOperands()) { mlir::Type allocEleTy = fir::unwrapRefType(alloc.getType()); // Scale the size by constant factors encoded in the array type. // We only do this for arrays that don't have a constant interior, since // those are the only ones that get decayed to a pointer to the element // type. if (auto seqTy = allocEleTy.dyn_cast()) { if (!seqTy.hasConstantInterior()) { fir::SequenceType::Extent constSize = 1; for (auto extent : seqTy.getShape()) if (extent != fir::SequenceType::getUnknownExtent()) constSize *= extent; mlir::Value constVal{ genConstantIndex(loc, ity, rewriter, constSize).getResult()}; size = rewriter.create(loc, ity, size, constVal); } } unsigned end = operands.size(); for (; i < end; ++i) size = rewriter.create( loc, ity, size, integerCast(loc, rewriter, ity, operands[i])); } if (ty == resultTy) { // Do not emit the bitcast if ty and resultTy are the same. rewriter.replaceOpWithNewOp(alloc, ty, size, alloc->getAttrs()); } else { auto al = rewriter.create(loc, ty, size, alloc->getAttrs()); rewriter.replaceOpWithNewOp(alloc, resultTy, al); } return success(); } }; /// Lower `fir.box_addr` to the sequence of operations to extract the first /// element of the box. struct BoxAddrOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxAddrOp boxaddr, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value a = adaptor.getOperands()[0]; auto loc = boxaddr.getLoc(); mlir::Type ty = convertType(boxaddr.getType()); if (auto argty = boxaddr.val().getType().dyn_cast()) { rewriter.replaceOp(boxaddr, loadBaseAddrFromBox(loc, ty, a, rewriter)); } else { auto c0attr = rewriter.getI32IntegerAttr(0); auto c0 = mlir::ArrayAttr::get(boxaddr.getContext(), c0attr); rewriter.replaceOpWithNewOp(boxaddr, ty, a, c0); } return success(); } }; /// Lower `fir.box_dims` to a sequence of operations to extract the requested /// dimension infomartion from the boxed value. /// Result in a triple set of GEPs and loads. struct BoxDimsOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxDimsOp boxdims, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { SmallVector resultTypes = { convertType(boxdims.getResult(0).getType()), convertType(boxdims.getResult(1).getType()), convertType(boxdims.getResult(2).getType()), }; auto results = getDimsFromBox(boxdims.getLoc(), resultTypes, adaptor.getOperands()[0], adaptor.getOperands()[1], rewriter); rewriter.replaceOp(boxdims, results); return success(); } }; /// Lower `fir.box_elesize` to a sequence of operations ro extract the size of /// an element in the boxed value. struct BoxEleSizeOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxEleSizeOp boxelesz, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value a = adaptor.getOperands()[0]; auto loc = boxelesz.getLoc(); auto ty = convertType(boxelesz.getType()); auto elemSize = getValueFromBox(loc, a, ty, rewriter, kElemLenPosInBox); rewriter.replaceOp(boxelesz, elemSize); return success(); } }; /// Lower `fir.box_isalloc` to a sequence of operations to determine if the /// boxed value was from an ALLOCATABLE entity. struct BoxIsAllocOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxIsAllocOp boxisalloc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value box = adaptor.getOperands()[0]; auto loc = boxisalloc.getLoc(); mlir::Value check = genBoxAttributeCheck(loc, box, rewriter, kAttrAllocatable); rewriter.replaceOp(boxisalloc, check); return success(); } }; /// Lower `fir.box_isarray` to a sequence of operations to determine if the /// boxed is an array. struct BoxIsArrayOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxIsArrayOp boxisarray, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value a = adaptor.getOperands()[0]; auto loc = boxisarray.getLoc(); auto rank = getValueFromBox(loc, a, rewriter.getI32Type(), rewriter, kRankPosInBox); auto c0 = genConstantOffset(loc, rewriter, 0); rewriter.replaceOpWithNewOp( boxisarray, mlir::LLVM::ICmpPredicate::ne, rank, c0); return success(); } }; /// Lower `fir.box_isptr` to a sequence of operations to determined if the /// boxed value was from a POINTER entity. struct BoxIsPtrOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxIsPtrOp boxisptr, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value box = adaptor.getOperands()[0]; auto loc = boxisptr.getLoc(); mlir::Value check = genBoxAttributeCheck(loc, box, rewriter, kAttrPointer); rewriter.replaceOp(boxisptr, check); return success(); } }; /// Lower `fir.box_rank` to the sequence of operation to extract the rank from /// the box. struct BoxRankOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxRankOp boxrank, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value a = adaptor.getOperands()[0]; auto loc = boxrank.getLoc(); mlir::Type ty = convertType(boxrank.getType()); auto result = getValueFromBox(loc, a, ty, rewriter, kRankPosInBox); rewriter.replaceOp(boxrank, result); return success(); } }; /// Lower `fir.string_lit` to LLVM IR dialect operation. struct StringLitOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::StringLitOp constop, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto ty = convertType(constop.getType()); auto attr = constop.getValue(); if (attr.isa()) { rewriter.replaceOpWithNewOp(constop, ty, attr); return success(); } auto arr = attr.cast(); auto charTy = constop.getType().cast(); unsigned bits = lowerTy().characterBitsize(charTy); mlir::Type intTy = rewriter.getIntegerType(bits); auto attrs = llvm::map_range( arr.getValue(), [intTy, bits](mlir::Attribute attr) -> Attribute { return mlir::IntegerAttr::get( intTy, attr.cast().getValue().sextOrTrunc(bits)); }); mlir::Type vecType = mlir::VectorType::get(arr.size(), intTy); auto denseAttr = mlir::DenseElementsAttr::get( vecType.cast(), llvm::to_vector<8>(attrs)); rewriter.replaceOpWithNewOp(constop, ty, denseAttr); return success(); } }; /// Lower `fir.boxproc_host` operation. Extracts the host pointer from the /// boxproc. /// TODO: Part of supporting Fortran 2003 procedure pointers. struct BoxProcHostOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxProcHostOp boxprochost, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(boxprochost.getLoc(), "fir.boxproc_host codegen"); return failure(); } }; /// Lower `fir.box_tdesc` to the sequence of operations to extract the type /// descriptor from the box. struct BoxTypeDescOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxTypeDescOp boxtypedesc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value box = adaptor.getOperands()[0]; auto loc = boxtypedesc.getLoc(); mlir::Type typeTy = fir::getDescFieldTypeModel()(boxtypedesc.getContext()); auto result = getValueFromBox(loc, box, typeTy, rewriter, kTypePosInBox); auto typePtrTy = mlir::LLVM::LLVMPointerType::get(typeTy); rewriter.replaceOpWithNewOp(boxtypedesc, typePtrTy, result); return success(); } }; // `fir.call` -> `llvm.call` struct CallOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::CallOp call, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { SmallVector resultTys; for (auto r : call.getResults()) resultTys.push_back(convertType(r.getType())); rewriter.replaceOpWithNewOp( call, resultTys, adaptor.getOperands(), call->getAttrs()); return success(); } }; } // namespace static mlir::Type getComplexEleTy(mlir::Type complex) { if (auto cc = complex.dyn_cast()) return cc.getElementType(); return complex.cast().getElementType(); } namespace { /// Compare complex values /// /// Per 10.1, the only comparisons available are .EQ. (oeq) and .NE. (une). /// /// For completeness, all other comparison are done on the real component only. struct CmpcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::CmpcOp cmp, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::ValueRange operands = adaptor.getOperands(); mlir::MLIRContext *ctxt = cmp.getContext(); mlir::Type eleTy = convertType(getComplexEleTy(cmp.lhs().getType())); mlir::Type resTy = convertType(cmp.getType()); mlir::Location loc = cmp.getLoc(); auto pos0 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(0)); SmallVector rp{rewriter.create( loc, eleTy, operands[0], pos0), rewriter.create( loc, eleTy, operands[1], pos0)}; auto rcp = rewriter.create(loc, resTy, rp, cmp->getAttrs()); auto pos1 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(1)); SmallVector ip{rewriter.create( loc, eleTy, operands[0], pos1), rewriter.create( loc, eleTy, operands[1], pos1)}; auto icp = rewriter.create(loc, resTy, ip, cmp->getAttrs()); SmallVector cp{rcp, icp}; switch (cmp.getPredicate()) { case mlir::arith::CmpFPredicate::OEQ: // .EQ. rewriter.replaceOpWithNewOp(cmp, resTy, cp); break; case mlir::arith::CmpFPredicate::UNE: // .NE. rewriter.replaceOpWithNewOp(cmp, resTy, cp); break; default: rewriter.replaceOp(cmp, rcp.getResult()); break; } return success(); } }; /// Lower complex constants struct ConstcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::ConstcOp conc, OpAdaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Location loc = conc.getLoc(); mlir::MLIRContext *ctx = conc.getContext(); mlir::Type ty = convertType(conc.getType()); mlir::Type ety = convertType(getComplexEleTy(conc.getType())); auto realFloatAttr = mlir::FloatAttr::get(ety, getValue(conc.getReal())); auto realPart = rewriter.create(loc, ety, realFloatAttr); auto imFloatAttr = mlir::FloatAttr::get(ety, getValue(conc.getImaginary())); auto imPart = rewriter.create(loc, ety, imFloatAttr); auto realIndex = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); auto imIndex = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); auto undef = rewriter.create(loc, ty); auto setReal = rewriter.create( loc, ty, undef, realPart, realIndex); rewriter.replaceOpWithNewOp(conc, ty, setReal, imPart, imIndex); return success(); } inline APFloat getValue(mlir::Attribute attr) const { return attr.cast().getValue(); } }; /// convert value of from-type to value of to-type struct ConvertOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; static bool isFloatingPointTy(mlir::Type ty) { return ty.isa(); } mlir::LogicalResult matchAndRewrite(fir::ConvertOp convert, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto fromTy = convertType(convert.value().getType()); auto toTy = convertType(convert.res().getType()); mlir::Value op0 = adaptor.getOperands()[0]; if (fromTy == toTy) { rewriter.replaceOp(convert, op0); return success(); } auto loc = convert.getLoc(); auto convertFpToFp = [&](mlir::Value val, unsigned fromBits, unsigned toBits, mlir::Type toTy) -> mlir::Value { if (fromBits == toBits) { // TODO: Converting between two floating-point representations with the // same bitwidth is not allowed for now. mlir::emitError(loc, "cannot implicitly convert between two floating-point " "representations of the same bitwidth"); return {}; } if (fromBits > toBits) return rewriter.create(loc, toTy, val); return rewriter.create(loc, toTy, val); }; // Complex to complex conversion. if (fir::isa_complex(convert.value().getType()) && fir::isa_complex(convert.res().getType())) { // Special case: handle the conversion of a complex such that both the // real and imaginary parts are converted together. auto zero = mlir::ArrayAttr::get(convert.getContext(), rewriter.getI32IntegerAttr(0)); auto one = mlir::ArrayAttr::get(convert.getContext(), rewriter.getI32IntegerAttr(1)); auto ty = convertType(getComplexEleTy(convert.value().getType())); auto rp = rewriter.create(loc, ty, op0, zero); auto ip = rewriter.create(loc, ty, op0, one); auto nt = convertType(getComplexEleTy(convert.res().getType())); auto fromBits = mlir::LLVM::getPrimitiveTypeSizeInBits(ty); auto toBits = mlir::LLVM::getPrimitiveTypeSizeInBits(nt); auto rc = convertFpToFp(rp, fromBits, toBits, nt); auto ic = convertFpToFp(ip, fromBits, toBits, nt); auto un = rewriter.create(loc, toTy); auto i1 = rewriter.create(loc, toTy, un, rc, zero); rewriter.replaceOpWithNewOp(convert, toTy, i1, ic, one); return mlir::success(); } // Floating point to floating point conversion. if (isFloatingPointTy(fromTy)) { if (isFloatingPointTy(toTy)) { auto fromBits = mlir::LLVM::getPrimitiveTypeSizeInBits(fromTy); auto toBits = mlir::LLVM::getPrimitiveTypeSizeInBits(toTy); auto v = convertFpToFp(op0, fromBits, toBits, toTy); rewriter.replaceOp(convert, v); return mlir::success(); } if (toTy.isa()) { rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } } else if (fromTy.isa()) { // Integer to integer conversion. if (toTy.isa()) { auto fromBits = mlir::LLVM::getPrimitiveTypeSizeInBits(fromTy); auto toBits = mlir::LLVM::getPrimitiveTypeSizeInBits(toTy); assert(fromBits != toBits); if (fromBits > toBits) { rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } // Integer to floating point conversion. if (isFloatingPointTy(toTy)) { rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } // Integer to pointer conversion. if (toTy.isa()) { rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } } else if (fromTy.isa()) { // Pointer to integer conversion. if (toTy.isa()) { rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } // Pointer to pointer conversion. if (toTy.isa()) { rewriter.replaceOpWithNewOp(convert, toTy, op0); return mlir::success(); } } return emitError(loc) << "cannot convert " << fromTy << " to " << toTy; } }; /// Lower `fir.dispatch` operation. A virtual call to a method in a dispatch /// table. struct DispatchOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::DispatchOp dispatch, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(dispatch.getLoc(), "fir.dispatch codegen"); return failure(); } }; /// Lower `fir.dispatch_table` operation. The dispatch table for a Fortran /// derived type. struct DispatchTableOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::DispatchTableOp dispTab, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(dispTab.getLoc(), "fir.dispatch_table codegen"); return failure(); } }; /// Lower `fir.dt_entry` operation. An entry in a dispatch table; binds a /// method-name to a function. struct DTEntryOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::DTEntryOp dtEnt, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(dtEnt.getLoc(), "fir.dt_entry codegen"); return failure(); } }; /// Lower `fir.global_len` operation. struct GlobalLenOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::GlobalLenOp globalLen, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(globalLen.getLoc(), "fir.global_len codegen"); return failure(); } }; /// Lower fir.len_param_index struct LenParamIndexOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; // FIXME: this should be specialized by the runtime target mlir::LogicalResult matchAndRewrite(fir::LenParamIndexOp lenp, OpAdaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(lenp.getLoc(), "fir.len_param_index codegen"); } }; /// Lower `fir.gentypedesc` to a global constant. struct GenTypeDescOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::GenTypeDescOp gentypedesc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(gentypedesc.getLoc(), "fir.gentypedesc codegen"); return failure(); } }; } // namespace /// Return the LLVMFuncOp corresponding to the standard malloc call. static mlir::LLVM::LLVMFuncOp getMalloc(fir::AllocMemOp op, mlir::ConversionPatternRewriter &rewriter) { auto module = op->getParentOfType(); if (mlir::LLVM::LLVMFuncOp mallocFunc = module.lookupSymbol("malloc")) return mallocFunc; mlir::OpBuilder moduleBuilder( op->getParentOfType().getBodyRegion()); auto indexType = mlir::IntegerType::get(op.getContext(), 64); return moduleBuilder.create( rewriter.getUnknownLoc(), "malloc", mlir::LLVM::LLVMFunctionType::get(getVoidPtrType(op.getContext()), indexType, /*isVarArg=*/false)); } /// Helper function for generating the LLVM IR that computes the size /// in bytes for a derived type. static mlir::Value computeDerivedTypeSize(mlir::Location loc, mlir::Type ptrTy, mlir::Type idxTy, mlir::ConversionPatternRewriter &rewriter) { auto nullPtr = rewriter.create(loc, ptrTy); mlir::Value one = genConstantIndex(loc, idxTy, rewriter, 1); llvm::SmallVector args{one}; auto gep = rewriter.create(loc, ptrTy, nullPtr, args); return rewriter.create(loc, idxTy, gep); } namespace { /// Lower a `fir.allocmem` instruction into `llvm.call @malloc` struct AllocMemOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::AllocMemOp heap, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Type ty = convertType(heap.getType()); mlir::LLVM::LLVMFuncOp mallocFunc = getMalloc(heap, rewriter); mlir::Location loc = heap.getLoc(); auto ity = lowerTy().indexType(); if (auto recTy = fir::unwrapSequenceType(heap.getAllocatedType()) .dyn_cast()) if (recTy.getNumLenParams() != 0) { TODO(loc, "fir.allocmem codegen of derived type with length parameters"); return failure(); } mlir::Value size = genTypeSizeInBytes(loc, ity, rewriter, ty); for (mlir::Value opnd : adaptor.getOperands()) size = rewriter.create( loc, ity, size, integerCast(loc, rewriter, ity, opnd)); heap->setAttr("callee", mlir::SymbolRefAttr::get(mallocFunc)); auto malloc = rewriter.create( loc, ::getVoidPtrType(heap.getContext()), size, heap->getAttrs()); rewriter.replaceOpWithNewOp(heap, ty, malloc.getResult(0)); return success(); } // Compute the (allocation) size of the allocmem type in bytes. mlir::Value genTypeSizeInBytes(mlir::Location loc, mlir::Type idxTy, mlir::ConversionPatternRewriter &rewriter, mlir::Type llTy) const { // Use the primitive size, if available. auto ptrTy = llTy.dyn_cast(); if (auto size = mlir::LLVM::getPrimitiveTypeSizeInBits(ptrTy.getElementType())) return genConstantIndex(loc, idxTy, rewriter, size / 8); // Otherwise, generate the GEP trick in LLVM IR to compute the size. return computeDerivedTypeSize(loc, ptrTy, idxTy, rewriter); } }; } // namespace /// Return the LLVMFuncOp corresponding to the standard free call. static mlir::LLVM::LLVMFuncOp getFree(fir::FreeMemOp op, mlir::ConversionPatternRewriter &rewriter) { auto module = op->getParentOfType(); if (mlir::LLVM::LLVMFuncOp freeFunc = module.lookupSymbol("free")) return freeFunc; mlir::OpBuilder moduleBuilder(module.getBodyRegion()); auto voidType = mlir::LLVM::LLVMVoidType::get(op.getContext()); return moduleBuilder.create( rewriter.getUnknownLoc(), "free", mlir::LLVM::LLVMFunctionType::get(voidType, getVoidPtrType(op.getContext()), /*isVarArg=*/false)); } namespace { /// Lower a `fir.freemem` instruction into `llvm.call @free` struct FreeMemOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::FreeMemOp freemem, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::LLVM::LLVMFuncOp freeFunc = getFree(freemem, rewriter); mlir::Location loc = freemem.getLoc(); auto bitcast = rewriter.create( freemem.getLoc(), voidPtrTy(), adaptor.getOperands()[0]); freemem->setAttr("callee", mlir::SymbolRefAttr::get(freeFunc)); rewriter.create( loc, mlir::TypeRange{}, mlir::ValueRange{bitcast}, freemem->getAttrs()); rewriter.eraseOp(freemem); return success(); } }; /// Convert `fir.end` struct FirEndOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::FirEndOp firEnd, OpAdaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(firEnd.getLoc(), "fir.end codegen"); return failure(); } }; /// Lower `fir.has_value` operation to `llvm.return` operation. struct HasValueOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::HasValueOp op, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { rewriter.replaceOpWithNewOp(op, adaptor.getOperands()); return success(); } }; /// Lower `fir.global` operation to `llvm.global` operation. /// `fir.insert_on_range` operations are replaced with constant dense attribute /// if they are applied on the full range. struct GlobalOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::GlobalOp global, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto tyAttr = convertType(global.getType()); if (global.getType().isa()) tyAttr = tyAttr.cast().getElementType(); auto loc = global.getLoc(); mlir::Attribute initAttr{}; if (global.initVal()) initAttr = global.initVal().getValue(); auto linkage = convertLinkage(global.linkName()); auto isConst = global.constant().hasValue(); auto g = rewriter.create( loc, tyAttr, isConst, linkage, global.getSymName(), initAttr); auto &gr = g.getInitializerRegion(); rewriter.inlineRegionBefore(global.region(), gr, gr.end()); if (!gr.empty()) { // Replace insert_on_range with a constant dense attribute if the // initialization is on the full range. auto insertOnRangeOps = gr.front().getOps(); for (auto insertOp : insertOnRangeOps) { if (isFullRange(insertOp.coor(), insertOp.getType())) { auto seqTyAttr = convertType(insertOp.getType()); auto *op = insertOp.val().getDefiningOp(); auto constant = mlir::dyn_cast(op); if (!constant) { auto convertOp = mlir::dyn_cast(op); if (!convertOp) continue; constant = cast( convertOp.value().getDefiningOp()); } mlir::Type vecType = mlir::VectorType::get( insertOp.getType().getShape(), constant.getType()); auto denseAttr = mlir::DenseElementsAttr::get( vecType.cast(), constant.getValue()); rewriter.setInsertionPointAfter(insertOp); rewriter.replaceOpWithNewOp( insertOp, seqTyAttr, denseAttr); } } } rewriter.eraseOp(global); return success(); } bool isFullRange(mlir::DenseIntElementsAttr indexes, fir::SequenceType seqTy) const { auto extents = seqTy.getShape(); if (indexes.size() / 2 != static_cast(extents.size())) return false; auto cur_index = indexes.value_begin(); for (unsigned i = 0; i < indexes.size(); i += 2) { if (*(cur_index++) != 0) return false; if (*(cur_index++) != extents[i / 2] - 1) return false; } return true; } // TODO: String comparaison should be avoided. Replace linkName with an // enumeration. mlir::LLVM::Linkage convertLinkage(Optional optLinkage) const { if (optLinkage.hasValue()) { auto name = optLinkage.getValue(); if (name == "internal") return mlir::LLVM::Linkage::Internal; if (name == "linkonce") return mlir::LLVM::Linkage::Linkonce; if (name == "common") return mlir::LLVM::Linkage::Common; if (name == "weak") return mlir::LLVM::Linkage::Weak; } return mlir::LLVM::Linkage::External; } }; } // namespace static void genCondBrOp(mlir::Location loc, mlir::Value cmp, mlir::Block *dest, Optional destOps, mlir::ConversionPatternRewriter &rewriter, mlir::Block *newBlock) { if (destOps.hasValue()) rewriter.create(loc, cmp, dest, destOps.getValue(), newBlock, mlir::ValueRange()); else rewriter.create(loc, cmp, dest, newBlock); } template static void genBrOp(A caseOp, mlir::Block *dest, Optional destOps, mlir::ConversionPatternRewriter &rewriter) { if (destOps.hasValue()) rewriter.replaceOpWithNewOp(caseOp, destOps.getValue(), dest); else rewriter.replaceOpWithNewOp(caseOp, llvm::None, dest); } static void genCaseLadderStep(mlir::Location loc, mlir::Value cmp, mlir::Block *dest, Optional destOps, mlir::ConversionPatternRewriter &rewriter) { auto *thisBlock = rewriter.getInsertionBlock(); auto *newBlock = createBlock(rewriter, dest); rewriter.setInsertionPointToEnd(thisBlock); genCondBrOp(loc, cmp, dest, destOps, rewriter, newBlock); rewriter.setInsertionPointToEnd(newBlock); } namespace { /// Conversion of `fir.select_case` /// /// The `fir.select_case` operation is converted to a if-then-else ladder. /// Depending on the case condition type, one or several comparison and /// conditional branching can be generated. /// /// A a point value case such as `case(4)`, a lower bound case such as /// `case(5:)` or an upper bound case such as `case(:3)` are converted to a /// simple comparison between the selector value and the constant value in the /// case. The block associated with the case condition is then executed if /// the comparison succeed otherwise it branch to the next block with the /// comparison for the the next case conditon. /// /// A closed interval case condition such as `case(7:10)` is converted with a /// first comparison and conditional branching for the lower bound. If /// successful, it branch to a second block with the comparison for the /// upper bound in the same case condition. /// /// TODO: lowering of CHARACTER type cases is not handled yet. struct SelectCaseOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::SelectCaseOp caseOp, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { unsigned conds = caseOp.getNumConditions(); llvm::ArrayRef cases = caseOp.getCases().getValue(); // Type can be CHARACTER, INTEGER, or LOGICAL (C1145) auto ty = caseOp.getSelector().getType(); if (ty.isa()) { TODO(caseOp.getLoc(), "fir.select_case codegen with character type"); return failure(); } mlir::Value selector = caseOp.getSelector(adaptor.getOperands()); auto loc = caseOp.getLoc(); for (unsigned t = 0; t != conds; ++t) { mlir::Block *dest = caseOp.getSuccessor(t); llvm::Optional destOps = caseOp.getSuccessorOperands(adaptor.getOperands(), t); llvm::Optional cmpOps = *caseOp.getCompareOperands(adaptor.getOperands(), t); mlir::Value caseArg = *(cmpOps.getValue().begin()); mlir::Attribute attr = cases[t]; if (attr.isa()) { auto cmp = rewriter.create( loc, mlir::LLVM::ICmpPredicate::eq, selector, caseArg); genCaseLadderStep(loc, cmp, dest, destOps, rewriter); continue; } if (attr.isa()) { auto cmp = rewriter.create( loc, mlir::LLVM::ICmpPredicate::sle, caseArg, selector); genCaseLadderStep(loc, cmp, dest, destOps, rewriter); continue; } if (attr.isa()) { auto cmp = rewriter.create( loc, mlir::LLVM::ICmpPredicate::sle, selector, caseArg); genCaseLadderStep(loc, cmp, dest, destOps, rewriter); continue; } if (attr.isa()) { auto cmp = rewriter.create( loc, mlir::LLVM::ICmpPredicate::sle, caseArg, selector); auto *thisBlock = rewriter.getInsertionBlock(); auto *newBlock1 = createBlock(rewriter, dest); auto *newBlock2 = createBlock(rewriter, dest); rewriter.setInsertionPointToEnd(thisBlock); rewriter.create(loc, cmp, newBlock1, newBlock2); rewriter.setInsertionPointToEnd(newBlock1); mlir::Value caseArg0 = *(cmpOps.getValue().begin() + 1); auto cmp0 = rewriter.create( loc, mlir::LLVM::ICmpPredicate::sle, selector, caseArg0); genCondBrOp(loc, cmp0, dest, destOps, rewriter, newBlock2); rewriter.setInsertionPointToEnd(newBlock2); continue; } assert(attr.isa()); assert((t + 1 == conds) && "unit must be last"); genBrOp(caseOp, dest, destOps, rewriter); } return success(); } }; } // namespace template static void selectMatchAndRewrite(fir::LLVMTypeConverter &lowering, OP select, typename OP::Adaptor adaptor, mlir::ConversionPatternRewriter &rewriter) { unsigned conds = select.getNumConditions(); auto cases = select.getCases().getValue(); mlir::Value selector = adaptor.selector(); auto loc = select.getLoc(); assert(conds > 0 && "select must have cases"); llvm::SmallVector destinations; llvm::SmallVector destinationsOperands; mlir::Block *defaultDestination; mlir::ValueRange defaultOperands; llvm::SmallVector caseValues; for (unsigned t = 0; t != conds; ++t) { mlir::Block *dest = select.getSuccessor(t); auto destOps = select.getSuccessorOperands(adaptor.getOperands(), t); const mlir::Attribute &attr = cases[t]; if (auto intAttr = attr.template dyn_cast()) { destinations.push_back(dest); destinationsOperands.push_back(destOps.hasValue() ? *destOps : ValueRange()); caseValues.push_back(intAttr.getInt()); continue; } assert(attr.template dyn_cast_or_null()); assert((t + 1 == conds) && "unit must be last"); defaultDestination = dest; defaultOperands = destOps.hasValue() ? *destOps : ValueRange(); } // LLVM::SwitchOp takes a i32 type for the selector. if (select.getSelector().getType() != rewriter.getI32Type()) selector = rewriter.create(loc, rewriter.getI32Type(), selector); rewriter.replaceOpWithNewOp( select, selector, /*defaultDestination=*/defaultDestination, /*defaultOperands=*/defaultOperands, /*caseValues=*/caseValues, /*caseDestinations=*/destinations, /*caseOperands=*/destinationsOperands, /*branchWeights=*/ArrayRef()); } namespace { /// conversion of fir::SelectOp to an if-then-else ladder struct SelectOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::SelectOp op, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { selectMatchAndRewrite(lowerTy(), op, adaptor, rewriter); return success(); } }; /// `fir.load` --> `llvm.load` struct LoadOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::LoadOp load, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { // fir.box is a special case because it is considered as an ssa values in // fir, but it is lowered as a pointer to a descriptor. So fir.ref // and fir.box end up being the same llvm types and loading a // fir.ref is actually a no op in LLVM. if (load.getType().isa()) { rewriter.replaceOp(load, adaptor.getOperands()[0]); } else { mlir::Type ty = convertType(load.getType()); ArrayRef at = load->getAttrs(); rewriter.replaceOpWithNewOp( load, ty, adaptor.getOperands(), at); } return success(); } }; /// Lower `fir.no_reassoc` to LLVM IR dialect. /// TODO: how do we want to enforce this in LLVM-IR? Can we manipulate the fast /// math flags? struct NoReassocOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::NoReassocOp noreassoc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { rewriter.replaceOp(noreassoc, adaptor.getOperands()[0]); return success(); } }; /// Lower `fir.select_type` to LLVM IR dialect. struct SelectTypeOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::SelectTypeOp select, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::emitError(select.getLoc(), "fir.select_type should have already been converted"); return failure(); } }; /// conversion of fir::SelectRankOp to an if-then-else ladder struct SelectRankOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::SelectRankOp op, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { selectMatchAndRewrite(lowerTy(), op, adaptor, rewriter); return success(); } }; /// `fir.store` --> `llvm.store` struct StoreOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::StoreOp store, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { if (store.value().getType().isa()) { // fir.box value is actually in memory, load it first before storing it. mlir::Location loc = store.getLoc(); mlir::Type boxPtrTy = adaptor.getOperands()[0].getType(); auto val = rewriter.create( loc, boxPtrTy.cast().getElementType(), adaptor.getOperands()[0]); rewriter.replaceOpWithNewOp( store, val, adaptor.getOperands()[1]); } else { rewriter.replaceOpWithNewOp( store, adaptor.getOperands()[0], adaptor.getOperands()[1]); } return success(); } }; /// convert to LLVM IR dialect `undef` struct UndefOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::UndefOp undef, OpAdaptor, mlir::ConversionPatternRewriter &rewriter) const override { rewriter.replaceOpWithNewOp( undef, convertType(undef.getType())); return success(); } }; /// `fir.unreachable` --> `llvm.unreachable` struct UnreachableOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::UnreachableOp unreach, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { rewriter.replaceOpWithNewOp(unreach); return success(); } }; struct ZeroOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::ZeroOp zero, OpAdaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Type ty = convertType(zero.getType()); if (ty.isa()) { rewriter.replaceOpWithNewOp(zero, ty); } else if (ty.isa()) { rewriter.replaceOpWithNewOp( zero, ty, mlir::IntegerAttr::get(zero.getType(), 0)); } else if (mlir::LLVM::isCompatibleFloatingPointType(ty)) { rewriter.replaceOpWithNewOp( zero, ty, mlir::FloatAttr::get(zero.getType(), 0.0)); } else { // TODO: create ConstantAggregateZero for FIR aggregate/array types. return rewriter.notifyMatchFailure( zero, "conversion of fir.zero with aggregate type not implemented yet"); } return success(); } }; } // namespace /// Common base class for embox to descriptor conversion. template struct EmboxCommonConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; // Find the LLVMFuncOp in whose entry block the alloca should be inserted. // The order to find the LLVMFuncOp is as follows: // 1. The parent operation of the current block if it is a LLVMFuncOp. // 2. The first ancestor that is a LLVMFuncOp. mlir::LLVM::LLVMFuncOp getFuncForAllocaInsert(mlir::ConversionPatternRewriter &rewriter) const { mlir::Operation *parentOp = rewriter.getInsertionBlock()->getParentOp(); return mlir::isa(parentOp) ? mlir::cast(parentOp) : parentOp->getParentOfType(); } // Generate an alloca of size 1 and type \p toTy. mlir::LLVM::AllocaOp genAllocaWithType(mlir::Location loc, mlir::Type toTy, unsigned alignment, mlir::ConversionPatternRewriter &rewriter) const { auto thisPt = rewriter.saveInsertionPoint(); mlir::LLVM::LLVMFuncOp func = getFuncForAllocaInsert(rewriter); rewriter.setInsertionPointToStart(&func.front()); auto size = this->genI32Constant(loc, rewriter, 1); auto al = rewriter.create(loc, toTy, size, alignment); rewriter.restoreInsertionPoint(thisPt); return al; } static int getCFIAttr(fir::BoxType boxTy) { auto eleTy = boxTy.getEleTy(); if (eleTy.isa()) return CFI_attribute_pointer; if (eleTy.isa()) return CFI_attribute_allocatable; return CFI_attribute_other; } static fir::RecordType unwrapIfDerived(fir::BoxType boxTy) { return fir::unwrapSequenceType(fir::dyn_cast_ptrOrBoxEleTy(boxTy)) .template dyn_cast(); } static bool isDerivedTypeWithLenParams(fir::BoxType boxTy) { auto recTy = unwrapIfDerived(boxTy); return recTy && recTy.getNumLenParams() > 0; } static bool isDerivedType(fir::BoxType boxTy) { return unwrapIfDerived(boxTy) != nullptr; } // Get the element size and CFI type code of the boxed value. std::tuple getSizeAndTypeCode( mlir::Location loc, mlir::ConversionPatternRewriter &rewriter, mlir::Type boxEleTy, mlir::ValueRange lenParams = {}) const { auto doInteger = [&](unsigned width) -> std::tuple { int typeCode = fir::integerBitsToTypeCode(width); return {this->genConstantOffset(loc, rewriter, width / 8), this->genConstantOffset(loc, rewriter, typeCode)}; }; auto doLogical = [&](unsigned width) -> std::tuple { int typeCode = fir::logicalBitsToTypeCode(width); return {this->genConstantOffset(loc, rewriter, width / 8), this->genConstantOffset(loc, rewriter, typeCode)}; }; auto doFloat = [&](unsigned width) -> std::tuple { int typeCode = fir::realBitsToTypeCode(width); return {this->genConstantOffset(loc, rewriter, width / 8), this->genConstantOffset(loc, rewriter, typeCode)}; }; auto doComplex = [&](unsigned width) -> std::tuple { auto typeCode = fir::complexBitsToTypeCode(width); return {this->genConstantOffset(loc, rewriter, width / 8 * 2), this->genConstantOffset(loc, rewriter, typeCode)}; }; auto doCharacter = [&](unsigned width, mlir::Value len) -> std::tuple { auto typeCode = fir::characterBitsToTypeCode(width); auto typeCodeVal = this->genConstantOffset(loc, rewriter, typeCode); if (width == 8) return {len, typeCodeVal}; auto byteWidth = this->genConstantOffset(loc, rewriter, width / 8); auto i64Ty = mlir::IntegerType::get(&this->lowerTy().getContext(), 64); auto size = rewriter.create(loc, i64Ty, byteWidth, len); return {size, typeCodeVal}; }; auto getKindMap = [&]() -> fir::KindMapping & { return this->lowerTy().getKindMap(); }; // Pointer-like types. if (auto eleTy = fir::dyn_cast_ptrEleTy(boxEleTy)) boxEleTy = eleTy; // Integer types. if (fir::isa_integer(boxEleTy)) { if (auto ty = boxEleTy.dyn_cast()) return doInteger(ty.getWidth()); auto ty = boxEleTy.cast(); return doInteger(getKindMap().getIntegerBitsize(ty.getFKind())); } // Floating point types. if (fir::isa_real(boxEleTy)) { if (auto ty = boxEleTy.dyn_cast()) return doFloat(ty.getWidth()); auto ty = boxEleTy.cast(); return doFloat(getKindMap().getRealBitsize(ty.getFKind())); } // Complex types. if (fir::isa_complex(boxEleTy)) { if (auto ty = boxEleTy.dyn_cast()) return doComplex( ty.getElementType().cast().getWidth()); auto ty = boxEleTy.cast(); return doComplex(getKindMap().getRealBitsize(ty.getFKind())); } // Character types. if (auto ty = boxEleTy.dyn_cast()) { auto charWidth = getKindMap().getCharacterBitsize(ty.getFKind()); if (ty.getLen() != fir::CharacterType::unknownLen()) { auto len = this->genConstantOffset(loc, rewriter, ty.getLen()); return doCharacter(charWidth, len); } assert(!lenParams.empty()); return doCharacter(charWidth, lenParams.back()); } // Logical type. if (auto ty = boxEleTy.dyn_cast()) return doLogical(getKindMap().getLogicalBitsize(ty.getFKind())); // Array types. if (auto seqTy = boxEleTy.dyn_cast()) return getSizeAndTypeCode(loc, rewriter, seqTy.getEleTy(), lenParams); // Derived-type types. if (boxEleTy.isa()) { auto ptrTy = mlir::LLVM::LLVMPointerType::get( this->lowerTy().convertType(boxEleTy)); auto nullPtr = rewriter.create(loc, ptrTy); auto one = genConstantIndex(loc, this->lowerTy().offsetType(), rewriter, 1); auto gep = rewriter.create(loc, ptrTy, nullPtr, mlir::ValueRange{one}); auto eleSize = rewriter.create( loc, this->lowerTy().indexType(), gep); return {eleSize, this->genConstantOffset(loc, rewriter, fir::derivedToTypeCode())}; } // Reference type. if (fir::isa_ref_type(boxEleTy)) { // FIXME: use the target pointer size rather than sizeof(void*) return {this->genConstantOffset(loc, rewriter, sizeof(void *)), this->genConstantOffset(loc, rewriter, CFI_type_cptr)}; } fir::emitFatalError(loc, "unhandled type in fir.box code generation"); } /// Basic pattern to write a field in the descriptor mlir::Value insertField(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value dest, ArrayRef fldIndexes, mlir::Value value, bool bitcast = false) const { auto boxTy = dest.getType(); auto fldTy = this->getBoxEleTy(boxTy, fldIndexes); if (bitcast) value = rewriter.create(loc, fldTy, value); else value = this->integerCast(loc, rewriter, fldTy, value); SmallVector attrs; for (auto i : fldIndexes) attrs.push_back(rewriter.getI32IntegerAttr(i)); auto indexesAttr = mlir::ArrayAttr::get(rewriter.getContext(), attrs); return rewriter.create(loc, boxTy, dest, value, indexesAttr); } inline mlir::Value insertBaseAddress(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value dest, mlir::Value base) const { return insertField(rewriter, loc, dest, {kAddrPosInBox}, base, /*bitCast=*/true); } inline mlir::Value insertLowerBound(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value dest, unsigned dim, mlir::Value lb) const { return insertField(rewriter, loc, dest, {kDimsPosInBox, dim, kDimLowerBoundPos}, lb); } inline mlir::Value insertExtent(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value dest, unsigned dim, mlir::Value extent) const { return insertField(rewriter, loc, dest, {kDimsPosInBox, dim, kDimExtentPos}, extent); } inline mlir::Value insertStride(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value dest, unsigned dim, mlir::Value stride) const { return insertField(rewriter, loc, dest, {kDimsPosInBox, dim, kDimStridePos}, stride); } /// Get the address of the type descriptor global variable that was created by /// lowering for derived type \p recType. template mlir::Value getTypeDescriptor(BOX box, mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, fir::RecordType recType) const { std::string name = recType.translateNameToFrontendMangledName(); auto module = box->template getParentOfType(); if (auto global = module.template lookupSymbol(name)) { auto ty = mlir::LLVM::LLVMPointerType::get( this->lowerTy().convertType(global.getType())); return rewriter.create(loc, ty, global.getSymName()); } if (auto global = module.template lookupSymbol(name)) { // The global may have already been translated to LLVM. auto ty = mlir::LLVM::LLVMPointerType::get(global.getType()); return rewriter.create(loc, ty, global.getSymName()); } // The global does not exist in the current translation unit, but may be // defined elsewhere (e.g., type defined in a module). // For now, create a extern_weak symbol (will become nullptr if unresolved) // to support generating code without the front-end generated symbols. // These could be made available_externally to require the symbols to be // defined elsewhere and to cause link-time failure otherwise. auto i8Ty = rewriter.getIntegerType(8); mlir::OpBuilder modBuilder(module.getBodyRegion()); // TODO: The symbol should be lowered to constant in lowering, they are read // only. modBuilder.create(loc, i8Ty, /*isConstant=*/false, mlir::LLVM::Linkage::ExternWeak, name, mlir::Attribute{}); auto ty = mlir::LLVM::LLVMPointerType::get(i8Ty); return rewriter.create(loc, ty, name); } template std::tuple consDescriptorPrefix(BOX box, mlir::ConversionPatternRewriter &rewriter, unsigned rank, mlir::ValueRange lenParams) const { auto loc = box.getLoc(); auto boxTy = box.getType().template dyn_cast(); auto convTy = this->lowerTy().convertBoxType(boxTy, rank); auto llvmBoxPtrTy = convTy.template cast(); auto llvmBoxTy = llvmBoxPtrTy.getElementType(); mlir::Value descriptor = rewriter.create(loc, llvmBoxTy); llvm::SmallVector typeparams = lenParams; if constexpr (!std::is_same_v) { if (!box.substr().empty() && fir::hasDynamicSize(boxTy.getEleTy())) typeparams.push_back(box.substr()[1]); } // Write each of the fields with the appropriate values auto [eleSize, cfiTy] = getSizeAndTypeCode(loc, rewriter, boxTy.getEleTy(), typeparams); descriptor = insertField(rewriter, loc, descriptor, {kElemLenPosInBox}, eleSize); descriptor = insertField(rewriter, loc, descriptor, {kVersionPosInBox}, this->genI32Constant(loc, rewriter, CFI_VERSION)); descriptor = insertField(rewriter, loc, descriptor, {kRankPosInBox}, this->genI32Constant(loc, rewriter, rank)); descriptor = insertField(rewriter, loc, descriptor, {kTypePosInBox}, cfiTy); descriptor = insertField(rewriter, loc, descriptor, {kAttributePosInBox}, this->genI32Constant(loc, rewriter, getCFIAttr(boxTy))); const bool hasAddendum = isDerivedType(boxTy); descriptor = insertField(rewriter, loc, descriptor, {kF18AddendumPosInBox}, this->genI32Constant(loc, rewriter, hasAddendum ? 1 : 0)); if (hasAddendum) { auto isArray = fir::dyn_cast_ptrOrBoxEleTy(boxTy).template isa(); unsigned typeDescFieldId = isArray ? kOptTypePtrPosInBox : kDimsPosInBox; auto typeDesc = getTypeDescriptor(box, rewriter, loc, unwrapIfDerived(boxTy)); descriptor = insertField(rewriter, loc, descriptor, {typeDescFieldId}, typeDesc, /*bitCast=*/true); } return {boxTy, descriptor, eleSize}; } /// Compute the base address of a substring given the base address of a scalar /// string and the zero based string lower bound. mlir::Value shiftSubstringBase(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value base, mlir::Value lowerBound) const { llvm::SmallVector gepOperands; auto baseType = base.getType().cast().getElementType(); if (baseType.isa()) { auto idxTy = this->lowerTy().indexType(); mlir::Value zero = genConstantIndex(loc, idxTy, rewriter, 0); gepOperands.push_back(zero); } gepOperands.push_back(lowerBound); return this->genGEP(loc, base.getType(), rewriter, base, gepOperands); } /// If the embox is not in a globalOp body, allocate storage for the box; /// store the value inside and return the generated alloca. Return the input /// value otherwise. mlir::Value placeInMemoryIfNotGlobalInit(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value boxValue) const { auto *thisBlock = rewriter.getInsertionBlock(); if (thisBlock && mlir::isa(thisBlock->getParentOp())) return boxValue; auto boxPtrTy = mlir::LLVM::LLVMPointerType::get(boxValue.getType()); auto alloca = genAllocaWithType(loc, boxPtrTy, defaultAlign, rewriter); rewriter.create(loc, boxValue, alloca); return alloca; } }; /// Compute the extent of a triplet slice (lb:ub:step). static mlir::Value computeTripletExtent(mlir::ConversionPatternRewriter &rewriter, mlir::Location loc, mlir::Value lb, mlir::Value ub, mlir::Value step, mlir::Value zero, mlir::Type type) { mlir::Value extent = rewriter.create(loc, type, ub, lb); extent = rewriter.create(loc, type, extent, step); extent = rewriter.create(loc, type, extent, step); // If the resulting extent is negative (`ub-lb` and `step` have different // signs), zero must be returned instead. auto cmp = rewriter.create( loc, mlir::LLVM::ICmpPredicate::sgt, extent, zero); return rewriter.create(loc, cmp, extent, zero); } /// Create a generic box on a memory reference. This conversions lowers the /// abstract box to the appropriate, initialized descriptor. struct EmboxOpConversion : public EmboxCommonConversion { using EmboxCommonConversion::EmboxCommonConversion; mlir::LogicalResult matchAndRewrite(fir::EmboxOp embox, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { assert(!embox.getShape() && "There should be no dims on this embox op"); auto [boxTy, dest, eleSize] = consDescriptorPrefix(embox, rewriter, /*rank=*/0, /*lenParams=*/adaptor.getOperands().drop_front(1)); dest = insertBaseAddress(rewriter, embox.getLoc(), dest, adaptor.getOperands()[0]); if (isDerivedTypeWithLenParams(boxTy)) { TODO(embox.getLoc(), "fir.embox codegen of derived with length parameters"); return failure(); } auto result = placeInMemoryIfNotGlobalInit(rewriter, embox.getLoc(), dest); rewriter.replaceOp(embox, result); return success(); } }; /// Lower `fir.emboxproc` operation. Creates a procedure box. /// TODO: Part of supporting Fortran 2003 procedure pointers. struct EmboxProcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::EmboxProcOp emboxproc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(emboxproc.getLoc(), "fir.emboxproc codegen"); return failure(); } }; /// Create a generic box on a memory reference. struct XEmboxOpConversion : public EmboxCommonConversion { using EmboxCommonConversion::EmboxCommonConversion; mlir::LogicalResult matchAndRewrite(fir::cg::XEmboxOp xbox, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto [boxTy, dest, eleSize] = consDescriptorPrefix( xbox, rewriter, xbox.getOutRank(), adaptor.getOperands().drop_front(xbox.lenParamOffset())); // Generate the triples in the dims field of the descriptor mlir::ValueRange operands = adaptor.getOperands(); auto i64Ty = mlir::IntegerType::get(xbox.getContext(), 64); mlir::Value base = operands[0]; assert(!xbox.shape().empty() && "must have a shape"); unsigned shapeOffset = xbox.shapeOffset(); bool hasShift = !xbox.shift().empty(); unsigned shiftOffset = xbox.shiftOffset(); bool hasSlice = !xbox.slice().empty(); unsigned sliceOffset = xbox.sliceOffset(); mlir::Location loc = xbox.getLoc(); mlir::Value zero = genConstantIndex(loc, i64Ty, rewriter, 0); mlir::Value one = genConstantIndex(loc, i64Ty, rewriter, 1); mlir::Value prevDim = integerCast(loc, rewriter, i64Ty, eleSize); mlir::Value prevPtrOff = one; mlir::Type eleTy = boxTy.getEleTy(); const unsigned rank = xbox.getRank(); llvm::SmallVector gepArgs; unsigned constRows = 0; mlir::Value ptrOffset = zero; if (auto memEleTy = fir::dyn_cast_ptrEleTy(xbox.memref().getType())) if (auto seqTy = memEleTy.dyn_cast()) { mlir::Type seqEleTy = seqTy.getEleTy(); // Adjust the element scaling factor if the element is a dependent type. if (fir::hasDynamicSize(seqEleTy)) { if (fir::isa_char(seqEleTy)) { assert(xbox.lenParams().size() == 1); prevPtrOff = integerCast(loc, rewriter, i64Ty, operands[xbox.lenParamOffset()]); } else if (seqEleTy.isa()) { TODO(loc, "generate call to calculate size of PDT"); } else { return rewriter.notifyMatchFailure(xbox, "unexpected dynamic type"); } } else { constRows = seqTy.getConstantRows(); } } bool hasSubcomp = !xbox.subcomponent().empty(); mlir::Value stepExpr; if (hasSubcomp) { // We have a subcomponent. The step value needs to be the number of // bytes per element (which is a derived type). mlir::Type ty0 = base.getType(); [[maybe_unused]] auto ptrTy = ty0.dyn_cast(); assert(ptrTy && "expected pointer type"); mlir::Type memEleTy = fir::dyn_cast_ptrEleTy(xbox.memref().getType()); assert(memEleTy && "expected fir pointer type"); auto seqTy = memEleTy.dyn_cast(); assert(seqTy && "expected sequence type"); mlir::Type seqEleTy = seqTy.getEleTy(); auto eleTy = mlir::LLVM::LLVMPointerType::get(convertType(seqEleTy)); stepExpr = computeDerivedTypeSize(loc, eleTy, i64Ty, rewriter); } // Process the array subspace arguments (shape, shift, etc.), if any, // translating everything to values in the descriptor wherever the entity // has a dynamic array dimension. for (unsigned di = 0, descIdx = 0; di < rank; ++di) { mlir::Value extent = operands[shapeOffset]; mlir::Value outerExtent = extent; bool skipNext = false; if (hasSlice) { mlir::Value off = operands[sliceOffset]; mlir::Value adj = one; if (hasShift) adj = operands[shiftOffset]; auto ao = rewriter.create(loc, i64Ty, off, adj); if (constRows > 0) { gepArgs.push_back(ao); --constRows; } else { auto dimOff = rewriter.create(loc, i64Ty, ao, prevPtrOff); ptrOffset = rewriter.create(loc, i64Ty, dimOff, ptrOffset); } if (mlir::isa_and_nonnull( xbox.slice()[3 * di + 1].getDefiningOp())) { // This dimension contains a scalar expression in the array slice op. // The dimension is loop invariant, will be dropped, and will not // appear in the descriptor. skipNext = true; } } if (!skipNext) { // store lower bound (normally 0) mlir::Value lb = zero; if (eleTy.isa() || eleTy.isa()) { lb = one; if (hasShift) lb = operands[shiftOffset]; } dest = insertLowerBound(rewriter, loc, dest, descIdx, lb); // store extent if (hasSlice) extent = computeTripletExtent(rewriter, loc, operands[sliceOffset], operands[sliceOffset + 1], operands[sliceOffset + 2], zero, i64Ty); dest = insertExtent(rewriter, loc, dest, descIdx, extent); // store step (scaled by shaped extent) mlir::Value step = hasSubcomp ? stepExpr : prevDim; if (hasSlice) step = rewriter.create(loc, i64Ty, step, operands[sliceOffset + 2]); dest = insertStride(rewriter, loc, dest, descIdx, step); ++descIdx; } // compute the stride and offset for the next natural dimension prevDim = rewriter.create(loc, i64Ty, prevDim, outerExtent); if (constRows == 0) prevPtrOff = rewriter.create(loc, i64Ty, prevPtrOff, outerExtent); // increment iterators ++shapeOffset; if (hasShift) ++shiftOffset; if (hasSlice) sliceOffset += 3; } if (hasSlice || hasSubcomp || !xbox.substr().empty()) { llvm::SmallVector args = {ptrOffset}; args.append(gepArgs.rbegin(), gepArgs.rend()); if (hasSubcomp) { // For each field in the path add the offset to base via the args list. // In the most general case, some offsets must be computed since // they are not be known until runtime. if (fir::hasDynamicSize(fir::unwrapSequenceType( fir::unwrapPassByRefType(xbox.memref().getType())))) TODO(loc, "fir.embox codegen dynamic size component in derived type"); args.append(operands.begin() + xbox.subcomponentOffset(), operands.begin() + xbox.subcomponentOffset() + xbox.subcomponent().size()); } base = rewriter.create(loc, base.getType(), base, args); if (!xbox.substr().empty()) base = shiftSubstringBase(rewriter, loc, base, operands[xbox.substrOffset()]); } dest = insertBaseAddress(rewriter, loc, dest, base); if (isDerivedTypeWithLenParams(boxTy)) TODO(loc, "fir.embox codegen of derived with length parameters"); mlir::Value result = placeInMemoryIfNotGlobalInit(rewriter, loc, dest); rewriter.replaceOp(xbox, result); return success(); } }; /// Create a new box given a box reference. struct XReboxOpConversion : public EmboxCommonConversion { using EmboxCommonConversion::EmboxCommonConversion; mlir::LogicalResult matchAndRewrite(fir::cg::XReboxOp rebox, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Location loc = rebox.getLoc(); mlir::Type idxTy = lowerTy().indexType(); mlir::Value loweredBox = adaptor.getOperands()[0]; mlir::ValueRange operands = adaptor.getOperands(); // Create new descriptor and fill its non-shape related data. llvm::SmallVector lenParams; mlir::Type inputEleTy = getInputEleTy(rebox); if (auto charTy = inputEleTy.dyn_cast()) { mlir::Value len = loadElementSizeFromBox(loc, idxTy, loweredBox, rewriter); if (charTy.getFKind() != 1) { mlir::Value width = genConstantIndex(loc, idxTy, rewriter, charTy.getFKind()); len = rewriter.create(loc, idxTy, len, width); } lenParams.emplace_back(len); } else if (auto recTy = inputEleTy.dyn_cast()) { if (recTy.getNumLenParams() != 0) TODO(loc, "reboxing descriptor of derived type with length parameters"); } auto [boxTy, dest, eleSize] = consDescriptorPrefix(rebox, rewriter, rebox.getOutRank(), lenParams); // Read input extents, strides, and base address llvm::SmallVector inputExtents; llvm::SmallVector inputStrides; const unsigned inputRank = rebox.getRank(); for (unsigned i = 0; i < inputRank; ++i) { mlir::Value dim = genConstantIndex(loc, idxTy, rewriter, i); SmallVector dimInfo = getDimsFromBox(loc, {idxTy, idxTy, idxTy}, loweredBox, dim, rewriter); inputExtents.emplace_back(dimInfo[1]); inputStrides.emplace_back(dimInfo[2]); } mlir::Type baseTy = getBaseAddrTypeFromBox(loweredBox.getType()); mlir::Value baseAddr = loadBaseAddrFromBox(loc, baseTy, loweredBox, rewriter); if (!rebox.slice().empty() || !rebox.subcomponent().empty()) return sliceBox(rebox, dest, baseAddr, inputExtents, inputStrides, operands, rewriter); return reshapeBox(rebox, dest, baseAddr, inputExtents, inputStrides, operands, rewriter); } private: /// Write resulting shape and base address in descriptor, and replace rebox /// op. mlir::LogicalResult finalizeRebox(fir::cg::XReboxOp rebox, mlir::Value dest, mlir::Value base, mlir::ValueRange lbounds, mlir::ValueRange extents, mlir::ValueRange strides, mlir::ConversionPatternRewriter &rewriter) const { mlir::Location loc = rebox.getLoc(); mlir::Value one = genConstantIndex(loc, lowerTy().indexType(), rewriter, 1); for (auto iter : llvm::enumerate(llvm::zip(extents, strides))) { unsigned dim = iter.index(); mlir::Value lb = lbounds.empty() ? one : lbounds[dim]; dest = insertLowerBound(rewriter, loc, dest, dim, lb); dest = insertExtent(rewriter, loc, dest, dim, std::get<0>(iter.value())); dest = insertStride(rewriter, loc, dest, dim, std::get<1>(iter.value())); } dest = insertBaseAddress(rewriter, loc, dest, base); mlir::Value result = placeInMemoryIfNotGlobalInit(rewriter, rebox.getLoc(), dest); rewriter.replaceOp(rebox, result); return success(); } // Apply slice given the base address, extents and strides of the input box. mlir::LogicalResult sliceBox(fir::cg::XReboxOp rebox, mlir::Value dest, mlir::Value base, mlir::ValueRange inputExtents, mlir::ValueRange inputStrides, mlir::ValueRange operands, mlir::ConversionPatternRewriter &rewriter) const { mlir::Location loc = rebox.getLoc(); mlir::Type voidPtrTy = ::getVoidPtrType(rebox.getContext()); mlir::Type idxTy = lowerTy().indexType(); mlir::Value zero = genConstantIndex(loc, idxTy, rewriter, 0); // Apply subcomponent and substring shift on base address. if (!rebox.subcomponent().empty() || !rebox.substr().empty()) { // Cast to inputEleTy* so that a GEP can be used. mlir::Type inputEleTy = getInputEleTy(rebox); auto llvmElePtrTy = mlir::LLVM::LLVMPointerType::get(convertType(inputEleTy)); base = rewriter.create(loc, llvmElePtrTy, base); if (!rebox.subcomponent().empty()) { llvm::SmallVector gepOperands = {zero}; for (unsigned i = 0; i < rebox.subcomponent().size(); ++i) gepOperands.push_back(operands[rebox.subcomponentOffset() + i]); base = genGEP(loc, llvmElePtrTy, rewriter, base, gepOperands); } if (!rebox.substr().empty()) base = shiftSubstringBase(rewriter, loc, base, operands[rebox.substrOffset()]); } if (rebox.slice().empty()) // The array section is of the form array[%component][substring], keep // the input array extents and strides. return finalizeRebox(rebox, dest, base, /*lbounds*/ llvm::None, inputExtents, inputStrides, rewriter); // Strides from the fir.box are in bytes. base = rewriter.create(loc, voidPtrTy, base); // The slice is of the form array(i:j:k)[%component]. Compute new extents // and strides. llvm::SmallVector slicedExtents; llvm::SmallVector slicedStrides; mlir::Value one = genConstantIndex(loc, idxTy, rewriter, 1); const bool sliceHasOrigins = !rebox.shift().empty(); unsigned sliceOps = rebox.sliceOffset(); unsigned shiftOps = rebox.shiftOffset(); auto strideOps = inputStrides.begin(); const unsigned inputRank = inputStrides.size(); for (unsigned i = 0; i < inputRank; ++i, ++strideOps, ++shiftOps, sliceOps += 3) { mlir::Value sliceLb = integerCast(loc, rewriter, idxTy, operands[sliceOps]); mlir::Value inputStride = *strideOps; // already idxTy // Apply origin shift: base += (lb-shift)*input_stride mlir::Value sliceOrigin = sliceHasOrigins ? integerCast(loc, rewriter, idxTy, operands[shiftOps]) : one; mlir::Value diff = rewriter.create(loc, idxTy, sliceLb, sliceOrigin); mlir::Value offset = rewriter.create(loc, idxTy, diff, inputStride); base = genGEP(loc, voidPtrTy, rewriter, base, offset); // Apply upper bound and step if this is a triplet. Otherwise, the // dimension is dropped and no extents/strides are computed. mlir::Value upper = operands[sliceOps + 1]; const bool isTripletSlice = !mlir::isa_and_nonnull(upper.getDefiningOp()); if (isTripletSlice) { mlir::Value step = integerCast(loc, rewriter, idxTy, operands[sliceOps + 2]); // extent = ub-lb+step/step mlir::Value sliceUb = integerCast(loc, rewriter, idxTy, upper); mlir::Value extent = computeTripletExtent(rewriter, loc, sliceLb, sliceUb, step, zero, idxTy); slicedExtents.emplace_back(extent); // stride = step*input_stride mlir::Value stride = rewriter.create(loc, idxTy, step, inputStride); slicedStrides.emplace_back(stride); } } return finalizeRebox(rebox, dest, base, /*lbounds*/ llvm::None, slicedExtents, slicedStrides, rewriter); } /// Apply a new shape to the data described by a box given the base address, /// extents and strides of the box. mlir::LogicalResult reshapeBox(fir::cg::XReboxOp rebox, mlir::Value dest, mlir::Value base, mlir::ValueRange inputExtents, mlir::ValueRange inputStrides, mlir::ValueRange operands, mlir::ConversionPatternRewriter &rewriter) const { mlir::ValueRange reboxShifts{operands.begin() + rebox.shiftOffset(), operands.begin() + rebox.shiftOffset() + rebox.shift().size()}; if (rebox.shape().empty()) { // Only setting new lower bounds. return finalizeRebox(rebox, dest, base, reboxShifts, inputExtents, inputStrides, rewriter); } mlir::Location loc = rebox.getLoc(); // Strides from the fir.box are in bytes. mlir::Type voidPtrTy = ::getVoidPtrType(rebox.getContext()); base = rewriter.create(loc, voidPtrTy, base); llvm::SmallVector newStrides; llvm::SmallVector newExtents; mlir::Type idxTy = lowerTy().indexType(); // First stride from input box is kept. The rest is assumed contiguous // (it is not possible to reshape otherwise). If the input is scalar, // which may be OK if all new extents are ones, the stride does not // matter, use one. mlir::Value stride = inputStrides.empty() ? genConstantIndex(loc, idxTy, rewriter, 1) : inputStrides[0]; for (unsigned i = 0; i < rebox.shape().size(); ++i) { mlir::Value rawExtent = operands[rebox.shapeOffset() + i]; mlir::Value extent = integerCast(loc, rewriter, idxTy, rawExtent); newExtents.emplace_back(extent); newStrides.emplace_back(stride); // nextStride = extent * stride; stride = rewriter.create(loc, idxTy, extent, stride); } return finalizeRebox(rebox, dest, base, reboxShifts, newExtents, newStrides, rewriter); } /// Return scalar element type of the input box. static mlir::Type getInputEleTy(fir::cg::XReboxOp rebox) { auto ty = fir::dyn_cast_ptrOrBoxEleTy(rebox.box().getType()); if (auto seqTy = ty.dyn_cast()) return seqTy.getEleTy(); return ty; } }; // Code shared between insert_value and extract_value Ops. struct ValueOpCommon { // Translate the arguments pertaining to any multidimensional array to // row-major order for LLVM-IR. static void toRowMajor(SmallVectorImpl &attrs, mlir::Type ty) { assert(ty && "type is null"); const auto end = attrs.size(); for (std::remove_const_t i = 0; i < end; ++i) { if (auto seq = ty.dyn_cast()) { const auto dim = getDimension(seq); if (dim > 1) { auto ub = std::min(i + dim, end); std::reverse(attrs.begin() + i, attrs.begin() + ub); i += dim - 1; } ty = getArrayElementType(seq); } else if (auto st = ty.dyn_cast()) { ty = st.getBody()[attrs[i].cast().getInt()]; } else { llvm_unreachable("index into invalid type"); } } } static llvm::SmallVector collectIndices(mlir::ConversionPatternRewriter &rewriter, mlir::ArrayAttr arrAttr) { llvm::SmallVector attrs; for (auto i = arrAttr.begin(), e = arrAttr.end(); i != e; ++i) { if (i->isa()) { attrs.push_back(*i); } else { auto fieldName = i->cast().getValue(); ++i; auto ty = i->cast().getValue(); auto index = ty.cast().getFieldIndex(fieldName); attrs.push_back(mlir::IntegerAttr::get(rewriter.getI32Type(), index)); } } return attrs; } private: static unsigned getDimension(mlir::LLVM::LLVMArrayType ty) { unsigned result = 1; for (auto eleTy = ty.getElementType().dyn_cast(); eleTy; eleTy = eleTy.getElementType().dyn_cast()) ++result; return result; } static mlir::Type getArrayElementType(mlir::LLVM::LLVMArrayType ty) { auto eleTy = ty.getElementType(); while (auto arrTy = eleTy.dyn_cast()) eleTy = arrTy.getElementType(); return eleTy; } }; namespace { /// Extract a subobject value from an ssa-value of aggregate type struct ExtractValueOpConversion : public FIROpAndTypeConversion, public ValueOpCommon { using FIROpAndTypeConversion::FIROpAndTypeConversion; mlir::LogicalResult doRewrite(fir::ExtractValueOp extractVal, mlir::Type ty, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto attrs = collectIndices(rewriter, extractVal.coor()); toRowMajor(attrs, adaptor.getOperands()[0].getType()); auto position = mlir::ArrayAttr::get(extractVal.getContext(), attrs); rewriter.replaceOpWithNewOp( extractVal, ty, adaptor.getOperands()[0], position); return success(); } }; /// InsertValue is the generalized instruction for the composition of new /// aggregate type values. struct InsertValueOpConversion : public FIROpAndTypeConversion, public ValueOpCommon { using FIROpAndTypeConversion::FIROpAndTypeConversion; mlir::LogicalResult doRewrite(fir::InsertValueOp insertVal, mlir::Type ty, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto attrs = collectIndices(rewriter, insertVal.coor()); toRowMajor(attrs, adaptor.getOperands()[0].getType()); auto position = mlir::ArrayAttr::get(insertVal.getContext(), attrs); rewriter.replaceOpWithNewOp( insertVal, ty, adaptor.getOperands()[0], adaptor.getOperands()[1], position); return success(); } }; /// InsertOnRange inserts a value into a sequence over a range of offsets. struct InsertOnRangeOpConversion : public FIROpAndTypeConversion { using FIROpAndTypeConversion::FIROpAndTypeConversion; // Increments an array of subscripts in a row major fasion. void incrementSubscripts(const SmallVector &dims, SmallVector &subscripts) const { for (size_t i = dims.size(); i > 0; --i) { if (++subscripts[i - 1] < dims[i - 1]) { return; } subscripts[i - 1] = 0; } } mlir::LogicalResult doRewrite(fir::InsertOnRangeOp range, mlir::Type ty, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { llvm::SmallVector dims; auto type = adaptor.getOperands()[0].getType(); // Iteratively extract the array dimensions from the type. while (auto t = type.dyn_cast()) { dims.push_back(t.getNumElements()); type = t.getElementType(); } SmallVector lBounds; SmallVector uBounds; // Unzip the upper and lower bound and convert to a row major format. mlir::DenseIntElementsAttr coor = range.coor(); auto reversedCoor = llvm::reverse(coor.getValues()); for (auto i = reversedCoor.begin(), e = reversedCoor.end(); i != e; ++i) { uBounds.push_back(*i++); lBounds.push_back(*i); } auto &subscripts = lBounds; auto loc = range.getLoc(); mlir::Value lastOp = adaptor.getOperands()[0]; mlir::Value insertVal = adaptor.getOperands()[1]; auto i64Ty = rewriter.getI64Type(); while (subscripts != uBounds) { // Convert uint64_t's to Attribute's. SmallVector subscriptAttrs; for (const auto &subscript : subscripts) subscriptAttrs.push_back(IntegerAttr::get(i64Ty, subscript)); lastOp = rewriter.create( loc, ty, lastOp, insertVal, ArrayAttr::get(range.getContext(), subscriptAttrs)); incrementSubscripts(dims, subscripts); } // Convert uint64_t's to Attribute's. SmallVector subscriptAttrs; for (const auto &subscript : subscripts) subscriptAttrs.push_back( IntegerAttr::get(rewriter.getI64Type(), subscript)); mlir::ArrayRef arrayRef(subscriptAttrs); rewriter.replaceOpWithNewOp( range, ty, lastOp, insertVal, ArrayAttr::get(range.getContext(), arrayRef)); return success(); } }; } // namespace /// XArrayCoor is the address arithmetic on a dynamically shaped, sliced, /// shifted etc. array. /// (See the static restriction on coordinate_of.) array_coor determines the /// coordinate (location) of a specific element. struct XArrayCoorOpConversion : public FIROpAndTypeConversion { using FIROpAndTypeConversion::FIROpAndTypeConversion; mlir::LogicalResult doRewrite(fir::cg::XArrayCoorOp coor, mlir::Type ty, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto loc = coor.getLoc(); mlir::ValueRange operands = adaptor.getOperands(); unsigned rank = coor.getRank(); assert(coor.indices().size() == rank); assert(coor.shape().empty() || coor.shape().size() == rank); assert(coor.shift().empty() || coor.shift().size() == rank); assert(coor.slice().empty() || coor.slice().size() == 3 * rank); mlir::Type idxTy = lowerTy().indexType(); mlir::Value one = genConstantIndex(loc, idxTy, rewriter, 1); mlir::Value prevExt = one; mlir::Value zero = genConstantIndex(loc, idxTy, rewriter, 0); mlir::Value offset = zero; const bool isShifted = !coor.shift().empty(); const bool isSliced = !coor.slice().empty(); const bool baseIsBoxed = coor.memref().getType().isa(); auto indexOps = coor.indices().begin(); auto shapeOps = coor.shape().begin(); auto shiftOps = coor.shift().begin(); auto sliceOps = coor.slice().begin(); // For each dimension of the array, generate the offset calculation. for (unsigned i = 0; i < rank; ++i, ++indexOps, ++shapeOps, ++shiftOps, sliceOps += 3) { mlir::Value index = integerCast(loc, rewriter, idxTy, operands[coor.indicesOffset() + i]); mlir::Value lb = isShifted ? integerCast(loc, rewriter, idxTy, operands[coor.shiftOffset() + i]) : one; mlir::Value step = one; bool normalSlice = isSliced; // Compute zero based index in dimension i of the element, applying // potential triplets and lower bounds. if (isSliced) { mlir::Value ub = *(sliceOps + 1); normalSlice = !mlir::isa_and_nonnull(ub.getDefiningOp()); if (normalSlice) step = integerCast(loc, rewriter, idxTy, *(sliceOps + 2)); } auto idx = rewriter.create(loc, idxTy, index, lb); mlir::Value diff = rewriter.create(loc, idxTy, idx, step); if (normalSlice) { mlir::Value sliceLb = integerCast(loc, rewriter, idxTy, operands[coor.sliceOffset() + i]); auto adj = rewriter.create(loc, idxTy, sliceLb, lb); diff = rewriter.create(loc, idxTy, diff, adj); } // Update the offset given the stride and the zero based index `diff` // that was just computed. if (baseIsBoxed) { // Use stride in bytes from the descriptor. mlir::Value stride = loadStrideFromBox(loc, adaptor.getOperands()[0], i, rewriter); auto sc = rewriter.create(loc, idxTy, diff, stride); offset = rewriter.create(loc, idxTy, sc, offset); } else { // Use stride computed at last iteration. auto sc = rewriter.create(loc, idxTy, diff, prevExt); offset = rewriter.create(loc, idxTy, sc, offset); // Compute next stride assuming contiguity of the base array // (in element number). auto nextExt = integerCast(loc, rewriter, idxTy, operands[coor.shapeOffset() + i]); prevExt = rewriter.create(loc, idxTy, prevExt, nextExt); } } // Add computed offset to the base address. if (baseIsBoxed) { // Working with byte offsets. The base address is read from the fir.box. // and need to be casted to i8* to do the pointer arithmetic. mlir::Type baseTy = getBaseAddrTypeFromBox(adaptor.getOperands()[0].getType()); mlir::Value base = loadBaseAddrFromBox(loc, baseTy, adaptor.getOperands()[0], rewriter); mlir::Type voidPtrTy = getVoidPtrType(); base = rewriter.create(loc, voidPtrTy, base); llvm::SmallVector args{offset}; auto addr = rewriter.create(loc, voidPtrTy, base, args); if (coor.subcomponent().empty()) { rewriter.replaceOpWithNewOp(coor, baseTy, addr); return success(); } auto casted = rewriter.create(loc, baseTy, addr); args.clear(); args.push_back(zero); if (!coor.lenParams().empty()) { // If type parameters are present, then we don't want to use a GEPOp // as below, as the LLVM struct type cannot be statically defined. TODO(loc, "derived type with type parameters"); } // TODO: array offset subcomponents must be converted to LLVM's // row-major layout here. for (auto i = coor.subcomponentOffset(); i != coor.indicesOffset(); ++i) args.push_back(operands[i]); rewriter.replaceOpWithNewOp(coor, baseTy, casted, args); return success(); } // The array was not boxed, so it must be contiguous. offset is therefore an // element offset and the base type is kept in the GEP unless the element // type size is itself dynamic. mlir::Value base; if (coor.subcomponent().empty()) { // No subcomponent. if (!coor.lenParams().empty()) { // Type parameters. Adjust element size explicitly. auto eleTy = fir::dyn_cast_ptrEleTy(coor.getType()); assert(eleTy && "result must be a reference-like type"); if (fir::characterWithDynamicLen(eleTy)) { assert(coor.lenParams().size() == 1); auto bitsInChar = lowerTy().getKindMap().getCharacterBitsize( eleTy.cast().getFKind()); auto scaling = genConstantIndex(loc, idxTy, rewriter, bitsInChar / 8); auto scaledBySize = rewriter.create(loc, idxTy, offset, scaling); auto length = integerCast(loc, rewriter, idxTy, adaptor.getOperands()[coor.lenParamsOffset()]); offset = rewriter.create(loc, idxTy, scaledBySize, length); } else { TODO(loc, "compute size of derived type with type parameters"); } } // Cast the base address to a pointer to T. base = rewriter.create(loc, ty, adaptor.getOperands()[0]); } else { // Operand #0 must have a pointer type. For subcomponent slicing, we // want to cast away the array type and have a plain struct type. mlir::Type ty0 = adaptor.getOperands()[0].getType(); auto ptrTy = ty0.dyn_cast(); assert(ptrTy && "expected pointer type"); mlir::Type eleTy = ptrTy.getElementType(); while (auto arrTy = eleTy.dyn_cast()) eleTy = arrTy.getElementType(); auto newTy = mlir::LLVM::LLVMPointerType::get(eleTy); base = rewriter.create(loc, newTy, adaptor.getOperands()[0]); } SmallVector args = {offset}; for (auto i = coor.subcomponentOffset(); i != coor.indicesOffset(); ++i) args.push_back(operands[i]); rewriter.replaceOpWithNewOp(coor, ty, base, args); return success(); } }; // // Primitive operations on Complex types // /// Generate inline code for complex addition/subtraction template static mlir::LLVM::InsertValueOp complexSum(OPTY sumop, mlir::ValueRange opnds, mlir::ConversionPatternRewriter &rewriter, fir::LLVMTypeConverter &lowering) { mlir::Value a = opnds[0]; mlir::Value b = opnds[1]; auto loc = sumop.getLoc(); auto ctx = sumop.getContext(); auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); mlir::Type eleTy = lowering.convertType(getComplexEleTy(sumop.getType())); mlir::Type ty = lowering.convertType(sumop.getType()); auto x0 = rewriter.create(loc, eleTy, a, c0); auto y0 = rewriter.create(loc, eleTy, a, c1); auto x1 = rewriter.create(loc, eleTy, b, c0); auto y1 = rewriter.create(loc, eleTy, b, c1); auto rx = rewriter.create(loc, eleTy, x0, x1); auto ry = rewriter.create(loc, eleTy, y0, y1); auto r0 = rewriter.create(loc, ty); auto r1 = rewriter.create(loc, ty, r0, rx, c0); return rewriter.create(loc, ty, r1, ry, c1); } namespace { struct AddcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::AddcOp addc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { // given: (x + iy) + (x' + iy') // result: (x + x') + i(y + y') auto r = complexSum(addc, adaptor.getOperands(), rewriter, lowerTy()); rewriter.replaceOp(addc, r.getResult()); return success(); } }; struct SubcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::SubcOp subc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { // given: (x + iy) - (x' + iy') // result: (x - x') + i(y - y') auto r = complexSum(subc, adaptor.getOperands(), rewriter, lowerTy()); rewriter.replaceOp(subc, r.getResult()); return success(); } }; /// Inlined complex multiply struct MulcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::MulcOp mulc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { // TODO: Can we use a call to __muldc3 ? // given: (x + iy) * (x' + iy') // result: (xx'-yy')+i(xy'+yx') mlir::Value a = adaptor.getOperands()[0]; mlir::Value b = adaptor.getOperands()[1]; auto loc = mulc.getLoc(); auto *ctx = mulc.getContext(); auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); mlir::Type eleTy = convertType(getComplexEleTy(mulc.getType())); mlir::Type ty = convertType(mulc.getType()); auto x0 = rewriter.create(loc, eleTy, a, c0); auto y0 = rewriter.create(loc, eleTy, a, c1); auto x1 = rewriter.create(loc, eleTy, b, c0); auto y1 = rewriter.create(loc, eleTy, b, c1); auto xx = rewriter.create(loc, eleTy, x0, x1); auto yx = rewriter.create(loc, eleTy, y0, x1); auto xy = rewriter.create(loc, eleTy, x0, y1); auto ri = rewriter.create(loc, eleTy, xy, yx); auto yy = rewriter.create(loc, eleTy, y0, y1); auto rr = rewriter.create(loc, eleTy, xx, yy); auto ra = rewriter.create(loc, ty); auto r1 = rewriter.create(loc, ty, ra, rr, c0); auto r0 = rewriter.create(loc, ty, r1, ri, c1); rewriter.replaceOp(mulc, r0.getResult()); return success(); } }; /// Inlined complex division struct DivcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::DivcOp divc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { // TODO: Can we use a call to __divdc3 instead? // Just generate inline code for now. // given: (x + iy) / (x' + iy') // result: ((xx'+yy')/d) + i((yx'-xy')/d) where d = x'x' + y'y' mlir::Value a = adaptor.getOperands()[0]; mlir::Value b = adaptor.getOperands()[1]; auto loc = divc.getLoc(); auto *ctx = divc.getContext(); auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); mlir::Type eleTy = convertType(getComplexEleTy(divc.getType())); mlir::Type ty = convertType(divc.getType()); auto x0 = rewriter.create(loc, eleTy, a, c0); auto y0 = rewriter.create(loc, eleTy, a, c1); auto x1 = rewriter.create(loc, eleTy, b, c0); auto y1 = rewriter.create(loc, eleTy, b, c1); auto xx = rewriter.create(loc, eleTy, x0, x1); auto x1x1 = rewriter.create(loc, eleTy, x1, x1); auto yx = rewriter.create(loc, eleTy, y0, x1); auto xy = rewriter.create(loc, eleTy, x0, y1); auto yy = rewriter.create(loc, eleTy, y0, y1); auto y1y1 = rewriter.create(loc, eleTy, y1, y1); auto d = rewriter.create(loc, eleTy, x1x1, y1y1); auto rrn = rewriter.create(loc, eleTy, xx, yy); auto rin = rewriter.create(loc, eleTy, yx, xy); auto rr = rewriter.create(loc, eleTy, rrn, d); auto ri = rewriter.create(loc, eleTy, rin, d); auto ra = rewriter.create(loc, ty); auto r1 = rewriter.create(loc, ty, ra, rr, c0); auto r0 = rewriter.create(loc, ty, r1, ri, c1); rewriter.replaceOp(divc, r0.getResult()); return success(); } }; /// Inlined complex negation struct NegcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::NegcOp neg, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { // given: -(x + iy) // result: -x - iy auto *ctxt = neg.getContext(); auto eleTy = convertType(getComplexEleTy(neg.getType())); auto ty = convertType(neg.getType()); auto loc = neg.getLoc(); mlir::Value o0 = adaptor.getOperands()[0]; auto c0 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(0)); auto c1 = mlir::ArrayAttr::get(ctxt, rewriter.getI32IntegerAttr(1)); auto rp = rewriter.create(loc, eleTy, o0, c0); auto ip = rewriter.create(loc, eleTy, o0, c1); auto nrp = rewriter.create(loc, eleTy, rp); auto nip = rewriter.create(loc, eleTy, ip); auto r = rewriter.create(loc, ty, o0, nrp, c0); rewriter.replaceOpWithNewOp(neg, ty, r, nip, c1); return success(); } }; /// Conversion pattern for operation that must be dead. The information in these /// operations is used by other operation. At this point they should not have /// anymore uses. /// These operations are normally dead after the pre-codegen pass. template struct MustBeDeadConversion : public FIROpConversion { explicit MustBeDeadConversion(fir::LLVMTypeConverter &lowering) : FIROpConversion(lowering) {} using OpAdaptor = typename FromOp::Adaptor; mlir::LogicalResult matchAndRewrite(FromOp op, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const final { if (!op->getUses().empty()) return rewriter.notifyMatchFailure(op, "op must be dead"); rewriter.eraseOp(op); return success(); } }; struct ShapeOpConversion : public MustBeDeadConversion { using MustBeDeadConversion::MustBeDeadConversion; }; struct ShapeShiftOpConversion : public MustBeDeadConversion { using MustBeDeadConversion::MustBeDeadConversion; }; struct ShiftOpConversion : public MustBeDeadConversion { using MustBeDeadConversion::MustBeDeadConversion; }; struct SliceOpConversion : public MustBeDeadConversion { using MustBeDeadConversion::MustBeDeadConversion; }; /// `fir.is_present` --> /// ``` /// %0 = llvm.mlir.constant(0 : i64) /// %1 = llvm.ptrtoint %0 /// %2 = llvm.icmp "ne" %1, %0 : i64 /// ``` struct IsPresentOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::IsPresentOp isPresent, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Type idxTy = lowerTy().indexType(); mlir::Location loc = isPresent.getLoc(); auto ptr = adaptor.getOperands()[0]; if (isPresent.val().getType().isa()) { auto structTy = ptr.getType().cast(); assert(!structTy.isOpaque() && !structTy.getBody().empty()); mlir::Type ty = structTy.getBody()[0]; mlir::MLIRContext *ctx = isPresent.getContext(); auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); ptr = rewriter.create(loc, ty, ptr, c0); } mlir::LLVM::ConstantOp c0 = genConstantIndex(isPresent.getLoc(), idxTy, rewriter, 0); auto addr = rewriter.create(loc, idxTy, ptr); rewriter.replaceOpWithNewOp( isPresent, mlir::LLVM::ICmpPredicate::ne, addr, c0); return success(); } }; /// Convert `!fir.emboxchar, #n>` into a sequence of /// instructions that generate `!llvm.struct<(ptr, i64)>`. The 1st element /// in this struct is a pointer. Its type is determined from `KIND`. The 2nd /// element is the length of the character buffer (`#n`). struct EmboxCharOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::EmboxCharOp emboxChar, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::ValueRange operands = adaptor.getOperands(); MLIRContext *ctx = emboxChar.getContext(); mlir::Value charBuffer = operands[0]; mlir::Value charBufferLen = operands[1]; mlir::Location loc = emboxChar.getLoc(); mlir::Type llvmStructTy = convertType(emboxChar.getType()); auto llvmStruct = rewriter.create(loc, llvmStructTy); mlir::Type lenTy = llvmStructTy.cast().getBody()[1]; mlir::Value lenAfterCast = integerCast(loc, rewriter, lenTy, charBufferLen); auto c0 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(0)); auto c1 = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(1)); auto insertBufferOp = rewriter.create( loc, llvmStructTy, llvmStruct, charBuffer, c0); rewriter.replaceOpWithNewOp( emboxChar, llvmStructTy, insertBufferOp, lenAfterCast, c1); return success(); } }; } // namespace /// Construct an `llvm.extractvalue` instruction. It will return value at /// element \p x from \p tuple. static mlir::LLVM::ExtractValueOp genExtractValueWithIndex(mlir::Location loc, mlir::Value tuple, mlir::Type ty, mlir::ConversionPatternRewriter &rewriter, mlir::MLIRContext *ctx, int x) { auto cx = mlir::ArrayAttr::get(ctx, rewriter.getI32IntegerAttr(x)); auto xty = ty.cast().getBody()[x]; return rewriter.create(loc, xty, tuple, cx); } namespace { /// Convert `!fir.boxchar_len` to `!llvm.extractvalue` for the 2nd part of the /// boxchar. struct BoxCharLenOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::BoxCharLenOp boxCharLen, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::Value boxChar = adaptor.getOperands()[0]; mlir::Location loc = boxChar.getLoc(); mlir::MLIRContext *ctx = boxChar.getContext(); mlir::Type returnValTy = boxCharLen.getResult().getType(); constexpr int boxcharLenIdx = 1; mlir::LLVM::ExtractValueOp len = genExtractValueWithIndex( loc, boxChar, boxChar.getType(), rewriter, ctx, boxcharLenIdx); mlir::Value lenAfterCast = integerCast(loc, rewriter, returnValTy, len); rewriter.replaceOp(boxCharLen, lenAfterCast); return success(); } }; /// Convert `fir.unboxchar` into two `llvm.extractvalue` instructions. One for /// the character buffer and one for the buffer length. struct UnboxCharOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::UnboxCharOp unboxchar, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { MLIRContext *ctx = unboxchar.getContext(); mlir::Type lenTy = convertType(unboxchar.getType(1)); mlir::Value tuple = adaptor.getOperands()[0]; mlir::Type tupleTy = tuple.getType(); mlir::Location loc = unboxchar.getLoc(); mlir::Value ptrToBuffer = genExtractValueWithIndex(loc, tuple, tupleTy, rewriter, ctx, 0); mlir::LLVM::ExtractValueOp len = genExtractValueWithIndex(loc, tuple, tupleTy, rewriter, ctx, 1); mlir::Value lenAfterCast = integerCast(loc, rewriter, lenTy, len); rewriter.replaceOp(unboxchar, ArrayRef{ptrToBuffer, lenAfterCast}); return success(); } }; /// Lower `fir.unboxproc` operation. Unbox a procedure box value, yielding its /// components. /// TODO: Part of supporting Fortran 2003 procedure pointers. struct UnboxProcOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; mlir::LogicalResult matchAndRewrite(fir::UnboxProcOp unboxproc, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { TODO(unboxproc.getLoc(), "fir.unboxproc codegen"); return failure(); } }; /// Convert `fir.field_index`. The conversion depends on whether the size of /// the record is static or dynamic. struct FieldIndexOpConversion : public FIROpConversion { using FIROpConversion::FIROpConversion; // NB: most field references should be resolved by this point mlir::LogicalResult matchAndRewrite(fir::FieldIndexOp field, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { auto recTy = field.on_type().cast(); unsigned index = recTy.getFieldIndex(field.field_id()); if (!fir::hasDynamicSize(recTy)) { // Derived type has compile-time constant layout. Return index of the // component type in the parent type (to be used in GEP). rewriter.replaceOp(field, mlir::ValueRange{genConstantOffset( field.getLoc(), rewriter, index)}); return success(); } // Derived type has compile-time constant layout. Call the compiler // generated function to determine the byte offset of the field at runtime. // This returns a non-constant. FlatSymbolRefAttr symAttr = mlir::SymbolRefAttr::get( field.getContext(), getOffsetMethodName(recTy, field.field_id())); NamedAttribute callAttr = rewriter.getNamedAttr("callee", symAttr); NamedAttribute fieldAttr = rewriter.getNamedAttr( "field", mlir::IntegerAttr::get(lowerTy().indexType(), index)); rewriter.replaceOpWithNewOp( field, lowerTy().offsetType(), adaptor.getOperands(), llvm::ArrayRef{callAttr, fieldAttr}); return success(); } // Re-Construct the name of the compiler generated method that calculates the // offset inline static std::string getOffsetMethodName(fir::RecordType recTy, llvm::StringRef field) { return recTy.getName().str() + "P." + field.str() + ".offset"; } }; /// Convert to (memory) reference to a reference to a subobject. /// The coordinate_of op is a Swiss army knife operation that can be used on /// (memory) references to records, arrays, complex, etc. as well as boxes. /// With unboxed arrays, there is the restriction that the array have a static /// shape in all but the last column. struct CoordinateOpConversion : public FIROpAndTypeConversion { using FIROpAndTypeConversion::FIROpAndTypeConversion; mlir::LogicalResult doRewrite(fir::CoordinateOp coor, mlir::Type ty, OpAdaptor adaptor, mlir::ConversionPatternRewriter &rewriter) const override { mlir::ValueRange operands = adaptor.getOperands(); mlir::Location loc = coor.getLoc(); mlir::Value base = operands[0]; mlir::Type baseObjectTy = coor.getBaseType(); mlir::Type objectTy = fir::dyn_cast_ptrOrBoxEleTy(baseObjectTy); assert(objectTy && "fir.coordinate_of expects a reference type"); // Complex type - basically, extract the real or imaginary part if (fir::isa_complex(objectTy)) { mlir::LLVM::ConstantOp c0 = genConstantIndex(loc, lowerTy().indexType(), rewriter, 0); SmallVector offs = {c0, operands[1]}; mlir::Value gep = genGEP(loc, ty, rewriter, base, offs); rewriter.replaceOp(coor, gep); return success(); } // Boxed type - get the base pointer from the box if (baseObjectTy.dyn_cast()) return doRewriteBox(coor, ty, operands, loc, rewriter); // Reference or pointer type if (baseObjectTy.isa()) return doRewriteRefOrPtr(coor, ty, operands, loc, rewriter); return rewriter.notifyMatchFailure( coor, "fir.coordinate_of base operand has unsupported type"); } unsigned getFieldNumber(fir::RecordType ty, mlir::Value op) const { return fir::hasDynamicSize(ty) ? op.getDefiningOp() ->getAttrOfType("field") .getInt() : getIntValue(op); } int64_t getIntValue(mlir::Value val) const { assert(val && val.dyn_cast() && "must not be null value"); mlir::Operation *defop = val.getDefiningOp(); if (auto constOp = dyn_cast(defop)) return constOp.value(); if (auto llConstOp = dyn_cast(defop)) if (auto attr = llConstOp.getValue().dyn_cast()) return attr.getValue().getSExtValue(); fir::emitFatalError(val.getLoc(), "must be a constant"); } bool hasSubDimensions(mlir::Type type) const { return type.isa(); } /// Check whether this form of `!fir.coordinate_of` is supported. These /// additional checks are required, because we are not yet able to convert /// all valid forms of `!fir.coordinate_of`. /// TODO: Either implement the unsupported cases or extend the verifier /// in FIROps.cpp instead. bool supportedCoordinate(mlir::Type type, mlir::ValueRange coors) const { const std::size_t numOfCoors = coors.size(); std::size_t i = 0; bool subEle = false; bool ptrEle = false; for (; i < numOfCoors; ++i) { mlir::Value nxtOpnd = coors[i]; if (auto arrTy = type.dyn_cast()) { subEle = true; i += arrTy.getDimension() - 1; type = arrTy.getEleTy(); } else if (auto recTy = type.dyn_cast()) { subEle = true; type = recTy.getType(getFieldNumber(recTy, nxtOpnd)); } else if (auto tupTy = type.dyn_cast()) { subEle = true; type = tupTy.getType(getIntValue(nxtOpnd)); } else { ptrEle = true; } } if (ptrEle) return (!subEle) && (numOfCoors == 1); return subEle && (i >= numOfCoors); } /// Walk the abstract memory layout and determine if the path traverses any /// array types with unknown shape. Return true iff all the array types have a /// constant shape along the path. bool arraysHaveKnownShape(mlir::Type type, mlir::ValueRange coors) const { const std::size_t sz = coors.size(); std::size_t i = 0; for (; i < sz; ++i) { mlir::Value nxtOpnd = coors[i]; if (auto arrTy = type.dyn_cast()) { if (fir::sequenceWithNonConstantShape(arrTy)) return false; i += arrTy.getDimension() - 1; type = arrTy.getEleTy(); } else if (auto strTy = type.dyn_cast()) { type = strTy.getType(getFieldNumber(strTy, nxtOpnd)); } else if (auto strTy = type.dyn_cast()) { type = strTy.getType(getIntValue(nxtOpnd)); } else { return true; } } return true; } private: mlir::LogicalResult doRewriteBox(fir::CoordinateOp coor, mlir::Type ty, mlir::ValueRange operands, mlir::Location loc, mlir::ConversionPatternRewriter &rewriter) const { mlir::Type boxObjTy = coor.getBaseType(); assert(boxObjTy.dyn_cast() && "This is not a `fir.box`"); mlir::Value boxBaseAddr = operands[0]; // 1. SPECIAL CASE (uses `fir.len_param_index`): // %box = ... : !fir.box> // %lenp = fir.len_param_index len1, !fir.type // %addr = coordinate_of %box, %lenp if (coor.getNumOperands() == 2) { mlir::Operation *coordinateDef = (*coor.coor().begin()).getDefiningOp(); if (isa_and_nonnull(coordinateDef)) { TODO(loc, "fir.coordinate_of - fir.len_param_index is not supported yet"); } } // 2. GENERAL CASE: // 2.1. (`fir.array`) // %box = ... : !fix.box> // %idx = ... : index // %resultAddr = coordinate_of %box, %idx : !fir.ref // 2.2 (`fir.derived`) // %box = ... : !fix.box> // %idx = ... : i32 // %resultAddr = coordinate_of %box, %idx : !fir.ref // 2.3 (`fir.derived` inside `fir.array`) // %box = ... : !fir.box>> // %idx1 = ... : index // %idx2 = ... : i32 // %resultAddr = coordinate_of %box, %idx1, %idx2 : !fir.ref // 2.4. TODO: Either document or disable any other case that the following // implementation might convert. mlir::LLVM::ConstantOp c0 = genConstantIndex(loc, lowerTy().indexType(), rewriter, 0); mlir::Value resultAddr = loadBaseAddrFromBox(loc, getBaseAddrTypeFromBox(boxBaseAddr.getType()), boxBaseAddr, rewriter); auto currentObjTy = fir::dyn_cast_ptrOrBoxEleTy(boxObjTy); mlir::Type voidPtrTy = ::getVoidPtrType(coor.getContext()); for (unsigned i = 1, last = operands.size(); i < last; ++i) { if (auto arrTy = currentObjTy.dyn_cast()) { if (i != 1) TODO(loc, "fir.array nested inside other array and/or derived type"); // Applies byte strides from the box. Ignore lower bound from box // since fir.coordinate_of indexes are zero based. Lowering takes care // of lower bound aspects. This both accounts for dynamically sized // types and non contiguous arrays. auto idxTy = lowerTy().indexType(); mlir::Value off = genConstantIndex(loc, idxTy, rewriter, 0); for (unsigned index = i, lastIndex = i + arrTy.getDimension(); index < lastIndex; ++index) { mlir::Value stride = loadStrideFromBox(loc, operands[0], index - i, rewriter); auto sc = rewriter.create(loc, idxTy, operands[index], stride); off = rewriter.create(loc, idxTy, sc, off); } auto voidPtrBase = rewriter.create(loc, voidPtrTy, resultAddr); SmallVector args{off}; resultAddr = rewriter.create(loc, voidPtrTy, voidPtrBase, args); i += arrTy.getDimension() - 1; currentObjTy = arrTy.getEleTy(); } else if (auto recTy = currentObjTy.dyn_cast()) { auto recRefTy = mlir::LLVM::LLVMPointerType::get(lowerTy().convertType(recTy)); mlir::Value nxtOpnd = operands[i]; auto memObj = rewriter.create(loc, recRefTy, resultAddr); llvm::SmallVector args = {c0, nxtOpnd}; currentObjTy = recTy.getType(getFieldNumber(recTy, nxtOpnd)); auto llvmCurrentObjTy = lowerTy().convertType(currentObjTy); auto gep = rewriter.create( loc, mlir::LLVM::LLVMPointerType::get(llvmCurrentObjTy), memObj, args); resultAddr = rewriter.create(loc, voidPtrTy, gep); } else { fir::emitFatalError(loc, "unexpected type in coordinate_of"); } } rewriter.replaceOpWithNewOp(coor, ty, resultAddr); return success(); } mlir::LogicalResult doRewriteRefOrPtr(fir::CoordinateOp coor, mlir::Type ty, mlir::ValueRange operands, mlir::Location loc, mlir::ConversionPatternRewriter &rewriter) const { mlir::Type baseObjectTy = coor.getBaseType(); mlir::Type currentObjTy = fir::dyn_cast_ptrOrBoxEleTy(baseObjectTy); bool hasSubdimension = hasSubDimensions(currentObjTy); bool columnIsDeferred = !hasSubdimension; if (!supportedCoordinate(currentObjTy, operands.drop_front(1))) { TODO(loc, "unsupported combination of coordinate operands"); } const bool hasKnownShape = arraysHaveKnownShape(currentObjTy, operands.drop_front(1)); // If only the column is `?`, then we can simply place the column value in // the 0-th GEP position. if (auto arrTy = currentObjTy.dyn_cast()) { if (!hasKnownShape) { const unsigned sz = arrTy.getDimension(); if (arraysHaveKnownShape(arrTy.getEleTy(), operands.drop_front(1 + sz))) { llvm::ArrayRef shape = arrTy.getShape(); bool allConst = true; for (unsigned i = 0; i < sz - 1; ++i) { if (shape[i] < 0) { allConst = false; break; } } if (allConst) columnIsDeferred = true; } } } if (fir::hasDynamicSize(fir::unwrapSequenceType(currentObjTy))) { mlir::emitError( loc, "fir.coordinate_of with a dynamic element size is unsupported"); return failure(); } if (hasKnownShape || columnIsDeferred) { SmallVector offs; if (hasKnownShape && hasSubdimension) { mlir::LLVM::ConstantOp c0 = genConstantIndex(loc, lowerTy().indexType(), rewriter, 0); offs.push_back(c0); } const std::size_t sz = operands.size(); Optional dims; SmallVector arrIdx; for (std::size_t i = 1; i < sz; ++i) { mlir::Value nxtOpnd = operands[i]; if (!currentObjTy) { mlir::emitError(loc, "invalid coordinate/check failed"); return failure(); } // check if the i-th coordinate relates to an array if (dims.hasValue()) { arrIdx.push_back(nxtOpnd); int dimsLeft = *dims; if (dimsLeft > 1) { dims = dimsLeft - 1; continue; } currentObjTy = currentObjTy.cast().getEleTy(); // append array range in reverse (FIR arrays are column-major) offs.append(arrIdx.rbegin(), arrIdx.rend()); arrIdx.clear(); dims.reset(); continue; } if (auto arrTy = currentObjTy.dyn_cast()) { int d = arrTy.getDimension() - 1; if (d > 0) { dims = d; arrIdx.push_back(nxtOpnd); continue; } currentObjTy = currentObjTy.cast().getEleTy(); offs.push_back(nxtOpnd); continue; } // check if the i-th coordinate relates to a field if (auto recTy = currentObjTy.dyn_cast()) currentObjTy = recTy.getType(getFieldNumber(recTy, nxtOpnd)); else if (auto tupTy = currentObjTy.dyn_cast()) currentObjTy = tupTy.getType(getIntValue(nxtOpnd)); else currentObjTy = nullptr; offs.push_back(nxtOpnd); } if (dims.hasValue()) offs.append(arrIdx.rbegin(), arrIdx.rend()); mlir::Value base = operands[0]; mlir::Value retval = genGEP(loc, ty, rewriter, base, offs); rewriter.replaceOp(coor, retval); return success(); } mlir::emitError(loc, "fir.coordinate_of base operand has unsupported type"); return failure(); } }; } // namespace namespace { /// Convert FIR dialect to LLVM dialect /// /// This pass lowers all FIR dialect operations to LLVM IR dialect. An /// MLIR pass is used to lower residual Std dialect to LLVM IR dialect. /// /// This pass is not complete yet. We are upstreaming it in small patches. class FIRToLLVMLowering : public fir::FIRToLLVMLoweringBase { public: mlir::ModuleOp getModule() { return getOperation(); } void runOnOperation() override final { auto mod = getModule(); if (!forcedTargetTriple.empty()) { fir::setTargetTriple(mod, forcedTargetTriple); } auto *context = getModule().getContext(); fir::LLVMTypeConverter typeConverter{getModule()}; mlir::RewritePatternSet pattern(context); pattern.insert< AbsentOpConversion, AddcOpConversion, AddrOfOpConversion, AllocaOpConversion, AllocMemOpConversion, BoxAddrOpConversion, BoxCharLenOpConversion, BoxDimsOpConversion, BoxEleSizeOpConversion, BoxIsAllocOpConversion, BoxIsArrayOpConversion, BoxIsPtrOpConversion, BoxProcHostOpConversion, BoxRankOpConversion, BoxTypeDescOpConversion, CallOpConversion, CmpcOpConversion, ConstcOpConversion, ConvertOpConversion, CoordinateOpConversion, DispatchOpConversion, DispatchTableOpConversion, DTEntryOpConversion, DivcOpConversion, EmboxOpConversion, EmboxCharOpConversion, EmboxProcOpConversion, ExtractValueOpConversion, FieldIndexOpConversion, FirEndOpConversion, FreeMemOpConversion, HasValueOpConversion, GenTypeDescOpConversion, GlobalLenOpConversion, GlobalOpConversion, InsertOnRangeOpConversion, InsertValueOpConversion, IsPresentOpConversion, LenParamIndexOpConversion, LoadOpConversion, NegcOpConversion, NoReassocOpConversion, MulcOpConversion, SelectCaseOpConversion, SelectOpConversion, SelectRankOpConversion, SelectTypeOpConversion, ShapeOpConversion, ShapeShiftOpConversion, ShiftOpConversion, SliceOpConversion, StoreOpConversion, StringLitOpConversion, SubcOpConversion, UnboxCharOpConversion, UnboxProcOpConversion, UndefOpConversion, UnreachableOpConversion, XArrayCoorOpConversion, XEmboxOpConversion, XReboxOpConversion, ZeroOpConversion>( typeConverter); mlir::populateStdToLLVMConversionPatterns(typeConverter, pattern); mlir::arith::populateArithmeticToLLVMConversionPatterns(typeConverter, pattern); mlir::cf::populateControlFlowToLLVMConversionPatterns(typeConverter, pattern); mlir::ConversionTarget target{*context}; target.addLegalDialect(); // required NOPs for applying a full conversion target.addLegalOp(); // apply the patterns if (mlir::failed(mlir::applyFullConversion(getModule(), target, std::move(pattern)))) { signalPassFailure(); } } }; /// Lower from LLVM IR dialect to proper LLVM-IR and dump the module struct LLVMIRLoweringPass : public mlir::PassWrapper> { using Printer = fir::LLVMIRLoweringPrinter; LLVMIRLoweringPass(raw_ostream &output, Printer p) : output{output}, printer{p} {} mlir::ModuleOp getModule() { return getOperation(); } void runOnOperation() override final { auto *ctx = getModule().getContext(); auto optName = getModule().getName(); llvm::LLVMContext llvmCtx; if (auto llvmModule = mlir::translateModuleToLLVMIR( getModule(), llvmCtx, optName ? *optName : "FIRModule")) { printer(*llvmModule, output); return; } mlir::emitError(mlir::UnknownLoc::get(ctx), "could not emit LLVM-IR\n"); signalPassFailure(); } private: raw_ostream &output; Printer printer; }; } // namespace std::unique_ptr fir::createFIRToLLVMPass() { return std::make_unique(); } std::unique_ptr fir::createLLVMDialectToLLVMPass(raw_ostream &output, fir::LLVMIRLoweringPrinter printer) { return std::make_unique(output, printer); }