sys-memory 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c4673911e1763e8282380312020206b04a9fb268572d3b64e8fc0a631befa03
-  data.tar.gz: 28e0b52dd179b98a4896dab5442bac98beb538fea493d0db5ea113b6148ed70d
+  metadata.gz: 25b5f9d04be24191f9eb133c8cd851a39b8c46df7464d0dc9256dfbaf0d88f6d
+  data.tar.gz: 065dfcc2df8519394092d64cb4f354dd9c33e12cb9d982e1df861ea564c6410f
 SHA512:
-  metadata.gz: f6b1f2cf5a71c94be2dc997fb7e4c3d91a2d32c83af4b7399cba169c8ef36d20382decb1d35e020d7c7b7f7651957d1a1deb105e748db66087f071aae20879a8
-  data.tar.gz: 0c4f87e99e7b69148c0abcbfed29217a2fac229eff5237a3f632bfd2994dc89d6b432c63169a9e5bef1ab1f432f81330617bddef72f6a3092770fbcaaac49eb6
+  metadata.gz: aa249753e3a61d6d77a74fb3bfef92cbaeb440e78e0f6c37f11c708756713e5381fc1f6572a9ab2eb8d2392f00f67d63b04d53bfe662f1f987a19cc8674d1991
+  data.tar.gz: 46c66b080426c803617ba62579d570fda47b5a12d7e2f35270963e3e1709a12411044924498e1f435396c215c997401671e38bbe455fe5eef9837a73c569f905

data/CHANGES.md

@@ -1,3 +1,16 @@
+## 0.3.0 - 3-Jun-2026
+* Added an .available method. Thanks go to Splendide-Imaginarius for the
+  original inspiration.
+* Fixed the MacOS version. Recent versions of MacOS added more vm_stat
+  struct members so that code was updated accordingly.
+* Minor gemspec tweak.
+
+## 0.2.1 - 2-Jun-2026
+* Fixed swap for FreeBSD.
+* Rubocop fixes.
+* Some spec updates.
+* Minor Rakefile updates.
+
 ## 0.2.0 - 12-Jun-2024
 * Added support for DragonflyBSD. Currently the default implementation
   for all BSD platforms.

data/README.md

@@ -9,7 +9,7 @@ A Ruby interface for getting memory information.
 * OSX
 * BSD
 
-Note that only DragonflyBSD has been tested. I am not sure about other flavors yet.
+Note that only FreeBSD and DragonflyBSD have been tested. I am not sure about other flavors yet.
 
 ## Installation
 `gem install sys-memory`
@@ -27,7 +27,7 @@ p Sys::Memory.total                 # Total memory, no swap
 p Sys::Memory.total(extended: true) # Total memory, include swap
 ```
 
-There's also the `free`, `used` and `load` module methods.
+There's also the `free`, `available`, `used` and `load` module methods.
 
 ## Notes
 I realize there are some philosophical differences about what constitutes
@@ -35,6 +35,11 @@ I realize there are some philosophical differences about what constitutes
 it that I saw debated online. In short, you can choose to include swap memory
 as part of memory calculations or not as you see fit via an optional argument.
 
+The `free` method reports memory the operating system currently classifies as
+free. The `available` method reports memory that can be used by new work without
+serious memory pressure. On platforms that expose caches or inactive pages
+separately, `available` may be higher than `free`.
+
 You can also just use `Sys::Memory.memory` and collate the various hash data
 pieces as you see fit.
 
@@ -47,7 +52,7 @@ https://github.com/djberg96/sys-memory
 Apache-2.0
 
 ## Copyright
-(C) 2021-2024 Daniel J. Berger, All Rights Reserved
+(C) 2021-2026 Daniel J. Berger, All Rights Reserved
 
 ## Warranty
 This package is provided "as is" and without any express or

data/Rakefile

@@ -5,7 +5,10 @@ require 'rubocop/rake_task'
 
 CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.rspec_opts = '-f documentation -w'
+end
 
 namespace 'gem' do
   desc "Create the sys-memory gem"
@@ -25,4 +28,9 @@ end
 
 RuboCop::RakeTask.new
 
+# Clean up afterwards
+Rake::Task[:spec].enhance do
+  Rake::Task[:clean].invoke
+end
+
 task :default => :spec

data/lib/sys/bsd/memory.rb

@@ -7,10 +7,34 @@ module Sys
   # The Memory module is a house for memory related singleton methods that don't require state.
   module Memory
     extend FFI::Library
+
     ffi_lib FFI::Library::LIBC
 
     attach_function :sysctlbyname, %i[string pointer pointer pointer size_t], :int
 
+    if RbConfig::CONFIG['host_os'] =~ /freebsd/i
+      ffi_lib FFI::Library::LIBC, FFI.map_library_name('kvm')
+
+      attach_function :kvm_openfiles, %i[string string string int pointer], :pointer
+      attach_function :kvm_geterr, [:pointer], :string
+      attach_function :kvm_getswapinfo, %i[pointer pointer int int], :int
+      attach_function :kvm_close, [:pointer], :int
+
+      # Private class wrapper for struct kvm_swap
+      class KvmSwap < FFI::Struct
+        layout(
+          :ksw_devname, [:char, 32],
+          :ksw_used, :uint,
+          :ksw_total, :uint,
+          :ksw_flags, :int,
+          :ksw_reserved1, :uint,
+          :ksw_reserved2, :uint
+        )
+      end
+
+      private_constant :KvmSwap
+    end
+
     # Obtain detailed memory information about your host in the form of a hash.
     # Note that the exact nature of this hash is largely dependent on your
     # operating system.
@@ -26,8 +50,19 @@ module Sys
       hash[:free] = get_by_name('vm.stats.vm.v_free_count') * page_size
       hash[:inactive] = get_by_name('vm.stats.vm.v_inactive_count') * page_size
       hash[:wire] = get_by_name('vm.stats.vm.v_wire_count') * page_size
-      hash[:swap_size] = get_by_name('vm.swap_size')
-      hash[:swap_free] = get_by_name('vm.swap_free')
+
+      if RbConfig::CONFIG['host_os'] =~ /dragonfly/i
+        hash[:swap_size] = get_by_name('vm.swap_size')
+        hash[:swap_free] = get_by_name('vm.swap_free')
+      elsif RbConfig::CONFIG['host_os'] =~ /freebsd/i
+        hash[:swap_size] = get_by_name('vm.swap_total')
+        hash[:swap_free] = hash[:swap_size] - get_freebsd_swap_used(page_size)
+      else
+        hash[:swap_size] = get_by_name('vm.swap_total')
+        hash[:swap_free] = hash[:swap_size] - get_by_name('vm.swap_reserved') # Best guess
+      end
+
+      hash[:available] = hash[:free] + hash[:inactive] + hash[:cache]
 
       hash
     end
@@ -50,6 +85,18 @@ module Sys
       extended ? hash[:free] + hash[:swap_free] : hash[:free]
     end
 
+    # The memory currently available, in bytes. This includes free memory and
+    # inactive/cache pages that the system can reclaim.
+    # If the +extended+ option is set to true, then free swap memory is also
+    # included.
+    #
+    def available(extended: false)
+      hash = memory
+      available = hash[:available]
+
+      extended ? available + hash[:swap_free] : available
+    end
+
     # The memory, in bytes, currently in use. By default this is only
     # physical memory, but if the +extended+ option is set to true then
     # swap is included in the calculation.
@@ -66,7 +113,7 @@ module Sys
       (used(extended: extended) / total(extended: extended).to_f).round(2) * 100
     end
 
-    module_function :memory, :total, :free, :load, :used
+    module_function :memory, :total, :free, :available, :load, :used
 
     private
 
@@ -79,7 +126,7 @@ module Sys
         size.write_int(optr.size)
 
         if sysctlbyname(mib, optr, size, nil, 0) < 0
-          raise SystemCallError.new('sysctlbyname', FFI.errno)
+          raise SystemCallError.new("sysctlbyname: #{mib}", FFI.errno)
         end
 
         value = optr.read_uint64
@@ -91,6 +138,31 @@ module Sys
       value
     end
 
-    module_function :get_by_name
+    def get_freebsd_swap_used(page_size)
+      kd = nil
+
+      begin
+        error = FFI::MemoryPointer.new(:char, 2048)
+        kd = kvm_openfiles(nil, File::NULL, nil, 0, error)
+
+        if kd.null?
+          message = error.read_string
+          raise SystemCallError, "kvm_openfiles: #{message.empty? ? 'unknown error' : message}"
+        end
+
+        swap = KvmSwap.new
+
+        if kvm_getswapinfo(kd, swap.pointer, 1, 0) < 0
+          raise SystemCallError, "kvm_getswapinfo: #{kvm_geterr(kd)}"
+        end
+
+        swap[:ksw_used] * page_size
+      ensure
+        kvm_close(kd) if kd && !kd.null?
+        error.free if error && !error.null?
+      end
+    end
+
+    module_function :get_by_name, :get_freebsd_swap_used
   end
 end

data/lib/sys/linux/memory.rb

@@ -44,13 +44,28 @@ module Sys
       extended ? (hash['MemFree'] + hash['SwapFree']) * 1024 : hash['MemFree'] * 1024
     end
 
+    # The memory currently available, in bytes. This is an estimate of the
+    # amount of memory available for starting new applications, without swapping.
+    # If the +extended+ option is set to true, then free swap memory is also
+    # included.
+    #
+    def available(extended: false)
+      hash = memory
+
+      available = hash.fetch('MemAvailable') do
+        hash['MemFree'] + hash['Buffers'] + hash['Cached'] + hash.fetch('SReclaimable', 0)
+      end
+
+      extended ? (available + hash['SwapFree']) * 1024 : available * 1024
+    end
+
     # The memory, in bytes, currently in use. By default this is only
     # physical memory, but if the +extended+ option is set to true then
     # swap is included in the calculation.
     #
     def used(extended: false)
       hash = memory
-      total(extended: extended) - free(extended: extended) - (hash['Buffers'] + hash['Cached'] + hash['Slab']) * 1024
+      total(extended: extended) - free(extended: extended) - ((hash['Buffers'] + hash['Cached'] + hash['Slab']) * 1024)
     end
 
     # A number between 0 and 100 that specifies the approximate percentage of
@@ -61,6 +76,6 @@ module Sys
       (used(extended: extended) / total(extended: extended).to_f).round(2) * 100
     end
 
-    module_function :memory, :total, :free, :used, :load
+    module_function :memory, :total, :free, :available, :used, :load
   end # Memory
 end # Sys

data/lib/sys/osx/memory.rb

@@ -7,13 +7,14 @@ module Sys
   # The Memory module is a house for memory related singleton methods that don't require state.
   module Memory
     extend FFI::Library
+
     ffi_lib FFI::Library::LIBC
 
     HOST_VM_INFO64 = 4
-    HOST_VM_INFO64_COUNT = 38
+    INTEGER_T_SIZE = 4
 
     private_constant :HOST_VM_INFO64
-    private_constant :HOST_VM_INFO64_COUNT
+    private_constant :INTEGER_T_SIZE
 
     attach_function :sysctlbyname, %i[string pointer pointer pointer size_t], :int
     attach_function :host_page_size, %i[pointer pointer], :int
@@ -25,6 +26,7 @@ module Sys
 
     typedef :uint, :natural_t
 
+    # Private class wrapper for struct swap
     class Swap < FFI::Struct
       layout(
         :xsu_total, :uint64_t,
@@ -37,6 +39,7 @@ module Sys
 
     private_constant :Swap
 
+    # Private class wrapper for struct vmstat
     class VmStat < FFI::Struct
       layout(
         :free_count, :natural_t,             # of pages free
@@ -62,7 +65,19 @@ module Sys
         :throttled_count, :natural_t,        # of pages throttled
         :external_page_count, :natural_t,    # of pages that are file-backed (non-swap)
         :internal_page_count, :natural_t,    # of pages that are anonymous
-        :total_uncompressed_pages_in_compressor, :uint64_t # of pages (uncompressed) held within the compressor
+        :total_uncompressed_pages_in_compressor, :uint64_t, # of pages (uncompressed) held within the compressor
+        :swapped_count, :uint64_t, # of compressor-stored pages currently stored in swap
+        :total_tag_storage_pages, :uint64_t,
+        :nontag_pageable_tag_storage_pages, :uint64_t,
+        :nontag_wired_tag_storage_pages, :uint64_t,
+        :free_tag_storage_pages, :uint64_t,
+        :tag_storing_tag_storage_pages, :uint64_t,
+        :total_tagged_pages, :uint64_t,
+        :resident_tagged_pages, :uint64_t,
+        :compressed_tagged_pages, :uint64_t,
+        :tagged_compressions, :uint64_t,
+        :tagged_decompressions, :uint64_t,
+        :compressed_tag_storage_bytes, :uint64_t
       )
     end
 
@@ -109,8 +124,8 @@ module Sys
 
       host_self = mach_host_self()
       vmstat = VmStat.new
-      count = FFI::MemoryPointer.new(:size_t)
-      count.write_int(vmstat.size)
+      count = FFI::MemoryPointer.new(:uint)
+      count.write_uint(vmstat.size / INTEGER_T_SIZE)
 
       rv = host_statistics64(host_self, HOST_VM_INFO64, vmstat, count)
       raise SystemCallError.new('host_statistics64', rv) if rv != 0
@@ -121,6 +136,7 @@ module Sys
       hash[:speculative] = vmstat[:speculative_count] * page_size
       hash[:wire] = vmstat[:wire_count] * page_size
       hash[:compressed] = vmstat[:compressor_page_count] * page_size
+      hash[:available] = hash[:free] + hash[:inactive]
 
       hash
     ensure
@@ -145,6 +161,18 @@ module Sys
       extended ? hash[:free] + hash[:swap_available] : hash[:free]
     end
 
+    # The memory currently available, in bytes. This includes free memory and
+    # inactive pages that the system can reclaim.
+    # If the +extended+ option is set to true, then available swap memory is
+    # also included.
+    #
+    def available(extended: false)
+      hash = memory
+      available = hash[:available]
+
+      extended ? available + hash[:swap_available] : available
+    end
+
     # The memory, in bytes, currently in use. By default this is only
     # physical memory, but if the +extended+ option is set to true then
     # swap is included in the calculation.
@@ -161,6 +189,6 @@ module Sys
       (used(extended: extended) / total(extended: extended).to_f).round(2) * 100
     end
 
-    module_function :memory, :total, :free, :load, :used
+    module_function :memory, :total, :free, :available, :load, :used
   end
 end

data/lib/sys/version.rb

@@ -3,6 +3,6 @@
 module Sys
   module Memory
     # The version of the sys-memory library.
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/sys/windows/memory.rb

@@ -7,11 +7,13 @@ module Sys
   module Memory
     require 'ffi'
     extend FFI::Library
+
     ffi_lib 'kernel32'
 
     typedef :uint32, :dword
     typedef :uint64, :dwordlong
 
+    # Private wrapper class for the MEMORYSTATUSEX struct
     class MemoryStatusEx < FFI::Struct
       layout(
         :dwLength, :dword,
@@ -33,6 +35,7 @@ module Sys
 
     ffi_lib 'psapi'
 
+    # Private wrapper class for the PERFORMANCE_INFORMATION struct
     class PerformanceInformation < FFI::Struct
       layout(
         :cb, :dword,
@@ -115,6 +118,18 @@ module Sys
       extended ? hash['AvailPhys'] + hash['AvailPageFile'] : hash['AvailPhys']
     end
 
+    # The physical memory currently available, in bytes. This is the amount of
+    # physical memory that can be immediately reused without having to write
+    # its contents to disk first.
+    #
+    # If the +extended+ option is set to true then available swap (pagefile)
+    # memory is included as part of the total.
+    #
+    def available(extended: false)
+      hash = memory
+      extended ? hash['AvailPhys'] + hash['AvailPageFile'] : hash['AvailPhys']
+    end
+
     # The memory, in bytes, currently in use. By default this is only
     # physical memory, but if the +extended+ option is set to true then
     # swap (pagefile) is included in the calculation.
@@ -133,6 +148,6 @@ module Sys
       memory['MemoryLoad']
     end
 
-    module_function :memory, :total, :free, :load, :used
+    module_function :memory, :total, :free, :available, :load, :used
   end
 end

data/spec/sys_memory_spec.rb

@@ -4,9 +4,20 @@ require 'active_support/core_ext/numeric/bytes'
 require 'sys-memory'
 
 RSpec.describe Sys::Memory do
+  let(:memory) { described_class.memory }
+
+  let(:swap_keys) do
+    [
+      %i[swap_size swap_free],
+      %i[swap_total swap_available],
+      %w[SwapTotal SwapFree],
+      %w[TotalPageFile AvailPageFile]
+    ].find { |total_key, free_key| memory.key?(total_key) && memory.key?(free_key) }
+  end
+
   context 'Sys::Memory::VERSION' do
     example 'the version constant is set to the expected value' do
-      expect(described_class::VERSION).to eq('0.2.0')
+      expect(described_class::VERSION).to eq('0.3.0')
       expect(described_class::VERSION).to be_frozen
     end
   end
@@ -17,9 +28,24 @@ RSpec.describe Sys::Memory do
     end
 
     example 'the memory singleton method returns the expected hash' do
-      expect(described_class.memory).to be_kind_of(Hash)
+      expect(described_class.memory).to be_a(Hash)
       expect(described_class.memory.size).to be > 4
     end
+
+    example 'the memory singleton method returns non-negative numeric values' do
+      described_class.memory.each do |key, value|
+        expect(value).to be_a(Numeric), "#{key.inspect} should be numeric"
+        expect(value).to be >= 0
+      end
+    end
+
+    example 'the memory singleton method returns sane swap values' do
+      swap_total, swap_free = swap_keys
+      skip 'no swap values reported on this platform' unless swap_total && swap_free
+
+      expect(memory[swap_total]).to be >= 0
+      expect(memory[swap_free]).to be_between(0, memory[swap_total]).inclusive
+    end
   end
 
   context 'Sys::Memory.total' do
@@ -42,6 +68,20 @@ RSpec.describe Sys::Memory do
     end
   end
 
+  context 'Sys::Memory.available' do
+    example 'the available singleton method is defined' do
+      expect(described_class).to respond_to(:available)
+    end
+
+    example 'the available singleton method returns a sane value' do
+      expect(described_class.available).to be > 64.megabytes
+    end
+
+    example 'the available singleton method is at least free memory' do
+      expect(described_class.available).to be >= described_class.free
+    end
+  end
+
   context 'Sys::Memory.used' do
     example 'the used singleton method is defined' do
       expect(described_class).to respond_to(:used)

data/sys-memory.gemspec

@@ -2,18 +2,18 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-memory'
-  spec.version    = '0.2.0'
+  spec.version    = '0.3.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
   spec.homepage   = 'https://github.com/djberg96/sys-memory'
   spec.summary    = 'A Ruby interface for providing memory information'
   spec.test_file  = 'spec/sys_memory_spec.rb'
-  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+  spec.files      = Dir['**/*'].reject{ |f| f.include?('git') || f.end_with?('.gem') }
   spec.cert_chain = ['certs/djberg96_pub.pem']
 
   spec.add_dependency('ffi', '~> 1.1')
-  spec.add_development_dependency('activesupport', '~> 6.0')
+  spec.add_development_dependency('activesupport', '>= 6.0')
   spec.add_development_dependency('rspec', '~> 3.9')
   spec.add_development_dependency('rake', '~> 13.0')
   spec.add_development_dependency('rubocop')
@@ -27,7 +27,8 @@ Gem::Specification.new do |spec|
     'source_code_uri'       => 'https://github.com/djberg96/sys-memory',
     'wiki_uri'              => 'https://github.com/djberg96/sys-memory/wiki',
     'rubygems_mfa_required' => 'true',
-    'github_repo'           => 'https://github.com/djberg96/sys-memory'
+    'github_repo'           => 'https://github.com/djberg96/sys-memory',
+    'funding_uri'           => 'https://github.com/sponsors/djberg96'
   }
 
   spec.description = <<-EOF

metadata

@@ -1,11 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: sys-memory
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -35,7 +34,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2024-06-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -55,14 +54,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
@@ -158,7 +157,7 @@ metadata:
   wiki_uri: https://github.com/djberg96/sys-memory/wiki
   rubygems_mfa_required: 'true'
   github_repo: https://github.com/djberg96/sys-memory
-post_install_message:
+  funding_uri: https://github.com/sponsors/djberg96
 rdoc_options: []
 require_paths:
 - lib
@@ -173,8 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Ruby interface for providing memory information
 test_files: