LockRegistry.php 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Cache;
  11. use Psr\Log\LoggerInterface;
  12. use Symfony\Contracts\Cache\CacheInterface;
  13. use Symfony\Contracts\Cache\ItemInterface;
  14. /**
  15. * LockRegistry is used internally by existing adapters to protect against cache stampede.
  16. *
  17. * It does so by wrapping the computation of items in a pool of locks.
  18. * Foreach each apps, there can be at most 20 concurrent processes that
  19. * compute items at the same time and only one per cache-key.
  20. *
  21. * @author Nicolas Grekas <p@tchwork.com>
  22. */
  23. final class LockRegistry
  24. {
  25. private static $openedFiles = [];
  26. private static $lockedFiles = [];
  27. /**
  28. * The number of items in this list controls the max number of concurrent processes.
  29. */
  30. private static $files = [
  31. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'AbstractAdapter.php',
  32. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'AbstractTagAwareAdapter.php',
  33. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'AdapterInterface.php',
  34. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'ApcuAdapter.php',
  35. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'ArrayAdapter.php',
  36. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'ChainAdapter.php',
  37. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'DoctrineAdapter.php',
  38. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'FilesystemAdapter.php',
  39. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'FilesystemTagAwareAdapter.php',
  40. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'MemcachedAdapter.php',
  41. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'NullAdapter.php',
  42. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'PdoAdapter.php',
  43. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'PhpArrayAdapter.php',
  44. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'PhpFilesAdapter.php',
  45. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'ProxyAdapter.php',
  46. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'Psr16Adapter.php',
  47. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'RedisAdapter.php',
  48. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'RedisTagAwareAdapter.php',
  49. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'SimpleCacheAdapter.php',
  50. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'TagAwareAdapter.php',
  51. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'TagAwareAdapterInterface.php',
  52. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'TraceableAdapter.php',
  53. __DIR__.\DIRECTORY_SEPARATOR.'Adapter'.\DIRECTORY_SEPARATOR.'TraceableTagAwareAdapter.php',
  54. ];
  55. /**
  56. * Defines a set of existing files that will be used as keys to acquire locks.
  57. *
  58. * @return array The previously defined set of files
  59. */
  60. public static function setFiles(array $files): array
  61. {
  62. $previousFiles = self::$files;
  63. self::$files = $files;
  64. foreach (self::$openedFiles as $file) {
  65. if ($file) {
  66. flock($file, LOCK_UN);
  67. fclose($file);
  68. }
  69. }
  70. self::$openedFiles = self::$lockedFiles = [];
  71. return $previousFiles;
  72. }
  73. public static function compute(callable $callback, ItemInterface $item, bool &$save, CacheInterface $pool, \Closure $setMetadata = null, LoggerInterface $logger = null)
  74. {
  75. $key = self::$files ? crc32($item->getKey()) % \count(self::$files) : -1;
  76. if ($key < 0 || (self::$lockedFiles[$key] ?? false) || !$lock = self::open($key)) {
  77. return $callback($item, $save);
  78. }
  79. while (true) {
  80. try {
  81. // race to get the lock in non-blocking mode
  82. $locked = flock($lock, LOCK_EX | LOCK_NB, $wouldBlock);
  83. if ($locked || !$wouldBlock) {
  84. $logger && $logger->info(sprintf('Lock %s, now computing item "{key}"', $locked ? 'acquired' : 'not supported'), ['key' => $item->getKey()]);
  85. self::$lockedFiles[$key] = true;
  86. $value = $callback($item, $save);
  87. if ($save) {
  88. if ($setMetadata) {
  89. $setMetadata($item);
  90. }
  91. $pool->save($item->set($value));
  92. $save = false;
  93. }
  94. return $value;
  95. }
  96. // if we failed the race, retry locking in blocking mode to wait for the winner
  97. $logger && $logger->info('Item "{key}" is locked, waiting for it to be released', ['key' => $item->getKey()]);
  98. flock($lock, LOCK_SH);
  99. } finally {
  100. flock($lock, LOCK_UN);
  101. unset(self::$lockedFiles[$key]);
  102. }
  103. static $signalingException, $signalingCallback;
  104. $signalingException = $signalingException ?? unserialize("O:9:\"Exception\":1:{s:16:\"\0Exception\0trace\";a:0:{}}");
  105. $signalingCallback = $signalingCallback ?? function () use ($signalingException) { throw $signalingException; };
  106. try {
  107. $value = $pool->get($item->getKey(), $signalingCallback, 0);
  108. $logger && $logger->info('Item "{key}" retrieved after lock was released', ['key' => $item->getKey()]);
  109. $save = false;
  110. return $value;
  111. } catch (\Exception $e) {
  112. if ($signalingException !== $e) {
  113. throw $e;
  114. }
  115. $logger && $logger->info('Item "{key}" not found while lock was released, now retrying', ['key' => $item->getKey()]);
  116. }
  117. }
  118. return null;
  119. }
  120. private static function open(int $key)
  121. {
  122. if (null !== $h = self::$openedFiles[$key] ?? null) {
  123. return $h;
  124. }
  125. set_error_handler(function () {});
  126. try {
  127. $h = fopen(self::$files[$key], 'r+');
  128. } finally {
  129. restore_error_handler();
  130. }
  131. return self::$openedFiles[$key] = $h ?: @fopen(self::$files[$key], 'r');
  132. }
  133. }