Add preliminary PHP 8.1 support (#109)

* Bump PHP API version, remove flags removed from PHP API

See following commits:
- php/php-src@70195c3
- php/php-src@b5746a4

* Add PHP 8.1 to CI

* Clippy lint

* Fix PHP 8.1 support with new features

Author: davidcole1340

.github/workflows/build.yml

@@ -19,6 +19,7 @@ jobs:
           - nightly
         php:
           - '8.0'
+          - '8.1'
         llvm:
           - '11.0'
     steps:

Cargo.toml

@@ -14,6 +14,7 @@ exclude = ["/.github", "/.crates", "/guide"]
 [dependencies]
 bitflags = "1.2.1"
 parking_lot = "0.11.2"
+cfg-if = "1.0"
 ext-php-rs-derive = { version = "=0.7.1", path = "./crates/macros" }
 
 [build-dependencies]

allowed_bindings.rs

@@ -190,5 +190,6 @@ bind! {
     zend_class_serialize_deny,
     zend_class_unserialize_deny,
     zend_objects_store_del,
-    gc_possible_root
+    gc_possible_root,
+    ZEND_ACC_NOT_SERIALIZABLE
 }

build.rs

@@ -8,12 +8,13 @@ use std::{
 use regex::Regex;
 
 const MIN_PHP_API_VER: u32 = 20200930;
-const MAX_PHP_API_VER: u32 = 20200930;
+const MAX_PHP_API_VER: u32 = 20210902;
 
 fn main() {
     // rerun if wrapper header is changed
     println!("cargo:rerun-if-changed=src/wrapper.h");
     println!("cargo:rerun-if-changed=src/wrapper.c");
+    println!("cargo:rerun-if-changed=allowed_bindings.rs");
 
     let out_dir = env::var_os("OUT_DIR").expect("Failed to get OUT_DIR");
     let out_path = PathBuf::from(out_dir).join("bindings.rs");
@@ -63,10 +64,25 @@ fn main() {
         .and_then(|ver| ver.as_str().parse::<u32>().ok())
         .expect("Unable to retrieve PHP API version from `php -i`.");
 
-    if api_ver < MIN_PHP_API_VER || api_ver > MAX_PHP_API_VER {
+    if !(MIN_PHP_API_VER..=MAX_PHP_API_VER).contains(&api_ver) {
         panic!("The current version of PHP is not supported. Current PHP API version: {}, requires a version between {} and {}", api_ver, MIN_PHP_API_VER, MAX_PHP_API_VER);
     }
 
+    // Infra cfg flags - use these for things that change in the Zend API that don't
+    // rely on a feature and the crate user won't care about (e.g. struct field
+    // changes). Use a feature flag for an actual feature (e.g. enums being
+    // introduced in PHP 8.1).
+    //
+    // PHP 8.0 is the baseline - no feature flags will be introduced here.
+    //
+    // The PHP version cfg flags should also stack - if you compile on PHP 8.2 you
+    // should get both the `php81` and `php82` flags.
+    const PHP_81_API_VER: u32 = 20210902;
+
+    if api_ver >= PHP_81_API_VER {
+        println!("cargo:rustc-cfg=php81");
+    }
+
     let includes =
         String::from_utf8(includes_cmd.stdout).expect("unable to parse `php-config` stdout");
 

src/builders/class.rs

@@ -7,8 +7,8 @@ use crate::{
     error::{Error, Result},
     exception::PhpException,
     ffi::{
-        zend_class_serialize_deny, zend_class_unserialize_deny, zend_declare_class_constant,
-        zend_declare_property, zend_do_implement_interface, zend_register_internal_class_ex,
+        zend_declare_class_constant, zend_declare_property, zend_do_implement_interface,
+        zend_register_internal_class_ex,
     },
     flags::{ClassFlags, MethodFlags, PropertyFlags},
     types::{ZendClassObject, ZendObject, ZendStr, Zval},
@@ -242,12 +242,15 @@ impl ClassBuilder {
         };
 
         // disable serialization if the class has an associated object
-        //
-        // TODO(david): change to support PHP 8.1 - uses a flag instead of the
-        // serializable/deserializable properties
         if self.object_override.is_some() {
-            class.serialize = Some(zend_class_serialize_deny);
-            class.unserialize = Some(zend_class_unserialize_deny);
+            cfg_if::cfg_if! {
+                if #[cfg(php81)] {
+                    class.ce_flags |= ClassFlags::NotSerializable.bits();
+                } else {
+                    class.serialize = Some(crate::ffi::zend_class_serialize_deny);
+                    class.unserialize = Some(crate::ffi::zend_class_unserialize_deny);
+                }
+            }
         }
 
         for iface in self.interfaces {

src/flags.rs

@@ -10,15 +10,14 @@ use crate::ffi::{
     ZEND_ACC_CHANGED, ZEND_ACC_CLOSURE, ZEND_ACC_CONSTANTS_UPDATED, ZEND_ACC_CTOR,
     ZEND_ACC_DEPRECATED, ZEND_ACC_DONE_PASS_TWO, ZEND_ACC_EARLY_BINDING, ZEND_ACC_FAKE_CLOSURE,
     ZEND_ACC_FINAL, ZEND_ACC_GENERATOR, ZEND_ACC_HAS_FINALLY_BLOCK, ZEND_ACC_HAS_RETURN_TYPE,
-    ZEND_ACC_HAS_TYPE_HINTS, ZEND_ACC_HAS_UNLINKED_USES, ZEND_ACC_HEAP_RT_CACHE,
-    ZEND_ACC_IMMUTABLE, ZEND_ACC_IMPLICIT_ABSTRACT_CLASS, ZEND_ACC_INTERFACE, ZEND_ACC_LINKED,
-    ZEND_ACC_NEARLY_LINKED, ZEND_ACC_NEVER_CACHE, ZEND_ACC_NO_DYNAMIC_PROPERTIES,
-    ZEND_ACC_PRELOADED, ZEND_ACC_PRIVATE, ZEND_ACC_PROMOTED, ZEND_ACC_PROPERTY_TYPES_RESOLVED,
-    ZEND_ACC_PROTECTED, ZEND_ACC_PUBLIC, ZEND_ACC_RESOLVED_INTERFACES, ZEND_ACC_RESOLVED_PARENT,
-    ZEND_ACC_RETURN_REFERENCE, ZEND_ACC_REUSE_GET_ITERATOR, ZEND_ACC_STATIC, ZEND_ACC_STRICT_TYPES,
-    ZEND_ACC_TOP_LEVEL, ZEND_ACC_TRAIT, ZEND_ACC_TRAIT_CLONE, ZEND_ACC_UNRESOLVED_VARIANCE,
-    ZEND_ACC_USES_THIS, ZEND_ACC_USE_GUARDS, ZEND_ACC_VARIADIC, ZEND_HAS_STATIC_IN_METHODS,
-    Z_TYPE_FLAGS_SHIFT, _IS_BOOL,
+    ZEND_ACC_HAS_TYPE_HINTS, ZEND_ACC_HEAP_RT_CACHE, ZEND_ACC_IMMUTABLE,
+    ZEND_ACC_IMPLICIT_ABSTRACT_CLASS, ZEND_ACC_INTERFACE, ZEND_ACC_LINKED, ZEND_ACC_NEARLY_LINKED,
+    ZEND_ACC_NEVER_CACHE, ZEND_ACC_NO_DYNAMIC_PROPERTIES, ZEND_ACC_PRELOADED, ZEND_ACC_PRIVATE,
+    ZEND_ACC_PROMOTED, ZEND_ACC_PROTECTED, ZEND_ACC_PUBLIC, ZEND_ACC_RESOLVED_INTERFACES,
+    ZEND_ACC_RESOLVED_PARENT, ZEND_ACC_RETURN_REFERENCE, ZEND_ACC_REUSE_GET_ITERATOR,
+    ZEND_ACC_STATIC, ZEND_ACC_STRICT_TYPES, ZEND_ACC_TOP_LEVEL, ZEND_ACC_TRAIT,
+    ZEND_ACC_TRAIT_CLONE, ZEND_ACC_UNRESOLVED_VARIANCE, ZEND_ACC_USES_THIS, ZEND_ACC_USE_GUARDS,
+    ZEND_ACC_VARIADIC, ZEND_HAS_STATIC_IN_METHODS, Z_TYPE_FLAGS_SHIFT, _IS_BOOL,
 };
 
 use std::{convert::TryFrom, fmt::Display};
@@ -76,13 +75,14 @@ bitflags! {
         const ConstantsUpdated = ZEND_ACC_CONSTANTS_UPDATED;
         const NoDynamicProperties = ZEND_ACC_NO_DYNAMIC_PROPERTIES;
         const HasStaticInMethods = ZEND_HAS_STATIC_IN_METHODS;
-        const PropertyTypesResolved = ZEND_ACC_PROPERTY_TYPES_RESOLVED;
         const ReuseGetIterator = ZEND_ACC_REUSE_GET_ITERATOR;
         const ResolvedParent = ZEND_ACC_RESOLVED_PARENT;
         const ResolvedInterfaces = ZEND_ACC_RESOLVED_INTERFACES;
         const UnresolvedVariance = ZEND_ACC_UNRESOLVED_VARIANCE;
         const NearlyLinked = ZEND_ACC_NEARLY_LINKED;
-        const HasUnlinkedUses = ZEND_ACC_HAS_UNLINKED_USES;
+
+        #[cfg(php81)]
+        const NotSerializable = crate::ffi::ZEND_ACC_NOT_SERIALIZABLE;
     }
 }