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

// 
// System.Threading.ExecutionContext.cs
//
// Authors:
//	Lluis Sanchez ([email protected])
//	Sebastien Pouliot  <[email protected]>
//  Marek Safar ([email protected])
//
// Copyright (C) 2004-2005 Novell, Inc (http://www.novell.com)
// Copyright (C) 2014 Xamarin Inc (http://www.xamarin.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.InteropServices;
using System.Runtime.Serialization;
using System.Security;
using System.Security.Permissions;
using System.Runtime.Remoting.Messaging;
using System.Collections;
using System.Collections.Generic;

namespace System.Threading {
	[Serializable]
	public sealed partial class ExecutionContext : ISerializable
           , IDisposable
	{

#if !MOBILE
		private SecurityContext _sc;
#endif
		internal LogicalCallContext _lcc;
		internal bool _suppressFlow;
		internal bool _capture;
		internal Dictionary<string, object> local_data;

		internal ExecutionContext ()
		{
		}

		private ExecutionContext (ExecutionContext ec)
		{
			CloneData (ec);

			_suppressFlow = ec._suppressFlow;
			_capture = true;
		}

		void CloneData (ExecutionContext ec)
		{
#if !MOBILE
			if (ec._sc != null)
				_sc = new SecurityContext (ec._sc);
#endif
			if (ec._lcc != null)
				_lcc = (LogicalCallContext) ec._lcc.Clone ();
		}
		
		[MonoTODO]
		internal ExecutionContext (SerializationInfo info, StreamingContext context)
		{
			throw new NotImplementedException ();
		}

		public static ExecutionContext Capture ()
		{
			return Capture (true, false);
		}
		
		internal static ExecutionContext Capture (bool captureSyncContext, bool nullOnEmpty)
		{
			var thread = Thread.CurrentThread;
			if (nullOnEmpty && !thread.HasExecutionContext)
				return null;

			var ec = thread.ExecutionContext;
			if (ec.FlowSuppressed)
				return null;

			if (nullOnEmpty
#if !MOBILE
			 && ec._sc == null
#endif
				&& (ec._lcc == null || !ec._lcc.HasInfo))
				return null;

			ExecutionContext capture = new ExecutionContext (ec);
#if !MOBILE
			if (SecurityManager.SecurityEnabled)
				capture.SecurityContext = SecurityContext.Capture ();
#endif
			return capture;
		}
		
		public ExecutionContext CreateCopy ()
		{
			if (!_capture)
				throw new InvalidOperationException ();

			return new ExecutionContext (this);
		}
		
		public void Dispose ()
		{
#if !MOBILE
			if (_sc != null)
				_sc.Dispose ();
#endif
		}

		[MonoTODO]
		[ReflectionPermission (SecurityAction.Demand, MemberAccess = true)]
		public void GetObjectData (SerializationInfo info, StreamingContext context)
		{
			if (info == null)
				throw new ArgumentNullException ("info");
			throw new NotImplementedException ();
		}
		
		// internal stuff

		internal LogicalCallContext LogicalCallContext {
			get {
				if (_lcc == null)
					_lcc = new LogicalCallContext ();
				return _lcc;
			}
			set {
				_lcc = value;
			}
		}

		internal Dictionary<string, object> DataStore {
			get {
				if (local_data == null)
					local_data = new Dictionary<string, object> ();
				return local_data;
			}
			set {
				local_data = value;
			}
		}

#if !MOBILE
		internal SecurityContext SecurityContext {
			get {
				if (_sc == null)
					_sc = new SecurityContext ();
				return _sc;
			}
			set { _sc = value; }
		}
#endif

		internal bool FlowSuppressed {
			get { return _suppressFlow; }
			set { _suppressFlow = value; }
		}

		internal bool CopyOnWrite { get; set; }

		public static bool IsFlowSuppressed ()
		{
			return Current.FlowSuppressed;
		}

		public static void RestoreFlow ()
		{
			ExecutionContext ec = Current;
			if (!ec.FlowSuppressed)
				throw new InvalidOperationException ();

			ec.FlowSuppressed = false;
		}
		
		internal static void Run(ExecutionContext executionContext, ContextCallback callback, Object state, bool preserveSyncCtx)
		{
			Run (executionContext, callback, state);
		}

		[SecurityPermission (SecurityAction.LinkDemand, Infrastructure = true)]
		public static void Run (ExecutionContext executionContext, ContextCallback callback, object state)
		{
			if (executionContext == null) {
				throw new InvalidOperationException (Locale.GetText (
					"Null ExecutionContext"));
			}

			var prev = Current;
			try {
				Thread.CurrentThread.ExecutionContext = executionContext;
				callback (state);
			} finally {
				Thread.CurrentThread.ExecutionContext = prev;
			}
		}

		public static AsyncFlowControl SuppressFlow ()
		{
			Thread t = Thread.CurrentThread;
			t.ExecutionContext.FlowSuppressed = true;
			return new AsyncFlowControl (t, AsyncFlowControlType.Execution);
		}

		internal static LogicalCallContext CreateLogicalCallContext (bool createEmpty)
		{
			var lcc = Current._lcc;
			LogicalCallContext ctx = null;

			if (lcc != null && lcc.HasInfo) {
				ctx = new LogicalCallContext ();
				foreach (DictionaryEntry entry in lcc.Datastore) {
					ctx.SetData ((string)entry.Key, entry.Value);
				}
			} else if (createEmpty)
				ctx = new LogicalCallContext ();

			return ctx;
		}

		internal void FreeNamedDataSlot (string name)
		{
			if (_lcc != null)
				_lcc.FreeNamedDataSlot (name);

			if (local_data != null)
				local_data.Remove (name);
		}

		internal static ExecutionContext Current {
			get {
				return Thread.CurrentThread.ExecutionContext;
			}
		}

		internal static ExecutionContext GetCurrentWritable ()
		{
			var current = Thread.CurrentThread.ExecutionContext;
			if (current.CopyOnWrite) {
				current.CopyOnWrite = false;
				current.CloneData (current);
			}

			return current;
		}

		static internal void EstablishCopyOnWriteScope (Thread currentThread, bool knownNullWindowsIdentity, ref ExecutionContextSwitcher ecsw)
		{
			if (!currentThread.HasExecutionContext) {
				ecsw = default (ExecutionContextSwitcher);
			} else {
				var _ec = currentThread.ExecutionContext;
				ecsw = new ExecutionContextSwitcher (_ec);
				_ec.CopyOnWrite = true;
			}
		}
	}

	internal struct ExecutionContextSwitcher
	{
		readonly ExecutionContext ec;
		readonly LogicalCallContext _lcc;
		readonly bool _suppressFlow;
		readonly bool _capture;
		readonly Dictionary<string, object> local_data;
		readonly bool copy_on_write;

		public ExecutionContextSwitcher (ExecutionContext ec)
		{
			this.ec = ec;
			this._lcc = ec._lcc;
			this._suppressFlow = ec._suppressFlow;
			this._capture = ec._capture;
			this.local_data = ec.local_data;
			this.copy_on_write = ec.CopyOnWrite;
		}

		public bool IsEmpty {
			get {
				return ec == null;
			}
		}

		public void Undo (Thread currentThread)
		{
			if (currentThread == null)
				return;

			if (ec != null) {
				ec._lcc = this._lcc;
				ec._suppressFlow = this._suppressFlow;
				ec._capture = this._capture;
				ec.local_data = this.local_data;
				ec.CopyOnWrite = this.copy_on_write;
			}

			currentThread.ExecutionContext = ec;
		}
	}
}