libguile/gc-malloc.c

   1 /* Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   2  *   2004, 2006, 2008, 2009, 2010, 2011, 2012 Free Software Foundation, Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public License
   6  * as published by the Free Software Foundation; either version 3 of
   7  * the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17  * 02110-1301 USA
  18  */
  19
  20
  21 \f
  22 #ifdef HAVE_CONFIG_H
  23 #  include <config.h>
  24 #endif
  25
  26 #include <stdio.h>
  27 #include <errno.h>
  28 #include <string.h>
  29 #include <stdlib.h>
  30
  31 #ifdef __ia64__
  32 #include <ucontext.h>
  33 extern unsigned long * __libc_ia64_register_backing_store_base;
  34 #endif
  35
  36 #include "libguile/_scm.h"
  37 #include "libguile/eval.h"
  38 #include "libguile/stime.h"
  39 #include "libguile/stackchk.h"
  40 #include "libguile/struct.h"
  41 #include "libguile/smob.h"
  42 #include "libguile/arrays.h"
  43 #include "libguile/async.h"
  44 #include "libguile/ports.h"
  45 #include "libguile/root.h"
  46 #include "libguile/strings.h"
  47 #include "libguile/vectors.h"
  48 #include "libguile/hashtab.h"
  49 #include "libguile/tags.h"
  50
  51 #include "libguile/validate.h"
  52 #include "libguile/deprecation.h"
  53 #include "libguile/gc.h"
  54
  55 #include "libguile/private-gc.h"
  56
  57 #ifdef GUILE_DEBUG_MALLOC
  58 #include "libguile/debug-malloc.h"
  59 #endif
  60
  61 #ifdef HAVE_UNISTD_H
  62 #include <unistd.h>
  63 #endif
  64
  65 /*
  66   INIT_MALLOC_LIMIT is the initial amount of malloc usage which will
  67   trigger a GC.
  68
  69   After startup (at the guile> prompt), we have approximately 100k of
  70   alloced memory, which won't go away on GC. Let's set the init such
  71   that we get a nice yield on the next allocation:
  72 */
  73 #define SCM_DEFAULT_INIT_MALLOC_LIMIT 200*1024
  74 #define SCM_DEFAULT_MALLOC_MINYIELD 40
  75
  76 /* #define DEBUGINFO */
  77
  78
  79 \f
  80
  81 static void*
  82 do_realloc (void *from, size_t new_size)
  83 {
  84   scm_gc_register_allocation (new_size);
  85   return realloc (from, new_size);
  86 }
  87
  88 static void*
  89 do_calloc (size_t n, size_t size)
  90 {
  91   scm_gc_register_allocation (size);
  92   return calloc (n, size);
  93 }
  94
  95 static void*
  96 do_gc_malloc (size_t size, const char *what)
  97 {
  98   /* Ensure nonzero size to be compatible with always-nonzero return of
  99      glibc malloc.  */
 100   return GC_MALLOC (size ? size : sizeof (void *));
 101 }
 102
 103 static void*
 104 do_gc_malloc_atomic (size_t size, const char *what)
 105 {
 106   return GC_MALLOC_ATOMIC (size ? size : sizeof (void *));
 107 }
 108
 109 static void*
 110 do_gc_realloc (void *from, size_t size, const char *what)
 111 {
 112   return GC_REALLOC (from, size ? size : sizeof (void *));
 113 }
 114
 115 static void
 116 do_gc_free (void *ptr)
 117 {
 118   GC_FREE (ptr);
 119 }
 120
 121
 122 \f
 123 /* Function for non-cell memory management.
 124  */
 125
 126 void *
 127 scm_realloc (void *mem, size_t size)
 128 {
 129   void *ptr;
 130
 131   ptr = do_realloc (mem, size);
 132
 133   if (ptr || size == 0)
 134     return ptr;
 135
 136   /* Time is hard: trigger a full, ``stop-the-world'' GC, and try again.  */
 137 #ifdef HAVE_GC_GCOLLECT_AND_UNMAP
 138   GC_gcollect_and_unmap ();
 139 #else
 140   GC_gcollect ();
 141 #endif
 142
 143   ptr = do_realloc (mem, size);
 144   if (ptr)
 145     return ptr;
 146
 147   scm_memory_error ("realloc");
 148 }
 149
 150 void *
 151 scm_malloc (size_t sz)
 152 {
 153   return scm_realloc (NULL, sz);
 154 }
 155
 156 /*
 157   Hmm. Should we use the C convention for arguments (i.e. N_ELTS,
 158   SIZEOF_ELT)? --hwn
 159  */
 160 void *
 161 scm_calloc (size_t sz)
 162 {
 163   void * ptr;
 164
 165   /*
 166     By default, try to use calloc, as it is likely more efficient than
 167     calling memset by hand.
 168    */
 169   ptr = do_calloc (sz, 1);
 170   if (ptr || sz == 0)
 171     return ptr;
 172
 173   ptr = scm_realloc (NULL, sz);
 174   memset (ptr, 0x0, sz);
 175   return ptr;
 176 }
 177
 178
 179 char *
 180 scm_strndup (const char *str, size_t n)
 181 {
 182   char *dst = scm_malloc (n + 1);
 183   memcpy (dst, str, n);
 184   dst[n] = 0;
 185   return dst;
 186 }
 187
 188 char *
 189 scm_strdup (const char *str)
 190 {
 191   return scm_strndup (str, strlen (str));
 192 }
 193
 194
 195
 196 void
 197 scm_gc_register_collectable_memory (void *mem, size_t size, const char *what)
 198 {
 199   scm_gc_register_allocation (size);
 200
 201 #ifdef GUILE_DEBUG_MALLOC
 202   if (mem)
 203     scm_malloc_register (mem, what);
 204 #endif
 205 }
 206
 207
 208 void
 209 scm_gc_unregister_collectable_memory (void *mem, size_t size, const char *what)
 210 {
 211   /* Nothing to do.  */
 212 #ifdef GUILE_DEBUG_MALLOC
 213   if (mem)
 214     scm_malloc_unregister (mem);
 215 #endif
 216 }
 217
 218 /* Allocate SIZE bytes of memory whose contents should not be scanned
 219    for pointers (useful, e.g., for strings).  Note though that this
 220    memory is *not* cleared; be sure to initialize it to prevent
 221    information leaks.  */
 222 void *
 223 scm_gc_malloc_pointerless (size_t size, const char *what)
 224 {
 225   return do_gc_malloc_atomic (size, what);
 226 }
 227
 228 void *
 229 scm_gc_malloc (size_t size, const char *what)
 230 {
 231   return do_gc_malloc (size, what);
 232 }
 233
 234 void *
 235 scm_gc_calloc (size_t size, const char *what)
 236 {
 237   /* `GC_MALLOC ()' always returns a zeroed buffer.  */
 238   return do_gc_malloc (size, what);
 239 }
 240
 241 void *
 242 scm_gc_realloc (void *mem, size_t old_size, size_t new_size, const char *what)
 243 {
 244   return do_gc_realloc (mem, new_size, what);
 245 }
 246
 247 void
 248 scm_gc_free (void *mem, size_t size, const char *what)
 249 {
 250   do_gc_free (mem);
 251 }
 252
 253 char *
 254 scm_gc_strndup (const char *str, size_t n, const char *what)
 255 {
 256   char *dst = do_gc_malloc_atomic (n + 1, what);
 257   memcpy (dst, str, n);
 258   dst[n] = 0;
 259   return dst;
 260 }
 261
 262 char *
 263 scm_gc_strdup (const char *str, const char *what)
 264 {
 265   return scm_gc_strndup (str, strlen (str), what);
 266 }