gc.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859
  1. /* Copyright (C) 1995,1996,1997,1998,1999,2000,2001, 2002, 2003, 2006, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
  2. *
  3. * This library is free software; you can redistribute it and/or
  4. * modify it under the terms of the GNU Lesser General Public License
  5. * as published by the Free Software Foundation; either version 3 of
  6. * the License, or (at your option) any later version.
  7. *
  8. * This library is distributed in the hope that it will be useful, but
  9. * WITHOUT ANY WARRANTY; without even the implied warranty of
  10. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11. * Lesser General Public License for more details.
  12. *
  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
  15. * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16. * 02110-1301 USA
  17. */
  18. /* #define DEBUGINFO */
  19. #ifdef HAVE_CONFIG_H
  20. # include <config.h>
  21. #endif
  22. #include "libguile/gen-scmconfig.h"
  23. #include <stdio.h>
  24. #include <errno.h>
  25. #include <string.h>
  26. #ifdef __ia64__
  27. #include <ucontext.h>
  28. extern unsigned long * __libc_ia64_register_backing_store_base;
  29. #endif
  30. #include "libguile/_scm.h"
  31. #include "libguile/eval.h"
  32. #include "libguile/stime.h"
  33. #include "libguile/stackchk.h"
  34. #include "libguile/struct.h"
  35. #include "libguile/smob.h"
  36. #include "libguile/arrays.h"
  37. #include "libguile/async.h"
  38. #include "libguile/ports.h"
  39. #include "libguile/root.h"
  40. #include "libguile/strings.h"
  41. #include "libguile/vectors.h"
  42. #include "libguile/hashtab.h"
  43. #include "libguile/tags.h"
  44. #include "libguile/private-gc.h"
  45. #include "libguile/validate.h"
  46. #include "libguile/deprecation.h"
  47. #include "libguile/gc.h"
  48. #include "libguile/dynwind.h"
  49. #include "libguile/bdw-gc.h"
  50. /* For GC_set_start_callback. */
  51. #include <gc/gc_mark.h>
  52. #ifdef GUILE_DEBUG_MALLOC
  53. #include "libguile/debug-malloc.h"
  54. #endif
  55. #ifdef HAVE_MALLOC_H
  56. #include <malloc.h>
  57. #endif
  58. #ifdef HAVE_UNISTD_H
  59. #include <unistd.h>
  60. #endif
  61. /* Set this to != 0 if every cell that is accessed shall be checked:
  62. */
  63. int scm_debug_cell_accesses_p = 0;
  64. int scm_expensive_debug_cell_accesses_p = 0;
  65. /* Set this to 0 if no additional gc's shall be performed, otherwise set it to
  66. * the number of cell accesses after which a gc shall be called.
  67. */
  68. int scm_debug_cells_gc_interval = 0;
  69. /* Hash table that keeps a reference to objects the user wants to protect from
  70. garbage collection. It could arguably be private but applications have come
  71. to rely on it (e.g., Lilypond 2.13.9). */
  72. SCM scm_protects;
  73. #if (SCM_DEBUG_CELL_ACCESSES == 1)
  74. /*
  75. Assert that the given object is a valid reference to a valid cell. This
  76. test involves to determine whether the object is a cell pointer, whether
  77. this pointer actually points into a heap segment and whether the cell
  78. pointed to is not a free cell. Further, additional garbage collections may
  79. get executed after a user defined number of cell accesses. This helps to
  80. find places in the C code where references are dropped for extremely short
  81. periods.
  82. */
  83. void
  84. scm_i_expensive_validation_check (SCM cell)
  85. {
  86. /* If desired, perform additional garbage collections after a user
  87. * defined number of cell accesses.
  88. */
  89. if (scm_debug_cells_gc_interval)
  90. {
  91. static unsigned int counter = 0;
  92. if (counter != 0)
  93. {
  94. --counter;
  95. }
  96. else
  97. {
  98. counter = scm_debug_cells_gc_interval;
  99. scm_gc ();
  100. }
  101. }
  102. }
  103. /* Whether cell validation is already running. */
  104. static int scm_i_cell_validation_already_running = 0;
  105. void
  106. scm_assert_cell_valid (SCM cell)
  107. {
  108. if (!scm_i_cell_validation_already_running && scm_debug_cell_accesses_p)
  109. {
  110. scm_i_cell_validation_already_running = 1; /* set to avoid recursion */
  111. /*
  112. During GC, no user-code should be run, and the guile core
  113. should use non-protected accessors.
  114. */
  115. if (scm_gc_running_p)
  116. return;
  117. /*
  118. Only scm_in_heap_p and rescanning the heap is wildly
  119. expensive.
  120. */
  121. if (scm_expensive_debug_cell_accesses_p)
  122. scm_i_expensive_validation_check (cell);
  123. scm_i_cell_validation_already_running = 0; /* re-enable */
  124. }
  125. }
  126. SCM_DEFINE (scm_set_debug_cell_accesses_x, "set-debug-cell-accesses!", 1, 0, 0,
  127. (SCM flag),
  128. "If @var{flag} is @code{#f}, cell access checking is disabled.\n"
  129. "If @var{flag} is @code{#t}, cheap cell access checking is enabled,\n"
  130. "but no additional calls to garbage collection are issued.\n"
  131. "If @var{flag} is a number, strict cell access checking is enabled,\n"
  132. "with an additional garbage collection after the given\n"
  133. "number of cell accesses.\n"
  134. "This procedure only exists when the compile-time flag\n"
  135. "@code{SCM_DEBUG_CELL_ACCESSES} was set to 1.")
  136. #define FUNC_NAME s_scm_set_debug_cell_accesses_x
  137. {
  138. if (scm_is_false (flag))
  139. {
  140. scm_debug_cell_accesses_p = 0;
  141. }
  142. else if (scm_is_eq (flag, SCM_BOOL_T))
  143. {
  144. scm_debug_cells_gc_interval = 0;
  145. scm_debug_cell_accesses_p = 1;
  146. scm_expensive_debug_cell_accesses_p = 0;
  147. }
  148. else
  149. {
  150. scm_debug_cells_gc_interval = scm_to_signed_integer (flag, 0, INT_MAX);
  151. scm_debug_cell_accesses_p = 1;
  152. scm_expensive_debug_cell_accesses_p = 1;
  153. }
  154. return SCM_UNSPECIFIED;
  155. }
  156. #undef FUNC_NAME
  157. #endif /* SCM_DEBUG_CELL_ACCESSES == 1 */
  158. /* Hooks. */
  159. scm_t_c_hook scm_before_gc_c_hook;
  160. scm_t_c_hook scm_before_mark_c_hook;
  161. scm_t_c_hook scm_before_sweep_c_hook;
  162. scm_t_c_hook scm_after_sweep_c_hook;
  163. scm_t_c_hook scm_after_gc_c_hook;
  164. static void
  165. run_before_gc_c_hook (void)
  166. {
  167. scm_c_hook_run (&scm_before_gc_c_hook, NULL);
  168. }
  169. /* GC Statistics Keeping
  170. */
  171. unsigned long scm_gc_ports_collected = 0;
  172. static long gc_time_taken = 0;
  173. static long gc_start_time = 0;
  174. static unsigned long protected_obj_count = 0;
  175. SCM_SYMBOL (sym_gc_time_taken, "gc-time-taken");
  176. SCM_SYMBOL (sym_heap_size, "heap-size");
  177. SCM_SYMBOL (sym_heap_free_size, "heap-free-size");
  178. SCM_SYMBOL (sym_heap_total_allocated, "heap-total-allocated");
  179. SCM_SYMBOL (sym_heap_allocated_since_gc, "heap-allocated-since-gc");
  180. SCM_SYMBOL (sym_protected_objects, "protected-objects");
  181. SCM_SYMBOL (sym_times, "gc-times");
  182. /* {Scheme Interface to GC}
  183. */
  184. static SCM
  185. tag_table_to_type_alist (void *closure, SCM key, SCM val, SCM acc)
  186. {
  187. if (scm_is_integer (key))
  188. {
  189. int c_tag = scm_to_int (key);
  190. char const * name = scm_i_tag_name (c_tag);
  191. if (name != NULL)
  192. {
  193. key = scm_from_locale_string (name);
  194. }
  195. else
  196. {
  197. char s[100];
  198. sprintf (s, "tag %d", c_tag);
  199. key = scm_from_locale_string (s);
  200. }
  201. }
  202. return scm_cons (scm_cons (key, val), acc);
  203. }
  204. SCM_DEFINE (scm_gc_live_object_stats, "gc-live-object-stats", 0, 0, 0,
  205. (),
  206. "Return an alist of statistics of the current live objects. ")
  207. #define FUNC_NAME s_scm_gc_live_object_stats
  208. {
  209. SCM tab = scm_make_hash_table (scm_from_int (57));
  210. SCM alist;
  211. alist
  212. = scm_internal_hash_fold (&tag_table_to_type_alist, NULL, SCM_EOL, tab);
  213. return alist;
  214. }
  215. #undef FUNC_NAME
  216. extern int scm_gc_malloc_yield_percentage;
  217. SCM_DEFINE (scm_gc_stats, "gc-stats", 0, 0, 0,
  218. (),
  219. "Return an association list of statistics about Guile's current\n"
  220. "use of storage.\n")
  221. #define FUNC_NAME s_scm_gc_stats
  222. {
  223. SCM answer;
  224. size_t heap_size, free_bytes, bytes_since_gc, total_bytes;
  225. size_t gc_times;
  226. heap_size = GC_get_heap_size ();
  227. free_bytes = GC_get_free_bytes ();
  228. bytes_since_gc = GC_get_bytes_since_gc ();
  229. total_bytes = GC_get_total_bytes ();
  230. gc_times = GC_gc_no;
  231. answer =
  232. scm_list_n (scm_cons (sym_gc_time_taken, scm_from_long (gc_time_taken)),
  233. scm_cons (sym_heap_size, scm_from_size_t (heap_size)),
  234. scm_cons (sym_heap_free_size, scm_from_size_t (free_bytes)),
  235. scm_cons (sym_heap_total_allocated,
  236. scm_from_size_t (total_bytes)),
  237. scm_cons (sym_heap_allocated_since_gc,
  238. scm_from_size_t (bytes_since_gc)),
  239. scm_cons (sym_protected_objects,
  240. scm_from_ulong (protected_obj_count)),
  241. scm_cons (sym_times, scm_from_size_t (gc_times)),
  242. SCM_UNDEFINED);
  243. return answer;
  244. }
  245. #undef FUNC_NAME
  246. SCM_DEFINE (scm_gc_dump, "gc-dump", 0, 0, 0,
  247. (void),
  248. "Dump information about the garbage collector's internal data "
  249. "structures and memory usage to the standard output.")
  250. #define FUNC_NAME s_scm_gc_dump
  251. {
  252. GC_dump ();
  253. return SCM_UNSPECIFIED;
  254. }
  255. #undef FUNC_NAME
  256. SCM_DEFINE (scm_object_address, "object-address", 1, 0, 0,
  257. (SCM obj),
  258. "Return an integer that for the lifetime of @var{obj} is uniquely\n"
  259. "returned by this function for @var{obj}")
  260. #define FUNC_NAME s_scm_object_address
  261. {
  262. return scm_from_ulong (SCM_UNPACK (obj));
  263. }
  264. #undef FUNC_NAME
  265. SCM_DEFINE (scm_gc_disable, "gc-disable", 0, 0, 0,
  266. (),
  267. "Disables the garbage collector. Nested calls are permitted. "
  268. "GC is re-enabled once @code{gc-enable} has been called the "
  269. "same number of times @code{gc-disable} was called.")
  270. #define FUNC_NAME s_scm_gc_disable
  271. {
  272. GC_disable ();
  273. return SCM_UNSPECIFIED;
  274. }
  275. #undef FUNC_NAME
  276. SCM_DEFINE (scm_gc_enable, "gc-enable", 0, 0, 0,
  277. (),
  278. "Enables the garbage collector.")
  279. #define FUNC_NAME s_scm_gc_enable
  280. {
  281. GC_enable ();
  282. return SCM_UNSPECIFIED;
  283. }
  284. #undef FUNC_NAME
  285. SCM_DEFINE (scm_gc, "gc", 0, 0, 0,
  286. (),
  287. "Scans all of SCM objects and reclaims for further use those that are\n"
  288. "no longer accessible.")
  289. #define FUNC_NAME s_scm_gc
  290. {
  291. scm_i_gc ("call");
  292. return SCM_UNSPECIFIED;
  293. }
  294. #undef FUNC_NAME
  295. void
  296. scm_i_gc (const char *what)
  297. {
  298. #ifndef HAVE_GC_SET_START_CALLBACK
  299. run_before_gc_c_hook ();
  300. #endif
  301. GC_gcollect ();
  302. }
  303. /* {GC Protection Helper Functions}
  304. */
  305. /*
  306. * If within a function you need to protect one or more scheme objects from
  307. * garbage collection, pass them as parameters to one of the
  308. * scm_remember_upto_here* functions below. These functions don't do
  309. * anything, but since the compiler does not know that they are actually
  310. * no-ops, it will generate code that calls these functions with the given
  311. * parameters. Therefore, you can be sure that the compiler will keep those
  312. * scheme values alive (on the stack or in a register) up to the point where
  313. * scm_remember_upto_here* is called. In other words, place the call to
  314. * scm_remember_upto_here* _behind_ the last code in your function, that
  315. * depends on the scheme object to exist.
  316. *
  317. * Example: We want to make sure that the string object str does not get
  318. * garbage collected during the execution of 'some_function' in the code
  319. * below, because otherwise the characters belonging to str would be freed and
  320. * 'some_function' might access freed memory. To make sure that the compiler
  321. * keeps str alive on the stack or in a register such that it is visible to
  322. * the conservative gc we add the call to scm_remember_upto_here_1 _after_ the
  323. * call to 'some_function'. Note that this would not be necessary if str was
  324. * used anyway after the call to 'some_function'.
  325. * char *chars = scm_i_string_chars (str);
  326. * some_function (chars);
  327. * scm_remember_upto_here_1 (str); // str will be alive up to this point.
  328. */
  329. /* Remove any macro versions of these while defining the functions.
  330. Functions are always included in the library, for upward binary
  331. compatibility and in case combinations of GCC and non-GCC are used. */
  332. #undef scm_remember_upto_here_1
  333. #undef scm_remember_upto_here_2
  334. void
  335. scm_remember_upto_here_1 (SCM obj SCM_UNUSED)
  336. {
  337. /* Empty. Protects a single object from garbage collection. */
  338. }
  339. void
  340. scm_remember_upto_here_2 (SCM obj1 SCM_UNUSED, SCM obj2 SCM_UNUSED)
  341. {
  342. /* Empty. Protects two objects from garbage collection. */
  343. }
  344. void
  345. scm_remember_upto_here (SCM obj SCM_UNUSED, ...)
  346. {
  347. /* Empty. Protects any number of objects from garbage collection. */
  348. }
  349. /*
  350. These crazy functions prevent garbage collection
  351. of arguments after the first argument by
  352. ensuring they remain live throughout the
  353. function because they are used in the last
  354. line of the code block.
  355. It'd be better to have a nice compiler hint to
  356. aid the conservative stack-scanning GC. --03/09/00 gjb */
  357. SCM
  358. scm_return_first (SCM elt, ...)
  359. {
  360. return elt;
  361. }
  362. int
  363. scm_return_first_int (int i, ...)
  364. {
  365. return i;
  366. }
  367. SCM
  368. scm_permanent_object (SCM obj)
  369. {
  370. return (scm_gc_protect_object (obj));
  371. }
  372. /* Protect OBJ from the garbage collector. OBJ will not be freed, even if all
  373. other references are dropped, until the object is unprotected by calling
  374. scm_gc_unprotect_object (OBJ). Calls to scm_gc_protect/unprotect_object nest,
  375. i. e. it is possible to protect the same object several times, but it is
  376. necessary to unprotect the object the same number of times to actually get
  377. the object unprotected. It is an error to unprotect an object more often
  378. than it has been protected before. The function scm_protect_object returns
  379. OBJ.
  380. */
  381. /* Implementation note: For every object X, there is a counter which
  382. scm_gc_protect_object (X) increments and scm_gc_unprotect_object (X) decrements.
  383. */
  384. SCM
  385. scm_gc_protect_object (SCM obj)
  386. {
  387. SCM handle;
  388. /* This critical section barrier will be replaced by a mutex. */
  389. /* njrev: Indeed; if my comment above is correct, there is the same
  390. critsec/mutex inconsistency here. */
  391. SCM_CRITICAL_SECTION_START;
  392. handle = scm_hashq_create_handle_x (scm_protects, obj, scm_from_int (0));
  393. SCM_SETCDR (handle, scm_sum (SCM_CDR (handle), scm_from_int (1)));
  394. protected_obj_count ++;
  395. SCM_CRITICAL_SECTION_END;
  396. return obj;
  397. }
  398. /* Remove any protection for OBJ established by a prior call to
  399. scm_protect_object. This function returns OBJ.
  400. See scm_protect_object for more information. */
  401. SCM
  402. scm_gc_unprotect_object (SCM obj)
  403. {
  404. SCM handle;
  405. /* This critical section barrier will be replaced by a mutex. */
  406. /* njrev: and again. */
  407. SCM_CRITICAL_SECTION_START;
  408. if (scm_gc_running_p)
  409. {
  410. fprintf (stderr, "scm_unprotect_object called during GC.\n");
  411. abort ();
  412. }
  413. handle = scm_hashq_get_handle (scm_protects, obj);
  414. if (scm_is_false (handle))
  415. {
  416. fprintf (stderr, "scm_unprotect_object called on unprotected object\n");
  417. abort ();
  418. }
  419. else
  420. {
  421. SCM count = scm_difference (SCM_CDR (handle), scm_from_int (1));
  422. if (scm_is_eq (count, scm_from_int (0)))
  423. scm_hashq_remove_x (scm_protects, obj);
  424. else
  425. SCM_SETCDR (handle, count);
  426. }
  427. protected_obj_count --;
  428. SCM_CRITICAL_SECTION_END;
  429. return obj;
  430. }
  431. void
  432. scm_gc_register_root (SCM *p)
  433. {
  434. /* Nothing. */
  435. }
  436. void
  437. scm_gc_unregister_root (SCM *p)
  438. {
  439. /* Nothing. */
  440. }
  441. void
  442. scm_gc_register_roots (SCM *b, unsigned long n)
  443. {
  444. SCM *p = b;
  445. for (; p < b + n; ++p)
  446. scm_gc_register_root (p);
  447. }
  448. void
  449. scm_gc_unregister_roots (SCM *b, unsigned long n)
  450. {
  451. SCM *p = b;
  452. for (; p < b + n; ++p)
  453. scm_gc_unregister_root (p);
  454. }
  455. /*
  456. MOVE THIS FUNCTION. IT DOES NOT HAVE ANYTHING TODO WITH GC.
  457. */
  458. /* Get an integer from an environment variable. */
  459. int
  460. scm_getenv_int (const char *var, int def)
  461. {
  462. char *end = 0;
  463. char *val = getenv (var);
  464. long res = def;
  465. if (!val)
  466. return def;
  467. res = strtol (val, &end, 10);
  468. if (end == val)
  469. return def;
  470. return res;
  471. }
  472. void
  473. scm_storage_prehistory ()
  474. {
  475. GC_all_interior_pointers = 0;
  476. GC_set_free_space_divisor (scm_getenv_int ("GC_FREE_SPACE_DIVISOR", 3));
  477. GC_INIT ();
  478. #if (! ((defined GC_VERSION_MAJOR) && (GC_VERSION_MAJOR >= 7))) \
  479. && (defined SCM_I_GSC_USE_PTHREAD_THREADS)
  480. /* When using GC 6.8, this call is required to initialize thread-local
  481. freelists (shouldn't be necessary with GC 7.0). */
  482. GC_init ();
  483. #endif
  484. GC_expand_hp (SCM_DEFAULT_INIT_HEAP_SIZE_2);
  485. /* We only need to register a displacement for those types for which the
  486. higher bits of the type tag are used to store a pointer (that is, a
  487. pointer to an 8-octet aligned region). For `scm_tc3_struct', this is
  488. handled in `scm_alloc_struct ()'. */
  489. GC_REGISTER_DISPLACEMENT (scm_tc3_cons);
  490. /* GC_REGISTER_DISPLACEMENT (scm_tc3_unused); */
  491. /* Sanity check. */
  492. if (!GC_is_visible (&scm_protects))
  493. abort ();
  494. scm_c_hook_init (&scm_before_gc_c_hook, 0, SCM_C_HOOK_NORMAL);
  495. scm_c_hook_init (&scm_before_mark_c_hook, 0, SCM_C_HOOK_NORMAL);
  496. scm_c_hook_init (&scm_before_sweep_c_hook, 0, SCM_C_HOOK_NORMAL);
  497. scm_c_hook_init (&scm_after_sweep_c_hook, 0, SCM_C_HOOK_NORMAL);
  498. scm_c_hook_init (&scm_after_gc_c_hook, 0, SCM_C_HOOK_NORMAL);
  499. }
  500. scm_i_pthread_mutex_t scm_i_gc_admin_mutex = SCM_I_PTHREAD_MUTEX_INITIALIZER;
  501. void
  502. scm_init_gc_protect_object ()
  503. {
  504. scm_protects = scm_c_make_hash_table (31);
  505. #if 0
  506. /* We can't have a cleanup handler since we have no thread to run it
  507. in. */
  508. #ifdef HAVE_ATEXIT
  509. atexit (cleanup);
  510. #else
  511. #ifdef HAVE_ON_EXIT
  512. on_exit (cleanup, 0);
  513. #endif
  514. #endif
  515. #endif
  516. }
  517. SCM scm_after_gc_hook;
  518. static SCM after_gc_async_cell;
  519. /* The function after_gc_async_thunk causes the execution of the
  520. * after-gc-hook. It is run after the gc, as soon as the asynchronous
  521. * events are handled by the evaluator.
  522. */
  523. static SCM
  524. after_gc_async_thunk (void)
  525. {
  526. /* Fun, no? Hook-run *and* run-hook? */
  527. scm_c_hook_run (&scm_after_gc_c_hook, NULL);
  528. scm_c_run_hook (scm_after_gc_hook, SCM_EOL);
  529. return SCM_UNSPECIFIED;
  530. }
  531. /* The function queue_after_gc_hook is run by the scm_before_gc_c_hook
  532. * at the end of the garbage collection. The only purpose of this
  533. * function is to mark the after_gc_async (which will eventually lead to
  534. * the execution of the after_gc_async_thunk).
  535. */
  536. static void *
  537. queue_after_gc_hook (void * hook_data SCM_UNUSED,
  538. void *fn_data SCM_UNUSED,
  539. void *data SCM_UNUSED)
  540. {
  541. /* If cell access debugging is enabled, the user may choose to perform
  542. * additional garbage collections after an arbitrary number of cell
  543. * accesses. We don't want the scheme level after-gc-hook to be performed
  544. * for each of these garbage collections for the following reason: The
  545. * execution of the after-gc-hook causes cell accesses itself. Thus, if the
  546. * after-gc-hook was performed with every gc, and if the gc was performed
  547. * after a very small number of cell accesses, then the number of cell
  548. * accesses during the execution of the after-gc-hook will suffice to cause
  549. * the execution of the next gc. Then, guile would keep executing the
  550. * after-gc-hook over and over again, and would never come to do other
  551. * things.
  552. *
  553. * To overcome this problem, if cell access debugging with additional
  554. * garbage collections is enabled, the after-gc-hook is never run by the
  555. * garbage collecter. When running guile with cell access debugging and the
  556. * execution of the after-gc-hook is desired, then it is necessary to run
  557. * the hook explicitly from the user code. This has the effect, that from
  558. * the scheme level point of view it seems that garbage collection is
  559. * performed with a much lower frequency than it actually is. Obviously,
  560. * this will not work for code that depends on a fixed one to one
  561. * relationship between the execution counts of the C level garbage
  562. * collection hooks and the execution count of the scheme level
  563. * after-gc-hook.
  564. */
  565. #if (SCM_DEBUG_CELL_ACCESSES == 1)
  566. if (scm_debug_cells_gc_interval == 0)
  567. #endif
  568. {
  569. scm_i_thread *t = SCM_I_CURRENT_THREAD;
  570. if (scm_is_false (SCM_CDR (after_gc_async_cell)))
  571. {
  572. SCM_SETCDR (after_gc_async_cell, t->active_asyncs);
  573. t->active_asyncs = after_gc_async_cell;
  574. t->pending_asyncs = 1;
  575. }
  576. }
  577. return NULL;
  578. }
  579. static void *
  580. start_gc_timer (void * hook_data SCM_UNUSED,
  581. void *fn_data SCM_UNUSED,
  582. void *data SCM_UNUSED)
  583. {
  584. if (!gc_start_time)
  585. gc_start_time = scm_c_get_internal_run_time ();
  586. return NULL;
  587. }
  588. static void *
  589. accumulate_gc_timer (void * hook_data SCM_UNUSED,
  590. void *fn_data SCM_UNUSED,
  591. void *data SCM_UNUSED)
  592. {
  593. if (gc_start_time)
  594. { long now = scm_c_get_internal_run_time ();
  595. gc_time_taken += now - gc_start_time;
  596. gc_start_time = 0;
  597. }
  598. return NULL;
  599. }
  600. char const *
  601. scm_i_tag_name (scm_t_bits tag)
  602. {
  603. switch (tag & 0x7f) /* 7 bits */
  604. {
  605. case scm_tcs_struct:
  606. return "struct";
  607. case scm_tcs_cons_imcar:
  608. return "cons (immediate car)";
  609. case scm_tcs_cons_nimcar:
  610. return "cons (non-immediate car)";
  611. case scm_tc7_pointer:
  612. return "foreign";
  613. case scm_tc7_hashtable:
  614. return "hashtable";
  615. case scm_tc7_weak_set:
  616. return "weak-set";
  617. case scm_tc7_weak_table:
  618. return "weak-table";
  619. case scm_tc7_fluid:
  620. return "fluid";
  621. case scm_tc7_dynamic_state:
  622. return "dynamic state";
  623. case scm_tc7_frame:
  624. return "frame";
  625. case scm_tc7_objcode:
  626. return "objcode";
  627. case scm_tc7_vm:
  628. return "vm";
  629. case scm_tc7_vm_cont:
  630. return "vm continuation";
  631. case scm_tc7_wvect:
  632. return "weak vector";
  633. case scm_tc7_vector:
  634. return "vector";
  635. case scm_tc7_number:
  636. switch (tag)
  637. {
  638. case scm_tc16_real:
  639. return "real";
  640. break;
  641. case scm_tc16_big:
  642. return "bignum";
  643. break;
  644. case scm_tc16_complex:
  645. return "complex number";
  646. break;
  647. case scm_tc16_fraction:
  648. return "fraction";
  649. break;
  650. }
  651. break;
  652. case scm_tc7_string:
  653. return "string";
  654. break;
  655. case scm_tc7_stringbuf:
  656. return "string buffer";
  657. break;
  658. case scm_tc7_symbol:
  659. return "symbol";
  660. break;
  661. case scm_tc7_variable:
  662. return "variable";
  663. break;
  664. case scm_tc7_port:
  665. return "port";
  666. break;
  667. case scm_tc7_smob:
  668. {
  669. int k = 0xff & (tag >> 8);
  670. return (scm_smobs[k].name);
  671. }
  672. break;
  673. }
  674. return NULL;
  675. }
  676. void
  677. scm_init_gc ()
  678. {
  679. /* `GC_INIT ()' was invoked in `scm_storage_prehistory ()'. */
  680. scm_after_gc_hook = scm_make_hook (SCM_INUM0);
  681. scm_c_define ("after-gc-hook", scm_after_gc_hook);
  682. /* When the async is to run, the cdr of the gc_async pair gets set to
  683. the asyncs queue of the current thread. */
  684. after_gc_async_cell = scm_cons (scm_c_make_gsubr ("%after-gc-thunk", 0, 0, 0,
  685. after_gc_async_thunk),
  686. SCM_BOOL_F);
  687. scm_c_hook_add (&scm_before_gc_c_hook, queue_after_gc_hook, NULL, 0);
  688. scm_c_hook_add (&scm_before_gc_c_hook, start_gc_timer, NULL, 0);
  689. scm_c_hook_add (&scm_after_gc_c_hook, accumulate_gc_timer, NULL, 0);
  690. #ifdef HAVE_GC_SET_START_CALLBACK
  691. GC_set_start_callback (run_before_gc_c_hook);
  692. #endif
  693. #include "libguile/gc.x"
  694. }
  695. void
  696. scm_gc_sweep (void)
  697. #define FUNC_NAME "scm_gc_sweep"
  698. {
  699. /* FIXME */
  700. fprintf (stderr, "%s: doing nothing\n", FUNC_NAME);
  701. }
  702. #undef FUNC_NAME
  703. /*
  704. Local Variables:
  705. c-file-style: "gnu"
  706. End:
  707. */