get_process_mem 0.2.2 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94fcbfe333ae0cfed19b0152cc0ac30185ade620dfdee8602c650d2af0e2f335
-  data.tar.gz: 1ae8b971296e8707f11709c351e914b24dcf78cdcb35a137b43e24ac6f228bce
+  metadata.gz: 06a96e8d978fd95bcf546a1e5e8bbc01cc10635d50b2f87639eb9c1f8c7f4f76
+  data.tar.gz: 6c941ae4f0301ff698b9be4ba75597537ed3ae5a11bf9295ab81144ef8435047
 SHA512:
-  metadata.gz: 84f9147a2c2ac5de19db50ef12a0d0ce281f0e17c616d7ddcda88bef6660b4e13b6c588d746330d566fffc6d9af657fe3d630ca52307b3a40147dc7ce26e2e77
-  data.tar.gz: 2db59b624cd6ed098685b8851eb4776c36c83ec63da54e6da5b885c562311f37ee2792c9de59bad1b7fa138aff7f90a1e2de84db5806c204330149736a8e47c5
+  metadata.gz: 3cdb2baad08676298249f006b12f0c61bd0fdc1e13902211e2e0c3ea965c39fee2edb2ad3d2ceb617dcf450738e765c60c7e748830d85c52b044fa0ad8a3c8db
+  data.tar.gz: 35d717cc39f85a902adaa8ea6028d969b40b89465bcc0d1578de4e97308fe890e77ce9ff06b68855253030b3ab26fa130e2e44be06b041368a39a4cb4bc300f8

data/.github/workflows/check_changelog.yml

@@ -0,0 +1,12 @@
+name: Check Changelog
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Check that CHANGELOG is touched
+      run: |
+        cat $GITHUB_EVENT_PATH | jq .pull_request.title |  grep -i '\[\(\(changelog skip\)\|\(ci skip\)\)\]' ||  git diff remotes/origin/${{ github.base_ref }} --name-only | grep CHANGELOG.md

data/.travis.yml

@@ -1,18 +1,22 @@
 language: ruby
+os:
+  - linux
+  - osx
 
 before_install:
-  - gem install bundler -v 1.12.5
+  - gem install bundler -v 1.17.3
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
+  - 2.2
+  - 2.6
   - ruby-head
-  - jruby-19mode
-  - rbx-19mode
+  - jruby-head
+  - truffleruby
 
 matrix:
   allow_failures:
+    - rvm: 2.2
+      if: os = osx
     - rvm: ruby-head
-    - rvm: rbx-19mode
-    - rvm: jruby-19mode
+    - rvm: jruby-head
+    - rvm: truffleruby

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+## HEAD (unreleased)
+
+## 0.2.7
+
+- Native (faster) support for returning memory from different PIDs on mac (https://github.com/schneems/get_process_mem/pull/42)
+
+## 0.2.6
+
+- Support returning memory from different PIDs on mac (https://github.com/schneems/get_process_mem/pull/41)
+
+## 0.2.5
+
+- Use new sys-proctable interface (https://github.com/schneems/get_process_mem/pull/36)
+
+## 0.2.4
+
+- Use FFI to speed up memory lookup on Mac (darwin) by roughly 12x (#32)
+
+## 0.2.3
+
+- Silence BigDecimal deprecation warning under Ruby 2.5 (#26)
+
 ## 0.2.2
 
 - Fix support for Ruby 2.4 (#23)
@@ -21,4 +43,4 @@
 
 ## 0.0.1
 
-- Initial
+- Initial

data/README.md

@@ -1,6 +1,6 @@
 # Get Process Memory
 
-[![Build Status](https://travis-ci.org/schneems/get_process_mem.png?branch=master)](https://travis-ci.org/schneems/get_process_mem)
+[![Build Status](https://travis-ci.org/schneems/get_process_mem.svg?branch=master)](https://travis-ci.org/schneems/get_process_mem)
 [![Help Contribute to Open Source](https://www.codetriage.com/schneems/get_process_mem/badges/users.svg)](https://www.codetriage.com/schneems/get_process_mem)
 
 Do you need to get the memory usage of a process? Great because this library does that.

data/get_process_mem.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency "sys-proctable", "~> 1.0"
-  gem.add_development_dependency "rake",  "~> 10.1"
-  gem.add_development_dependency "test-unit", "~> 3.1.0"
+  gem.add_dependency "ffi", "~> 1.0"
+
+  gem.add_development_dependency "sys-proctable", "~> 1.2"
+  gem.add_development_dependency "rake", "~> 12"
+  gem.add_development_dependency "test-unit", "~> 3"
 end

data/lib/get_process_mem.rb

@@ -3,11 +3,19 @@ require 'bigdecimal'
 
 # Cribbed from Unicorn Worker Killer, thanks!
 class GetProcessMem
-  KB_TO_BYTE = 1024          # 2**10   = 1024
-  MB_TO_BYTE = 1_048_576     # 1024**2 = 1_048_576
-  GB_TO_BYTE = 1_073_741_824 # 1024**3 = 1_073_741_824
+  private_class_method def self.number_to_bigdecimal(value)
+    BigDecimal(value)
+  end
+
+  private def number_to_bigdecimal(value)
+    self.class.send(:number_to_bigdecimal, value)
+  end
+
+  KB_TO_BYTE = number_to_bigdecimal 1024          # 2**10   = 1024
+  MB_TO_BYTE = number_to_bigdecimal 1_048_576     # 1024**2 = 1_048_576
+  GB_TO_BYTE = number_to_bigdecimal 1_073_741_824 # 1024**3 = 1_073_741_824
   CONVERSION = { "kb" => KB_TO_BYTE, "mb" => MB_TO_BYTE, "gb" => GB_TO_BYTE }
-  ROUND_UP   = BigDecimal.new("0.5")
+  ROUND_UP   = number_to_bigdecimal "0.5"
   attr_reader :pid
 
   RUNS_ON_WINDOWS = Gem.win_platform?
@@ -23,6 +31,20 @@ class GetProcessMem
     include Sys
   end
 
+  RUNS_ON_DARWIN =  Gem.platforms.detect do |p|
+                      p.is_a?(Gem::Platform) && p.os == 'darwin'
+                    end
+
+  if RUNS_ON_DARWIN
+    begin
+      require 'get_process_mem/darwin'
+    rescue LoadError => e
+      message = "Please add `ffi` to your Gemfile for darwin (macos) machines\n"
+      message << e.message
+      raise e, message
+    end
+  end
+
   def initialize(pid = Process.pid)
     @status_file  = Pathname.new "/proc/#{pid}/status"
     @process_file = Pathname.new "/proc/#{pid}/smaps"
@@ -36,19 +58,20 @@ class GetProcessMem
 
   def bytes
     memory =   linux_status_memory if linux?
+    memory ||= darwin_memory if RUNS_ON_DARWIN
     memory ||= ps_memory
   end
 
   def kb(b = bytes)
-    (b/BigDecimal.new(KB_TO_BYTE)).to_f
+    (b/KB_TO_BYTE).to_f
   end
 
   def mb(b = bytes)
-    (b/BigDecimal.new(MB_TO_BYTE)).to_f
+    (b/MB_TO_BYTE).to_f
   end
 
   def gb(b = bytes)
-    (b/BigDecimal.new(GB_TO_BYTE)).to_f
+    (b/GB_TO_BYTE).to_f
   end
 
   def inspect
@@ -73,7 +96,7 @@ class GetProcessMem
     return if lines.empty?
     lines.reduce(0) do |sum, line|
       line.match(/(?<value>(\d*\.{0,1}\d+))\s+(?<unit>\w\w)/) do |m|
-        value = BigDecimal.new(m[:value]) + ROUND_UP
+        value = number_to_bigdecimal(m[:value]) + ROUND_UP
         unit  = m[:unit].downcase
         sum  += CONVERSION[unit] * value
       end
@@ -87,11 +110,17 @@ class GetProcessMem
   # in low memory situations
   def ps_memory
     if RUNS_ON_WINDOWS
-      size = ProcTable.ps(pid).working_set_size
-      BigDecimal.new(size)
+      size = ProcTable.ps(pid: pid).working_set_size
+      number_to_bigdecimal(size)
     else
       mem = `ps -o rss= -p #{pid}`
-      KB_TO_BYTE * BigDecimal.new(mem == "" ? 0 : mem)
+      KB_TO_BYTE * number_to_bigdecimal(mem == "" ? 0 : mem)
     end
   end
+
+  def darwin_memory
+    Darwin.resident_size(pid)
+  rescue Errno::EPERM
+    nil
+  end
 end

data/lib/get_process_mem/darwin.rb

@@ -0,0 +1,63 @@
+require 'ffi'
+
+class GetProcessMem
+  class Darwin
+    extend FFI::Library
+    ffi_lib 'proc'
+
+
+    class TaskInfo < FFI::Struct
+      layout :pti_virtual_size, :uint64,
+             :pti_resident_size, :uint64,
+             :pti_total_user, :uint64,
+             :pti_total_system, :uint64,
+             :pti_threads_user, :uint64,
+             :pti_threads_system, :uint64,
+             :pti_policy, :int32,
+             :pti_faults, :int32,
+             :pti_pageins, :int32,
+             :pti_cow_faults, :int32,
+             :pti_messages_sent, :int32,
+             :pti_messages_received, :int32,
+             :pti_syscalls_mach, :int32,
+             :pti_syscalls_unix, :int32,
+             :pti_csw, :int32,
+             :pti_threadnum, :int32,
+             :pti_numrunning, :int32,
+             :pti_priority, :int32
+
+    end
+
+
+    attach_function :proc_pidinfo,
+                    [
+                      :int, #pid
+                      :int, # flavour
+                      :uint64, #arg, not needed for this selector
+                      TaskInfo.by_ref, #output buffer
+                      :int, #size of buffer
+                    ],
+                    :int
+
+
+    PROC_PIDTASKINFO = 4 #from sys/proc_info.h
+
+    class << self
+      def resident_size(pid)
+        get_proc_pidinfo(pid)[:pti_resident_size]
+      end
+
+      private
+
+      def get_proc_pidinfo(pid)
+        data = TaskInfo.new
+        result = proc_pidinfo(pid, PROC_PIDTASKINFO, 0, data, TaskInfo.size)
+        if result == TaskInfo.size
+          data
+        else
+          raise SystemCallError.new("proc_pidinfo returned #{result}", FFI.errno);
+        end
+      end
+    end
+  end
+end

data/lib/get_process_mem/version.rb

@@ -1,3 +1,3 @@
 class GetProcessMem
-  VERSION = "0.2.2"
+  VERSION = "0.2.7"
 end

data/test/get_process_mem_test.rb

@@ -1,11 +1,20 @@
 require 'test_helper'
 
 class GetProcessMemTest < Test::Unit::TestCase
-
   def setup
     @mem = GetProcessMem.new
   end
 
+  def test_different_pid_returns_different_memory
+    pid = Process.spawn("tail -f Gemfile")
+
+    other_mem = GetProcessMem.new(pid)
+    assert @mem.kb > other_mem.kb
+  ensure
+    Process.kill('TERM', pid) if pid
+    Process.wait(pid) if pid
+  end
+
   def test_seems_to_work
     assert @mem.kb    > 0
     assert @mem.mb    > 0
@@ -16,7 +25,7 @@ class GetProcessMemTest < Test::Unit::TestCase
   def test_linux_smap
     delta = 1
     bytes = @mem.linux_memory(fixture_path("heroku-bash-smap"))
-    assert_in_delta BigDecimal.new("2122240.0"), bytes, delta
+    assert_in_delta BigDecimal("2122240.0"), bytes, delta
   end
 
   def test_linux_status
@@ -26,7 +35,7 @@ class GetProcessMemTest < Test::Unit::TestCase
 
   def test_conversions
     bytes = 0
-    delta = BigDecimal.new("0.0000001")
+    delta = BigDecimal("0.0000001")
     assert_in_delta  0.0, @mem.kb(bytes), delta
     assert_in_delta  0.0, @mem.mb(bytes), delta
     assert_in_delta  0.0, @mem.gb(bytes), delta

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: get_process_mem
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.7
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: sys-proctable
+  name: ffi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '12'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '3'
 description: " Get memory usage of a process in Ruby "
 email:
 - richard.schneeman+rubygems@gmail.com
@@ -59,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/check_changelog.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -68,6 +83,7 @@ files:
 - appveyor.yml
 - get_process_mem.gemspec
 - lib/get_process_mem.rb
+- lib/get_process_mem/darwin.rb
 - lib/get_process_mem/version.rb
 - test/fixtures/heroku-bash-smap
 - test/fixtures/heroku-bash-status
@@ -77,7 +93,7 @@ homepage: https://github.com/schneems/get_process_mem
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Use GetProcessMem to find out the amount of RAM used by any process
 test_files: