miner_mover 0.1.1.1 → 0.1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e2daa3ba8e778e20c25e3a6363683b3163e1141f9438b53be890845acf5440e
-  data.tar.gz: b72dc662be9c50caa281e087b3708c72a53aa5e593eeb053b59a0679238d568b
+  metadata.gz: 4901bb324083ef4c73adb1ed174794d0c90821fe9eae11f7a9935690dab821e3
+  data.tar.gz: ad001e368e39ab5e11bc2750d37e6aee4ba6dc42be2e08d0f346f57065c12a88
 SHA512:
-  metadata.gz: 3203db4674a641c4a53ebed0cea4aaa445ef9e120ad582bc1cfcc787541ee53a8677eff1e4936429c4eaa72ef686ef97941a7a929d2d5db4e88a678684005962
-  data.tar.gz: e0052a82fa40bcf19b3382ead683087e52f90e6065751a65ff9475aadd141beb0ebe098673acffe48784f90c672aa5990fe2c0e117a3db4bd1782252af7cec91
+  metadata.gz: 22db270f2c03cbbcace66a2724ed8c98315b14caa3d0d135e02e04d98b9baaaa49c9b2bc3aaa7f64b35fd6d5416611e29d344582dbc3cc5820ce351ea0a6b22c
+  data.tar.gz: 7ef93f90a90e33c34e3a5412495a828fb9030ccb160389b764448bf5e7e9dfe022687b1db9ba6e64e7418af541a681033d437b21ff50ebba320b18fa4a9c6095

data/README.md

@@ -42,51 +42,57 @@ configured via `:work_type`
 
 # Usage
 
+You'll want to use **Ruby 3.1+** (CRuby) to make the most of Ractors, Fibers,
+and Fiber::Scheduler.
+
+This gem can be used on JRuby and TruffleRuby, but several concurrency options
+are not available: process forking, Ractors, and Fiber::Scheduler.
+However, their threading performance exceeds CRuby's as they don't have a
+Global VM Lock (GVL).
+
 ## Install
 
-You'll want to use **Ruby 3.x** (CRuby) to make the most of Fibers.
+Right now, a gem installation only provides the Miner Mover library.
+Use the **Development** process below to access all of the demonstration
+scripts showing the different concurrency strategies.
 
-### Dependencies
+`gem install miner_mover`
 
-* rake
-* minitest
-* dotcfg
-* fiber_scheduler
+For Ruby 3.1+ on linux,  you'll also want:
 
-`gem install rake minitest dotcfg fiber_scheduler`
+`gem install fiber_scheduler io-event`
 
-### Clone
+## Development
 
 ```
 git clone https://github.com/rickhull/miner_mover
 cd miner_mover
+bundle config set --local with development
+bundle install
 ```
 
-### Try rake
+### Rake Tasks
 
 Try: `rake -T` to see available [Rake tasks](Rakefile)
 
 ```
 $ rake -T
 
-rake alt_demo         # run all demos minus fiber_scheduler / ractor / process
-rake config           # run demo/config
-rake default          # rake test
-rake demo             # run all demos
-rake fiber            # run demo/fiber
-rake fiber_scheduler  # run demo/fiber_scheduler
-rake process_pipe     # run demo/process_pipe
-rake process_socket   # run demo/process_socket
-rake ractor           # run demo/ractor
-rake serial           # run demo/serial
+rake config           # Run demo/config.rb
+rake demo             # Run all demos
+rake fiber            # Run demo/fiber.rb
+rake fiber_scheduler  # Run demo/fiber_scheduler.rb
+rake jvm_demo         # Run JVM compatible demos
+rake process_pipe     # Run demo/process_pipe.rb
+rake process_socket   # Run demo/process_socket.rb
+rake ractor           # Run demo/ractor.rb
+rake serial           # Run demo/serial.rb
 rake test             # Run tests
-rake thread           # run demo/thread
+rake thread           # Run demo/thread.rb
 ```
 
 Try: `rake test`
 
-## Rake Tasks
-
 Included demonstration scripts can be executed via Rake tasks.
 The following order is recommended:
 
@@ -101,7 +107,7 @@ The following order is recommended:
 Try each task; there will be about 6 seconds worth of many lines of output
 logging.  These rake tasks correspond to the scripts within [`demo/`](demo/).
 
-## Satisfy `LOAD_PATH`
+### Satisfy `LOAD_PATH`
 
 Rake tasks take care of `LOAD_PATH`, so the following is
 **only necessary when *not* using rake tasks**:
@@ -111,41 +117,81 @@ Rake tasks take care of `LOAD_PATH`, so the following is
   `require 'miner_mover'` will work.
 * This project does not use `require_relative`
 
-## Exploration in `irb`
+### Exploration in `irb`
 
 `$ irb -I lib`
 
 ```
-irb(main):001:0> include MinerMover
+irb(main):001:0> require 'miner_mover/worker'
+=> true
+
+irb(main):002:0> include MinerMover
 => Object
 
-irb(main):002:0> miner = Miner.new
+irb(main):003:0> miner = Miner.new
 =>
-#<MinerMover::Miner:0x00007fdd649754e8
+#<MinerMover::Miner:0x00007fbee8a3a080
 ...
 
-irb(main):003:0> miner.mine_ore
-=> 0
-
-irb(main):004:0> miner.mine_ore 5
-=> 3
-
-irb(main):005:0> miner.mine_ore 20
-=> 6483
-
-irb(main):006:0> mover = Mover.new
+irb(main):004:0> mover = Mover.new
 =>
-#<MinerMover::Mover:0x00007fdd64979930
+#<MinerMover::Mover:0x00007fbee8a8a6c0
 ...
 
-irb(main):007:0> mover.load_ore 6483
-=> 6483
-
-irb(main):008:0> mover.status
-=> "Batch 6483 / 10M 0% | Moved 0x (0M)"
+irb(main):005:0> miner.state
+=>
+{:id=>"00050720",
+ :logging=>false,
+ :debugging=>false,
+ :timer=>10200,
+ :variance=>0,
+ :depth=>5,
+ :partial_reward=>false}
+
+irb(main):006:0> mover.state
+=>
+{:id=>"00057860",
+ :logging=>false,
+ :debugging=>false,
+ :timer=>10456,
+ :variance=>0,
+ :work_type=>:cpu,
+ :batch_size=>10000000,
+ :batch=>0,
+ :batches=>0,
+ :ore_moved=>0}
+
+irb(main):007:0> miner.mine_ore
+=> 7
+
+irb(main):008:0> mover.load_ore 7
+=> 7
+
+irb(main):009:0> miner.state
+=>
+{:id=>"00050720",
+ :logging=>false,
+ :debugging=>false,
+ :timer=>28831,
+ :variance=>0,
+ :depth=>5,
+ :partial_reward=>false}
+
+irb(main):010:0> mover.state
+=>
+{:id=>"00057860",
+ :logging=>false,
+ :debugging=>false,
+ :timer=>27959,
+ :variance=>0,
+ :work_type=>:cpu,
+ :batch_size=>10000000,
+ :batch=>7,
+ :batches=>0,
+ :ore_moved=>0}
 ```
 
-## Included scripts
+### Included scripts
 
 These scripts implement a full miner mover simulation using different
 multitasking paradigms in Ruby.
@@ -165,6 +211,46 @@ multiple miners or movers.
 
 Execute via e.g. `ruby -Ilib demo/thread.rb`
 
+### Concurrency Strategies
+
+#### [Serial](demo/serial.rb)
+
+One miner, one mover.  The miner mines to a depth, then loads the ore.
+When the mover has a full batch, the batch is moved while the miner waits.
+
+#### [Fibers](demo/fiber.rb)
+
+Without a Fiber Scheduler, this just changes some organizational things.
+Again, one miner, one mover.  The mover has its own fiber, and the mining
+fiber can pass ore to the moving fiber.  There is no concurrency, so the
+performance is roughly the same as before.
+
+#### [Fiber Scheduler](demo/fiber_scheduler.rb)
+
+TBD
+
+#### [Threads](demo/thread.rb)
+
+An array of mining threads and an array of moving threads.
+A single shared queue for loading ore from miners to movers.
+All threads contend for the same execution lock (GVL).
+
+#### [Ractors](demo/ractor.rb)
+
+Moving threads execute in their own ractor.
+Mining threads contend against mining threads.  Moving threads, likewise.
+
+#### [Processes with pipes](demo/process_pipe.rb)
+
+Similar to ractors, but using `Process.fork` for movers, using a pipe to send
+ore from the parent mining process.
+
+#### [Processes with sockets](demo/process_socket.rb)
+
+As above, but with Unix sockets (*not* network sockets), using any of
+`SOCK_STREAM` `SOCK_DGRAM` `SOCK_SEQPACKET` socket types.
+In all cases, ore amounts are 4 bytes so the types behave roughly equivalently.
+
 # Multitasking
 
 *Multitasking* here means "the most general sense of performing several tasks

data/Rakefile

@@ -1,27 +1,43 @@
-require 'rake/testtask'
+#
+# test task
+#
 
+require 'rake/testtask'
 Rake::TestTask.new :test do |t|
   t.pattern = "test/*.rb"
   t.warning = true
 end
-
-desc "rake test"
 task default: :test
 
+#
+# demo tasks
+#
+
+if ENV['RUBYOPT'].nil? or ENV['RUBYOPT'].empty?
+  flags = ['-I', File.join(__dir__, 'lib')]
+else
+  flags = nil # subprocesses will have RUBYOPT
+end
+
+# create a rake task to run each script in demo/
 Dir['demo/*.rb'].each { |demo_path|
   name = File.basename(demo_path, '.rb')
-  desc "run demo/#{name}"
-  task(name) { sh "ruby -Ilib #{demo_path}" }
+  desc "Run #{demo_path}"
+  task(name) { ruby *flags, demo_path }
 }
 
 # jruby / truffleruby lack fiber_scheduler, Ractor, and Process#fork
-desc "run all demos minus fiber_scheduler / ractor / process"
+desc "Run JVM compatible demos"
 task jvm_demo: [:serial, :fiber, :thread]
 
-desc "run all demos"
+desc "Run all demos"
 task demo: [:serial, :fiber, :fiber_scheduler,
             :thread, :ractor, :process_pipe, :process_socket]
 
+#
+# release tasks
+#
+
 begin
   require 'buildar'
 

data/VERSION

@@ -1 +1 @@
-0.1.1.1
+0.1.2.3

data/demo/process_socket.rb

@@ -15,7 +15,7 @@ Signal.trap("INT") {
   stop_mining = true
 }
 
-socktype = [:DGRAM, :STREAM, :RAW].sample
+socktype = [:DGRAM, :STREAM, :SEQPACKET].sample
 run.log "SOCK #{socktype}"
 csock, psock = UNIXSocket.pair(socktype)
 

data/lib/miner_mover.rb

@@ -3,20 +3,22 @@ module MinerMover
 
   # $/ is the default line separator: "\n"
   def self.puts(str, io = $stdout, separator = LINE_SEP)
-    self.write_nonblock(io, str + separator)
+    self.write(io, str + separator)
   end
 
-  def self.write_nonblock(io, str)
+  def self.write(io, str)
+    # nonblocking write attempt; ensure the full string is written
     begin
-      # nonblocking write attempt; ensure the full string is written
-      size = str.bytesize
       num_bytes = io.write_nonblock(str)
-      # blocking write if nonblocking write comes up short
-      io.write str.byteslice(num_bytes, size - num_bytes) if num_bytes < size
     rescue IO::WaitWritable, Errno::EINTR
       IO.select([], [io]) # wait until writable
       retry
     end
+    # blocking write if nonblocking write comes up short
+    if num_bytes < str.bytesize
+      io.write str.byteslice(num_bytes, str.bytesize - num_bytes)
+    end
+    nil
   end
 
   def self.log_fmt(timer, id, msg)

data/miner_mover.gemspec

@@ -5,29 +5,23 @@ Gem::Specification.new do |s|
   s.description = <<EOF
 Fundamentally, we have a set of miners and a set of movers. A miner takes some amount of time to mine ore, which is given to a mover. When a mover has enough ore for a full batch, the delivery takes some amount of time before more ore can be loaded.
 EOF
-    s.authors = ["Rick Hull"]
+  s.authors = ["Rick Hull"]
   s.homepage = "https://github.com/rickhull/miner_mover"
   s.license = "LGPL-3.0"
 
-  s.required_ruby_version = "~> 2"
+  s.required_ruby_version = "> 2"
 
   s.version = File.read(File.join(__dir__, 'VERSION')).chomp
 
-  s.files = %w[miner_mover.gemspec VERSION README.md Rakefile]
-  s.files += Dir['lib/**/*.rb']
-  s.files += Dir['test/**/*.rb']
-  s.files += Dir['demo/**/*.rb']
+  s.files = Dir[
+    'miner_mover.gemspec',
+    'VERSION',
+    'README.md',
+    'Rakefile',
+    'lib/**/*.rb',
+    'test/**/*.rb',
+    'demo/**/*.rb',
+  ]
 
-  s.add_dependency "dotcfg", "~> 1.0"
-
-  s.requirements << "For all features and best performance:"
-  s.requirements << "gem install rake minitest fiber_scheduler"
-  s.requirements << "For dev tools:"
-  s.requirements << "gem install buildar flog flay"
-
-  s.add_development_dependency "rake", "~> 13.0" # CVE-2020-8130
-  s.add_development_dependency "minitest", "~> 5.0"
-  s.add_development_dependency "buildar", "~> 3.0"
-  s.add_development_dependency "flog", "~> 0"
-  s.add_development_dependency "flay", "~> 0"
+  s.add_runtime_dependency "dotcfg", "~> 1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: miner_mover
 version: !ruby/object:Gem::Version
-  version: 0.1.1.1
+  version: 0.1.2.3
 platform: ruby
 authors:
 - Rick Hull
@@ -24,76 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: buildar
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: flog
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: flay
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 'Fundamentally, we have a set of miners and a set of movers. A miner
   takes some amount of time to mine ore, which is given to a mover. When a mover has
   enough ore for a full batch, the delivery takes some amount of time before more
@@ -133,7 +63,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">"
     - !ruby/object:Gem::Version
       version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -141,12 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements:
-- 'For all features and best performance:'
-- gem install rake minitest fiber_scheduler
-- 'For dev tools:'
-- gem install buildar flog flay
-rubygems_version: 3.3.20
+requirements: []
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: This project provides a basic concurrency problem useful for exploring different