gh-143632: Detect availability of PR_SET_VMA at runtime (fixes build with musl libc)#148771
gh-143632: Detect availability of PR_SET_VMA at runtime (fixes build with musl libc)#148771sideeffect42 wants to merge 1 commit intopython:mainfrom
PR_SET_VMA at runtime (fixes build with musl libc)#148771Conversation
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
248dbf9 to
4dcdecf
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
…ibc)
The build would fail on musl-based systems with the following error:
gcc -c -fno-strict-overflow -Wsign-compare -DNDEBUG -g -O3 -Wall -std=c11 -Wextra -Wno-unused-parameter -Wno-missing-field-initializers -Wstrict-prototypes -Werror=implicit-function-declaration -fvisibility=hidden -I./Include/internal -I./Include/internal/mimalloc -I. -I./Include -DPy_BUILD_CORE -o Objects/obmalloc.o Objects/obmalloc.c
In file included from ./Include/internal/pycore_mmap.h:16,
from Objects/obmalloc.c:5:
/usr/include/sys/prctl.h:88:8: error: redefinition of 'struct prctl_mm_map'
88 | struct prctl_mm_map {
| ^~~~~~~~~~~~
In file included from ./Include/internal/pycore_mmap.h:15:
/usr/include/linux/prctl.h:134:8: note: originally defined here
134 | struct prctl_mm_map {
| ^~~~~~~~~~~~
make: *** [Makefile:3388: Objects/obmalloc.o] Error 1
This is due to Python including both <linux/prctl.h> and <sys/prctl.h> (which on
glibc imports the definitions from <linux/prctl.h> and on musl includes all the
definitions itself).
Given that Python is not the Linux kernel, <sys/prctl.h> should be included.
Another issue of the previous implementation and the configure check was that
the `_PyAnnotateMemoryMap()` function would only be enabled if the linux-headers
on the build host are recent enough to contain the `PR_SET_VMA_ANON_NAME` macro.
However the resulting binaries might be run on older kernels lacking the
functionality or be built on older systems but run on newer kernels.
With this patch, the function is always enabled and the magic numbers are
included with Python, so that the `prctl()` is always executed and
feature detection is essentially done at runtime.
When run on a kernel too old to support `PR_SET_VMA_ANON_NAME`,
`mmap.mmap.set_name()` will silently do nothing.
When the kernel is new enough but `CONFIG_ANON_VMA_NAME` is not enabled,
`mmap.mmap.set_name()` will raise an `OSError`, e.g.:
>>> mm.set_name("hello")
Traceback (most recent call last):
File "<python-input-5>", line 1, in <module>
mm.set_name("hello")
~~~~~~~~~~~^^^^^^^^^
OSError: [Errno 22] Invalid argument
4dcdecf to
8ddb452
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
|
||
| #include "pycore_pystate.h" | ||
|
|
||
| #if defined(HAVE_PR_SET_VMA_ANON_NAME) && defined(__linux__) |
There was a problem hiding this comment.
I think that you should fix the detecting logic of HAVE_PR_SET_VMA_ANON_NAME not code itself.
There was a problem hiding this comment.
Why would I fix the detection logic to address a compile-time error in the actual implementation?
When you think about what this configure step actually does, you may notice that what we are detecting there has no real connection to reality.
The set of macro definitions in the two header files is either whatever the libc has copied from a random kernel version (<sys/prctl.h>) or whatever the version of the system's linux-headers package contains (<linux/prctl.h>).
Both of which don't have to match the kernel which will then actually run the interpreter in the future.
Say, the interpreter is compiled as part of the build chain of some distro which is then used as the base image for a Linux container.
The kernel on which this container may be run does not have to have anything in common with the kernel the distro in the base image usually ships.
What does this configure check tell us?
Further, the mere presence of #define HAVE_PR_SET_VMA_ANON_NAME in <linux/prctl.h> says nothing about whether the kernel has CONFIG_ANON_VMA_NAME enabled.
So Python could call prctl() on a kernel which does not support this feature.
Building latest Python 3.15.0a8+ on musl-based Linux fails with the following error:
This is due to Python including both
<linux/prctl.h>and<sys/prctl.h>(which on glibc imports the definitions from<linux/prctl.h>and on musl includes all the definitions itself).Given that Python is not the Linux kernel,
<sys/prctl.h>should be included.Another issue of the previous implementation and the configure check was that the
_PyAnnotateMemoryMap()function would only be enabled if the linux-headers on the build host are recent enough to contain thePR_SET_VMA_ANON_NAMEmacro.However the resulting binaries might be run on older kernels lacking the functionality or be built on older systems but run on newer kernels.
With this patch, the function is always enabled and the magic numbers are included with Python, so that the
prctl()is always executed and feature detection is essentially done at runtime.When run on a kernel too old to support
PR_SET_VMA_ANON_NAME,mmap.mmap.set_name()will silently do nothing.When the kernel is new enough but
CONFIG_ANON_VMA_NAMEis not enabled,mmap.mmap.set_name()will raise anOSError, e.g.: