|
| 1 | +from os import path |
| 2 | +import sys |
| 3 | +import traceback |
| 4 | + |
| 5 | +from cupy.cuda import memory_hook |
| 6 | + |
| 7 | + |
| 8 | +class PeakMemoryLineProfileHook(memory_hook.MemoryHook): |
| 9 | + name = 'LineProfileHook' |
| 10 | + |
| 11 | + def __init__(self, running_peak_root_file_names, max_depth=0): |
| 12 | + self._memory_frames = {} |
| 13 | + self._root = MemoryFrame(None, None) |
| 14 | + self._filename = path.abspath(__file__) |
| 15 | + self._max_depth = max_depth |
| 16 | + self.running_peak_root_file_names = running_peak_root_file_names |
| 17 | + |
| 18 | + # callback |
| 19 | + def malloc_preprocess(self, device_id, size, mem_size): |
| 20 | + self._create_frame_tree(used_bytes=mem_size) |
| 21 | + |
| 22 | + # callback |
| 23 | + def alloc_preprocess(self, device_id, mem_size): |
| 24 | + self._create_frame_tree(acquired_bytes=mem_size) |
| 25 | + |
| 26 | + def free_preprocess(self, **kwargs): |
| 27 | + mem_size = kwargs.get("mem_size") |
| 28 | + if mem_size is not None: |
| 29 | + self._create_frame_tree(freed_bytes=mem_size) |
| 30 | + |
| 31 | + def _create_frame_tree(self, used_bytes=0, acquired_bytes=0, freed_bytes=0): |
| 32 | + self._root.used_bytes += used_bytes |
| 33 | + self._root.acquired_bytes += acquired_bytes |
| 34 | + self._root.freed_bytes += freed_bytes |
| 35 | + parent = self._root |
| 36 | + for depth, stackframe in enumerate(self._extract_stackframes()): |
| 37 | + if 0 < self._max_depth <= depth + 1: |
| 38 | + break |
| 39 | + memory_frame = self._add_frame(parent, stackframe) |
| 40 | + memory_frame.used_bytes += used_bytes |
| 41 | + memory_frame.acquired_bytes += acquired_bytes |
| 42 | + memory_frame.freed_bytes += freed_bytes |
| 43 | + parent = memory_frame |
| 44 | + |
| 45 | + def _extract_stackframes(self): |
| 46 | + stackframes = traceback.extract_stack() |
| 47 | + stackframes = [StackFrame(st) for st in stackframes] |
| 48 | + stackframes = [ |
| 49 | + st for st in stackframes if st.filename != self._filename] |
| 50 | + return stackframes |
| 51 | + |
| 52 | + def _key_frame(self, parent, stackframe): |
| 53 | + return (parent, |
| 54 | + stackframe.filename, |
| 55 | + stackframe.lineno, |
| 56 | + stackframe.name) |
| 57 | + |
| 58 | + def _add_frame(self, parent, stackframe): |
| 59 | + key = self._key_frame(parent, stackframe) |
| 60 | + if key in self._memory_frames: |
| 61 | + memory_frame = self._memory_frames[key] |
| 62 | + else: |
| 63 | + memory_frame = MemoryFrame(parent, stackframe) |
| 64 | + self._memory_frames[key] = memory_frame |
| 65 | + return memory_frame |
| 66 | + |
| 67 | + def print_report(self, file=sys.stdout): |
| 68 | + """Prints a report of line memory profiling.""" |
| 69 | + line = '_root (%s, %s, %s)\n' % self._root.humanized_bytes() |
| 70 | + file.write(line) |
| 71 | + |
| 72 | + running_peak_bytes = [0] |
| 73 | + running_used_bytes = [0] |
| 74 | + for child in self._root.children: |
| 75 | + self._print_frame(child, running_peak_bytes, running_used_bytes, depth=1, file=file) |
| 76 | + file.flush() |
| 77 | + |
| 78 | + def _print_frame(self, memory_frame, running_peak_bytes, running_used_bytes, depth=0, file=sys.stdout): |
| 79 | + indent = ' ' * (depth * 2) |
| 80 | + st = memory_frame.stackframe |
| 81 | + used_bytes, acquired_bytes, freed_bytes = memory_frame.humanized_bytes() |
| 82 | + |
| 83 | + humanized_running_peak_bytes = None |
| 84 | + humanized_running_used_bytes = None |
| 85 | + if path.basename(st.filename) in self.running_peak_root_file_names: |
| 86 | + running_used_bytes[0] += memory_frame.used_bytes |
| 87 | + running_peak_bytes[0] = max(running_peak_bytes[0], running_used_bytes[0]) |
| 88 | + running_used_bytes[0] -= memory_frame.freed_bytes |
| 89 | + |
| 90 | + humanized_running_peak_bytes = MemoryFrame.humanized_size(running_peak_bytes[0]) |
| 91 | + humanized_running_used_bytes = MemoryFrame.humanized_size(running_used_bytes[0]) |
| 92 | + |
| 93 | + line = '%s%s:%s:%s (%s, %s, %s, %s, %s)\n' % ( |
| 94 | + indent, st.filename, st.lineno, st.name, |
| 95 | + used_bytes, acquired_bytes, freed_bytes, humanized_running_peak_bytes, humanized_running_used_bytes) |
| 96 | + file.write(line) |
| 97 | + for child in memory_frame.children: |
| 98 | + self._print_frame(child, running_peak_bytes, running_used_bytes, depth=depth + 1, file=file) |
| 99 | + |
| 100 | + |
| 101 | +class StackFrame(object): |
| 102 | + """Compatibility layer for outputs of traceback.extract_stack(). |
| 103 | +
|
| 104 | + Attributes: |
| 105 | + filename (string): filename |
| 106 | + lineno (int): line number |
| 107 | + name (string): function name |
| 108 | + """ |
| 109 | + |
| 110 | + def __init__(self, obj): |
| 111 | + if isinstance(obj, tuple): # < 3.5 |
| 112 | + self.filename = obj[0] |
| 113 | + self.lineno = obj[1] |
| 114 | + self.name = obj[2] |
| 115 | + else: # >= 3.5 FrameSummary |
| 116 | + self.filename = obj.filename |
| 117 | + self.lineno = obj.lineno |
| 118 | + self.name = obj.name |
| 119 | + |
| 120 | + |
| 121 | +class MemoryFrame(object): |
| 122 | + """A single stack frame along with sum of memory usage at the frame. |
| 123 | +
|
| 124 | + Attributes: |
| 125 | + stackframe (FrameSummary): stackframe from traceback.extract_stack(). |
| 126 | + parent (MemoryFrame): parent frame, that is, caller. |
| 127 | + children (list of MemoryFrame): child frames, that is, callees. |
| 128 | + used_bytes (int): memory bytes that users used from CuPy memory pool. |
| 129 | + acquired_bytes (int): memory bytes that CuPy memory pool acquired |
| 130 | + freed_bytes (int): memory bytes that were released to the CuPy memory pool |
| 131 | + from GPU device. |
| 132 | + """ |
| 133 | + |
| 134 | + def __init__(self, parent, stackframe): |
| 135 | + self.stackframe = stackframe |
| 136 | + self.children = [] |
| 137 | + self._set_parent(parent) |
| 138 | + self.used_bytes = 0 |
| 139 | + self.acquired_bytes = 0 |
| 140 | + self.freed_bytes = 0 |
| 141 | + |
| 142 | + def humanized_bytes(self): |
| 143 | + used_bytes = MemoryFrame.humanized_size(self.used_bytes) |
| 144 | + acquired_bytes = MemoryFrame.humanized_size(self.acquired_bytes) |
| 145 | + freed_bytes = MemoryFrame.humanized_size(self.freed_bytes) |
| 146 | + return (used_bytes, acquired_bytes, freed_bytes) |
| 147 | + |
| 148 | + @staticmethod |
| 149 | + def humanized_size(size): |
| 150 | + for unit in ['', 'K', 'M', 'G', 'T', 'P', 'E']: |
| 151 | + if size < 1024.0: |
| 152 | + return '%3.2f%sB' % (size, unit) |
| 153 | + size /= 1024.0 |
| 154 | + return '%.2f%sB' % (size, 'Z') |
| 155 | + |
| 156 | + def _set_parent(self, parent): |
| 157 | + if parent and parent not in parent.children: |
| 158 | + self.parent = parent |
| 159 | + parent.children.append(self) |
0 commit comments