Skip to content

Avoid leaking module object on numpy C-API import failure #263

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

Open
antonwolfy wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −3
Open

Avoid leaking module object on numpy C-API import failure #263

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions mkl_umath/src/ufuncsmodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,11 @@ PyMODINIT_FUNC PyInit__ufuncs(void)
PyObject *m;
PyObject *d;

/* import_array()/import_umath() expand to `return NULL;` on failure, so
* call them before creating the module object to avoid leaking it. */
Comment on lines +43 to +44

@ndgrigorian ndgrigorian Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if these return NULL, why would the module object leak? It's not clear to me, we don't check if the imports are NULL anywhere either

@antonwolfy antonwolfy Aug 31, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There will be leak (if any import_array()/import_umath() failed and call return NULL) if calls placed after m = PyModule_Create(&_ufuncs_module); since no Py_XDECREF(m)

@ndgrigorian ndgrigorian Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see, these functions are macros internally in NumPy which expand to 'return NULL' or 'return' respectively, so it actually crashes later or unexpectedly

@ndgrigorian ndgrigorian Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assumed it was using PyImport_ImportModule. In that case, maybe make the comment a bit clearer for future reference

import_array();
import_umath();

m = PyModule_Create(&_ufuncs_module);
if (m == NULL)
return NULL;
Expand All @@ -50,9 +55,6 @@ PyMODINIT_FUNC PyInit__ufuncs(void)
return NULL;
}

import_array();
import_umath();

if (InitOperators(d) < 0) {
Py_XDECREF(d);
Py_XDECREF(m);
Expand Down
Loading