Fix Bug 527: Creating a context w/ shared context, while the latter is in use (threading)

Bug 527 describes the situation where wglShareLists() fails (throws exception)
while the shared context is in use by another thread (some Animator).

It was reported by Jerome Jouvie.

The exception happens not everytime, but at least around 20% on manual tests
I have performed on the Windows platform.

The context in question are all JOGL's GL2, which natively where bound to an OpenGL 3.0 profile.
The WGL_ARB_create_context spec says http://www.opengl.org/registry/specs/ARB/wgl_create_context.txt:
+++
    Future versions of OpenGL may only support being added to a share
    group at context creation time. Specifying such a version of a
    context as either the <hglrc1> or <hglrc2> arguments to
    wglShareLists will fail. wglShareLists will return FALSE, and
    GetLastError will return ERROR_INCOMPATIBLE_DEVICE_CONTEXTS_ARB.
+++
Hence the 1st patch was to remove 'wglShareLists()' usage in case
we use the new WGL_ARB_create_context context creation method.
Even though this is a desired change, and works in general, it didn't fix the issue.

It seems that the shared context, which is passed @ new context creation,
cannot be used while it is in use itself in another thread.

This conclusion leads to the actual fix, ie. locking the shared context
while creating the new context which shares it.
Manual tests using this patch could not reproduce this issue (40 attempts).

Test: TestSharedContextListNEWT2

1 files changed, 157 insertions, 0 deletions

diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextListNEWT2.java b/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextListNEWT2.java
new file mode 100644
index 000000000..036cacac0
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/acore/TestSharedContextListNEWT2.java
@@ -0,0 +1,157 @@
+/**
+ * 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.acore;
+
+import java.io.IOException;
+
+import com.jogamp.newt.opengl.GLWindow;
+
+import javax.media.nativewindow.util.InsetsImmutable;
+import javax.media.opengl.GLCapabilities;
+import javax.media.opengl.GLProfile;
+import com.jogamp.opengl.util.Animator;
+
+import com.jogamp.opengl.test.junit.util.AWTRobotUtil;
+import com.jogamp.opengl.test.junit.util.UITestCase;
+import com.jogamp.opengl.test.junit.jogl.demos.gl2.Gears;
+
+import org.junit.Assert;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class TestSharedContextListNEWT2 extends UITestCase {
+    static GLProfile glp;
+    static GLCapabilities caps;
+    static int width, height;
+    GLWindow sharedDrawable;
+    Gears sharedGears;
+
+    @BeforeClass
+    public static void initClass() {
+        GLProfile.initSingleton(true);
+        glp = GLProfile.get(GLProfile.GL2);
+        Assert.assertNotNull(glp);
+        caps = new GLCapabilities(glp);
+        Assert.assertNotNull(caps);
+        width  = 256;
+        height = 256;
+    }
+
+    private void initShared() {
+    	sharedDrawable = GLWindow.create(caps);
+        Assert.assertNotNull(sharedDrawable);
+        sharedGears = new Gears();
+        Assert.assertNotNull(sharedGears);
+        sharedDrawable.addGLEventListener(sharedGears);
+        sharedDrawable.setSize(width, height);
+        sharedDrawable.setVisible(true);
+        // init and render one frame, which will setup the Gears display lists
+        sharedDrawable.display();
+    }
+
+    private void releaseShared() {
+        Assert.assertNotNull(sharedDrawable);
+        sharedDrawable.destroy();
+        sharedDrawable = null;
+    }
+
+    protected GLWindow runTestGL(Animator animator, int x, int y, boolean useShared, boolean vsync) throws InterruptedException {
+        GLWindow glWindow = GLWindow.create(caps);
+        
+        Assert.assertNotNull(glWindow);
+        glWindow.setTitle("Shared Gears NEWT Test: "+x+"/"+y+" shared "+useShared);
+        if(useShared) {
+            glWindow.setSharedContext(sharedDrawable.getContext());
+        }
+
+        glWindow.setSize(width, height);
+
+        Gears gears = new Gears(vsync ? 1 : 0);
+        if(useShared) {
+            gears.setGears(sharedGears.getGear1(), sharedGears.getGear2(), sharedGears.getGear3());
+        }
+        glWindow.addGLEventListener(gears);
+
+        animator.add(glWindow);
+        animator.start();
+        glWindow.setVisible(true);
+
+        Assert.assertTrue(AWTRobotUtil.waitForRealized(glWindow, true));
+        Assert.assertTrue(AWTRobotUtil.waitForVisible(glWindow, true));
+        glWindow.setPosition(x, y);
+        
+        return glWindow;
+    }
+
+    @Test
+    public void test01() throws InterruptedException {
+        initShared();
+        GLWindow f1 = runTestGL(new Animator(), 0, 0, true, false);
+        InsetsImmutable insets = f1.getInsets();
+        GLWindow f2 = runTestGL(new Animator(), f1.getX()+width+insets.getTotalWidth(), 
+                                f1.getY()+0, true, false);
+        GLWindow f3 = runTestGL(new Animator(), f1.getX()+0, 
+                                f1.getY()+height+insets.getTotalHeight(), true, false);
+
+        try {
+			Thread.sleep(duration);
+		} catch(Exception e) {
+			e.printStackTrace();
+		}
+
+        // here we go again: On AMD/X11 the create/destroy sequence must be the same
+        // even though this is against the chicken/egg logic here ..
+        releaseShared();
+
+        f1.destroy();
+        f2.destroy();
+        f3.destroy();
+
+        // see above ..
+        // releaseShared();
+    }
+
+    static long duration = 2000; // ms
+
+    public static void main(String args[]) throws IOException {
+        for(int i=0; i<args.length; i++) {
+            if(args[i].equals("-time")) {
+                i++;
+                try {
+                    duration = Integer.parseInt(args[i]);
+                } catch (Exception ex) { ex.printStackTrace(); }
+            }
+        }
+        /**
+        BufferedReader stdin = new BufferedReader(new InputStreamReader(System.in));
+        System.err.println("Press enter to continue");
+        System.err.println(stdin.readLine()); */         
+        org.junit.runner.JUnitCore.main(TestSharedContextListNEWT2.class.getName());
+    }
+}