From b96bef0ed6544ddcd20af6ce2bf3b1282953b5f7 Mon Sep 17 00:00:00 2001 From: William Cohen Date: Wed, 9 Mar 2011 16:31:39 -0500 Subject: Update the README --- README | 45 +++++++++++++++++++-------------------------- 1 file changed, 19 insertions(+), 26 deletions(-) diff --git a/README b/README index 5195524..232abc9 100644 --- a/README +++ b/README @@ -1,39 +1,31 @@ -MUTRACE Mutex Tracer +MEMSTOMP memcpy checker GIT: - git://git.0pointer.de/mutrace.git + clone http://wcohen.fedorapeople.org/git/memstomp/ GITWEB: - http://git.0pointer.de/?p=mutrace.git + http://fedorapeople.org/gitweb?p=wcohen/public_git/memstomp.git NOTES: - For a terse overview what mutrace can do for you, please read - the announcement blog story: + memstomp checks the operation of memcpy. In particular memstomp + warns when memcpy is used to copy overlapping regions of + memory (such as the problem encountered in + https://bugzilla.redhat.com/show_bug.cgi?id=638477) - http://0pointer.de/blog/projects/mutrace.html + Just use it as prefix for your usual command line and it will + check memcpy used in all child processes. Example: - The tarball includes two profilers: + memstomp gedit - mutrace profiles lock contention for you. Just use it as - prefix for your usual command line and it will profile - mutexes used in all child processes. Example: - - mutrace gedit - - matrace traces memory allocation operations in realtime - threads for you. It is of no use in applications that do not - make use of realtime scheduling. Example: - - matrace myrealtimetool - - Both tools understand a --debug-info switch in which case the + The tool understands a --debug-info switch in which case the backtraces generated will include debugging information such as line numbers and source file names. This is not enabled by default since generating those traces is not always safe in situations where locks are taken or memory allocated as we do it here. YMMV. - mutrace cannot be used to profile glibc-internal mutexes. + Note that valgrind can perform this type of check also. + memstomp merely lowers the overhead for this type of check. LICENSE: LGPLv3+ @@ -41,14 +33,15 @@ LICENSE: Exception: backtrace-symbols.c is GPLv2+. Which probably means that using - the --debug-info switch for mutrace and matrace might not be - legally safe for non-GPL-compatible applications. However, - since that module is independantly built into a seperate .so - it should still be safe using the profilers without this - switch on such software. + the --debug-info switch for memstomp might not be legally safe + for non-GPL-compatible applications. However, since that + module is independantly built into a seperate .so it should + still be safe using the profilers without this switch on such + software. AUTHORS: Lennart Poettering + William Cohen REQUIREMENTS: Recent gcc, glibc, Linux -- cgit