sys-proctable 0.7.6-i586-linux

data/doc/hpux.txt

@@ -0,0 +1,77 @@
+= Description
+   sys-proctable
+
+   A Ruby version of the 'ps' command.  This is a C extension, not parsed
+   output.  For HP-UX, proc structs are grabbed via the pstat_getproc() call.
+
+= Synopsis
+   require 'sys/proctable'
+   include Sys
+
+   # Everything
+   ProcTable.ps{ |p|
+      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| ... }
+   Returns a struct of type ProcTableStruct for every process in the proc
+   table in block form.  Otherwise it returns an array of ProcTableStruct's.
+
+   If a pid is provided then a single ProcTable struct is returned, or nil
+   if the pid is not found.
+
+= Supported fields
+   You can view the supported fields with the "fields()" class method.
+
+= Future Plans
+   Have the flags field return a meaningful value.
+
+= Notes
+   The "comm" field isn't really part of the psinfo struct.  It is just a copy
+   (i.e. is identical to) the "fname" field.  I added it to provide a degree
+   of consistency between all of the platforms.  I will also make a point
+   of adding it to any future platform releases.
+
+= Known Bugs
+   None that I'm aware of.  Please log any bugs on the project page at
+   http://www.rubyforge.org/projects/sysutils
+
+= License
+   Ruby's
+
+= Copyright
+   (C) 2003-2006 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

data/doc/linux.txt

@@ -0,0 +1,85 @@
+= Description
+   sys-proctable
+
+   A Ruby version of the 'ps' command.  This is a C extension, not parsed
+   output. For Linux, process information is read out of /proc.
+
+= 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
+ProcTableError < 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
+   Create a pure Ruby version as an alternative.
+   Change the ttynum field to ttydev and return a string instead of an int.
+
+= 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-2006 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
+   rubyhacker1 on IRC (Freenode)
+
+= See Also
+    ps, proc(5)

data/doc/solaris.txt

@@ -0,0 +1,99 @@
+= Description
+   sys-proctable
+
+   A Ruby version of the 'ps' command.  This is a C extension, not parsed
+   output.  For Solaris, data is read out of /proc via the psinfo struct.
+   
+= 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
+   
+= 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 is included as an argument, in block form it
+   returns a struct of type ProcTableStruct for every process in the proc
+   table.  Otherwise it returns an array of ProcTable struct's.  If a pid
+   is provided it will return a single ProcTable struct for that pid, or
+   nil if it is not found.
+    
+= Exception Classes
+ProcTableError < StandardError
+   Raised if the /proc directory is unreadable and/or unmounted.
+    
+= Supported fields
+   You can view the supported fields with the "fields()" class method.
+
+= Future Plans
+   Return a more meaningful result for the wchan member (2.6+).
+   Add env info where possible.
+    
+= Notes
+   The "comm" field isn't really part of the psinfo struct.  It is just a copy
+   (i.e. is identical to) the "fname" field.  I added it to provide a degree
+   of consistency between all of the platforms.  I will also make a point
+   of adding it to any future platform releases.
+
+   The cmdline string is limited to 80 characters, except for those processes
+   which you (or your program) own.
+
+   The ttydev field is, for now, an integer.  If there is no associated tty with
+   the process, a -1 is returned.   In the future, this field will be changed to
+   a string (i.e. the actual device name).
+
+   I suppose I *could* add a -lkvm version for Solaris (this is what Dan Urist
+   is now using in Proc::ProcessTable) but I haven't found a compelling reason
+   to do so.  If you think you have one, please let me know.
+    
+= Known Bugs
+   None that I am aware of.  Please log any bugs on the RubyForge project page at
+   http://www.rubyforge.org/projects/sysutils
+
+= License
+   Ruby's
+    
+= Copyright
+   (C) 2003-2006 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

data/doc/top.txt

@@ -0,0 +1,53 @@
+= 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.
+
+   I used sort() instead of sort_by() internally to maintain backward
+   compatability with Ruby 1.6.8, which I happen to need.
+	
+= 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-2006 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/doc/windows.txt

@@ -0,0 +1,122 @@
+= Description
+   A Ruby interface for gathering process information.  For MS Windows,
+   the process information is gathered via OLE + WMI, using pure Ruby.
+   
+= Synopsis
+   require 'sys/proctable'
+   include Sys
+
+   # Everything
+   ProcTable.ps{ |p|
+      puts p.pid.to_s
+      puts p.comm
+      ...
+   }
+
+   or
+
+   # A single pid
+   p = ProcTable.ps(1234)
+   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 in the
+   ProcTableStruct.
+    
+ProcTable.ps(pid=nil, host='localhost')
+ProcTable.ps{ |s| ... }
+   Returns a struct of type ProcTableStruct for every process in the proc
+   table in block form.  Otherwise it returns an array of ProcTableStruct's.
+
+   If 'pid' is provided, then only a struct for that pid is returned, or
+   nil if it is not found.
+ 
+   If 'host' is provided, then processes from that host are gathered.  By
+   default, process information is gathered on the local host.
+	 	
+= Supported fields
+   The currently supported fields for MS Windows (i.e. your ProcTable struct
+   members) are:
+    
+    caption, cmdline, comm, creation_class_name, creation_date,
+    cs_creation_class_name, cs_name, description, executable_path,
+    execution_state, handle, handle_count, install_date, kernel_mode_time,
+    maximum_working_set_size, minimum_working_set_size, name,
+    os_creation_class_name, os_name, other_operation_count,
+    other_transfer_count, page_faults, page_file_usage, peak_virtual_size,
+    ppid, peak_working_set_size, priority, private_page_count, pid,
+    quota_non_paged_pool_usage, quota_paged_pool_usage,
+    quota_peak_non_paged_pool_usage, quota_non_paged_pool_usage,
+    read_operation_count, read_transfer_count, session_id,
+    termination_date, thread_count, user_mode_time, virtual_size,
+    windows_version, working_set_size, write_operation_count,
+    write_transfer_count
+
+    You can also view them with the fields() class method.
+    
+= Notes
+   For the sake of attempting to provide a somewhat common API, the 'comm'
+   and 'cmdline' fields have been included as part of the structure.  The
+   'comm' member corresponds to the Name attribute of Win32_Process.  The
+   'cmdline' attribute corresponds to either the Executable_Path attribute
+   (on Windows 2000 or earlier) or the CommandLine attribute (on Windows XP
+   and later).
+	 
+   Also note that the ProcessId and ParentProcessId attributes have been
+   abbreviated as 'pid' and 'ppid' in the struct members, again to keep the
+   members more consistent between platforms.
+	 
+   The "Mem Usage" and "VM Size" that you may be used to seeing in your Task
+   Manager window (probably) correspond to the 'working_set_size' and
+   'page_file_usage' struct members, respectively, keeping in mind that
+   those values are in bytes, not kilobytes.  I say 'probably' because
+   comments that I've read online indicate that it may not always line up
+   with what you see in the Task Manager, based on the current version (or
+   even Service Pack) of Windows that you are using.
+	 
+= Future Plans
+   Possibly use the Win32_PerfFormattedData_PerfProc_Process class to get
+   additional process information.
+    
+= Known Bugs
+   Versions of Ruby earlier than 1.8.2 resulted in segfaults when trying to
+   run this code.  You will likely encounter the same behavior.
+
+   Please log any additional bug reports on the project page at
+   http://www.rubyforge.org/projects/sysutils
+	
+= License
+   Ruby's
+    
+= Copyright
+   (C) 2003-2006 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
+   OLE + WMI

data/ext/extconf.rb

@@ -0,0 +1,98 @@
+#############################################################################
+# Installation script for sys-proctable.
+#
+# By running this file, it is assumed that you want a C extension, and not
+# a pure Ruby version.  If you want a pure Ruby version (and you're on a 
+# platform for which it's supported), run install.rb instead.
+#############################################################################
+require 'mkmf'
+require 'fileutils'
+
+c_file  = nil
+h_file  = nil
+tc_file = nil
+
+########################################################################
+# Ruby 1.8.3 and later mandates the use of rb_pid_t over pid_t because
+# some libraries define their own pid_t.  So, we check for that.
+########################################################################
+have_type('rb_pid_t', 'ruby.h')
+
+##########################################################################
+# Determine appropriate source files based on platform.  Also, check for
+# certain header files and/or libraries on some platforms.
+#
+# On FreeBSD a different source file is used if the /proc filesystem is
+# not found (kvm is used instead).  For OpenBSD or NetBSD, the kvm
+# interface is always used for now.
+##########################################################################
+case RUBY_PLATFORM
+   when /hpux/i
+      c_file  = 'hpux/hpux.c'
+      h_file  = 'hpux/hpux.h'
+      tc_file = 'tc_hpux'
+   when /freebsd/i
+      if File.exists?('/proc') && Dir['/proc/*'].length > 0
+         c_file  = 'freebsd/freebsd.c'
+         h_file  = 'freebsd/freebsd.h'
+         tc_file = 'tc_freebsd'
+      else
+         have_library('kvm')
+         have_struct_member('struct kinfo_proc', 'kp_proc', 'sys/user.h')
+         have_struct_member('struct kinfo_proc', 'kp_eproc', 'sys/user.h')
+         c_file  = 'bsd/bsd.c'
+         tc_file = 'tc_kvm_bsd.rb'
+      end
+   when /openbsd|netbsd/
+      have_library('kvm')
+      c_file  = 'bsd/bsd.c'
+      tc_file = 'tc_kvm_bsd.rb'
+   when /solaris|sunos/i
+      c_file  = 'sunos/sunos.c'
+      h_file  = 'sunos/sunos.h'
+      tc_file = 'tc_sunos'
+      have_header('procfs.h') # false means Solaris 2.5.x
+   when /linux/i
+      c_file  = 'linux/linux.c'
+      h_file  = 'linux/linux.h'
+      tc_file = 'tc_linux'
+   when /darwin/i
+      c_file = 'darwin/darwin.c'
+      tc_file = 'tc_darwin'
+   when /windows|win32|cygwin|mingw|dos/i
+      msg = 'Use the install_pure_ruby.rb script to install on MS Windows'
+      STDERR.puts msg
+      exit
+   else
+      puts 'This platform not currently supported.  Exiting...'
+      exit
+end
+
+#####################################################################
+# Move the 'windows.rb' file under 'lib/sys/' to '.orig' to prevent
+# mkmf from installing it during the 'make install' phase.
+#####################################################################
+if File.exists?('../lib/sys/windows.rb')
+   File.rename('../lib/sys/windows.rb', '../lib/sys/windows.orig')
+end
+
+###################
+# build ts_all.rb
+###################
+test_file = '../test/ts_all.rb'
+File.open(test_file, 'w'){ |fh|
+   fh.puts "require 'tc_all'"
+   fh.puts "require '#{tc_file}'"
+   fh.puts "require 'tc_top'"
+}
+
+########################################################################
+# Copy or link files to current directory for create_makefile to work.
+######################################################################## 
+File.delete('proctable.c') rescue nil
+File.delete(File.basename(h_file)) rescue nil
+
+FileUtils.cp(c_file, 'proctable.c')
+FileUtils.cp(h_file, File.basename(h_file)) if h_file
+
+create_makefile('sys/proctable')