Skip to content

Add static local variables to the dump #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add static local variables to the dump #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 48 additions & 5 deletions extension/meminfo.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ PHP_FUNCTION(meminfo_dump)
php_stream_printf(stream, " \"items\": {\n");
meminfo_browse_exec_frames(stream, &visited_items, &first_element);
meminfo_browse_class_static_members(stream, &visited_items, &first_element);
meminfo_browse_function_static_variables(stream, "<GLOBAL_FUNCTION>", CG(function_table), &visited_items, &first_element);

php_stream_printf(stream, "\n }\n");
php_stream_printf(stream, "}\n}\n");
Expand Down Expand Up @@ -134,7 +135,6 @@ void meminfo_browse_class_static_members(php_stream *stream, HashTable *visited
zend_class_entry *class_entry;
zend_property_info * prop_info;

char frame_label[500];
char symbol_name[500];
const char *prop_name, *class_name;
zend_string * zstr_symbol_name;
Expand All @@ -156,7 +156,6 @@ void meminfo_browse_class_static_members(php_stream *stream, HashTable *visited
while ((prop_info = zend_hash_get_current_data_ptr_ex(properties_info, &prop_pos)) != NULL) {

if (prop_info->flags & ZEND_ACC_STATIC) {
snprintf(frame_label, sizeof(frame_label), "<CLASS_STATIC_MEMBER>");
#if PHP_VERSION_ID >= 70400
prop = CE_STATIC_MEMBERS(class_entry) + prop_info->offset;
#else
Expand All @@ -166,26 +165,70 @@ void meminfo_browse_class_static_members(php_stream *stream, HashTable *visited
zend_unmangle_property_name(prop_info->name, &class_name, &prop_name);

if (class_name) {
snprintf(symbol_name, sizeof(frame_label), "%s::%s", class_name, prop_name);
snprintf(symbol_name, sizeof(symbol_name), "%s::%s", class_name, prop_name);
} else {
snprintf(symbol_name, sizeof(frame_label), "%s::%s", ZSTR_VAL(class_entry->name), ZSTR_VAL(prop_info->name));
snprintf(symbol_name, sizeof(symbol_name), "%s::%s", ZSTR_VAL(class_entry->name), ZSTR_VAL(prop_info->name));
}

zstr_symbol_name = zend_string_init(symbol_name, strlen(symbol_name), 0);

meminfo_zval_dump(stream, frame_label, zstr_symbol_name, prop, visited_items, first_element);
meminfo_zval_dump(stream, "<CLASS_STATIC_MEMBER>", zstr_symbol_name, prop, visited_items, first_element);

zend_string_release(zstr_symbol_name);
}

zend_hash_move_forward_ex(properties_info, &prop_pos);
}
}

// Static local variables can be hiding in class member functions. Find them here
meminfo_browse_function_static_variables(
stream,
ZSTR_VAL(class_entry->name),
&class_entry->function_table,
visited_items,
first_element
);

zend_hash_move_forward_ex(CG(class_table), &ce_pos);
}
}

/**
* Go through static variables of functions
*/
void meminfo_browse_function_static_variables(php_stream *stream, char* class_name, HashTable *function_table, HashTable *visited_items, int *first_element)
{
char frame_label[500];
char symbol_name[500];
zend_string * zstr_symbol_name;
zend_function * func;
zval * zfunc;
zend_string * zstaticvarkey;
zval * zstaticvar;

ZEND_HASH_FOREACH_VAL(function_table, zfunc) {
func = Z_FUNC_P(zfunc);
if (func->type == ZEND_USER_FUNCTION && func->op_array.static_variables != NULL) {
ZEND_HASH_FOREACH_STR_KEY_VAL(func->op_array.static_variables, zstaticvarkey, zstaticvar) {

snprintf(frame_label, sizeof(frame_label), "<STATIC_VARIABLE(%s::%s)>",
class_name,
ZSTR_VAL(func->op_array.function_name)
);
snprintf(symbol_name, sizeof(symbol_name), "$%s", ZSTR_VAL(zstaticvarkey));

zstr_symbol_name = zend_string_init(symbol_name, strlen(symbol_name), 0);

meminfo_zval_dump(stream, frame_label, zstr_symbol_name, zstaticvar, visited_items, first_element);

zend_string_release(zstr_symbol_name);

} ZEND_HASH_FOREACH_END();
}
} ZEND_HASH_FOREACH_END();
}

void meminfo_browse_zvals_from_symbol_table(php_stream *stream, char* frame_label, HashTable *p_symbol_table, HashTable * visited_items, int *first_element)
{
zval *zval_to_dump;
Expand Down
1 change: 1 addition & 0 deletions extension/php_meminfo.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ zend_ulong meminfo_get_element_size(zval* z);
// Functions to browse memory parts to record item
void meminfo_browse_exec_frames(php_stream *stream, HashTable *visited_items, int *first_element);
void meminfo_browse_class_static_members(php_stream *stream, HashTable *visited_items, int *first_element);
void meminfo_browse_function_static_variables(php_stream *stream, char* class_name, HashTable *function_table, HashTable *visited_items, int *first_element);

void meminfo_zval_dump(php_stream * stream, char * frame_label, zend_string * symbol_name, zval * zv, HashTable *visited_items, int *first_element);
void meminfo_hash_dump(php_stream *stream, HashTable *ht, zend_bool is_object, HashTable *visited_items, int *first_element);
Expand Down
46 changes: 46 additions & 0 deletions extension/tests/dump-class_function_static_local_variables.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
--TEST--
Check that static variables inside a class member function are accounted for
--SKIPIF--
<?php
if (!extension_loaded('json')) die('skip json ext not loaded');
?>
--FILE--
<?php
$dump = fopen('php://memory', 'rw');

class MyClass {
public function myMethod() {
static $staticLocalVar;

if (!isset($staticLocalVar)) {
$staticLocalVar = 'one time load';
}

return $staticLocalVar;
}
}

(new MyClass)->myMethod();

meminfo_dump($dump);

rewind($dump);
$meminfoData = json_decode(stream_get_contents($dump), true);
fclose($dump);

$myArrayDump = [];

foreach ($meminfoData['items'] as $item) {
if (isset($item['symbol_name']) && $item['symbol_name'] == '$staticLocalVar') {
echo "Symbol: " . $item['symbol_name'] . "\n";
echo " Frame: " . $item['frame'] . "\n";
echo " Type: " . $item['type'] . "\n";
echo " Is root: " . $item['is_root'] . "\n";
}
}
?>
--EXPECT--
Symbol: $staticLocalVar
Frame: <STATIC_VARIABLE(MyClass::myMethod)>
Type: string
Is root: 1
44 changes: 44 additions & 0 deletions extension/tests/dump-global_function_static_local_variables.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
--TEST--
Check that static variables inside global functions are accounted for
--SKIPIF--
<?php
if (!extension_loaded('json')) die('skip json ext not loaded');
?>
--FILE--
<?php
$dump = fopen('php://memory', 'rw');

function myMethod() {
static $staticLocalVar;

if (!isset($staticLocalVar)) {
$staticLocalVar = 'one time load';
}

return $staticLocalVar;
}

myMethod();

meminfo_dump($dump);

rewind($dump);
$meminfoData = json_decode(stream_get_contents($dump), true);
fclose($dump);

$myArrayDump = [];

foreach ($meminfoData['items'] as $item) {
if (isset($item['symbol_name']) && $item['symbol_name'] == '$staticLocalVar') {
echo "Symbol: " . $item['symbol_name'] . "\n";
echo " Frame: " . $item['frame'] . "\n";
echo " Type: " . $item['type'] . "\n";
echo " Is root: " . $item['is_root'] . "\n";
}
}
?>
--EXPECT--
Symbol: $staticLocalVar
Frame: <STATIC_VARIABLE(<GLOBAL_FUNCTION>::myMethod)>
Type: string
Is root: 1