sys-memory 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8db02636f7f2e60a3cc6a56365b10eecfa117825aa4ce7992f8f8bf2a9ae61
-  data.tar.gz: b336bd31a553a7b2e3a3ca24848152c5f73bf913f0bfdce402ae7164717050ba
+  metadata.gz: 457079deac5b71c2aa7827dc99fd05ad3a2096937db1d59d0824fa9d19307fc3
+  data.tar.gz: 8d3a0331639955099db7909cace2e596a5972573053ec88f4f7e9013051ae474
 SHA512:
-  metadata.gz: 6634473e9c7ca86e19bbd341e88beff8d8094be5e64a7228049599171f31d486a52db9d0ef2c1e0dc2ffe040639936f3a0b1f639e0960cdc03760ef26ba64ec7
-  data.tar.gz: e23244aacf479c8936a443458c6b584f9013fe8882bf23e7a18647ebda78fb79d9ea2f1006dc8e5760a524c64dd89a9b84f6bca428f155e966ba350a5fdc5f8f
+  metadata.gz: 3e3c784ef9a72e5c8f1a1ed0a8de66355381fb8391744440c621346b965dc45d55276737a9d4417ec8057550bb561ed54285dbf1935b33abbfc723b89cdeaef1
+  data.tar.gz: a8910b5ad70f11cea073144e08a9db16b876669ec2611bf75cb8e6624e6ac2d0c88dae07fe28f0ef387e1feca55c57d989dc5e042f79c351072a7137d107f36a

data/CHANGES.md

@@ -1,3 +1,13 @@
+## 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.
+
 ## 0.1.3 - 12-Dec-2023
 * Fix "used" calculations on Linux. Thanks go to Splendide-Imaginarius
   for the spot and the patch.

data/README.md

@@ -7,6 +7,9 @@ A Ruby interface for getting memory information.
 * Linux
 * Windows
 * OSX
+* BSD
+
+Note that only DragonflyBSD has been tested. I am not sure about other flavors yet.
 
 ## Installation
 `gem install sys-memory`
@@ -44,7 +47,7 @@ https://github.com/djberg96/sys-memory
 Apache-2.0
 
 ## Copyright
-(C) 2021-2023 Daniel J. Berger, All Rights Reserved
+(C) 2021-2024 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

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'ffi'
+
+# The Sys module serves only as a namespace.
+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.
+    #
+    def memory
+      page_size = get_by_name('hw.pagesize')
+
+      hash = {}
+      hash[:total] = get_by_name('hw.physmem')
+      hash[:active] = get_by_name('vm.stats.vm.v_active_count') * page_size
+      hash[:all] = get_by_name('vm.stats.vm.v_page_count') * page_size
+      hash[:cache] = get_by_name('vm.stats.vm.v_cache_count') * page_size
+      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
+
+      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
+    end
+
+    # Total memory in bytes. By default this is only physical memory, but
+    # if the +extended+ option is set to true, then swap memory is included as
+    # part of the total.
+    #
+    def total(extended: false)
+      hash = memory
+      extended ? hash[:total] + hash[:swap_size] : hash[:total]
+    end
+
+    # The memory currently available, in bytes. By default this is only
+    # physical memory, but if the +extended+ option is set to true, then free
+    # swap memory is also included.
+    #
+    def free(extended: false)
+      hash = memory
+      extended ? hash[:free] + hash[:swap_free] : hash[:free]
+    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)
+      total(extended: extended) - free(extended: extended)
+    end
+
+    # A number between 0 and 100 that specifies the approximate percentage of
+    # memory that is in use. If the +extended+ option is set to true then
+    # swap memory is included in the calculation.
+    #
+    def load(extended: false)
+      (used(extended: extended) / total(extended: extended).to_f).round(2) * 100
+    end
+
+    module_function :memory, :total, :free, :load, :used
+
+    private
+
+    def get_by_name(mib)
+      value = nil
+
+      begin
+        optr = FFI::MemoryPointer.new(:uint64_t)
+        size = FFI::MemoryPointer.new(:size_t)
+        size.write_int(optr.size)
+
+        if sysctlbyname(mib, optr, size, nil, 0) < 0
+          raise SystemCallError.new("sysctlbyname: #{mib}", FFI.errno)
+        end
+
+        value = optr.read_uint64
+      ensure
+        optr.free if optr && !optr.null?
+        size.free if size && !size.null?
+      end
+
+      value
+    end
+
+    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

@@ -50,7 +50,7 @@ module Sys
     #
     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

data/lib/sys/memory.rb

@@ -8,6 +8,8 @@ case RbConfig::CONFIG['host_os']
     require_relative 'linux/memory'
   when /darwin|macos/i
     require_relative 'osx/memory'
+  when /bsd|dragonfly/i
+    require_relative 'bsd/memory'
   when /windows|win32|mingw/i
     require_relative 'windows/memory'
 end

data/lib/sys/osx/memory.rb

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

data/lib/sys/version.rb

@@ -3,6 +3,6 @@
 module Sys
   module Memory
     # The version of the sys-memory library.
-    VERSION = '0.1.3'
+    VERSION = '0.2.1'
   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,

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.1.3')
+      expect(described_class::VERSION).to eq('0.2.1')
       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

data/sys-memory.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-memory'
-  spec.version    = '0.1.3'
+  spec.version    = '0.2.1'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   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.1.3
+  version: 0.2.1
 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: 2023-12-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
@@ -138,6 +137,7 @@ files:
 - Rakefile
 - certs/djberg96_pub.pem
 - lib/sys-memory.rb
+- lib/sys/bsd/memory.rb
 - lib/sys/linux/memory.rb
 - lib/sys/memory.rb
 - lib/sys/osx/memory.rb
@@ -157,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
@@ -172,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: