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

Source
/*
   +----------------------------------------------------------------------+
   | Zend Engine, Call Graph                                              |
   +----------------------------------------------------------------------+
   | Copyright © The PHP Group and Contributors.                          |
   +----------------------------------------------------------------------+
   | This source file is subject to the Modified BSD License that is      |
   | bundled with this package in the file LICENSE, and is available      |
   | through the World Wide Web at <https://www.php.net/license/>.        |
   |                                                                      |
   | SPDX-License-Identifier: BSD-3-Clause                                |
   +----------------------------------------------------------------------+
   | 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"

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:
      case ZEND_CALLABLE_CONVERT_PARTIAL:
        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:
      case ZEND_SEND_PLACEHOLDER:
        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: 2026-09-14 06:25

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