sys-memory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eb58ad679007156871e4cc8b3906546c10a634a04537b69b6021c9b83a7be18b
+  data.tar.gz: 464f3d02c1e96915808772ac2d66652d62c956a05f03054e246af893e8316a64
+SHA512:
+  metadata.gz: d5125dcc2e250ba8d4e4e513901321b397fd473f1934e5c7d3155bdda00ee5c75cd51d2e90e2cd7b7797d97279699237a3b574004f00f63a4bb2bb2788ed9f3a
+  data.tar.gz: 472f13e448c5ce16c7750a88f93e65283b22fce862bbe2c010210fbca2be2b0465bdd7c82dae4c08457773f026da10ccd5ac3157cf4c5c334c1daeb8f77dca42

checksums.yaml.gz.sig

@@ -0,0 +1,3 @@
+^Rt%Ǟ��ѿx	�Z��F�]�RəP�M'ӌ��'!Z��A��6����ʣ����8B*,��J��pÍ�h�?{
+�욶��ay��O
tm�ʓ�Ę�<���B~�d���[��
+Ez����TM����X��9W��&$6BN����I�韥o�"v&�=-V���Xcf<��"$����ϟ��n������n��#��I$@���������B��Y��m!�Ԡ!la�h��+S��6U�d�"���1tM

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,53 @@
+## Description
+A Ruby interface for getting memory information.
+
+## Supported Platforms
+* Linux
+* Windows
+* OSX
+
+## Installation
+`gem install sys-memory`
+
+## Synopsis
+```
+require 'sys-memory'
+
+p Sys::Memory.memory                # Hash of all information
+
+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.
+
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-memory/ffi/certs/djberg96_pub.pem)`
+
+## Notes
+I realize there are some philosophical differences about what constitutes
+"available memory". I've tried to accomodate both of the approaches to 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.
+
+You can also just use `Sys::Memory.memory` and collate the various hash data
+pieces as you see fit.
+
+## Known Bugs
+None that I'm aware of. Please report bugs on the project page at:
+
+https://github.com/djberg96/sys-cpu
+
+## License
+Apache-2.0
+
+## Copyright
+(C) 2021 Daniel J. Berger, All Rights Reserved
+
+## Warranty
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## Author
+Daniel J. Berger

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace 'gem' do
+  desc "Create the sys-memory gem"
+  task :create => [:clean] do
+    require 'rubygems/package'
+    spec = Gem::Specification.load('sys-memory.gemspec')
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
+  end
+
+  desc "Install the sys-memory gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+task :default => :spec

data/certs/djberg96_pub.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+-----END CERTIFICATE-----

data/lib/sys-memory.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'sys/memory'

data/lib/sys/linux/memory.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Sys
+  module Memory
+    MEMORY_FILE = '/proc/meminfo'
+    MEMINFO_REGEX = /(.*)?:\s+?(\d+)/.freeze
+
+    private_constant :MEMORY_FILE
+    private_constant :MEMINFO_REGEX
+
+    # 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
+      hash = {}
+
+      IO.foreach(MEMORY_FILE) do |line|
+        key, value = MEMINFO_REGEX.match(line.chomp).captures
+        hash[key] = value.to_i
+      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['MemTotal'] + hash['SwapTotal']) * 1024 : hash['MemTotal'] * 1024
+    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['MemFree'] + hash['SwapFree']) * 1024 : hash['MemFree'] * 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
+    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, :used, :load
+  end
+end

data/lib/sys/memory.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rbconfig'
+require_relative 'version'
+
+case RbConfig::CONFIG['host_os']
+  when /linux/i
+    require_relative 'linux/memory'
+  when /darwin|macos/i
+    require_relative 'osx/memory'
+  when /windows|win32|mingw/i
+    require_relative 'windows/memory'
+end

data/lib/sys/osx/memory.rb

@@ -0,0 +1,166 @@
+# 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
+
+    HOST_VM_INFO64 = 4
+    HOST_VM_INFO64_COUNT = 38
+
+    private_constant :HOST_VM_INFO64
+    private_constant :HOST_VM_INFO64_COUNT
+
+    attach_function :sysctlbyname, %i[string pointer pointer pointer size_t], :int
+    attach_function :host_page_size, %i[pointer pointer], :int
+    attach_function :host_statistics64, %i[pointer int pointer pointer], :int
+    attach_function :mach_host_self, [], :pointer
+
+    private_class_method :sysctlbyname, :host_page_size
+    private_class_method :host_statistics64, :mach_host_self
+
+    typedef :uint, :natural_t
+
+    class Swap < FFI::Struct
+      layout(
+        :xsu_total, :uint64_t,
+        :xsu_avail, :uint64_t,
+        :xsu_used, :uint64_t,
+        :xsu_pagesize, :uint32_t,
+        :xsu_encrypted, :bool
+      )
+    end
+
+    private_constant :Swap
+
+    class VmStat < FFI::Struct
+      layout(
+        :free_count, :natural_t,             # of pages free
+        :active_count, :natural_t,           # of pages active
+        :inactive_count, :natural_t,         # of pages inactive
+        :wire_count, :natural_t,             # of pages wired down
+        :zero_fill_count, :uint64_t,         # of zero fill pages
+        :reactivations, :uint64_t,           # of pages reactivated
+        :pageins, :uint64_t,                 # of pageins
+        :pageouts, :uint64_t,                # of pageouts
+        :faults, :uint64_t,                  # of faults
+        :cow_faults, :uint64_t,              # of copy-on-writes
+        :lookups, :uint64_t,                 # object cache lookups
+        :hits, :uint64_t,                    # object cache hits
+        :purges, :uint64_t,                  # of pages purged
+        :purgeable_count, :natural_t,        # of pages purgeable
+        :speculative_count, :natural_t,      # of pages speculative
+        :decompressions, :uint64_t,          # of pages decompressed
+        :compressions, :uint64_t,            # of pages compressed
+        :swapins, :uint64_t,                 # of pages swapped in (via compression segments)
+        :swapouts, :uint64_t,                # of pages swapped out (via compression segments)
+        :compressor_page_count, :natural_t,  # of pages used by the compressed pager to hold all the compressed data
+        :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
+      )
+    end
+
+    private_constant :VmStat
+
+    # 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
+      hash = {}
+      page_size = 4096 # Possibly changed later
+
+      begin
+        optr = FFI::MemoryPointer.new(:uint64_t)
+        size = FFI::MemoryPointer.new(:size_t)
+        size.write_int(optr.size)
+
+        if sysctlbyname('hw.memsize', optr, size, nil, 0) < 0
+          raise SystemCallError.new('sysctlbyname', FFI.errno)
+        end
+
+        hash[:total] = optr.read_uint64
+      ensure
+        optr.free if optr && !optr.null?
+        size.clear
+      end
+
+      begin
+        swap = Swap.new
+        size.write_int(swap.size)
+
+        if sysctlbyname('vm.swapusage', swap, size, nil, 0) < 0
+          raise SystemCallError.new('sysctlbyname', FFI.errno)
+        end
+
+        hash[:swap_total] = swap[:xsu_total]
+        hash[:swap_available] = swap[:xsu_avail]
+        hash[:swap_used] = swap[:xsu_used]
+        page_size = swap[:xsu_pagesize]
+      ensure
+        size.free if size && !size.null?
+      end
+
+      host_self = mach_host_self()
+      vmstat = VmStat.new
+      count = FFI::MemoryPointer.new(:size_t)
+      count.write_int(vmstat.size)
+
+      rv = host_statistics64(host_self, HOST_VM_INFO64, vmstat, count)
+      raise SystemCallError.new('host_statistics64', rv) if rv != 0
+
+      hash[:free] = vmstat[:free_count] * page_size
+      hash[:active] = vmstat[:active_count] * page_size
+      hash[:inactive] = vmstat[:inactive_count] * page_size
+      hash[:speculative] = vmstat[:speculative_count] * page_size
+      hash[:wire] = vmstat[:wire_count] * page_size
+      hash[:compressed] = vmstat[:compressor_page_count] * page_size
+
+      hash
+    ensure
+      count.free if count && !count.null?
+    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_total] : 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_available] : 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
+  end
+end

data/lib/sys/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Sys
+  module Memory
+    # The version of the sys-memory library.
+    VERSION = '0.1.0'
+  end
+end

data/lib/sys/windows/memory.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Sys
+  module Memory
+    require 'ffi'
+    extend FFI::Library
+    ffi_lib 'kernel32'
+
+    private
+
+    typedef :uint32, :dword
+    typedef :uint64, :dwordlong
+
+    class MemoryStatusEx < FFI::Struct
+      layout(
+        :dwLength, :dword,
+        :dwMemoryLoad, :dword,
+        :ullTotalPhys, :dwordlong,
+        :ullAvailPhys, :dwordlong,
+        :ullTotalPageFile, :dwordlong,
+        :ullAvailPageFile, :dwordlong,
+        :ullTotalVirtual, :dwordlong,
+        :ullAvailVirtual, :dwordlong,
+        :ullAvailExtendedVirtual, :dwordlong
+      )
+    end
+
+    attach_function :GlobalMemoryStatusEx, [MemoryStatusEx], :bool
+
+    ffi_lib 'psapi'
+
+    class PerformanceInformation < FFI::Struct
+      layout(
+        :cb, :dword,
+        :CommitTotal, :size_t,
+        :CommitLimit, :size_t,
+        :CommitPeak, :size_t,
+        :PhysicalTotal, :size_t,
+        :PhysicalAvailable, :size_t,
+        :SystemCache, :size_t,
+        :KernelTotal, :size_t,
+        :KernelPaged, :size_t,
+        :KernelNonpaged, :size_t,
+        :PageSize, :size_t,
+        :HandleCount, :dword,
+        :ProcessCount, :dword,
+        :ThreadCount, :dword
+      )
+    end
+
+    attach_function :GetPerformanceInfo, [PerformanceInformation, :dword], :bool
+
+    public
+
+    # 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
+      struct = MemoryStatusEx.new
+      struct[:dwLength] = struct.size
+
+      unless GlobalMemoryStatusEx(struct)
+        raise SystemCallError.new('GlobalMemoryStatusEx', FFI.errno)
+      end
+
+      hash = {}
+
+      struct.members.each do |member|
+        key = member.to_s.sub(/^ull|^dw/, '')
+        hash[key] = struct[member]
+      end
+
+      hash.delete('Length')
+
+      perf = PerformanceInformation.new
+
+      unless GetPerformanceInfo(perf, perf.size)
+        raise SystemCallError.new('GetPerformanceInfo', FFI.errno)
+      end
+
+      perf.members.each do |member|
+        key = member.to_s
+        hash[key] = perf[member]
+      end
+
+      hash.delete('cb')
+
+      hash
+    end
+
+    # Total memory in bytes. By default this is only physical memory, but
+    # if the +extended+ option is set to true then swap (pagefile) memory is
+    # included as part of the total.
+    #
+    def total(extended: false)
+      hash = memory
+      extended ? hash['TotalPhys'] + hash['TotalPageFile'] : hash['TotalPhys']
+    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 free(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.
+    #
+    def used(extended: false)
+      total(extended: extended) - free(extended: extended)
+    end
+
+    # A number between 0 and 100 that specifies the approximate percentage of
+    # physical 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)
+      memory['MemoryLoad']
+    end
+
+    module_function :memory, :total, :free, :load, :used
+  end
+end

data/spec/sys_memory_spec.rb

@@ -0,0 +1,62 @@
+require 'active_support/core_ext/numeric/bytes'
+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.0')
+      expect(described_class::VERSION).to be_frozen
+    end
+  end
+
+  context 'Sys::Memory.memory' do
+    example 'the memory singleton method is defined' do
+      expect(described_class).to respond_to(:memory)
+    end
+
+    example 'the memory singleton method returns the expected hash' do
+      expect(described_class.memory).to be_kind_of(Hash)
+      expect(described_class.memory.size).to be > 4
+    end
+  end
+
+  context 'Sys::Memory.total' do
+    example 'the total singleton method is defined' do
+      expect(described_class).to respond_to(:total)
+    end
+
+    example 'the total singleton method returns a sane value' do
+      expect(described_class.total).to be > 64.megabytes
+    end
+  end
+
+  context 'Sys::Memory.free' do
+    example 'the free singleton method is defined' do
+      expect(described_class).to respond_to(:free)
+    end
+
+    example 'the free singleton method returns a sane value' do
+      expect(described_class.free).to be > 64.megabytes
+    end
+  end
+
+  context 'Sys::Memory.used' do
+    example 'the used singleton method is defined' do
+      expect(described_class).to respond_to(:used)
+    end
+
+    example 'the used singleton method returns a sane value' do
+      expect(described_class.used).to be > 64.megabytes
+    end
+  end
+
+  context 'Sys::Memory.load' do
+    example 'the load singleton method is defined' do
+      expect(described_class).to respond_to(:load)
+    end
+
+    example 'the load singleton method returns a sane value' do
+      expect(described_class.load).to be > 1
+    end
+  end
+end

data/sys-memory.gemspec

@@ -0,0 +1,36 @@
+require 'rubygems'
+
+Gem::Specification.new do |spec|
+  spec.name       = 'sys-memory'
+  spec.version    = '0.1.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.cert_chain = ['certs/djberg96_pub.pem']
+
+  spec.extra_rdoc_files = Dir['*.rdoc']
+
+  spec.add_dependency('ffi', "~> 1.1")
+  spec.add_dependency('activesupport', "~> 6.0")
+  spec.add_development_dependency('rspec', "~> 3.9")
+  spec.add_development_dependency('rake', "~> 13.0")
+
+  spec.metadata = {
+    'homepage_uri'      => 'https://github.com/djberg96/sys-memory',
+    'bug_tracker_uri'   => 'https://github.com/djberg96/sys-memory/issues',
+    'changelog_uri'     => 'https://github.com/djberg96/sys-memory/blob/main/CHANGES.md',
+    'documentation_uri' => 'https://github.com/djberg96/sys-memory/wiki',
+    'source_code_uri'   => 'https://github.com/djberg96/sys-memory',
+    'wiki_uri'          => 'https://github.com/djberg96/sys-memory/wiki'
+  }
+
+  spec.description = <<-EOF
+    The sys-memory library provides an interface for gathering information
+    about your system's memory. Information includes total physical memory,
+    swap, free memory, and so on.
+  EOF
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: sys-memory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
+  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
+  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
+  -----END CERTIFICATE-----
+date: 2021-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: |2
+      The sys-memory library provides an interface for gathering information
+      about your system's memory. Information includes total physical memory,
+      swap, free memory, and so on.
+email: djberg96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- certs/djberg96_pub.pem
+- lib/sys-memory.rb
+- lib/sys/linux/memory.rb
+- lib/sys/memory.rb
+- lib/sys/osx/memory.rb
+- lib/sys/version.rb
+- lib/sys/windows/memory.rb
+- spec/sys_memory_spec.rb
+- sys-memory.gemspec
+homepage: https://github.com/djberg96/sys-memory
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/djberg96/sys-memory
+  bug_tracker_uri: https://github.com/djberg96/sys-memory/issues
+  changelog_uri: https://github.com/djberg96/sys-memory/blob/main/CHANGES.md
+  documentation_uri: https://github.com/djberg96/sys-memory/wiki
+  source_code_uri: https://github.com/djberg96/sys-memory
+  wiki_uri: https://github.com/djberg96/sys-memory/wiki
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.25
+signing_key: 
+specification_version: 4
+summary: A Ruby interface for providing memory information
+test_files:
+- spec/sys_memory_spec.rb