Merge pull request #11 from BitOne/objects_summary

Objects summary

Author: BitOne

README.md

@@ -11,7 +11,6 @@ For now, PHP Meminfo provides a list of live objects in memory with their class
 
 Compatibility
 -------------
- 
 Compiled and tested on:
 
  - PHP 5.4.4 (Debian 7)
@@ -43,31 +42,69 @@ Restart your webserver.
 
 Check the PHP Info output and look for the MemInfo data. If you can find it, installation has been successful.
 
-To see the PHP Info output, just create a page calling the phpinfo(); function, a load it from your browser, or call php -i from command line.
+To see the PHP Info output, just create a page calling the phpinfo(); function, and load it from your browser, or call php -i from command line.
 
 Usage
 -----
-All meminfo functions take a stream handle as a parameter. It allows you to specify a file (if needed with a variable name identified to your context), as well as uses standard output with the `php://stdout` stream.
+All meminfo functions take a stream handle as a parameter. It allows you to specify a file (if needed with a variable name identifying your context), as well as to use standard output with the `php://stdout` stream.
+
+## Object instances count per class
+Display the number of instances per class, ordered descending. Very useful to identify the content of a memory leak.
+
+```php
+    meminfo_objects_summary(fopen('php://stdout','w'));
+```
+
+The result will provide something similar to the following example (generated at the end of the Symfony2 console launch)
+
+```
+    Instances count by class:
+    num          #instances   class
+    -----------------------------------------------------------------
+    1            181          Symfony\Component\Console\Input\InputOption
+    2            88           Symfony\Component\Console\Input\InputDefinition
+    3            77           ReflectionObject
+    4            46           Symfony\Component\Console\Input\InputArgument
+    5            2            Symfony\Bridge\Monolog\Logger
+    6            1            Symfony\Component\EventDispatcher\ContainerAwareEventDispatcher
+    7            1            Doctrine\Bundle\MigrationsBundle\Command\MigrationsDiffDoctrineCommand
+    ...
+```
+
+Note: It's a good idea to call the `gc_collect_cycles()` function before executing  `meminfo_objects_summary()`, as it will collect dead objects that has not been reclaimed by the ref counter due to circular references. See http://www.php.net/manual/en/features.gc.php for more details.
+
+### Examples
+The `examples/` directory at the root of the repository contains more detailed examples.
+```bash
+    $ php examples/objects_summary.php
+```
 
 ## Information on structs size
 Display size in byte of main data structs size in PHP. Will mainly differ between 32bits et 64bits environments.
 
+```php
+
     meminfo_structs_size(fopen('php://stdout','w'));
+```
 
 It can be useful to understand difference in memory usage between two platforms.
 
 Example Output on 64bits environment:
 
+```
     Structs size on this platform:
       Class (zend_class_entry): 568 bytes.
       Object (zend_object): 32 bytes.
       Variable (zval): 24 bytes.
       Variable value (zvalue_value): 16 bytes.
+```
 
 ##List of currently active objects
 Provides a list of live objects with their class and their handle, as well as the total number of active objects and the total number of allocated object buckets.
 
+```php
     meminfo_objects_list(fopen('php://stdout','w'));
+```
 
 For example:
 
@@ -78,24 +115,13 @@ For example:
       - Class MyClassC, handle 7, refcount 1
     Total object buckets: 7. Current objects: 4.
 
-Note: It's a good idea to call the `gc_collect_cycles()` function before executing  `meminfo_objects_list()`, as it will collect dead objects that has not been reclaimed by the ref counter due to circular references. See http://www.php.net/manual/en/features.gc.php for more details.
+Note: The same remark about `gc_collect_cycle()` before `meminfo_objects_summary()` applies as well for this function.
 
 ### Examples
 The `examples/` directory at the root of the repository contains more detailed examples.
 
     php examples/objects_list.php
 
-### Analysis
-Some simple shell one-liners can help you aggregate data from the dumped objects list to get a better grasp at what's happening:
-
- - Ordered list of number of objects per class
-
-    cat objects_list.meminfo | grep - | cut -d "," -f 1 | sort | uniq -c | sort -n
-
- - Top 5 of the most present class by objects number
-
-    cat objects_list.meminfo | grep - | cut -d "," -f 1 | sort | uniq -c | sort -nr | head -n 5
-
 Usage in production
 -------------------
 PHP Meminfo can be used in production, as it does not have any impact on performances outside of the call to the `meminfo` functions.

examples/objects_summary.php

@@ -0,0 +1,57 @@
+<?php
+
+class MyClassA {
+}
+
+class MyClassB {
+}
+
+class MyClassC {
+}
+
+$objectA = new MyClassA();
+$objectB = new MyClassB();
+
+echo "* Objects summary after instanciating objects A and B\n";
+meminfo_objects_summary(fopen('php://stdout', 'w'));
+
+$objectsC = array();
+
+for ($i = 0; $i < 5; $i++) {
+    $objectsC[] = new MyClassC();
+}
+
+echo "\n* Objects summary after instanciating 10 objects C\n";
+meminfo_objects_summary(fopen('php://stdout', 'w'));
+
+unset($objectA);
+unset($objectsC[0]);
+unset($objectsC[1]);
+
+echo "\n* Objects summary after unset on some objects\n";
+meminfo_objects_summary(fopen('php://stdout', 'w'));
+
+$myClosure = function() {
+    $a = 1;
+};
+
+echo "\n* Objects summary after instantiating an anonymous function\n";
+meminfo_objects_summary(fopen('php://stdout', 'w'));
+
+$objectBClone = clone $objectB;
+
+echo "\n* Objects summary after cloning objectB\n";
+meminfo_objects_summary(fopen('php://stdout', 'w'));
+
+function myFunction() {
+    $myDate = new \DateTime();
+
+    echo "\n* Objects summary in function call with inside DateTime object\n";
+    meminfo_objects_summary(fopen('php://stdout', 'w'));
+}
+
+myFunction();
+
+echo "\n* Objects summary after function call\n";
+meminfo_objects_summary(fopen('php://stdout', 'w'));
+

meminfo.c

@@ -17,6 +17,7 @@
 const zend_function_entry meminfo_functions[] = {
     PHP_FE(meminfo_structs_size, NULL)
     PHP_FE(meminfo_objects_list, NULL)
+    PHP_FE(meminfo_objects_summary, NULL)
     PHP_FE(meminfo_gc_roots_list, NULL)
     PHP_FE(meminfo_symbol_table, NULL)
     {NULL, NULL, NULL}
@@ -61,11 +62,11 @@ char* get_type_label(zval* z) {
         case IS_DOUBLE:
             return "double";
             break;
-    
+
         case IS_STRING:
             return "string";
             break;
-    
+
         case IS_ARRAY:
             return "array";
             break;
@@ -161,7 +162,104 @@ PHP_FUNCTION(meminfo_objects_list)
      }
 
     php_stream_printf(stream, "Total object buckets: %d. Current objects: %d.\n", total_objects_buckets, current_objects);
+}
+
+PHP_FUNCTION(meminfo_objects_summary)
+{
+    zval *zval_stream = NULL;
+    php_stream *stream = NULL;
+    HashTable *classes = NULL;
+
+    if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zval_stream) == FAILURE) {
+        return;
+    }
+
+    ALLOC_HASHTABLE(classes);
+
+    zend_hash_init(classes, 1000, NULL, NULL, 0);
+
+    zend_objects_store *objects = &EG(objects_store);
+    zend_uint i;
+    zend_object *object;
+
+    for (i = 1; i < objects->top ; i++) {
+        if (objects->object_buckets[i].valid && !objects->object_buckets[i].destructor_called) {
+            const char *class_name;
+            zval **zv_dest;
+
+            class_name = get_classname(i);
+
+            if (zend_hash_find(classes, class_name, strlen(class_name)+1, (void **) &zv_dest) == SUCCESS) {
+                Z_LVAL_PP(zv_dest) = Z_LVAL_PP(zv_dest) ++;
+            } else {
+                zval *zv_instances_count;
+                MAKE_STD_ZVAL(zv_instances_count);
+                ZVAL_LONG(zv_instances_count, 1);
+
+                zend_hash_update(classes, class_name, strlen(class_name)+1, &zv_instances_count, sizeof(zval *), NULL);
+            }
+        }
+    }
+
+    zend_hash_sort(classes, zend_qsort, instances_count_compare, 0 TSRMLS_CC);
 
+    php_stream_from_zval(stream, &zval_stream);
+    php_stream_printf(stream, "Instances count by class:\n");
+
+    php_stream_printf(stream, "%-12s %-12s %s\n", "num", "#instances", "class");
+    php_stream_printf(stream, "-----------------------------------------------------------------\n");
+
+    zend_uint num = 1;
+
+    HashPosition position;
+    zval **entry = NULL;
+
+    for (zend_hash_internal_pointer_reset_ex(classes, &position);
+         zend_hash_get_current_data_ex(classes, (void **) &entry, &position) == SUCCESS;
+         zend_hash_move_forward_ex(classes, &position)) {
+
+        char *class_name = NULL;
+        uint  class_name_len;
+        ulong index;
+
+        zend_hash_get_current_key_ex(classes, &class_name, &class_name_len, &index, 0, &position);
+        php_stream_printf(stream, "%-12d %-12d %s\n", num, Z_LVAL_PP(entry), class_name);
+
+        num++;
+    }
+
+    zend_hash_destroy(classes);
+    FREE_HASHTABLE(classes);
+}
+
+static int instances_count_compare(const void *a, const void *b TSRMLS_DC)
+{
+    const Bucket *first_bucket;
+    const Bucket *second_bucket;
+
+    first_bucket = *((const Bucket **) a);
+    second_bucket = *((const Bucket **) b);
+
+    zval *zv_first;
+    zval *zv_second;
+
+    zv_first = (zval *) first_bucket->pDataPtr;
+    zv_second = (zval *) second_bucket->pDataPtr;
+
+
+    zend_uint first;
+    zend_uint second;
+
+    first = Z_LVAL_P(zv_first);
+    second = Z_LVAL_P(zv_second);
+
+    if (first > second) {
+        return -1;
+    } else if (first == second) {
+        return 0;
+    } else {
+        return 1;
+    }
 }
 
 PHP_FUNCTION(meminfo_gc_roots_list)
@@ -181,7 +279,7 @@ PHP_FUNCTION(meminfo_gc_roots_list)
 
     while (current != &GC_G(roots)) {
         pz = current->u.pz;
-        php_stream_printf( stream, "  zval pointer: %p ", (void *) pz); 
+        php_stream_printf( stream, "  zval pointer: %p ", (void *) pz);
         if (current->handle) {
             php_stream_printf(
                 stream,
@@ -214,7 +312,4 @@ PHP_FUNCTION(meminfo_symbol_table)
 
     php_stream_printf(stream, "Nb elements in Symbol Table: %d\n",main_symbol_table.nNumOfElements);
 
-    
 }
-
-

php_meminfo.h

@@ -2,16 +2,19 @@
 #define PHP_MEMINFO_H 1
 
 #define MEMINFO_NAME "PHP Meminfo"
-#define MEMINFO_VERSION "0.1-dev"
+#define MEMINFO_VERSION "0.2"
 #define MEMINFO_AUTHOR "Benoit Jacquemont"
-#define MEMINFO_COPYRIGHT  "Copyright (c) 2010-2014 by Benoit Jacquemont"
-#define MEMINFO_COPYRIGHT_SHORT "Copyright (c) 2011-2014"
+#define MEMINFO_COPYRIGHT  "Copyright (c) 2010-2015 by Benoit Jacquemont"
+#define MEMINFO_COPYRIGHT_SHORT "Copyright (c) 2011-2015"
 
 PHP_FUNCTION(meminfo_structs_size);
 PHP_FUNCTION(meminfo_objects_list);
+PHP_FUNCTION(meminfo_objects_summary);
 PHP_FUNCTION(meminfo_gc_roots_list);
 PHP_FUNCTION(meminfo_symbol_table);
 
+static int instances_count_compare(const void *a, const void *b TSRMLS_DC);
+
 extern zend_module_entry meminfo_entry;
 #define phpext_meminfo_ptr &meminfo_module_entry