szymanskis_mutex 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6538dbfac64f4bdd4bd53fbb5e2807036ed382958326a2df443bf8b37b97aaf8
-  data.tar.gz: af0cad1545a97ebccfc7534bad9cc527e73901c51d4805772136b79e79c2c59e
+  metadata.gz: 63735b01825b9d298bd271d2dc8a6cab38729d52f7b49aae9e8c28d8dacc591a
+  data.tar.gz: 3f43c6e9a4106b65558f4afa1b86107a7ca90ba11d470f3484d617d94b0efff8
 SHA512:
-  metadata.gz: 4bc341584bb0cdbe2bb73136dba30cace5d3562e0cd1640b60503e0673b157d33611f8684e217c69c59ad3bfa486d07223a004eb80ecdfea403c2723a6fd2054
-  data.tar.gz: 5b045819425278d099efd33df24fbb5eaf631f98380878ca3b3eb64906528a7a43020c2bfe8d7fffa12b95c1ec4945f2b63707136b164f0c042ec6f5442d5831
+  metadata.gz: 34ffa81607a1336bc618a101a5846bd1f31bc0da7e1e22455096333272ae954473b2526ac12d0438476f6f04459c7c0eb0856dacb05672688e75545671ebd56f
+  data.tar.gz: 41403cc4967677f84d63769db892181175a19337128f27bf5bb860fc627c88cddfa59d2607394d8c27a411331963fba78066b620b0733c2a82af8a1aa8224b99

data/lib/szymanskis_mutex.rb

@@ -24,77 +24,93 @@
 # OTHER DEALINGS IN THE SOFTWARE.
 
 # Based on the Szymanski's Mutual Exclusion Algorithm
-module SzymanskisMutex
-  # Larger seconds mean less cycles/second but may result in lower completion
-  SZYMANSKIS_SLEEP = 0.05
-
-  @@flags = {}
-  @@counter = {}
-
-  def mutual_exclusion(concern)
-    @@counter[concern] ||= 0
-    @@flags[concern] ||= {}
-
-    # Suppose @@counter += 1 is an atomic function
-    my_id = @@counter[concern] += 1
-
-    entry_protocol(concern, my_id)
-    begin
-      yield
-    ensure
-      exit_protocol(concern, my_id)
+class SzymanskisMutex
+  # Metaclass to make code more readable.
+  # The only available method to SzymanskisMutex is #mutual_exclusion
+  class << self
+    # Larger seconds mean less cycles/second but may result in lower completion
+    SZYMANSKIS_SLEEP = 0.05
+
+    @@flags = {}
+    @@counter = {}
+
+    # Provide a MutEx lock
+    # Provide the critical section as a block to this method
+    # Different concerns will prevent unrelated code to wait on each other
+    # Returns the result of the critical code or nil if something fails
+    def mutual_exclusion(concern)
+      @@counter[concern] ||= 0
+      @@flags[concern] ||= {}
+
+      # Suppose @@counter += 1 is an atomic function
+      my_id = @@counter[concern] += 1
+
+      entry_protocol(concern, my_id)
+      begin
+        result = yield
+      ensure
+        # If something fails in the critical section release the resource
+        exit_protocol(concern, my_id)
+        result
+      end
     end
-  end
 
-  # 1: Standing outside waiting room
-  # 2: Waiting for other processes to enter
-  # 3: Standing in doorway
-  # 4: Closed entrance door
-  def entry_protocol(concern, id)
-    # Standing outside waiting room
-    @@flags[concern][id] = 1
+    private
 
-    # Wait for open door
-    sleep(SZYMANSKIS_SLEEP) while @@flags[concern].values.any? { |f| f > 2 }
+    # 1: Standing outside waiting room
+    # 2: Waiting for other processes to enter
+    # 3: Standing in doorway
+    # 4: Closed entrance door
+    # id is the number of the process entering this section relative to concern
+    def entry_protocol(concern, id)
+      # Standing outside waiting room
+      @@flags[concern][id] = 1
 
-    # Stand in doorway
-    @@flags[concern][id] = 3
+      # Wait for open door
+      sleep(SZYMANSKIS_SLEEP) while @@flags[concern].values.any? { |f| f > 2 }
 
-    # Is another process waiting to enter?
-    if @@flags[concern].values.any? { |f| f == 1 }
+      # Stand in doorway
+      @@flags[concern][id] = 3
 
-      # Wait for other processes to enter
-      @@flags[concern][id] = 2
+      # Is another process waiting to enter?
+      if @@flags[concern].values.any? { |f| f == 1 }
 
-      # Wait for a process to enter and close the door
-      sleep(SZYMANSKIS_SLEEP) while @@flags[concern].values.all? { |f| f != 4 }
-    end
+        # Wait for other processes to enter
+        @@flags[concern][id] = 2
 
-    # Close the entrance door
-    @@flags[concern][id] = 4
+        # Wait for a process to enter and close the door
+        sleep(SZYMANSKIS_SLEEP) while @@flags[concern].values.all? { |f| f != 4 }
+      end
 
-    # Wait for lower ids to finish exit protocol
-    while @@flags[concern].select { |i| i < id }.values.any? { |f| f != 1 }
-      sleep(SZYMANSKIS_SLEEP)
-    end
-  end
+      # Close the entrance door
+      @@flags[concern][id] = 4
 
-  def exit_protocol(concern, id)
-    # Ensure everyone in the waiting room has realized that the door
-    # is supposed to be closed
-    while @@flags[concern].select { |i| i > id }.any? { |f| [2, 3].include?(f) }
-      sleep(SZYMANSKIS_SLEEP)
+      # Wait for lower ids to finish exit protocol
+      while @@flags[concern].select { |i| i < id }.values.any? { |f| f != 1 }
+        sleep(SZYMANSKIS_SLEEP)
+      end
     end
 
-    # Leave. This will reopen door if nobody is still in the waiting room
-    @@flags[concern].delete(id)
-
-    return unless @@flags[concern].empty?
-
-    # Prevent counter from increasing indefinitely
-    @@counter.delete concern
-    @@flags.delete concern
+    # Exit the process and if it is the last one in that batch then
+    # reopens the door for the next batch
+    # id is the number of the process exiting this section relative to concern
+    def exit_protocol(concern, id)
+      # Ensure everyone in the waiting room has realized that the door
+      # is supposed to be closed
+      while @@flags[concern].select { |i| i > id }.any? { |f| [2, 3].include?(f) }
+        sleep(SZYMANSKIS_SLEEP)
+      end
+
+      # Leave. This will reopen door if nobody is still in the waiting room
+      @@flags[concern].delete(id)
+
+      # If there are processes still running this concern there is
+      # nothing else to do
+      return unless @@flags[concern].empty?
+
+      # Prevent counter from increasing indefinitely
+      @@counter.delete concern
+      @@flags.delete concern
+    end
   end
-
-  protected :entry_protocol, :exit_protocol
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: szymanskis_mutex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Emmanuel Byrd
@@ -16,20 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.0
 description: Algorithm devised by Boleslaw Szymanski. This MutEx has linear wait and
   only 5 communication variables
 email: emmanuel_pajaro@hotmail.com