Skip to content

Add section about the design of CPython's garbage collector #562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
Jan 21, 2020
Merged
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
10ee4fd
Add section about the design of CPython's garbage collector
pablogsal Jan 20, 2020
8aac485
Fix several typos
pablogsal Jan 20, 2020
7776e14
Update garbage_collector.rst
pablogsal Jan 20, 2020
c72ce11
Fix more typos
pablogsal Jan 20, 2020
410487b
Update garbage_collector.rst
pablogsal Jan 20, 2020
b18da79
Update garbage_collector.rst
pablogsal Jan 20, 2020
25d7555
Apply suggestions from code review
pablogsal Jan 20, 2020
811235f
Fix more typos
pablogsal Jan 20, 2020
8b72c71
Update garbage_collector.rst
pablogsal Jan 20, 2020
3b84282
Update garbage_collector.rst
pablogsal Jan 20, 2020
0d3f322
Apply suggestions from code review
pablogsal Jan 21, 2020
d84a267
Apply suggestions from code review
pablogsal Jan 21, 2020
5ca46f7
Fix indentation and rework incomplete sentence
pablogsal Jan 21, 2020
404fcc5
Fix more indentation
pablogsal Jan 21, 2020
8fc0547
Rework sentence about _gc_prev
pablogsal Jan 21, 2020
e956478
Update garbage_collector.rst
pablogsal Jan 21, 2020
47190cd
Fix indentation
pablogsal Jan 21, 2020
722a99c
Fix quotes
pablogsal Jan 21, 2020
b40b030
Fix typo and indentation
pablogsal Jan 21, 2020
111b2bb
Update garbage_collector.rst
pablogsal Jan 21, 2020
2ec5002
Update garbage_collector.rst
pablogsal Jan 21, 2020
7c8e02a
Add author section
pablogsal Jan 21, 2020
e51d354
Add a warning section regarding tagged pointers
pablogsal Jan 21, 2020
411037f
Add reference to the memory layout
pablogsal Jan 21, 2020
4081607
Fix link to the generation section
pablogsal Jan 21, 2020
03178a0
Apply suggestions from code review
pablogsal Jan 21, 2020
6d01e46
Fix more typos
pablogsal Jan 21, 2020
4321593
Address Petr feedback and fix more typos
pablogsal Jan 21, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix typo and indentation
  • Loading branch information
pablogsal committed Jan 21, 2020
commit b40b030ba7e4fe744a98cfc8cbdb88267a1189cc
12 changes: 6 additions & 6 deletions garbage_collector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -399,12 +399,12 @@ word-aligned addresses end in ``000``, leaving the last 3 bits available.
The CPython GC makes use of two fat pointers:

* The ``_gc_prev``` field is normally used as the "previous" pointer to maintain the
doubly linked list but the lowest two bits of are used to keep some flags like
``PREV_MASK_COLLECTING`` and ``_PyGC_PREV_MASK_FINALIZED``. Between collections, the
only flag that can be present is ``_PyGC_PREV_MASK_FINALIZED`` that indicates if an
object has been already finalized. During collections ``_gc_prev`` is temporary
used for storing the temporary copy of the reference count (``gc_refs``), and the
GC linked list becomes a singly linked list until ``_gc_prev`` is restored.
doubly linked list but its lowest two bits are used to keep some flags like
``PREV_MASK_COLLECTING`` and ``_PyGC_PREV_MASK_FINALIZED``. Between collections,
the only flag that can be present is ``_PyGC_PREV_MASK_FINALIZED`` that indicates
if an object has been already finalized. During collections ``_gc_prev`` is
temporary used for storing the temporary copy of the reference count (``gc_refs``),
and the GC linked list becomes a singly linked list until ``_gc_prev`` is restored.

* The ``_gc_next`` field is used as the "next" pointer to maintain the doubly linked
list but during collection its lowest bit is used to keep the
Expand Down