Quick Start Feature Guide Xgig Analyzer: 4

Xgig Analyzer: Quick Start Feature Guide 4.0

Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

Xgig Analyzer: Quick Start Feature Guide 4.0Table of ContentsNew Features and Improvements 1

Decode and Defect Fixes 2

Graphical Display of OOB and Speed Negotiation 3

Segmented Xgig Analyzer Buffer 6

API for TDIO 12

In-Place Editing within the Template Editor 13

Enlarge/Reduce Font Size in TraceView Display 16

Decode Switch Improvements 17

Improved Expert Report View 19

Finisar Corporation 1389 Moffett Park Drive Sunnyvale, CA 94089-1133 Phone: (408) 548-1000

www.finisar.com

Quickstart Feature Guide

Page 1

Welcome to the Xgig Analyzer 4.0 Quickstart Guide to Features! Use this guide to get acquainted with the major new capabilities introduced into this best-of-breed tool. The following list outlines features new to the Xgig Analyzer applications family. The remainder of this guide shows how to use these features within the applications. For in-depth details, refer to the help file for each application.

New Features:

Trace Buffer Segmentation - divide the trace buffer into smaller logical segments (up to 128 segments) allowing capture of many smaller traces within the physical buffer

Graphical display of OOB and Speed Negotiation - view, scroll, and zoom OOB events graphically

In-place editing in the Template Editor’s Tree View - enter or edit IP addresses in decimal format

Port pair licensing - license each port pair instead of the entire blade thus reducing licensing cost

Language independent SDK interface - Access buffers and files programmatically for post-processing

•

•

•

•

•

New Features:

New Report Format - create reports in a new, easier to understand format, with hyperlinks to Expert’s famous help file

Tighter Integration with TraceView - Automatically include Expert Trace Data in TraceView’s group file (.tgp)

New Expert Link Names - View Expert’s annotations within TraceView using the less confusing names “I-Link” for initiators and “T-Link” for targets (SAS wide links only).

Finisar’s commitment to its customers goes beyond new features and capabilities. Version 4.0 also includes many incremental improvements, decodes, and bug fixes requested by customers. The following lists outline these changes, however this document does not cover these items.

Improvements:

Support for Fibre Channel over Ethernet (FCoE) protocol

•

•

•

•

Page � Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

Support for FC-AE 1553 protocol including FCP_RESP codes (FCP-3/FCP-4) templates for status frames

For an exhaustive list of decode improvements, please read the “CurrentProtocolVersions.txt” file located in the following location. <Xgig Analyzer installation location>\Finisar\XgigAnalyzer\CurrentProtocols.

Decode and other Improvements:

Updated Preference Options Dialog - Choose Expert options with a newly laid-out tabbed Options dialog

Defect Fixes:

In Fibre Channel and iSCSI, the XPT output file now contains the SCSI Completion event on the port where the STATUS occurred. For SAS/SATA,

•

•

•

•

TraceView places the Command XPT output on the port sent. Both now use the same methodology.

LUN Reset now handled properly in FC.

Exported graph data from Expert now includes the timestamp for every sample.

SATA/ATA FPDMA commands templates added.

D10.2 incorrectly marked as a PSE error when coming out of slumber mode corrected.

Incorrect use of a bit when sending continuous “fake” target reset frames between controllers caused Expert to clear all I/T/L pending exchanges for iSCSI and FCP-SCSI protocols. Expert will now only produce an error for the bad flag, reusing the existing Target Reset warning, instead.

Expert incorrectly handled the FCP flags when FCP_DL = 0. Expert no longer produces error saying that the FCP_RDD and FCP_WD must be non-zero.

TraceView did not retain decode switches settings when closed and re-opened. TraceView now saves these as part of the configuration, thus correcting the problem.

•

•

•

•

•

•

•


Page 3

Graphical Display of OOB and Speed Negotiation (SAS Protocol Only)Debugging OOB problems with an analyzer can frustrate even seasoned network protocol engineers. Now, the Xgig Analyzer graphically displays OOB and Speed Negotiation from within TraceView. View, scroll, and zoom OOB events to quickly discover issues.

Step 1: Activate OOB window by pressing OOB button or via grid context menu item.

Page 4 Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

Using either method opens an OOB events display in a separate dialog box. Use this dialog’s controls to navigate OOB events and timings. Time interval display

Duration selection

Step 2: Drag selection to choose time interval in the trace, then choose the duration to display.


Page 5

Step 3: Press the “display” button to open the main OOB display window showing the time interval and duration selected.

Page � Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

Segmented Xgig Analyzer BufferDivide the hardware capture buffer into different segments on the Xgig Analyzer to allow multiple captures to the Xgig’s memory buffer. Using the segmented buffer allows multiple rapid trace captures without the need for time-consuming saving of trace files.

Step 1: Locate the controls for Capture Buffer Segmentation on Trace Control’s Configuration window. Use the up-down control to divide the Xgig’s memory into equal subsegments for use during subsequent trace captures. Trace Control allows up to 128 buffer sub-segments.


Page �

Step 2: (optional): Select capture segment. By default, the initial segment is 1. (NOTE: An asterisk next to a number means that the memory already contains a trace)


Xgig Analyzer 4.0

TraceControl provides different modes when using buffer segmentation.

Location of segment options on start button drop-down menu.

Step 3: Select ‘Capture a single segment and stop’, ‘Advance to the next segment before starting the capture’, or ‘Capture in all segments and stop’.


Page 9

Location of segment options within hardware menu.


Xgig Analyzer 4.0

View each different segment in TraceView and Expert using a drop-down in the toolbar.

Location of segment selection drop-down within TraceView


Page 11

Location of segment selection drop-down within TraceView Expert

Page 1� Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

API for TDIOXgig now provides a Software Developer’s Kit (SDK) and API to manipulate data within both in-memory captures and trace files. The API harnesses the Xgig software’s powerful Trace Data Input/Output (TDIO) functions, used by both TraceView and Expert, to allow user post-processing manipulation within C, C++ and C#. Use the included working demonstration example projects with Microsoft’s Visual Studio 2005.

The Xgig Analyzer Client CD includes examples, functions, and documentation for the API. The CD automatically installs these to your computer, by default, during Xgig Analyzer software installation. Look in the .../SDK/TDIO_API sub-directory within the Xgig Analyzer software directory to find these materials.

Note that the TDIO API does not control configuring or starting captures. For greater direct control when configuring and starting captures, please see the FRunner module. Look in the .../Program Files/Finisar/Frunner directory within the Xgig Analyzer software directory.


Page 13

In-Place Editing within the Template EditorCustomize your own templates within the improved Xgig Template Editor. Both TraceControl and TraceView Xgig applications utilize this control. Within TraceControl, the Template Editor allows filter and trigger definitions. In TraceView, it creates detailed Find/Filter/Color conditions.

Template editor button


Xgig Analyzer 4.0

From within TraceView, open the Detailed Find/Filter/Color dialog and then click-and-drag templates to one of the Detailed Find/Filter/Color window tabs to set up conditions.

Use context menu (right-click) to open the template.


Page 15

For editable fields within a template, context menu selection Edit or the F2 function key now allow you to edit the value fields within the Template Editor’s Tree View.

In-place editing is very useful for fields where the general format is not hexadecimal. For example, enter source or destination addresses in IP dotted notation rather than first translating to hexadecimal for entry in the byte pattern.

Page 1� Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

Enlarge/Reduce Font Size in TraceView DisplayButtons have been added to the TraceView toolbar to increase/reduce the font size in the event grid and Dword view.


Page 1�

Decode Switch ImprovementsDecode Switches within TraceView contain the following improvements.

Decode switches within the TraceView “View” menu.

The Decode Switches menu in the Template Editor now contains only the relevant options for the currently edited template.

TraceView adds a new Decode Switch to enable FC-AE-FCLP and options to further decode Response and Data frames.

Functional enhancements include two new menu items added to TraceView’s Decode Switches list: /C/ Encodings and FC-AE-FCLP


Xgig Analyzer 4.0

TraceView now stores the state of the Decode Switches to the configuration file. Once you set a switch, TraceView saves it as part of the last configuration when you close and remembers it when you re-launch TraceView.

TraceView now stores the state of the Decode Switches menu in the Template Editor when you click the OK button for all User Library templates. (NOTE: this does not work for templates in the Finisar Library since they are read-only.)

Prior to the current version, TraceView made Decode Switches global. If you modified them in the Template Editor or in the main application window, they applied to the entire application. In version 4.0, the Decode Switches menu is independent in each template, and independent of TraceView’s main application. Changes made to Decode Switches in one template will not affect the main TraceView application Decode Switches, nor will they affect other templates.


Page 19

Improved Expert Report ViewExpert contains an updated and easier to use hyperlinked look for Report View within Version 4.0. To access the Report View, press either the “Report View” button or “Report Setup” button on the Expert’s main dialog. (NOTE: Alternatively, you can also select Report View or Create New Report… via the Report menu item.)

Page �0 Finisar Proprietary Information, for Finisar and Finisar Customer Use Only. Do Not Distribute.

Xgig Analyzer 4.0

Setup the report using the options on the Report Setup dialog and press Create Report.


Page �1

The new report shows allowable options on the left, and a hyperlinked output on the right. Check or uncheck options on the left to add or remove items within the report. Click on hyperlinks to active Expert’s help system and read entries on the hyperlink’s topic.

Hyperlinks to Expert’s Help

Click Here to Select options

Xgig Analyzer: Quick Start Feature Guide

Finisar Headquarters1389 Moffett Park DriveSunnyvale, CA 94089-1133

Telephone: 408-548-1000www.finisar.com

Copyright © 2008, Finisar Corporation. All rights reserved. 2/08

Quick Start Feature Guide Xgig Analyzer: 4

Documents