sys-cpu 0.8.3 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c889d0a79359903abbe62cbd38095a88335386cc3c930b61ad94c9000350956
-  data.tar.gz: b050390fc7fccbc4ad842f348e5dd702432f221c037a533bb4df2138d198d70c
+  metadata.gz: 8f9a7931b9cc69f3f9725734f85a34fd5ca077226a52f22bdef4fd9f298813c7
+  data.tar.gz: b7fc906ea6420ed2dde2c9bc546cd5a782e6dc4f3527eb60ac7e5ee9b2cc002e
 SHA512:
-  metadata.gz: 780e4ee7023069eb9c0d6dc0beb296edacda8db250f84cabada5961d2ab6728acd311a7eab41c292703feec6904a3caee6927b676454db46f4e6c1a248a06d12
-  data.tar.gz: 310b45098badac319002989cd86009cb85fe4924300fb737f8de1b5c62fd2846f104c46a87233f2644dbc6527df1579cf5aa1eb78faea965eecd1648ddc46d15
+  metadata.gz: 07a5729274191c98a35515d26b04906222504a8f9a27d551a604998fad5cf40596a240d90434ec0706e54e7ac27d211d222cac122ce101b9d72e29657eda1990
+  data.tar.gz: 44068c3fa47b3b9af47485133cd52e8d5bfef6638fbfd54a1e21822b1f8617343c4156d2ce17f3f2a46987cdbc2309fecfbacc33f582bb74ffe553229bd7d0ba

data/{CHANGES.rdoc → CHANGES.md}

@@ -1,34 +1,59 @@
-== 0.8.3 - 18-Mar-2020
+## 1.0.3 - 28-Jan-2021
+* The code for OSX was split out into its own source file. This was partly for
+  ease of maintenance, but also because there was confusion with the
+  processor_info function. The original function was only aimed at Solaris, but
+  it turns out OSX has its own, different implementation. This caused segfaults.
+
+## 1.0.2 - 25-Jan-2021
+* Fixed issues where things that were meant to be private weren't actually private.
+
+## 1.0.1 - 20-Dec-2020
+* Switched from rdoc to markdown.
+
+## 1.0.0 - 23-Oct-2020
+* Fixed a bug in the Windows version where the attempt to convert the ConfigManagerErrorCode
+  to a string was busted. Coincidentally, this also exposed a core bug in JRuby (see PR #6443).
+  Thanks go to G. Gibson for reporting the issue.
+* Switched the tests from test-unit to rspec.
+
+## 0.9.0 - 12-May-2020
+* Added explicit freq, architecture, num_cpu and model methods to the Linux
+  version in an effort to create a common interface across platforms.
+* Modified the Linux version so that method_missing will raise a NoMethodError
+  if you try to call access an attribute that doesn't exist.
+* Some updates to the Linux tests.
+
+## 0.8.3 - 18-Mar-2020
 * Properly include a LICENSE file as per the Apache-2.0 license.
 
-== 0.8.2 - 14-Jan-2020
+## 0.8.2 - 14-Jan-2020
 * Added explicit .rdoc extension to README, CHANGES and MANIFEST files.
 * Fixed license name in README.
 
-== 0.8.1 - 4-Nov-2018
+## 0.8.1 - 4-Nov-2018
 * Added metadata to the gemspec.
 * Fixed missing hyphen in license name.
 
-== 0.8.0 - 17-Oct-2018
+## 0.8.0 - 17-Oct-2018
 * Switched license to Apache 2.0.
 * Updated documentation for the cpu_stats method on Linux.
 * The VERSION constant is now frozen.
 * Now uses require_relative internally where needed.
 
-== 0.7.2 - 5-Sep-2015
+## 0.7.2 - 5-Sep-2015
 * Replaced a global array with a constant in the Linux version. Thanks go
   to Yorick Peterse for the patch.
 * Added method comments back to the Unix version.
 * Added a sys-cpu.rb stub file for your convenience.
 * This gem is now signed.
 
-== 0.7.1 - 2-May-2013
+## 0.7.1 - 2-May-2013
 * Added a workaround for a win32ole bug in the Windows version.
 * Reorganized code so that there is now a single gem rather than three
   separate platform gems.
 * Updated test-unit dependency which let me simplify the test files a bit.
 
-== 0.7.0 - 14-Dec-2011
+## 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.
@@ -37,7 +62,7 @@
 * The type method has been changed to cpu_type on Windows.
 * Some Rakefile and test suite updates.
 
-== 0.6.4 - 27-Sep-2011
+## 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
   returned the machine model. However, the information is limited.
@@ -45,7 +70,7 @@
 * The Linux and Windows gems now have a 'universal' architecture.
 * Refactored the clean task in the Rakefile.
 
-== 0.6.3 - 9-Oct-2010
+## 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.
@@ -53,7 +78,7 @@
 * Fixed and updated the CPU.architecture method on MS Windows to handle IA64
   and x64 architectures.
 
-== 0.6.2 - 1-Jan-2010
+## 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.
@@ -66,13 +91,13 @@
 * Test files renamed.
 * Added test-unit 2.x as a development dependency.
 
-== 0.6.1 - 4-Jan-2009
+## 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
+## 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
@@ -84,7 +109,7 @@
 * Improved RDoc comments in the C source files.
 * Changed CPUError to CPU::Error.
 
-== 0.5.5 - 17-Nov-2006
+## 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.
@@ -94,14 +119,14 @@
 * Modified the gemspec so that it sets the platform properly for Linux
   and Windows.
 
-== 0.5.4 - 12-Jul-2006
+## 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
+## 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.
@@ -109,7 +134,7 @@
   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
+## 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.
@@ -118,7 +143,7 @@
   is the only entry.
 * Added a sample program for Linux under the 'examples' directory.
 
-== 0.5.1 - 5-May-2005
+## 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.
@@ -131,7 +156,7 @@
   doc/linux.txt.
 * Some $LOAD_PATH setup changes in the unit tests.
 
-== 0.5.0 - 26-Jun-2004
+## 0.5.0 - 26-Jun-2004
 * Now requires Ruby 1.8.0 or later.
 * FreeBSD support added.
 * Replaced 'CPUException' with 'CPUError'
@@ -145,7 +170,7 @@
 * The .html files have been removed.  You can generate the html on your own
   if you like.
 
-== 0.4.0 - 18-Sep-2003
+## 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.
@@ -157,14 +182,14 @@
 * 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
+## 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
+## 0.3.0 - 30-Jun-2003
 * Added HP-UX support
 * Removed the VERSION class method.  Use the constant instead
 * Changed license to "Artistic"
@@ -173,7 +198,7 @@
 * Modified extconf.rb, moving some of the dynamic test generation
   into separate files
 
-== 0.2.2 - 25-Mar-2003
+## 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
@@ -181,19 +206,19 @@
 * Added another test to the solaris test suite
 * Important note added to INSTALL file
 
-== 0.2.1 - 12-Mar-2003
+## 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
+## 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
+## 0.1.0 - 3-Feb-2003
 * Initial release
 * Currently supports Solaris (only)

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org' do
+  gem 'ffi', '~> 1.1'
+  group 'test' do
+    gem 'rake'
+    gem 'rspec', '~> 3.9'
+  end
+end

data/{MANIFEST.rdoc → MANIFEST.md}

@@ -1,8 +1,9 @@
 * install.rb
-* MANIFEST.rdoc
-* CHANGES.rdoc
+* LICENSE
+* MANIFEST.md
+* CHANGES.md
 * Rakefile
-* README.rdoc
+* README.md
 * sys-cpu.gemspec
 * certs/djberg96_pub.pem
 * doc/bsd.txt
@@ -16,12 +17,14 @@
 * examples/example_sys_cpu_sunos.rb
 * examples/example_sys_cpu_windows.rb
 * lib/sys/cpu.rb
+* lib/sys/darwin/sys/cpu.rb
 * lib/sys/linux/sys/cpu.rb
 * lib/sys/unix/sys/cpu.rb
 * lib/sys/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
+* spec/spec_helper.rb
+* spec/sys_cpu_spec.rb
+* spec/sys_cpu_bsd_spec.rb
+* spec/sys_cpu_hpux_spec.rb
+* spec/sys_cpu_linux_spec.rb
+* spec/sys_cpu_sunos_spec.rb
+* spec/sys_cpu_windows_spec.rb

data/{README.rdoc → README.md}

@@ -1,22 +1,22 @@
-= Description
+## Description
 A Ruby interface for getting cpu information.
 
-= Installation
-  gem install sys-cpu
+## Installation
+`gem install sys-cpu`
 
-= Adding the trusted cert
-  gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-cpu/ffi/certs/djberg96_pub.pem)
+## Adding the trusted cert
+`gem cert --add <(curl -Ls https://raw.githubusercontent.com/djberg96/sys-cpu/ffi/certs/djberg96_pub.pem)`
 
-= Notes
-== Solaris
+## 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
+### OS X
 The CPU.model method returns very limited information. I do not yet know
 how to get more detailed information.
 
-== Linux
+### 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.
 
@@ -30,7 +30,7 @@ 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
+### HP-UX
 Unlike other platforms, you can get load averages for an individual cpu in
 multi-cpu systems. See documentation for more details.
 
@@ -38,38 +38,38 @@ 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
+### 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.
+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
+## Acknowledgements
 Thanks go to the MPlayer team for some source code that helped me on
 certain versions of FreeBSD in the original C version.
 
-= Known Bugs
+## Known Bugs
 None that I'm aware of. Please report bugs on the project page at:
 
 https://github.com/djberg96/sys-cpu
 
-= Future Plans
+## Future Plans
 * Add iterative CPU.processors method.
 * Add more information in general, such as what +prtdiag+ shows.
 
-= License
+## License
 Apache-2.0
 
-= Copyright
-(C) 2003-2020 Daniel J. Berger, All Rights Reserved
+## Copyright
+(C) 2003-2021 Daniel J. Berger, All Rights Reserved
 
-= Warranty
+## 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
+## Author
 Daniel J. Berger

data/Rakefile

@@ -1,10 +1,10 @@
 require 'rake'
 require 'rake/clean'
-require 'rake/testtask'
 require 'rbconfig'
+require 'rspec/core/rake_task'
 include RbConfig
 
-CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx')
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.rbx', '**/*.lock')
 
 namespace 'gem' do
   desc "Create the sys-cpu gem"
@@ -12,7 +12,7 @@ namespace 'gem' do
     require 'rubygems/package'
     spec = eval(IO.read('sys-cpu.gemspec'))
     spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
+    Gem::Package.build(spec)
   end
 
   desc "Install the sys-cpu gem"
@@ -44,9 +44,7 @@ task :example => [:clean] do
 
 end
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/test_sys_cpu.rb']
-end
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/sys/cpu.rb

@@ -5,7 +5,7 @@ require 'rbconfig'
 module Sys
   class CPU
     # The version of the sys-cpu gem.
-    VERSION = '0.8.3'.freeze
+    VERSION = '1.0.3'.freeze
   end
 end
 
@@ -14,6 +14,8 @@ case RbConfig::CONFIG['host_os']
     require_relative('linux/sys/cpu')
   when /windows|mswin|mingw|cygwin|dos/i
     require_relative('windows/sys/cpu')
+  when /darwin|mach|osx/i
+    require_relative('darwin/sys/cpu')
   else
     require_relative('unix/sys/cpu')
 end

data/lib/sys/darwin/sys/cpu.rb

@@ -0,0 +1,167 @@
+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
+
+    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
+    HW_MACHINE_ARCH = 12 # Machine architecture
+
+    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
+
+    attach_function(
+      :sysctl,
+      [:pointer, :uint, :pointer, :pointer, :pointer, :size_t],
+      :int
+    )
+
+    private_class_method :sysctl
+
+    attach_function(
+      :sysctlbyname,
+      [:string, :pointer, :pointer, :pointer, :size_t],
+      :int
+    )
+
+    private_class_method :sysctlbyname
+
+    attach_function :getloadavg, [:pointer, :int], :int
+    attach_function :processor_info, [:int, :int, :string, :pointer, :pointer], :int
+    attach_function :sysconf, [:int], :long
+
+    private_class_method :getloadavg
+    private_class_method :processor_info
+    private_class_method :sysconf
+
+    # Returns the cpu's architecture. On most systems this will be identical
+    # to the CPU.machine method. On OpenBSD it will be identical to the CPU.model
+    # method.
+    #
+    def self.architecture
+      optr = FFI::MemoryPointer.new(:char, 256)
+      size = FFI::MemoryPointer.new(:size_t)
+
+      size.write_int(optr.size)
+
+      if sysctlbyname('hw.machine', optr, size, nil, 0) < 0
+        raise Error, 'sysctlbyname function failed'
+      end
+
+      optr.read_string
+    end
+
+    # Returns the number of cpu's on your system. Note that each core on
+    # multi-core systems are counted as a cpu, e.g. one dual core cpu would
+    # return 2, not 1.
+    #
+    def self.num_cpu
+      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
+    end
+
+    # Returns the cpu's class type. On most systems this will be identical
+    # to the CPU.architecture method. On OpenBSD it will be identical to the
+    # CPU.model method.
+    #
+    def self.machine
+      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
+    end
+
+    # Returns a string indicating the cpu model.
+    #
+    def self.model
+      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
+    end
+
+    # Returns an integer indicating the speed of the CPU.
+    #
+    def self.freq
+      optr = FFI::MemoryPointer.new(:long)
+      size = FFI::MemoryPointer.new(:size_t)
+
+      size.write_long(optr.size)
+
+      if sysctlbyname('hw.cpufrequency', optr, size, nil, 0) < 0
+        raise Error, 'sysctlbyname failed'
+      end
+
+      optr.read_long / 1000000
+    end
+
+    # Returns an array of three floats indicating the 1, 5 and 15 minute load
+    # average.
+    #
+    def self.load_avg
+      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
+end