Software Development Kit for the System Visible Event Nexus
Contents
1. NOTE The timestamp counter is a very fast and low overhead access clock but can be unreliable with sleep states See also Adapting the SVEN SDK which explains how to test the reliability of the used clock input Defining SVEN Modules Each SVEN event is tagged with a module ID that defines its originating SW module This module ID is used for various features like printing and filtering of events Each code module instrumented with SVEN should be defined in the module table of the BSP The files defining modules are e bsp your bsp name include sven_module h e bsp your bsp name include sven_mrd_table h The file sven_module h contains enumerations for the known modules and D s for the module specific events that come from these modules 19 e n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 8 4 20 The file sven_mrd_table h contains the data structures for defining modules and its related module specific events The file from the example BSP folder defines 2 modules called VR_MyModule andSVENTEST These are meant for demonstration purposes and can be replaced with your own module definitions NOTE The module SVENTEST is used by the sventest kernel mode driver stored under driver linux test of the SVEN SDK You should keep the SVENTEST module in order to utilize this test driver for SVEN infrastructure validation see also Testing the SVEN SDK To understand how the de2. E Intel Software Development Tools Software Development Kit for the System Visible Event Nexus Technology SVEN User Guide Copyright O 2013 Intel Corporation All Rights Reserved Document Number 328506 001US Revision 1 0 World Wide Web http www intel com 5 n te I Software Development Kit for the System Visible Event Nexus Technology SVEN Disclaimer and Legal Information INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS NO LICENSE EXPRESS OR IMPLIED BY ESTOPPEL OR OTHERWISE TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT EXCEPT AS PROVIDED IN INTEL S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY RELATING TO SALE AND OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE MERCHANTABILITY OR INFRINGEMENT OF ANY PATENT COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT A Mission Critical Application is any application in which failure of the Intel Product could result directly or indirectly in personal injury or death SHOULD YOU PURCHASE OR USE INTEL S PRODUCTS FOR ANY SUCH MISSION CRITICAL APPLICATION YOU SHALL INDEMNIFY AND HOLD INTEL AND ITS SUBSIDIARIES SUBCONTRACTORS AND AFFILIATES AND THE DIRECTORS OFFICERS AND EMPLOYEES OF EACH HARMLESS AGAINST ALL CLAIMS COSTS DAMAGES AND EXPENSES AND REASONABLE
3. The first step in adapting the SVEN SDK is to create your own BSP based on the example BSP that ships with the SDK Perform the following steps 1 Copy the the BSP example folder to a name that describes your platform for example crownbay S cd sdk bsp cp r example crownbay 2 Set the environment variable SVEN_BSP to match your BSP name For example S export SVEN_BSP crownbay The build environment will now use the sources from the bsp crownbay folder o Adapting the SVEN SDK l n te I 8 2 8 3 User Guide Defining SVEN Time Stamps Each SVEN event is tagged with a 32bit time stamp that allows profiling and historically locating of SVEN events in a time line The clock source used for the timestamp is defined in the following BSP file bsp name include sven_timestamp h The symbol sventimestamp returns the clock value as a 32 bit unsigned integer The symbol sven_get_timestamp_frequency returns the clock frequency The example BSP ships with definitions for two different clock sources It provides e Wall clock time using Linux API functions with micro second resolution 1 MHz e CPU time stamp counter ticks at cou_max_freq 1024 resolution The wall clock time is used by default This method works reliable but causes more overhead for transmitting an event Uncomment the define USE_TSC_TIMESTAMP in sven_timestamp h to switch the BSP to use the time stamp counter as clock input
4. Copyright 2006 2012 Intel Corporation All Rights Reserved type help for a list of commands or quit ewa 32 one 4 aioe s4 SO 32 Caen 3 il SVEN Header ver SVE2 disab 00000000 debugfl 00000000 hdr_pa 35550000 hdr_sz 00001000 buf_pa 01c00000 buf_sz 00100000 Chmcoumt 000000104 Testing the SVEN SDK User Guide SVEN CPi DMA EE OOO OOM ONES AAAMOOO ORCOS 010 00007 Elo els OOOO sven gt Enter the command timestamp calc to detect and validate the time stamp clock input from the BSP sven gt timestamp calc Calculating SVEN timestamp frequency for 30 SECAS done Average sven clock ticks per second 71211 time 1 wall clock 01000202 sven 00069925 delta 1286 time 2 wall clock 02000439 sven 00136149 delta 4987 time 3 wall clock 03000594 sven 00207586 delta 226 time 28 wall clock 2000 4358 sven OLS98YIS elta asad time 29 wall clock 290076600 sven 02065132 delta 499 Standard deviation of sven clock for 1 second durations 11179 156981123 ws WARNING Clock source for sven is unstable SVEN Timestamp Frequency kHz 71 Ox00000047 The command prints the red marked warning above if the timestamp clock produces unreliable results Try adding the Linux kernel boot option idle halt if the CPU time stamp counter is used for calculation SVEN time stamps This option disables Cx sleep mode utilization which causes the T
5. The SVEN SDK is built See also Building the SDK 3 Run make install with root privileges The SVEN kernel modules header files tools and libraries are built see also Building the SDK 4 Verify the installation using the included sventest ko driver and the csven debug console utility see also Testing the SVEN SDK Optional Adapt the SVEN SDK to your needs and repeat the above build and install steps see also Adapting the SVEN SDK 11 intel 4 12 Software Development Kit for the System Visible Event Nexus Technology SVEN Building the SVEN SDK The SVEN SDK comes with a simple GNU make based build system It allows building the SDK without changes and makes it easy to replace it with a custom build system used for the target platform The build system understands the following environment variables to customize the build Variable Meaning Default value SVEN_BSP Directory name of the example SVEN board support package BSP inside The example BSP that ships with the the bsp folder that gets SDK used during build KBUILDDIR Location of kernel lib modules uname r modules module build environment The module build environment for the currently running kernel Use the following commands to build the SVEN SDK with default settings which mean using the example SVEN SDK BSP and the currently installed kernel make clean make E Installing the SVEN SDK File On the Lo
6. The API is called sven_test_timer_tick API Adapting the SVEN SDK l n te instrumentation calls for this API are generated by the sventest example driver module in driver linux test Search for DEVH_API in the file driver linux test sventest c to understand how API instrumentation calls are used User Guide 21 22 e n te I Software Development Kit for the System Visible Event Nexus Technology SVEN Instrumenting User Mode Software This chapter describes how to add SVEN instrumentation to a user mode software module The following code shows a hello world style SVEN instrumented application include lt stdio h gt include lt sven_devh h gt ao ela SLIME ESE Claus Elo get SVEN device handle os_devhandle_t devh DEVH_FACTORY NULL assign module and unit ID DEVH_SETMODULEUNIT devh SVEN_module_SVENTEST 0 general purpose print event DEVH_DEBUG devh hello world cleanup handle DEVH_DELETE devh return 0 Use the following command line to compile the application gcc o hello_sven hello_sven c lsven lpthread Run the csven debug console from a second terminal with the following command csven monitor Run the hello_ sven application It produces the bold marked trace event output line in the csven debug console that originated from the DEVH_DEBUG Call in hel
7. gt stream events bbr svenlog_thread_created CUSER BREAK exiting monitor back to console wrote 1395 events to file events bbr sven gt The csven utility stops saving the events and reports how many events where written into the given file 23 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 10 3 10 3 1 24 Loading Events From a File You can use the load and dump commands to load and view a previously recorded event file sven gt load events bbr eading events from file xx bbr read 1395 of 1395 events from file xx bbr filtered Event Capture is now paused you must type run to capture again sven gt dump Gheg SIL 000 mesg SOi WOO Me S VAENE sat U 00 T module_event HASTET TERECOUNE S693 5G aa TIOS dt 100035 mes 10 00 MS SWIaNIdas U 00 T module_event TASI TIOS RE CUNAS 1 tte SiG SSS 9018 dts Elo IS mes O 2 MAS VIENES U 00 T module_event TASI IWC Coba 3699516 Tires VIS AOS DP ESOS VENTES U 00 T module_event ASI TIC COUN SOIL aa 76589218 Event filtering There are two types of event filters This first one is a global event mask called the hot enable mask The second one is a display filter inside the csven debug console It controls which events are loaded into the csven local memory buffer and get shown using the dump and monitor commands HOT filtering The hot
8. package adaptation tree bsp example Example BSP that ships with the SVEN SDK Adaptations to the SVEN SDK are usually done by copying this folder to a name matching the targeted platform bsp example include Definitions for SVEN modules SVEN module events SVEN API events and device registers driver linux Location of the SVEN device driver source code for Linux This driver provides the infrastructure for storing SVEN event in a system and user mode visible memory buffer It also exposes the SVEN instrumentation API to kernel modules ae IL driver linux test ude A hello world style device driver that shows how to use instrumentation calls It uses the following event types Module specific events from the example bsp devh_SVEN_WriteModuleEvent API events from the example bsp DEVH_API_CALL DEVH_API_RETURN O eneric Func enter exit events DEVH_FUNC_ENTER DEVH_FUNC_EXIT Generic output events DEVH_DEBUG Public include files for the SVEN infrastructure osal Location of an OS abstraction layer This folder increases the portability of the generic SVEN code by providing a generic API to OS specific primitives User Guide 35 36 Software Development Kit for the System Visible Event Nexus Technology SVEN memory mapping thread synchronization This code is usually used as is without the need
9. ATTORNEYS FEES ARISING OUT OF DIRECTLY OR INDIRECTLY ANY CLAIM OF PRODUCT LIABILITY PERSONAL INJURY OR DEATH ARISING IN ANY WAY OUT OF SUCH MISSION CRITICAL APPLICATION WHETHER OR NOT INTEL OR ITS SUBCONTRACTOR WAS NEGLIGENT IN THE DESIGN MANUFACTURE OR WARNING OF THE INTEL PRODUCT OR ANY OF ITS PARTS Intel may make changes to specifications and product descriptions at any time without notice Designers must not rely on the absence or characteristics of any features or instructions marked reserved or undefined Intel reserves these for future definition and shall have no responsibility whatsoever for conflicts or incompatibilities arising from future changes to them The information here is subject to change without notice Do not finalize a design with this information The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published specifications Current characterized errata are available on request Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order About this Document n tel User Guide Copies of documents which have an order number and are referenced in this document or other Intel literature may be obtained by calling 1 800 548 4725 or go to http www intel com design literature htm Intel processor numbers are not a measure of performance Pr
10. K n te 7 Uninstalling the SVEN SDK Run the following command while inside the top level SVEN SDK folder to uninstall the SVEN SDK This step requires root rights at is removes the SDK distribution files from various system directories like usr bin and usr lib S make uninstall This step may produce several warnings and error messages which can Safely be ignored User Guide 17 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 8 8 1 18 Adapting the SVEN SDK You can use the SVEN SDK as is to get familiar with the SVEN infrastructure Optionally you can adapt the SDK to your needs in order to use its full potential To adapt the SVEN SDK to your needs modify the Board Support Package BSP component of the SVEN SDK The BSP contains the time stamp computation code and definitions for software modules that create events and definitions for custom event types You can also add device register information to utilize the device register API portion of SVEN NOTE Note Alternatively you can define modules and events using meta data files This way you can use the original SVEN SDK and still be able to define your own modules and events Use the metaload command to load the event decoding information dynamically into the SVEN console The following sections describe how to modify the BSP and define your own modules and event definitions for SVEN Create Your Own BSP
11. S al sventest_timer_tick pointer 0x00000000 f84583b8 A A t 23046 043 API retn sventest_timer_tick 0 eae O44 03S APRIS CE sventest_timer_tick pointer 0x00000000 f84583b8 t 22044 024 API retn sventest_timer_tick 0 eS ZALOAZ 0S0 INE IS Cel sventest_timer_tick pointer 27 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 10 5 28 0x00000000 f84583b8 Handling SVEN Time Stamps The timestamp command can be used to show set and auto detect the SVEN time stamp frequency used for computing event time information in csven Type timestamp to get an overview about the variants of the timestamp command Enter the following command to show the current timestamp frequency used by csven sven gt timestamp SVEN Timestamp Frequency kHz 1269 0x000004f5 Enter the following command to change the timestamp frequency value You can use khz mhz or ghz suffixes to specify the magnitude of the frequency sven gt timestamp lmhz timestamp frequency set to 1000 kHz Enter the following command to auto detect the used timestamp frequency for SVEN event based on 30 one second intervals The command also computes the standard deviation of the clock from its 1 second tick average and gives a warning if the clock is unstable see also Defining SVEN Time Stamps sven gt timestamp calc Calculating S
12. SC to stop counting on various CPU families Verify that the frequency shown on the last line matches the value specified in the BSP The default wall clock timer frequency is 1000 kHz The frequency used by the TSC clock input is MAX_CPU_ FREQUENCY 1024 for example 1269 kHz on a 1 3 GHz CPU Enter the command monitor into the sven console The console will display event sequences from the SVENTEST module sven gt monitor svenlog_thread_created ces SIOVIG S84 mes 70 LO S84 MEQ0 USO Weeksiome sti Ss Los SVEN RBD_ABSENI 15 16 intel 7 8 ces SS NGS m pointer 0x00 Software Development Kit for the System Visible Event Nexus Technology SVEN eS LOS S49 APIS AS Snes Tmerr Cia 000000 f84583b8 ola E O OOS as 0 003 M SVENTEST U 00 T debug_str S FuncEnter sventest_timer_tick OE E 0 Ze e OROOZ SMS VEN E Sen U 00 T module_event SHOWER CK NC OUT SS tE SEO SS 247 52 aie 0 004 mt 0 004 M SVENTEST Wi OOM AE GSD UCmESi Sauce sventest_timer_tick eies 0 001 mme 0 001 API retn sventest_timer_tick 0 ees 9 9088 mes S SG IMLS SWARIN La Sal U 00 T module_event NSE MICK cobiaies 42 Jirriess 03532420 To stop monitoring events hit Ctrl C Then enter quit to exit the csven console Type the following command to unload the sven device drivers from your platform S sudo rmmod sventest S sudo rmmod sven Uninstalling the SVEN SD
13. SP information and can be used to provide event pretty printing information without the need to compile an own BSP Syntax metaload mv filename The option m merges the metadata with the current information instead of replacing it This option is used to add BSP definition incrementally to the console The option v provides verbose output on the action taken by metaload It is useful for analyzing problems when using manual modified metadata files metashow Print currently used metadata information metareset Revert to the compiled in BSP metadata time Select time display mode overhead Measures SVEN instrumentation overhead stream Stream the SVENLOG to a file Events are saved until a trigger fires or Ctrl C is pressed timestamp Set or compute timestamp frequency 33 intel 11 34 11 35 34 Syntax timestamp num GHz MHz KHz timestamp calc timestamp systime Print the current system time echo Print a string Software Development Kit for the System Visible Event Nexus Technology SVEN set timestamp frequency compute timestamp frequency show timestamp frequency Understanding the SVEN SDK Folder Structure 12 Understanding the SVEN SDK Folder Structure The SVEN SDK is delivered as a source tree The following table explains the contents of the various folders in the distribution bsp Folder Name Description Root folder of the SVEN board support
14. VEN timestamp frequency for 30 seconds fete ei E E E eae ets NE O done Average sven clock ticks per second 1000141 eines wall clock 0000 LGS sven gt O10 00MCS delta 27 time 2 wall clock 02000298 sven 02000298 delta 11 time 3 wall clock 03000434 sven 03000434 delta 5 time 4 wall clock 04000564 sven 04000563 delta 12 time 28 wall clock 28003982 sven 28003982 delta 5 time 29 wall clock 29004112 sven 29004112 delta 11 Sitan darcGiedevalalitelonmOr kovenee oek Ero eCOM raens IO SSS Us SVEN Timestamp Frequency kHz 1000 0x000003e8 Command Reference l n te 11 Command Reference This chapter describes the csven console command set Type help to print the list of available console commands 11 1 quit Exit the SVEN console 11 2 help Print list of available commands including a short description of its purpose 11 3 sleep Syntax sleep number Suspend command processing for the specified number of seconds 114 pause Immediately stop capturing additional events into local memory NOTE This does not prevent events from being transmitted into the Nexus It just prevents the console from capturing them In this mode you can inspect recently transmitted events usually using the dump command 11 5 run Immediately resume capturing additional events into local memory This is often used to resume capture after a trigger fires User Gu
15. Write a named register requires register data definitions in the BSP 11 19 hot Hot enable disable of event writer categories The hot gate is a global filter It controls which event types that will be transferred into the event nexus Using hot disable all turns off any SVEN logging on a system User Guide 31 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 11 20 11 21 11 22 11 23 11 24 11 25 11 26 32 Syntax hot enable disable all strings regio func smd mod perf api fw trigger Trigger on a specific event Event capture will stop when the trigger matching even is seen on input See also triggerdelay and triggerwait triggerdelay Set the number of events to record in addition after a trigger fires triggerwait Wait for a trigger event optional timeout in seconds filter Filter SVENLOG based on a mask provided see also section Event filtering Save Save the binary SVENLOG to a file load Load a binary SVENLOG from a file The console stops monitoring the nexus and uses the provided file as the trace input buffer metasave Save bsp metadata into a file This metadata contains all BSP definitions like modules module events and APIs Command Reference l n te 11 27 11 28 11 29 11 30 11 31 11 32 11 33 User Guide metaload Load bsp metadata from a file The metadata replaces the B
16. cal System l n tel 5 Installing the SVEN SDK File On the Local System After building the Sven SDK successfully run the following command to install the Sven SDK file on the local system This step needs root rights as it copies the tools kernel modules libraries and header files into the system directories like usr include usr lib and usr bin sudo E make install User Guide 13 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 6 14 Testing the SVEN SDK This chapter assumes that the SDK was successfully build and installed Enter the following commands to test the SVEN SDK integration on your platform 1 Load the sventest ko driver that issues periodic SVEN events to the SVEN event nexus This step requires root rights as it loads kernel modules into the running kernel sudo modprobe sventest 2 Verify that both the sven and sventest kernel modules are loaded into the kernel using the following command lsmod grep sven sventest 1433 0 sven 2Sa 1 sventes 3 Check your system event log if the modprobe command above produced an error or if one of the two SVEN modules is not listed by Ismod The event log is either shown on the console window or can be investigated with the following command S sudo tail var log messages 4 Run the SVEN console application csven S csven The console displays the output such as SVEN Interactive Built Mar 22 2012
17. command is used to enable disable SVEN Event transmission into the nexus Events that are hot disabled will not be seen by any logging application This is the most convenient way to turn off debug instrumentation transmission into the nexus even while streaming software is executing The command syntax is hot enable category enable system wide transmission of an event category into the nexus hot disable category disable system wide transmission of an event category into the nexus Where category is one of e all All Events Using the csven Debug Console l n te e strings General debug strings transmitted by calls to DEVH_DEBUG devh str DEVH_WARN devh str DEVH_FATAL_ERROR devh str e regio All hardware register reads writes transmitted by calls to devh_ReadReg32 devh offset devh_WriteReg32 devh offset value e func driver execution sequence events transmitted by DEVH_FUNC_ENTERED devh DEVH_FUNC_EXITED devh DEVH_AUTO_TRACE devh e mod Module specific events e api SVEN API call return trasmitted by DimVAst INDI ICN elena UNC PO jell jo2 iOS pA DEVH_API_RETURN devh api func rt When you use filter reject all use also filter accept event specification to re enable the filter for the specified kind of events See also Display filtering 10 3 2 Display filtering The SVEN Debug console by default records all events bei
18. e unless uppercase is significant This type style Indicates the exact characters you type as input Also used to highlight the elements of a graphical user interface such as buttons and menu names Indicates a placeholder for an identifier an expression a string a symbol or a value Substitute one of these items for the placeholder Indicates that the items enclosed in brackets are optional User Guide 7 item item ellipses Software Development Kit for the System Visible Event Nexus Technology SVEN Indicates to select only one of the items listed between braces A vertical bar separates the items Indicates that you can repeat the preceding item Introduction 2 2 1 User Guide Introduction System Visible Event Nexus Technology SVEN SVEN is a software technology and API that collects real time full system visible software event traces SVEN is currently built into Intel media display drivers and is the primary debug tool for the Intel Media SoC debug performance measurement and regression SVEN is simply a list of software events with high resolution timestamps The SVEN API provides developers a method of transmitting events from any operating system context and firmware e n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 2 2 10 SVEN Debug Infrastructure The SVEN debug infrastructure consists of a small and fast even
19. ec 33 T134 SySUME rrene d 34 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN 12 A A A ne re ee 34 Understanding the SVEN SDK Folder Structure cooococciccinccnicicnnncnoconconconononoss 35 8 About this Document n te About this Document This document describes the preview of the Software Development Kit for the System Visible Event Nexus technology SVEN SDK The SVEN SDK contains the source code for the event tracing infrastructure using the System Visible Event Nexus technology SVEN and related tools You can use it to adapt the SVEN event tracing infrastructure to a Linux platform It also provides the necessary C C include files and libraries for adding SVEN event instrumentation calls to kernel mode drivers and user space applications 1 1 Intended Audience The SVEN SDK is intended for software and validation engineers that plan to add SVEN software instrumented trace calls to their driver and application code It provides the platform runtime infrastructure for collecting events and the development environment headers and libraries for instrumenting software modules 12 Conventions and Symbols The following conventions are used in this document Table 1 Conventions and Symbols used in this Document This type style Indicates an element of syntax reserved word keyword filename computer output or part of a program example The text appears in lowercas
20. finition of SVEN modules work search for the pattern SVENTEST and the module specific event definition g_SVENTEST_specific_events in the file bsp lt bspname gt include sven_mrd_table h Then compare it with the usage in driver linux test sventest c that shows how the module definitions are used for code instrumentation Search for the calls to devh_SVEN_WriteModuleEvent that issue module specific events defined by the BSP Defining API Events SVEN offers predefined event types for API Call tracing These are typically used to instrument functions that are exposed to other SW modules or third party code The following SVEN instrumentation calls generate trace events for calling and returning from an API call e DEVH_API_CAL Create a trace event for entering an API call e DEV_API_RETURN Create a trace event for returning from an API call An API call is identified by two numbers that are provided to the above SVEN instrumentation call The first number defines an API function set The second number defines the call inside the set Both numbers are defined in the file include sven_api h of the used SVEN BSP Pretty printing of API events is done via the file include sven_api_table h of the used BSP This file is used by the csven debug console to map the API Id Function Id pairs from the instrumentation call to human readable information The example BSP contains one API call definition for demonstration purposes
21. for modifications Shared source code of the SVEN infrastructure It is both used by the kernel mode driver and the user mode libraries tools csven The source code of the SVEN debug console This code is used to configure the SVEN runtime and to visualize or save trace data tools dumpbbr A simple utility to dump the raw SVEN event data saved by the debug console It can be used as a starting point for writing an own event data post processing application
22. ide 29 5 n te Software Development Kit for the System Visible Event Nexus Technology SVEN 11 7 11 8 11 9 11 10 11 11 11 12 30 monitor Print all events that are coming into the nexus This command keeps running until a trigger fires or Ctr1 C is pressed hdr Print SVEN shared memory header information dump Syntax dump number Show the recently received events in the nexus The parameter number defines the maximum number of events shown The default for number is 40 hexdump Show the recently received events in the nexus in raw hex format The parameter number defines the maximum number of events shown The default for number is 40 search Search events for any payload between min and max lookup Lookup a module register or bitfield modules List supported modules from BSP or meta data Command Reference l n te 11 13 logwrite Create various events from the console into the nexus This is used to demonstrate various instrumentation API calls and to test event transmission into the SVEN nexus 11 14 source Execute commands from a csven script file 11 15 thread Launch svenlog monitor thread to collect events from the nexus 11 16 decode Decode MODULE reg_offset reg_value prev_value to text requires register data definitions in the BSP 11 17 peek Read a named register requires register data definitions in the BSP 11 18 poke
23. lo_sven csven monitor svenlog_thread_created cli ORO USE me SOS 23 S32 Ms SVENIS IE USO dsbugks Pasillo g hello world Inspect the file sven_devh h and search for the pattern DEVH_ to learn what other SVEN instrumentation calls exist o Using the csven Debug Console l n te I 10 10 1 User Guide Using the csven Debug Console The csven utility is a console mode command for storing and displaying SVEN events directly on the platform It can be uses both interactively and with scripts To get an overview over the supported command type help Quickstart Capturing SVEN events into a Data File Type the following commands to record all SVEN events into a data file The bold font shows the commands the normal font shows the tool output csven SVEN Interactive Built Mar 22 2012 Copyright 2006 2012 Intel Corporation All Rights Reserved type help for a list of commands or quit EME Clon e Aaa e A Sot 2 le hata ell SVEN Header ver SVE2 disab 00000000 debugf1 00000000 3 melie oa 507 aO OOM lack szi 00001000 buf_pa 01c00000 buf_sz 00100000 cb_count 00000001 SVEN CBu tS Oc Compass 0Leco000o ci siz 00L0OOCQ0 cb poss OS dales cb_id 00000000 sven gt hot enable all hdr disable 0x00000000 gt 0x00000000 sven gt stream events bbr svenlog_thread_created Now execute the workload that issues the events to capture Type Ctrl C when you are done sven
24. ng transmitted into the nexus The filter command is used to selectively enable or disable recording of these events into the debug console s local memory for display by the dump or monitor commands The command syntax is sven gt filter help ERR usage filter accept reject event specification Where e filter accept event specification Allows event specificationto be recorded locally e filter reject event specification Rejects event specification do not record locally e filter reject all Sets default to not record events locally e filter accept all Sets default to record all events locally More complex event specifications are given in tuples for example User Guide 25 26 e n te I Software Development Kit for the System Visible Event Nexus Technology SVEN filter reject module SVEN_TEST Do not record any event written by module SVEN_TEST filter reject event register_io Do not record register 1O Events transmitted by any device filter reject module SVEN_TEST event module_event Do not record module specific Events transmitted by SVEN_TEST To find options available for a tuple submit a question mark in its place to get a list of available options sven gt filter accept event event types invalid trigger debug_str register_io port_io module_isr os_isr os_thread smd module_event api sven gt filter reject event debug_str subtype sub
25. ocessor numbers differentiate features within each processor family not across different processor families Go to Learn About Intel Processor Numbers http www intel com products processor_number Intel and Atom are trademarks of Intel Corporation in the U S and or other countries Other names and brands may be claimed as the property of others Copyright 2001 2013 Intel Corporation All rights reserved 5 o n te I Software Development Kit for the System Visible Event Nexus Technology SVEN Contents 1 ABOUt this DOCUMEA Li 7 LI Int hded AU GIGI CS nisterio eaae iaaa iaae aiat 7 1 2 Conventions and SYMDO S escoria 7 2 o o e eee 9 2 1 System Visible Event Nexus Technology SVEN oooccicicicinicincocicccs 9 2 2 SVEN Debug Infrastructure noia da 10 3 l stalling the SVEN SDK ie nnn e E E 11 LU Prere atiendan Ot 11 32 ANSIA ee 11 4 Building the SVEN SDK ii 12 5 Installing the SVEN SDK File On the Local SysSteM ooccicicicciconicicconcccnnncncnns 13 6 Testing the SVEN SDK sn 14 7 Uninstalling the SVEN SDK cocoa 17 8 Adapting the SVEN SDK sido 18 9 1 Create Your OWN BSP sin 18 8 2 Defining SVEN Time Stamps arica 19 8 3 Defining SVEN Modules sessi 19 8 4 Defining API EVE ES ano 20 9 Instrumenting User Mode Software ocociccicicicicniconicoccconoconocnnnnnncnonnnnna nn nn cn ancora 22 10 Using the csven Debug Console occcooononicccinicionoconcncnccnnncncononnonncnrnnnnncnn ne cranannnnos 23 10 1 Quicks
26. t transmit SVEN TX library and a verbose capture and analysis SVEN RX capability for viewing and post processing The TX library also contains debug hooks for the Intel system debugger It enables the debugger to utilize SVEN instrumentation for advanced break conditions SVEN Intrumented SW modules device kernel User SVEN TX OS Integration Intel System Debugger Trace Receivers Visualisation Trace File Storage Post processing Scripting Remote or DUT analsyis tools Installing the SVEN SDK n te 3 3 1 3 2 User Guide Installing the SVEN SDK Prerequisites e Build the SVEN SDK on the same platform where you intend to run it Installation using a cross build environment like the Yocto Linux pokey environment is not supported by this release The SVEN SDK supports 32 bit and 64 bit Linux systems using kernel 2 6 37 or higher Building the SDK requires the GNU development tools for C C GNU make and the kernel development environment for modules The following command shows how to install the required components for a MeeGo 1 2 IVI release S sudo zypper install kernel adaptation intel automotive kernel adaptation intel automotive devel make gcc gcc c Installation The SVEN SDK is provided in full source code Follow the steps below to build and install it on your local system 1 Go into the sdk folder of your local SVEN SDK copy 2 Run make from inside the sdk folder
27. tart Capturing SVEN events into a Data File 23 10 2 Loading Events From a Piles anni 24 10 3 Evert FUME SUING ata 24 10 31 HOT filtering oo 24 10 3 2 Display TINO rn 25 10 4 Offline Viewing of Events from a Binary Event File 27 10 5 Handling SVEN Time Stamps cee csesesssseseseeseeeeeesseeceseteeeeeeeeeseeeeeans 28 About this Document n te 11 User Guide Command REFEreNCe cccccccccesesscssesscssesecsessecsessesecssesecsecsecsesseeeeseesecsessecseeaeesasaeeess 29 LA UNE cost ied Aa 29 A E O UN a ER 29 TES sleep AR 29 TILA Pr ce 29 A A on e 9 ee ee 29 LES MOI 30 A apne ne cae a CR nN Pe 30 A eee ee eden een een 30 119 HASH CAIN A e o A 30 A zisne miine e aa eaa a EEEE Eea dean danse AEE SEERE 30 A E E 30 o E EE ai 30 TLIIS NOW It Ea E ee 31 al VA SOUR E PE EE E EA T A LEE A E A EN 31 he ESE E A E E 31 T116 decd A A 31 11 17 A n POE rE ae ee ee ee eer E EE 31 ADO ion 31 A ene Untreated eae SUCRE Ee ne 31 T120 TOES di 32 11 21 la 32 HU A A 32 TL23 t rada E 32 DV 24 Save neee ek cases E EE ER E E EE ERAR 32 11 25 03d anna 32 T1260 MMOCAS AVE condition EE EELEE ORERE EE 32 11 27 Medid 33 11 28 met sShoW a 33 WL 29 metareS Et eperen eeaeee ne E E AEE EAE E ae EE E aAa R EEEE EEEE 33 TSO UME see ee a a a E a a 33 ii nesiem a A ed Seren me een 33 VD 32 Stred rerien or A E a ea are Eaa SE ESS 33 T133 timestamp ee escanscs ech cccineatencen ee atsdenicene A as
28. types invalid log FuncEnter FuncExit AutoTrace FuncInvalidParam Checkpoint Assert Warning FatalError PresTiming Using the csven Debug Console l n te I 10 4 User Guide Offline Viewing of Events from a Binary Event File This is an example script to extract and print API events from a binary SVEN event log file Save this test into a file called sift sven sift sven filter reject all filter accept event api load event bbr Binary sven log time tminus dump 1000000 Number to dump large number extracts all events Type the following command to run the script S csven source sift sven It will produce output such as Sourcing eripe SVAN SVEN SVEN filter reject all SVENLog default rejects all events SVEN filter accept event api Adding Filter EV 00000000 000c0000 00000000 00000000 00000000 00000000 0000000 00000000 1SK 00000000 003 0000 00000000 00000000 00000000 00000000 00000000 00000000 SUENE ANS EA Binary sven log S reading events from file event bbr read 50 of 1395 events from file event bbr filtered Event Capture is now paused you must type run to capture again SVEN time tminus time display mode is now 2 SVEN dump 1000000 Number of events to extract large number extracts all events A ASS INP Cel sventest_timer_tick pointer 0x00000000 f84583b8 t 24048 009 API retn sventest_timer_tick 0 E SAS0AG WSS INPIL
Download Pdf Manuals
Related Search