Skip to content

Commit fecbc3e

Browse files
aviateskaviatesk
committed
optimizer: early finalize insertion
Currently, in the finalizer inlining pass, if not all the code between the finalizer registration and the end of the object’s lifetime (i.e., where the finalizer would be inlined) is marked as `:nothrow`, it simply bails out. However, even in such cases, we can insert a `finalize` call at the end of the object’s lifetime, allowing us to call the finalizer early if no exceptions occur. This commit implements this optimization. To do so, it also moves `finalize` to `Core`, so the compiler can handle it directly.
1 parent 84a2458 commit fecbc3e

File tree

10 files changed

+91
-63
lines changed

10 files changed

+91
-63
lines changed

‎base/Base.jl‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -271,8 +271,7 @@ end
271271

272272
BUILDROOT::String = ""
273273

274-
baremodule BuildSettings
275-
end
274+
baremodule BuildSettings end
276275

277276
let i = 1
278277
global BUILDROOT

‎base/boot.jl‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ export
214214
nfields, throw, tuple, ===, isdefined, eval,
215215
# access to globals
216216
getglobal, setglobal!, swapglobal!, modifyglobal!, replaceglobal!, setglobalonce!,
217-
# ifelse, sizeof # not exported, to avoid conflicting with Base
217+
# ifelse, sizeof, finalize # not exported, to avoid conflicting with Base
218218
# type reflection
219219
<:, typeof, isa, typeassert,
220220
# method reflection

‎base/compiler/ssair/passes.jl‎

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1625,19 +1625,18 @@ function try_resolve_finalizer!(ir::IRCode, alloc_idx::Int, finalizer_idx::Int,
16251625
foreach(note_defuse!, defuse.defs)
16261626
insert_bb != 0 || return nothing # verify post-dominator of all uses exists
16271627

1628+
# Figure out the exact statement where we're going to inline the finalizer.
1629+
loc = insert_idx === nothing ? first(ir.cfg.blocks[insert_bb].stmts) : insert_idx::Int
1630+
attach_after = insert_idx !== nothing
1631+
flag = info isa FinalizerInfo ? flags_for_effects(info.effects) : IR_FLAG_NULL
1632+
finalizer_stmt = ir[SSAValue(finalizer_idx)][:stmt]
1633+
16281634
if !OptimizationParams(inlining.interp).assume_fatal_throw
16291635
# Collect all reachable blocks between the finalizer registration and the
16301636
# insertion point
16311637
blocks = reachable_blocks(ir.cfg, finalizer_bb, insert_bb)
16321638

16331639
# Check #3
1634-
function check_range_nothrow(s::Int, e::Int)
1635-
return all(s:e) do sidx::Int
1636-
sidx == finalizer_idx && return true
1637-
sidx == alloc_idx && return true
1638-
return is_nothrow(ir, SSAValue(sidx))
1639-
end
1640-
end
16411640
for bb in blocks
16421641
range = ir.cfg.blocks[bb].stmts
16431642
s, e = first(range), last(range)
@@ -1648,18 +1647,23 @@ function try_resolve_finalizer!(ir::IRCode, alloc_idx::Int, finalizer_idx::Int,
16481647
if bb == finalizer_bb
16491648
s = finalizer_idx
16501649
end
1651-
check_range_nothrow(s, e) || return nothing
1650+
all(s:e) do sidx::Int
1651+
sidx == finalizer_idx && return true
1652+
sidx == alloc_idx && return true
1653+
return is_nothrow(ir, SSAValue(sidx))
1654+
end && continue
1655+
1656+
# An exception may be thrown between the finalizer registration and the point
1657+
# where the object’s lifetime ends (`insert_idx`): In such cases, we can’t
1658+
# remove the finalizer registration, but we can still insert a `Core.finalize`
1659+
# call at `insert_idx` while leaving the registration intact.
1660+
newinst = add_flag(NewInstruction(Expr(:call, GlobalRef(Core, :finalize), finalizer_stmt.args[3]), Nothing), flag)
1661+
insert_node!(ir, loc, newinst, attach_after)
1662+
return nothing
16521663
end
16531664
end
16541665

1655-
# Ok, legality check complete. Figure out the exact statement where we're
1656-
# going to inline the finalizer.
1657-
loc = insert_idx === nothing ? first(ir.cfg.blocks[insert_bb].stmts) : insert_idx::Int
1658-
attach_after = insert_idx !== nothing
1659-
1660-
finalizer_stmt = ir[SSAValue(finalizer_idx)][:stmt]
16611666
argexprs = Any[finalizer_stmt.args[2], finalizer_stmt.args[3]]
1662-
flag = info isa FinalizerInfo ? flags_for_effects(info.effects) : IR_FLAG_NULL
16631667
if length(finalizer_stmt.args) >= 4
16641668
inline = finalizer_stmt.args[4]
16651669
if inline === nothing

‎base/compiler/tfuncs.jl‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -743,6 +743,7 @@ add_tfunc(donotdelete, 0, INT_INF, @nospecs((𝕃::AbstractLattice, args...)->No
743743
end
744744
add_tfunc(compilerbarrier, 2, 2, compilerbarrier_tfunc, 5)
745745
add_tfunc(Core.finalizer, 2, 4, @nospecs((𝕃::AbstractLattice, args...)->Nothing), 5)
746+
add_tfunc(Core.finalize, 1, 1, @nospecs((𝕃::AbstractLattice, o)->Nothing), 100)
746747

747748
@nospecs function compilerbarrier_nothrow(setting, val)
748749
return isa(setting, Const) && contains_is((:type, :const, :conditional), setting.val)
@@ -2288,8 +2289,11 @@ function _builtin_nothrow(𝕃::AbstractLattice, @nospecialize(f::Builtin), argt
22882289
return true
22892290
elseif f === Core.finalizer
22902291
2 <= na <= 4 || return false
2291-
# Core.finalizer does no error checking - that's done in Base.finalizer
2292+
# `Core.finalizer` does no error checking - that's done in Base.finalizer
22922293
return true
2294+
elseif f === Core.finalize
2295+
na == 2 || return false
2296+
return true # `Core.finalize` does no error checking
22932297
elseif f === Core.compilerbarrier
22942298
na == 2 || return false
22952299
return compilerbarrier_nothrow(argtypes[1], nothing)

‎base/gcutils.jl‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# This file is a part of Julia. License is MIT: https://julialang.org/license
22

3-
43
"""
54
WeakRef(x)
65
@@ -99,8 +98,7 @@ end
9998
10099
Immediately run finalizers registered for object `x`.
101100
"""
102-
finalize(@nospecialize(o)) = ccall(:jl_finalize_th, Cvoid, (Any, Any,),
103-
current_task(), o)
101+
finalize(@nospecialize(o)) = Core.finalize(o)
104102

105103
"""
106104
Base.GC

‎src/builtin_proto.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ DECLARE_BUILTIN(compilerbarrier);
3737
DECLARE_BUILTIN(current_scope);
3838
DECLARE_BUILTIN(donotdelete);
3939
DECLARE_BUILTIN(fieldtype);
40+
DECLARE_BUILTIN(finalize);
4041
DECLARE_BUILTIN(finalizer);
4142
DECLARE_BUILTIN(getfield);
4243
DECLARE_BUILTIN(getglobal);

‎src/builtins.c‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2010,6 +2010,13 @@ JL_CALLABLE(jl_f_finalizer)
20102010
return jl_nothing;
20112011
}
20122012

2013+
JL_CALLABLE(jl_f_finalize)
2014+
{
2015+
JL_NARGS(finalize, 1, 1);
2016+
jl_finalize(args[0]);
2017+
return jl_nothing;
2018+
}
2019+
20132020
JL_CALLABLE(jl_f__compute_sparams)
20142021
{
20152022
JL_NARGSV(_compute_sparams, 1);
@@ -2442,6 +2449,7 @@ void jl_init_primitives(void) JL_GC_DISABLED
24422449
jl_builtin_donotdelete = add_builtin_func("donotdelete", jl_f_donotdelete);
24432450
jl_builtin_compilerbarrier = add_builtin_func("compilerbarrier", jl_f_compilerbarrier);
24442451
add_builtin_func("finalizer", jl_f_finalizer);
2452+
add_builtin_func("finalize", jl_f_finalize);
24452453
add_builtin_func("_compute_sparams", jl_f__compute_sparams);
24462454
add_builtin_func("_svec_ref", jl_f__svec_ref);
24472455
jl_builtin_current_scope = add_builtin_func("current_scope", jl_f_current_scope);

‎src/codegen.cpp‎

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1607,47 +1607,48 @@ static const auto jlintrinsic_func = new JuliaFunction<>{XSTR(jl_f_intrinsic_cal
16071607

16081608
static const auto &builtin_func_map() {
16091609
static std::map<jl_fptr_args_t, JuliaFunction<>*> builtins = {
1610-
{ jl_f_is_addr, new JuliaFunction<>{XSTR(jl_f_is), get_func_sig, get_func_attrs} },
1611-
{ jl_f_typeof_addr, new JuliaFunction<>{XSTR(jl_f_typeof), get_func_sig, get_func_attrs} },
1612-
{ jl_f_sizeof_addr, new JuliaFunction<>{XSTR(jl_f_sizeof), get_func_sig, get_func_attrs} },
1613-
{ jl_f_issubtype_addr, new JuliaFunction<>{XSTR(jl_f_issubtype), get_func_sig, get_func_attrs} },
1614-
{ jl_f_isa_addr, new JuliaFunction<>{XSTR(jl_f_isa), get_func_sig, get_func_attrs} },
1615-
{ jl_f_typeassert_addr, new JuliaFunction<>{XSTR(jl_f_typeassert), get_func_sig, get_func_attrs} },
1616-
{ jl_f_ifelse_addr, new JuliaFunction<>{XSTR(jl_f_ifelse), get_func_sig, get_func_attrs} },
1617-
{ jl_f__apply_iterate_addr, new JuliaFunction<>{XSTR(jl_f__apply_iterate), get_func_sig, get_func_attrs} },
1618-
{ jl_f__apply_pure_addr, new JuliaFunction<>{XSTR(jl_f__apply_pure), get_func_sig, get_func_attrs} },
1619-
{ jl_f__call_latest_addr, new JuliaFunction<>{XSTR(jl_f__call_latest), get_func_sig, get_func_attrs} },
1620-
{ jl_f__call_in_world_addr, new JuliaFunction<>{XSTR(jl_f__call_in_world), get_func_sig, get_func_attrs} },
1610+
{ jl_f_is_addr, new JuliaFunction<>{XSTR(jl_f_is), get_func_sig, get_func_attrs} },
1611+
{ jl_f_typeof_addr, new JuliaFunction<>{XSTR(jl_f_typeof), get_func_sig, get_func_attrs} },
1612+
{ jl_f_sizeof_addr, new JuliaFunction<>{XSTR(jl_f_sizeof), get_func_sig, get_func_attrs} },
1613+
{ jl_f_issubtype_addr, new JuliaFunction<>{XSTR(jl_f_issubtype), get_func_sig, get_func_attrs} },
1614+
{ jl_f_isa_addr, new JuliaFunction<>{XSTR(jl_f_isa), get_func_sig, get_func_attrs} },
1615+
{ jl_f_typeassert_addr, new JuliaFunction<>{XSTR(jl_f_typeassert), get_func_sig, get_func_attrs} },
1616+
{ jl_f_ifelse_addr, new JuliaFunction<>{XSTR(jl_f_ifelse), get_func_sig, get_func_attrs} },
1617+
{ jl_f__apply_iterate_addr, new JuliaFunction<>{XSTR(jl_f__apply_iterate), get_func_sig, get_func_attrs} },
1618+
{ jl_f__apply_pure_addr, new JuliaFunction<>{XSTR(jl_f__apply_pure), get_func_sig, get_func_attrs} },
1619+
{ jl_f__call_latest_addr, new JuliaFunction<>{XSTR(jl_f__call_latest), get_func_sig, get_func_attrs} },
1620+
{ jl_f__call_in_world_addr, new JuliaFunction<>{XSTR(jl_f__call_in_world), get_func_sig, get_func_attrs} },
16211621
{ jl_f__call_in_world_total_addr, new JuliaFunction<>{XSTR(jl_f__call_in_world_total), get_func_sig, get_func_attrs} },
1622-
{ jl_f_throw_addr, new JuliaFunction<>{XSTR(jl_f_throw), get_func_sig, get_func_attrs} },
1623-
{ jl_f_throw_methoderror_addr, new JuliaFunction<>{XSTR(jl_f_throw_methoderror), get_func_sig, get_func_attrs} },
1624-
{ jl_f_tuple_addr, jltuple_func },
1625-
{ jl_f_svec_addr, new JuliaFunction<>{XSTR(jl_f_svec), get_func_sig, get_func_attrs} },
1626-
{ jl_f_applicable_addr, new JuliaFunction<>{XSTR(jl_f_applicable), get_func_sig, get_func_attrs} },
1627-
{ jl_f_invoke_addr, new JuliaFunction<>{XSTR(jl_f_invoke), get_func_sig, get_func_attrs} },
1628-
{ jl_f_isdefined_addr, new JuliaFunction<>{XSTR(jl_f_isdefined), get_func_sig, get_func_attrs} },
1629-
{ jl_f_getfield_addr, new JuliaFunction<>{XSTR(jl_f_getfield), get_func_sig, get_func_attrs} },
1630-
{ jl_f_setfield_addr, new JuliaFunction<>{XSTR(jl_f_setfield), get_func_sig, get_func_attrs} },
1631-
{ jl_f_swapfield_addr, new JuliaFunction<>{XSTR(jl_f_swapfield), get_func_sig, get_func_attrs} },
1632-
{ jl_f_modifyfield_addr, new JuliaFunction<>{XSTR(jl_f_modifyfield), get_func_sig, get_func_attrs} },
1633-
{ jl_f_fieldtype_addr, new JuliaFunction<>{XSTR(jl_f_fieldtype), get_func_sig, get_func_attrs} },
1634-
{ jl_f_nfields_addr, new JuliaFunction<>{XSTR(jl_f_nfields), get_func_sig, get_func_attrs} },
1635-
{ jl_f__expr_addr, new JuliaFunction<>{XSTR(jl_f__expr), get_func_sig, get_func_attrs} },
1636-
{ jl_f__typevar_addr, new JuliaFunction<>{XSTR(jl_f__typevar), get_func_sig, get_func_attrs} },
1637-
{ jl_f_memoryref_addr, new JuliaFunction<>{XSTR(jl_f_memoryref), get_func_sig, get_func_attrs} },
1638-
{ jl_f_memoryrefoffset_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefoffset), get_func_sig, get_func_attrs} },
1639-
{ jl_f_memoryrefset_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefset), get_func_sig, get_func_attrs} },
1640-
{ jl_f_memoryrefswap_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefswap), get_func_sig, get_func_attrs} },
1641-
{ jl_f_memoryrefreplace_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefreplace), get_func_sig, get_func_attrs} },
1642-
{ jl_f_memoryrefmodify_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefmodify), get_func_sig, get_func_attrs} },
1643-
{ jl_f_memoryrefsetonce_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefsetonce), get_func_sig, get_func_attrs} },
1644-
{ jl_f_memoryref_isassigned_addr,new JuliaFunction<>{XSTR(jl_f_memoryref_isassigned), get_func_sig, get_func_attrs} },
1645-
{ jl_f_apply_type_addr, new JuliaFunction<>{XSTR(jl_f_apply_type), get_func_sig, get_func_attrs} },
1646-
{ jl_f_donotdelete_addr, new JuliaFunction<>{XSTR(jl_f_donotdelete), get_donotdelete_sig, get_donotdelete_func_attrs} },
1647-
{ jl_f_compilerbarrier_addr, new JuliaFunction<>{XSTR(jl_f_compilerbarrier), get_func_sig, get_func_attrs} },
1648-
{ jl_f_finalizer_addr, new JuliaFunction<>{XSTR(jl_f_finalizer), get_func_sig, get_func_attrs} },
1649-
{ jl_f__svec_ref_addr, new JuliaFunction<>{XSTR(jl_f__svec_ref), get_func_sig, get_func_attrs} },
1650-
{ jl_f_current_scope_addr, new JuliaFunction<>{XSTR(jl_f_current_scope), get_func_sig, get_func_attrs} },
1622+
{ jl_f_throw_addr, new JuliaFunction<>{XSTR(jl_f_throw), get_func_sig, get_func_attrs} },
1623+
{ jl_f_throw_methoderror_addr, new JuliaFunction<>{XSTR(jl_f_throw_methoderror), get_func_sig, get_func_attrs} },
1624+
{ jl_f_tuple_addr, jltuple_func },
1625+
{ jl_f_svec_addr, new JuliaFunction<>{XSTR(jl_f_svec), get_func_sig, get_func_attrs} },
1626+
{ jl_f_applicable_addr, new JuliaFunction<>{XSTR(jl_f_applicable), get_func_sig, get_func_attrs} },
1627+
{ jl_f_invoke_addr, new JuliaFunction<>{XSTR(jl_f_invoke), get_func_sig, get_func_attrs} },
1628+
{ jl_f_isdefined_addr, new JuliaFunction<>{XSTR(jl_f_isdefined), get_func_sig, get_func_attrs} },
1629+
{ jl_f_getfield_addr, new JuliaFunction<>{XSTR(jl_f_getfield), get_func_sig, get_func_attrs} },
1630+
{ jl_f_setfield_addr, new JuliaFunction<>{XSTR(jl_f_setfield), get_func_sig, get_func_attrs} },
1631+
{ jl_f_swapfield_addr, new JuliaFunction<>{XSTR(jl_f_swapfield), get_func_sig, get_func_attrs} },
1632+
{ jl_f_modifyfield_addr, new JuliaFunction<>{XSTR(jl_f_modifyfield), get_func_sig, get_func_attrs} },
1633+
{ jl_f_fieldtype_addr, new JuliaFunction<>{XSTR(jl_f_fieldtype), get_func_sig, get_func_attrs} },
1634+
{ jl_f_nfields_addr, new JuliaFunction<>{XSTR(jl_f_nfields), get_func_sig, get_func_attrs} },
1635+
{ jl_f__expr_addr, new JuliaFunction<>{XSTR(jl_f__expr), get_func_sig, get_func_attrs} },
1636+
{ jl_f__typevar_addr, new JuliaFunction<>{XSTR(jl_f__typevar), get_func_sig, get_func_attrs} },
1637+
{ jl_f_memoryref_addr, new JuliaFunction<>{XSTR(jl_f_memoryref), get_func_sig, get_func_attrs} },
1638+
{ jl_f_memoryrefoffset_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefoffset), get_func_sig, get_func_attrs} },
1639+
{ jl_f_memoryrefset_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefset), get_func_sig, get_func_attrs} },
1640+
{ jl_f_memoryrefswap_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefswap), get_func_sig, get_func_attrs} },
1641+
{ jl_f_memoryrefreplace_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefreplace), get_func_sig, get_func_attrs} },
1642+
{ jl_f_memoryrefmodify_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefmodify), get_func_sig, get_func_attrs} },
1643+
{ jl_f_memoryrefsetonce_addr, new JuliaFunction<>{XSTR(jl_f_memoryrefsetonce), get_func_sig, get_func_attrs} },
1644+
{ jl_f_memoryref_isassigned_addr, new JuliaFunction<>{XSTR(jl_f_memoryref_isassigned), get_func_sig, get_func_attrs} },
1645+
{ jl_f_apply_type_addr, new JuliaFunction<>{XSTR(jl_f_apply_type), get_func_sig, get_func_attrs} },
1646+
{ jl_f_donotdelete_addr, new JuliaFunction<>{XSTR(jl_f_donotdelete), get_donotdelete_sig, get_donotdelete_func_attrs} },
1647+
{ jl_f_compilerbarrier_addr, new JuliaFunction<>{XSTR(jl_f_compilerbarrier), get_func_sig, get_func_attrs} },
1648+
{ jl_f_finalizer_addr, new JuliaFunction<>{XSTR(jl_f_finalizer), get_func_sig, get_func_attrs} },
1649+
{ jl_f_finalize_addr, new JuliaFunction<>{XSTR(jl_f_finalize), get_func_sig, get_func_attrs} },
1650+
{ jl_f__svec_ref_addr, new JuliaFunction<>{XSTR(jl_f__svec_ref), get_func_sig, get_func_attrs} },
1651+
{ jl_f_current_scope_addr, new JuliaFunction<>{XSTR(jl_f_current_scope), get_func_sig, get_func_attrs} },
16511652
};
16521653
return builtins;
16531654
}

‎src/staticdata.c‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ static const jl_fptr_args_t id_to_fptrs[] = {
514514
&jl_f__typebody, &jl_f__setsuper, &jl_f__equiv_typedef, &jl_f_get_binding_type,
515515
&jl_f_opaque_closure_call, &jl_f_donotdelete, &jl_f_compilerbarrier,
516516
&jl_f_getglobal, &jl_f_setglobal, &jl_f_swapglobal, &jl_f_modifyglobal, &jl_f_replaceglobal, &jl_f_setglobalonce,
517-
&jl_f_finalizer, &jl_f__compute_sparams, &jl_f__svec_ref,
517+
&jl_f_finalizer, &jl_f_finalize, &jl_f__compute_sparams, &jl_f__svec_ref,
518518
&jl_f_current_scope,
519519
NULL };
520520

‎test/compiler/inline.jl‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1622,6 +1622,19 @@ let src = code_typed1((Int,)) do x
16221622
@test count(iscall((src, setfield!)), src.code) == 1
16231623
end
16241624

1625+
# early `finalize` insertion
1626+
let src = code_typed1((Int,)) do x
1627+
xs = finalizer(Ref(x)) do obj
1628+
Base.@assume_effects :nothrow :notaskstate
1629+
Core.println("finalizing: ", objectid(obj))
1630+
end
1631+
@show xs[]
1632+
return xs[]
1633+
end
1634+
@test count(iscall((src, Core.finalizer)), src.code) == 1
1635+
@test count(iscall((src, Core.finalize)), src.code) == 1
1636+
end
1637+
16251638
# optimize `[push!|pushfirst!](::Vector{Any}, x...)`
16261639
@testset "optimize `$f(::Vector{Any}, x...)`" for f = Any[push!, pushfirst!]
16271640
@eval begin

0 commit comments

Comments
 (0)