sys-proctable 1.2.0 → 1.2.5

data/lib/darwin/sys/proctable.rb

@@ -26,6 +26,11 @@ module Sys
     MAXTHREADNAMESIZE = 64
     PROC_PIDPATHINFO_MAXSIZE = MAXPATHLEN * 4
 
+    # JRuby on Mac
+    unless defined? FFI::StructLayout::CharArray
+      FFI::StructLayout::CharArray = FFI::StructLayout::CharArrayProxy
+    end
+
     class ProcBsdInfo < FFI::Struct
       layout(
         :pbi_flags, :uint32_t,
@@ -174,66 +179,98 @@ module Sys
     #
     def self.ps(**kwargs)
       pid = kwargs[:pid]
-      raise TypeError unless pid.is_a?(Numeric) if pid
-
-      num = proc_listallpids(nil, 0)
-      ptr = FFI::MemoryPointer.new(:pid_t, num)
-      num = proc_listallpids(ptr, ptr.size)
-
-      raise SystemCallError.new('proc_listallpids', FFI.errno) if num == 0
-
-      pids  = ptr.get_array_of_int32(0, num).sort
-      array = block_given? ? nil : []
+      thread_info = kwargs[:thread_info]
 
-      pids.each do |lpid|
-        next unless pid == lpid if pid
+      if pid
+        raise TypeError unless pid.is_a?(Numeric)
         info = ProcTaskAllInfo.new
 
-        nb = proc_pidinfo(lpid, PROC_PIDTASKALLINFO, 0, info, info.size)
+        nb = proc_pidinfo(pid, PROC_PIDTASKALLINFO, 0, info, info.size)
 
         if nb <= 0
           if [Errno::EPERM::Errno, Errno::ESRCH::Errno].include?(FFI.errno)
-            next # Either we don't have permission, or the pid no longer exists
+            return # Either we don't have permission, or the pid no longer exists
           else
             raise SystemCallError.new('proc_pidinfo', FFI.errno)
           end
         end
 
-        # Avoid potentially invalid data
-        next if nb != info.size
+        return nil if nb != info.size # Invalid data
 
         struct = ProcTableStruct.new
 
         # Pass by reference
-        get_cmd_args_and_env(lpid, struct)
-        get_thread_info(lpid, struct, info[:ptinfo]) unless kwargs[:thread_info] == false
-
-        # Chop the leading xx_ from the FFI struct members for our ruby struct.
-        info.members.each do |nested|
-          info[nested].members.each do |member|
-            if info[nested][member].is_a?(FFI::StructLayout::CharArray)
-              struct[PROC_STRUCT_FIELD_MAP[member]] = info[nested][member].to_s
+        get_cmd_args_and_env(pid, struct)
+        get_thread_info(pid, struct, info[:ptinfo]) unless thread_info == false
+        apply_info_to_struct(info, struct)
+
+        struct.freeze
+        yield struct if block_given?
+        struct
+      else
+        num = proc_listallpids(nil, 0)
+        ptr = FFI::MemoryPointer.new(:pid_t, num)
+        num = proc_listallpids(ptr, ptr.size)
+
+        raise SystemCallError.new('proc_listallpids', FFI.errno) if num == 0
+
+        pids  = ptr.get_array_of_int32(0, num).sort
+        array = block_given? ? nil : []
+
+        pids.each do |lpid|
+          next unless pid == lpid if pid
+          info = ProcTaskAllInfo.new
+
+          nb = proc_pidinfo(lpid, PROC_PIDTASKALLINFO, 0, info, info.size)
+
+          if nb <= 0
+            if [Errno::EPERM::Errno, Errno::ESRCH::Errno].include?(FFI.errno)
+              next # Either we don't have permission, or the pid no longer exists
             else
-              struct[PROC_STRUCT_FIELD_MAP[member]] = info[nested][member]
+              raise SystemCallError.new('proc_pidinfo', FFI.errno)
             end
           end
-        end
 
-        struct.freeze
+          # Avoid potentially invalid data
+          next if nb != info.size
 
-        if block_given?
-          yield struct
-        else
-          array << struct
+          struct = ProcTableStruct.new
+
+          # Pass by reference
+          get_cmd_args_and_env(lpid, struct)
+          get_thread_info(lpid, struct, info[:ptinfo]) unless thread_info == false
+          apply_info_to_struct(info, struct)
+
+          struct.freeze
+
+          if block_given?
+            yield struct
+          else
+            array << struct
+          end
         end
-      end
 
-      return nil if array.nil?
-      pid ? array.first : array
+        array
+      end
     end
 
     private
 
+    # Pass by reference method that updates the Ruby struct based on the FFI struct.
+    #
+    def self.apply_info_to_struct(info, struct)
+      # Chop the leading xx_ from the FFI struct members for our ruby struct.
+      info.members.each do |nested|
+        info[nested].members.each do |member|
+          if info[nested][member].is_a?(FFI::StructLayout::CharArray)
+            struct[PROC_STRUCT_FIELD_MAP[member]] = info[nested][member].to_s
+          else
+            struct[PROC_STRUCT_FIELD_MAP[member]] = info[nested][member]
+          end
+        end
+      end
+    end
+
     # Returns an array of ThreadInfo objects for the given pid.
     #
     def self.get_thread_info(pid, struct, ptinfo)
@@ -253,7 +290,13 @@ module Sys
 
       0.upto(max-1) do |index|
         tinfo = ProcThreadInfo.new
-        nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_uint64, tinfo, tinfo.size)
+
+        # Use read_array_of_uint64 for compatibility with JRuby if necessary.
+        if buf[index].respond_to?(:read_uint64)
+          nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_uint64, tinfo, tinfo.size)
+        else
+          nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_array_of_uint64(1).first, tinfo, tinfo.size)
+        end
 
         if nb <= 0
           if [Errno::EPERM::Errno, Errno::ESRCH::Errno].include?(FFI.errno)

data/lib/linux/sys/proctable.rb

@@ -20,62 +20,67 @@ module Sys
     @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
+      '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
+      'num_threads',           # Number of threads in this process
+      '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 (old)
+      'rsslim',                # Current limit on the rss in bytes (current)
+      '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
+      'delayacct_blkio_ticks', # Aggregated block I/O delays
+      'guest_time',            # Guest time of the process
+      'cguest_time',           # Guest time of the process's children
+      '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
@@ -197,47 +202,51 @@ module Sys
 
         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
+        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
+        struct.num_threads           = stat[19].to_i
+        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 # Old name for backwards compatibility
+        struct.rsslim                = 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
+        struct.delayacct_blkio_ticks = stat[41].to_i
+        struct.guest_time            = stat[42].to_i
+        struct.cguest_time           = stat[43].to_i
 
         # Get /proc/<pid>/status information (name, uid, euid, gid, egid)
         begin

data/lib/sys/proctable/version.rb

@@ -1,6 +1,6 @@
 module Sys
   class ProcTable
     # The version of the sys-proctable library
-    VERSION = '1.2.0'.freeze
+    VERSION = '1.2.5'.freeze
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+RSpec.configure do |config|
+  config.filter_run_excluding :skip_jruby if RUBY_PLATFORM == 'java'
+end
+
+if RUBY_PLATFORM == 'java'
+  require 'ffi'
+  module Exec
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+    attach_function :fork, [], :int
+  end
+
+  def fork
+    pid = Exec.fork
+    if pid == 0
+      yield if block_given?
+      return nil
+    else
+      return pid
+    end
+  end
+end

data/spec/sys_proctable_all_spec.rb

@@ -16,7 +16,8 @@ describe Sys::ProcTable do
   end
 
   it "has a VERSION constant set to the expected value" do
-    expect(Sys::ProcTable::VERSION).to eql('1.2.0')
+    expect(Sys::ProcTable::VERSION).to eql('1.2.5')
+    expect(Sys::ProcTable::VERSION).to be_frozen
   end
 
   it "defines a custom error class" do

data/spec/sys_proctable_darwin_spec.rb

@@ -87,30 +87,30 @@ describe Sys::ProcTable do
       expect(subject.svgid).to eql(Process.gid)
     end
 
-    it "contains a comm member and returns the expected value" do
+    it "contains a comm member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:comm)
       expect(subject.comm).to be_kind_of(String)
       expect(subject.comm).to eql('sleep')
     end
 
-    it "contains a cmdline member and returns the expected value" do
+    it "contains a cmdline member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:cmdline)
       expect(subject.cmdline).to be_kind_of(String)
       expect(subject.cmdline).to eql('sleep 60')
     end
 
-    it "returns a string with the expected arguments for the cmdline member" do
+    it "returns a string with the expected arguments for the cmdline member", :skip_jruby do
       ptable = Sys::ProcTable.ps(pid: @pid2)
       expect(ptable.cmdline).to eql('ruby -Ilib -e sleep \'120\'.to_i -- foo bar')
     end
 
-    it "contains an exe member and returns the expected value" do
+    it "contains an exe member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:exe)
       expect(subject.exe).to be_kind_of(String)
       expect(subject.exe).to eql(`which sleep`.chomp)
     end
 
-    it "contains an environ member and returns the expected value" do
+    it "contains an environ member and returns the expected value", :skip_jruby do
       expect(subject).to respond_to(:environ)
       expect(subject.environ).to be_kind_of(Hash)
       expect(subject.environ['A']).to eql('B')