Class: Sys::ProcTable

Inherits:

Object

• Object
• Sys::ProcTable

Extended by:

FFI::Library

Defined in:

lib/darwin/sys/proctable.rb,
lib/sys/proctable/version.rb

Defined Under Namespace

Classes: Error, ProcBsdInfo, ProcTableStruct, ProcTaskAllInfo, ProcTaskInfo, ProcThreadInfo, ThreadInfoStruct

Constant Summary

VERSION =

The version of the sys-proctable library

'1.1.4'.freeze

Class Method Summary

• .fields ⇒ Object

  Returns an array of fields that each ProcTableStruct will contain.

• .ps(pid = nil) ⇒ Object

  In block form, yields a ProcTableStruct for each process entry that you have rights to.

Class Method Details

.fields ⇒ Object

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}"
}

# File 'lib/darwin/sys/proctable.rb', line 141

def self.fields
  @fields
end

.ps(pid = nil) ⇒ Object

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)

Raises:

• (TypeError)

# File 'lib/darwin/sys/proctable.rb', line 162

def self.ps(pid = nil)
  raise TypeError unless pid.is_a?(Fixnum) 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])

    # Chop the leading xx_ from the FFI struct members for our ruby struct.
    info.members.each do |nested|
      info[nested].members.each do |member|
        temp = member.to_s.split('_')
        sproperty = temp.size > 1 ? temp[1..-1].join('_') : temp.first
        if info[nested][member].is_a?(FFI::StructLayout::CharArray)
          struct[sproperty.to_sym] = info[nested][member].to_s
        else
          struct[sproperty.to_sym] = 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