sys-proctable 0.7.3

data/lib/os/linux.c

@@ -0,0 +1,315 @@
+/***************************************************************
+ * linux.c (proctable.c)
+ *
+ * Linux specific code for the Ruby ps extension.  Some code
+ * has been copied directly from Dan Urist's Proc::ProcessTable
+ * Perl module.
+ *
+ * Author: Daniel J. Berger
+ **************************************************************/
+#include "ruby.h"
+#include "linux.h"
+#include "version.h"
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+VALUE sProc, cProcError;
+
+/* 
+ * Converts a proc_info struct into a Ruby struct.
+ */
+static VALUE proctable_get_process(struct proc_info *p, VALUE env_hash) {
+   return rb_struct_new(sProc,
+      rb_str_new2(p->cmdline),
+      rb_str_new2(p->cwd),
+      rb_str_new2(p->exe),
+      INT2FIX(p->pid),
+      rb_str_new2(p->name),
+      INT2FIX(p->uid),
+      INT2FIX(p->euid),
+      INT2FIX(p->gid),
+      INT2FIX(p->egid),
+      rb_str_new2(p->comm),
+      rb_str_new(p->state,1),
+      INT2FIX(p->ppid),
+      INT2FIX(p->pgrp),
+      INT2FIX(p->session),
+      INT2FIX(p->tty_num),
+      INT2FIX(p->tpgid),
+      UINT2NUM(p->flags),
+      UINT2NUM(p->minflt),
+      UINT2NUM(p->cminflt),
+      UINT2NUM(p->majflt),
+      UINT2NUM(p->cmajflt),
+      INT2FIX(p->utime),
+      INT2FIX(p->stime),
+      INT2FIX(p->cutime),
+      INT2FIX(p->cstime),
+      INT2FIX(p->priority),
+      INT2FIX(p->nice),
+      UINT2NUM(p->itrealvalue),
+      INT2FIX(p->starttime),
+      UINT2NUM(p->vsize),
+      INT2FIX(p->rss),
+      UINT2NUM(p->rlim),
+      UINT2NUM(p->startcode),
+      UINT2NUM(p->endcode),
+      UINT2NUM(p->startstack),
+      UINT2NUM(p->kstkesp),
+      UINT2NUM(p->kstkeip),
+      UINT2NUM(p->signal),
+      UINT2NUM(p->blocked),
+      UINT2NUM(p->sigignore),
+      UINT2NUM(p->sigcatch),
+      UINT2NUM(p->wchan),
+      UINT2NUM(p->nswap),
+      UINT2NUM(p->cnswap),
+      INT2FIX(p->exit_signal),
+      INT2FIX(p->processor),
+      env_hash
+   );
+}
+
+/*
+ * 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* dir_ptr;
+   FILE* file_ptr;
+   struct dirent* dirent_ptr;
+   struct proc_info p;
+   char pathbuf[NAME_MAX];
+   int temp;
+   int pid = -1;
+
+   VALUE v_pid     = Qnil;
+   VALUE v_array   = Qnil;
+   VALUE v_pstruct = Qnil;
+   VALUE v_env     = rb_hash_new();
+
+   rb_scan_args(argc, argv, "01", &v_pid);
+
+   if((dir_ptr = opendir("/proc")) == NULL)
+      rb_raise(cProcError,"/proc filesystem unreadable");
+   
+   if(!NIL_P(v_pid))
+      pid = NUM2INT(v_pid);
+      
+   if(!rb_block_given_p())
+      v_array = rb_ary_new();
+
+   /* Iterate through all the (numeric) process entries uner /proc */
+   while((dirent_ptr = readdir(dir_ptr)) != NULL){
+
+      /* Only look at this file if it's a proc id; that is, all numbers */
+      if( strtok(dirent_ptr->d_name, "0123456789") != NULL ) {
+         continue;
+      }
+
+      if(!NIL_P(v_pid)){
+         if(atoi(dirent_ptr->d_name) != pid){
+            continue;
+         }
+      }
+
+      /* Get the /proc/PID/cmdline info */
+      sprintf(pathbuf, "%s%s%s", "/proc/", dirent_ptr->d_name, "/cmdline");
+      if( (file_ptr = fopen(pathbuf, "r")) != NULL ){
+         size_t got;
+         if((got = fread(p.cmdline, sizeof(char), ARG_MAX, file_ptr)) > 0 ){
+            size_t i;
+            
+            /* Replace \0 characters with spaces */
+            for(i = 0; i < got; i++){
+               if(p.cmdline[i] == '\0'){
+                  p.cmdline[i] = ' ';
+               }
+            }
+            
+            p.cmdline[got] = '\0';
+            trimr(p.cmdline);       /* Trim trailing whitespace */
+         }
+         fclose(file_ptr);
+      }
+
+      /* Get the /proc/PID/exe info (which is a link) */
+      sprintf(pathbuf, "%s%s%s", "/proc/", dirent_ptr->d_name, "/exe");
+      memset(p.exe, 0, sizeof(p.exe));
+      readlink(pathbuf, p.exe, sizeof(p.exe));
+
+      /* Get the /proc/PID/cwd info (which is a link) */
+      sprintf(pathbuf, "%s%s%s", "/proc/", dirent_ptr->d_name, "/cwd");
+      memset(p.cwd, 0, sizeof(p.cwd));
+      readlink(pathbuf, p.cwd, sizeof(p.cwd));
+
+      /* Get name, uid, euid, gid and gid info out of /proc/PID/status */
+      sprintf(pathbuf,"%s%s%s","/proc/",dirent_ptr->d_name,"/status");
+      if((file_ptr = fopen(pathbuf,"r")) != NULL ){
+         char line[ARG_MAX];
+         char dummy[ARG_MAX];
+
+         while(fgets(line, ARG_MAX - 1, file_ptr) != NULL){ 
+            if(!strncmp("Name", line, strlen("Name"))) { 
+               sscanf(line, "%s %s", dummy, p.name);
+            }
+            else if(!strncmp("Uid", line, strlen("Uid"))){ 
+               sscanf(line, "%s %d %d", dummy, &p.uid, &p.euid);
+            }
+            else if (!strncmp("Gid", line, strlen("Gid"))) { 
+               sscanf(line, "%s %d %d", dummy, &p.gid, &p.egid);
+            }
+         }
+         fclose(file_ptr);
+      }
+
+      /* Get the /proc/PID/stat info */
+      sprintf(pathbuf,"%s%s%s","/proc/",dirent_ptr->d_name,"/stat");
+      if((file_ptr = fopen(pathbuf,"r")) != NULL){
+         fscanf(file_ptr,
+            "%i %s %s %i %i\
+            %i %i %i %u %u\
+            %u %u %u %i %i\
+            %i %i %i %i %i\
+            %u %i %u %li %u\
+            %u %u %u %u %u\
+            %u %u %u %u %u\
+            %u %u %i %i",
+            &p.pid,        p.comm,       p.state,       &p.ppid,     &p.pgrp,
+            &p.session,    &p.tty_num,   &p.tpgid,      &p.flags,    &p.minflt,
+            &p.cminflt,    &p.majflt,    &p.cmajflt,    &p.utime,    &p.stime,
+            &p.cutime,     &p.cstime,    &p.priority,   &p.nice,     &temp,
+            &p.itrealvalue,&p.starttime, &p.vsize,      &p.rss,      &p.rlim,
+            &p.startcode,  &p.endcode,   &p.startstack, &p.kstkesp,  &p.kstkeip,
+            &p.signal,     &p.blocked,   &p.sigignore,  &p.sigcatch, &p.wchan,
+            &p.nswap,      &p.cnswap,    &p.exit_signal,&p.processor
+         );
+
+         fclose(file_ptr);
+      }
+
+      /* Get rid of the parens in the comm field */
+      strcpy(p.comm, strtok(p.comm,"()"));
+
+      /**********************************************************************
+       * Get the environ string out or /proc/PID/environ and make a hash
+       *  out of it
+       **********************************************************************/
+      sprintf(pathbuf, "%s%s%s", "/proc/", dirent_ptr->d_name, "/environ");
+      if((file_ptr = fopen( pathbuf, "r" )) != NULL){
+
+         int count;
+         char env_buf[ARG_MAX];
+         char key[MAX_ENV_NAME];
+         char *next_var, *value;
+
+         /* Get char count */
+         count = fread(env_buf, sizeof(char), ARG_MAX, file_ptr); 
+         next_var = env_buf;
+
+         while(next_var < env_buf + count){
+            value = strchr(next_var,'=');
+            /***************************************************************
+             * It's possible some environ files contain data that's not in
+             * the KEY=value format.  For such cases, we'll just set the
+             * string as the key, and set the corresponding value to nil.
+             ***************************************************************/
+            if(NULL == value){
+               rb_hash_aset(v_env, rb_str_new2(next_var), Qnil);
+               break;
+            }
+            strncpy(key, next_var, value - next_var);
+            key[value-next_var] = '\0';
+
+            ++value;
+            rb_hash_aset(v_env, rb_str_new2(key), rb_str_new2(value));
+            next_var += strlen(next_var) + 1;
+         }
+
+         fclose(file_ptr);
+      }
+
+      /* If cmdline is empty, use comm instead */
+      if(0 == strlen(p.cmdline))
+         strcpy(p.cmdline, p.comm);
+      
+      v_pstruct = proctable_get_process(&p, v_env);
+
+      if(rb_block_given_p())
+         rb_yield(v_pstruct);
+      else
+         rb_ary_push(v_array, v_pstruct);
+   }
+
+   closedir(dir_ptr);
+
+   /* If a process ID was provided and found, return a single struct */
+   if(!NIL_P(v_pid))
+      return v_pstruct;
+   
+   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){
+   unsigned int 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 */
+   sProc = rb_struct_define("ProcTableStruct","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",
+      NULL
+   );
+}
+
+#ifdef __cplusplus
+}
+#endif

data/lib/os/linux.h

@@ -0,0 +1,138 @@
+/************************************************************************
+ * linux.h
+ *
+ * Linux specific information, including struct layout.
+ ************************************************************************/
+#include <dirent.h>
+#include <linux/limits.h>
+#include <unistd.h>
+#include <string.h>
+#include <ctype.h>
+
+#ifndef CLK_TCK
+#define CLK_TCK sysconf(_SC_CLK_TCK)
+#endif
+
+#define MAX_ENV_NAME 128
+
+/**************************************************************************** 
+ * Note that the 20th field (between nice and itrealvalue) is not included
+ * in our struct.  It is a simple placeholder that was hardcoded for a
+ * removed field.  See the proc man page for more details.
+ *
+ * Also note that the environ attribute is not part of this struct, mostly
+ * because I wouldn't know what type to set it to.  It *is* part of the ruby
+ * struct, however.
+ ****************************************************************************/
+struct proc_info{
+   char cmdline[ARG_MAX];
+   char cwd[ARG_MAX];
+   char exe[ARG_MAX];
+   int pid;
+   char name[ARG_MAX];
+   int uid;
+   int euid;
+   int gid;
+   int egid;
+   char comm[ARG_MAX];
+   char state[1];
+   int ppid;
+   int pgrp;
+   int session;
+   int tty_num;
+   int tpgid;
+   unsigned flags;
+   unsigned minflt;
+   unsigned cminflt;
+   unsigned majflt;
+   unsigned cmajflt;
+   int utime;
+   int stime;
+   int cutime;
+   int cstime;
+   int priority;
+   int nice;
+   unsigned itrealvalue;
+   int starttime;
+   unsigned vsize;
+   long rss;
+   unsigned rlim;
+   unsigned startcode;
+   unsigned endcode;
+   unsigned startstack;
+   unsigned kstkesp;
+   unsigned kstkeip;
+   unsigned signal;
+   unsigned blocked;
+   unsigned sigignore;
+   unsigned sigcatch;
+   unsigned wchan;
+   unsigned nswap;
+   unsigned cnswap;
+   int exit_signal;
+   int processor;
+};
+
+/*****************************************************************************
+ * This array's only purpose is for the 'fields()' class method.  If there's
+ * a way to report fields out of our defined struct (sProc), please tell me
+ * how!
+ *****************************************************************************/
+char *fields[] = {
+   "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"
+};
+
+/* Helper function to remove trailing whitespace.  Use for cmdline info */
+void trimr(char* s){
+   char* p = s + strlen(s);
+   while(--p >= s && isspace(*p))
+      ;
+
+   *++p = 0;
+}