Skip to content
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

Multiple reference leaks in curses error-branches #123290

Closed
picnixz opened this issue Aug 24, 2024 · 2 comments
Closed

Multiple reference leaks in curses error-branches #123290

picnixz opened this issue Aug 24, 2024 · 2 comments
Assignees
Labels
extension-modules C modules in the Modules dir type-bug An unexpected behavior, bug, or error

Comments

@picnixz
Copy link
Contributor

picnixz commented Aug 24, 2024

Bug report

Bug description:

In _cursesmodule.c, we have

#define SetDictInt(string,ch)                                           \
    do {                                                                \
        PyObject *o = PyLong_FromLong((long) (ch));                     \
        if (o && PyDict_SetItemString(ModDict, string, o) == 0)     {   \
            Py_DECREF(o);                                               \
        }                                                               \
    } while (0)

However, PyDict_SetItemString does not steal a reference. If the dict insertion fails for whatever reason, o must be decref, which is not the case here. Similarly, in PyInit__curses, a module object is explicitly created via PyModule_Create but is not decref if an error occurs:

m = PyModule_Create(&_cursesmodule);

There are also calls that are not checked against errors:

/* Make the version available */
v = PyBytes_FromString(PyCursesVersion);
PyDict_SetItemString(d, "version", v);
PyDict_SetItemString(d, "__version__", v);

Here, insertion is assumed to always succeed, but this may not be the case, in which case we shouldn't continue.

On the other hand, the PyCursesWindowType leaks since it's never cleared. While it does not matter if you exit the interpreter, I think it may matter if you just want to unload the module and continue with a normal execution.


There are also other bugs that are more generally related to error-handling where some pointers might be NULL but are used as if they were not NULL, e.g. #123913).

CPython versions tested on:

CPython main branch

Operating systems tested on:

Linux

Linked PRs

@picnixz picnixz added type-bug An unexpected behavior, bug, or error extension-modules C modules in the Modules dir labels Aug 24, 2024
@picnixz picnixz self-assigned this Aug 24, 2024
@picnixz picnixz changed the title Multiple error checks branches leak in curses Multiple reference leaks in curses Sep 3, 2024
@picnixz picnixz changed the title Multiple reference leaks in curses Multiple reference leaks in curses error-branches Sep 11, 2024
@picnixz
Copy link
Contributor Author

picnixz commented Sep 11, 2024

I'll keep the issue opened until we decide whether to backport the changes or not one by one, or in one go (there will be subsequent modifications on the curses module).

@vstinner
Copy link
Member

The code is old and nobody reported issues about ref leaks. IMO the change is too big to be backported. I don't think that it's worth it to backport it. I close the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
extension-modules C modules in the Modules dir type-bug An unexpected behavior, bug, or error
Projects
Status: Done
Development

No branches or pull requests

2 participants