README

   1 Release notes for Valgrind
   2 ~~~~~~~~~~~~~~~~~~~~~~~~~~
   3 If you are building a binary package of Valgrind for distribution,
   4 please read README_PACKAGERS.  It contains some important information.
   5
   6 If you are developing Valgrind, please read README_DEVELOPERS.  It contains
   7 some useful information.
   8
   9 For instructions on how to build/install, see the end of this file.
  10
  11 If you have problems, consult the FAQ to see if there are workarounds.
  12
  13
  14 Executive Summary
  15 ~~~~~~~~~~~~~~~~~
  16 Valgrind is a framework for building dynamic analysis tools. There are
  17 Valgrind tools that can automatically detect many memory management
  18 and threading bugs, and profile your programs in detail. You can also
  19 use Valgrind to build new tools.
  20
  21 The Valgrind distribution currently includes seven production-quality
  22 tools: a memory error detector, two thread error detectors, a cache
  23 and branch-prediction profiler, a call-graph generating cache and
  24 branch-prediction profiler, and two heap profilers. It also includes
  25 one experimental tool: a SimPoint basic block vector generator.
  26
  27 Valgrind is closely tied to details of the CPU, operating system and to
  28 a lesser extent, compiler and basic C libraries. This makes it difficult
  29 to make it portable.  Nonetheless, it is available for the following
  30 platforms:
  31
  32 - X86/Linux
  33 - AMD64/Linux
  34 - PPC32/Linux
  35 - PPC64/Linux
  36 - ARM/Linux
  37 - ARM64/Linux
  38 - X86/macOS
  39 - AMD64/macOS
  40 - S390X/Linux
  41 - MIPS32/Linux
  42 - MIPS64/Linux
  43 - nanoMIPS/Linux
  44 - X86/Solaris
  45 - AMD64/Solaris
  46 - X86/FreeBSD
  47 - AMD64/FreeBSD
  48 - ARM64/FreeBSD
  49
  50 Note that AMD64 is just another name for x86_64, and Valgrind runs fine
  51 on Intel processors.  Also note that the core of macOS is called
  52 "Darwin" and this name is used sometimes.
  53
  54 Valgrind is licensed under the GNU General Public License, version 2.
  55 Read the file COPYING in the source distribution for details.
  56
  57 However: if you contribute code, you need to make it available as GPL
  58 version 2 or later, and not 2-only.
  59
  60
  61 Documentation
  62 ~~~~~~~~~~~~~
  63 A comprehensive user guide is supplied.  Point your browser at
  64 $PREFIX/share/doc/valgrind/manual.html, where $PREFIX is whatever you
  65 specified with --prefix= when building.
  66
  67
  68 Building and installing it
  69 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  70 To install from the GIT repository:
  71
  72   0. Clone the code from GIT:
  73      git clone https://sourceware.org/git/valgrind.git
  74      There are further instructions at
  75      http://www.valgrind.org/downloads/repository.html.
  76
  77   1. cd into the source directory.
  78
  79   2. Run ./autogen.sh to setup the environment (you need the standard
  80      autoconf tools to do so).
  81
  82   3. Continue with the following instructions...
  83
  84 To install from a tar.bz2 distribution:
  85
  86   4. Run ./configure, with some options if you wish.  The only interesting
  87      one is the usual --prefix=/where/you/want/it/installed.
  88
  89   5. Run "make".
  90
  91   6. Run "make install", possibly as root if the destination permissions
  92      require that.
  93
  94   7. See if it works.  Try "valgrind ls -l".  Either this works, or it
  95      bombs out with some complaint.  In that case, please let us know
  96      (see http://valgrind.org/support/bug_reports.html).
  97
  98 Important!  Do not move the valgrind installation into a place
  99 different from that specified by --prefix at build time.  This will
 100 cause things to break in subtle ways, mostly when Valgrind handles
 101 fork/exec calls.
 102
 103
 104 The Valgrind Developers