1 #ifndef DALI_INTERNAL_BASE_PERFORMANCE_INTERFACE_H
2 #define DALI_INTERNAL_BASE_PERFORMANCE_INTERFACE_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
31 * Abstract Performance Interface.
32 * Used by the Adaptor to store performance metrics.
35 class PerformanceInterface
39 typedef unsigned short ContextId; ///< Type to represent a context ID
42 * bitmask of statistics logging options.
43 * Used for output data like min/max/average time spent in event, update,render and custom tasks.
45 * Event, min 0.04 ms, max 5.27 ms, total (0.1 secs), avg 0.28 ms, std dev 0.73 ms
46 * Update, min 0.29 ms, max 0.91 ms, total (0.5 secs), avg 0.68 ms, std dev 0.15 ms
47 * Render, min 0.33 ms, max 0.97 ms, total (0.6 secs), avg 0.73 ms, std dev 0.17 ms
48 * TableViewInit, min 76.55 ms, max 76.55 ms, total (0.1 secs), avg 76.55 ms, std dev 0.00 ms
50 enum StatisticsLogOptions
53 LOG_EVERYTHING = 1 << 0, ///< Bit 0 (1), log all statistics to the DALi log
54 LOG_UPDATE_RENDER = 1 << 1, ///< Bit 1 (2), log update and render statistics to the DALi log
55 LOG_EVENT_PROCESS = 1 << 2, ///< Bit 2 (4), log event task statistics to the DALi log
56 LOG_CUSTOM_MARKERS = 1 << 3, ///< Bit 3 (8), log custom marker statistics to the DALi log
60 * bitmask of time stamp output options.
61 * E.g. DALI_PERFORMANCE_TIMESTAMP_OUTPUT = 1 dali-demo
62 * Used for logging out time stamped markers for detailed analysis (see MarkerType, for the markers logged)
63 * Typical output would look like:
64 * 379.059025 (seconds), V_SYNC
65 * 379.059066 (seconds), UPDATE_START
66 * 379.059747 (seconds), UPDATE_END
67 * 379.059820 (seconds), RENDER_START
68 * 379.060708 (seconds), RENDER_END
69 * 379.075795 (seconds), V_SYNC
70 * 379.076444 (seconds), MY_CUSTOM_MARKER_START ( customer marker using PerformanceLogger public API).
71 * 379.077353 (seconds), MY_CUSTOM_MARKER_END ( customer marker using PerformanceLogger public API).
75 NO_TIME_STAMP_OUTPUT = 0,
76 OUTPUT_DALI_LOG = 1 << 0, ///< Bit 0 (1), log markers to DALi log
77 OUTPUT_KERNEL_TRACE = 1 << 1, ///< Bit 1 (2), log makers to kernel trace
78 OUTPUT_SYSTEM_TRACE = 1 << 2, ///< Bit 2 (4), log markers to system trace
79 OUTPUT_NETWORK = 1 << 3, ///< Bit 3 (8), log markers to network client
83 * enum for difference performance markers.
84 * Please modify the name lookup table in performance-interface.cpp
85 * file if adding new markers (the order must match one to one).
89 VSYNC = 0, ///< V-Sync
90 UPDATE_START , ///< Update start
91 UPDATE_END , ///< Update end
92 RENDER_START , ///< Render start
93 RENDER_END , ///< Render end
94 SWAP_START , ///< SwapBuffers Start
95 SWAP_END , ///< SwapBuffers End
96 PROCESS_EVENTS_START, ///< Process events start (e.g. touch event)
97 PROCESS_EVENTS_END, ///< Process events end
98 PAUSED , ///< Pause start
99 RESUME , ///< Resume start
100 START , ///< The start of custom tracking
101 END ///< The end of custom tracking
107 PerformanceInterface() {}
112 virtual ~PerformanceInterface() {};
115 * @brief Add a new context with a given name
117 * @param[in] name The name of the context
118 * @return Return the unique id for this context
120 virtual ContextId AddContext( const char* name ) = 0;
123 * @brief Remove a context from use
125 * @param[in] contextId The ID of the context to remove
127 virtual void RemoveContext( ContextId contextId ) = 0;
130 * @brief Add a performance marker
131 * This function can be called from ANY THREAD.
132 * The default context 0 Event/Update/Render is assumed.
133 * @param[in] markerType performance marker type
135 virtual void AddMarker( MarkerType markerType ) = 0;
138 * @brief Add a performance marker for a used defined context
139 * This function can be called from ANY THREAD.
140 * @param[in] markerType performance marker type
141 * @param[in] contextId The context of the marker. This must be one generated by AddContext.
143 virtual void AddMarker( MarkerType markerType, ContextId contextId ) = 0;
146 * @brief Set the logging level and frequency
147 * @param[in] StatisticsLogOptions 0 = disabled, >0 bitmask of StatisticsLogOptions
148 * @param[in] timeStampOutput 0 = disabled, > 0 bitmask of TimeStampOutput options.
149 * @param[in] logFrequency how often to log out in seconds
151 virtual void SetLogging( unsigned int statisticsLogOptions, unsigned int timeStampOutput, unsigned int logFrequency) = 0;
154 * @brief Set the logging frequency for an individual context
156 * @param[in] logFrequency how often to log out in seconds
158 virtual void SetLoggingFrequency( unsigned int logFrequency, ContextId contextId ) = 0;
161 * @brief Set logging on or off for a particular context
163 * @param[in] enable Enable logging or not
164 * @param[in] contextId The id of the context to log. This must be one generated by AddContext.
166 virtual void EnableLogging( bool enable, ContextId contextId ) = 0;
170 // Undefined copy constructor.
171 PerformanceInterface( const PerformanceInterface& );
173 // Undefined assignment operator.
174 PerformanceInterface& operator=( const PerformanceInterface& );
178 } // namespace Internal
180 } // namespace Adaptor