Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-90997: Show cached inline values in dis output #92360

Merged
merged 6 commits into from
May 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions Lib/dis.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,14 @@
import io

from opcode import *
from opcode import __all__ as _opcodes_all
from opcode import _nb_ops, _inline_cache_entries, _specializations, _specialized_instructions
from opcode import (
__all__ as _opcodes_all,
_cache_format,
_inline_cache_entries,
_nb_ops,
_specializations,
_specialized_instructions,
)

__all__ = ["code_info", "dis", "disassemble", "distb", "disco",
"findlinestarts", "findlabels", "show_code",
Expand Down Expand Up @@ -437,9 +443,6 @@ def _get_instructions_bytes(code, varname_from_oparg=None,
cache_counter = 0
for offset, op, arg in _unpack_opargs(code):
if cache_counter > 0:
if show_caches:
yield Instruction("CACHE", 0, None, None, '',
offset, None, False, None)
cache_counter -= 1
continue
if linestarts is not None:
Expand Down Expand Up @@ -494,6 +497,17 @@ def _get_instructions_bytes(code, varname_from_oparg=None,
yield Instruction(_all_opname[op], op,
arg, argval, argrepr,
offset, starts_line, is_jump_target, positions)
if show_caches and cache_counter:
for name, caches in _cache_format[opname[deop]].items():
data = code[offset + 2: offset + 2 + caches * 2]
argrepr = f"{name}: {int.from_bytes(data, sys.byteorder)}"
for _ in range(caches):
offset += 2
yield Instruction(
"CACHE", 0, 0, None, argrepr, offset, None, False, None
)
# Only show the actual value for the first cache entry:
argrepr = ""

def disassemble(co, lasti=-1, *, file=None, show_caches=False, adaptive=False):
"""Disassemble a code object."""
Expand Down
95 changes: 74 additions & 21 deletions Lib/opcode.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,20 @@
opmap = {}
opname = ['<%r>' % (op,) for op in range(256)]

_inline_cache_entries = [0] * 256

def def_op(name, op, entries=0):
def def_op(name, op):
opname[op] = name
opmap[name] = op
_inline_cache_entries[op] = entries

def name_op(name, op, entries=0):
def_op(name, op, entries)
def name_op(name, op):
def_op(name, op)
hasname.append(op)

def jrel_op(name, op, entries=0):
def_op(name, op, entries)
def jrel_op(name, op):
def_op(name, op)
hasjrel.append(op)

def jabs_op(name, op, entries=0):
def_op(name, op, entries)
def jabs_op(name, op):
def_op(name, op)
hasjabs.append(op)

# Instruction opcodes for compiled code
Expand All @@ -68,7 +65,7 @@ def jabs_op(name, op, entries=0):

def_op('UNARY_INVERT', 15)

def_op('BINARY_SUBSCR', 25, 4)
def_op('BINARY_SUBSCR', 25)

def_op('GET_LEN', 30)
def_op('MATCH_MAPPING', 31)
Expand All @@ -86,7 +83,7 @@ def jabs_op(name, op, entries=0):
def_op('BEFORE_WITH', 53)
def_op('END_ASYNC_FOR', 54)

def_op('STORE_SUBSCR', 60, 1)
def_op('STORE_SUBSCR', 60)
def_op('DELETE_SUBSCR', 61)

def_op('GET_ITER', 68)
Expand All @@ -110,10 +107,10 @@ def jabs_op(name, op, entries=0):

name_op('STORE_NAME', 90) # Index in name list
name_op('DELETE_NAME', 91) # ""
def_op('UNPACK_SEQUENCE', 92, 1) # Number of tuple items
def_op('UNPACK_SEQUENCE', 92) # Number of tuple items
jrel_op('FOR_ITER', 93)
def_op('UNPACK_EX', 94)
name_op('STORE_ATTR', 95, 4) # Index in name list
name_op('STORE_ATTR', 95) # Index in name list
name_op('DELETE_ATTR', 96) # ""
name_op('STORE_GLOBAL', 97) # ""
name_op('DELETE_GLOBAL', 98) # ""
Expand All @@ -125,8 +122,8 @@ def jabs_op(name, op, entries=0):
def_op('BUILD_LIST', 103) # Number of list items
def_op('BUILD_SET', 104) # Number of set items
def_op('BUILD_MAP', 105) # Number of dict entries
name_op('LOAD_ATTR', 106, 4) # Index in name list
def_op('COMPARE_OP', 107, 2) # Comparison operator
name_op('LOAD_ATTR', 106) # Index in name list
def_op('COMPARE_OP', 107) # Comparison operator
hascompare.append(107)
name_op('IMPORT_NAME', 108) # Index in name list
name_op('IMPORT_FROM', 109) # Index in name list
Expand All @@ -135,12 +132,12 @@ def jabs_op(name, op, entries=0):
jrel_op('JUMP_IF_TRUE_OR_POP', 112) # ""
jrel_op('POP_JUMP_FORWARD_IF_FALSE', 114)
jrel_op('POP_JUMP_FORWARD_IF_TRUE', 115)
name_op('LOAD_GLOBAL', 116, 5) # Index in name list
name_op('LOAD_GLOBAL', 116) # Index in name list
def_op('IS_OP', 117)
def_op('CONTAINS_OP', 118)
def_op('RERAISE', 119)
def_op('COPY', 120)
def_op('BINARY_OP', 122, 1)
def_op('BINARY_OP', 122)
jrel_op('SEND', 123) # Number of bytes to skip
def_op('LOAD_FAST', 124) # Local variable number
haslocal.append(124)
Expand Down Expand Up @@ -185,15 +182,15 @@ def jabs_op(name, op, entries=0):
def_op('BUILD_CONST_KEY_MAP', 156)
def_op('BUILD_STRING', 157)

name_op('LOAD_METHOD', 160, 10)
name_op('LOAD_METHOD', 160)

def_op('LIST_EXTEND', 162)
def_op('SET_UPDATE', 163)
def_op('DICT_MERGE', 164)
def_op('DICT_UPDATE', 165)
def_op('PRECALL', 166, 1)
def_op('PRECALL', 166)

def_op('CALL', 171, 4)
def_op('CALL', 171)
def_op('KW_NAMES', 172)
hasconst.append(172)

Expand Down Expand Up @@ -352,3 +349,59 @@ def jabs_op(name, op, entries=0):
"miss",
"deopt",
]

_cache_format = {
"LOAD_GLOBAL": {
"counter": 1,
"index": 1,
"module_keys_version": 2,
"builtin_keys_version": 1,
},
"BINARY_OP": {
"counter": 1,
},
"UNPACK_SEQUENCE": {
"counter": 1,
},
"COMPARE_OP": {
"counter": 1,
"mask": 1,
},
"BINARY_SUBSCR": {
"counter": 1,
"type_version": 2,
"func_version": 1,
},
"LOAD_ATTR": {
"counter": 1,
"version": 2,
"index": 1,
},
"STORE_ATTR": {
"counter": 1,
"version": 2,
"index": 1,
},
"LOAD_METHOD": {
"counter": 1,
"type_version": 2,
"dict_offset": 1,
"keys_version": 2,
"descr": 4,
},
"CALL": {
"counter": 1,
"func_version": 2,
"min_args": 1,
},
"PRECALL": {
"counter": 1,
},
"STORE_SUBSCR": {
"counter": 1,
},
}

_inline_cache_entries = [
sum(_cache_format.get(opname[opcode], {}).values()) for opcode in range(256)
]
31 changes: 31 additions & 0 deletions Lib/test/test_dis.py
Original file line number Diff line number Diff line change
Expand Up @@ -999,6 +999,37 @@ def test_loop_quicken(self):
got = self.get_disassembly(loop_test, adaptive=True)
self.do_disassembly_compare(got, dis_loop_test_quickened_code, True)

def get_cached_values(self, quickened, adaptive):
def f():
l = []
for i in range(42):
l.append(i)
if quickened:
self.code_quicken(f)
else:
# "copy" the code to un-quicken it:
f.__code__ = f.__code__.replace()
for instruction in dis.get_instructions(
f, show_caches=True, adaptive=adaptive
):
if instruction.opname == "CACHE":
yield instruction.argrepr

@cpython_only
def test_show_caches(self):
for quickened in (False, True):
for adaptive in (False, True):
with self.subTest(f"{quickened=}, {adaptive=}"):
if quickened and adaptive:
pattern = r"^(\w+: \d+)?$"
else:
pattern = r"^(\w+: 0)?$"
caches = list(self.get_cached_values(quickened, adaptive))
for cache in caches:
self.assertRegex(cache, pattern)
self.assertEqual(caches.count(""), 8)
self.assertEqual(len(caches), 25)


class DisWithFileTests(DisTests):

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Show the actual named values stored in inline caches when
``show_caches=True`` is passed to :mod:`dis` utilities.