mono/mcs/class/corlib/System.Threading/Mutex.cs

//
// System.Threading.Mutex.cs
//
// Author:
//   Dick Porter ([email protected])
//   Veronica De Santis ([email protected])
//
// (C) Ximian, Inc.  http://www.ximian.com
// Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
// 
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//

using System.Runtime.CompilerServices;
using System.Security.Permissions;

using System.Runtime.ConstrainedExecution;
using System.IO;
using System.Runtime.InteropServices;
using System.Security.AccessControl;

namespace System.Threading
{
	[ComVisible (true)]
	public sealed class Mutex : WaitHandle 
	{
		[MethodImplAttribute(MethodImplOptions.InternalCall)]
		private unsafe static extern IntPtr CreateMutex_icall (bool initiallyOwned, char *name,
			int name_length, out bool created);

		[MethodImplAttribute(MethodImplOptions.InternalCall)]
		private unsafe static extern IntPtr OpenMutex_icall (char *name, int name_length,
			MutexRights rights, out MonoIOError error);

		[MethodImplAttribute(MethodImplOptions.InternalCall)]
		private static extern bool ReleaseMutex_internal(IntPtr handle);
		
		private unsafe static IntPtr CreateMutex_internal (bool initiallyOwned,
			string name, out bool created)
		{
			fixed (char *fixed_name = name)
				return CreateMutex_icall (initiallyOwned, fixed_name,
					name?.Length ?? 0, out created);
		}

		private unsafe static IntPtr OpenMutex_internal (string name, MutexRights rights, out MonoIOError error)
		{
			fixed (char *fixed_name = name)
				return OpenMutex_icall (fixed_name, name?.Length ?? 0, rights, out error);
		}

		private Mutex (IntPtr handle)
		{
			Handle = handle;
		}

		[ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
		public Mutex() {
			bool created;
			
			Handle=CreateMutex_internal(false, null, out created);
		}
		
		[ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
		public Mutex(bool initiallyOwned) {
			bool created;
			
			Handle=CreateMutex_internal(initiallyOwned, null,
						    out created);
		}

#if !MOBILE
		[ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
		[SecurityPermission (SecurityAction.LinkDemand, UnmanagedCode = true)]
		public Mutex (bool initiallyOwned, string name)
		{
			bool created;
			Handle = CreateMutex_internal (initiallyOwned, name, out created);
		}

		[ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
		[SecurityPermission (SecurityAction.LinkDemand, UnmanagedCode = true)]
		public Mutex (bool initiallyOwned, string name, out bool createdNew)
		{
			Handle = CreateMutex_internal (initiallyOwned, name, out createdNew);
		}

		[MonoTODO ("Use MutexSecurity in CreateMutex_internal")]
		[ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
		public Mutex (bool initiallyOwned, string name, out bool createdNew, MutexSecurity mutexSecurity)
		{
			Handle = CreateMutex_internal (initiallyOwned, name, out createdNew);
		}

		public MutexSecurity GetAccessControl ()
		{
			return new MutexSecurity (SafeWaitHandle,
						  AccessControlSections.Owner |
						  AccessControlSections.Group |
						  AccessControlSections.Access);
		}

		public static Mutex OpenExisting (string name)
		{
			return(OpenExisting (name, MutexRights.Synchronize |
					     MutexRights.Modify));
		}
		
		public static Mutex OpenExisting (string name,
						  MutexRights rights)
		{
			if (name == null) {
				throw new ArgumentNullException ("name");
			}
			if ((name.Length == 0) ||
			    (name.Length > 260)) {
				throw new ArgumentException ("name", Locale.GetText ("Invalid length [1-260]."));
			}
			
			MonoIOError error;
			IntPtr handle = OpenMutex_internal (name, rights,
							    out error);
			if (handle == (IntPtr)null) {
				if (error == MonoIOError.ERROR_FILE_NOT_FOUND) {
					throw new WaitHandleCannotBeOpenedException (Locale.GetText ("Named Mutex handle does not exist: ") + name);
				} else if (error == MonoIOError.ERROR_ACCESS_DENIED) {
					throw new UnauthorizedAccessException ();
				} else {
					throw new IOException (Locale.GetText ("Win32 IO error: ") +  error.ToString ());
				}
			}
			
			return(new Mutex (handle));
		}

		public static bool TryOpenExisting (string name, out Mutex result)
		{
			return TryOpenExisting (name, MutexRights.Synchronize | MutexRights.Modify, out result);
		}

		public static bool TryOpenExisting (string name, MutexRights rights, out Mutex result)
		{
			if (name == null) {
				throw new ArgumentNullException ("name");
			}
			if ((name.Length == 0) || (name.Length > 260)) {
				throw new ArgumentException ("name", Locale.GetText ("Invalid length [1-260]."));
			}
			
			MonoIOError error;
			IntPtr handle = OpenMutex_internal (name, rights, out error);
			if (handle == (IntPtr)null) {
				result = null;
				return false;
			}

			result = new Mutex (handle);
			return true;
		}
#else
		public Mutex (bool initiallyOwned, string name)
		{
			throw new NotSupportedException ();
		}
		
		public Mutex (bool initiallyOwned, string name, out bool createdNew)
		{
			throw new NotSupportedException ();
		}
		
		public Mutex (bool initiallyOwned, string name, out bool createdNew, MutexSecurity mutexSecurity)
		{
			throw new NotSupportedException ();
		}

		public static Mutex OpenExisting (string name)
		{
			throw new NotSupportedException ();
		}

		public static Mutex OpenExisting (string name, MutexRights rights)
		{
			throw new NotSupportedException ();
		}

		public static bool TryOpenExisting (string name, out Mutex result)
		{
			throw new NotSupportedException ();
		}

		public static bool TryOpenExisting (string name, MutexRights rights, out Mutex result)
		{
			throw new NotSupportedException ();
		}
#endif

		[ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
		public void ReleaseMutex() {
			bool success = ReleaseMutex_internal(Handle);
			if (!success) {
				throw new ApplicationException ("Mutex is not owned");
			}
		}

#if !MOBILE
		public void SetAccessControl (MutexSecurity mutexSecurity)
		{
			if (null == mutexSecurity)
				throw new ArgumentNullException ("mutexSecurity");
				
			mutexSecurity.PersistModifications (SafeWaitHandle);
		}
#endif
	}
}