CHANGE: Use ProfilerMarker in place of Profiler based on Unity version and presence of com.unity.profiling.core package (#1970)

* Change instances of Profiler.BeginSample with ProfilerMarkers where possible to enable capturing of data from ProfilerRecorders.

* Update to the minimum editor version for the com.unity.profiling package.

* Wrap ifdef logic into a profiler class to avoid sprinkling code with them.

* revert change to analyze config.

* Remove unused imports. Update changelog to better reflect changes.

* Use m_Name instead of name.

* Update member names to reflect coding conventions.

* Use the Input ProfilerCategory for the profiler Markers.

Author: surfnerd

Packages/com.unity.inputsystem/CHANGELOG.md

@@ -10,6 +10,9 @@ however, it has to be formatted properly to pass verification tests.
 
 ## [Unreleased] - yyyy-mm-dd
 
+### Changed
+- Use `ProfilerMarker` instead of `Profiler.BeginSample` and `Profiler.EndSample` when appropriate to enable recording of profiling data.
+
 ## [1.10.0] - 2024-07-24
 
 ### Fixed

Packages/com.unity.inputsystem/InputSystem/Actions/InputActionState.cs

@@ -6,8 +6,10 @@
 using Unity.Collections.LowLevel.Unsafe;
 using UnityEngine.InputSystem.Controls;
 using UnityEngine.InputSystem.LowLevel;
+using UnityEngine.InputSystem.Profiler;
 using UnityEngine.InputSystem.Utilities;
-using UnityEngine.Profiling;
+
+using ProfilerMarker = Unity.Profiling.ProfilerMarker;
 
 ////TODO: now that we can bind to controls by display name, we need to re-resolve controls when those change (e.g. when the keyboard layout changes)
 
@@ -122,6 +124,9 @@ internal unsafe class InputActionState : IInputStateChangeMonitor, ICloneable, I
         private InputEventPtr m_CurrentlyProcessingThisEvent;
         private Action m_OnBeforeUpdateDelegate;
         private Action m_OnAfterUpdateDelegate;
+        private static readonly InputProfilerMarker k_InputInitialActionStateCheckMarker = new InputProfilerMarker("InitialActionStateCheck");
+        private static readonly InputProfilerMarker k_InputActionResolveConflictMarker = new InputProfilerMarker("InputActionResolveConflict");
+        private static readonly InputProfilerMarker k_InputActionCallbackMarker = new InputProfilerMarker("InputActionCallback");
 
         /// <summary>
         /// Initialize execution state with given resolved binding information.
@@ -1257,7 +1262,7 @@ private void OnBeforeInitialUpdate()
             // Remove us from the callback as the processing we're doing here is a one-time thing.
             UnhookOnBeforeUpdate();
 
-            Profiler.BeginSample("InitialActionStateCheck");
+            k_InputInitialActionStateCheckMarker.Begin();
 
             // Use current time as time of control state change.
             var time = InputState.currentTime;
@@ -1315,7 +1320,7 @@ private void OnBeforeInitialUpdate()
             }
             manager.FireStateChangeNotifications();
 
-            Profiler.EndSample();
+            k_InputInitialActionStateCheckMarker.End();
         }
 
         // Called from InputManager when one of our state change monitors has fired.
@@ -1657,7 +1662,7 @@ private bool IsConflictingInput(ref TriggerState trigger, int actionIndex)
             // Anything below here we want to avoid executing whenever we can.
             Debug.Assert(actionState->mayNeedConflictResolution);
 
-            Profiler.BeginSample("InputActionResolveConflict");
+            k_InputActionResolveConflictMarker.Begin();
 
             // We take a local copy of this value, so we can change it to use the starting control of composites
             // for simpler conflict resolution (so composites always use the same value), but still report the actually
@@ -1691,7 +1696,7 @@ private bool IsConflictingInput(ref TriggerState trigger, int actionIndex)
             if (actionStateControlIndex == kInvalidIndex)
             {
                 actionState->magnitude = trigger.magnitude;
-                Profiler.EndSample();
+                k_InputActionResolveConflictMarker.End();
                 return false;
             }
 
@@ -1720,7 +1725,7 @@ private bool IsConflictingInput(ref TriggerState trigger, int actionIndex)
 
                 // Keep recorded magnitude in action state up to date.
                 actionState->magnitude = trigger.magnitude;
-                Profiler.EndSample();
+                k_InputActionResolveConflictMarker.End();
                 return false;
             }
 
@@ -1734,7 +1739,7 @@ private bool IsConflictingInput(ref TriggerState trigger, int actionIndex)
                 // actuation as we didn't have the highest actuation anyway.
                 if (!isControlCurrentlyDrivingTheAction)
                 {
-                    Profiler.EndSample();
+                    k_InputActionResolveConflictMarker.End();
                     ////REVIEW: should we *count* actuations instead? (problem is that then we have to reliably determine when a control
                     ////        first actuates; the current solution will occasionally run conflict resolution when it doesn't have to
                     ////        but won't require the extra bookkeeping)
@@ -1749,7 +1754,7 @@ private bool IsConflictingInput(ref TriggerState trigger, int actionIndex)
                 {
                     // Keep recorded magnitude in action state up to date.
                     actionState->magnitude = trigger.magnitude;
-                    Profiler.EndSample();
+                    k_InputActionResolveConflictMarker.End();
                     return false;
                 }
 
@@ -1868,12 +1873,12 @@ private bool IsConflictingInput(ref TriggerState trigger, int actionIndex)
                     actionState->bindingIndex = bindingWithHighestActuation;
                     actionState->magnitude = highestActuationLevel;
 
-                    Profiler.EndSample();
+                    k_InputActionResolveConflictMarker.End();
                     return false;
                 }
             }
 
-            Profiler.EndSample();
+            k_InputActionResolveConflictMarker.End();
 
             // If we're not really effecting any change on the action, ignore the control state change.
             // NOTE: We may be looking at a control here that points in a completely direction, for example, even
@@ -2520,7 +2525,7 @@ private void CallActionListeners(int actionIndex, InputActionMap actionMap, Inpu
                 m_ActionIndex = actionIndex,
             };
 
-            Profiler.BeginSample("InputActionCallback");
+            k_InputActionCallbackMarker.Begin();
 
             // Global callback goes first.
             var action = context.action;
@@ -2552,7 +2557,7 @@ private void CallActionListeners(int actionIndex, InputActionMap actionMap, Inpu
             // Run callbacks (if any) on action map.
             DelegateHelpers.InvokeCallbacksSafe(ref callbacksOnMap, context, callbackName, actionMap);
 
-            Profiler.EndSample();
+            k_InputActionCallbackMarker.End();
         }
 
         private object GetActionOrNoneString(ref TriggerState trigger)

Packages/com.unity.inputsystem/InputSystem/Devices/Touchscreen.cs

@@ -6,7 +6,7 @@
 using UnityEngine.InputSystem.Layouts;
 using UnityEngine.InputSystem.LowLevel;
 using UnityEngine.InputSystem.Utilities;
-using UnityEngine.Profiling;
+using UnityEngine.InputSystem.Profiler;
 
 ////TODO: property that tells whether a Touchscreen is multi-touch capable
 
@@ -521,6 +521,10 @@ public class Touchscreen : Pointer, IInputStateCallbackReceiver, IEventMerger, I
         /// </remarks>
         public ReadOnlyArray<TouchControl> touches { get; protected set; }
 
+
+        static readonly InputProfilerMarker k_TouchscreenUpdateMarker = new InputProfilerMarker("Touchscreen.OnNextUpdate");
+        static readonly InputProfilerMarker k_TouchAllocateMarker = new InputProfilerMarker("TouchAllocate");
+
         protected TouchControl[] touchControlArray
         {
             get => touches.m_Array;
@@ -607,7 +611,7 @@ protected override void FinishSetup()
 
         protected new unsafe void OnNextUpdate()
         {
-            Profiler.BeginSample("Touchscreen.OnNextUpdate");
+            k_TouchscreenUpdateMarker.Begin();
 
             ////TODO: early out and skip crawling through touches if we didn't change state in the last update
             ////      (also obsoletes the need for the if() check below)
@@ -634,7 +638,7 @@ protected override void FinishSetup()
             if (primaryTouchState->tapCount > 0 && InputState.currentTime >= primaryTouchState->startTime + s_TapTime + s_TapDelayTime)
                 InputState.Change(primaryTouch.tapCount, (byte)0);
 
-            Profiler.EndSample();
+            k_TouchscreenUpdateMarker.End();
         }
 
         /// <summary>
@@ -657,7 +661,7 @@ protected override void FinishSetup()
                 return;
             }
 
-            Profiler.BeginSample("TouchAllocate");
+            k_TouchAllocateMarker.Begin();
 
             // For performance reasons, we read memory here directly rather than going through
             // ReadValue() of the individual TouchControl children. This means that Touchscreen,
@@ -820,15 +824,15 @@ protected override void FinishSetup()
                             InputState.Change(touches[i], ref newTouchState, eventPtr: eventPtr);
                         }
 
-                        Profiler.EndSample();
+                        k_TouchAllocateMarker.End();
                         return;
                     }
                 }
 
                 // Couldn't find an entry. Either it was a touch that we previously ran out of available
                 // entries for or it's an event sent out of sequence. Ignore the touch to be consistent.
 
-                Profiler.EndSample();
+                k_TouchAllocateMarker.End();
                 return;
             }
 
@@ -863,7 +867,7 @@ protected override void FinishSetup()
 
                     InputState.Change(touches[i], ref newTouchState, eventPtr: eventPtr);
 
-                    Profiler.EndSample();
+                    k_TouchAllocateMarker.End();
                     return;
                 }
             }
@@ -873,7 +877,7 @@ protected override void FinishSetup()
             // NOTE: Getting here means we're having fewer touch entries than the number of concurrent touches supported
             //       by the backend (or someone is simply sending us nonsense data).
 
-            Profiler.EndSample();
+            k_TouchAllocateMarker.End();
         }
 
         void IInputStateCallbackReceiver.OnNextUpdate()

Packages/com.unity.inputsystem/InputSystem/Editor/Internal/InputControlTreeView.cs

@@ -4,7 +4,7 @@
 using System.Linq;
 using UnityEditor.IMGUI.Controls;
 using UnityEngine.InputSystem.LowLevel;
-using UnityEngine.Profiling;
+using UnityEngine.InputSystem.Profiler;
 
 ////TODO: make control values editable (create state events from UI and pump them into the system)
 
@@ -23,6 +23,8 @@ internal class InputControlTreeView : TreeView
         public byte[][] multipleStateBuffers;
         public bool showDifferentOnly;
 
+        static readonly InputProfilerMarker k_InputBuildControlTreeMarker = new InputProfilerMarker("BuildControlTree");
+
         public static InputControlTreeView Create(InputControl rootControl, int numValueColumns, ref TreeViewState treeState, ref MultiColumnHeaderState headerState)
         {
             if (treeState == null)
@@ -136,14 +138,14 @@ private InputControlTreeView(InputControl root, TreeViewState state, MultiColumn
 
         protected override TreeViewItem BuildRoot()
         {
-            Profiler.BeginSample("BuildControlTree");
+            k_InputBuildControlTreeMarker.Begin();
 
             var id = 1;
 
             // Build tree from control down the control hierarchy.
             var rootItem = BuildControlTreeRecursive(m_RootControl, 0, ref id);
 
-            Profiler.EndSample();
+            k_InputBuildControlTreeMarker.End();
 
             // Wrap root control in invisible item required by TreeView.
             return new TreeViewItem

Packages/com.unity.inputsystem/InputSystem/Editor/Internal/InputEventTreeView.cs

@@ -4,7 +4,7 @@
 using UnityEditor.IMGUI.Controls;
 using UnityEngine.InputSystem.LowLevel;
 using UnityEditor;
-using UnityEngine.Profiling;
+using UnityEngine.InputSystem.Profiler;
 
 ////FIXME: this performs horribly; the constant rebuilding on every single event makes the debug view super slow when device is noisy
 
@@ -23,6 +23,7 @@ internal class InputEventTreeView : TreeView
     {
         private readonly InputEventTrace m_EventTrace;
         private readonly InputControl m_RootControl;
+        private static readonly InputProfilerMarker k_InputEventTreeBuildRootMarker = new InputProfilerMarker("InputEventTreeView.BuildRoot");
 
         private enum ColumnId
         {
@@ -177,7 +178,7 @@ private void PopUpStateWindow(InputEventPtr eventPtr)
 
         protected override TreeViewItem BuildRoot()
         {
-            Profiler.BeginSample("InputEventTreeView.BuildRoot");
+            k_InputEventTreeBuildRootMarker.Begin();
 
             var root = new TreeViewItem
             {
@@ -217,7 +218,7 @@ protected override TreeViewItem BuildRoot()
                 root.children.Reverse();
             }
 
-            Profiler.EndSample();
+            k_InputEventTreeBuildRootMarker.End();
             return root;
         }
 

Packages/com.unity.inputsystem/InputSystem/Events/InputEventTrace.cs

@@ -6,7 +6,7 @@
 using Unity.Collections;
 using Unity.Collections.LowLevel.Unsafe;
 using UnityEngine.InputSystem.Layouts;
-using UnityEngine.Profiling;
+using UnityEngine.InputSystem.Profiler;
 
 namespace UnityEngine.InputSystem.LowLevel
 {
@@ -27,6 +27,7 @@ namespace UnityEngine.InputSystem.LowLevel
     public sealed unsafe class InputEventTrace : IDisposable, IEnumerable<InputEventPtr>
     {
         private const int kDefaultBufferSize = 1024 * 1024;
+        private static readonly InputProfilerMarker k_InputEvenTraceMarker = new InputProfilerMarker("InputEventTrace");
 
         /// <summary>
         /// If <see name="recordFrameMarkers"/> is enabled, an <see cref="InputEvent"/> with this <see cref="FourCC"/>
@@ -811,7 +812,7 @@ private void OnInputEvent(InputEventPtr inputEvent, InputDevice device)
             if (bytesNeeded > m_MaxEventBufferSize)
                 return;
 
-            Profiler.BeginSample("InputEventTrace");
+            k_InputEvenTraceMarker.Begin();
 
             if (m_EventBufferTail == default)
             {
@@ -837,7 +838,7 @@ private void OnInputEvent(InputEventPtr inputEvent, InputDevice device)
 
                     if (newBufferSize < bytesNeeded)
                     {
-                        Profiler.EndSample();
+                        k_InputEvenTraceMarker.End();
                         return;
                     }
 
@@ -936,7 +937,7 @@ private void OnInputEvent(InputEventPtr inputEvent, InputDevice device)
                 DelegateHelpers.InvokeCallbacksSafe(ref m_EventListeners, new InputEventPtr((InputEvent*)buffer),
                     "InputEventTrace.onEvent");
 
-            Profiler.EndSample();
+            k_InputEvenTraceMarker.End();
         }
 
         private class Enumerator : IEnumerator<InputEventPtr>