Code:
/ 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / Services / Monitoring / system / Diagnosticts / ProcessThread.cs / 1305376 / ProcessThread.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
namespace System.Diagnostics {
using System.Threading;
using System.Runtime.InteropServices;
using System.ComponentModel;
using System.Diagnostics;
using System;
using System.Collections;
using System.IO;
using Microsoft.Win32;
using System.Security.Permissions;
using Microsoft.Win32.SafeHandles;
using System.Runtime.Versioning;
// using System.Windows.Forms;
///
///
/// Represents a Win32 thread. This can be used to obtain
/// information about the thread, such as it's performance characteristics. This is
/// returned from the System.Diagnostics.Process.ProcessThread property of the System.Diagnostics.Process component.
///
///
/// I don't understand
/// the following comment associated with the previous sentence: "property of
/// Process component " Rather than just "processTHread". There is no such
/// member on Process. Do we mean 'threads'?
///
///
[
Designer("System.Diagnostics.Design.ProcessThreadDesigner, " + AssemblyRef.SystemDesign),
HostProtection(SelfAffectingProcessMgmt=true, SelfAffectingThreading=true)
]
public class ProcessThread : Component {
//
// FIELDS
//
ThreadInfo threadInfo;
bool isRemoteMachine;
bool priorityBoostEnabled;
bool havePriorityBoostEnabled;
ThreadPriorityLevel priorityLevel;
bool havePriorityLevel;
//
// CONSTRUCTORS
//
///
/// Internal constructor.
///
///
/// Returns the base priority of the thread which is computed by combining the
/// process priority class with the priority level of the associated thread.
///
[MonitoringDescription(SR.ThreadBasePriority)]
public int BasePriority {
get {
return threadInfo.basePriority;
}
}
///
/// The current priority indicates the actual priority of the associated thread,
/// which may deviate from the base priority based on how the OS is currently
/// scheduling the thread.
///
[MonitoringDescription(SR.ThreadCurrentPriority)]
public int CurrentPriority {
get {
return threadInfo.currentPriority;
}
}
///
/// Returns the unique identifier for the associated thread.
///
[MonitoringDescription(SR.ThreadId)]
public int Id {
[ResourceExposure(ResourceScope.Process)]
get {
return threadInfo.threadId;
}
}
///
///
/// Sets the processor that this thread would ideally like to run on.
///
///
[Browsable(false)]
public int IdealProcessor {
[ResourceExposure(ResourceScope.Process)]
[ResourceConsumption(ResourceScope.Process)]
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION);
if (NativeMethods.SetThreadIdealProcessor(threadHandle, value) < 0) {
throw new Win32Exception();
}
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
///
/// Returns or sets whether this thread would like a priority boost if the user interacts
/// with user interface associated with this thread.
///
[MonitoringDescription(SR.ThreadPriorityBoostEnabled)]
public bool PriorityBoostEnabled {
get {
if (!havePriorityBoostEnabled) {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_QUERY_INFORMATION);
bool disabled = false;
if (!NativeMethods.GetThreadPriorityBoost(threadHandle, out disabled)) {
throw new Win32Exception();
}
priorityBoostEnabled = !disabled;
havePriorityBoostEnabled = true;
}
finally {
CloseThreadHandle(threadHandle);
}
}
return priorityBoostEnabled;
}
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION);
if (!NativeMethods.SetThreadPriorityBoost(threadHandle, !value))
throw new Win32Exception();
priorityBoostEnabled = value;
havePriorityBoostEnabled = true;
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
///
/// Returns or sets the priority level of the associated thread. The priority level is
/// not an absolute level, but instead contributes to the actual thread priority by
/// considering the priority class of the process.
///
[MonitoringDescription(SR.ThreadPriorityLevel)]
public ThreadPriorityLevel PriorityLevel {
get {
if (!havePriorityLevel) {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_QUERY_INFORMATION);
int value = NativeMethods.GetThreadPriority(threadHandle);
if (value == 0x7fffffff) {
throw new Win32Exception();
}
priorityLevel = (ThreadPriorityLevel)value;
havePriorityLevel = true;
}
finally {
CloseThreadHandle(threadHandle);
}
}
return priorityLevel;
}
[ResourceExposure(ResourceScope.Process)]
[ResourceConsumption(ResourceScope.Process)]
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION);
if (!NativeMethods.SetThreadPriority(threadHandle, (int)value)) {
throw new Win32Exception();
}
priorityLevel = value;
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
///
/// Returns the amount of time the thread has spent running code inside the operating
/// system core.
///
[MonitoringDescription(SR.ThreadPrivilegedProcessorTime)]
public TimeSpan PrivilegedProcessorTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().PrivilegedProcessorTime;
}
}
///
/// Returns the memory address of the function that was called when the associated
/// thread was started.
///
[MonitoringDescription(SR.ThreadStartAddress)]
public IntPtr StartAddress {
get {
EnsureState(State.IsNt);
return threadInfo.startAddress;
}
}
///
/// Returns the time the associated thread was started.
///
[MonitoringDescription(SR.ThreadStartTime)]
public DateTime StartTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().StartTime;
}
}
///
/// Returns the current state of the associated thread, e.g. is it running, waiting, etc.
///
[MonitoringDescription(SR.ThreadThreadState)]
public ThreadState ThreadState {
get {
EnsureState(State.IsNt);
return threadInfo.threadState;
}
}
///
/// Returns the amount of time the associated thread has spent utilizing the CPU.
/// It is the sum of the System.Diagnostics.ProcessThread.UserProcessorTime and
/// System.Diagnostics.ProcessThread.PrivilegedProcessorTime.
///
[MonitoringDescription(SR.ThreadTotalProcessorTime)]
public TimeSpan TotalProcessorTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().TotalProcessorTime;
}
}
///
/// Returns the amount of time the associated thread has spent running code
/// inside the application (not the operating system core).
///
[MonitoringDescription(SR.ThreadUserProcessorTime)]
public TimeSpan UserProcessorTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().UserProcessorTime;
}
}
///
/// Returns the reason the associated thread is waiting, if any.
///
[MonitoringDescription(SR.ThreadWaitReason)]
public ThreadWaitReason WaitReason {
get {
EnsureState(State.IsNt);
if (threadInfo.threadState != ThreadState.Wait) {
throw new InvalidOperationException(SR.GetString(SR.WaitReasonUnavailable));
}
return threadInfo.threadWaitReason;
}
}
//
// METHODS
//
///
/// Helper to close a thread handle.
///
///
/// Helper to check preconditions for property access.
///
void EnsureState(State state) {
if ( ((state & State.IsLocal) != (State)0) && isRemoteMachine) {
throw new NotSupportedException(SR.GetString(SR.NotSupportedRemoteThread));
}
if ((state & State.IsNt) != (State)0) {
if (Environment.OSVersion.Platform != PlatformID.Win32NT) {
throw new PlatformNotSupportedException(SR.GetString(SR.WinNTRequired));
}
}
}
///
/// Helper to open a thread handle.
///
///
/// Resets the ideal processor so there is no ideal processor for this thread (e.g.
/// any processor is ideal).
///
[ResourceExposure(ResourceScope.None)]
[ResourceConsumption(ResourceScope.Machine, ResourceScope.Machine)]
public void ResetIdealProcessor() {
// 32 means "any processor is fine"
IdealProcessor = 32;
}
///
/// Sets which processors the associated thread is allowed to be scheduled to run on.
/// Each processor is represented as a bit: bit 0 is processor one, bit 1 is processor
/// two, etc. For example, the value 1 means run on processor one, 2 means run on
/// processor two, 3 means run on processor one or two.
///
[Browsable(false)]
public IntPtr ProcessorAffinity {
[ResourceExposure(ResourceScope.Process)]
[ResourceConsumption(ResourceScope.Process)]
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION | NativeMethods.THREAD_QUERY_INFORMATION);
if (NativeMethods.SetThreadAffinityMask(threadHandle, new HandleRef(this, value)) == IntPtr.Zero) {
throw new Win32Exception();
}
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
private ProcessThreadTimes GetThreadTimes() {
ProcessThreadTimes threadTimes = new ProcessThreadTimes();
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_QUERY_INFORMATION);
if (!NativeMethods.GetThreadTimes(threadHandle,
out threadTimes.create,
out threadTimes.exit,
out threadTimes.kernel,
out threadTimes.user)) {
throw new Win32Exception();
}
}
finally {
CloseThreadHandle(threadHandle);
}
return threadTimes;
}
///
/// Preconditions for accessing properties.
///
///
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
namespace System.Diagnostics {
using System.Threading;
using System.Runtime.InteropServices;
using System.ComponentModel;
using System.Diagnostics;
using System;
using System.Collections;
using System.IO;
using Microsoft.Win32;
using System.Security.Permissions;
using Microsoft.Win32.SafeHandles;
using System.Runtime.Versioning;
// using System.Windows.Forms;
///
///
/// Represents a Win32 thread. This can be used to obtain
/// information about the thread, such as it's performance characteristics. This is
/// returned from the System.Diagnostics.Process.ProcessThread property of the System.Diagnostics.Process component.
///
///
/// I don't understand
/// the following comment associated with the previous sentence: "property of
/// Process component " Rather than just "processTHread". There is no such
/// member on Process. Do we mean 'threads'?
///
///
[
Designer("System.Diagnostics.Design.ProcessThreadDesigner, " + AssemblyRef.SystemDesign),
HostProtection(SelfAffectingProcessMgmt=true, SelfAffectingThreading=true)
]
public class ProcessThread : Component {
//
// FIELDS
//
ThreadInfo threadInfo;
bool isRemoteMachine;
bool priorityBoostEnabled;
bool havePriorityBoostEnabled;
ThreadPriorityLevel priorityLevel;
bool havePriorityLevel;
//
// CONSTRUCTORS
//
///
/// Internal constructor.
///
///
/// Returns the base priority of the thread which is computed by combining the
/// process priority class with the priority level of the associated thread.
///
[MonitoringDescription(SR.ThreadBasePriority)]
public int BasePriority {
get {
return threadInfo.basePriority;
}
}
///
/// The current priority indicates the actual priority of the associated thread,
/// which may deviate from the base priority based on how the OS is currently
/// scheduling the thread.
///
[MonitoringDescription(SR.ThreadCurrentPriority)]
public int CurrentPriority {
get {
return threadInfo.currentPriority;
}
}
///
/// Returns the unique identifier for the associated thread.
///
[MonitoringDescription(SR.ThreadId)]
public int Id {
[ResourceExposure(ResourceScope.Process)]
get {
return threadInfo.threadId;
}
}
///
///
/// Sets the processor that this thread would ideally like to run on.
///
///
[Browsable(false)]
public int IdealProcessor {
[ResourceExposure(ResourceScope.Process)]
[ResourceConsumption(ResourceScope.Process)]
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION);
if (NativeMethods.SetThreadIdealProcessor(threadHandle, value) < 0) {
throw new Win32Exception();
}
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
///
/// Returns or sets whether this thread would like a priority boost if the user interacts
/// with user interface associated with this thread.
///
[MonitoringDescription(SR.ThreadPriorityBoostEnabled)]
public bool PriorityBoostEnabled {
get {
if (!havePriorityBoostEnabled) {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_QUERY_INFORMATION);
bool disabled = false;
if (!NativeMethods.GetThreadPriorityBoost(threadHandle, out disabled)) {
throw new Win32Exception();
}
priorityBoostEnabled = !disabled;
havePriorityBoostEnabled = true;
}
finally {
CloseThreadHandle(threadHandle);
}
}
return priorityBoostEnabled;
}
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION);
if (!NativeMethods.SetThreadPriorityBoost(threadHandle, !value))
throw new Win32Exception();
priorityBoostEnabled = value;
havePriorityBoostEnabled = true;
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
///
/// Returns or sets the priority level of the associated thread. The priority level is
/// not an absolute level, but instead contributes to the actual thread priority by
/// considering the priority class of the process.
///
[MonitoringDescription(SR.ThreadPriorityLevel)]
public ThreadPriorityLevel PriorityLevel {
get {
if (!havePriorityLevel) {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_QUERY_INFORMATION);
int value = NativeMethods.GetThreadPriority(threadHandle);
if (value == 0x7fffffff) {
throw new Win32Exception();
}
priorityLevel = (ThreadPriorityLevel)value;
havePriorityLevel = true;
}
finally {
CloseThreadHandle(threadHandle);
}
}
return priorityLevel;
}
[ResourceExposure(ResourceScope.Process)]
[ResourceConsumption(ResourceScope.Process)]
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION);
if (!NativeMethods.SetThreadPriority(threadHandle, (int)value)) {
throw new Win32Exception();
}
priorityLevel = value;
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
///
/// Returns the amount of time the thread has spent running code inside the operating
/// system core.
///
[MonitoringDescription(SR.ThreadPrivilegedProcessorTime)]
public TimeSpan PrivilegedProcessorTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().PrivilegedProcessorTime;
}
}
///
/// Returns the memory address of the function that was called when the associated
/// thread was started.
///
[MonitoringDescription(SR.ThreadStartAddress)]
public IntPtr StartAddress {
get {
EnsureState(State.IsNt);
return threadInfo.startAddress;
}
}
///
/// Returns the time the associated thread was started.
///
[MonitoringDescription(SR.ThreadStartTime)]
public DateTime StartTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().StartTime;
}
}
///
/// Returns the current state of the associated thread, e.g. is it running, waiting, etc.
///
[MonitoringDescription(SR.ThreadThreadState)]
public ThreadState ThreadState {
get {
EnsureState(State.IsNt);
return threadInfo.threadState;
}
}
///
/// Returns the amount of time the associated thread has spent utilizing the CPU.
/// It is the sum of the System.Diagnostics.ProcessThread.UserProcessorTime and
/// System.Diagnostics.ProcessThread.PrivilegedProcessorTime.
///
[MonitoringDescription(SR.ThreadTotalProcessorTime)]
public TimeSpan TotalProcessorTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().TotalProcessorTime;
}
}
///
/// Returns the amount of time the associated thread has spent running code
/// inside the application (not the operating system core).
///
[MonitoringDescription(SR.ThreadUserProcessorTime)]
public TimeSpan UserProcessorTime {
get {
EnsureState(State.IsNt);
return GetThreadTimes().UserProcessorTime;
}
}
///
/// Returns the reason the associated thread is waiting, if any.
///
[MonitoringDescription(SR.ThreadWaitReason)]
public ThreadWaitReason WaitReason {
get {
EnsureState(State.IsNt);
if (threadInfo.threadState != ThreadState.Wait) {
throw new InvalidOperationException(SR.GetString(SR.WaitReasonUnavailable));
}
return threadInfo.threadWaitReason;
}
}
//
// METHODS
//
///
/// Helper to close a thread handle.
///
///
/// Helper to check preconditions for property access.
///
void EnsureState(State state) {
if ( ((state & State.IsLocal) != (State)0) && isRemoteMachine) {
throw new NotSupportedException(SR.GetString(SR.NotSupportedRemoteThread));
}
if ((state & State.IsNt) != (State)0) {
if (Environment.OSVersion.Platform != PlatformID.Win32NT) {
throw new PlatformNotSupportedException(SR.GetString(SR.WinNTRequired));
}
}
}
///
/// Helper to open a thread handle.
///
///
/// Resets the ideal processor so there is no ideal processor for this thread (e.g.
/// any processor is ideal).
///
[ResourceExposure(ResourceScope.None)]
[ResourceConsumption(ResourceScope.Machine, ResourceScope.Machine)]
public void ResetIdealProcessor() {
// 32 means "any processor is fine"
IdealProcessor = 32;
}
///
/// Sets which processors the associated thread is allowed to be scheduled to run on.
/// Each processor is represented as a bit: bit 0 is processor one, bit 1 is processor
/// two, etc. For example, the value 1 means run on processor one, 2 means run on
/// processor two, 3 means run on processor one or two.
///
[Browsable(false)]
public IntPtr ProcessorAffinity {
[ResourceExposure(ResourceScope.Process)]
[ResourceConsumption(ResourceScope.Process)]
set {
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_SET_INFORMATION | NativeMethods.THREAD_QUERY_INFORMATION);
if (NativeMethods.SetThreadAffinityMask(threadHandle, new HandleRef(this, value)) == IntPtr.Zero) {
throw new Win32Exception();
}
}
finally {
CloseThreadHandle(threadHandle);
}
}
}
private ProcessThreadTimes GetThreadTimes() {
ProcessThreadTimes threadTimes = new ProcessThreadTimes();
SafeThreadHandle threadHandle = null;
try {
threadHandle = OpenThreadHandle(NativeMethods.THREAD_QUERY_INFORMATION);
if (!NativeMethods.GetThreadTimes(threadHandle,
out threadTimes.create,
out threadTimes.exit,
out threadTimes.kernel,
out threadTimes.user)) {
throw new Win32Exception();
}
}
finally {
CloseThreadHandle(threadHandle);
}
return threadTimes;
}
///
/// Preconditions for accessing properties.
///
///
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- DataContractSerializer.cs
- Int32Collection.cs
- TraceShell.cs
- ReadOnlyDataSource.cs
- XmlTextEncoder.cs
- WsdlWriter.cs
- XD.cs
- DbExpressionBuilder.cs
- Comparer.cs
- GridViewEditEventArgs.cs
- UseLicense.cs
- CommonDialog.cs
- Camera.cs
- GridViewSortEventArgs.cs
- CodeSnippetTypeMember.cs
- HyperLinkStyle.cs
- TextBounds.cs
- ContentType.cs
- ISCIIEncoding.cs
- InfoCardAsymmetricCrypto.cs
- ProtocolElement.cs
- XslUrlEditor.cs
- DeviceSpecific.cs
- Translator.cs
- DnsPermission.cs
- OutputScopeManager.cs
- DataBindingCollection.cs
- ConsoleEntryPoint.cs
- CompiledQueryCacheKey.cs
- EntityReference.cs
- InvalidDataException.cs
- Event.cs
- Base64Encoder.cs
- SortKey.cs
- GridViewSortEventArgs.cs
- XmlNamespaceMapping.cs
- TransformerInfoCollection.cs
- OutputScopeManager.cs
- FontClient.cs
- SQLString.cs
- TextRangeEditTables.cs
- OleDbConnectionInternal.cs
- AnnotationAuthorChangedEventArgs.cs
- DictionaryChange.cs
- DefaultObjectMappingItemCollection.cs
- ProviderSettings.cs
- GB18030Encoding.cs
- TrustLevelCollection.cs
- IResourceProvider.cs
- DecryptedHeader.cs
- MethodExpression.cs
- BufferedGraphicsContext.cs
- RealizedColumnsBlock.cs
- Hex.cs
- ZoneIdentityPermission.cs
- ServiceNotStartedException.cs
- RemotingClientProxy.cs
- NotifyIcon.cs
- CompilationLock.cs
- _PooledStream.cs
- Misc.cs
- SqlError.cs
- Expressions.cs
- DependencyStoreSurrogate.cs
- PrimaryKeyTypeConverter.cs
- HasRunnableWorkflowEvent.cs
- Util.cs
- FastEncoderWindow.cs
- WebAdminConfigurationHelper.cs
- Win32Exception.cs
- UpdatePanel.cs
- X509CertificateStore.cs
- TargetPerspective.cs
- AnimationException.cs
- AsynchronousChannelMergeEnumerator.cs
- PropertyChangedEventManager.cs
- BinaryFormatter.cs
- PropertyTabAttribute.cs
- XmlCharType.cs
- Dictionary.cs
- Variable.cs
- UriScheme.cs
- WorkflowRuntime.cs
- XmlLoader.cs
- TextProperties.cs
- SkewTransform.cs
- CodeGeneratorOptions.cs
- _BaseOverlappedAsyncResult.cs
- BitmapEffectGroup.cs
- SByteConverter.cs
- DropTarget.cs
- AccessibleObject.cs
- DataGridPagerStyle.cs
- TrackingServices.cs
- BitVec.cs
- RegexParser.cs
- VariableQuery.cs
- NullExtension.cs
- XmlArrayAttribute.cs
- Inflater.cs