1 /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002 Free Software Foundation, Inc.
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2, or (at your option)
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this software; see the file COPYING. If not, write to
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
18 * As a special exception, the Free Software Foundation gives permission
19 * for additional uses of the text contained in its release of GUILE.
21 * The exception is that, if you link the GUILE library with other files
22 * to produce an executable, this does not by itself cause the
23 * resulting executable to be covered by the GNU General Public License.
24 * Your use of that executable is in no way restricted on account of
25 * linking the GUILE library code into it.
27 * This exception does not however invalidate any other reasons why
28 * the executable file might be covered by the GNU General Public License.
30 * This exception applies only to the code released by the
31 * Free Software Foundation under the name GUILE. If you copy
32 * code from other Free Software Foundation releases into a copy of
33 * GUILE, as the General Public License permits, the exception does
34 * not apply to the code that you add in this way. To avoid misleading
35 * anyone as to the status of such modified files, you must delete
36 * this exception notice from them.
38 * If you write modifications of your own for GUILE, it is your choice
39 * whether to permit this exception to apply to your modifications.
40 * If you do not wish that, delete this exception notice. */
50 extern unsigned long * __libc_ia64_register_backing_store_base
;
53 #include "libguile/_scm.h"
54 #include "libguile/eval.h"
55 #include "libguile/stime.h"
56 #include "libguile/stackchk.h"
57 #include "libguile/struct.h"
58 #include "libguile/smob.h"
59 #include "libguile/unif.h"
60 #include "libguile/async.h"
61 #include "libguile/ports.h"
62 #include "libguile/root.h"
63 #include "libguile/strings.h"
64 #include "libguile/vectors.h"
65 #include "libguile/weaks.h"
66 #include "libguile/hashtab.h"
67 #include "libguile/tags.h"
69 #include "libguile/validate.h"
70 #include "libguile/deprecation.h"
71 #include "libguile/gc.h"
73 #include "libguile/private-gc.h"
75 #ifdef GUILE_DEBUG_MALLOC
76 #include "libguile/debug-malloc.h"
88 INIT_MALLOC_LIMIT is the initial amount of malloc usage which will
91 After startup (at the guile> prompt), we have approximately 100k of
92 alloced memory, which won't go away on GC. Let's set the init such
93 that we get a nice yield on the next allocation:
95 #define SCM_DEFAULT_INIT_MALLOC_LIMIT 200*1024
96 #define SCM_DEFAULT_MALLOC_MINYIELD 40
98 /* #define DEBUGINFO */
100 static int scm_i_minyield_malloc
;
103 scm_gc_init_malloc (void)
105 scm_mtrigger
= scm_getenv_int ("GUILE_INIT_MALLOC_LIMIT",
106 SCM_DEFAULT_INIT_MALLOC_LIMIT
);
107 scm_i_minyield_malloc
= scm_getenv_int ("GUILE_MIN_YIELD_MALLOC",
108 SCM_DEFAULT_MALLOC_MINYIELD
);
110 if (scm_i_minyield_malloc
>= 100)
111 scm_i_minyield_malloc
= 99;
112 if (scm_i_minyield_malloc
< 1)
113 scm_i_minyield_malloc
= 1;
115 if (scm_mtrigger
< 0)
116 scm_mtrigger
= SCM_DEFAULT_INIT_MALLOC_LIMIT
;
121 /* Function for non-cell memory management.
125 scm_realloc (void *mem
, size_t size
)
129 SCM_SYSCALL (ptr
= realloc (mem
, size
));
133 scm_i_thread_put_to_sleep ();
135 scm_i_sweep_all_segments ("realloc");
137 SCM_SYSCALL (ptr
= realloc (mem
, size
));
140 scm_i_thread_wake_up ();
145 scm_i_sweep_all_segments ("realloc");
147 scm_i_thread_wake_up ();
149 SCM_SYSCALL (ptr
= realloc (mem
, size
));
153 scm_memory_error ("realloc");
157 scm_malloc (size_t sz
)
159 return scm_realloc (NULL
, sz
);
163 Hmm. Should we use the C convention for arguments (i.e. N_ELTS,
167 scm_calloc (size_t sz
)
172 By default, try to use calloc, as it is likely more efficient than
173 calling memset by hand.
175 SCM_SYSCALL(ptr
= calloc (sz
, 1));
179 ptr
= scm_realloc (NULL
, sz
);
180 memset (ptr
, 0x0, sz
);
186 scm_strndup (const char *str
, size_t n
)
188 char *dst
= scm_malloc (n
+1);
189 memcpy (dst
, str
, n
);
195 scm_strdup (const char *str
)
197 return scm_strndup (str
, strlen (str
));
201 scm_gc_register_collectable_memory (void *mem
, size_t size
, const char *what
)
203 scm_mallocated
+= size
;
206 we could finish the full sweep (without mark) here, but in
207 practice this turns out to be ineffective.
211 A program that uses a lot of malloced collectable memory (vectors,
212 strings), will use a lot of memory off the cell-heap; it needs to
213 do GC more often (before cells are exhausted), otherwise swapping
214 and malloc management will tie it down.
216 if (scm_mallocated
> scm_mtrigger
)
218 unsigned long prev_alloced
;
221 scm_i_thread_put_to_sleep ();
223 prev_alloced
= scm_mallocated
;
225 scm_i_sweep_all_segments ("mtrigger");
227 yield
= ((float)prev_alloced
- (float) scm_mallocated
)
228 / (float) prev_alloced
;
230 scm_gc_malloc_yield_percentage
= (int) (100 * yield
);
233 fprintf (stderr
, "prev %lud , now %lud, yield %4.2lf, want %d",
234 prev_alloced
, scm_mallocated
, 100.0*yield
, scm_i_minyield_malloc
);
237 if (yield
< scm_i_minyield_malloc
/ 100.0)
240 We make the trigger a little larger, even; If you have a
241 program that builds up a lot of data in strings, then the
242 desired yield will never be satisfied.
244 Instead of getting bogged down, we let the mtrigger grow
247 float no_overflow_trigger
= scm_mallocated
* 110.0;
249 no_overflow_trigger
/= (float) (100.0 - scm_i_minyield_malloc
);
250 scm_mtrigger
= (unsigned long) no_overflow_trigger
;
253 fprintf (stderr
, "Mtrigger sweep: ineffective. New trigger %d\n", scm_mtrigger
);
257 scm_i_thread_wake_up ();
260 #ifdef GUILE_DEBUG_MALLOC
262 scm_malloc_register (mem
, what
);
267 scm_gc_unregister_collectable_memory (void *mem
, size_t size
, const char *what
)
269 scm_mallocated
-= size
;
270 scm_gc_malloc_collected
+= size
;
272 #ifdef GUILE_DEBUG_MALLOC
274 scm_malloc_unregister (mem
);
279 scm_gc_malloc (size_t size
, const char *what
)
282 The straightforward implementation below has the problem
283 that it might call the GC twice, once in scm_malloc and then
284 again in scm_gc_register_collectable_memory. We don't really
285 want the second GC since it will not find new garbage.
288 Note: this is a theoretical peeve. In reality, malloc() never
289 returns NULL. Usually, memory is overcommitted, and when you try
290 to write it the program is killed with signal 11. --hwn
293 void *ptr
= scm_malloc (size
);
294 scm_gc_register_collectable_memory (ptr
, size
, what
);
299 scm_gc_calloc (size_t size
, const char *what
)
301 void *ptr
= scm_gc_malloc (size
, what
);
302 memset (ptr
, 0x0, size
);
308 scm_gc_realloc (void *mem
, size_t old_size
, size_t new_size
, const char *what
)
310 /* XXX - see scm_gc_malloc. */
312 void *ptr
= scm_realloc (mem
, new_size
);
313 scm_gc_unregister_collectable_memory (mem
, old_size
, what
);
314 scm_gc_register_collectable_memory (ptr
, new_size
, what
);
319 scm_gc_free (void *mem
, size_t size
, const char *what
)
321 scm_gc_unregister_collectable_memory (mem
, size
, what
);
326 scm_gc_strndup (const char *str
, size_t n
, const char *what
)
328 char *dst
= scm_gc_malloc (n
+1, what
);
329 memcpy (dst
, str
, n
);
335 scm_gc_strdup (const char *str
, const char *what
)
337 return scm_gc_strndup (str
, strlen (str
), what
);
340 #if SCM_ENABLE_DEPRECATED == 1
342 /* {Deprecated front end to malloc}
344 * scm_must_malloc, scm_must_realloc, scm_must_free, scm_done_malloc,
347 * These functions provide services comparable to malloc, realloc, and
348 * free. They should be used when allocating memory that will be under
349 * control of the garbage collector, i.e., if the memory may be freed
350 * during garbage collection.
352 * They are deprecated because they weren't really used the way
353 * outlined above, and making sure to return the right amount from
354 * smob free routines was sometimes difficult when dealing with nested
355 * data structures. We basically want everybody to review their code
356 * and use the more symmetrical scm_gc_malloc/scm_gc_free functions
357 * instead. In some cases, where scm_must_malloc has been used
358 * incorrectly (i.e. for non-GC-able memory), use scm_malloc/free.
362 scm_must_malloc (size_t size
, const char *what
)
364 scm_c_issue_deprecation_warning
365 ("scm_must_malloc is deprecated. "
366 "Use scm_gc_malloc and scm_gc_free instead.");
368 return scm_gc_malloc (size
, what
);
372 scm_must_realloc (void *where
,
377 scm_c_issue_deprecation_warning
378 ("scm_must_realloc is deprecated. "
379 "Use scm_gc_realloc and scm_gc_free instead.");
381 return scm_gc_realloc (where
, old_size
, size
, what
);
385 scm_must_strndup (const char *str
, size_t length
)
387 scm_c_issue_deprecation_warning
388 ("scm_must_strndup is deprecated. "
389 "Use scm_gc_strndup and scm_gc_free instead.");
391 return scm_gc_strndup (str
, length
, "string");
395 scm_must_strdup (const char *str
)
397 scm_c_issue_deprecation_warning
398 ("scm_must_strdup is deprecated. "
399 "Use scm_gc_strdup and scm_gc_free instead.");
401 return scm_gc_strdup (str
, "string");
405 scm_must_free (void *obj
)
406 #define FUNC_NAME "scm_must_free"
408 scm_c_issue_deprecation_warning
409 ("scm_must_free is deprecated. "
410 "Use scm_gc_malloc and scm_gc_free instead.");
412 #ifdef GUILE_DEBUG_MALLOC
413 scm_malloc_unregister (obj
);
419 fprintf (stderr
,"freeing NULL pointer");
427 scm_done_malloc (long size
)
429 scm_c_issue_deprecation_warning
430 ("scm_done_malloc is deprecated. "
431 "Use scm_gc_register_collectable_memory instead.");
433 scm_gc_register_collectable_memory (NULL
, size
, "foreign mallocs");
437 scm_done_free (long size
)
439 scm_c_issue_deprecation_warning
440 ("scm_done_free is deprecated. "
441 "Use scm_gc_unregister_collectable_memory instead.");
443 scm_gc_unregister_collectable_memory (NULL
, size
, "foreign mallocs");
446 #endif /* SCM_ENABLE_DEPRECATED == 1 */