-
Notifications
You must be signed in to change notification settings - Fork 1.4k
[Python] Set memory policy to "strict" #13593
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
base: master
Are you sure you want to change the base?
Conversation
7b2132c to
a2fe3d5
Compare
a2fe3d5 to
f3aa24f
Compare
f3aa24f to
b147011
Compare
b7f0c8f to
4eadd14
Compare
819ccd4 to
bb5d158
Compare
|
restarted all builds due to the issues with the server serving files for the tests. |
bb5d158 to
2141d65
Compare
d509a93 to
1833321
Compare
1833321 to
05f4dd0
Compare
05f4dd0 to
262a8b4
Compare
vepadulano
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm coming back to this old PR, I still agree with my previous statement that this is the right direction, but I see more potential misunderstandings and issues creeping up. I'm thinking about approaches we could employ to mitigate them, e.g. by running also these changes in CMSSW CI, or by thinking about more Pythonizations to include (e.g. in TList), or by thinking about if we can add more warnings for users in situations that lead to dangling pointers.
Also, a question that becomes more important now, are all of these changes still required in light of the recent and future improvements to the cppyy we use?
bindings/pyroot/pythonizations/python/ROOT/_pythonization/_roofit/_rooabspdf.py
Outdated
Show resolved
Hide resolved
| c = ROOT.TList() | ||
| pylist = [] | ||
| for _ in range(self.num_elems): | ||
| o = ROOT.TObject() | ||
| # Prevent immediate deletion of C++ TObjects | ||
| ROOT.SetOwnership(o, False) | ||
| c.Add(o) | ||
| pylist.append(o) | ||
|
|
||
| # To prevent memory leaks | ||
| c._owned_objects = pylist |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These few lines seem overly complicated: do we need both the SetOwnership and the extra attribute lifeline? Will this surface in real user code or is it a contrived example just for the test?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, we don't need to release the ownership here. The lifeline is enough.
| # A TList is by default non-owning. To make sure that the objects live | ||
| # long enough, we attach then as an attribute of the output list, such | ||
| # that the Python reference counter doesn't hit zero. | ||
| sc.owning_pylist = sc_pylist |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sounds counter-intuitive for a Python user, shall we perhaps discuss making it part of a TList pythonization?
README/ReleaseNotes/v636/index.md
Outdated
| **Note:** You can change back to the old policy by calling | ||
| `ROOT.SetMemoryPolicy(ROOT.kMemoryHeuristics)` after importing ROOT, but this | ||
| should be only used for debugging purposes and this function might be removed | ||
| in the future! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should make this perhaps explicit at usage by also raising a warning from the function when calling it.
262a8b4 to
d0e71c7
Compare
|
Hi @vepadulano, thanks for coming back to this! Let's try to make progress then and merge this soon 🙂
Good points. I'll address them once we see where we stand with a fresh CI run.
The upcoming cppyy rebase on libinterop is more happening in the backend, and we have no frontend development lined up that change the behavior of these memory heuristics. But what we should consider is that it's better to not change both backend and frontend too much in one release, because it makes potential regressions harder to fix. If we assume that the backend upgrade will hit in 6.42, then this means the best time to update the memory policy is now for 6.40. Otherwise, it would be wiser to wait for 6.44, but this is quite far away. |
630a6ca to
8c11bac
Compare
The ROOT Python interfaces have many memory leaks, which is a major pain point for people using it for long-running scripts in batch jobs. One source of memory leaks was indentified to be the "heuristic memory policy" of cppyy. This means that cppyy assumes that every non-const pointer member function argument was interpreted as the object taking ownership if the argument. For examle, take the non-owning RooLinkedList container. It has a `RooLinkedList::Add(RooAbsArg *arg)` method. ROOT wrongly assumes that this means the RooLinkedList takes ownership of arg, and it drops the ROOT overship. Nobody feels responsible for deleting the object anymore, and there is a memory leak or `arg`. That particular leak was reported in this forum post: https://root-forum.cern.ch/t/memory-leak-in-fits/56249 Function parameters of type `T *` are very common in ROOT, and only rarely do they imply ownership transfer. So changing the memory policy to "strict" would surely fix also many other memory leaks that are not reported so far. In fact, upstream cppyy doesn't even have this heuristic memory policy anymore! So moving ROOT also to the strict memory policy closes the gap between ROOT and cppyy. The potential drawback of this change are crashes in usercode if memory is not properly managed. But these problems should either be fixed by: * the user * dedicated pythonizations for these methods to manage shared ownership via Python reference counters (i.e., setting the parameter as an attribute of the object that the member function was called on) This follows up on PR root-project#4294, in particular it reverts 3a12063.
8c11bac to
18dd852
Compare
The ROOT Python interfaces have many memory leaks, which is a major pain
point for people using it for long-running scripts in batch jobs.
One source of memory leaks was indentified to be the "heuristic memory
policy" of cppyy. This means that cppyy assumes that every non-const
pointer member function argument was interpreted as the object taking
ownership if the argument.
For examle, take the non-owning RooLinkedList container. It has a
RooLinkedList::Add(RooAbsArg *arg)method. ROOT wrongly assumes thatthis means the RooLinkedList takes ownership of arg, and it drops the
ROOT overship. Nobody feels responsible for deleting the object
anymore, and there is a memory leak or
arg.That particular leak was reported in this forum post:
https://root-forum.cern.ch/t/memory-leak-in-fits/56249
Function parameters of type
T *are very common in ROOT, and onlyrarely do they imply ownership transfer. So changing the memory policy
to "strict" would surely fix also many other memory leaks that are not
reported so far. In fact, upstream cppyy doesn't even have this
heuristic memory policy anymore! So moving ROOT also to the strict
memory policy closes the gap between ROOT and cppyy.
The potential drawback of this change are crashes in usercode if memory
is not properly managed. But these problems should either be fixed by:
the user
dedicated pythonizations for these methods to manage shared
ownership via Python reference counters (i.e., setting the parameter
as an attribute of the object that the member function was called
on)
This follows up on PR #4294, in particular it reverts guitargeek@3a12063.