1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
/* Copyright 2017 The TensorFlow Authors. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==============================================================================*/
#include "tensorflow/compiler/xla/service/tuple_simplifier.h"
#include <memory>
#include <utility>
#include "tensorflow/compiler/xla/literal.h"
#include "tensorflow/compiler/xla/service/hlo_computation.h"
#include "tensorflow/compiler/xla/service/hlo_instruction.h"
#include "tensorflow/compiler/xla/service/hlo_matchers.h"
#include "tensorflow/compiler/xla/service/hlo_opcode.h"
#include "tensorflow/compiler/xla/shape_util.h"
#include "tensorflow/compiler/xla/test.h"
#include "tensorflow/compiler/xla/tests/hlo_test_base.h"
#include "tensorflow/compiler/xla/types.h"
#include "tensorflow/core/lib/core/status_test_util.h"
namespace op = xla::testing::opcode_matchers;
namespace xla {
namespace {
class TupleSimplifierTest : public HloTestBase {
protected:
void Run(HloModule* module, bool change_expected) {
TupleSimplifier simplifier;
auto changed_status = simplifier.Run(module);
TF_ASSERT_OK(changed_status.status());
EXPECT_EQ(change_expected, changed_status.ValueOrDie());
}
void Run(HloModule* module, bool change_expected, bool exclude_entry) {
TupleSimplifier simplifier(exclude_entry);
auto changed_status = simplifier.Run(module);
TF_ASSERT_OK(changed_status.status());
EXPECT_EQ(change_expected, changed_status.ValueOrDie());
}
const Shape scalar_shape_ = ShapeUtil::MakeShape(F32, {});
const Shape tuple_shape_ = ShapeUtil::MakeTupleShape(
{ShapeUtil::MakeShape(F32, {}), ShapeUtil::MakeShape(F32, {}),
ShapeUtil::MakeShape(F32, {})});
};
TEST_F(TupleSimplifierTest, TupleOfParameters) {
// A Tuple constructed of a bunch of parameters should not be changed.
HloComputation::Builder builder(TestName());
HloInstruction* param0 = builder.AddInstruction(
HloInstruction::CreateParameter(0, scalar_shape_, "param0"));
HloInstruction* param1 = builder.AddInstruction(
HloInstruction::CreateParameter(1, scalar_shape_, "param1"));
HloInstruction* param2 = builder.AddInstruction(
HloInstruction::CreateParameter(2, scalar_shape_, "param2"));
builder.AddInstruction(HloInstruction::CreateTuple({param0, param1, param2}));
auto module = CreateNewModule();
module->AddEntryComputation(builder.Build());
Run(module.get(), /*change_expected=*/false);
}
TEST_F(TupleSimplifierTest, GteOfTupleOfParameter) {
// A GTE of a tuple parameter should not be changed.
HloComputation::Builder builder(TestName());
HloInstruction* param = builder.AddInstruction(
HloInstruction::CreateParameter(0, tuple_shape_, "param"));
builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, param, 1));
auto module = CreateNewModule();
module->AddEntryComputation(builder.Build());
Run(module.get(), /*change_expected=*/false);
}
TEST_F(TupleSimplifierTest, GteOfTuple) {
// A GTE of a Tuple should be short-circuited.
HloComputation::Builder builder(TestName());
HloInstruction* param0 = builder.AddInstruction(
HloInstruction::CreateParameter(0, scalar_shape_, "param0"));
HloInstruction* param1 = builder.AddInstruction(
HloInstruction::CreateParameter(1, scalar_shape_, "param1"));
HloInstruction* param2 = builder.AddInstruction(
HloInstruction::CreateParameter(2, scalar_shape_, "param2"));
HloInstruction* tuple = builder.AddInstruction(
HloInstruction::CreateTuple({param0, param1, param2}));
HloInstruction* gte = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple, 1));
auto module = CreateNewModule();
auto computation = module->AddEntryComputation(builder.Build());
EXPECT_THAT(computation->root_instruction(), gte);
Run(module.get(), /*change_expected=*/true);
EXPECT_THAT(computation->root_instruction(), param1);
}
TEST_F(TupleSimplifierTest, GteOfTupleChain) {
// Verify a chain of GTE/Tuple instructions is collapsed.
HloComputation::Builder builder(TestName());
HloInstruction* param = builder.AddInstruction(
HloInstruction::CreateParameter(0, scalar_shape_, "param"));
const int kChainLength = 10;
HloInstruction* element = param;
for (int i = 0; i < kChainLength; ++i) {
HloInstruction* tuple = builder.AddInstruction(
HloInstruction::CreateTuple({element, element, element}));
element = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple, 1));
}
builder.AddInstruction(
HloInstruction::CreateUnary(scalar_shape_, HloOpcode::kNegate, element));
auto module = CreateNewModule();
auto computation = module->AddEntryComputation(builder.Build());
EXPECT_THAT(computation->root_instruction(),
op::Negate(op::GetTupleElement(op::Tuple())));
Run(module.get(), /*change_expected=*/true);
EXPECT_THAT(computation->root_instruction(), op::Negate(op::Parameter()));
}
TEST_F(TupleSimplifierTest, NestedGteOfTuples) {
// Verify a nesting of GTE/Tuple instructions is collapsed. Tuples are nested
// to some depth with a chain of Tuple instructions, then extracted with a
// chain of GTE instructions.
HloComputation::Builder builder(TestName());
HloInstruction* param = builder.AddInstruction(
HloInstruction::CreateParameter(0, scalar_shape_, "param"));
const int kNestingDepth = 5;
HloInstruction* nested_tuple = param;
for (int i = 0; i < kNestingDepth; ++i) {
nested_tuple = builder.AddInstruction(
HloInstruction::CreateTuple({nested_tuple, nested_tuple}));
}
HloInstruction* element = nested_tuple;
for (int i = 0; i < kNestingDepth; ++i) {
element = builder.AddInstruction(HloInstruction::CreateGetTupleElement(
ShapeUtil::GetTupleElementShape(element->shape(), 0), element, 0));
}
auto module = CreateNewModule();
auto computation = module->AddEntryComputation(builder.Build());
EXPECT_THAT(computation->root_instruction(), element);
Run(module.get(), /*change_expected=*/true);
EXPECT_THAT(computation->root_instruction(), param);
}
TEST_F(TupleSimplifierTest, TupleOfGteInstructions) {
// Verify that a tuple constructed of GTE instructions operating on the same
// tuple are collapsed.
HloComputation::Builder builder(TestName());
HloInstruction* tuple_param = builder.AddInstruction(
HloInstruction::CreateParameter(0, tuple_shape_, "param"));
HloInstruction* gte0 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple_param, 0));
HloInstruction* gte1 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple_param, 1));
HloInstruction* gte2 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple_param, 2));
HloInstruction* tuple =
builder.AddInstruction(HloInstruction::CreateTuple({gte0, gte1, gte2}));
auto module = CreateNewModule();
auto computation = module->AddEntryComputation(builder.Build());
EXPECT_THAT(computation->root_instruction(), tuple);
Run(module.get(), /*change_expected=*/true);
EXPECT_THAT(computation->root_instruction(), tuple_param);
}
TEST_F(TupleSimplifierTest, IncompatibleTuples) {
// Verify that a tuple->GTE->tuple construct is not simplified if the input
// and output tuple are not compatible shapes.
HloComputation::Builder builder(TestName());
HloInstruction* tuple_param = builder.AddInstruction(
HloInstruction::CreateParameter(0, tuple_shape_, "param"));
HloInstruction* gte0 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple_param, 0));
HloInstruction* gte1 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple_param, 1));
// Output tuple has only two elements. Parameter tuple has three elements so
// simplification is not possible.
HloInstruction* tuple =
builder.AddInstruction(HloInstruction::CreateTuple({gte0, gte1}));
auto module = CreateNewModule();
auto computation = module->AddEntryComputation(builder.Build());
EXPECT_THAT(computation->root_instruction(), tuple);
Run(module.get(), /*change_expected=*/false);
EXPECT_THAT(computation->root_instruction(), tuple);
}
TEST_F(TupleSimplifierTest, CanExcludeEntryComputation) {
// Verify that the root computation can be excluded
auto module = CreateNewModule();
HloInstruction* p0;
HloInstruction* p1;
HloComputation* c0;
HloComputation* c1;
HloComputation* entry;
{
HloComputation::Builder builder(TestName() + "_1");
p0 = builder.AddInstruction(
HloInstruction::CreateParameter(0, tuple_shape_, "param"));
HloInstruction* gte0 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, p0, 0));
HloInstruction* gte1 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, p0, 1));
HloInstruction* gte2 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, p0, 2));
builder.AddInstruction(HloInstruction::CreateTuple({gte0, gte1, gte2}));
c0 = module->AddEmbeddedComputation(builder.Build());
}
{
HloComputation::Builder builder(TestName() + "_2");
p1 = builder.AddInstruction(
HloInstruction::CreateParameter(0, tuple_shape_, "param"));
HloInstruction* gte0 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, p1, 0));
HloInstruction* gte1 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, p1, 1));
HloInstruction* gte2 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, p1, 2));
builder.AddInstruction(HloInstruction::CreateTuple({gte0, gte1, gte2}));
c1 = module->AddEmbeddedComputation(builder.Build());
}
{
HloComputation::Builder builder(TestName() + "_Entry");
HloInstruction* tuple_param = builder.AddInstruction(
HloInstruction::CreateParameter(0, tuple_shape_, "param"));
HloInstruction* call0 = builder.AddInstruction(
HloInstruction::CreateCall(tuple_shape_, {tuple_param}, c0));
HloInstruction* call1 = builder.AddInstruction(
HloInstruction::CreateCall(tuple_shape_, {tuple_param}, c1));
HloInstruction* gte0 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, call0, 0));
HloInstruction* gte1 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, call1, 1));
HloInstruction* tuple0 =
builder.AddInstruction(HloInstruction::CreateTuple({gte0, gte1}));
HloInstruction* gte2 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple0, 0));
HloInstruction* gte3 = builder.AddInstruction(
HloInstruction::CreateGetTupleElement(scalar_shape_, tuple0, 1));
builder.AddInstruction(HloInstruction::CreateTuple({gte2, gte3}));
entry = module->AddEntryComputation(builder.Build());
}
Run(module.get(), /*change_expected=*/true, /*exclude_entry=*/ true);
EXPECT_THAT(c0->root_instruction(), p0);
EXPECT_THAT(c1->root_instruction(), p1);
EXPECT_THAT(entry->instruction_count(), 9);
}
} // namespace
} // namespace xla
|
