Fix object release memory leaks #30

rtheunissen · rtheunissen · commit e937fb5653b8 · 2016-08-04T05:36:13.000+12:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [1.1.1] - 2016-08-04
+### Fixed
+- Multiple memory leaks where objects were not free'd correctly. #30
+
 ## [1.1.0] - 2016-08-04
 ### Added
 - `Pair::copy`
@@ -16,7 +20,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - `Set::merge`
 
 ### Fixed
-- ds_htable_put_next bucket rehash fix (see docs #4)
+- ds_htable_put_next bucket rehash fix
 - 
 ## [1.0.2] - 2016-07-31
 ### Added
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/php-ds/extension.svg?branch=master)](https://travis-ci.org/php-ds/extension)
 [![Build status](https://ci.appveyor.com/api/projects/status/dbcssp6flml2gher?svg=true)](https://ci.appveyor.com/project/rtheunissen/extension)
-[![PECL](https://img.shields.io/badge/PECL-1.0.5-blue.svg)](https://pecl.php.net/package/ds)
+[![PECL](https://img.shields.io/badge/PECL-1.1.1-blue.svg)](https://pecl.php.net/package/ds)
 
 ## Documentation
 
diff --git a/package.xml b/package.xml
@@ -17,9 +17,9 @@
         <active>yes</active>
     </lead>
     <date>2016-08-04</date>
-    <time>05:02:13</time>
+    <time>05:35:40</time>
     <version>
-        <release>1.1.0</release>
+        <release>1.1.1</release>
         <api>1.1.0</api>
     </version>
     <stability>
@@ -28,7 +28,7 @@
     </stability>
     <license uri="https://opensource.org/licenses/MIT">MIT License</license>
     <notes>
-        Add Pair::copy
+        Fix memory leaks where objects were not free'd correctly
     </notes>
     <contents>
         <dir name="/">
diff --git a/php_ds.h b/php_ds.h
@@ -20,7 +20,7 @@ extern zend_module_entry ds_module_entry;
 #define phpext_ds_ptr &ds_module_entry
 
 /* Replace with version number for your extension */
-#define PHP_DS_VERSION "1.1.0"
+#define PHP_DS_VERSION "1.1.1"
 
 #ifdef PHP_WIN32
 #  define PHP_API __declspec(dllexport)
diff --git a/src/ds/ds_deque.c b/src/ds/ds_deque.c
@@ -194,10 +194,11 @@ void ds_deque_clear(ds_deque_t *deque)
     deque->size     = 0;
 }
 
-void ds_deque_destroy(ds_deque_t *deque)
+void ds_deque_free(ds_deque_t *deque)
 {
     ds_deque_clear(deque);
     efree(deque->buffer);
+    efree(deque);
 }
 
 /**
diff --git a/src/ds/ds_deque.h b/src/ds/ds_deque.h
@@ -37,7 +37,7 @@ ds_deque_t *ds_deque_clone(ds_deque_t *src);
 ds_deque_t *ds_deque_from_buffer(zval *buffer, zend_long size);
 
 void ds_deque_clear(ds_deque_t *deque);
-void ds_deque_destroy(ds_deque_t *deque);
+void ds_deque_free(ds_deque_t *deque);
 void ds_deque_allocate(ds_deque_t *deque, zend_long capacity);
 
 void ds_deque_push(ds_deque_t *deque, zval *value);
diff --git a/src/ds/ds_htable.c b/src/ds/ds_htable.c
@@ -473,7 +473,7 @@ void ds_htable_clear(ds_htable_t *table)
     table->next = 0;
 }
 
-void ds_htable_destroy(ds_htable_t *table)
+void ds_htable_free(ds_htable_t *table)
 {
     ds_htable_clear(table);
 
@@ -934,7 +934,7 @@ ds_htable_t *ds_htable_map(ds_htable_t *table, FCI_PARAMS)
         fci.retval      = &retval;
 
         if (zend_call_function(&fci, &fci_cache) == FAILURE || Z_ISUNDEF(retval)) {
-            ds_htable_destroy(clone);
+            ds_htable_free(clone);
             return NULL;
         } else {
             zval_ptr_dtor(&dst->value);
@@ -980,7 +980,7 @@ ds_htable_t *ds_htable_filter_callback(ds_htable_t *table, FCI_PARAMS)
         fci.retval      = &retval;
 
         if (zend_call_function(&fci, &fci_cache) == FAILURE || Z_ISUNDEF(retval)) {
-            ds_htable_destroy(filtered);
+            ds_htable_free(filtered);
             return NULL;
         } else {
             if (zend_is_true(&retval)) {
diff --git a/src/ds/ds_htable.h b/src/ds/ds_htable.h
@@ -176,7 +176,7 @@ bool ds_htable_has_value(ds_htable_t *h, zval *value);
 int  ds_htable_remove(ds_htable_t *h, zval *key, zval *return_value);
 void ds_htable_put(ds_htable_t *h, zval *key, zval *value);
 void ds_htable_to_array(ds_htable_t *h, zval *arr);
-void ds_htable_destroy(ds_htable_t *h);
+void ds_htable_free(ds_htable_t *h);
 zval *ds_htable_get(ds_htable_t *h, zval *key);
 ds_htable_t *ds_htable_slice(ds_htable_t *table, zend_long index, zend_long length);
 
diff --git a/src/ds/ds_map.c b/src/ds/ds_map.c
@@ -351,8 +351,8 @@ void ds_map_sum(ds_map_t *map, zval *return_value)
     DS_HTABLE_FOREACH_END();
 }
 
-void ds_map_destroy(ds_map_t *map)
+void ds_map_free(ds_map_t *map)
 {
-    ds_htable_destroy(map->table);
+    ds_htable_free(map->table);
     efree(map);
 }
diff --git a/src/ds/ds_map.h b/src/ds/ds_map.h
@@ -17,7 +17,7 @@ ds_map_t *ds_map();
 ds_map_t *ds_map_clone(ds_map_t *map);
 
 void ds_map_clear(ds_map_t *map);
-void ds_map_destroy(ds_map_t *map);
+void ds_map_free(ds_map_t *map);
 
 void ds_map_reverse(ds_map_t *map);
 ds_map_t *ds_map_reversed(ds_map_t *map);
diff --git a/src/ds/ds_pair.c b/src/ds/ds_pair.c
@@ -46,7 +46,7 @@ void ds_pair_to_array(ds_pair_t *pair, zval *array)
     Z_TRY_ADDREF_P(&pair->value);
 }
 
-void ds_pair_destroy(ds_pair_t *pair)
+void ds_pair_free(ds_pair_t *pair)
 {
     DTOR_AND_UNDEF(&pair->key);
     DTOR_AND_UNDEF(&pair->value);
diff --git a/src/ds/ds_pair.h b/src/ds/ds_pair.h
@@ -13,6 +13,6 @@ ds_pair_t *ds_pair_ex(zval *key, zval *value);
 ds_pair_t *ds_pair_clone(ds_pair_t *pair);
 
 void ds_pair_to_array(ds_pair_t *pair, zval *return_value);
-void ds_pair_destroy(ds_pair_t *pair);
+void ds_pair_free(ds_pair_t *pair);
 
 #endif
diff --git a/src/ds/ds_priority_queue.c b/src/ds/ds_priority_queue.c
@@ -251,7 +251,7 @@ void ds_priority_queue_clear(ds_priority_queue_t *queue)
     reallocate_to_capacity(queue, DS_PRIORITY_QUEUE_MIN_CAPACITY);
 }
 
-void ds_priority_queue_destroy(ds_priority_queue_t *queue)
+void ds_priority_queue_free(ds_priority_queue_t *queue)
 {
     ds_priority_queue_clear(queue);
     efree(queue->nodes);
diff --git a/src/ds/ds_priority_queue.h b/src/ds/ds_priority_queue.h
@@ -33,7 +33,7 @@ zval *ds_priority_queue_peek(ds_priority_queue_t *pq);
 void ds_priority_queue_pop(ds_priority_queue_t *pq, zval *return_value);
 void ds_priority_queue_push(ds_priority_queue_t *pq, zval *value, zend_long priority);
 void ds_priority_queue_to_array(ds_priority_queue_t *pq, zval *array);
-void ds_priority_queue_destroy(ds_priority_queue_t *pq);
+void ds_priority_queue_free(ds_priority_queue_t *pq);
 void ds_priority_queue_clear(ds_priority_queue_t *pq);
 ds_priority_queue_t *ds_priority_queue_clone(ds_priority_queue_t * pq);
 ds_priority_queue_node_t* ds_priority_queue_create_sorted_buffer(ds_priority_queue_t *pq);
diff --git a/src/ds/ds_queue.c b/src/ds/ds_queue.c
@@ -78,9 +78,10 @@ void ds_queue_pop(ds_queue_t *queue, zval *return_value)
     ds_deque_shift(queue->deque, return_value);
 }
 
-void ds_queue_destroy(ds_queue_t *queue)
+void ds_queue_free(ds_queue_t *queue)
 {
-    ds_deque_destroy(queue->deque);
+    ds_deque_free(queue->deque);
+    efree(queue);
 }
 
 zval *ds_queue_peek(ds_queue_t *queue)
diff --git a/src/ds/ds_queue.h b/src/ds/ds_queue.h
@@ -37,7 +37,7 @@ void  ds_queue_pop(ds_queue_t *queue, zval *return_value);
 zval *ds_queue_peek(ds_queue_t *queue);
 void  ds_queue_push_all(ds_queue_t *queue, zval *value);
 void  ds_queue_to_array(ds_queue_t *queue, zval *return_value);
-void  ds_queue_destroy(ds_queue_t *queue);
+void  ds_queue_free(ds_queue_t *queue);
 
 int ds_queue_serialize(zval *object, unsigned char **buffer, size_t *length, zend_serialize_data *data);
 int ds_queue_unserialize(zval *object, zend_class_entry *ce, const unsigned char *buffer, size_t length, zend_unserialize_data *data);
diff --git a/src/ds/ds_set.c b/src/ds/ds_set.c
@@ -271,9 +271,10 @@ void ds_set_clear(ds_set_t *set)
     ds_htable_clear(set->table);
 }
 
-void ds_set_destroy(ds_set_t *set)
+void ds_set_free(ds_set_t *set)
 {
-    ds_htable_destroy(set->table);
+    ds_htable_free(set->table);
+    efree(set);
 }
 
 void ds_set_reduce(ds_set_t *set, FCI_PARAMS, zval *initial, zval *return_value)
@@ -330,7 +331,7 @@ ds_set_t *ds_set_filter_callback(ds_set_t *set, FCI_PARAMS)
             fci.retval      = &retval;
 
             if (zend_call_function(&fci, &fci_cache) == FAILURE || Z_ISUNDEF(retval)) {
-                ds_set_destroy(filtered);
+                ds_set_free(filtered);
                 return NULL;
 
             //
diff --git a/src/ds/ds_set.h b/src/ds/ds_set.h
@@ -19,7 +19,7 @@ ds_set_t *ds_set();
 ds_set_t *ds_set_ex(ds_htable_t *table);
 ds_set_t *ds_set_clone(ds_set_t *set);
 
-void ds_set_destroy(ds_set_t *set);
+void ds_set_free(ds_set_t *set);
 void ds_set_clear(ds_set_t *set);
 void ds_set_allocate(ds_set_t *set, zend_long capacity);
 
diff --git a/src/ds/ds_stack.c b/src/ds/ds_stack.c
@@ -23,9 +23,10 @@ ds_stack_t *ds_stack_clone(ds_stack_t *stack)
     return ds_stack_ex(ds_vector_clone(stack->vector));
 }
 
-void ds_stack_destroy(ds_stack_t *stack)
+void ds_stack_free(ds_stack_t *stack)
 {
-    ds_vector_destroy(stack->vector);
+    ds_vector_free(stack->vector);
+    efree(stack);
 }
 
 void ds_stack_allocate(ds_stack_t *stack, zend_long capacity)
diff --git a/src/ds/ds_stack.h b/src/ds/ds_stack.h
@@ -42,6 +42,6 @@ void  ds_stack_pop(ds_stack_t *stack, zval *return_value);
 zval *ds_stack_peek(ds_stack_t *stack);
 void  ds_stack_push_all(ds_stack_t *stack, zval *value);
 void  ds_stack_to_array(ds_stack_t *stack, zval *return_value);
-void  ds_stack_destroy(ds_stack_t *stack);
+void  ds_stack_free(ds_stack_t *stack);
 
 #endif
diff --git a/src/ds/ds_vector.c b/src/ds/ds_vector.c
@@ -702,7 +702,7 @@ void ds_vector_sum(ds_vector_t *vector, zval *return_value)
     DS_VECTOR_FOREACH_END();
 }
 
-void ds_vector_destroy(ds_vector_t *vector)
+void ds_vector_free(ds_vector_t *vector)
 {
     ds_vector_clear(vector);
     efree(vector->buffer);
diff --git a/src/ds/ds_vector.h b/src/ds/ds_vector.h
@@ -49,7 +49,7 @@ ds_vector_t *ds_vector_from_buffer(zval *buffer, zend_long size);
 void ds_vector_allocate(ds_vector_t *vector, zend_long capacity);
 
 void ds_vector_clear(ds_vector_t *vector);
-void ds_vector_destroy(ds_vector_t *vector);
+void ds_vector_free(ds_vector_t *vector);
 
 void ds_vector_set(ds_vector_t *vector, zend_long index, zval *value);
 void ds_vector_pop(ds_vector_t *vector, zval *return_value);
diff --git a/src/php/handlers/php_deque_handlers.c b/src/php/handlers/php_deque_handlers.c
@@ -74,8 +74,7 @@ static void ds_deque_free_object(zend_object *object)
 {
     php_ds_deque_t *intern = (php_ds_deque_t*) object;
     zend_object_std_dtor(&intern->std);
-    ds_deque_destroy(intern->deque);
-    efree(intern->deque);
+    ds_deque_free(intern->deque);
 }
 
 static HashTable *ds_deque_get_debug_info(zval *obj, int *is_temp)
diff --git a/src/php/handlers/php_map_handlers.c b/src/php/handlers/php_map_handlers.c
@@ -60,7 +60,7 @@ static void ds_map_free_object(zend_object *object)
 {
     php_ds_map_t *intern = (php_ds_map_t*) object;
     zend_object_std_dtor(&intern->std);
-    ds_map_destroy(intern->map);
+    ds_map_free(intern->map);
 }
 
 static HashTable *ds_map_get_debug_info(zval *obj, int *is_temp)
diff --git a/src/php/handlers/php_pair_handlers.c b/src/php/handlers/php_pair_handlers.c
@@ -100,7 +100,7 @@ static void ds_pair_free_object(zend_object *object)
 {
     php_ds_pair_t *obj = (php_ds_pair_t*) object;
     zend_object_std_dtor(&obj->std);
-    ds_pair_destroy(obj->pair);
+    ds_pair_free(obj->pair);
 }
 
 static int ds_pair_count_elements(zval *object, zend_long *count)
diff --git a/src/php/handlers/php_priority_queue_handlers.c b/src/php/handlers/php_priority_queue_handlers.c
@@ -10,7 +10,7 @@ static void ds_priority_queue_free_object(zend_object *object)
 {
     php_ds_priority_queue_t *queue = (php_ds_priority_queue_t*) object;
     zend_object_std_dtor(&queue->std);
-    ds_priority_queue_destroy(queue->pq);
+    ds_priority_queue_free(queue->pq);
 }
 
 static int ds_priority_queue_count_elements(zval *obj, zend_long *count)
diff --git a/src/php/handlers/php_queue_handlers.c b/src/php/handlers/php_queue_handlers.c
@@ -22,7 +22,7 @@ static void ds_queue_free_object(zend_object *object)
 {
     php_ds_queue_t *q = (php_ds_queue_t*) object;
     zend_object_std_dtor(&q->std);
-    ds_queue_destroy(q->queue);
+    ds_queue_free(q->queue);
 }
 
 static int ds_queue_count_elements(zval *obj, zend_long *count)
diff --git a/src/php/handlers/php_set_handlers.c b/src/php/handlers/php_set_handlers.c
@@ -41,11 +41,11 @@ static int ds_set_count_elements(zval *obj, zend_long *count)
     return SUCCESS;
 }
 
-static void ds_set_destroy_object(zend_object *object)
+static void ds_set_free_object(zend_object *object)
 {
     php_ds_set_t *obj = (php_ds_set_t*) object;
     zend_object_std_dtor(&obj->std);
-    ds_set_destroy(obj->set);
+    ds_set_free(obj->set);
 }
 
 static HashTable *ds_set_get_debug_info(zval *obj, int *is_temp)
@@ -167,7 +167,7 @@ void php_ds_register_set_handlers()
 
     php_ds_set_handlers.offset = XtOffsetOf(php_ds_set_t, std);
 
-    php_ds_set_handlers.free_obj            = ds_set_destroy_object;
+    php_ds_set_handlers.free_obj            = ds_set_free_object;
     php_ds_set_handlers.clone_obj           = ds_set_clone_obj;
     php_ds_set_handlers.get_debug_info      = ds_set_get_debug_info;
     php_ds_set_handlers.count_elements      = ds_set_count_elements;
diff --git a/src/php/handlers/php_stack_handlers.c b/src/php/handlers/php_stack_handlers.c
@@ -21,7 +21,7 @@ static void ds_stack_free_object(zend_object *object)
 {
     php_ds_stack_t *obj = (php_ds_stack_t*) object;
     zend_object_std_dtor(&obj->std);
-    ds_stack_destroy(obj->stack);
+    ds_stack_free(obj->stack);
 }
 
 static int ds_stack_count_elements(zval *obj, zend_long *count)
diff --git a/src/php/handlers/php_vector_handlers.c b/src/php/handlers/php_vector_handlers.c
@@ -78,7 +78,7 @@ static void ds_vector_free_object(zend_object *obj)
 {
     php_ds_vector_t *intern = (php_ds_vector_t*) obj;
     zend_object_std_dtor(&intern->std);
-    ds_vector_destroy(intern->vector);
+    ds_vector_free(intern->vector);
 }
 
 static HashTable *ds_vector_get_debug_info(zval *obj, int *is_temp)
diff --git a/src/php/objects/php_deque.c b/src/php/objects/php_deque.c
@@ -78,7 +78,7 @@ int php_ds_deque_unserialize(zval *object, zend_class_entry *ce, const unsigned
     return SUCCESS;
 
 error:
-    ds_deque_destroy(deque);
+    ds_deque_free(deque);
     PHP_VAR_UNSERIALIZE_DESTROY(unserialize_data);
     UNSERIALIZE_ERROR();
     return FAILURE;
diff --git a/src/php/objects/php_map.c b/src/php/objects/php_map.c
@@ -72,7 +72,7 @@ int php_ds_map_unserialize(zval *object, zend_class_entry *ce, const unsigned ch
     ds_map_t *map = ds_map();
 
     if (ds_htable_unserialize(map->table, buffer, length, data) == FAILURE) {
-        ds_map_destroy(map);
+        ds_map_free(map);
         return FAILURE;
     }
 
diff --git a/src/php/objects/php_priority_queue.c b/src/php/objects/php_priority_queue.c
@@ -100,7 +100,7 @@ int php_ds_priority_queue_unserialize(zval *object, zend_class_entry *ce, const
     return SUCCESS;
 
 error:
-    ds_priority_queue_destroy(queue);
+    ds_priority_queue_free(queue);
     PHP_VAR_UNSERIALIZE_DESTROY(unserialize_data);
     UNSERIALIZE_ERROR();
     return FAILURE;
diff --git a/src/php/objects/php_queue.c b/src/php/objects/php_queue.c
@@ -79,7 +79,7 @@ int php_ds_queue_unserialize(zval *object, zend_class_entry *ce, const unsigned
     return SUCCESS;
 
 error:
-    ds_queue_destroy(queue);
+    ds_queue_free(queue);
     PHP_VAR_UNSERIALIZE_DESTROY(unserialize_data);
     UNSERIALIZE_ERROR();
     return FAILURE;
diff --git a/src/php/objects/php_set.c b/src/php/objects/php_set.c
@@ -78,7 +78,7 @@ int php_ds_set_unserialize(zval *object, zend_class_entry *ce, const unsigned ch
     return SUCCESS;
 
 error:
-    ds_set_destroy(set);
+    ds_set_free(set);
     PHP_VAR_UNSERIALIZE_DESTROY(unserialize_data);
     UNSERIALIZE_ERROR();
     return FAILURE;
diff --git a/src/php/objects/php_stack.c b/src/php/objects/php_stack.c
diff --git a/src/php/objects/php_vector.c b/src/php/objects/php_vector.c

Original file line number	Diff line number	Diff line change
`@@ -194,10 +194,11 @@ void ds_deque_clear(ds_deque_t *deque)`
`194`	`194`	`deque->size = 0;`
`195`	`195`	`}`
`196`	`196`
`197`		`-void ds_deque_destroy(ds_deque_t *deque)`
	`197`	`+void ds_deque_free(ds_deque_t *deque)`
`198`	`198`	`{`
`199`	`199`	`ds_deque_clear(deque);`
`200`	`200`	`efree(deque->buffer);`
	`201`	`+ efree(deque);`
`201`	`202`	`}`
`202`	`203`
`203`	`204`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -351,8 +351,8 @@ void ds_map_sum(ds_map_t map, zval return_value)`
`351`	`351`	`DS_HTABLE_FOREACH_END();`
`352`	`352`	`}`
`353`	`353`
`354`		`-void ds_map_destroy(ds_map_t *map)`
	`354`	`+void ds_map_free(ds_map_t *map)`
`355`	`355`	`{`
`356`		`- ds_htable_destroy(map->table);`
	`356`	`+ ds_htable_free(map->table);`
`357`	`357`	`efree(map);`
`358`	`358`	`}`