tracing.py 39.9 KB
Newer Older
1 2 3 4 5 6 7 8
# -*- coding: utf-8 -*-
# MegEngine is Licensed under the Apache License, Version 2.0 (the "License")
#
# Copyright (c) 2014-2020 Megvii Inc. All rights reserved.
#
# 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.
M
Megvii Engine Team 已提交
9
import collections
M
Megvii Engine Team 已提交
10 11
import contextlib
import functools
M
Megvii Engine Team 已提交
12
import itertools
13
import json
14
import os
M
Megvii Engine Team 已提交
15
import typing
M
Megvii Engine Team 已提交
16
import warnings
M
Megvii Engine Team 已提交
17 18
import weakref

M
Megvii Engine Team 已提交
19 20
import numpy as np

21
from ..core._imperative_rt import GraphProfiler, common
22
from ..core._imperative_rt.core2 import Tensor as RawTensor
23 24
from ..core._imperative_rt.core2 import TensorWeakRef
from ..core._imperative_rt.core2 import __make_empty_tensor as make_empty_tensor
25 26 27 28 29 30 31 32 33 34
from ..core._imperative_rt.core2 import (
    apply,
    set_compiled,
    set_symbolic,
    set_tracing,
    skip_tracing,
    unset_compiled,
    unset_symbolic,
    unset_tracing,
)
35 36
from ..core._imperative_rt.ops import (
    CollectiveComm,
37
    GaussianRNG,
38 39
    RemoteRecv,
    RemoteSend,
40
    UniformRNG,
41
)
42
from ..core._trace_option import set_symbolic_shape
43
from ..core._wrap import device as as_device
44
from ..core.ops.builtin import BackwardGraph, OpDef
M
Megvii Engine Team 已提交
45 46
from ..core.ops.special import Const
from ..core.tensor import megbrain_graph as G
47
from .sublinear_memory_config import SublinearMemoryConfig
M
Megvii Engine Team 已提交
48 49


50 51 52 53
def _input_node_use_static_shape():
    return os.environ.get("MEGENGINE_INPUT_NODE_USE_STATIC_SHAPE") is not None


M
Megvii Engine Team 已提交
54 55 56 57 58 59 60
class TraceMismatchError(RuntimeError):
    pass


active_trace = None


61 62 63 64 65 66 67
def is_tracing():
    if active_trace is None:
        return False
    else:
        return not skip_tracing


M
Megvii Engine Team 已提交
68 69 70 71 72 73 74 75
@contextlib.contextmanager
def exclude_from_trace():
    global skip_tracing
    if skip_tracing:
        yield
        return
    try:
        skip_tracing = True
76
        unset_tracing()
M
Megvii Engine Team 已提交
77 78 79 80 81
        if active_trace is not None:
            active_trace._begin_excluded_region()
        yield
    finally:
        skip_tracing = False
82
        set_tracing()
M
Megvii Engine Team 已提交
83 84 85 86 87 88


class TensorInfo:
    __slots__ = (
        # collected attributes
        "external",
89 90 91
        "data_read",
        "shape_read",
        "value_read",
M
Megvii Engine Team 已提交
92 93 94
        "exported",
        "device",
        "dtype",
95
        "shape",
96
        "is_const",
M
Megvii Engine Team 已提交
97 98 99 100 101 102 103 104 105 106 107
        "bound_data",
        # resources for execution
        "varnode",
        "data_setter",
        "shape_reader",
        "value_reader",
        "data_reader",
    )

    def __init__(self):
        self.exported = None
108 109 110
        self.data_read = None
        self.shape_read = None
        self.value_read = None
M
Megvii Engine Team 已提交
111 112 113 114 115 116 117 118
        self.bound_data = None

        self.data_setter = None
        self.shape_reader = None
        self.value_reader = None
        self.data_reader = None


119 120 121
_io_op_types = {CollectiveComm, RemoteSend, RemoteRecv}


M
Megvii Engine Team 已提交
122
class trace:
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
    """
    Wraps a callable and provide:

    * tracing via :meth:`.trace` and :meth:`.dump`
    * accelerated evalutaion via :meth:`.__call__`

    :param function: the function will be traced.
    :param symbolic: whether to apply symbolic execution for tracing. Default: False
    :param capture_as_const: capture global vars or closures as const value. Default: False
    :param sublinear_memory_config: configuration for sublinear memory optimization.
        If not None, it enables sublinear memory optimization with given setting.
    :param profiling: whether to profile compiled trace. Default: False
    :param opt_level: optimization level for compiling trace.
    :param symbolic_shape: whether to use symbolic shape for tracing. Default: True
    """

M
Megvii Engine Team 已提交
139 140 141
    def __new__(cls, *args, **kwargs):
        if not args:
            return functools.partial(cls, **kwargs)
142
        return super().__new__(cls)
M
Megvii Engine Team 已提交
143

144 145 146 147 148 149
    def __init__(
        self,
        function,
        symbolic=False,
        capture_as_const=False,
        sublinear_memory_config: SublinearMemoryConfig = None,
150
        profiling: bool = False,
151
        opt_level: int = None,
152
        symbolic_shape: bool = True,
153
    ):
M
Megvii Engine Team 已提交
154 155 156
        self.__wrapped__ = function
        self._symbolic = symbolic
        self._capture_as_const = capture_as_const
157
        self._sublinear_memory_config = sublinear_memory_config
158 159
        self._profiling = profiling
        self._profiler = None
160
        self._graph_opt_level = opt_level
161
        self._symbolic_shape = symbolic_shape
162
        self._handle2tensors = {}
163
        self._output_handles = set()
M
Megvii Engine Team 已提交
164

165 166 167
        self._reset()

    def _reset(self):
M
Megvii Engine Team 已提交
168 169 170 171 172 173 174
        self._untraced = True
        self._tinfo = []  # handle -> TensorInfo
        self._seq = []
        self._pc = 0
        self._graph = None
        self._need_reset_nodes = None
        self._lazy_eval_graph = None
175
        self._lazy_eval_tensors = set()
176
        self._lazy_eval_links = None
177
        self._active_tensors = set()
M
Megvii Engine Team 已提交
178 179
        self._tensor_remaps = None
        self._inputs_to_restore = None
180 181
        self._arg_bindings = None
        self._kwarg_bindings = None
M
Megvii Engine Team 已提交
182 183
        self._output_bindings = None
        self._output_names = None
M
Megvii Engine Team 已提交
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198

    def _new_handle(self):
        handle = len(self._tinfo)
        info = TensorInfo()
        self._tinfo.append(info)
        return handle, info

    def _apply_op(self, op, args):
        assert not self._untraced
        # check against trace
        if self._pc >= len(self._seq):
            raise TraceMismatchError("trace should end here, but more op observed")
        record = self._seq[self._pc]
        op_, ihandles, ohandles = record
        if op != op_:
199
            raise TraceMismatchError("op different from last time")
M
Megvii Engine Team 已提交
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
        if len(ihandles) != len(args):
            raise TraceMismatchError("op input size different from last time")

        for h, x in zip(ihandles, args):
            info = self._tinfo[h]
            if info.external:
                if (
                    x.__class__ is CompiledTensorProxy
                    and not self._tinfo[x._CompiledTensorProxy__handle].exported
                ):
                    raise TraceMismatchError(
                        "failed to capture: input was an external tensor "
                        "last time, got an internal tensor this time"
                    )
                if info.bound_data:
                    if x.__class__ is CompiledTensorProxy:
                        raise TraceMismatchError(
                            "const capture violated: was an external tensor "
                            "last time, got an internal tensor this time"
                        )
                    if x._handle != info.bound_data._handle:
221
                        if not np.array_equal(x.numpy(), info.bound_data.numpy()):
M
Megvii Engine Team 已提交
222 223 224 225
                            raise TraceMismatchError(
                                "const capture violated: got "
                                "a different tensor this time"
                            )
M
Megvii Engine Team 已提交
226 227 228 229 230 231 232 233 234 235 236
                else:
                    if info.dtype != x.dtype:
                        raise TraceMismatchError(
                            "failed to capture: different dtype from last time"
                        )
                    if info.device != x.device:
                        raise TraceMismatchError(
                            "failed to capture: different device from last time"
                        )
                    info.data_setter.set_value(x._dev_tensor())
            else:
237 238 239 240 241 242 243 244 245 246 247 248 249 250
                pass
                # if x.__class__ is not CompiledTensorProxy:
                #     if x not in self._tensor_remaps:
                #         raise TraceMismatchError(
                #             "unexpected capture: trying to use an external tensor as "
                #             "input, but that input was an internal tensor last time"
                #         )
                #     else:
                #         x = self._tensor_remaps[x]
                # if x._CompiledTensorProxy__handle != h:
                #     raise TraceMismatchError(
                #         "mis-wiring: input edge to an data flow "
                #         "graph node is different from last time"
                #     )
M
Megvii Engine Team 已提交
251 252

        self._pc += 1
253
        outputs = []
254 255 256
        for h in ohandles:
            t = CompiledTensorProxy(h)
            t._dev_tensor()
257 258
            outputs += [t._CompiledTensorProxy__tensor]
        self._output_handles.update(ohandles)
259
        self._active_tensors.update([TensorWeakRef(o) for o in outputs])
M
Megvii Engine Team 已提交
260 261
        return outputs

262
    def _apply_const(self, value, dtype, device):
263 264 265 266 267 268
        assert not self._untraced
        # check against trace
        if self._pc >= len(self._seq):
            raise TraceMismatchError("trace should end here, but more op observed")
        record = self._seq[self._pc]
        op_, ihandles, ohandles = record
269 270 271 272 273 274 275 276 277 278
        assert isinstance(op_, str) and op_ == "Const"

        # TODO : assert on const value
        # eq = value == self._tinfo[ohandles[0]].bound_data.numpy()
        # if not isinstance(eq, bool):
        #     eq = all(eq)
        # if not eq:
        #     raise TraceMismatchError(
        #         "const tensor violated: got a different tensor this time"
        #     )
279 280 281

        self._pc += 1
        (h,) = ohandles
282
        outputs = [self._tinfo[h].bound_data]
283 284
        return outputs

M
Megvii Engine Team 已提交
285 286 287
    def _record_op(self, op, inputs, outputs):
        if skip_tracing:
            for x in inputs:
288 289 290
                h = getattr(x, "mixin_handle", -1)
                if h >= 0:
                    x.data_read = True
M
Megvii Engine Team 已提交
291 292 293 294
            return

        ihandles = []
        for x in inputs:
295 296
            h = getattr(x, "mixin_handle", -1)
            if h < 0 or (not self._capture_as_const and self._tinfo[h].exported):
M
Megvii Engine Team 已提交
297 298 299 300
                h, info = self._new_handle()
                info.external = True
                info.device = x.device
                info.dtype = x.dtype
301
                info.shape = x.shape
M
Megvii Engine Team 已提交
302
                if self._capture_as_const:
303
                    info.bound_data = RawTensor(x.numpy(), x.dtype, x.device, False)
M
Megvii Engine Team 已提交
304 305 306 307 308 309 310 311

            ihandles.append(h)

        ohandles = []
        for x in outputs:
            h, info = self._new_handle()
            ohandles.append(h)
            info.external = False
312 313
            x.mixin_handle = h
            self._handle2tensors[h] = x
M
Megvii Engine Team 已提交
314 315

        self._seq.append((op, tuple(ihandles), tuple(ohandles)))
316
        self._active_tensors.update([TensorWeakRef(o) for o in outputs])
M
Megvii Engine Team 已提交
317

318
    def _record_const(self, outputs):
319 320
        if skip_tracing:
            (x,) = outputs
321 322 323
            h = getattr(x, "mixin_handle", -1)
            if h >= 0:
                x.data_read = True
324 325 326 327 328 329 330 331 332 333 334
            return

        (x,) = outputs
        h, info = self._new_handle()
        ohandles = [h]
        info.external = True
        info.device = x.device
        info.dtype = x.dtype
        info.shape = x.shape
        info.bound_data = x
        info.is_const = True
335 336 337
        x.mixin_handle = h
        self._handle2tensors[h] = x
        self._seq.append(("Const", tuple(), tuple(ohandles)))
338

339
    def _set_active(self, active: bool):
M
Megvii Engine Team 已提交
340
        global active_trace
341 342 343 344
        if active:
            if active_trace:
                raise NotImplementedError("sorry, not implemented: nested trace")
            active_trace = self
M
Megvii Engine Team 已提交
345
        else:
346 347 348 349 350
            assert active_trace is self
            active_trace = None

    def _init_trace(self, symbolic: bool):
        if symbolic:
351
            set_symbolic()
352
            self._lazy_eval_graph = G.Graph()
353
            self._apply_graph_options(self._lazy_eval_graph)
354
            self._lazy_eval_links = ()
355 356

    def _take_escaped_tensors(self):
357
        escaped_tensors = tuple(filter(lambda x: x() is not None, self._active_tensors))
M
Megvii Engine Team 已提交
358
        self._active_tensors.clear()
359 360
        return escaped_tensors

361
    def _lazy_eval(self, lazy_eval_graph, lazy_eval_tensors, lazy_eval_links):
362
        lazy_eval_tensors = list(filter(lambda x: x() is not None, lazy_eval_tensors))
363
        readers = [G.OutputNode(x()._varnode).outputs[0] for x in lazy_eval_tensors]
364
        self._apply_graph_options(lazy_eval_graph)
365 366 367 368 369
        # FIXME
        if self._graph_opt_level is not None:
            lazy_eval_graph.options.graph_opt_level = self._graph_opt_level
        else:
            lazy_eval_graph.options.graph_opt_level = 2
370
        lazy_eval_graph.set_priority_to_id([*lazy_eval_links, *readers])
371
        lazy_eval_graph.compile(*lazy_eval_links, *readers)
372
        lazy_eval_graph()
373
        for r, x in zip(readers, lazy_eval_tensors):
374
            x()._handle = RawTensor(r.op.get_value())._handle
375
            x()._reset_varnode()
376 377 378 379

    @contextlib.contextmanager
    def _setup(self):
        interrupted = False
M
Megvii Engine Team 已提交
380

381
        def do_enter():
382
            set_tracing()
383
            self._save_symbolic_shape = set_symbolic_shape(self._symbolic_shape)
384 385 386 387
            self._set_active(True)
            if self._untraced:
                self._init_trace(self._symbolic)
            else:
388 389 390
                # disable symbolic mode
                unset_symbolic()
                set_compiled()
391 392 393 394 395 396 397 398
                if self._graph is None:
                    self._compile()
                self._graph.execute()

        def do_finalize():
            escaped_tensors = self._take_escaped_tensors()
            if self._untraced:
                for x in escaped_tensors:
399 400 401
                    info = self._tinfo[x().mixin_handle]
                    x().data_read = True
                    x().mixin_handle = -1
402 403
                if self._inputs_to_restore:
                    for x in self._inputs_to_restore:
404
                        x.mixin_handle = -1
405 406 407 408 409 410
                for h, x in list(self._handle2tensors.items()):
                    info = self._tinfo[h]
                    info.data_read = x.data_read
                    info.shape_read = x.shape_read
                    info.value_read = x.value_read
                    del self._handle2tensors[h]
411 412 413
                if self._symbolic and (
                    self._lazy_eval_tensors or self._lazy_eval_links
                ):
414
                    # eval lazy eval tensors
415 416 417 418 419
                    self._lazy_eval(
                        self._lazy_eval_graph,
                        tuple(self._lazy_eval_tensors),
                        self._lazy_eval_links,
                    )
M
Megvii Engine Team 已提交
420 421
                    self._lazy_eval_graph = None
                    self._lazy_eval_tensors = None
422
                    self._lazy_eval_links = None
423 424 425 426 427 428
                self._untraced = False
            else:
                # compiled_tensor leaks
                if self._pc == len(self._seq):
                    for x in escaped_tensors:
                        try:
429
                            assign_raw_tensor(x(), RawTensor(x()._dev_tensor()))
430 431 432 433 434 435 436
                        except TraceMismatchError:
                            # TraceMismatchError thrown in do_exit
                            pass
                    self._graph.wait()
                    self._reset_exec_env()

            # reset status
M
Megvii Engine Team 已提交
437
            self._pc = 0
438 439
            self._tensor_remaps = None
            self._set_active(False)
440
            set_symbolic_shape(self._save_symbolic_shape)
441 442 443
            unset_compiled()
            unset_symbolic()
            unset_tracing()
444 445

        def do_exit():
446
            unset_tracing()
447 448 449 450
            if not self._untraced and self._pc != len(self._seq):
                raise TraceMismatchError("premature end")
            if not self._symbolic or not self._untraced:
                for x in self._active_tensors:
451 452 453
                    if x() is not None:
                        x()._dev_tensor()
                        x().mixin_handle = -1
454 455 456 457 458 459 460 461 462 463 464 465

        try:
            do_enter()
            yield
            do_exit()
        except:
            interrupted = True
            raise
        finally:
            do_finalize()
            if interrupted:
                self._reset()
M
Megvii Engine Team 已提交
466 467

    def _begin_excluded_region(self):
M
Megvii Engine Team 已提交
468 469 470 471
        if self._capture_as_const:
            raise RuntimeError(
                "exclude_from_trace cannot be used with capture_as_const"
            )
M
Megvii Engine Team 已提交
472 473 474 475
        if self._untraced:
            # conditionally reading a compiled tensor in excluded region
            # is permitted, so we have to assume every tensor might be read
            for x in self._active_tensors:
476
                info = self._tinfo[x().mixin_handle]
M
Megvii Engine Team 已提交
477
                info.exported = True
478
                x().data_read = True
M
Megvii Engine Team 已提交
479

480 481
    def _apply_graph_options(self, graph):

482
        graph.options.no_force_inplace = True
483
        graph.options.seq_opt.enable_seq_comp_node_opt = False
484
        # graph opt level
485 486 487 488
        # if self._graph_opt_level is not None:
        #     graph.options.graph_opt_level = self._graph_opt_level
        # FIXME
        graph.options.graph_opt_level = 0
489 490 491 492 493 494 495 496 497 498 499 500 501
        # sublinear
        if self._sublinear_memory_config is not None:
            graph.options.enable_sublinear_memory_opt = True
            sublinear_config = graph.options.sublinear_mem_config
            sublinear_config.lb_memory = self._sublinear_memory_config.lb_memory
            sublinear_config.genetic_nr_iter = (
                self._sublinear_memory_config.genetic_nr_iter
            )
            sublinear_config.genetic_pool_size = (
                self._sublinear_memory_config.genetic_pool_size
            )
            sublinear_config.thresh_nr_try = self._sublinear_memory_config.thresh_nr_try
            sublinear_config.num_worker = self._sublinear_memory_config.num_worker
502
        # profile
503 504
        if self._profiling:
            self._profiler = GraphProfiler(graph)
505

M
Megvii Engine Team 已提交
506 507
    def _compile(self):
        graph = self._graph = G.Graph()
508
        graph.options.async_exec_level = 0b100
509
        self._apply_graph_options(graph)
M
Megvii Engine Team 已提交
510 511 512
        # graph.options.graph_opt_level = 0
        need_reset_nodes = self._need_reset_nodes = []
        # links enforce ordering of I/O nodes
513 514
        in_out_links = ()
        io_links = ()
515
        readers = []
M
Megvii Engine Team 已提交
516 517

        if self._capture_as_const:
518
            for h in itertools.chain(self._arg_bindings, self._kwarg_bindings.values()):
M
Megvii Engine Team 已提交
519 520
                info = self._tinfo[h]
                opnode = info.data_setter = G.InputNode(
521 522
                    device=info.device,
                    dtype=info.dtype,
523
                    shape=info.shape or (1,),
524 525
                    graph=graph,
                    use_static_shape=_input_node_use_static_shape(),
M
Megvii Engine Team 已提交
526 527 528
                )
                need_reset_nodes.append(opnode)
                info.varnode = opnode.outputs[0]
529
                in_out_links += opnode.outputs[1:]
M
Megvii Engine Team 已提交
530

M
Megvii Engine Team 已提交
531
        for op, ihandles, ohandles in self._seq:
532
            if isinstance(op, str) and op == "Const":
533 534 535 536 537 538 539 540 541 542 543 544
                assert len(ihandles) == 0
                (h,) = ohandles
                info = self._tinfo[h]
                if not hasattr(info, "varnode"):
                    assert info.external
                    assert info.bound_data
                    info.varnode = graph.make_const(
                        info.bound_data.numpy(),
                        info.bound_data.dtype,
                        info.bound_data.device,
                    )
                continue
545

546
            require_links = type(op) in _io_op_types
M
Megvii Engine Team 已提交
547
            ivars = []
548
            for i, h in enumerate(ihandles):
M
Megvii Engine Team 已提交
549 550 551 552
                info = self._tinfo[h]
                if not hasattr(info, "varnode"):
                    assert info.external
                    if info.bound_data:
553 554 555 556 557 558 559 560 561 562 563
                        if hasattr(info, "is_const") and info.is_const:
                            info.varnode = graph.make_const(
                                info.bound_data.numpy(),
                                info.bound_data.dtype,
                                info.bound_data.device,
                            )
                        else:
                            info.varnode = graph.make_const(
                                info.bound_data._dev_tensor()
                                # info.bound_data.numpy()
                            )
M
Megvii Engine Team 已提交
564 565
                    else:
                        opnode = info.data_setter = G.InputNode(
566
                            *in_out_links,
567 568
                            device=info.device,
                            dtype=info.dtype,
569
                            shape=info.shape or (1,),
570
                            graph=graph,
571
                            use_static_shape=_input_node_use_static_shape(),
M
Megvii Engine Team 已提交
572 573
                        )
                        need_reset_nodes.append(opnode)
574 575
                        info.varnode, *in_out_links = opnode.outputs
                if require_links and i == 0 and len(io_links) > 0:
576 577 578 579
                    opnode = G.VirtualDepNode(
                        [info.varnode, *io_links], str(io_links[0].device)
                    )
                    info.varnode = opnode.outputs[0]
580
                    io_links = (info.varnode,)
M
Megvii Engine Team 已提交
581 582

                ivars.append(info.varnode)
583

584 585 586 587 588
            if isinstance(op, BackwardGraph):
                ovars = G.apply_backward_varnode(op, *ivars)
            else:
                ovars = G.apply_normal_varnode(op, *ivars)

589
            if require_links and len(ovars) > 0:
590
                io_links = (ovars[0],)
M
Megvii Engine Team 已提交
591 592 593 594 595 596
            assert len(ovars) == len(ohandles)
            for h, v in zip(ohandles, ovars):
                info = self._tinfo[h]
                info.varnode = v

                def add_reader(opnode):
597
                    nonlocal in_out_links
M
Megvii Engine Team 已提交
598 599
                    need_reset_nodes.append(opnode)
                    readers.append(opnode.outputs[0])
600
                    in_out_links = opnode.outputs
M
Megvii Engine Team 已提交
601

602
                if info.data_read:
M
Megvii Engine Team 已提交
603 604 605 606
                    # Shape can be obtained from data so doesn't need its own
                    # output node. On the other hand, value is read separately
                    # to leverage eager h2d copy
                    info.shape_read = False
607
                    opnode = info.data_reader = G.OutputNode(v, *in_out_links)
M
Megvii Engine Team 已提交
608 609
                    add_reader(opnode)
                if info.value_read:
610
                    opnode = info.value_reader = G.ValueOutputNode(v, *in_out_links)
M
Megvii Engine Team 已提交
611 612
                    add_reader(opnode)
                if info.shape_read:
613
                    opnode = info.shape_reader = G.AttrOutputNode(v, *in_out_links)
M
Megvii Engine Team 已提交
614
                    add_reader(opnode)
615

616 617 618 619 620
        # FIXME
        if self._graph_opt_level is not None:
            graph.options.graph_opt_level = self._graph_opt_level
        else:
            graph.options.graph_opt_level = 2
621 622
        graph.set_priority_to_id([*readers, *in_out_links, *io_links])
        graph.compile(*readers, *in_out_links, *io_links)
M
Megvii Engine Team 已提交
623 624 625 626 627 628

    def _reset_exec_env(self):
        for opnode in self._need_reset_nodes:
            opnode.reset()

    def __call__(self, *args, **kwargs):
629 630
        if is_tracing():
            return self.__wrapped__(*args, **kwargs)
M
Megvii Engine Team 已提交
631
        with self._setup():
M
Megvii Engine Team 已提交
632 633 634 635 636 637 638
            if self._capture_as_const:
                self._process_inputs(*args, **kwargs)
            outputs = self.__wrapped__(*args, **kwargs)
            if self._capture_as_const:
                self._process_outputs(outputs)
            return outputs

639 640 641 642 643 644 645 646 647 648
    def dump(
        self,
        file,
        *,
        arg_names=None,
        output_names=None,
        append=False,
        optimize_for_inference=True,
        **kwargs
    ):
649 650
        r"""
        Serializes trace to file system.
651 652 653 654 655 656 657

        :param file: output file, could be file object or filename.
        :param arg_names: names of the input tensors in the traced function.
        :param output_names: names of the output tensors in the traced function,
            use the default name if not specified.
        :param append: whether output is appended to ``file``.
            Only works when ``file`` is str.
658 659
        :param optimize_for_inference: enbale optmizations,
            will skip all optimize options if this is False. Default: True
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699

        :Keyword Arguments:

            * enable_io16xc32 --
                whether to use float16 for I/O between oprs and use
                float32 as internal computation precision. Note the output var would be
                changed to float16.
            * enable_ioc16 --
                whether to use float16 for both I/O and computation
                precision.

            * enable_hwcd4 --
                whether to use NHWCD4 data layout. This is faster on some
                OpenCL backend.
            * enable_nchw88 --
                whether to use NCHW88 data layout, currently
                used in X86 AVX backend.
            * enable_nchw44 --
                whether to use NCHW44 data layout, currently
                used in arm backend.
            * enable_nchw44_dot --
                whether to use NCHW44_dot data layout, currently
                used in armv8.2+dotprod backend.
            * enable_nchw4 --
                whether to use NCHW4 data layout, currently
                used in nvidia backend(based on cudnn).
            * enable_nchw32 --
                whether to use NCHW32 data layout, currently
                used in nvidia backend with tensorcore(based on cudnn).
            * enable_chwn4 --
                whether to use CHWN4 data layout, currently
                used in nvidia backend with tensorcore.

            * enable_fuse_conv_bias_nonlinearity: whether to fuse conv+bias+nonlinearty
                into one opr.
            * enable_fuse_conv_bias_with_z: whether to fuse conv_bias with z
                input for inference on nvidia backend(this optimization pass will
                result in mismatch of the precision of output of training and
                inference)
        """
M
Megvii Engine Team 已提交
700 701 702 703 704 705 706 707 708 709
        if not self._capture_as_const:
            raise ValueError(
                "you must specify capture_as_const=True at __init__ to use dump"
            )
        if self._untraced:
            raise RuntimeError("should run at least once before calling dump")
        if self._output_names and output_names:
            raise TypeError(
                "cannot specify output_names when output is already in dict format"
            )
M
Megvii Engine Team 已提交
710
        if output_names and not isinstance(output_names, collections.abc.Sequence):
M
Megvii Engine Team 已提交
711 712
            output_names = (output_names,)
        if output_names and len(output_names) != len(self._output_bindings):
713 714 715 716 717
            raise ValueError(
                "wrong number of output_names, should be {} values".format(
                    len(self._output_bindings)
                )
            )
718 719
        if arg_names is None:
            arg_names = ["arg_%d" % i for i in range(len(self._arg_bindings))]
M
Megvii Engine Team 已提交
720
        if arg_names and not isinstance(arg_names, collections.abc.Sequence):
M
Megvii Engine Team 已提交
721 722
            arg_names = (arg_names,)
        if arg_names and len(arg_names) != len(self._arg_bindings):
723 724 725 726 727
            raise ValueError(
                "wrong number of arg_names, should be {} values".format(
                    len(self._arg_bindings)
                )
            )
M
Megvii Engine Team 已提交
728 729
        output_names = output_names or self._output_names

730 731
        dumped_device = as_device("xpux")

M
Megvii Engine Team 已提交
732 733
        h2v = {}
        graph = G.Graph()
734 735
        # only graph_opt_level takes effect in dump
        self._apply_graph_options(graph)
M
Megvii Engine Team 已提交
736

737
        for i, h in enumerate(self._arg_bindings):
M
Megvii Engine Team 已提交
738
            info = self._tinfo[h]
739 740
            h2v[h] = graph.make_h2d(
                dtype=info.dtype,
741
                device=dumped_device,
742
                shape=info.shape or (1,),
743 744 745
                name=arg_names[i] if arg_names else None,
            )
        for k, h in self._kwarg_bindings.items():
M
Megvii Engine Team 已提交
746
            info = self._tinfo[h]
747
            h2v[h] = graph.make_h2d(
748
                dtype=info.dtype, device=dumped_device, shape=info.shape or (1,), name=k
749
            )
M
Megvii Engine Team 已提交
750

751
        set_tracing()
M
Megvii Engine Team 已提交
752
        for op, ihandles, ohandles in self._seq:
753
            if isinstance(op, str) and op == "Const":
754 755 756 757 758 759 760 761 762 763
                assert len(ihandles) == 0
                (h,) = ohandles
                info = self._tinfo[h]
                if h not in h2v:
                    assert info.external
                    assert info.bound_data
                    h2v[h] = graph.make_const(
                        info.bound_data.numpy(), dtype=info.dtype, device=info.device,
                    )
                continue
M
Megvii Engine Team 已提交
764 765 766 767 768 769
            ivars = []
            for h in ihandles:
                info = self._tinfo[h]
                if h not in h2v:
                    assert info.external
                    assert info.bound_data
770
                    h2v[h] = graph.make_const(
771
                        info.bound_data.numpy(), dtype=info.dtype, device=dumped_device
772
                    )
M
Megvii Engine Team 已提交
773
                ivars.append(h2v[h])
774
            ovars = G.apply_normal_varnode(op, *ivars)
M
Megvii Engine Team 已提交
775 776
            assert len(ovars) == len(ohandles)
            h2v.update(zip(ohandles, ovars))
777
        unset_tracing()
M
Megvii Engine Team 已提交
778 779 780 781 782 783 784 785

        dest_vars = []
        for i, h in enumerate(self._output_bindings):
            v = h2v[h]
            if output_names:
                v.name = output_names[i]
            dest_vars.append(v)

786 787
        if optimize_for_inference:
            dest_vars = G.optimize_for_inference(dest_vars, **kwargs)
788

M
Megvii Engine Team 已提交
789
        if isinstance(file, str):
790 791
            permission = "wb" if append == False else "ab"
            file = open(file, permission)
792 793 794
        dump_content, dump_info = G.dump_graph(dest_vars)
        file.write(dump_content)
        return dump_info
M
Megvii Engine Team 已提交
795 796 797 798 799 800 801 802 803 804 805 806

    def _process_inputs(self, *args, **kwargs):
        if self._untraced:
            self._inputs_to_restore = []

            def record_input(x):
                if x is None:
                    return
                h, info = self._new_handle()
                info.external = False
                info.device = x.device
                info.dtype = x.dtype
807 808 809
                info.shape = x.numpy().shape
                x.mixin_handle = h
                self._handle2tensors[h] = x
M
Megvii Engine Team 已提交
810 811 812
                self._inputs_to_restore.append(x)
                return h

813
            self._arg_bindings = []
M
Megvii Engine Team 已提交
814
            for i, x in enumerate(args):
815
                if not isinstance(x, RawTensor):
M
Megvii Engine Team 已提交
816 817 818 819
                    raise TypeError(
                        "positional arguments should all be tensor "
                        "but args[%d] cannot be recognized as one" % i
                    )
820
                self._arg_bindings.append(record_input(x))
M
Megvii Engine Team 已提交
821

822
            self._kwarg_bindings = {}
M
Megvii Engine Team 已提交
823
            for k, x in kwargs.items():
824
                if isinstance(x, RawTensor):
825
                    self._kwarg_bindings[k] = record_input(x)
M
Megvii Engine Team 已提交
826
        else:
827
            if len(args) != len(self._arg_bindings):
M
Megvii Engine Team 已提交
828 829 830 831
                raise TraceMismatchError("positional argument length mismatch")

            self._tensor_remaps = {}

832
            for i, (h, x) in enumerate(zip(self._arg_bindings, args)):
833
                if not isinstance(x, RawTensor):
M
Megvii Engine Team 已提交
834 835 836 837 838 839 840 841 842 843 844 845 846 847
                    raise TypeError(
                        "positional arguments should all be tensor "
                        "but args[%d] cannot be recognized as one" % i
                    )
                info = self._tinfo[h]
                if x.dtype != info.dtype:
                    raise TypeError("args[%d].dtype different from last time" % i)
                if x.device != info.device:
                    raise TypeError("args[%d].device different from last time" % i)
                info.data_setter.set_value(x._dev_tensor())
                self._tensor_remaps[x] = CompiledTensorProxy(h)

            kwargs_tensors = {}
            for k, x in kwargs.items():
848
                if isinstance(x, RawTensor):
M
Megvii Engine Team 已提交
849
                    kwargs_tensors[k] = x
850 851 852
            if set(kwargs_tensors) != set(self._kwarg_bindings):
                too_many = set(kwargs_tensors) - set(self._kwarg_bindings)
                too_few = set(self._kwarg_bindings) - set(kwargs_tensors)
M
Megvii Engine Team 已提交
853 854 855 856 857 858 859 860 861 862
                if too_many:
                    raise TraceMismatchError(
                        "keyword arguments found to be tensor this time "
                        "but were non-tensor previously: %s" % " ".join(too_many)
                    )
                if too_few:
                    raise TraceMismatchError(
                        "keyword arguments found to be non-tensor this time "
                        "but were tensor previously: %s" % " ".join(too_few)
                    )
863
            for k, h in self._kwarg_bindings.items():
M
Megvii Engine Team 已提交
864 865 866 867 868 869 870 871 872 873 874
                x = kwargs_tensors[k]
                info = self._tinfo[h]
                if x.dtype != info.dtype:
                    raise TypeError("kwargs[%s].dtype different from last time" % k)
                if x.device != info.device:
                    raise TypeError("kwargs[%s].device different from last time" % k)
                info.data_setter.set_value(x._dev_tensor())
                self._tensor_remaps[x] = CompiledTensorProxy(h)

    def _process_outputs(self, outputs):
        output_names = None
M
Megvii Engine Team 已提交
875
        if isinstance(outputs, collections.abc.Mapping):
M
Megvii Engine Team 已提交
876
            output_names, outputs = zip(*sorted(outputs.items()))
M
Megvii Engine Team 已提交
877
        elif not isinstance(outputs, collections.abc.Sequence):
M
Megvii Engine Team 已提交
878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
            outputs = (outputs,)

        if not self._untraced:
            if output_names != self._output_names:
                too_many = set(output_names) - set(self._output_names)
                too_few = set(self._output_names) - set(output_names)
                if too_many:
                    raise TraceMismatchError(
                        "output has more keys than last time: %s" % " ".join(too_many)
                    )
                if too_few:
                    raise TraceMismatchError(
                        "output has less keys than last time: %s" % " ".join(too_few)
                    )
            if len(outputs) != len(self._output_bindings):
                raise TraceMismatchError("output size differs from last time")
        else:
            self._output_names = output_names
            self._output_bindings = []

        for i, x in enumerate(outputs):
899
            if not isinstance(x, RawTensor):
M
Megvii Engine Team 已提交
900 901
                raise TypeError("every item of return value should be tensor")
            if self._untraced:
902 903
                h = x.mixin_handle
                if h < 0:
M
Megvii Engine Team 已提交
904 905 906
                    raise RuntimeError("output is not computed from inputs")
                self._output_bindings.append(h)
            else:
907
                h = x.mixin_handle
908
                if h not in self._output_handles:
M
Megvii Engine Team 已提交
909 910 911 912 913 914
                    raise RuntimeError("output is not computed from inputs")
                if h != self._output_bindings[i]:
                    raise TraceMismatchError(
                        "retval[%s] is a different tensor than last time"
                        % (output_names and output_names[i] or i)
                    )
M
Megvii Engine Team 已提交
915

916 917 918 919 920 921 922 923 924 925
    def get_profile(self):
        """
        Get profiling result for compiled trace.

        :return: a json compatible object.
        """
        if not self._profiler:
            raise RuntimeError("trace is not set with profiling=True")
        return json.loads(self._profiler.get())

926 927 928 929 930 931
    def trace(self, *args, **kwargs):
        raise NotImplementedError(
            "trace is deemed unbeneficial with the new "
            "tracing mechanism. You should alwasy use __call__."
        )

M
Megvii Engine Team 已提交
932

933
class CompiledTensorProxy:
M
Megvii Engine Team 已提交
934 935 936 937 938 939
    """
    Duck-typed RawTensor
    """

    def __init__(self, handle):
        self.__handle = handle
940
        self._isscalar = False
M
Megvii Engine Team 已提交
941 942 943 944
        self.__info = active_trace._tinfo[handle]
        self.__shape = None
        self.__data = None
        self.__value = None
945
        self.__tensor = make_empty_tensor()
M
Megvii Engine Team 已提交
946 947 948 949 950 951 952 953 954 955 956

    @property
    def dtype(self):
        return self.__info.varnode.dtype

    @property
    def device(self):
        return self.__info.varnode.device

    @property
    def shape(self):
957 958
        if self._isscalar:
            return ()
M
Megvii Engine Team 已提交
959
        if self.__shape is None:
960
            if self.__info.shape_read:
M
Megvii Engine Team 已提交
961
                self.__shape = self.__info.shape_reader.get_value().shape
962 963
            elif self.__info.data_read:
                self.__shape = self.__info._dev_tensor().shape
M
Megvii Engine Team 已提交
964 965 966 967 968 969
            else:
                raise TraceMismatchError("shape of this tensor is not read in trace")
        return self.__shape

    def numpy(self):
        if self.__value is None:
970
            if self.__info.value_read:
M
Megvii Engine Team 已提交
971
                self.__value = self.__info.value_reader.get_value()
972
            elif self.__info.data_read:
M
Megvii Engine Team 已提交
973 974 975
                self.__value = self._dev_tensor().numpy()
            else:
                raise TraceMismatchError("value of this tensor is not read in trace")
976 977
            if self._isscalar:
                self.__value = self.__value.squeeze()
M
Megvii Engine Team 已提交
978 979 980 981
        return self.__value

    def _dev_tensor(self):
        if self.__data is None:
982
            if not self.__info.data_read:
M
Megvii Engine Team 已提交
983 984
                raise TraceMismatchError("raw data of this tensor is not read in trace")
            self.__data = self.__info.data_reader.get_value()
985 986
            self.__tensor._reset(RawTensor(self.__data))
            self.__tensor.mixin_handle = self.__handle
M
Megvii Engine Team 已提交
987 988
        return self.__data

989 990 991 992 993 994 995 996 997
    def _drop(self):
        return

    def _swap_in(self):
        return

    def _swap_out(self):
        return

M
Megvii Engine Team 已提交
998
    def __del__(self):
999
        if self.__tensor.shape_read and self.__shape is not None:
M
Megvii Engine Team 已提交
1000
            self.__info.shape_reader.drop_value()
1001 1002 1003
        # if self.__tensor.value_read and self.__value is not None:
        #     self.__info.value_reader.drop_value()
        if self.__tensor.data_read and self.__data is not None:
M
Megvii Engine Team 已提交
1004 1005 1006 1007
            self.__info.data_reader.drop_value()


def assign_raw_tensor(lhs, rhs):
1008
    lhs.__init__(rhs)
M
Megvii Engine Team 已提交
1009 1010 1011 1012


def apply_symbolic_mode(op: OpDef, *args: RawTensor):
    graph = active_trace._lazy_eval_graph
1013 1014
    ivars = []
    for x in args:
1015
        var = getattr(x, "_varnode", None)
1016 1017 1018 1019 1020 1021
        if var:
            ivars.append(var)
        else:
            data_setter = G.InputNode(
                device=x.device,
                dtype=x.dtype,
1022
                shape=x.numpy().shape or (1,),
1023 1024 1025 1026 1027 1028
                graph=graph,
                use_static_shape=True,
            )
            var = data_setter.outputs[0]
            ivars.append(var)
            data_setter.set_value(x._dev_tensor())
1029 1030 1031 1032 1033

    require_links = type(op) in _io_op_types

    if require_links and active_trace._lazy_eval_links:
        assert len(ivars) > 0, "op should has at least one input"
1034 1035 1036 1037 1038
        opnode = G.VirtualDepNode(
            [ivars[0], *active_trace._lazy_eval_links],
            str(active_trace._lazy_eval_links[0].device),
        )
        ivars[0] = opnode.outputs[0]
1039 1040
        active_trace._lazy_eval_links = (ivars[0],)

1041 1042 1043 1044 1045
    if isinstance(op, BackwardGraph):
        ovars = G.apply_backward_varnode(op, *ivars)
    else:
        ovars = G.apply_normal_varnode(op, *ivars)
    outputs = [RawTensor(o) for o in ovars]
1046 1047

    if require_links:
1048
        active_trace._lazy_eval_links = (outputs[0]._varnode,)
1049

1050
    active_trace._lazy_eval_tensors.update([TensorWeakRef(o) for o in outputs])
M
Megvii Engine Team 已提交
1051 1052 1053
    return outputs


1054
def apply_const_symbolic_mode(value, dtype, device):
1055
    graph = active_trace._lazy_eval_graph
1056 1057 1058 1059
    # don't need to unset tracing
    # because varnode construction will ignore tracing flag
    ret = RawTensor(graph.make_const(value, dtype=dtype, device=device))
    active_trace._lazy_eval_tensors.add(TensorWeakRef(ret))
1060 1061 1062
    return (ret,)


M
Megvii Engine Team 已提交
1063 1064 1065
def apply_compiled_mode(op: OpDef, *args: RawTensor):
    if skip_tracing:
        args = [
1066
            RawTensor(x._dev_tensor()) if x.__class__ is CompiledTensorProxy else x
M
Megvii Engine Team 已提交
1067 1068
            for x in args
        ]
1069 1070 1071 1072
        unset_tracing()
        ret = apply(op, *args)
        set_tracing()
        return ret
M
Megvii Engine Team 已提交
1073 1074 1075
    return active_trace._apply_op(op, args)


1076
def apply_const_compiled_mode(value, dtype, device, is_const):
1077 1078
    if skip_tracing:
        args = [
1079
            RawTensor(x._dev_tensor()) if x.__class__ is CompiledTensorProxy else x
1080 1081
            for x in args
        ]
1082 1083 1084 1085 1086
        unset_tracing()
        ret = RawTensor(value, dtype, device, False)
        set_tracing()
        return ret
    return active_trace._apply_const(value, dtype, device)
1087 1088


M
Megvii Engine Team 已提交
1089 1090
# this hook injects TraceMixin
def apply_with_tracing(op: OpDef, *args: RawTensor):
1091 1092 1093 1094 1095 1096
    if active_trace._symbolic:
        outputs = apply_symbolic_mode(op, *args)
    else:
        unset_tracing()
        outputs = apply(op, *args)
        set_tracing()
M
Megvii Engine Team 已提交
1097

1098 1099
    active_trace._record_op(op, args, outputs)
    return list(outputs)
M
Megvii Engine Team 已提交
1100 1101


1102 1103 1104 1105 1106 1107 1108 1109 1110
def apply_const_with_tracing(value, dtype, device, is_const):
    if active_trace._symbolic:
        outputs = apply_const_symbolic_mode(value, dtype, device)
    else:
        unset_tracing()
        outputs = (RawTensor(value, dtype, device, False),)
        set_tracing()
    active_trace._record_const(outputs)
    return list(outputs)