Cleanup shutdown mechanism ; Fix X11/ATI SIGV at shutdown ; EGLDisplayUtil: Check for leaked display handles

GLProfile / all shutdown methods: Remove ShutdownType to remove complexity (not required)

Proper shutdown sequence:
  GLProfile - GLDrawableFactory+ - GLContext - NativeWindowFactory - [X11Util, OSXUtil, ..]

GLDrawableFactory: Always keep shutdown-hook alive, required for X11Util shutdown (@ JVMShutdown only)

X11Util: Shutdown
  - @ JVMShutdown only
  - If GL vendor ATI: close pending X11 display connections in proper order of creation.
    This finally removes the SIGV when shutting down the JVM on X11 w/ ATI driver.

EGLDisplayUtil: Add shutdown, allowing to validate whether leaked EGL display handles remain.

2 files changed, 44 insertions, 16 deletions

diff --git a/src/jogl/classes/jogamp/opengl/egl/EGLDisplayUtil.java b/src/jogl/classes/jogamp/opengl/egl/EGLDisplayUtil.java
index 18d2f830d..ce2e824f5 100644
--- a/src/jogl/classes/jogamp/opengl/egl/EGLDisplayUtil.java
+++ b/src/jogl/classes/jogamp/opengl/egl/EGLDisplayUtil.java
@@ -29,6 +29,7 @@
 package jogamp.opengl.egl;
 
 import java.nio.IntBuffer;
+import java.util.Iterator;
 
 import javax.media.nativewindow.AbstractGraphicsDevice;
 import javax.media.nativewindow.NativeSurface;
@@ -51,7 +52,7 @@ import com.jogamp.nativewindow.egl.EGLGraphicsDevice;
  * </p>
  */
 public class EGLDisplayUtil {
-    protected static final boolean DEBUG = Debug.debug("EGL");
+    protected static final boolean DEBUG = Debug.debug("EGLDisplayUtil");
     
     static LongIntHashMap eglDisplayCounter;
     
@@ -60,6 +61,32 @@ public class EGLDisplayUtil {
         eglDisplayCounter.setKeyNotFoundValue(0);
     }
 
+    /** 
+     * @return number of unclosed EGL Displays.<br>
+     */
+    public static int shutdown(boolean verbose) {
+        if(DEBUG || verbose || eglDisplayCounter.size() > 0 ) {
+            System.err.println("EGLDisplayUtil.EGLDisplays: Shutdown (open: "+eglDisplayCounter.size()+")");
+            if(DEBUG) {
+                Thread.dumpStack();
+            }
+            if( eglDisplayCounter.size() > 0) {
+                EGLDisplayUtil.dumpOpenDisplayConnections();
+            }
+        }
+
+        return eglDisplayCounter.size();
+    }
+    
+    public static void dumpOpenDisplayConnections() {
+        System.err.println("EGLDisplayUtil: Open EGL Display Connections: "+eglDisplayCounter.size());
+        int i=0;
+        for(Iterator<LongIntHashMap.Entry> iter = eglDisplayCounter.iterator(); iter.hasNext(); i++) {
+            final LongIntHashMap.Entry e = iter.next();
+            System.err.println("EGLDisplayUtil: Open["+i+"]: 0x"+Long.toHexString(e.key)+": refCnt "+e.value);
+        }
+    }
+    
     public static long eglGetDisplay(long nativeDisplay_id)  {
         final long eglDisplay = EGL.eglGetDisplay(nativeDisplay_id);
         if(DEBUG) {
@@ -89,6 +116,7 @@ public class EGLDisplayUtil {
         eglDisplayCounter.put(eglDisplay, refCnt);
         if(DEBUG) {
             System.err.println("EGLDisplayUtil.eglInitialize1("+EGLContext.toHexString(eglDisplay)+" ...): #"+refCnt+" = "+res);
+            // Thread.dumpStack();
         }
         return res;
     }
@@ -117,6 +145,7 @@ public class EGLDisplayUtil {
         }
         if(DEBUG) {
             System.err.println("EGLDisplayUtil.eglInitialize2("+EGLContext.toHexString(eglDisplay)+" ...): #"+refCnt+" = "+res);
+            // Thread.dumpStack();
         }
         return res;
     }
@@ -185,12 +214,13 @@ public class EGLDisplayUtil {
         final int refCnt = eglDisplayCounter.get(eglDisplay) - 1; // 1 - 1 = 0 -> final terminate
         if(0==refCnt) { // no terminate if still in use or already terminated
             res = EGL.eglTerminate(eglDisplay);
+            eglDisplayCounter.remove(eglDisplay);
         } else {
+            if(0 < refCnt) { // no negative refCount
+                eglDisplayCounter.put(eglDisplay, refCnt);
+            } 
             res = true;
         }
-        if(0<=refCnt) { // no negative refCount
-            eglDisplayCounter.put(eglDisplay, refCnt);
-        }
         if(DEBUG) {
             System.err.println("EGLDisplayUtil.eglTerminate("+EGLContext.toHexString(eglDisplay)+" ...): #"+refCnt+" = "+res);
             // Thread.dumpStack();
diff --git a/src/jogl/classes/jogamp/opengl/egl/EGLDrawableFactory.java b/src/jogl/classes/jogamp/opengl/egl/EGLDrawableFactory.java
index 986b110be..292eb17c8 100644
--- a/src/jogl/classes/jogamp/opengl/egl/EGLDrawableFactory.java
+++ b/src/jogl/classes/jogamp/opengl/egl/EGLDrawableFactory.java
@@ -64,7 +64,6 @@ import javax.media.opengl.GLDrawable;
 import javax.media.opengl.GLDrawableFactory;
 import javax.media.opengl.GLException;
 import javax.media.opengl.GLProfile;
-import javax.media.opengl.GLProfile.ShutdownType;
 
 import jogamp.opengl.Debug;
 import jogamp.opengl.GLDrawableFactoryImpl;
@@ -201,13 +200,13 @@ public class EGLDrawableFactory extends GLDrawableFactoryImpl {
   
     
     @Override
-    protected final void destroy(ShutdownType shutdownType) {
+    protected final void destroy() {
         if(null != sharedMap) {
             Collection<SharedResource> srl = sharedMap.values();
             for(Iterator<SharedResource> sri = srl.iterator(); sri.hasNext(); ) {
                 SharedResource sr = sri.next();
                 if(DEBUG) {
-                    System.err.println("EGLDrawableFactory.destroy("+shutdownType+"): "+sr.device.toString());
+                    System.err.println("EGLDrawableFactory.destroy(): "+sr.device.toString());
                 }
                 sr.device.close();
             }
@@ -220,17 +219,16 @@ public class EGLDrawableFactory extends GLDrawableFactoryImpl {
         /**
          * Pulling away the native library may cause havoc ..
          */
-        if(ShutdownType.COMPLETE == shutdownType) {
-            if(null != eglES1DynamicLookupHelper) {
-                // eglES1DynamicLookupHelper.destroy();
-                eglES1DynamicLookupHelper = null;
-            }
-            if(null != eglES2DynamicLookupHelper) {
-                // eglES2DynamicLookupHelper.destroy();
-                eglES2DynamicLookupHelper = null;
-            }
+        if(null != eglES1DynamicLookupHelper) {
+            // eglES1DynamicLookupHelper.destroy();
+            eglES1DynamicLookupHelper = null;
+        }
+        if(null != eglES2DynamicLookupHelper) {
+            // eglES2DynamicLookupHelper.destroy();
+            eglES2DynamicLookupHelper = null;
         }
         EGLGraphicsConfigurationFactory.unregisterFactory();
+        EGLDisplayUtil.shutdown(DEBUG);
     }
 
     private HashMap<String /*connection*/, SharedResource> sharedMap = null;