sys-proctable 0.7.5 → 0.7.6

data/CHANGES

@@ -1,5 +1,21 @@
+== 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.
+* 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

data/MANIFEST

@@ -1,7 +1,7 @@
 CHANGES
 INSTALL
 MANIFEST
-install.rb
+Rakefile
 sys-proctable.gemspec
 
 doc/freebsd.txt

data/README

@@ -13,17 +13,11 @@
 * FreeBSD (/proc or kvm)
 * Solaris
 * HP-UX
+* OS X
 
 = Installation
-=== UNIX
-   cd ext; ruby extconf.rb
-   make
-   cd ..; ruby test/ts_all.rb (optional)
-   make install
-   
-=== MS Windows
-   ruby test/tc_windows.rb (optional)
-   ruby install.rb
+* rake test (optional)
+* rake install
 
 = Synopsis
    require 'sys/proctable'
@@ -53,7 +47,7 @@
 
 = 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.
+   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.
@@ -61,56 +55,71 @@
 = Known Issues
 === BSD
    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
+   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.
+   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.
 
-   Not all fields are available on FreeBSD 5.x (yet).  OpenBSD and NetBSD are
+   Not all fields are available on FreeBSD 5.x (yet). OpenBSD and NetBSD are
    not yet supported.
 
-   Research has indicated that the kvm approach is less favored than a sysctl
-   approach.  I will try to add this interface in the 0.8.0 release.
-
 === 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.
+   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 (mandatory on all platforms
-   except MS Windows at the moment), then the windows.rb file under 'lib/sys/'
-   is renamed to 'windows.orig'.  This is to prevent mkmf from auto-installing
-   it during the 'make install' phase.
+   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 windows.rb
+   file under 'lib/sys/' is renamed to 'windows.orig'. This is necessary to
+   prevent mkmf from auto-installing it during the 'make install' phase.
+
+   The 'clean' Rake task will rename it back to 'windows.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
+   seriously wrong with your code logic. Using readdir_r() still won't solve
    all potential thread safety issues anyway.
 
 = Future Plans
    I'm considering using a pure Ruby version for Linux. 
 
+   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 the 0.8.0
+   release.
+
 = Acknowledgements
    This package 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.
+   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.
+   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 OS X, AIX, OpenBSD, and IRIX, among others, that I would
-   like to see ports for.  There are two ways you can help - either submit code
+   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.
 
@@ -122,7 +131,7 @@
    Ruby's
     
 = Copyright
-   (C) 2003-2006 Daniel J. Berger
+   (C) 2003-2007 Daniel J. Berger
    All Rights Reserved.
 
 = Author

data/ext/extconf.rb

@@ -81,9 +81,7 @@ end
 ###################
 test_file = '../test/ts_all.rb'
 File.open(test_file, 'w'){ |fh|
-   fh.puts '$LOAD_PATH.unshift Dir.pwd'
-   fh.puts '$LOAD_PATH.unshift Dir.pwd + "/lib"'
-   fh.puts '$LOAD_PATH.unshift Dir.pwd + "/ext"'
+   fh.puts "require 'tc_all'"
    fh.puts "require '#{tc_file}'"
    fh.puts "require 'tc_top'"
 }

data/ext/sunos/sunos.c

@@ -0,0 +1,374 @@
+/**************************************************************************
+ * sunos.c (proctable.c)
+ *
+ * Solaris specific code for the Ruby ps extension.  Some code
+ * has been copied directly from Dan Urist's Proc::ProcessTable
+ * Perl module.
+ *
+ * The portion of code that grabs data out of /proc/xxx/as is based
+ * on a post by Roger Faulkner on comp.unix.questions.
+ **************************************************************************/
+#include "ruby.h"
+#include "sunos.h"
+#include "version.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+VALUE sProcStruct, cProcError;
+
+/*
+ * Private method that converts a psinfo struct into a Ruby struct.
+ */
+#ifdef HAVE_PROCFS_H
+static VALUE proctable_getprocstruct(struct psinfo *p, VALUE v_cmd_array)
+#else
+static VALUE proctable_getprocstruct(struct prpsinfo *p, VALUE v_cmd_array)
+#endif
+{
+   char state[STATE_MAX];
+   char comm[COMM_MAX];
+   prusage_t pbuf;
+   VALUE cmdline;
+   VALUE rbTTY = Qnil;
+
+   /*
+    * If we were unable to get the full command line, resort to the limited
+    * pr_psargs struct member.
+    */
+   if(RARRAY(v_cmd_array)->len == 0)
+      cmdline = rb_str_new2(p->pr_psargs);
+   else
+      cmdline = rb_ary_join(v_cmd_array,rb_str_new2(" "));
+
+   if(PRNODEV != p->pr_ttydev)
+      rbTTY = UINT2NUM(p->pr_ttydev);
+   else
+      rbTTY = INT2NUM(-1);
+
+#ifndef HAVE_PROCFS_H
+   char wchan[WCHAN_MAX];
+   sprintf(wchan, "%x", (unsigned int)p->pr_wchan);
+#endif
+
+#ifdef HAVE_PROCFS_H
+   switch(p->pr_lwp.pr_state)
+#else
+   switch(p->pr_state)
+#endif
+   {
+      case SSLEEP: 
+         strcpy(state, SLEEP);
+         break;
+      case SRUN:
+         strcpy(state, RUN);
+         break;
+      case SZOMB:
+         strcpy(state, ZOMBIE);
+         break;
+      case SSTOP:
+         strcpy(state, STOP);
+         break;
+      case SIDL:
+         strcpy(state, IDLE);
+         break;
+      case SONPROC:
+         strcpy(state, ONPROC);
+         break;
+   }
+
+   strcpy(comm, p->pr_fname);
+
+   getprusage(p->pr_pid,&pbuf); /* Get the process usage info */
+
+   return rb_struct_new(sProcStruct,
+      INT2FIX(p->pr_flag),
+#ifdef HAVE_PROCFS_H
+      INT2FIX(p->pr_nlwp),
+#endif
+      UINT2NUM(p->pr_pid),
+      UINT2NUM(p->pr_ppid),
+#ifdef HAVE_PROCFS_H
+      UINT2NUM(p->pr_pgid),
+#else
+      UINT2NUM(p->pr_pgrp),
+#endif
+      UINT2NUM(p->pr_sid),
+      UINT2NUM(p->pr_uid),
+      UINT2NUM(p->pr_euid),
+      UINT2NUM(p->pr_gid),
+      UINT2NUM(p->pr_egid),
+#ifdef HAVE_PROCFS_H
+      INT2FIX(p->pr_lwp.pr_pri),
+      INT2FIX(p->pr_lwp.pr_nice),
+#else
+      INT2FIX(p->pr_pri),
+      INT2FIX(p->pr_nice),
+#endif
+      rbTTY,
+      INT2FIX(p->pr_time.tv_sec),
+      INT2FIX(p->pr_ctime.tv_sec),
+#ifdef HAVE_PROCFS_H
+      INT2FIX(p->pr_size * 1024),
+      INT2FIX(p->pr_rssize * 1024),
+      UINT2NUM(p->pr_lwp.pr_wchan),
+#else
+      INT2FIX(p->pr_bysize),
+      INT2FIX(p->pr_rssize),
+      rb_str_new2(wchan),
+#endif
+      rb_float_new(((double)p->pr_pctcpu)/0x8000*100),
+      rb_float_new(((double)p->pr_pctmem)/0x8000*100),
+      rb_str_new2(state),
+      rb_str_new2(p->pr_fname),
+      cmdline,
+      rb_time_new(p->pr_start.tv_sec,0),
+#ifdef HAVE_PROCFS_H
+      INT2NUM(p->pr_lwp.pr_onpro),
+#endif
+      rb_str_new2(comm),
+      INT2FIX(p->pr_argc),
+      v_cmd_array,
+      LONG2FIX(pbuf.pr_lwpid),
+      INT2FIX(pbuf.pr_count),
+      LONG2FIX(pbuf.pr_tstamp.tv_sec),
+      LONG2FIX(pbuf.pr_create.tv_sec),
+      LONG2FIX(pbuf.pr_term.tv_sec),
+      LONG2FIX(pbuf.pr_rtime.tv_sec),
+      LONG2FIX(pbuf.pr_utime.tv_sec),
+      LONG2FIX(pbuf.pr_stime.tv_sec),
+      LONG2FIX(pbuf.pr_ttime.tv_sec),
+      LONG2FIX(pbuf.pr_tftime.tv_sec),
+      LONG2FIX(pbuf.pr_dftime.tv_sec),
+      LONG2FIX(pbuf.pr_kftime.tv_sec),
+      LONG2FIX(pbuf.pr_ltime.tv_sec),
+      LONG2FIX(pbuf.pr_slptime.tv_sec),
+      LONG2FIX(pbuf.pr_wtime.tv_sec),
+      LONG2FIX(pbuf.pr_stoptime.tv_sec),
+      ULONG2NUM(pbuf.pr_minf),
+      ULONG2NUM(pbuf.pr_majf),
+      ULONG2NUM(pbuf.pr_nswap),
+      ULONG2NUM(pbuf.pr_inblk),
+      ULONG2NUM(pbuf.pr_oublk),
+      ULONG2NUM(pbuf.pr_msnd),
+      ULONG2NUM(pbuf.pr_mrcv),
+      ULONG2NUM(pbuf.pr_sigs),
+      ULONG2NUM(pbuf.pr_vctx),
+      ULONG2NUM(pbuf.pr_ictx),
+      ULONG2NUM(pbuf.pr_sysc),
+      ULONG2NUM(pbuf.pr_ioch)
+   );
+}
+
+/*
+ * call-seq:
+ *    ProcTable.ps(pid=nil)
+ *    ProcTable.ps(pid=nil){ |ps| ... }
+ *
+ * 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+.
+ */
+static VALUE proctable_ps(int argc, VALUE *argv, VALUE klass)
+{
+   DIR *procdir;
+   struct dirent *procdirp;
+   int psdata;
+   char pathbuf[PATH_MAX];
+
+   char* arg;
+   uintptr_t addr_args;
+   uintptr_t* arg_vec;
+   size_t arg_len;
+   int fd, arg_count, i, pid;
+
+   VALUE v_pid;
+   VALUE v_ps_struct = Qnil;
+   VALUE v_array = Qnil;
+   VALUE v_cmd_array = rb_ary_new();
+
+#ifdef HAVE_PROCFS_H
+   struct psinfo p;
+   char as_file[MAXPATHLEN];
+#else
+   struct prpsinfo p;
+#endif
+
+   rb_scan_args(argc, argv, "01", &v_pid);
+
+   if(!rb_block_given_p())
+      v_array = rb_ary_new();
+
+   if( (procdir = opendir( "/proc" )) == NULL )
+      rb_raise(cProcError,"/proc filesystem unreadable");
+
+   while( (procdirp = readdir(procdir)) != NULL )
+   {
+      /* Only look at this file if it's a proc id; that is, all numbers */
+      if(strtok(procdirp->d_name, "0123456789") != NULL ){ continue; }
+
+      /* If a pid is provided, only return info on that pid */
+      if(!NIL_P(v_pid)){
+         pid = NUM2INT(v_pid);
+         if(atoi(procdirp->d_name) != pid)
+            continue;
+      }
+    
+      /* Construct path of the form /proc/proc_number */
+      strcpy(pathbuf, "/proc/"); 
+      strcpy(as_file, "/proc/");
+      strcat(pathbuf, procdirp->d_name);
+      strcat(as_file, procdirp->d_name);
+    
+#ifdef HAVE_PROCFS_H
+      strcat(pathbuf, "/psinfo"); /* Solaris 2.6+ has process info here */
+      strcat(as_file, "/as");
+#endif
+
+      if( (psdata = open( pathbuf, O_RDONLY )) == -1 )
+         continue;
+
+#ifdef HAVE_PROCFS_H
+      read(psdata, (void *) &p, sizeof(struct psinfo));
+#else
+      if(ioctl(psdata, PIOCPSINFO, &p) == -1)
+         continue;
+#endif
+
+#ifdef HAVE_PROCFS_H
+      /*
+       * For those processes where it is possible to read /proc/xxx/as
+       * get the entire command line string.
+       */
+      addr_args = p.pr_argv;
+      arg_count = p.pr_argc;
+
+      if((fd = open(as_file, O_RDONLY)) < 0){
+         /* Do nothing - you can only get info on processes you rights to */
+      }
+      else
+      {
+         arg_vec = malloc(arg_count * sizeof(uintptr_t));
+         
+         /* We need this here to pick up args properly on 2.8+ */
+#ifdef PR_MODEL_NATIVE         
+         if(p.pr_dmodel == PR_MODEL_NATIVE){
+            (void)pread(fd, arg_vec, arg_count * sizeof (uintptr_t), addr_args);
+         }
+         else{
+            caddr32_t *arg_vec32 = (caddr32_t *)arg_vec;
+            (void)pread(fd, arg_vec32, arg_count * sizeof (caddr32_t), addr_args);
+            for (i = arg_count - 1; i >= 0; --i)
+            {
+               arg_vec[i] = arg_vec32[i];
+            }
+         }
+#else
+         /* Need a better patch for 2.6 here */
+         (void)pread(fd, arg_vec, arg_count * sizeof (uintptr_t), addr_args);
+#endif
+
+         arg_len = 16;
+         arg = malloc(arg_len+1);
+         for(i = 0; i < arg_count; i++) {
+
+            if(pread(fd, arg, arg_len, arg_vec[i]) < 0)
+               continue;
+
+            arg[arg_len] = '\0';
+            if(strlen(arg) == arg_len){
+               arg_len *= 2;
+               arg = realloc(arg, arg_len + 1);
+               i--;
+               continue;
+            }
+            rb_ary_push(v_cmd_array, rb_str_new2(arg));
+         }
+         free(arg);
+         free(arg_vec);
+      }
+      close(fd);
+#endif
+
+      close(psdata);
+      v_ps_struct = proctable_getprocstruct(&p, v_cmd_array);
+
+      if(rb_block_given_p()){
+         rb_yield(v_ps_struct);
+      }
+      else{
+         rb_ary_push(v_array, v_ps_struct);
+      }
+      rb_ary_clear(v_cmd_array);
+   }
+   closedir(procdir);
+
+   /* If a process ID was provided and found, return a single struct */
+   if(!NIL_P(v_pid))
+      return v_ps_struct;
+   
+   return v_array; /* nil if block was provided */
+}
+
+/*
+ * call-seq:
+ *    ProcTable.fields
+ *
+ * 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.
+ */
+static VALUE proctable_fields(VALUE klass){
+   uint_t i;
+   VALUE rbFarray = rb_ary_new();
+
+   for(i = 0; i < (sizeof(fields) / sizeof(fields[0])); i++)
+      rb_ary_push(rbFarray, rb_str_new2(fields[i]));
+
+   return rbFarray;
+}
+
+/*
+ * A Ruby interface for gathering process table information.
+ */
+void Init_proctable(){
+   VALUE mSys, cProcTable;
+
+   /* Modules and Classes */
+   mSys = rb_define_module("Sys");
+   cProcTable = rb_define_class_under(mSys, "ProcTable", rb_cObject);
+   cProcError = rb_define_class_under(mSys, "ProcTableError", rb_eStandardError);
+   
+   /* Class methods */
+   rb_define_singleton_method(cProcTable, "fields", proctable_fields, 0);
+   rb_define_singleton_method(cProcTable, "ps", proctable_ps, -1);
+
+   /* Constants */
+   rb_define_const(cProcTable, "VERSION", rb_str_new2(SYS_PROCTABLE_VERSION));
+
+   /* Structs */
+   sProcStruct = rb_struct_define("ProcTableStruct","flag",
+#ifdef HAVE_PROCFS_H
+"nlwp",
+#endif
+      "pid","ppid","pgid","sid","uid","euid","gid","egid","priority","nice",
+      "ttydev","time","ctime","size","rss","wchan","pctcpu","pctmem","state",
+      "fname","cmdline","start",
+#ifdef HAVE_PROCFS_H
+"processor",
+#endif
+      "comm","num_args","cmd_args","lwpid","count","tstamp","create","term",
+      "rtime","utime","stime","ttime","tftime","dftime","kftime","ltime",
+      "slptime","wtime","stoptime","minf","majf","nswap","inblk","oublk",
+      "msnd","mrcv","sigs","vctx","ictx","sysc","ioch",NULL
+      ); 
+}
+
+#ifdef __cplusplus
+}
+#endif