Getting Started - Revision history

Tcarlson at 12:15, 17 February 2019

2019-02-17T12:15:02Z

Tcarlson at 07:58, 16 February 2019

2019-02-16T07:58:03Z

Wheirman at 18:06, 7 April 2016

2016-04-07T18:06:14Z

Wheirman at 11:25, 31 July 2014

2014-07-31T11:25:21Z

Tcarlson at 15:14, 24 January 2013

2013-01-24T15:14:40Z

Tcarlson at 15:13, 24 January 2013

2013-01-24T15:13:59Z

Tcarlson at 03:46, 12 August 2012

2012-08-12T03:46:00Z

Tcarlson at 03:22, 12 August 2012

2012-08-12T03:22:45Z

Tcarlson: /* Prerequisites */

2012-07-26T02:34:43Z

Prerequisites

Tcarlson: /* Prerequisites */

2012-07-26T02:34:24Z

Prerequisites

@@ Line 9: / Line 9: @@
 * Install Option 1 - Docker Install
 ** <code>cd sniper/docker</code>
-** <code>make run # downloads the requirements and starts running a Docker instance</code>
+** <code>make # build the Docker image</code>
-** <code>cd .. # return to the base Sniper directory </code>
+** <code>make run # starts running the Docker image</code>
 * Install Option 2 - Native install

@@ Line 1: / Line 1: @@
 * Get the Sniper source code from our [[Download]] page
-* Download a Pin kit from the [http://www.pintool.org/downloads.html Pin downloads] page
+* Download a [https://software.intel.com/en-us/articles/pin-a-dynamic-binary-instrumentation-tool Pin] or [https://software.intel.com/en-us/articles/program-recordreplay-toolkit Pinplay] kit from their respective sites.
-** Do not use any (new) version that uses PinCRT. Currently the (older) revision 71313 is still available which is known to work with Sniper
+** The master branch of Sniper works with modern Pin versions (Pin 3.0+), while the pin2 branch works with older versions (Pin 2.14-71313). We recommend using a modern Pin 3 version if possible.
-** Extract Pin into sniper/pin_kit
+** Sniper 7.2 has been tested with versions of Pin up to Pin-3.7 and Pinplay-3.5.
-** Or set PIN_HOME to the location of Pin if you use a different directory or shared Pin location
+** Extract Pin and symlink or rename to the pin_kit directory in Sniper's subdirectory: <code>sniper/pin_kit</code>
-* Optional: Set target architecture
+* Install Option 1 - Docker Install
-** <code>export SNIPER_TARGET_ARCH=ia32 # default: intel64 (or update Makefile.config)</code>
+** <code>cd sniper/docker</code>
-** <code>sudo apt-get install libc6-dev-i386 g++-4.4-multilib lib32z1-dev # install 32-bit libraries if running 64-bit OS (Ubuntu in this case) and the g++ multilib version depends on the g++ version that you are using</code>
+** <code>make run # downloads the requirements and starts running a Docker instance</code>
 * Compile Sniper. Some extra dependencies (a pre-compiled copy of the Python interpreter environment) will be downloaded automatically, so make sure you have a working internet connection when you make Sniper for the first time
@@ Line 32: / Line 38: @@
 === Prerequisites ===
-* GCC 4.3 or higher
+* Modern Ubuntu version (16.04, 18.04, etc.)
-* A recent Pin version (for example, [http://www.pintool.org/ 2.14-71313] or newer)
+* A recent Pin version (for example, [https://software.intel.com/en-us/articles/pin-a-dynamic-binary-instrumentation-tool Pin 3.5] or newer recommended)

@@ Line 1: / Line 1: @@
 * Get the Sniper source code from our [[Download]] page
-* Download the latest Pin kit from the [http://www.pintool.org/downloads.html Pin downloads] page
+* Download a Pin kit from the [http://www.pintool.org/downloads.html Pin downloads] page
 ** Extract Pin into sniper/pin_kit
 ** Or set PIN_HOME to the location of Pin if you use a different directory or shared Pin location
@@ Line 32: / Line 33: @@
 * GCC 4.3 or higher
-* A recent Pin version (for example, [http://www.pintool.org/ 2.11-49306] or newer)
+* A recent Pin version (for example, [http://www.pintool.org/ 2.14-71313] or newer)
 * Boost 1.38+
 * Linux 2.6.22+

@@ Line 6: / Line 6: @@
 * Optional: Set target architecture
-** <code>export TARGET_ARCH=ia32 # default: intel64 (or update Makefile.config)</code>
+** <code>export SNIPER_TARGET_ARCH=ia32 # default: intel64 (or update Makefile.config)</code>
 ** <code>sudo apt-get install libc6-dev-i386 g++-4.4-multilib lib32z1-dev # install 32-bit libraries if running 64-bit OS (Ubuntu in this case) and the g++ multilib version depends on the g++ version that you are using</code>

@@ Line 10: / Line 10: @@
 * Compile Sniper. Some extra dependencies (a pre-compiled copy of the Python interpreter environment) will be downloaded automatically, so make sure you have a working internet connection when you make Sniper for the first time
-** <code>make # or use 'make -j N' for multicore machines</code>
+** <code>make # or use 'make -j N' where N is the number of cores in your machine to use parallel make</code>
 * Running an application