Coverage Report

Created: 2025-06-13 06:43

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