xchan.rb 0.21.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8936112cb188471884a6fa66ee0db2b61d5229ac75acb8953c78e5b76587bc8
-  data.tar.gz: e76eb21f0f7f2a11e465ee3d4834b3abd48b54269949ee3623e2b2c2bdc1a17c
+  metadata.gz: 4bf62c9fb6b3813e464c25bcd2e99f860a7a106ff85ea3e8e564f8a0d16e160b
+  data.tar.gz: 1e1868a087396c56e176c9fff11d4086e4b30d6d5cc09968c48261212317e8dc
 SHA512:
-  metadata.gz: d6ff8db4154e29a41a41b3878a93355ab3ce8092112f76f7fa4a61042a9747138f9a270217decf0e39cc5a9890f7ce5f34ebaa8a93e74aeb68d1cf5b0d470a09
-  data.tar.gz: bbe432d09de33e607b7940005a1d29ee0c1de6c14d3a2a56105c5fa26e32ea81a6327a87a6e520163f34836ffe820296674bf29a46c72cc45c603872500f090f
+  metadata.gz: '0095b2e81e0f76c47fb8f3fc402945956b9865b16e119e85f2d1aa3e9ab1ff90e7ed63214871298bea7da759a7a7f9b8c38a57c87c0bf5d541d3ae6491be1956'
+  data.tar.gz: 5b21ab069f5be98a2f14fa596492654a73b90efb5e25a670cbb3aa81f034927ef77e954d589dab1504f627010933f335ba84f84e0749fe236c802b040d29a6eb

data/lib/xchan/lockf.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "fiddle/import"
+require "tempfile"
+
+##
+# @private
+# {Chan::Lockf Chan::Lockf} provides an object-oriented
+# [lockf(3)](https://man.freebsd.org/cgi/man.cgi?query=lockf&sektion=3)
+# interface backed by Fiddle from the standard library.
+# It supersedes the runtime dependency on the lockf.rb gem.
+class Chan::Lockf
+  module LibC
+    extend Fiddle::Importer
+    dlload Fiddle.dlopen(nil)
+    extern "int lockf(int fd, int cmd, int size)"
+  end
+  private_constant :LibC
+
+  F_ULOCK = 0x0
+  F_LOCK  = 0x1
+  F_TLOCK = 0x2
+  F_TEST  = 0x3
+
+  ##
+  # @return [<#fileno>]
+  #  Returns a file handle
+  attr_reader :file
+
+  ##
+  # @param [<#fileno>] file
+  # @param [Integer] size
+  # @return [Chan::Lockf]
+  #  Returns an instance of {Chan::Lockf Chan::Lockf}
+  def initialize(file, size = 0)
+    @file = file
+    @size = size
+  end
+
+  ##
+  # Acquire lock (blocking)
+  # @raise [SystemCallError]
+  #  Might raise a subclass of SystemCallError
+  # @return [Boolean]
+  #  Returns true when successful
+  def lock = try(F_LOCK)
+
+  ##
+  # Acquire lock (non-blocking)
+  # @raise [SystemCallError]
+  #  Might raise a subclass of SystemCallError
+  # @return [Boolean]
+  #  Returns true when successful
+  def lock_nonblock = try(F_TLOCK)
+
+  ##
+  # Release lock
+  # @raise [SystemCallError]
+  #  Might raise a subclass of SystemCallError
+  # @return [Boolean]
+  #  Returns true when successful
+  def release = try(F_ULOCK)
+
+  ##
+  # @return [Boolean]
+  #  Returns true when lock can be acquired
+  def lockable?
+    try(F_TEST)
+    true
+  rescue Errno::EACCES, Errno::EAGAIN, Errno::EWOULDBLOCK
+    false
+  end
+
+  ##
+  # Closes {Chan::Lockf#file Chan::Lockf#file}
+  # @return [void]
+  def close
+    @file.respond_to?(:close) ? @file.close : nil
+  end
+
+  private
+
+  def try(function, attempts: 3)
+    fileno = @file.respond_to?(:fileno) ? @file.fileno : @file
+    LibC.lockf(fileno, function, @size).zero? ||
+      raise(SystemCallError.new("lockf", Fiddle.last_error))
+  rescue Errno::EINTR => ex
+    attempts -= 1
+    (attempts.zero? ? raise(ex) : retry)
+  end
+end

data/lib/xchan/unix_socket.rb

@@ -4,7 +4,6 @@
 # An easy-to-use InterProcess Communication (IPC) library
 class Chan::UNIXSocket
   require "socket"
-  require "lockf"
   require_relative "bytes"
 
   ##
@@ -46,6 +45,8 @@ class Chan::UNIXSocket
     @counter = Chan::Counter.new(tmpdir)
     @lock = Chan.locks[lock]&.call(tmpdir) || lock
     @mutex = Mutex.new
+    @partial = nil
+    @partial_len = 0
   end
 
   ##
@@ -107,10 +108,12 @@ class Chan::UNIXSocket
     @mutex.synchronize do
       @lock.lock_nonblock
       raise IOError, "channel closed" if closed?
-      len = @w.write_nonblock(serialize(object))
-      @bytes.push(len)
-      @counter.increment!(bytes_written: len)
-      len.tap { @lock.release }
+      data = serialize(object)
+      head = [data.bytesize].pack("Q>")
+      n = @w.write_nonblock(head << data)
+      @bytes.push(data.bytesize)
+      @counter.increment!(bytes_written: data.bytesize)
+      data.bytesize.tap { @lock.release }
     rescue IOError, IO::WaitWritable, Errno::ENOBUFS => ex
       @lock.release
       raise Chan::WaitWritable, ex.message
@@ -157,15 +160,35 @@ class Chan::UNIXSocket
     @mutex.synchronize do
       @lock.lock_nonblock
       raise IOError, "closed channel" if closed?
-      len = @bytes.shift
-      obj = deserialize(@r.read_nonblock(len.zero? ? 1 : len))
-      @counter.increment!(bytes_read: len)
+      stream = @r.local_address.socktype == Socket::SOCK_STREAM
+      unless @partial
+        if stream
+          head = String.new
+          while head.bytesize < 8
+            head << @r.read_nonblock(8 - head.bytesize)
+          end
+          @partial_len = head.unpack1("Q>")
+          @partial = String.new(capacity: @partial_len)
+        else
+          buf = @r.read_nonblock(65536)
+          @partial_len = buf[0, 8].unpack1("Q>")
+          @partial = buf[8, @partial_len]
+        end
+        @bytes.shift
+      end
+      if stream
+        while @partial.bytesize < @partial_len
+          @partial << @r.read_nonblock(@partial_len - @partial.bytesize)
+        end
+      end
+      obj = deserialize(@partial)
+      @counter.increment!(bytes_read: @partial.bytesize)
+      @partial = nil
       obj.tap { @lock.release }
     rescue IOError => ex
       @lock.release
       raise(ex)
     rescue IO::WaitReadable => ex
-      @bytes.unshift(len)
       @lock.release
       raise Chan::WaitReadable, ex.message
     rescue Errno::EAGAIN => ex
@@ -198,6 +221,13 @@ class Chan::UNIXSocket
     lock { size.zero? }
   end
 
+  ##
+  # @return [Integer]
+  #  Returns the number of elements waiting to be read
+  def size
+    @bytes.size
+  end
+
   ##
   # @group Stat methods
 
@@ -218,14 +248,16 @@ class Chan::UNIXSocket
   alias_method :bytes_read, :bytes_received
 
   ##
-  # @return [Integer]
-  #  Returns the number of objects waiting to be read
-  def size
-    lock { @bytes.size }
-  end
+  # @endgroup
 
   ##
-  # @endgroup
+  # @return [void]
+  def flush
+    @lock.lock
+    to_a
+  ensure
+    @lock.release
+  end
 
   ##
   # @group Wait methods

data/lib/xchan/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chan
-  VERSION = "0.21.0"
+  VERSION = "0.23.0"
 end

data/lib/xchan.rb

@@ -5,6 +5,7 @@ module Chan
   require_relative "xchan/unix_socket"
   require_relative "xchan/null_lock"
   require_relative "xchan/tempfile"
+  require_relative "xchan/lockf"
 
   WaitReadable = Class.new(IO::EAGAINWaitReadable)
   WaitWritable = Class.new(IO::EAGAINWaitWritable)
@@ -65,7 +66,7 @@ module Chan
   def self.locks
     {
       null: lambda { |_tmpdir| Chan::NullLock },
-      file: lambda { |tmpdir| Lockf.new Chan.temporary_file(%w[xchan lock], tmpdir:) }
+      file: lambda { |tmpdir| Chan::Lockf.new Chan.temporary_file(%w[xchan lock], tmpdir:) }
     }
   end
 end

data/xchan.rb.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.summary = "An easy to use InterProcess Communication (IPC) library"
   gem.description = gem.summary
-  gem.add_runtime_dependency "lockf.rb", "~> 3.0"
+
+  gem.add_runtime_dependency "fiddle", "~> 1.1"
   gem.add_development_dependency "test-unit", "~> 3.5.7"
   gem.add_development_dependency "yard", "~> 0.9"
   gem.add_development_dependency "kramdown", "~> 2.5"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xchan.rb
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.23.0
 platform: ruby
 authors:
 - '0x1eef'
@@ -10,19 +10,19 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: lockf.rb
+  name: fiddle
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,7 @@ files:
 - lib/xchan.rb
 - lib/xchan/bytes.rb
 - lib/xchan/counter.rb
+- lib/xchan/lockf.rb
 - lib/xchan/null_lock.rb
 - lib/xchan/tempfile.rb
 - lib/xchan/unix_socket.rb
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.16
 specification_version: 4
 summary: An easy to use InterProcess Communication (IPC) library
 test_files: []