I've been looking into a bug in my code that seems to be caused by some "ugly" finalizer code. The code looks roughly like this
public class A {
public B b = new B();
@Override public void finalize() {
b.close();
}
}
public class B {
public void close() { /* do clean up our resources. */ }
public void doSomething() { /* do something that requires us not to be closed */ }
}
void main() {
A a = new A();
B b = a.b;
for(/*lots of time*/) {
b.doSomething();
}
}
What I think is happening is that a
is getting detected as having no references after
the second line of main()
and getting GC'd and finalized the finalizer thread - while the for
loop is still happening, using b
while a
is still "in scope".
Is this plausable? Is java allowed to GC an object before it goes out of scope?
Note: I know that doing anything inside finalizers is bad. This is code I've inherited and am intending to fix - the question is whether I'm understanding the root issue correctly. If this is impossible then something more subtle must be the root of my bug.
JLS §12.6.1:
So yes, I think it's allowable for a compiler to add hidden code to set
a
tonull
, thus allowing it to be garbage-collected. If this is what's happening, you may not be able to tell from the bytecode (see @user2357112's comment).Possible (ugly) workaround: Add
public static boolean alwaysFalse = false;
to the main class or some other class, and then at the end ofmain()
, addif (alwaysFalse) System.out.println(a);
or something else that referencesa
. I don't think an optimizer can ever determine with certainty thatalwaysFalse
is never set (since some class could always use reflection to set it); therefore, it won't be able to tell thata
is no longer needed. At the least, this kind of "workaround" could be used to determine whether this is indeed the problem.Yes.
However, I'm being pedantic here. Scope is a language concept that determines the validity of names. Whether an object can be garbage collected (and therefore finalized) depends on whether it is reachable.
The answer from ajb almost had it (+1) by citing a significant passage from the JLS. However I don't think it's directly applicable to the situation. JLS §12.6.1 also says:
Now consider this applied to the following code:
On JDK 8 GA, this will finalize
a
every single time. If you uncomment theprintln
at the end,a
will never be finalized.With the
println
commented out, one can see how the reachability rule applies. When the code reaches the loop, there is no possible way that the thread can have any access toa
. Thus it is unreachable and is therefore subject to finalization and garbage collection.Note that the name
a
is still in scope because one can usea
anywhere within the enclosing block -- in this case themain
method body -- from its declaration to the end of the block. The exact scope rules are covered in JLS §6.3. But really, as you can see, scope has nothing to do with reachability or garbage collection.To prevent the object from being garbage collected, you can store a reference to it in a static field, or if don't want to do that, you can keep it reachable by using it later on in the same method after the time-consuming loop. It should be sufficient to call an innocuous method like
toString
on it.