Skip to content

Modify AvTrace call chain to use params ReadOnlySpan<object> instead of an array #9468

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
merged 15 commits into from
Apr 4, 2025
Merged

Modify AvTrace call chain to use params ReadOnlySpan<object> instead of an array #9468

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
886a02d
modify call chain from params object[] to params Span<object>
h3xds1nz Jul 25, 2024
5423841
replace arraylist with lit<object>
h3xds1nz Jul 25, 2024
9174b52
use defaultinterpolatedstringhandler instead of string concs
h3xds1nz Jul 25, 2024
5b30793
fix up conditions to be more readable
h3xds1nz Jul 25, 2024
f167a76
make the event's collection immutable
h3xds1nz Jul 25, 2024
566edde
replace the rest of the existing overloads with single params Span<ob…
h3xds1nz Jul 25, 2024
22a07eb
modify the t4 template for AvTraceMessages
h3xds1nz Jul 25, 2024
d6cde81
remove additional overloads as Roslyn will Span<object>.Empty by default
h3xds1nz Jul 25, 2024
8f762a9
fix unintentional bug in formatIndex addition
h3xds1nz Jul 25, 2024
b2b6265
fix whitespaces in Trace function
h3xds1nz Jul 26, 2024
d19d7e0
modify call-chain from Span<object> to ROS<object>, slice in AvTraceE…
h3xds1nz Jul 26, 2024
f318139
swap List<object> for array, delay array alloc, remove re-alloc
h3xds1nz Jul 26, 2024
9cc4c86
Post-merge
h3xds1nz Mar 31, 2025
799f8c1
fix t4
h3xds1nz Apr 4, 2025
a63706b
fix whitespace
h3xds1nz Apr 4, 2025
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
44 changes: 4 additions & 40 deletions eng/WpfArcadeSdk/tools/CodeGen/AvTrace/AvTraceMessages.tt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,51 +70,15 @@ namespace MS.Internal
<# } #>

/// <summary> Send a single trace output </summary>
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, params object[] parameters )
public static void Trace(TraceEventType type, AvTraceDetails traceDetails, params ReadOnlySpan<object> parameters)
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters );
}

/// <summary> These help delay allocation of object array </summary>
public static void Trace( TraceEventType type, AvTraceDetails traceDetails )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, Array.Empty<object>() );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1 } );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1, object p2 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2 } );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1, object p2, object p3 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2, p3 } );
_avTrace.Trace(type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters);
}

/// <summary> Send a singleton "activity" trace (really, this sends the same trace as both a Start and a Stop) </summary>
public static void TraceActivityItem( AvTraceDetails traceDetails, params Object[] parameters )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters );
}

/// <summary> These help delay allocation of object array </summary>
public static void TraceActivityItem( AvTraceDetails traceDetails )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, Array.Empty<object>() );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1 )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1 } );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1, object p2 )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2 } );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1, object p2, object p3 )
public static void TraceActivityItem(AvTraceDetails traceDetails, params ReadOnlySpan<object> parameters)
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2, p3 } );
_avTrace.TraceStartStop(traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters);
}

public static bool IsEnabled
Expand Down
88 changes: 8 additions & 80 deletions src/Microsoft.DotNet.Wpf/src/PresentationCore/MS/internal/Generated/AvTraceMessages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,51 +69,15 @@ public static AvTraceDetails InvokeHandlers
}

/// <summary> Send a single trace output </summary>
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, params object[] parameters )
public static void Trace(TraceEventType type, AvTraceDetails traceDetails, params ReadOnlySpan<object> parameters)
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters );
}

/// <summary> These help delay allocation of object array </summary>
public static void Trace( TraceEventType type, AvTraceDetails traceDetails )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, Array.Empty<object>() );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1 } );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1, object p2 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2 } );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1, object p2, object p3 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2, p3 } );
_avTrace.Trace(type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters);
}

/// <summary> Send a singleton "activity" trace (really, this sends the same trace as both a Start and a Stop) </summary>
public static void TraceActivityItem( AvTraceDetails traceDetails, params Object[] parameters )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters );
}

/// <summary> These help delay allocation of object array </summary>
public static void TraceActivityItem( AvTraceDetails traceDetails )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, Array.Empty<object>() );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1 )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1 } );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1, object p2 )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2 } );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1, object p2, object p3 )
public static void TraceActivityItem(AvTraceDetails traceDetails, params ReadOnlySpan<object> parameters)
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2, p3 } );
_avTrace.TraceStartStop(traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters);
}

public static bool IsEnabled
Expand Down Expand Up @@ -252,51 +216,15 @@ public static AvTraceDetails AnimateStorageValidationNoLongerFailing
}

/// <summary> Send a single trace output </summary>
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, params object[] parameters )
public static void Trace(TraceEventType type, AvTraceDetails traceDetails, params ReadOnlySpan<object> parameters)
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters );
}

/// <summary> These help delay allocation of object array </summary>
public static void Trace( TraceEventType type, AvTraceDetails traceDetails )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, Array.Empty<object>() );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1 } );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1, object p2 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2 } );
}
public static void Trace( TraceEventType type, AvTraceDetails traceDetails, object p1, object p2, object p3 )
{
_avTrace.Trace( type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2, p3 } );
_avTrace.Trace(type, traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters);
}

/// <summary> Send a singleton "activity" trace (really, this sends the same trace as both a Start and a Stop) </summary>
public static void TraceActivityItem( AvTraceDetails traceDetails, params Object[] parameters )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters );
}

/// <summary> These help delay allocation of object array </summary>
public static void TraceActivityItem( AvTraceDetails traceDetails )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, Array.Empty<object>() );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1 )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1 } );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1, object p2 )
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2 } );
}
public static void TraceActivityItem( AvTraceDetails traceDetails, object p1, object p2, object p3 )
public static void TraceActivityItem(AvTraceDetails traceDetails, params ReadOnlySpan<object> parameters)
{
_avTrace.TraceStartStop( traceDetails.Id, traceDetails.Message, traceDetails.Labels, new object[] { p1, p2, p3 } );
_avTrace.TraceStartStop(traceDetails.Id, traceDetails.Message, traceDetails.Labels, parameters);
}

public static bool IsEnabled
Expand Down
35 changes: 11 additions & 24 deletions src/Microsoft.DotNet.Wpf/src/PresentationCore/System/Windows/EventRoute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,31 +168,26 @@ private void InvokeHandlersImpl(object source, RoutedEventArgs args, bool reRais
args.Source=newSource;
}
}

// Invoke listeners

var traceRoutedEventIsEnabled = TraceRoutedEvent.IsEnabled;
if ( traceRoutedEventIsEnabled )
bool traceRoutedEventIsEnabled = TraceRoutedEvent.IsEnabled;
if (traceRoutedEventIsEnabled)
{
_traceArguments ??= new object[3];
_traceArguments[0] = _routeItemList[i].Target;
_traceArguments[1] = args;
_traceArguments[2] = BooleanBoxes.Box(args.Handled);
TraceRoutedEvent.Trace(
TraceEventType.Start,
TraceRoutedEvent.InvokeHandlers,
_traceArguments);
_routeItemList[i].Target, args, BooleanBoxes.Box(args.Handled));
}

_routeItemList[i].InvokeHandler(args);

if( traceRoutedEventIsEnabled )
if (traceRoutedEventIsEnabled)
{
_traceArguments[2] = BooleanBoxes.Box(args.Handled);
TraceRoutedEvent.Trace(
TraceEventType.Stop,
TraceRoutedEvent.InvokeHandlers,
_traceArguments);
_routeItemList[i].Target, args, BooleanBoxes.Box(args.Handled));
}


Expand Down Expand Up @@ -243,29 +238,24 @@ private void InvokeHandlersImpl(object source, RoutedEventArgs args, bool reRais
}


var traceRoutedEventIsEnabled = TraceRoutedEvent.IsEnabled;
if ( traceRoutedEventIsEnabled )
bool traceRoutedEventIsEnabled = TraceRoutedEvent.IsEnabled;
if (traceRoutedEventIsEnabled)
{
_traceArguments ??= new object[3];
_traceArguments[0] = _routeItemList[i].Target;
_traceArguments[1] = args;
_traceArguments[2] = BooleanBoxes.Box(args.Handled);
TraceRoutedEvent.Trace(
TraceEventType.Start,
TraceRoutedEvent.InvokeHandlers,
_traceArguments);
_routeItemList[i].Target, args, BooleanBoxes.Box(args.Handled));
}

// Invoke listeners
_routeItemList[i].InvokeHandler(args);

if (traceRoutedEventIsEnabled)
{
_traceArguments[2] = BooleanBoxes.Box(args.Handled);
TraceRoutedEvent.Trace(
TraceEventType.Stop,
TraceRoutedEvent.InvokeHandlers,
_traceArguments);
_routeItemList[i].Target, args, BooleanBoxes.Box(args.Handled));
}

}
Expand Down Expand Up @@ -532,9 +522,6 @@ internal void Clear()
// Stores Source Items for separated trees
private FrugalStructList<SourceItem> _sourceItemList;

// Stores arguments that are passed to TraceRoutedEvent.Trace (to reduce allocations)
private object[] _traceArguments;

#endregion Data
}
}
Expand Down
Loading