WindView

User's Guide

2.2

1 Introduction

1.1 What WindView Can Do for You

1.2 Integrated WindView

1.3 System Requirements: Optional Product

1.4 Documentation Guide

About This Document

Release Notes

Online Help

Other Resources

2 Getting Started

2.1 Introduction

2.2 Running WindView

2.2.1 The WindView Defaults

Launch WindView

Collection Configuration

Upload Configuration

2.2.2 Collecting Data

Start WindView

View Log Status

Stop WindView

Upload Data

Saving the Log File

2.3 An Overview of WindView

2.3.1 Understanding Events

2.3.2 The View Graph

2.3.3 The WindView Task

2.4 WindView Optional Product

2.4.1 Installing WindView

2.4.2 Configuring VxWorks

WindView Libraries

Timestamp Driver

Upload Path

Post-Mortem Analysis

Triggering

Rebuilding VxWorks and Rebooting Your Target

2.4.3 Starting a Target Server

Configuring the Target Server for TSFS

Launching the Target Server

2.5 Preparing for Distribution

3 Configuring Data Collection

3.1 Introduction

3.2 Selecting a Logging Level

Context Switch Logging Level (CSE Level)

Task State Transition Logging Level (TST Level)

Additional Instrumentation Logging Level (AIL Level)

3.3 Instrumented Objects

The Selection Screen

The Memory Library

Networking Library

3.4 Starting and Stopping Data Collection

4 Configuring Data Upload

4.1 Introduction

4.2 Dynamic Ring Buffer

4.2.1 Parameters

Minimum Buffer Count

Maximum Buffer Count

Buffer Size

4.2.2 Buffer-Full Behavior

4.3 Upload Path and Destination

4.3.1 Alternative Upload Paths

Target Server

Network Facilities

4.3.2 Alternative Destinations

View Graph

File

4.3.3 Choosing the Path and Destination

Direct to Graph

File via TSFS

Socket via TSFS

Socket via TCP/IP

NFS to File

4.4 Upload Mode

Deferred Upload Mode

Continuous Upload Mode

Post-Mortem Mode

5 Data Display

5.1 Introduction

5.2 Controlling the Displayed Interval

The Tool Bar

The Event Pop-Up Menu

5.3 Viewing Context Information

The Task Pop-Up Menu

Context State Information

Context State Summary

5.4 Viewing Event Information

The Status Bar

The Show Event Dialog Box

The Legend Window

The Event Dictionary

Log Properties Dialog Box

5.5 Viewing Analog Information

Analysis Packs

Splitting the View Graph

Exporting Data to Excel (Windows only)

Exporting Data to File (UNIX Only)

5.6 Filtering for Data of Interest

Specify Which Tasks to Display

Hide Nonexecuting States

The Filter Events/States Dialog Box

6 Triggering

6.1 Introduction

6.2 The Triggering GUI

Specifying a Trigger

Specifying an Action

Saving a Trigger Configuration

Loading a Trigger Configuration File

Starting Triggering

Stopping Triggering

Chaining Triggers

6.3 Using Triggers

Using a Trigger to Start Log Collection

Using a Trigger to Stop Log Collection

Triggering Examples

Other Uses of Triggering

7 Data Collection

7.1 Introduction

7.2 Instrumenting Objects Programmatically

7.2.1 Kernel Libraries

7.2.2 Additional Libraries

memLib

netLib

7.3 Adding Eventpoints

The e( ) Routine

The wvEvent( ) Routine

7.4 Merging Logs from Multiple Processors

7.5 Timestamping

High-Resolution Timestamp Driver

Sequence-Stamp Driver

7.6 Dynamic Buffer Allocation

7.6.1 Configuring the Event Log Buffer

Upload Mode

rBuff Task Priority

Target Memory Constraints

7.6.2 Configuration Tuning

8 Data Upload

8.1 Introduction

8.2 Data Upload Mode

Deferred Upload Mode

Continuous Upload Mode

Post-Mortem Mode

Configuring the Upload Task

8.3 Data Upload to the Host

The Target Server Path

The Network Path

8.4 The Event Receive Tool

Running Event Receive on UNIX

Running Event Receive on Windows

A WindView Architecture

A.1 Introduction

A.2 Host Facilities

WindView

Event-Base

Non-WindView Tools

A.3 Target Facilities

WindView

VxWorks Events

Logging

Timestamp Driver

Triggering

Dynamic Ring Buffer

A.4 Communication Facilities

WindView Communication

Event Data Upload

B Event-Base API

B.1 Introduction

B.2 C++ API

WVEventBase Class

WVContext Class

WVEvent Class

WVCoords Class

Supported Compilers

Runtime Errors

B.3 Tcl API

Event-Base Commands

Alternative Output Formats

Coordinates Commands

Typical (Simplified) Tcl Session

Event Definition File Format

B.4 Example

C Triggering API

C.1 Overview

C.2 Trigger Structure

C.3 Triggering API

Adding a Trigger to the Trigger List

Deleting a Trigger from the Trigger List

Activating Triggering

Deactivating Triggering

Showing Information on Triggers

Changing Trigger Status

Creating a User Event to Fire a Trigger

D Customizing WindView and User Applications

D.1 Introduction

D.2 Customizing WindView Tcl Initialization Files

D.3 Customizing the Show Event Dialog Box for User Events

D.4 Creating Icons for User-Defined Events

D.5 Updating Non-WRS Code to WindView 2.2

E Creating a VxWorks Timestamp Driver

E.1 Introduction

E.2 Hardware Overview

Modes of Operation

Characteristics of Hardware Timers

VxWorks Requirements for Timestamp Timers

E.3 Timestamp Driver Interface

sysTimestampConnect( )

sysTimestampEnable( )

sysTimestampDisable( )

sysTimestampPeriod( )

sysTimestampFreq( )

sysTimestamp( )

sysTimestampLock( )

E.4 Writing the Driver

Timers That Can Be Read While Enabled

Working Around Deficiencies in Hardware Timers

Using the VxWorks System Clock Timer

E.5 Using the Timestamp Driver with WindView

Attaching the Timestamp Driver to VxWorks

Using the System Clock

E.6 Sample Drivers

F Glossary

Index