Title: gh-159185: Fix marshalling of a set modified while its elements are marshalled by gpshead · Pull Request #159195 · python/cpython · GitHub
Open Graph Title: gh-159185: Fix marshalling of a set modified while its elements are marshalled by gpshead · Pull Request #159195 · python/cpython
X Title: gh-159185: Fix marshalling of a set modified while its elements are marshalled by gpshead · Pull Request #159195 · python/cpython
Description: To order the elements of a set, marshal marshals each element on its own. That can run Python code (an element's __buffer__(), an audit hook), and that code can change the set. The number of elements was read once, before the loop.
class Item:
def __hash__(self):
return 0
def __buffer__(self, flags):
s.update(range(1000, 1400)) # or: s.difference_update(range(1, 60))
return memoryview(b'abc')
s = {Item()}
s.update(range(1, 60))
marshal.dumps(s)
on main
release build
debug build
set grows
no error; writes past the end of the list
PyList_SET_ITEM: Assertion 'index < list->allocated' failed
set shrinks
segmentation fault
w_complex_object: Assertion `i == n' failed
With this PR both raise RuntimeError: set changed size during iteration, as iterating the set would.
Change
flowchart TB
subgraph before["main"]
direction TB
b1["n = size of the set"] --> b2["list of n slots"]
b2 --> b3["for each element:
marshal it (may run Python code)
store in slot i++"]
b3 -- "set grew" --> b4["writes past slot n"]
b3 -- "set shrank" --> b5["slots left NULL,
then sorted"]
end
subgraph after["this PR"]
direction TB
a1["n = size of the set"] --> a2["list of n slots"]
a2 --> a3["for each element:
stop if i == n
marshal it, store in slot i++"]
a3 --> a4{"stopped early,
or i != n?"}
a4 -- yes --> a5["RuntimeError"]
a4 -- no --> a6["sort and write"]
end
Loading
The change is two checks around the existing loop in w_complex_object(). On the free-threaded build the same checks cover another thread changing the set between the size being read and the critical section being entered. A set that is changed without changing its size is not detected; that is memory safe, and the output is whatever was iterated.
This touches the same block as the PR for gh-159184; whichever is merged second needs a one-line conflict resolved.
Tests
test_set_changed_size: grow and shrink, all marshal versions.
Issue: gh-159185
Open Graph Description: To order the elements of a set, marshal marshals each element on its own. That can run Python code (an element's __buffer__(), an audit hook), and that code can change the set. The number of ...
X Description: To order the elements of a set, marshal marshals each element on its own. That can run Python code (an element's __buffer__(), an audit hook), and that code can change the set. The number...
Opengraph URL: https://github.com/python/cpython/pull/159195
X: @github
Domain: github.com
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:c9007cfd-9abc-502a-e06e-de75b8b90672 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 8416:34DB8F:34F174E:46BE98A:6B0210D2 |
| html-safe-nonce | bd95846323e22e0120b17e5b0d7b5b534f02e37d029d105fdd6f9d47795b39e3 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NDE2OjM0REI4RjozNEYxNzRFOjQ2QkU5OEE6NkIwMjEwRDIiLCJ2aXNpdG9yX2lkIjoiNzg2Njc0Mzg5NDUwNjA4MjUxNCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 53127c1a854554830dbbab0c7caf5c9ba15f0760ad9ad51d1a4ef4ba40c8f21e |
| hovercard-subject-tag | pull_request:4822162720 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/python/cpython/pull/159195/files |
| twitter:image | https://avatars.githubusercontent.com/u/68491?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/68491?s=400&v=4 |
| og:image:alt | To order the elements of a set, marshal marshals each element on its own. That can run Python code (an element's __buffer__(), an audit hook), and that code can change the set. The number of ... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456 |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/python/cpython git https://github.com/python/cpython.git |
| octolytics-dimension-user_id | 1525981 |
| octolytics-dimension-user_login | python |
| octolytics-dimension-repository_id | 81598961 |
| octolytics-dimension-repository_nwo | python/cpython |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 81598961 |
| octolytics-dimension-repository_network_root_nwo | python/cpython |
| turbo-body-classes | logged-out env-production page-responsive full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 423dbb54c5e7bfecc838eb387c1435eb3d0e760d |
| ui-target | canary-1 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width