2009-04-12 Gonzalo Paniagua Javier <gonzalo@novell.com>
[mono.git] / mcs / class / corlib / System.Threading / WaitHandle.cs
index cc80b77bc412486f94669dd4468b81d053ac923b..2d7f4f4662bad00ad56874448b0d0a90995a9d76 100644 (file)
@@ -34,8 +34,17 @@ using System.Runtime.CompilerServices;
 using System.Runtime.Remoting.Contexts;
 using System.Security.Permissions;
 
+#if NET_2_0
+using System.Runtime.InteropServices;
+using Microsoft.Win32.SafeHandles;
+using System.Runtime.ConstrainedExecution;
+#endif
+
 namespace System.Threading
 {
+#if NET_2_0
+       [ComVisible (true)]
+#endif
        public abstract class WaitHandle : MarshalByRefObject, IDisposable
        {
                [MethodImplAttribute(MethodImplOptions.InternalCall)]
@@ -50,20 +59,49 @@ namespace System.Threading
                        if (length > 64)
                                throw new NotSupportedException ("Too many handles");
 
-                       if (waitAll && length > 1 &&
-                           (Thread.CurrentThread.ApartmentState == ApartmentState.STA ||
-                            Assembly.GetEntryAssembly ().EntryPoint.GetCustomAttributes (typeof (STAThreadAttribute), false).Length == 1))
+#if false
+                       //
+                       // Although we should thrown an exception if this is an STA thread,
+                       // Mono does not know anything about STA threads, and just makes
+                       // things like Paint.NET not even possible to work.
+                       //
+                       // See bug #78455 for the bug this is supposed to fix. 
+                       // 
+                       if (waitAll && length > 1 && IsSTAThread)
                                throw new NotSupportedException ("WaitAll for multiple handles is not allowed on an STA thread.");
-                       
+#endif
                        foreach (WaitHandle w in handles) {
                                if (w == null)
                                        throw new ArgumentNullException ("waitHandles", "null handle");
 
+#if NET_2_0
+                               if (w.safe_wait_handle == null)
+                                       throw new ArgumentException ("null element found", "waitHandle");
+#else
                                if (w.os_handle == InvalidHandle)
                                        throw new ArgumentException ("null element found", "waitHandle");
+#endif
                        }
                }
-               
+#if false
+               // usage of property is commented - see above
+               static bool IsSTAThread {
+                       get {
+                               bool isSTA = Thread.CurrentThread.ApartmentState ==
+                                       ApartmentState.STA;
+
+                               // FIXME: remove this check after Thread.ApartmentState
+                               // has been properly implemented.
+                               if (!isSTA) {
+                                       Assembly asm = Assembly.GetEntryAssembly ();
+                                       if (asm != null)
+                                               isSTA = asm.EntryPoint.GetCustomAttributes (typeof (STAThreadAttribute), false).Length > 0;
+                               }
+
+                               return isSTA;
+                       }
+               }
+#endif
                public static bool WaitAll(WaitHandle[] waitHandles)
                {
                        CheckArray (waitHandles, true);
@@ -105,12 +143,18 @@ namespace System.Threading
                private static extern int WaitAny_internal(WaitHandle[] handles, int ms, bool exitContext);
 
                // LAMESPEC: Doesn't specify how to signal failures
+#if NET_2_0
+               [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
+#endif
                public static int WaitAny(WaitHandle[] waitHandles)
                {
                        CheckArray (waitHandles, false);
                        return(WaitAny_internal(waitHandles, Timeout.Infinite, false));
                }
 
+#if NET_2_0
+               [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
+#endif
                public static int WaitAny(WaitHandle[] waitHandles,
                                          int millisecondsTimeout,
                                          bool exitContext)
@@ -125,6 +169,22 @@ namespace System.Threading
                        }
                }
 
+#if NET_2_0
+               [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
+               public static int WaitAny(WaitHandle[] waitHandles, TimeSpan timeout)
+               {
+                       return WaitAny (waitHandles, timeout, false);
+               }
+
+               [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
+               public static int WaitAny(WaitHandle[] waitHandles, int millisecondsTimeout)
+               {
+                       return WaitAny (waitHandles, millisecondsTimeout, false);
+               }
+#endif
+#if NET_2_0
+               [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
+#endif
                public static int WaitAny(WaitHandle[] waitHandles,
                                          TimeSpan timeout, bool exitContext)
                {
@@ -143,13 +203,204 @@ namespace System.Threading
                        }
                }
 
-               [MonoTODO]
-               public WaitHandle() {
+#if NET_2_0
+               protected
+#else
+               public
+#endif
+               WaitHandle() {
                        // FIXME
                }
 
+               public virtual void Close() {
+                       Dispose(true);
+                       GC.SuppressFinalize (this);
+               }
+
                public const int WaitTimeout = 258;
 
+#if NET_2_0
+               //
+               // In 2.0 we use SafeWaitHandles instead of IntPtrs
+               //
+               SafeWaitHandle safe_wait_handle;
+
+               [Obsolete ("In the profiles > 2.x, use SafeHandle instead of Handle")]
+               public virtual IntPtr Handle {
+                       get {
+                               return safe_wait_handle.DangerousGetHandle ();
+                       }
+
+                       [SecurityPermission (SecurityAction.LinkDemand, UnmanagedCode = true)]
+                       [SecurityPermission (SecurityAction.InheritanceDemand, UnmanagedCode = true)]
+                       set {
+                               if (value == InvalidHandle)
+                                       safe_wait_handle = new SafeWaitHandle (InvalidHandle, false);
+                               else
+                                       safe_wait_handle = new SafeWaitHandle (value, true);
+                       }
+               }
+               
+               [MethodImplAttribute(MethodImplOptions.InternalCall)]
+               private extern bool WaitOne_internal(IntPtr handle, int ms, bool exitContext);
+
+               protected virtual void Dispose (bool explicitDisposing)
+               {
+                       if (!disposed){
+                               disposed = true;
+
+                               //
+                               // This is only the case if the handle was never properly initialized
+                               // most likely a bug in the derived class
+                               //
+                               if (safe_wait_handle == null)
+                                       return;
+
+                               lock (this){
+                                       if (safe_wait_handle != null)
+                                               safe_wait_handle.Dispose ();
+                               }
+                       }
+               }
+
+               public SafeWaitHandle SafeWaitHandle {
+                       [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
+                       get {
+                               return safe_wait_handle;
+                       }
+
+                       [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
+                       set {
+                               if (value == null)
+                                       safe_wait_handle = new SafeWaitHandle (InvalidHandle, false);
+                               else
+                                       safe_wait_handle = value;
+                       }
+               }
+
+               public static bool SignalAndWait (WaitHandle toSignal,
+                                                 WaitHandle toWaitOn)
+               {
+                       return SignalAndWait (toSignal, toWaitOn, -1, false);
+               }
+               
+               public static bool SignalAndWait (WaitHandle toSignal,
+                                                 WaitHandle toWaitOn,
+                                                 int millisecondsTimeout,
+                                                 bool exitContext)
+               {
+                       if (toSignal == null)
+                               throw new ArgumentNullException ("toSignal");
+                       if (toWaitOn == null)
+                               throw new ArgumentNullException ("toWaitOn");
+
+                       if (millisecondsTimeout < -1)
+                               throw new ArgumentOutOfRangeException ("millisecondsTimeout");
+
+                       return SignalAndWait_Internal (toSignal.Handle, toWaitOn.Handle, millisecondsTimeout, exitContext);
+               }
+               
+               public static bool SignalAndWait (WaitHandle toSignal,
+                                                 WaitHandle toWaitOn,
+                                                 TimeSpan timeout,
+                                                 bool exitContext)
+               {
+                       double ms = timeout.TotalMilliseconds;
+                       if (ms > Int32.MaxValue)
+                               throw new ArgumentOutOfRangeException ("timeout");
+
+                       return SignalAndWait (toSignal, toWaitOn, Convert.ToInt32 (ms), false);
+               }
+
+               [MethodImplAttribute(MethodImplOptions.InternalCall)]
+               static extern bool SignalAndWait_Internal (IntPtr toSignal, IntPtr toWaitOn, int ms, bool exitContext);
+
+               public virtual bool WaitOne()
+               {
+                       CheckDisposed ();
+                       bool release = false;
+                       try {
+                               safe_wait_handle.DangerousAddRef (ref release);
+                               return (WaitOne_internal(safe_wait_handle.DangerousGetHandle (), Timeout.Infinite, false));
+                       } finally {
+                               if (release)
+                                       safe_wait_handle.DangerousRelease ();
+                       }
+               }
+
+               public virtual bool WaitOne(int millisecondsTimeout, bool exitContext)
+               {
+                       CheckDisposed ();
+                       bool release = false;
+                       try {
+                               if (exitContext)
+                                       SynchronizationAttribute.ExitContext ();
+                               safe_wait_handle.DangerousAddRef (ref release);
+                               return (WaitOne_internal(safe_wait_handle.DangerousGetHandle (), millisecondsTimeout, exitContext));
+                       } finally {
+                               if (exitContext)
+                                       SynchronizationAttribute.EnterContext ();
+                               if (release)
+                                       safe_wait_handle.DangerousRelease ();
+                       }
+               }
+
+               public virtual bool WaitOne (int millisecondsTimeout)
+               {
+                       return WaitOne (millisecondsTimeout, false);
+               }
+
+               public virtual bool WaitOne (TimeSpan timeout)
+               {
+                       return WaitOne (timeout, false);
+               }
+
+               public virtual bool WaitOne(TimeSpan timeout, bool exitContext)
+               {
+                       CheckDisposed ();
+                       long ms = (long) timeout.TotalMilliseconds;
+                       if (ms < -1 || ms > Int32.MaxValue)
+                               throw new ArgumentOutOfRangeException ("timeout");
+
+                       bool release = false;
+                       try {
+                               if (exitContext)
+                                       SynchronizationAttribute.ExitContext ();
+                               safe_wait_handle.DangerousAddRef (ref release);
+                               return (WaitOne_internal(safe_wait_handle.DangerousGetHandle (), (int) ms, exitContext));
+                       }
+                       finally {
+                               if (exitContext)
+                                       SynchronizationAttribute.EnterContext ();
+                               if (release)
+                                       safe_wait_handle.DangerousRelease ();
+                       }
+               }
+
+               internal void CheckDisposed ()
+               {
+                       if (disposed || safe_wait_handle == null)
+                               throw new ObjectDisposedException (GetType ().FullName);
+               }
+
+               public static bool WaitAll(WaitHandle[] waitHandles, int millisecondsTimeout)
+               {
+                       CheckArray (waitHandles, true);
+                       return WaitAll_internal (waitHandles, millisecondsTimeout, false);
+               }
+
+               public static bool WaitAll(WaitHandle[] waitHandles, TimeSpan timeout)
+               {
+                       CheckArray (waitHandles, true);
+                       long ms = (long) timeout.TotalMilliseconds;
+                       
+                       if (ms < -1 || ms > Int32.MaxValue)
+                               throw new ArgumentOutOfRangeException ("timeout");
+
+                       return (WaitAll_internal (waitHandles, (int) ms, false));
+               }
+               
+#else
                private IntPtr os_handle = InvalidHandle;
                
                public virtual IntPtr Handle {
@@ -164,11 +415,6 @@ namespace System.Threading
                        }
                }
 
-               public virtual void Close() {
-                       Dispose(true);
-                       GC.SuppressFinalize (this);
-               }
-
                internal void CheckDisposed ()
                {
                        if (disposed || os_handle == InvalidHandle)
@@ -178,6 +424,22 @@ namespace System.Threading
                [MethodImplAttribute(MethodImplOptions.InternalCall)]
                private extern bool WaitOne_internal(IntPtr handle, int ms, bool exitContext);
 
+               protected virtual void Dispose(bool explicitDisposing) {
+                       // Check to see if Dispose has already been called.
+                       if (!disposed) {
+                               disposed=true;
+                               if (os_handle == InvalidHandle)
+                                       return;
+
+                               lock (this) {
+                                       if (os_handle != InvalidHandle) {
+                                               NativeEventCalls.CloseEvent_internal (os_handle);
+                                               os_handle = InvalidHandle;
+                                       }
+                               }
+                       }
+               }
+               
                public virtual bool WaitOne()
                {
                        CheckDisposed ();
@@ -211,9 +473,9 @@ namespace System.Threading
                                if (exitContext) SynchronizationAttribute.EnterContext ();
                        }
                }
+#endif
 
-               protected static readonly IntPtr InvalidHandle = IntPtr.Zero;
-
+               protected static readonly IntPtr InvalidHandle = (IntPtr) (-1);
                bool disposed = false;
 
                void IDisposable.Dispose() {
@@ -222,22 +484,6 @@ namespace System.Threading
                        GC.SuppressFinalize(this);
                }
                
-               protected virtual void Dispose(bool explicitDisposing) {
-                       // Check to see if Dispose has already been called.
-                       if (!disposed) {
-                               disposed=true;
-                               if (os_handle == InvalidHandle)
-                                       return;
-
-                               lock (this) {
-                                       if (os_handle != InvalidHandle) {
-                                               NativeEventCalls.CloseEvent_internal (os_handle);
-                                               os_handle = InvalidHandle;
-                                       }
-                               }
-                       }
-               }
-
                ~WaitHandle() {
                        Dispose(false);
                }