d8888 888 888      88888888888 888      d8b                                 888       888          888       .d8888b.           888                               
      d88888 888 888          888     888      Y8P                                 888   o   888          888      d88P  Y88b          888                               
     d88P888 888 888          888     888                                          888  d8b  888          888      Y88b.               888                               
    d88P 888 888 888          888     88888b.  888 88888b.   .d88b.  .d8888b       888 d888b 888  .d88b.  88888b.   "Y888b.   88888b.  88888b.   .d88b.  888d888 .d88b.  
   d88P  888 888 888          888     888 "88b 888 888 "88b d88P"88b 88K           888d88888b888 d8P  Y8b 888 "88b     "Y88b. 888 "88b 888 "88b d8P  Y8b 888P"  d8P  Y8b 
  d88P   888 888 888          888     888  888 888 888  888 888  888 "Y8888b.      88888P Y88888 88888888 888  888       "888 888  888 888  888 88888888 888    88888888 
 d8888888888 888 888          888     888  888 888 888  888 Y88b 888      X88      8888P   Y8888 Y8b.     888 d88P Y88b  d88P 888 d88P 888  888 Y8b.     888    Y8b.     
d88P     888 888 888          888     888  888 888 888  888  "Y88888  88888P'      888P     Y888  "Y8888  88888P"   "Y8888P"  88888P"  888  888  "Y8888  888     "Y8888  
                                                                 888                                                          888                                        
                                                            Y8b d88P                                                          888                                        
                                                             "Y88P"                                                           888   

All Things WebSphere

Concerns and issues relating to all versions of WebSphere Application Server

Tuesday, January 31, 2012


WebSphere Classloader Memory Leak Prevention

Solving Application ClassLoader Leaks

Applications tend to want to:
  • Start new threads using Runnable implementations from the application class loader. Even though the JEE programming model does not support this, customers frequently either directly create new threads or indirectly create them by using Timers. Customers must ensure that these threads are stopped when the corresponding application (or WAR module) is stopped:
    • javax.servlet.ServletContextListener.contextDestroyed can be used to be notified when a WAR is being stopped in order to clean up. Note that WARs can be stopped independently from an application when class reloading is enabled.
    • javax.ejb.Singletonjavax.ejb.Startup, and javax.annotation.PreDestroy annotations can be used to be notified when an EJB module is being stopped in order to clean it up. Note, singleton EJBs are only available in EJB 3.1 (WAS v8).
    • Startup beans can be used to be notified when an EJB module is being stopped in order to clean up. All EJB modules are stopped when an entire application is being stopped.
  • Use ThreadLocal (storing a ThreadLocal in a static). ThreadLocal values are effectively stored as WeakHashMap in each Thread. Since the values typically include application objects, the application object references its Class, which references its ClassLoader, which references the Class contain the ThreadLocal, the weak reference is never broken, and a leak occurs.
    Customers are encouraged either to avoid the use of ThreadLocal, to clear references to the ThreadLocal when the module is stopped (see above), or to ensure that remove() is called after every request.
  • Register JMX MBeans or NotificationListener with the JMX server. Customers must ensure that these are unregistered when the corresponding application (or WAR module) is stopped.

Arbitrary components

This includes JDBC providers, third-party software, and applications themselvestend to want to:
  • Start new threads, including the "timer threads" created by the java.util.Timer constructor. When a Thread is created, two pieces of information are copied from the primordial thread:
    1. The context class loader (getContextClassLoader()). When an application is executing, the containers set the context class loader to the module class loader, so the newly created thread will keep the context class loader alive for the duration of its existence. This can be avoided by calling setContextClassLoader to a non-application class loader prior to starting the timer and then resetting it afterwards.
    2. The AccessControlContext of the calling thread (as documented by AccessController). If the thread is being started due to an API call from an application, then the application's ProtectionDomain will be in theAccessControlContext, and the ProtectionDomain of an application class will include a reference to its ClassLoader. This can be avoided by creating the thread using doPrivileged. Note that care must be taken to ensure that the use of doPrivileged does not allow unprivileged applications to create threads.

    For example:
    // doPrivileged fixes the AccessControlContext leak, and it is also required
    // for calls to Thread.get/setContextClassLoader.
    Timer timer = AccessController.doPrivileged(new PrivilegedAction() {
      public void run() {
        Thread thread = Thread.currentThread();
        ClassLoader savedCL = thread.getContextClassLoader();
        try {
          // The Timer constructor will create a Thread, which will copy the
          // context class loader from the current thread, which is now null.
          return new Timer(true);
        } finally {
  • Associate data with the current context class loader. This is typically done via a MapValue>. This Map must either:
    1. Have explicit lifecycle APIs. In this case, the lifecycle API must be called. If the code was introduced by a customer, then the customer is responsible for adding a JMX listener. If the code was introduced by a WAS prereq, then the owner must use a WAS application listener API. If the code belongs to the JDK, then the runtime team will accept responsibility for calling it (e.g., ResourceBundle.clearCache andIntrospector.flushCaches).
    2. Be a WeakHashMap to allow the ClassLoader key to be garbage collected. Note that the value must not hold a non-weak reference to classes or objects created from that ClassLoader, or the entry will never be removed. Either WeakHashMap<ClassLoader, WeakReference<Class>> or WeakHashMap<ClassLoader, Tuple>, where Tuple contains WeakReference<Class> and WeakReference<Object> to an object instantiated from the class. In both cases, the Class is held weakly, which will still allow the ClassLoader to be collected. In the latter case, the reference to the instantiated object will be cleared if a GC occurs, but the assumption is made that it can be cheaply reinstantiated.
These tips are courtesy of WAS guru Brett Kail



Post a Comment

Subscribe to Post Comments [Atom]

Links to this post:

Create a Link

<< Home


December 2006   September 2008   January 2009   February 2009   March 2009   September 2009   October 2009   November 2009   December 2009   January 2010   February 2010   March 2010   April 2010   October 2010   January 2011   February 2011   April 2011   May 2011   June 2011   July 2011   August 2011   September 2011   October 2011   November 2011   December 2011   January 2012   February 2012   March 2012   April 2012   May 2012   June 2012   July 2012   August 2012   September 2012   October 2012   November 2012   January 2013   May 2013   June 2013   July 2013   September 2013   October 2013   June 2014   August 2014  

This page is powered by Blogger. Isn't yours?

Subscribe to Posts [Atom]