Files
clang-p2996/mlir/docs/Dialects/Builtin.md
Tobias Gysi 728a8d5a81 [mlir] Add a builtin distinct attribute
A distinct attribute associates a referenced attribute with a unique
identifier. Every call to its create function allocates a new
distinct attribute instance. The address of the attribute instance
temporarily serves as its unique identifier. Similar to the names
of SSA values, the final unique identifiers are generated during
pretty printing.

Examples:
 #distinct = distinct[0]<42.0 : f32>
 #distinct1 = distinct[1]<42.0 : f32>
 #distinct2 = distinct[2]<array<i32: 10, 42>>

This mechanism is meant to generate attributes with a unique
identifier, which can be used to mark groups of operations
that share a common properties such as if they are aliasing.

The design of the distinct attribute ensures minimal memory
footprint per distinct attribute since it only contains a reference
to another attribute. All distinct attributes are stored outside of
the storage uniquer in a thread local store that is part of the
context. It uses one bump pointer allocator per thread to ensure
distinct attributes can be created in-parallel.

Reviewed By: rriddle, Dinistro, zero9178

Differential Revision: https://reviews.llvm.org/D153360
2023-07-11 07:33:16 +00:00

68 lines
2.1 KiB
Markdown

# Builtin Dialect
The builtin dialect contains a core set of Attributes, Operations, and Types
that have wide applicability across a very large number of domains and
abstractions. Many of the components of this dialect are also instrumental in
the implementation of the core IR. As such, this dialect is implicitly loaded in
every `MLIRContext`, and available directly to all users of MLIR.
Given the far-reaching nature of this dialect and the fact that MLIR is
extensible by design, any potential additions are heavily scrutinized.
[TOC]
## Attributes
[include "Dialects/BuiltinAttributes.md"]
## Location Attributes
A subset of the builtin attribute values correspond to
[source locations](../Diagnostics.md/#source-locations), that may be attached to
Operations.
[include "Dialects/BuiltinLocationAttributes.md"]
## DistinctAttribute
A DistinctAttribute associates an attribute with a unique identifier.
As a result, multiple DistinctAttribute instances may point to the same
attribute. Every call to the `create` function allocates a new
DistinctAttribute instance. The address of the attribute instance serves as a
temporary unique identifier. Similar to the names of SSA values, the final
unique identifiers are generated during pretty printing. This delayed
numbering ensures the printed identifiers are deterministic even if
multiple DistinctAttribute instances are created in-parallel.
Syntax:
```
distinct-id ::= integer-literal
distinct-attribute ::= `distinct` `[` distinct-id `]<` attribute `>`
```
Examples:
```mlir
#distinct = distinct[0]<42.0 : f32>
#distinct1 = distinct[1]<42.0 : f32>
#distinct2 = distinct[2]<array<i32: 10, 42>>
```
This mechanism is meant to generate attributes with a unique
identifier, which can be used to mark groups of operations that share a
common property. For example, groups of aliasing memory operations may be
marked using one DistinctAttribute instance per alias group.
## Operations
[include "Dialects/BuiltinOps.md"]
## Types
[include "Dialects/BuiltinTypes.md"]
## Type Interfaces
[include "Dialects/BuiltinTypeInterfaces.md"]