Skip to content

Commit d8d5612

Browse files
pierreduppierredup
committedNov 27, 2024
Add memoize attribute
·
0.1.10.1.0
1 parent 6357bc7 commit d8d5612

14 files changed

+528
-79
lines changed
 

‎aspect.c

+176-36
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,216 @@
11
/* aspect extension for PHP */
22

33
#ifdef HAVE_CONFIG_H
4+
45
# include <config.h>
6+
# include <zend_smart_str.h>
7+
58
#endif
69

710
#include "php.h"
811
#include "ext/standard/info.h"
12+
#include "ext/standard/php_standard.h"
913
#include "php_aspect.h"
1014
#include "aspect_arginfo.h"
15+
#include "zend_attributes.h"
16+
#include "zend_exceptions.h"
1117

1218
/* For compatibility with older PHP versions */
1319
#ifndef ZEND_PARSE_PARAMETERS_NONE
1420
#define ZEND_PARSE_PARAMETERS_NONE() \
15-
ZEND_PARSE_PARAMETERS_START(0, 0) \
16-
ZEND_PARSE_PARAMETERS_END()
21+
ZEND_PARSE_PARAMETERS_START(0, 0) \
22+
ZEND_PARSE_PARAMETERS_END()
1723
#endif
1824

19-
PHP_FUNCTION(test1)
20-
{
21-
ZEND_PARSE_PARAMETERS_NONE();
25+
ZEND_API zend_class_entry *zend_ce_memoize;
26+
27+
ZEND_DECLARE_MODULE_GLOBALS(aspect)
28+
29+
static void (*original_zend_execute_ex)(zend_execute_data *execute_data);
30+
31+
ZEND_API static void aspect_execute_ex(zend_execute_data *execute_data);
32+
33+
static void handle_memoize_functions(zend_execute_data *execute_data);
34+
35+
static zend_string *compute_cache_key(zend_execute_data *execute_data) {
36+
smart_str key = {0};
37+
zend_function *func = execute_data->func;
38+
39+
// Check if it's a method call
40+
if (func->common.scope) {
41+
// Check if it's a static method call
42+
if (func->common.fn_flags & ZEND_ACC_STATIC) {
43+
// Append fully qualified class name
44+
smart_str_appends(&key, ZSTR_VAL(func->common.scope->name));
45+
} else {
46+
// Append object handle
47+
smart_str_append_long(&key, (long) Z_OBJ_HANDLE(execute_data->This));
48+
}
49+
// Append method name
50+
smart_str_appends(&key, "::");
51+
smart_str_appends(&key, ZSTR_VAL(func->common.function_name));
52+
} else {
53+
// Append function name
54+
smart_str_appends(&key, ZSTR_VAL(func->common.function_name));
55+
}
56+
57+
// Serialize arguments
58+
zval *params = ZEND_CALL_ARG(execute_data, 1);
59+
for (uint32_t i = 0; i < ZEND_CALL_NUM_ARGS(execute_data); i++) {
60+
switch (Z_TYPE(params[i])) {
61+
case IS_OBJECT: {
62+
// Use object handle (unique for each object instance)
63+
smart_str_append_long(&key, (long) Z_OBJ_HANDLE(params[i]));
64+
break;
65+
}
66+
case IS_CALLABLE: {
67+
// Serialize callable as string
68+
smart_str_appendc(&key, ':');
69+
zend_string *callable_str = zval_get_string(&params[i]);
70+
smart_str_appends(&key, ZSTR_VAL(callable_str));
71+
zend_string_release(callable_str);
72+
break;
73+
}
74+
case IS_RESOURCE: {
75+
// Serialize resource as string
76+
smart_str_appendc(&key, ':');
77+
smart_str_append_long(&key, Z_RES_HANDLE(params[i]));
78+
break;
79+
}
80+
default: {
81+
// Serialize other types as usual
82+
smart_str_appendc(&key, ':');
83+
php_serialize_data_t var_hash;
84+
PHP_VAR_SERIALIZE_INIT(var_hash);
85+
php_var_serialize(&key, &params[i], &var_hash);
86+
PHP_VAR_SERIALIZE_DESTROY(var_hash);
87+
break;
88+
}
89+
}
90+
}
91+
92+
smart_str_0(&key);
93+
94+
return key.s;
95+
}
96+
97+
static void aspect_execute_ex(zend_execute_data *execute_data) {
98+
zend_function *func = execute_data->func;
99+
100+
// Check if function name is set
101+
if (!func->common.function_name) {
102+
original_zend_execute_ex(execute_data);
103+
return;
104+
}
105+
106+
if (func->common.attributes && zend_get_attribute_str(func->common.attributes, "memoize", sizeof("memoize") - 1)) {
107+
handle_memoize_functions(execute_data);
108+
return;
109+
}
110+
111+
// Default execution for non-memoized functions
112+
original_zend_execute_ex(execute_data);
113+
}
114+
115+
static void handle_memoize_functions(zend_execute_data *execute_data) {
116+
zend_string *cache_key = compute_cache_key(execute_data);
117+
zval *cached_value = zend_hash_find(&ASPECT_G(memoize_cache), cache_key);
118+
119+
if (cached_value) {
120+
// Return the cached value
121+
ZVAL_COPY(EX(return_value), cached_value);
122+
zend_string_release(cache_key);
123+
return;
124+
}
125+
126+
// Call the original function
127+
original_zend_execute_ex(execute_data);
128+
129+
if (EG(exception) || EG(exit_status)) {
130+
zend_string_release(cache_key);
131+
return;
132+
}
133+
134+
if (Z_TYPE_P(EX(return_value)) == IS_UNDEF) {
135+
php_error_docref(NULL, E_WARNING, "Return value is undefined");
136+
zend_string_release(cache_key);
137+
return;
138+
}
139+
140+
// Cache the result if no exception or exit occurred
141+
zval cache_copy;
142+
ZVAL_DUP(&cache_copy, EX(return_value));
143+
144+
if (zend_hash_add(&ASPECT_G(memoize_cache), cache_key, &cache_copy) == NULL) {
145+
php_error_docref(NULL, E_WARNING, "Failed to add cache entry");
146+
zval_ptr_dtor(&cache_copy); // Clean up if adding fails
147+
zend_string_release(cache_key);
148+
return;
149+
}
22150

23-
php_printf("The extension %s is loaded and working!\r\n", "aspect");
151+
zend_string_release(cache_key);
24152
}
25153

26-
PHP_FUNCTION(test2)
27-
{
28-
char *var = "World";
29-
size_t var_len = sizeof("World") - 1;
30-
zend_string *retval;
154+
PHP_MINIT_FUNCTION (aspect) {
155+
// Initialize the memoize cache
156+
zend_hash_init(&ASPECT_G(memoize_cache), 8, NULL, ZVAL_PTR_DTOR, 1);
31157

32-
ZEND_PARSE_PARAMETERS_START(0, 1)
33-
Z_PARAM_OPTIONAL
34-
Z_PARAM_STRING(var, var_len)
35-
ZEND_PARSE_PARAMETERS_END();
158+
original_zend_execute_ex = zend_execute_ex;
36159

37-
retval = strpprintf(0, "Hello %s", var);
160+
zend_execute_ex = aspect_execute_ex;
38161

39-
RETURN_STR(retval);
162+
// Register the Memoize attribute
163+
zend_ce_memoize = register_class_Memoize();
164+
165+
return SUCCESS;
166+
}
167+
168+
PHP_MSHUTDOWN_FUNCTION (aspect) {
169+
// Destroy the memoize cache
170+
zend_hash_destroy(&ASPECT_G(memoize_cache));
171+
172+
zend_execute_ex = original_zend_execute_ex;
173+
return SUCCESS;
40174
}
41175

42-
PHP_RINIT_FUNCTION(aspect)
43-
{
176+
PHP_RINIT_FUNCTION (aspect) {
44177
#if defined(ZTS) && defined(COMPILE_DL_ASPECT)
45-
ZEND_TSRMLS_CACHE_UPDATE();
178+
ZEND_TSRMLS_CACHE_UPDATE();
46179
#endif
47180

48-
return SUCCESS;
181+
return SUCCESS;
49182
}
50183

51-
PHP_MINFO_FUNCTION(aspect)
52-
{
53-
php_info_print_table_start();
54-
php_info_print_table_row(2, "aspect support", "enabled");
55-
php_info_print_table_end();
184+
PHP_RSHUTDOWN_FUNCTION (aspect) {
185+
zend_hash_clean(&ASPECT_G(memoize_cache));
186+
return SUCCESS;
187+
}
188+
189+
PHP_MINFO_FUNCTION (aspect) {
190+
php_info_print_table_start();
191+
php_info_print_table_row(2, "aspect support", "enabled");
192+
php_info_print_table_row(2, "Version", PHP_ASPECT_VERSION);
193+
php_info_print_table_end();
56194
}
57195

58196
zend_module_entry aspect_module_entry = {
59-
STANDARD_MODULE_HEADER,
60-
"aspect", /* Extension name */
61-
ext_functions, /* zend_function_entry */
62-
NULL, /* PHP_MINIT - Module initialization */
63-
NULL, /* PHP_MSHUTDOWN - Module shutdown */
64-
PHP_RINIT(aspect), /* PHP_RINIT - Request initialization */
65-
NULL, /* PHP_RSHUTDOWN - Request shutdown */
66-
PHP_MINFO(aspect), /* PHP_MINFO - Module info */
67-
PHP_ASPECT_VERSION, /* Version */
68-
STANDARD_MODULE_PROPERTIES
197+
STANDARD_MODULE_HEADER,
198+
"aspect", /* Extension name */
199+
NULL, /* zend_function_entry */
200+
PHP_MINIT(aspect), /* PHP_MINIT - Module initialization */
201+
PHP_MSHUTDOWN(aspect), /* PHP_MSHUTDOWN - Module shutdown */
202+
PHP_RINIT(aspect), /* PHP_RINIT - Request initialization */
203+
PHP_RSHUTDOWN(aspect), /* PHP_RSHUTDOWN - Request shutdown */
204+
PHP_MINFO(aspect), /* PHP_MINFO - Module info */
205+
PHP_ASPECT_VERSION, /* Version */
206+
STANDARD_MODULE_PROPERTIES
69207
};
70208

71209
#ifdef COMPILE_DL_ASPECT
72210
# ifdef ZTS
73211
ZEND_TSRMLS_CACHE_DEFINE()
74212
# endif
213+
75214
ZEND_GET_MODULE(aspect)
215+
76216
#endif

‎aspect.stub.php

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
<?php
22

3-
/**
4-
* @generate-class-entries
5-
* @undocumentable
6-
*/
3+
/** @generate-class-entries */
74

8-
function test1(): void {}
9-
10-
function test2(string $str = ""): string {}
5+
/** @strict-properties */
6+
#[\Attribute(2 | 4)]
7+
final class Memoize
8+
{
9+
}

‎aspect_arginfo.h

+22-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,29 @@
1+
#include <zend_attributes.h>
2+
13
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: 54b0ffc3af871b189435266df516f7575c1b9675 */
4+
* Stub hash: 7fe2851260165fea167af14286eceaf94f1a6699 */
35

4-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_test1, 0, 0, IS_VOID, 0)
5-
ZEND_END_ARG_INFO()
66

7-
ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_test2, 0, 0, IS_STRING, 0)
8-
ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, str, IS_STRING, 0, "\"\"")
9-
ZEND_END_ARG_INFO()
107

11-
ZEND_FUNCTION(test1);
12-
ZEND_FUNCTION(test2);
138

14-
static const zend_function_entry ext_functions[] = {
15-
ZEND_FE(test1, arginfo_test1)
16-
ZEND_FE(test2, arginfo_test2)
9+
static const zend_function_entry class_Memoize_methods[] = {
1710
ZEND_FE_END
1811
};
12+
13+
static zend_class_entry *register_class_Memoize(void)
14+
{
15+
zend_class_entry ce, *class_entry;
16+
17+
INIT_CLASS_ENTRY(ce, "Memoize", class_Memoize_methods);
18+
class_entry = zend_register_internal_class_ex(&ce, NULL);
19+
class_entry->ce_flags |= ZEND_ACC_FINAL|ZEND_ACC_NO_DYNAMIC_PROPERTIES;
20+
21+
zend_string *attribute_name_Attribute_class_Memoize_0 = zend_string_init_interned("Attribute", sizeof("Attribute") - 1, 1);
22+
zend_attribute *attribute_Attribute_class_Memoize_0 = zend_add_class_attribute(class_entry, attribute_name_Attribute_class_Memoize_0, 1);
23+
zend_string_release(attribute_name_Attribute_class_Memoize_0);
24+
zval attribute_Attribute_class_Memoize_0_arg0;
25+
ZVAL_LONG(&attribute_Attribute_class_Memoize_0_arg0, ZEND_ATTRIBUTE_TARGET_FUNCTION | ZEND_ATTRIBUTE_TARGET_METHOD);
26+
ZVAL_COPY_VALUE(&attribute_Attribute_class_Memoize_0->args[0].value, &attribute_Attribute_class_Memoize_0_arg0);
27+
28+
return class_entry;
29+
}

‎php_aspect.h

+15
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@ extern zend_module_entry aspect_module_entry;
88

99
# define PHP_ASPECT_VERSION "0.1.0"
1010

11+
PHP_MINIT_FUNCTION(aspect);
12+
PHP_MSHUTDOWN_FUNCTION(aspect);
13+
PHP_RINIT_FUNCTION(aspect);
14+
PHP_RSHUTDOWN_FUNCTION(aspect);
15+
16+
ZEND_BEGIN_MODULE_GLOBALS(aspect)
17+
HashTable memoize_cache; // Global cache
18+
ZEND_END_MODULE_GLOBALS(aspect)
19+
20+
#define ASPECT_G(v) ZEND_MODULE_GLOBALS_ACCESSOR(aspect, v)
21+
22+
BEGIN_EXTERN_C()
23+
extern ZEND_API zend_class_entry *zend_ce_memoize;
24+
END_EXTERN_C()
25+
1126
# if defined(ZTS) && defined(COMPILE_DL_ASPECT)
1227
ZEND_TSRMLS_CACHE_EXTERN()
1328
# endif

‎tests/002.phpt

-13
This file was deleted.

‎tests/003.phpt

-12
This file was deleted.

‎tests/001.phpt ‎tests/memoize_001.phpt

File renamed without changes.

‎tests/memoize_002.phpt

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
--TEST--
2+
Memoize attribute exists
3+
--EXTENSIONS--
4+
aspect
5+
--FILE--
6+
<?php
7+
var_dump(class_exists('Memoize'));
8+
9+
#[Memoize]
10+
function foo() {
11+
return 'foo';
12+
}
13+
14+
var_dump((new ReflectionFunction('foo'))->getAttributes()[0]->getName());
15+
16+
class Bar {
17+
#[Memoize]
18+
public function bar() {
19+
return 'bar';
20+
}
21+
}
22+
23+
$bar = new Bar();
24+
var_dump((new ReflectionMethod($bar, 'bar'))->getAttributes()[0]->getName());
25+
26+
?>
27+
--EXPECT--
28+
bool(true)
29+
string(7) "Memoize"
30+
string(7) "Memoize"

0 commit comments

Comments
 (0)
Please sign in to comment.