Commit Graph

31 Commits

Author SHA1 Message Date
Philippe Waroquiers
ff2b7ff016 small refinement in the outer/inner doc
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15206
2015-05-10 18:17:38 +00:00
Florian Krohm
544aa45a0f Merge the contents of docs/internals/howto_build_documentation
into docs/README.
Remove the section about the XML Toolchain as it is outdated.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15019
2015-03-16 22:42:13 +00:00
Florian Krohm
df2bfc8447 Add a howto for building documentation.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15017
2015-03-16 12:22:35 +00:00
Philippe Waroquiers
14c1c10305 clarify that vg-in-place cannot be used as an outer in outer/inner setup
If you use a vg-in-place outer, then you obtain errors such as:
valgrind: mmap(0x38000000, 3293184) failed in UME with error 22 (Invalid argument).
valgrind: this can be caused by executables with very large text, data or bss segments.

What must be used is the "make install"-ed valgrind



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@13545
2013-09-12 21:12:24 +00:00
Josef Weidendorfer
df260d8344 README_DEVELOPERS: Debugging a tool needs "--tool=..."
Otherwise the function redirections / client requests seem
to get confused. Symptoms are error messages such as
--3031-- VG_USERREQ__CLIENT_CALL1: func=0x0

git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12852
2012-08-06 12:27:51 +00:00
Philippe Waroquiers
54dc680c2b fix typo in README_DEVELOPERS
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12557
2012-05-06 21:29:59 +00:00
Philippe Waroquiers
2bd926a725 outer/inner setup: new perf/vg_perf options to run perf tests + support translation chaining in inner.
* perf/vg_perf:
Similarly to tests/vg_regtest, perf/vg_perf now accepts the 3 
optional arguments:
    --outer-valgrind
    --outer-tool
    --outer-args

This allows easy analysis or comparison of performance between
different Valgrind versions (e.g. using callgrind, or cachegrind/cg_diff).

* See README_DEVELOPERS for more details.

* vg_regtest modified so as to use the 'in-place' build of inner, rather
  than the installed version.

* added option --smc-check=all-non-file to vg_perf and vg_regtest 
  outer default arguments (needed when evaluating a Valgrind which does
  translation chaining).




git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12496
2012-04-08 19:52:38 +00:00
Philippe Waroquiers
aa50a7e4df Allows to run regression tests in an outer/inner setup.
A '3 lines how to':
   perl tests/vg_regtest --outer-valgrind=../trunk_untouched/install/bin/valgrind --all
           (the outer results for a test xxx is in xxx.outer.log)
   To run with another tool (e.g. drd), add the argument --outer-tool=drd


Still to do/things to improve:

* Most (inner) tests are successful when running under an outer
  memcheck. Need to analyse the reasons of remaining failures.

* The memcheck annotations in m_mallocfree.c can be improved:
  - A superblock is marked 'undefined', it should rather be marked
    'no access'.
  - When a free block is splitted, the remaining free block is
    not made 'no access'. Instead, it is made 'undefined'.
      => this decreases the chance to find bugs.
      => this is not very efficient (e.g. the rest of a superblock
         is often marked undefined repetitively).
    Similarly, the free block created by VG_(arena_memalign)
    is marked 'undefined'. 'No access' would be preferrable.
  - mkInuseBlock marks the new block as undefined. This is probably
    not needed, as VALGRIND_MALLOCLIKE_BLOCK will do it already.
  - VG_(arena_malloc) should give the requested size to
    VALGRIND_MALLOCLIKE_BLOCK, not the malloc usable size,
    as this decreases the chance to find buffer overrun bugs.
    But giving the requested size is tricky (see comments in
    the code).

* need to do memcheck annotations in m_poolalloc.c
   so as to allow leak checking for pool allocated elements.

* vg_regtest.in
  - should analyse the results of the outer and should
    produce a separate result for the tests for which
    the outer detects an error or a memory leak or ...


Changes done:
   README_DEVELOPERS: document the new outer/inner features.
   manual-core.xml: document the new sim-hint no-inner-prefix
   tests/outer_inner.supp: new file, containing the suppressions for inner.
   vg_regtest.in: implement new args --outer-valgrind, --outer-tool, --outer-args.
   m_mallocfree.c: annotations for memcheck.
   m_libcprint.c: handle the new sim-hint no-inner-prefix
   m_main.c: do an (early) parse of --sim-hints




git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12441
2012-03-11 22:24:03 +00:00
Philippe Waroquiers
74d44d1764 * README_DEVELOPERS : complete/enhance the section about outer/inner
* manual-core.xml : fix a typo
* include/pub_tool_inner.h : new file, defining macros for inner annotation
  include/Makefile.am : reference this new file.
* syswrap-linux.c : when ENABLE_INNER, register the stacks for the outer.
   (otherwise, nothing works properly).
* m_redir.c : avoid inner interpreting the outer vgpreload instructions.
* sema.c : annotate the semaphore with RWLOCK annotations for helgrind
* ticket-lock-linux.c : similar.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12414
2012-03-03 12:01:48 +00:00
Florian Krohm
080238fd39 Add some verbiage about "make dist".
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@12170
2011-10-19 21:56:25 +00:00
Julian Seward
b43eec1219 Documentation update for 3.6.0 (not including NEWS).
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@11440
2010-10-13 21:47:29 +00:00
Nicholas Nethercote
f7198c4858 Various minor tweaks to the distribution docs.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10709
2009-08-04 07:02:54 +00:00
Nicholas Nethercote
fb0ebe0dfe Tweak the README -- make its text match the website, get rid of some of the
more detailed explanation (if they're reading the README, we probably don't
need to convince them about Valgrind's wonderfulness).


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10313
2009-06-12 23:40:04 +00:00
Nicholas Nethercote
86b2e5ec21 Extra info about debugging with GDB
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6854
2007-09-17 22:35:57 +00:00
Nicholas Nethercote
2e87ac2d9c Add a script to make running in-place simpler.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@6603
2007-02-19 04:09:24 +00:00
Nicholas Nethercote
8c294cb028 wibbles
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5952
2006-06-02 23:59:40 +00:00
Nicholas Nethercote
7992313b2f Add documentation on how to run the performance suite.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5951
2006-06-02 23:57:22 +00:00
Josef Weidendorfer
4daf8d83d6 Hint to better run with option "--pop-on-jump" when doing
self-hosting runs with outer callgrind.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5871
2006-05-01 01:49:28 +00:00
Tom Hughes
7acf361f06 Update README_DEVELOPERS to describe how to debug valgrind more
easily. Based on patch from Yao Qi <qiyaoltc@cn.ibm.com>.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5165
2005-11-17 12:31:12 +00:00
Nicholas Nethercote
bc87879123 Minor tweaks.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5154
2005-11-16 20:12:22 +00:00
Nicholas Nethercote
9b9daa1431 fix
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5101
2005-11-12 19:07:45 +00:00
Nicholas Nethercote
95ff6df5b7 need --trace-children when self-hosting
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@5064
2005-11-10 03:40:36 +00:00
Nicholas Nethercote
b9f2bd1a13 Record a useful nugget from Julian.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4995
2005-11-03 16:24:53 +00:00
Nicholas Nethercote
407e892ade clarify self-hosting instructions
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4897
2005-10-10 11:43:14 +00:00
Nicholas Nethercote
24c69df731 Document self-hosting.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4896
2005-10-10 11:36:55 +00:00
Julian Seward
cc8ccbbfb4 This commit merges in changes from branches/ASPACEM (specifically,
changes from r4341 through r4787 inclusive).  That branch is now dead.
Please do not commit anything else to it.

For the most part the merge was not troublesome.  The main areas of
uncertainty are:

- build system: I had to import by hand Makefile.core-AM_CPPFLAGS.am
  and include it in a couple of places.  Building etc seems to still
  work, but I haven't tried building the documentation.

- syscall wrappers: Following analysis by Greg & Nick, a whole lot of
  stuff was moved from -generic to -linux after the branch was created.
  I think that is satisfactorily glued back together now.

- Regtests: although this appears to work, no .out files appear, which
  is strange, and makes it hard to diagnose regtest failures.  In
  particular memcheck/tests/x86/scalar.stderr.exp remains in a 
  conflicted state.

- amd64 is broken (slightly), and ppc32 will be unbuildable.  I'll
  attend to the former shortly.



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@4789
2005-09-27 19:20:21 +00:00
Nicholas Nethercote
39fc3ebf0d Fix up old stuff in README_DEVELOPERS, including VALGRINDLIB instructions.
MERGED FROM CVS HEAD



git-svn-id: svn://svn.valgrind.org/valgrind/trunk@3305
2005-03-12 16:47:07 +00:00
Nicholas Nethercote
d62aa78d9d clarify debugging instructions
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@2901
2004-11-02 09:13:12 +00:00
Nicholas Nethercote
44f0b4c6d5 Add README_DEVELOPERS to the 'make dist' tarball (since it's mentioned in
README), and add some instructions about attaching GDB to Valgrind itself
within it.

This fixes bug 90138.

MERGE WITH STABLE


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@2738
2004-10-09 15:59:05 +00:00
Nicholas Nethercote
fc9a6bbced Updated the README file. It had lots of out-of-date and incorrect information
in it, much of it from 1.0.X days.  Did it in such a way that if it doesn't get
touched (and it undoubtedly won't) it won't really go out of date, eg. by
removing temporary details like version numbers, dates, details of specific
software incompatibilities.  It's much better to be vague but correct, than
precise but incorrect;  having incorrect info in a file as important as the
README is bad.  Also removed the README_KDE3_FOLKS file because it's pretty
redundant now.  Also added some changes that had been made in the stable branch
but not the HEAD.

Did similar, but smaller changes to README_DEVELOPERS and README_PACKAGERS.

Also updated the valgrind.spec.in file to use the new, post-1.0.X description
in the README.

Also fixed a minor omission in Addrcheck's docs.

MERGE TO STABLE


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@2089
2003-12-03 21:44:45 +00:00
Nicholas Nethercote
705542afcc Added README_DEVELOPERS file.
git-svn-id: svn://svn.valgrind.org/valgrind/trunk@1615
2003-05-05 13:04:49 +00:00