Optimize code. (#37)

jmjoy · web-flow · commit b8e0a23b2b1a · 2022-08-15T18:46:55.000+08:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -94,12 +94,12 @@ jobs:
           command: build
           args: --release
 
-      # - name: Cargo clippy
-      #   uses: actions-rs/cargo@v1
-      #   with:
-      #     toolchain: stable
-      #     command: clippy
-      #     args: --release
+      - name: Cargo clippy
+        uses: actions-rs/cargo@v1
+        with:
+          toolchain: stable
+          command: clippy
+          args: --release
 
       - name: Cargo test
         uses: actions-rs/cargo@v1
@@ -117,6 +117,7 @@ jobs:
           command: doc
           args: --workspace --no-deps --all-features
 
+  # Test every features for single crate.
   check:
     name: Check
     strategy:
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 ## Rust ❤️ PHP
 
-A library that allows us to write PHP extensions using pure Rust and using safe Rust whenever possible.
+The framework that allows us to write PHP extensions using pure and safe Rust whenever possible.
 
 ## Requirement
 
diff --git a/examples/hello/Cargo.toml b/examples/hello/Cargo.toml
@@ -29,10 +29,10 @@ path = "src/_reexport.rs"
 crate-type = ["cdylib"]
 
 [dependencies]
-phper = { version = "0.4.0-alpha.4", path = "../../phper" }
+phper = { version = "0.4.0", path = "../../phper" }
 
 [dev-dependencies]
-phper-test = { version = "0.4.0-alpha.4", path = "../../phper-test" }
+phper-test = { version = "0.4.0", path = "../../phper-test" }
 
 [build-dependencies]
-phper-build = { version = "0.4.0-alpha.4", path = "../../phper-build" }
+phper-build = { version = "0.4.0", path = "../../phper-build" }
diff --git a/examples/http-client/Cargo.toml b/examples/http-client/Cargo.toml
@@ -32,9 +32,9 @@ crate-type = ["cdylib"]
 anyhow = "1.0.58"
 bytes = "1.1.0"
 indexmap = "1.9.1"
-phper = { version = "0.4.0-alpha.4", path = "../../phper" }
+phper = { version = "0.4.0", path = "../../phper" }
 reqwest = { version = "0.11.11", features = ["blocking", "cookies"] }
 thiserror = "1.0.31"
 
 [dev-dependencies]
-phper-test = { version = "0.4.0-alpha.4", path = "../../phper-test" }
+phper-test = { version = "0.4.0", path = "../../phper-test" }
diff --git a/examples/http-server/Cargo.toml b/examples/http-server/Cargo.toml
@@ -30,10 +30,10 @@ crate-type = ["cdylib"]
 
 [dependencies]
 hyper = { version = "0.14.20", features = ["http1", "runtime", "server"] }
-phper = { version = "0.4.0-alpha.4", path = "../../phper" }
+phper = { version = "0.4.0", path = "../../phper" }
 thiserror = "1.0.31"
 tokio = { version = "1.19.2", features = ["full"] }
 
 [dev-dependencies]
-phper-test = { version = "0.4.0-alpha.4", path = "../../phper-test" }
+phper-test = { version = "0.4.0", path = "../../phper-test" }
 reqwest = "0.11.11"
diff --git a/examples/logging/Cargo.toml b/examples/logging/Cargo.toml
@@ -30,10 +30,10 @@ crate-type = ["cdylib"]
 
 [dependencies]
 anyhow = "1.0.58"
-phper = { version = "0.4.0-alpha.4", path = "../../phper" }
+phper = { version = "0.4.0", path = "../../phper" }
 
 [dev-dependencies]
-phper-test = { version = "0.4.0-alpha.4", path = "../../phper-test" }
+phper-test = { version = "0.4.0", path = "../../phper-test" }
 
 [build-dependencies]
-phper-build = { version = "0.4.0-alpha.4", path = "../../phper-build" }
+phper-build = { version = "0.4.0", path = "../../phper-build" }
diff --git a/phper-alloc/Cargo.toml b/phper-alloc/Cargo.toml
@@ -10,7 +10,7 @@
 
 [package]
 name = "phper-alloc"
-version = "0.4.0-alpha.4"
+version = "0.4.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2021"
 rust-version = "1.56"
@@ -22,7 +22,7 @@ keywords = ["php", "alloc"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-phper-sys = { version = "0.4.0-alpha.4", path = "../phper-sys" }
+phper-sys = { version = "0.4.0", path = "../phper-sys" }
 
 [build-dependencies]
-phper-build = { version = "0.4.0-alpha.4", path = "../phper-build" }
+phper-build = { version = "0.4.0", path = "../phper-build" }
diff --git a/phper-build/Cargo.toml b/phper-build/Cargo.toml
@@ -10,7 +10,7 @@
 
 [package]
 name = "phper-build"
-version = "0.4.0-alpha.4"
+version = "0.4.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2021"
 rust-version = "1.56"
@@ -22,4 +22,4 @@ keywords = ["php", "binding"]
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-phper-sys = { version = "0.4.0-alpha.4", path = "../phper-sys" }
+phper-sys = { version = "0.4.0", path = "../phper-sys" }
diff --git a/phper-macros/Cargo.toml b/phper-macros/Cargo.toml
@@ -10,7 +10,7 @@
 
 [package]
 name = "phper-macros"
-version = "0.4.0-alpha.4"
+version = "0.4.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2021"
 rust-version = "1.56"
diff --git a/phper-sys/Cargo.toml b/phper-sys/Cargo.toml
@@ -10,7 +10,7 @@
 
 [package]
 name = "phper-sys"
-version = "0.4.0-alpha.4"
+version = "0.4.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2021"
 rust-version = "1.56"
diff --git a/phper-test/Cargo.toml b/phper-test/Cargo.toml
@@ -10,7 +10,7 @@
 
 [package]
 name = "phper-test"
-version = "0.4.0-alpha.4"
+version = "0.4.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2021"
 rust-version = "1.56"
@@ -28,7 +28,7 @@ fpm = ["fastcgi-client", "tokio/full"]
 fastcgi-client = { version = "0.7.0", optional = true }
 libc = "0.2.126"
 once_cell = "1.13.0"
-phper-macros = { version = "0.4.0-alpha.4", path = "../phper-macros" }
+phper-macros = { version = "0.4.0", path = "../phper-macros" }
 tempfile = "3.3.0"
 tokio = { version = "1.19.2", optional = true }
 
diff --git a/phper-test/README.md b/phper-test/README.md
@@ -6,9 +6,11 @@ The `php-config` is needed. You can set environment `PHP_CONFIG` to specify the
 
 ## Notice
 
-Because the `phper-test` depends on the `cdylib` to do integration test, but now `cargo test` don't build `cdylib` in `[lib]`, so you must call `cargo build` before `cargo test`.
+1. Because the `phper-test` depends on the `cdylib` to do integration test, but now `cargo test` don't build `cdylib` in `[lib]`, so you must call `cargo build` before `cargo test`.
 
-Maybe, when the feature [artifact-dependencies](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#artifact-dependencies) becomes stable, or the [issue](https://github.com/rust-lang/cargo/issues/8628) be solved, you don't have to call `cargo build` in advance, but I think it will be a long long stage.
+   Maybe, when the feature [artifact-dependencies](https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#artifact-dependencies) becomes stable, or the [issue](https://github.com/rust-lang/cargo/issues/8628) be solved, you don't have to call `cargo build` in advance, but I think it will be a long long stage.
+
+1. Or, define an `[[example]]` section, re-export all the symbols of your crate, and set `lto = true`. It's strange, but this is the only method to just run `cargo test` without running `cargo build` in advance. Please refer to [tests/integration/Cargo.toml](https://github.com/jmjoy/phper/blob/master/tests/integration/Cargo.toml).
 
 ## License
 
diff --git a/phper/Cargo.toml b/phper/Cargo.toml
@@ -10,11 +10,11 @@
 
 [package]
 name = "phper"
-version = "0.4.0-alpha.4"
+version = "0.4.0"
 authors = ["jmjoy <918734043@qq.com>"]
 edition = "2021"
 rust-version = "1.56"
-description = "A library that allows us to write PHP extensions using pure Rust and using safe Rust whenever possible."
+description = "The framework that allows us to write PHP extensions using pure and safe Rust whenever possible."
 repository = "https://github.com/jmjoy/phper.git"
 documentation = "https://docs.rs/phper"
 license = "MulanPSL-2.0"
@@ -30,11 +30,11 @@ dashmap = "5.3.4"
 derive_more = "0.99.17"
 indexmap = "1.9.1"
 once_cell = "1.13.0"
-phper-alloc = { version = "0.4.0-alpha.4", path = "../phper-alloc" }
-phper-macros = { version = "0.4.0-alpha.4", path = "../phper-macros" }
-phper-sys = { version = "0.4.0-alpha.4", path = "../phper-sys" }
+phper-alloc = { version = "0.4.0", path = "../phper-alloc" }
+phper-macros = { version = "0.4.0", path = "../phper-macros" }
+phper-sys = { version = "0.4.0", path = "../phper-sys" }
 thiserror = "1.0.31"
 
 [build-dependencies]
-phper-build = { version = "0.4.0-alpha.4", path = "../phper-build" }
-phper-sys = { version = "0.4.0-alpha.4", path = "../phper-sys" }
+phper-build = { version = "0.4.0", path = "../phper-build" }
+phper-sys = { version = "0.4.0", path = "../phper-sys" }
diff --git a/phper/src/arrays.rs b/phper/src/arrays.rs
@@ -57,14 +57,38 @@ pub struct ZArr {
 }
 
 impl ZArr {
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
     pub unsafe fn from_ptr<'a>(ptr: *const zend_array) -> &'a Self {
         (ptr as *const Self).as_ref().expect("ptr should't be null")
     }
 
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
+    pub unsafe fn try_from_ptr<'a>(ptr: *const zend_array) -> Option<&'a Self> {
+        (ptr as *const Self).as_ref()
+    }
+
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
     pub unsafe fn from_mut_ptr<'a>(ptr: *mut zend_array) -> &'a mut Self {
         (ptr as *mut Self).as_mut().expect("ptr should't be null")
     }
 
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
+    pub unsafe fn try_from_mut_ptr<'a>(ptr: *mut zend_array) -> Option<&'a mut Self> {
+        (ptr as *mut Self).as_mut()
+    }
+
     pub const fn as_ptr(&self) -> *const zend_array {
         &self.inner
     }
@@ -277,6 +301,14 @@ impl ZArray {
         }
     }
 
+    /// Create owned object From raw pointer, usually used in pairs with
+    /// `into_raw`.
+    ///
+    /// # Safety
+    ///
+    /// This function is unsafe because improper use may lead to memory
+    /// problems. For example, a double-free may occur if the function is called
+    /// twice on the same raw pointer.
     #[inline]
     pub unsafe fn from_raw(ptr: *mut zend_array) -> Self {
         Self {
diff --git a/phper/src/classes.rs b/phper/src/classes.rs
@@ -168,22 +168,36 @@ pub struct ClassEntry {
 }
 
 impl ClassEntry {
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
     pub unsafe fn from_ptr<'a>(ptr: *const zend_class_entry) -> &'a Self {
         (ptr as *const Self).as_ref().expect("ptr should't be null")
     }
 
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
+    pub unsafe fn try_from_ptr<'a>(ptr: *const zend_class_entry) -> Option<&'a Self> {
+        (ptr as *const Self).as_ref()
+    }
+
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
     pub unsafe fn from_mut_ptr<'a>(ptr: *mut zend_class_entry) -> &'a mut Self {
         (ptr as *mut Self).as_mut().expect("ptr should't be null")
     }
 
-    pub fn from_globals<'a>(class_name: impl AsRef<str>) -> crate::Result<&'a Self> {
-        let name = class_name.as_ref();
-        let ptr: *mut Self = find_global_class_entry_ptr(name).cast();
-        unsafe {
-            ptr.as_ref().ok_or_else(|| {
-                crate::Error::ClassNotFound(ClassNotFoundError::new(name.to_string()))
-            })
-        }
+    /// # Safety
+    ///
+    /// Create from raw pointer.
+    #[inline]
+    pub unsafe fn try_from_mut_ptr<'a>(ptr: *mut zend_class_entry) -> Option<&'a mut Self> {
+        (ptr as *mut Self).as_mut()
     }
 
     pub const fn as_ptr(&self) -> *const zend_class_entry {
@@ -195,6 +209,16 @@ impl ClassEntry {
         &mut self.inner
     }
 
+    pub fn from_globals<'a>(class_name: impl AsRef<str>) -> crate::Result<&'a Self> {
+        let name = class_name.as_ref();
+        let ptr: *mut Self = find_global_class_entry_ptr(name).cast();
+        unsafe {
+            ptr.as_ref().ok_or_else(|| {
+                crate::Error::ClassNotFound(ClassNotFoundError::new(name.to_string()))
+            })
+        }
+    }
+
     /// Create the object from class and call `__construct` with arguments.
     pub fn new_object(&self, arguments: impl AsMut<[ZVal]>) -> crate::Result<ZObject> {
         let mut object = self.init_object()?;
@@ -382,7 +406,7 @@ impl PropertyEntity {
 }
 
 #[repr(u32)]
-#[derive(Debug, Copy, Clone, PartialEq)]
+#[derive(Debug, Copy, Clone, PartialEq, Eq)]
 pub enum Visibility {
     Public = ZEND_ACC_PUBLIC,
     Protected = ZEND_ACC_PROTECTED,
diff --git a/phper/src/functions.rs b/phper/src/functions.rs
@@ -26,7 +26,7 @@ use crate::{
 use std::{
     convert::TryInto,
     marker::PhantomData,
-    mem::{forget, size_of, zeroed},
+    mem::{size_of, transmute, zeroed},
     os::raw::c_char,
     ptr::null_mut,
 };
@@ -93,7 +93,7 @@ where
     ) {
         unsafe {
             let this = execute_data.get_this_mut().unwrap();
-            let this = StatefulObj::from_z_obj(this);
+            let this = this.as_mut_stateful_obj();
             let r = (self.f)(this, arguments);
             *return_value = r.into();
         }
@@ -225,8 +225,7 @@ impl ZendFunction {
         ptr.as_mut().expect("ptr shouldn't be null")
     }
 
-    #[inline]
-    pub fn as_ptr(&self) -> *const zend_function {
+    pub const fn as_ptr(&self) -> *const zend_function {
         &self.inner
     }
 
@@ -368,16 +367,10 @@ unsafe extern "C" fn invoke(execute_data: *mut zend_execute_data, return_value:
     }
 
     let mut arguments = execute_data.get_parameters_array();
+    let arguments = arguments.as_mut_slice();
 
     // TODO catch_unwind for call, translate some panic to throwing Error.
-    handler.call(execute_data, &mut arguments, return_value);
-
-    // Do not call the drop method, because there is the `zend_vm_stack_free_args`
-    // call after executing function.
-    // TODO remove after arguments become reference.
-    for argument in arguments {
-        forget(argument);
-    }
+    handler.call(execute_data, transmute(arguments), return_value);
 }
 
 pub(crate) const fn create_zend_arg_info(
diff --git a/phper/src/objects.rs b/phper/src/objects.rs
diff --git a/phper/src/output.rs b/phper/src/output.rs
diff --git a/phper/src/resources.rs b/phper/src/resources.rs
diff --git a/phper/src/strings.rs b/phper/src/strings.rs
diff --git a/phper/src/types.rs b/phper/src/types.rs
diff --git a/phper/src/values.rs b/phper/src/values.rs
diff --git a/tests/integration/Cargo.toml b/tests/integration/Cargo.toml
