Commit | Line | Data |
---|---|---|
b226295a | 1 | /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2004, 2006, 2008 Free Software Foundation, Inc. |
c7743d02 | 2 | * |
73be1d9e MV |
3 | * This library is free software; you can redistribute it and/or |
4 | * modify it under the terms of the GNU Lesser General Public | |
5 | * License as published by the Free Software Foundation; either | |
6 | * version 2.1 of the License, or (at your option) any later version. | |
c7743d02 | 7 | * |
73be1d9e | 8 | * This library is distributed in the hope that it will be useful, |
c7743d02 | 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
73be1d9e MV |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
11 | * Lesser General Public License for more details. | |
c7743d02 | 12 | * |
73be1d9e MV |
13 | * You should have received a copy of the GNU Lesser General Public |
14 | * License along with this library; if not, write to the Free Software | |
92205699 | 15 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
73be1d9e | 16 | */ |
c7743d02 HWN |
17 | |
18 | ||
19 | \f | |
dbb605f5 | 20 | #ifdef HAVE_CONFIG_H |
132fa21f RB |
21 | # include <config.h> |
22 | #endif | |
23 | ||
c7743d02 HWN |
24 | #include <stdio.h> |
25 | #include <errno.h> | |
26 | #include <string.h> | |
27 | ||
28 | #ifdef __ia64__ | |
29 | #include <ucontext.h> | |
30 | extern unsigned long * __libc_ia64_register_backing_store_base; | |
31 | #endif | |
32 | ||
33 | #include "libguile/_scm.h" | |
34 | #include "libguile/eval.h" | |
35 | #include "libguile/stime.h" | |
36 | #include "libguile/stackchk.h" | |
37 | #include "libguile/struct.h" | |
38 | #include "libguile/smob.h" | |
39 | #include "libguile/unif.h" | |
40 | #include "libguile/async.h" | |
41 | #include "libguile/ports.h" | |
42 | #include "libguile/root.h" | |
43 | #include "libguile/strings.h" | |
44 | #include "libguile/vectors.h" | |
45 | #include "libguile/weaks.h" | |
46 | #include "libguile/hashtab.h" | |
47 | #include "libguile/tags.h" | |
48 | ||
49 | #include "libguile/validate.h" | |
50 | #include "libguile/deprecation.h" | |
51 | #include "libguile/gc.h" | |
52 | ||
53 | #include "libguile/private-gc.h" | |
54 | ||
55 | #ifdef GUILE_DEBUG_MALLOC | |
56 | #include "libguile/debug-malloc.h" | |
57 | #endif | |
58 | ||
59 | #ifdef HAVE_MALLOC_H | |
60 | #include <malloc.h> | |
61 | #endif | |
62 | ||
63 | #ifdef HAVE_UNISTD_H | |
64 | #include <unistd.h> | |
65 | #endif | |
66 | ||
67 | /* | |
68 | INIT_MALLOC_LIMIT is the initial amount of malloc usage which will | |
69 | trigger a GC. | |
70 | ||
71 | After startup (at the guile> prompt), we have approximately 100k of | |
72 | alloced memory, which won't go away on GC. Let's set the init such | |
73 | that we get a nice yield on the next allocation: | |
74 | */ | |
c2cbcc57 | 75 | #define SCM_DEFAULT_INIT_MALLOC_LIMIT 200*1024 |
c7743d02 HWN |
76 | #define SCM_DEFAULT_MALLOC_MINYIELD 40 |
77 | ||
61ef9c1f | 78 | /* #define DEBUGINFO */ |
c7743d02 HWN |
79 | |
80 | static int scm_i_minyield_malloc; | |
81 | ||
82 | void | |
83 | scm_gc_init_malloc (void) | |
84 | { | |
85 | scm_mtrigger = scm_getenv_int ("GUILE_INIT_MALLOC_LIMIT", | |
86 | SCM_DEFAULT_INIT_MALLOC_LIMIT); | |
82ae1b8e HWN |
87 | scm_i_minyield_malloc = scm_getenv_int ("GUILE_MIN_YIELD_MALLOC", |
88 | SCM_DEFAULT_MALLOC_MINYIELD); | |
dac04e9f HWN |
89 | |
90 | if (scm_i_minyield_malloc >= 100) | |
91 | scm_i_minyield_malloc = 99; | |
92 | if (scm_i_minyield_malloc < 1) | |
93 | scm_i_minyield_malloc = 1; | |
94 | ||
95 | if (scm_mtrigger < 0) | |
96 | scm_mtrigger = SCM_DEFAULT_INIT_MALLOC_LIMIT; | |
c7743d02 HWN |
97 | } |
98 | ||
99 | ||
100 | \f | |
101 | /* Function for non-cell memory management. | |
102 | */ | |
103 | ||
c7743d02 HWN |
104 | void * |
105 | scm_realloc (void *mem, size_t size) | |
106 | { | |
107 | void *ptr; | |
108 | ||
109 | SCM_SYSCALL (ptr = realloc (mem, size)); | |
110 | if (ptr) | |
111 | return ptr; | |
112 | ||
9de87eea | 113 | scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex); |
b17e0ac3 MV |
114 | scm_gc_running_p = 1; |
115 | ||
b17e0ac3 | 116 | scm_i_gc ("realloc"); |
676d9cc5 HWN |
117 | |
118 | /* | |
119 | We don't want these sweep statistics to influence results for | |
120 | cell GC, so we don't collect statistics. | |
121 | ||
1f584400 | 122 | realloc () failed, so we're really desparate to free memory. Run a |
676d9cc5 HWN |
123 | full sweep. |
124 | */ | |
82ae1b8e | 125 | scm_i_sweep_all_segments ("realloc", NULL); |
676d9cc5 | 126 | |
b17e0ac3 | 127 | scm_gc_running_p = 0; |
9de87eea | 128 | scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex); |
9bc4701c | 129 | |
c7743d02 HWN |
130 | SCM_SYSCALL (ptr = realloc (mem, size)); |
131 | if (ptr) | |
132 | return ptr; | |
133 | ||
134 | scm_memory_error ("realloc"); | |
135 | } | |
136 | ||
39e8f371 HWN |
137 | void * |
138 | scm_malloc (size_t sz) | |
139 | { | |
140 | return scm_realloc (NULL, sz); | |
141 | } | |
ba1b2226 HWN |
142 | |
143 | /* | |
144 | Hmm. Should we use the C convention for arguments (i.e. N_ELTS, | |
145 | SIZEOF_ELT)? --hwn | |
146 | */ | |
147 | void * | |
148 | scm_calloc (size_t sz) | |
149 | { | |
1383773b HWN |
150 | void * ptr; |
151 | ||
152 | /* | |
153 | By default, try to use calloc, as it is likely more efficient than | |
154 | calling memset by hand. | |
155 | */ | |
fb50ef08 | 156 | SCM_SYSCALL (ptr = calloc (sz, 1)); |
1383773b HWN |
157 | if (ptr) |
158 | return ptr; | |
159 | ||
160 | ptr = scm_realloc (NULL, sz); | |
ba1b2226 HWN |
161 | memset (ptr, 0x0, sz); |
162 | return ptr; | |
163 | } | |
164 | ||
39e8f371 | 165 | |
c7743d02 HWN |
166 | char * |
167 | scm_strndup (const char *str, size_t n) | |
168 | { | |
fb50ef08 | 169 | char *dst = scm_malloc (n + 1); |
c7743d02 HWN |
170 | memcpy (dst, str, n); |
171 | dst[n] = 0; | |
172 | return dst; | |
173 | } | |
174 | ||
175 | char * | |
176 | scm_strdup (const char *str) | |
177 | { | |
178 | return scm_strndup (str, strlen (str)); | |
179 | } | |
180 | ||
cbfe8e62 HWN |
181 | static void |
182 | decrease_mtrigger (size_t size, const char * what) | |
183 | { | |
9de87eea | 184 | scm_i_pthread_mutex_lock (&scm_i_gc_admin_mutex); |
2b829bbb KR |
185 | |
186 | if (size > scm_mallocated) | |
187 | { | |
188 | fprintf (stderr, "`scm_mallocated' underflow. This means that more " | |
189 | "memory was unregistered\n" | |
190 | "via `scm_gc_unregister_collectable_memory ()' than " | |
191 | "registered.\n"); | |
192 | abort (); | |
193 | } | |
194 | ||
cbfe8e62 HWN |
195 | scm_mallocated -= size; |
196 | scm_gc_malloc_collected += size; | |
9de87eea | 197 | scm_i_pthread_mutex_unlock (&scm_i_gc_admin_mutex); |
cbfe8e62 HWN |
198 | } |
199 | ||
200 | static void | |
201 | increase_mtrigger (size_t size, const char *what) | |
c7743d02 | 202 | { |
eb01cb64 MV |
203 | size_t mallocated = 0; |
204 | int overflow = 0, triggered = 0; | |
205 | ||
9de87eea | 206 | scm_i_pthread_mutex_lock (&scm_i_gc_admin_mutex); |
131805f0 | 207 | if (ULONG_MAX - size < scm_mallocated) |
eb01cb64 MV |
208 | overflow = 1; |
209 | else | |
131805f0 | 210 | { |
eb01cb64 MV |
211 | scm_mallocated += size; |
212 | mallocated = scm_mallocated; | |
213 | if (scm_mallocated > scm_mtrigger) | |
214 | triggered = 1; | |
131805f0 | 215 | } |
9de87eea | 216 | scm_i_pthread_mutex_unlock (&scm_i_gc_admin_mutex); |
131805f0 | 217 | |
eb01cb64 | 218 | if (overflow) |
9de87eea | 219 | scm_memory_error ("Overflow of scm_mallocated: too much memory in use."); |
c7743d02 | 220 | |
c7743d02 HWN |
221 | /* |
222 | A program that uses a lot of malloced collectable memory (vectors, | |
223 | strings), will use a lot of memory off the cell-heap; it needs to | |
224 | do GC more often (before cells are exhausted), otherwise swapping | |
225 | and malloc management will tie it down. | |
226 | */ | |
eb01cb64 | 227 | if (triggered) |
c7743d02 | 228 | { |
9bc4701c | 229 | unsigned long prev_alloced; |
c7743d02 | 230 | float yield; |
4c7016dc | 231 | |
9de87eea | 232 | scm_i_scm_pthread_mutex_lock (&scm_i_sweep_mutex); |
b17e0ac3 | 233 | scm_gc_running_p = 1; |
9bc4701c | 234 | |
82ae1b8e HWN |
235 | prev_alloced = mallocated; |
236 | ||
237 | /* The GC will finish the pending sweep. For that reason, we | |
238 | don't execute a complete sweep after GC, although that might | |
239 | free some more memory. | |
240 | */ | |
b17e0ac3 | 241 | scm_i_gc (what); |
c7743d02 | 242 | |
fb50ef08 MD |
243 | yield = (((float) prev_alloced - (float) scm_mallocated) |
244 | / (float) prev_alloced); | |
ffd72400 | 245 | |
82ae1b8e | 246 | scm_gc_malloc_yield_percentage = (int) (100 * yield); |
61ef9c1f HWN |
247 | |
248 | #ifdef DEBUGINFO | |
c7743d02 | 249 | fprintf (stderr, "prev %lud , now %lud, yield %4.2lf, want %d", |
fb50ef08 MD |
250 | prev_alloced, |
251 | scm_mallocated, | |
252 | 100.0 * yield, | |
253 | scm_i_minyield_malloc); | |
61ef9c1f HWN |
254 | #endif |
255 | ||
c7743d02 HWN |
256 | if (yield < scm_i_minyield_malloc / 100.0) |
257 | { | |
258 | /* | |
259 | We make the trigger a little larger, even; If you have a | |
260 | program that builds up a lot of data in strings, then the | |
261 | desired yield will never be satisfied. | |
262 | ||
263 | Instead of getting bogged down, we let the mtrigger grow | |
264 | strongly with it. | |
265 | */ | |
e88e4f2e | 266 | float no_overflow_trigger = scm_mallocated * 110.0; |
dac04e9f | 267 | |
e88e4f2e | 268 | no_overflow_trigger /= (float) (100.0 - scm_i_minyield_malloc); |
131805f0 HWN |
269 | |
270 | ||
271 | if (no_overflow_trigger >= (float) ULONG_MAX) | |
272 | scm_mtrigger = ULONG_MAX; | |
273 | else | |
82ae1b8e | 274 | scm_mtrigger = (unsigned long) no_overflow_trigger; |
c7743d02 | 275 | |
61ef9c1f | 276 | #ifdef DEBUGINFO |
fb50ef08 MD |
277 | fprintf (stderr, "Mtrigger sweep: ineffective. New trigger %d\n", |
278 | scm_mtrigger); | |
61ef9c1f | 279 | #endif |
c7743d02 | 280 | } |
b17e0ac3 MV |
281 | |
282 | scm_gc_running_p = 0; | |
9de87eea | 283 | scm_i_pthread_mutex_unlock (&scm_i_sweep_mutex); |
c7743d02 | 284 | } |
cbfe8e62 HWN |
285 | } |
286 | ||
287 | void | |
288 | scm_gc_register_collectable_memory (void *mem, size_t size, const char *what) | |
289 | { | |
290 | increase_mtrigger (size, what); | |
c7743d02 HWN |
291 | #ifdef GUILE_DEBUG_MALLOC |
292 | if (mem) | |
293 | scm_malloc_register (mem, what); | |
294 | #endif | |
295 | } | |
296 | ||
cbfe8e62 | 297 | |
c7743d02 HWN |
298 | void |
299 | scm_gc_unregister_collectable_memory (void *mem, size_t size, const char *what) | |
300 | { | |
cbfe8e62 | 301 | decrease_mtrigger (size, what); |
c7743d02 HWN |
302 | #ifdef GUILE_DEBUG_MALLOC |
303 | if (mem) | |
304 | scm_malloc_unregister (mem); | |
305 | #endif | |
306 | } | |
307 | ||
308 | void * | |
309 | scm_gc_malloc (size_t size, const char *what) | |
310 | { | |
311 | /* | |
312 | The straightforward implementation below has the problem | |
313 | that it might call the GC twice, once in scm_malloc and then | |
314 | again in scm_gc_register_collectable_memory. We don't really | |
315 | want the second GC since it will not find new garbage. | |
316 | ||
1f584400 | 317 | Note: this is a theoretical peeve. In reality, malloc () never |
c7743d02 HWN |
318 | returns NULL. Usually, memory is overcommitted, and when you try |
319 | to write it the program is killed with signal 11. --hwn | |
320 | */ | |
321 | ||
4a19ed04 | 322 | void *ptr = size ? scm_malloc (size) : NULL; |
c7743d02 HWN |
323 | scm_gc_register_collectable_memory (ptr, size, what); |
324 | return ptr; | |
325 | } | |
326 | ||
39e8f371 HWN |
327 | void * |
328 | scm_gc_calloc (size_t size, const char *what) | |
329 | { | |
330 | void *ptr = scm_gc_malloc (size, what); | |
331 | memset (ptr, 0x0, size); | |
332 | return ptr; | |
333 | } | |
334 | ||
335 | ||
c7743d02 HWN |
336 | void * |
337 | scm_gc_realloc (void *mem, size_t old_size, size_t new_size, const char *what) | |
338 | { | |
53f18a0d KR |
339 | void *ptr; |
340 | ||
c7743d02 HWN |
341 | /* XXX - see scm_gc_malloc. */ |
342 | ||
cbfe8e62 HWN |
343 | |
344 | /* | |
1f584400 | 345 | scm_realloc () may invalidate the block pointed to by WHERE, eg. by |
cbfe8e62 | 346 | unmapping it from memory or altering the contents. Since |
1f584400 HWN |
347 | increase_mtrigger () might trigger a GC that would scan |
348 | MEM, it is crucial that this call precedes realloc (). | |
cbfe8e62 HWN |
349 | */ |
350 | ||
351 | decrease_mtrigger (old_size, what); | |
352 | increase_mtrigger (new_size, what); | |
353 | ||
53f18a0d | 354 | ptr = scm_realloc (mem, new_size); |
cbfe8e62 HWN |
355 | |
356 | #ifdef GUILE_DEBUG_MALLOC | |
357 | if (mem) | |
358 | scm_malloc_reregister (mem, ptr, what); | |
359 | #endif | |
360 | ||
c7743d02 HWN |
361 | return ptr; |
362 | } | |
363 | ||
364 | void | |
365 | scm_gc_free (void *mem, size_t size, const char *what) | |
366 | { | |
367 | scm_gc_unregister_collectable_memory (mem, size, what); | |
4a19ed04 NJ |
368 | if (mem) |
369 | free (mem); | |
c7743d02 HWN |
370 | } |
371 | ||
372 | char * | |
373 | scm_gc_strndup (const char *str, size_t n, const char *what) | |
374 | { | |
375 | char *dst = scm_gc_malloc (n+1, what); | |
376 | memcpy (dst, str, n); | |
377 | dst[n] = 0; | |
378 | return dst; | |
379 | } | |
380 | ||
381 | char * | |
382 | scm_gc_strdup (const char *str, const char *what) | |
383 | { | |
384 | return scm_gc_strndup (str, strlen (str), what); | |
385 | } | |
386 | ||
387 | #if SCM_ENABLE_DEPRECATED == 1 | |
388 | ||
389 | /* {Deprecated front end to malloc} | |
390 | * | |
391 | * scm_must_malloc, scm_must_realloc, scm_must_free, scm_done_malloc, | |
392 | * scm_done_free | |
393 | * | |
394 | * These functions provide services comparable to malloc, realloc, and | |
395 | * free. They should be used when allocating memory that will be under | |
396 | * control of the garbage collector, i.e., if the memory may be freed | |
397 | * during garbage collection. | |
398 | * | |
399 | * They are deprecated because they weren't really used the way | |
400 | * outlined above, and making sure to return the right amount from | |
401 | * smob free routines was sometimes difficult when dealing with nested | |
402 | * data structures. We basically want everybody to review their code | |
403 | * and use the more symmetrical scm_gc_malloc/scm_gc_free functions | |
404 | * instead. In some cases, where scm_must_malloc has been used | |
405 | * incorrectly (i.e. for non-GC-able memory), use scm_malloc/free. | |
406 | */ | |
407 | ||
408 | void * | |
409 | scm_must_malloc (size_t size, const char *what) | |
410 | { | |
411 | scm_c_issue_deprecation_warning | |
412 | ("scm_must_malloc is deprecated. " | |
413 | "Use scm_gc_malloc and scm_gc_free instead."); | |
414 | ||
415 | return scm_gc_malloc (size, what); | |
416 | } | |
417 | ||
418 | void * | |
419 | scm_must_realloc (void *where, | |
420 | size_t old_size, | |
421 | size_t size, | |
422 | const char *what) | |
423 | { | |
424 | scm_c_issue_deprecation_warning | |
425 | ("scm_must_realloc is deprecated. " | |
426 | "Use scm_gc_realloc and scm_gc_free instead."); | |
427 | ||
428 | return scm_gc_realloc (where, old_size, size, what); | |
429 | } | |
430 | ||
431 | char * | |
432 | scm_must_strndup (const char *str, size_t length) | |
433 | { | |
434 | scm_c_issue_deprecation_warning | |
435 | ("scm_must_strndup is deprecated. " | |
436 | "Use scm_gc_strndup and scm_gc_free instead."); | |
437 | ||
438 | return scm_gc_strndup (str, length, "string"); | |
439 | } | |
440 | ||
441 | char * | |
442 | scm_must_strdup (const char *str) | |
443 | { | |
444 | scm_c_issue_deprecation_warning | |
445 | ("scm_must_strdup is deprecated. " | |
446 | "Use scm_gc_strdup and scm_gc_free instead."); | |
447 | ||
448 | return scm_gc_strdup (str, "string"); | |
449 | } | |
450 | ||
451 | void | |
452 | scm_must_free (void *obj) | |
453 | #define FUNC_NAME "scm_must_free" | |
454 | { | |
455 | scm_c_issue_deprecation_warning | |
456 | ("scm_must_free is deprecated. " | |
457 | "Use scm_gc_malloc and scm_gc_free instead."); | |
458 | ||
459 | #ifdef GUILE_DEBUG_MALLOC | |
460 | scm_malloc_unregister (obj); | |
461 | #endif | |
462 | if (obj) | |
463 | free (obj); | |
464 | else | |
be3ff021 HWN |
465 | { |
466 | fprintf (stderr,"freeing NULL pointer"); | |
467 | abort (); | |
468 | } | |
c7743d02 HWN |
469 | } |
470 | #undef FUNC_NAME | |
471 | ||
472 | ||
473 | void | |
474 | scm_done_malloc (long size) | |
475 | { | |
476 | scm_c_issue_deprecation_warning | |
477 | ("scm_done_malloc is deprecated. " | |
478 | "Use scm_gc_register_collectable_memory instead."); | |
479 | ||
4cd3853f KR |
480 | if (size >= 0) |
481 | scm_gc_register_collectable_memory (NULL, size, "foreign mallocs"); | |
482 | else | |
483 | scm_gc_unregister_collectable_memory (NULL, -size, "foreign mallocs"); | |
c7743d02 HWN |
484 | } |
485 | ||
486 | void | |
487 | scm_done_free (long size) | |
488 | { | |
489 | scm_c_issue_deprecation_warning | |
490 | ("scm_done_free is deprecated. " | |
491 | "Use scm_gc_unregister_collectable_memory instead."); | |
492 | ||
4cd3853f KR |
493 | if (size >= 0) |
494 | scm_gc_unregister_collectable_memory (NULL, size, "foreign mallocs"); | |
495 | else | |
496 | scm_gc_register_collectable_memory (NULL, -size, "foreign mallocs"); | |
c7743d02 HWN |
497 | } |
498 | ||
499 | #endif /* SCM_ENABLE_DEPRECATED == 1 */ |