summaryrefslogtreecommitdiffstatshomepage
path: root/tests/phpunit/includes/wp-profiler.php
blob: fefdca63c6502e6841b68feda65025173ec49a47 (plain) (blame)
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
<?php

/**
 * A simple manually-instrumented profiler for WordPress.
 *
 * This records basic execution time, and a summary of the actions and SQL queries run within each block.
 *
 * start() and stop() must be called in pairs, for example:
 *
 *     function something_to_profile() {
 *         wppf_start( __FUNCTION__ );
 *         do_stuff();
 *         wppf_stop();
 *     }
 *
 * Multiple profile blocks are permitted, and they may be nested.
 */
class WPProfiler {
	public $stack;
	public $profile;

	/**
	 * PHP5 constructor.
	 */
	public function __construct() {
		$this->stack   = array();
		$this->profile = array();
	}

	public function start( $name ) {
		$time = $this->microtime();

		if ( ! $this->stack ) {
			// Log all actions and filters.
			add_filter( 'all', array( $this, 'log_filter' ) );
		}

		// Reset the wpdb queries log, storing it on the profile stack if necessary.
		global $wpdb;
		if ( $this->stack ) {
			$this->stack[ count( $this->stack ) - 1 ]['queries'] = $wpdb->queries;
		}
		$wpdb->queries = array();

		global $wp_object_cache;

		$this->stack[] = array(
			'start'               => $time,
			'name'                => $name,
			'cache_cold_hits'     => $wp_object_cache->cold_cache_hits,
			'cache_warm_hits'     => $wp_object_cache->warm_cache_hits,
			'cache_misses'        => $wp_object_cache->cache_misses,
			'cache_dirty_objects' => $this->_dirty_objects_count( $wp_object_cache->dirty_objects ),
			'actions'             => array(),
			'filters'             => array(),
			'queries'             => array(),
		);
	}

	public function stop() {
		$item = array_pop( $this->stack );
		$time = $this->microtime( $item['start'] );
		$name = $item['name'];

		global $wpdb;
		$item['queries'] = $wpdb->queries;
		global $wp_object_cache;

		$cache_dirty_count = $this->_dirty_objects_count( $wp_object_cache->dirty_objects );
		$cache_dirty_delta = $this->array_sub( $cache_dirty_count, $item['cache_dirty_objects'] );

		if ( isset( $this->profile[ $name ] ) ) {
			$this->profile[ $name ]['time'] += $time;
			++$this->profile[ $name ]['calls'];
			$this->profile[ $name ]['cache_cold_hits']    += ( $wp_object_cache->cold_cache_hits - $item['cache_cold_hits'] );
			$this->profile[ $name ]['cache_warm_hits']    += ( $wp_object_cache->warm_cache_hits - $item['cache_warm_hits'] );
			$this->profile[ $name ]['cache_misses']       += ( $wp_object_cache->cache_misses - $item['cache_misses'] );
			$this->profile[ $name ]['cache_dirty_objects'] = array_add( $this->profile[ $name ]['cache_dirty_objects'], $cache_dirty_delta );
			$this->profile[ $name ]['actions']             = array_add( $this->profile[ $name ]['actions'], $item['actions'] );
			$this->profile[ $name ]['filters']             = array_add( $this->profile[ $name ]['filters'], $item['filters'] );
			$this->profile[ $name ]['queries']             = array_add( $this->profile[ $name ]['queries'], $item['queries'] );
			#$this->_query_summary($item['queries'], $this->profile[$name]['queries']);

		} else {
			$queries = array();
			$this->_query_summary( $item['queries'], $queries );
			$this->profile[ $name ] = array(
				'time'                        => $time,
				'calls'                       => 1,
				'cache_cold_hits'             => ( $wp_object_cache->cold_cache_hits - $item['cache_cold_hits'] ),
				'cache_warm_hits'             => ( $wp_object_cache->warm_cache_hits - $item['cache_warm_hits'] ),
				'cache_misses'                => ( $wp_object_cache->cache_misses - $item['cache_misses'] ),
				'cache_dirty_objects'         => $cache_dirty_delta,
				'actions'                     => $item['actions'],
				'filters'                     => $item['filters'],
				#               'queries' => $item['queries'],
									'queries' => $queries,
			);
		}

		if ( ! $this->stack ) {
			remove_filter( 'all', array( $this, 'log_filter' ) );
		}
	}

	public function microtime( $since = 0.0 ) {
		list($usec, $sec) = explode( ' ', microtime() );
		return (float) $sec + (float) $usec - $since;
	}

	public function log_filter( $tag ) {
		if ( $this->stack ) {
			global $wp_actions;
			if ( end( $wp_actions ) === $tag ) {
				++$this->stack[ count( $this->stack ) - 1 ]['actions'][ $tag ];
			} else {
				++$this->stack[ count( $this->stack ) - 1 ]['filters'][ $tag ];
			}
		}
		return $arg;
	}

	public function log_action( $tag ) {
		if ( $this->stack ) {
			++$this->stack[ count( $this->stack ) - 1 ]['actions'][ $tag ];
		}
	}

	public function _current_action() {
		global $wp_actions;
		return $wp_actions[ count( $wp_actions ) - 1 ];
	}

	public function results() {
		return $this->profile;
	}

	public function _query_summary( $queries, &$out ) {
		foreach ( $queries as $q ) {
			$sql = $q[0];
			$sql = preg_replace( '/(WHERE \w+ =) \d+/', '$1 x', $sql );
			$sql = preg_replace( '/(WHERE \w+ =) \'\[-\w]+\'/', '$1 \'xxx\'', $sql );

			++$out[ $sql ];
		}
		asort( $out );
		return;
	}

	public function _query_count( $queries ) {
		// This requires the SAVEQUERIES patch at https://core.trac.wordpress.org/ticket/5218
		$out = array();
		foreach ( $queries as $q ) {
			if ( empty( $q[2] ) ) {
				++$out['unknown'];
			} else {
				++$out[ $q[2] ];
			}
		}
		return $out;
	}

	public function _dirty_objects_count( $dirty_objects ) {
		$out = array();
		foreach ( array_keys( $dirty_objects ) as $group ) {
			$out[ $group ] = count( $dirty_objects[ $group ] );
		}
		return $out;
	}

	public function array_add( $a, $b ) {
		$out = $a;
		foreach ( array_keys( $b ) as $key ) {
			if ( array_key_exists( $key, $out ) ) {
				$out[ $key ] += $b[ $key ];
			} else {
				$out[ $key ] = $b[ $key ];
			}
		}
		return $out;
	}

	public function array_sub( $a, $b ) {
		$out = $a;
		foreach ( array_keys( $b ) as $key ) {
			if ( array_key_exists( $key, $b ) ) {
				$out[ $key ] -= $b[ $key ];
			}
		}
		return $out;
	}

	public function print_summary() {
		$results = $this->results();

		printf( "\nname                      calls   time action filter   warm   cold misses  dirty\n" );
		foreach ( $results as $name => $stats ) {
			printf( "%24.24s %6d %6.4f %6d %6d %6d %6d %6d %6d\n", $name, $stats['calls'], $stats['time'], array_sum( $stats['actions'] ), array_sum( $stats['filters'] ), $stats['cache_warm_hits'], $stats['cache_cold_hits'], $stats['cache_misses'], array_sum( $stats['cache_dirty_objects'] ) );
		}
	}
}

global $wppf;
$wppf = new WPProfiler();

function wppf_start( $name ) {
	$GLOBALS['wppf']->start( $name );
}

function wppf_stop() {
	$GLOBALS['wppf']->stop();
}

function wppf_results() {
	return $GLOBALS['wppf']->results();
}

function wppf_print_summary() {
	$GLOBALS['wppf']->print_summary();
}