szymanskis_mutex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6538dbfac64f4bdd4bd53fbb5e2807036ed382958326a2df443bf8b37b97aaf8
+  data.tar.gz: af0cad1545a97ebccfc7534bad9cc527e73901c51d4805772136b79e79c2c59e
+SHA512:
+  metadata.gz: 4bc341584bb0cdbe2bb73136dba30cace5d3562e0cd1640b60503e0673b157d33611f8684e217c69c59ad3bfa486d07223a004eb80ecdfea403c2723a6fd2054
+  data.tar.gz: 5b045819425278d099efd33df24fbb5eaf631f98380878ca3b3eb64906528a7a43020c2bfe8d7fffa12b95c1ec4945f2b63707136b164f0c042ec6f5442d5831

data/lib/szymanskis_mutex.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, Emmanuel Byrd
+
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# 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)
+    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
+
+    # Wait for open door
+    sleep(SZYMANSKIS_SLEEP) while @@flags[concern].values.any? { |f| f > 2 }
+
+    # Stand in doorway
+    @@flags[concern][id] = 3
+
+    # Is another process waiting to enter?
+    if @@flags[concern].values.any? { |f| f == 1 }
+
+      # Wait for other processes to enter
+      @@flags[concern][id] = 2
+
+      # Wait for a process to enter and close the door
+      sleep(SZYMANSKIS_SLEEP) while @@flags[concern].values.all? { |f| f != 4 }
+    end
+
+    # Close the entrance door
+    @@flags[concern][id] = 4
+
+    # 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
+
+  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)
+
+    return unless @@flags[concern].empty?
+
+    # Prevent counter from increasing indefinitely
+    @@counter.delete concern
+    @@flags.delete concern
+  end
+
+  protected :entry_protocol, :exit_protocol
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: szymanskis_mutex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emmanuel Byrd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: Algorithm devised by Boleslaw Szymanski. This MutEx has linear wait and
+  only 5 communication variables
+email: emmanuel_pajaro@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/szymanskis_mutex.rb
+homepage: https://github.com/EByrdS/szymanskis_mutex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Szymanski's Mutual Exclusion Algorithm.
+test_files: []