Skip to content

Add Memory support #1

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

Merged
jarstelfox merged 6 commits into from
Nov 6, 2023
Merged

Add Memory support #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ada7f44
Preprocessor.php: break up some long lines
danielbeardsley Nov 3, 2023
648de4c
PHP 8 fixes (no undefined properties).
danielbeardsley Nov 3, 2023
b638910
Support Memory in cachegrind files.
danielbeardsley Nov 3, 2023
b5aa9f6
Preprocessor.cpp: read memory usage if asked
danielbeardsley Nov 3, 2023
0cfb031
blockUI: handle jQuery upgrade
danielbeardsley Nov 6, 2023
30066e6
Table sorting: be explicit with column types
danielbeardsley Nov 6, 2023
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
1 change: 1 addition & 0 deletions js/jquery.blockUI.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* http://www.gnu.org/licenses/gpl.html
*/
(function($) {
$.browser = {};
/**
* blockUI provides a mechanism for blocking user interaction with a page (or parts of a page).
* This can be an effective way to simulate synchronous behavior during ajax operations without
Expand Down
8 changes: 5 additions & 3 deletions library/FileHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ class Webgrind_FileHandler
{

private static $singleton = null;

private $files;

/**
* @return Singleton instance of the filehandler
Expand Down Expand Up @@ -160,12 +160,14 @@ public function getTraceList() {
* @return Webgrind_Reader Reader for $file
*/
public function getTraceReader($file, $costFormat) {
$prepFile = Webgrind_Config::storageDir().$file.Webgrind_Config::$preprocessedSuffix;
$readMemory = $costFormat === 'bytes';
$memorySuffix = $readMemory ? ".memory" : "";
$prepFile = Webgrind_Config::storageDir().$file.$memorySuffix.Webgrind_Config::$preprocessedSuffix;
try {
$r = new Webgrind_Reader($prepFile, $costFormat);
} catch (Exception $e) {
// Preprocessed file does not exist or other error
Webgrind_Preprocessor::parse(Webgrind_Config::xdebugOutputDir().$file, $prepFile);
Webgrind_Preprocessor::parse(Webgrind_Config::xdebugOutputDir().$file, $prepFile, $readMemory);
Comment on lines +163 to +170
Copy link
Copy Markdown

@jarstelfox jarstelfox Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah! Cool, you are creating two pre-processed files (one for memory, one for CPU)

$r = new Webgrind_Reader($prepFile, $costFormat);
}
return $r;
Expand Down
50 changes: 37 additions & 13 deletions library/Preprocessor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ class Webgrind_Preprocessor
* @param string $outFile File to write preprocessed data to
* @return void
*/
static function parse($inFile, $outFile)
static function parse($inFile, $outFile, $readMemory = false)
{
$costPattern = $readMemory ? "%*d %d" : "%d";
Copy link
Copy Markdown

@jarstelfox jarstelfox Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you explain the reason for this pattern?
The %*d is skipping the number correct?
What number is in the second / third positions?

Copy link
Copy Markdown
Member Author

@danielbeardsley danielbeardsley Nov 3, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, every "cost line" looks like this:
4 936 160 == {line number} {time cost in usec} {memory cost in bytes}

When we want to read memory, we effectively need to skip the time cost and read the last number (which is normally unread).

// If possible, use the binary preprocessor
if (self::binaryParse($inFile, $outFile)) {
if (self::binaryParse($inFile, $outFile, $readMemory)) {
return;
}

Expand Down Expand Up @@ -74,17 +75,17 @@ static function parse($inFile, $outFile)
$buffer = fgets($in);
if(strlen($buffer) > 0 && ctype_digit($buffer[0])) {
// Cost line
sscanf($buffer, "%d %d", $lnr, $cost);
sscanf($buffer, "%d $costPattern", $lnr, $cost);
} else {
// Special case for ENTRY_POINT - it contains summary header
$headers[] = fgets($in);
fgets($in);
// Cost line
fscanf($in, "%d %d", $lnr, $cost);
fscanf($in, "%d $costPattern", $lnr, $cost);
}
} else {
// Cost line
fscanf($in, "%d %d", $lnr, $cost);
fscanf($in, "%d $costPattern", $lnr, $cost);
}

if (!isset($functionNames[$function])) {
Expand Down Expand Up @@ -114,7 +115,7 @@ static function parse($inFile, $outFile)
// Skip call line
fgets($in);
// Cost line
fscanf($in, "%d %d", $lnr, $cost);
fscanf($in, "%d $costPattern", $lnr, $cost);

// Current function is a proxy -> skip
if (isset($proxyQueue[$index])) {
Expand All @@ -139,15 +140,25 @@ static function parse($inFile, $outFile)

$key = $index.$lnr;
if (!isset($functions[$calledIndex]['calledFromInformation'][$key])) {
$functions[$calledIndex]['calledFromInformation'][$key] = array('functionNr'=>$index,'line'=>$lnr,'callCount'=>0,'summedCallCost'=>0);
$functions[$calledIndex]['calledFromInformation'][$key] = array(
'functionNr'=>$index,
'line'=>$lnr,
'callCount'=>0,
'summedCallCost'=>0,
);
}

$functions[$calledIndex]['calledFromInformation'][$key]['callCount']++;
$functions[$calledIndex]['calledFromInformation'][$key]['summedCallCost'] += $cost;

$calledKey = $calledIndex.$lnr;
if (!isset($functions[$index]['subCallInformation'][$calledKey])) {
$functions[$index]['subCallInformation'][$calledKey] = array('functionNr'=>$calledIndex,'line'=>$lnr,'callCount'=>0,'summedCallCost'=>0);
$functions[$index]['subCallInformation'][$calledKey] = array(
'functionNr'=>$calledIndex,
'line'=>$lnr,
'callCount'=>0,
'summedCallCost'=>0,
);
}

$functions[$index]['subCallInformation'][$calledKey]['callCount']++;
Expand All @@ -171,14 +182,27 @@ static function parse($inFile, $outFile)
$functionAddresses[] = ftell($out);
$calledFromCount = sizeof($function['calledFromInformation']);
$subCallCount = sizeof($function['subCallInformation']);
fwrite($out, pack(self::NR_FORMAT.'*', $function['line'], $function['summedSelfCost'], $function['summedInclusiveCost'], $function['invocationCount'], $calledFromCount, $subCallCount));
fwrite($out, pack(self::NR_FORMAT.'*',
$function['line'],
$function['summedSelfCost'],
$function['summedInclusiveCost'],
$function['invocationCount'],
$calledFromCount, $subCallCount));
// Write called from information
foreach ((array)$function['calledFromInformation'] as $call) {
fwrite($out, pack(self::NR_FORMAT.'*', $call['functionNr'], $call['line'], $call['callCount'], $call['summedCallCost']));
fwrite($out, pack(self::NR_FORMAT.'*',
$call['functionNr'],
$call['line'],
$call['callCount'],
$call['summedCallCost']));
}
// Write sub call information
foreach ((array)$function['subCallInformation'] as $call) {
fwrite($out, pack(self::NR_FORMAT.'*', $call['functionNr'], $call['line'], $call['callCount'], $call['summedCallCost']));
fwrite($out, pack(self::NR_FORMAT.'*',
$call['functionNr'],
$call['line'],
$call['callCount'],
$call['summedCallCost']));
}

fwrite($out, $function['filename']."\n".$functionNames[$index]."\n");
Expand Down Expand Up @@ -233,14 +257,14 @@ static function getCompressedName($name, $isFile)
* @param string $outFile File to write preprocessed data to
* @return bool True if binary preprocessor was executed
*/
static function binaryParse($inFile, $outFile)
static function binaryParse($inFile, $outFile, $readMemory)
{
$preprocessor = Webgrind_Config::getBinaryPreprocessor();
if (!is_executable($preprocessor)) {
return false;
}

$cmd = escapeshellarg($preprocessor).' '.escapeshellarg($inFile).' '.escapeshellarg($outFile);
$cmd = escapeshellarg($preprocessor).' '.escapeshellarg($inFile).' '.escapeshellarg($outFile).' '.($readMemory ? '1' : '0');
foreach (Webgrind_Config::$proxyFunctions as $function) {
$cmd .= ' '.escapeshellarg($function);
}
Expand Down
6 changes: 6 additions & 0 deletions library/Reader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ class Webgrind_Reader
*/
private $costFormat;

private $fp;


/**
* Constructor
Expand Down Expand Up @@ -229,6 +231,10 @@ function formatCost($cost, $format=null) {
if ($format==null)
$format = $this->costFormat;

if ($format == 'bytes') {
return number_format($cost, 0, '.', ',');
}

if ($format == 'percent') {
$total = $this->getHeader('summary');
$result = ($total==0) ? 0 : ($cost*100)/$total;
Expand Down
12 changes: 9 additions & 3 deletions library/preprocessor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ class Webgrind_Preprocessor
* @param outFile File to write preprocessed data to
* @param proxyFunctions Functions to skip, treated as proxies
*/
void parse(const char* inFile, const char* outFile, std::vector<std::string>& proxyFunctions)
void parse(const char* inFile, const char* outFile, bool readMemory, std::vector<std::string>& proxyFunctions)
{
#ifdef WITH_ZLIB
igzstream in(inFile);
Expand Down Expand Up @@ -160,18 +160,21 @@ class Webgrind_Preprocessor
// Cost line
std::istringstream bufferReader(buffer);
bufferReader >> lnr >> cost;
if (readMemory) bufferReader >> cost;
} else {
// Special case for ENTRY_POINT - it contains summary header
std::getline(in, buffer);
headers.push_back(buffer);
std::getline(in, buffer);
// Cost line
in >> lnr >> cost;
if (readMemory) in >> cost;
std::getline(in, buffer);
}
} else {
// Cost line
in >> lnr >> cost;
if (readMemory) in >> cost;
std::getline(in, buffer);
}

Expand Down Expand Up @@ -200,6 +203,7 @@ class Webgrind_Preprocessor
std::getline(in, buffer);
// Cost line
in >> lnr >> cost;
if (readMemory) in >> cost;
std::getline(in, buffer);

int calledIndex = funcIndexes[funcCompressedId];
Expand Down Expand Up @@ -372,7 +376,7 @@ class Webgrind_Preprocessor

int main(int argc, char* argv[])
{
if (argc < 3) {
if (argc < 4) {
return 1;
}
std::vector<std::string> proxyFunctions;
Expand All @@ -381,6 +385,8 @@ int main(int argc, char* argv[])
}
std::sort(proxyFunctions.begin(), proxyFunctions.end());
Webgrind_Preprocessor processor;
processor.parse(argv[1], argv[2], proxyFunctions);

bool useMemory = argv[3] == std::string("1");
processor.parse(argv[1], argv[2], useMemory, proxyFunctions);
return 0;
}
9 changes: 7 additions & 2 deletions templates/index.phtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,9 @@
$("#"+idPrefix+functionNr).tablesorter({
widgets: ['zebra'],
headers: {
2: { sorter: "floating" },
3: {
sorter: false
sorter: "floating"
}
}
});
Expand Down Expand Up @@ -330,7 +331,10 @@
},
2: {
sorter: false
}
},
3: { sorter: "floating" },
4: { sorter: "floating" },
5: { sorter: "floating" },
}
});
$("#function_table").bind("sortStart",sortBlock).bind("sortEnd",$.unblockUI);
Expand Down Expand Up @@ -386,6 +390,7 @@
<option value="percent" <?php echo (Webgrind_Config::$defaultCostformat=='percent') ? 'selected' : ''?>>percent</option>
<option value="msec" <?php echo (Webgrind_Config::$defaultCostformat=='msec') ? 'selected' : ''?>>milliseconds</option>
<option value="usec" <?php echo (Webgrind_Config::$defaultCostformat=='usec') ? 'selected' : ''?>>microseconds</option>
<option value="bytes" <?php echo (Webgrind_Config::$defaultCostformat=='bytes') ? 'selected' : ''?>>bytes of memory</option>
</select>
</div>
<div style="float:right;">
Expand Down