Skip to content

CFTree: retain children and the context info - #51

Merged
fredkiefer merged 3 commits into
gnustep:masterfrom
DTW-Thalion:fix/cftree-retain-model
Aug 16, 2026
Merged

CFTree: retain children and the context info#51
fredkiefer merged 3 commits into
gnustep:masterfrom
DTW-Thalion:fix/cftree-retain-model

Conversation

@DTW-Thalion

@DTW-Thalion DTW-Thalion commented Jun 28, 2026

Copy link
Copy Markdown
Contributor

CFTree never took real ownership of anything:

  • CFTreeAppendChild()/CFTreeInsertSibling() called the child's context retain callback (passing the tree node, and a no-op for the default NULL context) instead of retaining the child, and CFTreePrependChild() retained nothing at all. A parent therefore did not keep its children alive; releasing a child before its parent left the parent with a dangling pointer (use-after-free when the tree was later traversed or finalized).

  • The context retain/release callbacks are meant to apply to the info pointer, but CFTreeCreate() never retained the info and CFTreeFinalize() passed the tree (not the info) to the release callback.

  • CFTreeFinalize()/CFTreeRemoveAllChildren() called CFTreeFinalize() directly on each child rather than releasing it, bypassing the normal reference count.

This retains children with CFRetain() when they are added and releases them with CFRelease() in CFTreeRemove(), CFTreeRemoveAllChildren() and CFTreeFinalize(); retains the info in CFTreeCreate() and releases the info (not the node) in CFTreeFinalize(); and fixes CFTreePrependChild() (set _lastChild to the new child) and CFTreeGetChildAtIndex() (stop at the end of the list). Regression tests added; verified leak-free and use-after-free-free under AddressSanitizer.

Note: this is a comprehensive CFTree memory-management fix. It is stacked on the CFTreeRemove() unlink fix, so the diff currently also includes that commit, and it supersedes the two smaller CFTree PRs (the CFTreePrependChild/CFTreeGetChildAtIndex null-dereference fixes and the CFTreeRemove unlink fix) — they can be closed in favour of this one, or this can be merged after them.

CFTree never took real ownership of anything:

  * CFTreeAppendChild()/CFTreeInsertSibling() called the child's *context*
    retain callback (passing the tree node, and a no-op for the default
    NULL context) instead of retaining the child, and CFTreePrependChild()
    retained nothing at all.  A parent therefore did not keep its children
    alive; releasing a child before its parent left the parent with a
    dangling pointer (use-after-free when the tree was later traversed or
    finalized).

  * The context retain/release callbacks are meant to apply to the info
    pointer, but CFTreeCreate() never retained the info and CFTreeFinalize()
    passed the tree (not the info) to the release callback.

  * CFTreeFinalize()/CFTreeRemoveAllChildren() called CFTreeFinalize()
    directly on each child rather than releasing it, bypassing the normal
    reference count.

Retain children with CFRetain() when they are added and release them with
CFRelease() in CFTreeRemove(), CFTreeRemoveAllChildren() and
CFTreeFinalize(); retain the info in CFTreeCreate() and release it (the
info, not the node) in CFTreeFinalize(); and fix CFTreePrependChild() to
set _lastChild to the new child and CFTreeGetChildAtIndex() to stop at the
end of the child list.  Adds regression tests (verified leak- and
use-after-free-free under AddressSanitizer).

Builds on the CFTreeRemove() unlink fix; supersedes the smaller CFTree
null-dereference and CFTreeRemove changes.
@fredkiefer
fredkiefer merged commit c729914 into gnustep:master Aug 16, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants