Fix memleak when writer is closed prior to closing containers #303
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The writer's _pending_temp_entity_pool is moved over to _temp_entity_pool while transitioning from the symtab intercept state, when depth is zero. Prior to this commit if the writer was closed prior to that transition, the data pointed to by _pending_temp_entity_pool would be leaked. This commit adds checking during _ion_writer_free to ensure the pending temp entity pool is freed if needed, similar to how the temp entity pool is freed.
tgregg
reviewed
Jul 11, 2022
| writer->_pending_temp_entity_pool = NULL; | ||
| } | ||
|
|
||
| RETURN(__location_name__, __line__, __count__++, err); |
There was a problem hiding this comment.
Is this an intentional choice not to use iRETURN?
Should this just be a void function since it looks like it can't return anything but IERR_OK?
There was a problem hiding this comment.
Yea that was intentional. Since the fail label that iRETURN defines isn't used, using it over RETURN only adds to the warnings generated at build.
It could definitely be a void function. I maintained the signature that the other free functions had for writer members, but all of them could be converted to void since all 3 only return IERR_OK.
There was a problem hiding this comment.
Got it. So maybe we need a separate (and larger) task to get rid of unnecessary iRETURN usages, if we want to reduce warnings. Approving this PR.
tgregg
approved these changes
Jul 11, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue #, if available: None
Description of changes:
ION_WRITER's
_pending_temp_entity_poolis moved over to_temp_entity_poolwhile transitioning from the symtab intercept state, when depth is zero.If the writer was closed prior to that transition, the data pointed to by
_pending_temp_entity_poolwould be leaked. This PR adds a function to free the data, and checks during_ion_writer_freeto ensure the pending temp entity pool is freed if needed, similar to how the temp entity pool is freed.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.