Skip to content

Document Process timing properties after exit #130794

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamsitnik merged 9 commits into from
Jul 17, 2026
Merged

Document Process timing properties after exit #130794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
acdd958
Document Process timing after exit
Copilot Jul 15, 2026
d377590
Clarify Unix StartTime caching
Copilot Jul 15, 2026
802d661
Clarify exited StartTime test
Copilot Jul 15, 2026
2d17f3b
Address review feedback on Process timing docs and tests
Copilot Jul 15, 2026
8695dd1
Apply suggestions from code review
adamsitnik Jul 15, 2026
4002a12
Unify processor time XML docs using partial properties
Copilot Jul 16, 2026
f217d8d
Address Process timing doc and test feedback
Copilot Jul 16, 2026
f2fcfcf
test: stabilize Process StartTime after-exit caching test
Copilot Jul 16, 2026
bc58964
Use public terminology in StartTime XML docs
Copilot Jul 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.FreeBSD.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,7 @@ internal DateTime StartTimeCore
}
}

/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='System.Diagnostics.Process.UserProcessorTime'/> and
/// <see cref='System.Diagnostics.Process.PrivilegedProcessorTime'/>.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan TotalProcessorTime
public partial TimeSpan TotalProcessorTime
{
get
{
Expand All @@ -45,14 +37,7 @@ public TimeSpan TotalProcessorTime
}
}

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan UserProcessorTime
public partial TimeSpan UserProcessorTime
{
get
{
Expand All @@ -68,11 +53,7 @@ public TimeSpan UserProcessorTime
}
}

/// <summary>Gets the amount of time the process has spent running code inside the operating system core.</summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan PrivilegedProcessorTime
public partial TimeSpan PrivilegedProcessorTime
{
get
{
Expand Down
25 changes: 3 additions & 22 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.Linux.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@ namespace System.Diagnostics
{
public partial class Process : IDisposable
{
/// <summary>Gets the amount of time the process has spent running code inside the operating system core.</summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan PrivilegedProcessorTime
public partial TimeSpan PrivilegedProcessorTime
{
get => IsCurrentProcess ? Environment.CpuUsage.PrivilegedTime : TicksToTimeSpan(GetStat().stime);
}
Expand Down Expand Up @@ -83,15 +79,7 @@ private static DateTime BootTime
return null;
}

/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='System.Diagnostics.Process.UserProcessorTime'/> and
/// <see cref='System.Diagnostics.Process.PrivilegedProcessorTime'/>.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan TotalProcessorTime
public partial TimeSpan TotalProcessorTime
{
get
{
Expand All @@ -105,14 +93,7 @@ public TimeSpan TotalProcessorTime
}
}

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan UserProcessorTime
public partial TimeSpan UserProcessorTime
{
get => IsCurrentProcess ? Environment.CpuUsage.UserTime : TicksToTimeSpan(GetStat().utime);
}
Expand Down
25 changes: 3 additions & 22 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.OSX.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,7 @@ public partial class Process

private const int MicrosecondsToSecondsFactor = 1_000_000;

/// <summary>Gets the amount of time the process has spent running code inside the operating system core.</summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan PrivilegedProcessorTime
public partial TimeSpan PrivilegedProcessorTime
{
get
{
Expand Down Expand Up @@ -57,15 +53,7 @@ internal static string GetPathToOpenFile()
return "/usr/bin/open";
}

/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='System.Diagnostics.Process.UserProcessorTime'/> and
/// <see cref='System.Diagnostics.Process.PrivilegedProcessorTime'/>.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan TotalProcessorTime
public partial TimeSpan TotalProcessorTime
{
get
{
Expand All @@ -80,14 +68,7 @@ public TimeSpan TotalProcessorTime
}
}

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan UserProcessorTime
public partial TimeSpan UserProcessorTime
{
get
{
Expand Down
25 changes: 3 additions & 22 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.OpenBSD.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,7 @@ internal DateTime StartTimeCore
}
}

/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='System.Diagnostics.Process.UserProcessorTime'/> and
/// <see cref='System.Diagnostics.Process.PrivilegedProcessorTime'/>.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan TotalProcessorTime
public partial TimeSpan TotalProcessorTime
{
get
{
Expand All @@ -45,14 +37,7 @@ public TimeSpan TotalProcessorTime
}
}

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan UserProcessorTime
public partial TimeSpan UserProcessorTime
{
get
{
Expand All @@ -68,11 +53,7 @@ public TimeSpan UserProcessorTime
}
}

/// <summary>Gets the amount of time the process has spent running code inside the operating system core.</summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan PrivilegedProcessorTime
public partial TimeSpan PrivilegedProcessorTime
{
get
{
Expand Down
28 changes: 3 additions & 25 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.SunOS.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,15 +41,7 @@ internal DateTime StartTimeCore
return ProcessUtils.FindProgramInPath("xdg-open");
}

/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='System.Diagnostics.Process.UserProcessorTime'/> and
/// <see cref='System.Diagnostics.Process.PrivilegedProcessorTime'/>.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan TotalProcessorTime
public partial TimeSpan TotalProcessorTime
{
get
{
Expand All @@ -61,14 +53,7 @@ public TimeSpan TotalProcessorTime
}
}

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan UserProcessorTime
public partial TimeSpan UserProcessorTime
{
get
{
Expand All @@ -79,14 +64,7 @@ public TimeSpan UserProcessorTime
}
}

/// <summary>
/// Gets the amount of time the process has spent running code inside the operating
/// system core.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan PrivilegedProcessorTime
public partial TimeSpan PrivilegedProcessorTime
{
get
{
Expand Down
25 changes: 3 additions & 22 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.Windows.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,11 +192,7 @@ private DateTime ExitTimeCore
get { return GetProcessTimes().ExitTime; }
}

/// <summary>Gets the amount of time the process has spent running code inside the operating system core.</summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan PrivilegedProcessorTime
public partial TimeSpan PrivilegedProcessorTime
{
get => IsCurrentProcess ? Environment.CpuUsage.PrivilegedTime : GetProcessTimes().PrivilegedProcessorTime;
}
Expand All @@ -207,27 +203,12 @@ internal DateTime StartTimeCore
get { return GetProcessTimes().StartTime; }
}

/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='System.Diagnostics.Process.UserProcessorTime'/> and
/// <see cref='System.Diagnostics.Process.PrivilegedProcessorTime'/>.
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan TotalProcessorTime
public partial TimeSpan TotalProcessorTime
{
get => IsCurrentProcess ? Environment.CpuUsage.TotalTime : GetProcessTimes().TotalProcessorTime;
}

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public TimeSpan UserProcessorTime
public partial TimeSpan UserProcessorTime
{
get => IsCurrentProcess ? Environment.CpuUsage.UserTime : GetProcessTimes().UserProcessorTime;
}
Expand Down
70 changes: 65 additions & 5 deletions src/libraries/System.Diagnostics.Process/src/System/Diagnostics/Process.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,15 @@ public bool HasExited
}

/// <summary>Gets the time the associated process was started.</summary>
/// <remarks>
/// On Windows, if a handle to the process is available, this property can be read after the process exits.
/// On Unix, this property caches its value on first access. A cached value can be read after the process exits,
/// but accessing an uncached value after the process exits may throw <see cref="InvalidOperationException"/> when the value is unavailable.
/// </remarks>
/// <exception cref="InvalidOperationException">
/// No process is associated with this object; on Windows, there is no process handle available; or on Unix,
/// the value was not cached and is unavailable after the process exited.
/// </exception>
Comment thread
adamsitnik marked this conversation as resolved.
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
Expand All @@ -203,11 +212,11 @@ public DateTime StartTime
}
}

/// <devdoc>
/// <para>
/// Gets the time that the associated process exited.
/// </para>
/// </devdoc>
/// <summary>Gets the time that the associated process exited.</summary>
/// <exception cref="InvalidOperationException">
/// No process is associated with this object, the process has not exited,
/// or there is no process handle available.
/// </exception>
public DateTime ExitTime
{
get
Expand All @@ -222,6 +231,57 @@ public DateTime ExitTime
}
}

/// <summary>Gets the amount of time the process has spent running code inside the operating system core.</summary>
/// <remarks>
/// On Windows, if a handle to the process is available, the value can be retrieved after the process exits.
/// On Unix, the value is unavailable after the process exits.
/// </remarks>
/// <exception cref="InvalidOperationException">
/// No process is associated with this object. On Windows, there is no process handle available.
/// On Unix, the process has exited.
/// </exception>
/// <exception cref="Win32Exception">The operating system could not retrieve process timing information.</exception>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public partial TimeSpan PrivilegedProcessorTime { get; }

Comment thread
adamsitnik marked this conversation as resolved.
/// <summary>
/// Gets the amount of time the associated process has spent utilizing the CPU.
/// It is the sum of the <see cref='UserProcessorTime'/> and <see cref='PrivilegedProcessorTime'/>.
/// </summary>
/// <remarks>
/// On Windows, if a handle to the process is available, the value can be retrieved after the process exits.
/// On Unix, the value is unavailable after the process exits.
/// </remarks>
/// <exception cref="InvalidOperationException">
/// No process is associated with this object. On Windows, there is no process handle available.
/// On Unix, the process has exited.
/// </exception>
/// <exception cref="Win32Exception">The operating system could not retrieve process timing information.</exception>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public partial TimeSpan TotalProcessorTime { get; }

/// <summary>
/// Gets the amount of time the associated process has spent running code
/// inside the application portion of the process (not the operating system core).
/// </summary>
/// <remarks>
/// On Windows, if a handle to the process is available, the value can be retrieved after the process exits.
/// On Unix, the value is unavailable after the process exits.
/// </remarks>
/// <exception cref="InvalidOperationException">
/// No process is associated with this object. On Windows, there is no process handle available.
/// On Unix, the process has exited.
/// </exception>
/// <exception cref="Win32Exception">The operating system could not retrieve process timing information.</exception>
[UnsupportedOSPlatform("ios")]
[UnsupportedOSPlatform("tvos")]
[SupportedOSPlatform("maccatalyst")]
public partial TimeSpan UserProcessorTime { get; }

/// <devdoc>
/// <para>
/// Gets
Expand Down
Loading
Loading