sys-memory 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 457079deac5b71c2aa7827dc99fd05ad3a2096937db1d59d0824fa9d19307fc3
-  data.tar.gz: 8d3a0331639955099db7909cace2e596a5972573053ec88f4f7e9013051ae474
+  metadata.gz: 25b5f9d04be24191f9eb133c8cd851a39b8c46df7464d0dc9256dfbaf0d88f6d
+  data.tar.gz: 065dfcc2df8519394092d64cb4f354dd9c33e12cb9d982e1df861ea564c6410f
 SHA512:
-  metadata.gz: 3e3c784ef9a72e5c8f1a1ed0a8de66355381fb8391744440c621346b965dc45d55276737a9d4417ec8057550bb561ed54285dbf1935b33abbfc723b89cdeaef1
-  data.tar.gz: a8910b5ad70f11cea073144e08a9db16b876669ec2611bf75cb8e6624e6ac2d0c88dae07fe28f0ef387e1feca55c57d989dc5e042f79c351072a7137d107f36a
+  metadata.gz: aa249753e3a61d6d77a74fb3bfef92cbaeb440e78e0f6c37f11c708756713e5381fc1f6572a9ab2eb8d2392f00f67d63b04d53bfe662f1f987a19cc8674d1991
+  data.tar.gz: 46c66b080426c803617ba62579d570fda47b5a12d7e2f35270963e3e1709a12411044924498e1f435396c215c997401671e38bbe455fe5eef9837a73c569f905

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 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.

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/lib/sys/bsd/memory.rb

@@ -62,6 +62,8 @@ module Sys
         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
 
@@ -83,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.
@@ -99,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
 

data/lib/sys/linux/memory.rb

@@ -44,6 +44,21 @@ 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.
@@ -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

@@ -11,10 +11,10 @@ module Sys
     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
@@ -65,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
 
@@ -112,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
@@ -124,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
@@ -148,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.
@@ -164,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.1'
+    VERSION = '0.3.0'
   end
 end

data/lib/sys/windows/memory.rb

@@ -118,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.
@@ -136,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

@@ -17,7 +17,7 @@ RSpec.describe Sys::Memory do
 
   context 'Sys::Memory::VERSION' do
     example 'the version constant is set to the expected value' do
-      expect(described_class::VERSION).to eq('0.2.1')
+      expect(described_class::VERSION).to eq('0.3.0')
       expect(described_class::VERSION).to be_frozen
     end
   end
@@ -68,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,14 +2,14 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-memory'
-  spec.version    = '0.2.1'
+  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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-memory
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Daniel J. Berger