About This Guide

This chapter includes:

What you'll find in this guide

The QNX Neutrino System Analysis Toolkit User's Guide describes how to use the instrumented microkernel to obtain a detailed analysis of what's happening in an entire QNX Neutrino system. This guide contains the following sections and chapters:

To find out about: Go to:
What the SAT is, what it can do for you, and how it works Introduction
What generates events Events and the Kernel
How the kernel buffers data Kernel Buffer Management
How to save data Capturing Trace Data
Different ways to reduce the amount of data Filtering
What the data tells you Interpreting Trace Data
Examples of filtering the trace data Tutorials
Sample data-capture and parsing programs Sample Programs
What specific events return Current Trace Events and Data

Typographical conventions

Throughout this manual, we use certain typographical conventions to distinguish technical terms. In general, the conventions we use conform to those found in IEEE POSIX publications. The following table summarizes our conventions:

Reference Example
Code examples if( stream == NULL )
Command options -lR
Commands make
Environment variables PATH
File and pathnames /dev/null
Function names exit()
Keyboard chords Ctrl-Alt-Delete
Keyboard input something you type
Keyboard keys Enter
Program output login:
Programming constants NULL
Programming data types unsigned short
Programming literals 0xFF, "message string"
Variable names stdin
User-interface components Cancel

We use an arrow (→) in directions for accessing menu items, like this:

You'll find the Other... menu item under Perspective-->Show View.

We use notes, cautions, and warnings to highlight important messages:

Note: Notes point out something important or useful.

Caution: Cautions tell you about commands or procedures that may have unwanted or undesirable side effects.

WARNING: Warnings tell you about commands or procedures that could be dangerous to your files, your hardware, or even yourself.

Note to Windows users

In our documentation, we use a forward slash (/) as a delimiter in all pathnames, including those pointing to Windows files.

We also generally follow POSIX/UNIX filesystem conventions.

Technical support

To obtain technical support for any QNX product, visit the Support area on our website (www.qnx.com). You'll find a wide range of support options, including community forums.

Copyright © 2001–2018, QNX Software Systems Limited, a subsidiary of BlackBerry Limited. All rights reserved.