Blame README

Packit b1f7ae
Intel(R) Processor Trace Decoder Library
Packit b1f7ae
========================================
Packit b1f7ae
Packit b1f7ae
The Intel Processor Trace (Intel PT) Decoder Library is Intel's reference
Packit b1f7ae
implementation for decoding Intel PT.  It can be used as a standalone library or
Packit b1f7ae
it can be partially or fully integrated into your tool.
Packit b1f7ae
Packit b1f7ae
The library comes with a set of sample tools built on top of it and a test
Packit b1f7ae
system built on top of the sample tools.  The samples demonstrate how to use the
Packit b1f7ae
library and may serve as a starting point for integrating the library into your
Packit b1f7ae
tool.
Packit b1f7ae
Packit b1f7ae
Go to https://software.intel.com/en-us/intel-platform-analysis-library for
Packit b1f7ae
support of upcoming (non-public) processors (NDA required).
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
Contents
Packit b1f7ae
--------
Packit b1f7ae
Packit b1f7ae
  README        this file
Packit b1f7ae
Packit b1f7ae
  libipt        A packet encoder/decoder library
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
Optional Contents and Samples
Packit b1f7ae
-----------------------------
Packit b1f7ae
Packit b1f7ae
  ptdump        Example implementation of a packet dumper
Packit b1f7ae
Packit b1f7ae
  ptxed         Example implementation of a trace disassembler
Packit b1f7ae
Packit b1f7ae
  pttc          A trace test generator
Packit b1f7ae
Packit b1f7ae
  ptunit        A simple unit test system
Packit b1f7ae
Packit b1f7ae
  script        A collection of scripts
Packit b1f7ae
Packit b1f7ae
  test          A collection of tests
Packit b1f7ae
Packit b1f7ae
  include       A collection of substitute headers
Packit b1f7ae
Packit b1f7ae
  doc           A document describing the build
Packit b1f7ae
                A document describing how to get started
Packit b1f7ae
                A document describing the usage of the decoder library
Packit b1f7ae
                A document describing how to capture trace
Packit b1f7ae
                A document describing pttc
Packit b1f7ae
Packit b1f7ae
  doc/man       Man pages for the encoder/decoder library
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
Dependencies
Packit b1f7ae
------------
Packit b1f7ae
Packit b1f7ae
We use cmake for building.
Packit b1f7ae
Packit b1f7ae
  cmake         The cross-platform open-source build system.
Packit b1f7ae
                http://www.cmake.org
Packit b1f7ae
Packit b1f7ae
Packit b1f7ae
Other packages you need for some of the above optional components.
Packit b1f7ae
Packit b1f7ae
  xed           The Intel x86 instruction encoder and decoder.
Packit b1f7ae
                http://www.intel.com/software/xed
Packit b1f7ae
Packit b1f7ae
                This is needed to build and run ptxed.
Packit b1f7ae
Packit b1f7ae
  yasm          The Yasm Modular Assembler
Packit b1f7ae
                http://github.com/yasm
Packit b1f7ae
Packit b1f7ae
                This is needed to run pttc.
Packit b1f7ae
Packit b1f7ae
  pandoc        A universal document converter
Packit b1f7ae
                http://pandoc.org
Packit b1f7ae
Packit b1f7ae
                This is needed for man pages.