Add return type and fix invoke issue (#158)

jmjoy · web-flow · commit fe07b2eb0326 · 2024-08-08T10:39:48.000+08:00
diff --git a/phper-sys/php_wrapper.c b/phper-sys/php_wrapper.c
@@ -461,6 +461,25 @@ phper_zend_begin_arg_info_ex(bool return_reference,
 #undef const
 }
 
+zend_internal_arg_info
+phper_zend_begin_arg_with_return_type_info_ex(bool return_reference,
+                                              uintptr_t required_num_args,
+                                              uint32_t typ, bool allow_null) {
+#define static
+#define const
+#if PHP_VERSION_ID >= 70200
+    ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(info, return_reference,
+                                            required_num_args, typ, allow_null)
+#else
+    ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(
+        info, return_reference, required_num_args, typ, NULL, allow_null)
+#endif
+    ZEND_END_ARG_INFO()
+    return info[0];
+#undef static
+#undef const
+}
+
 zend_internal_arg_info phper_zend_arg_info(bool pass_by_ref, const char *name) {
     zend_internal_arg_info info[] = {ZEND_ARG_INFO(pass_by_ref, )};
     info[0].name = name;
diff --git a/phper/src/classes.rs b/phper/src/classes.rs
@@ -13,7 +13,7 @@
 use crate::{
     arrays::ZArr,
     errors::{ClassNotFoundError, InitializeObjectError, Throwable},
-    functions::{Function, FunctionEntry, Method, MethodEntity},
+    functions::{Function, FunctionEntry, HandlerMap, Method, MethodEntity},
     modules::global_module,
     objects::{StateObj, StateObject, ZObject},
     strings::ZStr,
@@ -649,6 +649,20 @@ impl<T: 'static> ClassEntity<T> {
         }
         entry
     }
+
+    pub(crate) fn handler_map(&self) -> HandlerMap {
+        self.method_entities
+            .iter()
+            .filter_map(|method| {
+                method.handler.as_ref().map(|handler| {
+                    (
+                        (Some(self.class_name.clone()), method.name.clone()),
+                        handler.clone(),
+                    )
+                })
+            })
+            .collect()
+    }
 }
 
 unsafe extern "C" fn class_init_handler(
diff --git a/phper/src/functions.rs b/phper/src/functions.rs
@@ -15,21 +15,32 @@
 use crate::{
     classes::{ClassEntry, RawVisibility, Visibility},
     errors::{throw, ArgumentCountError, ExceptionGuard, ThrowObject, Throwable},
+    modules::global_module,
     objects::{StateObj, ZObj, ZObject},
     strings::{ZStr, ZString},
     sys::*,
+    types::TypeInfo,
     utils::ensure_end_with_zero,
     values::{ExecuteData, ZVal},
 };
 use phper_alloc::ToRefOwned;
 use std::{
+    collections::HashMap,
     ffi::{CStr, CString},
     marker::PhantomData,
-    mem::{transmute, zeroed, ManuallyDrop},
+    mem::{size_of, transmute, zeroed, ManuallyDrop},
     ptr::{self, null_mut},
     rc::Rc,
+    slice,
 };
 
+/// Used to mark the arguments obtained by the invoke function as mysterious
+/// codes from phper
+const INVOKE_MYSTERIOUS_CODE: &[u8] = b"PHPER";
+
+/// Used to find the handler in the invoke function.
+pub(crate) type HandlerMap = HashMap<(Option<CString>, CString), Rc<dyn Callable>>;
+
 pub(crate) trait Callable {
     fn call(&self, execute_data: &mut ExecuteData, arguments: &mut [ZVal], return_value: &mut ZVal);
 }
@@ -107,6 +118,7 @@ impl FunctionEntry {
         Self::entry(
             &entity.name,
             &entity.arguments,
+            entity.return_type.as_ref(),
             Some(entity.handler.clone()),
             None,
         )
@@ -116,20 +128,31 @@ impl FunctionEntry {
         Self::entry(
             &entity.name,
             &entity.arguments,
+            entity.return_type.as_ref(),
             entity.handler.clone(),
             Some(entity.visibility),
         )
     }
 
     /// Will leak memory
     unsafe fn entry(
-        name: &CStr, arguments: &[Argument], handler: Option<Rc<dyn Callable>>,
-        visibility: Option<RawVisibility>,
+        name: &CStr, arguments: &[Argument], return_type: Option<&ReturnType>,
+        handler: Option<Rc<dyn Callable>>, visibility: Option<RawVisibility>,
     ) -> zend_function_entry {
         let mut infos = Vec::new();
 
         let require_arg_count = arguments.iter().filter(|arg| arg.required).count();
-        infos.push(phper_zend_begin_arg_info_ex(false, require_arg_count));
+
+        if let Some(return_type) = return_type {
+            infos.push(phper_zend_begin_arg_with_return_type_info_ex(
+                return_type.ret_by_ref,
+                require_arg_count,
+                return_type.type_info.into_raw(),
+                return_type.allow_null,
+            ));
+        } else {
+            infos.push(phper_zend_begin_arg_info_ex(false, require_arg_count));
+        }
 
         for arg in arguments {
             infos.push(phper_zend_arg_info(
@@ -140,6 +163,9 @@ impl FunctionEntry {
 
         infos.push(zeroed::<zend_internal_arg_info>());
 
+        // Will be checked in `invoke` function.
+        infos.push(Self::create_mysterious_code());
+
         let raw_handler = handler.as_ref().map(|_| invoke as _);
 
         if let Some(handler) = handler {
@@ -160,13 +186,22 @@ impl FunctionEntry {
             flags,
         }
     }
+
+    unsafe fn create_mysterious_code() -> zend_internal_arg_info {
+        let mut mysterious_code = [0u8; size_of::<zend_internal_arg_info>()];
+        for (i, n) in INVOKE_MYSTERIOUS_CODE.iter().enumerate() {
+            mysterious_code[i] = *n;
+        }
+        transmute(mysterious_code)
+    }
 }
 
 /// Builder for registering php function.
 pub struct FunctionEntity {
     name: CString,
     handler: Rc<dyn Callable>,
     arguments: Vec<Argument>,
+    return_type: Option<ReturnType>,
 }
 
 impl FunctionEntity {
@@ -176,6 +211,7 @@ impl FunctionEntity {
             name: ensure_end_with_zero(name),
             handler,
             arguments: Default::default(),
+            return_type: None,
         }
     }
 
@@ -192,14 +228,22 @@ impl FunctionEntity {
         self.arguments.extend(arguments);
         self
     }
+
+    /// Add return type info.
+    #[inline]
+    pub fn return_type(&mut self, return_type: ReturnType) -> &mut Self {
+        self.return_type = Some(return_type);
+        self
+    }
 }
 
 /// Builder for registering class method.
 pub struct MethodEntity {
-    name: CString,
-    handler: Option<Rc<dyn Callable>>,
+    pub(crate) name: CString,
+    pub(crate) handler: Option<Rc<dyn Callable>>,
     arguments: Vec<Argument>,
     visibility: RawVisibility,
+    return_type: Option<ReturnType>,
 }
 
 impl MethodEntity {
@@ -212,6 +256,7 @@ impl MethodEntity {
             handler,
             visibility: visibility as RawVisibility,
             arguments: Default::default(),
+            return_type: None,
         }
     }
 
@@ -240,6 +285,13 @@ impl MethodEntity {
         self.arguments.extend(arguments);
         self
     }
+
+    /// Add return type info.
+    #[inline]
+    pub fn return_type(&mut self, return_type: ReturnType) -> &mut Self {
+        self.return_type = Some(return_type);
+        self
+    }
 }
 
 /// Function or method argument info.
@@ -291,6 +343,42 @@ impl Argument {
     }
 }
 
+/// Function or method return type.
+pub struct ReturnType {
+    type_info: TypeInfo,
+    ret_by_ref: bool,
+    allow_null: bool,
+}
+
+impl ReturnType {
+    /// Indicate the return type is return by value.
+    #[inline]
+    pub fn by_val(type_info: TypeInfo) -> Self {
+        Self {
+            type_info,
+            ret_by_ref: false,
+            allow_null: false,
+        }
+    }
+
+    /// Indicate the return type is return by reference.
+    #[inline]
+    pub fn by_ref(type_info: TypeInfo) -> Self {
+        Self {
+            type_info,
+            ret_by_ref: true,
+            allow_null: false,
+        }
+    }
+
+    /// Indicate the return type can be null.
+    #[inline]
+    pub fn allow_null(mut self) -> Self {
+        self.allow_null = true;
+        self
+    }
+}
+
 /// Wrapper of [`zend_function`].
 #[repr(transparent)]
 pub struct ZFunc {
@@ -447,12 +535,43 @@ unsafe extern "C" fn invoke(execute_data: *mut zend_execute_data, return_value:
     let num_args = execute_data.common_num_args();
     let arg_info = execute_data.common_arg_info();
 
-    let last_arg_info = arg_info.offset((num_args + 1) as isize);
-    let translator = CallableTranslator {
-        arg_info: *last_arg_info,
+    // should be mysterious code
+    let mysterious_arg_info = arg_info.offset((num_args + 1) as isize);
+    let mysterious_code = slice::from_raw_parts(
+        mysterious_arg_info as *const u8,
+        INVOKE_MYSTERIOUS_CODE.len(),
+    );
+
+    let handler = if mysterious_code == INVOKE_MYSTERIOUS_CODE {
+        // hiddden real handler
+        let last_arg_info = arg_info.offset((num_args + 2) as isize);
+        let translator = CallableTranslator {
+            arg_info: *last_arg_info,
+        };
+        let handler = translator.callable;
+        handler.as_ref().expect("handler is null")
+    } else {
+        let function_name = execute_data
+            .func()
+            .get_function_name()
+            .and_then(|name| name.to_c_str().ok())
+            .map(CString::from);
+
+        function_name
+            .and_then(|function_name| {
+                let class_name = execute_data
+                    .func()
+                    .get_class()
+                    .and_then(|cls| cls.get_name().to_c_str().ok())
+                    .map(CString::from);
+
+                global_module()
+                    .handler_map
+                    .get(&(class_name, function_name))
+            })
+            .expect("invoke handler is not correct")
+            .as_ref()
     };
-    let handler = translator.callable;
-    let handler = handler.as_ref().expect("handler is null");
 
     // Check arguments count.
     let num_args = execute_data.num_args();
diff --git a/phper/src/modules.rs b/phper/src/modules.rs
@@ -15,7 +15,7 @@ use crate::{
     classes::{ClassEntity, InterfaceEntity},
     constants::Constant,
     errors::Throwable,
-    functions::{Function, FunctionEntity, FunctionEntry},
+    functions::{Function, FunctionEntity, FunctionEntry, HandlerMap},
     ini,
     sys::*,
     types::Scalar,
@@ -54,6 +54,7 @@ unsafe extern "C" fn module_startup(_type: c_int, module_number: c_int) -> c_int
     for class_entity in &module.class_entities {
         let ce = class_entity.init();
         class_entity.declare_properties(ce);
+        module.handler_map.extend(class_entity.handler_map());
     }
 
     for interface_entity in &module.interface_entities {
@@ -133,6 +134,8 @@ pub struct Module {
     constants: Vec<Constant>,
     ini_entities: Vec<ini::IniEntity>,
     infos: HashMap<CString, CString>,
+    /// Used to find the handler in the invoke function.
+    pub(crate) handler_map: HandlerMap,
 }
 
 impl Module {
@@ -154,6 +157,7 @@ impl Module {
             constants: Default::default(),
             ini_entities: Default::default(),
             infos: Default::default(),
+            handler_map: Default::default(),
         }
     }
 
diff --git a/tests/integration/Cargo.toml b/tests/integration/Cargo.toml
@@ -26,3 +26,11 @@ phper = { workspace = true }
 
 [dev-dependencies]
 phper-test = { workspace = true }
+
+[build-dependencies]
+phper-build = { workspace = true }
+
+[lints.rust]
+unexpected_cfgs = { level = "warn", check-cfg = [
+    'cfg(phper_major_version, values("8"))',
+] }
diff --git a/tests/integration/build.rs b/tests/integration/build.rs
@@ -9,9 +9,5 @@
 // See the Mulan PSL v2 for more details.
 
 fn main() {
-    #[cfg(target_os = "macos")]
-    {
-        println!("cargo:rustc-link-arg=-undefined");
-        println!("cargo:rustc-link-arg=dynamic_lookup");
-    }
+    phper_build::register_all();
 }
diff --git a/tests/integration/src/classes.rs b/tests/integration/src/classes.rs
@@ -25,6 +25,8 @@ pub fn integrate(module: &mut Module) {
     integrate_foo(module);
     integrate_i_bar(module);
     integrate_static_props(module);
+    #[cfg(phper_major_version = "8")]
+    integrate_stringable(module);
 }
 
 fn integrate_a(module: &mut Module) {
@@ -181,3 +183,16 @@ fn integrate_static_props(module: &mut Module) {
 
     module.add_class(class);
 }
+
+#[cfg(phper_major_version = "8")]
+fn integrate_stringable(module: &mut Module) {
+    use phper::{functions::ReturnType, types::TypeInfo};
+
+    let mut cls = ClassEntity::new(r"IntegrationTest\FooString");
+    cls.implements(|| ClassEntry::from_globals("Stringable").unwrap());
+    cls.add_method("__toString", Visibility::Public, |_this, _: &mut [ZVal]| {
+        phper::ok("string")
+    })
+    .return_type(ReturnType::by_val(TypeInfo::STRING));
+    module.add_class(cls);
+}
diff --git a/tests/integration/tests/php/classes.php b/tests/integration/tests/php/classes.php
