sys-cpu 0.6.4 → 0.7.0

data/CHANGES

@@ -1,3 +1,12 @@
+== 0.7.0 - 14-Dec-2011
+* Code base now uses FFI. However, HP-UX is not currently supported.
+  HP-UX users should continue to use the 0.6.x version. Note that
+  the code base remains unchanged on Linux and Windows.
+* The cpu_type method has been replaced with the architecture method
+  on Solaris to keep the interface more in line with other platforms.
+* The type method has been changed to cpu_type on Windows.
+* Some Rakefile and test suite updates.
+
 == 0.6.4 - 27-Sep-2011
 * The CPU.freq method now works on OSX.
 * The CPU.model method on OSX has been altered. Previously it

data/README

@@ -36,6 +36,10 @@
   Unlike other platforms, you can get load averages for an individual cpu in
   multi-cpu systems. See documentation for more details.
 
+  Note that version 0.7.x and later will not work on HP-UX because of the
+  switch to FFI and the lack of a testing platform. However, version 0.6.x
+  will work just fine.
+
 == MS Windows
   This is a pure Ruby implementation using the win32ole package + WMI. The C
   version has been scrapped. 
@@ -48,11 +52,11 @@
    
 = Acknowledgements
   Thanks go to the MPlayer team for some source code that helped me on
-  certain versions of FreeBSD.
+  certain versions of FreeBSD in the original C version.
 
 = Known Bugs
   None that I'm aware of. Please report bugs on the project page at
-  http://www.rubyforge.org/projects/sysutils.
+  https://github.com/djberg96/sys-cpu
 
 = Future Plans
   Add iterative CPU.processors method.

data/Rakefile

@@ -4,29 +4,7 @@ require 'rake/testtask'
 require 'rbconfig'
 include Config
 
-CLEAN.include(
-  '**/*.gem',               # Gem files
-  '**/*.rbc',               # Rubinius
-  'ext/cpu.c',              # Temporary file
-  '**/*.o',                 # C object file
-  '**/*.log',               # Ruby extension build log
-  '**/Makefile',            # C Makefile
-  '**/conftest.dSYM',       # OS X build directory
-  "**/*.#{CONFIG['DLEXT']}" # C shared object
-)
-
-desc "Build the sys-cpu library on UNIX systems"
-task :build => [:clean] do
-  Dir.chdir('ext') do
-    unless CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|windows|linux/i
-      ruby 'extconf.rb'
-      sh 'make'
-      build_file = 'cpu.' + CONFIG['DLEXT']
-      Dir.mkdir('sys') unless File.exists?('sys')
-      FileUtils.cp(build_file, 'sys')
-    end
-  end
-end
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx')
 
 namespace 'gem' do
   desc "Create the sys-cpu gem"
@@ -43,32 +21,25 @@ namespace 'gem' do
 end
 
 desc "Run the example program"
-task :example => [:build] do
-  Dir.mkdir('sys') unless File.exists?('sys')
-  if CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|windows|linux/i
-    if CONFIG['host_os'].match('linux')
-      cp 'lib/linux/sys/cpu.rb', 'sys' 
-    else
-      cp 'lib/windows/sys/cpu.rb', 'sys'
-    end
-  else
-    build_file = 'ext/cpu.' + CONFIG['DLEXT']
-    cp build_file, 'sys'
-  end
-
+task :example => [:clean] do
   case CONFIG['host_os']
-    when /bsd|darwin|mach|osx/i
-      file = 'examples/example_sys_cpu_bsd.rb'
-    when /hpux/i
-      file = 'examples/example_sys_cpu_hpux.rb'
-    when /linux/i
-      file = 'examples/example_sys_cpu_linux.rb'
-    when /sunos|solaris/i
-      file = 'examples/example_sys_cpu_sunos.rb'
-    when /mswin|win32|cygwin|mingw|dos/i
-      file = 'examples/example_sys_cpu_windows.rb'
+  when /bsd|darwin|osx/i
+    file = "examples/example_sys_cpu_bsd.rb"
+    sh "ruby -Ilib/unix #{file}"
+  when /hpux/i
+    file = "examples/example_sys_cpu_hpux.rb"
+    sh "ruby -Ilib/unix #{file}"
+  when /linux/i
+    file = "examples/example_sys_cpu_linux.rb"
+    sh "ruby -Ilib/linux #{file}"
+  when /windows|win32|cygwin|mingw|dos/i
+    file = "examples/example_sys_cpu_windows.rb"
+    sh "ruby -Ilib/windows #{file}"
+  when /sunos|solaris/i
+    file = "examples/example_sys_cpu_sunos.rb"
+    sh "ruby -Ilib/unix #{file}"
   end
-  sh "ruby -I. -Iext -Ilib #{file}"
+
 end
 
 Rake::TestTask.new do |t|
@@ -77,9 +48,7 @@ Rake::TestTask.new do |t|
   elsif CONFIG['host_os'] =~ /linux/i
     t.libs << 'lib/linux'
   else
-    task :test => :build
-    t.libs << 'ext'
-    t.libs.delete('lib')
+    t.libs << 'lib/unix'
   end
 
   t.libs << 'test'

data/doc/sunos.txt

@@ -9,7 +9,7 @@
    puts "Mhz: " + CPU.cpu_freq(0).to_s
    puts "State: " + CPU.state(0)
    puts "Number of cpu's on this system: " + CPU.num_cpu.to_s
-   puts "CPU type: " + CPU.type
+   puts "CPU type: " + CPU.architecture
    puts "FPU type: " + CPU.fpu_type
    puts "CPU model: " + CPU.model
    puts "Load averages: " + CPU.load_avg.join(", ")
@@ -23,7 +23,7 @@ CPU.freq(cpu_num=0)
    Returns an integer indicating the speed (i.e. frequency in Mhz) of
    'cpu_num', or CPU 0 if no number is provided.
     
-CPU.type
+CPU.architecture
    Returns a string indicating the type of processor.  This is the
    architecture (e.g. sparcv9), not the exact model (e.g. Ultra-IIe).
    Returns nil if not found.

data/doc/windows.txt

@@ -14,7 +14,7 @@
    puts "CPU Speed (Frequency): " + CPU.freq(0).to_s
    puts "Load avg: " + CPU.load_avg.to_s
    puts "Num CPU: " + CPU.num_cpu.to_s
-   puts "Type: " + CPU.type
+   puts "Type: " + CPU.cpu_type
    puts "Model: " + CPU.model
    puts "Architecture: " + CPU.architecture
     
@@ -98,7 +98,7 @@ CPU.processors(host=localhost){ |cpu| ... }
    Note that not all of these members will necessarily be defined.  See the
    NOTES section below.
     
-CPU.type(host=localhost)
+CPU.cpu_type(host=localhost)
     Returns a string indicating the type of processor, e.g. GenuineIntel.
     
 == Exception Classes

data/examples/example_sys_cpu_windows.rb

@@ -6,7 +6,8 @@
 #
 # Modify as you see fit.
 #######################################################################
-require "sys/cpu"
+require 'sys/cpu'
+require 'pp'
 include Sys
 
 puts "VERSION: " + CPU::VERSION
@@ -14,11 +15,11 @@ puts "========"
 
 puts "Architecture: " + CPU.architecture.to_s
 puts "CPU Speed (Frequency): " + CPU.freq.to_s
-puts "Load Average: " + CPU.load_average.to_s
+puts "Load Average: " + CPU.load_avg.to_s
 puts "Model: " + CPU.model.to_s
-puts "Type: " + CPU.type.to_s
+puts "Type: " + CPU.cpu_type.to_s
 puts "Num CPU: " + CPU.num_cpu.to_s
 
 CPU.processors{ |cpu|
-   p cpu
+   pp cpu
 }

data/lib/linux/sys/cpu.rb

@@ -42,7 +42,7 @@ module Sys
   class CPU
 
     # The version of the sys-cpu library.
-    VERSION = '0.6.4'
+    VERSION = '0.7.0'
 
     # :stopdoc:
 

data/lib/unix/sys/cpu.rb

@@ -0,0 +1,347 @@
+require 'ffi'
+require 'rbconfig'
+
+module Sys
+  class CPU
+    extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    # Error raised if any of the CPU methods fail.
+    class Error < StandardError; end
+
+    # The version of the sys-cpu library
+    VERSION = '0.7.0'
+
+    CTL_HW = 6 # Generic hardware/cpu
+
+    HW_MACHINE      = 1  # Machine class
+    HW_MODEL        = 2  # Specific machine model
+    HW_NCPU         = 3  # Number of CPU's
+    HW_CPU_FREQ     = 15 # CPU frequency
+
+    if RbConfig::CONFIG['host_os'] =~ /bsd/
+      HW_MACHINE_ARCH = 11 # Machine architecture
+    else
+      HW_MACHINE_ARCH = 12 # Machine architecture
+    end
+
+    SI_MACHINE          = 5
+    SI_ARCHITECTURE     = 6
+    SC_NPROCESSORS_ONLN = 15
+
+    P_OFFLINE  = 1
+    P_ONLINE   = 2
+    P_FAULTED  = 4
+    P_POWEROFF = 5
+    P_NOINTR   = 6
+    P_SPARE    = 7
+
+    CPU_ARCH_ABI64     = 0x01000000
+    CPU_TYPE_X86       = 7
+    CPU_TYPE_X86_64    = (CPU_TYPE_X86 | CPU_ARCH_ABI64)
+    CPU_TYPE_SPARC     = 14
+    CPU_TYPE_POWERPC   = 18
+    CPU_TYPE_POWERPC64 = CPU_TYPE_POWERPC | CPU_ARCH_ABI64
+
+    begin
+      attach_function(
+        :sysctl,
+        [:pointer, :uint, :pointer, :pointer, :pointer, :size_t],
+        :int
+      )
+      private_class_method :sysctl
+    rescue FFI::NotFoundError
+      # Do nothing, not supported on this platform.
+    end
+
+    begin
+      attach_function(
+        :sysctlbyname,
+        [:string, :pointer, :pointer, :pointer, :size_t],
+        :int
+      )
+      private_class_method :sysctlbyname
+    rescue FFI::NotFoundError
+      # Do nothing, not supported on this platform.
+    end
+
+    # Solaris
+    begin
+      attach_function :getloadavg, [:pointer, :int], :int
+      attach_function :processor_info, [:int, :pointer], :int
+      attach_function :sysconf, [:int], :long
+      attach_function :sysinfo, [:int, :pointer, :long], :int
+
+      private_class_method :getloadavg
+      private_class_method :processor_info
+      private_class_method :sysconf
+      private_class_method :sysinfo
+    rescue FFI::NotFoundError
+      # Do nothing, not supported on this platform.
+    end
+
+    class ProcInfo < FFI::Struct
+      layout(
+        :pi_state, :int,
+        :pi_processor_type, [:char, 16],
+        :pi_fputypes, [:char, 32],
+        :pi_clock, :int
+      )
+    end
+
+    def self.architecture
+      if respond_to?(:sysinfo, true)
+        buf = 0.chr * 257
+
+        if sysinfo(SI_ARCHITECTURE, buf, buf.size) < 0
+          raise Error, "sysinfo function failed"
+        end
+
+        buf.strip
+      elsif respond_to?(:sysctlbyname, true)
+        optr = FFI::MemoryPointer.new(:char, 256)
+        size = FFI::MemoryPointer.new(:size_t)
+
+        size.write_int(optr.size)
+
+        if RbConfig::CONFIG['host_os'] =~ /darwin/i
+          name = 'hw.machine'
+        else
+          name = 'hw.machine_arch'
+        end
+
+        if sysctlbyname(name, optr, size, nil, 0) < 0
+          raise Error, "sysctlbyname function failed"
+        end
+
+        optr.read_string
+      else
+        buf  = 0.chr * 64
+        mib  = FFI::MemoryPointer.new(:int, 2)
+        size = FFI::MemoryPointer.new(:long, 1)
+
+        mib.write_array_of_int([CTL_HW, HW_MACHINE_ARCH])
+        size.write_int(buf.size)
+
+        if sysctl(mib, 2, buf, size, nil, 0) < 0
+          raise Error, "sysctl function failed"
+        end
+
+        buf.strip
+      end
+    end
+
+    def self.num_cpu
+      if respond_to?(:sysctlbyname, true)
+        optr = FFI::MemoryPointer.new(:long)
+        size = FFI::MemoryPointer.new(:size_t)
+
+        size.write_long(optr.size)
+
+        if sysctlbyname('hw.ncpu', optr, size, nil, 0) < 0
+          raise Error, "sysctlbyname failed"
+        end
+
+        optr.read_long
+      elsif respond_to?(:sysconf, true)
+        num = sysconf(SC_NPROCESSORS_ONLN)
+
+        if num < 0
+          raise Error, "sysconf function failed"
+        end
+
+        num
+      else
+        buf  = 0.chr * 4
+        mib  = FFI::MemoryPointer.new(:int, 2)
+        size = FFI::MemoryPointer.new(:long, 1)
+
+        mib.write_array_of_int([CTL_HW, HW_NCPU])
+        size.write_int(buf.size)
+
+        if sysctl(mib, 2, buf, size, nil, 0) < 0
+          raise Error, "sysctl function failed"
+        end
+
+        buf.strip.unpack("C").first
+      end
+    end
+
+    def self.machine
+      if respond_to?(:sysctl, true)
+        buf  = 0.chr * 32
+        mib  = FFI::MemoryPointer.new(:int, 2)
+        size = FFI::MemoryPointer.new(:long, 1)
+
+        mib.write_array_of_int([CTL_HW, HW_MACHINE])
+        size.write_int(buf.size)
+
+        if sysctl(mib, 2, buf, size, nil, 0) < 0
+          raise Error, "sysctl function failed"
+        end
+
+        buf.strip
+      else
+        buf = 0.chr * 257
+
+        if sysinfo(SI_MACHINE, buf, buf.size) < 0
+          raise Error, "sysinfo function failed"
+        end
+
+        buf.strip
+      end
+    end
+
+    def self.model
+      if RbConfig::CONFIG['host_os'] =~ /darwin/i
+        ptr  = FFI::MemoryPointer.new(:long)
+        size = FFI::MemoryPointer.new(:size_t)
+
+        size.write_long(ptr.size)
+
+        if sysctlbyname("hw.cputype", ptr, size, nil, 0) < 0
+          raise "sysctlbyname function failed"
+        end
+
+        case ptr.read_long
+          when  CPU_TYPE_X86, CPU_TYPE_X86_64
+            "Intel"
+          when CPU_TYPE_SPARC
+            "Sparc"
+          when CPU_TYPE_POWERPC, CPU_TYPE_POWERPC64
+            "PowerPC"
+          else
+            "Unknown"
+        end
+      else
+        if respond_to?(:sysctl, true)
+          buf  = 0.chr * 64
+          mib  = FFI::MemoryPointer.new(:int, 2)
+          size = FFI::MemoryPointer.new(:long, 1)
+
+          mib.write_array_of_int([CTL_HW, HW_MODEL])
+          size.write_int(buf.size)
+
+          if sysctl(mib, 2, buf, size, nil, 0) < 0
+            raise Error, "sysctl function failed"
+          end
+
+          buf.strip
+        else
+          pinfo = ProcInfo.new
+
+          # Some systems start at 0, some at 1
+          if processor_info(0, pinfo) < 0
+            if processor_info(1, pinfo) < 0
+              raise Error, "process_info function failed"
+            end
+          end
+
+          pinfo[:pi_processor_type].to_s
+        end
+      end
+    end
+
+    def self.freq
+      if respond_to?(:sysctlbyname, true)
+        optr = FFI::MemoryPointer.new(:long)
+        size = FFI::MemoryPointer.new(:size_t)
+
+        size.write_long(optr.size)
+
+        if RbConfig::CONFIG['host_os'] =~ /bsd/i
+          name = 'hw.clockrate'
+        else
+          name = 'hw.cpufrequency'
+        end
+
+        if sysctlbyname(name, optr, size, nil, 0) < 0
+          raise Error, "sysctlbyname failed"
+        end
+
+        if RbConfig::CONFIG['host_os'] =~ /darwin/i
+          optr.read_long / 1000000
+        else
+          optr.read_long
+        end
+      elsif respond_to?(:sysctl, true)
+        buf  = 0.chr * 16
+        mib  = FFI::MemoryPointer.new(:int, 2)
+        size = FFI::MemoryPointer.new(:long, 1)
+
+        mib.write_array_of_int([CTL_HW, HW_CPU_FREQ])
+        size.write_int(buf.size)
+
+        if sysctl(mib, 2, buf, size, nil, 0) < 0
+          raise Error, "sysctl function failed"
+        end
+
+        buf.unpack("I*").first / 1000000
+      else
+        pinfo = ProcInfo.new
+
+        # Some systems start at 0, some at 1
+        if processor_info(0, pinfo) < 0
+          if processor_info(1, pinfo) < 0
+            raise Error, "process_info function failed"
+          end
+        end
+
+        pinfo[:pi_clock].to_i
+      end
+    end
+
+    def self.load_avg
+      if respond_to?(:getloadavg, true)
+        loadavg = FFI::MemoryPointer.new(:double, 3)
+
+        if getloadavg(loadavg, loadavg.size) < 0
+          raise Error, "getloadavg function failed"
+        end
+
+        loadavg.get_array_of_double(0, 3)
+      end
+    end
+
+    def self.fpu_type
+      raise NoMethodError unless respond_to?(:processor_info, true)
+
+      pinfo = ProcInfo.new
+
+      if processor_info(0, pinfo) < 0
+        if processor_info(1, pinfo) < 0
+          raise Error, "process_info function failed"
+        end
+      end
+
+      pinfo[:pi_fputypes].to_s
+    end
+
+    def self.state(num = 0)
+      raise NoMethodError unless respond_to?(:processor_info, true)
+
+      pinfo = ProcInfo.new
+
+      if processor_info(num, pinfo) < 0
+        raise Error, "process_info function failed"
+      end
+
+      case pinfo[:pi_state].to_i
+        when P_ONLINE
+          "online"
+        when P_OFFLINE
+          "offline"
+        when P_POWEROFF
+          "poweroff"
+        when P_FAULTED
+          "faulted"
+        when P_NOINTR
+          "nointr"
+        when P_SPARE
+          "spare"
+        else
+          "unknown"
+      end
+    end
+  end
+end