sys-cpu 0.6.4-universal-linux

data/CHANGES

@@ -0,0 +1,159 @@
+== 0.6.4 - ???
+* The CPU.freq method now works on OSX.
+* The CPU.model method on OSX has been altered. Previously it
+  returned the machine model. However, the information is limited.
+* Fixed a couple unused variable warnings for the BSD/OSX code.
+* Refactored the clean task in the Rakefile.
+
+== 0.6.3 - 9-Oct-2010
+* Fixed a bug in the install.rb file and refactored it a bit. Thanks go
+  to Di-an Jan for the spot. Note, however, that this file will eventually
+  be removed and/or integrated into the Linux source file.
+* Fixed the example Rake task, and refactored some of the other tasks.
+* Fixed and updated the CPU.architecture method on MS Windows to handle IA64
+  and x64 architectures.
+
+== 0.6.2 - 1-Jan-2010
+* Fixed a bug in the cpu_freq function (which would only be noticed on
+  certain platforms in cases where the CPU.freq method failed). Thanks
+  go to Edho P Arief for the spot.
+* Explicitly add sys/param.h on OpenBSD, and default to the HW_MODEL mib
+  because HW_MACHINE does not exist. Thanks go to Edho P Arief for the patch.
+* Updated my support notes. In short I will support 1.8.6 and 1.9.x. I will
+  not support any 1.8.x branch later than 1.8.6.
+* Removed redundant information in the various .txt files that is already
+  covered in the README file.
+* Test files renamed.
+* Added test-unit 2.x as a development dependency.
+
+== 0.6.1 - 4-Jan-2009
+* Fix for OS X 10.5.x. Thanks go to Victor Costan for the spot and the patch.
+* Updated the gemspec and some other minor changes.
+* On MS Windows the impersonation level is now explicitly set to 'impersonate'
+  to avoid issues where systems might be using an older version of WMI.
+
+== 0.6.0 - 26-Apr-2007
+* Added support for most BSD flavors, including OS X. The freebsd.c file is
+  now just bsd.c.
+* The CPU.type method for Solaris has been changed to CPU.cpu_type to avoid
+  conflicting with the Object.type method.
+* Added a Rakefile. There are now tasks for building, testing and installing,
+  among other things. Run 'rake -T' to check your options.
+* Many internal directory layout changes - C source files are now under the
+  'ext' directory.
+* Improved RDoc comments in the C source files.
+* Changed CPUError to CPU::Error.
+
+== 0.5.5 - 17-Nov-2006
+* Fixed a bug in the Linux version where there could be a key but no
+   associated value, causing a String#strip! call to fail.  Now the value is
+   simply left at nil.
+* Refactored the CPU.processors method on Linux, including the removal of '?'
+  from the CPUStruct members for the boolean methods (Ruby doesn't like them).
+* Minor tweaks and updates to the documentation, including the README.
+* Modified the gemspec so that it sets the platform properly for Linux
+  and Windows.
+
+== 0.5.4 - 12-Jul-2006
+* Added a gemspec (and a gem on RubyForge).
+* The CPU.architecture method on HP-UX now returns nil if it cannot be
+  determined instead of "Unknown" for consistency with the other
+  platforms.
+* Inlined the RDoc and made some minor cosmetic source code changes.
+
+== 0.5.3 - 4-May-2006
+* Fixed in a bug in the Solaris version where CPU.load_avg returned bad values
+  when compiled in 64 bit mode.  Thanks go to James Hranicky for the spot and
+  both James Hranicky and Peter Tribble (via comp.unix.solaris) for patches.
+* Made some modifications to the test suite.  You know longer need to know
+  which test suite to run.  All platforms now use 'ts_all.rb', which will run
+  the appropriate test case behind the scenes.
+
+== 0.5.2 - 24-Jun-2005
+* Bug fixed on Linux where empty lines could cause problems.  This affected
+  both the install.rb and linux.rb files, though it only seems to have been
+  an issue on the 2.6+ kernel.
+* Altered the behavior of the CPU.cpu_stats method on Linux.  Now, only the
+  numbered cpu entries return associated data, unless the numberless entry
+  is the only entry.
+* Added a sample program for Linux under the 'examples' directory.
+
+== 0.5.1 - 5-May-2005
+* Fixed a potential bug in the FreeBSD version of CPU.model.
+* Eliminated some warnings in the FreeBSD version.
+* Moved examples directory to the toplevel package directory.
+* Renamed and updated the sample scripts.
+* Added a sample script for FreeBSD.
+* Removed the INSTALL file.  That information is now included in the README.
+* Made the CHANGES, README, and .txt files rdoc friendly.
+* The dynamic documentation generation for Linux has been altered.  Anything
+  relating to rd2 has been removed.  The doc file generated is now
+  doc/linux.txt.
+* Some $LOAD_PATH setup changes in the unit tests.
+
+== 0.5.0 - 26-Jun-2004
+* Now requires Ruby 1.8.0 or later.
+* FreeBSD support added.
+* Replaced 'CPUException' with 'CPUError'
+* The MS Windows version has been completely revamped to use WMI instead of
+  the C API.  Some method names have changed and some methods have been
+  dropped entirely.  Please see the documentation for details.
+* Corresponding documentation updates and test suite changes.
+* Sample programs have been moved to doc/examples.
+* Installation procedure somewhat revamped.
+* No longer autogenerates test file.
+* The .html files have been removed.  You can generate the html on your own
+  if you like.
+
+== 0.4.0 - 18-Sep-2003
+* Added MS Windows support
+* Changed some method names.  The "cpu" has been dropped from most method
+  names.  See documentation for details.
+* The state() and freq() methods (where supported) now assume a default 
+  value of zero.
+* More unit tests added.
+* Fixed minor issue with test.rb for those without TestUnit installed.
+* Fixed issue with linux.rb file being auto-installed on non-Linux platforms.
+* Minor API change for the load_avg() method on HP-UX.  It now accepts a
+  CPU number as an argument.
+
+== 0.3.1 - 16-Jul-2003
+* Fixed a bug in the Solaris version that was using up and not
+  freeing file descriptors.
+* Added html doc for Solaris under doc directory.
+* Minor changes to test_hpux.rb and test_sunos.rb
+* Minor README changes.
+
+== 0.3.0 - 30-Jun-2003
+* Added HP-UX support
+* Removed the VERSION class method.  Use the constant instead
+* Changed license to "Artistic"
+* Moved version info into its own file for convenience
+* Some minor mods to the test suites
+* Modified extconf.rb, moving some of the dynamic test generation
+  into separate files
+
+== 0.2.2 - 25-Mar-2003
+* fpu_type and cpu_type now return nil if not found (Solaris)
+* CPUException is now a direct subclass of StandardError
+* Modified extconf.rb script
+* Minor doc updates
+* Added another test to the solaris test suite
+* Important note added to INSTALL file
+
+== 0.2.1 - 12-Mar-2003
+* Added the cpu_stats() class method for Linux, which contains the
+  data from the 'cpu' lines of /proc/stat
+* Minor fix for extconf.rb (thanks Michael Granger)
+* Some tests added to Linux test suite
+* MANIFEST correction
+
+== 0.2.0 - 13-Feb-2003
+* Linux support added (pure Ruby only)
+* Many changes to extconf.rb to support Linux version
+* sys-uname prerequisite dropped
+* rd2 documentation now kept separate from source
+
+== 0.1.0 - 3-Feb-2003
+* Initial release
+* Currently supports Solaris (only)

data/MANIFEST

@@ -0,0 +1,29 @@
+* install.rb
+* MANIFEST
+* CHANGES
+* Rakefile
+* README
+* sys-cpu.gemspec
+* doc/bsd.txt
+* doc/hpux.txt
+* doc/linux.txt
+* doc/sunos.txt
+* doc/windows.txt
+* examples/example_sys_cpu_freebsd.rb
+* examples/example_sys_cpu_hpux.rb
+* examples/example_sys_cpu_linux.rb
+* examples/example_sys_cpu_sunos.rb
+* examples/example_sys_cpu_windows.rb
+* ext/extconf.rb
+* ext/version.h
+* ext/bsd/bsd.c
+* ext/hpux/hpux.c
+* ext/sunos/sunos.c
+* lib/linux/sys/cpu.rb
+* lib/windows/sys/cpu.rb
+* test/test_sys_cpu.rb
+* test/test_sys_cpu_bsd.rb
+* test/test_sys_cpu_hpux.rb
+* test/test_sys_cpu_sunos.rb
+* test/test_sys_cpu_linux.rb
+* test/test_sys_cpu_windows.rb

data/README

@@ -0,0 +1,73 @@
+= Description
+   A Ruby interface for getting cpu information.
+
+= Installation
+  gem install sys-cpu
+
+  If that doesn't work try one of these:
+
+  gem install sys-cpu --platform linux   # Linux
+  gem install sys-cpu --platform mingw32 # MS Windows
+
+= Notes
+== Solaris
+  Currently there is no 'processors()' iterative method for multi-cpu systems.
+  I plan to add it this in a future release.
+   
+== OS X
+  The CPU.model method returns very limited information. I do not yet know
+  how to get more detailed information.
+
+== Linux
+  This is pure Ruby. This version reads information out of /proc/cpuinfo and
+  /proc/loadavg, so if /proc isn't mounted it won't work.
+
+  The key-value information in /proc/cpuinfo is stored internally (i.e. in
+  memory) as an array of hashes when you first 'require' this package.  This
+  overhead is exceptionally minimal, given that your average cpuinfo file
+  contains less than 1k of text (and I don't store whitespace or newlines).
+
+  The text documentation for Linux is dynamically generated during the
+  build process because the fields vary depending on your setup.  So, don't
+  look at it until *after* you've installed it.  You will see a doc/linux.txt
+  file after you run 'rake install' (via install.rb).
+
+== HP-UX
+  Unlike other platforms, you can get load averages for an individual cpu in
+  multi-cpu systems. See documentation for more details.
+
+== MS Windows
+  This is a pure Ruby implementation using the win32ole package + WMI. The C
+  version has been scrapped. 
+
+  As of version 0.5.0, the CPU.usage method has been removed in favor of the
+  CPU.load_avg method.  This does not (currently) use a perf counter, so there
+  is no longer any delay.  Also, the 'processors' method has been
+  added and the 'supported' method has been dropped.  See the documentation
+  for other changes.
+   
+= Acknowledgements
+  Thanks go to the MPlayer team for some source code that helped me on
+  certain versions of FreeBSD.
+
+= Known Bugs
+  None that I'm aware of. Please report bugs on the project page at
+  http://www.rubyforge.org/projects/sysutils.
+
+= Future Plans
+  Add iterative CPU.processors method.
+  Add more information in general, such as what 'prtdiag' shows.
+
+= License
+  Artistic 2.0
+
+= Copyright
+  (C) 2003-2011 Daniel J. Berger, All Rights Reserved
+
+= Warranty
+  This package is provided "as is" and without any express or
+  implied warranties, including, without limitation, the implied
+  warranties of merchantability and fitness for a particular purpose.
+
+= Author
+  Daniel J. Berger

data/Rakefile

@@ -0,0 +1,89 @@
+require 'rake'
+require 'rake/clean'
+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
+
+namespace 'gem' do
+  desc "Create the sys-cpu gem"
+  task :create => [:clean] do
+    spec = eval(IO.read('sys-cpu.gemspec'))
+    Gem::Builder.new(spec).build
+  end
+
+  desc "Install the sys-cpu gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
+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
+
+  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'
+  end
+  sh "ruby -I. -Iext -Ilib #{file}"
+end
+
+Rake::TestTask.new do |t|
+  if CONFIG['host_os'] =~ /mswin|win32|mingw|cygwin|dos|windows/i
+    t.libs << 'lib/windows'
+  elsif CONFIG['host_os'] =~ /linux/i
+    t.libs << 'lib/linux'
+  else
+    task :test => :build
+    t.libs << 'ext'
+    t.libs.delete('lib')
+  end
+
+  t.libs << 'test'
+  t.test_files = FileList['test/test_sys_cpu.rb']
+end
+
+task :default => :test

data/doc/bsd.txt

@@ -0,0 +1,49 @@
+== Description
+   Sys::CPU - An interface for various cpu statistics
+   
+== Synopsis
+   require "sys/cpu"
+   include Sys
+
+   # BSD and OS X
+   puts "Architecture: " + CPU.architecture
+   puts "Machine: " + CPU.machine
+   puts "Mhz: " + CPU.cpu_freq.to_s
+   puts "Number of cpu's on this system: " + CPU.num_cpu.to_s
+   puts "CPU model: " + CPU.model
+   puts "Load averages: " + CPU.load_avg.join(", ")
+   
+== Constants
+VERSION
+   Returns the current version number for this package.
+    
+== Class Methods
+CPU.architecture
+   Returns the cpu's architecture.
+
+CPU.freq
+   Returns an integer indicating the speed (i.e. frequency in Mhz) of
+   the cpu.
+   
+   Not supported on OS X.
+    
+CPU.load_avg
+   Returns an array of three floats indicating the 1, 5 and 15 minute load
+   average.
+    
+CPU.machine
+   Returns the class of cpu (probably identical to the architecture).
+
+CPU.model
+   Returns a string indicating the cpu model.
+    
+CPU.num_cpu
+   Returns an integer indicating the number of cpu's on the system.
+    
+== Error Classes
+CPU::Error < StandardError
+   Raised is response to internal function errors, usually relating to an
+   invalid cpu number.
+    
+== More Information
+See the README file for more information.

data/doc/hpux.txt

@@ -0,0 +1,54 @@
+== Description
+   Sys::CPU - An interface for various cpu statistics
+   
+== Synopsis
+   require "sys/cpu"
+   include Sys
+
+   puts "Mhz: " + CPU.cpu_freq.to_s
+   puts "State: " + CPU.state(0)
+   puts "Number of cpu's on this system: " + CPU.num_cpu.to_s
+   puts "Number of active cpu's: " + CPU.num_active_cpu.to_s
+   puts "Load averages: " + CPU.load_avg.join(", ")
+   
+== Constants
+VERSION
+   Returns the current version number for this package.
+    
+== Class Methods
+CPU.architecture
+   Returns the cpu architecture, e.g. PA RISC 1.2, etc.
+    
+CPU.freq(cpu_num=0)
+   Returns an integer indicating the speed (i.e. frequency in Mhz) of
+   the cpu.
+    
+CPU.load_avg
+CPU.load_avg(cpu_num)
+CPU.load_avg{ |cpu| ... }
+
+   In non-block form returns an array of three floats indicating the 1, 5
+   and 15 minute overall load average.
+
+   In block form, it returns an array of three floats indicating the 1, 5
+   and 15 minute load average for each cpu.  Only useful on multi-cpu
+   systems.
+
+   If 'cpu_num' is provided, returns the load average (as a 3-element
+   array) for that cpu only.
+
+   You cannot provide a cpu number and use block form at the same time.
+    
+CPU.num_cpu
+   Returns an integer indicating the number of cpu's on the system.
+    
+CPU.num_active_cpu
+   Returns an integer indicating the number of active cpu's on the system.
+    
+== Error Classes
+CPU::Error < StandardError
+   Raised is response to internal function errors, usually relating to an
+   invalid cpu number.
+    
+== More Information
+See the README file for more information.