├── VERSION ├── .gitignore ├── libleaktracer ├── include │ ├── LeakTracer_l.hpp │ ├── leaktracer.h │ ├── MutexLock.hpp │ ├── Mutex.hpp │ ├── MapMemoryInfo.hpp │ ├── ObjectsPool.hpp │ └── MemoryTrace.hpp └── src │ ├── LeakTracerC.c │ ├── AllocationHandlers.cpp │ └── MemoryTrace.cpp ├── THANKS ├── TODO ├── AUTHORS ├── INSTALL ├── helpers ├── leak-analyze-addr2line ├── leak-analyze-gdb └── leak-check ├── tests └── test.cc ├── NEWS ├── Makefile ├── README ├── COPYING └── COPYING.LIB /VERSION: -------------------------------------------------------------------------------- 1 | 3.0 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build/ 2 | leaks.out 3 | -------------------------------------------------------------------------------- /libleaktracer/include/LeakTracer_l.hpp: -------------------------------------------------------------------------------- 1 | #ifndef __LEAKTRACE_L_h_included__ 2 | #define __LEAKTRACE_L_h_included__ 3 | 4 | #ifndef TRACE 5 | #ifdef LOGGER 6 | #define TRACE(arg) fprintf arg 7 | #else 8 | #define TRACE(arg) 9 | #endif 10 | #endif 11 | 12 | #define LEAKTRACER_VERSION "3.0.0" 13 | 14 | #endif /* __LEAKTRACE_L_h_included__ */ 15 | -------------------------------------------------------------------------------- /libleaktracer/include/leaktracer.h: -------------------------------------------------------------------------------- 1 | #ifndef __LEAKTRACER_H__ 2 | #define __LEAKTRACER_H__ 3 | 4 | #ifdef __cplusplus 5 | extern "C" 6 | { 7 | #endif 8 | 9 | /** starts monitoring memory allocations in all threads */ 10 | void leaktracer_startMonitoringAllThreads(void); 11 | 12 | /** starts monitoring memory allocations in current thread */ 13 | void leaktracer_startMonitoringThisThread(void); 14 | 15 | /** stops monitoring memory allocations (in all threads or in 16 | * this thread only, depends on the function used to start 17 | * monitoring 18 | */ 19 | void leaktracer_stopMonitoringAllocations(void); 20 | 21 | /** stops all monitoring - both of allocations and releases */ 22 | void leaktracer_stopAllMonitoring(void); 23 | 24 | /** writes report with all memory leaks */ 25 | void leaktracer_writeLeaksToFile(const char* reportFileName); 26 | 27 | #ifdef __cplusplus 28 | } 29 | #endif 30 | 31 | #endif /* LEAKTRACER_H */ 32 | -------------------------------------------------------------------------------- /THANKS: -------------------------------------------------------------------------------- 1 | Here is a list of people, who helped in LeakTracer development. 2 | Please help us to keep it complete and free of errors. 3 | 4 | Erwin S. Andreasen erwin@andreasen.org 5 | Yann Dirson 6 | Frederic Germain 7 | José María González 8 | Michael Gopshtein mgopshtein@gmail.com 9 | Robin Hiroko Walsh 10 | Amir Kirsh 11 | Andrew Ogley 12 | Greg Stewart 13 | Henner Zeller H.Zeller@acm.org 14 | Ido Zilbergled 15 | Patrick 16 | Боби Б. 17 | Nikita Melnichenko [http://nikita.melnichenko.name] 18 | 19 | 20 | 21 | Copyright 1998, 1999, 2000, 2001, 2002, 2003 Free Software Foundation, Inc. 22 | 23 | This file is free software; as a special exception the author gives 24 | unlimited permission to copy and/or distribute it, with or without 25 | modifications, as long as this notice is preserved. 26 | 27 | This file is distributed in the hope that it will be useful, but 28 | WITHOUT ANY WARRANTY, to the extent permitted by law; without even the 29 | implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 30 | -------------------------------------------------------------------------------- /TODO: -------------------------------------------------------------------------------- 1 | What's left to do 2 | 3 | * dynamic ALLOCATION_STACK_DEPTH based on an environment variable 4 | 5 | * basic heap smashing detection using a marker system (though other library might 6 | do some better job than us by design) 7 | 8 | * Integrating better frontend for leak analyzis. 9 | **Most interresting would be to find a way to be independant from gdb to lookup leak address in library depedency. 10 | **Graphical tools? 11 | 12 | * Cleaning MemoryTrace.hpp to export to program, renaming it ot LeakTracer.hpp ?? 13 | 14 | * Extending leak detection to other kind of leak : 15 | ** file descriptors 16 | ** mapped area 17 | ** ... 18 | 19 | * Making it less os-dependent (now quite linked to a Unix OS with a gcc toolchain) 20 | ** Rewriting Makefile based on autoconf to have plenty of compilation flags to play with 21 | ** Having a client/server kind of architecture to start/stop/write monitoring (instead of Unix signal) 22 | 23 | * Plug new/delete operator to the dlopen RTLD_NEXT symbol 24 | 25 | * Tests 26 | We need a lot more tests. Lets keep an ever growing list here. 27 | ** Write tests that test behaviour with different environment variable settings 28 | -------------------------------------------------------------------------------- /libleaktracer/src/LeakTracerC.c: -------------------------------------------------------------------------------- 1 | #include "leaktracer.h" 2 | #include "MemoryTrace.hpp" 3 | 4 | 5 | /** starts monitoring memory allocations in all threads */ 6 | void leaktracer_startMonitoringAllThreads() 7 | { 8 | leaktracer::MemoryTrace::GetInstance().startMonitoringAllThreads(); 9 | } 10 | 11 | /** starts monitoring memory allocations in current thread */ 12 | void leaktracer_startMonitoringThisThread() 13 | { 14 | leaktracer::MemoryTrace::GetInstance().startMonitoringThisThread(); 15 | } 16 | 17 | /** stops monitoring memory allocations (in all threads or in 18 | * this thread only, depends on the function used to start 19 | * monitoring 20 | */ 21 | void leaktracer_stopMonitoringAllocations() 22 | { 23 | leaktracer::MemoryTrace::GetInstance().stopMonitoringAllocations(); 24 | } 25 | 26 | /** stops all monitoring - both of allocations and releases */ 27 | void leaktracer_stopAllMonitoring() 28 | { 29 | leaktracer::MemoryTrace::GetInstance().stopAllMonitoring(); 30 | } 31 | 32 | /** writes report with all memory leaks */ 33 | void leaktracer_writeLeaksToFile(const char* reportFileName) 34 | { 35 | leaktracer::MemoryTrace::GetInstance().writeLeaksToFile(reportFileName); 36 | } 37 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Authors of LeakTracer 2 | ==================== 3 | 4 | LEAKTRACER Erwin S. Andreasen 2000-00-00 erwin@andreasen.org 5 | Original author 6 | 7 | LEAKTRACER Henner Zeller 2000-00-00 H.Zeller@acm.org 8 | rewrite of the code which introduced dynamic loading of LeakTracer and more. 9 | 10 | LEAKTRACER Michael Gopshtein 2000-00-00 mgopshtein@gmail.com 11 | Completely rewrote LeakTracer to make it more efficient and flexible, monitor specific threads 12 | and display the full stack trace. 13 | 14 | LEAKTRACER Yann Dirson 2000-00-00 15 | Debian packaging integration 16 | 17 | 18 | 19 | 20 | 21 | More credits 22 | ============ 23 | ... 24 | 25 | 26 | Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2006, 27 | 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. 28 | 29 | This file is free software; as a special exception the author gives 30 | unlimited permission to copy and/or distribute it, with or without 31 | modifications, as long as this notice is preserved. 32 | 33 | This file is distributed in the hope that it will be useful, but 34 | WITHOUT ANY WARRANTY, to the extent permitted by law; without even the 35 | implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 36 | 37 | 38 | -------------------------------------------------------------------------------- /INSTALL: -------------------------------------------------------------------------------- 1 | Prerequisites 2 | ============= 3 | 4 | LeakTracer does not requires the specific packages. 5 | It needs C++ support from your toolchain 6 | It needs that your toolchain support some evolve functions like pthread_key_create... 7 | leak-analyze needs perl 8 | 9 | 10 | Simple install procedure 11 | ======================== 12 | 13 | Global options for Makefile 14 | * OBJDIR= where you want the build tree, default build/{machine}/{gccversion} 15 | * CROSS_COMPILE= prefix of the gcc to use in case of cross compilation 16 | * or GXX= g++ to use 17 | * DEBUG= compilation in debug mode 18 | 19 | make or make all 20 | Compiles dynamic and static library which exposes all LearTracer functionality 21 | 22 | make test 23 | 1) Builds test application which creates some memory leaks 24 | 2) Runs the test application 25 | 3) Parses LeakTracer log to show information in readable format 26 | 27 | make clean 28 | Deletes all binary files and logs created by "make" or "make test" 29 | 30 | make install 31 | Install the files suitable for distribution 32 | Options: 33 | * PREFIX= prefix where you want the files install, probably /usr is what you want 34 | * DESTDIR= destination rootfs, mainly for chroot or cross compilation install 35 | 36 | The Details 37 | =========== 38 | 39 | 40 | 41 | -------------------------------------------------------------------------------- /libleaktracer/include/MutexLock.hpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #ifndef __LEAKTRACER_MUTEX_LOCK_h_included__ 15 | #define __LEAKTRACER_MUTEX_LOCK_h_included__ 16 | 17 | #include "Mutex.hpp" 18 | 19 | #include 20 | 21 | namespace leaktracer { 22 | 23 | /** 24 | * Used to lock Mutex, ensures that the mutex 25 | * is always released. 26 | * 27 | * Example: 28 | * 29 | * class MyClass { 30 | * private: 31 | * Mutex my_mutex; 32 | * 33 | * public: 34 | * void doSomething(void) { 35 | * MutexLock lock(my_mutex); 36 | * // some code 37 | * } 38 | * // the Mutex is released automatically by 39 | * // destructor of MutexLock, even is exception 40 | * // is thrown inside the body of the function. 41 | * }; 42 | */ 43 | class MutexLock { 44 | public: 45 | inline explicit MutexLock(Mutex& m) : __mutex(m), __locked(true) { 46 | pthread_mutex_lock(&__mutex.__mutex); 47 | } 48 | 49 | inline void unlock() { 50 | if (__locked) { 51 | __locked = false; 52 | pthread_mutex_unlock(&__mutex.__mutex); 53 | } 54 | } 55 | 56 | // no one should be derived from this (non-virtual destructor) 57 | inline ~MutexLock() { 58 | unlock(); 59 | } 60 | 61 | protected: 62 | Mutex& __mutex; 63 | bool __locked; 64 | }; 65 | 66 | 67 | } // end namespace 68 | 69 | #endif // include once 70 | -------------------------------------------------------------------------------- /libleaktracer/include/Mutex.hpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #ifndef __LEAKTRACER_MUTEX_h_included__ 15 | #define __LEAKTRACER_MUTEX_h_included__ 16 | 17 | #include 18 | #include 19 | 20 | #ifndef TRACE 21 | #ifdef LOGGER 22 | #define TRACE(arg) fprintf arg 23 | #else 24 | #define TRACE(arg) 25 | #endif 26 | #endif 27 | 28 | namespace leaktracer { 29 | 30 | // forward declaration 31 | class MutexLock; 32 | 33 | /** 34 | * Wrapper to "pthread_mutex_t", should be used with 35 | * MutexLock class, which insures that the mutex is 36 | * released even in case of exception. 37 | */ 38 | class Mutex { // not intended to be overridden, non-virtual destructor 39 | public: 40 | inline Mutex() { 41 | // TRACE((stderr, "LeakTracer: Mutex()\n")); 42 | pthread_mutexattr_t attr; 43 | pthread_mutexattr_init(&attr); 44 | // pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE); 45 | pthread_mutex_init(&__mutex, &attr); 46 | pthread_mutexattr_destroy(&attr); 47 | } 48 | 49 | // not intended to be overridden, non-virtual destructor 50 | inline ~Mutex() { 51 | // TRACE((stderr, "LeakTracer: ~Mutex()\n")); 52 | pthread_mutex_destroy(&__mutex); 53 | } 54 | 55 | pthread_mutex_t __mutex; 56 | 57 | protected: 58 | friend class MutexLock; 59 | }; 60 | 61 | } // end namespace 62 | 63 | 64 | #endif // include once 65 | -------------------------------------------------------------------------------- /helpers/leak-analyze-addr2line: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | use IO::Handle; 3 | 4 | my $exe_name = shift (@ARGV); 5 | my $log_name = shift (@ARGV); 6 | 7 | if (!$exe_name || !$log_name) { 8 | print "Usage: $0 \n"; 9 | exit (1); 10 | } 11 | 12 | print "Processing \"$log_name\" log for \"$exe_name\"\n"; 13 | 14 | print "Matching addresses to \"$exe_name\"\n"; 15 | 16 | my %stacks; 17 | my %addresses; 18 | my $lines = 0; 19 | 20 | open (LEAKFILE, $log_name) || die("failed to read from \"$log_name\""); 21 | 22 | while () { 23 | chomp; 24 | my $line = $_; 25 | if ($line =~ /^leak, time=([\d.]*), stack=([\w ]*), size=(\d*), data=.*/) { 26 | $lines ++; 27 | 28 | my $id = $2; 29 | $stacks{$id}{COUNTER} ++; 30 | $stacks{$id}{TIME} = $1; 31 | $stacks{$id}{SIZE} += $3; 32 | 33 | my @ptrs = split(/ /, $id); 34 | foreach $ptr (@ptrs) { 35 | $addresses{$ptr} = "unknown"; 36 | } 37 | } 38 | } 39 | close (LEAKFILE); 40 | printf "found $lines leak(s)\n"; 41 | if ($lines == 0) { exit 0; } 42 | 43 | # resolving addresses 44 | my @unique_addresses = keys (%addresses); 45 | my $addr_list = ""; 46 | foreach $addr (@unique_addresses) { $addr_list .= " $addr"; } 47 | 48 | if (!open(ADDRLIST, "addr2line -e $exe_name $addr_list |")) { die "Failed to resolve addresses"; } 49 | my $addr_idx = 0; 50 | while () { 51 | chomp; 52 | $addresses{$unique_addresses[$addr_idx]} = $_; 53 | $addr_idx++; 54 | } 55 | close (ADDRLIST); 56 | 57 | # printing allocations 58 | while (($stack, $info) = each(%stacks)) { 59 | print $info->{SIZE}." bytes lost in ".$info->{COUNTER}." blocks (one of them allocated at ".$info->{TIME}."), from following call stack:\n"; 60 | @stack = split(/ /, $stack); 61 | foreach $addr (@stack) { print "\t".$addresses{$addr}."\n"; } 62 | } 63 | -------------------------------------------------------------------------------- /tests/test.cc: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | 15 | #include 16 | #include 17 | #include 18 | #include 19 | #include "MemoryTrace.hpp" 20 | 21 | 22 | char *doAlloc(unsigned int size); 23 | 24 | 25 | int main() 26 | { 27 | // startup part of the program 28 | // following allocation is not registered 29 | char *lostAtStartup = doAlloc(128); strcpy(lostAtStartup, "Lost at startup"); 30 | 31 | // starting monitoring allocations 32 | leaktracer::MemoryTrace::GetInstance().startMonitoringAllThreads(); 33 | char *memLeak = doAlloc(256); strcpy(memLeak, "This is a real memory leak"); 34 | char *notLeak = doAlloc(64); strcpy(notLeak, "This is NOT a memory leak"); 35 | 36 | char *memLeak2 = (char*)malloc(256); strcpy(memLeak2, "This is a malloc memory leak"); 37 | free(lostAtStartup); 38 | 39 | // while (1) 40 | // wait(); 41 | 42 | // stop monitoring allocations, but do still 43 | // monitor releases of the memory 44 | leaktracer::MemoryTrace::GetInstance().stopMonitoringAllocations(); 45 | delete[] notLeak; 46 | notLeak = doAlloc(32); 47 | 48 | // stop all monitoring, print report 49 | leaktracer::MemoryTrace::GetInstance().stopAllMonitoring(); 50 | 51 | std::ofstream oleaks; 52 | oleaks.open("leaks.out", std::ios_base::out); 53 | if (oleaks.is_open()) 54 | leaktracer::MemoryTrace::GetInstance().writeLeaks(oleaks); 55 | else 56 | std::cerr << "Failed to write to \"leaks.out\"\n"; 57 | 58 | return 0; 59 | } 60 | 61 | 62 | char *doAlloc(unsigned int size) { 63 | return new char[size]; 64 | } 65 | 66 | 67 | -------------------------------------------------------------------------------- /helpers/leak-analyze-gdb: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | use IO::Handle; 3 | 4 | my $exe_name = shift (@ARGV); 5 | my $log_name = shift (@ARGV); 6 | my $breakpoint; 7 | 8 | if ($#ARGV >= 0) { 9 | $breakpoint = shift @ARGV; 10 | } 11 | 12 | if (!$exe_name || !$log_name) { 13 | print "Usage: $0 [BREAKPOINT]\n"; 14 | exit (1); 15 | } 16 | 17 | my %stacks; 18 | my %addresses; 19 | my $lines = 0; 20 | 21 | open (LEAKFILE, $log_name) || die("failed to read from \"$log_name\""); 22 | 23 | while () { 24 | chomp; 25 | my $line = $_; 26 | if ($line =~ /^leak, time=([\d.]*), stack=([\w ]*), size=(\d*), data=.*/) { 27 | $lines ++; 28 | 29 | my $id = $2; 30 | $stacks{$id}{COUNTER} ++; 31 | $stacks{$id}{TIME} = $1; 32 | $stacks{$id}{SIZE} += $3; 33 | 34 | my @ptrs = split(/ /, $id); 35 | foreach $ptr (@ptrs) { 36 | $addresses{$ptr} = "unknown"; 37 | } 38 | } 39 | } 40 | close (LEAKFILE); 41 | printf "found $lines leak(s)\n"; 42 | 43 | 44 | # Instead of using -batch, we just run things as usual. with -batch, 45 | # we quit on the first error, which we don't want. 46 | open (PIPE, "|gdb -q") or die "Cannot start gdb"; 47 | #open (PIPE, "|cat"); 48 | 49 | # Change set listsize 2 to something else to show more lines 50 | print PIPE "set prompt\nset complaints 1000\nset height 0\n"; 51 | 52 | if ($exe_name eq int($exe_name)) { 53 | print PIPE "attach $exe_name\n"; 54 | } 55 | else 56 | { 57 | print PIPE "file $exe_name\n"; 58 | } 59 | 60 | print PIPE "set environment LD_PRELOAD /usr/lib/libleaktracer.so\n"; 61 | 62 | # Optionally, run the program 63 | if (defined($breakpoint)) { 64 | print PIPE "break $breakpoint\n"; 65 | print PIPE "run ", join(" ", @ARGV), " \n"; 66 | } 67 | 68 | # printing allocations 69 | print PIPE "set listsize 1\n"; 70 | print PIPE "set print symbol-filename on\n"; 71 | 72 | #print PIPE "info sharedlibrary\n"; 73 | 74 | while (($stack, $info) = each(%stacks)) { 75 | print PIPE "echo ".$info->{SIZE}." bytes lost in ".$info->{COUNTER}." blocks (one of them allocated at ".$info->{TIME}."), from following call stack:\\n\n"; 76 | @stack = split(/ /, $stack); 77 | foreach $addr (@stack) { 78 | print PIPE "info symbol " . ($addr) . "\n"; 79 | print PIPE "l *" . ($addr) . "\n"; 80 | } 81 | print PIPE "echo \\n\n"; 82 | } 83 | 84 | if ($exe_name eq int($exe_name)) { 85 | print PIPE "detach\n"; 86 | } 87 | elsif (defined($breakpoint)) { 88 | print PIPE "kill\n"; 89 | } 90 | 91 | print PIPE "quit\n"; 92 | PIPE->flush(); 93 | wait(); 94 | 95 | close (PIPE); 96 | -------------------------------------------------------------------------------- /helpers/leak-check: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # 3 | # This is a helper for running custom executable with LeakTracer. 4 | # 5 | # Set LEAKTRACER_SHARED_LIB environment variable to specify a path to the LeakTracer library. 6 | # 7 | # Set LEAKTRACER_ONSIG environment variable to use signals for managing LeakTracer, 8 | # otherwise LeakTracer would be enabled from the start. 9 | # 10 | # You can override defaults by setting 11 | # - LEAKTRACER_ONSIG_REPORTFILENAME, 12 | # - LEAKTRACER_ONSIG_STARTALLTHREAD, 13 | # - LEAKTRACER_ONSIG_STOPALLTHREAD, 14 | # - LEAKTRACER_ONSIG_REPORT, 15 | # when LEAKTRACER_ONSIG is set, and 16 | # - LEAKTRACER_AUTO_REPORTFILENAME 17 | # otherwise. 18 | # 19 | # Copyright Nikita Melnichenko [http://nikita.melnichenko.name], 2012 20 | # Lisence: GPL v2 21 | 22 | 23 | 24 | # print usage 25 | if [ -z "$1" ] ; then 26 | echo "Usage: $0 PROGRAM [PARAMETER]..." 27 | exit 0 28 | fi 29 | 30 | # if library wasn't set explicitly, try the one in the current dir 31 | if [ -z "$LEAKTRACER_SHARED_LIB" ] && [ -x "./libleaktracer.so" ] ; then 32 | LEAKTRACER_SHARED_LIB="./libleaktracer.so" 33 | fi 34 | 35 | # set a path to the LeakTracer library 36 | if [ -z "$LEAKTRACER_SHARED_LIB" ] ; then 37 | # THIS SHOULD POINT TO THE SYSTEM LIBRARY: 38 | # USE: sed -i -e 's|\tLEAKTRACER_SYSTEM_SHARED_LIB=.*|\tLEAKTRACER_SYSTEM_SHARED_LIB=/PATH/TO/LIB|' leak-check 39 | LEAKTRACER_SYSTEM_SHARED_LIB=/usr/lib/libleaktracer.so 40 | LEAKTRACER_SHARED_LIB="$LEAKTRACER_SYSTEM_SHARED_LIB" 41 | fi 42 | 43 | # check the library 44 | if ! [ -x "$LEAKTRACER_SHARED_LIB" ] 45 | then 46 | echo "LeakTracer library '$LEAKTRACER_SHARED_LIB' not found!" 47 | echo "Please, set a proper path in the LEAKTRACER_SHARED_LIB variable." 48 | exit 1 49 | fi 50 | 51 | # set defaults for those variables that haven't been specified 52 | if ! [ -z "$LEAKTRACER_ONSIG" ] ; then 53 | 54 | if [ -z "$LEAKTRACER_ONSIG_REPORTFILENAME" ] ; then 55 | LEAKTRACER_ONSIG_REPORTFILENAME=leak.out 56 | fi 57 | if [ -z "$LEAKTRACER_ONSIG_STARTALLTHREAD" ] ; then 58 | LEAKTRACER_ONSIG_STARTALLTHREAD=USR1 59 | fi 60 | if [ -z "$LEAKTRACER_ONSIG_REPORT" ] ; then 61 | LEAKTRACER_ONSIG_REPORT=USR2 62 | fi 63 | 64 | export LEAKTRACER_ONSIG_REPORTFILENAME 65 | export LEAKTRACER_ONSIG_STARTALLTHREAD 66 | export LEAKTRACER_ONSIG_REPORT 67 | 68 | REPORTFILENAME="$LEAKTRACER_ONSIG_REPORTFILENAME" 69 | 70 | elif [ -z "$LEAKTRACER_AUTO_REPORTFILENAME" ] ; then 71 | 72 | export LEAKTRACER_AUTO_REPORTFILENAME=leak.out 73 | 74 | REPORTFILENAME="$LEAKTRACER_AUTO_REPORTFILENAME" 75 | 76 | fi 77 | 78 | # save old report file 79 | if [ -f "$REPORTFILENAME" ] ; then 80 | mv "$REPORTFILENAME" "$REPORTFILENAME-`stat --format '%Y' "$REPORTFILENAME"`" 81 | fi 82 | 83 | # run the program 84 | export LD_PRELOAD="$LEAKTRACER_SHARED_LIB" 85 | exec $@ 86 | -------------------------------------------------------------------------------- /libleaktracer/src/AllocationHandlers.cpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #include "MemoryTrace.hpp" 15 | #include "LeakTracer_l.hpp" 16 | 17 | void* (*lt_malloc)(size_t size); 18 | void (*lt_free)(void* ptr); 19 | void* (*lt_realloc)(void *ptr, size_t size); 20 | void* (*lt_calloc)(size_t nmemb, size_t size); 21 | 22 | void* operator new(size_t size) { 23 | void *p; 24 | leaktracer::MemoryTrace::Setup(); 25 | 26 | p = LT_MALLOC(size); 27 | leaktracer::MemoryTrace::GetInstance().registerAllocation(p, size, false); 28 | 29 | return p; 30 | } 31 | 32 | 33 | void* operator new[] (size_t size) { 34 | void *p; 35 | leaktracer::MemoryTrace::Setup(); 36 | 37 | p = LT_MALLOC(size); 38 | leaktracer::MemoryTrace::GetInstance().registerAllocation(p, size, true); 39 | 40 | return p; 41 | } 42 | 43 | 44 | void operator delete (void *p) { 45 | leaktracer::MemoryTrace::Setup(); 46 | 47 | leaktracer::MemoryTrace::GetInstance().registerRelease(p, false); 48 | LT_FREE(p); 49 | } 50 | 51 | 52 | void operator delete[] (void *p) { 53 | leaktracer::MemoryTrace::Setup(); 54 | 55 | leaktracer::MemoryTrace::GetInstance().registerRelease(p, true); 56 | LT_FREE(p); 57 | } 58 | 59 | /** -- libc memory operators -- **/ 60 | 61 | /* malloc 62 | * in some malloc implementation, there is a recursive call to malloc 63 | * (for instance, in uClibc 0.9.29 malloc-standard ) 64 | * we use a InternalMonitoringDisablerThreadUp that use a tls variable to prevent several registration 65 | * during the same malloc 66 | */ 67 | void *malloc(size_t size) 68 | { 69 | void *p; 70 | leaktracer::MemoryTrace::Setup(); 71 | 72 | leaktracer::MemoryTrace::GetInstance().InternalMonitoringDisablerThreadUp(); 73 | p = LT_MALLOC(size); 74 | leaktracer::MemoryTrace::GetInstance().InternalMonitoringDisablerThreadDown(); 75 | leaktracer::MemoryTrace::GetInstance().registerAllocation(p, size, false); 76 | 77 | return p; 78 | } 79 | 80 | void free(void* ptr) 81 | { 82 | leaktracer::MemoryTrace::Setup(); 83 | 84 | leaktracer::MemoryTrace::GetInstance().registerRelease(ptr, false); 85 | LT_FREE(ptr); 86 | } 87 | 88 | void* realloc(void *ptr, size_t size) 89 | { 90 | void *p; 91 | leaktracer::MemoryTrace::Setup(); 92 | 93 | leaktracer::MemoryTrace::GetInstance().InternalMonitoringDisablerThreadUp(); 94 | 95 | p = LT_REALLOC(ptr, size); 96 | 97 | leaktracer::MemoryTrace::GetInstance().InternalMonitoringDisablerThreadDown(); 98 | 99 | if (p != ptr) 100 | { 101 | if (ptr) 102 | leaktracer::MemoryTrace::GetInstance().registerRelease(ptr, false); 103 | leaktracer::MemoryTrace::GetInstance().registerAllocation(p, size, false); 104 | } 105 | else 106 | { 107 | leaktracer::MemoryTrace::GetInstance().registerReallocation(p, size, false); 108 | } 109 | 110 | return p; 111 | } 112 | 113 | void* calloc(size_t nmemb, size_t size) 114 | { 115 | void *p; 116 | leaktracer::MemoryTrace::Setup(); 117 | 118 | leaktracer::MemoryTrace::GetInstance().InternalMonitoringDisablerThreadUp(); 119 | p = LT_CALLOC(nmemb, size); 120 | leaktracer::MemoryTrace::GetInstance().InternalMonitoringDisablerThreadDown(); 121 | leaktracer::MemoryTrace::GetInstance().registerAllocation(p, nmemb*size, false); 122 | 123 | return p; 124 | } 125 | -------------------------------------------------------------------------------- /NEWS: -------------------------------------------------------------------------------- 1 | 2 | Overview of Changes from LeakTracer 2.4/2.4_MG/2.4_GS to 3.0 3 | ============================================== 4 | 2011/09/15 5 | 6 | 7 | Overview of Changes from LeakTracer 2.4 to 2.4_GS (Greg Stewart) 8 | ============================================== 9 | Patch for tracing malloc/free too by Greg Stewart 10 | 11 | 12 | Overview of Changes from LeakTracer 2.4 to 2.4_MG (Michael Gopshtein) 13 | ============================================== 14 | 2006/??/?? 15 | (*) Functions to stop and end monitoring at any point of time, in 16 | order to avoid "false alarms", e.g. for start-up code. 17 | (*) Separate flags for monitoring allocations and releases. Allows 18 | to stop monitoring new allocations, but still monitor releases. 19 | Useful in applications which release memory after some period of time 20 | (*) Monitoring of memory alocated by certain threads. For example, only 21 | threads performing specific task. 22 | (*) Printing full call stack of allocated memory. 23 | 24 | 25 | 26 | Overview of Changes from LeakTracer 2.3 to 2.4 27 | ============================================== 28 | 2003/08/28 29 | Improve MAGIC on platforms that don't allow unaligned access 30 | 31 | 32 | Overview of Changes from LeakTracer 2.2 to 2.3 33 | ============================================== 34 | 2001/06/13 35 | Made LT more resistant to being called before init and after destruction 36 | 37 | 38 | Overview of Changes from LeakTracer 2.1 to 2.2 39 | ============================================== 40 | 2001/03/02 41 | Another updated by Henner: hash table to increase performance with many allocations 42 | 43 | 44 | Overview of Changes from LeakTracer 2.0 to 2.1 45 | ============================================== 46 | 2001/02/27 47 | Further update by Henner: optional thread safety, 48 | choose what should make LeakTracer abort(), better 49 | tracing of delete on non-new'ed pointers 50 | 51 | 52 | Overview of Changes from LeakTracer 2.0 to 2.1 53 | ============================================== 54 | 2000/11/19 55 | Rewrite by Henner Zeller introduces LD_PRELOAD and much more 56 | 57 | 58 | Overview of Changes from LeakTracer 1.5 to 1.6 59 | ============================================== 60 | 2000/08/21 61 | use a destructor instead of __attribute__(destructor) 62 | 63 | 64 | 65 | Overview of Changes from LeakTracer 1.4 to 1.5 66 | ============================================== 67 | 1999/07/21 68 | Fix for the above suggested by Alan Gonzalez 69 | 70 | 71 | Overview of Changes from LeakTracer 1.3 to 1.4 72 | ============================================== 73 | 1999/03/27 74 | Allow %p format without leading 0x for non-GNU libc. 75 | Option to leak-analyze to run the program. 76 | 77 | 78 | Overview of Changes from LeakTracer 1.2 to 1.3 79 | ============================================== 80 | 1999/02/26 81 | allow delete 0 82 | 83 | 84 | Overview of Changes from LeakTracer 1.1 to 1.2 85 | ============================================== 86 | 1999/02/23 87 | Oops, forgot to free() the memory.. 88 | 89 | 90 | Overview of Changes from LeakTracer 1.0 to 1.1 91 | ============================================== 92 | 1999/02/23 93 | first public release/added operator new[] / delete[] 94 | 95 | 96 | Overview of LeakTracer 1.0 97 | ============================================== 98 | 1999/02/21 99 | only tested internally 100 | 101 | 102 | Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2006, 103 | 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. 104 | 105 | This file is free software; as a special exception the author gives 106 | unlimited permission to copy and/or distribute it, with or without 107 | modifications, as long as this notice is preserved. 108 | 109 | This file is distributed in the hope that it will be useful, but 110 | WITHOUT ANY WARRANTY, to the extent permitted by law; without even the 111 | implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 112 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | #/////////////////////////////////////////////////////// 2 | # 3 | # LeakTracer 4 | # Contribution to original project by Erwin S. Andreasen 5 | # site: http://www.andreasen.org/LeakTracer/ 6 | # 7 | # Added by Michael Gopshtein, 2006 8 | # mgopshtein@gmail.com 9 | # 10 | # Any comments/suggestions are welcome 11 | # 12 | #/////////////////////////////////////////////////////// 13 | TEST_LINK_STATIC = 0 14 | TEST_HARD_LINK = 1 15 | 16 | ifneq ($(CROSS_COMPILE),) 17 | CXX=$(CROSS_COMPILE)g++ 18 | else 19 | ifeq ($(CXX),) 20 | CXX ?= g++ 21 | endif 22 | LIBDIR := $(shell echo -n lib; (ldd /usr/bin/ls |grep -q lib64) && echo -n 64) 23 | endif 24 | SRCDIR ?= $(CURDIR) 25 | OBJDIR ?= $(CURDIR)/build/$(shell $(CXX) -dumpmachine)/$(shell $(CXX) -dumpversion) 26 | ifeq ($(PREFIX),) 27 | PREFIX := /usr 28 | endif 29 | 30 | ifeq ($(DEBUG),1) 31 | NOOPT := 1 32 | endif 33 | 34 | LIBLEAKTRACERPATH := libleaktracer 35 | 36 | # Common flags 37 | CXXFLAGS = -Wall -pthread 38 | ifeq ($(NOOPT),1) 39 | # with -O0, functions are not inlined, so it's harder to get the backtrace on some architecture 40 | # but you can use it if you want to debug leaktracer (if some could find the right optim option to pass to gcc to 41 | # use with O0, it would be nice !) 42 | #CXXFLAGS += -O0 -finline-functions-called-once 43 | CXXFLAGS += -O1 44 | CXXFLAGS += -g3 -DLOGGER 45 | else 46 | CXXFLAGS += -O3 47 | endif 48 | 49 | # some architecture generate a lot more instuction than on x86 (mips, arm...), this make the functions not inlined 50 | # make inline-limit big to force inline 51 | CXXFLAGS += -finline-limit=10000 52 | CPPFLAGS += -I$(LIBLEAKTRACERPATH)/include -I$(LIBLEAKTRACERPATH)/src 53 | # on some archi, __builtin_return_address with idx > 1 fails. 54 | # and on most intel platform, [e]glibc backtrace() function is more efficient and less 55 | # buggy, so -DUSE_BACKTRACE is becoming the default, as it is the most used target 56 | # uclibc target might need to turn this off... 57 | CPPFLAGS += -DUSE_BACKTRACE 58 | DYNLIB_FLAGS=-fpic -DSHARED -Wl,-z,defs 59 | # timestamp support 60 | LD_FLAGS=-lrt 61 | LD_FLAGS+= -ldl -lpthread 62 | 63 | CXXFLAGS += $(EXTRA_CXXFLAGS) 64 | 65 | # File names 66 | LTLIB = $(OBJDIR)/libleaktracer.a 67 | LTLIBSO = $(OBJDIR)/libleaktracer.so 68 | 69 | # Source files 70 | SRCS := AllocationHandlers.cpp MemoryTrace.cpp LeakTracerC.c 71 | HEADERS := $(wildcard $(LIBLEAKTRACERPATH)/include/*) $(wildcard $(LIBLEAKTRACERPATH)/src/*hpp) 72 | 73 | OBJS := $(SRCS) 74 | OBJS := $(patsubst %.cpp,$(OBJDIR)/%.o,$(OBJS)) 75 | OBJS := $(patsubst %.c,$(OBJDIR)/%.o,$(OBJS)) 76 | SHOBJS := $(SRCS) 77 | SHOBJS := $(patsubst %.cpp,$(OBJDIR)/%.os,$(SHOBJS)) 78 | SHOBJS := $(patsubst %.c,$(OBJDIR)/%.os,$(SHOBJS)) 79 | 80 | TESTSSRC := $(wildcard tests/*.cc) 81 | TESTSBIN := $(patsubst tests/%.cc,$(OBJDIR)/%.bin,$(TESTSSRC)) 82 | 83 | VPATH := $(LIBLEAKTRACERPATH)/src 84 | 85 | # Library 86 | all: $(LTLIB) $(LTLIBSO) 87 | 88 | VPATH := $(LIBLEAKTRACERPATH)/src 89 | $(LTLIB): $(OBJS) 90 | ar rcs $(LTLIB) $(OBJS) 91 | 92 | $(LTLIBSO): $(SHOBJS) 93 | $(CXX) -shared $(DYNLIB_FLAGS) -o $(LTLIBSO) $(SHOBJS) $(LD_FLAGS) 94 | 95 | $(OBJDIR)/%.os: %.c $(HEADERS) 96 | @[ -d $(OBJDIR) ] || mkdir -p $(OBJDIR) 97 | $(CXX) $(CPPFLAGS) $(CXXFLAGS) $(DYNLIB_FLAGS) -c -o $@ $< 98 | 99 | $(OBJDIR)/%.o: %.c $(HEADERS) 100 | @[ -d $(OBJDIR) ] || mkdir -p $(OBJDIR) 101 | $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $< 102 | 103 | $(OBJDIR)/%.os: %.cpp $(HEADERS) 104 | @[ -d $(OBJDIR) ] || mkdir -p $(OBJDIR) 105 | $(CXX) $(CPPFLAGS) $(CXXFLAGS) $(DYNLIB_FLAGS) -c -o $@ $< 106 | 107 | $(OBJDIR)/%.o: %.cpp $(HEADERS) 108 | @[ -d $(OBJDIR) ] || mkdir -p $(OBJDIR) 109 | $(CXX) $(CPPFLAGS) $(CXXFLAGS) -c -o $@ $< 110 | 111 | 112 | TESTRUNENV := LEAKTRACER_NOBANNER=1 113 | ifeq ($(TEST_LINK_STATIC),1) 114 | TESTLINKDEP := $(LTLIB) 115 | TESTLINKARGS := -L$(OBJDIR) $(LTLIB) 116 | TESTRUNENV += LD_LIBRARY_PATH=$(OBJDIR) 117 | else 118 | ifeq ($(TEST_HARD_LINK),1) 119 | TESTLINKDEP := $(LTLIBSO) 120 | TESTLINKARGS := -L$(OBJDIR) -lleaktracer 121 | TESTRUNENV += LD_LIBRARY_PATH=$(OBJDIR) 122 | else 123 | TESTLINKDEP := 124 | TESTLINKARGS := 125 | TESTRUNENV += LD_PRELOAD=$(LTLIBSO) LD_LIBRARY_PATH=$(OBJDIR) 126 | endif 127 | endif 128 | 129 | runtests: $(TESTSBIN) 130 | ifneq ($(CROSS_COMPILE),) 131 | @echo "Run tests not available when cross compiling for $(CROSS_COMPILE)" 132 | else 133 | @[ -d $(OBJDIR)/tests ] || mkdir -p $(OBJDIR)/tests 134 | for testbin in $(TESTSBIN); do \ 135 | rm $(OBJDIR)/tests/leaks.out; \ 136 | cd $(OBJDIR)/tests && $(TESTRUNENV) $${testbin}; \ 137 | echo "###### running $${testbin}"; \ 138 | $(SRCDIR)/helpers/leak-analyze-addr2line $${testbin} $(OBJDIR)/tests/leaks.out; \ 139 | done 140 | endif 141 | 142 | tests: $(TESTSBIN) 143 | 144 | $(OBJDIR)/%.bin: tests/%.cc $(TESTLINKDEP) $(HEADERS) 145 | $(CXX) -o $@ $< -g2 -I$(LIBLEAKTRACERPATH)/include $(CXXFLAGS) -O0 $(TESTLINKARGS) -ldl -lpthread 146 | 147 | clean: 148 | rm -f $(SHOBJS) $(LTLIBSO) $(OBJS) $(LTLIB) $(TESTSBIN) *~ *.out 149 | 150 | install: 151 | install -d $(DESTDIR)$(PREFIX)/include 152 | install -d $(DESTDIR)$(PREFIX)/$(LIBDIR) 153 | install -d $(DESTDIR)$(PREFIX)/bin 154 | install -d $(DESTDIR)$(PREFIX)/share/doc/leaktracer 155 | install -m 664 $(LIBLEAKTRACERPATH)/include/* $(DESTDIR)$(PREFIX)/include 156 | install -m 775 $(LTLIBSO) $(DESTDIR)$(PREFIX)/$(LIBDIR) 157 | install -m 775 helpers/* $(DESTDIR)$(PREFIX)/bin 158 | install -m 664 $(LTLIB) $(DESTDIR)$(PREFIX)/$(LIBDIR) 159 | install -m 664 README $(DESTDIR)$(PREFIX)/share/doc/leaktracer 160 | -------------------------------------------------------------------------------- /libleaktracer/include/MapMemoryInfo.hpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #ifndef __MAP_MEMORY_INFO_h_included__ 15 | #define __MAP_MEMORY_INFO_h_included__ 16 | 17 | #include "ObjectsPool.hpp" 18 | 19 | 20 | namespace leaktracer { 21 | 22 | /** 23 | * Help class, holds all relevant information for each 24 | * allocation (logically it's a map of void* address to 25 | * structure with required info) 26 | */ 27 | template 28 | class TMapMemoryInfo { 29 | public: 30 | TMapMemoryInfo(void); 31 | virtual ~TMapMemoryInfo(void) {} 32 | 33 | /** Allocates sizeof(T) buffer, and associates it with given 34 | * poiter */ 35 | inline T * insert(void *ptr); 36 | 37 | /** Returns pointer to T object, associated with given pointer */ 38 | inline T * find(void *ptr); 39 | 40 | /** Releases a buffer, associated with given pointer. */ 41 | inline void release(void *ptr); 42 | 43 | /** Following 2 functions used for iteration over all 44 | * elements */ 45 | void beginIteration(void); 46 | bool getNextPair(T **ppObject, void **pptr); 47 | bool empty(void); 48 | 49 | void clearAllInfo(void); 50 | 51 | private: 52 | // hash function from pointer to int (range is defined by POINTER_HASH_LENGTH static) 53 | inline unsigned long hash(void *ptr); 54 | 55 | // defines single pointer's info 56 | typedef struct _pointer_info_struct { 57 | void *ptr; 58 | T info; 59 | } pointer_info_t; 60 | 61 | // list node - to hold list of all info's having same hash value 62 | typedef struct _list_node_struct { 63 | pointer_info_t pinfo; 64 | struct _list_node_struct *next; 65 | } list_node_t; 66 | 67 | // array of lists (according to hash function) 68 | #define POINTER_HASH_LENGTH 16 69 | #define NUMBER_OF_MEMORY_INFO_LISTS (1 << POINTER_HASH_LENGTH) 70 | list_node_t * __info_lists[NUMBER_OF_MEMORY_INFO_LISTS]; 71 | 72 | // memory allocation - using a pool 73 | #define DEFAULT_NUMBER_OF_ELEMENTS_IN_CHUNK (1 << 12) 74 | typedef TObjectsPool nodes_pool_t; 75 | nodes_pool_t __pool; 76 | 77 | // current position in iteration 78 | long __lIterationCurrentListIndex; 79 | list_node_t *__pIterationCurrentElement; 80 | }; 81 | 82 | 83 | ////////////////////////////////////////////////////////////////////// 84 | // 85 | // IMPLEMENTATION: TMapMemoryInfo 86 | // (inline template functions) 87 | // 88 | ////////////////////////////////////////////////////////////////////// 89 | 90 | template 91 | TMapMemoryInfo::TMapMemoryInfo(void) 92 | { 93 | // initializes all lists to be empty 94 | for( int i = 0; i < NUMBER_OF_MEMORY_INFO_LISTS; i++ ) 95 | __info_lists[i] = NULL; 96 | 97 | // members used for iteration 98 | __lIterationCurrentListIndex = -1; 99 | __pIterationCurrentElement = NULL; 100 | } 101 | 102 | template 103 | inline unsigned long TMapMemoryInfo::hash(void *ptr) 104 | { return (reinterpret_cast(ptr) & (NUMBER_OF_MEMORY_INFO_LISTS - 1)); } 105 | 106 | template 107 | inline T * TMapMemoryInfo::insert(void *ptr) 108 | { 109 | list_node_t * pNew = static_cast(__pool.allocate()); 110 | if( !pNew ) 111 | return NULL; 112 | 113 | // insert to the "hash(ptr)" list 114 | long key = hash(ptr); 115 | pNew->next = __info_lists[key]; 116 | __info_lists[key] = pNew; 117 | 118 | (pNew->pinfo).ptr = ptr; 119 | return &((pNew->pinfo).info); 120 | } 121 | 122 | 123 | template 124 | inline T * TMapMemoryInfo::find(void *ptr) 125 | { 126 | list_node_t * pNext = __info_lists[hash(ptr)]; 127 | while( pNext != NULL ) 128 | { 129 | if( (pNext->pinfo).ptr == ptr ) 130 | return &((pNext->pinfo).info); 131 | pNext = pNext->next; 132 | } 133 | 134 | // not found 135 | return NULL; 136 | } 137 | 138 | 139 | template 140 | inline void TMapMemoryInfo::release(void *ptr) 141 | { 142 | long key = hash(ptr); 143 | list_node_t * pNext = __info_lists[key]; 144 | if( NULL == pNext ) 145 | // list is empty 146 | return; 147 | 148 | if( (pNext->pinfo).ptr == ptr ) 149 | { 150 | // found: is a first element 151 | __info_lists[key] = pNext->next; 152 | __pool.release(pNext); 153 | return; 154 | } 155 | 156 | // searching in other elements 157 | list_node_t * pPrev = pNext; 158 | pNext = pNext->next; 159 | 160 | while( pNext != NULL) 161 | { 162 | if( (pNext->pinfo).ptr == ptr ) 163 | { 164 | pPrev->next = pNext->next; 165 | __pool.release( pNext ); 166 | return; 167 | } 168 | pPrev = pNext; 169 | pNext = pNext->next; 170 | } 171 | } 172 | 173 | 174 | template 175 | void TMapMemoryInfo::beginIteration(void) 176 | { 177 | __lIterationCurrentListIndex = 0; 178 | __pIterationCurrentElement = __info_lists[0]; 179 | } 180 | 181 | 182 | //--------------------------------- 183 | // returns next pair (element, pointer) as output parameters 184 | // returns false if no more elements 185 | template 186 | bool TMapMemoryInfo::getNextPair(T **ppObject, void **pptr) 187 | { 188 | if( NULL == __pIterationCurrentElement ) 189 | { 190 | // current list ended, should find next non-empty list 191 | while (__lIterationCurrentListIndex < NUMBER_OF_MEMORY_INFO_LISTS && 192 | NULL == __pIterationCurrentElement) 193 | { 194 | __lIterationCurrentListIndex ++; 195 | __pIterationCurrentElement = __info_lists[__lIterationCurrentListIndex]; 196 | } 197 | 198 | if (__lIterationCurrentListIndex == NUMBER_OF_MEMORY_INFO_LISTS) 199 | { 200 | // reached the end of the lists 201 | *ppObject = NULL; 202 | *pptr = NULL; 203 | return false; 204 | } 205 | 206 | } 207 | 208 | *ppObject = &(__pIterationCurrentElement->pinfo.info); 209 | *pptr = __pIterationCurrentElement->pinfo.ptr; 210 | 211 | // advise "current element" to be the next element in current list 212 | __pIterationCurrentElement = __pIterationCurrentElement->next; 213 | 214 | return true; 215 | } 216 | 217 | template 218 | bool TMapMemoryInfo::empty(void) 219 | { 220 | for (long l = 0; l < NUMBER_OF_MEMORY_INFO_LISTS; l++) { 221 | list_node_t * pNext = __info_lists[l]; 222 | if (pNext != NULL){ 223 | return false; 224 | } 225 | } 226 | return true; 227 | } 228 | 229 | 230 | template 231 | void TMapMemoryInfo::clearAllInfo(void) 232 | { 233 | for (long l = 0; l < NUMBER_OF_MEMORY_INFO_LISTS; l++) { 234 | list_node_t * pNext = __info_lists[l]; 235 | while (pNext != NULL) { 236 | __info_lists[l] = pNext->next; 237 | __pool.release(pNext); 238 | pNext = __info_lists[l]; 239 | } 240 | } 241 | } 242 | 243 | 244 | } // end namespace 245 | 246 | 247 | #endif // include once 248 | -------------------------------------------------------------------------------- /libleaktracer/include/ObjectsPool.hpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #ifndef __OBJECTS_POOL_h_included__ 15 | #define __OBJECTS_POOL_h_included__ 16 | 17 | ////////////////////////////////////////////////////////// 18 | // Objects' pool implementation 19 | // 20 | // Concept taken from "Pool" class, C++ Boost: 21 | // http://www.boost.org/libs/pool/doc/concepts.html 22 | ////////////////////////////////////////////////////////// 23 | 24 | 25 | #include "Mutex.hpp" 26 | #include "MutexLock.hpp" 27 | #include 28 | 29 | /** 30 | * dynamic call interfaces to memory allocation functions in libc.so 31 | */ 32 | extern void* (*lt_malloc)(size_t size); 33 | extern void (*lt_free)(void* ptr); 34 | extern void* (*lt_realloc)(void *ptr, size_t size); 35 | extern void* (*lt_calloc)(size_t nmemb, size_t size); 36 | 37 | /* 38 | * underlying allocation, de-allocation used within 39 | * this tool 40 | */ 41 | #define LT_MALLOC (*lt_malloc) 42 | #define LT_FREE (*lt_free) 43 | #define LT_REALLOC (*lt_realloc) 44 | #define LT_CALLOC (*lt_calloc) 45 | 46 | namespace leaktracer { 47 | 48 | 49 | /** 50 | * This class used for allocation of chunks of elements 51 | * of type E on the heap 52 | */ 53 | template 54 | class TDefaultChunkAllocator 55 | { 56 | public: 57 | E * allocate() 58 | { 59 | return (E*) LT_MALLOC( NumOfElementsInChunk * sizeof(E) ); 60 | } 61 | 62 | void release( E * p ) 63 | { 64 | LT_FREE(p); 65 | } 66 | }; 67 | 68 | 69 | //--------------------------------- 70 | // type for list element, which may be 71 | // a data used by the client, or a pointer 72 | // to next free cell, when the cell is free 73 | template 74 | struct t_list_element 75 | { 76 | union { 77 | unsigned char data[sizeof(T)]; 78 | t_list_element * next_free_cell; 79 | }; 80 | }; 81 | 82 | 83 | 84 | #define FREE_CELL_NONE NULL 85 | 86 | template , NumOfElementsInChunk > > 90 | class TObjectsPool 91 | { 92 | public: 93 | 94 | //--------------------------------- 95 | // Returns a pointer to free object 96 | // NOTE: no constructor is executed 97 | void * allocate(); 98 | 99 | 100 | //--------------------------------- 101 | // Releases object when unused 102 | void release( void *p ); 103 | 104 | 105 | //--------------------------------- 106 | // constructor 107 | TObjectsPool(); 108 | 109 | 110 | //--------------------------------- 111 | // statistics 112 | unsigned long getNumOfObjects(); 113 | unsigned long getNumOfChunks(); 114 | 115 | 116 | private: 117 | // internal allocate/release functions 118 | void * allocate_unlocked(); 119 | void release_unlocked( void *p ); 120 | 121 | //--------------------------------- 122 | // initializes the "list" 123 | void initializeList( t_list_element *pChunk ); 124 | 125 | // the memory allocator function 126 | CHUNK_ALLOCATOR __allocator; 127 | 128 | // pointer to the first free element 129 | t_list_element *__first_free_cell; 130 | 131 | // statistics 132 | unsigned long __num_of_objects; 133 | unsigned long __num_of_chunks; 134 | 135 | // synchnonization 136 | Mutex __mutex; 137 | }; 138 | 139 | 140 | 141 | //====================================================== 142 | // Implementation 143 | //====================================================== 144 | 145 | //--------------------------------- 146 | // constructor 147 | template 148 | TObjectsPool::TObjectsPool() 149 | : __first_free_cell( FREE_CELL_NONE ), __num_of_objects(0), __num_of_chunks(0) 150 | { 151 | # if 0 152 | // allocate the first block 153 | t_list_element *pBlock = __allocator.allocate(); 154 | if( NULL != pBlock ) { 155 | initializeList( pBlock ); 156 | __num_of_chunks ++; 157 | } 158 | #endif 159 | } 160 | 161 | 162 | //--------------------------------- 163 | // initializing linked list of free cells 164 | template 165 | void TObjectsPool::initializeList( t_list_element *pChunk ) 166 | { 167 | for( unsigned int i = 0; i < NumOfElementsInChunk; i++ ) 168 | pChunk[i].next_free_cell = pChunk + i + 1; 169 | 170 | pChunk[NumOfElementsInChunk - 1].next_free_cell = __first_free_cell; 171 | __first_free_cell = pChunk; 172 | } 173 | 174 | 175 | //--------------------------------- 176 | // allocating objects 177 | template 178 | void * TObjectsPool::allocate_unlocked() 179 | { 180 | if( FREE_CELL_NONE == __first_free_cell ) 181 | { 182 | // try to allocate additional block 183 | t_list_element *pNewBlock = __allocator.allocate(); 184 | if( NULL != pNewBlock ) { 185 | initializeList( pNewBlock ); 186 | __num_of_chunks ++; 187 | } 188 | 189 | if( FREE_CELL_NONE == __first_free_cell ) 190 | return NULL; 191 | } 192 | 193 | void* retVal = static_cast( &(__first_free_cell->data) ); 194 | __first_free_cell = __first_free_cell->next_free_cell; 195 | __num_of_objects ++; 196 | return retVal; 197 | } 198 | 199 | template 200 | void * TObjectsPool::allocate() 201 | { 202 | if (! IsThreadSafe) 203 | return allocate_unlocked(); 204 | 205 | MutexLock lock(__mutex); 206 | return allocate_unlocked(); 207 | } 208 | 209 | 210 | //--------------------------------- 211 | // ideallocating objects 212 | template 213 | void TObjectsPool::release_unlocked( void *p ) 214 | { 215 | t_list_element *pReleased = reinterpret_cast *>( p ); 216 | pReleased->next_free_cell = __first_free_cell; 217 | __first_free_cell = pReleased; 218 | 219 | if( __num_of_objects != 0 ) 220 | __num_of_objects --; 221 | } 222 | 223 | template 224 | void TObjectsPool::release( void *p ) 225 | { 226 | if( p == NULL ) return; 227 | 228 | if (! IsThreadSafe) { 229 | release_unlocked(p); 230 | } else { 231 | MutexLock lock(__mutex); 232 | release_unlocked(p); 233 | } 234 | } 235 | 236 | 237 | // Statistics 238 | template 239 | unsigned long TObjectsPool::getNumOfObjects() 240 | { 241 | return __num_of_objects; 242 | } 243 | 244 | template 245 | unsigned long TObjectsPool::getNumOfChunks() 246 | { 247 | return __num_of_chunks; 248 | } 249 | 250 | 251 | }; // namespace 252 | 253 | 254 | #endif // include once 255 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | Library: LeakTracer 2 | Homepage: http://www.andreasen.org/LeakTracer/ 3 | Maintainer: Frederic GERMAIN 4 | Bug reports: https://github.com/fredericgermain/LeakTracer/issues 5 | License (library): LGPLv2.1+ 6 | License (manual and tools): GPLv2+ 7 | 8 | 9 | General Information 10 | =================== 11 | 12 | This library is designed to be a nice complement of valgrind and libduma (ex efence) to 13 | detect leak memory. It simply override C/C++ allocation function (new, malloc, ...) to 14 | keep then in a simple list that could be analysed later. The effective allocation is 15 | still done by the underlying libc. 16 | It can be used when valgrind is not ported on your platform, when libduma is using too 17 | much virtual memory (embedded system), or when you're really interested in tracking only 18 | memory leaks. 19 | You may start/stop/dump monitoring allocation from the first allocation, when the program 20 | receive a signal (for ex. SIGUSR1), or when you explicitly call a LeakTracer function. 21 | 22 | 23 | The following documentation is inspired by DUMA, which is quite similar to use. 24 | 25 | 26 | Installation 27 | ============ 28 | 29 | See the file 'INSTALL' 30 | 31 | 32 | Usage 33 | ===== 34 | 35 | 3 ways to load the libleaktracer library : 36 | * Link your program with libleaktracer.a 37 | * Link your program with libleaktracer.so. You need the option -lleaktracer to be the 38 | first of your link command. You should see leaktracer.so as the first NEEDED entry of 39 | the Dynamic Section when you do a "objdump -p" of your program (through this check is 40 | really dependent of your binary loader) 41 | * use the LD_PRELOAD environment variable to be sure it is loaded before any other library. 42 | You don't need to change your program using this method. You can then customize LeakTracer 43 | behaviour using Environment variables. 44 | 45 | 46 | In any case your application must also be compiled with debugging symbols enabled 47 | (i.e. -g), so that you can lookup part of code that leaked with your source code. 48 | 49 | 50 | Environment variables 51 | ===================== 52 | 53 | LeakTracer has several configuration switches that can be enabled via 54 | the shell environment. These switches change how LeakTracer will behave, so 55 | it's important to know them. 56 | 57 | 58 | LEAKTRACER_NOBANNER - Prevent LeakTracer to announce itself on stderr when it load. 59 | 60 | LEAKTRACER_ONSIG_STARTALLTHREAD - If set, install a signal handler that will start allocation 61 | monitoring on the threads. 62 | Supported value are SIGUSR1, SIGUSR2 or a signal number for now. 63 | 64 | LEAKTRACER_ONSIG_STOPALLTHREAD - If set, install a signal handler that will stop allocation 65 | monitoring on the threads. 66 | Supported value are SIGUSR1, SIGUSR2 or a signal number for now. 67 | 68 | LEAKTRACER_ONSIG_REPORT - If set, install a signal handler that will write a raw LeakTracer 69 | report in the file LEAKTRACER_ONSIG_REPORTFILENAME. 70 | Supported value are SIGUSR1, SIGUSR2 or a signal number for now. 71 | 72 | LEAKTRACER_ONSIG_REPORTFILENAME - Name of a file where a report will be dump on a LEAKTRACER_ONSIG_REPORT. 73 | 74 | LEAKTRACER_ONSTART_STARTALLTHREAD - If set, start monitoring all allocation from the first allocation made. 75 | 76 | LEAKTRACER_ONEXIT_REPORT - If set, write a raw LeakTracer report in the file 77 | LEAKTRACER_ONEXIT_REPORTFILENAME when program exit. 78 | 79 | LEAKTRACER_ONEXIT_REPORTFILENAME - 80 | 81 | LEAKTRACER_AUTO_REPORTFILENAME - Equivalent to LEAKTRACER_ONSTART_STARTALLTHREAD=1 82 | LEAKTRACER_ONEXIT_REPORT=1 LEAKTRACER_ONEXIT_REPORTFILENAME=$LEAKTRACER_AUTO_REPORTFILENAME 83 | 84 | LEAKTRACER_EXIT_CODE_ON_LEAKS - The program will exit with specified code if at least one leak is present. 85 | 86 | Example: 87 | LD_PRELOAD=/usr/lib/libleaktracer.so LEAKTRACER_AUTO_REPORTFILENAME=leaks.out /bin/ls 88 | 89 | 90 | LD_PRELOAD=/usr/lib/libleaktracer.so LEAKTRACER_ONSIG_STARTALLTHREAD=USR1 LEAKTRACER_ONSIG_REPORT=USR2 LEAKTRACER_ONSIG_REPORTFILENAME=leaks.out top 91 | killall -USR1 top 92 | ... 93 | killall -USR2 top 94 | 95 | Sometimes, SIGUSR1 and SIGUSR2 are used. You can use RT signals, which are generally not used : 96 | LD_PRELOAD=/usr/lib/libleaktracer.so LEAKTRACER_ONSIG_STARTALLTHREAD=35 LEAKTRACER_ONSIG_REPORT=36 LEAKTRACER_ONSIG_REPORTFILENAME=leaks.out top 97 | 98 | 99 | Fine grained control of memory allocation 100 | ========================================= 101 | You can use directly LeakTracer api to start/stop allocation monitoring, or to write reports to file. 102 | Two set of API are available, one in C, one in C++ 103 | 104 | C API 105 | You should include file "leaktracer.h" in your program 106 | 107 | 108 | C++ API 109 | You should include file "MemoryTrace.hpp" in your program 110 | 111 | 112 | 113 | Catching the leak 114 | ================= 115 | 116 | Once you have your leak report, find the call stacks which generate the leaks. 117 | The call stack is sequence of call where the leak appeared. 118 | 119 | To find the code that generate the leak given a memory address, several method can be used. 120 | * GDB/GDBSERVER: the most reliable method is to attach gdb or gdbserver to your program. When you're 121 | attach, type "break *addr" or "disassemble addr addr+10" to know where the leak appeared. 122 | The advantage of using a breakpoint is that you can find quickly how the leak happens. 123 | * You can activate the core dump support using "ulimit -c unlimited" in your shell. Generate a corefile 124 | with "kill -QUIT $pidprogram", and use gdb again to find the code that leak. 125 | * addr2line utility can give you an address given a program. But if your leak appear in a dynamic library, 126 | it won't give you the information. 127 | 128 | 129 | Analyzing output 130 | ================ 131 | 132 | You should then run leak-analyze, since looking at the raw leaks.out file will 133 | not help you much. You need perl to run it. 134 | Two versions of lead-analyze are provided: 135 | * one is using gdb to find the line of the leak in your source code. This is the best way so far. 136 | * one is using addr2line. To problem with is method is that it won't find the line in the dynamic libraries 137 | 138 | 139 | Help developping Leaktracer 140 | ========================= 141 | You can use the debug mode to track problem in LeakTracer 142 | To do that, build in debug mode : 143 | > make DEBUG=1 clean all 144 | > gdb /bin/ls 145 | In gdb 146 | set environment LD_PRELOAD /usr/lib/libleaktracer.so 147 | set environment LEAKTRACER_AUTO_REPORTFILENAME leaks.out 148 | run 149 | ... 150 | 151 | Note about implementation 152 | ========================= 153 | 154 | * FG: I tried to first use LTS variable instead of pthread_key, but it looks like I was having a problem with them 155 | on a old uclibc problem. 156 | * On x86_64, gcc 4.5.2, or other platform, it looks like there is a crash in __builtin_frame_address(i) if i > 1. You should define 157 | ALLOCATION_STACK_DEPTH to 1, or define USE_BACKTRACE to use backtrace() function. 158 | 159 | 160 | Project history 161 | =============== 162 | Original project is made by Erwin S. Andreasen 163 | Michael Gopshtein rewrite most of it to add nice start/stop and other functionalities. 164 | Frederic Germain added malloc/realloc/free support, and environment variable support to 165 | use LeakTracer without having to recompile your program. 166 | 167 | License was change to LGPL/GPL from version 3.0. 168 | If you're a original contributor and you have something to oppose to the license change, please contact 169 | me, I'll rewrite some code. 170 | 171 | 172 | 173 | Contact 174 | ======= 175 | For any questions/problems/suggestions please contact 176 | Frederic Germain, frederic.germain@gmail.com 177 | 178 | 179 | 180 | Patches you want to be integrated 181 | ================================= 182 | 183 | Use github to submit your patches. Git way to do it are preferred. 184 | 185 | Patches should be in unified diff form. (The -up option to GNU diff.) 186 | -------------------------------------------------------------------------------- /libleaktracer/src/MemoryTrace.cpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #include 15 | 16 | #include "MemoryTrace.hpp" 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | 23 | #include 24 | #include 25 | 26 | 27 | #include 28 | #include "LeakTracer_l.hpp" 29 | 30 | // glibc/eglibc: dlsym uses calloc internally now, so use weak symbol to get their symbol 31 | extern "C" void* __libc_malloc(size_t size) __attribute__((weak)); 32 | extern "C" void __libc_free(void* ptr) __attribute__((weak)); 33 | extern "C" void* __libc_realloc(void *ptr, size_t size) __attribute__((weak)); 34 | extern "C" void* __libc_calloc(size_t nmemb, size_t size) __attribute__((weak)); 35 | 36 | namespace leaktracer { 37 | 38 | typedef struct { 39 | const char *symbname; 40 | void *libcsymbol; 41 | void **localredirect; 42 | } libc_alloc_func_t; 43 | 44 | static libc_alloc_func_t libc_alloc_funcs[] = { 45 | { "calloc", (void*)__libc_calloc, (void**)(<_calloc) }, 46 | { "malloc", (void*)__libc_malloc, (void**)(<_malloc) }, 47 | { "realloc", (void*)__libc_realloc, (void**)(<_realloc) }, 48 | { "free", (void*)__libc_free, (void**)(<_free) } 49 | }; 50 | 51 | MemoryTrace *MemoryTrace::__instance = NULL; 52 | char s_memoryTrace_instance[sizeof(MemoryTrace)]; 53 | pthread_once_t MemoryTrace::_init_no_alloc_allowed_once = PTHREAD_ONCE_INIT; 54 | pthread_once_t MemoryTrace::_init_full_once = PTHREAD_ONCE_INIT; 55 | 56 | int MemoryTrace::__sigStartAllThread = 0; 57 | int MemoryTrace::__sigStopAllThread = 0; 58 | int MemoryTrace::__sigReport = 0; 59 | 60 | 61 | MemoryTrace::MemoryTrace(void) : 62 | __setupDone(false), __monitoringAllThreads(false), __monitoringReleases(false), __monitoringDisabler(0) 63 | { 64 | } 65 | 66 | void MemoryTrace::sigactionHandler(int sigNumber, siginfo_t *siginfo, void *arg) 67 | { 68 | (void)siginfo; 69 | (void)arg; 70 | if (sigNumber == __sigStartAllThread) 71 | { 72 | TRACE((stderr, "MemoryTracer: signal %d received, starting monitoring\n", sigNumber)); 73 | leaktracer::MemoryTrace::GetInstance().startMonitoringAllThreads(); 74 | } 75 | if (sigNumber == __sigStopAllThread) 76 | { 77 | TRACE((stderr, "MemoryTracer: signal %d received, stoping monitoring\n", sigNumber)); 78 | leaktracer::MemoryTrace::GetInstance().stopAllMonitoring(); 79 | } 80 | if (sigNumber == __sigReport) 81 | { 82 | const char* reportFilename; 83 | if (getenv("LEAKTRACER_ONSIG_REPORTFILENAME") == NULL) 84 | reportFilename = "leaks.out"; 85 | else 86 | reportFilename = getenv("LEAKTRACER_ONSIG_REPORTFILENAME"); 87 | TRACE((stderr, "MemoryTracer: signal %d received, writing report to %s\n", sigNumber, reportFilename)); 88 | leaktracer::MemoryTrace::GetInstance().writeLeaksToFile(reportFilename); 89 | } 90 | } 91 | 92 | int MemoryTrace::signalNumberFromString(const char* signame) 93 | { 94 | if (strncmp(signame, "SIG", 3) == 0) 95 | signame += 3; 96 | 97 | if (strcmp(signame, "USR1") == 0) 98 | return SIGUSR1; 99 | else if (strcmp(signame, "USR2") == 0) 100 | return SIGUSR2; 101 | else 102 | return atoi(signame); 103 | } 104 | 105 | void 106 | MemoryTrace::init_no_alloc_allowed() 107 | { 108 | libc_alloc_func_t *curfunc; 109 | unsigned i; 110 | 111 | for (i=0; i<(sizeof(libc_alloc_funcs)/sizeof(libc_alloc_funcs[0])); ++i) { 112 | curfunc = &libc_alloc_funcs[i]; 113 | if (!*curfunc->localredirect) { 114 | if (curfunc->libcsymbol) { 115 | *curfunc->localredirect = curfunc->libcsymbol; 116 | } else { 117 | *curfunc->localredirect = dlsym(RTLD_NEXT, curfunc->symbname); 118 | } 119 | } 120 | } 121 | 122 | __instance = reinterpret_cast(&s_memoryTrace_instance); 123 | 124 | // we're using a c++ placement to initialized the MemoryTrace object living in the data section 125 | new (__instance) MemoryTrace(); 126 | 127 | // it seems some implementation of pthread_key_create use malloc() internally (old linuxthreads) 128 | // these are not supported yet 129 | pthread_key_create(&__instance->__thread_internal_disabler_key, NULL); 130 | } 131 | 132 | void 133 | MemoryTrace::init_full_from_once() 134 | { 135 | leaktracer::MemoryTrace::GetInstance().init_full(); 136 | } 137 | 138 | void 139 | MemoryTrace::init_full() 140 | { 141 | int sigNumber; 142 | struct sigaction sigact; 143 | 144 | __monitoringDisabler++; 145 | 146 | void *testmallocok = malloc(1); 147 | free(testmallocok); 148 | 149 | pthread_key_create(&__thread_options_key, CleanUpThreadData); 150 | 151 | if (!getenv("LEAKTRACER_NOBANNER")) 152 | { 153 | #ifdef SHARED 154 | fprintf(stderr, "LeakTracer " LEAKTRACER_VERSION " (shared library) -- LGPLv2\n"); 155 | #else 156 | fprintf(stderr, "LeakTracer " LEAKTRACER_VERSION " (static library) -- LGPLv2\n"); 157 | #endif 158 | } 159 | 160 | if (getenv("LEAKTRACER_ONSIG_STARTALLTHREAD")) 161 | { 162 | sigact.sa_sigaction = sigactionHandler; 163 | sigemptyset(&sigact.sa_mask); 164 | sigact.sa_flags = SA_SIGINFO; 165 | sigNumber = signalNumberFromString(getenv("LEAKTRACER_ONSIG_STARTALLTHREAD")); 166 | __sigStartAllThread = sigNumber; 167 | sigaction(sigNumber, &sigact, NULL); 168 | TRACE((stderr, "LeakTracer: registered signal %d SIGSTART for tid %d\n", sigNumber, (pid_t) syscall (SYS_gettid))); 169 | } 170 | 171 | if (getenv("LEAKTRACER_ONSIG_STOPALLTHREAD")) 172 | { 173 | sigact.sa_sigaction = sigactionHandler; 174 | sigemptyset(&sigact.sa_mask); 175 | sigact.sa_flags = SA_SIGINFO; 176 | sigNumber = signalNumberFromString(getenv("LEAKTRACER_ONSIG_STOPALLTHREAD")); 177 | __sigStopAllThread = sigNumber; 178 | sigaction(sigNumber, &sigact, NULL); 179 | TRACE((stderr, "LeakTracer: registered signal %d SIGSTOP for tid %d\n", sigNumber, (pid_t) syscall (SYS_gettid))); 180 | } 181 | 182 | if (getenv("LEAKTRACER_ONSIG_REPORT")) 183 | { 184 | sigact.sa_sigaction = sigactionHandler; 185 | sigemptyset(&sigact.sa_mask); 186 | sigact.sa_flags = SA_SIGINFO; 187 | sigNumber = signalNumberFromString(getenv("LEAKTRACER_ONSIG_REPORT")); 188 | __sigReport = sigNumber; 189 | sigaction(sigNumber, &sigact, NULL); 190 | TRACE((stderr, "LeakTracer: registered signal %d SIGREPORT for tid %d\n", sigNumber, (pid_t) syscall (SYS_gettid))); 191 | } 192 | 193 | if (getenv("LEAKTRACER_ONSTART_STARTALLTHREAD") || getenv("LEAKTRACER_AUTO_REPORTFILENAME")) 194 | { 195 | leaktracer::MemoryTrace::GetInstance().startMonitoringAllThreads(); 196 | } 197 | #ifdef USE_BACKTRACE 198 | // we call backtrace here, because there is some init on its first call 199 | void *bt; 200 | backtrace(&bt, 1); 201 | #endif 202 | __setupDone = true; 203 | 204 | __monitoringDisabler--; 205 | } 206 | 207 | int MemoryTrace::Setup(void) 208 | { 209 | pthread_once(&MemoryTrace::_init_no_alloc_allowed_once, MemoryTrace::init_no_alloc_allowed); 210 | 211 | if (!leaktracer::MemoryTrace::GetInstance().AllMonitoringIsDisabled()) { 212 | pthread_once(&MemoryTrace::_init_full_once, MemoryTrace::init_full_from_once); 213 | } 214 | #if 0 215 |  else if (!leaktracer::MemoryTrace::GetInstance().__setupDone) { 216 | } 217 | #endif 218 | return 0; 219 | } 220 | 221 | void MemoryTrace::MemoryTraceOnInit(void) 222 | { 223 | //TRACE((stderr, "LeakTracer: MemoryTrace::MemoryTraceOnInit\n")); 224 | leaktracer::MemoryTrace::Setup(); 225 | } 226 | 227 | 228 | void MemoryTrace::MemoryTraceOnExit(void) 229 | { 230 | if (getenv("LEAKTRACER_ONEXIT_REPORT") || getenv("LEAKTRACER_AUTO_REPORTFILENAME")) 231 | { 232 | const char *reportName; 233 | if ( !(reportName = getenv("LEAKTRACER_ONEXIT_REPORTFILENAME")) && !(reportName = getenv("LEAKTRACER_AUTO_REPORTFILENAME"))) 234 | { 235 | TRACE((stderr, "LeakTracer: LEAKTRACER_ONEXIT_REPORTFILENAME needs to be defined when using LEAKTRACER_ONEXIT_REPORT\n")); 236 | return; 237 | } 238 | leaktracer::MemoryTrace::GetInstance().stopAllMonitoring(); 239 | TRACE((stderr, "LeakTracer: writing leak report in %s\n", reportName)); 240 | leaktracer::MemoryTrace::GetInstance().writeLeaksToFile(reportName); 241 | } 242 | 243 | const char *exitCode = getenv("LEAKTRACER_EXIT_CODE_ON_LEAKS"); 244 | if (exitCode != NULL && !leaktracer::MemoryTrace::GetInstance().__allocations.empty()) 245 | { 246 | exit(atoi(exitCode)); 247 | } 248 | } 249 | 250 | MemoryTrace::~MemoryTrace(void) 251 | { 252 | pthread_key_delete(__thread_options_key); 253 | } 254 | 255 | 256 | 257 | // is called automatically when thread exists, whould 258 | // cleanup per-thread data 259 | void MemoryTrace::CleanUpThreadData(void *ptrThreadOptions) 260 | { 261 | if( ptrThreadOptions != NULL ) 262 | GetInstance().removeThreadOptions( reinterpret_cast(ptrThreadOptions) ); 263 | } 264 | 265 | 266 | // cleans per-thread configuration object, and removes 267 | // it from the list of all objects 268 | void MemoryTrace::removeThreadOptions(ThreadMonitoringOptions *pOptions) 269 | { 270 | MutexLock lock(__threadListMutex); 271 | for (list_monitoring_options_t::iterator it = __listThreadOptions.begin(); it != __listThreadOptions.end(); ++it) { 272 | if (*it == pOptions) { 273 | // found this object in the list 274 | delete *it; 275 | __listThreadOptions.erase(it); 276 | return; 277 | } 278 | } 279 | } 280 | 281 | 282 | // writes all memory leaks to given stream 283 | void MemoryTrace::writeLeaksPrivate(std::ostream &out) 284 | { 285 | struct timespec mono, utc, diff; 286 | allocation_info_t *info; 287 | void *p; 288 | double d; 289 | const int precision = 6; 290 | int maxsecwidth; 291 | 292 | clock_gettime(CLOCK_REALTIME, &utc); 293 | clock_gettime(CLOCK_MONOTONIC, &mono); 294 | 295 | if (utc.tv_nsec > mono.tv_nsec) { 296 | diff.tv_nsec = utc.tv_nsec - mono.tv_nsec; 297 | diff.tv_sec = utc.tv_sec - mono.tv_sec; 298 | } else { 299 | diff.tv_nsec = 1000000000 - (mono.tv_nsec - utc.tv_nsec); 300 | diff.tv_sec = utc.tv_sec - mono.tv_sec -1; 301 | } 302 | 303 | maxsecwidth = 0; 304 | while(mono.tv_sec > 0) { 305 | mono.tv_sec = mono.tv_sec/10; 306 | maxsecwidth++; 307 | } 308 | if (maxsecwidth == 0) maxsecwidth=1; 309 | 310 | out << "# LeakTracer report"; 311 | d = diff.tv_sec + (((double)diff.tv_nsec)/1000000000); 312 | out << " diff_utc_mono=" << std::fixed << std::left << std::setprecision(precision) << d ; 313 | out << "\n"; 314 | 315 | __allocations.beginIteration(); 316 | while (__allocations.getNextPair(&info, &p)) { 317 | d = info->timestamp.tv_sec + (((double)info->timestamp.tv_nsec)/1000000000); 318 | out << "leak, "; 319 | out << "time=" << std::fixed << std::right << std::setprecision(precision) << std::setfill('0') << std::setw(maxsecwidth+1+precision) << d << ", "; // setw(16) ? 320 | out << "stack="; 321 | for (unsigned int i = 0; i < ALLOCATION_STACK_DEPTH; i++) { 322 | if (info->allocStack[i] == NULL) break; 323 | 324 | if (i > 0) out << ' '; 325 | out << info->allocStack[i]; 326 | } 327 | out << ", "; 328 | 329 | out << "size=" << info->size << ", "; 330 | 331 | out << "data="; 332 | const char *data = reinterpret_cast(p); 333 | for (unsigned int i = 0; i < PRINTED_DATA_BUFFER_SIZE && i < info->size; i++) 334 | out << (isprint(data[i]) ? data[i] : '.'); 335 | out << '\n'; 336 | } 337 | } 338 | 339 | 340 | // writes all memory leaks to given stream 341 | void MemoryTrace::writeLeaks(std::ostream &out) 342 | { 343 | MutexLock lock(__allocations_mutex); 344 | InternalMonitoringDisablerThreadUp(); 345 | 346 | writeLeaksPrivate(out); 347 | 348 | InternalMonitoringDisablerThreadDown(); 349 | } 350 | 351 | 352 | // writes all memory leaks to given stream 353 | void MemoryTrace::writeLeaksToFile(const char* reportFilename) 354 | { 355 | MutexLock lock(__allocations_mutex); 356 | InternalMonitoringDisablerThreadUp(); 357 | 358 | std::ofstream oleaks; 359 | oleaks.open(reportFilename, std::ios_base::out); 360 | if (oleaks.is_open()) 361 | { 362 | writeLeaksPrivate(oleaks); 363 | oleaks.close(); 364 | } 365 | else 366 | { 367 | std::cerr << "Failed to write to \"" << reportFilename << "\"\n"; 368 | } 369 | InternalMonitoringDisablerThreadDown(); 370 | } 371 | 372 | void MemoryTrace::clearAllocationsInfo(void) 373 | { 374 | MutexLock lock(__allocations_mutex); 375 | __allocations.clearAllInfo(); 376 | } 377 | 378 | 379 | } // end namespace 380 | -------------------------------------------------------------------------------- /libleaktracer/include/MemoryTrace.hpp: -------------------------------------------------------------------------------- 1 | //////////////////////////////////////////////////////// 2 | // 3 | // LeakTracer 4 | // Contribution to original project by Erwin S. Andreasen 5 | // site: http://www.andreasen.org/LeakTracer/ 6 | // 7 | // Added by Michael Gopshtein, 2006 8 | // mgopshtein@gmail.com 9 | // 10 | // Any comments/suggestions are welcome 11 | // 12 | //////////////////////////////////////////////////////// 13 | 14 | #ifndef __MEMORY_TRACE_h_included__ 15 | #define __MEMORY_TRACE_h_included__ 16 | 17 | #include 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #ifdef USE_BACKTRACE 25 | #include 26 | #endif 27 | 28 | 29 | #include "Mutex.hpp" 30 | #include "MutexLock.hpp" 31 | #include "MapMemoryInfo.hpp" 32 | 33 | 34 | ///////////////////////////////////////////////////////////// 35 | // Following MACROS are available at compile time: 36 | // 37 | // START_TRACING_FROM_PROCESS_START - starts monitoring memory 38 | // allocations from the start of BeatBox process. 39 | // Otherwise should be explicetly activated 40 | // default: OFF 41 | // 42 | // ALLOCATION_STACK_DEPTH - max number of stack frame to 43 | // save. Max supported value: 10 44 | // 45 | // PRINTED_DATA_BUFFER_SIZE - size of the data buffer to be printed 46 | // for each allocation. 47 | // 48 | ///////////////////////////////////////////////////////////// 49 | 50 | #ifndef ALLOCATION_STACK_DEPTH 51 | # define ALLOCATION_STACK_DEPTH 5 52 | #endif 53 | 54 | #ifndef PRINTED_DATA_BUFFER_SIZE 55 | # define PRINTED_DATA_BUFFER_SIZE 50 56 | #endif 57 | #include "LeakTracer_l.hpp" 58 | 59 | 60 | namespace leaktracer { 61 | 62 | 63 | /** 64 | * Main class to trace memory allocations 65 | * and releases. 66 | */ 67 | class MemoryTrace { 68 | public: 69 | /** singleton class */ 70 | inline static MemoryTrace & GetInstance(void); 71 | 72 | /** setup undelying libc malloc/free... */ 73 | static int Setup(void); 74 | 75 | /** starts monitoring memory allocations in all threads */ 76 | inline void startMonitoringAllThreads(void); 77 | /** starts monitoring memory allocations in current thread */ 78 | inline void startMonitoringThisThread(void); 79 | 80 | /** stops monitoring memory allocations (in all threads or in 81 | * this thread only, depends on the function used to start 82 | * monitoring */ 83 | inline void stopMonitoringAllocations(void); 84 | 85 | /** stops all monitoring - both of allocations and releases */ 86 | inline void stopAllMonitoring(void); 87 | 88 | /** registers new memory allocation, should be called by the 89 | * function intercepting "new" calls */ 90 | inline void registerAllocation(void *p, size_t size, bool is_array); 91 | 92 | /** registers memory reallocation, should be called by the 93 | * function intercepting realloc calls */ 94 | inline void registerReallocation(void *p, size_t size, bool is_array); 95 | 96 | /** registers memory release, should be called by the 97 | * function intercepting "delete" calls */ 98 | inline void registerRelease(void *p, bool is_array); 99 | 100 | /** writes report with all memory leaks */ 101 | void writeLeaks(std::ostream &out); 102 | 103 | /** writes report with all memory leaks */ 104 | void writeLeaksToFile(const char* reportFileName); 105 | 106 | /** returns TRUE if all monitoring is currently disabled, 107 | * required to make sure we don't use this class before it 108 | * was properly initialized */ 109 | inline bool AllMonitoringIsDisabled(void) { 110 | return ( (__monitoringDisabler!=0)|| 111 | (((intptr_t)pthread_getspecific(__thread_internal_disabler_key)) != 0) ); 112 | } 113 | 114 | inline int InternalMonitoringDisablerThreadUp(void) { 115 | intptr_t oldvalue; 116 | oldvalue = (intptr_t)pthread_getspecific(__thread_internal_disabler_key); 117 | //TRACE((stderr, "InternalMonitoringDisablerThreadUp oldvalue %d\n", oldvalue)); 118 | pthread_setspecific(__thread_internal_disabler_key, (void*) (oldvalue + 1) ); 119 | return oldvalue; 120 | } 121 | 122 | inline int InternalMonitoringDisablerThreadDown(void) { 123 | intptr_t oldvalue; 124 | oldvalue = (intptr_t)pthread_getspecific(__thread_internal_disabler_key); 125 | //TRACE((stderr, "InternalMonitoringDisablerThreadDown oldvalue %d\n", oldvalue)); 126 | pthread_setspecific(__thread_internal_disabler_key, (void*) (oldvalue - 1) ); 127 | return oldvalue; 128 | } 129 | 130 | static void __attribute__ ((constructor)) MemoryTraceOnInit(void); 131 | static void __attribute__ ((destructor)) MemoryTraceOnExit(void); 132 | 133 | /** destructor */ 134 | virtual ~MemoryTrace(void); 135 | 136 | private: 137 | // singleton object 138 | MemoryTrace(void); 139 | static MemoryTrace *__instance; 140 | 141 | // global settings 142 | bool __setupDone; 143 | bool __monitoringAllThreads; 144 | bool __monitoringReleases; 145 | int __monitoringDisabler; 146 | 147 | // per-thread settings, for cases where only allocations 148 | // made by specific threads are monitored 149 | struct ThreadMonitoringOptions { 150 | bool monitoringAllocations; 151 | inline ThreadMonitoringOptions() : monitoringAllocations(false) {} 152 | }; 153 | inline ThreadMonitoringOptions & getThreadOptions(void); 154 | void removeThreadOptions(ThreadMonitoringOptions *pOptions); 155 | inline void stopMonitoringPerThreadAllocations(void); 156 | 157 | // key to access per-thread info 158 | pthread_key_t __thread_internal_disabler_key; 159 | 160 | static void CleanUpThreadData(void *ptrThreadOptions); 161 | pthread_key_t __thread_options_key; 162 | 163 | // init functions 164 | static void init_no_alloc_allowed(); 165 | static pthread_once_t _init_no_alloc_allowed_once; 166 | 167 | void init_full(); 168 | static void init_full_from_once(); 169 | static pthread_once_t _init_full_once; 170 | 171 | // signal handler 172 | static int __sigStartAllThread; 173 | static int __sigStopAllThread; 174 | static int __sigReport; 175 | static void sigactionHandler(int, siginfo_t *, void *); 176 | static int signalNumberFromString(const char* signame); 177 | 178 | /** writes report with all memory leaks */ 179 | void writeLeaksPrivate(std::ostream &out); 180 | 181 | // centralized list of all per-thread options 182 | typedef std::list list_monitoring_options_t; 183 | list_monitoring_options_t __listThreadOptions; 184 | Mutex __threadListMutex; 185 | 186 | // per - allocation info 187 | typedef struct _allocation_info_struct { 188 | size_t size; 189 | struct timespec timestamp; 190 | void * allocStack[ALLOCATION_STACK_DEPTH]; 191 | bool isArray; 192 | } allocation_info_t; 193 | inline void storeAllocationStack(void* arr[ALLOCATION_STACK_DEPTH]); 194 | inline void storeTimestamp(struct timespec &tm); 195 | 196 | typedef TMapMemoryInfo memory_allocations_info_t; 197 | memory_allocations_info_t __allocations; 198 | Mutex __allocations_mutex; 199 | void clearAllocationsInfo(void); 200 | }; 201 | 202 | 203 | 204 | ////////////////////////////////////////////////////////////////////// 205 | // 206 | // IMPLEMENTATION: MemoryTrace 207 | // (inline functions) 208 | // 209 | ////////////////////////////////////////////////////////////////////// 210 | 211 | 212 | // Returns singleton instance of MemoryTrace object 213 | inline MemoryTrace & MemoryTrace::GetInstance(void) 214 | { 215 | return *__instance; 216 | } 217 | 218 | 219 | // Returns per-thread object for calling thread 220 | // (creates one if called for the first time) 221 | inline MemoryTrace::ThreadMonitoringOptions & MemoryTrace::getThreadOptions(void) 222 | { 223 | ThreadMonitoringOptions *pOpt = reinterpret_cast(pthread_getspecific(__thread_options_key)); 224 | if (pOpt == NULL) { 225 | MutexLock lock(__threadListMutex); 226 | // before creating new object we need to disable any monitoring 227 | InternalMonitoringDisablerThreadUp(); 228 | pOpt = new ThreadMonitoringOptions; 229 | pthread_setspecific(__thread_options_key, pOpt); 230 | __listThreadOptions.push_back(pOpt); 231 | InternalMonitoringDisablerThreadDown(); 232 | } 233 | return *pOpt; 234 | } 235 | 236 | 237 | // iterates over list of per-thread objects, and diables 238 | // monitoring for all threads 239 | inline void MemoryTrace::stopMonitoringPerThreadAllocations(void) 240 | { 241 | leaktracer::MemoryTrace::Setup(); 242 | 243 | MutexLock lock(__threadListMutex); 244 | for (list_monitoring_options_t::iterator it = __listThreadOptions.begin(); it != __listThreadOptions.end(); ++it) { 245 | (*it)->monitoringAllocations = false; 246 | } 247 | } 248 | 249 | 250 | // starts monitoring allocations and releases in all threads 251 | inline void MemoryTrace::startMonitoringAllThreads(void) 252 | { 253 | leaktracer::MemoryTrace::Setup(); 254 | 255 | TRACE((stderr, "LeakTracer: startMonitoringAllThreads\n")); 256 | if (!__monitoringReleases) { 257 | MutexLock lock(__allocations_mutex); 258 | // double-check inside Mutex 259 | if (!__monitoringReleases) { 260 | __allocations.clearAllInfo(); 261 | __monitoringReleases = true; 262 | } 263 | } 264 | __monitoringAllThreads = true; 265 | stopMonitoringPerThreadAllocations(); 266 | } 267 | 268 | 269 | // starts monitoring memory allocations in this thread 270 | // (note: releases are monitored in all threads) 271 | inline void MemoryTrace::startMonitoringThisThread(void) 272 | { 273 | leaktracer::MemoryTrace::Setup(); 274 | 275 | TRACE((stderr, "LeakTracer: startMonitoringThisThread\n")); 276 | if (!__monitoringAllThreads) { 277 | if (!__monitoringReleases) { 278 | MutexLock lock(__allocations_mutex); 279 | // double-check inside Mutex 280 | if (!__monitoringReleases) { 281 | __allocations.clearAllInfo(); 282 | __monitoringReleases = true; 283 | } 284 | } 285 | getThreadOptions().monitoringAllocations = true; 286 | } 287 | } 288 | 289 | 290 | // Depending on "startMonitoring" function used previously, 291 | // will stop monitoring all threads, of current thread only 292 | inline void MemoryTrace::stopMonitoringAllocations(void) 293 | { 294 | leaktracer::MemoryTrace::Setup(); 295 | 296 | TRACE((stderr, "LeakTracer: stopMonitoringAllocations\n")); 297 | if (__monitoringAllThreads) 298 | __monitoringAllThreads = false; 299 | else 300 | getThreadOptions().monitoringAllocations = false; 301 | } 302 | 303 | 304 | // stop all allocation/releases monitoring 305 | inline void MemoryTrace::stopAllMonitoring(void) 306 | { 307 | leaktracer::MemoryTrace::Setup(); 308 | 309 | TRACE((stderr, "LeakTracer: stopAllMonitoring\n")); 310 | stopMonitoringAllocations(); 311 | __monitoringReleases = false; 312 | } 313 | 314 | 315 | // stores allocation stack, up to ALLOCATION_STACK_DEPTH 316 | // frames 317 | inline void MemoryTrace::storeAllocationStack(void* arr[ALLOCATION_STACK_DEPTH]) 318 | { 319 | unsigned int iIndex = 0; 320 | #ifdef USE_BACKTRACE 321 | void* arrtmp[ALLOCATION_STACK_DEPTH+1]; 322 | iIndex = backtrace(arrtmp, ALLOCATION_STACK_DEPTH + 1) - 1; 323 | memcpy(arr, &arrtmp[1], iIndex*sizeof(void*)); 324 | #else 325 | void *pFrame; 326 | // NOTE: we can't use "for" loop, __builtin_* functions 327 | // require the number to be known at compile time 328 | arr[iIndex++] = ( (pFrame = __builtin_frame_address(0)) != NULL) ? __builtin_return_address(0) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 329 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(1)) != NULL) ? __builtin_return_address(1) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 330 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(2)) != NULL) ? __builtin_return_address(2) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 331 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(3)) != NULL) ? __builtin_return_address(3) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 332 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(4)) != NULL) ? __builtin_return_address(4) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 333 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(5)) != NULL) ? __builtin_return_address(5) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 334 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(6)) != NULL) ? __builtin_return_address(6) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 335 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(7)) != NULL) ? __builtin_return_address(7) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 336 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(8)) != NULL) ? __builtin_return_address(8) : NULL; if (iIndex == ALLOCATION_STACK_DEPTH) return; 337 | arr[iIndex++] = (pFrame != NULL && (pFrame = __builtin_frame_address(9)) != NULL) ? __builtin_return_address(9) : NULL; 338 | #endif 339 | // fill remaining spaces 340 | for (; iIndex < ALLOCATION_STACK_DEPTH; iIndex++) 341 | arr[iIndex] = NULL; 342 | } 343 | 344 | 345 | // adds all relevant info regarding current allocation to map 346 | inline void MemoryTrace::registerAllocation(void *p, size_t size, bool is_array) 347 | { 348 | allocation_info_t *info = NULL; 349 | if (!AllMonitoringIsDisabled() && (__monitoringAllThreads || getThreadOptions().monitoringAllocations) && p != NULL) { 350 | MutexLock lock(__allocations_mutex); 351 | info = __allocations.insert(p); 352 | if (info != NULL) { 353 | info->size = size; 354 | info->isArray = is_array; 355 | storeTimestamp(info->timestamp); 356 | } 357 | } 358 | // we store the stack without locking __allocations_mutex 359 | // it should be safe enough 360 | // prevent a deadlock between backtrave function who are now using advanced dl_iterate_phdr function 361 | // and dl_* function which uses malloc functions 362 | if (info != NULL) { 363 | storeAllocationStack(info->allocStack); 364 | } 365 | 366 | if (p == NULL) { 367 | InternalMonitoringDisablerThreadUp(); 368 | // WARNING 369 | InternalMonitoringDisablerThreadDown(); 370 | } 371 | } 372 | 373 | 374 | // adds all relevant info regarding current allocation to map 375 | inline void MemoryTrace::registerReallocation(void *p, size_t size, bool is_array) 376 | { 377 | if (!AllMonitoringIsDisabled() && (__monitoringAllThreads || getThreadOptions().monitoringAllocations) && p != NULL) { 378 | MutexLock lock(__allocations_mutex); 379 | allocation_info_t *info = __allocations.find(p); 380 | if (info != NULL) { 381 | info->size = size; 382 | info->isArray = is_array; 383 | storeAllocationStack(info->allocStack); 384 | storeTimestamp(info->timestamp); 385 | } 386 | } 387 | 388 | if (p == NULL) { 389 | InternalMonitoringDisablerThreadUp(); 390 | // WARNING 391 | InternalMonitoringDisablerThreadDown(); 392 | } 393 | } 394 | 395 | 396 | // removes allocation's info from the map 397 | inline void MemoryTrace::registerRelease(void *p, bool is_array) 398 | { 399 | if (!AllMonitoringIsDisabled() && __monitoringReleases && p != NULL) { 400 | MutexLock lock(__allocations_mutex); 401 | allocation_info_t *info = __allocations.find(p); 402 | if (info != NULL) { 403 | if (info->isArray != is_array) { 404 | InternalMonitoringDisablerThreadUp(); 405 | // WARNING 406 | InternalMonitoringDisablerThreadDown(); 407 | } 408 | __allocations.release(p); 409 | } 410 | } 411 | } 412 | 413 | // storetimestamp function 414 | inline void MemoryTrace::storeTimestamp(struct timespec ×tamp) 415 | { 416 | clock_gettime(CLOCK_MONOTONIC, ×tamp); 417 | } 418 | 419 | 420 | } // end namespace 421 | 422 | 423 | #endif // include once 424 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Library General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License 307 | along with this program; if not, write to the Free Software 308 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 309 | 310 | 311 | Also add information on how to contact you by electronic and paper mail. 312 | 313 | If the program is interactive, make it output a short notice like this 314 | when it starts in an interactive mode: 315 | 316 | Gnomovision version 69, Copyright (C) year name of author 317 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 318 | This is free software, and you are welcome to redistribute it 319 | under certain conditions; type `show c' for details. 320 | 321 | The hypothetical commands `show w' and `show c' should show the appropriate 322 | parts of the General Public License. Of course, the commands you use may 323 | be called something other than `show w' and `show c'; they could even be 324 | mouse-clicks or menu items--whatever suits your program. 325 | 326 | You should also get your employer (if you work as a programmer) or your 327 | school, if any, to sign a "copyright disclaimer" for the program, if 328 | necessary. Here is a sample; alter the names: 329 | 330 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 331 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 332 | 333 | , 1 April 1989 334 | Ty Coon, President of Vice 335 | 336 | This General Public License does not permit incorporating your program into 337 | proprietary programs. If your program is a subroutine library, you may 338 | consider it more useful to permit linking proprietary applications with the 339 | library. If this is what you want to do, use the GNU Library General 340 | Public License instead of this License. 341 | -------------------------------------------------------------------------------- /COPYING.LIB: -------------------------------------------------------------------------------- 1 | 2 | GNU LESSER GENERAL PUBLIC LICENSE 3 | Version 2.1, February 1999 4 | 5 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 6 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | [This is the first released version of the Lesser GPL. It also counts 11 | as the successor of the GNU Library Public License, version 2, hence 12 | the version number 2.1.] 13 | 14 | Preamble 15 | 16 | The licenses for most software are designed to take away your 17 | freedom to share and change it. By contrast, the GNU General Public 18 | Licenses are intended to guarantee your freedom to share and change 19 | free software--to make sure the software is free for all its users. 20 | 21 | This license, the Lesser General Public License, applies to some 22 | specially designated software packages--typically libraries--of the 23 | Free Software Foundation and other authors who decide to use it. You 24 | can use it too, but we suggest you first think carefully about whether 25 | this license or the ordinary General Public License is the better 26 | strategy to use in any particular case, based on the explanations 27 | below. 28 | 29 | When we speak of free software, we are referring to freedom of use, 30 | not price. Our General Public Licenses are designed to make sure that 31 | you have the freedom to distribute copies of free software (and charge 32 | for this service if you wish); that you receive source code or can get 33 | it if you want it; that you can change the software and use pieces of 34 | it in new free programs; and that you are informed that you can do 35 | these things. 36 | 37 | To protect your rights, we need to make restrictions that forbid 38 | distributors to deny you these rights or to ask you to surrender these 39 | rights. These restrictions translate to certain responsibilities for 40 | you if you distribute copies of the library or if you modify it. 41 | 42 | For example, if you distribute copies of the library, whether gratis 43 | or for a fee, you must give the recipients all the rights that we gave 44 | you. You must make sure that they, too, receive or can get the source 45 | code. If you link other code with the library, you must provide 46 | complete object files to the recipients, so that they can relink them 47 | with the library after making changes to the library and recompiling 48 | it. And you must show them these terms so they know their rights. 49 | 50 | We protect your rights with a two-step method: (1) we copyright the 51 | library, and (2) we offer you this license, which gives you legal 52 | permission to copy, distribute and/or modify the library. 53 | 54 | To protect each distributor, we want to make it very clear that 55 | there is no warranty for the free library. Also, if the library is 56 | modified by someone else and passed on, the recipients should know 57 | that what they have is not the original version, so that the original 58 | author's reputation will not be affected by problems that might be 59 | introduced by others. 60 | ^L 61 | Finally, software patents pose a constant threat to the existence of 62 | any free program. We wish to make sure that a company cannot 63 | effectively restrict the users of a free program by obtaining a 64 | restrictive license from a patent holder. Therefore, we insist that 65 | any patent license obtained for a version of the library must be 66 | consistent with the full freedom of use specified in this license. 67 | 68 | Most GNU software, including some libraries, is covered by the 69 | ordinary GNU General Public License. This license, the GNU Lesser 70 | General Public License, applies to certain designated libraries, and 71 | is quite different from the ordinary General Public License. We use 72 | this license for certain libraries in order to permit linking those 73 | libraries into non-free programs. 74 | 75 | When a program is linked with a library, whether statically or using 76 | a shared library, the combination of the two is legally speaking a 77 | combined work, a derivative of the original library. The ordinary 78 | General Public License therefore permits such linking only if the 79 | entire combination fits its criteria of freedom. The Lesser General 80 | Public License permits more lax criteria for linking other code with 81 | the library. 82 | 83 | We call this license the "Lesser" General Public License because it 84 | does Less to protect the user's freedom than the ordinary General 85 | Public License. It also provides other free software developers Less 86 | of an advantage over competing non-free programs. These disadvantages 87 | are the reason we use the ordinary General Public License for many 88 | libraries. However, the Lesser license provides advantages in certain 89 | special circumstances. 90 | 91 | For example, on rare occasions, there may be a special need to 92 | encourage the widest possible use of a certain library, so that it 93 | becomes a de-facto standard. To achieve this, non-free programs must 94 | be allowed to use the library. A more frequent case is that a free 95 | library does the same job as widely used non-free libraries. In this 96 | case, there is little to gain by limiting the free library to free 97 | software only, so we use the Lesser General Public License. 98 | 99 | In other cases, permission to use a particular library in non-free 100 | programs enables a greater number of people to use a large body of 101 | free software. For example, permission to use the GNU C Library in 102 | non-free programs enables many more people to use the whole GNU 103 | operating system, as well as its variant, the GNU/Linux operating 104 | system. 105 | 106 | Although the Lesser General Public License is Less protective of the 107 | users' freedom, it does ensure that the user of a program that is 108 | linked with the Library has the freedom and the wherewithal to run 109 | that program using a modified version of the Library. 110 | 111 | The precise terms and conditions for copying, distribution and 112 | modification follow. Pay close attention to the difference between a 113 | "work based on the library" and a "work that uses the library". The 114 | former contains code derived from the library, whereas the latter must 115 | be combined with the library in order to run. 116 | ^L 117 | GNU LESSER GENERAL PUBLIC LICENSE 118 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 119 | 120 | 0. This License Agreement applies to any software library or other 121 | program which contains a notice placed by the copyright holder or 122 | other authorized party saying it may be distributed under the terms of 123 | this Lesser General Public License (also called "this License"). 124 | Each licensee is addressed as "you". 125 | 126 | A "library" means a collection of software functions and/or data 127 | prepared so as to be conveniently linked with application programs 128 | (which use some of those functions and data) to form executables. 129 | 130 | The "Library", below, refers to any such software library or work 131 | which has been distributed under these terms. A "work based on the 132 | Library" means either the Library or any derivative work under 133 | copyright law: that is to say, a work containing the Library or a 134 | portion of it, either verbatim or with modifications and/or translated 135 | straightforwardly into another language. (Hereinafter, translation is 136 | included without limitation in the term "modification".) 137 | 138 | "Source code" for a work means the preferred form of the work for 139 | making modifications to it. For a library, complete source code means 140 | all the source code for all modules it contains, plus any associated 141 | interface definition files, plus the scripts used to control 142 | compilation and installation of the library. 143 | 144 | Activities other than copying, distribution and modification are not 145 | covered by this License; they are outside its scope. The act of 146 | running a program using the Library is not restricted, and output from 147 | such a program is covered only if its contents constitute a work based 148 | on the Library (independent of the use of the Library in a tool for 149 | writing it). Whether that is true depends on what the Library does 150 | and what the program that uses the Library does. 151 | 152 | 1. You may copy and distribute verbatim copies of the Library's 153 | complete source code as you receive it, in any medium, provided that 154 | you conspicuously and appropriately publish on each copy an 155 | appropriate copyright notice and disclaimer of warranty; keep intact 156 | all the notices that refer to this License and to the absence of any 157 | warranty; and distribute a copy of this License along with the 158 | Library. 159 | 160 | You may charge a fee for the physical act of transferring a copy, 161 | and you may at your option offer warranty protection in exchange for a 162 | fee. 163 | 164 | 2. You may modify your copy or copies of the Library or any portion 165 | of it, thus forming a work based on the Library, and copy and 166 | distribute such modifications or work under the terms of Section 1 167 | above, provided that you also meet all of these conditions: 168 | 169 | a) The modified work must itself be a software library. 170 | 171 | b) You must cause the files modified to carry prominent notices 172 | stating that you changed the files and the date of any change. 173 | 174 | c) You must cause the whole of the work to be licensed at no 175 | charge to all third parties under the terms of this License. 176 | 177 | d) If a facility in the modified Library refers to a function or a 178 | table of data to be supplied by an application program that uses 179 | the facility, other than as an argument passed when the facility 180 | is invoked, then you must make a good faith effort to ensure that, 181 | in the event an application does not supply such function or 182 | table, the facility still operates, and performs whatever part of 183 | its purpose remains meaningful. 184 | 185 | (For example, a function in a library to compute square roots has 186 | a purpose that is entirely well-defined independent of the 187 | application. Therefore, Subsection 2d requires that any 188 | application-supplied function or table used by this function must 189 | be optional: if the application does not supply it, the square 190 | root function must still compute square roots.) 191 | 192 | These requirements apply to the modified work as a whole. If 193 | identifiable sections of that work are not derived from the Library, 194 | and can be reasonably considered independent and separate works in 195 | themselves, then this License, and its terms, do not apply to those 196 | sections when you distribute them as separate works. But when you 197 | distribute the same sections as part of a whole which is a work based 198 | on the Library, the distribution of the whole must be on the terms of 199 | this License, whose permissions for other licensees extend to the 200 | entire whole, and thus to each and every part regardless of who wrote 201 | it. 202 | 203 | Thus, it is not the intent of this section to claim rights or contest 204 | your rights to work written entirely by you; rather, the intent is to 205 | exercise the right to control the distribution of derivative or 206 | collective works based on the Library. 207 | 208 | In addition, mere aggregation of another work not based on the Library 209 | with the Library (or with a work based on the Library) on a volume of 210 | a storage or distribution medium does not bring the other work under 211 | the scope of this License. 212 | 213 | 3. You may opt to apply the terms of the ordinary GNU General Public 214 | License instead of this License to a given copy of the Library. To do 215 | this, you must alter all the notices that refer to this License, so 216 | that they refer to the ordinary GNU General Public License, version 2, 217 | instead of to this License. (If a newer version than version 2 of the 218 | ordinary GNU General Public License has appeared, then you can specify 219 | that version instead if you wish.) Do not make any other change in 220 | these notices. 221 | ^L 222 | Once this change is made in a given copy, it is irreversible for 223 | that copy, so the ordinary GNU General Public License applies to all 224 | subsequent copies and derivative works made from that copy. 225 | 226 | This option is useful when you wish to copy part of the code of 227 | the Library into a program that is not a library. 228 | 229 | 4. You may copy and distribute the Library (or a portion or 230 | derivative of it, under Section 2) in object code or executable form 231 | under the terms of Sections 1 and 2 above provided that you accompany 232 | it with the complete corresponding machine-readable source code, which 233 | must be distributed under the terms of Sections 1 and 2 above on a 234 | medium customarily used for software interchange. 235 | 236 | If distribution of object code is made by offering access to copy 237 | from a designated place, then offering equivalent access to copy the 238 | source code from the same place satisfies the requirement to 239 | distribute the source code, even though third parties are not 240 | compelled to copy the source along with the object code. 241 | 242 | 5. A program that contains no derivative of any portion of the 243 | Library, but is designed to work with the Library by being compiled or 244 | linked with it, is called a "work that uses the Library". Such a 245 | work, in isolation, is not a derivative work of the Library, and 246 | therefore falls outside the scope of this License. 247 | 248 | However, linking a "work that uses the Library" with the Library 249 | creates an executable that is a derivative of the Library (because it 250 | contains portions of the Library), rather than a "work that uses the 251 | library". The executable is therefore covered by this License. 252 | Section 6 states terms for distribution of such executables. 253 | 254 | When a "work that uses the Library" uses material from a header file 255 | that is part of the Library, the object code for the work may be a 256 | derivative work of the Library even though the source code is not. 257 | Whether this is true is especially significant if the work can be 258 | linked without the Library, or if the work is itself a library. The 259 | threshold for this to be true is not precisely defined by law. 260 | 261 | If such an object file uses only numerical parameters, data 262 | structure layouts and accessors, and small macros and small inline 263 | functions (ten lines or less in length), then the use of the object 264 | file is unrestricted, regardless of whether it is legally a derivative 265 | work. (Executables containing this object code plus portions of the 266 | Library will still fall under Section 6.) 267 | 268 | Otherwise, if the work is a derivative of the Library, you may 269 | distribute the object code for the work under the terms of Section 6. 270 | Any executables containing that work also fall under Section 6, 271 | whether or not they are linked directly with the Library itself. 272 | ^L 273 | 6. As an exception to the Sections above, you may also combine or 274 | link a "work that uses the Library" with the Library to produce a 275 | work containing portions of the Library, and distribute that work 276 | under terms of your choice, provided that the terms permit 277 | modification of the work for the customer's own use and reverse 278 | engineering for debugging such modifications. 279 | 280 | You must give prominent notice with each copy of the work that the 281 | Library is used in it and that the Library and its use are covered by 282 | this License. You must supply a copy of this License. If the work 283 | during execution displays copyright notices, you must include the 284 | copyright notice for the Library among them, as well as a reference 285 | directing the user to the copy of this License. Also, you must do one 286 | of these things: 287 | 288 | a) Accompany the work with the complete corresponding 289 | machine-readable source code for the Library including whatever 290 | changes were used in the work (which must be distributed under 291 | Sections 1 and 2 above); and, if the work is an executable linked 292 | with the Library, with the complete machine-readable "work that 293 | uses the Library", as object code and/or source code, so that the 294 | user can modify the Library and then relink to produce a modified 295 | executable containing the modified Library. (It is understood 296 | that the user who changes the contents of definitions files in the 297 | Library will not necessarily be able to recompile the application 298 | to use the modified definitions.) 299 | 300 | b) Use a suitable shared library mechanism for linking with the 301 | Library. A suitable mechanism is one that (1) uses at run time a 302 | copy of the library already present on the user's computer system, 303 | rather than copying library functions into the executable, and (2) 304 | will operate properly with a modified version of the library, if 305 | the user installs one, as long as the modified version is 306 | interface-compatible with the version that the work was made with. 307 | 308 | c) Accompany the work with a written offer, valid for at least 309 | three years, to give the same user the materials specified in 310 | Subsection 6a, above, for a charge no more than the cost of 311 | performing this distribution. 312 | 313 | d) If distribution of the work is made by offering access to copy 314 | from a designated place, offer equivalent access to copy the above 315 | specified materials from the same place. 316 | 317 | e) Verify that the user has already received a copy of these 318 | materials or that you have already sent this user a copy. 319 | 320 | For an executable, the required form of the "work that uses the 321 | Library" must include any data and utility programs needed for 322 | reproducing the executable from it. However, as a special exception, 323 | the materials to be distributed need not include anything that is 324 | normally distributed (in either source or binary form) with the major 325 | components (compiler, kernel, and so on) of the operating system on 326 | which the executable runs, unless that component itself accompanies 327 | the executable. 328 | 329 | It may happen that this requirement contradicts the license 330 | restrictions of other proprietary libraries that do not normally 331 | accompany the operating system. Such a contradiction means you cannot 332 | use both them and the Library together in an executable that you 333 | distribute. 334 | ^L 335 | 7. You may place library facilities that are a work based on the 336 | Library side-by-side in a single library together with other library 337 | facilities not covered by this License, and distribute such a combined 338 | library, provided that the separate distribution of the work based on 339 | the Library and of the other library facilities is otherwise 340 | permitted, and provided that you do these two things: 341 | 342 | a) Accompany the combined library with a copy of the same work 343 | based on the Library, uncombined with any other library 344 | facilities. This must be distributed under the terms of the 345 | Sections above. 346 | 347 | b) Give prominent notice with the combined library of the fact 348 | that part of it is a work based on the Library, and explaining 349 | where to find the accompanying uncombined form of the same work. 350 | 351 | 8. You may not copy, modify, sublicense, link with, or distribute 352 | the Library except as expressly provided under this License. Any 353 | attempt otherwise to copy, modify, sublicense, link with, or 354 | distribute the Library is void, and will automatically terminate your 355 | rights under this License. However, parties who have received copies, 356 | or rights, from you under this License will not have their licenses 357 | terminated so long as such parties remain in full compliance. 358 | 359 | 9. You are not required to accept this License, since you have not 360 | signed it. However, nothing else grants you permission to modify or 361 | distribute the Library or its derivative works. These actions are 362 | prohibited by law if you do not accept this License. Therefore, by 363 | modifying or distributing the Library (or any work based on the 364 | Library), you indicate your acceptance of this License to do so, and 365 | all its terms and conditions for copying, distributing or modifying 366 | the Library or works based on it. 367 | 368 | 10. Each time you redistribute the Library (or any work based on the 369 | Library), the recipient automatically receives a license from the 370 | original licensor to copy, distribute, link with or modify the Library 371 | subject to these terms and conditions. You may not impose any further 372 | restrictions on the recipients' exercise of the rights granted herein. 373 | You are not responsible for enforcing compliance by third parties with 374 | this License. 375 | ^L 376 | 11. If, as a consequence of a court judgment or allegation of patent 377 | infringement or for any other reason (not limited to patent issues), 378 | conditions are imposed on you (whether by court order, agreement or 379 | otherwise) that contradict the conditions of this License, they do not 380 | excuse you from the conditions of this License. If you cannot 381 | distribute so as to satisfy simultaneously your obligations under this 382 | License and any other pertinent obligations, then as a consequence you 383 | may not distribute the Library at all. For example, if a patent 384 | license would not permit royalty-free redistribution of the Library by 385 | all those who receive copies directly or indirectly through you, then 386 | the only way you could satisfy both it and this License would be to 387 | refrain entirely from distribution of the Library. 388 | 389 | If any portion of this section is held invalid or unenforceable under 390 | any particular circumstance, the balance of the section is intended to 391 | apply, and the section as a whole is intended to apply in other 392 | circumstances. 393 | 394 | It is not the purpose of this section to induce you to infringe any 395 | patents or other property right claims or to contest validity of any 396 | such claims; this section has the sole purpose of protecting the 397 | integrity of the free software distribution system which is 398 | implemented by public license practices. Many people have made 399 | generous contributions to the wide range of software distributed 400 | through that system in reliance on consistent application of that 401 | system; it is up to the author/donor to decide if he or she is willing 402 | to distribute software through any other system and a licensee cannot 403 | impose that choice. 404 | 405 | This section is intended to make thoroughly clear what is believed to 406 | be a consequence of the rest of this License. 407 | 408 | 12. If the distribution and/or use of the Library is restricted in 409 | certain countries either by patents or by copyrighted interfaces, the 410 | original copyright holder who places the Library under this License 411 | may add an explicit geographical distribution limitation excluding those 412 | countries, so that distribution is permitted only in or among 413 | countries not thus excluded. In such case, this License incorporates 414 | the limitation as if written in the body of this License. 415 | 416 | 13. The Free Software Foundation may publish revised and/or new 417 | versions of the Lesser General Public License from time to time. 418 | Such new versions will be similar in spirit to the present version, 419 | but may differ in detail to address new problems or concerns. 420 | 421 | Each version is given a distinguishing version number. If the Library 422 | specifies a version number of this License which applies to it and 423 | "any later version", you have the option of following the terms and 424 | conditions either of that version or of any later version published by 425 | the Free Software Foundation. If the Library does not specify a 426 | license version number, you may choose any version ever published by 427 | the Free Software Foundation. 428 | ^L 429 | 14. If you wish to incorporate parts of the Library into other free 430 | programs whose distribution conditions are incompatible with these, 431 | write to the author to ask for permission. For software which is 432 | copyrighted by the Free Software Foundation, write to the Free 433 | Software Foundation; we sometimes make exceptions for this. Our 434 | decision will be guided by the two goals of preserving the free status 435 | of all derivatives of our free software and of promoting the sharing 436 | and reuse of software generally. 437 | 438 | NO WARRANTY 439 | 440 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 441 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 442 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 443 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 444 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 445 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 446 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 447 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 448 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 449 | 450 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 451 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 452 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 453 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 454 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 455 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 456 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 457 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 458 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 459 | DAMAGES. 460 | 461 | END OF TERMS AND CONDITIONS 462 | ^L 463 | How to Apply These Terms to Your New Libraries 464 | 465 | If you develop a new library, and you want it to be of the greatest 466 | possible use to the public, we recommend making it free software that 467 | everyone can redistribute and change. You can do so by permitting 468 | redistribution under these terms (or, alternatively, under the terms 469 | of the ordinary General Public License). 470 | 471 | To apply these terms, attach the following notices to the library. 472 | It is safest to attach them to the start of each source file to most 473 | effectively convey the exclusion of warranty; and each file should 474 | have at least the "copyright" line and a pointer to where the full 475 | notice is found. 476 | 477 | 478 | 479 | Copyright (C) 480 | 481 | This library is free software; you can redistribute it and/or 482 | modify it under the terms of the GNU Lesser General Public 483 | License as published by the Free Software Foundation; either 484 | version 2.1 of the License, or (at your option) any later version. 485 | 486 | This library is distributed in the hope that it will be useful, 487 | but WITHOUT ANY WARRANTY; without even the implied warranty of 488 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 489 | Lesser General Public License for more details. 490 | 491 | You should have received a copy of the GNU Lesser General Public 492 | License along with this library; if not, write to the Free Software 493 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 494 | 495 | Also add information on how to contact you by electronic and paper mail. 496 | 497 | You should also get your employer (if you work as a programmer) or 498 | your school, if any, to sign a "copyright disclaimer" for the library, 499 | if necessary. Here is a sample; alter the names: 500 | 501 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 502 | library `Frob' (a library for tweaking knobs) written by James 503 | Random Hacker. 504 | 505 | , 1 April 1990 506 | Ty Coon, President of Vice 507 | 508 | That's all there is to it! 509 | 510 | 511 | --------------------------------------------------------------------------------