Github/emacs
2
0
Fork 1
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-16 17:24:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

* etc/DEBUG: Document debugging the igc

Browse source
This commit is contained in:
Jeremy Bryant 2025-03-08 13:34:51 +00:00 committed by Pip Cet
parent d488239a2e
commit 856446ab05
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
etc/DEBUG
View file

@ -1364,6 +1364,32 @@ subsequent to which a reproduction of the exception precipitating the
spurious OOM error should be located. This exception is invariably
indicative of a bug within Emacs that should be fixed.
** Debugging Emacs with Incremental Garbage Collector (igc)
The Emacs incremental garbage collector (igc), relies on the C library
by Ravenbrook Limited, the Memory Pool System (MPS). It is copyrighted
under the 2-clause BSD license.
Debugging memory management errors can be complex.
The following is explained in the MPS documentation from Ravenbrook.
See also the Info manual:
(info "(MemoryPoolSystem) Debugging with the Memory Pool System")
The key abstraction is the concept of memory `arena', which has four
states. Two of these are important for debugging, the clamped and
parked states. When debugging igc, you can clamp the arena before
inspecting memory:
(gdb) call mps_arena_clamp(arena)
and then release it afterwards with:
(gdb) call mps_arena_release(arena)
This file is part of GNU Emacs.