File: excimer_log.c

package info (click to toggle)
php-excimer 0.1.0~git20181204.9f02079-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 216 kB
  • sloc: ansic: 1,776; makefile: 12; sh: 3
file content (501 lines) | stat: -rw-r--r-- 14,463 bytes parent folder | download | duplicates (2)
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
/* Copyright 2018 Wikimedia Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "php.h"
#include "Zend/zend_smart_str.h"
#include "php_excimer.h"
#include "excimer_log.h"


static uint32_t excimer_log_find_or_add_frame(excimer_log *log,
		zend_execute_data *execute_data, zend_long depth);

/* {{{ Compatibility functions and macros */

#if PHP_VERSION_ID >= 70300
#define excimer_log_new_array zend_new_array
#else
static inline HashTable *excimer_log_new_array(uint32_t nSize)
{
	HashTable *ht = emalloc(sizeof(HashTable));
	zend_hash_init(ht, 0, NULL, ZVAL_PTR_DTOR, 0);
	return ht;
}
#endif

#if PHP_VERSION_ID >= 70200
#define excimer_log_smart_str_get_len smart_str_get_len
#define excimer_log_smart_str_extract smart_str_extract
#define excimer_log_smart_str_append_printf smart_str_append_printf
#define excimer_log_known_string ZSTR_KNOWN
#else
static inline size_t excimer_log_smart_str_get_len(smart_str *str)
{
	return str->s ? ZSTR_LEN(str->s) : 0;
}

static inline zend_string *excimer_log_smart_str_extract(smart_str *str)
{
	if (str->s) {
		zend_string *res;
		smart_str_0(str);
		res = str->s;
		str->s = NULL;
		return res;
	} else {
		return ZSTR_EMPTY_ALLOC();
	}
}


static void excimer_log_smart_str_append_printf(smart_str *dest, const char *format, ...)
{
	va_list arg;
	size_t len;
	char *buf;

	va_start(arg, format);
	len = vspprintf(&buf, 0, format, arg);
	va_end(arg);
	smart_str_appendl(dest, buf, len);
	efree(buf);
}
#define excimer_log_known_string(index) CG(known_strings)[index]
#endif

/* }}} */

void excimer_log_init(excimer_log *log)
{
	log->entries_size = 0;
	log->entries = NULL;
	log->frames = ecalloc(1, sizeof(excimer_log_frame));
	log->frames_size = 1;
	log->reverse_frames = excimer_log_new_array(0);
	log->epoch = 0;
	log->event_count = 0;
}

void excimer_log_destroy(excimer_log *log)
{
	if (log->entries) {
		efree(log->entries);
	}
	if (log->frames) {
		int i;
		for (i = 0; i < log->frames_size; i++) {
			if (log->frames[i].filename) {
				zend_string_delref(log->frames[i].filename);
			}
			if (log->frames[i].class_name) {
				zend_string_delref(log->frames[i].class_name);
			}
			if (log->frames[i].function_name) {
				zend_string_delref(log->frames[i].function_name);
			}
		}
		efree(log->frames);
	}
	zend_hash_destroy(log->reverse_frames);
	efree(log->reverse_frames);
}

void excimer_log_set_max_depth(excimer_log *log, zend_long depth)
{
	log->max_depth = depth;
}

void excimer_log_copy_options(excimer_log *dest, excimer_log  *src)
{
	dest->max_depth = src->max_depth;
	dest->epoch = src->epoch;
}

void excimer_log_add(excimer_log *log, zend_execute_data *execute_data,
	zend_long event_count, uint64_t timestamp)
{
	uint32_t frame_index = excimer_log_find_or_add_frame(log, execute_data, 0);
	excimer_log_entry *entry;

	log->entries = safe_erealloc(log->entries, log->entries_size + 1,
		sizeof(excimer_log_entry), 0);
	entry = &log->entries[log->entries_size++];
	entry->frame_index = frame_index;
	entry->event_count = event_count;
	log->event_count += event_count;
	entry->timestamp = timestamp;
}

static uint32_t excimer_log_find_or_add_frame(excimer_log *log,
	zend_execute_data *execute_data, zend_long depth)
{
	uint32_t prev_index;
	if (!execute_data) {
		return 0;
	} else if (execute_data->prev_execute_data
		&& (!log->max_depth || depth < log->max_depth))
	{
		prev_index = excimer_log_find_or_add_frame(log,
			execute_data->prev_execute_data, depth + 1);
	} else {
		prev_index = 0;
	}
	if (!execute_data->func
		|| !ZEND_USER_CODE(execute_data->func->common.type))
	{
		return prev_index;
	} else {
		zend_function *func = execute_data->func;
		excimer_log_frame frame = {NULL};
		smart_str ss_key = {NULL};
		zend_string *str_key;
		zval* zp_index;

		frame.filename = func->op_array.filename;
		zend_string_addref(frame.filename);

		if (func->common.scope && func->common.scope->name) {
			frame.class_name = func->common.scope->name;
			zend_string_addref(frame.class_name);
		}

		if (func->common.function_name) {
			frame.function_name = func->common.function_name;
			zend_string_addref(frame.function_name);
		}

		if (func->op_array.fn_flags & ZEND_ACC_CLOSURE) {
			frame.closure_line = func->op_array.line_start;
		}

		frame.lineno = execute_data->opline->lineno;
		frame.prev_index = prev_index;

		/* Make a key for reverse lookup */
		smart_str_append(&ss_key, frame.filename);
		smart_str_appendc(&ss_key, '\0');
		excimer_log_smart_str_append_printf(&ss_key, "%d", frame.lineno);
		smart_str_appendc(&ss_key, '\0');
		excimer_log_smart_str_append_printf(&ss_key, "%d", frame.prev_index);
		str_key = excimer_log_smart_str_extract(&ss_key);

		/* Look for a matching frame in the reverse hashtable */
		zp_index = zend_hash_find(log->reverse_frames, str_key);
		if (zp_index) {
			zend_string_free(str_key);
			zend_string_delref(frame.filename);
			if (frame.class_name) {
				zend_string_delref(frame.class_name);
			}
			if (frame.function_name) {
				zend_string_delref(frame.function_name);
			}

			return excimer_safe_uint32(Z_LVAL_P(zp_index));
		} else {
			zval z_new_index;

			/* Create a new entry in the array and reverse hashtable */
			ZVAL_LONG(&z_new_index, log->frames_size);
			zend_hash_add(log->reverse_frames, str_key, &z_new_index);
			log->frames = safe_erealloc(log->frames, log->frames_size + 1,
				sizeof(excimer_log_frame), 0);
			memcpy(&log->frames[log->frames_size++], &frame, sizeof(excimer_log_frame));

			zend_string_delref(str_key);
			return excimer_safe_uint32(Z_LVAL(z_new_index));
		}
	}
}

zend_long excimer_log_get_size(excimer_log *log)
{
	return log->entries_size;
}

excimer_log_entry *excimer_log_get_entry(excimer_log *log, zend_long i)
{
	if (i >= 0 && i < log->entries_size) {
		return &log->entries[i];
	} else {
		return NULL;
	}
}

excimer_log_frame *excimer_log_get_frame(excimer_log *log, zend_long i)
{
	if (i > 0 && i < log->frames_size) {
		return &log->frames[i];
	} else {
		return NULL;
	}
}

static void excimer_log_append_no_spaces(smart_str *dest, zend_string *src)
{
	size_t new_len = smart_str_alloc(dest, ZSTR_LEN(src), 0);
	size_t prev_len = ZSTR_LEN(dest->s);
	size_t i;
	for (i = 0; i < ZSTR_LEN(src); i++) {
		char c = ZSTR_VAL(src)[i];
		if (c == ' ') {
			c = '_';
		}
		ZSTR_VAL(dest->s)[prev_len + i] = c;
	}
	ZSTR_LEN(dest->s) = new_len;
}

zend_string *excimer_log_format_collapsed(excimer_log *log)
{
	zend_long entry_index;
	zend_long frame_index;
	zval *zp_count;
	smart_str buf = {NULL};
	HashTable ht_storage;
	HashTable *ht;

	ht = &ht_storage;
	memset(ht, 0, sizeof(HashTable));
	zend_hash_init(ht, 0, NULL, NULL, 0);
	excimer_log_frame ** frame_ptrs = NULL;
	size_t frames_capacity = 0;

	/* Collate frame counts */
	for (entry_index = 0; entry_index < log->entries_size; entry_index++) {
		excimer_log_entry *entry = excimer_log_get_entry(log, entry_index);
		zp_count = zend_hash_index_find(ht, entry->frame_index);
		if (!zp_count) {
			zval z_count;
			ZVAL_LONG(&z_count, 0);
			zp_count = zend_hash_index_add(ht, entry->frame_index, &z_count);
		}

		Z_LVAL_P(zp_count) += entry->event_count;
	}

	/* Format traces */
	ZEND_HASH_FOREACH_NUM_KEY_VAL(ht, frame_index, zp_count) {
		zend_long current_frame_index = frame_index;
		zend_long num_frames = 0;
		excimer_log_frame *frame;
		zend_long i;

		/* Build the array of frame pointers */
		while (current_frame_index) {
			frame = excimer_log_get_frame(log, current_frame_index);
			if (num_frames >= frames_capacity) {
				if (frames_capacity >= ZEND_LONG_MAX - 1) {
					/* Probably unreachable */
					zend_error_noreturn(E_ERROR, "Too many Excimer frames");
				}
				frames_capacity++;
				frame_ptrs = safe_erealloc(frame_ptrs, frames_capacity, sizeof(*frame_ptrs), 0);
			}
			frame_ptrs[num_frames++] = frame;
			current_frame_index = frame->prev_index;
		}

		/* Run through the array in reverse */
		for (i = num_frames - 1; i >= 0; i--) {
			frame = frame_ptrs[i];

			if (excimer_log_smart_str_get_len(&buf) != 0) {
				smart_str_appends(&buf, ";");
			}

			if (frame->closure_line != 0) {
				/* Annotate anonymous functions with their source location.
				 * Example: {closure:/path/to/file.php(123)}
				 */
				smart_str_appends(&buf, "{closure:");
				excimer_log_append_no_spaces(&buf, frame->filename);
				excimer_log_smart_str_append_printf(&buf, "(%d)}", frame->closure_line);
			} else if (frame->function_name == NULL) {
				/* For file-scope code, use the file name */
				excimer_log_append_no_spaces(&buf, frame->filename);
			} else {
				if (frame->class_name) {
					excimer_log_append_no_spaces(&buf, frame->class_name);
					smart_str_appends(&buf, "::");
				}
				excimer_log_append_no_spaces(&buf, frame->function_name);
			}
		}

		/* Append count and line break */
		excimer_log_smart_str_append_printf(&buf, " %ld\n", Z_LVAL_P(zp_count));
	}
	ZEND_HASH_FOREACH_END();
	zend_hash_destroy(ht);
	efree(frame_ptrs);
	return excimer_log_smart_str_extract(&buf);
}

HashTable *excimer_log_frame_to_array(excimer_log_frame *frame) {
	HashTable *ht_func = excimer_log_new_array(0);
	zval tmp;

	if (frame->filename) {
		ZVAL_STR_COPY(&tmp, frame->filename);
		zend_hash_add_new(ht_func, excimer_log_known_string(ZEND_STR_FILE), &tmp);
		ZVAL_LONG(&tmp, frame->lineno);
		zend_hash_add_new(ht_func, excimer_log_known_string(ZEND_STR_LINE), &tmp);
	}

	if (frame->class_name) {
		ZVAL_STR_COPY(&tmp, frame->class_name);
		zend_hash_add_new(ht_func, excimer_log_known_string(ZEND_STR_CLASS), &tmp);
	}

	if (frame->function_name) {
		ZVAL_STR_COPY(&tmp, frame->function_name);
		zend_hash_add_new(ht_func, excimer_log_known_string(ZEND_STR_FUNCTION), &tmp);
	}

	if (frame->closure_line) {
		zend_string *s = zend_string_init("closure_line", sizeof("closure_line") - 1, 0);
		ZVAL_LONG(&tmp, frame->closure_line);
		zend_hash_add_new(ht_func, s, &tmp);
		zend_string_delref(s);
	}

	return ht_func;
}

HashTable *excimer_log_trace_to_array(excimer_log *log, zend_long l_frame_index)
{
	HashTable *ht_trace = excimer_log_new_array(0);
	uint32_t frame_index = excimer_safe_uint32(l_frame_index);
	while (frame_index) {
		excimer_log_frame *frame = excimer_log_get_frame(log, frame_index);
		HashTable *ht_func = excimer_log_frame_to_array(frame);
		zval tmp;

		ZVAL_ARR(&tmp, ht_func);
		zend_hash_next_index_insert(ht_trace, &tmp);

		frame_index = frame->prev_index;
	}

	return ht_trace;
}

/**
 * ht[key] += term;
 */
static void excimer_log_array_incr(HashTable *ht, zend_string *sp_key, zend_long term)
{
	zval *zp_value = zend_hash_find(ht, sp_key);
	if (!zp_value) {
		zval z_tmp;
		ZVAL_LONG(&z_tmp, term);
		zend_hash_add_new(ht, sp_key, &z_tmp);
	} else {
		Z_LVAL_P(zp_value) += term;
	}
}

static int excimer_log_aggr_compare(const void *a, const void *b)
{
	zval *zp_a = &((Bucket*)a)->val;
	zval *zp_b = &((Bucket*)b)->val;

	zval *zp_a_incl = zend_hash_str_find(Z_ARRVAL_P(zp_a), "inclusive", sizeof("inclusive")-1);
	zval *zp_b_incl = zend_hash_str_find(Z_ARRVAL_P(zp_b), "inclusive", sizeof("inclusive")-1);

	return ZEND_NORMALIZE_BOOL(Z_LVAL_P(zp_b_incl) - Z_LVAL_P(zp_a_incl));
}

HashTable *excimer_log_aggr_by_func(excimer_log *log)
{
	HashTable *ht_result = excimer_log_new_array(0);
	zend_string *sp_inclusive = zend_string_init("inclusive", sizeof("inclusive")-1, 0);
	zend_string *sp_self = zend_string_init("self", sizeof("self")-1, 0);
	HashTable *ht_unique_names = excimer_log_new_array(0);
	size_t entry_index;
	zval z_zero;

	ZVAL_LONG(&z_zero, 0);

	for (entry_index = 0; entry_index < log->entries_size; entry_index++) {
		excimer_log_entry *entry = excimer_log_get_entry(log, entry_index);
		uint32_t frame_index = entry->frame_index;
		int is_top = 1;

		while (frame_index) {
			excimer_log_frame *frame = excimer_log_get_frame(log, frame_index);
			smart_str ss_name = {NULL};
			zend_string *sp_name;
			zval *zp_info;
			zval z_tmp;

			/* Make a human-readable name */
			if (frame->closure_line != 0) {
				/* Annotate anonymous functions with their source location.
				 * Example: {closure:/path/to/file.php(123)}
				 */
				smart_str_appends(&ss_name, "{closure:");
				smart_str_append(&ss_name, frame->filename);
				excimer_log_smart_str_append_printf(&ss_name, "(%d)}", frame->closure_line);
			} else if (frame->function_name == NULL) {
				/* For file-scope code, use the file name */
				smart_str_append(&ss_name, frame->filename);
			} else {
				if (frame->class_name) {
					smart_str_append(&ss_name, frame->class_name);
					smart_str_appends(&ss_name, "::");
				}
				smart_str_append(&ss_name, frame->function_name);
			}
			sp_name = excimer_log_smart_str_extract(&ss_name);

			/* If it is not in ht_result, add it, along with frame info */
			zp_info = zend_hash_find(ht_result, sp_name);
			if (!zp_info) {
				ZVAL_ARR(&z_tmp, excimer_log_frame_to_array(frame));
				zend_hash_add_new(Z_ARRVAL(z_tmp), sp_self, &z_zero);
				zend_hash_add_new(Z_ARRVAL(z_tmp), sp_inclusive, &z_zero);
				zp_info = zend_hash_add(ht_result, sp_name, &z_tmp);
			}

			/* If this is the top frame of a log entry, increment the "self" key */
			if (is_top) {
				excimer_log_array_incr(Z_ARRVAL_P(zp_info), sp_self, entry->event_count);
			}

			/* If this is the first instance of a function in an entry, i.e.
			 * counting recursive functions only once, increment the "inclusive" key */
			if (zend_hash_find(ht_unique_names, sp_name) == NULL) {
				excimer_log_array_incr(Z_ARRVAL_P(zp_info), sp_inclusive, entry->event_count);
				/* Add the function to the unique_names array */
				zend_hash_add_new(ht_unique_names, sp_name, &z_zero);
			}

			is_top = 0;
			frame_index = frame->prev_index;
			zend_string_delref(sp_name);
		}
		zend_hash_clean(ht_unique_names);
	}
	zend_hash_destroy(ht_unique_names);
	zend_string_delref(sp_self);
	zend_string_delref(sp_inclusive);

	/* Sort the result in descending order by inclusive */
	zend_hash_sort(ht_result, excimer_log_aggr_compare, 0);

	return ht_result;
}