interpreter_impl.cpp 51.3 KB
Newer Older
M
Megvii Engine Team 已提交
1
/**
2
 * \file imperative/src/impl/interpreter/interpreter_impl.cpp
M
Megvii Engine Team 已提交
3 4
 * MegEngine is Licensed under the Apache License, Version 2.0 (the "License")
 *
5
 * Copyright (c) 2014-2021 Megvii Inc. All rights reserved.
M
Megvii Engine Team 已提交
6 7 8 9 10 11
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT ARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 */

12
#include "./interpreter_impl.h"
13

14 15
#include "range/v3/all.hpp"

16
#include "megbrain/common.h"
17 18
#include "megbrain/imperative/opr_utility.h"
#include "megbrain/imperative/ops/autogen.h"
19 20
#include "megbrain/imperative/ops/backward_graph.h"
#include "megbrain/imperative/ops/opr_attr.h"
21
#include "megbrain/imperative/ops/utility.h"
22
#include "megbrain/imperative/utils/stats.h"
23 24
#include "megbrain/imperative/utils/to_string.h"

25
#include "../blob_manager_impl.h"
26 27 28
#include "../event_pool.h"
#include "../op_trait.h"

29 30 31 32 33
using namespace mgb;
using namespace imperative;
using namespace interpreter;
using namespace interpreter::intl;

34
namespace {
M
Megvii Engine Team 已提交
35 36 37 38 39 40 41 42
auto tinfo_to_tid(SmallVector<TensorInfo*> tinfo) {
    SmallVector<uint64_t> tid;
    for (auto* ptinfo : tinfo) {
        tid.push_back(ptinfo->id);
    }
    return tid;
};
}  // namespace
43

44
namespace mgb {
M
Megvii Engine Team 已提交
45
using namespace profiler;
46 47
}

48 49 50 51 52
#if defined(_WIN32) || defined(_WIN64)
#define SYMBOL_EXPORT __declspec(dllexport)
#else
#define SYMBOL_EXPORT __attribute__((visibility("default")))
#endif
53 54 55 56 57 58 59

namespace mgb {

/**
 * USAGE
 *
 *   header:
60
 *     namespace mgb { void imperative_log_profile(const char* message); }
61 62 63 64 65
 *
 *   code:
 *     mgb::imperative_log_profile("MY MESSAGE");
 *
 **/
66
SYMBOL_EXPORT
67
void imperative_log_profile_begin(const char* message) {
68
    MGB_RECORD_EVENT(CustomEvent, std::string{message});
69 70
}

71
SYMBOL_EXPORT
72
void imperative_log_profile_end(const char* message) {
73
    MGB_RECORD_EVENT(CustomFinishEvent, std::string{message});
74 75
}

76
SYMBOL_EXPORT
M
Megvii Engine Team 已提交
77
void imperative_log_profile(const char* message) {
78 79 80 81
    imperative_log_profile_begin(message);
    imperative_log_profile_end(message);
}

82 83 84 85
SYMBOL_EXPORT
void imperative_log_profile_begin(const char* message, const char* device) {
    auto comp_node = CompNode::load(device);
    MGB_RECORD_EVENT(CustomEvent, std::string{message}, {}, comp_node);
M
Megvii Engine Team 已提交
86 87
    MGB_RECORD_EVENT(
            RecordDeviceEvent, EventPool::with_timer().alloc_shared(comp_node));
88 89 90 91 92
}

SYMBOL_EXPORT
void imperative_log_profile_end(const char* message, const char* device) {
    auto comp_node = CompNode::load(device);
M
Megvii Engine Team 已提交
93 94
    MGB_RECORD_EVENT(
            RecordDeviceEvent, EventPool::with_timer().alloc_shared(comp_node));
95 96 97
    MGB_RECORD_EVENT(CustomFinishEvent, std::string{message}, {}, comp_node);
}

M
Megvii Engine Team 已提交
98
}  // namespace mgb
99

100 101 102 103 104 105 106 107 108 109 110 111 112 113
std::thread::id ChannelImpl::get_worker_tid() {
    return m_worker_state.tid;
}

ChannelImpl::ChannelState& ChannelImpl::get_channel_state() {
    assert_in_channel();
    return m_channel_state;
}

ChannelImpl::WorkerState& ChannelImpl::get_worker_state() {
    assert_in_worker();
    return m_worker_state;
}

114 115 116 117 118 119 120 121 122 123
void ChannelImpl::WorkQueue::on_async_queue_worker_thread_start() {
    sys::set_thread_name("worker");
    m_owner->m_worker_state.tid = std::this_thread::get_id();
    OpDef::set_allocator([&](CompNode device, size_t size) {
        auto blob = Blob::make(device, size);
        m_owner->alloc_tensor_with_evict(blob.get());
        return blob->storage();
    });
}

124
// Do not use m_xxx_state directly
125 126 127
#define m_channel_state
#define m_worker_state

128 129 130 131 132 133 134 135 136
std::unique_ptr<Interpreter::Channel> InterpreterImpl::create_channel() {
    return std::make_unique<ChannelImpl>();
}

Interpreter& Interpreter::inst() {
    static InterpreterImpl inst_;
    return inst_;
}

137
Handle ChannelImpl::put(const HostTensorND& value, bool no_cache) {
138
    MGB_LOCK_GUARD(m_spin);
139
    mgb_assert(check_available(), "Channel already closed");
140
    auto& state = get_channel_state();
141
    auto _ = StackManager::Guard{"Put", &state.stack_manager};
142
    auto info = put_impl(value, no_cache);
M
Megvii Engine Team 已提交
143
    return reinterpret_cast<Handle>(info);
144 145 146
}

TensorInfo* ChannelImpl::put_impl(const HostTensorND& value, bool no_cache) {
147 148 149 150 151
    if (value.empty()) {
        auto layout = value.layout();
        layout.init_contiguous_stride();
        const_cast<HostTensorND&>(value).reset(value.storage(), layout);
    }
152
    auto info = alloc();
153 154 155 156 157 158
    constexpr int size_threshold = TensorShape::MAX_NDIM;
    init(info, {value.layout(), value.comp_node()});
    if (value.layout().total_nr_elems() <= size_threshold) {
        info->h_value = value;
        info->desc.value = value.proxy_to_default_cpu();
    }
159 160 161
    m_worker.add_task(
            {Profiler::next_id(), Put{info, value, no_cache},
             get_channel_state().stack_manager.dump()});
162
    if (m_async_level == 0) {
163
        sync_impl();
164
        info->desc.comp_node.sync();
165 166
        auto err = info->desc.comp_node.check_async_error();
        mgb_assert(!err, "%s", err->what());
167
    }
168 169 170
    return info;
}

171
Handle ChannelImpl::put(const DeviceTensorND& data, const HostTensorND& hvalue) {
172
    MGB_LOCK_GUARD(m_spin);
173
    mgb_assert(check_available(), "Channel already closed");
M
Megvii Engine Team 已提交
174
    return reinterpret_cast<Handle>(put_impl(data, hvalue));
175
}
M
Megvii Engine Team 已提交
176 177
TensorInfo* ChannelImpl::put_impl(
        const DeviceTensorND& data, const HostTensorND& hvalue) {
178
    auto& state = get_channel_state();
179
    auto _ = StackManager::Guard{"Put", &state.stack_manager};
M
Megvii Engine Team 已提交
180
    auto info = alloc();
181
    MGB_RECORD_EVENT(TensorCommandEvent, info->id, TensorCommandKind::Put);
182
    constexpr int size_threshold = TensorShape::MAX_NDIM;
183
    init(info, {data.layout(), data.comp_node()});
184 185 186
    if ((!hvalue.empty()) && info->desc.layout.total_nr_elems() <= size_threshold) {
        info->desc.value = hvalue.proxy_to_default_cpu();
    }
187
    info->ptr = Tensor::make(data, hvalue);
M
Megvii Engine Team 已提交
188 189 190
    MGB_RECORD_EVENT(
            TensorProduceEvent, info->id, info->desc.layout, info->desc.comp_node,
            data.raw_ptr());
191
    info->status = TensorInfo::Produced;
192
    MGB_RECORD_EVENT(TensorCommandFinishEvent, info->id, TensorCommandKind::Put);
M
Megvii Engine Team 已提交
193 194 195
    return info;
}

196
void ChannelImpl::del(Handle handle) {
197
    MGB_LOCK_GUARD(m_spin);
M
Megvii Engine Team 已提交
198
    if (!check_available()) {
199 200
        return;
    }
201 202 203 204
    del_impl(handle);
}

void ChannelImpl::del_impl(Handle handle) {
205 206 207
    mgb_assert(m_valid_handle.count(handle), "invalid handle: %p", handle);
    auto* info = reinterpret_cast<TensorInfo*>(handle);
    m_valid_handle.erase(handle);
208 209
    m_worker.add_task(
            {Profiler::next_id(), Del{info}, get_channel_state().stack_manager.dump()});
210 211
}

212
void ChannelImpl::drop(Handle handle) {
213
    MGB_LOCK_GUARD(m_spin);
214
    mgb_assert(check_available(), "Channel already closed");
215 216
    auto& state = get_channel_state();
    if (state.options.enable_drop) {
M
Megvii Engine Team 已提交
217 218
        mgb_assert(
                m_valid_handle.find(handle) != m_valid_handle.end(),
219
                "invalid handle: %p", handle);
220
        auto* info = reinterpret_cast<TensorInfo*>(handle);
221 222 223
        m_worker.add_task(
                {Profiler::next_id(), Drop{info},
                 get_channel_state().stack_manager.dump()});
224 225 226
    }
}

227
void ChannelImpl::dispatch_default_cpu(
M
Megvii Engine Team 已提交
228
        std::shared_ptr<OpDef> op, const SmallVector<TensorInfo*>& input_infos,
229 230
        const SmallVector<LogicalTensorDesc>& input_descs,
        SmallVector<Handle>* outputs) {
231
    auto& state = get_channel_state();
232 233

    auto name = op->trait()->make_name(*op);
234
    auto _ = StackManager::Guard(name, &state.stack_manager);
235

M
Megvii Engine Team 已提交
236 237
    auto [output_descs, validated] =
            OpDef::infer_output_attrs_fallible(*op, input_descs);
238
    MGB_RECORD_EVENT(ShapeInferEvent, validated);
239

240 241
    SmallVector<DeviceTensorND> input_tensornds;
    CompNode output_cn;
242 243
    {
        MGB_LOCK_GUARD(m_mutex);
244
        for (auto&& info : input_infos) {
245
            auto input_cn = info->desc.comp_node;
246
            if (!output_cn.valid()) {
247 248 249 250 251 252
                output_cn = input_cn;
            } else {
                mgb_assert(output_cn == input_cn, "cannot decide output comp node");
            }

            if (info->ptr && info->ptr->try_get_value()) {
M
Megvii Engine Team 已提交
253 254
                input_tensornds.emplace_back(
                        info->ptr->get_value().proxy_to_default_cpu());
255
            } else {
256
                // We assign h_value before drop ptr
257 258
                mgb_assert(!info->h_value.empty(), "inp->h_value is empty!");
                input_tensornds.emplace_back(info->h_value.proxy_to_default_cpu());
259 260 261 262 263 264 265 266 267
            }
        }
    }

    SmallVector<DeviceTensorND> output_tensornds;
    for (auto&& desc : output_descs) {
        // TODO: may conflict with condtake, which need alloc inside
        mgb_assert(!desc.layout.is_empty());
        // use HostTensorND alloc_host for cuda pinned memory
M
Megvii Engine Team 已提交
268 269
        output_tensornds.emplace_back(
                HostTensorND(output_cn, desc.layout).proxy_to_default_cpu());
270 271
    }

272
    uint64_t op_id = Profiler::next_id();
273

274 275 276 277 278 279 280 281 282
    if (op->trait()->apply_on_device_tensornd) {
        OpDef::apply_on_device_tensornd(*op, input_tensornds, &output_tensornds);
    } else {
        // proxy to apply_on_physical_tensor
        SmallVector<TensorPtr> input_tensors;
        for (auto&& input_tensornd : input_tensornds) {
            input_tensors.push_back(Tensor::make(
                    input_tensornd, HostTensorND::make_proxy(input_tensornd)));
        }
283 284
        auto output_tensors = OpDef::apply_on_physical_tensor(
                *op, input_tensors, output_descs, validated);
285 286 287 288
        for (size_t i = 0; i < output_tensors.size(); ++i) {
            output_tensornds[i].copy_from_fixlayout(output_tensors[i]->dev_tensor());
        }
    }
289 290 291

    SmallVector<TensorInfo*> output_infos;
    for (auto&& tensornd : output_tensornds) {
M
Megvii Engine Team 已提交
292 293
        HostTensorND host_tensornd =
                HostTensorND::make_proxy(tensornd).proxy_to_comp_node(output_cn);
294
        // use `put` for consistency
295
        auto info = reinterpret_cast<TensorInfo*>(put_impl(host_tensornd, false));
296
        mgb_assert(info->desc.layout.ndim != 0);
297
        output_infos.push_back(info);
M
Megvii Engine Team 已提交
298
        outputs->push_back(reinterpret_cast<Handle>(info));
299
    }
M
Megvii Engine Team 已提交
300
    auto op_info_getter = [op] {
301 302
        std::unordered_map<std::string, std::string> op_info;
        auto props = OpDef::props(*op);
M
Megvii Engine Team 已提交
303
        for (auto&& [key, value] : props) {
304 305 306 307
            op_info[key] = value;
        }
        return op_info;
    };
M
Megvii Engine Team 已提交
308 309 310
    MGB_RECORD_EVENT(
            OpDispatchEvent, op_id, name, op_info_getter, tinfo_to_tid(input_infos),
            tinfo_to_tid(output_infos), state.stack_manager.dump());
311
}
312

313
void ChannelImpl::dispatch_kernel(
M
Megvii Engine Team 已提交
314
        std::shared_ptr<OpDef> op, const SmallVector<TensorInfo*>& input_infos,
315 316
        const SmallVector<LogicalTensorDesc>& input_descs,
        SmallVector<Handle>* outputs) {
317
    auto& state = get_channel_state();
318 319 320
    auto& options = state.options;

    auto name = op->trait()->make_name(*op);
M
Megvii Engine Team 已提交
321
    auto _ = StackManager::Guard{name, &state.stack_manager};
322

M
Megvii Engine Team 已提交
323 324
    auto [output_descs, validated] =
            OpDef::infer_output_attrs_fallible(*op, input_descs);
325
    MGB_RECORD_EVENT(ShapeInferEvent, validated);
326

327
    ApplyOp cmd{Profiler::next_id(), std::move(op)};
328
    cmd.validated = validated;
329
    cmd.inputs = std::move(input_infos);
330 331
    for (int i = 0; i < output_descs.size(); ++i) {
        auto&& desc = output_descs[i];
332
        auto info = alloc();
333
        init(info, desc);
334 335 336
        // make sure desc's value is consistent with h_value
        if (!info->desc.value.empty()) {
            info->h_value = HostTensorND::make_proxy(desc.value)
M
Megvii Engine Team 已提交
337
                                    .proxy_to_comp_node(desc.comp_node);
338
        }
339
        cmd.outputs.push_back(info);
M
Megvii Engine Team 已提交
340
        outputs->push_back(reinterpret_cast<Handle>(info));
341
    }
M
Megvii Engine Team 已提交
342
    auto op_info_getter = [op = cmd.op] {
343 344
        std::unordered_map<std::string, std::string> op_info;
        auto props = OpDef::props(*op);
M
Megvii Engine Team 已提交
345
        for (auto&& [key, value] : props) {
346 347 348 349
            op_info[key] = value;
        }
        return op_info;
    };
M
Megvii Engine Team 已提交
350 351 352
    MGB_RECORD_EVENT(
            OpDispatchEvent, cmd.id, name, op_info_getter, tinfo_to_tid(cmd.inputs),
            tinfo_to_tid(cmd.outputs), state.stack_manager.dump());
353 354 355
    m_worker.add_task(
            {Profiler::next_id(), std::move(cmd),
             get_channel_state().stack_manager.dump()});
356
    if (!validated && options.async_level == 1) {
357
        sync_impl();
358
    } else if (options.async_level == 0) {
359
        sync_impl();
360
        // check device error
361
        for (auto&& oup : *outputs) {
362 363
            auto info = reinterpret_cast<TensorInfo*>(oup);
            info->ptr->comp_node().sync();
364 365
            auto err = info->ptr->comp_node().check_async_error();
            mgb_assert(!err, "%s", err->what());
366
        }
367
    }
368 369 370
}

SmallVector<Handle> ChannelImpl::apply_op(
M
Megvii Engine Team 已提交
371
        std::shared_ptr<OpDef> op, const SmallVector<Handle>& inputs) {
372
    MGB_LOCK_GUARD(m_spin);
373
    mgb_assert(check_available(), "Channel already closed");
374 375 376 377 378 379 380 381 382 383 384
    auto* input = reinterpret_cast<TensorInfo*>(inputs[0]);
    if (op->same_type<GetVarShape>() && input->desc.layout.ndim) {
        size_t ndim = input->desc.layout.ndim;
        auto& gvs = op->cast_final_safe<GetVarShape>();
        if (gvs.axis == MEGDNN_MAX_NDIM) {
            HostTensorND shape_tensor{input->desc.comp_node, {ndim}, dtype::Int32()};
            DeviceTensorND shape_tensor_device = shape_tensor.proxy_to_default_cpu();
            cg::copy_shape_to_tensor_value(shape_tensor_device, input->desc.layout);
            return {reinterpret_cast<Handle>(put_impl(shape_tensor, false))};
        }
    }
385 386 387 388
    return apply_op_impl(std::move(op), inputs);
}

SmallVector<Handle> ChannelImpl::apply_op_impl(
M
Megvii Engine Team 已提交
389
        std::shared_ptr<OpDef> op, const SmallVector<Handle>& inputs) {
390
    auto& state = get_channel_state();
391
    for (auto i : inputs) {
M
Megvii Engine Team 已提交
392 393 394
        mgb_assert(
                m_valid_handle.find(i) != m_valid_handle.end(), "invalid handle: %p",
                i);
395 396 397 398 399 400 401
    }
    SmallVector<TensorInfo*> input_infos;
    SmallVector<LogicalTensorDesc> input_descs;
    {
        MGB_LOCK_GUARD(m_mutex);
        for (auto i : inputs) {
            auto info = reinterpret_cast<TensorInfo*>(i);
M
Megvii Engine Team 已提交
402 403 404
            mgb_assert(
                    !info->invalid,
                    "an input tensor is unusable due to previous error");
405 406 407 408 409 410
            input_infos.push_back(info);
            input_descs.push_back(info->desc);
        }
    }

    SmallVector<Handle> outputs;
411
    DispatchMode dispatch_mode = state.options.enable_host_compute
M
Megvii Engine Team 已提交
412 413
                                       ? OpDef::decide_dispatch_mode(*op, input_descs)
                                       : DispatchMode::KERNEL;
414
    switch (dispatch_mode) {
415 416 417 418 419 420 421 422 423
        case DEFAULT_CPU: {
            dispatch_default_cpu(op, input_infos, input_descs, &outputs);
            break;
        }
        case KERNEL: {
            dispatch_kernel(op, input_infos, input_descs, &outputs);
            break;
        }
    }
424 425 426
    return outputs;
}

427
HostTensorND ChannelImpl::get_value(Handle handle) {
428
    MGB_LOCK_GUARD(m_spin);
429
    mgb_assert(check_available(), "Channel already closed");
M
Megvii Engine Team 已提交
430 431 432
    mgb_assert(
            m_valid_handle.find(handle) != m_valid_handle.end(), "invalid handle: %p",
            handle);
433
    auto info = reinterpret_cast<TensorInfo*>(handle);
434
    // donnot use info->value_fetched, it's unsafe
435
    mgb_assert(!info->invalid, "tensor is unusable due to previous error");
436
    return wait_tensor(info, TensorProp::HostValue)->get_value();
437 438
}

439
TensorShape ChannelImpl::get_shape(Handle handle) {
440
    MGB_LOCK_GUARD(m_spin);
441
    mgb_assert(check_available(), "Channel already closed");
M
Megvii Engine Team 已提交
442 443 444
    mgb_assert(
            m_valid_handle.find(handle) != m_valid_handle.end(), "invalid handle: %p",
            handle);
445 446 447 448
    auto info = reinterpret_cast<TensorInfo*>(handle);
    if (info->desc.layout.ndim != 0) {
        return info->desc.layout;
    }
449
    TensorShape ret = wait_tensor(info, TensorProp::Shape)->layout();
450 451 452 453
    mgb_assert(ret.ndim != 0);
    return ret;
}

454
DType ChannelImpl::get_dtype(Handle handle) {
455
    MGB_LOCK_GUARD(m_spin);
456
    mgb_assert(check_available(), "Channel already closed");
M
Megvii Engine Team 已提交
457 458 459
    mgb_assert(
            m_valid_handle.find(handle) != m_valid_handle.end(), "invalid handle: %p",
            handle);
460
    auto info = reinterpret_cast<TensorInfo*>(handle);
461
    MGB_RECORD_EVENT(TensorGetPropEvent, info->id, TensorProp::DType);
462 463 464 465 466
    auto ret = info->desc.layout.dtype;
    mgb_assert(ret.valid());
    return ret;
}

467
CompNode ChannelImpl::get_device(Handle handle) {
468
    MGB_LOCK_GUARD(m_spin);
469
    mgb_assert(check_available(), "Channel already closed");
M
Megvii Engine Team 已提交
470 471 472
    mgb_assert(
            m_valid_handle.find(handle) != m_valid_handle.end(), "invalid handle: %p",
            handle);
473
    auto info = reinterpret_cast<TensorInfo*>(handle);
474
    MGB_RECORD_EVENT(TensorGetPropEvent, info->id, TensorProp::Device);
475 476 477 478 479
    auto ret = info->desc.comp_node;
    mgb_assert(ret.valid());
    return ret;
}

480
DeviceTensorND ChannelImpl::get_dev_tensor(Handle handle) {
481
    MGB_LOCK_GUARD(m_spin);
482
    mgb_assert(check_available(), "Channel already closed");
M
Megvii Engine Team 已提交
483 484 485
    mgb_assert(
            m_valid_handle.find(handle) != m_valid_handle.end(), "invalid handle: %p",
            handle);
486
    auto info = reinterpret_cast<TensorInfo*>(handle);
487
    return wait_tensor(info, TensorProp::DevValue)->dev_tensor();
488 489 490
}

void ChannelImpl::sync() {
491
    MGB_LOCK_GUARD(m_spin);
492
    mgb_assert(check_available(), "Channel already closed");
493 494 495 496
    sync_impl();
}

void ChannelImpl::sync_impl() {
497 498 499 500 501 502
    m_worker.wait_all_task_finish();
    MGB_LOCK_GUARD(m_mutex);
    check_worker_exc_unsafe();
}

void ChannelImpl::close() {
503
    MGB_LOCK_GUARD(m_spin);
504 505 506 507
    if (!check_available()) {
        return;
    }
    std::vector<Handle> valid_handles(m_valid_handle.begin(), m_valid_handle.end());
M
Megvii Engine Team 已提交
508
    for (auto* handle : valid_handles) {
509
        del_impl(handle);
510 511 512
    }
    mgb_assert(m_valid_handle.empty());
    mgb_log_debug("%ld tensor exists before channel close", (long)valid_handles.size());
513
    sync_impl();
514
    m_closed = true;
515 516
}

517
size_t ChannelImpl::get_option(std::string name) {
518
    MGB_LOCK_GUARD(m_spin);
519
    mgb_assert(check_available(), "Channel already closed");
520 521
    auto& state = get_channel_state();
    return state.options.get_option(name);
522 523
}

524
void ChannelImpl::set_option(std::string name, size_t value) {
525
    MGB_LOCK_GUARD(m_spin);
526
    mgb_assert(check_available(), "Channel already closed");
527 528
    auto& state = get_channel_state();
    state.options.set_option(name, value);
529 530 531
    m_worker.add_task(
            {Profiler::next_id(), SetOption{name, value},
             get_channel_state().stack_manager.dump()});
532 533
}

534 535 536 537 538 539
void ChannelImpl::clear_candidates() {
    MGB_LOCK_GUARD(m_spin);
    mgb_assert(check_available(), "Channel already closed");
    m_dtr.candidates.clear();
}

540
TensorInfo* ChannelImpl::alloc() {
541
    auto& state = get_channel_state();
M
Megvii Engine Team 已提交
542
    auto info = [this] {
543 544 545 546 547
        MGB_LOCK_GUARD(m_mutex);
        return m_pool.alloc();
    }();
    info->id = Profiler::next_id();
    if (Profiler::is_profiling()) {
548
        size_t tensor_id = state.stack_manager.current()->next_id("tensor");
M
Megvii Engine Team 已提交
549 550
        info->name =
                state.stack_manager.dump().to_string() + ssprintf(":%zu", tensor_id);
551
    }
552
    return info;
553 554
}

555
void ChannelImpl::init(TensorInfo* info, LogicalTensorDesc desc) {
M
Megvii Engine Team 已提交
556
    m_valid_handle.insert(reinterpret_cast<Handle>(info));
557
    MGB_RECORD_EVENT(TensorDeclareEvent, info->id, info->name);
558 559 560 561
    info->status = TensorInfo::Allocated;
    info->desc = std::move(desc);
}

M
Megvii Engine Team 已提交
562
void ChannelImpl::do_drop(TensorInfo* ptr, bool user = false) {
563 564
    if (!ptr->producer) {
        if (user) {
M
Megvii Engine Team 已提交
565 566 567 568
            mgb_log_warn(
                    "the input that produced tensor %p has been deleted, this drop "
                    "operation will be ignored",
                    ptr);
569 570 571 572 573 574 575
        }
        return;
    }
    if (ptr->evict_type != EvictType::NONE) {
        return;
    }
    ptr->evict_type = EvictType::DROP;
576
    ptr->status = TensorInfo::Dropped;
577 578 579
    release_tensor(ptr);
}

580
void ChannelImpl::free(TensorInfo* ptr) {
581 582
    auto& state = get_worker_state();
    if (state.options.enable_dtr_auto_drop) {
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
        // Evicting a tensor, rather than freeing it, can avoid pinning
        // potentially exploding amounts of memory and allow us to save
        // more memory.
        ptr->allow_delete = true;
        if (!ptr->ref_cnt) {
            recursive_free(ptr);
        } else {
            do_drop(ptr);
        }
    } else {
        real_free(ptr);
    }
}

void ChannelImpl::recursive_free(TensorInfo* ptr) {
598
    MGB_RECORD_EVENT(TensorCommandEvent, ptr->id, TensorCommandKind::RecFree);
599
    SmallVector<TensorInfo*> inps;
600 601 602 603 604 605 606 607 608 609 610 611 612
    if (ptr->producer) {
        for (auto i : ptr->producer->inputs) {
            if (i && --i->ref_cnt == 0) {
                inps.push_back(i);
            }
        }
    }
    real_free(ptr);
    for (auto i : inps) {
        if (i->allow_delete) {
            recursive_free(i);
        }
    }
613
    MGB_RECORD_EVENT(TensorCommandFinishEvent, ptr->id, TensorCommandKind::RecFree);
614 615 616
}

void ChannelImpl::real_free(TensorInfo* ptr) {
617 618
    auto& state = get_worker_state();
    if (ptr->size_exceeds_thd(state.options.dtr_evictee_minimum_size)) {
619 620 621 622
        m_dtr.erase_candidate(ptr);
    }
    detach_users(ptr);
    ptr->detach_producer();
623 624
    bool has_value = ptr->ptr != nullptr;
    if (has_value) {
625
        MGB_RECORD_EVENT(TensorReleaseEvent, ptr->id);
626
    }
627
    MGB_RECORD_EVENT(TensorEraseEvent, ptr->id, ptr->ptr_use_count);
628
    ptr->status = TensorInfo::Deleted;
629
    MGB_LOCK_GUARD(m_mutex);
630 631 632
    m_pool.free(ptr);
}

633
ChannelImpl::ChannelImpl() : m_worker(this) {}
634

635 636 637
ChannelImpl::~ChannelImpl() {
    close();
}
638

639
void ChannelImpl::produce_tensor(TensorInfo* dest, TensorPtr ptr) {
640
    auto& state = get_worker_state();
641
    MGB_LOCK_GUARD(m_mutex);
642
    m_dtr.update_used_time(dest);
M
Megvii Engine Team 已提交
643 644
    MGB_RECORD_EVENT(
            TensorProduceEvent, dest->id, ptr->layout(), ptr->comp_node(),
645
            ptr->dev_tensor(false).raw_ptr());
646
    // update tensor desc for static infer
647 648 649 650 651 652
    if (dest->desc.layout.ndim) {
        mgb_assert(
                dest->desc.layout.eq_shape(ptr->layout()),
                "shape infer error, %s vs %s", dest->desc.layout.to_string().c_str(),
                ptr->layout().to_string().c_str());
    }
653 654
    dest->desc.layout = ptr->layout();
    dest->desc.comp_node = ptr->comp_node();
655
    dest->memory = ptr->blob()->size();
656
    dest->ptr = std::move(ptr);
657
    dest->evict_type = EvictType::NONE;
658
    dest->status = TensorInfo::Produced;
659 660
    if (dest->pinned == 0 &&
        dest->size_exceeds_thd(state.options.dtr_evictee_minimum_size)) {
661 662
        m_dtr.insert_candidate(dest);
    }
663
    notify_tensor_unsafe(dest);
664 665
}

666
void ChannelImpl::release_tensor(TensorInfo* dest) {
667
    MGB_RECORD_EVENT(TensorReleaseEvent, dest->id);
668 669
    MGB_LOCK_GUARD(m_mutex);
    dest->ptr.reset();
670 671 672 673
    auto& state = get_worker_state();
    if (dest->size_exceeds_thd(state.options.dtr_evictee_minimum_size)) {
        m_dtr.erase_candidate(dest);
    }
674 675
}

676
void ChannelImpl::regenerate(TensorInfo* dest) {
677
    if (dest->evict_type == EvictType::DROP) {
M
Megvii Engine Team 已提交
678 679
        auto&& path = dest->producer;
        m_apply_stack.push(
680
                {ApplyOp{path->id, path->op, path->inputs, path->outputs}, 0, dest,
M
Megvii Engine Team 已提交
681 682 683
                 "dtr"});
        if (!m_applying)
            flush_apply_stack();
684 685 686
    }
}

687
void ChannelImpl::do_apply_op(const ApplyOp& cmd, std::string reason) {
688 689
    using namespace ranges;
    using namespace ranges::views;
690
    auto& state = get_worker_state();
M
Megvii Engine Team 已提交
691 692
    bool profiling_device =
            Profiler::is_profiling() && Profiler::get_option("profile_device", 0);
693
    uint64_t apply_id = cmd.id;
694
    SmallVector<TensorPtr> inputs;
695
    inputs.reserve(cmd.inputs.size());
696 697 698
    // refcnt == 1, owners: [TensorInfo::ptr]
    for (auto i : cmd.inputs) {
        mgb_assert(i->ptr, "Invalid input tensor ptr!");
699
        // refcnt ++, owners: [i->ptr, tensor_inputs]
700
        // tensor_inputs.push_back(i->ptr);
701
        inputs.push_back(i->ptr);
702
    }
M
Megvii Engine Team 已提交
703 704
    if (state.options.enable_dtr_auto_drop &&
        state.options.dtr_eviction_threshold > 0) {
705 706
        auto_evict(0);
    }
M
Megvii Engine Team 已提交
707
    auto apply_on_physical_tensor =
708 709 710
            [&](auto&& self, const OpDef& def, SmallVector<TensorPtr> inputs,
                SmallVector<LogicalTensorDesc>& output_descs,
                const bool& validated) -> SmallVector<TensorPtr> {
M
Megvii Engine Team 已提交
711
        auto apply_functor = [&](std::shared_ptr<OpDef> op,
712 713
                                 SmallVector<TensorPtr> inputs,
                                 size_t nr_outputs) -> SmallVector<TensorPtr> {
714
            auto opname = op->trait()->make_name(*op);
715
            imperative_log_profile_begin(opname.c_str());
716 717
            // do not use infered output_desc in subgraph
            auto outputs = self(self, *op, inputs, output_descs, false);
718
            imperative_log_profile_end(opname.c_str());
719 720
            return outputs;
        };
721
        auto const_functor = [&](TensorPtr value) -> TensorPtr { return value; };
722 723 724
        if (def.trait()->make_forward_graph) {
            // apply recursivily
            SmallVector<LogicalTensorDesc> input_descs;
M
Megvii Engine Team 已提交
725
            for (auto&& input : inputs) {
726
                input_descs.push_back({{{}, input->dtype()}, input->comp_node()});
727
            }
728
            auto forward_graph = OpDef::make_forward_graph(def, input_descs);
729 730
            auto outputs = forward_graph.apply<TensorPtr>(
                    inputs, apply_functor, const_functor);
731 732
            return outputs;
        }
733 734 735 736 737 738 739 740 741 742 743 744
        // Check Input Layout
        // Get the input layout constraints, and if the constraint is not satisfied
        // inplace update the layout and blob to make the tensor contiguous
        auto&& constraints = OpDef::get_input_layout_constraint(def, inputs);
        for (size_t idx = 0; idx < inputs.size(); ++idx) {
            auto&& layout_checker = constraints[idx];
            if (layout_checker) {
                inputs[idx]->to_contiguous_inplace(layout_checker);
            }
        }
        return OpDef::apply_on_physical_tensor(
                def, std::move(inputs), output_descs, validated);
745
    };
746
    MGB_RECORD_EVENT(OpExecuteEvent, apply_id, {}, reason);
747 748 749 750
    SmallVector<std::pair<CompNode, uint64_t>> kernels;
    if (profiling_device) {
        // Collecting devices
        SmallVector<CompNode> devices;
751 752 753
        for (auto&& i : concat(cmd.inputs, cmd.outputs)) {
            if (i != nullptr && count(devices, i->desc.comp_node) == 0) {
                devices.push_back(i->desc.comp_node);
754
                kernels.push_back({i->desc.comp_node, Profiler::next_id()});
755 756 757
            }
        }
    }
M
Megvii Engine Team 已提交
758
    for (auto* input : cmd.inputs) {
759
        auto input_id = input->id;
760 761 762
        MGB_RECORD_EVENT(OpInputEvent, input_id);
        MGB_RECORD_EVENT(TensorUsageEvent, input_id);
        MGB_RECORD_EVENT(OpInputFinishEvent, input_id);
763 764
    }
    // Before wait
M
Megvii Engine Team 已提交
765
    // TODO: split operator wait and execute so that OpWait could be corrected recorded.
766
    // Before execute
M
Megvii Engine Team 已提交
767
    for (auto&& [device, kernel_id] : kernels) {
768
        MGB_RECORD_EVENT(KernelLaunchEvent, apply_id, kernel_id, device);
M
Megvii Engine Team 已提交
769 770 771
        MGB_RECORD_EVENT_IF(
                (Profiler::get_option("profile_device", 0)), RecordDeviceEvent,
                Timer::record_device(device));
772 773
    }
    // Apply op
774 775 776 777
    SmallVector<LogicalTensorDesc> output_descs;
    for (auto i : cmd.outputs) {
        output_descs.push_back(i->desc);
    }
778
    // Here std::move is REQUIRED for removing duplicated references.
779 780
    auto outputs = apply_on_physical_tensor(
            apply_on_physical_tensor, *cmd.op, inputs, output_descs, cmd.validated);
781
    // After execute
M
Megvii Engine Team 已提交
782 783 784 785
    for (auto&& [device, kernel_id] : kernels) {
        MGB_RECORD_EVENT_IF(
                (Profiler::get_option("profile_device", 0)), RecordDeviceEvent,
                Timer::record_device(device));
786
        MGB_RECORD_EVENT(KernelLaunchFinishEvent, apply_id, kernel_id, device);
787 788
    }
    // End profiling operator
789 790
    mgb_assert(outputs.size() == cmd.outputs.size());
    for (size_t i = 0; i < outputs.size(); ++i) {
791
        auto output = cmd.outputs[i];
792
        if (output == nullptr) {
793 794
            MGB_RECORD_EVENT(OpOutputEvent, 0);
            MGB_RECORD_EVENT(OpOutputFinishEvent, 0);
795
        } else if (output->ptr != nullptr) {
796 797
            MGB_RECORD_EVENT(OpOutputEvent, output->id);
            MGB_RECORD_EVENT(OpOutputFinishEvent, output->id);
798
        } else {
799
            MGB_RECORD_EVENT(OpOutputEvent, output->id);
800
            produce_tensor(output, outputs[i]);
801
            MGB_RECORD_EVENT(OpOutputFinishEvent, output->id);
802
            sample_on_device(output->desc.comp_node, false);
803 804 805 806 807 808 809 810
        }
    }

    if (state.options.enable_dtr_auto_drop) {
        double estimate_compute_time = 0;
        for (auto i : cmd.inputs) {
            estimate_compute_time += i->memory;
        }
811
        for (auto i : outputs) {
812
            estimate_compute_time += i->blob()->size();
813 814 815 816 817 818 819
        }
        m_dtr.estimate_timestamp += estimate_compute_time / 1e8;
        for (auto i : cmd.outputs) {
            if (i != nullptr) {
                i->compute_time = estimate_compute_time;
            }
        }
820
        m_dtr.unpin(cmd.inputs, state);
821
    }
822
    MGB_RECORD_EVENT(OpExecuteFinishEvent, apply_id, {}, reason);
823
    // End profiling operator
824
}
825

826 827
void ChannelImpl::flush_apply_stack() {
    m_applying = true;
828
    auto& state = get_worker_state();
829
    while (!m_apply_stack.empty()) {
M
Megvii Engine Team 已提交
830 831
        auto& [cmd, idx, recomp, reason] =
                m_apply_stack.top();  // cmd.inputs[0~idx-1] is in memory
832 833 834 835 836
        if (idx == 0) {
            if (state.options.enable_dtr_auto_drop) {
                m_dtr.pin(cmd.inputs);
            }
            if (recomp) {
M
Megvii Engine Team 已提交
837 838
                MGB_RECORD_EVENT(
                        TensorCommandEvent, recomp->id, TensorCommandKind::ReGen);
839 840 841
            }
        }
        bool regen = false;
M
Megvii Engine Team 已提交
842
        for (size_t i = idx; i < cmd.inputs.size(); i++) {
843 844 845 846 847 848
            auto&& p = cmd.inputs[i];
            if (state.options.enable_dtr_auto_drop) {
                m_dtr.update_used_time(p);
            }
            if (!p->ptr && p->evict_type != EvictType::NONE) {
                idx = i + 1;
M
Megvii Engine Team 已提交
849
                regenerate(p);  // add ApplyOp to the stack
850 851 852 853
                regen = true;
                break;
            }
        }
M
Megvii Engine Team 已提交
854 855
        if (regen)
            continue;
856
        // the required input tensors are already in memory
M
Megvii Engine Team 已提交
857 858
        auto [cmd_backup, recomp_backup, reason_backup] =
                std::make_tuple(cmd, recomp, reason);
859
        m_apply_stack.pop();
860
        do_apply_op(cmd_backup, reason_backup);
861
        if (recomp_backup) {
M
Megvii Engine Team 已提交
862 863 864
            MGB_RECORD_EVENT(
                    TensorCommandFinishEvent, recomp_backup->id,
                    TensorCommandKind::ReGen);
865 866
            for (auto o : cmd_backup.outputs) {
                if (o) {
867 868 869 870
                    m_dtr.update_dsu_after_recompute(o);
                }
            }
        }
871
    }
872
    m_applying = false;
873 874
}

875
bool ChannelImpl::auto_evict(size_t force_num) {
876
    auto& state = get_worker_state();
877
    if (!m_dtr.comp_node.valid()) {
878
        return false;
879 880
    }
    size_t current_memory = m_dtr.comp_node.get_used_memory();
881
    size_t flag = false;
M
Megvii Engine Team 已提交
882 883 884
    while ((state.options.dtr_eviction_threshold > 0 &&
            current_memory > state.options.dtr_eviction_threshold) ||
           force_num > 0) {
885
        MGB_RECORD_EVENT(AutoEvictEvent);
886
        sample_on_device(m_dtr.comp_node, false);
887
        auto best = m_dtr.find_best_tensor(state.options.enable_dtr_sqrt_sampling);
888
        if (!best) {
889
            MGB_RECORD_EVENT(AutoEvictFinishEvent);
890 891 892 893
            break;
        }
        if (best->ptr.unique() && best->ptr->blob().unique()) {
            current_memory -= best->memory;
894
            if (force_num > 0) {
M
Megvii Engine Team 已提交
895
                force_num--;
896 897
            }
            flag = true;
898 899 900 901
        }
        do_drop(best);
        if (best->evict_type == EvictType::DROP) {
            m_dtr.update_dsu_after_evict(best);
902
        }
903
        sample_on_device(m_dtr.comp_node, false);
904
        MGB_RECORD_EVENT(AutoEvictFinishEvent);
905
    }
906
    return flag;
907 908
}

909 910
void ChannelImpl::detach_users(TensorInfo* dest) {
    SmallVector<TensorInfo::ComputePath*> users = dest->users;
M
Megvii Engine Team 已提交
911
    for (auto* user : users) {
912 913
        SmallVector<TensorInfo*> outputs = user->outputs;
        SmallVector<TensorInfo*> inputs = user->inputs;
M
Megvii Engine Team 已提交
914 915 916 917 918
        for (auto* output : outputs) {
            // When a `ComputePath` is detach from it's input,
            // there is no need to reserve it,
            // so we detach all output of this path
            // to decrease it's `ref_cnt` to zero.
919 920 921 922 923
            if (output == nullptr) {
                continue;
            }
            regenerate(output);
            output->detach_producer();
M
Megvii Engine Team 已提交
924 925
            for (auto* input : inputs) {
                input->ref_cnt--;
926
            }
927
        }
928
        // now user is dead
929
    }
930
    mgb_assert(dest->users.empty(), "ComputePath leaking");
931 932
}

933 934 935 936
bool ChannelImpl::check_available() {
    return !m_closed;
}

937 938 939 940 941
TensorPtr ChannelImpl::wait_tensor(TensorInfo* info, TensorProp prop) {
    std::unique_lock<decltype(m_mutex)> lock(m_mutex);
    mgb_assert(!m_waitee, "duplicate waitee");
    m_waitee = info;
    m_waitee_id = Profiler::next_id();
942
    MGB_RECORD_EVENT(TensorWaitPropEvent, info->id, m_waitee_id, prop);
943
    bool require_host = prop == TensorProp::HostValue;
M
Megvii Engine Team 已提交
944
    auto host_available = [&] { return info->ptr && info->ptr->value_fetched(); };
945 946
    bool wait_host = false;
    if (require_host && !host_available()) {
947 948
        // avoid dead lock
        lock.unlock();
949 950 951
        m_worker.add_task(
                {Profiler::next_id(), GetValue{info},
                 get_channel_state().stack_manager.dump()});
952
        lock.lock();
953
        wait_host = true;
954
    }
955 956
    m_cv.wait(lock, [&]() {
        check_worker_exc_unsafe();
957
        return require_host ? host_available() : static_cast<bool>(info->ptr);
958
    });
959
    MGB_RECORD_EVENT(TensorWaitPropFinishEvent, info->id, m_waitee_id, prop);
960
    m_waitee = nullptr;
961
    if (wait_host) {
962 963 964
        auto err = info->ptr->comp_node().check_async_error();
        mgb_assert(!err, "%s", err->what());
    }
965 966 967 968 969
    return info->ptr;
}

void ChannelImpl::notify_tensor_unsafe(TensorInfo* info) {
    if (info == m_waitee) {
970
        MGB_RECORD_EVENT(TensorNotifyPropEvent, info->id);
971
        m_cv.notify_all();
972
    }
973 974 975 976
}

std::unordered_set<TensorInfo*> ChannelImpl::collect_valid_tensors() {
    std::unordered_set<TensorInfo*> valid_tensors;
M
Megvii Engine Team 已提交
977
    for (auto* handle : m_valid_handle) {
978 979
        auto* info = reinterpret_cast<TensorInfo*>(handle);
        valid_tensors.insert(info);
980
    }
981
    return valid_tensors;
982 983
}

984
void ChannelImpl::alloc_tensor_with_evict(Blob* x) {
985 986 987 988 989 990
    auto reserve_size = [&](size_t size) {
        if (!m_dtr.comp_node.valid()) {
            return false;
        }
        while (size > m_dtr.comp_node.get_max_block_size_available()) {
            bool evict_suc = auto_evict(1);
M
Megvii Engine Team 已提交
991 992
            if (!evict_suc)
                return false;
993 994 995 996
        }
        return true;
    };
    auto pre_level = set_log_level(LogLevel::NO_LOG);
997 998
    reserve_size(x->size());
    MGB_TRY { BlobManager::inst()->alloc_direct(x, x->size()); }
999 1000 1001 1002 1003 1004
    MGB_CATCH(MemAllocError&, {
        bool suc = false;
        while (!suc) {
            if (!auto_evict(1)) {
                break;
            }
1005
            MGB_TRY { BlobManager::inst()->alloc_direct(x, x->size()); }
1006 1007 1008 1009 1010
            MGB_CATCH(MemAllocError&, { continue; });
            suc = true;
        }
        if (!suc) {
            set_log_level(pre_level);
M
Megvii Engine Team 已提交
1011 1012 1013
            mgb_log_warn(
                    "reallocating all cuda memory to alleviate fragmentation, the "
                    "performance may be affected");
1014
            set_log_level(LogLevel::NO_LOG);
1015
            imperative_log_profile_begin("defrag");
1016
            BlobManager::inst()->defrag(x->comp_node());
1017
            imperative_log_profile_end("defrag");
1018
            BlobManager::inst()->alloc_direct(x, x->size());
1019 1020 1021 1022 1023
        }
    });
    set_log_level(pre_level);
}

1024
void ChannelImpl::process_one_task(Command& icmd) {
1025 1026
    using namespace ranges;
    using namespace ranges::views;
1027
    auto& state = get_worker_state();
1028
    auto& options = state.options;
M
Megvii Engine Team 已提交
1029
    // TODO: remove std::visit for support osx 10.12
1030
    auto cmd_visitor = [&](const auto& cmd) {
M
Megvii Engine Team 已提交
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
        using T = std::decay_t<decltype(cmd)>;
        if constexpr (std::is_same_v<T, Put>) {
            MGB_RECORD_EVENT(TensorCommandEvent, cmd.dest->id, TensorCommandKind::Put);
            MGB_RECORD_EVENT_IF(
                    (Profiler::get_option("profile_device", 0)), RecordDeviceEvent,
                    Timer::record_device(cmd.value.comp_node()));
            auto value = cmd.no_cache ? std::make_shared<Tensor>(cmd.value)
                                      : Tensor::make(cmd.value);
            MGB_RECORD_EVENT_IF(
                    (Profiler::get_option("profile_device", 0)), RecordDeviceEvent,
                    Timer::record_device(cmd.value.comp_node()));
            produce_tensor(cmd.dest, std::move(value));
            MGB_RECORD_EVENT(
                    TensorCommandFinishEvent, cmd.dest->id, TensorCommandKind::Put);
            sample_on_device(cmd.dest->desc.comp_node, false);
        } else if constexpr (std::is_same_v<T, ApplyOp>) {
            for (auto& i : cmd.inputs) {
                if (i->invalid) {
                    MGB_LOCK_GUARD(m_mutex);
                    for (auto& i : cmd.outputs) {
                        i->invalid = true;
1052
                    }
M
Megvii Engine Team 已提交
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
                    return;
                }
            }
            m_apply_stack.push({cmd, 0, nullptr, "cmd"});
            flush_apply_stack();
            for (size_t i = 0; i < cmd.outputs.size(); ++i) {
                auto output = cmd.outputs[i];
                if (output == nullptr) {
                    continue;
                }
                if (state.options.enable_dtr_auto_drop) {
                    output->dsu_ptr = std::make_shared<DsuNode>(output->compute_time);
1065
                }
M
Megvii Engine Team 已提交
1066 1067 1068 1069 1070 1071 1072
            }
            if (state.options.enable_drop && state.options.record_computing_path) {
                auto is_inplace = [](std::tuple<TensorInfo*, TensorInfo*> tuple2) {
                    auto& input = std::get<0>(tuple2);
                    auto& output = std::get<1>(tuple2);
                    if (!input->ptr || !output->ptr) {
                        return false;
1073
                    }
M
Megvii Engine Team 已提交
1074 1075 1076 1077 1078 1079 1080
                    return input->ptr->blob()->storage() ==
                           output->ptr->blob()->storage();
                };
                // FIXME: do not use opname as identifier
                auto get_name = [](const OpDef& opdef) {
                    if (auto attr = opdef.try_cast_final<OprAttr>()) {
                        return attr->type.c_str();
1081
                    }
M
Megvii Engine Team 已提交
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
                    return opdef.dyn_typeinfo()->name;
                };

                auto is_cross_cn = [comp_node = m_dtr.comp_node](TensorInfo* info) {
                    return info->desc.comp_node != comp_node;
                };

                bool cross_cn = any_of(concat(cmd.inputs, cmd.outputs), is_cross_cn);
                bool inplace =
                        any_of(cartesian_product(cmd.inputs, cmd.outputs), is_inplace);

                if (!inplace && !cross_cn && !m_dtr.is_bad_op(get_name(*cmd.op))) {
                    TensorInfo::ComputePath::make(
                            cmd.id, cmd.op, cmd.inputs, cmd.outputs);
                    size_t detach_cnt = 0;
                    if (!strcmp(get_name(*cmd.op), "BatchNorm") &&
                        cmd.outputs.size() == 5) {
                        cmd.outputs[0]->detach_producer();  // detach running_mean
                        cmd.outputs[1]->detach_producer();  // detach running_var
1101
                        for (auto input : cmd.inputs) {
M
Megvii Engine Team 已提交
1102
                            input->ref_cnt -= 2;
1103 1104
                        }
                    }
M
Megvii Engine Team 已提交
1105 1106 1107 1108 1109 1110 1111
                    for (auto output : cmd.outputs) {
                        if (output->producer &&
                            !output->size_exceeds_thd(
                                    state.options.dtr_evictee_minimum_size)) {
                            output->detach_producer();
                            detach_cnt++;
                        }
1112
                    }
M
Megvii Engine Team 已提交
1113 1114
                    for (auto input : cmd.inputs) {
                        input->ref_cnt -= detach_cnt;
1115
                    }
1116
                }
1117
            }
M
Megvii Engine Team 已提交
1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133
        } else if constexpr (std::is_same_v<T, Del>) {
            MGB_RECORD_EVENT(TensorCommandEvent, cmd.dest->id, TensorCommandKind::Del);
            CompNode device = cmd.dest->desc.comp_node;
            uint64_t tensor_id = cmd.dest->id;
            free(cmd.dest);
            MGB_RECORD_EVENT(
                    TensorCommandFinishEvent, tensor_id, TensorCommandKind::Del);
            sample_on_device(device, false);
        } else if constexpr (std::is_same_v<T, GetValue>) {
            if (cmd.dest->invalid)
                return;
            imperative_log_profile_begin("GetValue");
            if (!cmd.dest->ptr && cmd.dest->evict_type != EvictType::NONE) {
                regenerate(cmd.dest);
            }
            cmd.dest->ptr->fetch_value();
1134
            MGB_LOCK_GUARD(m_mutex);
M
Megvii Engine Team 已提交
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151
            notify_tensor_unsafe(cmd.dest);
            imperative_log_profile_end("GetValue");
        } else if constexpr (std::is_same_v<T, Drop>) {
            if (cmd.dest->invalid)
                return;
            MGB_RECORD_EVENT(TensorCommandEvent, cmd.dest->id, TensorCommandKind::Drop);
            do_drop(cmd.dest, true);
            MGB_RECORD_EVENT(
                    TensorCommandFinishEvent, cmd.dest->id, TensorCommandKind::Drop);
        } else if constexpr (std::is_same_v<T, SetOption>) {
            options.set_option(cmd.key, cmd.value);
        } else if constexpr (std::is_same_v<T, StartProfile>) {
            MGB_RECORD_EVENT(StartProfileEvent);
            CompNode::sync_all();
            for (auto* info : cmd.capture_tensors) {
                MGB_RECORD_EVENT(TensorDeclareEvent, info->id, info->name);
                if (info->status == TensorInfo::Produced) {
1152
                    // TODO: handle drop
M
Megvii Engine Team 已提交
1153 1154 1155
                    MGB_RECORD_EVENT(
                            TensorProduceEvent, info->id, info->desc.layout,
                            info->desc.comp_node, info->ptr->dev_tensor().raw_ptr());
1156 1157
                }
            }
M
Megvii Engine Team 已提交
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172
            CompNode::foreach ([&](CompNode device) {
                sample_on_device(device, true);
                MGB_RECORD_EVENT_IF(
                        (Profiler::get_option("profile_device", 0)), RecordDeviceEvent,
                        Timer::record_device(device));
            });
            MGB_RECORD_EVENT(StartProfileFinishEvent);
        } else if constexpr (std::is_same_v<T, StopProfile>) {
            MGB_RECORD_EVENT(StopProfileEvent);
            for (auto* info : cmd.escape_tensors) {
                bool has_value = info->status == TensorInfo::Produced;
                if (has_value) {
                    MGB_RECORD_EVENT(TensorReleaseEvent, info->id);
                }
                MGB_RECORD_EVENT(TensorEraseEvent, info->id);
1173
            }
M
Megvii Engine Team 已提交
1174 1175 1176 1177 1178 1179 1180 1181 1182
            CompNode::foreach (
                    [&](CompNode device) { sample_on_device(device, true); });
            MGB_RECORD_EVENT(StopProfileFinishEvent);
        } else if constexpr (std::is_same_v<T, PushScope>) {
            MGB_RECORD_EVENT(ScopeEvent, cmd.scope_name);
        } else if constexpr (std::is_same_v<T, PopScope>) {
            MGB_RECORD_EVENT(ScopeFinishEvent, cmd.scope_name);
        } else {
            static_assert(!std::is_same_v<T, T>);
1183
        }
M
Megvii Engine Team 已提交
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
    };
    std::visit(
            [&](const auto& cmd) {
                using T = std::decay_t<decltype(cmd)>;
                if (!options.catch_worker_execption) {
                    cmd_visitor(cmd);
                    return;
                }
                try {
                    cmd_visitor(cmd);
                } catch (...) {
                    MGB_LOCK_GUARD(m_mutex);
                    if constexpr (std::is_same_v<T, ApplyOp>) {
                        for (auto oup : cmd.outputs) {
                            oup->invalid = true;
                        }
                    } else if constexpr (std::is_same_v<T, Put>) {
                        cmd.dest->invalid = true;
                    }
                    m_worker_exc = std::current_exception();
                    MGB_RECORD_EVENT(WorkerExceptionEvent);
                    if (m_waitee) {
                        notify_tensor_unsafe(m_waitee);
                    }
                }
            },
            icmd.data);
1211 1212 1213 1214
}

void ChannelImpl::check_worker_exc_unsafe() {
    if (m_worker_exc) {
1215 1216
        // for reuse interpreter_for_py after some exception tests
        m_waitee = nullptr;
1217 1218
        std::exception_ptr exc;
        std::swap(exc, m_worker_exc);
1219 1220 1221 1222 1223
        try {
            std::rethrow_exception(exc);
        } catch (...) {
            throw AsyncError();
        }
1224 1225
    }
}
1226

1227
void ChannelImpl::start_profile() {
1228
    MGB_LOCK_GUARD(m_spin);
1229
    mgb_assert(check_available(), "Channel already closed");
1230 1231
    auto capture_tensors = collect_valid_tensors();
    if (capture_tensors.size() > 0) {
1232 1233 1234
        m_worker.add_task(
                {Profiler::next_id(), StartProfile{std::move(capture_tensors)},
                 get_channel_state().stack_manager.dump()});
1235
    }
1236 1237
}

1238
void ChannelImpl::stop_profile() {
1239
    MGB_LOCK_GUARD(m_spin);
1240
    mgb_assert(check_available(), "Channel already closed");
1241 1242
    auto escape_tensors = collect_valid_tensors();
    if (escape_tensors.size() > 0) {
1243 1244 1245
        m_worker.add_task(
                {Profiler::next_id(), StopProfile{std::move(escape_tensors)},
                 get_channel_state().stack_manager.dump()});
1246
    }
1247 1248 1249
}

void ChannelImpl::push_scope(std::string name) {
1250
    MGB_LOCK_GUARD(m_spin);
1251
    mgb_assert(check_available(), "Channel already closed");
1252
    auto& state = get_channel_state();
1253
    state.stack_manager.enter(name);
1254
    MGB_RECORD_EVENT(ScopeEvent, name);
1255 1256 1257
    m_worker.add_task(
            {Profiler::next_id(), PushScope{name},
             get_channel_state().stack_manager.dump()});
1258 1259 1260
}

void ChannelImpl::pop_scope(std::string name) {
1261
    MGB_LOCK_GUARD(m_spin);
1262
    mgb_assert(check_available(), "Channel already closed");
1263
    auto& state = get_channel_state();
1264
    state.stack_manager.exit(name);
1265
    MGB_RECORD_EVENT(ScopeFinishEvent, name);
1266 1267 1268
    m_worker.add_task(
            {Profiler::next_id(), PopScope{name},
             get_channel_state().stack_manager.dump()});
1269 1270
}

1271
void ChannelImpl::assert_in_channel() {
M
Megvii Engine Team 已提交
1272 1273 1274
    mgb_assert(
            get_worker_tid() != std::this_thread::get_id(),
            "this method cannot be called in worker thread");
1275 1276 1277
}

void ChannelImpl::assert_in_worker() {
M
Megvii Engine Team 已提交
1278 1279 1280
    mgb_assert(
            get_worker_tid() == std::this_thread::get_id(),
            "this method can only be called in worker thread");
1281 1282
}

1283 1284 1285
void ChannelImpl::sample_on_device(CompNode device, bool force) {
    if (!force) {
        thread_local int last_sample_id = 0;
M
Megvii Engine Team 已提交
1286 1287
        int sample_rate =
                Profiler::is_profiling() ? Profiler::get_option("sample_rate", 0) : 0;
1288 1289 1290 1291
        if (!sample_rate || ((++last_sample_id) % sample_rate != 0)) {
            return;
        }
    }
1292
    MGB_RECORD_EVENT(SampleDeviceEvent, device);
1293
    auto [total, free] = device.get_mem_status_bytes();
1294
    MGB_RECORD_EVENT(SampleDeviceFinishEvent, device, total, free);
1295 1296
}

1297 1298 1299
void ChannelImpl::DynamicSublinear::pin(const SmallVector<TensorInfo*>& vec) {
    for (auto i : vec) {
        i->pin();
1300
        erase_candidate(i);
1301 1302 1303
    }
}

1304 1305
void ChannelImpl::DynamicSublinear::unpin(
        const SmallVector<TensorInfo*>& vec, WorkerState& state) {
1306 1307
    for (auto i : vec) {
        i->unpin();
1308 1309 1310 1311 1312
        if (i->pinned == 0 &&
            i->size_exceeds_thd(state.options.dtr_evictee_minimum_size) &&
            i->cand_index == UINT_MAX) {
            insert_candidate(i);
        }
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
    }
}

void ChannelImpl::DynamicSublinear::update_dsu_after_recompute(TensorInfo* ptr) {
    auto&& dsu_fa = find_father(ptr->dsu_ptr);
    dsu_fa->t -= ptr->compute_time;
    ptr->dsu_ptr->parent.reset();
    ptr->dsu_ptr->t = ptr->compute_time;
}

void ChannelImpl::DynamicSublinear::update_dsu_after_evict(TensorInfo* ptr) {
    for (auto i : ptr->producer->inputs) {
        if (i->evict_type == EvictType::DROP) {
            merge(i->dsu_ptr, ptr->dsu_ptr);
        }
    }
    for (auto i : ptr->producer->outputs) {
        if (i && i->evict_type == EvictType::DROP) {
            merge(ptr->dsu_ptr, i->dsu_ptr);
        }
    }
}

double ChannelImpl::DynamicSublinear::estimate_neighbor_cost(TensorInfo* ptr) {
    double cost = 0;
    for (auto i : ptr->producer->inputs) {
        if (i->evict_type == EvictType::DROP) {
            double t = find_father(i->dsu_ptr)->t;
            if (t < i->compute_time) {
                t = i->compute_time;
            }
            cost += t;
        }
    }
    for (auto i : ptr->producer->outputs) {
        if (i && i->evict_type == EvictType::DROP) {
            double t = find_father(i->dsu_ptr)->t;
            if (t < i->compute_time) {
                t = i->compute_time;
            }
            cost += t;
        }
    }
    return cost;
}

M
Megvii Engine Team 已提交
1359 1360
TensorInfo* ChannelImpl::DynamicSublinear::find_best_tensor(
        bool enable_dtr_sqrt_sampling = false) {
1361 1362 1363
    if (candidates.empty())
        return nullptr;

1364 1365
    double min_msps = -1;
    TensorInfo* best = nullptr;
1366 1367
    size_t sz = 1;
    if (enable_dtr_sqrt_sampling) {
M
Megvii Engine Team 已提交
1368 1369
        while (sz * sz <= candidates.size())
            sz++;
1370
        sz--;
1371 1372 1373
    } else {
        sz = candidates.size();
    }
1374 1375 1376 1377 1378 1379 1380

    size_t ti = rand() % sz;
    for (size_t vi = 0; vi < sz; vi++) {
        if (!enable_dtr_sqrt_sampling) {
            ti = vi;
        }
        auto i = candidates[ti];
1381
        if (i->producer && i->ptr && i->evict_type == EvictType::NONE) {
1382
            double neighbor_cost = estimate_neighbor_cost(i);
M
Megvii Engine Team 已提交
1383 1384 1385 1386
            size_t begin_ptr =
                    reinterpret_cast<size_t>(i->ptr->blob()->storage().get());
            auto side_info = i->ptr->comp_node().get_free_left_and_right(
                    begin_ptr, begin_ptr + i->ptr->blob()->size());
1387
            double free_mem = side_info.first + side_info.second;
M
Megvii Engine Team 已提交
1388 1389
            double msps = i->eval_func(
                    neighbor_cost, free_mem, estimate_timestamp, 1.0, 1.0, 1.0, 1.0001);
1390 1391 1392 1393 1394
            if (min_msps < 0 || msps < min_msps) {
                min_msps = msps;
                best = i;
            }
        }
1395 1396 1397 1398 1399
        if (enable_dtr_sqrt_sampling) {
            ti += rand() % sz;
            if (ti > candidates.size())
                break;
        }
1400 1401 1402 1403
    }
    return best;
}

M
Megvii Engine Team 已提交
1404 1405
void ChannelImpl::DynamicSublinear::merge(
        std::shared_ptr<DsuNode>& x, std::shared_ptr<DsuNode>& y) {
1406 1407 1408 1409 1410 1411 1412 1413 1414
    auto&& f_x = find_father(x);
    auto&& f_y = find_father(y);
    if (f_x.get() == f_y.get()) {
        return;
    }
    f_y->t += f_x->t;
    f_x->parent = f_y;
}

M
Megvii Engine Team 已提交
1415 1416
std::shared_ptr<DsuNode> ChannelImpl::DynamicSublinear::find_father(
        std::shared_ptr<DsuNode>& x) {
1417 1418 1419 1420 1421 1422 1423 1424 1425
    if (x->is_root()) {
        return x;
    } else {
        auto&& fa = find_father(x->parent);
        return x->parent = fa;
    }
}

void ChannelImpl::DynamicSublinear::insert_candidate(TensorInfo* ptr) {
1426 1427 1428 1429 1430 1431
    // tensor to be inserted must be brand new
    mgb_assert(
            ptr->cand_index == UINT_MAX, "got wrong candidate index : %lu",
            ptr->cand_index);
    ptr->cand_index = candidates.size();
    candidates.push_back(ptr);
1432 1433 1434 1435 1436 1437
    if (!comp_node.valid()) {
        comp_node = ptr->ptr->comp_node();
    }
}

void ChannelImpl::DynamicSublinear::erase_candidate(TensorInfo* ptr) {
1438 1439 1440 1441 1442 1443
    // close dtr will just clear candidates, so nothing to erase
    if (candidates.empty()) {
        ptr->cand_index = UINT_MAX;
        return;
    }
    // some tensors may be erased already, just skip them
1444 1445 1446 1447 1448 1449
    if (ptr->cand_index != UINT_MAX) {
        std::swap(candidates[ptr->cand_index], candidates.back());
        candidates[ptr->cand_index]->cand_index = ptr->cand_index;
        candidates.pop_back();
        ptr->cand_index = UINT_MAX;
    }
1450 1451 1452 1453 1454
}

void ChannelImpl::DynamicSublinear::update_used_time(TensorInfo* ptr) {
    ptr->last_used_time = estimate_timestamp;
}