src/LeakFinder.cc

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