Refactor RayAOP to improve error handling and performance

The code has been significantly refactored to enhance error handling and simplify interception logic. New error codes have been introduced for more precise error messages, and numerous debug functions were removed to streamline the code. Additionally, the mutex handling was simplified, and function prototypes were rearranged for better readability.
ray-di · Dec 7, 2024 · efdb2bb · efdb2bb
1 parent eb4b10e
commit efdb2bb
Show file tree

Hide file tree

Showing 2 changed files with 197 additions and 309 deletions.
diff --git a/php_rayaop.h b/php_rayaop.h
@@ -1,22 +1,14 @@
-/* Header guard */
 #ifndef PHP_RAYAOP_H
 #define PHP_RAYAOP_H
 
-// #define RAYAOP_DEBUG 1
-
-/* Configuration header */
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
 
-/* Required system headers first */
-#include <stdint.h>
-
-/* PHP Core headers in correct order */
 #include "php.h"
 #include "zend.h"
-#include "zend_types.h"
 #include "zend_API.h"
+#include "zend_types.h"
 #include "zend_ini.h"
 #include "php_ini.h"
 #include "ext/standard/info.h"
@@ -27,129 +19,81 @@
 #include "TSRM.h"
 #endif
 
+/* Export macros */
+#ifdef PHP_WIN32
+# define PHP_RAYAOP_API __declspec(dllexport)
+#elif defined(__GNUC__) && __GNUC__ >= 4
+# define PHP_RAYAOP_API __attribute__ ((visibility("default")))
+#else
+# define PHP_RAYAOP_API
+#endif
+
 /* Constants */
 #define MAX_EXECUTION_DEPTH 100
 #define PHP_RAYAOP_VERSION "1.0.0"
 #define RAYAOP_NS "Ray\\Aop\\"
 
 /* Error codes */
-#define RAYAOP_E_MEMORY_ALLOCATION 1
-#define RAYAOP_E_HASH_UPDATE      2
-#define RAYAOP_E_INVALID_HANDLER  3
-#define RAYAOP_E_MAX_DEPTH_EXCEEDED 4
-
-/* Argument information declarations */
-ZEND_BEGIN_ARG_INFO_EX(arginfo_method_intercept, 0, 0, 3)
-    ZEND_ARG_TYPE_INFO(0, class_name, IS_STRING, 0)
-    ZEND_ARG_TYPE_INFO(0, method_name, IS_STRING, 0)
-    ZEND_ARG_OBJ_INFO(0, interceptor, Ray\\Aop\\MethodInterceptorInterface, 0)
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_INFO(arginfo_method_intercept_init, 0)
-ZEND_END_ARG_INFO()
-
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_method_intercept_enable, 0, 1, IS_VOID, 0)
-    ZEND_ARG_TYPE_INFO(0, enable, _IS_BOOL, 0)
-ZEND_END_ARG_INFO()
-
-/* Debug mode configuration */
-#ifdef RAYAOP_DEBUG
-#define PHP_RAYAOP_DEBUG_PRINT(fmt, ...) \
-    do { \
-        php_printf("RAYAOP DEBUG [%s:%d]: " fmt "\n", __FILE__, __LINE__, ##__VA_ARGS__); \
-    } while (0)
-#else
-#define PHP_RAYAOP_DEBUG_PRINT(fmt, ...)
-#endif
-
-/* Declare mutex type */
-#if defined(WIN32)
-#define MUTEX_T HANDLE
-#else
-#define MUTEX_T pthread_mutex_t*
-#endif
-extern MUTEX_T rayaop_mutex;
+#define RAYAOP_E_MEMORY_ALLOCATION   1
+#define RAYAOP_E_HASH_UPDATE         2
+#define RAYAOP_E_INVALID_HANDLER     3
+#define RAYAOP_E_MAX_DEPTH_EXCEEDED  4
+#define RAYAOP_E_NULL_POINTER        5
+#define RAYAOP_E_INVALID_STATE       6
 
 #ifdef ZTS
-#define RAYAOP_G_LOCK()   tsrm_mutex_lock(rayaop_mutex)
+extern MUTEX_T rayaop_mutex;
+#define RAYAOP_G_LOCK() tsrm_mutex_lock(rayaop_mutex)
 #define RAYAOP_G_UNLOCK() tsrm_mutex_unlock(rayaop_mutex)
 #else
 #define RAYAOP_G_LOCK()
 #define RAYAOP_G_UNLOCK()
 #endif
 
-/* Module entry */
-extern zend_module_entry rayaop_module_entry;
-#define phpext_rayaop_ptr &rayaop_module_entry
-
-/* Interface class entry */
-extern zend_class_entry *ray_aop_method_interceptor_interface_ce;
-
-/* Windows DLL export */
-#ifdef PHP_WIN32
-#define PHP_RAYAOP_API __declspec(dllexport)
-#elif defined(__GNUC__) && __GNUC__ >= 4
-#define PHP_RAYAOP_API __attribute__ ((visibility("default")))
-#else
-#define PHP_RAYAOP_API
-#endif
-
-/* Intercept information structure */
 typedef struct _php_rayaop_intercept_info {
-    zend_string *class_name;    /* Class name to intercept */
-    zend_string *method_name;   /* Method name to intercept */
-    zval handler;               /* Intercept handler */
-    zend_bool is_enabled;       /* Flag to enable/disable interception */
+    zend_string *class_name;     /* Class name */
+    zend_string *method_name;    /* Method name */
+    zval handler;                /* Intercept handler object */
+    zend_bool is_enabled;        /* Enabled flag */
 } php_rayaop_intercept_info;
 
-/* Module globals structure */
 ZEND_BEGIN_MODULE_GLOBALS(rayaop)
-    HashTable *intercept_ht;     /* Intercept hash table */
-    zend_bool is_intercepting;   /* Intercepting flag */
-    uint32_t execution_depth;    /* Execution depth counter */
-    zend_bool method_intercept_enabled;  /* Global interception enable flag */
-    uint32_t debug_level;        /* Debug level */
+    HashTable *intercept_ht;      /* Hash table for intercept information */
+    zend_bool is_intercepting;    /* Flag indicating if currently intercepting */
+    uint32_t execution_depth;     /* Nesting depth of interception */
+    zend_bool method_intercept_enabled; /* Global enable/disable flag */
+    uint32_t debug_level;         /* Debug level */
 ZEND_END_MODULE_GLOBALS(rayaop)
 
-/* Global initializer */
-static void php_rayaop_init_globals(zend_rayaop_globals *globals);
-
-/* Globals access macro */
 #ifdef ZTS
 #define RAYAOP_G(v) TSRMG(rayaop_globals_id, zend_rayaop_globals *, v)
 #else
 #define RAYAOP_G(v) (rayaop_globals.v)
 #endif
 
-/* Module functions */
+extern zend_module_entry rayaop_module_entry;
+#define phpext_rayaop_ptr &rayaop_module_entry
+
+extern zend_class_entry *ray_aop_method_interceptor_interface_ce;
+
+/* PHP lifecycle hooks */
 PHP_MINIT_FUNCTION(rayaop);
 PHP_MSHUTDOWN_FUNCTION(rayaop);
 PHP_RINIT_FUNCTION(rayaop);
 PHP_RSHUTDOWN_FUNCTION(rayaop);
 PHP_MINFO_FUNCTION(rayaop);
 
-/* Extension functions */
+/* PHP functions */
 PHP_FUNCTION(method_intercept);
 PHP_FUNCTION(method_intercept_init);
 PHP_FUNCTION(method_intercept_enable);
 
-/* Utility functions */
+/* API functions */
 PHP_RAYAOP_API void php_rayaop_handle_error(int error_code, const char *message);
-PHP_RAYAOP_API bool php_rayaop_should_intercept(zend_execute_data *execute_data);
+PHP_RAYAOP_API zend_bool php_rayaop_should_intercept(zend_execute_data *execute_data);
 PHP_RAYAOP_API char *php_rayaop_generate_key(zend_string *class_name, zend_string *method_name, size_t *key_len);
 PHP_RAYAOP_API php_rayaop_intercept_info *php_rayaop_find_intercept_info(const char *key, size_t key_len);
-
-/* Memory management functions */
 PHP_RAYAOP_API void php_rayaop_free_intercept_info(zval *zv);
 PHP_RAYAOP_API php_rayaop_intercept_info *php_rayaop_create_intercept_info(void);
 
-/* Debug functions */
-#ifdef RAYAOP_DEBUG
-void php_rayaop_debug_dump_intercept_info(void);
-void php_rayaop_debug_print_zval(zval *value);
-#endif
-
-/* Module globals declaration */
-ZEND_EXTERN_MODULE_GLOBALS(rayaop)
-
-#endif /* PHP_RAYAOP_H */
+#endif /* PHP_RAYAOP_H */