Add timed lock support to RWLock (#5866)

* Swoole\Lock: add timed rwlock support

* fixed known issues

Author: Appla

ext-src/stubs/php_swoole_lock.stub.php

@@ -4,7 +4,7 @@ class Lock {
         public function __construct(int $type = SWOOLE_MUTEX) {}
         public function __destruct() {}
         public function lock(): bool {}
-        public function locakwait(float $timeout = 1.0): bool {}
+        public function lockwait(float $timeout = 1.0, int $kind = 0): bool {}
         public function trylock(): bool {}
         public function lock_read(): bool {}
         public function trylock_read(): bool {}

ext-src/stubs/php_swoole_lock_arginfo.h

@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: 078bbefb0c45cb686da54e4c700bad31710589ef */
+ * Stub hash: aa2ff16543143c6d0e8858e9900fa511cffed40c */
 
 ZEND_BEGIN_ARG_INFO_EX(arginfo_class_Swoole_Lock___construct, 0, 0, 0)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, type, IS_LONG, 0, "SWOOLE_MUTEX")
@@ -11,8 +11,9 @@ ZEND_END_ARG_INFO()
 ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Swoole_Lock_lock, 0, 0, _IS_BOOL, 0)
 ZEND_END_ARG_INFO()
 
-ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Swoole_Lock_locakwait, 0, 0, _IS_BOOL, 0)
+ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_class_Swoole_Lock_lockwait, 0, 0, _IS_BOOL, 0)
 	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, timeout, IS_DOUBLE, 0, "1.0")
+	ZEND_ARG_TYPE_INFO_WITH_DEFAULT_VALUE(0, kind, IS_LONG, 0, "0")
 ZEND_END_ARG_INFO()
 
 #define arginfo_class_Swoole_Lock_trylock arginfo_class_Swoole_Lock_lock

ext-src/swoole_lock.cc

@@ -88,7 +88,7 @@ static const zend_function_entry swoole_lock_methods[] =
     PHP_ME(swoole_lock, __construct,  arginfo_class_Swoole_Lock___construct,  ZEND_ACC_PUBLIC)
     PHP_ME(swoole_lock, __destruct,   arginfo_class_Swoole_Lock___destruct,   ZEND_ACC_PUBLIC)
     PHP_ME(swoole_lock, lock,         arginfo_class_Swoole_Lock_lock,         ZEND_ACC_PUBLIC)
-    PHP_ME(swoole_lock, lockwait,     arginfo_class_Swoole_Lock_locakwait,    ZEND_ACC_PUBLIC)
+    PHP_ME(swoole_lock, lockwait,     arginfo_class_Swoole_Lock_lockwait,    ZEND_ACC_PUBLIC)
     PHP_ME(swoole_lock, trylock,      arginfo_class_Swoole_Lock_trylock,      ZEND_ACC_PUBLIC)
     PHP_ME(swoole_lock, lock_read,    arginfo_class_Swoole_Lock_lock_read,    ZEND_ACC_PUBLIC)
     PHP_ME(swoole_lock, trylock_read, arginfo_class_Swoole_Lock_trylock_read, ZEND_ACC_PUBLIC)
@@ -170,17 +170,42 @@ static PHP_METHOD(swoole_lock, lock) {
 
 static PHP_METHOD(swoole_lock, lockwait) {
     double timeout = 1.0;
+    // 0: write lock, 1: read lock(only for rwlock)
+    zend_long kind = 0;
 
-    ZEND_PARSE_PARAMETERS_START(0, 1)
+    ZEND_PARSE_PARAMETERS_START(0, 2)
     Z_PARAM_OPTIONAL
     Z_PARAM_DOUBLE(timeout)
+    Z_PARAM_LONG(kind)
     ZEND_PARSE_PARAMETERS_END_EX(RETURN_FALSE);
 
     Lock *lock = php_swoole_lock_get_and_check_ptr(ZEND_THIS);
-    if (lock->get_type() != Lock::MUTEX) {
+    if (!(lock->get_type() == Lock::MUTEX
+#ifdef HAVE_RWLOCK
+    || lock->get_type() == Lock::RW_LOCK
+#endif
+    )) {
+#ifdef HAVE_RWLOCK
+        zend_throw_exception(swoole_exception_ce, "only mutex and rwlock supports lockwait", -2);
+#else
         zend_throw_exception(swoole_exception_ce, "only mutex supports lockwait", -2);
+#endif
+
         RETURN_FALSE;
     }
+#ifdef HAVE_RWLOCK
+    if (lock->get_type() == Lock::RW_LOCK) {
+        RWLock *rwlock = dynamic_cast<RWLock *>(lock);
+        if (rwlock == nullptr) {
+            zend_throw_exception(swoole_exception_ce, "wrong lock type", -3);
+            RETURN_FALSE;
+        }
+        if (kind == 1) {
+            SW_LOCK_CHECK_RETURN(rwlock->lock_rd_wait((int) (timeout * 1000)));
+        }
+        SW_LOCK_CHECK_RETURN(rwlock->lock_wait((int) (timeout * 1000)));
+    }
+#endif
     Mutex *mutex = dynamic_cast<Mutex *>(lock);
     if (mutex == nullptr) {
         zend_throw_exception(swoole_exception_ce, "wrong lock type", -3);

include/swoole_lock.h

@@ -88,6 +88,8 @@ class RWLock final : public Lock {
     int unlock() override;
     int trylock_rd() override;
     int trylock() override;
+    int lock_wait(int timeout_msec);
+    int lock_rd_wait(int timeout_msec);
 };
 #endif
 

src/lock/rw_lock.cc

@@ -52,6 +52,20 @@ int RWLock::lock_rd() {
     return pthread_rwlock_rdlock(&impl->_lock);
 }
 
+int RWLock::lock_rd_wait(int timeout_msec) {
+    timespec timeo;
+    realtime_get(&timeo);
+    realtime_add(&timeo, timeout_msec);
+    return pthread_rwlock_timedrdlock(&impl->_lock, &timeo);
+}
+
+int RWLock::lock_wait(int timeout_msec) {
+    timespec timeo;
+    realtime_get(&timeo);
+    realtime_add(&timeo, timeout_msec);
+    return pthread_rwlock_timedwrlock(&impl->_lock, &timeo);
+}
+
 int RWLock::lock() {
     return pthread_rwlock_wrlock(&impl->_lock);
 }