1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
<?php
/**
* Class for preprocessing callgrind files.
*
* Information from the callgrind file is extracted and written in a binary format for
* fast random access.
*
* @see https://github.com/jokkedk/webgrind/wiki/Preprocessed-Format
* @see http://valgrind.org/docs/manual/cl-format.html
* @package Webgrind
* @author Jacob Oettinger
*/
class Webgrind_Preprocessor
{
/**
* Fileformat version. Embedded in the output for parsers to use.
*/
const FILE_FORMAT_VERSION = 7;
/**
* Binary number format used.
* @see http://php.net/pack
*/
const NR_FORMAT = 'V';
/**
* Size, in bytes, of the above number format
*/
const NR_SIZE = 4;
/**
* String name of main function
*/
const ENTRY_POINT = '{main}';
/**
* Extract information from $inFile and store in preprocessed form in $outFile
*
* @param string $inFile Callgrind file to read
* @param string $outFile File to write preprocessed data to
* @return void
*/
static function parse($inFile, $outFile)
{
$in = @fopen($inFile, 'rb');
if (!$in)
throw new Exception('Could not open '.$inFile.' for reading.');
$out = @fopen($outFile, 'w+b');
if (!$out)
throw new Exception('Could not open '.$outFile.' for writing.');
// If possible, use the binary preprocessor
if (self::binaryParse($inFile, $outFile)) {
return;
}
$proxyFunctions = array_flip(Webgrind_Config::$proxyFunctions);
$proxyQueue = array();
$nextFuncNr = 0;
$functionNames = array();
$functions = array();
$headers = array();
// Read information into memory
while (($line = fgets($in))) {
if (substr($line, 0, 3) === 'fl=') {
// Found invocation of function. Read function name
fscanf($in, "fn=%[^\n\r]s", $function);
$function = self::getCompressedName($function, false);
// Special case for ENTRY_POINT - it contains summary header
if (self::ENTRY_POINT == $function) {
fgets($in);
$headers[] = fgets($in);
fgets($in);
}
// Cost line
fscanf($in, "%d %d", $lnr, $cost);
if (!isset($functionNames[$function])) {
$index = $nextFuncNr++;
$functionNames[$function] = $index;
if (isset($proxyFunctions[$function])) {
$proxyQueue[$index] = array();
}
$functions[$index] = array(
'filename' => self::getCompressedName(substr(trim($line), 3), true),
'line' => $lnr,
'invocationCount' => 1,
'summedSelfCost' => $cost,
'summedInclusiveCost' => $cost,
'calledFromInformation' => array(),
'subCallInformation' => array()
);
} else {
$index = $functionNames[$function];
$functions[$index]['invocationCount']++;
$functions[$index]['summedSelfCost'] += $cost;
$functions[$index]['summedInclusiveCost'] += $cost;
}
} else if (substr($line,0,4)==='cfn=') {
// Found call to function. ($function/$index should contain function call originates from)
$calledFunctionName = self::getCompressedName(substr(trim($line), 4), false);
// Skip call line
fgets($in);
// Cost line
fscanf($in, "%d %d", $lnr, $cost);
// Current function is a proxy -> skip
if (isset($proxyQueue[$index])) {
$proxyQueue[$index][] = array(
'calledIndex' => $functionNames[$calledFunctionName],
'lnr' => $lnr,
'cost' => $cost,
);
continue;
}
$calledIndex = $functionNames[$calledFunctionName];
// Called a proxy
if (isset($proxyQueue[$calledIndex])) {
$data = array_shift($proxyQueue[$calledIndex]);
$calledIndex = $data['calledIndex'];
$lnr = $data['lnr'];
$cost = $data['cost'];
}
$functions[$index]['summedInclusiveCost'] += $cost;
$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]['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]['callCount']++;
$functions[$index]['subCallInformation'][$calledKey]['summedCallCost'] += $cost;
} else if (strpos($line, ': ') !== false) {
// Found header
$headers[] = $line;
}
}
$functionNames = array_flip($functionNames);
// Write output
$functionCount = sizeof($functions);
fwrite($out, pack(self::NR_FORMAT.'*', self::FILE_FORMAT_VERSION, 0, $functionCount));
// Make room for function addresses
fseek($out, self::NR_SIZE*$functionCount, SEEK_CUR);
$functionAddresses = array();
foreach ($functions as $index=>$function) {
$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));
// Write called from information
foreach ((array)$function['calledFromInformation'] as $call) {
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, $function['filename']."\n".$functionNames[$index]."\n");
}
$headersPos = ftell($out);
// Write headers
foreach ($headers as $header) {
fwrite($out, $header);
}
// Write addresses
fseek($out, self::NR_SIZE, SEEK_SET);
fwrite($out, pack(self::NR_FORMAT, $headersPos));
// Skip function count
fseek($out, self::NR_SIZE, SEEK_CUR);
// Write function addresses
foreach ($functionAddresses as $address) {
fwrite($out, pack(self::NR_FORMAT, $address));
}
}
/**
* Extract information from $inFile and store in preprocessed form in $outFile
*
* @param string $name String to parse (either a filename or function name line)
* @param int $isFile True if this is a filename line (since files and functions have their own symbol tables)
* @return void
**/
static function getCompressedName($name, $isFile)
{
global $compressedNames;
if (!preg_match("/\((\d+)\)(.+)?/", $name, $matches)) {
return $name;
}
$functionIndex = $matches[1];
if (isset($matches[2])) {
$compressedNames[$isFile][$functionIndex] = trim($matches[2]);
} else if (!isset($compressedNames[$isFile][$functionIndex])) {
return $name; // should not happen - is file valid?
}
return $compressedNames[$isFile][$functionIndex];
}
/**
* Extract information from $inFile and store in preprocessed form in $outFile
* using the (~20x) faster binary preprocessor
*
* @param string $inFile Callgrind file to read
* @param string $outFile File to write preprocessed data to
* @return bool True if binary preprocessor was executed
*/
static function binaryParse($inFile, $outFile)
{
$preprocessor = Webgrind_Config::getBinaryPreprocessor();
if (!is_executable($preprocessor)) {
return false;
}
$cmd = escapeshellarg($preprocessor).' '.escapeshellarg($inFile).' '.escapeshellarg($outFile);
foreach (Webgrind_Config::$proxyFunctions as $function) {
$cmd .= ' '.escapeshellarg($function);
}
exec($cmd);
return true;
}
}
|
