13#ifndef FORTRAN_OPTIMIZER_DIALECT_FIRTYPE_H
14#define FORTRAN_OPTIMIZER_DIALECT_FIRTYPE_H
16#include "mlir/IR/BuiltinAttributes.h"
17#include "mlir/IR/BuiltinTypes.h"
18#include "mlir/Interfaces/DataLayoutInterfaces.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/IR/Type.h"
25using KindTy = unsigned;
42 using mlir::Type::Type;
45 enum class Attribute { None, Allocatable, Pointer };
57 mlir::Type getElementOrSequenceType()
const;
80 static bool classof(mlir::Type type);
85#define GET_TYPEDEF_CLASSES
86#include "flang/Optimizer/Dialect/FIROpsTypes.h.inc"
97class DialectAsmParser;
98class DialectAsmPrinter;
106struct RecordTypeStorage;
122 return mlir::isa<fir::ReferenceType, fir::PointerType, fir::HeapType,
123 fir::LLVMPointerType>(t);
128 return mlir::isa<fir::BaseBoxType, fir::BoxCharType, fir::BoxProcType>(t);
135 return mlir::isa<fir::ReferenceType, mlir::FunctionType>(t) ||
147inline bool isa_derived(mlir::Type t) {
return mlir::isa<fir::RecordType>(t); }
151 if (
auto recTy = mlir::dyn_cast_or_null<fir::RecordType>(t))
152 return recTy.getName().ends_with(
"T__builtin_c_ptr") ||
153 recTy.getName().ends_with(
"T__builtin_c_funptr");
158inline bool isa_builtin_c_devptr_type(mlir::Type t) {
159 if (
auto recTy = mlir::dyn_cast_or_null<fir::RecordType>(t))
160 return recTy.getName().ends_with(
"T__builtin_c_devptr");
166 if (
auto recTy = mlir::dyn_cast_or_null<fir::RecordType>(t))
167 return recTy.getName().ends_with(
"T__builtin_c_devptr");
185inline bool isa_real(mlir::Type t) {
return mlir::isa<mlir::FloatType>(t); }
189 return mlir::isa<mlir::IndexType, mlir::IntegerType, fir::IntegerType>(t);
194 return mlir::isa<mlir::VectorType, fir::VectorType>(t);
197mlir::Type parseFirType(FIROpsDialect *, mlir::DialectAsmParser &parser);
199void printFirType(FIROpsDialect *, mlir::Type ty, mlir::DialectAsmPrinter &p);
207 return mlir::isa<mlir::ComplexType>(t) &&
208 mlir::isa<mlir::FloatType>(
209 mlir::cast<mlir::ComplexType>(t).getElementType());
213inline bool isa_char(mlir::Type t) {
return mlir::isa<fir::CharacterType>(t); }
219 mlir::isa<fir::LogicalType>(t);
224 if (
auto ct = mlir::dyn_cast_or_null<fir::CharacterType>(t))
225 return ct.getLen() != fir::CharacterType::singleton();
242 if (
auto charTy = mlir::dyn_cast<fir::CharacterType>(t))
243 return charTy.hasDynamicLen();
250 return seqTy.hasUnknownShape() || seqTy.hasDynamicExtents();
256inline unsigned getRankOfShapeType(mlir::Type t) {
257 if (
auto shTy = mlir::dyn_cast<fir::ShapeType>(t))
258 return shTy.getRank();
259 if (
auto shTy = mlir::dyn_cast<fir::ShapeShiftType>(t))
260 return shTy.getRank();
261 if (
auto shTy = mlir::dyn_cast<fir::ShiftType>(t))
262 return shTy.getRank();
269 if (!mlir::isa<fir::PointerType, fir::HeapType>(eleTy))
270 eleTy = fir::ReferenceType::get(t);
276 if (
auto seqTy = mlir::dyn_cast<fir::SequenceType>(t))
277 return seqTy.getEleTy();
284inline mlir::Type unwrapRefType(mlir::Type t) {
329 if (
auto seqTy = mlir::dyn_cast<fir::SequenceType>(t))
338 return mlir::dyn_cast<fir::RecordType>(
345 return recTy && recTy.getNumLenParams() > 0;
356inline bool singleIndirectionLevel(mlir::Type ty) {
431 if (
auto recTy = mlir::dyn_cast_or_null<fir::RecordType>(ty))
432 return recTy.isDependentType();
449mlir::Type
fromRealTypeID(mlir::MLIRContext *context, llvm::Type::TypeID typeID,
452int getTypeCode(mlir::Type ty,
const KindMapping &kindMap);
455 return mlir::isa<fir::BoxType, fir::ClassType>(type);
460 if (
auto seqTy = mlir::dyn_cast<fir::SequenceType>(type))
461 return mlir::isa<mlir::NoneType>(seqTy.getEleTy());
462 return mlir::isa<mlir::NoneType>(type);
468 bool isPolymorphic =
false,
471 return fir::ClassType::get(eleTy);
472 return fir::BoxType::get(eleTy);
486 if (
auto seqTy = mlir::dyn_cast<fir::SequenceType>(ty))
487 return fir::SequenceType::get(
489 if (
auto heapTy = mlir::dyn_cast<fir::HeapType>(ty))
490 return fir::HeapType::get(
492 if (
auto pointerTy = mlir::dyn_cast<fir::PointerType>(ty))
493 return fir::PointerType::get(
495 if (!mlir::isa<mlir::NoneType, fir::RecordType>(ty))
496 return mlir::NoneType::get(ty.getContext());
509 bool turnBoxIntoClass);
514 mlir::isa<fir::BaseBoxType>(fir::unwrapRefType(t));
519 return mlir::isa<fir::BaseBoxType>(fir::unwrapRefType(t));
525 return t && mlir::isa<fir::BoxProcType>(t);
528inline bool isRefOfConstantSizeAggregateType(mlir::Type t) {
531 mlir::isa<fir::CharacterType, fir::RecordType, fir::SequenceType>(t) &&
540 llvm::StringRef prefix =
"");
550std::pair<std::uint64_t, unsigned short>
552 const mlir::DataLayout &dl,
553 const fir::KindMapping &kindMap);
556std::optional<std::pair<uint64_t, unsigned short>>
558 const mlir::DataLayout &dl,
559 const fir::KindMapping &kindMap);
This class provides a shared interface for box and class types.
Definition FIRType.h:40
Attribute
Box attributes.
Definition FIRType.h:45
BaseBoxType getBoxTypeWithNewAttr(Attribute attr) const
Return the same type, except for the attribute (fir.heap/fir.ptr).
Definition FIRType.cpp:1487
bool isVolatile() const
Is this a box describing volatile memory?
Definition FIRType.cpp:1524
bool isPointer() const
Is this a box for a pointer?
Definition FIRType.cpp:1516
bool isAssumedRank() const
Is this the box for an assumed rank?
Definition FIRType.cpp:1509
mlir::Type unwrapInnerType() const
Unwrap element type from fir.heap, fir.ptr and fir.array.
Definition FIRType.cpp:1426
mlir::Type getEleTy() const
Returns the element type of this box type.
Definition FIRType.cpp:1413
bool isPointerOrAllocatable() const
Does this box for a pointer or allocatable?
Definition FIRType.cpp:1520
mlir::Type getBaseAddressType() const
Get the raw address type of the memory described by the box.
Definition FIRType.cpp:1419
BaseBoxType getBoxTypeWithNewShape(mlir::Type shapeMold) const
Definition FIRType.cpp:1468
static bool classof(mlir::Type type)
Methods for support type inquiry through isa, cast, and dyn_cast.
Definition FIRType.h:454
Definition KindMapping.h:48
Definition AbstractConverter.h:34
bool isa_box_type(mlir::Type t)
Is t a boxed type?
Definition FIRType.h:127
int getTypeCode(mlir::Type ty, const KindMapping &kindMap)
Return the ISO_C_BINDING intrinsic module value of type ty.
Definition FIRType.cpp:493
bool isScalarBoxedRecordType(mlir::Type ty)
Definition FIRType.cpp:350
mlir::Type applyPathToType(mlir::Type rootTy, mlir::ValueRange path)
Definition FIROps.cpp:4887
std::string getTypeAsString(mlir::Type ty, const KindMapping &kindMap, llvm::StringRef prefix="")
Definition FIRType.cpp:590
fir::SequenceType unwrapUntilSeqType(mlir::Type t)
Definition FIRType.h:321
bool sequenceWithNonConstantShape(fir::SequenceType seqTy)
Definition FIRType.h:249
bool isa_ref_type(mlir::Type t)
Is t a FIR dialect type that implies a memory (de)reference?
Definition FIRType.h:121
bool isBoxAddressOrValue(mlir::Type t)
Is t a fir.box or class address or value type?
Definition FIRType.h:518
bool conformsWithPassByRef(mlir::Type t)
Definition FIRType.h:142
bool isa_volatile_type(mlir::Type t)
Definition FIRType.cpp:748
bool isa_builtin_cdevptr_type(mlir::Type t)
Is t type(c_devptr)?
Definition FIRType.h:165
mlir::Type updateTypeWithVolatility(mlir::Type type, bool isVolatile)
Definition FIRType.cpp:234
mlir::Type fromRealTypeID(mlir::MLIRContext *context, llvm::Type::TypeID typeID, fir::KindTy kind)
Convert llvm::Type::TypeID to mlir::Type.
Definition FIRType.cpp:1387
bool isUnlimitedPolymorphicType(mlir::Type ty)
Definition FIRType.cpp:410
bool isa_vector(mlir::Type t)
Is t a vector type?
Definition FIRType.h:193
mlir::Type unwrapPassByRefType(mlir::Type t)
Definition FIRType.h:292
bool isDerivedType(fir::BaseBoxType boxTy)
Return true iff boxTy wraps a fir::RecordType.
Definition FIRType.h:349
bool isa_char(mlir::Type t)
Is t a CHARACTER type? Does not check the length.
Definition FIRType.h:213
bool isBoxedRecordType(mlir::Type ty)
Definition FIRType.cpp:327
bool isBoxNone(mlir::Type ty)
Return true iff ty is !fir.box<none>.
Definition FIRType.cpp:321
mlir::Type unwrapSeqOrBoxedSeqType(mlir::Type ty)
Definition FIRType.cpp:474
bool isBoxAddress(mlir::Type t)
Is t an address to fir.box or class type?
Definition FIRType.h:512
mlir::Type updateTypeForUnlimitedPolymorphic(mlir::Type ty)
Definition FIRType.h:485
bool isa_derived(mlir::Type t)
Is t a derived (record) type?
Definition FIRType.h:147
bool isa_aggregate(mlir::Type t)
Is t a FIR dialect aggregate type?
Definition FIRType.h:172
bool isDerivedTypeWithLenParams(fir::BaseBoxType boxTy)
Return true iff boxTy wraps a fir::RecordType with length parameters.
Definition FIRType.h:343
mlir::Type unwrapInnerType(mlir::Type ty)
Return the inner type of the given type.
Definition FIRType.cpp:418
bool isAssumedShape(mlir::Type ty)
Return true iff ty is the type of an assumed shape array.
Definition FIRType.cpp:377
bool isCharacterProcedureTuple(mlir::Type type, bool acceptRawFunc=true)
Is this tuple type holding a character function and its result length?
Definition FIRType.cpp:1369
mlir::Type dyn_cast_ptrEleTy(mlir::Type t)
Definition FIRType.cpp:247
mlir::Type getDerivedType(mlir::Type ty)
Return the nested RecordType if one if found. Return ty otherwise.
Definition FIRType.cpp:222
bool isa_fir_or_std_type(mlir::Type t)
Is t any of the FIR dialect or Standard dialect types?
Definition FIRType.cpp:215
mlir::Type getFortranElementType(mlir::Type ty)
Definition FIRType.cpp:469
bool isNoneOrSeqNone(mlir::Type type)
Return true iff ty is none or fir.array<none>.
Definition FIRType.h:459
std::optional< std::pair< uint64_t, unsigned short > > getTypeSizeAndAlignment(mlir::Location loc, mlir::Type ty, const mlir::DataLayout &dl, const fir::KindMapping &kindMap)
This variant returns std::nullopt if an unsupported type is passed.
Definition FIRType.cpp:1547
fir::RecordType unwrapIfDerived(fir::BaseBoxType boxTy)
Definition FIRType.h:337
bool boxHasAddendum(fir::BaseBoxType boxTy)
Definition FIRType.h:411
bool isRecordWithAllocatableMember(mlir::Type ty)
Return true iff ty is a RecordType with members that are allocatable.
Definition FIRType.cpp:430
unsigned getBoxRank(mlir::Type boxTy)
Get the rank from a !fir.box type.
Definition FIRType.cpp:485
bool isClassStarType(mlir::Type ty)
Return true if CLASS(*)
Definition FIRType.cpp:340
mlir::Type dyn_cast_ptrOrBoxEleTy(mlir::Type t)
Definition FIRType.cpp:254
bool isPointerType(mlir::Type ty)
Definition FIRType.cpp:305
bool isTypeWithDescriptor(mlir::Type ty)
Return true iff ty is a type that contains descriptor information.
Definition FIRType.cpp:396
bool characterWithDynamicLen(mlir::Type t)
Returns true iff t is a fir.char type and has an unknown length.
Definition FIRType.h:241
bool isAllocatableType(mlir::Type ty)
Return true iff ty is the type of an ALLOCATABLE entity or value.
Definition FIRType.cpp:313
mlir::Type changeElementType(mlir::Type type, mlir::Type newElementType, bool turnBoxIntoClass)
Definition FIRType.cpp:685
bool isPolymorphicType(mlir::Type ty)
Definition FIRType.cpp:402
bool isa_builtin_cptr_type(mlir::Type t)
Is t type(c_ptr) or type(c_funptr)?
Definition FIRType.h:150
mlir::Type unwrapAllRefAndSeqType(mlir::Type ty)
Definition FIRType.cpp:458
bool hasAbstractResult(mlir::FunctionType ty)
Definition FIRType.cpp:1377
bool isAllocatableOrPointerArray(mlir::Type ty)
Return true iff ty is the type of an allocatable array.
Definition FIRType.cpp:384
bool isa_integer(mlir::Type t)
Is t an integral type?
Definition FIRType.h:188
mlir::Type extractSequenceType(mlir::Type ty)
Return the nested sequence type if any.
Definition FIRType.cpp:293
bool isa_char_string(mlir::Type t)
Is t a CHARACTER type with a LEN other than 1?
Definition FIRType.h:223
bool isRecordWithDescriptorMember(mlir::Type ty)
Definition FIRType.cpp:444
bool isBoxProcAddressType(mlir::Type t)
Is this a fir.boxproc address type?
Definition FIRType.h:523
bool isa_std_type(mlir::Type t)
Is t any of the Standard dialect types?
Definition FIRType.cpp:211
bool isa_passbyref_type(mlir::Type t)
Definition FIRType.h:134
std::pair< std::uint64_t, unsigned short > getTypeSizeAndAlignmentOrCrash(mlir::Location loc, mlir::Type ty, const mlir::DataLayout &dl, const fir::KindMapping &kindMap)
This variant terminates the compilation if an unsupported type is passed.
Definition FIRType.cpp:1601
bool hasDynamicSize(mlir::Type t)
Returns true iff the type t does not have a constant size.
Definition FIRType.cpp:280
mlir::Type boxMemRefType(fir::BaseBoxType t)
Get the memory reference type of the data pointer from the box type,.
Definition FIRType.h:267
bool isRecordWithTypeParameters(mlir::Type ty)
Return true iff ty is a RecordType with type parameters.
Definition FIRType.h:430
bool isAssumedType(mlir::Type ty)
Definition FIRType.cpp:364
void verifyIntegralType(mlir::Type type)
Definition FIRType.cpp:726
bool isa_complex(mlir::Type t)
Is t a floating point complex type?
Definition FIRType.h:206
bool isa_fir_type(mlir::Type t)
Is t any of the FIR dialect types?
Definition FIRType.cpp:207
mlir::Type wrapInClassOrBoxType(mlir::Type eleTy, bool isPolymorphic=false, bool isAssumedType=false)
Definition FIRType.h:467
bool isa_trivial(mlir::Type t)
Definition FIRType.h:217
mlir::Type unwrapSequenceType(mlir::Type t)
If t is a SequenceType return its element type, otherwise return t.
Definition FIRType.h:275
bool isa_unknown_size_box(mlir::Type t)
Definition FIRType.cpp:738
bool isa_real(mlir::Type t)
Is t a real type?
Definition FIRType.h:185
Definition AbstractConverter.h:29
Derived type storage.
Definition FIRType.cpp:149