sys-proctable 0.7.6 → 1.2.0

data/lib/darwin/sys/proctable.rb

@@ -0,0 +1,363 @@
+require 'sys/proctable/version'
+require 'ffi'
+
+module Sys
+  class ProcTable
+    extend FFI::Library
+
+    # Error typically raised if the ProcTable.ps method fails.
+    class Error < StandardError; end
+
+    # There is no constructor
+    private_class_method :new
+
+    private
+
+    PROC_PIDTASKALLINFO = 2
+    PROC_PIDTHREADINFO  = 5
+    PROC_PIDLISTTHREADS = 6
+
+    CTL_KERN       = 1
+    KERN_PROCARGS  = 38
+    KERN_PROCARGS2 = 49
+    MAXCOMLEN      = 16
+    MAXPATHLEN     = 256
+
+    MAXTHREADNAMESIZE = 64
+    PROC_PIDPATHINFO_MAXSIZE = MAXPATHLEN * 4
+
+    class ProcBsdInfo < FFI::Struct
+      layout(
+        :pbi_flags, :uint32_t,
+        :pbi_status, :uint32_t,
+        :pbi_xstatus, :uint32_t,
+        :pbi_pid, :uint32_t,
+        :pbi_ppid, :uint32_t,
+        :pbi_uid, :uid_t,
+        :pbi_gid, :uid_t,
+        :pbi_ruid, :uid_t,
+        :pbi_rgid, :gid_t,
+        :pbi_svuid, :uid_t,
+        :pbi_svgid, :gid_t,
+        :rfu1, :uint32_t,
+        :pbi_comm, [:char, MAXCOMLEN],
+        :pbi_name, [:char, MAXCOMLEN * 2],
+        :pbi_nfiles, :uint32_t,
+        :pbi_pgid, :uint32_t,
+        :pbi_pjobc, :uint32_t,
+        :e_tdev, :uint32_t,
+        :e_tpgid, :uint32_t,
+        :pbi_nice, :int32_t,
+        :pbi_start_tvsec, :uint64_t,
+        :pbi_start_tvusec, :uint64_t
+      )
+    end
+
+    class ProcTaskInfo < FFI::Struct
+      layout(
+        :pti_virtual_size, :uint64_t,
+        :pti_resident_size, :uint64_t,
+        :pti_total_user, :uint64_t,
+        :pti_total_system, :uint64_t,
+        :pti_threads_user, :uint64_t,
+        :pti_threads_system, :uint64_t,
+        :pti_policy, :int32_t,
+        :pti_faults, :int32_t,
+        :pti_pageins, :int32_t,
+        :pti_cow_faults, :int32_t,
+        :pti_messages_sent, :int32_t,
+        :pti_messages_received, :int32_t,
+        :pti_syscalls_mach, :int32_t,
+        :pti_syscalls_unix, :int32_t,
+        :pti_csw, :int32_t,
+        :pti_threadnum, :int32_t,
+        :pti_numrunning, :int32_t,
+        :pti_priority, :int32_t
+      )
+    end
+
+    class ProcThreadInfo < FFI::Struct
+      layout(
+        :pth_user_time, :uint64_t,
+        :pth_system_time, :uint64_t,
+        :pth_cpu_usage, :int32_t,
+        :pth_policy, :int32_t,
+        :pth_run_state, :int32_t,
+        :pth_flags, :int32_t,
+        :pth_sleep_time, :int32_t,
+        :pth_curpri, :int32_t,
+        :pth_priority, :int32_t,
+        :pth_maxpriority, :int32_t,
+        :pth_name, [:char, MAXTHREADNAMESIZE]
+      )
+    end
+
+    # Map the fields from the FFI::Structs to the Sys::ProcTable struct on
+    # class load to reduce the amount of objects needing to be generated for
+    # each invocation of Sys::ProcTable.ps
+    all_members           = ProcBsdInfo.members + ProcTaskInfo.members + ProcThreadInfo.members
+    PROC_STRUCT_FIELD_MAP = all_members.map { |member|
+                              temp = member.to_s.split('_')
+                              sproperty = temp.size > 1 ? temp[1..-1].join('_') : temp.first
+                              [member, sproperty.to_sym]
+                            }.to_h
+
+    class ProcTaskAllInfo < FFI::Struct
+      layout(:pbsd, ProcBsdInfo, :ptinfo, ProcTaskInfo)
+    end
+
+    ffi_lib 'proc'
+
+    attach_function :proc_listallpids, [:pointer, :int], :int
+    attach_function :proc_pidinfo, [:int, :int, :uint64_t, :pointer, :int], :int
+
+    ffi_lib FFI::Library::LIBC
+
+    attach_function :sysctl, [:pointer, :uint, :pointer, :pointer, :pointer, :size_t], :int
+
+    # These mostly mimic the struct members, but we've added a few custom ones as well.
+    @fields = %w[
+      flags status xstatus pid ppid uid gid ruid rgid svuid svgid rfu1 comm
+      name nfiles pgid pjobc tdev tpgid nice start_tvsec start_tvusec
+      virtual_size resident_size total_user total_system threads_user
+      threads_system policy faults pageins cow_faults messages_sent
+      messages_received syscalls_mach syscalls_unix csw threadnum numrunning
+      priority cmdline exe environ threadinfo
+    ]
+
+    # Add a couple aliases to make it similar to Linux
+    ProcTableStruct = Struct.new("ProcTableStruct", *@fields) do
+      alias vsize virtual_size
+      alias rss resident_size
+    end
+
+    ThreadInfoStruct = Struct.new("ThreadInfo", :user_time, :system_time,
+      :cpu_usage, :policy, :run_state, :flags, :sleep_time, :curpri,
+      :priority, :maxpriority, :name
+    )
+
+    public
+
+    # 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 process table.
+    #
+    # Example:
+    #
+    #   Sys::ProcTable.fields.each{ |field|
+    #      puts "Field: #{field}"
+    #   }
+    #
+    def self.fields
+      @fields
+    end
+
+    # 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(pid: 1001)
+    #
+    #   # Same as above, but do not include thread information
+    #   p ProcTable.ps(pid: 1001, thread_info: false)
+    #
+    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 : []
+
+      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
+            raise SystemCallError.new('proc_pidinfo', FFI.errno)
+          end
+        end
+
+        # Avoid potentially invalid data
+        next if nb != info.size
+
+        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
+            else
+              struct[PROC_STRUCT_FIELD_MAP[member]] = info[nested][member]
+            end
+          end
+        end
+
+        struct.freeze
+
+        if block_given?
+          yield struct
+        else
+          array << struct
+        end
+      end
+
+      return nil if array.nil?
+      pid ? array.first : array
+    end
+
+    private
+
+    # Returns an array of ThreadInfo objects for the given pid.
+    #
+    def self.get_thread_info(pid, struct, ptinfo)
+      buf = FFI::MemoryPointer.new(:uint64_t, ptinfo[:pti_threadnum])
+      num = proc_pidinfo(pid, PROC_PIDLISTTHREADS, 0, buf, buf.size)
+
+      if num <= 0
+        if [Errno::EPERM::Errno, Errno::ESRCH::Errno].include?(FFI.errno)
+          return # Either we don't have permission, or the pid no longer exists
+        else
+          raise SystemCallError.new('proc_pidinfo', FFI.errno)
+        end
+      end
+
+      max = ptinfo[:pti_threadnum]
+      struct[:threadinfo] = []
+
+      0.upto(max-1) do |index|
+        tinfo = ProcThreadInfo.new
+        nb = proc_pidinfo(pid, PROC_PIDTHREADINFO, buf[index].read_uint64, tinfo, tinfo.size)
+
+        if nb <= 0
+          if [Errno::EPERM::Errno, Errno::ESRCH::Errno].include?(FFI.errno)
+            return # Either we don't have permission, or the pid no longer exists
+          else
+            raise SystemCallError.new('proc_pidinfo', FFI.errno)
+          end
+        end
+
+        tinfo_struct = ThreadInfoStruct.new(
+          tinfo[:pth_user_time],
+          tinfo[:pth_system_time],
+          tinfo[:pth_cpu_usage],
+          tinfo[:pth_policy],
+          tinfo[:pth_run_state],
+          tinfo[:pth_flags],
+          tinfo[:pth_sleep_time],
+          tinfo[:pth_curpri],
+          tinfo[:pth_priority],
+          tinfo[:pth_maxpriority],
+          tinfo[:pth_name].to_s,
+        )
+
+        struct[:threadinfo] << tinfo_struct
+      end
+    end
+
+    # Get the command line arguments, as well as the environment settings,
+    # for the given PID.
+    #
+    def self.get_cmd_args_and_env(pid, struct)
+      len = FFI::MemoryPointer.new(:size_t)
+      mib = FFI::MemoryPointer.new(:int, 3)
+
+      # Since we may not have access to the process information due
+      # to improper privileges, just bail if we see a failure here.
+
+      # First use KERN_PROCARGS2 to discover the argc value of the running process.
+      mib.write_array_of_int([CTL_KERN, KERN_PROCARGS2, pid])
+      return if sysctl(mib, 3, nil, len, nil, 0) < 0
+
+      buf = FFI::MemoryPointer.new(:char, len.read_ulong)
+      return if sysctl(mib, 3, buf, len, nil, 0) < 0
+
+      # The argc value is located in the first byte of buf
+      argc = buf.read_bytes(1).ord
+      buf.free
+
+      # Now use KERN_PROCARGS to fetch the rest of the process information
+      mib.write_array_of_int([CTL_KERN, KERN_PROCARGS, pid])
+      return if sysctl(mib, 3, nil, len, nil, 0) < 0
+
+      buf = FFI::MemoryPointer.new(:char, len.read_ulong)
+      return if sysctl(mib, 3, buf, len, nil, 0) < 0
+
+      exe = buf.read_string # Read up to first null, does not include args
+      struct[:exe] = exe
+
+      # Parse the rest of the information out of a big, ugly string
+      array = buf.read_bytes(len.read_ulong).split(0.chr)
+      array.delete('') # Delete empty strings
+
+      # The format that sysctl outputs is as follows:
+      #
+      #   [full executable path]
+      #   [executable name]
+      #   [arguments]
+      #   [environment variables]
+      #   ...
+      #   \FF\BF
+      #   [full executable path]
+      #
+      # Strip the first executable path and the last two entries from the array.
+      # What is left is the name, arguments, and environment variables
+      array = array[1..-3]
+
+      # It seems that argc sometimes returns a bogus value. In that case, delete
+      # any environment variable strings, and reset the argc value.
+      #
+      if argc > array.size
+        array.delete_if{ |e| e.include?('=') }
+        argc = array.size
+      end
+
+      cmdline = ''
+
+      # Extract the full command line and its arguments from the array
+      argc.times do
+        cmdline << ' ' + array.shift
+      end
+
+      struct[:cmdline] = cmdline.strip
+
+      # Anything remaining at this point is a collection of key=value
+      # pairs which we convert into a hash.
+      environ = array.inject({}) do |hash, string|
+        if string && string.include?('=')
+          key, value = string.split('=')
+          hash[key] = value
+        end
+        hash
+      end
+
+      struct[:environ] = environ
+    end
+  end
+end

data/lib/freebsd/sys/proctable.rb

@@ -0,0 +1,363 @@
+require 'ffi'
+require 'sys/proctable/version'
+
+module Sys
+  class ProcTable
+    extend FFI::Library
+
+    # Error typically raised if the ProcTable.ps method fails.
+    class Error < StandardError; end
+
+    # There is no constructor
+    private_class_method :new
+
+    private
+
+    ffi_lib :kvm
+
+    attach_function :devname, [:dev_t, :mode_t], :string
+    attach_function :kvm_open, [:string, :string, :string, :int, :string], :pointer
+    attach_function :kvm_close, [:pointer], :int
+    attach_function :kvm_getprocs, [:pointer, :int, :int, :pointer], :pointer
+    attach_function :kvm_getargv, [:pointer, :pointer, :int], :pointer
+
+    POSIX_ARG_MAX = 4096
+
+    KERN_PROC_PID  = 1
+    KERN_PROC_PROC = 8
+
+    S_IFCHR = 0020000
+
+    WMESGLEN       = 8
+    LOCKNAMELEN    = 8
+    OCOMMLEN       = 16
+    COMMLEN        = 19
+    KI_EMULNAMELEN = 16
+    KI_NGROUPS     = 16
+    LOGNAMELEN     = 17
+    KI_NSPARE_INT  = 9
+    KI_NSPARE_LONG = 12
+    KI_NSPARE_PTR  = 6
+
+    class Timeval < FFI::Struct
+      layout(:tv_sec, :time_t, :tv_usec, :suseconds_t)
+    end
+
+    class Priority < FFI::Struct
+      layout(
+        :pri_class, :uchar,
+        :pri_level, :uchar,
+        :pri_native, :uchar,
+        :pri_user, :uchar
+      )
+    end
+
+    class Rusage < FFI::Struct
+      layout(
+        :ru_utime, Timeval,
+        :ru_stime, Timeval,
+        :ru_maxrss, :long,
+        :ru_ixrss, :long,
+        :ru_idrss, :long,
+        :ru_isrss, :long,
+        :ru_minflt, :long,
+        :ru_majflt, :long,
+        :ru_nswap, :long,
+        :ru_inblock, :long,
+        :ru_oublock, :long,
+        :ru_msgsnd, :long,
+        :ru_msgrcv, :long,
+        :ru_nsignals, :long,
+        :ru_nvcsw, :long,
+        :ru_nivcsw, :long
+      )
+    end
+
+    class Pargs < FFI::Struct
+      layout(
+        :ar_ref, :uint,
+        :ar_length, :uint,
+        :ar_args, [:uchar,1]
+      )
+    end
+
+    class KInfoProc < FFI::Struct
+      layout(
+        :ki_structsize, :int,
+        :ki_layout, :int,
+        :ki_args, :pointer,
+        :ki_paddr, :pointer,
+        :ki_addr, :pointer,
+        :ki_tracep, :pointer,
+        :ki_textvp, :pointer,
+        :ki_fd, :pointer,
+        :ki_vmspace, :pointer,
+        :ki_wchan, :pointer,
+        :ki_pid, :pid_t,
+        :ki_ppid, :pid_t,
+        :ki_pgid, :pid_t,
+        :ki_tpgid, :pid_t,
+        :ki_sid, :pid_t,
+        :ki_tsid, :pid_t,
+        :ki_jobc, :short,
+        :ki_spare_short1, :short,
+        :ki_tdev, :dev_t,
+        :ki_siglist, [:uint32_t, 4],
+        :ki_sigmask, [:uint32_t, 4],
+        :ki_sigignore, [:uint32_t, 4],
+        :ki_sigcatch, [:uint32_t, 4],
+        :ki_uid, :uid_t,
+        :ki_ruid, :uid_t,
+        :ki_svuid, :uid_t,
+        :ki_rgid, :gid_t,
+        :ki_svgid, :gid_t,
+        :ki_ngroups, :short,
+        :ki_spare_short2, :short,
+        :ki_groups, [:gid_t, KI_NGROUPS],
+        :ki_size, :uint32_t,
+        :ki_rssize, :segsz_t,
+        :ki_swrss, :segsz_t,
+        :ki_tsize, :segsz_t,
+        :ki_dsize, :segsz_t,
+        :ki_ssize, :segsz_t,
+        :ki_xstat, :u_short,
+        :ki_acflag, :u_short,
+        :ki_pctcpu, :fixpt_t,
+        :ki_estcpu, :uint,
+        :ki_slptime, :uint,
+        :ki_swtime, :uint,
+        :ki_swtime, :int,
+        :ki_runtime, :uint64_t,
+        :ki_start, Timeval,
+        :ki_childtime, Timeval,
+        :ki_flag, :long,
+        :ki_kiflag, :long,
+        :ki_traceflag, :int,
+        :ki_stat, :char,
+        :ki_nice, :char,
+        :ki_lock, :char,
+        :ki_rqindex, :char,
+        :ki_oncpu, :uchar,
+        :ki_lastcpu, :uchar,
+        :ki_ocomm, [:char, OCOMMLEN+1],
+        :ki_wmesg, [:char, WMESGLEN+1],
+        :ki_login, [:char, LOGNAMELEN+1],
+        :ki_lockname, [:char, LOCKNAMELEN+1],
+        :ki_comm, [:char, COMMLEN+1],
+        :ki_emul, [:char, KI_EMULNAMELEN+1],
+        :ki_sparestrings, [:char, 68],
+        :ki_spareints, [:int, KI_NSPARE_INT],
+        :ki_cr_flags, :uint,
+        :ki_jid, :int,
+        :ki_numthreads, :int,
+        :ki_tid, :pid_t,
+        :ki_pri, Priority,
+        :ki_rusage, Rusage,
+        :ki_rusage_ch, Rusage,
+        :ki_pcb, :pointer,
+        :ki_kstack, :pointer,
+        :ki_udata, :pointer,
+        :ki_tdaddr, :pointer,
+        :ki_spareptrs, [:pointer, KI_NSPARE_PTR],
+        :ki_sparelongs, [:long, KI_NSPARE_LONG],
+        :ki_sflags, :long,
+        :ki_tdflags, :long
+      )
+    end
+
+    @fields = %w[
+      pid ppid pgid tpgid sid tsid jobc uid ruid rgid
+      ngroups groups size rssize swrss tsize dsize ssize
+      xstat acflag pctcpu estcpu slptime swtime runtime start
+      flag state nice lock rqindex oncpu lastcpu wmesg login
+      lockname comm ttynum ttydev jid priority usrpri cmdline
+      utime stime maxrss ixrss idrss isrss minflt majflt nswap
+      inblock oublock msgsnd msgrcv nsignals nvcsw nivcsw
+    ]
+
+    ProcTableStruct = Struct.new('ProcTableStruct', *@fields)
+
+    public
+
+    # 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(**kwargs)
+      pid = kwargs[:pid]
+
+      begin
+        kd = kvm_open(nil, nil, nil, 0, nil)
+
+        if kd.null?
+          raise SystemCallError.new('kvm_open', FFI.errno)
+        end
+
+        ptr = FFI::MemoryPointer.new(:int) # count
+
+        if pid
+          procs = kvm_getprocs(kd, KERN_PROC_PID, pid, ptr)
+        else
+          procs = kvm_getprocs(kd, KERN_PROC_PROC, 0, ptr)
+        end
+
+        if procs.null?
+          if pid && FFI.errno == Errno::ESRCH::Errno
+            return nil
+          else
+            raise SystemCallError.new('kvm_getprocs', FFI.errno)
+          end
+        end
+
+        count = ptr.read_int
+        array = []
+
+        0.upto(count-1){ |i|
+          cmd = nil
+          kinfo = KInfoProc.new(procs[i * KInfoProc.size])
+
+          args = kvm_getargv(kd, kinfo, 0)
+
+          unless args.null?
+            cmd = []
+
+            until ((ptr = args.read_pointer).null?)
+              cmd << ptr.read_string
+              args += FFI::Type::POINTER.size
+            end
+
+            cmd = cmd.join(' ')
+          end
+
+          struct = ProcTableStruct.new(
+            kinfo[:ki_pid],
+            kinfo[:ki_ppid],
+            kinfo[:ki_pgid],
+            kinfo[:ki_tpgid],
+            kinfo[:ki_sid],
+            kinfo[:ki_tsid],
+            kinfo[:ki_jobc],
+            kinfo[:ki_uid],
+            kinfo[:ki_ruid],
+            kinfo[:ki_rgid],
+            kinfo[:ki_ngroups],
+            kinfo[:ki_groups].to_a[0...kinfo[:ki_ngroups]],
+            kinfo[:ki_size],
+            kinfo[:ki_rssize],
+            kinfo[:ki_swrss],
+            kinfo[:ki_tsize],
+            kinfo[:ki_dsize],
+            kinfo[:ki_ssize],
+            kinfo[:ki_xstat],
+            kinfo[:ki_acflag],
+            kinfo[:ki_pctcpu].to_f,
+            kinfo[:ki_estcpu],
+            kinfo[:ki_slptime],
+            kinfo[:ki_swtime],
+            kinfo[:ki_runtime],
+            Time.at(kinfo[:ki_start][:tv_sec]),
+            kinfo[:ki_flag],
+            get_state(kinfo[:ki_stat]),
+            kinfo[:ki_nice],
+            kinfo[:ki_lock],
+            kinfo[:ki_rqindex],
+            kinfo[:ki_oncpu],
+            kinfo[:ki_lastcpu],
+            kinfo[:ki_wmesg].to_s,
+            kinfo[:ki_login].to_s,
+            kinfo[:ki_lockname].to_s,
+            kinfo[:ki_comm].to_s,
+            kinfo[:ki_tdev],
+            devname(kinfo[:ki_tdev], S_IFCHR),
+            kinfo[:ki_jid],
+            kinfo[:ki_pri][:pri_level],
+            kinfo[:ki_pri][:pri_user],
+            cmd,
+            kinfo[:ki_rusage][:ru_utime][:tv_sec],
+            kinfo[:ki_rusage][:ru_stime][:tv_sec],
+            kinfo[:ki_rusage][:ru_maxrss],
+            kinfo[:ki_rusage][:ru_ixrss],
+            kinfo[:ki_rusage][:ru_idrss],
+            kinfo[:ki_rusage][:ru_isrss],
+            kinfo[:ki_rusage][:ru_minflt],
+            kinfo[:ki_rusage][:ru_majflt],
+            kinfo[:ki_rusage][:ru_nswap],
+            kinfo[:ki_rusage][:ru_inblock],
+            kinfo[:ki_rusage][:ru_oublock],
+            kinfo[:ki_rusage][:ru_msgsnd],
+            kinfo[:ki_rusage][:ru_msgrcv],
+            kinfo[:ki_rusage][:ru_nsignals],
+            kinfo[:ki_rusage][:ru_nvcsw],
+            kinfo[:ki_rusage][:ru_nivcsw]
+          )
+
+          struct.freeze # This is readonly data
+
+          if block_given?
+            yield struct
+          else
+            array << struct
+          end
+        }
+      ensure
+        kvm_close(kd) unless kd.null?
+      end
+
+      if block_given?
+        nil
+      else
+        pid ? array.first : array
+      end
+    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
+
+    private
+
+    SIDL   = 1
+    SRUN   = 2
+    SSLEEP = 3
+    SSTOP  = 4
+    SZOMB  = 5
+    SWAIT  = 6
+    SLOCK  = 7
+
+    def self.get_state(int)
+      case int
+        when SIDL; "idle"
+        when SRUN; "run"
+        when SSLEEP; "sleep"
+        when SSTOP; "stop"
+        when SZOMB; "zombie"
+        when SWAIT; "waiting"
+        when SLOCK; "locked"
+        else; "unknown"
+      end
+    end
+  end
+end