The use of `PyStackRef_AsPyObjectBorrow` makes it hard to track ownership of references, making analysis of escaping calls too difficult
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 35.9k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
The problem with PyStackRef_AsPyObjectBorrow is that it is not clear whether the reference is owned by the stack ref or the pointer.
Borrowing references across calls is fine but in less structured code, it is error prone and very hard to analyze.
The solution is change most, ideally all, uses of PyStackRef_AsPyObjectBorrow to PyStackRef_AsPyObjectSteal so that the ownership of the reference is clear.
E.g.
inst(UNARY_NEGATIVE, (value -- res)) {
PyObject *val_o = PyStackRef_AsPyObjectBorrow(value);
PyObject *res_o = PyNumber_Negative(val_o);
PyStackRef_CLOSE(value);
ERROR_IF(res_o == NULL, error);
res = PyStackRef_FromPyObjectSteal(res_o);
}
would become:
inst(UNARY_NEGATIVE, (value -- res)) {
PyObject *val_o = PyStackRef_AsPyObjectSteal(value);
PyObject *res_o = PyNumber_Negative(val_o);
Py_DECREF(val_o);
ERROR_IF(res_o == NULL, error);
res = PyStackRef_FromPyObjectSteal(res_o);
}
This ensures that during the escaping call to PyNumber_Negative, the reference to the value a PyObject *, so will not be reclaimed by the garbage collector.
Linked PRs
- gh-122037
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Durchsuche den CPython-Quellcode nach Verwendungen von PyStackRef_AsPyObjectBorrow und überprüfe die im Issue gezeigten Ownership-Muster von PyStackRef_AsPyObjectSteal und PyStackRef_CLOSE. Bestimme, welche Verwendungen Aufrufe überqueren können, bei denen Referenzen entkommen können, und verifiziere anschließend, dass die relevanten Referenzen gültig bleiben und die Ownership explizit ist; vergleiche die Arbeit mit dem verknüpften PR gh-122037.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- c, python
- Bereich
- backend
- Issue-Typ
- Refactoring
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100