MLIR  18.0.0git
Types.h
Go to the documentation of this file.
1 //===- Types.h - MLIR Type Classes ------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef MLIR_IR_TYPES_H
10 #define MLIR_IR_TYPES_H
11 
12 #include "mlir/IR/TypeSupport.h"
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/DenseMapInfo.h"
15 #include "llvm/Support/PointerLikeTypeTraits.h"
16 
17 namespace mlir {
18 class AsmState;
19 
20 /// Instances of the Type class are uniqued, have an immutable identifier and an
21 /// optional mutable component. They wrap a pointer to the storage object owned
22 /// by MLIRContext. Therefore, instances of Type are passed around by value.
23 ///
24 /// Some types are "primitives" meaning they do not have any parameters, for
25 /// example the Index type. Parametric types have additional information that
26 /// differentiates the types of the same class, for example the Integer type has
27 /// bitwidth, making i8 and i16 belong to the same kind by be different
28 /// instances of the IntegerType. Type parameters are part of the unique
29 /// immutable key. The mutable component of the type can be modified after the
30 /// type is created, but cannot affect the identity of the type.
31 ///
32 /// Types are constructed and uniqued via the 'detail::TypeUniquer' class.
33 ///
34 /// Derived type classes are expected to implement several required
35 /// implementation hooks:
36 /// * Optional:
37 /// - static LogicalResult verify(
38 /// function_ref<InFlightDiagnostic()> emitError,
39 /// Args... args)
40 /// * This method is invoked when calling the 'TypeBase::get/getChecked'
41 /// methods to ensure that the arguments passed in are valid to construct
42 /// a type instance with.
43 /// * This method is expected to return failure if a type cannot be
44 /// constructed with 'args', success otherwise.
45 /// * 'args' must correspond with the arguments passed into the
46 /// 'TypeBase::get' call.
47 ///
48 ///
49 /// Type storage objects inherit from TypeStorage and contain the following:
50 /// - The dialect that defined the type.
51 /// - Any parameters of the type.
52 /// - An optional mutable component.
53 /// For non-parametric types, a convenience DefaultTypeStorage is provided.
54 /// Parametric storage types must derive TypeStorage and respect the following:
55 /// - Define a type alias, KeyTy, to a type that uniquely identifies the
56 /// instance of the type.
57 /// * The key type must be constructible from the values passed into the
58 /// detail::TypeUniquer::get call.
59 /// * If the KeyTy does not have an llvm::DenseMapInfo specialization, the
60 /// storage class must define a hashing method:
61 /// 'static unsigned hashKey(const KeyTy &)'
62 ///
63 /// - Provide a method, 'bool operator==(const KeyTy &) const', to
64 /// compare the storage instance against an instance of the key type.
65 ///
66 /// - Provide a static construction method:
67 /// 'DerivedStorage *construct(TypeStorageAllocator &, const KeyTy &key)'
68 /// that builds a unique instance of the derived storage. The arguments to
69 /// this function are an allocator to store any uniqued data within the
70 /// context and the key type for this storage.
71 ///
72 /// - If they have a mutable component, this component must not be a part of
73 /// the key.
74 class Type {
75 public:
76  /// Utility class for implementing types.
77  template <typename ConcreteType, typename BaseType, typename StorageType,
78  template <typename T> class... Traits>
79  using TypeBase = detail::StorageUserBase<ConcreteType, BaseType, StorageType,
80  detail::TypeUniquer, Traits...>;
81 
83 
85 
86  constexpr Type() = default;
87  /* implicit */ Type(const ImplType *impl)
88  : impl(const_cast<ImplType *>(impl)) {}
89 
90  Type(const Type &other) = default;
91  Type &operator=(const Type &other) = default;
92 
93  bool operator==(Type other) const { return impl == other.impl; }
94  bool operator!=(Type other) const { return !(*this == other); }
95  explicit operator bool() const { return impl; }
96 
97  bool operator!() const { return impl == nullptr; }
98 
99  template <typename... Tys>
100  bool isa() const;
101  template <typename... Tys>
102  bool isa_and_nonnull() const;
103  template <typename U>
104  U dyn_cast() const;
105  template <typename U>
106  U dyn_cast_or_null() const;
107  template <typename U>
108  U cast() const;
109 
110  /// Return a unique identifier for the concrete type. This is used to support
111  /// dynamic type casting.
112  TypeID getTypeID() { return impl->getAbstractType().getTypeID(); }
113 
114  /// Return the MLIRContext in which this type was uniqued.
115  MLIRContext *getContext() const;
116 
117  /// Get the dialect this type is registered to.
118  Dialect &getDialect() const { return impl->getAbstractType().getDialect(); }
119 
120  // Convenience predicates. This is only for floating point types,
121  // derived types should use isa/dyn_cast.
122  bool isIndex() const;
123  bool isFloat8E5M2() const;
124  bool isFloat8E4M3FN() const;
125  bool isFloat8E5M2FNUZ() const;
126  bool isFloat8E4M3FNUZ() const;
127  bool isFloat8E4M3B11FNUZ() const;
128  bool isBF16() const;
129  bool isF16() const;
130  bool isTF32() const;
131  bool isF32() const;
132  bool isF64() const;
133  bool isF80() const;
134  bool isF128() const;
135 
136  /// Return true if this is an integer type with the specified width.
137  bool isInteger(unsigned width) const;
138  /// Return true if this is a signless integer type (with the specified width).
139  bool isSignlessInteger() const;
140  bool isSignlessInteger(unsigned width) const;
141  /// Return true if this is a signed integer type (with the specified width).
142  bool isSignedInteger() const;
143  bool isSignedInteger(unsigned width) const;
144  /// Return true if this is an unsigned integer type (with the specified
145  /// width).
146  bool isUnsignedInteger() const;
147  bool isUnsignedInteger(unsigned width) const;
148 
149  /// Return the bit width of an integer or a float type, assert failure on
150  /// other types.
151  unsigned getIntOrFloatBitWidth() const;
152 
153  /// Return true if this is a signless integer or index type.
154  bool isSignlessIntOrIndex() const;
155  /// Return true if this is a signless integer, index, or float type.
156  bool isSignlessIntOrIndexOrFloat() const;
157  /// Return true of this is a signless integer or a float type.
158  bool isSignlessIntOrFloat() const;
159 
160  /// Return true if this is an integer (of any signedness) or an index type.
161  bool isIntOrIndex() const;
162  /// Return true if this is an integer (of any signedness) or a float type.
163  bool isIntOrFloat() const;
164  /// Return true if this is an integer (of any signedness), index, or float
165  /// type.
166  bool isIntOrIndexOrFloat() const;
167 
168  /// Print the current type.
169  void print(raw_ostream &os) const;
170  void print(raw_ostream &os, AsmState &state) const;
171  void dump() const;
172 
173  friend ::llvm::hash_code hash_value(Type arg);
174 
175  /// Methods for supporting PointerLikeTypeTraits.
176  const void *getAsOpaquePointer() const {
177  return static_cast<const void *>(impl);
178  }
179  static Type getFromOpaquePointer(const void *pointer) {
180  return Type(reinterpret_cast<ImplType *>(const_cast<void *>(pointer)));
181  }
182 
183  /// Returns true if `InterfaceT` has been promised by the dialect or
184  /// implemented.
185  template <typename InterfaceT>
188  getDialect(), getTypeID(), InterfaceT::getInterfaceID()) ||
189  mlir::isa<InterfaceT>(*this);
190  }
191 
192  /// Returns true if the type was registered with a particular trait.
193  template <template <typename T> class Trait>
194  bool hasTrait() {
195  return getAbstractType().hasTrait<Trait>();
196  }
197 
198  /// Return the abstract type descriptor for this type.
199  const AbstractTy &getAbstractType() const { return impl->getAbstractType(); }
200 
201  /// Return the Type implementation.
202  ImplType *getImpl() const { return impl; }
203 
204  /// Walk all of the immediately nested sub-attributes and sub-types. This
205  /// method does not recurse into sub elements.
207  function_ref<void(Type)> walkTypesFn) const {
208  getAbstractType().walkImmediateSubElements(*this, walkAttrsFn, walkTypesFn);
209  }
210 
211  /// Replace the immediately nested sub-attributes and sub-types with those
212  /// provided. The order of the provided elements is derived from the order of
213  /// the elements returned by the callbacks of `walkImmediateSubElements`. The
214  /// element at index 0 would replace the very first attribute given by
215  /// `walkImmediateSubElements`. On success, the new instance with the values
216  /// replaced is returned. If replacement fails, nullptr is returned.
218  ArrayRef<Type> replTypes) const {
219  return getAbstractType().replaceImmediateSubElements(*this, replAttrs,
220  replTypes);
221  }
222 
223  /// Walk this type and all attibutes/types nested within using the
224  /// provided walk functions. See `AttrTypeWalker` for information on the
225  /// supported walk function types.
226  template <WalkOrder Order = WalkOrder::PostOrder, typename... WalkFns>
227  auto walk(WalkFns &&...walkFns) {
228  AttrTypeWalker walker;
229  (walker.addWalk(std::forward<WalkFns>(walkFns)), ...);
230  return walker.walk<Order>(*this);
231  }
232 
233  /// Recursively replace all of the nested sub-attributes and sub-types using
234  /// the provided map functions. Returns nullptr in the case of failure. See
235  /// `AttrTypeReplacer` for information on the support replacement function
236  /// types.
237  template <typename... ReplacementFns>
238  auto replace(ReplacementFns &&...replacementFns) {
239  AttrTypeReplacer replacer;
240  (replacer.addReplacement(std::forward<ReplacementFns>(replacementFns)),
241  ...);
242  return replacer.replace(*this);
243  }
244 
245 protected:
246  ImplType *impl{nullptr};
247 };
248 
249 inline raw_ostream &operator<<(raw_ostream &os, Type type) {
250  type.print(os);
251  return os;
252 }
253 
254 //===----------------------------------------------------------------------===//
255 // TypeTraitBase
256 //===----------------------------------------------------------------------===//
257 
258 namespace TypeTrait {
259 /// This class represents the base of a type trait.
260 template <typename ConcreteType, template <typename> class TraitType>
262 } // namespace TypeTrait
263 
264 //===----------------------------------------------------------------------===//
265 // TypeInterface
266 //===----------------------------------------------------------------------===//
267 
268 /// This class represents the base of a type interface. See the definition of
269 /// `detail::Interface` for requirements on the `Traits` type.
270 template <typename ConcreteType, typename Traits>
271 class TypeInterface : public detail::Interface<ConcreteType, Type, Traits, Type,
272  TypeTrait::TraitBase> {
273 public:
278 
279 protected:
280  /// Returns the impl interface instance for the given type.
281  static typename InterfaceBase::Concept *getInterfaceFor(Type type) {
282 #ifndef NDEBUG
283  // Check that the current interface isn't an unresolved promise for the
284  // given type.
286  type.getDialect(), type.getTypeID(), ConcreteType::getInterfaceID(),
287  llvm::getTypeName<ConcreteType>());
288 #endif
289 
290  return type.getAbstractType().getInterface<ConcreteType>();
291  }
292 
293  /// Allow access to 'getInterfaceFor'.
295 };
296 
297 //===----------------------------------------------------------------------===//
298 // Core TypeTrait
299 //===----------------------------------------------------------------------===//
300 
301 /// This trait is used to determine if a type is mutable or not. It is attached
302 /// on a type if the corresponding ImplType defines a `mutate` function with
303 /// a proper signature.
304 namespace TypeTrait {
305 template <typename ConcreteType>
307 } // namespace TypeTrait
308 
309 //===----------------------------------------------------------------------===//
310 // Type Utils
311 //===----------------------------------------------------------------------===//
312 
313 // Make Type hashable.
314 inline ::llvm::hash_code hash_value(Type arg) {
316 }
317 
318 template <typename... Tys>
319 bool Type::isa() const {
320  return llvm::isa<Tys...>(*this);
321 }
322 
323 template <typename... Tys>
324 bool Type::isa_and_nonnull() const {
325  return llvm::isa_and_present<Tys...>(*this);
326 }
327 
328 template <typename U>
329 U Type::dyn_cast() const {
330  return llvm::dyn_cast<U>(*this);
331 }
332 
333 template <typename U>
335  return llvm::dyn_cast_or_null<U>(*this);
336 }
337 
338 template <typename U>
339 U Type::cast() const {
340  return llvm::cast<U>(*this);
341 }
342 
343 } // namespace mlir
344 
345 namespace llvm {
346 
347 // Type hash just like pointers.
348 template <>
349 struct DenseMapInfo<mlir::Type> {
351  auto *pointer = llvm::DenseMapInfo<void *>::getEmptyKey();
352  return mlir::Type(static_cast<mlir::Type::ImplType *>(pointer));
353  }
356  return mlir::Type(static_cast<mlir::Type::ImplType *>(pointer));
357  }
358  static unsigned getHashValue(mlir::Type val) { return mlir::hash_value(val); }
359  static bool isEqual(mlir::Type LHS, mlir::Type RHS) { return LHS == RHS; }
360 };
361 template <typename T>
362 struct DenseMapInfo<T, std::enable_if_t<std::is_base_of<mlir::Type, T>::value &&
363  !mlir::detail::IsInterface<T>::value>>
364  : public DenseMapInfo<mlir::Type> {
365  static T getEmptyKey() {
366  const void *pointer = llvm::DenseMapInfo<const void *>::getEmptyKey();
367  return T::getFromOpaquePointer(pointer);
368  }
369  static T getTombstoneKey() {
371  return T::getFromOpaquePointer(pointer);
372  }
373 };
374 
375 /// We align TypeStorage by 8, so allow LLVM to steal the low bits.
376 template <>
377 struct PointerLikeTypeTraits<mlir::Type> {
378 public:
379  static inline void *getAsVoidPointer(mlir::Type I) {
380  return const_cast<void *>(I.getAsOpaquePointer());
381  }
382  static inline mlir::Type getFromVoidPointer(void *P) {
384  }
385  static constexpr int NumLowBitsAvailable = 3;
386 };
387 
388 /// Add support for llvm style casts.
389 /// We provide a cast between To and From if From is mlir::Type or derives from
390 /// it
391 template <typename To, typename From>
392 struct CastInfo<
393  To, From,
394  std::enable_if_t<std::is_same_v<mlir::Type, std::remove_const_t<From>> ||
395  std::is_base_of_v<mlir::Type, From>>>
397  DefaultDoCastIfPossible<To, From, CastInfo<To, From>> {
398  /// Arguments are taken as mlir::Type here and not as `From`, because when
399  /// casting from an intermediate type of the hierarchy to one of its children,
400  /// the val.getTypeID() inside T::classof will use the static getTypeID of the
401  /// parent instead of the non-static Type::getTypeID that returns the dynamic
402  /// ID. This means that T::classof would end up comparing the static TypeID of
403  /// the children to the static TypeID of its parent, making it impossible to
404  /// downcast from the parent to the child.
405  static inline bool isPossible(mlir::Type ty) {
406  /// Return a constant true instead of a dynamic true when casting to self or
407  /// up the hierarchy.
408  if constexpr (std::is_base_of_v<To, From>) {
409  return true;
410  } else {
411  return To::classof(ty);
412  };
413  }
414  static inline To doCast(mlir::Type ty) { return To(ty.getImpl()); }
415 };
416 
417 } // namespace llvm
418 
419 #endif // MLIR_IR_TYPES_H
This class contains all of the static information common to all instances of a registered Type.
Definition: TypeSupport.h:30
Type replaceImmediateSubElements(Type type, ArrayRef< Attribute > replAttrs, ArrayRef< Type > replTypes) const
Replace the immediate sub-elements of the given type.
Definition: Types.cpp:25
void walkImmediateSubElements(Type type, function_ref< void(Attribute)> walkAttrsFn, function_ref< void(Type)> walkTypesFn) const
Walk the immediate sub-elements of the given type.
Definition: Types.cpp:19
T::Concept * getInterface() const
Returns an instance of the concept object for the given interface if it was registered to this type,...
Definition: TypeSupport.h:79
bool hasTrait() const
Returns true if the type has a particular trait.
Definition: TypeSupport.h:90
This class provides management for the lifetime of the state used when printing the IR.
Definition: AsmState.h:533
Attribute replace(Attribute attr)
Replace the given attribute/type, and recursively replace any sub elements.
void addReplacement(ReplaceFn< Attribute > fn)
Register a replacement function for mapping a given attribute or type.
void addWalk(WalkFn< Attribute > &&fn)
Register a walk function for a given attribute or type.
WalkResult walk(T element)
Walk the given attribute/type, and recursively walk any sub elements.
Attributes are known-constant values of operations.
Definition: Attributes.h:25
Dialects are groups of MLIR operations, types and attributes, as well as behavior associated with the...
Definition: Dialect.h:41
MLIRContext is the top-level object for a collection of MLIR operations.
Definition: MLIRContext.h:60
This class provides an efficient unique identifier for a specific C++ type.
Definition: TypeID.h:104
This class represents the base of a type interface.
Definition: Types.h:272
static InterfaceBase::Concept * getInterfaceFor(Type type)
Returns the impl interface instance for the given type.
Definition: Types.h:281
friend InterfaceBase
Allow access to 'getInterfaceFor'.
Definition: Types.h:294
Base storage class appearing in a Type.
Definition: TypeSupport.h:166
Instances of the Type class are uniqued, have an immutable identifier and an optional mutable compone...
Definition: Types.h:74
void print(raw_ostream &os) const
Print the current type.
bool isF64() const
Definition: Types.cpp:52
const void * getAsOpaquePointer() const
Methods for supporting PointerLikeTypeTraits.
Definition: Types.h:176
bool isTF32() const
Definition: Types.cpp:50
U cast() const
Definition: Types.h:339
bool isInteger(unsigned width) const
Return true if this is an integer type with the specified width.
Definition: Types.cpp:59
Dialect & getDialect() const
Get the dialect this type is registered to.
Definition: Types.h:118
auto replaceImmediateSubElements(ArrayRef< Attribute > replAttrs, ArrayRef< Type > replTypes) const
Replace the immediately nested sub-attributes and sub-types with those provided.
Definition: Types.h:217
Type(const Type &other)=default
bool isSignlessIntOrIndex() const
Return true if this is a signless integer or index type.
Definition: Types.cpp:101
U dyn_cast_or_null() const
Definition: Types.h:334
MLIRContext * getContext() const
Return the MLIRContext in which this type was uniqued.
Definition: Types.cpp:35
bool isa_and_nonnull() const
Definition: Types.h:324
bool isSignedInteger() const
Return true if this is a signed integer type (with the specified width).
Definition: Types.cpp:77
bool isFloat8E4M3FN() const
Definition: Types.cpp:38
bool isSignlessInteger() const
Return true if this is a signless integer type (with the specified width).
Definition: Types.cpp:65
ImplType * impl
Definition: Types.h:246
friend ::llvm::hash_code hash_value(Type arg)
Definition: Types.h:314
static Type getFromOpaquePointer(const void *pointer)
Definition: Types.h:179
bool isIndex() const
Definition: Types.cpp:56
bool hasTrait()
Returns true if the type was registered with a particular trait.
Definition: Types.h:194
constexpr Type()=default
bool isIntOrIndexOrFloat() const
Return true if this is an integer (of any signedness), index, or float type.
Definition: Types.cpp:121
U dyn_cast() const
Definition: Types.h:329
bool isF32() const
Definition: Types.cpp:51
void walkImmediateSubElements(function_ref< void(Attribute)> walkAttrsFn, function_ref< void(Type)> walkTypesFn) const
Walk all of the immediately nested sub-attributes and sub-types.
Definition: Types.h:206
bool hasPromiseOrImplementsInterface()
Returns true if InterfaceT has been promised by the dialect or implemented.
Definition: Types.h:186
bool isFloat8E4M3FNUZ() const
Definition: Types.cpp:42
bool isUnsignedInteger() const
Return true if this is an unsigned integer type (with the specified width).
Definition: Types.cpp:89
const AbstractTy & getAbstractType() const
Return the abstract type descriptor for this type.
Definition: Types.h:199
bool isIntOrIndex() const
Return true if this is an integer (of any signedness) or an index type.
Definition: Types.cpp:113
bool isFloat8E4M3B11FNUZ() const
Definition: Types.cpp:45
Type & operator=(const Type &other)=default
ImplType * getImpl() const
Return the Type implementation.
Definition: Types.h:202
bool isIntOrFloat() const
Return true if this is an integer (of any signedness) or a float type.
Definition: Types.cpp:117
Type(const ImplType *impl)
Definition: Types.h:87
bool isFloat8E5M2() const
Definition: Types.cpp:37
bool operator!() const
Definition: Types.h:97
bool operator==(Type other) const
Definition: Types.h:93
bool isF128() const
Definition: Types.cpp:54
TypeID getTypeID()
Return a unique identifier for the concrete type.
Definition: Types.h:112
void dump() const
bool operator!=(Type other) const
Definition: Types.h:94
bool isF16() const
Definition: Types.cpp:49
bool isF80() const
Definition: Types.cpp:53
bool isa() const
Definition: Types.h:319
auto replace(ReplacementFns &&...replacementFns)
Recursively replace all of the nested sub-attributes and sub-types using the provided map functions.
Definition: Types.h:238
auto walk(WalkFns &&...walkFns)
Walk this type and all attibutes/types nested within using the provided walk functions.
Definition: Types.h:227
bool isSignlessIntOrFloat() const
Return true of this is a signless integer or a float type.
Definition: Types.cpp:109
unsigned getIntOrFloatBitWidth() const
Return the bit width of an integer or a float type, assert failure on other types.
Definition: Types.cpp:123
bool isBF16() const
Definition: Types.cpp:48
bool isFloat8E5M2FNUZ() const
Definition: Types.cpp:39
bool isSignlessIntOrIndexOrFloat() const
Return true if this is a signless integer, index, or float type.
Definition: Types.cpp:105
This class represents an abstract interface.
Interface< ConcreteType, Type, Traits, Type, TypeTrait::TraitBase > InterfaceBase
Utility class for implementing users of storage classes uniqued by a StorageUniquer.
Helper class for implementing traits for storage classes.
Include the generated interface declarations.
Definition: CallGraph.h:229
bool hasPromisedInterface(Dialect &dialect, TypeID interfaceRequestorID, TypeID interfaceID)
Checks if a promise has been made for the interface/requestor pair.
Definition: Dialect.cpp:166
void handleUseOfUndefinedPromisedInterface(Dialect &dialect, TypeID interfaceRequestorID, TypeID interfaceID, StringRef interfaceName)
Checks if the given interface, which is attempting to be used, is a promised interface of this dialec...
Definition: Dialect.cpp:153
Include the generated interface declarations.
WalkOrder
Traversal order for region, block and operation walk utilities.
Definition: Visitors.h:63
inline ::llvm::hash_code hash_value(AffineExpr arg)
Make AffineExpr hashable.
Definition: AffineExpr.h:246
raw_ostream & operator<<(raw_ostream &os, const AliasResult &result)
Definition: AliasAnalysis.h:78
static bool isPossible(mlir::Type ty)
Arguments are taken as mlir::Type here and not as From, because when casting from an intermediate typ...
Definition: Types.h:405
static mlir::Type getEmptyKey()
Definition: Types.h:350
static unsigned getHashValue(mlir::Type val)
Definition: Types.h:358
static mlir::Type getTombstoneKey()
Definition: Types.h:354
static bool isEqual(mlir::Type LHS, mlir::Type RHS)
Definition: Types.h:359
static void * getAsVoidPointer(mlir::Type I)
Definition: Types.h:379
static mlir::Type getFromVoidPointer(void *P)
Definition: Types.h:382
This trait is used to determine if a storage user, like Type, is mutable or not.
A utility class to get, or create, unique instances of types within an MLIRContext.
Definition: TypeSupport.h:210