sys-memory 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8db02636f7f2e60a3cc6a56365b10eecfa117825aa4ce7992f8f8bf2a9ae61
-  data.tar.gz: b336bd31a553a7b2e3a3ca24848152c5f73bf913f0bfdce402ae7164717050ba
+  metadata.gz: 9c4673911e1763e8282380312020206b04a9fb268572d3b64e8fc0a631befa03
+  data.tar.gz: 28e0b52dd179b98a4896dab5442bac98beb538fea493d0db5ea113b6148ed70d
 SHA512:
-  metadata.gz: 6634473e9c7ca86e19bbd341e88beff8d8094be5e64a7228049599171f31d486a52db9d0ef2c1e0dc2ffe040639936f3a0b1f639e0960cdc03760ef26ba64ec7
-  data.tar.gz: e23244aacf479c8936a443458c6b584f9013fe8882bf23e7a18647ebda78fb79d9ea2f1006dc8e5760a524c64dd89a9b84f6bca428f155e966ba350a5fdc5f8f
+  metadata.gz: f6b1f2cf5a71c94be2dc997fb7e4c3d91a2d32c83af4b7399cba169c8ef36d20382decb1d35e020d7c7b7f7651957d1a1deb105e748db66087f071aae20879a8
+  data.tar.gz: 0c4f87e99e7b69148c0abcbfed29217a2fac229eff5237a3f632bfd2994dc89d6b432c63169a9e5bef1ab1f432f81330617bddef72f6a3092770fbcaaac49eb6

data/CHANGES.md

@@ -1,3 +1,7 @@
+## 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/lib/sys/bsd/memory.rb

@@ -0,0 +1,96 @@
+# 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
+
+    # 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
+      hash[:swap_size] = get_by_name('vm.swap_size')
+      hash[:swap_free] = get_by_name('vm.swap_free')
+
+      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', FFI.errno)
+        end
+
+        value = optr.read_uint64
+      ensure
+        optr.free if optr && !optr.null?
+        size.free if size && !size.null?
+      end
+
+      value
+    end
+
+    module_function :get_by_name
+  end
+end

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/version.rb

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

data/spec/sys_memory_spec.rb

@@ -6,7 +6,7 @@ require 'sys-memory'
 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.1.3')
+      expect(described_class::VERSION).to eq('0.2.0')
       expect(described_class::VERSION).to be_frozen
     end
   end

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.0'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-memory
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -138,6 +138,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