Fix Bug 642 TestJSplitPaneMixHwLw01AWT (AWT-GLCanvas); Robustness GLContext/GLDrawable

- Fix Bug 642 TestJSplitPaneMixHwLw01AWT
  On Windows platform when mixing hw/lw JSplitPanel,
  the GLCanvas is removed and added when splitter is moved.
  The lack of robustness (see below) lead to an exception.

  Note: Only w/ GLJPanel (no hw/lw mixing) the splitter can be moved
  in both direction. Only here it is guaranteed that the GL component
  will survive the action.

- Fix AWT-GLCanvas EDT Runnable: swapBuffer().. / display(..)
  - Check drawable.isRealized() within the lock on the performing thread.
    This is not possible before issuing the EDT Runnable action
    since we cannot hold the lock beforehand.

- Robustness GLDrawableImpl
  - boolean realized -> volatile boolean realized
  - remove 'synchronized' on isRealized() and setRealized(..)
  - Use dbl-checked locking on 'realized' test for swapBuffers() and setRealized(..)

- Robustness GLContextImpl
  - Catch createImpl(..) exception and properly return CONTEXT_NOT_CURRENT

6 files changed, 144 insertions, 27 deletions

diff --git a/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java b/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
index e5f39e5de..3877a7997 100644
--- a/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
+++ b/src/jogl/classes/javax/media/opengl/awt/GLCanvas.java
@@ -1024,7 +1024,9 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
         final RecursiveLock _lock = lock;
         _lock.lock();
         try {
-            helper.invokeGL(drawable, context, displayAction, initAction);
+            if( drawable.isRealized() ) {
+                helper.invokeGL(drawable, context, displayAction, initAction);
+            }
         } finally {
             _lock.unlock();
         }
@@ -1037,7 +1039,7 @@ public class GLCanvas extends Canvas implements AWTGLAutoDrawable, WindowClosing
         final RecursiveLock _lock = lock;
         _lock.lock();
         try {
-            if(null != drawable) {
+            if(null != drawable && drawable.isRealized() ) {
                 drawable.swapBuffers();
             }
         } finally {
diff --git a/src/jogl/classes/jogamp/opengl/GLContextImpl.java b/src/jogl/classes/jogamp/opengl/GLContextImpl.java
index 0a665f07e..6498a191b 100644
--- a/src/jogl/classes/jogamp/opengl/GLContextImpl.java
+++ b/src/jogl/classes/jogamp/opengl/GLContextImpl.java
@@ -567,7 +567,8 @@ public abstract class GLContextImpl extends GLContext {
         if (null != shareWith) {
             shareWith.getDrawableImpl().lockSurface();
         }
-        final boolean created;
+        Throwable exception = null;
+        boolean created;
         try {
             created = createImpl(shareWith); // may throws exception if fails!
             if( created && isGL3core() && ( ctxMajorVersion>3 || ctxMajorVersion==3 && ctxMinorVersion>=2 ) ) {
@@ -580,6 +581,9 @@ public abstract class GLContextImpl extends GLContext {
                 defaultVAO = tmp[0];
                 gl.getGL2GL3().glBindVertexArray(defaultVAO);
             }
+        } catch (Throwable t) {
+            exception = t;
+            created = false;
         } finally {
             if (null != shareWith) {
                 shareWith.getDrawableImpl().unlockSurface();
@@ -591,6 +595,9 @@ public abstract class GLContextImpl extends GLContext {
                 // Thread.dumpStack();
             } else {
                 System.err.println(getThreadName() + ": Create GL context FAILED obj " + toHexString(hashCode()) + ", surf "+toHexString(drawable.getHandle())+" for " + getClass().getName());
+                if(null != exception) {
+                    exception.printStackTrace();
+                }
             }
         }
         if(!created) {
diff --git a/src/jogl/classes/jogamp/opengl/GLDrawableImpl.java b/src/jogl/classes/jogamp/opengl/GLDrawableImpl.java
index ccf0a8f0d..2d062eaf1 100644
--- a/src/jogl/classes/jogamp/opengl/GLDrawableImpl.java
+++ b/src/jogl/classes/jogamp/opengl/GLDrawableImpl.java
@@ -76,7 +76,7 @@ public abstract class GLDrawableImpl implements GLDrawable {
 
   @Override
   public final void swapBuffers() throws GLException {
-    if( !realized ) {
+    if( !realized ) { // volatile OK (locked below)
         return; // destroyed already
     }
     int lockRes = lockSurface(); // it's recursive, so it's ok within [makeCurrent .. release]
@@ -87,17 +87,19 @@ public abstract class GLDrawableImpl implements GLDrawable {
         if (NativeSurface.LOCK_SURFACE_CHANGED == lockRes) {
             updateHandle();
         }
-        final GLCapabilitiesImmutable caps = (GLCapabilitiesImmutable)surface.getGraphicsConfiguration().getChosenCapabilities();
-        if ( caps.getDoubleBuffered() ) {
-            if(!surface.surfaceSwap()) {
-                swapBuffersImpl(true);
-            }
-        } else {
-            final GLContext ctx = GLContext.getCurrent();
-            if(null!=ctx && ctx.getGLDrawable()==this) {
-                ctx.getGL().glFlush();
+        if( realized ) { // volatile OK
+            final GLCapabilitiesImmutable caps = (GLCapabilitiesImmutable)surface.getGraphicsConfiguration().getChosenCapabilities();
+            if ( caps.getDoubleBuffered() ) {
+                if(!surface.surfaceSwap()) {
+                    swapBuffersImpl(true);
+                }
+            } else {
+                final GLContext ctx = GLContext.getCurrent();
+                if(null!=ctx && ctx.getGLDrawable()==this) {
+                    ctx.getGL().glFlush();
+                }
+                swapBuffersImpl(false);
             }
-            swapBuffersImpl(false);
         }
     } finally {
         unlockSurface();
@@ -160,12 +162,11 @@ public abstract class GLDrawableImpl implements GLDrawable {
   }
 
   @Override
-  public final synchronized void setRealized(boolean realizedArg) {
-    if ( realized != realizedArg ) {
+  public final void setRealized(boolean realizedArg) {
+    if ( realized != realizedArg ) { // volatile: OK (locked below)
         if(DEBUG) {
             System.err.println(getThreadName() + ": setRealized: "+getClass().getSimpleName()+" "+realized+" -> "+realizedArg);
         }
-        realized = realizedArg;
         AbstractGraphicsDevice aDevice = surface.getGraphicsConfiguration().getScreen().getDevice();
         if(realizedArg) {
             if(surface instanceof ProxySurface) {
@@ -178,12 +179,15 @@ public abstract class GLDrawableImpl implements GLDrawable {
             aDevice.lock();
         }
         try {
-            if(realizedArg) {
-                setRealizedImpl();
-                updateHandle();
-            } else {
-                destroyHandle();
-                setRealizedImpl();
+            if ( realized != realizedArg ) { // volatile: OK
+                realized = realizedArg;
+                if(realizedArg) {
+                    setRealizedImpl();
+                    updateHandle();
+                } else {
+                    destroyHandle();
+                    setRealizedImpl();
+                }
             }
         } finally {
             if(realizedArg) {
@@ -199,6 +203,7 @@ public abstract class GLDrawableImpl implements GLDrawable {
         System.err.println(getThreadName() + ": setRealized: "+getClass().getName()+" "+this.realized+" == "+realizedArg);
     }
   }
+  
   /**
    * Platform specific realization of drawable 
    */
@@ -256,7 +261,7 @@ public abstract class GLDrawableImpl implements GLDrawable {
   }
   
   @Override
-  public final synchronized boolean isRealized() {
+  public final boolean isRealized() {
     return realized;
   }
 
@@ -306,6 +311,6 @@ public abstract class GLDrawableImpl implements GLDrawable {
   // result of calling show() on the main thread. To work around this
   // we prevent any JAWT or OpenGL operations from being done until
   // addNotify() is called on the surface.
-  protected boolean realized;
+  protected volatile boolean realized;
 
 }
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestBug642JSplitPaneMixHwLw01AWT.java b/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestBug642JSplitPaneMixHwLw01AWT.java
index d0c07570a..76b6ba0d7 100644
--- a/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestBug642JSplitPaneMixHwLw01AWT.java
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestBug642JSplitPaneMixHwLw01AWT.java
@@ -77,7 +77,8 @@ public class TestBug642JSplitPaneMixHwLw01AWT extends UITestCase {
     }
     
     protected void runTestGL(GLCapabilities caps, boolean useGLJPanel) throws InterruptedException {
-        final JFrame frame = new JFrame("JSplitPane Mix Hw/Lw Swing");
+        final String typeS = useGLJPanel ? "LW" : "HW";
+        final JFrame frame = new JFrame("Mix Hw/Lw Swing - Canvas "+typeS);
         Assert.assertNotNull(frame);
         
         final Dimension f_sz = new Dimension(824,568);
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestIsRealizedConcurrency01AWT.java b/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestIsRealizedConcurrency01AWT.java
new file mode 100644
index 000000000..778f07fff
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestIsRealizedConcurrency01AWT.java
@@ -0,0 +1,101 @@
+/**
+ * Copyright 2010 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ * 
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ * 
+ *    2. Redistributions in binary form must reproduce the above copyright notice, this list
+ *       of conditions and the following disclaimer in the documentation and/or other materials
+ *       provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+ 
+package com.jogamp.opengl.test.junit.jogl.awt;
+
+import javax.media.opengl.awt.GLCanvas;
+import com.jogamp.opengl.util.Animator;
+
+import com.jogamp.opengl.test.junit.util.UITestCase;
+import com.jogamp.opengl.test.junit.jogl.demos.es2.GearsES2;
+
+import com.jogamp.opengl.test.junit.util.MiscUtils;
+
+import java.awt.Dimension;
+import java.awt.Frame;
+import java.lang.reflect.InvocationTargetException;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+
+public class TestIsRealizedConcurrency01AWT extends UITestCase {
+    static long durationPerTest = 1000; // ms
+        
+    @Test
+    public void testAddRemove() throws InterruptedException, InvocationTargetException {
+        final Dimension f_sz = new Dimension(512, 512);
+        
+        final GLCanvas glCanvas = new GLCanvas();
+        Assert.assertNotNull(glCanvas);
+        glCanvas.addGLEventListener(new GearsES2());
+
+        final Animator animator = new Animator(glCanvas);
+        animator.start();
+        
+        final Frame frame = new Frame("Frame");
+        Assert.assertNotNull(frame);        
+        frame.add(glCanvas);
+        
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame.setLocation(0, 0);
+                frame.setPreferredSize(f_sz);
+                frame.setSize(f_sz);
+                frame.pack();
+                frame.setVisible(true);
+            }});
+        Thread.sleep(durationPerTest/2);
+
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                frame.remove(glCanvas);
+                frame.validate();
+                frame.add(glCanvas);
+                frame.validate();
+            }});
+        Thread.sleep(durationPerTest/2);
+        
+        javax.swing.SwingUtilities.invokeAndWait(new Runnable() {
+            public void run() {
+                glCanvas.destroy();
+                frame.dispose();
+            }});
+        
+        animator.stop();
+    }
+
+    public static void main(String args[]) {
+        for(int i=0; i<args.length; i++) {
+            if(args[i].equals("-time")) {
+                durationPerTest = MiscUtils.atoi(args[++i], (int)durationPerTest);
+            }
+        }
+        org.junit.runner.JUnitCore.main(TestIsRealizedConcurrency01AWT.class.getName());
+    }
+}
diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestJScrollPaneMixHwLw01AWT.java b/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestJScrollPaneMixHwLw01AWT.java
index 78677c29b..8868d255d 100644
--- a/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestJScrollPaneMixHwLw01AWT.java
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/awt/TestJScrollPaneMixHwLw01AWT.java
@@ -77,7 +77,8 @@ public class TestJScrollPaneMixHwLw01AWT extends UITestCase {
     }
     
     protected void runTestGL(GLCapabilities caps, boolean useJScroll) throws InterruptedException {
-        final JFrame frame = new JFrame("JScrollPane Mix Hw/Lw Swing");
+        final String typeS = useJScroll ? "LW" : "HW";
+        final JFrame frame = new JFrame("Mix Hw/Lw Swing - ScrollPane "+typeS);
         Assert.assertNotNull(frame);
         
         final Dimension f_sz = new Dimension(600,400);