RTX MiniTutorial APPLICATION PROFILING USING RTX TIME VIEW

Transcription

1 RTX MiniTutorial APPLICATION PROFILING USING RTX TIME VIEW

2 Copyright by IntervalZero, Inc. All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means, graphic, electronic, or mechanical, including photocopying, and recording or by any information storage or retrieval system without the prior written permission of IntervalZero, Inc. unless such copying is expressly permitted by federal copyright law. While every effort has been made to ensure the accuracy and completeness of all information in this document, IntervalZero, Inc. assumes no liability to any party for any loss or damage caused by errors or omissions or by statements of any kind in this document, its updates, supplements, or special editions, whether such errors, omissions, or statements result from negligence, accident, or any other cause. IntervalZero, Inc. further assumes no liability arising out of the application or use of any product or system described herein; nor any liability for incidental or consequential damages arising from the use of this document. IntervalZero, Inc. disclaims all warranties regarding the information contained herein, whether expressed, implied or statutory, including implied warranties of merchantability or fitness for a particular purpose. IntervalZero, Inc. reserves the right to make changes to this document or to the products described herein without further notice. Microsoft, MS, and Win32 are registered trademarks and Windows 7, Windows Vista, Windows XP, and Windows Server 2003 are trademarks of Microsoft Corporation. All other companies and product names may be trademarks or registered trademarks of their respective holders. MiniTutorial: Application Profiling Using RTX Time View IZ-DOC-X April Fifth Avenue Fourth Floor Waltham, MA Phone:

3 Contents Overview 1 Checking System Setup 1 Check for Supported Environment 1 Check Subsystem Status 1 Location of RTX Time View 1 Location of TimeDoctor 2 Preparing to Run Your Application 3 Select the Application 3 Using RTX Time View to Capture Data 4 Running the RTSS Application 7 Displaying RTX Time View Data as Text 9 Preparing to Use TimeDoctor 12 Converting RTX Time View Data to TimeDoctor Input 13 Displaying RTX Time View Data as Graphs using TimeDoctor 14 Resources 18 i

4 Overview IntervalZero s RTX software includes the RTX Time View real-time event tracing tool that allows you to efficiently capture the execution sequence of threads within RTX. The output from RTX Time View can either be displayed as a text file, or fed into the TimeDoctor utility, which will create activity graphs that can be used to evaluate performance. This MiniTutorial will cover: Checking System Setup Preparing Your Working Environment Using RTX Time View to Capture Data Running the RTSS Application Displaying RTX Time View Data as Text Preparing to use TimeDoctor Converting RTX Time View Data to TimeDoctor Input Displaying RTX Time View Data as Graphs using TimeDoctor Checking System Setup Check for Supported Environment To ensure you are running in a supported environment, please read the section Preparing your RTX Environment in the RTX Getting Started Guide available from the RTX Product documentation: Check Subsystem Status Before running or debugging any of the programs, ensure that the real-time subsystem is up by checking the Control tab in the RTX properties control panel. Get there by selecting: Start > All Programs > IntervalZero > RTX 2012 > RTX Properties Control Location of RTX Time View RTX Time View is included with RTX and available by selecting IntervalZero > RTX 2012 > Tools > RTX Time View from the Start menu. IZ-DOC-X Overview

5 Location of TimeDoctor TimeDoctor is an Open Source Software (OSS) project and needs to be installed on your local host system, as described later in this document. IZ-DOC-X Overview

6 Preparing to Run Your Application Select the Application To make use of this tutorial, first select an application to evaluate. This tutorial will use the mutex sharing example available in the directory <RTXDIR>\samples\MutexSharingTest directory, where the default value of <RTXDIR> is C:\Program Files\IntervalZero\RTX. NOTE: The MutexSharing application uses the RtTraceEvent function. RtTraceEvent allows user defined trace events to be added to an application. A user defined trace event is useful as a trigger to determine when TimeView data capture will begin. Prepare your working environment: 1. Create a working directory, such as C:\samples\rtx. 2. Copy files from the RTX sample directory to your working directory. For example, copy files from: <RTXDIR>\samples\MutexSharingTest to C:\samples\rtx\MutexSharingTest 3. Open Visual Studio and build an RTSSRelease configuration for your application. a. Select Microsoft Visual Studio 2008 from the Start menu. b. Select Open > Project/Solution... from the Microsoft Visual Studio File pulldown menu and then open the MutexSharingTest.sln solution located in your working directory. c. Ensure that RTSSRelease is selected as the current configuration and then select Rebuild Solution from the Build pull-down menu. d. Exit out of the Microsoft Visual Studio environment. If you used the same working directory suggested in this example, you should now have the directory and file listed below. C:\Samples\RTX\MutexSharingTest\RTSSRelease\MutexSharing.rtss 4. Open a command prompt, or Visual Studio command prompt, and set the current directory to the directory holding your RTSS executable code. In our example, this would be done using the command: cd C:\Samples\RTX\MutexSharingTest\RTSSRelease. Keep the command prompt open and continue with this tutorial. IZ-DOC-X Preparing to Run Your Application

7 Using RTX Time View to Capture Data RTX Time View is a real-time event tracing tool that allows you to efficiently capture and display the execution sequence of threads within RTX. RTX Time View is designed to minimize the intrusion on the realtime task being monitored. Its graphical user interface provides both a Data Collection Setup Wizard and a data viewer. Once RTX Time View has been configured and started it will create a detailed log of system events. This log file can be converted to a text format or to one that is acceptable input to the TimeDoctor utility. Events that can be captured by RTX Time View include (but are not limited to): Thread Context Switches Timer Interrupts Interrupts (device and exception) Object events (creation, open, wait, close, destroy) Semaphore events (create, open, release) Mutex events (create, open, release) Shared memory, timer, exception and device events Service Request Interrupt (SRI) events Thread critical section and state changes Memory usage (map, allocate, free, etc.) File calls (create, read, write, delete) Configure and start RTX Time View data capture 1. Start RTX Time View by selecting IntervalZero > RTX 2012 > Tools > RTX Time View from the Start menu and then configure data collection using the steps below. NOTE: If you get an error about RTX Time View not working, check the Control tab in the RTX Propeties control panel to ensure that the RTX subsystem is started. IZ-DOC-X Using RTX Time View to Capture Data

8 2. Click the Log button to configure and start logging. 3. The default log file name is untitledn.rtv, which is saved in the C:\Documents and Settings\All Users\Application Data\RTX\TimeViewLogs directory. Enter a more descriptive name and then click Next. NOTE: If the file already exists, a warning pop-up window will appear, asking if you want to overwrite the existing file. You can overwrite your previous file, or replace the text NOW in the filename with the current date or time. IZ-DOC-X Using RTX Time View to Capture Data

9 4. The Trigger Setup window allows you to select an event that will trigger the start of data collection and logging. Logging can begin as a result of almost any type of event. For example, you can trigger on deterministic calls such as cancel timer, raise event or suspend thread, internal activity such as object creation or deletion and non-deterministic events such as memory creation, thread exit and critical section initialization. The MutexSharing application used for this tutorial calls RtTraceEvent, to create user event 1. Click the Specific user event id radio button and then enter 1 as the user event id. Ensure that you will trigger on Occurrence 1 of this event and then click Next to continue. 5. In the Data Capture Setup window: a. Type as the number of events that will be captured. b. Ensure that Stop when number of events reached is selected. c. Type 1000 as the number of milliseconds between data log writes. d. Move the slide bar to 5 to indicate that 5% of the events that occurred before the trigger event should be saved. e. Select Typical plus Internal data filter, which will include all items except for file calls. IZ-DOC-X Using RTX Time View to Capture Data

10 6. When you are ready to launch the application that will be monitored, click Start. This will allow RTX Time View to ensure that the subsystem is ready to capture data for any subsequent processes. RTX Time View will display a window indicating that data is being logged. Once RTX Time View is running, start any rtss executable files that you want to evaluate, as shown in the next section. Running the RTSS Application Once RTX Time View has been configured and started, data collection will begin as soon as the trigger event has occurred. This tutorial uses the RTX sample program MutexSharing.c. IZ-DOC-X Using RTX Time View to Capture Data

11 The MutexSharing application creates three threads which share mutexes. Each thread loops a number of times to request ownership of a mutex, calls the DoSomeWork function, and then release the mutex. The DoSomeWork function begins by saving current thread state information that includes current time, loop iteration and thread priority. It then performs some CPU activity before returning. When all loops have completed, information in the thread state mutex is displayed on the RTX server console. NOTE: For a detailed description of the MutexSharing.c program, read the inline comments included with the source code. You should still have a command prompt window open, with the default directory set to your working directory. From this command prompt window, follow the steps listed below. Steps: 1. Run your RTSS application using the rtssrun comment, as shown below: > rtssrun MutexSharing.rtss The MutexSharing application prints a startup status, loops through thread activity and then prints test results on the RtxServer console. Output includes a timestamp, process ID, thread ID and thread priority collected each time a thread performed work. Leave this window open, or save the RTX server console data to compare with information you will later see using the RTX Time View and TimeDoctor tools. IZ-DOC-X Using RTX Time View to Capture Data

12 NOTE: If Run until stopped had been selected in the RTX Time View Data Capture Setup, data collection would continue until you click the Stop button in the RTX Time View data log window. NOTE: If a data overflow errors occurs during data collection, decrease the amount of time between each data log write. 2. Since a fixed number of events to capture was specified, then after all events have been stored, the RTX Time View main window will reappear. Displaying RTX Time View Data as Text Once RTX Time View data has been collected, you can view it in text form using RTX Time View. Steps: 1. After data logging has been stopped, click the View button in the main RTX Time View window. IZ-DOC-X Using RTX Time View to Capture Data

13 2. Select the RTX Time View file from the default C:\Documents and Settings\All Users\Application Data\RTX\TimeViewLogs directory and then click Open. The collected data will be converted from the RTX Time View (.rtv) log format to text format. The collected data will then be displayed using the Notepad application. File name : c:\documents and settings\all users\application data \rtx\timeviewlogs\mutexsharingstats0934am.txt **** Trace Conditions : System clockrate : 2262 MHz Number of events to capture :50000 Trigger event: USER_EVENT 1 Its occurence for trigger : 1 Percent of Events to be Captured Before Trigger : 5 Event group(s) being captured : Context Switch Timer Interrupt Device Interrupt and Exception Interrupt User Events Semaphore Calls Mutex Calls IPC Event Calls Timer System Calls Exception System Calls Resume, Suspend, Set Priority, and WFSO Calls Memory, Heap and Other Non-deterministic Calls IZ-DOC-X Using RTX Time View to Capture Data

14 Object Management Device System Calls Group(s) to display : Active processes and threads: NT Process: Thread ID = 0 Pid = 0: Thread Id = 2 Thread Id = 3 Thread Id = 15 Thread Id = 16 Pid = 1: Thread Id = 23 Pid = 2: Thread Id = 24 Thread Id = 25 Thread Id = 26 Thread Id = 27 Thread Id = 28 END Active processes and threads: ********************************************************************* ********************************************************************* TIME (us) EVENT DESCRIPTION ============ ====================================================== 000,000,000 Tracing Starts (RtssLogger.rtss : Pid = 1, Tid = 23) 002,856,116 Timer interrupted 2326 times 002,856,215 Context switch to thread ID 2 of PID 0 002,856,217 Timer interrupted 1 times 002,856,217 Context switch to thread ID 3 of PID 0 002,856,218 Context switch to thread ID 0 of NT process 002,856,222 Context switch to thread ID 2 of PID 0 002,856,223 Context switch to thread ID 3 of PID 0 002,856,224 Context switch to thread ID 0 of NT process 002,856,227 Context switch to thread ID 2 of PID 0 002,856,227 Context switch to thread ID 3 of PID 0 002,856,230 Context switch to thread ID 24 of PID 2 002,856,230 Context switch to thread ID 3 of PID 0 002,856,230 Context switch to thread ID 0 of NT process 002,856,235 Context switch to thread ID 2 of PID 0 002,856,235 Context switch to thread ID 24 of PID 2 002,856,237 Heap creation 4096 bytes 002,856,238 Context switch to thread ID 0 of NT process 002,856,244 Context switch to thread ID 2 of PID 0 002,856,245 Context switch to thread ID 24 of PID 2 002,856,249 Create object Mutex 002,856,249 Context switch to thread ID 0 of NT process 002,856,253 Context switch to thread ID 2 of PID 0 002,856,253 Context switch to thread ID 24 of PID 2 002,856,254 Heap creation return status last error 0 002,856,255 Initialize critical section pointed by 0x961a7e78 002,856,255 Create object Mutex IZ-DOC-X Using RTX Time View to Capture Data

15 002,856,255 Context switch to thread ID 0 of NT process After viewing the data, click Exit in the RTX Time View window. NOTE: RTX Time View Trace Event Logging Traced items are written to the RTX Time View data file by the thread that encountered the activity. This will primarily occur immediately after the event occurs, but could be delayed when a priority inversion protocol is active. When a thread has its priority raised to allow it to complete use of a mutex needed by a higher priority thread, the higher priority thread will preempt as soon as the priority is lowered during the release of the mutex in the first thread. In this case, the demoted thread will not get a chance to call the trace function that will log its priority demotion until it has another opportunity to run. As a result, RTX Time View data will show the priority demotion occurring later than it actually did. Preparing to Use TimeDoctor TimeDoctor is an Open Source Software (OSS) project, hosted at: RTX Time View data can be converted for use with TimeDoctor. After conversion, the TimeDoctor tool takes the trace data input file and creates visual output that can be used to evaluate the behavior of tasks, queues and other application events. Installing TimeDoctor: 1. Locate the zipfile containing TimeDoctor files by either doing a web search on keyword TimeDoctor, or by looking in 2. Copy the TimeDoctor kit to a local directory and then open the zip file. 3. Extract files, preserving original folder names. After all files have been extracted, you should have a directory structure similar to the one shown below. IZ-DOC-X Using RTX Time View to Capture Data

16 Converting RTX Time View Data to TimeDoctor Input RTX Time View data can be used as input to the TimeDoctor utility after it has been converted to the expected format. The sample application RtvFileConvert, located in the RTX samples directory, can be used to perform a basic convert. Follow the steps below to convert the RTX RTX Time View (.rtv) trace file to TimeDoctor input (.tdi) using this sample. To convert a.rtv file to.tdi format: 1. Open a command line window 2. Type the command: "C:\Program Files\IntervalZero\RTX\tools\TimeView\RtvFileConvert.exe" /f "C:\Documents and Settings\All Users\Application Data\RTX\TimeViewLogs\MutexSharingStatsNOW.rtv" /s "C:\Documents and Settings\All Users\Application Data\RTX\TimeViewLogs\MutexSharingStatsNOW.tdi" /w NOTE: This should be one, contiguous line. The line is separated above for clarity. If full specifications include any spaces, enclose them in quote marks. The command line shown above can be found the samples directory C:\ProgramData\RTX\samples\MutexSharingTest\TimeDoctorCommandLine.txt. Open the text file in notepad, copy the command line, and then paste it into a command window to simplify the conversion process. IZ-DOC-X Using RTX Time View to Capture Data

17 In the command above: /f infile = a string for input file name (default is C:\RtxTrace.rtv) /s outfile = a string for output file name (default is RtxView.tdi) Displaying RTX Time View Data as Graphs using TimeDoctor To view trace file information in a visual form using TimeDoctor, follow the steps shown below. Steps: 1. Double-click the TimeDoctor.exe file to start the TimeDoctor utility. In the TimeDoctor Performance Visualizer window, select Open Trace... from the File pull-down menu. 2. Select the TimeDoctor input (.tdi) file that was converted using RtvFileConvert.exe. IZ-DOC-X Using RTX Time View to Capture Data

18 3. TimeDoctor provides a visual display of the trace log data as shown below. Note that process and thread identifiers should match those that were displayed as output by the MutexSharing application. IZ-DOC-X Using RTX Time View to Capture Data

19 If you put your cursor over a noted flag, a pop-up message will indicate the activity that has occurred. IZ-DOC-X Using RTX Time View to Capture Data

20 Using the expansion icons mark)., look for an area of high activity (as shown below, near the 3s Using the magnifier icons, you can magnify to view activity with more precision. IZ-DOC-X Using RTX Time View to Capture Data

21 Resources For more information, visit the IntervalZero website at IZ-DOC-X Resources