Skip to content

Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan information #136790

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.

Sign up for GitHub

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 3 commits into from
Jul 19, 2025
Merged

Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan information #136790

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f41ecdd
Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan informa…
disconnect3d Jul 19, 2025
7659c24
Update Doc/c-api/memory.rst
encukou Jul 19, 2025
d3483fc
Improve --with-address-sanitizer and pymalloc docs
disconnect3d Jul 19, 2025
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
7 changes: 7 additions & 0 deletions Doc/c-api/memory.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -672,6 +672,13 @@ This allocator is disabled if Python is configured with the
:option:`--without-pymalloc` option. It can also be disabled at runtime using
the :envvar:`PYTHONMALLOC` environment variable (ex: ``PYTHONMALLOC=malloc``).

Typically, it makes sense to disable the pymalloc allocator when building
Python with AddressSanitizer (ASan) which helps uncover low level bugs within
the C code. While pymalloc doesn't break under ASan, the ASan works more
effectively with the system allocator (since we do not add any padding in
between the objects managed/allocated by pymalloc and we do not annotate/poison
the "inaccessible" memory between the pymalloc allocated objects).

Customize pymalloc Arena Allocator
----------------------------------

Expand Down
Loading