module.cpp 34.8 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015-2022 Advanced Micro Devices, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
24
#include <iterator>
Shucai Xiao's avatar
Shucai Xiao committed
25
26
27
28
29
30
31
32
#include <migraphx/module.hpp>
#include <migraphx/stringutils.hpp>
#include <migraphx/instruction.hpp>
#include <migraphx/target.hpp>
#include <migraphx/env.hpp>
#include <migraphx/ranges.hpp>
#include <migraphx/time.hpp>
#include <migraphx/iterator_for.hpp>
33
#include <migraphx/iterator.hpp>
Shucai Xiao's avatar
Shucai Xiao committed
34
35
36
#include <migraphx/pass_manager.hpp>
#include <migraphx/make_op.hpp>
#include <migraphx/register_target.hpp>
37
#include <migraphx/json.hpp>
Shucai Xiao's avatar
Shucai Xiao committed
38
39
40
41
42
43
44
45
46
47
#include <iostream>
#include <sstream>
#include <algorithm>
#include <set>
#include <utility>
#include <unordered_set>

namespace migraphx {
inline namespace MIGRAPHX_INLINE_NS {

Paul Fultz II's avatar
Paul Fultz II committed
48
49
MIGRAPHX_DECLARE_ENV_VAR(MIGRAPHX_TRACE_FINALIZE)

Shucai Xiao's avatar
Shucai Xiao committed
50
51
52
53
struct module_impl
{
    // A list is used to keep references to an instruction stable
    std::list<instruction> instructions;
54
    std::unordered_set<instruction*> instruction_set;
Paul Fultz II's avatar
Paul Fultz II committed
55
    std::string name;
Paul Fultz II's avatar
Paul Fultz II committed
56
    uint32_t nparams = 0;
57
    bool bypass      = false;
58
59
60

    bool contains(instruction_ref ins) const
    {
61
        if(is_end(ins, instructions.end()))
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
            return false;
        return instruction_set.count(std::addressof(*ins)) > 0;
    }

    template <class... Ts>
    instruction_ref emplace(instruction_ref pos, Ts&&... xs)
    {
        // cppcheck-suppress redundantInitialization
        auto r = instructions.emplace(pos, std::forward<Ts>(xs)...);
        instruction_set.insert(std::addressof(*r));
        return r;
    }
    instruction_ref insert(instruction_ref pos, const instruction& ins)
    {
        return emplace(pos, ins);
    }

79
80
81
82
83
84
85
    void clear()
    {
        instructions.clear();
        instruction_set.clear();
        nparams = 0;
    }

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
    void push_front(const instruction& ins) { insert(instructions.begin(), ins); }

    void push_back(const instruction& ins) { insert(instructions.end(), ins); }

    template <class... Ts>
    void emplace_front(Ts&&... xs)
    {
        emplace(instructions.begin(), std::forward<Ts>(xs)...);
    }

    template <class... Ts>
    void emplace_back(Ts&&... xs)
    {
        emplace(instructions.end(), std::forward<Ts>(xs)...);
    }

    instruction_ref erase(instruction_ref pos)
    {
        instruction_set.erase(std::addressof(*pos));
        return instructions.erase(pos);
    }

    instruction_ref erase(instruction_ref start, instruction_ref last)
    {
        std::for_each(start, last, [&](auto& ins) { instruction_set.erase(std::addressof(ins)); });
        return instructions.erase(start, last);
    }
Shucai Xiao's avatar
Shucai Xiao committed
113
114
115
116
};

const operation& get_operation(instruction_ref ins) { return ins->get_operator(); }

Paul Fultz II's avatar
Paul Fultz II committed
117
118
119
120
module::module(const std::string& name) : impl(std::make_unique<module_impl>())
{
    impl->name = name;
}
Shucai Xiao's avatar
Shucai Xiao committed
121
122
123
124
125
126
127
128
129
130
131
132
133
134

module::module(module&&) noexcept = default;
module::~module() noexcept        = default;

// copy constructor
module::module(const module& m) { assign(m); }

// copy assignment operator
module& module::operator=(module m)
{
    std::swap(m.impl, this->impl);
    return *this;
}

Paul Fultz II's avatar
Paul Fultz II committed
135
136
std::string module::name() const { return impl->name; }

137
138
139
bool module::bypass() const { return impl->bypass; }
void module::set_bypass(bool b) { impl->bypass = b; }

Shucai Xiao's avatar
Shucai Xiao committed
140
141
void module::assign(const module& m)
{
142
    // copy the impl
143
    if(not impl)
Shucai Xiao's avatar
Shucai Xiao committed
144
        impl = std::make_unique<module_impl>();
145
146
147
    *impl = *m.impl;

    // clear instructions
148
    if(not impl->instructions.empty())
Shucai Xiao's avatar
Shucai Xiao committed
149
    {
150
        impl->clear();
Shucai Xiao's avatar
Shucai Xiao committed
151
152
153
154
155
156
157
158
159
    }

    std::unordered_map<instruction_ref, instruction_ref> ins_map;
    for(auto ins : iterator_for(m))
    {
        instruction_ref copy_ins{};
        if(ins->name() == "@literal")
        {
            auto l   = ins->get_literal();
160
            copy_ins = impl->insert(impl->instructions.end(), instruction{l});
Shucai Xiao's avatar
Shucai Xiao committed
161
162
163
164
        }
        else if(ins->name() == "@param")
        {
            auto&& name = any_cast<builtin::param>(ins->get_operator()).parameter;
165
            auto order  = any_cast<builtin::param>(ins->get_operator()).order;
Shucai Xiao's avatar
Shucai Xiao committed
166
            auto s      = ins->get_shape();
167
168
            copy_ins    = impl->insert(impl->instructions.end(),
                                    {builtin::param{name, order}, std::move(s), {}});
Charlie Lin's avatar
Charlie Lin committed
169
            impl->nparams++;
Shucai Xiao's avatar
Shucai Xiao committed
170
171
172
        }
        else if(ins->name() == "@outline")
        {
173
174
            auto s   = ins->get_shape();
            copy_ins = impl->insert(impl->instructions.end(), {builtin::outline{s}, s, {}});
Shucai Xiao's avatar
Shucai Xiao committed
175
176
177
        }
        else
        {
Shucai Xiao's avatar
Shucai Xiao committed
178
179
            // if there are sub_module inputs, need to make a copy of the submodule
            auto module_args = ins->module_inputs();
Shucai Xiao's avatar
Shucai Xiao committed
180
181
182
183
            // retrieve its mapped input
            auto inputs = ins->inputs();
            std::vector<instruction_ref> copy_inputs(inputs.size());
            std::transform(inputs.begin(), inputs.end(), copy_inputs.begin(), [&](auto i) {
Shucai Xiao's avatar
Shucai Xiao committed
184
                return contains(ins_map, i) ? ins_map[i] : i;
Shucai Xiao's avatar
Shucai Xiao committed
185
186
187
188
189
190
191
            });
            if(ins->name() == "@return")
            {
                copy_ins = add_return(copy_inputs);
            }
            else
            {
Shucai Xiao's avatar
Shucai Xiao committed
192
                copy_ins = add_instruction(ins->get_operator(), copy_inputs, module_args);
Shucai Xiao's avatar
Shucai Xiao committed
193
194
195
196
197
198
199
            }
        }

        ins_map[ins] = copy_ins;
    }
}

Paul's avatar
Paul committed
200
template <class Range, class Inserter>
201
202
203
204
static std::vector<instruction_ref>
insert_generic_instructions(module& m,
                            instruction_ref ins,
                            Range&& instructions,
Paul's avatar
Paul committed
205
206
                            std::unordered_map<instruction_ref, instruction_ref> map_ins,
                            Inserter insert)
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
{
    assert(m.has_instruction(ins) or is_end(ins, m.end()));
    std::vector<instruction_ref> mod_outputs;
    instruction_ref last;
    for(instruction_ref sins : instructions)
    {
        last = sins;
        if(contains(map_ins, sins))
            continue;
        instruction_ref copy_ins;
        if(sins->name() == "@literal")
        {
            auto l   = sins->get_literal();
            copy_ins = m.add_literal(l);
        }
        else if(sins->name() == "@param")
        {
            auto&& name = any_cast<builtin::param>(sins->get_operator()).parameter;
            auto s      = sins->get_shape();
            copy_ins    = m.add_parameter(name, s);
        }
        else if(sins->name() == "@outline")
        {
            auto s   = sins->get_shape();
            copy_ins = m.add_outline(s);
        }
        else
        {
            auto mod_args = sins->module_inputs();
            auto inputs   = sins->inputs();
            std::vector<instruction_ref> copy_inputs(inputs.size());
            std::transform(inputs.begin(), inputs.end(), copy_inputs.begin(), [&](auto i) {
                return contains(map_ins, i) ? map_ins[i] : i;
            });

            if(sins->name() == "@return")
            {
                mod_outputs = copy_inputs;
                break;
            }

Paul's avatar
Paul committed
248
            copy_ins = insert(m, ins, sins->get_operator(), copy_inputs, mod_args);
249
250
251
252
253
254
255
256
        }
        map_ins[sins] = copy_ins;
    }
    if(mod_outputs.empty() and instructions.begin() != instructions.end())
        mod_outputs = {map_ins.at(last)};
    return mod_outputs;
}

Paul's avatar
Paul committed
257
258
259
260
261
262
263
static auto default_module_inserter()
{
    return [](module& m, auto&&... xs) {
        return m.insert_instruction(static_cast<decltype(xs)&&>(xs)...);
    };
}

Shucai Xiao's avatar
Shucai Xiao committed
264
265
266
267
268
269
270
271
instruction_ref module::add_instruction(const operation& op, std::vector<instruction_ref> args)
{
    return insert_instruction(impl->instructions.end(), op, std::move(args));
}
instruction_ref module::insert_instruction(instruction_ref ins,
                                           const operation& op,
                                           std::vector<instruction_ref> args)
{
272
    assert(has_instruction(ins) or is_end(ins, this->end()));
Shucai Xiao's avatar
Shucai Xiao committed
273
274
    assert(not starts_with(op.name(), "@"));
    shape r     = compute_shape(op, args);
275
    auto result = impl->insert(ins, {op, r, std::move(args)});
Shucai Xiao's avatar
Shucai Xiao committed
276
277
278
279
280
    instruction::backreference(result);
    assert(result->valid(begin()));
    return result;
}

Shucai Xiao's avatar
Shucai Xiao committed
281
282
283
284
285
286
287
288
289
290
291
292
293
instruction_ref module::add_instruction(const operation& op,
                                        std::vector<instruction_ref> args,
                                        std::vector<module_ref> module_args)
{
    return insert_instruction(
        impl->instructions.end(), op, std::move(args), std::move(module_args));
}

instruction_ref module::insert_instruction(instruction_ref ins,
                                           const operation& op,
                                           std::vector<instruction_ref> args,
                                           std::vector<module_ref> module_args)
{
294
    assert(has_instruction(ins) or is_end(ins, this->end()));
Shucai Xiao's avatar
Shucai Xiao committed
295
296
    assert(not starts_with(op.name(), "@"));
    auto out_shape = compute_shape(op, args, module_args);
297
    auto result    = impl->insert(ins, {op, out_shape, std::move(args), std::move(module_args)});
Shucai Xiao's avatar
Shucai Xiao committed
298
299
300
301
302
    instruction::backreference(result);
    assert(result->valid(begin()));
    return result;
}

Shucai Xiao's avatar
Shucai Xiao committed
303
304
305
306
instruction_ref module::replace_instruction(instruction_ref ins,
                                            const operation& op,
                                            std::vector<instruction_ref> args) MIGRAPHX_TIDY_CONST
{
307
    assert(has_instruction(ins));
Shucai Xiao's avatar
Shucai Xiao committed
308
309
310
311
312
313
314
315
    assert(not starts_with(op.name(), "@"));

    shape r = compute_shape(op, args);
    instruction::replace(ins, op, r, std::move(args));
    assert(ins->valid(begin()));
    return ins;
}

Shucai Xiao's avatar
Shucai Xiao committed
316
317
318
319
320
instruction_ref module::replace_instruction(instruction_ref ins,
                                            const operation& op,
                                            std::vector<instruction_ref> args,
                                            std::vector<module_ref> module_args) MIGRAPHX_TIDY_CONST
{
321
    assert(has_instruction(ins));
Shucai Xiao's avatar
Shucai Xiao committed
322
323
324
325
326
327
328
    assert(not starts_with(op.name(), "@"));
    auto out_shape = compute_shape(op, args, module_args);
    instruction::replace(ins, op, out_shape, std::move(args), std::move(module_args));
    assert(ins->valid(begin()));
    return ins;
}

Shucai Xiao's avatar
Shucai Xiao committed
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
instruction_ref module::replace_instruction(instruction_ref ins, instruction_ref rep)
{
    assert(has_instruction(ins));
    assert(has_instruction(rep));
    assert(ins != rep);

    if(ins == std::prev(this->end()))
    {
        return replace_instruction(ins, make_op("identity"), rep);
    }

    // TODO: Should it be an error if the output is empty?
    if(ins->outputs().empty())
    {
        return rep;
    }
    // Make a copy of outputs which can be changed when calling replace_argument
    auto outputs = ins->outputs();
    for(auto out : outputs)
    {
        // TODO: Check for possible cycles
        if(out != rep)
        {
            instruction::replace_argument(out, ins, rep);
        }
        assert(out->valid(begin()));
    }
    // Replacement should not be dead code unless its the last instruction
357
    assert(not rep->outputs().empty() or rep == std::prev(end()));
Shucai Xiao's avatar
Shucai Xiao committed
358
359
360
361
362
363
364
365
366
367
368
369
370
371
    // Output of the original instruction should only be the replacement or empty
    assert(ins->outputs().empty() or std::all_of(ins->outputs().begin(),
                                                 ins->outputs().end(),
                                                 [&](auto i) { return i == rep; }));
    assert(ins->valid(begin()));
    assert(rep->valid(begin()));
    return rep;
}

instruction_ref module::remove_instruction(instruction_ref ins)
{
    assert(has_instruction(ins));
    assert(ins->outputs().empty());
    ins->clear_arguments();
372
    return impl->erase(ins);
Shucai Xiao's avatar
Shucai Xiao committed
373
374
375
376
377
378
379
380
381
382
}

instruction_ref module::remove_instructions(instruction_ref first, instruction_ref last)
{
    if(first == last)
        return first;
    // TODO: Check every element
    assert(has_instruction(first));
    std::for_each(first, last, [&](instruction& ins) { ins.clear_arguments(); });
    assert(std::all_of(first, last, [&](const instruction& ins) { return ins.outputs().empty(); }));
383
    return impl->erase(first, last);
Shucai Xiao's avatar
Shucai Xiao committed
384
385
386
387
}

instruction_ref module::move_instruction(instruction_ref src, instruction_ref dst)
{
388
389
    assert(has_instruction(src));
    assert(has_instruction(dst) or is_end(dst, this->end()));
Shucai Xiao's avatar
Shucai Xiao committed
390
391
392
393
394
395
396
    impl->instructions.splice(dst, impl->instructions, src);
    return src;
}

instruction_ref module::move_instructions(instruction_ref src, instruction_ref dst)
{
    for(auto ins : src->inputs())
397
398
399
400
401
402
    {
        if(not contains(this->impl->instructions, ins))
            continue;
        this->move_instructions(ins, dst);
    }
    this->move_instruction(src, dst);
Shucai Xiao's avatar
Shucai Xiao committed
403
404
405
    return src;
}

406
407
408
std::vector<instruction_ref>
module::add_instructions(const std::vector<instruction_ref>& instructions,
                         std::unordered_map<instruction_ref, instruction_ref> map_ins)
409
{
410
411
    return this->insert_instructions(this->end(), instructions, std::move(map_ins));
}
412

413
std::vector<instruction_ref>
Paul Fultz II's avatar
Paul Fultz II committed
414
415
module::add_instructions(const_module_ref m,
                         std::unordered_map<instruction_ref, instruction_ref> map_ins)
416
417
418
{
    return this->insert_instructions(this->end(), m, std::move(map_ins));
}
419

420
421
422
423
424
425
426
427
428
429
430
431
432
std::vector<instruction_ref>
module::add_instructions(instruction_ref start,
                         instruction_ref last,
                         std::unordered_map<instruction_ref, instruction_ref> map_ins)
{
    return this->insert_instructions(this->end(), start, last, std::move(map_ins));
}

std::vector<instruction_ref>
module::insert_instructions(instruction_ref ins,
                            const std::vector<instruction_ref>& instructions,
                            std::unordered_map<instruction_ref, instruction_ref> map_ins)
{
Paul's avatar
Paul committed
433
434
435
436
437
438
439
440
441
    return insert_generic_instructions(*this, ins, instructions, std::move(map_ins), default_module_inserter());
}

std::vector<instruction_ref>
module::insert_instructions(module::inserter insert, instruction_ref ins,
                            const std::vector<instruction_ref>& instructions,
                            std::unordered_map<instruction_ref, instruction_ref> map_ins)
{
    return insert_generic_instructions(*this, ins, instructions, std::move(map_ins), insert);
442
443
}

Paul Fultz II's avatar
Paul Fultz II committed
444
445
446
447
std::vector<instruction_ref>
module::insert_instructions(instruction_ref ins,
                            const_module_ref m,
                            std::unordered_map<instruction_ref, instruction_ref> map_ins)
448
{
Paul's avatar
Paul committed
449
    return insert_generic_instructions(*this, ins, iterator_for(*m), std::move(map_ins), default_module_inserter());
450
451
452
453
454
455
456
457
458
}

std::vector<instruction_ref>
module::insert_instructions(instruction_ref ins,
                            instruction_ref start,
                            instruction_ref last,
                            std::unordered_map<instruction_ref, instruction_ref> map_ins)
{
    auto r = range(start, last);
Paul's avatar
Paul committed
459
    return insert_generic_instructions(*this, ins, iterator_for(r), std::move(map_ins), default_module_inserter());
460
461
}

Paul Fultz II's avatar
Paul Fultz II committed
462
instruction_ref module::add_literal(literal l) { return insert_literal(begin(), std::move(l)); }
Shucai Xiao's avatar
Shucai Xiao committed
463
464
465

instruction_ref module::add_outline(const shape& s)
{
466
    impl->push_front({builtin::outline{s}, s, {}});
Shucai Xiao's avatar
Shucai Xiao committed
467
468
469
470
471
    return impl->instructions.begin();
}

instruction_ref module::add_parameter(std::string name, shape s)
{
Paul Fultz II's avatar
Paul Fultz II committed
472
    return insert_parameter(begin(), std::move(name), std::move(s));
Shucai Xiao's avatar
Shucai Xiao committed
473
474
475
476
}

instruction_ref module::add_return(std::vector<instruction_ref> args)
{
477
    impl->push_back({builtin::returns{}, {}, std::move(args)});
Shucai Xiao's avatar
Shucai Xiao committed
478
479
480
481
482
483
484
    auto result = std::prev(impl->instructions.end());
    instruction::backreference(result);
    assert(result->valid(begin()));

    return result;
}

Paul Fultz II's avatar
Paul Fultz II committed
485
486
487
488
489
490
491
492
493
494
495
496
497
498
instruction_ref module::insert_literal(instruction_ref ins, literal l)
{
    impl->emplace(ins, std::move(l));
    return std::prev(ins);
}

instruction_ref module::insert_parameter(instruction_ref ins, std::string name, shape s)
{
    assert(get_parameter_shape(name) == shape{});
    impl->insert(ins, {builtin::param{std::move(name), impl->nparams}, std::move(s), {}});
    impl->nparams++;
    return std::prev(ins);
}

499
500
501
502
503
504
505
506
507
508
509
510
511
512
instruction_ref module::replace_return(std::vector<instruction_ref> args)
{
    auto last = std::prev(this->end());
    // If there is no return then add a return
    if(last->name() != "@return")
        return this->add_return(args);

    shape r = compute_shape(last->get_operator(), args);
    instruction::replace(last, last->get_operator(), r, std::move(args));
    assert(last->valid(begin()));

    return last;
}

Shucai Xiao's avatar
Shucai Xiao committed
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
shape module::get_parameter_shape(std::string name) const
{
    auto ins = std::find_if(
        impl->instructions.begin(), impl->instructions.end(), [&](const instruction& x) {
            if(x.name() == "@param")
            {
                return any_cast<builtin::param>(x.get_operator()).parameter == name;
            }
            else
            {
                return false;
            }
        });
    if(ins != this->end())
        return ins->get_shape();
    else
        return {};
}

std::vector<std::string> module::get_parameter_names() const
{
Paul Fultz II's avatar
Paul Fultz II committed
534
535
    std::vector<std::string> result;
    std::vector<builtin::param> params;
Shucai Xiao's avatar
Shucai Xiao committed
536
537
538
539
    for(auto&& ins : impl->instructions)
    {
        if(ins.name() == "@param")
        {
Paul Fultz II's avatar
Paul Fultz II committed
540
541
            auto&& param = any_cast<builtin::param>(ins.get_operator());
            params.push_back(param);
Shucai Xiao's avatar
Shucai Xiao committed
542
543
        }
    }
Paul Fultz II's avatar
Paul Fultz II committed
544
545
546
547
548
    std::stable_sort(
        params.begin(), params.end(), by(std::less<>{}, [](auto&& p) { return p.order; }));
    std::transform(params.begin(), params.end(), std::back_inserter(result), [&](auto&& p) {
        return p.parameter;
    });
Shucai Xiao's avatar
Shucai Xiao committed
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
    return result;
}

instruction_ref module::get_parameter(std::string name) const
{
    auto ins = std::find_if(
        impl->instructions.begin(), impl->instructions.end(), [&](const instruction& x) {
            if(x.name() == "@param")
            {
                return any_cast<builtin::param>(x.get_operator()).parameter == name;
            }
            else
            {
                return false;
            }
        });
    if(ins != this->end())
        return ins;
    else
        return this->end();
}

std::unordered_map<std::string, shape> module::get_parameter_shapes() const
{
    std::unordered_map<std::string, shape> result;
    for(auto&& ins : impl->instructions)
    {
        if(ins.name() == "@param")
        {
            auto&& name  = any_cast<builtin::param>(ins.get_operator()).parameter;
            result[name] = ins.get_shape();
        }
    }
    return result;
}

585
bool module::has_instruction(instruction_ref ins) const { return impl->contains(ins); }
Shucai Xiao's avatar
Shucai Xiao committed
586
587
588
589
590
591
592

std::size_t module::size() const { return impl->instructions.size(); }
instruction_ref module::begin() const { return impl->instructions.begin(); }
instruction_ref module::end() const { return impl->instructions.end(); }

std::vector<shape> module::get_output_shapes() const
{
593
594
    if(impl->instructions.empty())
        return {};
Shucai Xiao's avatar
Shucai Xiao committed
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
    auto last_ins = impl->instructions.back();
    if(last_ins.name() == "@return")
    {
        const auto& output_ins = last_ins.inputs();
        std::vector<shape> output_shapes;
        std::transform(output_ins.begin(),
                       output_ins.end(),
                       std::back_inserter(output_shapes),
                       [](auto& ins) { return ins->get_shape(); });

        return output_shapes;
    }
    // The else branch is to provide backward compatibility
    else
    {
        return {last_ins.get_shape()};
    }
}

Paul Fultz II's avatar
Paul Fultz II committed
614
615
616
617
618
619
620
621
std::vector<instruction_ref> module::get_returns() const
{
    auto last = std::prev(this->end());
    if(last->name() == "@return")
        return last->inputs();
    return {last};
}

Shucai Xiao's avatar
Shucai Xiao committed
622
623
instruction_ref module::validate() const
{
Shucai Xiao's avatar
Shucai Xiao committed
624
625
626
    return std::find_if(
        impl->instructions.begin(), impl->instructions.end(), [&](const instruction& i) {
            auto inputs      = i.inputs();
627
628
            bool check_order = std::all_of(
                inputs.begin(), inputs.end(), [&](auto in) { return has_instruction(in); });
629
            return not i.valid(impl->instructions.begin(), check_order);
Shucai Xiao's avatar
Shucai Xiao committed
630
        });
Shucai Xiao's avatar
Shucai Xiao committed
631
632
}

633
634
635
636
637
bool is_borrowed(instruction_ref ins)
{
    auto alias = instruction::get_output_alias(ins, true);
    if(alias == ins)
        return false;
638
639
    lifetime l = alias->get_operator().get_lifetime();
    if(l == lifetime::borrow)
640
641
642
643
        return true;
    return is_borrowed(alias);
}

644
bool is_global(instruction_ref ins)
645
{
646
647
    const auto& op = instruction::get_output_alias(ins)->get_operator();
    return op.name() == "@param" or op.get_lifetime() == lifetime::global;
648
649
}

650
bool is_dangling(instruction_ref ins) { return not is_global(ins) and is_borrowed(ins); }
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668

instruction_ref module::find_dangling_reference() const
{
    auto last = std::prev(end());
    if(last->name() == "@return")
    {
        auto dangling = std::find_if(
            last->inputs().begin(), last->inputs().end(), [](auto x) { return is_dangling(x); });
        if(dangling != last->inputs().end())
            return *dangling;
    }
    else if(is_dangling(last))
    {
        return last;
    }
    return end();
}

Shucai Xiao's avatar
Shucai Xiao committed
669
670
void module::finalize(context& ctx)
{
Paul Fultz II's avatar
Paul Fultz II committed
671
    const bool trace = enabled(MIGRAPHX_TRACE_FINALIZE{});
Shucai Xiao's avatar
Shucai Xiao committed
672
673
    for(auto ins : iterator_for(*this))
    {
Paul Fultz II's avatar
Paul Fultz II committed
674
675
676
677
678
        if(trace)
        {
            std::cout << "Finalize: ";
            this->debug_print(ins);
        }
Shucai Xiao's avatar
Shucai Xiao committed
679
        ins->finalize(ctx);
Shucai Xiao's avatar
Shucai Xiao committed
680
681
682
683
        for(const auto& smod : ins->module_inputs())
        {
            smod->finalize(ctx);
        }
Shucai Xiao's avatar
Shucai Xiao committed
684
    }
Shucai Xiao's avatar
Shucai Xiao committed
685

686
687
688
689
690
    // Warn when an instruction is not normalized
    auto ins = std::find_if(begin(), end(), [](auto& i) { return i.need_normalization(); });
    if(ins != end())
        std::cerr << "WARNING: Instruction needs normalization, performance may be affected."
                  << std::endl;
Shucai Xiao's avatar
Shucai Xiao committed
691
692
693
}

void module::debug_print() const { std::cout << *this << std::endl; }
Shucai Xiao's avatar
Shucai Xiao committed
694
695

void module::debug_print(instruction_ref ins,
Shucai Xiao's avatar
Shucai Xiao committed
696
                         std::unordered_map<instruction_ref, std::string>& names) const
Shucai Xiao's avatar
Shucai Xiao committed
697
{
698
    if(is_end(ins, this->end()))
Shucai Xiao's avatar
Shucai Xiao committed
699
700
701
702
703
704
705
706
707
708
    {
        std::cout << "End instruction" << std::endl;
        return;
    }
    if(not has_instruction(ins))
    {
        std::cout << "Instruction not part of module" << std::endl;
        return;
    }
    std::stringstream ss;
Shucai Xiao's avatar
Shucai Xiao committed
709
    names = this->print(
Shucai Xiao's avatar
Shucai Xiao committed
710
711
712
713
714
715
716
717
        [&](auto x, auto ins_names) {
            if(x == ins)
            {
                instruction::print(std::cout, x, ins_names);
                std::cout << std::endl;
            }
        },
        names);
Shucai Xiao's avatar
Shucai Xiao committed
718
}
Shucai Xiao's avatar
Shucai Xiao committed
719
720
721
722
723
724
725

void module::debug_print(instruction_ref ins) const
{
    std::unordered_map<instruction_ref, std::string> names;
    this->debug_print(ins, names);
}

Shucai Xiao's avatar
Shucai Xiao committed
726
727
728
729
730
731
732
void module::debug_print(const std::vector<instruction_ref>& inss) const
{
    for(auto ins : inss)
        this->debug_print(ins);
    std::cout << std::endl;
}

Shucai Xiao's avatar
Shucai Xiao committed
733
734
735
736
std::unordered_map<instruction_ref, std::string> module::print(
    const std::function<void(instruction_ref,
                             const std::unordered_map<instruction_ref, std::string>&)>& print_func,
    std::unordered_map<instruction_ref, std::string> names) const
Shucai Xiao's avatar
Shucai Xiao committed
737
738
739
740
741
742
743
744
745
746
747
{
    int count = 0;
    for(auto ins : iterator_for(*this))
    {
        std::string var_name;
        if(ins->name() == "@param")
        {
            var_name = any_cast<builtin::param>(ins->get_operator()).parameter;
        }
        else
        {
Shucai Xiao's avatar
Shucai Xiao committed
748
749
750
            var_name = this->name();
            var_name.append((this->name().empty() ? "@" : ":@"));
            var_name.append(std::to_string(count));
Shucai Xiao's avatar
Shucai Xiao committed
751
        }
Shucai Xiao's avatar
Shucai Xiao committed
752
753
        // count every instruction so index matches loc in the printout program
        count++;
Shucai Xiao's avatar
Shucai Xiao committed
754
755
756
757
        names.emplace(ins, var_name);

        print_func(ins, names);
    }
Shucai Xiao's avatar
Shucai Xiao committed
758
759
760
761
762
763
764
765
    return names;
}

void module::print(const std::function<
                   void(instruction_ref, const std::unordered_map<instruction_ref, std::string>&)>&
                       print_func) const
{
    this->print(print_func, {});
Shucai Xiao's avatar
Shucai Xiao committed
766
767
768
769
770
771
772
773
774
775
776
}

static std::string enclose_name(const std::string& name)
{
    return '"' + replace_string(name, "\"", "\\\"") + '"';
}

void module::print_graph(std::ostream& os, bool brief) const
{
    os << "digraph {" << std::endl;
    os << "\trankdir=LR;" << std::endl;
Shucai Xiao's avatar
Shucai Xiao committed
777
    this->print([&](auto ins, auto ins_names) {
Shucai Xiao's avatar
Shucai Xiao committed
778
779
780
781
782
        std::string label;
        if(brief)
            label = ins->name();
        else
            label = to_string(ins->get_operator());
Shucai Xiao's avatar
Shucai Xiao committed
783
        os << "\t" << enclose_name(ins_names.at(ins)) << "[label=" << enclose_name(label) << "]";
Shucai Xiao's avatar
Shucai Xiao committed
784
        os << ";" << std::endl;
785
        if(not ins->inputs().empty())
Shucai Xiao's avatar
Shucai Xiao committed
786
787
788
        {
            for(auto&& arg : ins->inputs())
            {
Shucai Xiao's avatar
Shucai Xiao committed
789
790
                os << "\t" << enclose_name(ins_names.at(arg)) << " -> "
                   << enclose_name(ins_names.at(ins));
Shucai Xiao's avatar
Shucai Xiao committed
791
792
793
794
795
796
797
798
799
                if(not brief)
                    os << "[label=" << enclose_name(to_string(ins->get_shape())) << "]";
                os << ";" << std::endl;
            }
        }
    });
    os << "}" << std::endl;
}

800
static std::string to_c_id(const std::string& name, char rep = '_')
Shucai Xiao's avatar
Shucai Xiao committed
801
{
802
803
804
805
806
807
808
809
    std::string id = transform_string(name, [&](auto c) {
        if(with_char(::isalnum)(c) or c == '_')
            return c;
        return rep;
    });
    while(contains(id, "__"))
        replace_string_inplace(id, "__", "_");
    return id;
Shucai Xiao's avatar
Shucai Xiao committed
810
811
}

812
static std::string cpp_var_name(const std::string& name)
Shucai Xiao's avatar
Shucai Xiao committed
813
{
814
    return to_c_id("x_" + replace_string(name, ":", "_module_"));
Shucai Xiao's avatar
Shucai Xiao committed
815
816
}

817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
static void print_py_op(std::ostream& os, const operation& op)
{
    auto v = op.to_value();
    os << "migraphx.op(" << enclose_name(op.name());

    auto default_values = make_op(op.name()).to_value();
    for(auto&& x : v)
    {
        auto name = x.get_key();
        if(default_values[name] == x)
            continue;
        os << ", " << name << "=" << to_json_string(x.without_key());
    }
    os << ")";
}

833
static void print_make_op(std::ostream& os, const operation& op)
Shucai Xiao's avatar
Shucai Xiao committed
834
{
835
836
    auto v = op.to_value();
    if(not v.empty())
Shucai Xiao's avatar
Shucai Xiao committed
837
    {
838
839
840
841
842
843
        os << "migraphx::make_json_op(" << enclose_name(op.name());
        os << ", " << enclose_name(to_json_string(v));
    }
    else
    {
        os << "migraphx::make_op(" << enclose_name(op.name());
Shucai Xiao's avatar
Shucai Xiao committed
844
    }
845
    os << ")";
Shucai Xiao's avatar
Shucai Xiao committed
846
847
}

848
849
static void print_py_shape(std::ostream& os, const migraphx::shape& s)
{
850
851
    os << "migraphx.shape(type=" << to_json_string(s.type_string())
       << ", lens=" << to_json_string(s.lens());
852
853
854
855
856
    if(not s.standard())
        os << ", strides=" << to_json_string(s.strides());
    os << ")";
}

Shucai Xiao's avatar
Shucai Xiao committed
857
858
859
860
861
862
863
864
865
static void print_cpp_shape(std::ostream& os, const migraphx::shape& s)
{
    os << "migraphx::shape{migraphx::shape::" << s.type_string();
    os << ", {" << to_string_range(s.lens()) << "}";
    if(not s.standard())
        os << ", {" << to_string_range(s.strides()) << "}";
    os << "}";
}

866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
std::unordered_map<instruction_ref, std::string>
module::print_py(std::ostream& os,
                 const std::string& mname,
                 std::unordered_map<instruction_ref, std::string> names) const
{
    // cppcheck-suppress variableScope
    unsigned long seed = names.size();
    auto last          = std::prev(this->end());
    names              = this->print(
        [&](auto ins, auto ins_names) {
            std::vector<std::string> input_vars;
            std::transform(ins->inputs().begin(),
                           ins->inputs().end(),
                           std::back_inserter(input_vars),
                           [&](auto input) { return cpp_var_name(ins_names.at(input)); });
            if(ins != last)
                os << cpp_var_name(ins_names.at(ins)) << " = ";
            if(ins->name() == "@literal")
            {
                os << mname << ".add_literal(";
                bool use_abs = false;
                ins->get_literal().visit([&](auto v) {
                    use_abs = std::none_of(v.begin(), v.end(), [](auto x) { return x < 0; });
                });
                // Disable abs for now
                use_abs = false;
                if(use_abs)
                    os << "migraphx.abs_literal(";
                os << "migraphx.generate_literal(";
                print_py_shape(os, ins->get_shape());
                os << ", " << seed << ")";
                if(use_abs)
                    os << ")";
                os << ")" << std::endl;
                seed++;
            }
            else if(ins->name() == "@param")
            {
                std::string name = any_cast<builtin::param>(ins->get_operator()).parameter;
                os << mname << ".add_parameter(" << enclose_name(name) << ",";
                print_py_shape(os, ins->get_shape());
                os << ")" << std::endl;
            }
            else if(ins->name() == "@return")
            {
                os << mname << ".add_return([" << join_strings(input_vars, ", ") << "])"
                   << std::endl;
            }
            else
            {
                assert(ins->name().front() != '@');
                os << mname << ".add_instruction(";
                print_py_op(os, ins->get_operator());
                os << ", [" << join_strings(input_vars, ", ") << "]";
                os << ")" << std::endl;
            }
        },
        names);

    return names;
}

Shucai Xiao's avatar
Shucai Xiao committed
928
std::unordered_map<instruction_ref, std::string>
929
930
931
module::print_cpp(std::ostream& os,
                  const std::string& mname,
                  std::unordered_map<instruction_ref, std::string> names) const
Shucai Xiao's avatar
Shucai Xiao committed
932
{
933
934
935
    // cppcheck-suppress variableScope
    unsigned long seed = names.size();
    auto last          = std::prev(this->end());
Shucai Xiao's avatar
Shucai Xiao committed
936
937
    names              = this->print(
        [&](auto ins, auto ins_names) {
938
939
940
941
942
943
944
            std::vector<std::string> input_vars;
            std::transform(ins->inputs().begin(),
                           ins->inputs().end(),
                           std::back_inserter(input_vars),
                           [&](auto input) { return cpp_var_name(ins_names.at(input)); });
            if(ins != last)
                os << "auto " << cpp_var_name(ins_names.at(ins)) << " = ";
Shucai Xiao's avatar
Shucai Xiao committed
945
946
            if(ins->name() == "@literal")
            {
947
                os << mname << "->add_literal(";
Shucai Xiao's avatar
Shucai Xiao committed
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
                bool use_abs = false;
                ins->get_literal().visit([&](auto v) {
                    use_abs = std::none_of(v.begin(), v.end(), [](auto x) { return x < 0; });
                });
                if(use_abs)
                    os << "migraphx::abs(";
                os << "migraphx::generate_literal(";
                print_cpp_shape(os, ins->get_shape());
                os << ", " << seed << ")";
                if(use_abs)
                    os << ")";
                os << ");" << std::endl;
                seed++;
            }
            else if(ins->name() == "@param")
            {
                std::string name = any_cast<builtin::param>(ins->get_operator()).parameter;
965
                os << mname << "->add_parameter(" << enclose_name(name) << ",";
Shucai Xiao's avatar
Shucai Xiao committed
966
967
968
                print_cpp_shape(os, ins->get_shape());
                os << ");" << std::endl;
            }
969
970
971
972
973
974
            else if(ins->name() == "@return")
            {
                os << mname << "->add_return({";
                os << join_strings(input_vars, ", ");
                os << "});" << std::endl;
            }
Shucai Xiao's avatar
Shucai Xiao committed
975
976
            else
            {
977
978
979
980
                assert(ins->name().front() != '@');
                os << mname << "->add_instruction(";
                print_make_op(os, ins->get_operator());
                os << ", " << join_strings(input_vars, ", ");
Shucai Xiao's avatar
Shucai Xiao committed
981
982
983
984
985
986
                os << ");" << std::endl;
            }
        },
        names);

    return names;
Shucai Xiao's avatar
Shucai Xiao committed
987
988
}

989
990
void module::print_py(std::ostream& os) const { this->print_py(os, this->name(), {}); }

991
void module::print_cpp(std::ostream& os) const { this->print_cpp(os, this->name(), {}); }
Shucai Xiao's avatar
Shucai Xiao committed
992

Shucai Xiao's avatar
Shucai Xiao committed
993
994
void module::annotate(std::ostream& os, std::function<void(instruction_ref)> a) const
{
Shucai Xiao's avatar
Shucai Xiao committed
995
996
    this->print([&](auto ins, auto ins_names) {
        instruction::print(os, ins, ins_names);
Shucai Xiao's avatar
Shucai Xiao committed
997
998
999
1000
1001
        a(ins);
        os << std::endl;
    });
}

1002
std::vector<module_ref> module::get_sub_modules(bool shallow) const
Shucai Xiao's avatar
Shucai Xiao committed
1003
1004
1005
1006
1007
1008
{
    std::vector<module_ref> vec_modules;
    for(auto ins : iterator_for(*this))
    {
        const auto& mod_args = ins->module_inputs();
        vec_modules.insert(vec_modules.end(), mod_args.begin(), mod_args.end());
1009
        if(not shallow)
Shucai Xiao's avatar
Shucai Xiao committed
1010
        {
1011
1012
1013
1014
1015
            for(const auto& smod : mod_args)
            {
                auto sub_mods = smod->get_sub_modules();
                vec_modules.insert(vec_modules.end(), sub_mods.begin(), sub_mods.end());
            }
Shucai Xiao's avatar
Shucai Xiao committed
1016
1017
1018
1019
1020
1021
        }
    }

    return vec_modules;
}

Shucai Xiao's avatar
Shucai Xiao committed
1022
1023
1024
1025
1026
module& module::sort()
{
    fix([&](auto self, auto ins) {
        this->move_instruction(ins, this->begin());
        for(auto child : ins->inputs())
Shucai Xiao's avatar
Shucai Xiao committed
1027
        {
1028
            if(not contains(this->impl->instructions, child))
Shucai Xiao's avatar
Shucai Xiao committed
1029
1030
1031
            {
                continue;
            }
Shucai Xiao's avatar
Shucai Xiao committed
1032
            self(child);
Shucai Xiao's avatar
Shucai Xiao committed
1033
        }
Shucai Xiao's avatar
Shucai Xiao committed
1034
1035
1036
1037
1038
    })(std::prev(this->end()));
    assert(this->validate() == this->end());
    return *this;
}

Shucai Xiao's avatar
Shucai Xiao committed
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
void module::calc_implicit_deps(const module& smod,
                                const module& pmod,
                                instruction_ref ins,
                                ins_dep_map& deps) const
{
    const auto& ins_inputs = ins->inputs();
    for(auto ii : iterator_for(smod))
    {
        const auto& ii_inputs = ii->inputs();
        for(auto iii : ii_inputs)
        {
            if(pmod.has_instruction(iii))
            {
                if(not contains(ins_inputs, iii))
                    deps[ins].insert(iii);
            }
        }

        const auto& mod_args = ii->module_inputs();
        if(not mod_args.empty())
        {
            for(const auto* ssmod : mod_args)
            {
                calc_implicit_deps(*ssmod, pmod, ins, deps);
            }
        }
    }
}

ins_dep_map module::calc_implicit_deps() const
{
    ins_dep_map mod_implicit_deps;
    for(auto ins : iterator_for(*this))
    {
        const auto& mod_args = ins->module_inputs();
        if(mod_args.empty())
        {
            continue;
        }

        for(const auto* mod : mod_args)
        {
            calc_implicit_deps(*mod, *this, ins, mod_implicit_deps);
        }
    }

    return mod_implicit_deps;
}

Shucai Xiao's avatar
Shucai Xiao committed
1088
1089
1090
1091
bool operator==(const module& x, const module& y) { return to_string(x) == to_string(y); }

std::ostream& operator<<(std::ostream& os, const module& m)
{
Shucai Xiao's avatar
Shucai Xiao committed
1092
1093
    m.print([&](auto ins, auto ins_names) {
        instruction::print(os, ins, ins_names);
Shucai Xiao's avatar
Shucai Xiao committed
1094
1095
        os << std::endl;
    });
Shucai Xiao's avatar
Shucai Xiao committed
1096

Shucai Xiao's avatar
Shucai Xiao committed
1097
1098
1099
1100
1101
    return os;
}

} // namespace MIGRAPHX_INLINE_NS
} // namespace migraphx