sys-proctable 0.7.6 → 1.2.0

data/lib/linux/sys/proctable.rb

@@ -0,0 +1,314 @@
+require 'sys/proctable/version'
+require_relative 'proctable/cgroup_entry'
+require_relative 'proctable/smaps'
+
+# The Sys module serves as a namespace only.
+module Sys
+
+  # The ProcTable class encapsulates process table information.
+  class ProcTable
+
+    # Error typically raised if the ProcTable.ps method fails.
+    class Error < StandardError; end
+
+    # There is no constructor
+    private_class_method :new
+
+    private
+
+    @mem_total = IO.read("/proc/meminfo")[/MemTotal.*/].split[1].to_i * 1024 rescue nil
+    @boot_time = IO.read("/proc/stat")[/btime.*/].split.last.to_i rescue nil
+
+    @fields = [
+      'cmdline',     # Complete command line
+      'cwd',         # Current working directory
+      'environ',     # Environment
+      'exe',         # Actual pathname of the executed command
+      'fd',          # File descriptors open by process
+      'root',        # Root directory of process
+      'pid',         # Process ID
+      'comm',        # Filename of executable
+      'state',       # Single character state abbreviation
+      'ppid',        # Parent process ID
+      'pgrp',        # Process group
+      'session',     # Session ID
+      'tty_nr',      # TTY (terminal) associated with the process
+      'tpgid',       # Group ID of the TTY
+      'flags',       # Kernel flags
+      'minflt',      # Number of minor faults
+      'cminflt',     # Number of minor faults of waited-for children
+      'majflt',      # Number of major faults
+      'cmajflt',     # Number of major faults of waited-for children
+      'utime',       # Number of user mode jiffies
+      'stime',       # Number of kernel mode jiffies
+      'cutime',      # Number of children's user mode jiffies
+      'cstime',      # Number of children's kernel mode jiffies
+      'priority',    # Nice value plus 15
+      'nice',        # Nice value
+      'itrealvalue', # Time in jiffies before next SIGALRM
+      'starttime',   # Time in jiffies since system boot
+      'vsize',       # Virtual memory size in bytes
+      'rss',         # Resident set size
+      'rlim',        # Current limit on the rss in bytes
+      'startcode',   # Address above which program text can run
+      'endcode',     # Address below which program text can run
+      'startstack',  # Address of the startstack
+      'kstkesp',     # Kernel stack page address
+      'kstkeip',     # Kernel instruction pointer
+      'signal',      # Bitmap of pending signals
+      'blocked',     # Bitmap of blocked signals
+      'sigignore',   # Bitmap of ignored signals
+      'sigcatch',    # Bitmap of caught signals
+      'wchan',       # Channel in which the process is waiting
+      'nswap',       # Number of pages swapped
+      'cnswap',      # Cumulative nswap for child processes
+      'exit_signal', # Signal to be sent to parent when process dies
+      'processor',   # CPU number last executed on
+      'rt_priority', # Real time scheduling priority
+      'policy',      # Scheduling policy
+      'name',        # Process name
+      'uid',         # Real user ID
+      'euid',        # Effective user ID
+      'gid',         # Real group ID
+      'egid',        # Effective group ID
+      '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
+      'smaps'        # Process memory size for all mapped files
+    ]
+
+    public
+
+    ProcTableStruct = Struct.new('ProcTableStruct', *@fields)
+
+    # In block form, yields a ProcTableStruct for each process entry that you
+    # have rights to. This method returns an array of ProcTableStruct's in
+    # non-block form.
+    #
+    # If a +pid+ is provided, then only a single ProcTableStruct is yielded or
+    # returned, or nil if no process information is found for that +pid+.
+    #
+    # Example:
+    #
+    #   # Iterate over all processes
+    #   ProcTable.ps do |proc_info|
+    #      p proc_info
+    #   end
+    #
+    #   # Print process table information for only pid 1001
+    #   p ProcTable.ps(pid: 1001)
+    #
+    #   # Skip smaps collection and/or cgroup collection
+    #   p ProcTable.ps(smaps: false, cgroup: false)
+    #
+    #--
+    #  It's possible that a process could terminate while gathering
+    #  information for that process. When that happens, this library
+    #  will simply skip to the next record. In short, this library will
+    #  either return all information for a process, or none at all.
+    #
+    def self.ps(**kwargs)
+      pid    = kwargs[:pid]
+      smaps  = kwargs[:smaps]
+      cgroup = kwargs[:cgroup]
+
+      array  = block_given? ? nil : []
+      struct = nil
+
+      raise TypeError unless pid.is_a?(Numeric) if pid
+
+      Dir.foreach("/proc"){ |file|
+        next if file =~ /\D/ # Skip non-numeric directories
+        next unless file.to_i == pid if pid
+
+        struct = ProcTableStruct.new
+
+        # Get /proc/<pid>/cmdline information. Strip out embedded nulls.
+        begin
+          data = IO.read("/proc/#{file}/cmdline").tr("\000", ' ').strip
+          struct.cmdline = data
+        rescue
+          next # Process terminated, on to the next process
+        end
+
+        # Get /proc/<pid>/cwd information
+        struct.cwd = File.readlink("/proc/#{file}/cwd") rescue nil
+
+        # Get /proc/<pid>/environ information. Environment information
+        # is represented as a Hash, with the environment variable as the
+        # key and its value as the hash value.
+        struct.environ = {}
+
+        begin
+          IO.read("/proc/#{file}/environ").split("\0").each{ |str|
+            key, value = str.split('=')
+            struct.environ[key] = value
+          }
+        rescue Errno::EACCES, Errno::ESRCH, Errno::ENOENT
+          # Ignore and move on.
+        end
+
+        # Get /proc/<pid>/exe information
+        struct.exe = File.readlink("/proc/#{file}/exe") rescue nil
+
+        # Get /proc/<pid>/fd information. File descriptor information
+        # is represented as a Hash, with the fd as the key, and its
+        # symlink as the value.
+        struct.fd = {}
+
+        begin
+          Dir["/proc/#{file}/fd/*"].each do |fd|
+            struct.fd[File.basename(fd)] = File.readlink(fd) rescue nil
+          end
+        rescue
+          # Ignore and move on
+        end
+
+        # Get /proc/<pid>/root information
+        struct.root = File.readlink("/proc/#{file}/root") rescue nil
+
+        # Get /proc/<pid>/stat information
+        stat = IO.read("/proc/#{file}/stat") rescue next
+
+        # Get number of LWP, one directory for each in /proc/<pid>/task/
+        # Every process has at least one thread, so if we fail to read the task directory, set nlwp to 1.
+        struct.nlwp = Dir.glob("/proc/#{file}/task/*").length rescue struct.nlwp = 1
+
+        # Get control groups to which the process belongs
+        unless cgroup == false
+          struct.cgroup = IO.readlines("/proc/#{file}/cgroup").map { |l| CgroupEntry.new(l) } rescue []
+        end
+
+        # 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.
+        unless smaps == false
+          smaps_contents = IO.read("/proc/#{file}/smaps") rescue ""
+          struct.smaps = Smaps.new(file, smaps_contents)
+        end
+
+        # Deal with spaces in comm name. Courtesy of Ara Howard.
+        re = %r/\([^\)]+\)/
+        comm = stat[re]
+        comm.tr!(' ', '-')
+        stat[re] = comm
+
+        stat = stat.split
+
+        struct.pid         = stat[0].to_i
+        struct.comm        = stat[1].tr('()','') # Remove parens
+        struct.state       = stat[2]
+        struct.ppid        = stat[3].to_i
+        struct.pgrp        = stat[4].to_i
+        struct.session     = stat[5].to_i
+        struct.tty_nr      = stat[6].to_i
+        struct.tpgid       = stat[7].to_i
+        struct.flags       = stat[8].to_i
+        struct.minflt      = stat[9].to_i
+        struct.cminflt     = stat[10].to_i
+        struct.majflt      = stat[11].to_i
+        struct.cmajflt     = stat[12].to_i
+        struct.utime       = stat[13].to_i
+        struct.stime       = stat[14].to_i
+        struct.cutime      = stat[15].to_i
+        struct.cstime      = stat[16].to_i
+        struct.priority    = stat[17].to_i
+        struct.nice        = stat[18].to_i
+        # Skip 19
+        struct.itrealvalue = stat[20].to_i
+        struct.starttime   = stat[21].to_i
+        struct.vsize       = stat[22].to_i
+        struct.rss         = stat[23].to_i
+        struct.rlim        = stat[24].to_i
+        struct.startcode   = stat[25].to_i
+        struct.endcode     = stat[26].to_i
+        struct.startstack  = stat[27].to_i
+        struct.kstkesp     = stat[28].to_i
+        struct.kstkeip     = stat[29].to_i
+        struct.signal      = stat[30].to_i
+        struct.blocked     = stat[31].to_i
+        struct.sigignore   = stat[32].to_i
+        struct.sigcatch    = stat[33].to_i
+        struct.wchan       = stat[34].to_i
+        struct.nswap       = stat[35].to_i
+        struct.cnswap      = stat[36].to_i
+        struct.exit_signal = stat[37].to_i
+        struct.processor   = stat[38].to_i
+        struct.rt_priority = stat[39].to_i
+        struct.policy      = stat[40].to_i
+
+        # Get /proc/<pid>/status information (name, uid, euid, gid, egid)
+        begin
+          IO.foreach("/proc/#{file}/status") do |line|
+            case line
+              when /Name:\s*?(\w+)/
+                struct.name = $1
+              when /Uid:\s*?(\d+)\s*?(\d+)/
+                struct.uid  = $1.to_i
+                struct.euid = $2.to_i
+              when /Gid:\s*?(\d+)\s*?(\d+)/
+                struct.gid  = $1.to_i
+                struct.egid = $2.to_i
+            end
+          end
+        rescue Errno::ESRCH, Errno::ENOENT
+          next
+        end
+
+        # If cmdline is empty use comm instead
+        struct.cmdline = struct.comm if struct.cmdline.empty?
+
+        # Manually calculate CPU and memory usage
+        struct.pctcpu = get_pctcpu(struct.utime, struct.starttime)
+        struct.pctmem = get_pctmem(struct.rss)
+
+        struct.freeze # This is read-only data
+
+        if block_given?
+          yield struct
+        else
+          array << struct
+        end
+      }
+
+      pid ? struct : array
+    end
+
+    # Returns an array of fields that each ProcTableStruct will contain. This
+    # may be useful if you want to know in advance what fields are available
+    # without having to perform at least one read of the /proc table.
+    #
+    # Example:
+    #
+    #   Sys::ProcTable.fields.each{ |field|
+    #      puts "Field: #{field}"
+    #   }
+    #
+    def self.fields
+      @fields
+    end
+
+    private
+
+    # Calculate the percentage of memory usage for the given process.
+    #
+    def self.get_pctmem(rss)
+      return nil unless @mem_total
+      page_size = 4096
+      rss_total = rss * page_size
+      sprintf("%3.2f", (rss_total.to_f / @mem_total) * 100).to_f
+    end
+
+    # Calculate the percentage of CPU usage for the given process.
+    #
+    def self.get_pctcpu(utime, start_time)
+      return nil unless @boot_time
+      hertz = 100.0
+      utime = (utime * 10000).to_f
+      stime = (start_time.to_f / hertz) + @boot_time
+      sprintf("%3.2f", (utime / 10000.0) / (Time.now.to_i - stime)).to_f
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+module Sys
+  class ProcTable
+    # 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 their fields in `/proc/[pid]/cgroup`.
+    #
+    # Example:
+    #
+    #   entry = CgroupEntry.new '7:devices:/init.scope'
+    #   entry.hierarchy_id  # => 7
+    #   entry.subsystems    # => ['devices']
+    #   entry.control_group # => '/init.scope'
+    #
+    class CgroupEntry
+      # Create a new cgroup entry object
+      #
+      # This expects a string of '7:devices:/init.scope' - see `man 5 proc` for a
+      # reference.
+      def initialize(string)
+        @string = string.chomp
+        @fields = @string.split(/:/)
+      rescue
+        @fields = []
+      end
+
+      # This returns the hierarchy id of the cgroup entry
+      def hierarchy_id
+        @fields[0].to_i
+      end
+
+      # Return sets of subsystems bound to the hierarchy
+      def subsystems
+        @fields[1].split(/,/)
+      rescue
+        []
+      end
+
+      # control group in the hierarchy to which the process belongs
+      def control_group
+        @fields[2]
+      end
+
+      # Return the line itself
+      def to_s
+        @string
+      end
+    end
+  end
+end

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