Halide  17.0.2
Halide compiler and libraries
IRPrinter.h
Go to the documentation of this file.
1 #ifndef HALIDE_IR_PRINTER_H
2 #define HALIDE_IR_PRINTER_H
3 
4 /** \file
5  * This header file defines operators that let you dump a Halide
6  * expression, statement, or type directly into an output stream
7  * in a human readable form.
8  * E.g:
9  \code
10  Expr foo = ...
11  std::cout << "Foo is " << foo << "\n";
12  \endcode
13  *
14  * These operators are implemented using \ref Halide::Internal::IRPrinter
15  */
16 
17 #include <ostream>
18 
19 #include "IRVisitor.h"
20 #include "Module.h"
21 #include "Scope.h"
22 
23 namespace Halide {
24 
25 /** Emit an expression on an output stream (such as std::cout) in
26  * human-readable form */
27 std::ostream &operator<<(std::ostream &stream, const Expr &);
28 
29 /** Emit a halide type on an output stream (such as std::cout) in
30  * human-readable form */
31 std::ostream &operator<<(std::ostream &stream, const Type &);
32 
33 /** Emit a halide Module on an output stream (such as std::cout) in
34  * human-readable form */
35 std::ostream &operator<<(std::ostream &stream, const Module &);
36 
37 /** Emit a halide device api type in human-readable form */
38 std::ostream &operator<<(std::ostream &stream, const DeviceAPI &);
39 
40 /** Emit a halide memory type in human-readable form */
41 std::ostream &operator<<(std::ostream &stream, const MemoryType &);
42 
43 /** Emit a halide tail strategy in human-readable form */
44 std::ostream &operator<<(std::ostream &stream, const TailStrategy &);
45 
46 /** Emit a halide loop partitioning policy in human-readable form */
47 std::ostream &operator<<(std::ostream &stream, const Partition &);
48 
49 /** Emit a halide LoopLevel in human-readable form */
50 std::ostream &operator<<(std::ostream &stream, const LoopLevel &);
51 
52 struct Target;
53 /** Emit a halide Target in a human readable form */
54 std::ostream &operator<<(std::ostream &stream, const Target &);
55 
56 namespace Internal {
57 
58 struct AssociativePattern;
59 struct AssociativeOp;
60 class Closure;
61 
62 /** Emit a halide associative pattern on an output stream (such as std::cout)
63  * in a human-readable form */
64 std::ostream &operator<<(std::ostream &stream, const AssociativePattern &);
65 
66 /** Emit a halide associative op on an output stream (such as std::cout) in a
67  * human-readable form */
68 std::ostream &operator<<(std::ostream &stream, const AssociativeOp &);
69 
70 /** Emit a halide statement on an output stream (such as std::cout) in
71  * a human-readable form */
72 std::ostream &operator<<(std::ostream &stream, const Stmt &);
73 
74 /** Emit a halide for loop type (vectorized, serial, etc) in a human
75  * readable form */
76 std::ostream &operator<<(std::ostream &stream, const ForType &);
77 
78 /** Emit a horizontal vector reduction op in human-readable form. */
79 std::ostream &operator<<(std::ostream &stream, const VectorReduce::Operator &);
80 
81 /** Emit a halide name mangling value in a human readable format */
82 std::ostream &operator<<(std::ostream &stream, const NameMangling &);
83 
84 /** Emit a halide LoweredFunc in a human readable format */
85 std::ostream &operator<<(std::ostream &stream, const LoweredFunc &);
86 
87 /** Emit a halide linkage value in a human readable format */
88 std::ostream &operator<<(std::ostream &stream, const LinkageType &);
89 
90 /** Emit a halide dimension type in human-readable format */
91 std::ostream &operator<<(std::ostream &stream, const DimType &);
92 
93 /** Emit a Closure in human-readable format */
94 std::ostream &operator<<(std::ostream &out, const Closure &c);
95 
96 struct Indentation {
97  int indent;
98 };
99 std::ostream &operator<<(std::ostream &stream, const Indentation &);
100 
101 /** An IRVisitor that emits IR to the given output stream in a human
102  * readable form. Can be subclassed if you want to modify the way in
103  * which it prints.
104  */
105 class IRPrinter : public IRVisitor {
106 public:
107  /** Construct an IRPrinter pointed at a given output stream
108  * (e.g. std::cout, or a std::ofstream) */
109  explicit IRPrinter(std::ostream &);
110 
111  /** emit an expression on the output stream */
112  void print(const Expr &);
113 
114  /** Emit an expression on the output stream without enclosing parens */
115  void print_no_parens(const Expr &);
116 
117  /** emit a statement on the output stream */
118  void print(const Stmt &);
119 
120  /** emit a comma delimited list of exprs, without any leading or
121  * trailing punctuation. */
122  void print_list(const std::vector<Expr> &exprs);
123 
124  static void test();
125 
126 protected:
128  return Indentation{indent};
129  }
130 
131  /** The stream on which we're outputting */
132  std::ostream &stream;
133 
134  /** The current indentation level, useful for pretty-printing
135  * statements */
136  int indent = 0;
137 
138  /** Certain expressions do not need parens around them, e.g. the
139  * args to a call are already separated by commas and a
140  * surrounding set of parens. */
141  bool implicit_parens = false;
142 
143  /** Either emits "(" or "", depending on the value of implicit_parens */
144  void open();
145 
146  /** Either emits ")" or "", depending on the value of implicit_parens */
147  void close();
148 
149  /** The symbols whose types can be inferred from values printed
150  * already. */
152 
153  /** A helper for printing a chain of lets with line breaks */
154  void print_lets(const Let *let);
155 
156  void visit(const IntImm *) override;
157  void visit(const UIntImm *) override;
158  void visit(const FloatImm *) override;
159  void visit(const StringImm *) override;
160  void visit(const Cast *) override;
161  void visit(const Reinterpret *) override;
162  void visit(const Variable *) override;
163  void visit(const Add *) override;
164  void visit(const Sub *) override;
165  void visit(const Mul *) override;
166  void visit(const Div *) override;
167  void visit(const Mod *) override;
168  void visit(const Min *) override;
169  void visit(const Max *) override;
170  void visit(const EQ *) override;
171  void visit(const NE *) override;
172  void visit(const LT *) override;
173  void visit(const LE *) override;
174  void visit(const GT *) override;
175  void visit(const GE *) override;
176  void visit(const And *) override;
177  void visit(const Or *) override;
178  void visit(const Not *) override;
179  void visit(const Select *) override;
180  void visit(const Load *) override;
181  void visit(const Ramp *) override;
182  void visit(const Broadcast *) override;
183  void visit(const Call *) override;
184  void visit(const Let *) override;
185  void visit(const LetStmt *) override;
186  void visit(const AssertStmt *) override;
187  void visit(const ProducerConsumer *) override;
188  void visit(const For *) override;
189  void visit(const Acquire *) override;
190  void visit(const Store *) override;
191  void visit(const Provide *) override;
192  void visit(const Allocate *) override;
193  void visit(const Free *) override;
194  void visit(const Realize *) override;
195  void visit(const Block *) override;
196  void visit(const Fork *) override;
197  void visit(const IfThenElse *) override;
198  void visit(const Evaluate *) override;
199  void visit(const Shuffle *) override;
200  void visit(const VectorReduce *) override;
201  void visit(const Prefetch *) override;
202  void visit(const Atomic *) override;
203  void visit(const HoistedStorage *) override;
204 };
205 
206 } // namespace Internal
207 } // namespace Halide
208 
209 #endif
Unsigned integer constants.
Definition: Expr.h:227
bool implicit_parens
Certain expressions do not need parens around them, e.g.
Definition: IRPrinter.h:141
The actual IR nodes begin here.
Definition: IR.h:30
A named variable.
Definition: IR.h:758
A base class for algorithms that need to recursively walk over the IR.
Definition: IRVisitor.h:19
A fragment of Halide syntax.
Definition: Expr.h:258
void print_no_parens(const Expr &)
Emit an expression on the output stream without enclosing parens.
Integer constants.
Definition: Expr.h:218
Is the first expression greater than the second.
Definition: IR.h:157
A reference-counted handle to a statement node.
Definition: Expr.h:419
Load a value from a named symbol if predicate is true.
Definition: IR.h:217
The difference of two expressions.
Definition: IR.h:65
A vector with &#39;lanes&#39; elements, in which every element is &#39;value&#39;.
Definition: IR.h:259
Partition
Different ways to handle loops with a potentially optimizable boundary conditions.
Logical and - are both expressions true.
Definition: IR.h:175
Defines Module, an IR container that fully describes a Halide program.
TailStrategy
Different ways to handle a tail case in a split when the factor does not provably divide the extent...
Definition: Schedule.h:33
Logical not - true if the expression false.
Definition: IR.h:193
Horizontally reduce a vector to a scalar or narrower vector using the given commutative and associati...
Definition: IR.h:966
Is the first expression less than the second.
Definition: IR.h:139
std::ostream & operator<<(std::ostream &stream, const Stmt &)
Emit a halide statement on an output stream (such as std::cout) in a human-readable form...
The product of two expressions.
Definition: IR.h:74
Lock all the Store nodes in the body statement.
Definition: IR.h:948
Floating point constants.
Definition: Expr.h:236
A ternary operator.
Definition: IR.h:204
void print_lets(const Let *let)
A helper for printing a chain of lets with line breaks.
The sum of two expressions.
Definition: IR.h:56
A linear ramp vector node.
Definition: IR.h:247
An if-then-else block.
Definition: IR.h:466
Allocate a multi-dimensional buffer of the given type and size.
Definition: IR.h:427
This file defines the class FunctionDAG, which is our representation of a Halide pipeline, and contains methods to using Halide&#39;s bounds tools to query properties of it.
An IRVisitor that emits IR to the given output stream in a human readable form.
Definition: IRPrinter.h:105
DimType
Each Dim below has a dim_type, which tells you what transformations are legal on it.
Definition: Schedule.h:370
void close()
Either emits ")" or "", depending on the value of implicit_parens.
Store a &#39;value&#39; to the buffer called &#39;name&#39; at a given &#39;index&#39; if &#39;predicate&#39; is true.
Definition: IR.h:333
void print(const Expr &)
emit an expression on the output stream
void print_list(const std::vector< Expr > &exprs)
emit a comma delimited list of exprs, without any leading or trailing punctuation.
Allocate a scratch area called with the given name, type, and size.
Definition: IR.h:371
Is the first expression greater than or equal to the second.
Definition: IR.h:166
A for loop.
Definition: IR.h:805
int indent
The current indentation level, useful for pretty-printing statements.
Definition: IRPrinter.h:136
A common pattern when traversing Halide IR is that you need to keep track of stuff when you find a Le...
void visit(const IntImm *) override
This defines the value of a function at a multi-dimensional location.
Definition: IR.h:354
Represent a multi-dimensional region of a Func or an ImageParam that needs to be prefetched.
Definition: IR.h:910
The ratio of two expressions.
Definition: IR.h:83
IRPrinter(std::ostream &)
Construct an IRPrinter pointed at a given output stream (e.g.
A function call.
Definition: IR.h:490
void open()
Either emits "(" or "", depending on the value of implicit_parens.
Is the first expression less than or equal to the second.
Definition: IR.h:148
Is the first expression not equal to the second.
Definition: IR.h:130
If the &#39;condition&#39; is false, then evaluate and return the message, which should be a call to an error...
Definition: IR.h:294
LinkageType
Type of linkage a function in a lowered Halide module can have.
Definition: Module.h:52
Not visible externally, similar to &#39;static&#39; linkage in C.
Is the first expression equal to the second.
Definition: IR.h:121
Represents a location where storage will be hoisted to for a Func / Realize node with a given name...
Definition: IR.h:932
The greater of two values.
Definition: IR.h:112
A pair of statements executed concurrently.
Definition: IR.h:457
Defines the Scope class, which is used for keeping track of names in a scope while traversing IR...
ForType
An enum describing a type of loop traversal.
Definition: Expr.h:401
A let expression, like you might find in a functional language.
Definition: IR.h:271
Free the resources associated with the given buffer.
Definition: IR.h:413
Indentation get_indent() const
Definition: IRPrinter.h:127
NameMangling
An enum to specify calling convention for extern stages.
Definition: Function.h:25
std::ostream & operator<<(std::ostream &stream, const Expr &)
Emit an expression on an output stream (such as std::cout) in human-readable form.
A sequence of statements to be executed in-order.
Definition: IR.h:442
The lesser of two values.
Definition: IR.h:103
Scope known_type
The symbols whose types can be inferred from values printed already.
Definition: IRPrinter.h:151
The remainder of a / b.
Definition: IR.h:94
Reinterpret value as another type, without affecting any of the bits (on little-endian systems)...
Definition: IR.h:47
std::ostream & stream
The stream on which we&#39;re outputting.
Definition: IRPrinter.h:132
String constants.
Definition: Expr.h:245
The statement form of a let node.
Definition: IR.h:282
DeviceAPI
An enum describing a type of device API.
Definition: DeviceAPI.h:15
Logical or - is at least one of the expression true.
Definition: IR.h:184
This node is a helpful annotation to do with permissions.
Definition: IR.h:315
Evaluate and discard an expression, presumably because it has some side-effect.
Definition: IR.h:476
Defines the base class for things that recursively walk over the IR.
Construct a new vector by taking elements from another sequence of vectors.
Definition: IR.h:841
MemoryType
An enum describing different address spaces to be used with Func::store_in.
Definition: Expr.h:348