/src/php-src/Zend/Optimizer/zend_call_graph.c

Source
/*
   +----------------------------------------------------------------------+
   | Zend Engine, Call Graph                                              |
   +----------------------------------------------------------------------+
   | Copyright (c) The PHP Group                                          |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.01 of the PHP license,      |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | https://www.php.net/license/3_01.txt                                 |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Authors: Dmitry Stogov <dmitry@php.net>                              |
   +----------------------------------------------------------------------+
*/

#include "zend_compile.h"
#include "zend_extensions.h"
#include "Optimizer/zend_optimizer.h"
#include "zend_optimizer_internal.h"
#include "zend_inference.h"
#include "zend_call_graph.h"
#include "zend_func_info.h"
#include "zend_inference.h"
#include "zend_call_graph.h"

static void zend_op_array_calc(zend_op_array *op_array, void *context)
{
  zend_call_graph *call_graph = context;
  call_graph->op_arrays_count++;
}

static void zend_op_array_collect(zend_op_array *op_array, void *context)
{
  zend_call_graph *call_graph = context;
  zend_func_info *func_info = call_graph->func_infos + call_graph->op_arrays_count;

  ZEND_SET_FUNC_INFO(op_array, func_info);
  call_graph->op_arrays[call_graph->op_arrays_count] = op_array;
  func_info->num = call_graph->op_arrays_count;
  call_graph->op_arrays_count++;
}

ZEND_API void zend_analyze_calls(zend_arena **arena, zend_script *script, uint32_t build_flags, zend_op_array *op_array, zend_func_info *func_info)
{
  zend_op *opline = op_array->opcodes;
  zend_op *end = opline + op_array->last;
  zend_function *func;
  zend_call_info *call_info;
  int call = 0;
  zend_call_info **call_stack;
  ALLOCA_FLAG(use_heap);
  bool is_prototype;

  call_stack = do_alloca((op_array->last / 2) * sizeof(zend_call_info*), use_heap);
  call_info = NULL;
  while (opline != end) {
    switch (opline->opcode) {
      case ZEND_INIT_FCALL:
      case ZEND_INIT_METHOD_CALL:
      case ZEND_INIT_STATIC_METHOD_CALL:
      case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
        call_stack[call] = call_info;
        func = zend_optimizer_get_called_func(
          script, op_array, opline, &is_prototype);
        if (func) {
          call_info = zend_arena_calloc(arena, 1, sizeof(zend_call_info) + (sizeof(zend_send_arg_info) * ((int)opline->extended_value - 1)));
          call_info->caller_op_array = op_array;
          call_info->caller_init_opline = opline;
          call_info->caller_call_opline = NULL;
          call_info->callee_func = func;
          call_info->num_args = opline->extended_value;
          call_info->next_callee = func_info->callee_info;
          call_info->is_prototype = is_prototype;
          call_info->is_frameless = false;
          func_info->callee_info = call_info;

          if (build_flags & ZEND_CALL_TREE) {
            call_info->next_caller = NULL;
          } else if (func->type == ZEND_INTERNAL_FUNCTION
           || func->op_array.filename != script->filename) {
            call_info->next_caller = NULL;
          } else {
            zend_func_info *callee_func_info = ZEND_FUNC_INFO(&func->op_array);
            if (callee_func_info) {
              call_info->next_caller = callee_func_info->caller_info;
              callee_func_info->caller_info = call_info;
            } else {
              call_info->next_caller = NULL;
            }
          }
        } else {
          call_info = NULL;
        }
        call++;
        break;
      case ZEND_INIT_FCALL_BY_NAME:
      case ZEND_INIT_NS_FCALL_BY_NAME:
      case ZEND_INIT_DYNAMIC_CALL:
      case ZEND_NEW:
      case ZEND_INIT_USER_CALL:
        call_stack[call] = call_info;
        call_info = NULL;
        call++;
        break;
      case ZEND_FRAMELESS_ICALL_0:
      case ZEND_FRAMELESS_ICALL_1:
      case ZEND_FRAMELESS_ICALL_2:
      case ZEND_FRAMELESS_ICALL_3: {
        func = ZEND_FLF_FUNC(opline);
        zend_call_info *call_info = zend_arena_calloc(arena, 1, sizeof(zend_call_info));
        call_info->caller_op_array = op_array;
        call_info->caller_init_opline = opline;
        call_info->caller_call_opline = NULL;
        call_info->callee_func = func;
        call_info->num_args = ZEND_FLF_NUM_ARGS(opline->opcode);
        call_info->next_callee = func_info->callee_info;
        call_info->is_prototype = false;
        call_info->is_frameless = true;
        call_info->next_caller = NULL;
        func_info->callee_info = call_info;
        break;
      }
      case ZEND_DO_FCALL:
      case ZEND_DO_ICALL:
      case ZEND_DO_UCALL:
      case ZEND_DO_FCALL_BY_NAME:
      case ZEND_CALLABLE_CONVERT:
        func_info->flags |= ZEND_FUNC_HAS_CALLS;
        if (call_info) {
          call_info->caller_call_opline = opline;
        }
        call--;
        call_info = call_stack[call];
        break;
      case ZEND_SEND_VAL:
      case ZEND_SEND_VAR:
      case ZEND_SEND_VAL_EX:
      case ZEND_SEND_VAR_EX:
      case ZEND_SEND_FUNC_ARG:
      case ZEND_SEND_REF:
      case ZEND_SEND_VAR_NO_REF:
      case ZEND_SEND_VAR_NO_REF_EX:
      case ZEND_SEND_USER:
        if (call_info) {
          if (opline->op2_type == IS_CONST) {
            call_info->named_args = true;
            break;
          }

          uint32_t num = opline->op2.num;
          if (num > 0) {
            num--;
          }
          call_info->arg_info[num].opline = opline;
        }
        break;
      case ZEND_SEND_ARRAY:
      case ZEND_SEND_UNPACK:
        if (call_info) {
          call_info->send_unpack = true;
        }
        break;
    }
    opline++;
  }
  free_alloca(call_stack, use_heap);
}

static bool zend_is_indirectly_recursive(const zend_op_array *root, const zend_op_array *op_array, zend_bitset visited)
{
  const zend_func_info *func_info;
  zend_call_info *call_info;
  bool ret = false;

  if (op_array == root) {
    return true;
  }

  func_info = ZEND_FUNC_INFO(op_array);
  if (zend_bitset_in(visited, func_info->num)) {
    return false;
  }
  zend_bitset_incl(visited, func_info->num);
  call_info = func_info->caller_info;
  while (call_info) {
    if (zend_is_indirectly_recursive(root, call_info->caller_op_array, visited)) {
      call_info->recursive = true;
      ret = true;
    }
    call_info = call_info->next_caller;
  }
  return ret;
}

static void zend_analyze_recursion(zend_call_graph *call_graph)
{
  const zend_op_array *op_array;
  zend_func_info *func_info;
  zend_call_info *call_info;
  uint32_t set_len = zend_bitset_len(call_graph->op_arrays_count);
  zend_bitset visited;
  ALLOCA_FLAG(use_heap);

  visited = ZEND_BITSET_ALLOCA(set_len, use_heap);
  for (uint32_t i = 0; i < call_graph->op_arrays_count; i++) {
    op_array = call_graph->op_arrays[i];
    func_info = call_graph->func_infos + i;
    call_info = func_info->caller_info;
    for (; call_info; call_info = call_info->next_caller) {
      if (call_info->is_prototype) {
        /* Might be calling an overridden child method and not actually recursive. */
        continue;
      }
      if (call_info->caller_op_array == op_array) {
        call_info->recursive = true;
        func_info->flags |= ZEND_FUNC_RECURSIVE | ZEND_FUNC_RECURSIVE_DIRECTLY;
      } else {
        memset(visited, 0, sizeof(zend_ulong) * set_len);
        if (zend_is_indirectly_recursive(op_array, call_info->caller_op_array, visited)) {
          call_info->recursive = true;
          func_info->flags |= ZEND_FUNC_RECURSIVE | ZEND_FUNC_RECURSIVE_INDIRECTLY;
        }
      }
    }
  }

  free_alloca(visited, use_heap);
}

static void zend_sort_op_arrays(zend_call_graph *call_graph)
{
  (void) call_graph;

  // TODO: perform topological sort of cyclic call graph
}

ZEND_API void zend_build_call_graph(zend_arena **arena, zend_script *script, zend_call_graph *call_graph) /* {{{ */
{
  call_graph->op_arrays_count = 0;
  zend_foreach_op_array(script, zend_op_array_calc, call_graph);

  call_graph->op_arrays = (zend_op_array**)zend_arena_calloc(arena, call_graph->op_arrays_count, sizeof(zend_op_array*));
  call_graph->func_infos = (zend_func_info*)zend_arena_calloc(arena, call_graph->op_arrays_count, sizeof(zend_func_info));
  call_graph->op_arrays_count = 0;
  zend_foreach_op_array(script, zend_op_array_collect, call_graph);
}
/* }}} */

ZEND_API void zend_analyze_call_graph(zend_arena **arena, zend_script *script, zend_call_graph *call_graph) /* {{{ */
{
  for (uint32_t i = 0; i < call_graph->op_arrays_count; i++) {
    zend_analyze_calls(arena, script, 0, call_graph->op_arrays[i], call_graph->func_infos + i);
  }
  zend_analyze_recursion(call_graph);
  zend_sort_op_arrays(call_graph);
}
/* }}} */

ZEND_API zend_call_info **zend_build_call_map(zend_arena **arena, const zend_func_info *info, const zend_op_array *op_array) /* {{{ */
{
  zend_call_info **map, *call;
  if (!info->callee_info) {
    /* Don't build call map if function contains no calls */
    return NULL;
  }

  map = zend_arena_calloc(arena, sizeof(zend_call_info *), op_array->last);
  for (call = info->callee_info; call; call = call->next_callee) {
    map[call->caller_init_opline - op_array->opcodes] = call;
    if (call->caller_call_opline) {
      map[call->caller_call_opline - op_array->opcodes] = call;
    }
    if (!call->is_frameless) {
      for (uint32_t i = 0; i < call->num_args; i++) {
        if (call->arg_info[i].opline) {
          map[call->arg_info[i].opline - op_array->opcodes] = call;
        }
      }
    }
  }
  return map;
}
/* }}} */

Coverage Report

Created: 2025-12-14 06:09

Line	Count	Source
1		/*
2		+----------------------------------------------------------------------+
3		\| Zend Engine, Call Graph \|
4		+----------------------------------------------------------------------+
5		\| Copyright (c) The PHP Group \|
6		+----------------------------------------------------------------------+
7		\| This source file is subject to version 3.01 of the PHP license, \|
8		\| that is bundled with this package in the file LICENSE, and is \|
9		\| available through the world-wide-web at the following url: \|
10		\| https://www.php.net/license/3_01.txt \|
11		\| If you did not receive a copy of the PHP license and are unable to \|
12		\| obtain it through the world-wide-web, please send a note to \|
13		\| license@php.net so we can mail you a copy immediately. \|
14		+----------------------------------------------------------------------+
15		\| Authors: Dmitry Stogov <dmitry@php.net> \|
16		+----------------------------------------------------------------------+
17		*/
18
19		#include "zend_compile.h"
20		#include "zend_extensions.h"
21		#include "Optimizer/zend_optimizer.h"
22		#include "zend_optimizer_internal.h"
23		#include "zend_inference.h"
24		#include "zend_call_graph.h"
25		#include "zend_func_info.h"
26		#include "zend_inference.h"
27		#include "zend_call_graph.h"
28
29		static void zend_op_array_calc(zend_op_array op_array, void context)
30	54.8k	{
31	54.8k	zend_call_graph *call_graph = context;
32	54.8k	call_graph->op_arrays_count++;
33	54.8k	}
34
35		static void zend_op_array_collect(zend_op_array op_array, void context)
36	54.8k	{
37	54.8k	zend_call_graph *call_graph = context;
38	54.8k	zend_func_info *func_info = call_graph->func_infos + call_graph->op_arrays_count;
39
40	54.8k	ZEND_SET_FUNC_INFO(op_array, func_info);
41	54.8k	call_graph->op_arrays[call_graph->op_arrays_count] = op_array;
42	54.8k	func_info->num = call_graph->op_arrays_count;
43	54.8k	call_graph->op_arrays_count++;
44	54.8k	}
45
46		ZEND_API void zend_analyze_calls(zend_arena *arena, zend_script script, uint32_t build_flags, zend_op_array op_array, zend_func_info func_info)
47	54.8k	{
48	54.8k	zend_op *opline = op_array->opcodes;
49	54.8k	zend_op *end = opline + op_array->last;
50	54.8k	zend_function *func;
51	54.8k	zend_call_info *call_info;
52	54.8k	int call = 0;
53	54.8k	zend_call_info **call_stack;
54	54.8k	ALLOCA_FLAG(use_heap);
55	54.8k	bool is_prototype;
56
57	54.8k	call_stack = do_alloca((op_array->last / 2) * sizeof(zend_call_info*), use_heap);
58	54.8k	call_info = NULL;
59	1.51M	while (opline != end) {
60	1.46M	switch (opline->opcode) {
61	57.7k	case ZEND_INIT_FCALL:
62	78.9k	case ZEND_INIT_METHOD_CALL:
63	82.7k	case ZEND_INIT_STATIC_METHOD_CALL:
64	82.8k	case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
65	82.8k	call_stack[call] = call_info;
66	82.8k	func = zend_optimizer_get_called_func(
67	82.8k	script, op_array, opline, &is_prototype);
68	82.8k	if (func) {
69	60.2k	call_info = zend_arena_calloc(arena, 1, sizeof(zend_call_info) + (sizeof(zend_send_arg_info) * ((int)opline->extended_value - 1)));
70	60.2k	call_info->caller_op_array = op_array;
71	60.2k	call_info->caller_init_opline = opline;
72	60.2k	call_info->caller_call_opline = NULL;
73	60.2k	call_info->callee_func = func;
74	60.2k	call_info->num_args = opline->extended_value;
75	60.2k	call_info->next_callee = func_info->callee_info;
76	60.2k	call_info->is_prototype = is_prototype;
77	60.2k	call_info->is_frameless = false;
78	60.2k	func_info->callee_info = call_info;
79
80	60.2k	if (build_flags & ZEND_CALL_TREE) {
81	0	call_info->next_caller = NULL;
82	60.2k	} else if (func->type == ZEND_INTERNAL_FUNCTION
83	47.6k	\|\| func->op_array.filename != script->filename) {
84	47.6k	call_info->next_caller = NULL;
85	47.6k	} else {
86	12.6k	zend_func_info *callee_func_info = ZEND_FUNC_INFO(&func->op_array);
87	12.6k	if (callee_func_info) {
88	12.6k	call_info->next_caller = callee_func_info->caller_info;
89	12.6k	callee_func_info->caller_info = call_info;
90	12.6k	} else {
91	12	call_info->next_caller = NULL;
92	12	}
93	12.6k	}
94	60.2k	} else {
95	22.5k	call_info = NULL;
96	22.5k	}
97	82.8k	call++;
98	82.8k	break;
99	4.67k	case ZEND_INIT_FCALL_BY_NAME:
100	6.02k	case ZEND_INIT_NS_FCALL_BY_NAME:
101	8.69k	case ZEND_INIT_DYNAMIC_CALL:
102	41.2k	case ZEND_NEW:
103	41.6k	case ZEND_INIT_USER_CALL:
104	41.6k	call_stack[call] = call_info;
105	41.6k	call_info = NULL;
106	41.6k	call++;
107	41.6k	break;
108	0	case ZEND_FRAMELESS_ICALL_0:
109	0	case ZEND_FRAMELESS_ICALL_1:
110	0	case ZEND_FRAMELESS_ICALL_2:
111	0	case ZEND_FRAMELESS_ICALL_3: {
112	0	func = ZEND_FLF_FUNC(opline);
113	0	zend_call_info *call_info = zend_arena_calloc(arena, 1, sizeof(zend_call_info));
114	0	call_info->caller_op_array = op_array;
115	0	call_info->caller_init_opline = opline;
116	0	call_info->caller_call_opline = NULL;
117	0	call_info->callee_func = func;
118	0	call_info->num_args = ZEND_FLF_NUM_ARGS(opline->opcode);
119	0	call_info->next_callee = func_info->callee_info;
120	0	call_info->is_prototype = false;
121	0	call_info->is_frameless = true;
122	0	call_info->next_caller = NULL;
123	0	func_info->callee_info = call_info;
124	0	break;
125	0	}
126	118k	case ZEND_DO_FCALL:
127	118k	case ZEND_DO_ICALL:
128	124k	case ZEND_DO_UCALL:
129	124k	case ZEND_DO_FCALL_BY_NAME:
130	124k	case ZEND_CALLABLE_CONVERT:
131	124k	func_info->flags \|= ZEND_FUNC_HAS_CALLS;
132	124k	if (call_info) {
133	60.2k	call_info->caller_call_opline = opline;
134	60.2k	}
135	124k	call--;
136	124k	call_info = call_stack[call];
137	124k	break;
138	43.7k	case ZEND_SEND_VAL:
139	100k	case ZEND_SEND_VAR:
140	109k	case ZEND_SEND_VAL_EX:
141	114k	case ZEND_SEND_VAR_EX:
142	115k	case ZEND_SEND_FUNC_ARG:
143	116k	case ZEND_SEND_REF:
144	116k	case ZEND_SEND_VAR_NO_REF:
145	118k	case ZEND_SEND_VAR_NO_REF_EX:
146	119k	case ZEND_SEND_USER:
147	119k	if (call_info) {
148	63.6k	if (opline->op2_type == IS_CONST) {
149	636	call_info->named_args = true;
150	636	break;
151	636	}
152
153	62.9k	uint32_t num = opline->op2.num;
154	62.9k	if (num > 0) {
155	62.9k	num--;
156	62.9k	}
157	62.9k	call_info->arg_info[num].opline = opline;
158	62.9k	}
159	118k	break;
160	118k	case ZEND_SEND_ARRAY:
161	707	case ZEND_SEND_UNPACK:
162	707	if (call_info) {
163	462	call_info->send_unpack = true;
164	462	}
165	707	break;
166	1.46M	}
167	1.46M	opline++;
168	1.46M	}
169	54.8k	free_alloca(call_stack, use_heap);
170	54.8k	}
171
172		static bool zend_is_indirectly_recursive(const zend_op_array root, const zend_op_array op_array, zend_bitset visited)
173	13.9k	{
174	13.9k	const zend_func_info *func_info;
175	13.9k	zend_call_info *call_info;
176	13.9k	bool ret = false;
177
178	13.9k	if (op_array == root) {
179	0	return true;
180	0	}
181
182	13.9k	func_info = ZEND_FUNC_INFO(op_array);
183	13.9k	if (zend_bitset_in(visited, func_info->num)) {
184	966	return false;
185	966	}
186	13.0k	zend_bitset_incl(visited, func_info->num);
187	13.0k	call_info = func_info->caller_info;
188	14.7k	while (call_info) {
189	1.67k	if (zend_is_indirectly_recursive(root, call_info->caller_op_array, visited)) {
190	0	call_info->recursive = true;
191	0	ret = true;
192	0	}
193	1.67k	call_info = call_info->next_caller;
194	1.67k	}
195	13.0k	return ret;
196	13.9k	}
197
198		static void zend_analyze_recursion(zend_call_graph *call_graph)
199	33.0k	{
200	33.0k	const zend_op_array *op_array;
201	33.0k	zend_func_info *func_info;
202	33.0k	zend_call_info *call_info;
203	33.0k	uint32_t set_len = zend_bitset_len(call_graph->op_arrays_count);
204	33.0k	zend_bitset visited;
205	33.0k	ALLOCA_FLAG(use_heap);
206
207	33.0k	visited = ZEND_BITSET_ALLOCA(set_len, use_heap);
208	87.9k	for (uint32_t i = 0; i < call_graph->op_arrays_count; i++) {
209	54.8k	op_array = call_graph->op_arrays[i];
210	54.8k	func_info = call_graph->func_infos + i;
211	54.8k	call_info = func_info->caller_info;
212	67.5k	for (; call_info; call_info = call_info->next_caller) {
213	12.6k	if (call_info->is_prototype) {
214		/* Might be calling an overridden child method and not actually recursive. */
215	178	continue;
216	178	}
217	12.4k	if (call_info->caller_op_array == op_array) {
218	116	call_info->recursive = true;
219	116	func_info->flags \|= ZEND_FUNC_RECURSIVE \| ZEND_FUNC_RECURSIVE_DIRECTLY;
220	12.3k	} else {
221	12.3k	memset(visited, 0, sizeof(zend_ulong) * set_len);
222	12.3k	if (zend_is_indirectly_recursive(op_array, call_info->caller_op_array, visited)) {
223	0	call_info->recursive = true;
224	0	func_info->flags \|= ZEND_FUNC_RECURSIVE \| ZEND_FUNC_RECURSIVE_INDIRECTLY;
225	0	}
226	12.3k	}
227	12.4k	}
228	54.8k	}
229
230	33.0k	free_alloca(visited, use_heap);
231	33.0k	}
232
233		static void zend_sort_op_arrays(zend_call_graph *call_graph)
234	33.0k	{
235	33.0k	(void) call_graph;
236
237		// TODO: perform topological sort of cyclic call graph
238	33.0k	}
239
240		ZEND_API void zend_build_call_graph(zend_arena *arena, zend_script script, zend_call_graph call_graph) / {{{ */
241	33.0k	{
242	33.0k	call_graph->op_arrays_count = 0;
243	33.0k	zend_foreach_op_array(script, zend_op_array_calc, call_graph);
244
245	33.0k	call_graph->op_arrays = (zend_op_array*)zend_arena_calloc(arena, call_graph->op_arrays_count, sizeof(zend_op_array));
246	33.0k	call_graph->func_infos = (zend_func_info*)zend_arena_calloc(arena, call_graph->op_arrays_count, sizeof(zend_func_info));
247	33.0k	call_graph->op_arrays_count = 0;
248	33.0k	zend_foreach_op_array(script, zend_op_array_collect, call_graph);
249	33.0k	}
250		/* }}} */
251
252		ZEND_API void zend_analyze_call_graph(zend_arena *arena, zend_script script, zend_call_graph call_graph) / {{{ */
253	33.0k	{
254	87.9k	for (uint32_t i = 0; i < call_graph->op_arrays_count; i++) {
255	54.8k	zend_analyze_calls(arena, script, 0, call_graph->op_arrays[i], call_graph->func_infos + i);
256	54.8k	}
257	33.0k	zend_analyze_recursion(call_graph);
258	33.0k	zend_sort_op_arrays(call_graph);
259	33.0k	}
260		/* }}} */
261
262		ZEND_API zend_call_info zend_build_call_map(zend_arena arena, const zend_func_info info, const zend_op_array op_array) /* {{{ */
263	54.8k	{
264	54.8k	zend_call_info *map, call;
265	54.8k	if (!info->callee_info) {
266		/* Don't build call map if function contains no calls */
267	32.2k	return NULL;
268	32.2k	}
269
270	22.6k	map = zend_arena_calloc(arena, sizeof(zend_call_info *), op_array->last);
271	82.8k	for (call = info->callee_info; call; call = call->next_callee) {
272	60.2k	map[call->caller_init_opline - op_array->opcodes] = call;
273	60.2k	if (call->caller_call_opline) {
274	60.2k	map[call->caller_call_opline - op_array->opcodes] = call;
275	60.2k	}
276	60.2k	if (!call->is_frameless) {
277	123k	for (uint32_t i = 0; i < call->num_args; i++) {
278	62.9k	if (call->arg_info[i].opline) {
279	62.9k	map[call->arg_info[i].opline - op_array->opcodes] = call;
280	62.9k	}
281	62.9k	}
282	60.2k	}
283	60.2k	}
284	22.6k	return map;
285	54.8k	}
286		/* }}} */