Workaround for Bug 623: Sporadic XCB assertion failures w/ ATI proprietary driver and w/o native X11 locking

The proprietary ATI X11 driver does not handle multi-threaded [GL] clients well,
i.e. triggers an XCB assertion 'from time to time'.

It almost seems like that the driver either:
  - aliases all display connections to it's connection name, i.e. server; or
  - utilizes a build-in display connection w/o locking, used for some reason

+++

- X11Lib: Add QueryExtension(dpy, name) allowing early driver determination w/o GL

- X11Util detects 'requiresGlobalToolkitLock' and 'markAllDisplaysUnclosable' via
  X11 extensions. In case certain ATI extensions are available, both are set to true.

- X11GLXDrawableFactory: Dropped setting 'markAllDisplaysUnclosable', using X11Util's detection (see above).

- New GlobalToolkitLock to satisfy certain driver restrictions (ATI's XCB multithreading bug)

- NativeWindowFactory handles new property requiresGlobalToolkitLock,
  in which case the new GlobalToolkitLock is being used instead of ResourceToolkitLock.

- JAWTUtil ToolkitLock locks GlobalToolkitLock 1st to match new 'requiresGlobalToolkitLock' property.

- Document static method requirement of X11Util, GDIUtil and OSXUtil via marker interface ToolkitProperties

- ToolkitLock: New method 'validateLocked()', allowing use to validate whether the device/toolkit
  is properly locked and hence to detect implementation bugs. See unit test class: ValidateLockListener

2 files changed, 73 insertions, 0 deletions

diff --git a/src/test/com/jogamp/opengl/test/junit/jogl/acore/InitConcurrentBaseNEWT.java b/src/test/com/jogamp/opengl/test/junit/jogl/acore/InitConcurrentBaseNEWT.java
index 11d1331ed..6b2de8366 100644
--- a/src/test/com/jogamp/opengl/test/junit/jogl/acore/InitConcurrentBaseNEWT.java
+++ b/src/test/com/jogamp/opengl/test/junit/jogl/acore/InitConcurrentBaseNEWT.java
@@ -43,6 +43,7 @@ import com.jogamp.newt.Window;
 import com.jogamp.newt.opengl.GLWindow;
 import com.jogamp.opengl.test.junit.jogl.demos.es2.GearsES2;
 import com.jogamp.opengl.test.junit.util.UITestCase;
+import com.jogamp.opengl.test.junit.util.ValidateLockListener;
 import com.jogamp.opengl.util.Animator;
 
 /**
@@ -100,6 +101,7 @@ public class InitConcurrentBaseNEWT extends UITestCase {
             glWindow.setTitle("Task "+id);
             glWindow.setPosition(x + insets.getLeftWidth(), y + insets.getTopHeight() );
     
+            glWindow.addGLEventListener(new ValidateLockListener());
             glWindow.addGLEventListener(new GearsES2(0));
     
             Animator animator = new Animator(glWindow);
diff --git a/src/test/com/jogamp/opengl/test/junit/util/ValidateLockListener.java b/src/test/com/jogamp/opengl/test/junit/util/ValidateLockListener.java
new file mode 100644
index 000000000..73c1ad74c
--- /dev/null
+++ b/src/test/com/jogamp/opengl/test/junit/util/ValidateLockListener.java
@@ -0,0 +1,71 @@
+/**
+ * Copyright 2012 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.util;
+
+
+import javax.media.nativewindow.NativeSurface;
+import javax.media.opengl.GLAutoDrawable;
+import javax.media.opengl.GLEventListener;
+
+
+public class ValidateLockListener implements GLEventListener {
+
+    private void validateLock(GLAutoDrawable drawable) {
+        final NativeSurface ns = drawable.getNativeSurface();
+        ns.getGraphicsConfiguration().getScreen().getDevice().validateLocked();
+        
+        final Thread current = Thread.currentThread();
+        final Thread owner = ns.getSurfaceLockOwner();
+        if( ns.isSurfaceLockedByOtherThread() ) {
+            throw new RuntimeException(current.getName()+": Locked by another thread(1), owner "+owner+", "+ns);
+        }
+        if( current != owner ) {
+            if( null == owner ) {
+                throw new RuntimeException(current.getName()+": Not locked: "+ns);
+            }
+            throw new RuntimeException(current.getName()+": Locked by another thread(2), owner "+owner+", "+ns);            
+        }
+    }
+    
+    public void init(GLAutoDrawable drawable) {
+        validateLock(drawable);
+    }
+
+    public void reshape(GLAutoDrawable drawable, int x, int y, int width, int height) {
+        validateLock(drawable);
+    }
+
+    public void display(GLAutoDrawable drawable) {
+        validateLock(drawable);
+    }
+
+    public void dispose(GLAutoDrawable drawable) {
+        validateLock(drawable);
+    }
+}