sys-cpu 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9b8cf15d0019738569df3847184952320df08960cc039e52ed819ae7a649d3f
-  data.tar.gz: b38dc203121fa564f8c6d156e99821eb33ea1b7db7070e261262458531b7393a
+  metadata.gz: 8f9a7931b9cc69f3f9725734f85a34fd5ca077226a52f22bdef4fd9f298813c7
+  data.tar.gz: b7fc906ea6420ed2dde2c9bc546cd5a782e6dc4f3527eb60ac7e5ee9b2cc002e
 SHA512:
-  metadata.gz: 7bbce2f399977b559cbbd799b0b2fb9c5343627e316d8d8c1a58fd61878452491ffd3bf4dc18851c1a8c76d383b7b9aea2e9f7b8bae03e465fd94cd602f1e802
-  data.tar.gz: 1ac9b193bf154c24b884ac0638a6bc2ff7ee959adaf0dac0d05eb8e47a4f4eadbc5e0f019cd50100cc5e30c0ac02ec8db6f10c89b1acf3404f30f64ea5341818
+  metadata.gz: 07a5729274191c98a35515d26b04906222504a8f9a27d551a604998fad5cf40596a240d90434ec0706e54e7ac27d211d222cac122ce101b9d72e29657eda1990
+  data.tar.gz: 44068c3fa47b3b9af47485133cd52e8d5bfef6638fbfd54a1e21822b1f8617343c4156d2ce17f3f2a46987cdbc2309fecfbacc33f582bb74ffe553229bd7d0ba

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 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.
 

data/MANIFEST.md

@@ -17,6 +17,7 @@
 * 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

data/lib/sys/cpu.rb

@@ -5,7 +5,7 @@ require 'rbconfig'
 module Sys
   class CPU
     # The version of the sys-cpu gem.
-    VERSION = '1.0.2'.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

data/lib/sys/unix/sys/cpu.rb

@@ -105,13 +105,7 @@ module Sys
 
         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
+        if sysctlbyname('hw.machine_arch', optr, size, nil, 0) < 0
           raise Error, 'sysctlbyname function failed'
         end
 
@@ -204,52 +198,30 @@ module Sys
     # Returns a string indicating the cpu model.
     #
     def self.model
-      if RbConfig::CONFIG['host_os'] =~ /darwin/i
-        ptr  = FFI::MemoryPointer.new(:long)
-        size = FFI::MemoryPointer.new(:size_t)
+      if respond_to?(:sysctl, true)
+        buf  = 0.chr * 64
+        mib  = FFI::MemoryPointer.new(:int, 2)
+        size = FFI::MemoryPointer.new(:long, 1)
 
-        size.write_long(ptr.size)
+        mib.write_array_of_int([CTL_HW, HW_MODEL])
+        size.write_int(buf.size)
 
-        if sysctlbyname('hw.cputype', ptr, size, nil, 0) < 0
-          raise 'sysctlbyname function failed'
+        if sysctl(mib, 2, buf, size, nil, 0) < 0
+          raise Error, 'sysctl 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
+        buf.strip
       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
+        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
+        # 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
-
-          pinfo[:pi_processor_type].to_s
         end
+
+        pinfo[:pi_processor_type].to_s
       end
     end
 
@@ -272,11 +244,7 @@ module Sys
           raise Error, 'sysctlbyname failed'
         end
 
-        if RbConfig::CONFIG['host_os'] =~ /darwin/i
-          optr.read_long / 1000000
-        else
-          optr.read_long
-        end
+        optr.read_long
       elsif respond_to?(:sysctl, true)
         buf  = 0.chr * 16
         mib  = FFI::MemoryPointer.new(:int, 2)

data/spec/sys_cpu_spec.rb

@@ -9,7 +9,7 @@ require 'rspec'
 
 RSpec.describe Sys::CPU::VERSION do
   example "version number is set to the expected value" do
-    expect(Sys::CPU::VERSION).to eq('1.0.2')
+    expect(Sys::CPU::VERSION).to eq('1.0.3')
   end
 
   example "version number is frozen" do

data/sys-cpu.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'sys-cpu'
-  spec.version    = '1.0.2'
+  spec.version    = '1.0.3'
   spec.author     = 'Daniel J. Berger'
   spec.email      = 'djberg96@gmail.com'
   spec.license    = 'Apache-2.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sys-cpu
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -35,7 +35,7 @@ cert_chain:
   ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
   WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -108,6 +108,7 @@ files:
 - install.rb
 - lib/sys-cpu.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