- !! This page is under construction !!*
For some time Tomcat has had some means of protection against memory leaks when stopping or redeploying applications. This page tries to list them, and shows the situations where leaks can be detected and fixed.
...
Leak cause | Detected by tomcat | Fixed by tomcat | Possible enhancements | |
>=6.0.246.0.24-6 | >= 7.0.26 but is unsafe. Made optional from 6 .0.27 | |||
>=6.0.24 | 6.0.24-6.0.26 but is unsafe. Made optional from 6.0.27 | >= 7.0.6 | ||
Webapp class instance indirectly held through a ThreadLocal value | no | no | >= 7.0.6 | |
>=6.0.24 | 6.0.24-6.0.26 but is unsafe. Made optional from 6.0.27 | >= 7.0.6 | ||
>=6.0.24 | In 6.0.24-6.0.26 | Detect child classloaders, Fix the application to stop the thread when the application is stopped | ||
ContextClassLoader / Threads spawned by classes loaded by the common classloader | >=6.0.24 | In 6.0.24-6.0.26 | Detect child classloaders, fix Fix the offending code (set the correct CCL when spawning the thread) | |
no | >=6.0.24 pre-spawns some known offenders |
| ||
no | > 6.0.? . Disabled by default with tomcat 7 |
| ||
| > 6.0.? |
| ||
> 6.0.? | > 6.0.? |
| ||
| > 6.0.? |
|
...
In this particular case, the leak is detected and a message is logged. Tomcat 6.0.24 to 6.0.26 modify internal structures of the JDK (ThreadLocalMap
) to remove the reference to the ThreadLocal
instance, but this is unsafe (see #48895) so that it became optional and disabled by default from 6.0.27. Starting with Tomcat 7.0.6, the threads of the pool are renewed so that the leak is safely fixed.
No Format |
---|
Mar 16, |
No Format |
Mar 16, 2010 11:47:24 PM org.apache.catalina.loader.WebappClassLoader clearThreadLocalMap
SEVERE: A web application created a ThreadLocal with key of type [test.MyThreadLocal] (value [test.MyThreadLocal@4dbb9a58]) and a value of type [test.MyCounter] (value [test.MyCounter@57922f46]) but failed to remove it when the web application was stopped. To prevent a memory leak, the ThreadLocal has been forcibly removed.
|
Note: this particular leak was actually already cured by previous versions of tomcat 6, because static references of classes loaded by the webappclassloader are nullified (see later).
...
We have more or less the same kind of leak as the previous one, but this time tomcat 6.0.24 does not detect the leak when stopping the application (and does not fix it). The problem is that when it inspects the entries of ThreadLocalMap
, it checks whether either the key or the value is an instance of a class loaded by the webapp classloader. Here the key is an instance of ThreadLocal
, and the value is an instance of java.util.ArrayList
.
...
But it does not give any clue about what caused the leak, we would need to make a heapdump and analyse it with some tool like Eclipse MAT.
Tomcat 7.0.6 and later fix this leak by renewing threads in the pool.
Anchor | ||||
---|---|---|---|---|
|
...
Tomcat 6.0.24-6.0.26 "speeds up" the removal of stale entries (and thus fixes the pseudo-leak), by calling expungeStaleEntries()
for each thread that has some stale entries. Since it's not thread-safe, it has been made optional and disabled by default from 6.0.27.
Threads ContextClassLoader
...
Tomcat 7.0.6 and later fix the problem by renewing threads in the pool.
Threads ContextClassLoader
Anchor | ||||
---|---|---|---|---|
|
...
Threads spawned by webapps
...
Instead of trying to stop such threads, tomcat prefers to force the creation of such threads when the container is started, before webapps are started. The JreMemoryLeakPreventionListener
does it for a few known offenders in the JRE.
...
Anchor | ||||
---|---|---|---|---|
|
static class variables
When an app is stopped, Tomcat (even before 6.0.24 and later detect leaks caused by ThreadLocal}}s and Threads context classloader only by checking for the current {{WebAppClassLoader
. If a child classloader is involved, the leak is not detected. That should be improved in a future release. Anchor
static class variables
When an app is stopped, Tomcat (even before 6.0.24) nullifies the value of all static class variables of classes loaded by the WebAppClassLoader
. In some cases, ) nullifies the value of all static class variables of classes loaded by the WebAppClassLoader
. In some cases, it may fix a classloader leak (for example because of a custom ThreadLocal
class, see above), but even if we still have a leak, it may decrease the amount of memory lost:
...
Related issues
48837 - Memory leaks protection does not cure leaks triggered by JSP pages codeAnchor 488374915948837 49159 Anchor 48895 48895 48895 - WebAppClassLoader.clearThreadLocalMap() concurrency issuesAnchor 48971 48971 48971 - memory leak protection : stopping TimerThreads should be optional and disabled by defaultAnchor 49159 49159 49159 - Improve 49159 - Improve ThreadLocal memory leak clean-up- Sun bug 4957990 - In some cases the Server JVM fails to collect classloaders. According to this page it should have been fixed with java 6u16 but actually it was not. It seems to be fixed with 6u21 (documented here and verified by the author of this wiki page).
- Sun bug 6916498 - An exception can keep a classloader in memory if the stack trace that was recorded when it was created contains a reference to one of its classes. Fixes were done in Tomcat for its own classes that had this issue (see BZ 50460), but some library or JRE code may still create a leak that is undetected by tools because of this JVM bug. See also BZ 53936 for a workaround that you can implement if you are unable to fix a buggy library.
...