You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
ctypes: We do not correctly handle NULL dlsym() return values #126554
In unusual cases (see NOTES) the value of the symbol could actually be
NULL. Therefore, a NULL return from dlsym() need not indicate an error.
The correct way to distinguish an error from a symbol whose value is NULL
is to call dlerror(3) to clear any old error conditions, then call dl‐
sym(), and then call dlerror(3) again, saving its return value into a
variable, and check whether this saved value is not NULL.
As such, there can be cases where a call to dlsym returns NULL, while no error has been encountered and the string that dlerror() returns has not been (re)set.
Create a file named foo.c with the following contents:
#include <stdio.h>
/* This is a 'GNU indirect function' (IFUNC) that will be called by
dlsym() to resolve the symbol "foo" to an address. Typically, such
a function would return the address of an actual function, but it
can also just return NULL. For some background on IFUNCs, see
https://willnewton.name/uncategorized/using-gnu-indirect-functions/ */
asm (".type foo, @gnu_indirect_function");
void *
foo(void)
{
fprintf(stderr, "foo called\n");
return NULL;
}
Create a file named main.c with the following contents:
When using ctypes to search for symbol foo in libfoo.so we get a Segmentation Fault.
(Tested on Python 3.10 from my system, as well as one built from main.)
python3 -c 'import ctypes; C = ctypes.CDLL("./libfoo.so"); C.foo'
foo called
Segmentation fault (core dumped)
With the interpreter built from my PR we instead get:
./python -c 'import ctypes; C = ctypes.CDLL("./libfoo.so"); C.foo'
foo called
Traceback (most recent call last):
File "<string>", line 1, in <module>
import ctypes; C = ctypes.CDLL("./libfoo.so"); C.foo
^^^^^
File "/home/grg/a-lab/cpython/Lib/ctypes/__init__.py", line 415, in __getattr__
func = self.__getitem__(name)
File "/home/grg/a-lab/cpython/Lib/ctypes/__init__.py", line 420, in __getitem__
func = self._FuncPtr((name_or_ordinal, self))
AttributeError: function 'foo' not found
When using ctypes to search for symbol foo in libfoo.so we get a Segmentation Fault.
[...]
So this turned out to be a bug after all!
Well, when a symbol you asked for points to uninitialized memory (like a NULL), a segfault seems rather reasonable to me. (Granted, it does happen for the wrong reasons.)
Treating NULL specially could possibly be considered a feature, rather than a bug.
Given how hard this is to reproduce, I wouldn't mind having the fix to 3.14 only, and omitting the backports.
Activity
efimov-mikhail commentedon Nov 7, 2024
Is it actually a bug?
Can we make a repro?
grgalex commentedon Nov 7, 2024
EDIT: See Reproducer below.
grgalex commentedon Nov 7, 2024
I managed to create a reproducer using Indirect Functions (IFUNCS) by adapting this SO answer: https://stackoverflow.com/a/53590014
foo.cwith the following contents:main.cwith the following contents:foo.cinto a shared library namedlibfoo.so:mainexecutable:main:grgalex commentedon Nov 7, 2024
When using
ctypesto search for symbolfooin libfoo.so we get a Segmentation Fault.(Tested on Python 3.10 from my system, as well as one built from
main.)So this turned out to be a bug after all!
grgalex commentedon Nov 7, 2024
With the interpreter built from my PR we instead get:
grgalex commentedon Nov 7, 2024
cc: @efimov-mikhail
grgalex commentedon Nov 8, 2024
Fun fact:
The StackOverflow answer, which I adapted to form the reproducer is actually written by Michael Kerrisk [1].
So, he was the one who came up to clarify his statements in the man page, when noone else {c,w}ould :)
[1] https://en.wikipedia.org/wiki/Michael_Kerrisk
gh-126554: ctypes: Correctly handle NULL dlsym values (GH-126555)
pythongh-126554: ctypes: Correctly handle NULL dlsym values (pythonGH…
encukou commentedon Nov 15, 2024
Thanks @grgalex for the fix, and @ZeroIntensity & @picnixz for the thorough reviews!
Well, when a symbol you asked for points to uninitialized memory (like a NULL), a segfault seems rather reasonable to me. (Granted, it does happen for the wrong reasons.)
Treating NULL specially could possibly be considered a feature, rather than a bug.
Given how hard this is to reproduce, I wouldn't mind having the fix to 3.14 only, and omitting the backports.
[3.13] gh-126554: ctypes: Correctly handle NULL dlsym values (GH-126555…
pythongh-126554: ctypes: Correctly handle NULL dlsym values (pythonGH…
[3.12] gh-126554: ctypes: Correctly handle NULL dlsym values (GH-126555…
pythongh-126554: ctypes: Correctly handle NULL dlsym values (pythonGH…
gh-126554: correct detection of `gcc` for `TestNullDlsym.test_null_dl…
pythongh-126554: correct detection of `gcc` for `TestNullDlsym.test_n…
pythongh-126554: correct detection of `gcc` for `TestNullDlsym.test_n…
[3.12] gh-126554: correct detection of `gcc` for `TestNullDlsym.test_…
[3.13] gh-126554: correct detection of `gcc` for `TestNullDlsym.test_…