Table of Contents
Summary of Contents for CATC IBTracer
- Page 1 2403 Walsh Avenue, Santa Clara, CA 95051-1302 Tel: +1/408.727.6600 Fax: +1/408.727.6622 IBTracer Verification Script Engine User Manual IBTracer VSE Manual Version 1.0 For IBTracer Software Version 2.2 or Higher 1 November, 2002...
-
Page 2: Table Of Contents
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Table of Contents Introduction ......................... 4 Verification Script Structure..................4 Interaction between IBTracer and verification script ..........7 Running verification scripts from IBTracer............... 9 ....................10 UNNING VERIFICATION SCRIPTS ........................12 DITOR SETTINGS Verification Script Engine Input Context members .......... - Page 3 Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 16.1 LRHF () ........................27 IELD 16.2 BTHF () ........................28 IELD 16.3 GRHF ()........................28 IELD 16.4 DETHF () ........................29 IELD 16.5 RETHF ()........................29 IELD 16.6 ETHF () ......................
-
Page 4: Introduction
A varification script file should have extension *.dec, and be located in the subfolder ..\Scripts\VFScripts of the main IBTracer folder. Some other files might be included in the main script file using directive %include. (see CATC Script Language (CSL) manual for details) The following schema can present the common structure of verification script: VS1.dec... - Page 5 Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 set DecoderType = "<Your VScript name>"; # Should be set for all verification scripts set DecoderDesc = "<Your Verification Script description>"; # Optional ############################################################################################ ########## # include main Verification Script Engine definitions %include "VSTools.inc"...
- Page 6 Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 ###################################################################################### ProcessData() ###################################################################################### ###################################################################################### # It is a main script function called by the application when the next waited event # occured in the evaluated trace. # !!! REQUIRED !!! – MUST BE IMPLEMENTED IN VERIFICATION SCRIPT...
-
Page 7: Interaction Between Ibtracer And Verification Script
3. Interaction between IBTracer and verification script The following describes how IBTracer interacts with a verification script to test an open trace: 1. When a verification script is run, VSE looks for the function OnStartScript() and calls it if it is found. - Page 8 Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Verification Script IBTracer Application (Run verification script) Call.. OnStartScript() Starting VSE running … Call..(If expected event ) ProcessData() Call..(If expected event ) ProcessData() Call..(If expected event ) ProcessData() Call..(If expected event ) ProcessData() Set out.Result =...
-
Page 9: Running Verification Scripts From Ibtracer
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 4. Running verification scripts from IBTracer To run a verification script over a trace –run the command Report>Run verification scripts… from the menu or push the button shown below on the main toolbar ( if it is not hidden ):... -
Page 10: Running Verification Scripts
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Verification Script description. Verification Script List. Descriptions for scripts are defined in Name for scripts are defined in set DecoderDesc= "MyDescription"; set DecoderType = "MyName"; Start running selected verification scripts... - Page 11 Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Right-click in script list to open a pop-up menu with options for performing additional operations over selected scripts: – starts running selected script. Run verification script Page 11 of 35...
-
Page 12: Editor Settings
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 – allows you to edit selected scripts using whatever editor application has been Edit script specified in ‘Editor settings’. – creates a new script file using the template specified in ‘Editor settings’. -
Page 13: Trace Event-Independent Set Of Members
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Trace event-independent set of members. This set of members is defined and can be used for any event passed to script: - time of the event( type : list, having format : 2 sec 125 ns -> [2 , 125]) in.Time... -
Page 14: Verification Script Engine Output Context Members
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 - current link state(Opcode) in.LinkStateCurr 6. Verification Script Engine Output Context members All verification scripts have output contexts –special structures whose members are set by the script and can be used inside of the application ( For more details about output contexts – please refer to the CATC Script Language(CSL) Manual ). -
Page 15: Notification Events
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Skips _PKT_SKIPS Notification events. VSE defines a group of notification events that can be passed to a verification script for evaluation or for retrieving and displaying some contained information. The information about the type of event can be seen in in.TraceEvent. -
Page 16: Sendevent
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 SendEvent () This function specifies what kind of events should be sent to script. Format : SendEvent( event ) Parameters: event – This parameter can be combination of the following values:... -
Page 17: Sendlinkpkt()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 SendLinkPkt () This function specifies more precise tuning for sending link packets. Format : SendLinkPkt( opcode = _ALL, vl = _ALL ) Parameters: opcode – This parameter specifies that only link packets with this Opcode will be sent ( _ALL –... - Page 18 Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 shown in CATC trace) and value equal to field_value will be sent ( This field makes sense only if one of the previous parameters are not equal to _ALL ) field_value –...
-
Page 19: Timer Functions
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 9. Timer functions This group of functions covers VSE capability to work with timers -an internal routines that repeatedly measures a timing intervals between different events. VSE time object A VSE time object –... -
Page 20: Gettimertime ()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 timer_id – a unique timer identifier. Example: KillTimer(); # - stop timing for timer with id = 0; KillTimer(23); # - stop timing for timer with id = 23;... -
Page 21: Timefromsymbols()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Parameters: nanoseconds – number of nanoseconds in specified time seconds – number of seconds in specified time Example: Time ( 50 * 1000 ); # - create time object of 50 microseconds Time (3, 100);... -
Page 22: Subtracttime()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Parameters: time_1 - VSE time object presenting first time interval time_2 - VSE time object presenting second time interval Example: t1 = Time(100); t2 = Time(2, 200); t3 = AddTime( t1, t2 ) # - returns VSE time object = 2 sec 300 ns. -
Page 23: Divtimebyint()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 11.4 DivTimeByInt() Divides VSE time object by integer value Format : DivTimeByInt (time, div) Return values: Returns VSE time object presenting time interval equal to time / div Parameters:... -
Page 24: Islesstime()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 If( IsEqualTime( t1, t2 ) ) DoSomething(); 12.2 IsLessTime() Verifies that one VSE time object is less than the other VSE time object Format : IsLessTime (time1, time2) Return values:... -
Page 25: Time Text Functions
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Time text functions This group of functions covers VSE capability to convert VSE time objects into text strings. 13.1 TimeToText() Converts a VSE time object into text. Format :... -
Page 26: Enable Output ()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 14.2 EnableOutput() Enables showing information in the output window. Format : EnableOutput () Example: EnableOutput ( ); 14.3 DisableOutput() Disables showing information in the output window. Format : DisableOutput () Example: DisableOutput ();... -
Page 27: Ismad()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Before calling this function - in.Payload and in.PayloadLength are empty but some other retrieving functions can be used to receive all information about fields in link packets, packet headers and MAD decoded fields. -
Page 28: Getbthfield()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 16.2 GetBTHField() Extracts information about BTH header field Format : GetBTHField ( bth_fld ) Parameters: bth_fld - BTH field identifier that can be one of the following values: Identifier... -
Page 29: Getdethfield()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 _DGID_0_3 Destination GID (bytes 0-3) _DGID_4_7 Destination GID (bytes 4-7) _DGID_8_11 Destination GID (bytes 8-11) _DGID_12_15 Destination GID (bytes 12-15) Example: val = GetGRHField ( _IPVER ); # extract IPVersion field from GTH header 16.4 GetDETHField() -
Page 30: Getatomicethfield()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 16.6 GetAtomicETHField() Extracts information about AtomicETH header field Format : GetAtomicETHField ( aeth_fld ) Parameters: aeth_fld - AtomicETH field identifier that can be one of the following values: Identifier... -
Page 31: Getrdethfield()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 16.8 GetRDETHField() Extracts information about AtomicAckETH header field Format : GetRDETHField ( rdeth_fld ) Parameters: rdeth_fld - RDETH field identifier that can be one of the following values: Identifier... -
Page 32: Mad Decoded Fields Retrieving Functions
MAD decoded fields retrieving functions This group of functions covers VSE capability to extract information about MAD decoded fields. 17.1 GetDecodedMADField() Extracts information about MAD decoded field how it is shown in IBTracer trace view or “View MAD” dialog. Format :... -
Page 33: Gethexmadfield()
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 str = GetDecodedMADField ( “PortState” ); # extract the decoded value of PortState # field. Remark: The name of field should be exactly the same as it seen in the trace ( case included ) 17.2 GetHexMADField() -
Page 34: Miscellaneous Functions
NOTE : Some other useful miscellaneous functions can be found in the file : VSTools.inc The VSE important script files The VSE working files are located in ..\Scripts\VFScripts subfolder of the main IBTracer folder. The current version of VSE includes following files: File Description VSTools.inc... -
Page 35: Appendix A How To Contact Catc
Computer Access Technology Corporation IBTracer Verification Script Engine Manual, version 1.0 Appendix A How to Contact CATC TYPE OF SERVICE CONTRACT Call for technical support… US and Canada: 1 (800) 909-2282 Worldwide: 1 (408) 727-6600 Fax your questions… Worldwide: 1 (408) 727-6622 Write a letter …...