/src/php-src/Zend/Optimizer/zend_optimizer_internal.h

Source
/*
   +----------------------------------------------------------------------+
   | Zend OPcache                                                         |
   +----------------------------------------------------------------------+
   | 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: Andi Gutmans <andi@php.net>                                 |
   |          Zeev Suraski <zeev@php.net>                                 |
   |          Stanislav Malyshev <stas@zend.com>                          |
   |          Dmitry Stogov <dmitry@php.net>                              |
   +----------------------------------------------------------------------+
*/

#ifndef ZEND_OPTIMIZER_INTERNAL_H
#define ZEND_OPTIMIZER_INTERNAL_H

#include "zend_ssa.h"
#include "zend_func_info.h"

#include <stdint.h>

#define ZEND_OP1_LITERAL(opline)    (op_array)->literals[(opline)->op1.constant]
#define ZEND_OP1_JMP_ADDR(opline)   OP_JMP_ADDR(opline, (opline)->op1)
#define ZEND_OP2_LITERAL(opline)    (op_array)->literals[(opline)->op2.constant]
#define ZEND_OP2_JMP_ADDR(opline)   OP_JMP_ADDR(opline, (opline)->op2)

#define VAR_NUM(v) EX_VAR_TO_NUM(v)
#define NUM_VAR(v) EX_NUM_TO_VAR(v)

#define INV_COND(op)       ((op) == ZEND_JMPZ    ? ZEND_JMPNZ    : ZEND_JMPZ)
#define INV_EX_COND(op)    ((op) == ZEND_JMPZ_EX ? ZEND_JMPNZ    : ZEND_JMPZ)
#define INV_COND_EX(op)    ((op) == ZEND_JMPZ    ? ZEND_JMPNZ_EX : ZEND_JMPZ_EX)
#define INV_EX_COND_EX(op) ((op) == ZEND_JMPZ_EX ? ZEND_JMPNZ_EX : ZEND_JMPZ_EX)

#define RESULT_UNUSED(op) (op->result_type == IS_UNUSED)
#define SAME_VAR(op1, op2)  (op1 ## _type == op2 ## _type && op1.var == op2.var)

typedef struct _zend_optimizer_ctx {
  zend_arena             *arena;
  zend_script            *script;
  HashTable              *constants;
  zend_long               optimization_level;
  zend_long               debug_level;
} zend_optimizer_ctx;

#define LITERAL_LONG(op, val) do { \
    zval _c; \
    ZVAL_LONG(&_c, val); \
    op.constant = zend_optimizer_add_literal(op_array, &_c); \
  } while (0)

#define LITERAL_BOOL(op, val) do { \
    zval _c; \
    ZVAL_BOOL(&_c, val); \
    op.constant = zend_optimizer_add_literal(op_array, &_c); \
  } while (0)

#define literal_dtor(zv) do { \
    zval_ptr_dtor_nogc(zv); \
    ZVAL_NULL(zv); \
  } while (0)

#define COPY_NODE(target, src) do { \
    target ## _type = src ## _type; \
    target = src; \
  } while (0)

static inline bool zend_optimizer_is_loop_var_free(const zend_op *opline) {
  return (opline->opcode == ZEND_FE_FREE && opline->extended_value != ZEND_FREE_ON_RETURN)
    || (opline->opcode == ZEND_FREE && opline->extended_value == ZEND_FREE_SWITCH);
}

void zend_optimizer_convert_to_free_op1(const zend_op_array *op_array, zend_op *opline);
uint32_t zend_optimizer_add_literal(zend_op_array *op_array, const zval *zv);
bool zend_optimizer_get_persistent_constant(zend_string *name, zval *result, bool copy);
void zend_optimizer_collect_constant(zend_optimizer_ctx *ctx, const zval *name, zval* value);
bool zend_optimizer_get_collected_constant(const HashTable *constants, const zval *name, zval* value);
zend_result zend_optimizer_eval_binary_op(zval *result, uint8_t opcode, zval *op1, zval *op2);
zend_result zend_optimizer_eval_unary_op(zval *result, uint8_t opcode, zval *op1);
zend_result zend_optimizer_eval_cast(zval *result, uint32_t type, zval *op1);
zend_result zend_optimizer_eval_strlen(zval *result, const zval *op1);
zend_result zend_optimizer_eval_special_func_call(
    zval *result, const zend_string *name, zend_string *arg);
bool zend_optimizer_update_op1_const(zend_op_array *op_array,
                                    zend_op       *opline,
                                    zval          *val);
bool zend_optimizer_update_op2_const(zend_op_array *op_array,
                                    zend_op       *opline,
                                    zval          *val);
bool zend_optimizer_replace_by_const(zend_op_array *op_array,
                                     zend_op       *opline,
                                     uint8_t     type,
                                     uint32_t       var,
                                     zval          *val);
zend_op *zend_optimizer_get_loop_var_def(const zend_op_array *op_array, zend_op *free_opline);
zend_class_entry *zend_optimizer_get_class_entry(
    const zend_script *script, const zend_op_array *op_array, zend_string *lcname);
zend_class_entry *zend_optimizer_get_class_entry_from_op1(
    const zend_script *script, const zend_op_array *op_array, const zend_op *opline);
const zend_class_constant *zend_fetch_class_const_info(
    const zend_script *script, const zend_op_array *op_array, const zend_op *opline, bool *is_prototype);

void zend_optimizer_pass1(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimizer_pass3(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimize_func_calls(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimize_cfg(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimize_dfa(zend_op_array *op_array, zend_optimizer_ctx *ctx);
zend_result zend_dfa_analyze_op_array(zend_op_array *op_array, zend_optimizer_ctx *ctx, zend_ssa *ssa);
void zend_dfa_optimize_op_array(zend_op_array *op_array, zend_optimizer_ctx *ctx, zend_ssa *ssa, zend_call_info **call_map);
void zend_optimize_temporary_variables(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimizer_nop_removal(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimizer_compact_literals(zend_op_array *op_array, zend_optimizer_ctx *ctx);
void zend_optimizer_compact_vars(zend_op_array *op_array);
zend_function *zend_optimizer_get_called_func(
    const zend_script *script, const zend_op_array *op_array, zend_op *opline, bool *is_prototype);
uint32_t zend_optimizer_classify_function(const zend_string *name, uint32_t num_args);
void zend_optimizer_migrate_jump(const zend_op_array *op_array, zend_op *new_opline, zend_op *opline);
void zend_optimizer_shift_jump(const zend_op_array *op_array, zend_op *opline, const uint32_t *shiftlist);
uint32_t sccp_optimize_op_array(zend_optimizer_ctx *ctx, zend_op_array *op_array, zend_ssa *ssa, zend_call_info **call_map);
int dce_optimize_op_array(zend_op_array *op_array, zend_optimizer_ctx *optimizer_ctx, zend_ssa *ssa, bool reorder_dtor_effects);
zend_result zend_ssa_escape_analysis(const zend_script *script, zend_op_array *op_array, zend_ssa *ssa);

#endif

Line	Count	Source
1		/*
2		+----------------------------------------------------------------------+
3		\| Zend OPcache \|
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: Andi Gutmans <andi@php.net> \|
14		\| Zeev Suraski <zeev@php.net> \|
15		\| Stanislav Malyshev <stas@zend.com> \|
16		\| Dmitry Stogov <dmitry@php.net> \|
17		+----------------------------------------------------------------------+
18		*/
19
20		#ifndef ZEND_OPTIMIZER_INTERNAL_H
21		#define ZEND_OPTIMIZER_INTERNAL_H
22
23		#include "zend_ssa.h"
24		#include "zend_func_info.h"
25
26		#include <stdint.h>
27
28	0	#define ZEND_OP1_LITERAL(opline) (op_array)->literals[(opline)->op1.constant]
29	0	#define ZEND_OP1_JMP_ADDR(opline) OP_JMP_ADDR(opline, (opline)->op1)
30	0	#define ZEND_OP2_LITERAL(opline) (op_array)->literals[(opline)->op2.constant]
31	0	#define ZEND_OP2_JMP_ADDR(opline) OP_JMP_ADDR(opline, (opline)->op2)
32
33	0	#define VAR_NUM(v) EX_VAR_TO_NUM(v)
34	0	#define NUM_VAR(v) EX_NUM_TO_VAR(v)
35
36	0	#define INV_COND(op) ((op) == ZEND_JMPZ ? ZEND_JMPNZ : ZEND_JMPZ)
37	0	#define INV_EX_COND(op) ((op) == ZEND_JMPZ_EX ? ZEND_JMPNZ : ZEND_JMPZ)
38		#define INV_COND_EX(op) ((op) == ZEND_JMPZ ? ZEND_JMPNZ_EX : ZEND_JMPZ_EX)
39	0	#define INV_EX_COND_EX(op) ((op) == ZEND_JMPZ_EX ? ZEND_JMPNZ_EX : ZEND_JMPZ_EX)
40
41	0	#define RESULT_UNUSED(op) (op->result_type == IS_UNUSED)
42	0	#define SAME_VAR(op1, op2) (op1 ## _type == op2 ## _type && op1.var == op2.var)
43
44		typedef struct _zend_optimizer_ctx {
45		zend_arena *arena;
46		zend_script *script;
47		HashTable *constants;
48		zend_long optimization_level;
49		zend_long debug_level;
50		} zend_optimizer_ctx;
51
52		#define LITERAL_LONG(op, val) do { \
53		zval _c; \
54		ZVAL_LONG(&_c, val); \
55		op.constant = zend_optimizer_add_literal(op_array, &_c); \
56		} while (0)
57
58		#define LITERAL_BOOL(op, val) do { \
59		zval _c; \
60		ZVAL_BOOL(&_c, val); \
61		op.constant = zend_optimizer_add_literal(op_array, &_c); \
62		} while (0)
63
64	0	#define literal_dtor(zv) do { \
65	0	zval_ptr_dtor_nogc(zv); \
66	0	ZVAL_NULL(zv); \
67	0	} while (0)
68
69	0	#define COPY_NODE(target, src) do { \
70	0	target ## _type = src ## _type; \
71	0	target = src; \
72	0	} while (0)
73
74	0	static inline bool zend_optimizer_is_loop_var_free(const zend_op *opline) {
75	0	return (opline->opcode == ZEND_FE_FREE && opline->extended_value != ZEND_FREE_ON_RETURN)
76	0	\|\| (opline->opcode == ZEND_FREE && opline->extended_value == ZEND_FREE_SWITCH);
77	0	} Unexecuted instantiation: block_pass.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: compact_literals.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: compact_vars.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: dce.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: dfa_pass.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: escape_analysis.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: nop_removal.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: optimize_func_calls.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: optimize_temp_vars_5.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: pass1.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: pass3.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: sccp.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: scdf.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: zend_call_graph.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: zend_cfg.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: zend_func_info.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: zend_inference.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: zend_optimizer.c:zend_optimizer_is_loop_var_free Unexecuted instantiation: zend_ssa.c:zend_optimizer_is_loop_var_free
78
79		void zend_optimizer_convert_to_free_op1(const zend_op_array op_array, zend_op opline);
80		uint32_t zend_optimizer_add_literal(zend_op_array op_array, const zval zv);
81		bool zend_optimizer_get_persistent_constant(zend_string name, zval result, bool copy);
82		void zend_optimizer_collect_constant(zend_optimizer_ctx ctx, const zval name, zval* value);
83		bool zend_optimizer_get_collected_constant(const HashTable constants, const zval name, zval* value);
84		zend_result zend_optimizer_eval_binary_op(zval result, uint8_t opcode, zval op1, zval *op2);
85		zend_result zend_optimizer_eval_unary_op(zval result, uint8_t opcode, zval op1);
86		zend_result zend_optimizer_eval_cast(zval result, uint32_t type, zval op1);
87		zend_result zend_optimizer_eval_strlen(zval result, const zval op1);
88		zend_result zend_optimizer_eval_special_func_call(
89		zval result, const zend_string name, zend_string *arg);
90		bool zend_optimizer_update_op1_const(zend_op_array *op_array,
91		zend_op *opline,
92		zval *val);
93		bool zend_optimizer_update_op2_const(zend_op_array *op_array,
94		zend_op *opline,
95		zval *val);
96		bool zend_optimizer_replace_by_const(zend_op_array *op_array,
97		zend_op *opline,
98		uint8_t type,
99		uint32_t var,
100		zval *val);
101		zend_op zend_optimizer_get_loop_var_def(const zend_op_array op_array, zend_op *free_opline);
102		zend_class_entry *zend_optimizer_get_class_entry(
103		const zend_script script, const zend_op_array op_array, zend_string *lcname);
104		zend_class_entry *zend_optimizer_get_class_entry_from_op1(
105		const zend_script script, const zend_op_array op_array, const zend_op *opline);
106		const zend_class_constant *zend_fetch_class_const_info(
107		const zend_script script, const zend_op_array op_array, const zend_op opline, bool is_prototype);
108
109		void zend_optimizer_pass1(zend_op_array op_array, zend_optimizer_ctx ctx);
110		void zend_optimizer_pass3(zend_op_array op_array, zend_optimizer_ctx ctx);
111		void zend_optimize_func_calls(zend_op_array op_array, zend_optimizer_ctx ctx);
112		void zend_optimize_cfg(zend_op_array op_array, zend_optimizer_ctx ctx);
113		void zend_optimize_dfa(zend_op_array op_array, zend_optimizer_ctx ctx);
114		zend_result zend_dfa_analyze_op_array(zend_op_array op_array, zend_optimizer_ctx ctx, zend_ssa *ssa);
115		void zend_dfa_optimize_op_array(zend_op_array op_array, zend_optimizer_ctx ctx, zend_ssa ssa, zend_call_info *call_map);
116		void zend_optimize_temporary_variables(zend_op_array op_array, zend_optimizer_ctx ctx);
117		void zend_optimizer_nop_removal(zend_op_array op_array, zend_optimizer_ctx ctx);
118		void zend_optimizer_compact_literals(zend_op_array op_array, zend_optimizer_ctx ctx);
119		void zend_optimizer_compact_vars(zend_op_array *op_array);
120		zend_function *zend_optimizer_get_called_func(
121		const zend_script script, const zend_op_array op_array, zend_op opline, bool is_prototype);
122		uint32_t zend_optimizer_classify_function(const zend_string *name, uint32_t num_args);
123		void zend_optimizer_migrate_jump(const zend_op_array op_array, zend_op new_opline, zend_op *opline);
124		void zend_optimizer_shift_jump(const zend_op_array op_array, zend_op opline, const uint32_t *shiftlist);
125		uint32_t sccp_optimize_op_array(zend_optimizer_ctx ctx, zend_op_array op_array, zend_ssa ssa, zend_call_info *call_map);
126		int dce_optimize_op_array(zend_op_array op_array, zend_optimizer_ctx optimizer_ctx, zend_ssa *ssa, bool reorder_dtor_effects);
127		zend_result zend_ssa_escape_analysis(const zend_script script, zend_op_array op_array, zend_ssa *ssa);
128
129		#endif

Coverage Report

Created: 2026-06-02 06:36