Expose SAPI module

Author: danog

allowed_bindings.rs

@@ -27,6 +27,7 @@ bind! {
     _emalloc,
     _zend_executor_globals,
     _sapi_globals_struct,
+    _sapi_module_struct,
     _zend_expected_type,
     _zend_expected_type_Z_EXPECTED_ARRAY,
     _zend_expected_type_Z_EXPECTED_BOOL,
@@ -243,6 +244,7 @@ bind! {
     zend_class_unserialize_deny,
     zend_executor_globals,
     sapi_globals_struct,
+    sapi_module_struct,
     zend_objects_store_del,
     zend_hash_move_forward_ex,
     zend_hash_get_current_key_type_ex,
@@ -254,6 +256,7 @@ bind! {
     ZEND_ACC_NOT_SERIALIZABLE,
     executor_globals,
     sapi_globals,
+    sapi_module,
     php_printf,
     __zend_malloc,
     tsrm_get_ls_cache,

src/ffi.rs

@@ -27,6 +27,7 @@ extern "C" {
     pub fn ext_php_rs_zend_object_release(obj: *mut zend_object);
     pub fn ext_php_rs_executor_globals() -> *mut zend_executor_globals;
     pub fn ext_php_rs_sapi_globals() -> *mut sapi_globals_struct;
+    pub fn ext_php_rs_sapi_module() -> *mut sapi_module_struct;
     pub fn ext_php_rs_zend_try_catch(
         func: unsafe extern "C" fn(*const c_void) -> *const c_void,
         ctx: *const c_void,

src/wrapper.c

@@ -52,6 +52,10 @@ sapi_globals_struct *ext_php_rs_sapi_globals() {
 #endif
 }
 
+sapi_module_struct *ext_php_rs_sapi_module() {
+  return &sapi_module;
+}
+
 bool ext_php_rs_zend_try_catch(void* (*callback)(void *), void *ctx, void **result) {
   zend_try {
     *result = callback(ctx);

src/wrapper.h

@@ -33,5 +33,6 @@ void *ext_php_rs_zend_object_alloc(size_t obj_size, zend_class_entry *ce);
 void ext_php_rs_zend_object_release(zend_object *obj);
 zend_executor_globals *ext_php_rs_executor_globals();;
 sapi_globals_struct *ext_php_rs_sapi_globals();
+sapi_module_struct *ext_php_rs_sapi_module();
 bool ext_php_rs_zend_try_catch(void* (*callback)(void *), void *ctx, void **result);
 void ext_php_rs_zend_bailout();

src/zend/globals.rs

@@ -10,6 +10,7 @@ use crate::boxed::ZBox;
 use crate::ffi::zend_atomic_bool_store;
 use crate::ffi::{
     _sapi_globals_struct, _zend_executor_globals, ext_php_rs_executor_globals,
+    _sapi_module_struct, ext_php_rs_sapi_module,
     ext_php_rs_sapi_globals, zend_ini_entry,
 };
 use crate::types::{ZendHashTable, ZendObject};
@@ -20,6 +21,9 @@ pub type ExecutorGlobals = _zend_executor_globals;
 /// Stores global SAPI variables used in the PHP executor.
 pub type SapiGlobals = _sapi_globals_struct;
 
+/// Stores the SAPI module used in the PHP executor.
+pub type SapiModule = _sapi_module_struct;
+
 impl ExecutorGlobals {
     /// Returns a reference to the PHP executor globals.
     ///
@@ -167,6 +171,40 @@ impl SapiGlobals {
     }
 }
 
+impl SapiModule {
+    /// Returns a reference to the PHP SAPI module.
+    ///
+    /// The executor globals are guarded by a RwLock. There can be multiple
+    /// immutable references at one time but only ever one mutable reference.
+    /// Attempting to retrieve the globals while already holding the global
+    /// guard will lead to a deadlock. Dropping the globals guard will release
+    /// the lock.
+    pub fn get() -> GlobalReadGuard<Self> {
+        // SAFETY: PHP executor globals are statically declared therefore should never
+        // return an invalid pointer.
+        let globals = unsafe { ext_php_rs_sapi_module().as_ref() }
+            .expect("Static executor globals were invalid");
+        let guard = SAPI_MODULE_LOCK.read();
+        GlobalReadGuard { globals, guard }
+    }
+
+    /// Returns a mutable reference to the PHP executor globals.
+    ///
+    /// The executor globals are guarded by a RwLock. There can be multiple
+    /// immutable references at one time but only ever one mutable reference.
+    /// Attempting to retrieve the globals while already holding the global
+    /// guard will lead to a deadlock. Dropping the globals guard will release
+    /// the lock.
+    pub fn get_mut() -> GlobalWriteGuard<Self> {
+        // SAFETY: PHP executor globals are statically declared therefore should never
+        // return an invalid pointer.
+        let globals = unsafe { ext_php_rs_sapi_module().as_mut() }
+            .expect("Static executor globals were invalid");
+        let guard = SAPI_MODULE_LOCK.write();
+        GlobalWriteGuard { globals, guard }
+    }
+}
+
 /// Executor globals rwlock.
 ///
 /// PHP provides no indication if the executor globals are being accessed so
@@ -179,6 +217,12 @@ static GLOBALS_LOCK: RwLock<()> = const_rwlock(());
 /// this is only effective on the Rust side.
 static SAPI_LOCK: RwLock<()> = const_rwlock(());
 
+/// SAPI globals rwlock.
+///
+/// PHP provides no indication if the executor globals are being accessed so
+/// this is only effective on the Rust side.
+static SAPI_MODULE_LOCK: RwLock<()> = const_rwlock(());
+
 /// Wrapper guard that contains a reference to a given type `T`. Dropping a
 /// guard releases the lock on the relevant rwlock.
 pub struct GlobalReadGuard<T: 'static> {