summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorPhilippe Waroquiers <philippe.waroquiers@skynet.be>2019-02-12 14:02:48 +0100
committerTom Tromey <tromey@gcc.gnu.org>2019-02-12 13:02:48 +0000
commitf9f75f8d3cc4afb77c2e75c1e786810cdca920c3 (patch)
treebc94a11a30f45a52486ce30aeb3b950e48f9d1f4 /include
parentc4d5763224c7817ad5cb671e651e69b2708d49f0 (diff)
Fix splay tree KEY leak detected in GDB test gdb.base/macscp.exp
When a node is removed from a splay tree, the splay tree was not using the function splay_tree_delete_key_fn to release the key. This was causing a leak, fixed by Tom Tromey. This patch fixes another key leak, that happens when a key equal to a key already present is inserted. In such a case, we have to release the old KEY. Note that this is based on the assumption that the caller always allocates a new KEY when doing an insert. Also, clarify the documentation about when the release functions are called. 2019-02-11 Philippe Waroquiers <philippe.waroquiers@skynet.be> * splay-tree.h (splay_tree_delete_key_fn): Update comment. (splay_tree_delete_value_fn): Likewise. libiberty/ChangeLog 2019-02-11 Philippe Waroquiers <philippe.waroquiers@skynet.be> * splay-tree.c (splay_tree_insert): Also release old KEY in case of insertion of a key equal to an already present key. (splay_tree_new_typed_alloc): Update comment. From-SVN: r268793
Diffstat (limited to 'include')
-rw-r--r--include/ChangeLog5
-rw-r--r--include/splay-tree.h11
2 files changed, 14 insertions, 2 deletions
diff --git a/include/ChangeLog b/include/ChangeLog
index 8be8343a78e..be08141deeb 100644
--- a/include/ChangeLog
+++ b/include/ChangeLog
@@ -1,3 +1,8 @@
+2019-02-11 Philippe Waroquiers <philippe.waroquiers@skynet.be>
+
+ * splay-tree.h (splay_tree_delete_key_fn): Update comment.
+ (splay_tree_delete_value_fn): Likewise.
+
2019-01-09 Sandra Loosemore <sandra@codesourcery.com>
PR other/16615
diff --git a/include/splay-tree.h b/include/splay-tree.h
index 0d262729435..da533dec183 100644
--- a/include/splay-tree.h
+++ b/include/splay-tree.h
@@ -58,11 +58,18 @@ typedef struct splay_tree_node_s *splay_tree_node;
typedef int (*splay_tree_compare_fn) (splay_tree_key, splay_tree_key);
/* The type of a function used to deallocate any resources associated
- with the key. */
+ with the key. If you provide this function, the splay tree
+ will take the ownership of the memory of the splay_tree_key arg
+ of splay_tree_insert. This function is called to release the keys
+ present in the tree when calling splay_tree_delete or splay_tree_remove.
+ If splay_tree_insert is called with a key equal to a key already
+ present in the tree, the old key and old value will be released. */
typedef void (*splay_tree_delete_key_fn) (splay_tree_key);
/* The type of a function used to deallocate any resources associated
- with the value. */
+ with the value. If you provide this function, the memory of the
+ splay_tree_value arg of splay_tree_insert is managed similarly to
+ the splay_tree_key memory: see splay_tree_delete_key_fn. */
typedef void (*splay_tree_delete_value_fn) (splay_tree_value);
/* The type of a function used to iterate over the tree. */