redis_queued_locks 1.17.0 → 1.18.0

data/lib/redis_queued_locks/acquirer/acquire_lock/try_to_lock/log_visitor.rb

@@ -14,11 +14,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def start(
       logger,
       log_sampled,
@@ -27,7 +28,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -37,7 +39,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -49,11 +52,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def rconn_fetched(
       logger,
       log_sampled,
@@ -62,7 +66,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -72,7 +77,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -84,11 +90,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def same_process_conflict_detected(
       logger,
       log_sampled,
@@ -97,7 +104,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -107,7 +115,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -119,12 +128,13 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param sp_conflict_status [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def same_process_conflict_analyzed(
       logger,
       log_sampled,
@@ -134,6 +144,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       sp_conflict_status
     )
       return unless log_sampled && log_lock_try
@@ -145,6 +156,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "spc_status => '#{sp_conflict_status}'"
       end rescue nil
     end
@@ -157,6 +169,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param sp_conflict_status [Symbol]
     # @param ttl [Integer]
     # @param spc_processed_timestamp [Float]
@@ -164,7 +177,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def reentrant_lock__extend_and_work_through(
       logger,
       log_sampled,
@@ -174,6 +187,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       sp_conflict_status,
       ttl,
       spc_processed_timestamp
@@ -187,6 +201,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "spc_status => '#{sp_conflict_status}' " \
         "last_ext_ttl => #{ttl} " \
         "last_ext_ts => '#{spc_processed_timestamp}'"
@@ -201,13 +216,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param sp_conflict_status [Symbol]
     # @param spc_processed_timestamp [Float]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def reentrant_lock__work_through(
       logger,
       log_sampled,
@@ -217,6 +233,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       sp_conflict_status,
       spc_processed_timestamp
     )
@@ -229,6 +246,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "spc_status => '#{sp_conflict_status}' " \
         "last_spc_ts => '#{spc_processed_timestamp}'"
       end rescue nil
@@ -242,13 +260,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param sp_conflict_status [Symbol]
     # @param spc_processed_timestamp [Float]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def single_process_lock_conflict__dead_lock(
       logger,
       log_sampled,
@@ -258,6 +277,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       sp_conflict_status,
       spc_processed_timestamp
     )
@@ -270,6 +290,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "spc_status => '#{sp_conflict_status}' " \
         "last_spc_ts => '#{spc_processed_timestamp}'"
       end rescue nil
@@ -283,11 +304,55 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
+    # @param sp_conflict_status [Symbol]
+    # @param spc_processed_timestamp [Float]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.18.0
+    def single_process_lock_conflict__lock_upgrade(
+      logger,
+      log_sampled,
+      log_lock_try,
+      lock_key,
+      queue_ttl,
+      acquirer_id,
+      host_id,
+      access_strategy,
+      rw_mode,
+      sp_conflict_status,
+      spc_processed_timestamp
+    )
+      return unless log_sampled && log_lock_try
+
+      logger.debug do
+        "[redis_queued_locks.try_lock.single_process_lock_conflict__lock_upgrade] " \
+        "lock_key => '#{lock_key}' " \
+        "queue_ttl => #{queue_ttl} " \
+        "acq_id => '#{acquirer_id}' " \
+        "hst_id => '#{host_id}' " \
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
+        "spc_status => '#{sp_conflict_status}' " \
+        "last_spc_ts => '#{spc_processed_timestamp}'"
+      end rescue nil
+    end
+
+    # @param logger [::Logger,#debug]
+    # @param log_sampled [Boolean]
+    # @param log_lock_try [Boolean]
+    # @param lock_key [String]
+    # @param queue_ttl [Integer]
+    # @param acquirer_id [String]
+    # @param host_id [String]
+    # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def acq_added_to_queue(
       logger,
       log_sampled,
@@ -296,7 +361,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -306,7 +372,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -318,11 +385,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def remove_expired_acqs(
       logger,
       log_sampled,
@@ -331,7 +399,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -341,7 +410,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -353,12 +423,13 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param waiting_acquirer [String,NilClass]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def get_first_from_queue(
       logger,
       log_sampled,
@@ -368,6 +439,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       waiting_acquirer
     )
       return unless log_sampled && log_lock_try
@@ -379,6 +451,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "first_acq_id_in_queue => '#{waiting_acquirer}'"
       end rescue nil
     end
@@ -391,11 +464,12 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def exit__queue_ttl_reached(
       logger,
       log_sampled,
@@ -404,7 +478,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -414,7 +489,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
 
@@ -426,13 +502,14 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param waiting_acquirer [String,NilClass]
     # @param current_lock_data [Hash<String,Any>]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def exit__no_first(
       logger,
       log_sampled,
@@ -442,6 +519,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       waiting_acquirer,
       current_lock_data
     )
@@ -454,6 +532,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "first_acq_id_in_queue => '#{waiting_acquirer}' " \
         "<current_lock_data> => <<#{current_lock_data}>>"
       end rescue nil
@@ -467,6 +546,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @param waiting_acquirer [String,NilClass]
     # @param locked_by_acquirer [String]
     # @param current_lock_data [Hash<String,Any>]
@@ -474,7 +554,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def exit__lock_still_obtained(
       logger,
       log_sampled,
@@ -484,6 +564,7 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       acquirer_id,
       host_id,
       access_strategy,
+      rw_mode,
       waiting_acquirer,
       locked_by_acquirer,
       current_lock_data
@@ -497,12 +578,57 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
         "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
         "first_acq_id_in_queue => '#{waiting_acquirer}' " \
         "locked_by_acq_id => '#{locked_by_acquirer}' " \
         "<current_lock_data> => <<#{current_lock_data}>>"
       end rescue nil
     end
 
+    # Read lock request is blocked by an earlier write lock request (FIFO between modes).
+    #
+    # @param logger [::Logger,#debug]
+    # @param log_sampled [Boolean]
+    # @param log_lock_try [Boolean]
+    # @param lock_key [String]
+    # @param queue_ttl [Integer]
+    # @param acquirer_id [String]
+    # @param host_id [String]
+    # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
+    # @param ahead_acquirer [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.18.0
+    def exit__write_request_ahead(
+      logger,
+      log_sampled,
+      log_lock_try,
+      lock_key,
+      queue_ttl,
+      acquirer_id,
+      host_id,
+      access_strategy,
+      rw_mode,
+      ahead_acquirer
+    )
+      return unless log_sampled && log_lock_try
+
+      logger.debug do
+        "[redis_queued_locks.try_lock.exit__write_request_ahead] " \
+        "lock_key => '#{lock_key}' " \
+        "queue_ttl => #{queue_ttl} " \
+        "acq_id => '#{acquirer_id}' " \
+        "hst_id => '#{host_id}' " \
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
+        "ahead_acq_id => '#{ahead_acquirer}'"
+      end rescue nil
+    end
+
+    # Write lock request is blocked by an earlier read lock request (FIFO between modes).
+    #
     # @param logger [::Logger,#debug]
     # @param log_sampled [Boolean]
     # @param log_lock_try [Boolean]
@@ -511,11 +637,95 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
     # @param acquirer_id [String]
     # @param host_id [String]
     # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
+    # @param ahead_acquirer [String]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.18.0
+    def exit__read_request_ahead(
+      logger,
+      log_sampled,
+      log_lock_try,
+      lock_key,
+      queue_ttl,
+      acquirer_id,
+      host_id,
+      access_strategy,
+      rw_mode,
+      ahead_acquirer
+    )
+      return unless log_sampled && log_lock_try
+
+      logger.debug do
+        "[redis_queued_locks.try_lock.exit__read_request_ahead] " \
+        "lock_key => '#{lock_key}' " \
+        "queue_ttl => #{queue_ttl} " \
+        "acq_id => '#{acquirer_id}' " \
+        "hst_id => '#{host_id}' " \
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
+        "ahead_acq_id => '#{ahead_acquirer}'"
+      end rescue nil
+    end
+
+    # The lock is still held by readers: write lock requests wait for all readers,
+    # read lock requests wait for their own (same acquirer) read lock (see `:wait_for_lock`).
+    #
+    # @param logger [::Logger,#debug]
+    # @param log_sampled [Boolean]
+    # @param log_lock_try [Boolean]
+    # @param lock_key [String]
+    # @param queue_ttl [Integer]
+    # @param acquirer_id [String]
+    # @param host_id [String]
+    # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
+    # @param waiting_acquirer [String,NilClass]
+    # @return [void]
+    #
+    # @api private
+    # @since 1.18.0
+    def exit__read_lock_still_obtained(
+      logger,
+      log_sampled,
+      log_lock_try,
+      lock_key,
+      queue_ttl,
+      acquirer_id,
+      host_id,
+      access_strategy,
+      rw_mode,
+      waiting_acquirer
+    )
+      return unless log_sampled && log_lock_try
+
+      logger.debug do
+        "[redis_queued_locks.try_lock.exit__read_lock_still_obtained] " \
+        "lock_key => '#{lock_key}' " \
+        "queue_ttl => #{queue_ttl} " \
+        "acq_id => '#{acquirer_id}' " \
+        "hst_id => '#{host_id}' " \
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}' " \
+        "first_acq_id_in_queue => '#{waiting_acquirer}'"
+      end rescue nil
+    end
+
+    # @param logger [::Logger,#debug]
+    # @param log_sampled [Boolean]
+    # @param log_lock_try [Boolean]
+    # @param lock_key [String]
+    # @param queue_ttl [Integer]
+    # @param acquirer_id [String]
+    # @param host_id [String]
+    # @param access_strategy [Symbol]
+    # @param rw_mode [Symbol]
     # @return [void]
     #
     # @api private
     # @since 1.7.0
-    # @version 1.9.0
+    # @version 1.18.0
     def obtain__free_to_acquire(
       logger,
       log_sampled,
@@ -524,7 +734,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
       queue_ttl,
       acquirer_id,
       host_id,
-      access_strategy
+      access_strategy,
+      rw_mode
     )
       return unless log_sampled && log_lock_try
 
@@ -534,7 +745,8 @@ module RedisQueuedLocks::Acquirer::AcquireLock::TryToLock::LogVisitor
         "queue_ttl => #{queue_ttl} " \
         "acq_id => '#{acquirer_id}' " \
         "hst_id => '#{host_id}' " \
-        "acs_strat => '#{access_strategy}'"
+        "acs_strat => '#{access_strategy}' " \
+        "rw_mode => '#{rw_mode}'"
       end rescue nil
     end
   end