cannam@127: /*
cannam@127:  * Copyright (c) 2003, 2007-14 Matteo Frigo
cannam@127:  * Copyright (c) 2003, 2007-14 Massachusetts Institute of Technology
cannam@127:  *
cannam@127:  * This program is free software; you can redistribute it and/or modify
cannam@127:  * it under the terms of the GNU General Public License as published by
cannam@127:  * the Free Software Foundation; either version 2 of the License, or
cannam@127:  * (at your option) any later version.
cannam@127:  *
cannam@127:  * This program is distributed in the hope that it will be useful,
cannam@127:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
cannam@127:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
cannam@127:  * GNU General Public License for more details.
cannam@127:  *
cannam@127:  * You should have received a copy of the GNU General Public License
cannam@127:  * along with this program; if not, write to the Free Software
cannam@127:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
cannam@127:  *
cannam@127:  */
cannam@127: 
cannam@127: #include "ifftw.h"
cannam@127: 
cannam@127: /**********************************************************
cannam@127:  *   DEBUGGING CODE
cannam@127:  **********************************************************/
cannam@127: #if defined(FFTW_DEBUG_MALLOC)
cannam@127: 
cannam@127: #include <stdio.h>
cannam@127: 
cannam@127: /*
cannam@127:   debugging malloc/free. 
cannam@127:  
cannam@127:   1) Initialize every malloced and freed area to random values, just
cannam@127:   to make sure we are not using uninitialized pointers.
cannam@127:  
cannam@127:   2) check for blocks freed twice.
cannam@127:  
cannam@127:   3) Check for writes past the ends of allocated blocks
cannam@127:  
cannam@127:   4) destroy contents of freed blocks in order to detect incorrect reuse.
cannam@127:  
cannam@127:   5) keep track of who allocates what and report memory leaks
cannam@127:  
cannam@127:   This code is a quick and dirty hack.  May be nonportable. 
cannam@127:   Use at your own risk.
cannam@127:  
cannam@127: */
cannam@127: 
cannam@127: #define MAGIC ((size_t)0xABadCafe)
cannam@127: #define PAD_FACTOR 2
cannam@127: #define SZ_HEADER (4 * sizeof(size_t))
cannam@127: #define HASHSZ 1031
cannam@127: 
cannam@127: static unsigned int hashaddr(void *p)
cannam@127: {
cannam@127:      return ((unsigned long)p) % HASHSZ;
cannam@127: }
cannam@127: 
cannam@127: struct mstat {
cannam@127:      int siz;
cannam@127:      int maxsiz;
cannam@127:      int cnt;
cannam@127:      int maxcnt;
cannam@127: };
cannam@127: 
cannam@127: static struct mstat mstat[MALLOC_WHAT_LAST];
cannam@127: 
cannam@127: struct minfo {
cannam@127:      const char *file;
cannam@127:      int line;
cannam@127:      size_t n;
cannam@127:      void *p;
cannam@127:      struct minfo *next;
cannam@127: };
cannam@127: 
cannam@127: static struct minfo *minfo[HASHSZ] = {0};
cannam@127: 
cannam@127: #if defined(HAVE_THREADS) || defined(HAVE_OPENMP)
cannam@127: int X(in_thread) = 0;
cannam@127: #endif
cannam@127: 
cannam@127: void *X(malloc_debug)(size_t n, enum malloc_tag what,
cannam@127:                       const char *file, int line)
cannam@127: {
cannam@127:      char *p;
cannam@127:      size_t i;
cannam@127:      struct minfo *info;
cannam@127:      struct mstat *stat = mstat + what;
cannam@127:      struct mstat *estat = mstat + EVERYTHING;
cannam@127: 
cannam@127:      if (n == 0)
cannam@127:           n = 1;
cannam@127: 
cannam@127:      if (!IN_THREAD) {
cannam@127: 	  stat->siz += n;
cannam@127: 	  if (stat->siz > stat->maxsiz)
cannam@127: 	       stat->maxsiz = stat->siz;
cannam@127: 	  estat->siz += n;
cannam@127: 	  if (estat->siz > estat->maxsiz)
cannam@127: 	       estat->maxsiz = estat->siz;
cannam@127:      }
cannam@127: 
cannam@127:      p = (char *) X(kernel_malloc)(PAD_FACTOR * n + SZ_HEADER);
cannam@127:      A(p);
cannam@127: 
cannam@127:      /* store the sz in a known position */
cannam@127:      ((size_t *) p)[0] = n;
cannam@127:      ((size_t *) p)[1] = MAGIC;
cannam@127:      ((size_t *) p)[2] = what;
cannam@127: 
cannam@127:      /* fill with junk */
cannam@127:      for (i = 0; i < PAD_FACTOR * n; i++)
cannam@127:           p[i + SZ_HEADER] = (char) (i ^ 0xEF);
cannam@127: 
cannam@127:      if (!IN_THREAD) {
cannam@127: 	  ++stat->cnt;
cannam@127: 	  ++estat->cnt;
cannam@127: 	  
cannam@127: 	  if (stat->cnt > stat->maxcnt)
cannam@127: 	       stat->maxcnt = stat->cnt;
cannam@127: 	  if (estat->cnt > estat->maxcnt)
cannam@127: 	       estat->maxcnt = estat->cnt;
cannam@127:      }
cannam@127: 
cannam@127:      /* skip the info we stored previously */
cannam@127:      p = p + SZ_HEADER;
cannam@127: 
cannam@127:      if (!IN_THREAD) {
cannam@127: 	  unsigned int h = hashaddr(p);
cannam@127: 	  /* record allocation in allocation list */
cannam@127: 	  info = (struct minfo *) malloc(sizeof(struct minfo));
cannam@127: 	  info->n = n;
cannam@127: 	  info->file = file;
cannam@127: 	  info->line = line;
cannam@127: 	  info->p = p;
cannam@127: 	  info->next = minfo[h];
cannam@127: 	  minfo[h] = info;
cannam@127:      }
cannam@127: 
cannam@127:      return (void *) p;
cannam@127: }
cannam@127: 
cannam@127: void X(ifree)(void *p)
cannam@127: {
cannam@127:      char *q;
cannam@127: 
cannam@127:      A(p);
cannam@127: 
cannam@127:      q = ((char *) p) - SZ_HEADER;
cannam@127:      A(q);
cannam@127: 
cannam@127:      {
cannam@127:           size_t n = ((size_t *) q)[0];
cannam@127:           size_t magic = ((size_t *) q)[1];
cannam@127:           int what = ((size_t *) q)[2];
cannam@127:           size_t i;
cannam@127:           struct mstat *stat = mstat + what;
cannam@127:           struct mstat *estat = mstat + EVERYTHING;
cannam@127: 
cannam@127:           /* set to zero to detect duplicate free's */
cannam@127:           ((size_t *) q)[0] = 0;
cannam@127: 
cannam@127:           A(magic == MAGIC);
cannam@127:           ((size_t *) q)[1] = ~MAGIC;
cannam@127: 
cannam@127: 	  if (!IN_THREAD) {
cannam@127: 	       stat->siz -= n;
cannam@127: 	       A(stat->siz >= 0);
cannam@127: 	       estat->siz -= n;
cannam@127: 	       A(estat->siz >= 0);
cannam@127: 	  }
cannam@127: 
cannam@127:           /* check for writing past end of array: */
cannam@127:           for (i = n; i < PAD_FACTOR * n; ++i)
cannam@127:                if (q[i + SZ_HEADER] != (char) (i ^ 0xEF)) {
cannam@127:                     A(0 /* array bounds overwritten */ );
cannam@127:                }
cannam@127:           for (i = 0; i < PAD_FACTOR * n; ++i)
cannam@127:                q[i + SZ_HEADER] = (char) (i ^ 0xAD);
cannam@127: 
cannam@127: 	  if (!IN_THREAD) {
cannam@127: 	       --stat->cnt;
cannam@127: 	       --estat->cnt;
cannam@127: 	       
cannam@127: 	       A(stat->cnt >= 0);
cannam@127: 	       A((stat->cnt == 0 && stat->siz == 0) ||
cannam@127: 		 (stat->cnt > 0 && stat->siz > 0));
cannam@127: 	       A(estat->cnt >= 0);
cannam@127: 	       A((estat->cnt == 0 && estat->siz == 0) ||
cannam@127: 		 (estat->cnt > 0 && estat->siz > 0));
cannam@127: 	  }
cannam@127: 
cannam@127:           X(kernel_free)(q);
cannam@127:      }
cannam@127: 
cannam@127:      if (!IN_THREAD) {
cannam@127:           /* delete minfo entry */
cannam@127: 	  unsigned int h = hashaddr(p);
cannam@127:           struct minfo **i;
cannam@127: 
cannam@127:           for (i = minfo + h; *i; i = &((*i)->next)) {
cannam@127:                if ((*i)->p == p) {
cannam@127:                     struct minfo *i0 = (*i)->next;
cannam@127:                     free(*i);
cannam@127:                     *i = i0;
cannam@127:                     return;
cannam@127:                }
cannam@127:           }
cannam@127: 
cannam@127:           A(0 /* no entry in minfo list */ );
cannam@127:      }
cannam@127: }
cannam@127: 
cannam@127: void X(malloc_print_minfo)(int verbose)
cannam@127: {
cannam@127:      struct minfo *info;
cannam@127:      int what;
cannam@127:      unsigned int h;
cannam@127:      int leak = 0;
cannam@127: 
cannam@127:      if (verbose > 2) {
cannam@127: 	  static const char *names[MALLOC_WHAT_LAST] = {
cannam@127: 	       "EVERYTHING",
cannam@127: 	       "PLANS", "SOLVERS", "PROBLEMS", "BUFFERS",
cannam@127: 	       "HASHT", "TENSORS", "PLANNERS", "SLVDSC", "TWIDDLES",
cannam@127: 	       "STRIDES", "OTHER"
cannam@127: 	  };
cannam@127: 
cannam@127: 	  printf("%12s %8s %8s %10s %10s\n",
cannam@127: 		 "what", "cnt", "maxcnt", "siz", "maxsiz");
cannam@127: 
cannam@127: 	  for (what = 0; what < MALLOC_WHAT_LAST; ++what) {
cannam@127: 	       struct mstat *stat = mstat + what;
cannam@127: 	       printf("%12s %8d %8d %10d %10d\n",
cannam@127: 		      names[what], stat->cnt, stat->maxcnt,
cannam@127: 		      stat->siz, stat->maxsiz);
cannam@127: 	  }
cannam@127:      }
cannam@127: 
cannam@127:      for (h = 0; h < HASHSZ; ++h) 
cannam@127: 	  if (minfo[h]) {
cannam@127: 	       printf("\nUnfreed allocations:\n");
cannam@127: 	       break;
cannam@127: 	  }
cannam@127: 
cannam@127:      for (h = 0; h < HASHSZ; ++h) 
cannam@127: 	  for (info = minfo[h]; info; info = info->next) {
cannam@127: 	       leak = 1;
cannam@127: 	       printf("%s:%d:  %zd bytes at %p\n",
cannam@127: 		      info->file, info->line, info->n, info->p);
cannam@127: 	  }
cannam@127: 
cannam@127:      if (leak)
cannam@127: 	  abort();
cannam@127: }
cannam@127: 
cannam@127: #else
cannam@127: /**********************************************************
cannam@127:  *   NON DEBUGGING CODE
cannam@127:  **********************************************************/
cannam@127: /* production version, no hacks */
cannam@127: 
cannam@127: void *X(malloc_plain)(size_t n)
cannam@127: {
cannam@127:      void *p;
cannam@127:      if (n == 0)
cannam@127:           n = 1;
cannam@127:      p = X(kernel_malloc)(n);
cannam@127:      CK(p);
cannam@127: 
cannam@127: #ifdef MIN_ALIGNMENT
cannam@127:      A((((uintptr_t)p) % MIN_ALIGNMENT) == 0);
cannam@127: #endif
cannam@127: 
cannam@127:      return p;
cannam@127: }
cannam@127: 
cannam@127: void X(ifree)(void *p)
cannam@127: {
cannam@127:      X(kernel_free)(p);
cannam@127: }
cannam@127: 
cannam@127: #endif
cannam@127: 
cannam@127: void X(ifree0)(void *p)
cannam@127: {
cannam@127:      /* common pattern */
cannam@127:      if (p) X(ifree)(p);
cannam@127: }