/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"

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: 2026-02-09 07:07

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
27		static void zend_op_array_calc(zend_op_array op_array, void context)
28	89.7k	{
29	89.7k	zend_call_graph *call_graph = context;
30	89.7k	call_graph->op_arrays_count++;
31	89.7k	}
32
33		static void zend_op_array_collect(zend_op_array op_array, void context)
34	89.7k	{
35	89.7k	zend_call_graph *call_graph = context;
36	89.7k	zend_func_info *func_info = call_graph->func_infos + call_graph->op_arrays_count;
37
38	89.7k	ZEND_SET_FUNC_INFO(op_array, func_info);
39	89.7k	call_graph->op_arrays[call_graph->op_arrays_count] = op_array;
40	89.7k	func_info->num = call_graph->op_arrays_count;
41	89.7k	call_graph->op_arrays_count++;
42	89.7k	}
43
44		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)
45	89.7k	{
46	89.7k	zend_op *opline = op_array->opcodes;
47	89.7k	zend_op *end = opline + op_array->last;
48	89.7k	zend_function *func;
49	89.7k	zend_call_info *call_info;
50	89.7k	int call = 0;
51	89.7k	zend_call_info **call_stack;
52	89.7k	ALLOCA_FLAG(use_heap);
53	89.7k	bool is_prototype;
54
55	89.7k	call_stack = do_alloca((op_array->last / 2) * sizeof(zend_call_info*), use_heap);
56	89.7k	call_info = NULL;
57	2.35M	while (opline != end) {
58	2.26M	switch (opline->opcode) {
59	100k	case ZEND_INIT_FCALL:
60	137k	case ZEND_INIT_METHOD_CALL:
61	143k	case ZEND_INIT_STATIC_METHOD_CALL:
62	143k	case ZEND_INIT_PARENT_PROPERTY_HOOK_CALL:
63	143k	call_stack[call] = call_info;
64	143k	func = zend_optimizer_get_called_func(
65	143k	script, op_array, opline, &is_prototype);
66	143k	if (func) {
67	104k	call_info = zend_arena_calloc(arena, 1, sizeof(zend_call_info) + (sizeof(zend_send_arg_info) * ((int)opline->extended_value - 1)));
68	104k	call_info->caller_op_array = op_array;
69	104k	call_info->caller_init_opline = opline;
70	104k	call_info->caller_call_opline = NULL;
71	104k	call_info->callee_func = func;
72	104k	call_info->num_args = opline->extended_value;
73	104k	call_info->next_callee = func_info->callee_info;
74	104k	call_info->is_prototype = is_prototype;
75	104k	call_info->is_frameless = false;
76	104k	func_info->callee_info = call_info;
77
78	104k	if (build_flags & ZEND_CALL_TREE) {
79	0	call_info->next_caller = NULL;
80	104k	} else if (func->type == ZEND_INTERNAL_FUNCTION
81	83.6k	\|\| func->op_array.filename != script->filename) {
82	83.6k	call_info->next_caller = NULL;
83	83.6k	} else {
84	20.8k	zend_func_info *callee_func_info = ZEND_FUNC_INFO(&func->op_array);
85	20.8k	if (callee_func_info) {
86	20.8k	call_info->next_caller = callee_func_info->caller_info;
87	20.8k	callee_func_info->caller_info = call_info;
88	20.8k	} else {
89	16	call_info->next_caller = NULL;
90	16	}
91	20.8k	}
92	104k	} else {
93	38.9k	call_info = NULL;
94	38.9k	}
95	143k	call++;
96	143k	break;
97	4.92k	case ZEND_INIT_FCALL_BY_NAME:
98	7.17k	case ZEND_INIT_NS_FCALL_BY_NAME:
99	11.5k	case ZEND_INIT_DYNAMIC_CALL:
100	63.1k	case ZEND_NEW:
101	63.7k	case ZEND_INIT_USER_CALL:
102	63.7k	call_stack[call] = call_info;
103	63.7k	call_info = NULL;
104	63.7k	call++;
105	63.7k	break;
106	0	case ZEND_FRAMELESS_ICALL_0:
107	0	case ZEND_FRAMELESS_ICALL_1:
108	0	case ZEND_FRAMELESS_ICALL_2:
109	0	case ZEND_FRAMELESS_ICALL_3: {
110	0	func = ZEND_FLF_FUNC(opline);
111	0	zend_call_info *call_info = zend_arena_calloc(arena, 1, sizeof(zend_call_info));
112	0	call_info->caller_op_array = op_array;
113	0	call_info->caller_init_opline = opline;
114	0	call_info->caller_call_opline = NULL;
115	0	call_info->callee_func = func;
116	0	call_info->num_args = ZEND_FLF_NUM_ARGS(opline->opcode);
117	0	call_info->next_callee = func_info->callee_info;
118	0	call_info->is_prototype = false;
119	0	call_info->is_frameless = true;
120	0	call_info->next_caller = NULL;
121	0	func_info->callee_info = call_info;
122	0	break;
123	0	}
124	197k	case ZEND_DO_FCALL:
125	197k	case ZEND_DO_ICALL:
126	206k	case ZEND_DO_UCALL:
127	206k	case ZEND_DO_FCALL_BY_NAME:
128	207k	case ZEND_CALLABLE_CONVERT:
129	207k	func_info->flags \|= ZEND_FUNC_HAS_CALLS;
130	207k	if (call_info) {
131	104k	call_info->caller_call_opline = opline;
132	104k	}
133	207k	call--;
134	207k	call_info = call_stack[call];
135	207k	break;
136	102k	case ZEND_SEND_VAL:
137	164k	case ZEND_SEND_VAR:
138	178k	case ZEND_SEND_VAL_EX:
139	188k	case ZEND_SEND_VAR_EX:
140	189k	case ZEND_SEND_FUNC_ARG:
141	191k	case ZEND_SEND_REF:
142	191k	case ZEND_SEND_VAR_NO_REF:
143	193k	case ZEND_SEND_VAR_NO_REF_EX:
144	195k	case ZEND_SEND_USER:
145	195k	if (call_info) {
146	112k	if (opline->op2_type == IS_CONST) {
147	1.21k	call_info->named_args = true;
148	1.21k	break;
149	1.21k	}
150
151	111k	uint32_t num = opline->op2.num;
152	111k	if (num > 0) {
153	111k	num--;
154	111k	}
155	111k	call_info->arg_info[num].opline = opline;
156	111k	}
157	194k	break;
158	194k	case ZEND_SEND_ARRAY:
159	1.17k	case ZEND_SEND_UNPACK:
160	1.17k	if (call_info) {
161	782	call_info->send_unpack = true;
162	782	}
163	1.17k	break;
164	2.26M	}
165	2.26M	opline++;
166	2.26M	}
167	89.7k	free_alloca(call_stack, use_heap);
168	89.7k	}
169
170		static bool zend_is_indirectly_recursive(const zend_op_array root, const zend_op_array op_array, zend_bitset visited)
171	23.1k	{
172	23.1k	const zend_func_info *func_info;
173	23.1k	zend_call_info *call_info;
174	23.1k	bool ret = false;
175
176	23.1k	if (op_array == root) {
177	0	return true;
178	0	}
179
180	23.1k	func_info = ZEND_FUNC_INFO(op_array);
181	23.1k	if (zend_bitset_in(visited, func_info->num)) {
182	1.46k	return false;
183	1.46k	}
184	21.6k	zend_bitset_incl(visited, func_info->num);
185	21.6k	call_info = func_info->caller_info;
186	24.4k	while (call_info) {
187	2.74k	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	2.74k	call_info = call_info->next_caller;
192	2.74k	}
193	21.6k	return ret;
194	23.1k	}
195
196		static void zend_analyze_recursion(zend_call_graph *call_graph)
197	49.8k	{
198	49.8k	const zend_op_array *op_array;
199	49.8k	zend_func_info *func_info;
200	49.8k	zend_call_info *call_info;
201	49.8k	uint32_t set_len = zend_bitset_len(call_graph->op_arrays_count);
202	49.8k	zend_bitset visited;
203	49.8k	ALLOCA_FLAG(use_heap);
204
205	49.8k	visited = ZEND_BITSET_ALLOCA(set_len, use_heap);
206	139k	for (uint32_t i = 0; i < call_graph->op_arrays_count; i++) {
207	89.7k	op_array = call_graph->op_arrays[i];
208	89.7k	func_info = call_graph->func_infos + i;
209	89.7k	call_info = func_info->caller_info;
210	110k	for (; call_info; call_info = call_info->next_caller) {
211	20.8k	if (call_info->is_prototype) {
212		/* Might be calling an overridden child method and not actually recursive. */
213	344	continue;
214	344	}
215	20.5k	if (call_info->caller_op_array == op_array) {
216	162	call_info->recursive = true;
217	162	func_info->flags \|= ZEND_FUNC_RECURSIVE \| ZEND_FUNC_RECURSIVE_DIRECTLY;
218	20.3k	} else {
219	20.3k	memset(visited, 0, sizeof(zend_ulong) * set_len);
220	20.3k	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	20.3k	}
225	20.5k	}
226	89.7k	}
227
228	49.8k	free_alloca(visited, use_heap);
229	49.8k	}
230
231		static void zend_sort_op_arrays(zend_call_graph *call_graph)
232	49.8k	{
233	49.8k	(void) call_graph;
234
235		// TODO: perform topological sort of cyclic call graph
236	49.8k	}
237
238		ZEND_API void zend_build_call_graph(zend_arena *arena, zend_script script, zend_call_graph call_graph) / {{{ */
239	49.8k	{
240	49.8k	call_graph->op_arrays_count = 0;
241	49.8k	zend_foreach_op_array(script, zend_op_array_calc, call_graph);
242
243	49.8k	call_graph->op_arrays = (zend_op_array*)zend_arena_calloc(arena, call_graph->op_arrays_count, sizeof(zend_op_array));
244	49.8k	call_graph->func_infos = (zend_func_info*)zend_arena_calloc(arena, call_graph->op_arrays_count, sizeof(zend_func_info));
245	49.8k	call_graph->op_arrays_count = 0;
246	49.8k	zend_foreach_op_array(script, zend_op_array_collect, call_graph);
247	49.8k	}
248		/* }}} */
249
250		ZEND_API void zend_analyze_call_graph(zend_arena *arena, zend_script script, zend_call_graph call_graph) / {{{ */
251	49.8k	{
252	139k	for (uint32_t i = 0; i < call_graph->op_arrays_count; i++) {
253	89.7k	zend_analyze_calls(arena, script, 0, call_graph->op_arrays[i], call_graph->func_infos + i);
254	89.7k	}
255	49.8k	zend_analyze_recursion(call_graph);
256	49.8k	zend_sort_op_arrays(call_graph);
257	49.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	89.7k	{
262	89.7k	zend_call_info *map, call;
263	89.7k	if (!info->callee_info) {
264		/* Don't build call map if function contains no calls */
265	49.2k	return NULL;
266	49.2k	}
267
268	40.4k	map = zend_arena_calloc(arena, sizeof(zend_call_info *), op_array->last);
269	144k	for (call = info->callee_info; call; call = call->next_callee) {
270	104k	map[call->caller_init_opline - op_array->opcodes] = call;
271	104k	if (call->caller_call_opline) {
272	104k	map[call->caller_call_opline - op_array->opcodes] = call;
273	104k	}
274	104k	if (!call->is_frameless) {
275	216k	for (uint32_t i = 0; i < call->num_args; i++) {
276	111k	if (call->arg_info[i].opline) {
277	111k	map[call->arg_info[i].opline - op_array->opcodes] = call;
278	111k	}
279	111k	}
280	104k	}
281	104k	}
282	40.4k	return map;
283	89.7k	}
284		/* }}} */