gc.c 22 KB

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