diff options
author | Jeroen Frijters <jeroen@sumatra.nl> | 2003-08-29 12:43:07 +0000 |
---|---|---|
committer | Jeroen Frijters <jeroen@sumatra.nl> | 2003-08-29 12:43:07 +0000 |
commit | 1451cb6526f172e8b466b558cf9d6318899c9320 (patch) | |
tree | af4d3fe816a6800f395377d70894aab254597627 /vm | |
parent | f6658148113b8117018ad9014e782bbc4ec96145 (diff) | |
download | classpath-1451cb6526f172e8b466b558cf9d6318899c9320.tar.gz |
New VM thread interface.
* java/lang/Thread.java: New file.
* vm/reference/java/lang/Thread.java: Removed.
* vm/reference/java/lang/VMThread.java: New file.
Diffstat (limited to 'vm')
-rw-r--r-- | vm/reference/java/lang/Thread.java | 890 | ||||
-rw-r--r-- | vm/reference/java/lang/VMThread.java | 393 |
2 files changed, 393 insertions, 890 deletions
diff --git a/vm/reference/java/lang/Thread.java b/vm/reference/java/lang/Thread.java deleted file mode 100644 index 8b660e4af..000000000 --- a/vm/reference/java/lang/Thread.java +++ /dev/null @@ -1,890 +0,0 @@ -/* Thread -- an independent thread of executable code - Copyright (C) 1998, 2001, 2002, 2003 Free Software Foundation - -This file is part of GNU Classpath. - -GNU Classpath is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. - -GNU Classpath is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. - -You should have received a copy of the GNU General Public License -along with GNU Classpath; see the file COPYING. If not, write to the -Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA -02111-1307 USA. - -Linking this library statically or dynamically with other modules is -making a combined work based on this library. Thus, the terms and -conditions of the GNU General Public License cover the whole -combination. - -As a special exception, the copyright holders of this library give you -permission to link this library with independent modules to produce an -executable, regardless of the license terms of these independent -modules, and to copy and distribute the resulting executable under -terms of your choice, provided that you also meet, for each linked -independent module, the terms and conditions of the license of that -module. An independent module is a module which is not derived from -or based on this library. If you modify this library, you may extend -this exception to your version of the library, but you are not -obligated to do so. If you do not wish to do so, delete this -exception statement from your version. */ - -package java.lang; - -/** - * Thread represents a single thread of execution in the VM. When an - * application VM starts up, it creates a non-daemon Thread which calls the - * main() method of a particular class. There may be other Threads running, - * such as the garbage collection thread. - * - * <p>Threads have names to identify them. These names are not necessarily - * unique. Every Thread has a priority, as well, which tells the VM which - * Threads should get more running time. New threads inherit the priority - * and daemon status of the parent thread, by default. - * - * <p>There are two methods of creating a Thread: you may subclass Thread and - * implement the <code>run()</code> method, at which point you may start the - * Thread by calling its <code>start()</code> method, or you may implement - * <code>Runnable</code> in the class you want to use and then call new - * <code>Thread(your_obj).start()</code>. - * - * <p>The virtual machine runs until all non-daemon threads have died (either - * by returning from the run() method as invoked by start(), or by throwing - * an uncaught exception); or until <code>System.exit</code> is called with - * adequate permissions. - * - * <p>It is unclear at what point a Thread should be added to a ThreadGroup, - * and at what point it should be removed. Should it be inserted when it - * starts, or when it is created? Should it be removed when it is suspended - * or interrupted? The only thing that is clear is that the Thread should be - * removed when it is stopped. - * - * @author John Keiser - * @author Eric Blake <ebb9@email.byu.edu> - * @see Runnable - * @see Runtime#exit(int) - * @see #run() - * @see #start() - * @see ThreadLocal - * @since 1.0 - * @status updated to 1.4 - */ -public class Thread implements Runnable -{ - /** The minimum priority for a Thread. */ - public static final int MIN_PRIORITY = 1; - - /** The priority a Thread gets by default. */ - public static final int NORM_PRIORITY = 5; - - /** The maximum priority for a Thread. */ - public static final int MAX_PRIORITY = 10; - - /** - * The group this thread belongs to. This is set to null by - * ThreadGroup.removeThread when the thread dies. - */ - ThreadGroup group; - - /** The object to run(), null if this is the target. */ - final Runnable toRun; - - /** The thread name, non-null. */ - String name; - - /** Whether the thread is a daemon. */ - boolean daemon; - - /** The thread priority, 1 to 10. */ - int priority; - - /** The context classloader for this Thread. */ - private ClassLoader contextClassLoader; - - /** The next thread number to use. */ - private static int numAnonymousThreadsCreated = 0; - - /** - * Allocate a new Thread object, as if by - * <code>Thread(null, null, <i>fake name</i>)</code>, where the fake name - * is "Thread-" + <i>unique integer</i>. - * - * @see #Thread(ThreadGroup, Runnable, String) - */ - public Thread() - { - this(null, (Runnable) null); - } - - /** - * Allocate a new Thread object, as if by - * <code>Thread(null, toRun, <i>fake name</i>)</code>, where the fake name - * is "Thread-" + <i>unique integer</i>. - * - * @param toRun the Runnable object to execute - * @see #Thread(ThreadGroup, Runnable, String) - */ - public Thread(Runnable toRun) - { - this(null, toRun); - } - - /** - * Allocate a new Thread object, as if by - * <code>Thread(group, toRun, <i>fake name</i>)</code>, where the fake name - * is "Thread-" + <i>unique integer</i>. - * - * @param group the group to put the Thread into - * @param target the Runnable object to execute - * @throws SecurityException if this thread cannot access <code>group</code> - * @throws IllegalThreadStateException if group is destroyed - * @see #Thread(ThreadGroup, Runnable, String) - */ - public Thread(ThreadGroup group, Runnable toRun) - { - this(group, toRun, "Thread-" + ++numAnonymousThreadsCreated, 0); - } - - /** - * Allocate a new Thread object, as if by - * <code>Thread(null, null, name)</code>. - * - * @param name the name for the Thread - * @throws NullPointerException if name is null - * @see #Thread(ThreadGroup, Runnable, String) - */ - public Thread(String name) - { - this(null, null, name, 0); - } - - /** - * Allocate a new Thread object, as if by - * <code>Thread(group, null, name)</code>. - * - * @param group the group to put the Thread into - * @param name the name for the Thread - * @throws NullPointerException if name is null - * @throws SecurityException if this thread cannot access <code>group</code> - * @throws IllegalThreadStateException if group is destroyed - * @see #Thread(ThreadGroup, Runnable, String) - */ - public Thread(ThreadGroup group, String name) - { - this(group, null, name, 0); - } - - /** - * Allocate a new Thread object, as if by - * <code>Thread(group, null, name)</code>. - * - * @param toRun the Runnable object to execute - * @param name the name for the Thread - * @throws NullPointerException if name is null - * @see #Thread(ThreadGroup, Runnable, String) - */ - public Thread(Runnable toRun, String name) - { - this(null, toRun, name, 0); - } - - /** - * Allocate a new Thread object, with the specified ThreadGroup and name, and - * using the specified Runnable object's <code>run()</code> method to - * execute. If the Runnable object is null, <code>this</code> (which is - * a Runnable) is used instead. - * - * <p>If the ThreadGroup is null, the security manager is checked. If a - * manager exists and returns a non-null object for - * <code>getThreadGroup</code>, that group is used; otherwise the group - * of the creating thread is used. Note that the security manager calls - * <code>checkAccess</code> if the ThreadGroup is not null. - * - * <p>The new Thread will inherit its creator's priority and daemon status. - * These can be changed with <code>setPriority</code> and - * <code>setDaemon</code>. - * - * @param group the group to put the Thread into - * @param target the Runnable object to execute - * @param name the name for the Thread - * @throws NullPointerException if name is null - * @throws SecurityException if this thread cannot access <code>group</code> - * @throws IllegalThreadStateException if group is destroyed - * @see Runnable#run() - * @see #run() - * @see #setDaemon(boolean) - * @see #setPriority(int) - * @see SecurityManager#checkAccess(ThreadGroup) - * @see ThreadGroup#checkAccess() - */ - public Thread(ThreadGroup group, Runnable toRun, String name) - { - this(group, toRun, name, 0); - } - - /** - * Allocate a new Thread object, as if by - * <code>Thread(group, null, name)</code>, and give it the specified stack - * size, in bytes. The stack size is <b>highly platform independent</b>, - * and the virtual machine is free to round up or down, or ignore it - * completely. A higher value might let you go longer before a - * <code>StackOverflowError</code>, while a lower value might let you go - * longer before an <code>OutOfMemoryError</code>. Or, it may do absolutely - * nothing! So be careful, and expect to need to tune this value if your - * virtual machine even supports it. - * - * @param group the group to put the Thread into - * @param target the Runnable object to execute - * @param name the name for the Thread - * @param size the stack size, in bytes; 0 to be ignored - * @throws NullPointerException if name is null - * @throws SecurityException if this thread cannot access <code>group</code> - * @throws IllegalThreadStateException if group is destroyed - * @since 1.4 - */ - public Thread(ThreadGroup group, Runnable toRun, String name, long size) - { - // Bypass System.getSecurityManager, for bootstrap efficiency. - SecurityManager sm = Runtime.securityManager; - Thread current = currentThread(); - if (group == null) - { - if (sm != null) - group = sm.getThreadGroup(); - if (group == null) - { - if (current == null) - group = ThreadGroup.root; - else - group = current.group; - } - } - else if (sm != null) - sm.checkAccess(group); - this.group = group; - - // Use toString hack to detect null. - this.name = name.toString(); - this.toRun = toRun; - if (current == null) - { - priority = NORM_PRIORITY; - daemon = false; - contextClassLoader = ClassLoader.getSystemClassLoader(); - } - else - { - priority = current.priority; - daemon = current.daemon; - contextClassLoader = current.contextClassLoader; - } - nativeInit(size); - - group.addThread(this); - InheritableThreadLocal.newChildThread(this); - } - - /** - * Get the currently executing Thread. In the situation that the - * currently running thread was created by native code and doesn't - * have an associated Thread object yet, currentThread() should set - * a flag and then attempt to construct and return a new Thread object. - * When currentThread() is invoked again recursively by the Thread - * constructor, the flag will already be set and in that second case - * currentThread() should just return null. currentThread() should not - * return a non-null value until after the constructor has returned. - * - * @return the currently executing Thread - */ - public static native Thread currentThread(); - - /** - * Yield to another thread. The Thread will not lose any locks it holds - * during this time. There are no guarantees which thread will be - * next to run, and it could even be this one, but most VMs will choose - * the highest priority thread that has been waiting longest. - */ - public static native void yield(); - - /** - * Suspend the current Thread's execution for the specified amount of - * time. The Thread will not lose any locks it has during this time. There - * are no guarantees which thread will be next to run, but most VMs will - * choose the highest priority thread that has been waiting longest. - * - * @param ms the number of milliseconds to sleep, or 0 for forever - * @throws InterruptedException if the Thread is interrupted; it's - * <i>interrupted status</i> will be cleared - * @see #notify() - * @see #wait(long) - */ - public static void sleep(long ms) throws InterruptedException - { - sleep(ms, 0); - } - - /** - * Suspend the current Thread's execution for the specified amount of - * time. The Thread will not lose any locks it has during this time. There - * are no guarantees which thread will be next to run, but most VMs will - * choose the highest priority thread that has been waiting longest. - * - * <p>Note that 1,000,000 nanoseconds == 1 millisecond, but most VMs do - * not offer that fine a grain of timing resolution. Besides, there is - * no guarantee that this thread can start up immediately when time expires, - * because some other thread may be active. So don't expect real-time - * performance. - * - * @param ms the number of milliseconds to sleep, or 0 for forever - * @param ns the number of extra nanoseconds to sleep (0-999999) - * @throws InterruptedException if the Thread is interrupted; it's - * <i>interrupted status</i> will be cleared - * @throws IllegalArgumentException if ns is invalid - * @see #notify() - * @see #wait(long, int) - */ - public static native void sleep(long ms, int ns) throws InterruptedException; - - /** - * Start this Thread, calling the run() method of the Runnable this Thread - * was created with, or else the run() method of the Thread itself. This - * is the only way to start a new thread; calling run by yourself will just - * stay in the same thread. The virtual machine will remove the thread from - * its thread group when the run() method completes. - * - * @throws IllegalThreadStateException if the thread has already started - * @see #run() - */ - public synchronized native void start(); - - /** - * The method of Thread that will be run if there is no Runnable object - * associated with the Thread. Thread's implementation does nothing at all. - * - * @see #start() - * @see #Thread(ThreadGroup, Runnable, String) - */ - public void run() - { - if (toRun != null) - toRun.run(); - } - - /** - * Cause this Thread to stop abnormally because of the throw of a ThreadDeath - * error. If you stop a Thread that has not yet started, it will stop - * immediately when it is actually started. - * - * <p>This is inherently unsafe, as it can interrupt synchronized blocks and - * leave data in bad states. Hence, there is a security check: - * <code>checkAccess(this)</code>, plus another one if the current thread - * is not this: <code>RuntimePermission("stopThread")</code>. If you must - * catch a ThreadDeath, be sure to rethrow it after you have cleaned up. - * ThreadDeath is the only exception which does not print a stack trace when - * the thread dies. - * - * @throws SecurityException if you cannot stop the Thread - * @see #interrupt() - * @see #checkAccess() - * @see #start() - * @see ThreadDeath - * @see ThreadGroup#uncaughtException(Thread, Throwable) - * @see SecurityManager#checkAccess(Thread) - * @see SecurityManager#checkPermission(Permission) - * @deprecated unsafe operation, try not to use - */ - public final void stop() - { - stop(new ThreadDeath()); - } - - /** - * Cause this Thread to stop abnormally and throw the specified exception. - * If you stop a Thread that has not yet started, it will stop immediately - * when it is actually started. <b>WARNING</b>This bypasses Java security, - * and can throw a checked exception which the call stack is unprepared to - * handle. Do not abuse this power. - * - * <p>This is inherently unsafe, as it can interrupt synchronized blocks and - * leave data in bad states. Hence, there is a security check: - * <code>checkAccess(this)</code>, plus another one if the current thread - * is not this: <code>RuntimePermission("stopThread")</code>. If you must - * catch a ThreadDeath, be sure to rethrow it after you have cleaned up. - * ThreadDeath is the only exception which does not print a stack trace when - * the thread dies. - * - * @param t the Throwable to throw when the Thread dies - * @throws SecurityException if you cannot stop the Thread - * @throws NullPointerException in the calling thread, if t is null - * @see #interrupt() - * @see #checkAccess() - * @see #start() - * @see ThreadDeath - * @see ThreadGroup#uncaughtException(Thread, Throwable) - * @see SecurityManager#checkAccess(Thread) - * @see SecurityManager#checkPermission(Permission) - * @deprecated unsafe operation, try not to use - */ - public final synchronized void stop(Throwable t) - { - if (t == null) - throw new NullPointerException(); - // Bypass System.getSecurityManager, for bootstrap efficiency. - SecurityManager sm = Runtime.securityManager; - if (sm != null) - { - sm.checkAccess(this); - if (this != currentThread()) - sm.checkPermission(new RuntimePermission("stopThread")); - } - nativeStop(t); - } - - /** - * Interrupt this Thread. First, there is a security check, - * <code>checkAccess</code>. Then, depending on the current state of the - * thread, various actions take place: - * - * <p>If the thread is waiting because of {@link #wait()}, - * {@link #sleep(long)}, or {@link #join()}, its <i>interrupt status</i> - * will be cleared, and an InterruptedException will be thrown. Notice that - * this case is only possible if an external thread called interrupt(). - * - * <p>If the thread is blocked in an interruptible I/O operation, in - * {@link java.nio.channels.InterruptibleChannel}, the <i>interrupt - * status</i> will be set, and ClosedByInterruptException will be thrown. - * - * <p>If the thread is blocked on a {@link java.nio.channels.Selector}, the - * <i>interrupt status</i> will be set, and the selection will return, with - * a possible non-zero value, as though by the wakeup() method. - * - * <p>Otherwise, the interrupt status will be set. - * - * @throws SecurityException if you cannot modify this Thread - */ - public synchronized void interrupt() - { - checkAccess(); - nativeInterrupt(); - } - - /** - * Determine whether the current Thread has been interrupted, and clear - * the <i>interrupted status</i> in the process. - * - * @return whether the current Thread has been interrupted - * @see #isInterrupted() - */ - public static native boolean interrupted(); - - /** - * Determine whether the given Thread has been interrupted, but leave - * the <i>interrupted status</i> alone in the process. - * - * @return whether the current Thread has been interrupted - * @see #interrupted() - */ - public native boolean isInterrupted(); - - /** - * Originally intended to destroy this thread, this method was never - * implemented by Sun, and is hence a no-op. - */ - public void destroy() - { - } - - /** - * Determine whether this Thread is alive. A thread which is alive has - * started and not yet died. - * - * @return whether this Thread is alive - */ - public final native boolean isAlive(); - - /** - * Suspend this Thread. It will not come back, ever, unless it is resumed. - * - * <p>This is inherently unsafe, as the suspended thread still holds locks, - * and can potentially deadlock your program. Hence, there is a security - * check: <code>checkAccess</code>. - * - * @throws SecurityException if you cannot suspend the Thread - * @see #checkAccess() - * @see #resume() - * @deprecated unsafe operation, try not to use - */ - public final synchronized void suspend() - { - checkAccess(); - nativeSuspend(); - } - - /** - * Resume this Thread. If the thread is not suspended, this method does - * nothing. To mirror suspend(), there may be a security check: - * <code>checkAccess</code>. - * - * @throws SecurityException if you cannot resume the Thread - * @see #checkAccess() - * @see #suspend() - * @deprecated pointless, since suspend is deprecated - */ - public final synchronized void resume() - { - checkAccess(); - nativeResume(); - } - - /** - * Set this Thread's priority. There may be a security check, - * <code>checkAccess</code>, then the priority is set to the smaller of - * priority and the ThreadGroup maximum priority. - * - * @param priority the new priority for this Thread - * @throws IllegalArgumentException if priority exceeds MIN_PRIORITY or - * MAX_PRIORITY - * @throws SecurityException if you cannot modify this Thread - * @see #getPriority() - * @see #checkAccess() - * @see ThreadGroup#getMaxPriority() - * @see #MIN_PRIORITY - * @see #MAX_PRIORITY - */ - public final void setPriority(int priority) - { - checkAccess(); - if (priority < MIN_PRIORITY || priority > MAX_PRIORITY) - throw new IllegalArgumentException("Invalid thread priority value " - + priority + "."); - this.priority = Math.min(priority, group.getMaxPriority()); - nativeSetPriority(this.priority); - } - - /** - * Get this Thread's priority. - * - * @return the Thread's priority - */ - public final int getPriority() - { - return priority; - } - - /** - * Set this Thread's name. There may be a security check, - * <code>checkAccess</code>. - * - * @param name the new name for this Thread - * @throws NullPointerException if name is null - * @throws SecurityException if you cannot modify this Thread - */ - public final void setName(String name) - { - checkAccess(); - // Use toString hack to detect null. - this.name = name.toString(); - } - - /** - * Get this Thread's name. - * - * @return this Thread's name - */ - public final String getName() - { - return name; - } - - /** - * Get the ThreadGroup this Thread belongs to. If the thread has died, this - * returns null. - * - * @return this Thread's ThreadGroup - */ - public final ThreadGroup getThreadGroup() - { - return group; - } - - /** - * Get the number of active threads in the current Thread's ThreadGroup. - * This implementation calls - * <code>currentThread().getThreadGroup().activeCount()</code>. - * - * @return the number of active threads in the current ThreadGroup - * @see ThreadGroup#activeCount() - */ - public static int activeCount() - { - return currentThread().group.activeCount(); - } - - /** - * Copy every active thread in the current Thread's ThreadGroup into the - * array. Extra threads are silently ignored. This implementation calls - * <code>getThreadGroup().enumerate(array)</code>, which may have a - * security check, <code>checkAccess(group)</code>. - * - * @param array the array to place the Threads into - * @return the number of Threads placed into the array - * @throws NullPointerException if array is null - * @throws SecurityException if you cannot access the ThreadGroup - * @see ThreadGroup#enumerate(Thread[]) - * @see #activeCount() - * @see SecurityManager#checkAccess(ThreadGroup) - */ - public static int enumerate(Thread[] array) - { - return currentThread().group.enumerate(array); - } - - /** - * Count the number of stack frames in this Thread. The Thread in question - * must be suspended when this occurs. - * - * @return the number of stack frames in this Thread - * @throws IllegalThreadStateException if this Thread is not suspended - * @deprecated pointless, since suspend is deprecated - */ - public native int countStackFrames(); - - /** - * Wait the specified amount of time for the Thread in question to die. - * - * @param ms the number of milliseconds to wait, or 0 for forever - * @throws InterruptedException if the Thread is interrupted; it's - * <i>interrupted status</i> will be cleared - */ - public final void join(long ms) throws InterruptedException - { - join(ms, 0); - } - - /** - * Wait the specified amount of time for the Thread in question to die. - * - * <p>Note that 1,000,000 nanoseconds == 1 millisecond, but most VMs do - * not offer that fine a grain of timing resolution. Besides, there is - * no guarantee that this thread can start up immediately when time expires, - * because some other thread may be active. So don't expect real-time - * performance. - * - * @param ms the number of milliseconds to wait, or 0 for forever - * @param ns the number of extra nanoseconds to sleep (0-999999) - * @throws InterruptedException if the Thread is interrupted; it's - * <i>interrupted status</i> will be cleared - * @throws IllegalArgumentException if ns is invalid - * @XXX A ThreadListener would be nice, to make this efficient. - */ - public final void join(long ms, int ns) throws InterruptedException - { - Thread current = currentThread(); - if (ms == 0 && ns == 0) - while (isAlive()) - current.sleep(10); - else - { - long startTime = System.currentTimeMillis(); - long currentTime = startTime; - do - { - if (! isAlive()) - return; - current.sleep(10); - currentTime = System.currentTimeMillis(); - } - while (Math.abs(startTime - currentTime) < ms); - } - } - - /** - * Wait forever for the Thread in question to die. - * - * @throws InterruptedException if the Thread is interrupted; it's - * <i>interrupted status</i> will be cleared - */ - public final void join() throws InterruptedException - { - join(0, 0); - } - - /** - * Print a stack trace of the current thread to stderr using the same - * format as Throwable's printStackTrace() method. - * - * @see Throwable#printStackTrace() - */ - public static void dumpStack() - { - new Throwable().printStackTrace(); - } - - /** - * Set the daemon status of this Thread. If this is a daemon Thread, then - * the VM may exit even if it is still running. This may only be called - * while the Thread is not running. There may be a security check, - * <code>checkAccess</code>. - * - * @param daemon whether this should be a daemon thread or not - * @throws SecurityException if you cannot modify this Thread - * @throws IllegalThreadStateException if the Thread is active - * @see #isDaemon() - * @see #checkAccess() - */ - public final void setDaemon(boolean daemon) - { - if (isAlive()) - throw new IllegalThreadStateException(); - checkAccess(); - this.daemon = daemon; - } - - /** - * Tell whether this is a daemon Thread or not. - * - * @return whether this is a daemon Thread or not - * @see #setDaemon(boolean) - */ - public final boolean isDaemon() - { - return daemon; - } - - /** - * Check whether the current Thread is allowed to modify this Thread. This - * passes the check on to <code>SecurityManager.checkAccess(this)</code>. - * - * @throws SecurityException if the current Thread cannot modify this Thread - * @see SecurityManager#checkAccess(Thread) - */ - public final void checkAccess() - { - // Bypass System.getSecurityManager, for bootstrap efficiency. - SecurityManager sm = Runtime.securityManager; - if (sm != null) - sm.checkAccess(this); - } - - /** - * Return a human-readable String representing this Thread. The format of - * the string is:<br> - * <code>"Thread[" + getName() + ',' + getPriority() + ',' - * + (getThreadGroup() == null ? "" : getThreadGroup().getName()) - + ']'</code>. - * - * @return a human-readable String representing this Thread - */ - public String toString() - { - return "Thread[" + name + ',' + priority + ',' - + (group == null ? "" : group.name) + ']'; - } - - /** - * Returns the context classloader of this Thread. The context - * classloader can be used by code that want to load classes depending - * on the current thread. Normally classes are loaded depending on - * the classloader of the current class. There may be a security check - * for <code>RuntimePermission("getClassLoader")</code> if the caller's - * class loader is not null or an ancestor of this thread's context class - * loader. - * - * @return the context class loader - * @throws SecurityException when permission is denied - * @see setContextClassLoader(ClassLoader) - * @since 1.2 - */ - public ClassLoader getContextClassLoader() - { - // Bypass System.getSecurityManager, for bootstrap efficiency. - SecurityManager sm = Runtime.securityManager; - if (sm != null) - // XXX Don't check this if the caller's class loader is an ancestor. - sm.checkPermission(new RuntimePermission("getClassLoader")); - return contextClassLoader; - } - - /** - * Sets the context classloader for this Thread. When not explicitly set, - * the context classloader for a thread is the same as the context - * classloader of the thread that created this thread. The first thread has - * as context classloader the system classloader. There may be a security - * check for <code>RuntimePermission("setContextClassLoader")</code>. - * - * @param classloader the new context class loader - * @throws SecurityException when permission is denied - * @see getContextClassLoader() - * @since 1.2 - */ - public void setContextClassLoader(ClassLoader classloader) - { - SecurityManager sm = System.getSecurityManager(); - if (sm != null) - sm.checkPermission(new RuntimePermission("setContextClassLoader")); - this.contextClassLoader = classloader; - } - - /** - * Checks whether the current thread holds the monitor on a given object. - * This allows you to do <code>assert Thread.holdsLock(obj)</code>. - * - * @param obj the object to check - * @return true if the current thread is currently synchronized on obj - * @throws NullPointerException if obj is null - * @since 1.4 - */ - public static native boolean holdsLock(Object obj); - - /** - * Whatever native initialization must be done in the constructor. - * - * @param size the requested stack size; may be ignored, and 0 signifies the - * default amount - * @see #Thread(ThreadGroup, Runnable, String, long) - */ - final native void nativeInit(long size); - - /** - * Stop a thread by throwing the given exception. - * - * @param t the exception to throw, non-null - * @see #stop(Throwable) - */ - final native void nativeStop(Throwable t); - - /** - * Interrupt a thread. - * - * @see #interrupt() - */ - final native void nativeInterrupt(); - - /** - * Suspend a thread. - * - * @see #suspend() - */ - final native void nativeSuspend(); - - /** - * Resume a suspended thread. - * - * @see #resume() - */ - final native void nativeResume(); - - /** - * Set the new priority of a thread. - * - * @param newPriority the new priority, in range - * @see #setPriority(int) - */ - final native void nativeSetPriority(int newPriority); -} // class Thread diff --git a/vm/reference/java/lang/VMThread.java b/vm/reference/java/lang/VMThread.java new file mode 100644 index 000000000..dc16964c5 --- /dev/null +++ b/vm/reference/java/lang/VMThread.java @@ -0,0 +1,393 @@ +/* VMThread -- VM interface for Thread of executable code + Copyright (C) 2003 Free Software Foundation + +This file is part of GNU Classpath. + +GNU Classpath is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2, or (at your option) +any later version. + +GNU Classpath is distributed in the hope that it will be useful, but +WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +General Public License for more details. + +You should have received a copy of the GNU General Public License +along with GNU Classpath; see the file COPYING. If not, write to the +Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA +02111-1307 USA. + +Linking this library statically or dynamically with other modules is +making a combined work based on this library. Thus, the terms and +conditions of the GNU General Public License cover the whole +combination. + +As a special exception, the copyright holders of this library give you +permission to link this library with independent modules to produce an +executable, regardless of the license terms of these independent +modules, and to copy and distribute the resulting executable under +terms of your choice, provided that you also meet, for each linked +independent module, the terms and conditions of the license of that +module. An independent module is a module which is not derived from +or based on this library. If you modify this library, you may extend +this exception to your version of the library, but you are not +obligated to do so. If you do not wish to do so, delete this +exception statement from your version. */ + +package java.lang; + +/** + * VM interface for Thread of executable code. Holds VM dependent state. + * It is deliberately package local and final and should only be accessed + * by the Thread class. + * <p> + * This is the GNU Classpath reference implementation, it should be adapted + * for a specific VM. + * <p> + * The following methods must be implemented: + * <ul> + * <li>native void start(long stacksize); + * <li>native void interrupt(); + * <li>native boolean isInterrupted(); + * <li>native void suspend(); + * <li>native void resume(); + * <li>native void nativeSetPriority(int priority); + * <li>native void nativeStop(Throwable t); + * <li>native static Thread currentThread(); + * <li>static native void yield(); + * <li>static native void sleep(long ms, int ns) throws InterruptedException; + * <li>static native boolean interrupted(); + * <li>static native boolean holdsLock(Object obj); + * </ul> + * All other methods may be implemented to make Thread handling more efficient + * or to implement some optional (and sometimes deprecated) behaviour. Default + * implementations are provided but it is highly recommended to optimize them + * for a specific VM. + * + * @author Jeroen Frijters (jeroen@frijters.net) + */ +final class VMThread +{ + /** + * The Thread object that this VM state belongs to. + * Used in currentThread() and start(). + * Note: when this thread dies, this reference is *not* cleared + */ + volatile Thread thread; + + /** + * Flag that is set when the thread runs, used by stop() to protect against + * stop's getting lost. + */ + private volatile boolean running; + + /** + * Private constructor, create VMThreads with the static create method. + * + * @param thread The Thread object that was just created. + */ + private VMThread(Thread thread) + { + this.thread = thread; + } + + /** + * This method is the initial Java code that gets executed when a native + * thread starts. It's job is to coordinate with the rest of the VMThread + * logic and to start executing user code and afterwards handle clean up. + */ + private void run() + { + try + { + try + { + running = true; + synchronized(thread) + { + Throwable t = thread.stillborn; + if(t != null) + { + thread.stillborn = null; + throw t; + } + } + thread.run(); + } + catch(Throwable t) + { + try + { + thread.group.uncaughtException(thread, t); + } + catch(Throwable ignore) + { + } + } + } + finally + { + // Setting runnable to false is partial protection against stop + // being called while we're cleaning up. To be safe all code in + // VMThread be unstoppable. + running = false; + thread.die(); + synchronized(this) + { + // release the threads waiting to join us + notifyAll(); + } + } + } + + /** + * Creates a native Thread. This is called from the start method of Thread. + * The Thread is started. + * + * @param thread The newly created Thread object + * @param stacksize Indicates the requested stacksize. Normally zero, + * non-zero values indicate requested stack size in bytes but it is up + * to the specific VM implementation to interpret them and may be ignored. + */ + static void create(Thread thread, long stacksize) + { + VMThread vmThread = new VMThread(thread); + vmThread.start(stacksize); + thread.vmThread = vmThread; + } + + /** + * Gets the name of the thread. Usually this is the name field of the + * associated Thread object, but some implementation might choose to + * return the name of the underlying platform thread. + */ + String getName() + { + return thread.name; + } + + /** + * Set the name of the thread. Usually this sets the name field of the + * associated Thread object, but some implementations might choose to + * set the name of the underlying platform thread. + * @param name The new name + */ + void setName(String name) + { + thread.name = name; + } + + /** + * Set the thread priority field in the associated Thread object and + * calls the native method to set the priority of the underlying + * platform thread. + * @param priority The new priority + */ + void setPriority(int priority) + { + thread.priority = priority; + nativeSetPriority(priority); + } + + /** + * Returns the priority. Usually this is the priority field from the + * associated Thread object, but some implementation might choose to + * return the priority of the underlying platform thread. + * @return this Thread's priority + */ + int getPriority() + { + return thread.priority; + } + + /** + * Returns true if the thread is a daemon thread. Usually this is the + * daemon field from the associated Thread object, but some + * implementation might choose to return the daemon state of the underlying + * platform thread. + * @return whether this is a daemon Thread or not + */ + boolean isDaemon() + { + return thread.daemon; + } + + /** + * Returns the number of stack frames in this Thread. + * Will only be called when when a previous call to suspend() returned true. + * + * @deprecated unsafe operation + */ + int countStackFrames() + { + return 0; + } + + /** + * Wait the specified amount of time for the Thread in question to die. + * + * <p>Note that 1,000,000 nanoseconds == 1 millisecond, but most VMs do + * not offer that fine a grain of timing resolution. Besides, there is + * no guarantee that this thread can start up immediately when time expires, + * because some other thread may be active. So don't expect real-time + * performance. + * + * @param ms the number of milliseconds to wait, or 0 for forever + * @param ns the number of extra nanoseconds to sleep (0-999999) + * @throws InterruptedException if the Thread is interrupted; it's + * <i>interrupted status</i> will be cleared + */ + synchronized void join(long ms, int ns) throws InterruptedException + { + // round up + ms += (ns != 0) ? 1 : 0; + + long end = System.currentTimeMillis() + ms; + + // Apparently, some VMs will return from wait without notify having + // been called, so we loop and test the vmThread field in our + // corresponding Thread object. + while(thread.vmThread != null) + { + // We use the VMThread object to wait on, because this is a private + // object, so client code cannot call notify on us. + wait(ms); + if(ms != 0) + { + long now = System.currentTimeMillis(); + ms = end - now; + if(ms <= 0) + { + break; + } + } + } + } + + /** + * Cause this Thread to stop abnormally and throw the specified exception. + * If you stop a Thread that has not yet started, the stop is ignored + * (contrary to what the JDK documentation says). + * <b>WARNING</b>This bypasses Java security, and can throw a checked + * exception which the call stack is unprepared to handle. Do not abuse + * this power. + * + * <p>This is inherently unsafe, as it can interrupt synchronized blocks and + * leave data in bad states. + * + * <p><b>NOTE</b> stop() should take care not to stop a thread if it is + * executing code in this class. + * + * @param t the Throwable to throw when the Thread dies + * @deprecated unsafe operation, try not to use + */ + void stop(Throwable t) + { + // Note: we assume that we own the lock on thread + // (i.e. that Thread.stop() is synchronized) + if(running) + nativeStop(t); + else + thread.stillborn = t; + } + + /** + * Create a native thread on the underlying platform and start it executing + * on the run method of this object. + * @param stacksize the requested size of the native thread stack + */ + native void start(long stacksize); + + /** + * Interrupt this thread. + */ + native void interrupt(); + + /** + * Determine whether this Thread has been interrupted, but leave + * the <i>interrupted status</i> alone in the process. + * + * @return whether the Thread has been interrupted + */ + native boolean isInterrupted(); + + /** + * Suspend this Thread. It will not come back, ever, unless it is resumed. + */ + native void suspend(); + + /** + * Resume this Thread. If the thread is not suspended, this method does + * nothing. + */ + native void resume(); + + /** + * Set the priority of the underlying platform thread. + * + * @param priority the new priority + */ + native void nativeSetPriority(int priority); + + /** + * Asynchronously throw the specified throwable in this Thread. + * + * @param t the exception to throw + */ + native void nativeStop(Throwable t); + + /** + * Return the Thread object associated with the currently executing + * thread. + * + * @return the currently executing Thread + */ + native static Thread currentThread(); + + /** + * Yield to another thread. The Thread will not lose any locks it holds + * during this time. There are no guarantees which thread will be + * next to run, and it could even be this one, but most VMs will choose + * the highest priority thread that has been waiting longest. + */ + static native void yield(); + + /** + * Suspend the current Thread's execution for the specified amount of + * time. The Thread will not lose any locks it has during this time. There + * are no guarantees which thread will be next to run, but most VMs will + * choose the highest priority thread that has been waiting longest. + * + * <p>Note that 1,000,000 nanoseconds == 1 millisecond, but most VMs do + * not offer that fine a grain of timing resolution. Besides, there is + * no guarantee that this thread can start up immediately when time expires, + * because some other thread may be active. So don't expect real-time + * performance. + * + * @param ms the number of milliseconds to sleep, or 0 for forever + * @param ns the number of extra nanoseconds to sleep (0-999999) + * @throws InterruptedException if the Thread is interrupted; it's + * <i>interrupted status</i> will be cleared + * @throws IllegalArgumentException if ns is invalid + */ + static native void sleep(long ms, int ns) throws InterruptedException; + + /** + * Determine whether the current Thread has been interrupted, and clear + * the <i>interrupted status</i> in the process. + * + * @return whether the current Thread has been interrupted + */ + static native boolean interrupted(); + + /** + * Checks whether the current thread holds the monitor on a given object. + * This allows you to do <code>assert Thread.holdsLock(obj)</code>. + * + * @param obj the object to check + * @return true if the current thread is currently synchronized on obj + * @throws NullPointerException if obj is null + */ + static native boolean holdsLock(Object obj); +} |