https://github.com/binaryanalysisplatform/bap-pintraces
https://github.com/binaryanalysisplatform/bap-pintraces
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/binaryanalysisplatform/bap-pintraces
- Owner: BinaryAnalysisPlatform
- Created: 2016-03-17T08:34:38.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-12-19T21:54:42.000Z (over 6 years ago)
- Last Synced: 2025-05-07T17:15:01.084Z (about 1 year ago)
- Language: C
- Size: 285 KB
- Stars: 19
- Watchers: 3
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Overview
Pin tracer - a tracer based on [Pin: Intel’s Dynamic Binary Instrumentation
Engine.](https://software.intel.com/en-us/articles/pintool) It executes a binary
executable and saves trace data using [Protocol
Buffer](https://developers.google.com/protocol-buffers/) format. The contents of
the trace data is defined in
[bap-frames](https://github.com/BinaryAnalysisPlatform/bap-frames) project.
# Preparing to build
Note: building instructions assume that you're using Ubuntu, but it
may work on other systems, that uses apt-get.
Since this tool requires pin 2 which does not fully support Linux kernels 4.x
and later, it is recommended to use a virtual machine with [Ubuntu 14.04.1](http://old-releases.ubuntu.com/releases/14.04.0/ubuntu-14.04.1-server-amd64.iso).
Before build tracer, you need download and install
* [pin](https://software.intel.com/en-us/articles/pintool-downloads)
* autoconf, libtool, protobuf-compiler, libboost-dev, libboost-filesystem-dev, libcrypto++-dev
* [piqi library](http://piqi.org/doc/ocaml)
Here are installation example.
Download [pin](https://software.intel.com/en-us/articles/pintool-downloads) library:
```bash
$ wget http://software.intel.com/sites/landingpage/pintool/downloads/pin-2.14-71313-gcc.4.4.7-linux.tar.gz
```
Suppose you want install pin to $(HOME)/opt directory then:
```bash
$ tar xvzf pin-2.14-71313-gcc.4.4.7-linux.tar.gz -C $HOME/opt
```
To let Pin's makefiles know where Pin is installed, set the PIN_ROOT environment
variable with a command like:
```bash
$ export PIN_ROOT=$HOME/opt/pin-2.14-71313-gcc.4.4.7-linux
```
To let bash know where pin executable is installed add the PIN_ROOT to PATH
environment variable with a command like:
```bash
$ export PATH=$PATH:$PIN_ROOT
```
It is probably a good idea to put this command in
a startup script like .bashrc, so that you don't need to set the variable
every time you log in:
```bash
$ echo 'export PIN_ROOT=$HOME/opt/pin-2.14-71313-gcc.4.4.7-linux' >>$HOME/.bashrc
$ echo 'export PATH=$PATH:$PIN_ROOT' >>$HOME/.bashrc
```
To install apt depends, use the following command
```bash
$ sudo apt-get install autoconf libtool protobuf-compiler libprotobuf-dev libboost-filesystem-dev libcrypto++-dev
```
To install [piqi library](http://piqi.org/doc/ocaml) with
[opam](https://opam.ocaml.org/doc/Install.html), use the following command
```bash
$ curl -o /usr/bin/piqi -L https://raw.github.com/alavrik/piqi-binary/master/Linux-x86_64/piqi && chmod +x /usr/bin/piqi
```
(alternatively, you can try to install piqi with `opam install piqi` but this
may be more difficult as the opam version that comes with Ubuntu 14.04.1 is too old)
# Build process
Download [bap-frames](https://github.com/BinaryAnalysisPlatform/bap-frames) with
following command
```bash
$ git clone https://github.com/BinaryAnalysisPlatform/bap-frames.git
```
Change folder to `bap-frames/libtrace`. Build and install library with following command
```bash
$ ./autogen.sh
$ ./configure
$ make
$ make install
```
Download [bap-pintraces](https://github.com/BinaryAnalysisPlatform/bap-pintraces) with following command
```bash
$ git clone https://github.com/BinaryAnalysisPlatform/bap-pintraces.git
```
Change folder to bap-pintraces and build tracer with command
```
$ make
```
To run executable `exec` and to save taint infromation to `-exec.frames`, use
```bash
$ pin -injection child -t obj-intel64/gentrace.so -o exec.frames -logall_before 1 -- exec [exec args]
```
To run executable `exec` and to save the trace data to `exec.frames`, use
```bash
$ pin -injection child -t obj-intel64/bpt.so -o exec.frames -- exec [exec args]
```