README

   1 Intel(R) Processor Trace Decoder Library
   2 ========================================
   3
   4 The Intel Processor Trace (Intel PT) Decoder Library is Intel's reference
   5 implementation for decoding Intel PT.  It can be used as a standalone library or
   6 it can be partially or fully integrated into your tool.
   7
   8 The library comes with a set of sample tools built on top of it and a test
   9 system built on top of the sample tools.  The samples demonstrate how to use the
  10 library and may serve as a starting point for integrating the library into your
  11 tool.
  12
  13 Go to https://software.intel.com/en-us/intel-platform-analysis-library for
  14 support of upcoming (non-public) processors (NDA required).
  15
  16
  17 Contents
  18 --------
  19
  20   README        this file
  21
  22   libipt        A packet encoder/decoder library
  23
  24
  25 Optional Contents and Samples
  26 -----------------------------
  27
  28   ptdump        Example implementation of a packet dumper
  29
  30   ptxed         Example implementation of a trace disassembler
  31
  32   pttc          A trace test generator
  33
  34   ptunit        A simple unit test system
  35
  36   sideband      A sideband correlation library
  37
  38   pevent        A library for reading/writing Linux perf event records
  39
  40   script        A collection of scripts
  41
  42   test          A collection of tests
  43
  44   include       A collection of substitute headers
  45
  46   doc           A document describing the build
  47                 A document describing how to get started
  48                 A document describing the usage of the decoder library
  49                 A document describing how to capture trace
  50                 A document describing pttc
  51
  52   doc/man       Man pages for the encoder/decoder library
  53
  54
  55 Dependencies
  56 ------------
  57
  58 We use cmake for building.
  59
  60   cmake         The cross-platform open-source build system.
  61                 http://www.cmake.org
  62
  63
  64 Other packages you need for some of the above optional components.
  65
  66   xed           The Intel x86 instruction encoder and decoder.
  67                 https://github.com/intelxed/xed
  68
  69                 This is needed to build and run ptxed.
  70
  71   yasm          The Yasm Modular Assembler
  72                 http://github.com/yasm
  73
  74                 This is needed to run pttc.
  75
  76   pandoc        A universal document converter
  77                 http://pandoc.org
  78
  79                 This is needed for man pages.