diff --git a/mongodb_lock/mongodb_lock.inc b/mongodb_lock/mongodb_lock.inc new file mode 100644 index 0000000..36c5a4b --- /dev/null +++ b/mongodb_lock/mongodb_lock.inc @@ -0,0 +1,280 @@ + $name, 'value' => _lock_id()); + $result = $collection->update($where, array('$set' => array('expire' => $expire)), array('safe' => 1)); + if (!isset($result['updatedExisting']) || $result['updatedExisting'] != 1) { + // The lock was broken. + unset($locks[$name]); + } + } + else { + // Optimistically try to acquire the lock, then retry once if it fails. + // The first time through the loop cannot be a retry. + $retry = FALSE; + $new_lock = array( + 'name' => $name, + 'value' => _lock_id(), + 'expire' => $expire + ); + // We always want to do this code at least once. + do { + try { + $collection->insert($new_lock, array('safe' => 1)); + // We track all acquired locks in the global variable. + $locks[$name] = TRUE; + // We never need to try again. + $retry = FALSE; + } + catch (MongoCursorException $e) { + // Suppress the error. If this is our first pass through the loop, + // then $retry is FALSE. In this case, the insert must have failed + // meaning some other request acquired the lock but did not release it. + // We decide whether to retry by checking lock_may_be_available() + // Since this will break the lock in case it is expired. + $retry = $retry ? FALSE : lock_may_be_available($name); + } + // We only retry in case the first attempt failed, but we then broke + // an expired lock. + } while ($retry); + } + return isset($locks[$name]); +} + +/** + * Check if lock acquired by a different process may be available. + * + * If an existing lock has expired, it is removed. + * + * @param $name + * The name of the lock. + * @return + * TRUE if there is no lock or it was removed, FALSE otherwise. + */ +function lock_may_be_available($name) { + $collection = mongodb_collection(variable_get('mongodb_semaphore', 'semaphore')); + $lock = $collection->findOne(array('name' => $name)); + if (!$lock) { + return TRUE; + } + $expire = (float) $lock['expire']; + list($usec, $sec) = explode(' ', microtime()); + $now = (float)$usec + (float)$sec; + if ($now > $lock['expire']) { + // We check two conditions to prevent a race condition where another + // request acquired the lock and set a new expire time. We add a small + // number to $expire to avoid errors with float to string conversion. + $conditions = array( + 'name' => $name, + 'value' => $lock['value'], + 'expire' => array('$lte' => 0.0001 + $expire) + ); + $result = $collection->remove($conditions, array('justOne' => 1, 'safe' => 1)); + if (isset($result['ok']) && $result['ok'] == 1) { + return TRUE; + } + } + return FALSE; +} + +/** + * Wait for a lock to be available. + * + * This function may be called in a request that fails to acquire a desired + * lock. This will block further execution until the lock is available or the + * specified delay in seconds is reached. This should not be used with locks + * that are acquired very frequently, since the lock is likely to be acquired + * again by a different request during the sleep(). + * + * @param $name + * The name of the lock. + * @param $delay + * The maximum number of seconds to wait, as an integer. + * @return + * TRUE if the lock holds, FALSE if it is available. + */ +function lock_wait($name, $delay = 30) { + static $sleep_start, $sleep_step, $sleep_max; + + // Delays in microseconds. + // Don't need to initialize these more than once per request. + if (!isset($sleep_start)) { + $sleep_start = variable_get('mongodb_lock_sleep_start', 25000); + $sleep_step = variable_get('mongodb_lock_sleep_step', 25000); + $sleep_max = variable_get('mongodb_lock_sleep_max', 500000); + } + + // Pause the process for short periods between calling + // lock_may_be_available(). This prevents hitting the database with constant + // database queries while waiting, which could lead to performance issues. + // However, if the wait period is too long, there is the potential for a + // large number of processes to be blocked waiting for a lock, especially + // if the item being rebuilt is commonly requested. To address both of these + // concerns, begin waiting for $sleep_start, then add $sleep_step to + // the wait period each time until it reaches $sleep_max. After this point + // polling will continue every $sleep_max until $delay is reached. + + // $delay is passed in seconds, but we will be using usleep(), which takes + // microseconds as a parameter. Multiply it by 1 million so that all + // further numbers are equivalent. + $delay = (int) $delay * 1000000; + + // Begin sleeping at 25ms by default. + $sleep = $sleep_start; + while ($delay > 0) { + // This function should only be called by a request that failed to get a + // lock, so we sleep first to give the parallel request a chance to finish + // and release the lock. + usleep($sleep); + // After each sleep, increase the value of $sleep until it reaches + // 500ms (by default), to reduce the potential for a lock stampede. + $delay = $delay - $sleep; + $sleep = min($sleep_max, $sleep + $sleep_step, $delay); + if (lock_may_be_available($name)) { + // No longer need to wait. + return FALSE; + } + } + // The caller must still wait longer to get the lock. + return TRUE; +} + + +/** + * Release a lock previously acquired by lock_acquire(). + * + * This will release the named lock if it is still held by the current request. + * + * @param $name + * The name of the lock. + */ +function lock_release($name) { + global $locks; + + unset($locks[$name]); + + mongodb_collection(variable_get('mongodb_semaphore', 'semaphore')) + ->remove(array('name' => $name, 'value' => _lock_id()), array('justOne' => 1, 'safe' => 1)); +} + +/** + * Release all previously acquired locks. + */ +function lock_release_all($lock_id = NULL) { + global $locks; + + $locks = array(); + if (empty($lock_id)) { + $lock_id = _lock_id(); + } + + mongodb_collection(variable_get('mongodb_semaphore', 'semaphore')) + ->remove(array('value' => _lock_id()), array('safe' => 1)); +} + +/** + * @} End of "defgroup locks". + */ diff --git a/mongodb_lock/mongodb_lock.info b/mongodb_lock/mongodb_lock.info new file mode 100644 index 0000000..2223131 --- /dev/null +++ b/mongodb_lock/mongodb_lock.info @@ -0,0 +1,5 @@ +name = MongoDB Lock +description = Locking framework implementation for MongoDB. +package = MongoDB +core = 6.x +dependencies[] = mongodb diff --git a/mongodb_lock/mongodb_lock.module b/mongodb_lock/mongodb_lock.module new file mode 100644 index 0000000..b3d9bbc --- /dev/null +++ b/mongodb_lock/mongodb_lock.module @@ -0,0 +1 @@ +