1

Introduction



1.1    What WindView Can Do for You

Your real-time system consists of the VxWorks operating system, your real-time application, and the target hardware. The system involves complex interactions among tasks, interrupts, and VxWorks system objects (including message queues and semaphores). These interactions must occur within certain time constraints, often characterized by resolutions of microseconds or finer.

While common tools for debugging and benchmarking real-time systems, such as source-level debuggers and profilers, can provide much useful information about a system, they provide only a static picture of a dynamic situation. WindView acts as a logic analyzer for real-time software. It allows you to study the dynamic interactions of all the elements of your complex system.

Visualization

WindView displays the dynamic information about your real-time system in a view graph window, shown in Figure 1-1. The view graph provides manageable access to a wealth of information about the real-time system. With this window, you can scroll the information forward and backward in time and zoom in and out to different time scales. You can tailor the display to contain only the tasks and events you need to study.

Figure 1-1:   WindView View Graph

Focus

WindView provides tools to collect exactly the data you need. You can specify several levels of detail. You can use the triggering facility to start and stop data collection so that data is collected from a precise interval under precise conditions. You can manage data upload to the host to optimize your system resources. You can create your own application-specific events to provide precise information on a unique condition. You can use pre-packaged analysis tools to relate calculated information to specific system events.

Problem Solutions

Because it provides a view into the complex activities of a real-time system, WindView allows you to do the following:

  • Detect race conditions, deadlocks, CPU starvation, and other problems relating to task interaction.

  • Determine application responsiveness and performance.

  • See cyclic patterns in application behavior.

  • Save data for deferred analysis.

  • Conduct post-mortem analyses of failed systems.

Throughout this manual examples are given to demonstrate configuring and using WindView to solve real-life problems.



1.2    Integrated WindView

Tornado 2.2 includes WindView for your host simulator. When you start Tornado, you can immediately run VxWorks on your integrated simulator and use WindView to examine events generated by various built-in shell commands.

The integrated version of WindView is automatically configured for your integrated simulator; no preparation is required. Its only limitation is that it does not support non-simulator targets. This means that you only upload data from a simulator and that there is no network support; thus the TCP/IP upload path is not available.



1.3    System Requirements: Optional Product

WindView requires the host- and target-specific items listed in the following subsections. Be sure to consult the WindView Release Notes for more detailed information on supported platforms and any release-specific information.

Host Requirements
  • A recommended minimum of RAM on the host (see the Tornado Release Notes).
  • A supported host and host operating system (see the Tornado Release Notes).
  • The Tornado development environment installed on the host.
Target Requirements

  • The current release of VxWorks (included with Tornado).

  • WindView 2.2 instrumentation (included with WindView).

  • A supported target board. See the Tornado Release Notes for details on which boards support the high-resolution timestamp.

  • The appropriate VxWorks BSP for your target board.

  • Memory:

  • Approximately 10 KB more memory than that used by VxWorks alone (required for WindView on the target).


1.4    Documentation Guide

The WindView documentation consists of the WindView Release Notes, the WindView User's Guide (this document), the WindView User's Reference, and the WindView online help. Each component of the documentation is designed to serve a specific purpose, and will serve you best if you take that purpose into account.

About This Document

This user's guide is an introduction to using the WindView tool. It provides information on installing WindView, using the default configuration, and customizing the tool to solve specific types of problems. The appendices are sources of detailed information and context. They discuss the WindView architecture and application programming interfaces (APIs). Detailed reference material on the VxWorks routines that are specific to WindView is found in the online help.

The chapters provide the following types of information about WindView:

  • 2. Getting Started takes you through the steps required to get WindView running with Tornado and your target, gives you an overview of collecting data, and introduces you to the view graph display.

  • 6. Triggering provides both configuration and background information for the triggering facility.

Figure 1-2 diagrams the purposes of these chapters.

Figure 1-2:   Relationship and Level of Detail of Chapters

The appendices provide the following types of information about WindView:

  • F. Glossary provides reference information on WindView terminology.

Release Notes

The Release Notes contain release-specific information, including information detailing the changes between previous versions of WindView and this release.

Online Help

The online help includes context sensitive help for the GUI. It also includes a detailed table of contents and index with an extensive list of "How Do I...?" questions. One of these methods can take you directly to the information you need to complete a specific task. In many cases, the short answers in the online help contain links to the online version of the WindView User's Guide to provide in-depth information not contained in the help references. Access to the complete text of the User's Guide is also provided through the Contents tab.

Help Menu

When WindView is installed, the entry WindView Help appears in the main Help menu. When you point to this entry, the following commands appear in a submenu: Help Topics, Search for Help on, and Legend. The first two commands are typical Windows help commands which take you to the WindView help window.

Legend

This command displays a window that summarizes the meaning of every WindView event icon and stipple, and also provides links to the full description of each event in the online event dictionary. See The Legend Window for more discussion of this window.

Online Help Contents
  • How to Use Online Documentation
  • User Interface Commands
  • Frequently Asked Questions
  • Event Dictionary
  • WindView Glossary
  • Legend

Other Resources

For information related to WindView, you may wish to refer to the following:

  • Tornado User's Guide, for information on Tornado in general and on the tools included in the standard Tornado release.

  • VxWorks Programmer's Guide, VxWorks Reference Manual, and Tornado Online Manuals for information on VxWorks.

  • Tcl and the Tk Toolkit, by John K. Ousterhout, published by Addison-Wesley Publishing Company, for information on Tcl, the Tool command language.