summaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/jogamp/opengl/GLContextLock.java
blob: ea78f520923e882887a9ff789341bea048de2366 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
 * Copyright (c) 2003 Sun Microsystems, Inc. All Rights Reserved.
 * Copyright (c) 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:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution 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.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package com.jogamp.opengl.impl;

import javax.media.opengl.*;

/** Implements the makeCurrent / release locking behavior of the
    GLContext class. When "fail fast mode" is enabled, attempts to
    lock the same GLContextLock on more than one thread cause
    GLException to be raised. This lock is not recursive. Attempts to
    lock it more than once on a given thread will cause GLException to
    be raised. */

public class GLContextLock {
  protected static final boolean DEBUG = GLContextImpl.DEBUG;

  static class SyncData {
      boolean failFastMode = true;
      Thread owner = null;
      int waiters = 0;
      Exception lockedStack = null; // only enabled if DEBUG
  }
  private SyncData sdata = new SyncData(); // synchronized (flow/mem)  mutable access

  /** Locks this GLContextLock on the current thread. If fail fast
      mode is enabled and the GLContextLock is already owned by
      another thread, throws GLException. */
  public final void lock() throws GLException {
    synchronized(sdata) {
      Thread current = Thread.currentThread();
      if (sdata.owner == null) {
        sdata.owner = current;
        if(DEBUG) {
            sdata.lockedStack = new Exception("Error: Previously made current (1) by "+sdata.owner+", lock: "+this);
        }
      } else if (sdata.owner != current) {
        while (sdata.owner != null) {
          if (sdata.failFastMode) {
            if(null!=sdata.lockedStack) {
                sdata.lockedStack.printStackTrace();
            }
            throw new GLException("Error: Attempt to make context current on thread " + current +
                                  " which is already current on thread " + sdata.owner);
          } else {
            try {
              ++sdata.waiters;
              sdata.wait();
            } catch (InterruptedException e) {
              throw new GLException(e);
            } finally {
              --sdata.waiters;
            }
          }
        }
        sdata.owner = current;
        if(DEBUG) {
            sdata.lockedStack = new Exception("Previously made current (2) by "+sdata.owner+", lock: "+this);
        }
      } else {
        throw new GLException("Attempt to make the same context current twice on thread " + current);
      }
    }
  }

  /** Unlocks this GLContextLock. */
  public final void unlock() throws GLException {
    synchronized (sdata) {
      Thread current = Thread.currentThread();
      if (sdata.owner == current) {
        sdata.owner = null;
        sdata.lockedStack = null;
        // Assuming notify() implementation weaks up the longest waiting thread, to avoid starvation. 
        // Otherwise we would need to have a Thread queue implemented, using sleep(timeout) and interrupt.
        sdata.notify();
      } else {
        if (sdata.owner != null) {
          throw new GLException("Attempt by thread " + current +
                                " to release context owned by thread " + sdata.owner);
        } else {
          throw new GLException("Attempt by thread " + current +
                                " to release unowned context");
        }
      }
    }
  }

  /** Indicates whether this lock is held by the current thread. */
  public final boolean isHeld() {
    synchronized(sdata) {
      return (Thread.currentThread() == sdata.owner);
    }
  }

  public final void setFailFastMode(boolean onOrOff) {
    synchronized(sdata) {
        sdata.failFastMode = onOrOff;
    }
  }

  public final boolean getFailFastMode() {
    synchronized(sdata) {
        return sdata.failFastMode;
    }
  }

  public final boolean hasWaiters() {
    synchronized(sdata) {
        return (0 != sdata.waiters);
    }
  }

  /** holding the owners stack trace when lock is acquired and DEBUG is true */
  public final Exception getLockedStack() {
    synchronized(sdata) {
        return sdata.lockedStack;
    }
  }

}