async-utilization 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 522f4b5822343c23f14422555147e2159e2bac50afbd230a06e985e2cfe1cee4
-  data.tar.gz: caa61db8daf6f65a77e319a210ee0079f9a647deed614e7cc5333507967964fa
+  metadata.gz: 64e873daf011f6226b574b609cecde9b402edb2a2ff5144f68526195575492ea
+  data.tar.gz: b5e25e805f9e8b359af97653bc1496706c9ac81d8c8c2ea42c1bbd1680be271b
 SHA512:
-  metadata.gz: ebaabb2e0959e3664e4e2a18812d71efa75d967a2fb01a89f8d63af02eb9e36bc564edfc50c7315b4efbbe8ee5f60e865250cb660daa274fa185e6a538994f6c
-  data.tar.gz: 7760f55b1383998120a3f7bf0b65b578c8da04bf648c0407f6b3e57040edec2b1487b82356f6d11eaf3bdb02cab9ddc8797eb3c8ee67c930a03d35fec08a5e60
+  metadata.gz: e486c1307fead9186ae112f2c258ec4e5ed25b7c6cb8d49d56974634ed2e250400ccb8a57caccb736871df8cd592e5be5379bfd9ac738cf9ace363812e651a90
+  data.tar.gz: 4c0380449a03ea7b1ba5c42cc0b70e86cbe76fb360e0bdccaf7f3b5477dccd26d0171921e91f2e535433a236c60c8abb8a97f3dcaf1c6e34b17d7e8c87a72a17

data/lib/async/utilization/segment_store.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require "console"
+
+module Async
+	module Utilization
+		# Represents a shared memory segment store for utilization data.
+		#
+		# Stores fixed-size segments in a shared memory file, associates each
+		# segment with a utilization schema, and reads the resulting values.
+		class SegmentStore
+			# Open a shared memory segment store.
+			#
+			# @parameter path [String] The path to the shared memory file.
+			# @parameter size [Integer] The initial size of the shared memory file.
+			# @parameter segment_size [Integer] The size of each allocation segment.
+			# @parameter growth_factor [Integer | Float] The factor used to grow the file when all segments are allocated.
+			# @parameter replace [Boolean] Whether to replace an existing file at the given path.
+			# @yields {|store| ...} The store, which is closed after the block completes.
+			# 	@parameter store [SegmentStore] The opened store.
+			# @returns [SegmentStore | Object] The store, or the value returned by the block.
+			# @raises [ArgumentError] If the store configuration is invalid.
+			# @raises [Errno::EEXIST] If the path already exists and `replace` is `false`.
+			def self.open(path, size: IO::Buffer::PAGE_SIZE * 8, segment_size: 512, growth_factor: 2, replace: false)
+				raise ArgumentError, "Size must be a positive integer!" unless size.is_a?(Integer) && size > 0
+				raise ArgumentError, "Segment size must be a positive integer!" unless segment_size.is_a?(Integer) && segment_size > 0
+				raise ArgumentError, "Segment size must not exceed size!" if segment_size > size
+				raise ArgumentError, "Growth factor must be greater than 1!" unless growth_factor.is_a?(Numeric) && growth_factor.real? && growth_factor > 1
+				
+				if replace
+					begin
+						File.unlink(path)
+					rescue Errno::ENOENT
+						# The file does not need to be replaced:
+					end
+				end
+				
+				file = File.open(path, "w+bx")
+				buffer = nil
+				
+				begin
+					file.truncate(size)
+					buffer = IO::Buffer.map(file, size)
+					store = new(file, buffer, size: size, segment_size: segment_size, growth_factor: growth_factor)
+				rescue
+					buffer&.free
+					file.close
+					raise
+				end
+				
+				return store unless block_given?
+				
+				begin
+					yield store
+				ensure
+					store.close
+				end
+			end
+			
+			# Initialize the shared memory segment store.
+			#
+			# @parameter file [File] The open shared memory file.
+			# @parameter buffer [IO::Buffer] The mapped shared memory buffer.
+			# @parameter size [Integer] The initial size of the shared memory file.
+			# @parameter segment_size [Integer] The size of each allocation segment.
+			# @parameter growth_factor [Integer | Float] The factor used to grow the file when all segments are allocated.
+			def initialize(file, buffer, size:, segment_size:, growth_factor:)
+				@file = file
+				@buffer = buffer
+				@size = size
+				@segment_size = segment_size
+				@growth_factor = growth_factor
+				
+				@allocations = {}
+				@free_list = []
+				
+				(0...(@size / @segment_size)).each do |segment_index|
+					@free_list << (segment_index * @segment_size)
+				end
+			end
+			
+			# Allocate a segment for the given key.
+			#
+			# The shared memory file is automatically resized if no segments are available.
+			#
+			# @parameter key [Object] The key used to identify the allocation.
+			# @parameter schema [Array] The `[key, type, offset]` tuples describing the data layout.
+			# @returns [Integer | Nil] The offset into the shared memory file, or `nil` if allocation fails.
+			def allocate(key, schema)
+				if @free_list.empty?
+					unless resize(@size * @growth_factor)
+						return nil
+					end
+				end
+				
+				offset = @free_list.shift
+				@allocations[key] = {offset: offset, schema: schema}
+				
+				return offset
+			end
+			
+			# Free the segment allocated to the given key.
+			#
+			# @parameter key [Object] The key used to identify the allocation.
+			def free(key)
+				if allocation = @allocations.delete(key)
+					@free_list << allocation[:offset]
+				end
+			end
+			
+			# Get the allocation information for the given key.
+			#
+			# @parameter key [Object] The key used to identify the allocation.
+			# @returns [Hash | Nil] The allocation offset and schema, or `nil` if the key is not allocated.
+			def allocation(key)
+				@allocations[key]
+			end
+			
+			# @attribute [Integer] The current size of the shared memory file.
+			attr :size
+			
+			# Update the schema for an existing allocation.
+			#
+			# @parameter key [Object] The key used to identify the allocation.
+			# @parameter schema [Array] The `[key, type, offset]` tuples describing the data layout.
+			def update_schema(key, schema)
+				if allocation = @allocations[key]
+					allocation[:schema] = schema
+				end
+			end
+			
+			# Read utilization data from an allocated segment.
+			#
+			# @parameter key [Object] The key used to identify the allocation.
+			# @returns [Hash | Nil] The utilization values, or `nil` if the key is not allocated.
+			def read(key)
+				allocation = @allocations[key]
+				return nil unless allocation
+				
+				offset = allocation[:offset]
+				schema = allocation[:schema]
+				
+				result = {}
+				schema.each do |field_key, type, field_offset|
+					absolute_offset = offset + field_offset
+					
+					begin
+						result[field_key] = @buffer.get_value(type, absolute_offset)
+					rescue => error
+						Console.warn(self, "Failed to read value", type: type, key: field_key, offset: absolute_offset, exception: error)
+					end
+				end
+				
+				return result
+			end
+			
+			# Resize the shared memory file.
+			#
+			# The new size is rounded up to the nearest page boundary.
+			#
+			# @parameter new_size [Integer] The requested new size of the shared memory file.
+			# @returns [Boolean] Whether the file was resized successfully.
+			def resize(new_size)
+				old_size = @size
+				return false if new_size <= old_size
+				
+				page_size = IO::Buffer::PAGE_SIZE
+				new_size = (((new_size + page_size - 1) / page_size) * page_size).to_i
+				
+				begin
+					@file.truncate(new_size)
+					buffer = IO::Buffer.map(@file, new_size)
+					
+					@buffer&.free
+					@buffer = buffer
+					
+					old_segment_count = old_size / @segment_size
+					new_segment_count = new_size / @segment_size
+					
+					(old_segment_count...new_segment_count).each do |segment_index|
+						@free_list << (segment_index * @segment_size)
+					end
+					
+					@size = new_size
+					
+					Console.info(self, "Resized shared memory", old_size: old_size, new_size: new_size, segments_added: new_segment_count - old_segment_count)
+					
+					return true
+				rescue => error
+					Console.error(self, "Failed to resize shared memory", old_size: old_size, new_size: new_size, exception: error)
+					return false
+				end
+			end
+			
+			# Close the shared memory file.
+			def close
+				@buffer&.free
+				@buffer = nil
+				
+				@file&.close
+				@file = nil
+			end
+		end
+	end
+end

data/lib/async/utilization/version.rb

@@ -7,6 +7,6 @@
 module Async
 	# @namespace
 	module Utilization
-		VERSION = "0.4.0"
+		VERSION = "0.5.0"
 	end
 end

data/lib/async/utilization.rb

@@ -9,6 +9,7 @@ require_relative "utilization/namespace"
 require_relative "utilization/registry"
 require_relative "utilization/observer"
 require_relative "utilization/metric"
+require_relative "utilization/segment_store"
 
 # @namespace
 module Async

data/readme.md

@@ -14,6 +14,10 @@ Please see the [project documentation](https://socketry.github.io/async-utilizat
 
 Please see the [project releases](https://socketry.github.io/async-utilization/releases/index) for all releases.
 
+### v0.5.0
+
+  - Add `Async::Utilization::SegmentStore` for allocating and reading utilization data in shared memory.
+
 ### v0.4.0
 
   - Add `Async::Utilization::Namespace` for composing registry metric names.
@@ -39,26 +43,26 @@ Please see the [project releases](https://socketry.github.io/async-utilization/r
 
 We welcome contributions to this project.
 
-1.  Fork it.
+1.  Fork the repository.
 2.  Create your feature branch (`git checkout -b my-new-feature`).
-3.  Commit your changes (`git commit -am 'Add some feature'`).
+3.  Commit your changes (`git commit -am 'Add some feature.'`).
 4.  Push to the branch (`git push origin my-new-feature`).
-5.  Create new Pull Request.
+5.  Create a new pull request.
 
 ### Running Tests
 
 To run the test suite:
 
-``` shell
-bundle exec sus
+``` bash
+$ bundle exec sus
 ```
 
 ### Making Releases
 
 To make a new release:
 
-``` shell
-bundle exec bake gem:release:patch # or minor or major
+``` bash
+$ bundle exec bake gem:release:patch # or minor or major
 ```
 
 ### Developer Certificate of Origin

data/releases.md

@@ -1,5 +1,9 @@
 # Releases
 
+## v0.5.0
+
+  - Add `Async::Utilization::SegmentStore` for allocating and reading utilization data in shared memory.
+
 ## v0.4.0
 
   - Add `Async::Utilization::Namespace` for composing registry metric names.

data/test/async/utilization/segment_store.rb

@@ -0,0 +1,175 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2026, by Samuel Williams.
+
+require "sus"
+require "sus/fixtures/console/null_logger"
+require "sus/fixtures/temporary_directory_context"
+require "async/utilization"
+
+describe Async::Utilization::SegmentStore do
+	include Sus::Fixtures::Console::NullLogger
+	include Sus::Fixtures::TemporaryDirectoryContext
+	
+	let(:path) {File.join(root, "utilization.shm")}
+	let(:page_size) {IO::Buffer::PAGE_SIZE}
+	let(:schema) do
+		Async::Utilization::Schema.build(
+			requests_total: :u64,
+			requests_active: :u32,
+		)
+	end
+	
+	it "allocates, reads, and reuses segments" do
+		store = subject.open(path, size: page_size, segment_size: page_size)
+		
+		first_offset = store.allocate(:first, [])
+		expect(first_offset).to be == 0
+		expect(store.allocation(:first)).to have_keys(offset: be == 0, schema: be == [])
+		
+		store.update_schema(:first, schema.to_a)
+		observer = Async::Utilization::Observer.open(schema, path, page_size, first_offset)
+		observer.buffer.set_value(:u64, 0, 12)
+		observer.buffer.set_value(:u32, 8, 3)
+		
+		expect(store.read(:first)).to be == {requests_total: 12, requests_active: 3}
+		
+		store.free(:first)
+		expect(store.read(:first)).to be_nil
+		expect(store.allocate(:second, schema.to_a)).to be == first_offset
+	ensure
+		observer&.buffer&.free
+		store&.close
+	end
+	
+	it "preserves existing observer mappings when resizing" do
+		store = subject.open(path, size: page_size, segment_size: page_size)
+		first_offset = store.allocate(:first, schema.to_a)
+		observer = Async::Utilization::Observer.open(schema, path, page_size, first_offset)
+		
+		observer.buffer.set_value(:u64, 0, 42)
+		expect(store.read(:first)[:requests_total]).to be == 42
+		
+		second_offset = store.allocate(:second, schema.to_a)
+		expect(second_offset).to be == page_size
+		expect(store.size).to be == page_size * 2
+		
+		observer.buffer.set_value(:u64, 0, 99)
+		expect(store.read(:first)[:requests_total]).to be == 99
+	ensure
+		observer&.buffer&.free
+		store&.close
+	end
+	
+	it "returns nil when automatic resizing fails" do
+		store = subject.open(path, size: page_size, segment_size: page_size)
+		store.allocate(:first, schema.to_a)
+		
+		expect(store).to receive(:resize).and_return(false)
+		expect(store.allocate(:second, schema.to_a)).to be_nil
+	ensure
+		store&.close
+	end
+	
+	it "skips fields that cannot be read" do
+		store = subject.open(path, size: page_size, segment_size: page_size)
+		store.allocate(:worker, [[:invalid, :invalid, 0]])
+		
+		expect(store.read(:worker)).to be == {}
+	ensure
+		store&.close
+	end
+	
+	it "reports resize failures" do
+		store = subject.open(path, size: page_size, segment_size: page_size)
+		file = store.instance_variable_get(:@file)
+		
+		expect(file).to receive(:truncate).and_raise(IOError, "Failed to resize")
+		expect(store.resize(page_size * 2)).to be_falsey
+	ensure
+		store&.close
+	end
+	
+	it "only replaces an existing file when requested" do
+		original = subject.open(path, size: page_size, segment_size: page_size)
+		original.resize(page_size * 2)
+		
+		existing_file = File.open(path, "rb")
+		original_size = existing_file.size
+		original.close
+		
+		expect do
+			subject.open(path, size: page_size, segment_size: page_size)
+		end.to raise_exception(Errno::EEXIST)
+		
+		replacement = subject.open(path, size: page_size, segment_size: page_size, replace: true)
+		expect(replacement.size).to be == page_size
+		expect(existing_file.size).to be == original_size
+	ensure
+		original&.close
+		replacement&.close
+		existing_file&.close
+	end
+	
+	it "validates configuration before replacing an existing file" do
+		File.write(path, "existing")
+		
+		[
+			[{size: 0}, "Size must be a positive integer!"],
+			[{segment_size: 0}, "Segment size must be a positive integer!"],
+			[{size: page_size, segment_size: page_size * 2}, "Segment size must not exceed size!"],
+			[{growth_factor: 1}, "Growth factor must be greater than 1!"],
+		].each do |options, message|
+			expect do
+				subject.open(path, replace: true, **options)
+			end.to raise_exception(ArgumentError, message: be == message)
+			
+			expect(File.read(path)).to be == "existing"
+		end
+	end
+	
+	it "closes the store after yielding it" do
+		file = nil
+		
+		result = subject.open(path, size: page_size, segment_size: page_size) do |store|
+			file = store.instance_variable_get(:@file)
+			expect(file.closed?).to be_falsey
+			:result
+		end
+		
+		expect(result).to be == :result
+		expect(file.closed?).to be_truthy
+	end
+	
+	it "closes the file when mapping fails" do
+		file = File.open(path, "w+bx")
+		File.unlink(path)
+		
+		expect(File).to receive(:open).with(path, "w+bx").and_return(file)
+		expect(IO::Buffer).to receive(:map).with(file, page_size).and_raise(IOError, "Failed to map")
+		
+		expect do
+			subject.open(path, size: page_size, segment_size: page_size)
+		end.to raise_exception(IOError, message: be == "Failed to map")
+		
+		expect(file.closed?).to be_truthy
+	end
+	
+	it "releases acquired resources when initialization fails" do
+		file = File.open(path, "w+bx")
+		File.unlink(path)
+		buffer = IO::Buffer.new(page_size)
+		
+		expect(File).to receive(:open).with(path, "w+bx").and_return(file)
+		expect(IO::Buffer).to receive(:map).with(file, page_size).and_return(buffer)
+		expect(subject).to receive(:new).and_raise(IOError, "Failed to initialize")
+		
+		expect do
+			subject.open(path, size: page_size, segment_size: page_size)
+		end.to raise_exception(IOError, message: be == "Failed to initialize")
+		
+		expect(file.closed?).to be_truthy
+		expect(buffer.null?).to be_truthy
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-utilization
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -62,6 +62,7 @@ files:
 - lib/async/utilization/observer.rb
 - lib/async/utilization/registry.rb
 - lib/async/utilization/schema.rb
+- lib/async/utilization/segment_store.rb
 - lib/async/utilization/version.rb
 - license.md
 - readme.md
@@ -72,10 +73,13 @@ files:
 - test/async/utilization/observer.rb
 - test/async/utilization/registry.rb
 - test/async/utilization/schema.rb
+- test/async/utilization/segment_store.rb
 homepage: https://github.com/socketry/async-utilization
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/socketry/async-utilization/issues
+  changelog_uri: https://github.com/socketry/async-utilization/blob/main/releases.md
   documentation_uri: https://socketry.github.io/async-utilization/
   source_code_uri: https://github.com/socketry/async-utilization.git
 rdoc_options: []
@@ -92,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: High-performance utilization metrics for Async services using shared memory.
 test_files: []