from rpython.jit.metainterp.heapcache import HeapCache from rpython.jit.metainterp.resoperation import rop from rpython.jit.metainterp.history import ConstInt, BoxInt, BasicFailDescr box1 = "box1" box2 = "box2" box3 = "box3" box4 = "box4" box5 = "box5" lengthbox1 = object() lengthbox2 = object() lengthbox3 = object() descr1 = object() descr2 = object() descr3 = object() index1 = ConstInt(0) index2 = ConstInt(1) class FakeEffectinfo(object): EF_ELIDABLE_CANNOT_RAISE = 0 #elidable function (and cannot raise) EF_LOOPINVARIANT = 1 #special: call it only once per loop EF_CANNOT_RAISE = 2 #a function which cannot raise EF_ELIDABLE_CAN_RAISE = 3 #elidable function (but can raise) EF_CAN_RAISE = 4 #normal function (can raise) EF_FORCES_VIRTUAL_OR_VIRTUALIZABLE = 5 #can raise and force virtualizables EF_RANDOM_EFFECTS = 6 #can do whatever OS_ARRAYCOPY = 0 def __init__(self, extraeffect, oopspecindex, write_descrs_arrays): self.extraeffect = extraeffect self.oopspecindex = oopspecindex self.write_descrs_arrays = write_descrs_arrays class FakeCallDescr(object): def __init__(self, extraeffect, oopspecindex=None, write_descrs_arrays=[]): self.extraeffect = extraeffect self.oopspecindex = oopspecindex self.write_descrs_arrays = write_descrs_arrays def get_extra_info(self): return FakeEffectinfo( self.extraeffect, self.oopspecindex, write_descrs_arrays=self.write_descrs_arrays ) class TestHeapCache(object): def test_known_class_box(self): h = HeapCache() assert not h.is_class_known(1) assert not h.is_class_known(2) h.class_now_known(1) assert h.is_class_known(1) assert not h.is_class_known(2) h.reset() assert not h.is_class_known(1) assert not h.is_class_known(2) def test_nonstandard_virtualizable(self): h = HeapCache() assert not h.is_nonstandard_virtualizable(1) assert not h.is_nonstandard_virtualizable(2) h.nonstandard_virtualizables_now_known(1) assert h.is_nonstandard_virtualizable(1) assert not h.is_nonstandard_virtualizable(2) h.reset() assert not h.is_nonstandard_virtualizable(1) assert not h.is_nonstandard_virtualizable(2) def test_heapcache_fields(self): h = HeapCache() assert h.getfield(box1, descr1) is None assert h.getfield(box1, descr2) is None h.setfield(box1, box2, descr1) assert h.getfield(box1, descr1) is box2 assert h.getfield(box1, descr2) is None h.setfield(box1, box3, descr2) assert h.getfield(box1, descr1) is box2 assert h.getfield(box1, descr2) is box3 h.setfield(box1, box3, descr1) assert h.getfield(box1, descr1) is box3 assert h.getfield(box1, descr2) is box3 h.setfield(box3, box1, descr1) assert h.getfield(box3, descr1) is box1 assert h.getfield(box1, descr1) is None assert h.getfield(box1, descr2) is box3 h.reset() assert h.getfield(box1, descr1) is None assert h.getfield(box1, descr2) is None assert h.getfield(box3, descr1) is None def test_heapcache_read_fields_multiple(self): h = HeapCache() h.getfield_now_known(box1, descr1, box2) h.getfield_now_known(box3, descr1, box4) assert h.getfield(box1, descr1) is box2 assert h.getfield(box1, descr2) is None assert h.getfield(box3, descr1) is box4 assert h.getfield(box3, descr2) is None h.reset() assert h.getfield(box1, descr1) is None assert h.getfield(box1, descr2) is None assert h.getfield(box3, descr1) is None assert h.getfield(box3, descr2) is None def test_heapcache_write_fields_multiple(self): h = HeapCache() h.setfield(box1, box2, descr1) assert h.getfield(box1, descr1) is box2 h.setfield(box3, box4, descr1) assert h.getfield(box3, descr1) is box4 assert h.getfield(box1, descr1) is None # box1 and box3 can alias h = HeapCache() h.new(box1) h.setfield(box1, box2, descr1) assert h.getfield(box1, descr1) is box2 h.setfield(box3, box4, descr1) assert h.getfield(box3, descr1) is box4 assert h.getfield(box1, descr1) is None # box1 and box3 can alias h = HeapCache() h.new(box1) h.new(box3) h.setfield(box1, box2, descr1) assert h.getfield(box1, descr1) is box2 h.setfield(box3, box4, descr1) assert h.getfield(box3, descr1) is box4 assert h.getfield(box1, descr1) is box2 # box1 and box3 cannot alias h.setfield(box1, box3, descr1) assert h.getfield(box1, descr1) is box3 def test_heapcache_arrays(self): h = HeapCache() assert h.getarrayitem(box1, index1, descr1) is None assert h.getarrayitem(box1, index1, descr2) is None assert h.getarrayitem(box1, index2, descr1) is None assert h.getarrayitem(box1, index2, descr2) is None h.setarrayitem(box1, index1, box2, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index1, descr2) is None assert h.getarrayitem(box1, index2, descr1) is None assert h.getarrayitem(box1, index2, descr2) is None h.setarrayitem(box1, index2, box4, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index1, descr2) is None assert h.getarrayitem(box1, index2, descr1) is box4 assert h.getarrayitem(box1, index2, descr2) is None h.setarrayitem(box1, index1, box3, descr2) assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index1, descr2) is box3 assert h.getarrayitem(box1, index2, descr1) is box4 assert h.getarrayitem(box1, index2, descr2) is None h.setarrayitem(box1, index1, box3, descr1) assert h.getarrayitem(box1, index1, descr1) is box3 assert h.getarrayitem(box1, index1, descr2) is box3 assert h.getarrayitem(box1, index2, descr1) is box4 assert h.getarrayitem(box1, index2, descr2) is None h.setarrayitem(box3, index1, box1, descr1) assert h.getarrayitem(box3, index1, descr1) is box1 assert h.getarrayitem(box1, index1, descr1) is None assert h.getarrayitem(box1, index1, descr2) is box3 assert h.getarrayitem(box1, index2, descr1) is box4 assert h.getarrayitem(box1, index2, descr2) is None h.reset() assert h.getarrayitem(box1, index1, descr1) is None assert h.getarrayitem(box1, index1, descr2) is None assert h.getarrayitem(box3, index1, descr1) is None def test_heapcache_array_nonconst_index(self): h = HeapCache() h.setarrayitem(box1, index1, box2, descr1) h.setarrayitem(box1, index2, box4, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index2, descr1) is box4 h.setarrayitem(box1, box2, box3, descr1) assert h.getarrayitem(box1, index1, descr1) is None assert h.getarrayitem(box1, index2, descr1) is None def test_heapcache_read_fields_multiple_array(self): h = HeapCache() h.getarrayitem_now_known(box1, index1, box2, descr1) h.getarrayitem_now_known(box3, index1, box4, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index1, descr2) is None assert h.getarrayitem(box3, index1, descr1) is box4 assert h.getarrayitem(box3, index1, descr2) is None h.reset() assert h.getarrayitem(box1, index1, descr1) is None assert h.getarrayitem(box1, index1, descr2) is None assert h.getarrayitem(box3, index1, descr1) is None assert h.getarrayitem(box3, index1, descr2) is None def test_heapcache_write_fields_multiple_array(self): h = HeapCache() h.setarrayitem(box1, index1, box2, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 h.setarrayitem(box3, index1, box4, descr1) assert h.getarrayitem(box3, index1, descr1) is box4 assert h.getarrayitem(box1, index1, descr1) is None # box1 and box3 can alias h = HeapCache() h.new(box1) h.setarrayitem(box1, index1, box2, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 h.setarrayitem(box3, index1, box4, descr1) assert h.getarrayitem(box3, index1, descr1) is box4 assert h.getarrayitem(box1, index1, descr1) is None # box1 and box3 can alias h = HeapCache() h.new(box1) h.new(box3) h.setarrayitem(box1, index1, box2, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 h.setarrayitem(box3, index1, box4, descr1) assert h.getarrayitem(box3, index1, descr1) is box4 assert h.getarrayitem(box1, index1, descr1) is box2 # box1 and box3 cannot alias h.setarrayitem(box1, index1, box3, descr1) assert h.getarrayitem(box3, index1, descr1) is box4 assert h.getarrayitem(box1, index1, descr1) is box3 # box1 and box3 cannot alias def test_length_cache(self): h = HeapCache() h.new_array(box1, lengthbox1) assert h.arraylen(box1) is lengthbox1 assert h.arraylen(box2) is None h.arraylen_now_known(box2, lengthbox2) assert h.arraylen(box2) is lengthbox2 def test_invalidate_cache(self): h = HeapCache() h.setfield(box1, box2, descr1) h.setarrayitem(box1, index1, box2, descr1) h.setarrayitem(box1, index2, box4, descr1) h.invalidate_caches(rop.INT_ADD, None, []) h.invalidate_caches(rop.INT_ADD_OVF, None, []) h.invalidate_caches(rop.SETFIELD_RAW, None, []) h.invalidate_caches(rop.SETARRAYITEM_RAW, None, []) assert h.getfield(box1, descr1) is box2 assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index2, descr1) is box4 h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_ELIDABLE_CANNOT_RAISE), []) assert h.getfield(box1, descr1) is box2 assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index2, descr1) is box4 h.invalidate_caches(rop.GUARD_TRUE, None, []) assert h.getfield(box1, descr1) is box2 assert h.getarrayitem(box1, index1, descr1) is box2 assert h.getarrayitem(box1, index2, descr1) is box4 h.invalidate_caches( rop.CALL_LOOPINVARIANT, FakeCallDescr(FakeEffectinfo.EF_LOOPINVARIANT), []) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_RANDOM_EFFECTS), []) assert h.getfield(box1, descr1) is None assert h.getarrayitem(box1, index1, descr1) is None assert h.getarrayitem(box1, index2, descr1) is None def test_replace_box(self): h = HeapCache() h.setfield(box1, box2, descr1) h.setfield(box1, box3, descr2) h.setfield(box2, box3, descr3) h.replace_box(box1, box4) assert h.getfield(box4, descr1) is box2 assert h.getfield(box4, descr2) is box3 assert h.getfield(box2, descr3) is box3 h.setfield(box4, box3, descr1) assert h.getfield(box4, descr1) is box3 h = HeapCache() h.setfield(box1, box2, descr1) h.setfield(box1, box3, descr2) h.setfield(box2, box3, descr3) h.replace_box(box3, box4) assert h.getfield(box1, descr1) is box2 assert h.getfield(box1, descr2) is box4 assert h.getfield(box2, descr3) is box4 def test_replace_box_twice(self): h = HeapCache() h.setfield(box1, box2, descr1) h.setfield(box1, box3, descr2) h.setfield(box2, box3, descr3) h.replace_box(box1, box4) h.replace_box(box4, box5) assert h.getfield(box5, descr1) is box2 assert h.getfield(box5, descr2) is box3 assert h.getfield(box2, descr3) is box3 h.setfield(box5, box3, descr1) assert h.getfield(box4, descr1) is box3 h = HeapCache() h.setfield(box1, box2, descr1) h.setfield(box1, box3, descr2) h.setfield(box2, box3, descr3) h.replace_box(box3, box4) h.replace_box(box4, box5) assert h.getfield(box1, descr1) is box2 assert h.getfield(box1, descr2) is box5 assert h.getfield(box2, descr3) is box5 def test_replace_box_array(self): h = HeapCache() h.setarrayitem(box1, index1, box2, descr1) h.setarrayitem(box1, index1, box3, descr2) h.arraylen_now_known(box1, lengthbox1) h.setarrayitem(box2, index2, box1, descr1) h.setarrayitem(box3, index2, box1, descr2) h.setarrayitem(box2, index2, box3, descr3) h.replace_box(box1, box4) assert h.arraylen(box4) is lengthbox1 assert h.getarrayitem(box4, index1, descr1) is box2 assert h.getarrayitem(box4, index1, descr2) is box3 assert h.getarrayitem(box2, index2, descr1) is box4 assert h.getarrayitem(box3, index2, descr2) is box4 assert h.getarrayitem(box2, index2, descr3) is box3 h.replace_box(lengthbox1, lengthbox2) assert h.arraylen(box4) is lengthbox2 def test_replace_box_array_twice(self): h = HeapCache() h.setarrayitem(box1, index1, box2, descr1) h.setarrayitem(box1, index1, box3, descr2) h.arraylen_now_known(box1, lengthbox1) h.setarrayitem(box2, index2, box1, descr1) h.setarrayitem(box3, index2, box1, descr2) h.setarrayitem(box2, index2, box3, descr3) h.replace_box(box1, box4) h.replace_box(box4, box5) assert h.arraylen(box4) is lengthbox1 assert h.getarrayitem(box5, index1, descr1) is box2 assert h.getarrayitem(box5, index1, descr2) is box3 assert h.getarrayitem(box2, index2, descr1) is box5 assert h.getarrayitem(box3, index2, descr2) is box5 assert h.getarrayitem(box2, index2, descr3) is box3 h.replace_box(lengthbox1, lengthbox2) h.replace_box(lengthbox2, lengthbox3) assert h.arraylen(box4) is lengthbox3 def test_ll_arraycopy(self): h = HeapCache() h.new_array(box1, lengthbox1) h.setarrayitem(box1, index1, box2, descr1) h.new_array(box2, lengthbox1) # Just need the destination box for this call h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box5, box2, index1, index1, index1] ) assert h.getarrayitem(box1, index1, descr1) is box2 h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box5, box3, index1, index1, index1] ) assert h.getarrayitem(box1, index1, descr1) is box2 h.setarrayitem(box4, index1, box2, descr1) assert h.getarrayitem(box4, index1, descr1) is box2 h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box3, box5, index1, index1, index2] ) assert h.getarrayitem(box4, index1, descr1) is None def test_ll_arraycopy_differing_descrs(self): h = HeapCache() h.setarrayitem(box1, index1, box2, descr1) assert h.getarrayitem(box1, index1, descr1) is box2 h.new_array(box2, lengthbox2) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr2]), [None, box3, box2, index1, index1, index2] ) assert h.getarrayitem(box1, index1, descr1) is box2 def test_ll_arraycopy_result_propogated(self): h = HeapCache() h.setarrayitem(box1, index1, box2, descr1) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box1, box3, index1, index1, index2] ) assert h.getarrayitem(box3, index1, descr1) is box2 def test_ll_arraycopy_dest_new(self): h = HeapCache() h.new_array(box1, lengthbox1) h.setarrayitem(box3, index1, box4, descr1) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box2, box1, index1, index1, index2] ) def test_ll_arraycopy_doesnt_escape_arrays(self): h = HeapCache() h.new_array(box1, lengthbox1) h.new_array(box2, lengthbox2) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box2, box1, index1, index1, index2] ) assert h.is_unescaped(box1) assert h.is_unescaped(box2) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CANNOT_RAISE, FakeEffectinfo.OS_ARRAYCOPY, write_descrs_arrays=[descr1]), [None, box2, box1, index1, index1, BoxInt()] ) assert not h.is_unescaped(box1) assert not h.is_unescaped(box2) def test_unescaped(self): h = HeapCache() assert not h.is_unescaped(box1) h.new(box2) assert h.is_unescaped(box2) h.invalidate_caches(rop.SETFIELD_GC, None, [box2, box1]) assert h.is_unescaped(box2) h.invalidate_caches(rop.SETFIELD_GC, None, [box1, box2]) assert not h.is_unescaped(box2) def test_unescaped_testing(self): h = HeapCache() h.new(box1) h.new(box2) assert h.is_unescaped(box1) assert h.is_unescaped(box2) # Putting a virtual inside of another virtual doesn't escape it. h.invalidate_caches(rop.SETFIELD_GC, None, [box1, box2]) assert h.is_unescaped(box2) # Reading a field from a virtual doesn't escape it. h.invalidate_caches(rop.GETFIELD_GC, None, [box1]) assert h.is_unescaped(box1) # Escaping a virtual transitively escapes anything inside of it. assert not h.is_unescaped(box3) h.invalidate_caches(rop.SETFIELD_GC, None, [box3, box1]) assert not h.is_unescaped(box1) assert not h.is_unescaped(box2) def test_ops_dont_escape(self): h = HeapCache() h.new(box1) h.new(box2) assert h.is_unescaped(box1) assert h.is_unescaped(box2) h.invalidate_caches(rop.INSTANCE_PTR_EQ, None, [box1, box2]) assert h.is_unescaped(box1) assert h.is_unescaped(box2) h.invalidate_caches(rop.INSTANCE_PTR_NE, None, [box1, box2]) assert h.is_unescaped(box1) assert h.is_unescaped(box2) def test_circular_virtuals(self): h = HeapCache() h.new(box1) h.new(box2) h.invalidate_caches(rop.SETFIELD_GC, None, [box1, box2]) h.invalidate_caches(rop.SETFIELD_GC, None, [box2, box1]) h.invalidate_caches(rop.SETFIELD_GC, None, [box3, box1]) # does not crash def test_unescaped_array(self): h = HeapCache() h.new_array(box1, lengthbox1) assert h.is_unescaped(box1) h.invalidate_caches(rop.SETARRAYITEM_GC, None, [box1, index1, box2]) assert h.is_unescaped(box1) h.invalidate_caches(rop.SETARRAYITEM_GC, None, [box2, index1, box1]) assert not h.is_unescaped(box1) h = HeapCache() h.new_array(box1, lengthbox1) h.new(box2) assert h.is_unescaped(box1) assert h.is_unescaped(box2) h.invalidate_caches(rop.SETARRAYITEM_GC, None, [box1, lengthbox2, box2]) assert h.is_unescaped(box1) assert h.is_unescaped(box2) h.invalidate_caches( rop.CALL, FakeCallDescr(FakeEffectinfo.EF_RANDOM_EFFECTS), [box1] ) assert not h.is_unescaped(box1) assert not h.is_unescaped(box2) def test_call_doesnt_invalidate_unescaped_boxes(self): h = HeapCache() h.new(box1) assert h.is_unescaped(box1) h.setfield(box1, box2, descr1) h.invalidate_caches(rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CAN_RAISE), [] ) assert h.getfield(box1, descr1) is box2 def test_call_doesnt_invalidate_unescaped_array_boxes(self): h = HeapCache() h.new_array(box1, lengthbox1) assert h.is_unescaped(box1) h.setarrayitem(box1, index1, box3, descr1) h.invalidate_caches(rop.CALL, FakeCallDescr(FakeEffectinfo.EF_CAN_RAISE), [] ) assert h.getarrayitem(box1, index1, descr1) is box3 def test_bug_missing_ignored_operations(self): h = HeapCache() h.new(box1) h.new(box2) h.setfield(box1, box2, descr1) assert h.getfield(box1, descr1) is box2 h.invalidate_caches(rop.STRSETITEM, None, []) h.invalidate_caches(rop.UNICODESETITEM, None, []) h.invalidate_caches(rop.SETFIELD_RAW, None, []) h.invalidate_caches(rop.SETARRAYITEM_RAW, None, []) h.invalidate_caches(rop.SETINTERIORFIELD_RAW, None, []) h.invalidate_caches(rop.RAW_STORE, None, []) assert h.is_unescaped(box1) assert h.is_unescaped(box2) assert h.getfield(box1, descr1) is box2 def test_bug_heap_cache_is_cleared_but_not_is_unescaped_1(self): # bug if only the getfield() link is cleared (heap_cache) but not # the is_unescaped() flags: we can do later a GETFIELD(box1) which # will give us a fresh box3, which is actually equal to box2. This # box3 is escaped, but box2 is still unescaped. Bug shown e.g. by # calling some residual code that changes the values on box3: then # the content of box2 is still cached at the old value. h = HeapCache() h.new(box1) h.new(box2) h.setfield(box1, box2, descr1) h.invalidate_caches(rop.SETFIELD_GC, None, [box1, box2]) assert h.getfield(box1, descr1) is box2 h.invalidate_caches(rop.CALL_MAY_FORCE, None, []) assert not h.is_unescaped(box1) assert not h.is_unescaped(box2) assert h.getfield(box1, descr1) is None def test_bug_heap_cache_is_cleared_but_not_is_unescaped_2(self): h = HeapCache() h.new(box1) h.new(box2) h.setfield(box1, box2, descr1) h.invalidate_caches(rop.SETFIELD_GC, None, [box1, box2]) assert h.getfield(box1, descr1) is box2 descr = BasicFailDescr() class XTra: oopspecindex = 0 OS_ARRAYCOPY = 42 extraeffect = 5 EF_LOOPINVARIANT = 1 EF_ELIDABLE_CANNOT_RAISE = 2 EF_ELIDABLE_CAN_RAISE = 3 descr.get_extra_info = XTra h.invalidate_caches(rop.CALL, descr, []) assert h.is_unescaped(box1) assert h.is_unescaped(box2) assert h.getfield(box1, descr1) is box2 def test_is_likely_virtual(self): h = HeapCache() h.new(box1) assert h.is_unescaped(box1) assert h.is_likely_virtual(box1) h.reset(reset_virtuals=False) assert not h.is_unescaped(box1) assert h.is_likely_virtual(box1) h._escape(box1) assert not h.is_unescaped(box1) assert not h.is_likely_virtual(box1)