sys-proctable 0.9.9-universal-linux → 1.0.0-universal-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0f13537cd8a33add0739cb78526d05006bc6aa5
-  data.tar.gz: 18433abb3f9dd310603bc9633ec2d55e24025c87
+  metadata.gz: 6d0b0a05d36c394362b0da61c6996ee92c98f5cf
+  data.tar.gz: 6f93ad7718224d50c60010375a0d7fa72ab8df2d
 SHA512:
-  metadata.gz: c9824df5d678bb2cfc4aaa3f8fc202b0acca08d6498d9798b97e51e4b3d9a789e0417be6dcfc4c90cb0cc340a6a3f1b2906897864411a4fe7ff800cb3676da44
-  data.tar.gz: bef2ef2d8b351d42065327e10bcba67e0334d4a7dc758ba5d789754301382d9eab6fa4fa123bb7bf4db33f85e6b868b9c665e30e71c78f6a128295b09c36298f
+  metadata.gz: 8bbd13a460d6b1fa732b9a36466de419dc5f79c9d55b879d5949a77b6faf70b983cd0d4902705c3befdb984fcb02f86235c6d2a161152188a8a05344d8997686
+  data.tar.gz: b064d160df07a3734ddce2758bfefca86c7dd360e9de948e62b915592035479981fa13fc3e36b64addcebe65ae5cfd2a21841cd92ba4a1e44c2c022db7acd8fb

data/CHANGES

@@ -1,3 +1,7 @@
+== 1.0.0 - 11-Jan-2016
+* Added smaps information for Linux. Thanks go to Joe Rafaniello for the patch.
+* This is not really a major release. I just ran out of version numbers.
+
 == 0.9.9 - 8-Nov-2015
 * Added support for cgroups on Linux. Thanks go to Dennis Günnewig for the patch.
 * Added a sys-proctable.rb file for convenience.

data/README

@@ -105,7 +105,7 @@
   Artistic 2.0
     
 == Copyright
-  (C) 2003-2015 Daniel J. Berger
+  (C) 2003-2016 Daniel J. Berger
   All Rights Reserved.
 
 == Contributions

data/Rakefile

@@ -166,7 +166,7 @@ namespace :gem do
       when /linux/i
          spec.platform = Gem::Platform.new(['universal', 'linux'])
          spec.require_paths = ['lib', 'lib/linux']
-         spec.files += ['lib/linux/sys/proctable.rb', 'lib/linux/sys/proctable/cgroup_entry.rb']
+         spec.files += ['lib/linux/sys/proctable.rb', 'lib/linux/sys/proctable/cgroup_entry.rb', 'lib/linux/sys/proctable/smaps.rb']
          spec.test_files << 'test/test_sys_proctable_linux.rb'
       when /sunos|solaris/i
          spec.platform = Gem::Platform.new(['universal', 'solaris'])

data/lib/linux/sys/proctable.rb

@@ -1,5 +1,6 @@
 require 'sys/proctable/version'
 require_relative 'proctable/cgroup_entry'
+require_relative 'proctable/smaps'
 
 # The Sys module serves as a namespace only.
 module Sys
@@ -73,7 +74,8 @@ module Sys
       'pctcpu',      # Percent of CPU usage (custom field)
       'pctmem',      # Percent of Memory usage (custom field)
       'nlwp',        # Number of Light-Weight Processes associated with the process (threads)
-      'cgroup'       # Control groups to which the process belongs
+      'cgroup',      # Control groups to which the process belongs
+      'smaps'        # Process memory size for all mapped files
     ]
 
     public
@@ -169,6 +171,13 @@ module Sys
         # Get control groups to which the process belongs
         struct.cgroup = IO.readlines("/proc/#{file}/cgroup").map { |l| CgroupEntry.new(l) } rescue []
 
+        # Read smaps, returning a parsable string if we don't have permissions.
+        # Note: We're blindly rescuing because File.readable?/readable_real?
+        # are true for a file in the /proc fileystem but raises a ErrNo:EACCESS
+        # when your try to read it without permissions.
+        smaps_contents = IO.read("/proc/#{file}/smaps") rescue ""
+        struct.smaps = Smaps.new(file, smaps_contents)
+
         # Deal with spaces in comm name. Courtesy of Ara Howard.
         re = %r/\([^\)]+\)/
         comm = stat[re]

data/lib/linux/sys/proctable/cgroup_entry.rb

@@ -3,7 +3,7 @@ module Sys
     # This represents a cgroup entry
     #
     # Have a look at `man 5 proc` on a linux distribution, to get some more
-    # information about the lines and there fields in `/proc/[pid]/cgroup`.
+    # information about the lines and their fields in `/proc/[pid]/cgroup`.
     #
     # Example:
     #

data/lib/linux/sys/proctable/smaps.rb

@@ -0,0 +1,118 @@
+module Sys
+  class ProcTable
+    # Smaps represents a process' memory size for all mapped files
+    #
+    # A single mapped file memory entry looks like this:
+    #
+    #   00400000-004d4000 r-xp 00000000 fd:00 785                      /bin/bash
+    #   Size:                848 kB
+    #   Rss:                 572 kB
+    #   Pss:                 572 kB
+    #   Shared_Clean:          0 kB
+    #   Shared_Dirty:          0 kB
+    #   Private_Clean:       572 kB
+    #   Private_Dirty:         0 kB
+    #   Referenced:          572 kB
+    #   Anonymous:             0 kB
+    #   AnonHugePages:         0 kB
+    #   Swap:                  0 kB
+    #   KernelPageSize:        4 kB
+    #   MMUPageSize:           4 kB
+    #
+    # Have a look at `man 5 proc` on a linux distribution, to get some more
+    # information about the lines and fields in `/proc/[pid]/smaps`.
+    #
+    # Example:
+    #
+    #   smaps = Smaps.new(123, IO.read("/proc/1234/smaps")
+    #     => #<Sys::ProcTable::Smaps:0x007f8ac5930768 @pid=123, @pss=107000, @rss=368000, @uss=96000, @swap=192000, @vss=136752000>
+    #   smaps.pss  # => 109568
+    #   smaps.rss  # => 376832
+    #   smaps.uss  # => 98304
+    #   smaps.swap # => 196608
+    #   smaps.vss  # => 140034048
+    #
+    class Smaps
+
+      # Process ID for this smaps
+      attr_reader :pid
+
+      # Proportional set size
+      #
+      # PSS is the size of private pages added to each shared mapping's size
+      # divided by the number of processes that share it.  It is meant to
+      # provide a better representation of the amount of memory actually used
+      # by a process.
+      #
+      # If a process has 4k of private pages, 4k of shared pages shared with one
+      # other process, and 3k of pages shared with two other processes, the PSS
+      # is:
+      #
+      # 4k + (4k / 2) + (3k / 3) = 7k
+      #
+      attr_reader :pss
+      alias_method :proportional_set_size, :pss
+
+      # Resident set size
+      #
+      # RSS is the total size of all pages, shared or not, mapped to a process.
+      attr_reader :rss
+      alias_method :resident_set_size, :rss
+
+      # Unique set size
+      #
+      # USS is the total size of all private pages mapped to a process.
+      attr_reader :uss
+      alias_method :unique_set_size, :uss
+
+      # Swap
+      #
+      # Swap is the total size of all swapped pages mapped to a process.
+      attr_reader :swap
+
+      # Virtual set size
+      #
+      # VSS is the total accessible address space in a process.  Since files are
+      # lazily loaded, this value represents the total size of all mapped files
+      # if they were all loaded.
+      attr_reader :vss
+      alias_method :virtual_set_size, :vss
+
+      # Create a new smaps object
+      #
+      #
+      # This expects a process id and a string containing the contents of
+      # /proc/PID/smaps - see `man 5 proc` for a reference.
+      #
+      # The smaps contents are parsed and memory sizes are calculated in bytes.
+      def initialize(pid, smaps_contents)
+        @pid            = pid
+        @pss            = 0
+        @rss            = 0
+        @uss            = 0
+        @swap           = 0
+        @vss            = 0
+        smaps_contents.each_line { |line| parse_smaps_line(line) }
+      end
+
+      alias_method :to_s, :inspect
+
+      private
+
+      def parse_smaps_line(line)
+        case line
+        when /^Pss:\s+?(\d+)/
+          @pss += Regexp.last_match[1].to_i * 1000
+        when /^Rss:\s+?(\d+)/
+          @rss += Regexp.last_match[1].to_i * 1000
+        when /^Size:\s+?(\d+)/
+          @vss += Regexp.last_match[1].to_i * 1000
+        when /^Swap:\s+?(\d+)/
+          @swap += Regexp.last_match[1].to_i * 1000
+        when /^Private_(Clean|Dirty):\s+?(\d+)/
+          @uss += Regexp.last_match[2].to_i * 1000
+        end
+      end
+    end
+  end
+end

data/lib/sys/proctable/version.rb

@@ -1,6 +1,6 @@
 module Sys
   class ProcTable
     # The version of the sys-proctable library
-    VERSION = '0.9.9'
+    VERSION = '1.0.0'
   end
 end

data/sys-proctable.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-proctable'
-  spec.version    = '0.9.9'
+  spec.version    = '1.0.0'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Artistic 2.0' 
   spec.email      = 'djberg96@gmail.com'

data/test/test_sys_proctable_all.rb

@@ -19,7 +19,7 @@ class TC_ProcTable_All < Test::Unit::TestCase
   end
 
   def test_version
-    assert_equal('0.9.9', ProcTable::VERSION)
+    assert_equal('1.0.0', ProcTable::VERSION)
   end
 
   def test_fields

data/test/test_sys_proctable_linux.rb

@@ -17,7 +17,7 @@ class TC_ProcTable_Linux < Test::Unit::TestCase
       stime cutime cstime priority nice itrealvalue starttime vsize
       rss rlim startcode endcode startstack kstkesp kstkeip signal blocked
       sigignore sigcatch wchan nswap cnswap exit_signal processor environ
-      pctcpu pctmem nlwp cgroup
+      pctcpu pctmem nlwp cgroup smaps
       /
   end
 
@@ -301,6 +301,11 @@ class TC_ProcTable_Linux < Test::Unit::TestCase
     assert_kind_of(ProcTable::CgroupEntry, @ptable.cgroup.first)
   end
 
+  def test_smaps
+    assert_respond_to(@ptable, :smaps)
+    assert_kind_of(ProcTable::Smaps, @ptable.smaps)
+  end
+
   def teardown
     @ptable = nil
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-proctable
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0
 platform: universal-linux
 authors:
 - Daniel J. Berger
@@ -30,7 +30,7 @@ cert_chain:
   EJYzxdPOrx2n6NYR3Hk+vHP0U7UBSveI6+qx+ndQYaeyCn+GRX2PKS9h66YF/Q1V
   tGSHgAmcLlkdGgan182qsE/4kKM=
   -----END CERTIFICATE-----
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2016-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -89,6 +89,7 @@ files:
 - test/test_sys_proctable_all.rb
 - lib/linux/sys/proctable.rb
 - lib/linux/sys/proctable/cgroup_entry.rb
+- lib/linux/sys/proctable/smaps.rb
 homepage: http://github.com/djberg96/sys-proctable
 licenses:
 - Artistic 2.0
@@ -110,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: An interface for providing process table information