1 /*
2 +----------------------------------------------------------------------+
3 | Zend Engine, Func Info |
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 | Xinchen Hui <laruence@php.net> |
17 +----------------------------------------------------------------------+
18 */
19
20 #include "zend_compile.h"
21 #include "zend_extensions.h"
22 #include "zend_ssa.h"
23 #include "zend_optimizer_internal.h"
24 #include "zend_inference.h"
25 #include "zend_call_graph.h"
26 #include "zend_func_info.h"
27 #include "zend_inference.h"
28 #ifdef _WIN32
29 #include "win32/ioutil.h"
30 #endif
31
32 typedef uint32_t (*info_func_t)(const zend_call_info *call_info, const zend_ssa *ssa);
33
34 typedef struct _func_info_t {
35 const char *name;
36 int name_len;
37 uint32_t info;
38 info_func_t info_func;
39 } func_info_t;
40
41 #define F0(name, info) \
42 {name, sizeof(name)-1, (info), NULL}
43 #define F1(name, info) \
44 {name, sizeof(name)-1, (MAY_BE_RC1 | (info)), NULL}
45 #define FN(name, info) \
46 {name, sizeof(name)-1, (MAY_BE_RC1 | MAY_BE_RCN | (info)), NULL}
47 #define FC(name, callback) \
48 {name, sizeof(name)-1, 0, callback}
49
50 #include "zend_func_infos.h"
51
zend_range_info(const zend_call_info * call_info,const zend_ssa * ssa)52 static uint32_t zend_range_info(const zend_call_info *call_info, const zend_ssa *ssa)
53 {
54 if (!call_info->send_unpack
55 && (call_info->num_args == 2 || call_info->num_args == 3)
56 && ssa
57 && !(ssa->cfg.flags & ZEND_SSA_TSSA)) {
58 zend_op_array *op_array = call_info->caller_op_array;
59 uint32_t t1 = _ssa_op1_info(op_array, ssa, call_info->arg_info[0].opline,
60 &ssa->ops[call_info->arg_info[0].opline - op_array->opcodes]);
61 uint32_t t2 = _ssa_op1_info(op_array, ssa, call_info->arg_info[1].opline,
62 &ssa->ops[call_info->arg_info[1].opline - op_array->opcodes]);
63 uint32_t t3 = 0;
64 uint32_t tmp = MAY_BE_RC1 | MAY_BE_ARRAY;
65
66 if (call_info->num_args == 3) {
67 t3 = _ssa_op1_info(op_array, ssa, call_info->arg_info[2].opline,
68 &ssa->ops[call_info->arg_info[2].opline - op_array->opcodes]);
69 }
70 if ((t1 & MAY_BE_STRING) && (t2 & MAY_BE_STRING)) {
71 tmp |= MAY_BE_ARRAY_OF_LONG | MAY_BE_ARRAY_OF_DOUBLE | MAY_BE_ARRAY_OF_STRING;
72 }
73 if ((t1 & (MAY_BE_DOUBLE|MAY_BE_STRING))
74 || (t2 & (MAY_BE_DOUBLE|MAY_BE_STRING))
75 || (t3 & (MAY_BE_DOUBLE|MAY_BE_STRING))) {
76 tmp |= MAY_BE_ARRAY_OF_DOUBLE;
77 }
78 if ((t1 & ((MAY_BE_ANY|MAY_BE_UNDEF)-MAY_BE_DOUBLE))
79 && (t2 & ((MAY_BE_ANY|MAY_BE_UNDEF)-MAY_BE_DOUBLE))) {
80 if ((t3 & MAY_BE_ANY) != MAY_BE_DOUBLE) {
81 tmp |= MAY_BE_ARRAY_OF_LONG;
82 }
83 }
84 if (tmp & MAY_BE_ARRAY_OF_ANY) {
85 tmp |= MAY_BE_ARRAY_PACKED;
86 }
87 return tmp;
88 } else {
89 /* May throw */
90 return MAY_BE_RC1 | MAY_BE_ARRAY | MAY_BE_ARRAY_PACKED | MAY_BE_ARRAY_OF_LONG | MAY_BE_ARRAY_OF_DOUBLE | MAY_BE_ARRAY_OF_STRING;
91 }
92 }
93
94 static const func_info_t old_func_infos[] = {
95 FC("range", zend_range_info),
96 };
97
98 static HashTable func_info;
99 ZEND_API int zend_func_info_rid = -1;
100
zend_get_internal_func_info(const zend_function * callee_func,const zend_call_info * call_info,const zend_ssa * ssa)101 uint32_t zend_get_internal_func_info(
102 const zend_function *callee_func, const zend_call_info *call_info, const zend_ssa *ssa) {
103 if (callee_func->common.scope) {
104 /* This is a method, not a function. */
105 return 0;
106 }
107
108 zend_string *name = callee_func->common.function_name;
109 if (!name) {
110 /* zend_pass_function has no name. */
111 return 0;
112 }
113
114 zval *zv = zend_hash_find_known_hash(&func_info, name);
115 if (!zv) {
116 return 0;
117 }
118
119 func_info_t *info = Z_PTR_P(zv);
120 if (info->info_func) {
121 return call_info ? info->info_func(call_info, ssa) : 0;
122 } else {
123 return info->info;
124 }
125 }
126
zend_get_func_info(const zend_call_info * call_info,const zend_ssa * ssa,zend_class_entry ** ce,bool * ce_is_instanceof)127 ZEND_API uint32_t zend_get_func_info(
128 const zend_call_info *call_info, const zend_ssa *ssa,
129 zend_class_entry **ce, bool *ce_is_instanceof)
130 {
131 uint32_t ret = 0;
132 const zend_function *callee_func = call_info->callee_func;
133 *ce = NULL;
134 *ce_is_instanceof = 0;
135
136 if (callee_func->type == ZEND_INTERNAL_FUNCTION) {
137 uint32_t internal_ret = zend_get_internal_func_info(callee_func, call_info, ssa);
138 #if !ZEND_DEBUG
139 if (internal_ret) {
140 return internal_ret;
141 }
142 #endif
143
144 ret = zend_get_return_info_from_signature_only(
145 callee_func, /* script */ NULL, ce, ce_is_instanceof, /* use_tentative_return_info */ !call_info->is_prototype);
146
147 #if ZEND_DEBUG
148 if (internal_ret) {
149 zend_string *name = callee_func->common.function_name;
150 /* Check whether the func_info information is a subset of the information we can
151 * compute from the specified return type, otherwise it contains redundant types. */
152 if (internal_ret & ~ret) {
153 fprintf(stderr, "Inaccurate func info for %s()\n", ZSTR_VAL(name));
154 }
155 /* Check whether the func info is completely redundant with arginfo. */
156 if (internal_ret == ret) {
157 fprintf(stderr, "Useless func info for %s()\n", ZSTR_VAL(name));
158 }
159 /* If the return type is not mixed, check that the types match exactly if we exclude
160 * RC and array information. */
161 uint32_t ret_any = ret & MAY_BE_ANY, internal_ret_any = internal_ret & MAY_BE_ANY;
162 if (ret_any != MAY_BE_ANY) {
163 uint32_t diff = internal_ret_any ^ ret_any;
164 /* Func info may contain "true" types as well as isolated "null" and "false". */
165 if (diff && !(diff == MAY_BE_FALSE && (ret & MAY_BE_FALSE))
166 && (internal_ret_any & ~(MAY_BE_NULL|MAY_BE_FALSE))) {
167 fprintf(stderr, "Incorrect func info for %s()\n", ZSTR_VAL(name));
168 }
169 }
170 return internal_ret;
171 }
172 #endif
173 } else {
174 if (!call_info->is_prototype) {
175 // FIXME: the order of functions matters!!!
176 zend_func_info *info = ZEND_FUNC_INFO((zend_op_array*)callee_func);
177 if (info) {
178 ret = info->return_info.type;
179 *ce = info->return_info.ce;
180 *ce_is_instanceof = info->return_info.is_instanceof;
181 }
182 }
183 if (!ret) {
184 ret = zend_get_return_info_from_signature_only(
185 callee_func, /* TODO: script */ NULL, ce, ce_is_instanceof, /* use_tentative_return_info */ !call_info->is_prototype);
186 /* It's allowed to override a method that return non-reference with a method that returns a reference */
187 if (call_info->is_prototype && (ret & ~MAY_BE_REF)) {
188 ret |= MAY_BE_REF;
189 *ce = NULL;
190 }
191 }
192 }
193 return ret;
194 }
195
zend_func_info_add(const func_info_t * func_infos,size_t n)196 static void zend_func_info_add(const func_info_t *func_infos, size_t n)
197 {
198 for (size_t i = 0; i < n; i++) {
199 zend_string *key = zend_string_init_interned(func_infos[i].name, func_infos[i].name_len, 1);
200
201 if (zend_hash_add_ptr(&func_info, key, (void**)&func_infos[i]) == NULL) {
202 fprintf(stderr, "ERROR: Duplicate function info for \"%s\"\n", func_infos[i].name);
203 }
204
205 zend_string_release_ex(key, 1);
206 }
207 }
208
zend_func_info_startup(void)209 int zend_func_info_startup(void)
210 {
211 if (zend_func_info_rid == -1) {
212 zend_func_info_rid = zend_get_resource_handle("Zend Optimizer");
213 if (zend_func_info_rid < 0) {
214 return FAILURE;
215 }
216
217 zend_hash_init(&func_info, sizeof(old_func_infos)/sizeof(func_info_t) + sizeof(func_infos)/sizeof(func_info_t), NULL, NULL, 1);
218
219 zend_func_info_add(old_func_infos, sizeof(old_func_infos)/sizeof(func_info_t));
220 zend_func_info_add(func_infos, sizeof(func_infos)/sizeof(func_info_t));
221 }
222
223 return SUCCESS;
224 }
225
zend_func_info_shutdown(void)226 int zend_func_info_shutdown(void)
227 {
228 if (zend_func_info_rid != -1) {
229 zend_hash_destroy(&func_info);
230 zend_func_info_rid = -1;
231 }
232 return SUCCESS;
233 }
234