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;
65 private IntPtr stack_ptr;
66 private UIntPtr static_data; /* GC-tracked */
67 private IntPtr runtime_thread_info;
68 /* current System.Runtime.Remoting.Contexts.Context instance
69 keep as an object to avoid triggering its class constructor when not needed */
70 private object current_appcontext;
71 private object root_domain_thread;
72 internal byte[] _serialized_principal;
73 internal int _serialized_principal_version;
74 private IntPtr appdomain_refs;
75 private int interruption_requested;
76 private IntPtr synch_cs;
77 internal bool threadpool_thread;
78 private bool thread_interrupt_requested;
79 /* These are used from managed code */
80 internal int stack_size;
81 internal byte apartment_state;
82 internal volatile int critical_region_level;
83 internal int managed_id;
85 private IntPtr manage_callback;
86 private IntPtr interrupt_on_stop;
88 private IntPtr thread_pinning_ref;
89 private IntPtr abort_protected_block_count;
90 private int priority = (int) ThreadPriority.Normal;
91 private IntPtr owned_mutex;
92 private IntPtr suspended_event;
93 private int self_suspended;
95 * These fields are used to avoid having to increment corlib versions
96 * when a new field is added to the unmanaged MonoThread structure.
98 private IntPtr unused1;
99 private IntPtr unused2;
101 /* This is used only to check that we are in sync between the representation
102 * of MonoInternalThread in native and InternalThread in managed
104 * DO NOT RENAME! DO NOT ADD FIELDS AFTER! */
107 #pragma warning restore 169, 414, 649
109 // Closes the system thread handle
110 [MethodImplAttribute(MethodImplOptions.InternalCall)]
111 private extern void Thread_free_internal();
113 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
115 Thread_free_internal();
119 [StructLayout (LayoutKind.Sequential)]
120 public sealed partial class Thread {
121 #pragma warning disable 414
122 #region Sync with metadata/object-internals.h
123 private InternalThread internal_thread;
124 object m_ThreadStartArg;
125 object pending_exception;
127 #pragma warning restore 414
129 IPrincipal principal;
130 int principal_version;
132 // the name of current_thread is
133 // important because they are used by the runtime.
136 static Thread current_thread;
138 // can be both a ThreadStart and a ParameterizedThreadStart
139 private MulticastDelegate m_Delegate;
141 private ExecutionContext m_ExecutionContext; // this call context follows the logical thread
143 private bool m_ExecutionContextBelongsToOuterScope;
145 [MethodImplAttribute(MethodImplOptions.InternalCall)]
146 private extern void ConstructInternalThread ();
148 private InternalThread Internal {
150 if (internal_thread == null)
151 ConstructInternalThread ();
152 return internal_thread;
156 public static Context CurrentContext {
157 [SecurityPermission (SecurityAction.LinkDemand, Infrastructure=true)]
159 return(AppDomain.InternalGetContext ());
164 * These two methods return an array in the target
165 * domain with the same content as the argument. If
166 * the argument is already in the target domain, then
167 * the argument is returned, otherwise a copy.
169 [MethodImplAttribute(MethodImplOptions.InternalCall)]
170 private extern static byte[] ByteArrayToRootDomain (byte[] arr);
172 [MethodImplAttribute(MethodImplOptions.InternalCall)]
173 private extern static byte[] ByteArrayToCurrentDomain (byte[] arr);
175 static void DeserializePrincipal (Thread th)
177 MemoryStream ms = new MemoryStream (ByteArrayToCurrentDomain (th.Internal._serialized_principal));
178 int type = ms.ReadByte ();
180 BinaryFormatter bf = new BinaryFormatter ();
181 th.principal = (IPrincipal) bf.Deserialize (ms);
182 th.principal_version = th.Internal._serialized_principal_version;
183 } else if (type == 1) {
184 BinaryReader reader = new BinaryReader (ms);
185 string name = reader.ReadString ();
186 string auth_type = reader.ReadString ();
187 int n_roles = reader.ReadInt32 ();
188 string [] roles = null;
190 roles = new string [n_roles];
191 for (int i = 0; i < n_roles; i++)
192 roles [i] = reader.ReadString ();
194 th.principal = new GenericPrincipal (new GenericIdentity (name, auth_type), roles);
195 } else if (type == 2 || type == 3) {
196 string [] roles = type == 2 ? null : new string [0];
197 th.principal = new GenericPrincipal (new GenericIdentity ("", ""), roles);
201 static void SerializePrincipal (Thread th, IPrincipal value)
203 MemoryStream ms = new MemoryStream ();
205 if (value.GetType () == typeof (GenericPrincipal)) {
206 GenericPrincipal gp = (GenericPrincipal) value;
207 if (gp.Identity != null && gp.Identity.GetType () == typeof (GenericIdentity)) {
208 GenericIdentity id = (GenericIdentity) gp.Identity;
209 if (id.Name == "" && id.AuthenticationType == "") {
210 if (gp.Roles == null) {
213 } else if (gp.Roles.Length == 0) {
219 BinaryWriter br = new BinaryWriter (ms);
220 br.Write (gp.Identity.Name);
221 br.Write (gp.Identity.AuthenticationType);
222 string [] roles = gp.Roles;
224 br.Write ((int) (-1));
226 br.Write (roles.Length);
227 foreach (string s in roles) {
238 BinaryFormatter bf = new BinaryFormatter ();
240 bf.Serialize (ms, value);
243 th.Internal._serialized_principal = ByteArrayToRootDomain (ms.ToArray ());
246 public static IPrincipal CurrentPrincipal {
248 Thread th = CurrentThread;
250 if (th.principal_version != th.Internal._serialized_principal_version)
253 if (th.principal != null)
256 if (th.Internal._serialized_principal != null) {
258 DeserializePrincipal (th);
263 th.principal = GetDomain ().DefaultPrincipal;
264 th.principal_version = th.Internal._serialized_principal_version;
267 [SecurityPermission (SecurityAction.Demand, ControlPrincipal = true)]
269 Thread th = CurrentThread;
271 if (value != GetDomain ().DefaultPrincipal) {
272 ++th.Internal._serialized_principal_version;
274 SerializePrincipal (th, value);
275 } catch (Exception) {
276 th.Internal._serialized_principal = null;
278 th.principal_version = th.Internal._serialized_principal_version;
280 th.Internal._serialized_principal = null;
283 th.principal = value;
287 [MethodImplAttribute(MethodImplOptions.InternalCall)]
288 private extern static Thread GetCurrentThread ();
290 public static Thread CurrentThread {
291 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
293 Thread current = current_thread;
296 // This will set the current_thread tls variable
297 return GetCurrentThread ();
301 internal static int CurrentThreadId {
303 return (int)(CurrentThread.internal_thread.thread_id);
307 public static AppDomain GetDomain() {
308 return AppDomain.CurrentDomain;
311 [MethodImplAttribute(MethodImplOptions.InternalCall)]
312 public extern static int GetDomainID();
314 // Returns the system thread handle
315 [MethodImplAttribute(MethodImplOptions.InternalCall)]
316 private extern IntPtr Thread_internal (MulticastDelegate start);
318 private Thread (InternalThread it) {
319 internal_thread = it;
322 // part of ".NETPortable,Version=v4.0,Profile=Profile3" i.e. FX4 and SL4
323 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
328 [Obsolete ("Deprecated in favor of GetApartmentState, SetApartmentState and TrySetApartmentState.")]
329 public ApartmentState ApartmentState {
331 if ((ThreadState & ThreadState.Stopped) != 0)
332 throw new ThreadStateException ("Thread is dead; state can not be accessed.");
334 return (ApartmentState)Internal.apartment_state;
338 TrySetApartmentState (value);
342 public bool IsThreadPoolThread {
344 return IsThreadPoolThreadInternal;
348 internal bool IsThreadPoolThreadInternal {
350 return Internal.threadpool_thread;
353 Internal.threadpool_thread = value;
357 public bool IsAlive {
359 ThreadState curstate = GetState (Internal);
361 if((curstate & ThreadState.Aborted) != 0 ||
362 (curstate & ThreadState.Stopped) != 0 ||
363 (curstate & ThreadState.Unstarted) != 0) {
371 public bool IsBackground {
373 ThreadState thread_state = GetState (Internal);
374 if ((thread_state & ThreadState.Stopped) != 0)
375 throw new ThreadStateException ("Thread is dead; state can not be accessed.");
377 return (thread_state & ThreadState.Background) != 0;
382 SetState (Internal, ThreadState.Background);
384 ClrState (Internal, ThreadState.Background);
389 [MethodImplAttribute(MethodImplOptions.InternalCall)]
390 private extern static string GetName_internal (InternalThread thread);
392 [MethodImplAttribute(MethodImplOptions.InternalCall)]
393 private extern static void SetName_internal (InternalThread thread, String name);
396 * The thread name must be shared by appdomains, so it is stored in
402 return GetName_internal (Internal);
406 SetName_internal (Internal, value);
410 public ThreadState ThreadState {
412 return GetState (Internal);
416 #if MONO_FEATURE_THREAD_ABORT
417 [MethodImplAttribute(MethodImplOptions.InternalCall)]
418 private extern static void Abort_internal (InternalThread thread, object stateInfo);
420 [SecurityPermission (SecurityAction.Demand, ControlThread=true)]
423 Abort_internal (Internal, null);
426 [SecurityPermission (SecurityAction.Demand, ControlThread=true)]
427 public void Abort (object stateInfo)
429 Abort_internal (Internal, stateInfo);
432 [MethodImplAttribute(MethodImplOptions.InternalCall)]
433 extern object GetAbortExceptionState ();
435 internal object AbortReason {
437 return GetAbortExceptionState ();
441 void ClearAbortReason ()
445 [Obsolete ("Thread.Abort is not supported on the current platform.", true)]
448 throw new PlatformNotSupportedException ("Thread.Abort is not supported on the current platform.");
451 [Obsolete ("Thread.Abort is not supported on the current platform.", true)]
452 public void Abort (object stateInfo)
454 throw new PlatformNotSupportedException ("Thread.Abort is not supported on the current platform.");
457 [Obsolete ("Thread.ResetAbort is not supported on the current platform.", true)]
458 public static void ResetAbort ()
460 throw new PlatformNotSupportedException ("Thread.ResetAbort is not supported on the current platform.");
463 internal object AbortReason {
465 throw new PlatformNotSupportedException ("Thread.ResetAbort is not supported on the current platform.");
468 #endif // MONO_FEATURE_THREAD_ABORT
470 [MethodImplAttribute (MethodImplOptions.InternalCall)]
471 private extern static void SpinWait_nop ();
474 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.Success)]
475 public static void SpinWait (int iterations)
479 while (iterations-- > 0)
485 void StartInternal (IPrincipal principal, ref StackCrawlMark stackMark)
487 #if FEATURE_ROLE_BASED_SECURITY
488 Internal._serialized_principal = CurrentThread.Internal._serialized_principal;
491 // Thread_internal creates and starts the new thread,
492 if (Thread_internal(m_Delegate) == IntPtr.Zero)
493 throw new SystemException ("Thread creation failed.");
495 m_ThreadStartArg = null;
498 [MethodImplAttribute (MethodImplOptions.InternalCall)]
499 extern private static void SetState (InternalThread thread, ThreadState set);
501 [MethodImplAttribute (MethodImplOptions.InternalCall)]
502 extern private static void ClrState (InternalThread thread, ThreadState clr);
504 [MethodImplAttribute (MethodImplOptions.InternalCall)]
505 extern private static ThreadState GetState (InternalThread thread);
507 [MethodImplAttribute (MethodImplOptions.InternalCall)]
508 extern public static byte VolatileRead (ref byte address);
510 [MethodImplAttribute (MethodImplOptions.InternalCall)]
511 extern public static double VolatileRead (ref double address);
513 [MethodImplAttribute (MethodImplOptions.InternalCall)]
514 extern public static short VolatileRead (ref short address);
516 [MethodImplAttribute (MethodImplOptions.InternalCall)]
517 extern public static int VolatileRead (ref int address);
519 [MethodImplAttribute (MethodImplOptions.InternalCall)]
520 extern public static long VolatileRead (ref long address);
522 [MethodImplAttribute (MethodImplOptions.InternalCall)]
523 extern public static IntPtr VolatileRead (ref IntPtr address);
525 [MethodImplAttribute (MethodImplOptions.InternalCall)]
526 extern public static object VolatileRead (ref object address);
528 [CLSCompliant(false)]
529 [MethodImplAttribute (MethodImplOptions.InternalCall)]
530 extern public static sbyte VolatileRead (ref sbyte address);
532 [MethodImplAttribute (MethodImplOptions.InternalCall)]
533 extern public static float VolatileRead (ref float address);
535 [CLSCompliant (false)]
536 [MethodImplAttribute (MethodImplOptions.InternalCall)]
537 extern public static ushort VolatileRead (ref ushort address);
539 [CLSCompliant (false)]
540 [MethodImplAttribute (MethodImplOptions.InternalCall)]
541 extern public static uint VolatileRead (ref uint address);
543 [CLSCompliant (false)]
544 [MethodImplAttribute (MethodImplOptions.InternalCall)]
545 extern public static ulong VolatileRead (ref ulong address);
547 [CLSCompliant (false)]
548 [MethodImplAttribute (MethodImplOptions.InternalCall)]
549 extern public static UIntPtr VolatileRead (ref UIntPtr address);
551 [MethodImplAttribute (MethodImplOptions.InternalCall)]
552 extern public static void VolatileWrite (ref byte address, byte value);
554 [MethodImplAttribute (MethodImplOptions.InternalCall)]
555 extern public static void VolatileWrite (ref double address, double value);
557 [MethodImplAttribute (MethodImplOptions.InternalCall)]
558 extern public static void VolatileWrite (ref short address, short value);
560 [MethodImplAttribute (MethodImplOptions.InternalCall)]
561 extern public static void VolatileWrite (ref int address, int value);
563 [MethodImplAttribute (MethodImplOptions.InternalCall)]
564 extern public static void VolatileWrite (ref long address, long value);
566 [MethodImplAttribute (MethodImplOptions.InternalCall)]
567 extern public static void VolatileWrite (ref IntPtr address, IntPtr value);
569 [MethodImplAttribute (MethodImplOptions.InternalCall)]
570 extern public static void VolatileWrite (ref object address, object value);
572 [CLSCompliant(false)]
573 [MethodImplAttribute (MethodImplOptions.InternalCall)]
574 extern public static void VolatileWrite (ref sbyte address, sbyte value);
576 [MethodImplAttribute (MethodImplOptions.InternalCall)]
577 extern public static void VolatileWrite (ref float address, float value);
579 [CLSCompliant (false)]
580 [MethodImplAttribute (MethodImplOptions.InternalCall)]
581 extern public static void VolatileWrite (ref ushort address, ushort value);
583 [CLSCompliant (false)]
584 [MethodImplAttribute (MethodImplOptions.InternalCall)]
585 extern public static void VolatileWrite (ref uint address, uint value);
587 [CLSCompliant (false)]
588 [MethodImplAttribute (MethodImplOptions.InternalCall)]
589 extern public static void VolatileWrite (ref ulong address, ulong value);
591 [CLSCompliant (false)]
592 [MethodImplAttribute (MethodImplOptions.InternalCall)]
593 extern public static void VolatileWrite (ref UIntPtr address, UIntPtr value);
595 [MethodImplAttribute (MethodImplOptions.InternalCall)]
596 extern static int SystemMaxStackStize ();
598 static int GetProcessDefaultStackSize (int maxStackSize)
600 if (maxStackSize == 0)
603 if (maxStackSize < 131072) // make sure stack is at least 128k big
606 int page_size = Environment.GetPageSize ();
608 if ((maxStackSize % page_size) != 0) // round up to a divisible of page size
609 maxStackSize = (maxStackSize / (page_size - 1)) * page_size;
611 /* Respect the max stack size imposed by the system*/
612 return Math.Min (maxStackSize, SystemMaxStackStize ());
615 void SetStart (MulticastDelegate start, int maxStackSize)
618 Internal.stack_size = maxStackSize;
621 public int ManagedThreadId {
622 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.Success)]
624 return Internal.managed_id;
628 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.MayFail)]
629 public static void BeginCriticalRegion ()
631 CurrentThread.Internal.critical_region_level++;
634 [ReliabilityContract (Consistency.WillNotCorruptState, Cer.Success)]
635 public static void EndCriticalRegion ()
637 CurrentThread.Internal.critical_region_level--;
640 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
641 public static void BeginThreadAffinity ()
643 // Managed and native threads are currently bound together.
646 [ReliabilityContractAttribute (Consistency.WillNotCorruptState, Cer.MayFail)]
647 public static void EndThreadAffinity ()
649 // Managed and native threads are currently bound together.
652 public ApartmentState GetApartmentState ()
654 return (ApartmentState)Internal.apartment_state;
657 public void SetApartmentState (ApartmentState state)
659 if (!TrySetApartmentState (state))
660 throw new InvalidOperationException ("Failed to set the specified COM apartment state.");
663 public bool TrySetApartmentState (ApartmentState state)
665 if ((ThreadState & ThreadState.Unstarted) == 0)
666 throw new ThreadStateException ("Thread was in an invalid state for the operation being executed.");
668 if ((ApartmentState)Internal.apartment_state != ApartmentState.Unknown &&
669 (ApartmentState)Internal.apartment_state != state)
672 Internal.apartment_state = (byte)state;
678 public override int GetHashCode ()
680 return ManagedThreadId;
683 [MethodImplAttribute(MethodImplOptions.InternalCall)]
684 internal static extern void GetStackTraces (out Thread[] threads, out object[] stack_frames);
686 // This is a mono extension to gather the stack traces for all running threads
687 internal static Dictionary<Thread, StackTrace> Mono_GetStackTraces () {
689 object[] stack_frames;
691 GetStackTraces (out threads, out stack_frames);
693 var res = new Dictionary<Thread, StackTrace> ();
694 for (int i = 0; i < threads.Length; ++i)
695 res [threads [i]] = new StackTrace ((StackFrame[])stack_frames [i]);
699 #if !MONO_FEATURE_THREAD_SUSPEND_RESUME
700 [Obsolete ("Thread.Suspend is not supported on the current platform.", true)]
701 public void Suspend ()
703 throw new PlatformNotSupportedException ("Thread.Suspend is not supported on the current platform.");
706 [Obsolete ("Thread.Resume is not supported on the current platform.", true)]
707 public void Resume ()
709 throw new PlatformNotSupportedException ("Thread.Resume is not supported on the current platform.");
713 public void DisableComObjectEagerCleanup ()
715 throw new PlatformNotSupportedException ();