Adjust the refcounts to avoid Mutex leak #6231
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses issue #5777.
After talking with @traeak a few days ago, staring at the code for a day, and talking with @SolidWallOfCode, I think I understand what is going on. The problem is that we are treating ProxyMutex objects as referenced counted smart pointers from within the INKContInternal objects, but we are also treating them as not-smart pointers via the C Plugin interface TSMutexCreate, TSMutexLock, TSMutexUnlock, and TSMutexDestroy.
@traeak identified the commit from PR #4926 as the cause of the leak. That PR was cleaning up the various mutex lock/unlock methods and added refcount increment decrement to TSMutexCreate/Destroy to try to make things uniformly reference counted. However, with that change, the ProxyMutex's created by TSMutexCreate and passed to TSContCreate would never be deleted, because the stand-alone TSMutexDestroy was never called to decrement the last reference count.
This PR
This is not the optimal solution, but good enough for release 9. A more consistent solution would likely require more changes in plugin code. I will leave discussion for that to another thread.