1 <html> 2 <head> 3 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> 4 <title>3.README</title> 5 <link rel="stylesheet" href="vg_basic.css" type="text/css"> 6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> 7 <link rel="home" href="index.html" title="Valgrind Documentation"> 8 <link rel="up" href="dist.html" title="Valgrind Distribution Documents"> 9 <link rel="prev" href="dist.news.html" title="2.NEWS"> 10 <link rel="next" href="dist.readme-missing.html" title="4.README_MISSING_SYSCALL_OR_IOCTL"> 11 </head> 12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13 <div><table class="nav" width="100%" cellspacing="3" cellpadding="3" border="0" summary="Navigation header"><tr> 14 <td width="22px" align="center" valign="middle"><a accesskey="p" href="dist.news.html"><img src="images/prev.png" width="18" height="21" border="0" alt="Prev"></a></td> 15 <td width="25px" align="center" valign="middle"><a accesskey="u" href="dist.html"><img src="images/up.png" width="21" height="18" border="0" alt="Up"></a></td> 16 <td width="31px" align="center" valign="middle"><a accesskey="h" href="index.html"><img src="images/home.png" width="27" height="20" border="0" alt="Up"></a></td> 17 <th align="center" valign="middle">Valgrind Distribution Documents</th> 18 <td width="22px" align="center" valign="middle"><a accesskey="n" href="dist.readme-missing.html"><img src="images/next.png" width="18" height="21" border="0" alt="Next"></a></td> 19 </tr></table></div> 20 <div class="chapter" title="3.README"> 21 <div class="titlepage"><div><div><h2 class="title"> 22 <a name="dist.readme"></a>3.README</h2></div></div></div> 23 <div class="literallayout"><p><br> 24 <br> 25 ReleasenotesforValgrind<br> 26 ~~~~~~~~~~~~~~~~~~~~~~~~~~<br> 27 IfyouarebuildingabinarypackageofValgrindfordistribution,<br> 28 pleasereadREADME_PACKAGERS.Itcontainssomeimportantinformation.<br> 29 <br> 30 IfyouaredevelopingValgrind,pleasereadREADME_DEVELOPERS.Itcontains<br> 31 someusefulinformation.<br> 32 <br> 33 Forinstructionsonhowtobuild/install,seetheendofthisfile.<br> 34 <br> 35 Ifyouhaveproblems,consulttheFAQtoseeifthereareworkarounds.<br> 36 <br> 37 <br> 38 ExecutiveSummary<br> 39 ~~~~~~~~~~~~~~~~~<br> 40 Valgrindisaframeworkforbuildingdynamicanalysistools.Thereare<br> 41 Valgrindtoolsthatcanautomaticallydetectmanymemorymanagement<br> 42 andthreadingbugs,andprofileyourprogramsindetail.Youcanalso<br> 43 useValgrindtobuildnewtools.<br> 44 <br> 45 TheValgrinddistributioncurrentlyincludessixproduction-quality<br> 46 tools:amemoryerrordetector,twothreaderrordetectors,acache<br> 47 andbranch-predictionprofiler,acall-graphgeneratingcacheabd<br> 48 branch-predictionprofiler,andaheapprofiler.Italsoincludes<br> 49 threeexperimentaltools:aheap/stack/globalarrayoverrundetector,<br> 50 adifferentkindofheapprofiler,andaSimPointbasicblockvector<br> 51 generator.<br> 52 <br> 53 ValgrindiscloselytiedtodetailsoftheCPU,operatingsystemandto<br> 54 alesserextent,compilerandbasicClibraries.Thismakesitdifficult<br> 55 tomakeitportable.Nonetheless,itisavailableforthefollowing<br> 56 platforms:<br> 57 <br> 58 -x86/Linux<br> 59 -AMD64/Linux<br> 60 -PPC32/Linux<br> 61 -PPC64/Linux<br> 62 -ARM/Linux<br> 63 -x86/MacOSX<br> 64 -AMD64/MacOSX<br> 65 <br> 66 NotethatAMD64isjustanothernameforx86-64,andValgrindrunsfine<br> 67 onIntelprocessors.AlsonotethatthecoreofMacOSXiscalled<br> 68 "Darwin"andthisnameisusedsometimes.<br> 69 <br> 70 ValgrindislicensedundertheGNUGeneralPublicLicense,version2.<br> 71 ReadthefileCOPYINGinthesourcedistributionfordetails.<br> 72 <br> 73 However:ifyoucontributecode,youneedtomakeitavailableasGPL<br> 74 version2orlater,andnot2-only.<br> 75 <br> 76 <br> 77 Documentation<br> 78 ~~~~~~~~~~~~~<br> 79 Acomprehensiveuserguideissupplied.Pointyourbrowserat<br> 80 $PREFIX/share/doc/valgrind/manual.html,where$PREFIXiswhateveryou<br> 81 specifiedwith--prefix=whenbuilding.<br> 82 <br> 83 <br> 84 Buildingandinstallingit<br> 85 ~~~~~~~~~~~~~~~~~~~~~~~~~~<br> 86 ToinstallfromtheSubversionrepository:<br> 87 <br> 88 0.CheckoutthecodefromSVN,followingtheinstructionsat<br> 89 http://www.valgrind.org/downloads/repository.html.<br> 90 <br> 91 1.cdintothesourcedirectory.<br> 92 <br> 93 2.Run./autogen.shtosetuptheenvironment(youneedthestandard<br> 94 autoconftoolstodoso).<br> 95 <br> 96 3.Continuewiththefollowinginstructions...<br> 97 <br> 98 Toinstallfromatar.bz2distribution:<br> 99 <br> 100 4.Run./configure,withsomeoptionsifyouwish.Theonlyinteresting<br> 101 oneistheusual--prefix=/where/you/want/it/installed.<br> 102 <br> 103 5.Run"make".<br> 104 <br> 105 6.Run"makeinstall",possiblyasrootifthedestinationpermissions<br> 106 requirethat.<br> 107 <br> 108 7.Seeifitworks.Try"valgrindls-l".Eitherthisworks,orit<br> 109 bombsoutwithsomecomplaint.Inthatcase,pleaseletusknow<br> 110 (seewww.valgrind.org).<br> 111 <br> 112 Important!Donotmovethevalgrindinstallationintoaplace<br> 113 differentfromthatspecifiedby--prefixatbuildtime.Thiswill<br> 114 causethingstobreakinsubtleways,mostlywhenValgrindhandles<br> 115 fork/execcalls.<br> 116 <br> 117 <br> 118 TheValgrindDevelopers<br> 119 <br> 120 </p></div> 121 </div> 122 <div> 123 <br><table class="nav" width="100%" cellspacing="3" cellpadding="2" border="0" summary="Navigation footer"> 124 <tr> 125 <td rowspan="2" width="40%" align="left"> 126 <a accesskey="p" href="dist.news.html"><<2.NEWS</a></td> 127 <td width="20%" align="center"><a accesskey="u" href="dist.html">Up</a></td> 128 <td rowspan="2" width="40%" align="right"><a accesskey="n" href="dist.readme-missing.html">4.README_MISSING_SYSCALL_OR_IOCTL>></a> 129 </td> 130 </tr> 131 <tr><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td></tr> 132 </table> 133 </div> 134 </body> 135 </html> 136
