chunk_codegen.py 85.7 KB
Newer Older
oahzxl's avatar
init  
oahzxl committed
1
2
import colossalai
import torch
oahzxl's avatar
oahzxl committed
3
import copy
oahzxl's avatar
init  
oahzxl committed
4
5
from typing import List, Callable, Any, Tuple, Dict, Iterable

oahzxl's avatar
oahzxl committed
6
from torch.fx.node import Node, Argument, map_arg, _type_repr, _get_qualified_name
oahzxl's avatar
oahzxl committed
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
from torch.fx.graph import (
    _Namespace,
    PythonCode,
    _custom_builtins,
    _is_from_torch,
    _format_target,
    magic_methods,
    CodeGen,
    _origin_type_map,
    inplace_methods,
    _CustomBuiltin,
)
from colossalai.fx.profiler import (
    calculate_fwd_out,
    calculate_fwd_tmp,
    parameter_size,
    activation_size,
)

oahzxl's avatar
oahzxl committed
26
CODEGEN_AVAILABLE = True
oahzxl's avatar
oahzxl committed
27
__all__ = ["ChunkCodeGen"]
oahzxl's avatar
init  
oahzxl committed
28
29


oahzxl's avatar
oahzxl committed
30
31
32
def _delete_free_var_from_last_use(user_to_last_uses):
    for key, value in user_to_last_uses.items():
        for n in value:
oahzxl's avatar
oahzxl committed
33
            if n.op == "placeholder":
oahzxl's avatar
oahzxl committed
34
35
                user_to_last_uses[key].remove(n)

oahzxl's avatar
oahzxl committed
36

37
def _get_node_shape(node):
oahzxl's avatar
oahzxl committed
38
39
    if hasattr(node.meta["tensor_meta"], "shape"):
        return node.meta["tensor_meta"].shape
40
41
    return None

oahzxl's avatar
oahzxl committed
42

oahzxl's avatar
oahzxl committed
43
def _is_non_compute_node(node):
oahzxl's avatar
oahzxl committed
44
45
46
    if any(i in node.op for i in ["placeholder", "get_attr", "output"]) or any(
        i in node.name for i in ["getitem", "getattr"]
    ):
oahzxl's avatar
oahzxl committed
47
48
        return True
    return False
oahzxl's avatar
oahzxl committed
49
50


oahzxl's avatar
oahzxl committed
51
def _is_non_compute_node_except_placeholder(node):
oahzxl's avatar
oahzxl committed
52
53
54
    if any(i in node.op for i in ["get_attr", "output"]) or any(
        i in node.name for i in ["getitem", "getattr"]
    ):
oahzxl's avatar
oahzxl committed
55
56
57
58
        return True
    return False


oahzxl's avatar
oahzxl committed
59
60
61
62
63
64
65
66
def _is_non_compute_node_except_placeholder_output(node):
    if any(i in node.op for i in ["get_attr"]) or any(
        i in node.name for i in ["getitem", "getattr"]
    ):
        return True
    return False


oahzxl's avatar
oahzxl committed
67
class IndexTracer(object):
oahzxl's avatar
oahzxl committed
68
69
70
    def __init__(self, gm) -> None:
        self.gm = gm
        self.nodes_list = list(gm.graph.nodes)
71
        self.idx_trace_list = self._init_idx_trace_list()
oahzxl's avatar
oahzxl committed
72
        self.idx_trace_equal = []
oahzxl's avatar
oahzxl committed
73
        self.idx_view_list = []
oahzxl's avatar
oahzxl committed
74
        self.idx_count = -1
oahzxl's avatar
oahzxl committed
75

76
77
78
    def _init_idx_trace_list(self):
        idx_trace_list = []
        for n in self.nodes_list:
oahzxl's avatar
oahzxl committed
79
            if _get_node_shape(n) != None:
80
                cur_trace = {
oahzxl's avatar
oahzxl committed
81
82
83
                    "idx": [None for _ in range(len(_get_node_shape(n)))],
                    "compute": [[] for _ in range(len(_get_node_shape(n)))],
                    "source": [{} for _ in range(len(_get_node_shape(n)))],
84
85
                }
            else:
oahzxl's avatar
oahzxl committed
86
                cur_trace = {"idx": [], "compute": [], "source": []}
87
88
            idx_trace_list.append(cur_trace)
        return idx_trace_list
oahzxl's avatar
oahzxl committed
89

oahzxl's avatar
oahzxl committed
90
    def _add_index(self):
oahzxl's avatar
oahzxl committed
91
92
        """
        Update the count and return it. To record the idx number.
oahzxl's avatar
oahzxl committed
93

oahzxl's avatar
oahzxl committed
94
95
        Returns:
            idx_count: int
oahzxl's avatar
oahzxl committed
96
        """
oahzxl's avatar
oahzxl committed
97
        self.idx_count += 1
oahzxl's avatar
oahzxl committed
98
        return self.idx_count
oahzxl's avatar
oahzxl committed
99

100
    def _del_dim(self, idx, dim_idx):
oahzxl's avatar
oahzxl committed
101
102
103
104
        self.idx_trace_list[idx]["idx"].pop(dim_idx)
        self.idx_trace_list[idx]["compute"].pop(dim_idx)
        self.idx_trace_list[idx]["source"].pop(dim_idx)

105
106
107
108
    def _add_dim(self, node_idx, dim_idx):
        self.idx_trace_list[node_idx]["idx"].insert(dim_idx, self._add_index())
        self.idx_trace_list[node_idx]["compute"].insert(dim_idx, [])
        self.idx_trace_list[node_idx]["source"].insert(dim_idx, {})
oahzxl's avatar
oahzxl committed
109

110
111
112
113
    def _transform_index(self, node, node_dim):
        node_idx = self._find_idx_trace_from_node(node)
        dims = list(range(len(node_idx)))
        return dims[node_dim]
oahzxl's avatar
oahzxl committed
114

115
116
117
118
119
    def _inherit_index(self, node_from, node_from_dim, node_to, node_to_dim):
        node_from_dim = self._transform_index(node_from, node_from_dim)
        node_to_dim = self._transform_index(node_to, node_to_dim)
        node_from_trace = self._find_trace_from_node(node_from)
        node_to_trace = self._find_trace_from_node(node_to)
oahzxl's avatar
oahzxl committed
120
121
122
123
        node_to_trace["idx"][node_to_dim] = node_from_trace["idx"][node_from_dim]
        node_to_trace["compute"][node_to_dim] = copy.deepcopy(
            node_from_trace["compute"][node_from_dim]
        )
oahzxl's avatar
oahzxl committed
124
        self._add_source(node_from, node_from_dim, node_to, node_to_dim, init=True)
oahzxl's avatar
oahzxl committed
125

126
127
128
129
130
131
132
    def _inherit_all_computation(self, node_from, node_to):
        node_from_compute = self._find_compute_trace_from_node(node_from)
        node_to_compute = self._find_compute_trace_from_node(node_to)
        assert len(node_from_compute) == len(node_to_compute)
        for i in range(len(node_from_compute)):
            self._add_source(node_from, i, node_to, i)
            node_to_compute[i] = copy.deepcopy(node_from_compute[i])
oahzxl's avatar
oahzxl committed
133

oahzxl's avatar
oahzxl committed
134
    def _add_source(self, node_from, node_from_dim, node_to, node_to_dim, init=False):
135
136
137
138
139
        node_from_dim = self._transform_index(node_from, node_from_dim)
        node_from_trace = self._find_trace_from_node(node_from)
        node_to_dim = self._transform_index(node_to, node_to_dim)
        node_to_trace = self._find_trace_from_node(node_to)
        node_from_idx = _find_idx_by_name(node_from.name, self.nodes_list)
oahzxl's avatar
oahzxl committed
140
        if init:
oahzxl's avatar
oahzxl committed
141
            node_to_trace["source"][node_to_dim] = {}
oahzxl's avatar
oahzxl committed
142
143
144
145
146
        # add dim to cur new source
        if node_from_idx not in node_to_trace["source"][node_to_dim]:
            node_to_trace["source"][node_to_dim][node_from_idx] = [node_from_dim]
        else:
            if node_from_dim not in node_to_trace["source"][node_to_dim][node_from_idx]:
oahzxl's avatar
oahzxl committed
147
148
149
                node_to_trace["source"][node_to_dim][node_from_idx].append(
                    node_from_dim
                )
oahzxl's avatar
oahzxl committed
150
        # update inputs source
oahzxl's avatar
oahzxl committed
151
152
153
154
        node_to_trace["source"][node_to_dim].update(
            node_from_trace["source"][node_from_dim]
        )

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
    def _mark_computation_from_node(self, node_from, node_to, exclude=None):
        if exclude == None:
            exclude = []
        else:
            exclude = [self._transform_index(node_to, i) for i in exclude]
        node_from_compute = self._find_compute_trace_from_node(node_from)
        node_to_compute = self._find_compute_trace_from_node(node_to)
        # assert len(node_from_compute) == len(node_to_compute)
        for i in range(-1, -min(len(node_from_compute), len(node_to_compute)) - 1, -1):
            if self._transform_index(node_to, i) in exclude:
                continue
            self._add_source(node_from, i, node_to, i)
            for j in node_from_compute[i]:
                if j not in node_to_compute[i]:
                    node_to_compute[i].append(j)
oahzxl's avatar
oahzxl committed
170

171
    def _mark_idx_equal(self, node1, dim1, node2, dim2):
oahzxl's avatar
oahzxl committed
172
173
174
175
176
177
        """
        Mark 2 index to be equal.

        Args:
            idx1 (int): index count.
            idx2 (int): index count.
178
179
180
181
182
183
184
        """
        # node1_idx = _find_idx_by_name(node1.name, self.nodes_list)
        # node2_idx = _find_idx_by_name(node2.name, self.nodes_list)
        # if node1_idx > node2_idx:
        #     self._add_source(node2, dim2, node1, dim1)
        # else:
        #     self._add_source(node1, dim1, node2, dim2)
oahzxl's avatar
oahzxl committed
185

oahzxl's avatar
oahzxl committed
186
    def _mark_computation(self, node, idx, dim):
oahzxl's avatar
oahzxl committed
187
188
189
190
191
192
193
        """
        Mark some dims of node as computed.

        Args:
            node (node)
            idx (int): node index
            dim (list or int): dims to be marked as computed
oahzxl's avatar
oahzxl committed
194
        """
oahzxl's avatar
oahzxl committed
195
196
        if isinstance(dim, int):
            dim = [dim]
197
        dims = list(range(len(_get_node_shape(node))))
oahzxl's avatar
oahzxl committed
198
        for d in dim:
199
            cur_dim = dims[d]
oahzxl's avatar
oahzxl committed
200
201
            if idx not in self.idx_trace_list[idx]["compute"][cur_dim]:
                self.idx_trace_list[idx]["compute"][cur_dim].append(idx)
202

oahzxl's avatar
oahzxl committed
203
    def _find_trace_from_node(self, node):
oahzxl's avatar
oahzxl committed
204
205
206
207
208
209
210
211
        """
        Find node idx and compute trace by the node.

        Args:
            node (node)
        Returns:
            idx (list): idx of the node
            compute (list): computed idx of the node.
oahzxl's avatar
oahzxl committed
212
        """
oahzxl's avatar
oahzxl committed
213
214
        node_idx = _find_idx_by_name(node.name, self.nodes_list)
        node_dict = self.idx_trace_list[node_idx]
215
        return node_dict
oahzxl's avatar
oahzxl committed
216

oahzxl's avatar
oahzxl committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
    def _find_source_trace_from_node(self, node):
        """
        Find node source trace by the node.

        Args:
            node (node)
        Returns:
            idx (list): idx of the node
            compute (list): computed idx of the node.
        """
        node_idx = _find_idx_by_name(node.name, self.nodes_list)
        node_dict = self.idx_trace_list[node_idx]
        return node_dict["source"]

oahzxl's avatar
oahzxl committed
231
    def _find_idx_trace_from_node(self, node):
oahzxl's avatar
oahzxl committed
232
233
234
235
236
237
238
        """
        Find node idx trace by the node.

        Args:
            node (node)
        Returns:
            idx (list): idx of the node
oahzxl's avatar
oahzxl committed
239
        """
oahzxl's avatar
oahzxl committed
240
        node_idx = _find_idx_by_name(node.name, self.nodes_list)
oahzxl's avatar
oahzxl committed
241
242
        return self.idx_trace_list[node_idx]["idx"]

oahzxl's avatar
oahzxl committed
243
    def _find_compute_trace_from_node(self, node):
oahzxl's avatar
oahzxl committed
244
245
246
247
248
249
250
        """
        Find node compute trace by the node.

        Args:
            node (node)
        Returns:
            compute (list): computed idx of the node.
oahzxl's avatar
oahzxl committed
251
        """
oahzxl's avatar
oahzxl committed
252
        node_idx = _find_idx_by_name(node.name, self.nodes_list)
oahzxl's avatar
oahzxl committed
253
254
        return self.idx_trace_list[node_idx]["compute"]

255
    def _assign_index_as_input(self, node, node_idx, input_node=None):
oahzxl's avatar
oahzxl committed
256
257
258
259
260
261
        """
        Assign node's trace as its input node.

        Args:
            node (node)
            node_idx (int)
262
263
264
265
        """
        if input_node == None:
            input_node = node.args[0]
        input_node_idx = _find_idx_by_name(input_node.name, self.nodes_list)
oahzxl's avatar
oahzxl committed
266
267
        input_node_idx_trace = self.idx_trace_list[input_node_idx]["idx"]

oahzxl's avatar
oahzxl committed
268
        new_idx_trace = copy.deepcopy(input_node_idx_trace)
oahzxl's avatar
oahzxl committed
269
270
        self.idx_trace_list[node_idx]["idx"] = new_idx_trace

271
        self._inherit_all_computation(input_node, node)
oahzxl's avatar
oahzxl committed
272

oahzxl's avatar
oahzxl committed
273
    def _assign_all_index(self, node, node_idx):
oahzxl's avatar
oahzxl committed
274
275
276
277
278
279
        """
        Add new index for all node's dims.

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
280
281
        """
        shape = node.meta["tensor_meta"].shape
oahzxl's avatar
oahzxl committed
282
283
        new_trace = []
        for _ in shape:
oahzxl's avatar
oahzxl committed
284
            new_trace.append(self._add_index())
oahzxl's avatar
oahzxl committed
285
        self.idx_trace_list[node_idx]["idx"] = new_trace
oahzxl's avatar
oahzxl committed
286

oahzxl's avatar
oahzxl committed
287
    def _assign_transpose_index(self, node, node_idx):
oahzxl's avatar
oahzxl committed
288
289
290
291
292
293
294
295
        """
        Assign index for transpose op.
        1. swap input's dim according to transpose args
        2. inherit input's computation

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
296
        """
297
        input_node = node.args[0]
oahzxl's avatar
oahzxl committed
298
        tranpose_dim = node.args[1:]
oahzxl's avatar
oahzxl committed
299

300
301
302
        self._assign_index_as_input(node, node_idx, input_node)
        self._inherit_index(input_node, tranpose_dim[1], node, tranpose_dim[0])
        self._inherit_index(input_node, tranpose_dim[0], node, tranpose_dim[1])
oahzxl's avatar
oahzxl committed
303

oahzxl's avatar
oahzxl committed
304
    def _assign_permute_index(self, node, node_idx):
oahzxl's avatar
oahzxl committed
305
306
307
308
309
310
311
312
        """
        Assign index for permute op.
        1. swap input's dim according to permute args
        2. inherit input's computation

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
313
        """
oahzxl's avatar
oahzxl committed
314
        permute_dim = node.args[1:]
315
        input_node = node.args[0]
oahzxl's avatar
oahzxl committed
316

317
        self._assign_index_as_input(node, node_idx, input_node)
oahzxl's avatar
oahzxl committed
318
        for idx, d in enumerate(permute_dim):
319
            self._inherit_index(input_node, d, node, idx)
oahzxl's avatar
oahzxl committed
320

oahzxl's avatar
oahzxl committed
321
    def _assign_linear_index(self, node, node_idx):
oahzxl's avatar
oahzxl committed
322
323
324
325
326
327
328
329
330
        """
        Assign index for linear op.
        1. copy trace from input node and change last index accroding to weight
        2. mark equal for input node last index, weight first dim and bias dim.
        3. inherit input's computation, mark computation for last dim.

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
331
332
333
334
335
336
        """
        if len(node.args) == 2:
            input_node, weight = node.args
            bias = None
        else:
            input_node, weight, bias = node.args
oahzxl's avatar
oahzxl committed
337

338
339
        self._assign_index_as_input(node, node_idx)
        self._inherit_index(weight, 1, node, -1)
oahzxl's avatar
oahzxl committed
340

oahzxl's avatar
oahzxl committed
341
        self._mark_computation(node, node_idx, [-1])
342
        self._mark_idx_equal(input_node, -1, weight, 0)
oahzxl's avatar
oahzxl committed
343

oahzxl's avatar
oahzxl committed
344
        if bias:
345
            self._mark_idx_equal(input_node, -1, bias, 0)
oahzxl's avatar
oahzxl committed
346

oahzxl's avatar
oahzxl committed
347
    def _assign_matmul_index(self, node, node_idx):
oahzxl's avatar
oahzxl committed
348
349
350
351
352
353
354
355
356
        """
        Assign index for matmul op.
        1. copy trace from matmul_left and change last index accroding to matmul_right. (assert they have same length)
        2. mark equal for input matmul_left -1 index and matmul_right -2 dim.
        3. inherit matmul_left and matmul_right computation, mark computation for last dim.

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
357
        """
oahzxl's avatar
oahzxl committed
358
        matmul_left, matmul_right = node.args
oahzxl's avatar
oahzxl committed
359
360

        assert len(_get_node_shape(matmul_left)) == len(_get_node_shape(matmul_right))
361
362
        self._assign_index_as_input(node, node_idx, matmul_left)
        self._inherit_index(matmul_right, -1, node, -1)
oahzxl's avatar
oahzxl committed
363

364
        self._mark_computation_from_node(matmul_right, node, [-1, -2])
oahzxl's avatar
oahzxl committed
365
        self._mark_computation(node, node_idx, [-1])
366
        self._mark_idx_equal(matmul_left, -1, matmul_right, -2)
oahzxl's avatar
oahzxl committed
367

oahzxl's avatar
oahzxl committed
368
    def _assign_layernorm_index(self, node, idx):
oahzxl's avatar
oahzxl committed
369
370
371
372
373
374
375
376
377
        """
        Assign index for layernorm op.
        1. assign index as input node
        2. inherit computation and mark last 2 dims as computed.

        Args:
            node (node)
            node_idx (int)
        """
oahzxl's avatar
oahzxl committed
378
        self._assign_index_as_input(node, idx)
oahzxl's avatar
oahzxl committed
379
        self._mark_computation(node, idx, [-1])
oahzxl's avatar
oahzxl committed
380

oahzxl's avatar
oahzxl committed
381
    def _assign_elementwise_index(self, node, idx):
oahzxl's avatar
oahzxl committed
382
383
384
385
386
387
388
389
        """
        Assign index for element-wise op (eg. relu sigmoid add mul).
        1. assign index as input node
        2. inherit computation from all input nodes.

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
390
        """
oahzxl's avatar
oahzxl committed
391
        self._assign_index_as_input(node, idx)
392
        nodes_in = []
oahzxl's avatar
oahzxl committed
393
        for node_in in node.args:
394
395
396
397
398
399
400
401
402
403
            if type(node_in) == type(node):
                nodes_in.append(node_in)
                self._mark_computation_from_node(node_in, node)
        assert len(nodes_in) <= 2
        if len(nodes_in) == 2:
            node_in0_shape = _get_node_shape(nodes_in[0])
            node_in1_shape = _get_node_shape(nodes_in[1])
            for i in range(-1, -min(len(node_in0_shape), len(node_in1_shape)) - 1, -1):
                if node_in0_shape[i] == node_in1_shape[i]:
                    self._mark_idx_equal(nodes_in[0], i, nodes_in[1], i)
oahzxl's avatar
oahzxl committed
404

405
406
407
408
409
    def _assgin_no_change_index(self, node, idx):
        self._assign_index_as_input(node, idx)
        for node_in in node.args:
            if type(node_in) == type(node):
                self._mark_computation_from_node(node_in, node)
oahzxl's avatar
oahzxl committed
410

411
412
413
414
415
416
417
418
419
420
    def _assign_einsum_index(self, node, idx):
        """
        Assign index for einsum op.

        Args:
            node (node)
            node_idx (int)
        """
        patterns = node.args[0]
        input_nodes = node.args[1:]
oahzxl's avatar
oahzxl committed
421

422
423
424
        patterns = patterns.replace(" ", "")
        left, right = patterns.split("->")
        left = left.split(",")
oahzxl's avatar
oahzxl committed
425

426
427
428
429
430
431
432
        all_index = []
        for i in left:
            for c in i:
                all_index.append(c)
        all_index = set(all_index)
        free_index = set([i for i in right])
        sum_index = all_index - free_index
oahzxl's avatar
oahzxl committed
433

434
435
436
437
        for right_idx, right_indice in enumerate(right):
            for left_idx, left_str in enumerate(left):
                if right_indice in left_str:
                    source_idx = left_str.index(right_indice)
oahzxl's avatar
oahzxl committed
438
439
440
441
                    self._inherit_index(
                        input_nodes[left_idx], source_idx, node, right_idx
                    )

oahzxl's avatar
oahzxl committed
442
443
444
445
446
        # for i in sum_index:
        #     for left_idx, left_str in enumerate(left):
        #         if i in left_str:
        #             self._mark_computation(node, idx, left_str.index(i))
        #             break
oahzxl's avatar
oahzxl committed
447

oahzxl's avatar
oahzxl committed
448
    def _assign_softmax_index(self, node, idx):
oahzxl's avatar
oahzxl committed
449
450
451
452
453
454
455
456
        """
        Assign index for softmax op.
        1. assign index as input node
        2. inherit computation and mark softmax dim as computed.

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
457
        """
oahzxl's avatar
oahzxl committed
458
        self._assign_index_as_input(node, idx)
oahzxl's avatar
oahzxl committed
459
460
        self._mark_computation(node, idx, [node.kwargs["dim"]])

oahzxl's avatar
oahzxl committed
461
462
463
464
465
466
467
468
    def _assign_unsqueeze_index(self, node, node_idx):
        """
        Assign index for unsqueeze op.
        1. assign new index for unsqueeze dim

        Args:
            node (node)
            node_idx (int)
469
470
        """
        self._del_dim(node_idx, -1)
oahzxl's avatar
oahzxl committed
471
        self._assign_index_as_input(node, node_idx)
472
        self._add_dim(node_idx, node.args[1])
oahzxl's avatar
oahzxl committed
473

oahzxl's avatar
oahzxl committed
474
475
476
477
478
479
480
481
    def _assign_dropout_index(self, node, node_idx):
        """
        Assign index for unsqueeze op.
        1. assign new index for unsqueeze dim

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
482
        """
oahzxl's avatar
oahzxl committed
483
        self._assign_index_as_input(node, node_idx)
oahzxl's avatar
oahzxl committed
484

oahzxl's avatar
oahzxl committed
485
486
487
488
489
490
491
492
    def _assign_ones_like_index(self, node, node_idx):
        """
        Assign index for oneslike op.
        1. assign new index for all dim

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
493
        """
oahzxl's avatar
oahzxl committed
494
        self._assign_all_index(node, node_idx)
oahzxl's avatar
oahzxl committed
495

oahzxl's avatar
oahzxl committed
496
    def _assign_view_reshape_index(self, node, node_idx):
oahzxl's avatar
oahzxl committed
497
498
499
500
501
502
        """
        Assign index for view and reshape op.
        1. get origin shape and target shape by meta info.
        2. compute the real value of -1 in target shape.
        3. determine changed dim, and assgin index for generated dim.
        4. log changed dim and generated dim for restore
oahzxl's avatar
oahzxl committed
503
504
        5. inherit computation.
        6. TODO: look into view list to see whether the view is associated with other,
oahzxl's avatar
oahzxl committed
505
506
507
508
509
           if so assgin equal dim according to previous view.

        Args:
            node (node)
            node_idx (int)
oahzxl's avatar
oahzxl committed
510
        """
oahzxl's avatar
oahzxl committed
511
512
        # get data, turn into number
        origin_node = node.args[0]
oahzxl's avatar
oahzxl committed
513
        origin_shape = origin_node.meta["tensor_meta"].shape
oahzxl's avatar
oahzxl committed
514
515
516
517
518
        target_shape = []
        for i in range(1, len(node.args)):
            if isinstance(node.args[i], int):
                target_shape.append(node.args[i])
            else:
oahzxl's avatar
oahzxl committed
519
                target_shape.append(node.args[i].meta["fwd_out"][0])
oahzxl's avatar
oahzxl committed
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538

        # compute the value of -1
        if -1 in target_shape:
            origin_product = 1
            for i in origin_shape:
                origin_product *= i
            target_product = -1
            for i in target_shape:
                target_product *= i
            shape_idx = target_shape.index(-1)
            target_shape[shape_idx] = origin_product // target_product

        # determine changed dim
        len_diff = len(origin_shape) - len(target_shape)
        if len_diff == 1:
            # dim merge
            dim_equal = [i == j for i, j in zip(origin_shape[:-1], target_shape)]
            dim_to = [dim_equal.index(False)]
            dim_from = [dim_equal.index(False), dim_equal.index(False) + 1]
539
            self._add_dim(node_idx, -1)
oahzxl's avatar
oahzxl committed
540
541
542
543
544
        elif len_diff == -1:
            # dim expand
            dim_equal = [i == j for i, j in zip(origin_shape, target_shape[:-1])]
            dim_from = [dim_equal.index(False)]
            dim_to = [dim_equal.index(False), dim_equal.index(False) + 1]
545
            self._del_dim(node_idx, -1)
oahzxl's avatar
oahzxl committed
546
        else:
oahzxl's avatar
oahzxl committed
547
548
549
550
551
552
553
            raise NotImplementedError(
                "shape"
                + str(origin_shape)
                + "and"
                + str(target_shape)
                + "view not implemented"
            )
oahzxl's avatar
oahzxl committed
554
555

        # get new index
oahzxl's avatar
oahzxl committed
556
        origin_trace = self._find_idx_trace_from_node(origin_node)
557
        self._assign_index_as_input(node, node_idx, origin_node)
oahzxl's avatar
oahzxl committed
558
559
        dim_from.reverse()
        for i in dim_from:
560
            self._del_dim(node_idx, i)
oahzxl's avatar
oahzxl committed
561
        for i in dim_to:
562
            self._add_dim(node_idx, i)
oahzxl's avatar
oahzxl committed
563

oahzxl's avatar
oahzxl committed
564
        # inherit computation
oahzxl's avatar
oahzxl committed
565
        compute_log = self._find_compute_trace_from_node(origin_node)
oahzxl's avatar
oahzxl committed
566
567
568
        for i in dim_from:
            if origin_trace[i] in compute_log:
                for j in dim_to:
oahzxl's avatar
oahzxl committed
569
                    self._mark_computation(node, node_idx, [j])
oahzxl's avatar
oahzxl committed
570
                break
oahzxl's avatar
oahzxl committed
571

oahzxl's avatar
oahzxl committed
572
        # log view, not used now
oahzxl's avatar
oahzxl committed
573
574
575
576
577
578
579
        view_dict = {
            "idx_from": [origin_trace[i] for i in dim_from],
            "dim_from": dim_from,
            "idx_to": [self.idx_trace_list[node_idx]["idx"][i] for i in dim_to],
            "dim_to": dim_to,
        }
        self.idx_view_list.append(view_dict)
580

oahzxl's avatar
oahzxl committed
581
582
583
584
585
586
587
    def _merge_equal_idx(self):
        idx_equal = copy.deepcopy(self.idx_trace_equal)
        idx_equal.reverse()
        for idx in idx_equal:
            merge_to = min(idx)
            merge_from = max(idx)
            for trace in self.idx_trace_list:
oahzxl's avatar
oahzxl committed
588
589
590
591
592
                if merge_from in trace["idx"]:
                    trace["idx"] = [
                        merge_to if i == merge_from else i for i in trace["idx"]
                    ]

oahzxl's avatar
oahzxl committed
593
    def trace_index(self):
oahzxl's avatar
oahzxl committed
594
        for idx, node in enumerate(self.nodes_list):
oahzxl's avatar
oahzxl committed
595
            if node.op == "placeholder":
oahzxl's avatar
oahzxl committed
596
                self._assign_all_index(node, idx)
oahzxl's avatar
oahzxl committed
597
598
            elif node.op == "call_method":
                if "transpose" in node.name:
oahzxl's avatar
oahzxl committed
599
                    self._assign_transpose_index(node, idx)
oahzxl's avatar
oahzxl committed
600
                elif "permute" in node.name:
oahzxl's avatar
oahzxl committed
601
                    self._assign_permute_index(node, idx)
oahzxl's avatar
oahzxl committed
602
                elif "view" in node.name or "reshape" in node.name:
oahzxl's avatar
oahzxl committed
603
                    self._assign_view_reshape_index(node, idx)
oahzxl's avatar
oahzxl committed
604
                elif "unsqueeze" in node.name:
oahzxl's avatar
oahzxl committed
605
                    self._assign_unsqueeze_index(node, idx)
oahzxl's avatar
oahzxl committed
606
                elif any(i in node.name for i in ["to", "contiguous"]):
607
                    self._assgin_no_change_index(node, idx)
oahzxl's avatar
oahzxl committed
608
609
                else:
                    raise NotImplementedError(node.name, "method not implemented yet!")
oahzxl's avatar
oahzxl committed
610
611
            elif node.op == "call_function":
                if "linear" in node.name:
oahzxl's avatar
oahzxl committed
612
                    self._assign_linear_index(node, idx)
oahzxl's avatar
oahzxl committed
613
                elif "matmul" in node.name:
oahzxl's avatar
oahzxl committed
614
                    self._assign_matmul_index(node, idx)
oahzxl's avatar
oahzxl committed
615
                elif "softmax" in node.name:
oahzxl's avatar
oahzxl committed
616
                    self._assign_softmax_index(node, idx)
oahzxl's avatar
oahzxl committed
617
                elif any(n in node.name for n in ["mul", "add", "sigmoid", "relu"]):
oahzxl's avatar
oahzxl committed
618
                    self._assign_elementwise_index(node, idx)
oahzxl's avatar
oahzxl committed
619
                elif "ones_like" in node.name:
oahzxl's avatar
oahzxl committed
620
                    self._assign_ones_like_index(node, idx)
oahzxl's avatar
oahzxl committed
621
                elif "dropout" in node.name:
oahzxl's avatar
oahzxl committed
622
                    self._assign_dropout_index(node, idx)
oahzxl's avatar
oahzxl committed
623
                elif "einsum" in node.name:
624
                    self._assign_einsum_index(node, idx)
oahzxl's avatar
oahzxl committed
625
626
627
628
                elif "getattr" in node.name:
                    continue  # get attr like shape
                elif "getitem" in node.name:
                    continue  # get item in list
oahzxl's avatar
oahzxl committed
629
                else:
oahzxl's avatar
oahzxl committed
630
631
632
633
634
                    raise NotImplementedError(
                        node.name, "function not implemented yet!"
                    )
            elif node.op == "call_module":
                if any(n in node.name for n in ["layernorm", "norm"]):
oahzxl's avatar
oahzxl committed
635
                    self._assign_layernorm_index(node, idx)
oahzxl's avatar
oahzxl committed
636
637
                else:
                    raise NotImplementedError(node.name, "module not implemented yet!")
oahzxl's avatar
oahzxl committed
638
639
640
            elif node.op == "get_attr":
                self._assign_all_index(node, idx)  # get param
            elif node.op == "output":
oahzxl's avatar
oahzxl committed
641
                continue
oahzxl's avatar
oahzxl committed
642
643
            else:
                raise NotImplementedError(node.op, "op not implemented yet!")
644
        # self._merge_equal_idx()
oahzxl's avatar
oahzxl committed
645

oahzxl's avatar
oahzxl committed
646
647
648
649
650
651
652
653
654
655
656
657
658
659
    def check_index_source(self, start_dim, start_node, start_idx, end_dim, end_node):
        """
        Check 2 given index: one index should be source of the other
        Args:
            start_idx(int): start node chunk dim
            start_node(node): start node
            end_idx(int): end node chunk dim
            end_node(node): end node

        Returns:
            bool: True if check pass
        """
        start_node_idx = _find_idx_by_name(start_node.name, self.nodes_list)
        end_node_trace = self._find_trace_from_node(end_node)
oahzxl's avatar
oahzxl committed
660
661
662
663
        end_node_trace_source = end_node_trace["source"][end_dim]
        sorted_source = sorted(
            end_node_trace_source.items(), key=lambda d: d[0], reverse=True
        )
oahzxl's avatar
oahzxl committed
664
        for node_idx, node_dim in sorted_source:
oahzxl's avatar
oahzxl committed
665
            if node_idx == start_node_idx and start_dim in node_dim:
oahzxl's avatar
oahzxl committed
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
                return True
            # it means we meet a node outside the loop, and the node is not input node
            if node_idx < start_idx:
                return False
        return False

    def check_index_compute(self, start_idx, end_dim, end_node, end_idx):
        """
        Check 2 given index: check they haven't been computed in the source trace.
        Args:
            start_idx(int): start node chunk dim
            start_node(node): start node
            end_idx(int): end node chunk dim
            end_node(node): end node

        Returns:
            bool: True if check pass
        """
        end_node_trace = self._find_trace_from_node(end_node)
oahzxl's avatar
oahzxl committed
685
        end_node_compute = end_node_trace["compute"][end_dim]
oahzxl's avatar
oahzxl committed
686
687
        if any(start_idx <= i <= end_idx for i in end_node_compute):
            return False
688
        return True
oahzxl's avatar
oahzxl committed
689

690
    def get_node_chunk_dim(self, node_from, node_from_dim, node_to):
oahzxl's avatar
oahzxl committed
691
692
693
694
695
696
697
698
        node_from_source = self._find_source_trace_from_node(node_from)
        dim_source = node_from_source[node_from_dim]
        node_to_idx = _find_idx_by_name(node_to.name, self.nodes_list)
        for k, v in dim_source.items():
            if k == node_to_idx:
                return v
        return None

699
700
701
702
703
704
    def _find_inherit_dim(self, input_node, input_dim, node):
        input_node_idx = _find_idx_by_name(input_node.name, self.nodes_list)
        node_trace_source = self._find_source_trace_from_node(node)
        for node_dim in range(len(_get_node_shape(node))):
            if (
                input_node_idx in node_trace_source[node_dim]
oahzxl's avatar
oahzxl committed
705
                and input_dim in node_trace_source[node_dim][input_node_idx]
706
            ):
oahzxl's avatar
oahzxl committed
707
708
                return node_dim
        return None
709

oahzxl's avatar
oahzxl committed
710
    def check_index_duplicate(self, chunk_infos, return_dim=False):
711
712
713
        input_dim_after_node = {}
        for input_node_idx, input_node in enumerate(chunk_infos["inputs"]):
            for k, v in chunk_infos["inputs_dim"][input_node_idx].items():
oahzxl's avatar
oahzxl committed
714
715
716
                inherit_dim = self._find_inherit_dim(input_node, v, self.nodes_list[k])
                if inherit_dim:
                    input_dim_after_node[k] = inherit_dim
717
718
719
720
721
722
723

        for node in self.nodes_list[
            chunk_infos["region"][0] : chunk_infos["region"][1] + 1
        ]:
            if _is_non_compute_node_except_placeholder(node):
                continue
            count = 0
oahzxl's avatar
oahzxl committed
724
            duplicate_dims = []
725
726
            node_trace_source = self._find_source_trace_from_node(node)
            for node_dim in range(len(_get_node_shape(node))):
oahzxl's avatar
oahzxl committed
727
728
                duplicate_dim = []
                duplicate_flag = False
729
730
731
                dim_source = node_trace_source[node_dim]
                for k, v in dim_source.items():
                    if chunk_infos["region"][0] <= k <= chunk_infos["region"][1]:
oahzxl's avatar
oahzxl committed
732
733
734
735
736
737
738
                        if k in input_dim_after_node and input_dim_after_node[k] in v:
                            duplicate_flag = True
                            duplicate_dim.append((k, v))
                duplicate_dims.append(duplicate_dim)
                if duplicate_flag:
                    count += 1

739
            if count > 1:
oahzxl's avatar
oahzxl committed
740
741
742
743
744
745
746
747
                if return_dim:
                    return False, duplicate_dims
                else:
                    return False
        if return_dim:
            return True, None
        else:
            return True
748

oahzxl's avatar
oahzxl committed
749

oahzxl's avatar
oahzxl committed
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
class FlowTracer(object):
    def __init__(self, gm) -> None:
        self.gm = gm
        self.node_list = list(gm.graph.nodes)
        self.flow_trace = {}

    def _add_trace(self, name):
        self.flow_trace[name] = []

    def _add_node(self, trace_name, node):
        self.flow_trace[trace_name].append(
            {"node": node, "inside_depend": [], "outside_depend": []}
        )

    def _add_inside_depend(self, flow_name, node, inside_depend_node):
        for i in self.flow_trace[flow_name]:
            if i["node"] == node:
                i["inside_depend"].append(inside_depend_node)
                return
        raise RuntimeError("node not found")

    def _add_outside_depend(
        self, flow_name, node, outside_depend_node, outside_depend_trace
    ):
        for i in self.flow_trace[flow_name]:
            if i["node"] == node:
                i["outside_depend"].append({outside_depend_trace: outside_depend_node})
                return
        raise RuntimeError("node not found")

    def _init_trace(self):
        for i in self.node_list:
            if i.op == "placeholder":
                self._add_trace(i.name)
                self._add_node(i.name, i)

    def _find_flow_for_node(self, node):
        if type(self.node_list[0]) != type(node):
            return None
        if _is_non_compute_node_except_placeholder(node):
            return None
        for name, trace in self.flow_trace.items():
            for i in trace:
                if node == i["node"]:
                    return name
        if any(i in node.name for i in ["ones_like"]):
            self._add_trace(node.name)
            self._add_node(node.name, node)
            return node.name
        raise RuntimeError("node not found")

    def _find_first_valid_flow(self, flow):
        for i in flow:
            if i is not None:
                return i
        raise RuntimeError("invalid flow")

    def find_node_flow(self, node):
        for name, trace in self.flow_trace.items():
            for i in trace:
                if node == i["node"]:
                    return name, i
        raise RuntimeError("invalid node")

    def _get_flow_mix_node(self, node):
        if _is_non_compute_node(node):
            return None
        _, node_trace = self.find_node_flow(node)
        if len(node_trace["outside_depend"]) == 0:
            return None
        elif len(node_trace["outside_depend"]) > 1:
            raise NotImplementedError
        vars = list(node_trace["outside_depend"][0].values())[0]
        return vars

    def _get_same_flow_node(self, node_list, node):
        name, _ = self.find_node_flow(node)
        result = []
        for i in self.flow_trace[name]:
            if i["node"] in node_list:
                result.append(i["node"])
        return result

    def trace_flow(self):
        # init trace
        self._init_trace()

        for node in self.node_list:
            # skip if non compute node
            if all(
                type(arg) != type(node) or _is_non_compute_node_except_placeholder(arg)
                for arg in node.args
            ) or _is_non_compute_node(node):
                continue

            node_input_flows = [self._find_flow_for_node(arg) for arg in node.args]

            node_domin_flow = self._find_first_valid_flow(node_input_flows)
            self._add_node(node_domin_flow, node)
            for node_input_flow, arg in zip(node_input_flows, node.args):
                if node_input_flow is None:
                    continue
                elif node_input_flow == node_domin_flow:
                    self._add_inside_depend(node_domin_flow, node, arg)
                else:
                    self._add_outside_depend(
                        node_domin_flow, node, arg, node_input_flow
                    )
        return self.flow_trace

oahzxl's avatar
oahzxl committed
860
861
862
    def _detect_flow(
        self, start_idx, start_dim, end_idx, end_dim, index_tracer: IndexTracer
    ):
oahzxl's avatar
oahzxl committed
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
        inputs, outputs = _find_chunk_compute_input_and_output_nodes(
            self.node_list[start_idx : end_idx + 1]
        )
        chunk_info = {
            "region": (start_idx, end_idx),
            "inputs": inputs,
            "inputs_non_chunk": [],
            "inputs_dim": start_dim,
            "outputs": outputs,
            "outputs_dim": end_dim,
            "args": {},
        }
        flow_block = False

        # TODO don't allow multi outputs now
        if len(outputs) > 1:
            flow_block = True
            return flow_block, chunk_info

oahzxl's avatar
oahzxl committed
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
        # for idx in range(start_idx, end_idx + 1):
        #     node = self.node_list[idx]
        #     mix_flow_node = self._get_flow_mix_node(node)
        #     if mix_flow_node is None:
        #         continue

        #     # if there is a flow mix, op must be in [mul, add, matmul]
        #     # element-wise op requires dim to be equal in every dim
        #     if any(n in node.name for n in ["mul", "add"]):
        #         for i in node.args:
        #             if type(i) == type(mix_flow_node) and i != mix_flow_node:
        #                 main_flow_var = i
        #         # if mix flow is a broadcast in chunk dim,
        #         # TODO: need to move that flow out of the chunk
        #         mix_flow_node_dim = index_tracer.get_node_chunk_dim(
        #             self.node_list[end_idx], end_dim, node
        #         )
        #         # TODO: we need to loop every dim
        #         if isinstance(mix_flow_node_dim, list):
        #             mix_flow_node_dim = mix_flow_node_dim[0]
        #         if mix_flow_node_dim is None:
        #             flow_block = True
        #             break
        #         if _get_node_shape(mix_flow_node)[mix_flow_node_dim] == 1:
        #             flow_block = False
        #             for i in self._get_same_flow_node(
        #                 chunk_info["inputs"], mix_flow_node
        #             ):
        #                 chunk_info["inputs"].remove(i)
        #         # else, we need to chunk mix var as well
        #         else:
        #             # TODO chunk another value
        #             flow_block = True
        #             break
        #     else:
        #         raise NotImplementedError("%s not implemented" % node.name)
        # if flow_block:
        #     flow_block = True
        #     return flow_block, chunk_info
oahzxl's avatar
oahzxl committed
921
922
923
924
925
926
927
928
929
930
931
932
933
934

        inputs_dim = []
        remove_inputs = []
        for input_node in chunk_info["inputs"]:
            input_dict = {}
            for user in input_node.users.keys():
                if _is_non_compute_node(user):
                    continue
                user_idx = _find_idx_by_name(user.name, self.node_list)
                dim = None
                if start_dim <= user_idx < end_idx:
                    dim = index_tracer.get_node_chunk_dim(
                        self.node_list[end_idx], end_dim, input_node
                    )
oahzxl's avatar
oahzxl committed
935
936
937
                    # TODO: we need to loop every dim
                    if isinstance(dim, list):
                        dim = dim[0]
oahzxl's avatar
oahzxl committed
938
939
940
941
942
943
944
945
946
947
948
949
950
                elif user_idx == end_idx:
                    dim = end_dim
                # n has relation with chunk dim
                if dim is not None and _get_node_shape(user)[dim] != 1:
                    input_dict[user_idx] = dim
            if len(input_dict) == 0:
                remove_inputs.append(input_node)
            else:
                inputs_dim.append(input_dict)
        chunk_info["inputs_dim"] = inputs_dim
        for i in remove_inputs:
            if i in chunk_info["inputs"]:
                chunk_info["inputs"].remove(i)
oahzxl's avatar
oahzxl committed
951
952
953
954

        duplicate_result, duplicate_dim = index_tracer.check_index_duplicate(
            chunk_info, return_dim=True
        )
oahzxl's avatar
oahzxl committed
955
956
957
958
959
960
961
962
963
964
965

        # we need to log input nodes to avoid deleteing them in the loop
        non_chunk_inputs = _find_chunk_all_input_nodes(
            self.node_list[start_idx : end_idx + 1]
        )
        for i in non_chunk_inputs:
            if i not in chunk_info["inputs"]:
                chunk_info["inputs_non_chunk"].append(i)

        return flow_block, chunk_info

oahzxl's avatar
oahzxl committed
966
967
968
969
970
971
972
973
974
975
976
977
978
979
    def _assgin_single_node_flow(
        self,
        arg_node,
        start_idx,
        end_idx,
        inputs,
        index_tracer,
        cur_node_dim,
        cur_node_compute,
        cur_node_source,
        cur_node_fix_dim,
        all_node_info,
        next_node_list,
    ):
oahzxl's avatar
oahzxl committed
980
981
982
983
        arg_idx = _find_idx_by_name(arg_node.name, index_tracer.nodes_list)
        # arg in chunk range or be inputs
        if not (start_idx <= arg_idx < end_idx):
            return True
oahzxl's avatar
oahzxl committed
984

oahzxl's avatar
oahzxl committed
985
986
987
988
989
990
991
992
993
994
995
        # find arg dim
        if cur_node_dim is not None:
            # dim is computed
            if arg_idx in cur_node_compute[cur_node_dim]:
                return False
            if arg_idx not in cur_node_source[cur_node_dim]:
                arg_dim = None
            else:
                arg_dim = cur_node_source[cur_node_dim][arg_idx][0]
        else:
            arg_dim = None
oahzxl's avatar
oahzxl committed
996

oahzxl's avatar
oahzxl committed
997
998
999
1000
1001
1002
1003
        # get fix dim
        arg_fix_dim = []
        if cur_node_dim is not None:
            for i in cur_node_fix_dim:
                fix_dim_source = cur_node_source[i]
                if arg_idx in fix_dim_source:
                    arg_fix_dim.append(fix_dim_source[arg_idx][0])
oahzxl's avatar
oahzxl committed
1004

oahzxl's avatar
oahzxl committed
1005
1006
        # if already in node_info, arg dim must be same
        if arg_node in all_node_info:
oahzxl's avatar
oahzxl committed
1007
            if all_node_info[arg_node]["chunk_dim"] != arg_dim:
oahzxl's avatar
oahzxl committed
1008
                return False
oahzxl's avatar
oahzxl committed
1009
1010
1011
            all_node_info[arg_node]["fix_dim"] = list(
                set(all_node_info[arg_node]["fix_dim"] + arg_fix_dim)
            )
oahzxl's avatar
oahzxl committed
1012
1013
        # else add it to list
        else:
oahzxl's avatar
oahzxl committed
1014
1015
            all_node_info[arg_node] = {"chunk_dim": arg_dim, "fix_dim": arg_fix_dim}

oahzxl's avatar
oahzxl committed
1016
1017
        next_node_list.append(arg_node)
        return True
oahzxl's avatar
oahzxl committed
1018
1019
1020
1021

    def flow_search(
        self, start_idx, start_dim, end_idx, end_dim, index_tracer: IndexTracer
    ):
oahzxl's avatar
oahzxl committed
1022
1023
1024
1025
1026
1027
        inputs, outputs = _find_chunk_compute_input_and_output_nodes(
            self.node_list[start_idx : end_idx + 1]
        )
        # only single ouput
        if len(outputs) > 1:
            return None
oahzxl's avatar
oahzxl committed
1028

oahzxl's avatar
oahzxl committed
1029
        cur_node_list = [index_tracer.nodes_list[end_idx]]  # start from the last node
oahzxl's avatar
oahzxl committed
1030
1031
        all_node_info = {cur_node_list[0]: {"chunk_dim": end_dim, "fix_dim": []}}

oahzxl's avatar
oahzxl committed
1032
1033
1034
1035
1036
        while len(cur_node_list) > 0:
            next_node_list = []

            for cur_node in cur_node_list:
                # get cur node info
oahzxl's avatar
oahzxl committed
1037
1038
                cur_node_chunk_dim = all_node_info[cur_node]["chunk_dim"]
                cur_node_fix_dim = all_node_info[cur_node]["fix_dim"]
oahzxl's avatar
oahzxl committed
1039
1040
                cur_node_idx = _find_idx_by_name(cur_node.name, index_tracer.nodes_list)
                if cur_node_chunk_dim:
oahzxl's avatar
oahzxl committed
1041
1042
1043
1044
1045
1046
                    cur_node_compute = index_tracer._find_compute_trace_from_node(
                        cur_node
                    )
                    cur_node_source = index_tracer._find_source_trace_from_node(
                        cur_node
                    )
oahzxl's avatar
oahzxl committed
1047
1048
                else:
                    cur_node_compute = cur_node_source = None
oahzxl's avatar
oahzxl committed
1049

oahzxl's avatar
oahzxl committed
1050
1051
1052
1053
1054
1055
1056
1057
                # get all valid args
                arg_list = []
                for arg in cur_node.args:
                    if type(arg) != type(cur_node):
                        continue
                    if _is_non_compute_node(arg):
                        continue
                    arg_list.append(arg)
oahzxl's avatar
oahzxl committed
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
                    flow_flag = self._assgin_single_node_flow(
                        arg,
                        start_idx,
                        end_idx,
                        inputs,
                        index_tracer,
                        cur_node_chunk_dim,
                        cur_node_compute,
                        cur_node_source,
                        cur_node_fix_dim,
                        all_node_info,
                        next_node_list,
                    )
oahzxl's avatar
oahzxl committed
1071
1072
                    if flow_flag == False:
                        return None
oahzxl's avatar
oahzxl committed
1073

oahzxl's avatar
oahzxl committed
1074
1075
1076
                if len(arg_list) == 2:
                    if any(i in cur_node.name for i in ["add", "mul"]):
                        for arg in arg_list:
oahzxl's avatar
oahzxl committed
1077
1078
1079
1080
1081
                            if not (
                                start_idx
                                <= _find_idx_by_name(arg.name, index_tracer.nodes_list)
                                < end_idx
                            ):
oahzxl's avatar
oahzxl committed
1082
                                continue
oahzxl's avatar
oahzxl committed
1083
1084
                            arg_chunk_dim = all_node_info[arg]["chunk_dim"]
                            arg_fix_dim = all_node_info[arg]["fix_dim"]
oahzxl's avatar
oahzxl committed
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
                            arg_shape = _get_node_shape(arg)
                            # add all dim as fix dim except chunk dim
                            for i, shape in enumerate(arg_shape):
                                if shape != 1 and i != cur_node_chunk_dim:
                                    if i == arg_chunk_dim:
                                        return None
                                    if i not in arg_fix_dim:
                                        arg_fix_dim.append(i)
                    elif "einsum" in cur_node.name:
                        pass
                    elif "matmul" in cur_node.name:
                        pass
                    else:
                        raise NotImplementedError()
            cur_node_list = next_node_list
oahzxl's avatar
oahzxl committed
1100

oahzxl's avatar
oahzxl committed
1101
1102
1103
1104
1105
1106
1107
1108
1109
        inputs_dim = []
        remove_inputs = []
        for input_node in inputs:
            input_dict = {}
            for user in input_node.users.keys():
                if _is_non_compute_node(user):
                    continue
                user_idx = _find_idx_by_name(user.name, self.node_list)
                if start_idx <= user_idx <= end_idx:
oahzxl's avatar
oahzxl committed
1110
                    chunk_dim = all_node_info[user]["chunk_dim"]
oahzxl's avatar
oahzxl committed
1111
1112
1113
1114
1115
1116
1117
1118
1119
                    if chunk_dim is not None:
                        input_dict[user_idx] = chunk_dim
            if len(input_dict) == 0:
                remove_inputs.append(input_node)
            else:
                inputs_dim.append(input_dict)
        for i in remove_inputs:
            if i in inputs:
                inputs.remove(i)
oahzxl's avatar
oahzxl committed
1120

oahzxl's avatar
oahzxl committed
1121
1122
1123
1124
1125
1126
1127
1128
1129
        chunk_info = {
            "region": (start_idx, end_idx),
            "inputs": inputs,
            "inputs_non_chunk": [],
            "inputs_dim": inputs_dim,
            "outputs": outputs,
            "outputs_dim": end_dim,
            "args": {},
        }
oahzxl's avatar
oahzxl committed
1130

oahzxl's avatar
oahzxl committed
1131
1132
1133
1134
        # move useless nodes ahead of loop
        # get all possible prepose nodes
        maybe_prepose_nodes = []
        for node, node_info in all_node_info.items():
oahzxl's avatar
oahzxl committed
1135
            if node_info["chunk_dim"] is None:
oahzxl's avatar
oahzxl committed
1136
                maybe_prepose_nodes.append(node)
oahzxl's avatar
oahzxl committed
1137
1138
1139
1140
        maybe_prepose_nodes.sort(
            key=lambda x: _find_idx_by_name(x.name, index_tracer.nodes_list),
            reverse=True,
        )  # from last node to first node
oahzxl's avatar
oahzxl committed
1141
1142
1143
1144
1145
1146
        prepose_nodes = []
        # set every node as root, search its args, if all legal, turn root and args as prepose nodes
        while len(maybe_prepose_nodes) > 0:
            tmp_cur_prepose_nodes = [maybe_prepose_nodes[0]]
            tmp_cur_related_prepose_nodes = []
            prepose_flag = True
oahzxl's avatar
oahzxl committed
1147

oahzxl's avatar
oahzxl committed
1148
1149
1150
1151
1152
1153
1154
1155
1156
            # loop cur node's all arg until out of chunk
            while len(tmp_cur_prepose_nodes) > 0:
                tmp_next_prepose_nodes = []
                tmp_cur_related_prepose_nodes.extend(tmp_cur_prepose_nodes)
                for cur_prepose_node in tmp_cur_prepose_nodes:
                    for cur_prepose_node_arg in cur_prepose_node.args:
                        if type(cur_prepose_node_arg) != type(cur_prepose_node):
                            continue
                        # out of loop
oahzxl's avatar
oahzxl committed
1157
1158
1159
1160
1161
1162
1163
                        if not (
                            start_idx
                            <= _find_idx_by_name(
                                cur_prepose_node_arg.name, self.node_list
                            )
                            < end_idx
                        ):
oahzxl's avatar
oahzxl committed
1164
1165
1166
                            continue
                        # compute op in loop
                        elif cur_prepose_node_arg in all_node_info:
oahzxl's avatar
oahzxl committed
1167
                            if all_node_info[cur_prepose_node_arg]["chunk_dim"] is None:
oahzxl's avatar
oahzxl committed
1168
1169
1170
                                tmp_next_prepose_nodes.append(cur_prepose_node_arg)
                            else:
                                prepose_flag = False
oahzxl's avatar
oahzxl committed
1171
1172
1173
                                break
                                break
                                break
oahzxl's avatar
oahzxl committed
1174
1175
1176
1177
                        # non compute op
                        else:
                            tmp_next_prepose_nodes.append(cur_prepose_node_arg)
                tmp_cur_prepose_nodes = tmp_next_prepose_nodes
oahzxl's avatar
oahzxl committed
1178

oahzxl's avatar
oahzxl committed
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
            if prepose_flag == False:
                maybe_prepose_nodes.remove(maybe_prepose_nodes[0])
                continue
            else:
                for n in tmp_cur_related_prepose_nodes:
                    if n not in prepose_nodes:
                        prepose_nodes.append(n)
                    if n in maybe_prepose_nodes:
                        maybe_prepose_nodes.remove(n)
        # sort by index
oahzxl's avatar
oahzxl committed
1189
1190
1191
        prepose_nodes.sort(
            key=lambda x: _find_idx_by_name(x.name, index_tracer.nodes_list)
        )
oahzxl's avatar
oahzxl committed
1192
        chunk_info["args"]["prepose_nodes"] = prepose_nodes
oahzxl's avatar
oahzxl committed
1193

oahzxl's avatar
oahzxl committed
1194
        # we need to log input nodes to avoid deleteing them in the loop
oahzxl's avatar
oahzxl committed
1195
1196
1197
1198
        chunk_node_list = self.node_list[start_idx : end_idx + 1]
        # also need to get some prepose node's arg out of non_chunk_inputs
        for n in prepose_nodes:
            chunk_node_list.remove(n)
oahzxl's avatar
oahzxl committed
1199
        non_chunk_inputs = _find_chunk_all_input_nodes(chunk_node_list)
oahzxl's avatar
oahzxl committed
1200
        for i in non_chunk_inputs:
oahzxl's avatar
oahzxl committed
1201
            if i not in chunk_info["inputs"]:
oahzxl's avatar
oahzxl committed
1202
                chunk_info["inputs_non_chunk"].append(i)
oahzxl's avatar
oahzxl committed
1203

oahzxl's avatar
oahzxl committed
1204
1205
        return chunk_info

oahzxl's avatar
oahzxl committed
1206

oahzxl's avatar
oahzxl committed
1207
class MemoryEstimator(object):
oahzxl's avatar
oahzxl committed
1208
1209
    def __init__(self, index_tracer: IndexTracer) -> None:
        self.index_tracer = index_tracer
oahzxl's avatar
oahzxl committed
1210

oahzxl's avatar
oahzxl committed
1211
    def _get_meta_node_size(self, x):
oahzxl's avatar
oahzxl committed
1212
        x = x.meta["tensor_meta"]
oahzxl's avatar
oahzxl committed
1213
1214
        x = x.numel * torch.tensor([], dtype=x.dtype).element_size()
        return x
oahzxl's avatar
oahzxl committed
1215

oahzxl's avatar
oahzxl committed
1216
    def _get_output_node(self, n):
oahzxl's avatar
oahzxl committed
1217
1218
1219
1220
1221
        fwd_out = {
            x.uuid: x
            for x in n.meta["fwd_out"]
            if isinstance(x, torch.Tensor) and hasattr(x, "uuid")
        }
oahzxl's avatar
oahzxl committed
1222
1223
        out_size = activation_size(fwd_out)
        out_node = [n.name] if out_size > 0 else []
oahzxl's avatar
oahzxl committed
1224
1225
        # if any(i in n.name for i in ['transpose', 'permute', 'view']):
        #     out_size = 0
oahzxl's avatar
oahzxl committed
1226
        return out_size, out_node
oahzxl's avatar
oahzxl committed
1227

oahzxl's avatar
oahzxl committed
1228
1229
    def _get_output_node_size(self, n):
        return self._get_output_node(n)[0]
oahzxl's avatar
oahzxl committed
1230

oahzxl's avatar
oahzxl committed
1231
1232
    def _add_active_node(self, n, active_list):
        new_active = self._get_output_node(n)[1]
oahzxl's avatar
oahzxl committed
1233
        if n.op == "placeholder":
oahzxl's avatar
oahzxl committed
1234
            new_active.append(n.name)
oahzxl's avatar
oahzxl committed
1235
1236
1237
        for i in new_active:
            if i not in active_list:
                active_list.append(i)
oahzxl's avatar
oahzxl committed
1238

oahzxl's avatar
oahzxl committed
1239
    def _get_delete_node(self, user, user_to_last_uses, to_keep=None):
oahzxl's avatar
oahzxl committed
1240
1241
        delete_size = 0
        delete_node = []
oahzxl's avatar
oahzxl committed
1242
        if user.op not in ("output",):
oahzxl's avatar
oahzxl committed
1243
            nodes_to_delete = user_to_last_uses.get(user, [])
oahzxl's avatar
oahzxl committed
1244
1245
1246
1247
1248
1249
1250
1251
            if to_keep is not None:
                keep_list = []
                for n in nodes_to_delete:
                    if n.name in to_keep:
                        keep_list.append(n)
                for n in keep_list:
                    if n in nodes_to_delete:
                        nodes_to_delete.remove(n)
oahzxl's avatar
oahzxl committed
1252
1253
1254
1255
1256
1257
            if len(nodes_to_delete):
                out_node = [self._get_output_node(i) for i in nodes_to_delete]
                delete_size = sum([i[0] for i in out_node])
                for i in range(len(out_node)):
                    if out_node[i][0] > 0:
                        delete_node.append(out_node[i][1][0])
oahzxl's avatar
oahzxl committed
1258
                    elif nodes_to_delete[i].op == "placeholder":
oahzxl's avatar
oahzxl committed
1259
                        delete_node.append(nodes_to_delete[i].name)
oahzxl's avatar
oahzxl committed
1260
1261
                    # elif any(j in nodes_to_delete[i].name for j in ['transpose', 'permute', 'view']):
                    #     delete_node.append(nodes_to_delete[i].name)
oahzxl's avatar
oahzxl committed
1262
        return delete_size, delete_node
oahzxl's avatar
oahzxl committed
1263

oahzxl's avatar
oahzxl committed
1264
1265
    def _get_delete_node_size(self, user, user_to_last_uses, to_keep):
        return self._get_delete_node(user, user_to_last_uses, to_keep)[0]
oahzxl's avatar
oahzxl committed
1266

oahzxl's avatar
oahzxl committed
1267
    def _remove_deactive_node(self, user, user_to_last_uses, active_list):
oahzxl's avatar
oahzxl committed
1268
1269
        delete_node = self._get_delete_node(user, user_to_last_uses)[1]
        for i in delete_node:
oahzxl's avatar
oahzxl committed
1270
1271
            if i in active_list:
                active_list.remove(i)
oahzxl's avatar
oahzxl committed
1272
1273
1274
1275

    def _get_chunk_inputs_size(
        self, chunk_inputs, chunk_inputs_non_chunk, node_list, chunk_end_idx
    ):
oahzxl's avatar
oahzxl committed
1276
1277
1278
        nodes_to_delete = []
        for chunk_input in chunk_inputs + chunk_inputs_non_chunk:
            chunk_input_users = chunk_input.users.keys()
oahzxl's avatar
oahzxl committed
1279
1280
1281
            chunk_input_users_idx = [
                _find_idx_by_name(i.name, node_list) for i in chunk_input_users
            ]
oahzxl's avatar
oahzxl committed
1282
1283
1284
1285
1286
1287
            if all(i <= chunk_end_idx for i in chunk_input_users_idx):
                if chunk_input not in nodes_to_delete:
                    nodes_to_delete.append(chunk_input)
        out_node = [self._get_output_node(i) for i in nodes_to_delete]
        delete_size = sum([i[0] for i in out_node])
        return delete_size
oahzxl's avatar
oahzxl committed
1288

oahzxl's avatar
oahzxl committed
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
    def _get_last_usr(self, nodes):
        node_to_last_use: Dict[Node, Node] = {}
        user_to_last_uses: Dict[Node, List[Node]] = {}

        def register_last_uses(n: Node, user: Node):
            if n not in node_to_last_use:
                node_to_last_use[n] = user
                user_to_last_uses.setdefault(user, []).append(n)

        for node in reversed(nodes):
            map_arg(node.args, lambda n: register_last_uses(n, node))
            map_arg(node.kwargs, lambda n: register_last_uses(n, node))
        return user_to_last_uses

    def _get_contiguous_memory(self, node, not_contiguous_list, delete=False):
        mem = 0
oahzxl's avatar
oahzxl committed
1305
1306
        not_contiguous_ops = ["permute"]
        inherit_contiguous_ops = ["transpose", "view"]
oahzxl's avatar
oahzxl committed
1307

oahzxl's avatar
oahzxl committed
1308
1309
1310
        if node.op == "call_function" and any(
            n in node.name for n in ["matmul", "reshape"]
        ):
oahzxl's avatar
oahzxl committed
1311
1312
1313
1314
            for n in node.args:
                if n in not_contiguous_list:
                    # matmul won't change origin tensor, but create a tmp copy
                    mem += self._get_output_node_size(n)
oahzxl's avatar
oahzxl committed
1315
        elif node.op == "call_module":
oahzxl's avatar
oahzxl committed
1316
1317
1318
1319
1320
            for n in node.args:
                if n in not_contiguous_list:
                    # module will just make origin tensor to contiguous
                    if delete:
                        not_contiguous_list.remove(n)
oahzxl's avatar
oahzxl committed
1321
1322
1323
        elif node.op == "call_method" and any(
            i in node.name for i in not_contiguous_ops
        ):
oahzxl's avatar
oahzxl committed
1324
1325
1326
1327
            if node not in not_contiguous_list:
                not_contiguous_list.append(node)
        return mem

oahzxl's avatar
oahzxl committed
1328
1329
1330
1331
1332
    def _get_chunk_ratio(self, node, chunk_inputs, chunk_inputs_dim, chunk_size):
        node_shape = _get_node_shape(node)
        node_source = self.index_tracer._find_source_trace_from_node(node)
        for (input_node, input_node_dim) in zip(chunk_inputs, chunk_inputs_dim):
            for k, v in input_node_dim.items():
oahzxl's avatar
oahzxl committed
1333
                # TODO: inherit dim should be list too, int now
oahzxl's avatar
oahzxl committed
1334
1335
1336
                inherit_dim = self.index_tracer._find_inherit_dim(
                    input_node, v, self.index_tracer.nodes_list[k]
                )
oahzxl's avatar
oahzxl committed
1337
1338
1339
1340
                if k == _find_idx_by_name(node.name, self.index_tracer.nodes_list):
                    chunk_ratio = float(chunk_size) / node_shape[inherit_dim]
                    return chunk_ratio
                for dim, source in enumerate(node_source):
oahzxl's avatar
oahzxl committed
1341
                    if k in source and inherit_dim in source[k]:
oahzxl's avatar
oahzxl committed
1342
1343
                        chunk_ratio = float(chunk_size) / node_shape[dim]
                        return chunk_ratio
oahzxl's avatar
oahzxl committed
1344
        return 1.0
oahzxl's avatar
oahzxl committed
1345

oahzxl's avatar
oahzxl committed
1346
    def _get_chunk_delete_node_size(
oahzxl's avatar
oahzxl committed
1347
        self, user, user_to_last_uses, chunk_ratio, chunk_inputs_names
oahzxl's avatar
oahzxl committed
1348
    ):
oahzxl's avatar
oahzxl committed
1349
1350
        # if any(j in user.name for j in ['transpose', 'permute', 'view']):
        #     return 0
oahzxl's avatar
oahzxl committed
1351
        if user.op in ("placeholder", "output"):
oahzxl's avatar
oahzxl committed
1352
1353
1354
1355
            return 0
        nodes_to_delete = user_to_last_uses.get(user, [])
        delete_size = 0
        for n in nodes_to_delete:
oahzxl's avatar
oahzxl committed
1356
1357
1358
            if n.name in chunk_inputs_names:
                continue
            delete_size += self._get_output_node_size(n) * chunk_ratio
oahzxl's avatar
oahzxl committed
1359
        return delete_size
oahzxl's avatar
oahzxl committed
1360

oahzxl's avatar
oahzxl committed
1361
1362
1363
1364
    def _print_mem_log(self, log, nodes, title=None):
        if title:
            print(title)
        for idx, (l, n) in enumerate(zip(log, nodes)):
oahzxl's avatar
oahzxl committed
1365
            print("%s:%.2f \t" % (n.name, l), end="")
oahzxl's avatar
oahzxl committed
1366
1367
1368
1369
            if (idx + 1) % 3 == 0:
                print("")
        print("\n")

oahzxl's avatar
oahzxl committed
1370
1371
1372
1373
    def _print_compute_op_mem_log(self, log, nodes, title=None):
        if title:
            print(title)
        for idx, (l, n) in enumerate(zip(log, nodes)):
oahzxl's avatar
oahzxl committed
1374
            if n.op in ["placeholder", "get_attr", "output"]:
oahzxl's avatar
oahzxl committed
1375
                continue
oahzxl's avatar
oahzxl committed
1376
            if any(i in n.name for i in ["getitem", "getattr"]):
oahzxl's avatar
oahzxl committed
1377
                continue
oahzxl's avatar
oahzxl committed
1378
            print("%s:%.2f \t" % (n.name, l), end="")
oahzxl's avatar
oahzxl committed
1379
1380
1381
            if (idx + 1) % 3 == 0:
                print("")
        print("\n")
oahzxl's avatar
oahzxl committed
1382
1383
1384
1385

    def estimate_chunk_inference_mem(
        self,
        gm: torch.fx.GraphModule,
oahzxl's avatar
oahzxl committed
1386
        chunk_infos=None,
oahzxl's avatar
oahzxl committed
1387
    ):
oahzxl's avatar
oahzxl committed
1388
1389
1390
        act_memory = 0.0
        act_memory_peak_log = []
        act_memory_after_node_log = []
oahzxl's avatar
oahzxl committed
1391
1392
        active_node_list = []
        active_node_list_log = []
oahzxl's avatar
oahzxl committed
1393
        not_contiguous_list = []
oahzxl's avatar
oahzxl committed
1394
        node_list = list(gm.graph.nodes)
oahzxl's avatar
oahzxl committed
1395
1396
1397
        user_to_last_uses = self._get_last_usr(node_list)
        user_to_last_uses_no_free_var = self._get_last_usr(node_list)
        _delete_free_var_from_last_use(user_to_last_uses_no_free_var)
oahzxl's avatar
oahzxl committed
1398

oahzxl's avatar
oahzxl committed
1399
        use_chunk = True if chunk_infos is not None else False
oahzxl's avatar
oahzxl committed
1400
        chunk_within = False
oahzxl's avatar
oahzxl committed
1401
        chunk_region_idx = None
oahzxl's avatar
oahzxl committed
1402
        chunk_ratio = 1  # use it to estimate chunk mem
oahzxl's avatar
oahzxl committed
1403
1404
        chunk_size = 1
        chunk_inputs_names = []
oahzxl's avatar
oahzxl committed
1405

oahzxl's avatar
oahzxl committed
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
        if use_chunk:
            chunk_regions = [i["region"] for i in chunk_infos]
            chunk_starts = [i[0] for i in chunk_regions]
            chunk_ends = [i[1] for i in chunk_regions]
            chunk_inputs = [i["inputs"] for i in chunk_infos]
            chunk_inputs_non_chunk = [i["inputs_non_chunk"] for i in chunk_infos]
            chunk_inputs_dim = [i["inputs_dim"] for i in chunk_infos]
            chunk_inputs_names = [j.name for i in chunk_inputs for j in i] + [
                j.name for i in chunk_inputs_non_chunk for j in i
            ]
            chunk_outputs = [i["outputs"][0] for i in chunk_infos]
oahzxl's avatar
oahzxl committed
1417
1418
1419

        for idx, node in enumerate(node_list):
            # if node in chunk start nodes, change chunk ratio and add chunk_tensor
oahzxl's avatar
oahzxl committed
1420
            if use_chunk and idx in chunk_starts:
oahzxl's avatar
oahzxl committed
1421
                chunk_within = True
oahzxl's avatar
oahzxl committed
1422
                chunk_region_idx = chunk_starts.index(idx)
oahzxl's avatar
oahzxl committed
1423
1424
1425
                act_memory += self._get_output_node_size(
                    chunk_outputs[chunk_region_idx]
                ) / (1024**2)
oahzxl's avatar
oahzxl committed
1426
1427

            # determine chunk ratio for current node
oahzxl's avatar
oahzxl committed
1428
            # TODO: adapt to prepose node memory
oahzxl's avatar
oahzxl committed
1429
            if chunk_within:
oahzxl's avatar
oahzxl committed
1430
                chunk_ratio = self._get_chunk_ratio(
oahzxl's avatar
oahzxl committed
1431
1432
1433
1434
                    node,
                    chunk_inputs[chunk_region_idx],
                    chunk_inputs_dim[chunk_region_idx],
                    chunk_size,
oahzxl's avatar
oahzxl committed
1435
1436
                )

oahzxl's avatar
oahzxl committed
1437
            # if node is placeholder, just add the size of the node
oahzxl's avatar
oahzxl committed
1438
1439
            if node.op == "placeholder":
                act_memory += self._get_meta_node_size(node) * chunk_ratio / (1024**2)
oahzxl's avatar
oahzxl committed
1440
1441
                act_memory_peak_log.append(act_memory)
            # skip output
oahzxl's avatar
oahzxl committed
1442
            elif node.op == "output":
oahzxl's avatar
oahzxl committed
1443
                continue
oahzxl's avatar
oahzxl committed
1444
1445
1446
1447
1448
            # no change for non compute node
            elif _is_non_compute_node_except_placeholder(node):
                act_memory_peak_log.append(act_memory)
            # node is a compute op
            # calculate tmp, output node and delete node memory
oahzxl's avatar
oahzxl committed
1449
            else:
oahzxl's avatar
oahzxl committed
1450
                # forward memory
oahzxl's avatar
oahzxl committed
1451
                # TODO: contiguous_memory still not accurate for matmul, view, reshape and transpose
oahzxl's avatar
oahzxl committed
1452
1453
1454
1455
1456
1457
1458
1459
                act_memory += (
                    self._get_contiguous_memory(node, not_contiguous_list)
                    * chunk_ratio
                    / (1024**2)
                )
                act_memory += (
                    self._get_output_node_size(node) * chunk_ratio / (1024**2)
                )
oahzxl's avatar
oahzxl committed
1460
1461
1462
                # record max act memory
                act_memory_peak_log.append(act_memory)
                # delete useless memory
oahzxl's avatar
oahzxl committed
1463
1464
1465
1466
1467
                act_memory -= (
                    self._get_contiguous_memory(node, not_contiguous_list, delete=True)
                    * chunk_ratio
                    / (1024**2)
                )
oahzxl's avatar
oahzxl committed
1468
                # delete unused vars not in chunk_input_list
oahzxl's avatar
oahzxl committed
1469
                # we can't delete input nodes until chunk ends
oahzxl's avatar
oahzxl committed
1470
                if chunk_within:
oahzxl's avatar
oahzxl committed
1471
                    act_memory -= self._get_chunk_delete_node_size(
oahzxl's avatar
oahzxl committed
1472
1473
1474
                        node,
                        user_to_last_uses_no_free_var,
                        chunk_ratio,
oahzxl's avatar
oahzxl committed
1475
                        chunk_inputs_names,
oahzxl's avatar
oahzxl committed
1476
                    ) / (1024**2)
oahzxl's avatar
oahzxl committed
1477
                else:
oahzxl's avatar
oahzxl committed
1478
                    act_memory -= self._get_delete_node_size(
oahzxl's avatar
oahzxl committed
1479
                        node, user_to_last_uses_no_free_var, chunk_inputs_names
oahzxl's avatar
oahzxl committed
1480
                    ) / (1024**2)
oahzxl's avatar
oahzxl committed
1481

oahzxl's avatar
oahzxl committed
1482
            # log active node, only effective without chunk
oahzxl's avatar
oahzxl committed
1483
1484
1485
1486
            self._add_active_node(node, active_node_list)
            self._remove_deactive_node(node, user_to_last_uses, active_node_list)

            # if node in chunk end nodes, restore chunk settings
oahzxl's avatar
oahzxl committed
1487
            if use_chunk and idx in chunk_ends:
oahzxl's avatar
oahzxl committed
1488
1489
1490
                act_memory -= (
                    self._get_output_node_size(node) * chunk_ratio / (1024**2)
                )
oahzxl's avatar
oahzxl committed
1491
                act_memory -= self._get_chunk_inputs_size(
oahzxl's avatar
oahzxl committed
1492
1493
                    chunk_inputs[chunk_region_idx],
                    chunk_inputs_non_chunk[chunk_region_idx],
oahzxl's avatar
oahzxl committed
1494
                    node_list,
oahzxl's avatar
oahzxl committed
1495
1496
                    chunk_regions[chunk_region_idx][1],
                ) / (1024**2)
oahzxl's avatar
oahzxl committed
1497
                chunk_within = False
oahzxl's avatar
oahzxl committed
1498
                chunk_ratio = 1
oahzxl's avatar
oahzxl committed
1499
                chunk_region_idx = None
oahzxl's avatar
oahzxl committed
1500

oahzxl's avatar
oahzxl committed
1501
            act_memory_after_node_log.append(act_memory)
oahzxl's avatar
oahzxl committed
1502
            active_node_list_log.append(copy.deepcopy(active_node_list))
oahzxl's avatar
oahzxl committed
1503

oahzxl's avatar
oahzxl committed
1504
        print("with chunk" if use_chunk else "without chunk")
oahzxl's avatar
oahzxl committed
1505
1506
1507
1508
        # self._print_mem_log(act_memory_peak_log, node_list, "peak")
        # self._print_mem_log(act_memory_after_node_log, node_list, "after")
        self._print_compute_op_mem_log(act_memory_peak_log, node_list, "peak")
        self._print_compute_op_mem_log(act_memory_after_node_log, node_list, "after")
oahzxl's avatar
oahzxl committed
1509

oahzxl's avatar
oahzxl committed
1510
1511
1512
1513
1514
1515
1516
1517
1518
        # param_memory = parameter_size(gm)
        # all_memory = act_memory + param_memory
        return act_memory_peak_log, act_memory_after_node_log, active_node_list_log


class ChunkRegionSearch(object):
    def __init__(self, gm) -> None:
        self.gm = gm
        self.node_list = list(gm.graph.nodes)
oahzxl's avatar
oahzxl committed
1519
        self.index_tracer = IndexTracer(gm)
oahzxl's avatar
oahzxl committed
1520
1521
1522
        self.index_tracer.trace_index()
        self.flow_tracer = FlowTracer(gm)
        self.flow_tracer.trace_flow()
oahzxl's avatar
oahzxl committed
1523
        self.memory_estimator = MemoryEstimator(self.index_tracer)
oahzxl's avatar
oahzxl committed
1524
1525
1526

    def _find_peak_node(self, mem_peak):
        max_value = max(mem_peak)
oahzxl's avatar
oahzxl committed
1527
        max_idx = mem_peak.index(max_value)
oahzxl's avatar
oahzxl committed
1528
        return max_idx
oahzxl's avatar
oahzxl committed
1529

oahzxl's avatar
oahzxl committed
1530
1531
1532
    def _get_free_var(self):
        free_var_idx = []
        for idx, n in enumerate(self.node_list):
oahzxl's avatar
oahzxl committed
1533
            if n.op == "placeholder":
oahzxl's avatar
oahzxl committed
1534
1535
                free_var_idx.append(idx)
        return free_var_idx
oahzxl's avatar
oahzxl committed
1536

oahzxl's avatar
oahzxl committed
1537
1538
1539
1540
1541
1542
1543
1544
    def _get_min_free_var(self, active_node_list, free_vars):
        min_len = 999
        for idx, n in enumerate(active_node_list):
            if idx in free_vars:
                continue
            if len(n) < min_len:
                min_len = len(n)
        return min_len
oahzxl's avatar
oahzxl committed
1545

1546
    def _search_max_chunk_region(self, active_node, peak_node, chunk_regions):
oahzxl's avatar
oahzxl committed
1547
        free_vars = self._get_free_var()
oahzxl's avatar
oahzxl committed
1548
1549
1550
1551
        free_var_num = len(free_vars)
        active_node_num = [len(i) for i in active_node]
        min_active_node_num = min(active_node_num[free_var_num:])
        threshold = max(free_var_num, min_active_node_num)
oahzxl's avatar
oahzxl committed
1552

oahzxl's avatar
oahzxl committed
1553
        # from peak_node to free_var
oahzxl's avatar
oahzxl committed
1554
1555
        inside_flag = False
        chunk_region_start = free_var_num
oahzxl's avatar
oahzxl committed
1556
        for i in range(peak_node, -1, -1):
oahzxl's avatar
oahzxl committed
1557
1558
1559
            if active_node_num[i] <= threshold:
                inside_flag = True
            if inside_flag and active_node_num[i] > threshold:
oahzxl's avatar
oahzxl committed
1560
1561
                chunk_region_start = i + 1
                break
oahzxl's avatar
oahzxl committed
1562

oahzxl's avatar
oahzxl committed
1563
        # from peak_node to len-2
oahzxl's avatar
oahzxl committed
1564
        inside_flag = False
oahzxl's avatar
oahzxl committed
1565
        chunk_region_end = len(active_node) - 1
oahzxl's avatar
oahzxl committed
1566
        for i in range(peak_node, len(active_node)):
oahzxl's avatar
oahzxl committed
1567
1568
1569
            if active_node_num[i] <= threshold:
                inside_flag = True
            if inside_flag and active_node_num[i] > threshold:
oahzxl's avatar
oahzxl committed
1570
                chunk_region_end = i
oahzxl's avatar
oahzxl committed
1571
                break
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586

        for i in chunk_regions:
            region = i["region"]
            if chunk_region_start >= region[0] and chunk_region_end <= region[1]:
                return None
            elif (
                region[0] <= chunk_region_start <= region[1]
                and chunk_region_end > region[1]
            ):
                chunk_region_start = region[1] + 1
            elif (
                region[0] <= chunk_region_end <= region[1]
                and chunk_region_start < region[0]
            ):
                chunk_region_end = region[0] - 1
oahzxl's avatar
oahzxl committed
1587
        return chunk_region_start, chunk_region_end
oahzxl's avatar
oahzxl committed
1588

oahzxl's avatar
oahzxl committed
1589
    def _is_not_compute(self, trace, chunk_range, dim_idx):
oahzxl's avatar
oahzxl committed
1590
        if trace["idx"][dim_idx] not in trace["compute"]:
oahzxl's avatar
oahzxl committed
1591
            return True
oahzxl's avatar
oahzxl committed
1592
1593
1594
1595
        if trace["idx"][dim_idx] in trace["compute"] and all(
            i < chunk_range[0] or i > chunk_range[1]
            for i in trace["compute"][trace["idx"][dim_idx]]
        ):
oahzxl's avatar
oahzxl committed
1596
1597
            return True
        return False
oahzxl's avatar
oahzxl committed
1598

oahzxl's avatar
oahzxl committed
1599
    def _find_free_dim(self, input_trace, output_trace, start_idx, end_idx):
oahzxl's avatar
oahzxl committed
1600
1601
1602
        start_traces = input_trace[start_idx]
        end_trace = output_trace[end_idx]
        end_node = self.node_list[end_idx]
oahzxl's avatar
oahzxl committed
1603
        chunk_infos = []
oahzxl's avatar
oahzxl committed
1604
        for end_dim, end_trace_idx in enumerate(end_trace["idx"]):
oahzxl's avatar
oahzxl committed
1605
            if len(start_traces) > 1:
1606
                continue
oahzxl's avatar
oahzxl committed
1607
            for start_node, start_trace in start_traces.items():
oahzxl's avatar
oahzxl committed
1608
                for start_dim, start_trace_idx in enumerate(start_trace["idx"]):
oahzxl's avatar
oahzxl committed
1609
                    # dim size cannot be 1
oahzxl's avatar
oahzxl committed
1610
1611
1612
1613
                    if (
                        _get_node_shape(end_node)[end_dim] == 1
                        or _get_node_shape(start_node)[start_dim] == 1
                    ):
oahzxl's avatar
oahzxl committed
1614
1615
1616
                        continue
                    # check index source align
                    if not self.index_tracer.check_index_source(
oahzxl's avatar
oahzxl committed
1617
1618
                        start_dim, start_node, start_idx, end_dim, end_node
                    ):
oahzxl's avatar
oahzxl committed
1619
1620
1621
                        continue
                    # check index copmute
                    if not self.index_tracer.check_index_compute(
oahzxl's avatar
oahzxl committed
1622
1623
                        start_idx, end_dim, end_node, end_idx
                    ):
oahzxl's avatar
oahzxl committed
1624
                        continue
oahzxl's avatar
oahzxl committed
1625
1626
                    # flow search
                    chunk_info = self.flow_tracer.flow_search(
oahzxl's avatar
oahzxl committed
1627
                        start_idx, start_dim, end_idx, end_dim, self.index_tracer
oahzxl's avatar
oahzxl committed
1628
                    )
oahzxl's avatar
oahzxl committed
1629
                    if chunk_info is None:
oahzxl's avatar
oahzxl committed
1630
                        continue
1631
1632
1633
                    # check index copmute
                    if not self.index_tracer.check_index_duplicate(chunk_info):
                        continue
oahzxl's avatar
oahzxl committed
1634
1635
                    chunk_infos.append(chunk_info)
        return chunk_infos
oahzxl's avatar
oahzxl committed
1636

oahzxl's avatar
oahzxl committed
1637
1638
    def _search_possible_chunk_regions(self, max_chunk_region, peak_node):
        possible_chunk_region = []
oahzxl's avatar
oahzxl committed
1639
        output_trace = copy.deepcopy(self.index_tracer.idx_trace_list)
oahzxl's avatar
oahzxl committed
1640
1641
1642
1643
        input_trace = []  # trace of a node's input nodes
        for _, n in enumerate(self.node_list):
            cur_trace = {}
            for arg in n.args:
oahzxl's avatar
oahzxl committed
1644
1645
1646
                if type(arg) == type(n) and not _is_non_compute_node_except_placeholder(
                    arg
                ):
oahzxl's avatar
oahzxl committed
1647
1648
1649
1650
                    cur_trace[arg] = self.index_tracer._find_trace_from_node(arg)
            input_trace.append(cur_trace)

        for start_idx in range(max_chunk_region[0], peak_node + 1):
oahzxl's avatar
oahzxl committed
1651
            for end_idx in range(peak_node, max_chunk_region[1] + 1):
oahzxl's avatar
oahzxl committed
1652
                # skip non compute nodes
oahzxl's avatar
oahzxl committed
1653
1654
1655
                if _is_non_compute_node(
                    self.node_list[start_idx]
                ) or _is_non_compute_node(self.node_list[end_idx]):
oahzxl's avatar
oahzxl committed
1656
                    continue
oahzxl's avatar
oahzxl committed
1657

oahzxl's avatar
oahzxl committed
1658
                # select free dim
oahzxl's avatar
oahzxl committed
1659
1660
1661
                chunk_info = self._find_free_dim(
                    input_trace, output_trace, start_idx, end_idx
                )
oahzxl's avatar
oahzxl committed
1662
1663
                if len(chunk_info) > 0:
                    possible_chunk_region.extend(chunk_info)
oahzxl's avatar
oahzxl committed
1664
        return possible_chunk_region
oahzxl's avatar
oahzxl committed
1665

oahzxl's avatar
oahzxl committed
1666
    def _search_best_chunk_region(self, possible_chunk_regions, chunk_infos):
oahzxl's avatar
oahzxl committed
1667
        max_region_range = 0
oahzxl's avatar
oahzxl committed
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
        best_region = None
        while len(possible_chunk_regions) > 0:
            for i in possible_chunk_regions:
                if i["region"][1] - i["region"][0] > max_region_range:
                    best_region = i
                    max_region_range = i["region"][1] - i["region"][0]
            if self._is_legal_region(best_region, chunk_infos):
                break
            possible_chunk_regions.remove(i)
            max_region_range = 0
            best_region = None
        return best_region
oahzxl's avatar
oahzxl committed
1680

oahzxl's avatar
oahzxl committed
1681
1682
1683
1684
1685
1686
1687
1688
    def _is_legal_region(self, cur_chunk_info, chunk_infos):
        (chunk_region_start, chunk_region_end) = cur_chunk_info["region"]
        if cur_chunk_info in chunk_infos:
            return False
        if chunk_region_end < chunk_region_start:
            return False
        for i in chunk_infos:
            region = i["region"]
oahzxl's avatar
oahzxl committed
1689
1690
1691
1692
            if not (
                (chunk_region_start > region[1] and chunk_region_end > region[1])
                or (chunk_region_start < region[0] and chunk_region_end < region[0])
            ):
oahzxl's avatar
oahzxl committed
1693
1694
                return False
        return True
oahzxl's avatar
oahzxl committed
1695

1696
    def _step_search(self, mem_peak, active_node, chunk_regions):
oahzxl's avatar
oahzxl committed
1697
        peak_node = self._find_peak_node(mem_peak)
1698
1699
1700
1701
1702
        max_chunk_region = self._search_max_chunk_region(
            active_node, peak_node, chunk_regions
        )
        if max_chunk_region == None:
            return None
oahzxl's avatar
oahzxl committed
1703
1704
1705
        possible_chunk_regions = self._search_possible_chunk_regions(
            max_chunk_region, peak_node
        )
oahzxl's avatar
oahzxl committed
1706
1707
1708
        best_chunk_region = self._search_best_chunk_region(
            possible_chunk_regions, chunk_regions
        )
oahzxl's avatar
oahzxl committed
1709
        return best_chunk_region
oahzxl's avatar
oahzxl committed
1710

oahzxl's avatar
oahzxl committed
1711
1712
1713
1714
1715
    def _stop_search(self, init_mem_peak, mem_peak):
        sorted_init_mem_peak = sorted(init_mem_peak)
        if max(mem_peak) < sorted_init_mem_peak[int(len(sorted_init_mem_peak) * 0.5)]:
            return True
        return False
oahzxl's avatar
oahzxl committed
1716

oahzxl's avatar
oahzxl committed
1717
    def search_region(self):
oahzxl's avatar
oahzxl committed
1718
        chunk_infos = []
oahzxl's avatar
oahzxl committed
1719
1720
1721
1722
1723
        (
            init_mem_peak,
            _,
            active_node,
        ) = self.memory_estimator.estimate_chunk_inference_mem(self.gm)
oahzxl's avatar
oahzxl committed
1724
        mem_peak = init_mem_peak
oahzxl's avatar
oahzxl committed
1725

oahzxl's avatar
oahzxl committed
1726
        while True:
oahzxl's avatar
oahzxl committed
1727
1728
            chunk_info = self._step_search(mem_peak, active_node, chunk_infos)
            if chunk_info is None:
oahzxl's avatar
oahzxl committed
1729
                break
oahzxl's avatar
oahzxl committed
1730

oahzxl's avatar
oahzxl committed
1731
            chunk_infos.append(chunk_info)
oahzxl's avatar
oahzxl committed
1732
1733
1734
1735
            (
                mem_peak,
                _,
                active_node,
oahzxl's avatar
oahzxl committed
1736
            ) = self.memory_estimator.estimate_chunk_inference_mem(self.gm, chunk_infos)
oahzxl's avatar
oahzxl committed
1737
1738
            if self._stop_search(init_mem_peak, mem_peak):
                break
oahzxl's avatar
oahzxl committed
1739
        return chunk_infos
oahzxl's avatar
oahzxl committed
1740
1741


oahzxl's avatar
oahzxl committed
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
def _gen_chunk_slice_dim(chunk_dim, chunk_idx_name, shape):
    new_shape = "["
    for idx, i in enumerate(shape):
        if idx == chunk_dim:
            new_shape += "%s:%s + chunk_size" % (chunk_idx_name, chunk_idx_name)
        else:
            new_shape += ":"
        new_shape += ", "
    new_shape = new_shape[:-2] + "]"
    return new_shape


oahzxl's avatar
oahzxl committed
1754
1755
1756
1757
1758
1759
1760
1761
1762
def _gen_loop_start(chunk_input, chunk_output, chunk_ouput_dim, chunk_size=2):
    input_node = chunk_input[0]
    out_shape = _get_node_shape(chunk_output)
    out_str = str(list(out_shape))
    context = (
        "chunk_result = torch.empty(%s, dtype=%s.dtype, device=%s.device); chunk_size = %d\nfor chunk_idx in range"
        % (out_str, input_node.name, input_node.name, chunk_size)
    )
    context += "(0, %d, chunk_size):\n" % (out_shape[chunk_ouput_dim])
oahzxl's avatar
oahzxl committed
1763
1764
1765
    return context


oahzxl's avatar
oahzxl committed
1766
1767
1768
def _gen_loop_end(
    chunk_inputs, chunk_non_compute_inputs, chunk_outputs, chunk_outputs_dim, node_list
):
oahzxl's avatar
oahzxl committed
1769
1770
    chunk_outputs_name = chunk_outputs.name
    chunk_outputs_idx = _find_idx_by_name(chunk_outputs_name, node_list)
oahzxl's avatar
oahzxl committed
1771
    chunk_output_shape = chunk_outputs.meta["tensor_meta"].shape
oahzxl's avatar
oahzxl committed
1772
1773
1774
    chunk_slice = _gen_chunk_slice_dim(
        chunk_outputs_dim, "chunk_idx", chunk_output_shape
    )
oahzxl's avatar
oahzxl committed
1775
1776
1777
1778
1779
    context = "    chunk_result%s = %s;  %s = None\n" % (
        chunk_slice,
        chunk_outputs_name,
        chunk_outputs_name,
    )
oahzxl's avatar
oahzxl committed
1780
1781
1782
    context += (
        chunk_outputs_name + " = chunk_result;  chunk_result = None;  chunk_size = None"
    )
oahzxl's avatar
oahzxl committed
1783

oahzxl's avatar
oahzxl committed
1784
    # determine if its the last use for chunk input
oahzxl's avatar
oahzxl committed
1785
    for chunk_input in chunk_inputs + chunk_non_compute_inputs:
oahzxl's avatar
oahzxl committed
1786
1787
1788
1789
1790
1791
1792
        if all(
            [
                _find_idx_by_name(user.name, node_list) <= chunk_outputs_idx
                for user in chunk_input.users.keys()
            ]
        ):
            context += ";  %s = None" % chunk_input.name
oahzxl's avatar
oahzxl committed
1793
1794

    context += "\n"
oahzxl's avatar
oahzxl committed
1795
1796
    return context

oahzxl's avatar
init  
oahzxl committed
1797

oahzxl's avatar
oahzxl committed
1798
1799
1800
1801
1802
1803
1804
1805
1806
def _find_chunk_all_input_nodes(nodes: List[Node]):
    """
    Find non-compute input and output node names.
    input nodes are nodes used in the list
    output nodes are nodes will use nodes in the list
    """
    input_nodes = []
    for node in nodes:
        for input_node in node._input_nodes.keys():
oahzxl's avatar
oahzxl committed
1807
            if input_node not in nodes and input_node not in input_nodes:
oahzxl's avatar
oahzxl committed
1808
1809
1810
1811
1812
                input_nodes.append(input_node)
    return input_nodes


def _find_chunk_compute_input_and_output_nodes(nodes: List[Node]):
oahzxl's avatar
oahzxl committed
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
    """
    Find non-compute input and output node names.
    input nodes are nodes used in the list
    output nodes are nodes will use nodes in the list
    """
    input_nodes = []
    output_nodes = []

    # if a node has an input node which is not in the node list
    # we treat that input node as the input of the checkpoint function
    for node in nodes:
        for input_node in node._input_nodes.keys():
oahzxl's avatar
oahzxl committed
1825
1826
1827
1828
1829
            if (
                input_node not in nodes
                and input_node not in input_nodes
                and not _is_non_compute_node_except_placeholder(input_node)
            ):
oahzxl's avatar
oahzxl committed
1830
1831
1832
1833
1834
1835
                input_nodes.append(input_node)

    # if a node has a user node which is not in the node list
    # we treat that user node as the node receiving the current node output
    for node in nodes:
        for output_node in node.users.keys():
oahzxl's avatar
oahzxl committed
1836
1837
1838
            if (
                output_node not in nodes
                and node not in output_nodes
oahzxl's avatar
oahzxl committed
1839
                and not _is_non_compute_node_except_placeholder_output(output_node)
oahzxl's avatar
oahzxl committed
1840
            ):
oahzxl's avatar
oahzxl committed
1841
1842
1843
1844
1845
                output_nodes.append(node)

    return input_nodes, output_nodes


oahzxl's avatar
oahzxl committed
1846
1847
1848
1849
1850
def _find_idx_by_name(name, nodes_list):
    for idx, node in enumerate(nodes_list):
        if node.name == name:
            return idx
    raise RuntimeError("name %s not found in node list" % name)
oahzxl's avatar
init  
oahzxl committed
1851
1852


oahzxl's avatar
oahzxl committed
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
def _replace_name(context, name_from, name_to):
    patterns = [(" ", " "), (" ", "."), (" ", ","), ("(", ")"), ("(", ",")]
    for p in patterns:
        source = p[0] + name_from + p[1]
        target = p[0] + name_to + p[1]
        if source in context:
            context = context.replace(source, target)
    return context


oahzxl's avatar
oahzxl committed
1863
1864
1865
1866
1867
1868
1869
1870
1871
def emit_code_with_chunk(
    body,
    ckpt_func,
    nodes,
    emit_node_func,
    delete_unused_value_func,
    meta_nodes,
    meta_graph,
):
oahzxl's avatar
init  
oahzxl committed
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
    """Emit code with nested activation checkpoint
    When we detect some of the node.activation_checkpoint is a List, we will use
    this function to emit the activation checkpoint codes.

    Args:
        body: forward code
        ckpt_func: checkpoint functions code
        nodes: graph.nodes
        emit_node_func: function to emit node
        delete_unused_value_func: function to remove the unused value
    """
oahzxl's avatar
oahzxl committed
1883
    node_list = list(nodes)
oahzxl's avatar
init  
oahzxl committed
1884

oahzxl's avatar
oahzxl committed
1885
    # find the chunk regions
oahzxl's avatar
oahzxl committed
1886
1887
    chunk_region_search = ChunkRegionSearch(meta_graph)
    chunk_search = chunk_region_search.search_region()
oahzxl's avatar
init  
oahzxl committed
1888

oahzxl's avatar
oahzxl committed
1889
1890
1891
    chunk_regions = [i["region"] for i in chunk_search]
    chunk_starts = [i[0] for i in chunk_regions]
    chunk_ends = [i[1] for i in chunk_regions]
oahzxl's avatar
oahzxl committed
1892

oahzxl's avatar
oahzxl committed
1893
1894
1895
    chunk_inputs = [i["inputs"] for i in chunk_search]
    chunk_inputs_non_chunk = [i["inputs_non_chunk"] for i in chunk_search]
    chunk_inputs_dim = [i["inputs_dim"] for i in chunk_search]
oahzxl's avatar
oahzxl committed
1896
1897
    chunk_inputs_names = [j.name for i in chunk_inputs for j in i] + [
        j.name for i in chunk_inputs_non_chunk for j in i
oahzxl's avatar
oahzxl committed
1898
    ]
oahzxl's avatar
oahzxl committed
1899
1900
1901

    chunk_outputs = [i["outputs"][0] for i in chunk_search]
    chunk_outputs_dim = [i["outputs_dim"] for i in chunk_search]
oahzxl's avatar
oahzxl committed
1902

oahzxl's avatar
oahzxl committed
1903
    chunk_prepose_nodes = [i["args"]["prepose_nodes"] for i in chunk_search]
oahzxl's avatar
oahzxl committed
1904

oahzxl's avatar
init  
oahzxl committed
1905
    node_idx = 0
oahzxl's avatar
oahzxl committed
1906
    region_idx = 0
oahzxl's avatar
oahzxl committed
1907
1908
    within_chunk_region = False

oahzxl's avatar
oahzxl committed
1909
    while node_idx < len(node_list):
oahzxl's avatar
oahzxl committed
1910
        node = node_list[node_idx]
oahzxl's avatar
init  
oahzxl committed
1911

oahzxl's avatar
oahzxl committed
1912
1913
        if node_idx in chunk_starts:
            within_chunk_region = True
1914
            region_idx = chunk_starts.index(node_idx)
oahzxl's avatar
oahzxl committed
1915
1916
1917
1918
1919
            # add prepose nodes
            for i in chunk_prepose_nodes[region_idx]:
                prepose_node = node_list[_find_idx_by_name(i.name, node_list)]
                emit_node_func(prepose_node, body)
                delete_unused_value_func(prepose_node, body, chunk_inputs_names)
oahzxl's avatar
oahzxl committed
1920
            # add for loop
oahzxl's avatar
oahzxl committed
1921
1922
            body.append(
                _gen_loop_start(
oahzxl's avatar
oahzxl committed
1923
1924
1925
                    chunk_inputs[region_idx],
                    chunk_outputs[region_idx],
                    chunk_outputs_dim[region_idx],
oahzxl's avatar
oahzxl committed
1926
1927
                )
            )
oahzxl's avatar
init  
oahzxl committed
1928

oahzxl's avatar
oahzxl committed
1929
        if within_chunk_region:
oahzxl's avatar
oahzxl committed
1930
1931
1932
1933
1934
1935
            if any(node.name == i.name for i in chunk_prepose_nodes[region_idx]):
                pass
            else:
                emit_node_func(node, body)
                # replace input var with chunk var
                for input_node_idx, input_node in enumerate(chunk_inputs[region_idx]):
oahzxl's avatar
oahzxl committed
1936
1937
1938
                    for idx, dim in chunk_inputs_dim[region_idx][
                        input_node_idx
                    ].items():
oahzxl's avatar
oahzxl committed
1939
1940
1941
1942
1943
1944
1945
1946
1947
                        if idx == node_idx:
                            chunk_slice = _gen_chunk_slice_dim(
                                dim, "chunk_idx", _get_node_shape(input_node)
                            )
                            body[-1] = _replace_name(
                                body[-1], input_node.name, input_node.name + chunk_slice
                            )
                body[-1] = "    " + body[-1]
                delete_unused_value_func(node, body, chunk_inputs_names)
oahzxl's avatar
oahzxl committed
1948
1949
1950
1951
        else:
            emit_node_func(node, body)
            if node_idx not in chunk_inputs:
                delete_unused_value_func(node, body, chunk_inputs_names)
oahzxl's avatar
init  
oahzxl committed
1952

oahzxl's avatar
oahzxl committed
1953
        if node_idx in chunk_ends:
oahzxl's avatar
oahzxl committed
1954
1955
            body.append(
                _gen_loop_end(
oahzxl's avatar
oahzxl committed
1956
1957
1958
                    chunk_inputs[region_idx],
                    chunk_inputs_non_chunk[region_idx],
                    chunk_outputs[region_idx],
oahzxl's avatar
oahzxl committed
1959
1960
                    chunk_outputs_dim[region_idx],
                    node_list,
oahzxl's avatar
oahzxl committed
1961
1962
                )
            )
oahzxl's avatar
oahzxl committed
1963
            within_chunk_region = False
oahzxl's avatar
init  
oahzxl committed
1964

oahzxl's avatar
oahzxl committed
1965
        node_idx += 1
oahzxl's avatar
init  
oahzxl committed
1966
1967
1968
1969


if CODEGEN_AVAILABLE:

oahzxl's avatar
oahzxl committed
1970
    class ChunkCodeGen(CodeGen):
oahzxl's avatar
oahzxl committed
1971
1972
        def __init__(self, meta_graph):
            super().__init__()
oahzxl's avatar
oahzxl committed
1973
            self.meta_graph = meta_graph
oahzxl's avatar
oahzxl committed
1974
            self.meta_node = list(meta_graph.graph.nodes)
oahzxl's avatar
init  
oahzxl committed
1975

oahzxl's avatar
oahzxl committed
1976
1977
1978
        def _gen_python_code(
            self, nodes, root_module: str, namespace: _Namespace
        ) -> PythonCode:
oahzxl's avatar
init  
oahzxl committed
1979
1980
1981
1982
1983
1984
            free_vars: List[str] = []
            body: List[str] = []
            globals_: Dict[str, Any] = {}
            wrapped_fns: Dict[str, None] = {}

            # Wrap string in list to pass by reference
oahzxl's avatar
oahzxl committed
1985
            maybe_return_annotation: List[str] = [""]
oahzxl's avatar
init  
oahzxl committed
1986
1987
1988
1989
1990
1991
1992
1993
1994

            def add_global(name_hint: str, obj: Any):
                """Add an obj to be tracked as a global.

                We call this for names that reference objects external to the
                Graph, like functions or types.

                Returns: the global name that should be used to reference 'obj' in generated source.
                """
oahzxl's avatar
oahzxl committed
1995
1996
1997
                if (
                    _is_from_torch(obj) and obj != torch.device
                ):  # to support registering torch.device
oahzxl's avatar
init  
oahzxl committed
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
                    # HACK: workaround for how torch custom ops are registered. We
                    # can't import them like normal modules so they must retain their
                    # fully qualified name.
                    return _get_qualified_name(obj)

                # normalize the name hint to get a proper identifier
                global_name = namespace.create_name(name_hint, obj)

                if global_name in globals_:
                    assert globals_[global_name] is obj
                    return global_name
                globals_[global_name] = obj
                return global_name

            # set _custom_builtins here so that we needn't import colossalai in forward
oahzxl's avatar
oahzxl committed
2013
2014
2015
            _custom_builtins["colossalai"] = _CustomBuiltin(
                "import colossalai", colossalai
            )
oahzxl's avatar
init  
oahzxl committed
2016
2017
2018
2019
2020
2021
2022
2023

            # Pre-fill the globals table with registered builtins.
            for name, (_, obj) in _custom_builtins.items():
                add_global(name, obj)

            def type_repr(o: Any):
                if o == ():
                    # Empty tuple is used for empty tuple type annotation Tuple[()]
oahzxl's avatar
oahzxl committed
2024
                    return "()"
oahzxl's avatar
init  
oahzxl committed
2025
2026
2027

                typename = _type_repr(o)

oahzxl's avatar
oahzxl committed
2028
                if hasattr(o, "__origin__"):
oahzxl's avatar
init  
oahzxl committed
2029
2030
2031
2032
                    # This is a generic type, e.g. typing.List[torch.Tensor]
                    origin_type = _origin_type_map.get(o.__origin__, o.__origin__)
                    origin_typename = add_global(_type_repr(origin_type), origin_type)

oahzxl's avatar
oahzxl committed
2033
                    if hasattr(o, "__args__"):
oahzxl's avatar
init  
oahzxl committed
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
                        # Assign global names for each of the inner type variables.
                        args = [type_repr(arg) for arg in o.__args__]

                        if len(args) == 0:
                            # Bare type, such as `typing.Tuple` with no subscript
                            # This code-path used in Python < 3.9
                            return origin_typename

                        return f'{origin_typename}[{",".join(args)}]'
                    else:
                        # Bare type, such as `typing.Tuple` with no subscript
                        # This code-path used in Python 3.9+
                        return origin_typename

                # Common case: this is a regular module name like 'foo.bar.baz'
                return add_global(typename, o)

oahzxl's avatar
oahzxl committed
2051
2052
2053
            def _format_args(
                args: Tuple[Argument, ...], kwargs: Dict[str, Argument]
            ) -> str:
oahzxl's avatar
init  
oahzxl committed
2054
2055
                def _get_repr(arg):
                    # Handle NamedTuples (if it has `_fields`) via add_global.
oahzxl's avatar
oahzxl committed
2056
                    if isinstance(arg, tuple) and hasattr(arg, "_fields"):
oahzxl's avatar
init  
oahzxl committed
2057
2058
2059
2060
2061
                        qualified_name = _get_qualified_name(type(arg))
                        global_name = add_global(qualified_name, type(arg))
                        return f"{global_name}{repr(tuple(arg))}"
                    return repr(arg)

oahzxl's avatar
oahzxl committed
2062
2063
                args_s = ", ".join(_get_repr(a) for a in args)
                kwargs_s = ", ".join(f"{k} = {_get_repr(v)}" for k, v in kwargs.items())
oahzxl's avatar
init  
oahzxl committed
2064
                if args_s and kwargs_s:
oahzxl's avatar
oahzxl committed
2065
                    return f"{args_s}, {kwargs_s}"
oahzxl's avatar
init  
oahzxl committed
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
                return args_s or kwargs_s

            # Run through reverse nodes and record the first instance of a use
            # of a given node. This represents the *last* use of the node in the
            # execution order of the program, which we will use to free unused
            # values
            node_to_last_use: Dict[Node, Node] = {}
            user_to_last_uses: Dict[Node, List[Node]] = {}

            def register_last_uses(n: Node, user: Node):
                if n not in node_to_last_use:
                    node_to_last_use[n] = user
                    user_to_last_uses.setdefault(user, []).append(n)

            for node in reversed(nodes):
                map_arg(node.args, lambda n: register_last_uses(n, node))
                map_arg(node.kwargs, lambda n: register_last_uses(n, node))
oahzxl's avatar
oahzxl committed
2083

oahzxl's avatar
oahzxl committed
2084
            _delete_free_var_from_last_use(user_to_last_uses)
oahzxl's avatar
oahzxl committed
2085

oahzxl's avatar
init  
oahzxl committed
2086
            # NOTE: we add a variable to distinguish body and ckpt_func
oahzxl's avatar
oahzxl committed
2087
            def delete_unused_values(user: Node, body, to_keep=[]):
oahzxl's avatar
init  
oahzxl committed
2088
2089
2090
2091
2092
                """
                Delete values after their last use. This ensures that values that are
                not used in the remainder of the code are freed and the memory usage
                of the code is optimal.
                """
oahzxl's avatar
oahzxl committed
2093
                if user.op == "placeholder":
oahzxl's avatar
init  
oahzxl committed
2094
                    return
oahzxl's avatar
oahzxl committed
2095
2096
                if user.op == "output":
                    body.append("\n")
oahzxl's avatar
init  
oahzxl committed
2097
2098
                    return
                nodes_to_delete = user_to_last_uses.get(user, [])
oahzxl's avatar
oahzxl committed
2099
                nodes_to_delete = [i for i in nodes_to_delete if i.name not in to_keep]
oahzxl's avatar
init  
oahzxl committed
2100
                if len(nodes_to_delete):
oahzxl's avatar
oahzxl committed
2101
2102
2103
2104
                    to_delete_str = " = ".join(
                        [repr(n) for n in nodes_to_delete] + ["None"]
                    )
                    body.append(f";  {to_delete_str}\n")
oahzxl's avatar
init  
oahzxl committed
2105
                else:
oahzxl's avatar
oahzxl committed
2106
                    body.append("\n")
oahzxl's avatar
init  
oahzxl committed
2107
2108
2109

            # NOTE: we add a variable to distinguish body and ckpt_func
            def emit_node(node: Node, body):
oahzxl's avatar
oahzxl committed
2110
2111
2112
2113
                maybe_type_annotation = (
                    "" if node.type is None else f" : {type_repr(node.type)}"
                )
                if node.op == "placeholder":
oahzxl's avatar
init  
oahzxl committed
2114
                    assert isinstance(node.target, str)
oahzxl's avatar
oahzxl committed
2115
2116
2117
2118
2119
2120
2121
                    maybe_default_arg = (
                        "" if not node.args else f" = {repr(node.args[0])}"
                    )
                    free_vars.append(
                        f"{node.target}{maybe_type_annotation}{maybe_default_arg}"
                    )
                    raw_name = node.target.replace("*", "")
oahzxl's avatar
init  
oahzxl committed
2122
                    if raw_name != repr(node):
oahzxl's avatar
oahzxl committed
2123
                        body.append(f"{repr(node)} = {raw_name}\n")
oahzxl's avatar
init  
oahzxl committed
2124
                    return
oahzxl's avatar
oahzxl committed
2125
                elif node.op == "call_method":
oahzxl's avatar
init  
oahzxl committed
2126
2127
                    assert isinstance(node.target, str)
                    body.append(
oahzxl's avatar
oahzxl committed
2128
2129
2130
                        f"{repr(node)}{maybe_type_annotation} = {_format_target(repr(node.args[0]), node.target)}"
                        f"({_format_args(node.args[1:], node.kwargs)})"
                    )
oahzxl's avatar
init  
oahzxl committed
2131
                    return
oahzxl's avatar
oahzxl committed
2132
                elif node.op == "call_function":
oahzxl's avatar
init  
oahzxl committed
2133
2134
                    assert callable(node.target)
                    # pretty print operators
oahzxl's avatar
oahzxl committed
2135
2136
2137
2138
                    if (
                        node.target.__module__ == "_operator"
                        and node.target.__name__ in magic_methods
                    ):
oahzxl's avatar
init  
oahzxl committed
2139
                        assert isinstance(node.args, tuple)
oahzxl's avatar
oahzxl committed
2140
2141
2142
2143
                        body.append(
                            f"{repr(node)}{maybe_type_annotation} = "
                            f"{magic_methods[node.target.__name__].format(*(repr(a) for a in node.args))}"
                        )
oahzxl's avatar
init  
oahzxl committed
2144
2145
2146
2147
                        return

                    # pretty print inplace operators; required for jit.script to work properly
                    # not currently supported in normal FX graphs, but generated by torchdynamo
oahzxl's avatar
oahzxl committed
2148
2149
2150
2151
2152
2153
2154
2155
                    if (
                        node.target.__module__ == "_operator"
                        and node.target.__name__ in inplace_methods
                    ):
                        body.append(
                            f"{inplace_methods[node.target.__name__].format(*(repr(a) for a in node.args))};  "
                            f"{repr(node)}{maybe_type_annotation} = {repr(node.args[0])}"
                        )
oahzxl's avatar
init  
oahzxl committed
2156
2157
2158
2159
2160
2161
                        return

                    qualified_name = _get_qualified_name(node.target)
                    global_name = add_global(qualified_name, node.target)
                    # special case for getattr: node.args could be 2-argument or 3-argument
                    # 2-argument: attribute access; 3-argument: fall through to attrib function call with default value
oahzxl's avatar
oahzxl committed
2162
2163
2164
2165
2166
2167
2168
                    if (
                        global_name == "getattr"
                        and isinstance(node.args, tuple)
                        and isinstance(node.args[1], str)
                        and node.args[1].isidentifier()
                        and len(node.args) == 2
                    ):
oahzxl's avatar
init  
oahzxl committed
2169
                        body.append(
oahzxl's avatar
oahzxl committed
2170
2171
                            f"{repr(node)}{maybe_type_annotation} = {_format_target(repr(node.args[0]), node.args[1])}"
                        )
oahzxl's avatar
init  
oahzxl committed
2172
2173
                        return
                    body.append(
oahzxl's avatar
oahzxl committed
2174
2175
2176
                        f"{repr(node)}{maybe_type_annotation} = {global_name}({_format_args(node.args, node.kwargs)})"
                    )
                    if node.meta.get("is_wrapped", False):
oahzxl's avatar
init  
oahzxl committed
2177
2178
                        wrapped_fns.setdefault(global_name)
                    return
oahzxl's avatar
oahzxl committed
2179
                elif node.op == "call_module":
oahzxl's avatar
init  
oahzxl committed
2180
                    assert isinstance(node.target, str)
oahzxl's avatar
oahzxl committed
2181
2182
2183
2184
                    body.append(
                        f"{repr(node)}{maybe_type_annotation} = "
                        f"{_format_target(root_module, node.target)}({_format_args(node.args, node.kwargs)})"
                    )
oahzxl's avatar
init  
oahzxl committed
2185
                    return
oahzxl's avatar
oahzxl committed
2186
                elif node.op == "get_attr":
oahzxl's avatar
init  
oahzxl committed
2187
                    assert isinstance(node.target, str)
oahzxl's avatar
oahzxl committed
2188
2189
2190
                    body.append(
                        f"{repr(node)}{maybe_type_annotation} = {_format_target(root_module, node.target)}"
                    )
oahzxl's avatar
init  
oahzxl committed
2191
                    return
oahzxl's avatar
oahzxl committed
2192
                elif node.op == "output":
oahzxl's avatar
init  
oahzxl committed
2193
2194
2195
2196
                    if node.type is not None:
                        maybe_return_annotation[0] = f" -> {type_repr(node.type)}"
                    body.append(self.generate_output(node.args[0]))
                    return
oahzxl's avatar
oahzxl committed
2197
                raise NotImplementedError(f"node: {node.op} {node.target}")
oahzxl's avatar
init  
oahzxl committed
2198
2199
2200
2201
2202
2203

            # Modified for activation checkpointing
            ckpt_func = []

            # if any node has a list of labels for activation_checkpoint, we
            # will use nested type of activation checkpoint codegen
oahzxl's avatar
oahzxl committed
2204
2205
2206
2207
2208
2209
2210
2211
2212
            emit_code_with_chunk(
                body,
                ckpt_func,
                nodes,
                emit_node,
                delete_unused_values,
                self.meta_node,
                self.meta_graph,
            )
oahzxl's avatar
init  
oahzxl committed
2213
2214
2215
2216
2217

            if len(body) == 0:
                # If the Graph has no non-placeholder nodes, no lines for the body
                # have been emitted. To continue to have valid Python code, emit a
                # single pass statement
oahzxl's avatar
oahzxl committed
2218
                body.append("pass\n")
oahzxl's avatar
init  
oahzxl committed
2219
2220

            if len(wrapped_fns) > 0:
oahzxl's avatar
oahzxl committed
2221
2222
2223
2224
                wrap_name = add_global("wrap", torch.fx.wrap)
                wrap_stmts = "\n".join(
                    [f'{wrap_name}("{name}")' for name in wrapped_fns]
                )
oahzxl's avatar
init  
oahzxl committed
2225
            else:
oahzxl's avatar
oahzxl committed
2226
                wrap_stmts = ""
oahzxl's avatar
init  
oahzxl committed
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236

            if self._body_transformer:
                body = self._body_transformer(body)

            for name, value in self.additional_globals():
                add_global(name, value)

            # as we need colossalai.utils.checkpoint, we need to import colossalai
            # in forward function
            prologue = self.gen_fn_def(free_vars, maybe_return_annotation[0])
oahzxl's avatar
oahzxl committed
2237
            prologue = "".join(ckpt_func) + prologue
oahzxl's avatar
init  
oahzxl committed
2238
2239
            prologue = prologue

oahzxl's avatar
oahzxl committed
2240
2241
            code = "".join(body)
            code = "\n".join("    " + line for line in code.split("\n"))
oahzxl's avatar
init  
oahzxl committed
2242
2243
2244
2245
            fn_code = f"""
{wrap_stmts}

{prologue}
oahzxl's avatar
oahzxl committed
2246
{code}"""
oahzxl's avatar
oahzxl committed
2247
            # print(fn_code)
oahzxl's avatar
init  
oahzxl committed
2248
            return PythonCode(fn_code, globals_)