This is an archive of the discontinued LLVM Phabricator instance.

Differential D77956

[MLIR][NFC] add doc cross links from/to std.alloca
ClosedPublic

Authored by bondhugula on Apr 11 2020, 2:32 PM.

Details

Reviewers
rriddle
Commits
rG75ea9e4e40ca: [MLIR][NFC] add doc cross links from/to std.alloca
Summary

Add doc cross links between std.alloca and AutomaticAllocationScope.

Diff Detail

Event Timeline

bondhugula created this revision.Apr 11 2020, 2:32 PM
Herald added a project: Restricted Project. · View Herald TranscriptApr 11 2020, 2:32 PM
Herald added subscribers: llvm-commits, frgossen, grosul1 and 12 others. · View Herald Transcript
rriddle accepted this revision.Apr 11 2020, 3:00 PM
rriddle added inline comments.
mlir/include/mlir/Dialect/StandardOps/IR/Ops.td
330

Please wrap this at 80 characters.

This revision is now accepted and ready to land.Apr 11 2020, 3:00 PM
bondhugula updated this revision to Diff 256804.Apr 11 2020, 3:02 PM
bondhugula marked an inline comment as done.

Line wrap.

Closed by commit rG75ea9e4e40ca: [MLIR][NFC] add doc cross links from/to std.alloca (authored by bondhugula). · Explain WhyApr 11 2020, 3:28 PM
This revision was automatically updated to reflect the committed changes.
Harbormaster failed remote builds in B52819: Diff 256804!Apr 11 2020, 4:00 PM
Harbormaster completed remote builds in B52816: Diff 256802.

Revision Contents

PathSize
mlir/
docs/
5 lines
include/
mlir/
Dialect/
StandardOps/
IR/
7 lines

Diff 256805

mlir/docs/Traits.md

Show First 20 Lines • Show All 136 Lines • ▼ Show 20 Lines
### AutomaticAllocationScope ### AutomaticAllocationScope
* `OpTrait::AutomaticAllocationScope` -- `AutomaticAllocationScope` * `OpTrait::AutomaticAllocationScope` -- `AutomaticAllocationScope`
This trait is carried by region holding operations that define a new scope for This trait is carried by region holding operations that define a new scope for
automatic allocation. Such allocations are automatically freed when control is automatic allocation. Such allocations are automatically freed when control is
transferred back from the regions of such operations. As an example, allocations transferred back from the regions of such operations. As an example, allocations
performed by std.alloca are automatically freed when control leaves the region performed by [`std.alloca`](Dialects/Standard.md#stdalloca-allocaop) are
of its closest surrounding op that has the trait AutomaticAllocationScope. automatically freed when control leaves the region of its closest surrounding op
that has the trait AutomaticAllocationScope.
### Broadcastable ### Broadcastable
* `OpTrait::ResultsBroadcastableShape` -- `ResultsBroadcastableShape` * `OpTrait::ResultsBroadcastableShape` -- `ResultsBroadcastableShape`
This trait adds the property that the operation is known to have This trait adds the property that the operation is known to have
[broadcast-compatible](https://docs.scipy.org/doc/numpy/user/basics.broadcasting.html) [broadcast-compatible](https://docs.scipy.org/doc/numpy/user/basics.broadcasting.html)
operands and its result types' shape is the broadcast compatible with the shape operands and its result types' shape is the broadcast compatible with the shape
▲ Show 20 Lines • Show All 94 Lines • Show Last 20 Lines

mlir/include/mlir/Dialect/StandardOps/IR/Ops.td

Show First 20 Lines • Show All 321 Lines • ▼ Show 20 Lines
// AllocaOp // AllocaOp
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
def AllocaOp : AllocLikeOp<"alloca"> { def AllocaOp : AllocLikeOp<"alloca"> {
let summary = "stack memory allocation operation"; let summary = "stack memory allocation operation";
let description = [{ let description = [{
The `alloca` operation allocates memory on the stack, to be automatically The `alloca` operation allocates memory on the stack, to be automatically
released when control transfers back from the region of its closest released when control transfers back from the region of its closest
surrounding operation with a AutomaticAllocationScope trait. The amount of surrounding operation with an
rriddleUnsubmitted
Done
ReplyInline Actions

Please wrap this at 80 characters.

rriddle: Please wrap this at 80 characters.
memory allocated is specified by its memref and additional operands. For [`AutomaticAllocationScope`](../Traits.md#automaticallocationscope) trait.
example: The amount of memory allocated is specified by its memref and additional
operands. For example:
```mlir ```mlir
%0 = alloca() : memref<8x64xf32> %0 = alloca() : memref<8x64xf32>
``` ```
The optional list of dimension operands are bound to the dynamic dimensions The optional list of dimension operands are bound to the dynamic dimensions
specified in its memref type. In the example below, the SSA value '%d' is specified in its memref type. In the example below, the SSA value '%d' is
bound to the second dimension of the memref (which is dynamic). bound to the second dimension of the memref (which is dynamic).
▲ Show 20 Lines • Show All 2,504 Lines • Show Last 20 Lines