sys-proctable 0.8.0-x86-linux

data/CHANGES

@@ -0,0 +1,260 @@
+== 0.8.0 - 26-Jan-2009
+* The Linux and Solaris versions of this library are now pure Ruby. Be warned,
+  however, that only Solaris 8 and later are now supported. This may change
+  in a future release if there's demand to support 2.6 and 2.7.
+* Some Struct::ProcTableStruct members have changed. As a general rule they
+  now more closely match the C struct member name. See individual platforms
+  for more details.
+* Bug fix for the cmd_args struct member on Solaris.
+* Bug fixes for OS X. Added a VERSION constant, fixed struct name, and changed
+  pct_cpu to pctcpu.
+* The .new method is now explicitly illegal.
+* The Struct::ProcTableStruct instances are now frozen. This is read-only data.
+* Added the peak_page_file_usage and status members on MS Windows. The status
+  member is always nil, but was added for completeness.
+* Fixed the quota_peak_paged_pool_usage member on MS Windows.
+* ProcTableError is now ProcTable::Error.
+* Minor test case fix for kvm/bsd based versions.
+* Added the 'time' library as a require for Windows (to parse MS date/time
+  format strings).
+* The kvm (bsd.c) implementation now works for FreeBSD 7.
+* Added many more tests.
+* Added some benchmarking code in the 'benchmarks' directory.
+* Added a 'bench' Rake task.
+* Renamed the test_ps.rb file to example_ps.rb in order to avoid any possible
+  confusion with actual test files.
+* Added an 'example' rake task to run the example file.
+
+== 0.7.6 - 11-Jul-2007
+* Fixed the starttime for Linux. Thanks go to Yaroslav Dmitriev for the spot.
+* Fixed a bug in the MS Windows version within a private method that parsed
+  an MS specific date format. This was caused by a backwards incompatible
+  change in the Time.parse method in Ruby 1.8.6. See ruby-core: 11245 ff.
+* Fixed the gemspec (I hope). Please let me know if you have problems.
+* Added a Rakefile. Building, testing and installing should now be handled via
+  Rake tasks. The install.rb file has been removed - that code is now
+  integrated in the Rakefile.
+* Minor directory layout changes and cleanup (mostly for the extconf.rb file).
+* Side note - it seems that the code for OS X *does* work, at least on 10.4.10.
+  I can only conclude that previous reports about it failing were related to
+  bugs in OS X or were really just build issues. Apologies (and thanks, again)
+  to David Felstead for the code. However, see the README for more information
+  specific to OS X, as there are shortcomings.
+
+== 0.7.5 - 23-Nov-2006
+* Fixed int/long issues for Linux. Thanks go to Matt Lightner for the spot.
+* Minor documentation fixes and changes to the extconf.rb file.
+
+== 0.7.4 - 20-Nov-2006
+* Added a patch that deals with the large file compilation issue on Solaris.
+  You no longer need to build Ruby with --disable-largefile, or build a
+  64 bit Ruby, in order for this package to work.  Thanks go to Steven Jenkins
+  for the information that led to the patch.
+* Added inline rdoc to the source code.
+* Added a gemspec.
+* Fixed some potential 64 bit issues (struct declarations).
+* Added preliminary support for Darwin (OS X). The code was provided by
+  David Felstead, but does not appear to compile successfully.  Help wanted.
+
+== 0.7.3 - 27-Oct-2005
+* Fix for 1.8.3 and later (rb_pid_t). This should have only affected
+  Solaris.
+
+== 0.7.2 - 15-May-2005
+* Bug fix for the FreeBSD version that reads from /proc.
+* Eliminated the test bug on Linux (inexplicably caused by File.copy).  The
+  test suite should now run without segfaulting.
+* Include bsd.c in tarball (oops).
+* Minor test updates for FreeBSD.
+* The 'pct_cpu' member for the BSD/kvm version has been changed to 'pctcpu'
+  for consistency with other platforms.
+
+== 0.7.1 - 8-May-2005
+* Bug fixed for the cmdline info on Linux.  Thanks go to Arash Abedinzadeh
+  for the spot.
+* Added an example program.
+* Minor setup fix for Win32 in tc_all.rb.
+
+== 0.7.0 - 25-Apr-2005
+* Scrapped the C implementation for Windows in favor of an OLE + WMI pure Ruby
+  approach.  See documentation for details.
+* Added an optional lkvm implementation for BSD users.  This is automatically
+  used if the /proc filesystem isn't found.
+* Added prusage info for the Solaris version.
+* Added name, eid, euid, gid and guid information for Linux.  Thanks go to
+  James Hranicky for the patch.
+* Fixed some potential bugs in the Linux version.  Thanks go to James
+  Hranicky for the spot.
+* Added the 'sys/top' package.
+* ProcTable.fields no longer supports a block form.
+* The BTIME (boot time) information has been removed from the Linux version.
+  If you want that information, use sys-uptime instead.
+* The .html and .rd files have been removed.  You can generate html on your
+  own with rdoc if you like.
+* Some code cleanup on the C side of the house.
+* Most documents made rdoc friendly.
+* Renamed 'install_pure_ruby.rb' to just 'install.rb'.
+* Removed the 'INSTALL' file.  Installation instructions are in the README.
+* Some test suite cleanup and reorganization.
+* Moved project to RubyForge.
+
+== 0.6.4 - 31-Mar-2004
+* Fixed a bug in the pure Ruby version for Win32.  Thanks go to Mark Hudson
+  for the spot.
+* Fixed a bug in the C implementation for Win32 where the cmdline and path
+  values were sometimes wrong for running processes.  Thanks go to Park Heesob
+  for the fix.
+* Updated the VERSION constant and removed the VERSION class method in the
+  pure Ruby version for Win32.
+* Updated install_pure_ruby.rb and test.rb scripts.
+* Updated warranty information.
+* The extconf.rb script has been revamped.  See the INSTALL and README files
+  for important changes since the last release.
+* The start ProcInfo struct member on Solaris, HP-UX and FreeBSD is now a
+  Time object, not a Fixnum/Bignum.
+* Modified linux.c yet again to make gcc happy when it comes to multi-line
+  string literals.
+* Minor change to way process state is handled on HP-UX.
+* Documentation additions and updates, including warranty information.
+
+== 0.6.3 - 24-Feb-2004
+* Fixed a bug in the Solaris version where the cmd_args array did not
+  necessarily contain data on 2.7 and later.  The current patch still
+  does not quite fix the problem for 2.6 and earlier but can be easily
+  derived manually by parsing the cmdline string.
+
+== 0.6.2 - 20-Jan-2004
+* Fixed a small memory leak in the solaris version.
+
+== 0.6.1 - 31-Dec-2003
+* Fixed a minor bug in the cmdline field on Linux where a blank character
+  was being appended to the end of the field.
+* Fixed a minor annoyance where the windows.rb file was being copied into
+  the Ruby lib directory on install.
+* Added a test_memleak.rb file.  Currently only supported on Linux and
+  only does a file descriptor count check.  I plan to expand this to
+  other platforms in the future.
+* Minor test suite changes
+* MANIFEST correction and update.
+
+== 0.6.0 - 22-Oct-2003
+* Significant API change (and thus, a version jump) - only a
+  single argument is now accepted to the ps() method, and only a PID
+  (Fixnum) is regarded as a valid argument.
+* Calling ps() with a pid returns a single ProcTable struct (or nil
+  if the pid is not found), instead of a one element array.
+* Argument to ps() now works properly on HP-UX and Win32.
+* Removed the '#include <sys/types32.h>' in sunos.h.  It wasn't needed
+  and you're not supposed to include it directly.
+* Fixed 2.6 compatibility issue with regards to cmdline on Solaris.
+* Removed the ProcStatException completely on Linux.  There was no reason
+  to fail on a directory read for /proc/xxx/stat.  If the read fails
+  (meaning the process died in the middle of collecting info for it), it
+  is simply ignored.
+* The ttynum bug on HPUX has been fixed.  In addition, the return value for
+  this field is now a string rather than an int and the field name has
+  been changed to "ttydev".
+* The ttynum field has been changed to ttydev on Solaris and HPUX.  On
+  Solaris, the ttydev is now reported as -1 if there is no associated tty.
+  In a future release, Solaris and the other *nix platforms will be changed 
+  so that ttydev is always a device name (i.e String).
+* Added plain text documentation for all platforms.
+* Some test suite cleanup.
+* Changed .rd2 extension to just '.rd'.
+
+== 0.5.2 - 18-Jul-2003
+* Modified cmdline to extend past the traditional 80 character limit on
+  Solaris, where possible (Solaris 2.6+ only).
+* Added the cmdline_args and num_args fields on Solaris, which returns
+  an array of cmdline arguments and the number of cmdline arguments,
+  respectively.
+* Minor modification to fields() method, in addition to warning cleanup
+  for Solaris.
+* Changed "defunct" state string to "zombie" for Solaris.
+* Should cleanly compile with -Wall -W now (gcc) on Solaris.
+* Added solaris.txt to doc directory.
+* MANIFEST corrections.
+
+== 0.5.1 - 16-Jul-2003
+* Fixed a nasty file descriptor bug in the Linux code, where file descriptors
+  were continuously being used up.
+* Added the BTIME (boot time) constant for Linux.
+* Fixed up the test/test.rb file a bit.
+* Added BTIME tests to tc_linux.rb.
+
+== 0.5.0 - 11-Jul-200
+* Added HP-UX support!
+* Note that passing PID's or strings as arguments to ps() is not supported
+  in the HP-UX version.  This functionality will be stripped out of the
+  other versions in a future release.  See the README file for more details.
+* Removed the VERSION() class method.  Use the constant instead.
+* Separated the rd docs from their respective source files.  Now in the doc
+  directory.
+* Got rid of the interactive html generation in extconf.rb.
+* Changed License to Artistic.
+
+== 0.4.3 - 30-May-2003
+* Added a version.h file to store the version number. Modified all of the
+  C source files to use that instead of hard coding the version everywhere.
+* Added a generic test.rb script for those without TestUnit installed, or
+  just futzing in general.  Modified the extconf.rb script to copy this
+  instead of writing an inline HERE document.
+* Modified extconf.rb so that it builds with mingw or cygwin.  Thanks go to
+  Peter Fischer for the spot and patch.
+* Modified test suite to work with TestUnit 0.1.6 or 0.1.8.
+
+== 0.4.2 - 14-Apr-2003
+* Added pure Ruby version for Win32 - thanks Park Heesob.
+* Modified extconf.rb file to handle pure Ruby versions.
+* Added install_pure_ruby.rb file, an alternate installation
+  script for pure Ruby versions.
+
+== 0.4.1 - 31-Mar-2003
+* Added support for Solaris 2.5.x.
+* All exceptions are now a direct subclass of StandardError.
+* Value returned for wchan now more meaningful (2.5.x only for now).
+* Fixed the start, utime and ctime for FreeBSD.
+* Minor fix to FreeBSD test suite.
+* Some changes to extconf.rb.
+* Minor doc changes.
+* Added License and Copyright info.
+
+== 0.4.0 - 10-Mar-2003
+* Added MS Windows support (non-cygwin).
+* Added environment information for Linux version.
+* Added real exceptions (type depends on platform).
+* Added a test suite (for those with testunit installed).
+* Removed the sys-uname requirement.
+* Heavily modified the extconf.rb script.
+* Changed "Changelog" to "CHANGES" and "Manifest" to "MANIFEST".
+* Added a VERSION constant and class method.
+* Minor internal directory layout change (put 'os' under 'lib').
+* Changed package name to lower case.
+* Doc changes, including license information.
+
+== 0.3.1 - 16-Aug-2002
+* Added a "comm" field to the sunos version.  I am going to try to make this a
+  common field for all platforms to help reduce RUBY_PLATFORM checking.
+* Fixed the release date for 0.3.0 (was accidentally marked *July*).
+* Added an INSTALL file.
+* Minor documentation change to the sunos.c source file.
+
+== 0.3.0 - 11-Aug-2002
+* Added FreeBSD support!
+* Struct name changed to just "ProcTableStruct" to be compliant with future
+  versions of Ruby.
+* The ps() function now returns an array of ProcTableStruct's in lvalue context.
+* Fixed the ability to search by process name in Linux.
+* Modified Linux "comm" field to strip parenthesis.
+* Some doc changes/additions.
+* Added Sean Chittenden to the "Acknowledgements" section.  Sean provided me
+  with access to a FreeBSD box, which is how I was able to provide FreeBSD
+  support.  Thanks Sean!
+
+== 0.2.0 - 19-Jul-2002
+* Added the ability to search by process name.
+* test.rb modified to be cross-platform.
+* Solaris - fixed bug with fname (was accidentally called "name").
+
+== 0.1.0 - 2-Jul-2002
+- Initial release.

data/MANIFEST

@@ -0,0 +1,38 @@
+CHANGES
+INSTALL
+MANIFEST
+Rakefile
+sys-proctable.gemspec
+
+doc/freebsd.txt
+doc/hpux.txt
+doc/linux.txt
+doc/solaris.txt
+doc/top.txt
+doc/windows.txt
+
+example/example_ps.rb
+
+ext/extconf.rb
+ext/bsd/bsd.c
+ext/darwin/darwin.c
+ext/freebsd/freebsd.c
+ext/freebsd/freebsd.h
+ext/hpux/hpux.c
+ext/hpux/hpux.h
+ext/version.h
+
+lib/sys/top.rb
+lib/sys/linux.rb
+lib/sys/sunos.rb
+lib/sys/windows.rb
+
+test/test_sys_proctable_all.rb
+test/test_sys_proctable_darwin.rb
+test/test_sys_proctable_freebsd.rb
+test/test_sys_proctable_hpux.rb
+test/test_sys_proctable_kvm.rb
+test/test_sys_proctable_linux.rb
+test/test_sys_proctable_sunos.rb
+test/test_sys_proctable_windows.rb
+test/test_sys_top.rb

data/README

@@ -0,0 +1,137 @@
+= Description
+   A Ruby interface for gathering process information.
+
+= Prerequisites
+* Ruby 1.8.2 or later
+* Test::Unit 2.x
+
+= Supported Platforms
+* Windows NT family (NT, 2000, XP, etc)
+* Linux
+* FreeBSD
+* Solaris 2.8+
+* HP-UX
+* OS X
+
+= Installation
+* rake test (optional)
+* rake install
+
+= Synopsis
+   require 'sys/proctable'
+   include Sys
+
+   # Everything
+   ProcTable.ps{ |p|
+      puts p.pid.to_s
+      puts p.comm
+      ...
+   }
+
+   or
+
+   # Just one process
+   s = ProcTable.ps(2123)
+   puts s.pid.to_s
+   puts s.comm
+   ...
+
+   # Return the results as an array of ProcTableStructs
+   a = ProcTable.ps
+   a.each do |p|
+      puts a.pid
+      ...
+   end
+
+= Notes 
+   Windows users may pass a host name as a second argument to get process
+   information from a different host. This relies on the WMI service running.
+
+   If you're building C source code, the ts_all.rb file is autogenerated for
+   you.
+
+= Known Issues
+=== FreeBSD
+   If you're building on FreeBSD, a standard /proc filesystem read approach is
+   used if mounted. Otherwise, a kvm interface is used. There are more fields
+   available with the kvm interface, but keep in mind that you need to be a
+   member of the kvm group (or root) to use this. You can tweak the extconf.rb
+   file manually if you want to force the issue.
+   
+=== OpenBSD, NetBSD
+   This library will attempt to use the kvm interface. It is untested,
+   however.
+
+=== Solaris
+   The cmdline member on Solaris is limited to 80 characters unless you (or
+   your program) own the process. This is a Solaris design flaw/feature.
+
+=== OS X
+   At the moment you do not get the full command line string. The code required
+   to get this information is obnoxious and I don't have any compelling desire
+   to add it. However, if you're willing to submit a patch I'll accept it.
+
+   You can find a good starting point with the OS X code found in Dan Urist's
+   Proc::ProcessTable module. You can find that module on CPAN. Point your
+   browser at http://search.cpan.org.
+
+=== Misc
+   If you build your library as a C extension (which is what will happen if
+   you run the 'build', 'test', or 'install' Rake tasks), then the .rb files
+   file under 'lib/sys/' are renamed to '.orig', except top.rb. This is
+   necessary to prevent mkmf from installing them during a 'make install'.
+
+   The 'clean' Rake task will rename them back to '.rb'.
+
+=== Thread Safety
+   I am not currently using a thread-safe version of readdir().  I am not
+   especially concerned about it either.  If you are trying to read information
+   out of /proc from different threads at the same time there is something
+   seriously wrong with your code logic. Using readdir_r() still won't solve
+   all potential thread safety issues anyway.
+
+= Future Plans
+   Research has indicated that the kvm approach is less favored than a sysctl
+   approach on BSD variants. I will try to add this interface in a future
+   release.
+
+= Acknowledgements
+   This library is largely based on the Perl module Proc::ProcessTable by
+   Dan Urist. Many ideas, as well as large chunks of code, were taken
+   from his work. So, a big THANK YOU goes out to Dan Urist.
+
+   A big thanks also goes out to Mike Hall who was very helpful with ideas,
+   logic and testing.
+
+   Thanks also go to Sean Chittenden for providing an account on one of his
+   FreeBSD machines. This is how the FreeBSD support was (initially) added.
+
+   Thanks go to James Hranicky for providing a patch that grabs name, eid,
+   euid, gid and guid info in the Linux version, along with some general
+   debugging help.
+
+   Finally I'd like to thank all the folks who have submitted bug reports
+   and/or patches.
+
+= Help Wanted
+   I do not have access to all platforms. There are a few other major platforms
+   out there, namely AIX, OpenBSD, and IRIX, among others, that I would
+   like to see ports for. There are two ways you can help - either submit code
+   for your particular platform or give me an account on your platform so I can
+   develop on it.
+
+= More documentation
+   See the documentation under the 'doc' directory for more information,
+   including platform specific notes and issues.
+
+= License
+   Ruby's
+    
+= Copyright
+   (C) 2003-2009 Daniel J. Berger
+   All Rights Reserved.
+
+= Author
+   Daniel J. Berger
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)

data/doc/linux.txt

@@ -0,0 +1,83 @@
+= Description
+   A Ruby interface for gathering process table information. This is a pure
+   Ruby implementation that reads data out of your /proc filesystem.
+
+= Synopsis
+   require 'sys/proctable'
+   include Sys
+
+   # Everything
+   ProcTable.ps{ |p|
+      puts p.pid.to_s
+      puts p.comm
+      ...
+   }
+
+   or
+
+   # Just one process
+   p = ProcTable.ps(2123)
+   puts p.pid.to_s
+   puts p.comm
+   ...
+
+   or
+
+   # Return the results as an array of ProcTableStructs
+   a = ProcTable.ps()
+   a.each do |p|
+      puts a.pid
+      ...
+   end
+
+= Constants
+VERSION
+   Returns the current version number for this package (as a string).
+
+= Class Methods
+ProcTable.fields
+   Returns an array of fields available on the current OS.
+
+ProcTable.ps(pid=nil)
+ProcTable.ps{ |s| ... }
+   If no pid's or processes are included as arguments, in block form it
+   returns a struct of type ProcTableStruct for every process in the proc
+   table.  Otherwise it returns an array of ProcTableStruct's.
+
+   If a process id is provided, a single ProcTable struct is returned, or
+   nil if the pid is not found.
+
+= Exception Classes
+ProcTable::Error < StandardError
+   Raised if the /proc field is unreadable and/or unmounted.
+
+= Supported fields
+   You can view the supported fields with the "fields()" class method.
+
+= Future Plans
+   None at this time. Please post any feature requests on the project page
+   at http://www.rubyforge.org/projects/sysutils.
+
+= Known Bugs
+   None known.  Please log any bugs on the project page at
+   http://www.rubyforge.org/projects/sysutils
+
+= License
+   Ruby's
+
+= Copyright
+   (C) 2003-2009 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
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)
+
+= See Also
+    ps, proc(5)

data/doc/top.txt

@@ -0,0 +1,50 @@
+= Description
+   A simple 'top' interface for Ruby
+
+= Prerequisites
+   Requires the "sys/proctable" package (which should be installed along
+   with this package).
+
+= Synopsis
+   require "sys/top"
+   include Sys
+
+   Top.top(5).each{ |ps|
+      p ps
+   }
+	
+= Constants
+VERSION
+   Returns the version number of this package as a String.
+	
+= Class Methods
+Top.top(number=10, field="pctcpu")
+   Returns an array of ProcTableStruct's.  The size of the array (i.e. the
+   number of processes) that it returns is based on +number+, and sorted by
+   +pctcpu+.  By default, the size and field values are 10 and "pctcpu",
+   respectively.
+
+= Notes
+   Not all fields are available on all platforms.  Please check your
+   platform specific documentation for which fields are available.
+	
+= Bugs
+   None that I'm aware of.  Please log bug reports on the project page at
+   http://www.rubyforge.org/projects/sysutils
+	
+= License
+   Ruby's
+	
+= Copyright
+   (C) 2004-2009 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
+   djberg96 at nospam at gmail dot com
+   imperator on IRC (Freenode)

data/lib/sys/proctable.rb

@@ -0,0 +1,237 @@
+# The Sys module serves as a namespace only.
+module Sys
+
+   # The ProcTable class encapsulates process table information.
+   class ProcTable
+      
+      # There is no constructor
+      private_class_method :new
+
+      # The version of the sys-proctable library
+      VERSION = '0.8.0'
+
+      private
+
+      @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
+      ]
+
+      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(1001)
+      #
+      def self.ps(pid=nil)
+         array  = block_given? ? nil : []
+         struct = nil
+
+         raise TypeError unless pid.is_a?(Fixnum) 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
+            struct.cmdline = IO.read("/proc/#{file}/cmdline")
+
+            # 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
+               # 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")
+
+            # 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)
+            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
+
+            # If cmdline is empty use comm instead
+            struct.cmdline = struct.comm if struct.cmdline.empty?
+            
+            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
+   end
+end

data/lib/sys/top.rb

@@ -0,0 +1,35 @@
+require 'sys/proctable'
+require 'rbconfig'
+
+# The Sys module serves as a namespace only
+module Sys
+
+   # The Top class serves as a toplevel name for the 'top' method.
+   class Top
+
+      # The version of the sys-top library
+      VERSION = '1.0.2'
+
+      # Returns an array of Struct::ProcTableStruct elements containing up
+      # to +num+ elements, sorted by +field+. The default number of elements
+      # is 10, while the default field is 'pctcpu'.
+      #
+      # Exception: the default sort field is 'pid' on Linux and Windows.
+      # 
+      def self.top(num=10, field='pctcpu')
+         field = field.to_s if field.is_a?(Symbol)
+
+         # Sort by pid on Windows by default
+         if Config::CONFIG['host_os'].match('mswin') && field == 'pctcpu'
+            field = 'pid'
+         end
+         
+         # Linux does not have a pctcpu field yet
+         if Config::CONFIG['host_os'].match('linux') && field == 'pctcpu'
+            field = 'pid'
+         end
+            
+         Sys::ProcTable.ps.sort_by{ |obj| obj.send(field) || '' }[0..num-1]
+      end
+   end
+end

data/test/test_sys_proctable_all.rb

@@ -0,0 +1,80 @@
+#######################################################################
+# test_sys_proctable_all.rb
+#
+# Test suite for methods common to all platforms. Generally speaking
+# you should run this test case using the 'rake test' task.
+#######################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'sys/proctable'
+require 'rbconfig'
+require 'test/test_sys_top'
+include Sys
+
+class TC_ProcTable_All < Test::Unit::TestCase
+   def self.startup
+      @@windows = Config::CONFIG['host_os'].match('mswin')
+   end
+
+   def setup
+      @pid = @@windows ? 0 : 1
+   end
+
+   def test_version
+      assert_equal('0.8.0', ProcTable::VERSION)
+   end
+
+   def test_fields
+      assert_respond_to(ProcTable, :fields)
+      assert_nothing_raised{ ProcTable.fields }
+      assert_kind_of(Array, ProcTable.fields)
+      assert_kind_of(String, ProcTable.fields.first)
+   end
+
+   def test_ps
+      assert_respond_to(ProcTable, :ps)
+      assert_nothing_raised{ ProcTable.ps }
+      assert_nothing_raised{ ProcTable.ps{} }
+   end
+
+   def test_ps_with_pid
+      assert_nothing_raised{ ProcTable.ps(0) }
+   end
+
+   def test_ps_with_explicit_nil
+      assert_nothing_raised{ ProcTable.ps(nil) }
+      assert_kind_of(Array, ProcTable.ps(nil))
+   end
+
+   def test_ps_return_value
+      assert_kind_of(Array, ProcTable.ps)
+      assert_kind_of(Struct::ProcTableStruct, ProcTable.ps(@pid))
+      assert_equal(nil, ProcTable.ps(999999999))
+      assert_equal(nil, ProcTable.ps(999999999){})
+      assert_equal(nil, ProcTable.ps{})
+   end
+
+   def test_ps_returned_struct_is_frozen
+      assert_true(ProcTable.ps.first.frozen?)
+   end
+
+   def test_ps_expected_errors
+      assert_raises(TypeError){ ProcTable.ps('vim') }
+      omit_if(@@windows, 'ArgumentError check skipped on MS Windows')
+      assert_raises(ArgumentError){ ProcTable.ps(0, 'localhost') }
+   end
+
+   def test_new_not_allowed
+      assert_raise(NoMethodError){ Sys::ProcTable.new }
+   end
+   
+   def teardown
+      @pid  = nil
+   end
+
+   def self.teardown
+      @@windows = nil
+   end
+end

data/test/test_sys_proctable_linux.rb

@@ -0,0 +1,288 @@
+#######################################################################
+# test_sys_proctable_linux.rb
+#
+# Test suite for the Linux version of the sys-proctable library. You
+# should run these tests via the 'rake test' task.
+#######################################################################
+require 'rubygems'
+gem 'test-unit'
+
+require 'sys/proctable'
+require 'test/test_sys_proctable_all'
+include Sys
+
+class TC_ProcTable_Linux < Test::Unit::TestCase
+
+   def self.startup
+      @@fields = %w/
+         cmdline cwd exe pid name uid euid gid egid comm state ppid pgrp
+         session tty_num tpgid flags minflt cminflt majflt cmajflt utime
+         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        
+      /
+   end
+
+   def setup
+      @ptable = ProcTable.ps.last
+   end
+
+   def test_cmdline
+      assert_respond_to(@ptable, :cmdline)
+      assert_kind_of(String, @ptable.cmdline)
+   end
+
+   def test_cwd
+      assert_respond_to(@ptable, :cwd)
+      assert_true([NilClass, String].include?(@ptable.cwd.class))
+   end
+
+   def test_environ
+      assert_respond_to(@ptable, :environ)
+      assert_kind_of(Hash, @ptable.environ)
+   end
+
+   def test_exe
+      assert_respond_to(@ptable, :exe)
+      assert_kind_of(String, @ptable.exe)
+   end
+
+   def test_fd
+      assert_respond_to(@ptable, :fd)
+      assert_kind_of(Hash, @ptable.fd)
+   end
+
+   def test_root
+      assert_respond_to(@ptable, :root)
+      assert_kind_of(String, @ptable.root)
+   end
+
+   def test_pid
+      assert_respond_to(@ptable, :pid)
+      assert_kind_of(Fixnum, @ptable.pid)
+   end
+
+   def test_comm
+      assert_respond_to(@ptable, :comm)
+      assert_kind_of(String, @ptable.comm)
+   end
+
+   def test_state
+      assert_respond_to(@ptable, :state)
+      assert_kind_of(String, @ptable.state)
+   end
+
+   def test_ppid
+      assert_respond_to(@ptable, :ppid)
+      assert_kind_of(Fixnum, @ptable.ppid)
+   end
+
+   def test_pgrp
+      assert_respond_to(@ptable, :pgrp)
+      assert_kind_of(Fixnum, @ptable.pgrp)
+   end
+
+   def test_session
+      assert_respond_to(@ptable, :session)
+      assert_kind_of(Fixnum, @ptable.session)
+   end
+
+   def test_tty_nr
+      assert_respond_to(@ptable, :tty_nr)
+      assert_kind_of(Fixnum, @ptable.tty_nr)
+   end
+
+   def test_tpgid
+      assert_respond_to(@ptable, :tpgid)
+      assert_kind_of(Fixnum, @ptable.tpgid)
+   end
+
+   def test_flags
+      assert_respond_to(@ptable, :flags)
+      assert_kind_of(Fixnum, @ptable.flags)
+   end
+
+   def test_minflt
+      assert_respond_to(@ptable, :minflt)
+      assert_kind_of(Fixnum, @ptable.minflt)
+   end
+
+   def test_cminflt
+      assert_respond_to(@ptable, :cminflt)
+      assert_kind_of(Fixnum, @ptable.cminflt)
+   end
+
+   def test_majflt
+      assert_respond_to(@ptable, :majflt)
+      assert_kind_of(Fixnum, @ptable.majflt)
+   end
+
+   def test_cmajflt
+      assert_respond_to(@ptable, :cmajflt)
+      assert_kind_of(Fixnum, @ptable.cmajflt)
+   end
+
+   def test_utime
+      assert_respond_to(@ptable, :utime)
+      assert_kind_of(Fixnum, @ptable.utime)
+   end
+
+   def test_stime
+      assert_respond_to(@ptable, :stime)
+      assert_kind_of(Fixnum, @ptable.stime)
+   end
+
+   def test_cutime
+      assert_respond_to(@ptable, :cutime)
+      assert_kind_of(Fixnum, @ptable.cutime)
+   end
+
+   def test_cstime
+      assert_respond_to(@ptable, :cstime)
+      assert_kind_of(Fixnum, @ptable.cstime)
+   end
+
+   def test_priority
+      assert_respond_to(@ptable, :priority)
+      assert_kind_of(Fixnum, @ptable.priority)
+   end
+
+   def test_nice
+      assert_respond_to(@ptable, :nice)
+      assert_kind_of(Fixnum, @ptable.nice)
+   end
+
+   def test_itrealvalue
+      assert_respond_to(@ptable, :itrealvalue)
+      assert_kind_of(Fixnum, @ptable.itrealvalue)
+   end
+
+   def test_starttime
+      assert_respond_to(@ptable, :starttime)
+      assert_kind_of(Fixnum, @ptable.starttime)
+   end
+
+   def test_vsize
+      assert_respond_to(@ptable, :vsize)
+      assert_kind_of(Fixnum, @ptable.vsize)
+   end
+
+   def test_rss
+      assert_respond_to(@ptable, :rss)
+      assert_kind_of(Fixnum, @ptable.rss)
+   end
+
+   def test_rlim
+      assert_respond_to(@ptable, :rlim)
+      assert_kind_of(Integer, @ptable.rlim)
+   end
+
+   def test_startcode
+      assert_respond_to(@ptable, :startcode)
+      assert_kind_of(Fixnum, @ptable.startcode)
+   end
+
+   def test_endcode
+      assert_respond_to(@ptable, :endcode)
+      assert_kind_of(Fixnum, @ptable.endcode)
+   end
+
+   def test_startstack
+      assert_respond_to(@ptable, :startstack)
+      assert_kind_of(Integer, @ptable.startstack)
+   end
+
+   def test_kstkesp
+      assert_respond_to(@ptable, :kstkesp)
+      assert_kind_of(Integer, @ptable.kstkesp)
+   end
+
+   def test_kstkeip
+      assert_respond_to(@ptable, :kstkeip)
+      assert_kind_of(Integer, @ptable.kstkeip)
+   end
+
+   def test_signal
+      assert_respond_to(@ptable, :signal)
+      assert_kind_of(Integer, @ptable.signal)
+   end
+
+   def test_blocked
+      assert_respond_to(@ptable, :blocked)
+      assert_kind_of(Fixnum, @ptable.blocked)
+   end
+
+   def test_sigignore
+      assert_respond_to(@ptable, :sigignore)
+      assert_kind_of(Fixnum, @ptable.sigignore)
+   end
+
+   def test_sigcatch
+      assert_respond_to(@ptable, :sigcatch)
+      assert_kind_of(Fixnum, @ptable.sigcatch)
+   end
+
+   def test_wchan
+      assert_respond_to(@ptable, :wchan)
+      assert_kind_of(Fixnum, @ptable.wchan)
+   end
+
+   def test_nswap
+      assert_respond_to(@ptable, :nswap)
+      assert_kind_of(Fixnum, @ptable.nswap)
+   end
+
+   def test_cnswap
+      assert_respond_to(@ptable, :cnswap)
+      assert_kind_of(Fixnum, @ptable.cnswap)
+   end
+
+   def test_exit_signal
+      assert_respond_to(@ptable, :exit_signal)
+      assert_kind_of(Fixnum, @ptable.exit_signal)
+   end
+
+   def test_processor
+      assert_respond_to(@ptable, :processor)
+      assert_kind_of(Fixnum, @ptable.processor)
+   end
+
+   def test_rt_priority
+      assert_respond_to(@ptable, :rt_priority)
+      assert_kind_of(Fixnum, @ptable.rt_priority)
+   end
+
+   def test_policy
+      assert_respond_to(@ptable, :policy)
+      assert_kind_of(Fixnum, @ptable.policy)
+   end
+
+   def test_name
+      assert_respond_to(@ptable, :name)
+      assert_kind_of(String, @ptable.name)
+   end
+
+   def test_uid
+      assert_respond_to(@ptable, :uid)
+      assert_kind_of(Fixnum, @ptable.uid)
+   end
+
+   def test_euid
+      assert_respond_to(@ptable, :euid)
+      assert_kind_of(Fixnum, @ptable.euid)
+   end
+
+   def test_gid
+      assert_respond_to(@ptable, :gid)
+      assert_kind_of(Fixnum, @ptable.gid)
+   end
+
+   def test_egid
+      assert_respond_to(@ptable, :egid)
+      assert_kind_of(Fixnum, @ptable.egid)
+   end
+
+   def teardown
+      @ptable = nil
+   end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: sys-proctable
+version: !ruby/object:Gem::Version 
+  version: 0.8.0
+platform: x86-linux
+authors: 
+- Daniel J. Berger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-26 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+description: An interface for providing process table information
+email: djberg96@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- README
+- MANIFEST
+- doc/top.txt
+- doc/linux.txt
+files: 
+- lib/sys/top.rb
+- test/test_sys_proctable_all.rb
+- CHANGES
+- README
+- MANIFEST
+- doc/top.txt
+- lib/sys/proctable.rb
+- doc/linux.txt
+has_rdoc: true
+homepage: http://www.rubyforge.org/projects/sysutils
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.2
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: sysutils
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: An interface for providing process table information
+test_files: 
+- test/test_sys_proctable_all.rb
+- test/test_sys_proctable_linux.rb