2 // System.Threading.Thread.cs
5 // Dick Porter (dick@ximian.com)
7 // (C) Ximian, Inc. http://www.ximian.com
8 // Copyright (C) 2004-2006 Novell, Inc (http://www.novell.com)
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
30 using System.Runtime.Remoting.Contexts;
31 using System.Runtime.Serialization;
32 using System.Runtime.Serialization.Formatters.Binary;
33 using System.Security.Permissions;
34 using System.Security.Principal;
35 using System.Globalization;
36 using System.Runtime.CompilerServices;
37 using System.Runtime.InteropServices;
39 using System.Collections.Generic;
40 using System.Reflection;
41 using System.Security;
42 using System.Diagnostics;
43 using System.Runtime.ConstrainedExecution;
45 namespace System.Threading {
46 [StructLayout (LayoutKind.Sequential)]
47 sealed class InternalThread : CriticalFinalizerObject {
48 #pragma warning disable 169, 414, 649
49 #region Sync with metadata/object-internals.h
51 // stores a thread handle
53 IntPtr native_handle; // used only on Win32
55 /* Note this is an opaque object (an array), not a CultureInfo */
56 private object cached_culture_info;
57 /* accessed only from unmanaged code */
60 private ThreadState state;
61 private object abort_exc;
62 private int abort_state_handle;
63 /* thread_id is only accessed from unmanaged code */
64 internal Int64 thread_id;
66 /* start_notify is used by the runtime to signal that Start()
69 private IntPtr stack_ptr;
70 private UIntPtr static_data; /* GC-tracked */
71 private IntPtr runtime_thread_info;
72 /* current System.Runtime.Remoting.Contexts.Context instance
73 keep as an object to avoid triggering its class constructor when not needed */
74 private object current_appcontext;
75 private object root_domain_thread;
76 internal byte[] _serialized_principal;
77 internal int _serialized_principal_version;
78 private IntPtr appdomain_refs;
79 private int interruption_requested;
80 private IntPtr synch_cs;
81 internal bool threadpool_thread;
82 private bool thread_interrupt_requested;
83 /* These are used from managed code */
84 internal int stack_size;
85 internal byte apartment_state;
86 internal volatile int critical_region_level;
87 internal int managed_id;
89 private IntPtr manage_callback;
90 private IntPtr interrupt_on_stop;
92 private IntPtr thread_pinning_ref;
93 private IntPtr abort_protected_block_count;
94 private int priority = (int) ThreadPriority.Normal;
95 private IntPtr owned_mutex;
96 private IntPtr suspended_event;
97 private int self_suspended;
99 * These fields are used to avoid having to increment corlib versions
100 * when a new field is added to the unmanaged MonoThread structure.
102 private IntPtr unused1;
103 private IntPtr unused2;
105 /* This is used only to check that we are in sync between the representation
106 * of MonoInternalThread in native and InternalThread in managed
108 * DO NOT RENAME! DO NOT ADD FIELDS AFTER! */
111 #pragma warning restore 169, 414, 649
113 // Closes the system thread handle
114 [MethodImplAttribute(MethodImplOptions.InternalCall)]
115 private extern void Thread_free_internal();
117 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
119 Thread_free_internal();
123 [StructLayout (LayoutKind.Sequential)]
124 public sealed partial class Thread {
125 #pragma warning disable 414
126 #region Sync with metadata/object-internals.h
127 private InternalThread internal_thread;
128 object m_ThreadStartArg;
129 object pending_exception;
131 #pragma warning restore 414
133 IPrincipal principal;
134 int principal_version;
136 // the name of current_thread is
137 // important because they are used by the runtime.
140 static Thread current_thread;
142 // can be both a ThreadStart and a ParameterizedThreadStart
143 private MulticastDelegate m_Delegate;
145 private ExecutionContext m_ExecutionContext; // this call context follows the logical thread
147 private bool m_ExecutionContextBelongsToOuterScope;
149 [MethodImplAttribute(MethodImplOptions.InternalCall)]
150 private extern void ConstructInternalThread ();
152 private InternalThread Internal {
154 if (internal_thread == null)
155 ConstructInternalThread ();
156 return internal_thread;
160 public static Context CurrentContext {
161 [SecurityPermission (SecurityAction.LinkDemand, Infrastructure=true)]
163 return(AppDomain.InternalGetContext ());
168 * These two methods return an array in the target
169 * domain with the same content as the argument. If
170 * the argument is already in the target domain, then
171 * the argument is returned, otherwise a copy.
173 [MethodImplAttribute(MethodImplOptions.InternalCall)]
174 private extern static byte[] ByteArrayToRootDomain (byte[] arr);
176 [MethodImplAttribute(MethodImplOptions.InternalCall)]
177 private extern static byte[] ByteArrayToCurrentDomain (byte[] arr);
179 static void DeserializePrincipal (Thread th)
181 MemoryStream ms = new MemoryStream (ByteArrayToCurrentDomain (th.Internal._serialized_principal));
182 int type = ms.ReadByte ();
184 BinaryFormatter bf = new BinaryFormatter ();
185 th.principal = (IPrincipal) bf.Deserialize (ms);
186 th.principal_version = th.Internal._serialized_principal_version;
187 } else if (type == 1) {
188 BinaryReader reader = new BinaryReader (ms);
189 string name = reader.ReadString ();
190 string auth_type = reader.ReadString ();
191 int n_roles = reader.ReadInt32 ();
192 string [] roles = null;
194 roles = new string [n_roles];
195 for (int i = 0; i < n_roles; i++)
196 roles [i] = reader.ReadString ();
198 th.principal = new GenericPrincipal (new GenericIdentity (name, auth_type), roles);
199 } else if (type == 2 || type == 3) {
200 string [] roles = type == 2 ? null : new string [0];
201 th.principal = new GenericPrincipal (new GenericIdentity ("", ""), roles);
205 static void SerializePrincipal (Thread th, IPrincipal value)
207 MemoryStream ms = new MemoryStream ();
209 if (value.GetType () == typeof (GenericPrincipal)) {
210 GenericPrincipal gp = (GenericPrincipal) value;
211 if (gp.Identity != null && gp.Identity.GetType () == typeof (GenericIdentity)) {
212 GenericIdentity id = (GenericIdentity) gp.Identity;
213 if (id.Name == "" && id.AuthenticationType == "") {
214 if (gp.Roles == null) {
217 } else if (gp.Roles.Length == 0) {
223 BinaryWriter br = new BinaryWriter (ms);
224 br.Write (gp.Identity.Name);
225 br.Write (gp.Identity.AuthenticationType);
226 string [] roles = gp.Roles;
228 br.Write ((int) (-1));
230 br.Write (roles.Length);
231 foreach (string s in roles) {
242 BinaryFormatter bf = new BinaryFormatter ();
244 bf.Serialize (ms, value);
247 th.Internal._serialized_principal = ByteArrayToRootDomain (ms.ToArray ());
250 public static IPrincipal CurrentPrincipal {
252 Thread th = CurrentThread;
254 if (th.principal_version != th.Internal._serialized_principal_version)
257 if (th.principal != null)
260 if (th.Internal._serialized_principal != null) {
262 DeserializePrincipal (th);
267 th.principal = GetDomain ().DefaultPrincipal;
268 th.principal_version = th.Internal._serialized_principal_version;
271 [SecurityPermission (SecurityAction.Demand, ControlPrincipal = true)]
273 Thread th = CurrentThread;
275 if (value != GetDomain ().DefaultPrincipal) {
276 ++th.Internal._serialized_principal_version;
278 SerializePrincipal (th, value);
279 } catch (Exception) {
280 th.Internal._serialized_principal = null;
282 th.principal_version = th.Internal._serialized_principal_version;
284 th.Internal._serialized_principal = null;
287 th.principal = value;
291 [MethodImplAttribute(MethodImplOptions.InternalCall)]
292 private extern static Thread GetCurrentThread ();
294 public static Thread CurrentThread {
295 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
297 Thread current = current_thread;
300 // This will set the current_thread tls variable
301 return GetCurrentThread ();
305 internal static int CurrentThreadId {
307 return (int)(CurrentThread.internal_thread.thread_id);
311 public static AppDomain GetDomain() {
312 return AppDomain.CurrentDomain;
315 [MethodImplAttribute(MethodImplOptions.InternalCall)]
316 public extern static int GetDomainID();
318 // Returns the system thread handle
319 [MethodImplAttribute(MethodImplOptions.InternalCall)]
320 private extern IntPtr Thread_internal (MulticastDelegate start);
322 private Thread (InternalThread it) {
323 internal_thread = it;
326 // part of ".NETPortable,Version=v4.0,Profile=Profile3" i.e. FX4 and SL4
327 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
332 [Obsolete ("Deprecated in favor of GetApartmentState, SetApartmentState and TrySetApartmentState.")]
333 public ApartmentState ApartmentState {
335 if ((ThreadState & ThreadState.Stopped) != 0)
336 throw new ThreadStateException ("Thread is dead; state can not be accessed.");
338 return (ApartmentState)Internal.apartment_state;
342 TrySetApartmentState (value);
346 public bool IsThreadPoolThread {
348 return IsThreadPoolThreadInternal;
352 internal bool IsThreadPoolThreadInternal {
354 return Internal.threadpool_thread;
357 Internal.threadpool_thread = value;
361 public bool IsAlive {
363 ThreadState curstate = GetState (Internal);
365 if((curstate & ThreadState.Aborted) != 0 ||
366 (curstate & ThreadState.Stopped) != 0 ||
367 (curstate & ThreadState.Unstarted) != 0) {
375 public bool IsBackground {
377 ThreadState thread_state = GetState (Internal);
378 if ((thread_state & ThreadState.Stopped) != 0)
379 throw new ThreadStateException ("Thread is dead; state can not be accessed.");
381 return (thread_state & ThreadState.Background) != 0;
386 SetState (Internal, ThreadState.Background);
388 ClrState (Internal, ThreadState.Background);
393 [MethodImplAttribute(MethodImplOptions.InternalCall)]
394 private extern static string GetName_internal (InternalThread thread);
396 [MethodImplAttribute(MethodImplOptions.InternalCall)]
397 private extern static void SetName_internal (InternalThread thread, String name);
400 * The thread name must be shared by appdomains, so it is stored in
406 return GetName_internal (Internal);
410 SetName_internal (Internal, value);
414 public ThreadState ThreadState {
416 return GetState (Internal);
420 #if MONO_FEATURE_THREAD_ABORT
421 [MethodImplAttribute(MethodImplOptions.InternalCall)]
422 private extern static void Abort_internal (InternalThread thread, object stateInfo);
424 [SecurityPermission (SecurityAction.Demand, ControlThread=true)]
427 Abort_internal (Internal, null);
430 [SecurityPermission (SecurityAction.Demand, ControlThread=true)]
431 public void Abort (object stateInfo)
433 Abort_internal (Internal, stateInfo);
436 [MethodImplAttribute(MethodImplOptions.InternalCall)]
437 extern object GetAbortExceptionState ();
439 internal object AbortReason {
441 return GetAbortExceptionState ();
445 void ClearAbortReason ()
449 [Obsolete ("Thread.Abort is not supported on the current platform.", true)]
452 throw new PlatformNotSupportedException ("Thread.Abort is not supported on the current platform.");
455 [Obsolete ("Thread.Abort is not supported on the current platform.", true)]
456 public void Abort (object stateInfo)
458 throw new PlatformNotSupportedException ("Thread.Abort is not supported on the current platform.");
461 [Obsolete ("Thread.ResetAbort is not supported on the current platform.", true)]
462 public static void ResetAbort ()
464 throw new PlatformNotSupportedException ("Thread.ResetAbort is not supported on the current platform.");
467 internal object AbortReason {
469 throw new PlatformNotSupportedException ("Thread.ResetAbort is not supported on the current platform.");
472 #endif // MONO_FEATURE_THREAD_ABORT
474 [MethodImplAttribute (MethodImplOptions.InternalCall)]
475 private extern static void SpinWait_nop ();
478 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.Success)]
479 public static void SpinWait (int iterations)
483 while (iterations-- > 0)
489 void StartInternal (IPrincipal principal, ref StackCrawlMark stackMark)
491 #if FEATURE_ROLE_BASED_SECURITY
492 Internal._serialized_principal = CurrentThread.Internal._serialized_principal;
495 // Thread_internal creates and starts the new thread,
496 if (Thread_internal(m_Delegate) == IntPtr.Zero)
497 throw new SystemException ("Thread creation failed.");
499 m_ThreadStartArg = null;
502 [MethodImplAttribute (MethodImplOptions.InternalCall)]
503 extern private static void SetState (InternalThread thread, ThreadState set);
505 [MethodImplAttribute (MethodImplOptions.InternalCall)]
506 extern private static void ClrState (InternalThread thread, ThreadState clr);
508 [MethodImplAttribute (MethodImplOptions.InternalCall)]
509 extern private static ThreadState GetState (InternalThread thread);
511 [MethodImplAttribute (MethodImplOptions.InternalCall)]
512 extern public static byte VolatileRead (ref byte address);
514 [MethodImplAttribute (MethodImplOptions.InternalCall)]
515 extern public static double VolatileRead (ref double address);
517 [MethodImplAttribute (MethodImplOptions.InternalCall)]
518 extern public static short VolatileRead (ref short address);
520 [MethodImplAttribute (MethodImplOptions.InternalCall)]
521 extern public static int VolatileRead (ref int address);
523 [MethodImplAttribute (MethodImplOptions.InternalCall)]
524 extern public static long VolatileRead (ref long address);
526 [MethodImplAttribute (MethodImplOptions.InternalCall)]
527 extern public static IntPtr VolatileRead (ref IntPtr address);
529 [MethodImplAttribute (MethodImplOptions.InternalCall)]
530 extern public static object VolatileRead (ref object address);
532 [CLSCompliant(false)]
533 [MethodImplAttribute (MethodImplOptions.InternalCall)]
534 extern public static sbyte VolatileRead (ref sbyte address);
536 [MethodImplAttribute (MethodImplOptions.InternalCall)]
537 extern public static float VolatileRead (ref float address);
539 [CLSCompliant (false)]
540 [MethodImplAttribute (MethodImplOptions.InternalCall)]
541 extern public static ushort VolatileRead (ref ushort address);
543 [CLSCompliant (false)]
544 [MethodImplAttribute (MethodImplOptions.InternalCall)]
545 extern public static uint VolatileRead (ref uint address);
547 [CLSCompliant (false)]
548 [MethodImplAttribute (MethodImplOptions.InternalCall)]
549 extern public static ulong VolatileRead (ref ulong address);
551 [CLSCompliant (false)]
552 [MethodImplAttribute (MethodImplOptions.InternalCall)]
553 extern public static UIntPtr VolatileRead (ref UIntPtr address);
555 [MethodImplAttribute (MethodImplOptions.InternalCall)]
556 extern public static void VolatileWrite (ref byte address, byte value);
558 [MethodImplAttribute (MethodImplOptions.InternalCall)]
559 extern public static void VolatileWrite (ref double address, double value);
561 [MethodImplAttribute (MethodImplOptions.InternalCall)]
562 extern public static void VolatileWrite (ref short address, short value);
564 [MethodImplAttribute (MethodImplOptions.InternalCall)]
565 extern public static void VolatileWrite (ref int address, int value);
567 [MethodImplAttribute (MethodImplOptions.InternalCall)]
568 extern public static void VolatileWrite (ref long address, long value);
570 [MethodImplAttribute (MethodImplOptions.InternalCall)]
571 extern public static void VolatileWrite (ref IntPtr address, IntPtr value);
573 [MethodImplAttribute (MethodImplOptions.InternalCall)]
574 extern public static void VolatileWrite (ref object address, object value);
576 [CLSCompliant(false)]
577 [MethodImplAttribute (MethodImplOptions.InternalCall)]
578 extern public static void VolatileWrite (ref sbyte address, sbyte value);
580 [MethodImplAttribute (MethodImplOptions.InternalCall)]
581 extern public static void VolatileWrite (ref float address, float value);
583 [CLSCompliant (false)]
584 [MethodImplAttribute (MethodImplOptions.InternalCall)]
585 extern public static void VolatileWrite (ref ushort address, ushort value);
587 [CLSCompliant (false)]
588 [MethodImplAttribute (MethodImplOptions.InternalCall)]
589 extern public static void VolatileWrite (ref uint address, uint value);
591 [CLSCompliant (false)]
592 [MethodImplAttribute (MethodImplOptions.InternalCall)]
593 extern public static void VolatileWrite (ref ulong address, ulong value);
595 [CLSCompliant (false)]
596 [MethodImplAttribute (MethodImplOptions.InternalCall)]
597 extern public static void VolatileWrite (ref UIntPtr address, UIntPtr value);
599 [MethodImplAttribute (MethodImplOptions.InternalCall)]
600 extern static int SystemMaxStackStize ();
602 static int GetProcessDefaultStackSize (int maxStackSize)
604 if (maxStackSize == 0)
607 if (maxStackSize < 131072) // make sure stack is at least 128k big
610 int page_size = Environment.GetPageSize ();
612 if ((maxStackSize % page_size) != 0) // round up to a divisible of page size
613 maxStackSize = (maxStackSize / (page_size - 1)) * page_size;
615 /* Respect the max stack size imposed by the system*/
616 return Math.Min (maxStackSize, SystemMaxStackStize ());
619 void SetStart (MulticastDelegate start, int maxStackSize)
622 Internal.stack_size = maxStackSize;
625 public int ManagedThreadId {
626 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.Success)]
628 return Internal.managed_id;
632 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
633 public static void BeginCriticalRegion ()
635 CurrentThread.Internal.critical_region_level++;
638 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
639 public static void EndCriticalRegion ()
641 CurrentThread.Internal.critical_region_level--;
644 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
645 public static void BeginThreadAffinity ()
647 // Managed and native threads are currently bound together.
650 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
651 public static void EndThreadAffinity ()
653 // Managed and native threads are currently bound together.
656 public ApartmentState GetApartmentState ()
658 return (ApartmentState)Internal.apartment_state;
661 public void SetApartmentState (ApartmentState state)
663 if (!TrySetApartmentState (state))
664 throw new InvalidOperationException ("Failed to set the specified COM apartment state.");
667 public bool TrySetApartmentState (ApartmentState state)
669 if ((ThreadState & ThreadState.Unstarted) == 0)
670 throw new ThreadStateException ("Thread was in an invalid state for the operation being executed.");
672 if ((ApartmentState)Internal.apartment_state != ApartmentState.Unknown &&
673 (ApartmentState)Internal.apartment_state != state)
676 Internal.apartment_state = (byte)state;
682 public override int GetHashCode ()
684 return ManagedThreadId;
687 [MethodImplAttribute(MethodImplOptions.InternalCall)]
688 internal static extern void GetStackTraces (out Thread[] threads, out object[] stack_frames);
690 // This is a mono extension to gather the stack traces for all running threads
691 internal static Dictionary<Thread, StackTrace> Mono_GetStackTraces () {
693 object[] stack_frames;
695 GetStackTraces (out threads, out stack_frames);
697 var res = new Dictionary<Thread, StackTrace> ();
698 for (int i = 0; i < threads.Length; ++i)
699 res [threads [i]] = new StackTrace ((StackFrame[])stack_frames [i]);
703 #if !MONO_FEATURE_THREAD_SUSPEND_RESUME
704 [Obsolete ("Thread.Suspend is not supported on the current platform.", true)]
705 public void Suspend ()
707 throw new PlatformNotSupportedException ("Thread.Suspend is not supported on the current platform.");
710 [Obsolete ("Thread.Resume is not supported on the current platform.", true)]
711 public void Resume ()
713 throw new PlatformNotSupportedException ("Thread.Resume is not supported on the current platform.");
717 public void DisableComObjectEagerCleanup ()
719 throw new PlatformNotSupportedException ();