src/LeakFinder.cc

   1
   2 /*
   3  * $Id$
   4  *
   5  * DEBUG: section 45    Callback Data Registry
   6  * AUTHOR: Duane Wessels
   7  *
   8  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   9  * ----------------------------------------------------------
  10  *
  11  *  Squid is the result of efforts by numerous individuals from
  12  *  the Internet community; see the CONTRIBUTORS file for full
  13  *  details.   Many organizations have provided support for Squid's
  14  *  development; see the SPONSORS file for full details.  Squid is
  15  *  Copyrighted (C) 2001 by the Regents of the University of
  16  *  California; see the COPYRIGHT file for full details.  Squid
  17  *  incorporates software developed and/or copyrighted by other
  18  *  sources; see the CREDITS file for full details.
  19  *
  20  *  This program is free software; you can redistribute it and/or modify
  21  *  it under the terms of the GNU General Public License as published by
  22  *  the Free Software Foundation; either version 2 of the License, or
  23  *  (at your option) any later version.
  24  *
  25  *  This program is distributed in the hope that it will be useful,
  26  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  *  GNU General Public License for more details.
  29  *
  30  *  You should have received a copy of the GNU General Public License
  31  *  along with this program; if not, write to the Free Software
  32  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  33  *
  34  */
  35
  36 /*
  37  * Use these to find memory leaks
  38  */
  39
  40 #include "squid.h"
  41 #include "LeakFinder.h"
  42 #include "Store.h"
  43 #include "SquidTime.h"
  44
  45 #if USE_LEAKFINDER
  46 /* ========================================================================= */
  47
  48 LeakFinderPtr::LeakFinderPtr(void *p , const char *f, const int l) :
  49         file(f), line(l), when(squid_curtime)
  50 {
  51     key = p;
  52     next = NULL;
  53 }
  54
  55 /* ========================================================================= */
  56
  57 LeakFinder::LeakFinder()
  58 {
  59     debugs(45, 3, "LeakFinder constructed");
  60     table = hash_create(cmp, 1 << 8, hash);
  61 #if 0
  62     /* if this is desired to reinstate, add a
  63      * RegisterWithCacheManager method
  64      */
  65     cachemgrRegister("leaks",
  66                      "Memory Leak Tracking",
  67                      cachemgr_dump, 0, 1);
  68 #endif
  69 }
  70
  71 void *
  72
  73 LeakFinder::add
  74 (void *p, const char *file, int line)
  75 {
  76     assert(hash_lookup(table, p) == NULL);
  77     LeakFinderPtr *c = new LeakFinderPtr(p, file, line);
  78     hash_join(table, c);
  79     count++;
  80     return p;
  81 }
  82
  83 void *
  84 LeakFinder::touch(void *p, const char *file, int line)
  85 {
  86     assert(p);
  87     LeakFinderPtr *c = (LeakFinderPtr *) hash_lookup(table, p);
  88     assert(c);
  89     c->file = file;
  90     c->line = line;
  91     c->when = squid_curtime;
  92     return p;
  93 }
  94
  95 void *
  96 LeakFinder::free(void *p, const char *file, int line)
  97 {
  98     assert(p);
  99     LeakFinderPtr *c = (LeakFinderPtr *) hash_lookup(table, p);
 100     assert(c);
 101     hash_remove_link(table, c);
 102     count--;
 103     delete c;
 104     dump();
 105     return p;
 106 }
 107
 108 /* ========================================================================= */
 109
 110 int
 111 LeakFinder::cmp(const void *p1, const void *p2)
 112 {
 113     return (char *) p1 - (char *) p2;
 114 }
 115
 116 unsigned int
 117 LeakFinder::hash(const void *p, unsigned int mod)
 118 {
 119     return ((unsigned long) p >> 8) % mod;
 120 }
 121
 122
 123 void
 124 LeakFinder::dump()
 125 {
 126     if (0 == count)
 127         return;
 128
 129     if (squid_curtime == last_dump)
 130         return;
 131
 132     last_dump = squid_curtime;
 133
 134     debugs(45, 1, "Tracking " << count << " pointers");
 135
 136     hash_first(table);
 137
 138     LeakFinderPtr *c;
 139
 140     while ((c = (LeakFinderPtr *)hash_next(table))) {
 141         debugs(45, 1, std::setw(20) << c->key << " last used " << std::setw(9) << (squid_curtime - c->when) <<
 142                " seconds ago by " << c->file << ":" << c->line);
 143     }
 144 }
 145
 146 #endif /* USE_LEAKFINDER */