compute_unit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5caf721411458c1307f2714ba330c737ddd5987433a51d7753b6004649a92429
-  data.tar.gz: ef3bacd1c4662e1ffe33dafad9c48f44c6fc3cefe161098957cc476e7ecac78d
+  metadata.gz: 0ce131c209f99ed5bd86a2439e56b2fcd8e0d7b85120db149d3c4427e6ea8ef0
+  data.tar.gz: 478ef837c6b68adecfc84bb6adc4f6120a8f8e119e371ce13f3503808e92788f
 SHA512:
-  metadata.gz: 73b107433ce4ffcb3d6a5d35a8711cf39489ed111ccc368cb66d5f788f36690382242a3437c0bd6d40147c2ca727856d2fffd48b8b5edbaa8f4dd22b5ab228da
-  data.tar.gz: 2debc1c284e7200efd00ca0e064d3b48f55a935d55409cc77f33db2db9344efabcdaadc3cd2bfd909174e58ba38727ed4ed845dad0395a19e08dc5ee0f54a428
+  metadata.gz: 9f1f22c7a80b053fb7612bb0e40bd7f2ea609b4c747dcdf486875289d2edab9090d590ca333d33be763cc3cec55faa6ca3a8568dc8f8f212eea3adf3e629120b
+  data.tar.gz: 11b96609eec70c967865ecb476367210a356dfdec6a9b833929c4992e937ad8f568cdf5a01e4f1a7fa77cdcf941a245d20a55a5704385b7de1c4efc11855605d

data/CHANGELOG.md

@@ -1,3 +1,10 @@
 # Compute Unit Changelog
 
+## Unrleased
+## 0.2.0
+Released 6/5/2020
+* Added more cpu methods for various POI.
+* Ensure constants exist when side loaded
+* Add descendent discovery mechanism to GPU class
+
 ## initial version 0.1.0

data/README.md

@@ -40,6 +40,34 @@ devices = ComputeUnit.find_all
 
 ```
 
+### Subclassing a compute object
+Instead of monkey patching this code you can simply subclass the objects.  The find_all methods are intelligent enough to locate your subclass by searching the Objectspace for all decendants of `ComputeUnit::ComputeBase`.  This makes it dead simple to add new functionality without having to wrap any code.  This gives you the ability to include new modules or override existing methods.
+
+```ruby
+# coolproject/vegagpu.rb
+module CoolProject
+  class VegaGpu < ::ComputeUnit::Gpu::AmdGpu
+    include CoolProject::Metrics
+
+    def initialize(device_path, opts)
+        super(device_path, opts)
+        @is_vega = true
+    end
+  end
+end
+
+```
+
+Once you have your new class created all you need to do is load the class before running find all.
+
+```
+require 'compute_unit'
+require 'coolproject/vegagpu'
+require 'yaml'
+
+puts ComputeUnit.find_all.to_yaml
+
+```
 
 ## Make and Model information
 This library uses the pci database maintained here https://pci-ids.ucw.cz/ which is also used by `lspci` and other linux tools. If your device is giving the wrong info the problem is likely due to the database being incorrect. 
@@ -51,9 +79,10 @@ If you want to refresh the database every time with finding all the devices you
 Or you can also run the simple cli tool. `update_pcidb` that comes with this library. 
 
 ## Kernel support
-There will likely be changes with reading and writing information to sysfs as new kerneles are released.  This library has been tested against. 
+There will likely be changes with reading and writing information to sysfs as new kernels are released.  This library has been tested against. 
 
 * 4.15 - 4.20
+* 5.x 
 
 ## Development
 

data/lib/compute_unit/asic.rb

@@ -9,6 +9,25 @@ module ComputeUnit
       []
     end
 
+    def self.create_from_path(device_path, index)
+      opts = {
+        device_class_id: device_class(device_path),
+        device_id: device(device_path),
+        device_vendor_id: device_vendor(device_path),
+        subsystem_vendor_id: subsystem_vendor(device_path),
+        subsystem_device_id: subsystem_device(device_path),
+        index: index
+      }
+      new(device_path, opts)
+    end
+
+    def self.find_all
+      return []
+      devices.sort.map.with_index do |device_path, index|
+        create_from_path(device_path, index)
+      end
+    end
+
     # /sys/devices/platform $ more coretemp.0/hwmon/hwmon1/temp1_input / 1000
   end
 end

data/lib/compute_unit/compute_base.rb

@@ -16,6 +16,16 @@ module ComputeUnit
     # timeout value
     CACHE_TIMEOUT = 30
 
+    # @return [Array] - find all the decendants of thyself
+    def self.compute_classes
+      ObjectSpace.each_object(Class).select do |klass|
+        # <Class:#<Crossbelt::ComputeUnit::NvidiaGpu:0x00007fddc5c02a10>>
+        #  We have to filter out these kinds of Ojbects as they don't respond to :new
+        #  without a singleton error.
+        klass < self && !klass.to_s.include?('Class')
+      end
+    end
+
     # @param value [Float] a value to offset the power calculation, either a whole number, or decimal
     # @return [Integer] the value set as the offset
     def power_offset=(value)

data/lib/compute_unit/cpu.rb

@@ -13,6 +13,78 @@ module ComputeUnit
       end
     end
 
+    def model
+      raw_cpu_data[:model_name]
+    end
+
+    def make
+      raw_cpu_data[:vendor_id]
+    end
+
+    def num_cores
+      raw_cpu_data[:cores_per_socket].to_i
+    end
+
+    def num_threads
+      raw_cpu_data[:threads_per_core].to_i
+    end
+
+    def nproc
+      raw_cpu_data[:cpus].to_i
+    end
+
+    def current_freq_mhz
+      raw_cpu_data[:cpu_mhz].to_f.round(0)
+    end
+
+    def max_freq_mhz
+      raw_cpu_data[:cpu_max_mhz].to_f.round(0)
+    end
+
+    def min_freq_mhz
+      raw_cpu_data[:cpu_min_mhz].to_f.round(0)
+    end
+
+    def base_hwmon_path
+      File.join(ComputeUnit::SYSFS_PATH, 'devices/platform/coretemp.0/hwmon')
+    end
+
+    # @return [Hash] - a hash of temp readings and their labels
+    # @example temps => {:core_0=>31, :core_1=>31, :package_id_0=>27}
+    def temps
+      Dir.glob(File.join(hwmon_path, 'temp*_label')).each_with_object({}) do |label_file, acc|
+        temp_file = label_file.sub('label', 'input')
+        label = normalize_name(read_file(label_file))
+        reading = read_file(temp_file).to_f.round(0) / 1000
+        acc[label] = reading
+        acc
+      end
+    end
+
+    # @return [Integer] - the temperature of the cpu package in Celsius
+    def temp
+      read_hwmon_data('temp1_input', 0).to_f.round(0) / 1000
+    end
+
+    def metrics
+      {
+        temp: temp,
+        minFreqMhz: min_freq_mhz,
+        maxFreqMhz: max_freq_mhz,
+        currentFreqMhz: current_freq_mhz,
+        model: model,
+        make: make,
+        numCores: num_cores,
+        numThreads: num_threads,
+        nproc: nproc,
+        temps: temps
+      }
+    end
+
+    def to_h
+      super.merge(metrics)
+    end
+
     def self.create_from_path(device_path, index)
       opts = {
         device_class_id: device_class(device_path),
@@ -26,11 +98,51 @@ module ComputeUnit
     end
 
     def self.find_all
-      return [] # not quite ready to show cpu data
       devices.sort.map.with_index do |device_path, index|
         create_from_path(device_path, index)
       end
     end
-    # /sys/devices/platform $ more coretemp.0/hwmon/hwmon1/temp1_input / 1000
+
+    private
+
+    # @param value [String]
+    # @return [String]
+    # @summary downcases and transforms spaces into underscores
+    def normalize_name(value)
+      value.downcase.gsub(/\s/, '_').gsub('(s)', 's').to_sym
+    end
+
+    # @return [Hash] - a hash of cpu info returned from lscpu
+    # normalizes the key name by downcasing and removing spaces
+    # @example
+    #   raw_cpu_data() =>
+    # {"architecture"=>"x86_64", "cpu_op-modes"=>"32-bit, 64-bit", "byte_order"=>"Little Endian",
+    #   "cpus"=>"4", "on-line_cpus list"=>"0-3", "threads_per core"=>"2", "cores_per socket"=>"2",
+    #   "sockets"=>"1", "numa_nodes"=>"1", "vendor_id"=>"GenuineIntel", "cpu_family"=>"6",
+    #   "model"=>"158", "model_name"=>"Intel(R) Core(TM) i3-7100 CPU @ 3.90GHz", "stepping"=>"9",
+    #   "cpu_mhz"=>"800.545", "cpu_max mhz"=>"3900.0000", "cpu_min mhz"=>"800.0000",
+    #   "bogomips"=>"7799.87", "virtualization"=>"VT-x", "l1d_cache"=>"32K", "l1i_cache"=>"32K",
+    #   "l2_cache"=>"256K", "l3_cache"=>"3072K", "numa_node0 cpus"=>"0-3",
+    #   "flags"=>"fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36
+    #    clflush dts acpi mmx fxsr sse sse2 ss ht tm pbe syscall nx pdpe1gb rdtscp lm constant_tsc
+    #   art arch_perfmon pebs bts rep_good nopl xtopology nonstop_tsc cpuid aperfmperf pni
+    #   pclmulqdq dtes64 monitor ds_cpl vmx est tm2 ssse3 sdbg fma cx16 xtpr pdcm pcid sse4_1
+    #   sse4_2 x2apic movbe popcnt tsc_deadline_timer aes xsave avx f16c rdrand lahf_lm abm
+    #   3dnowprefetch cpuid_fault invpcid_single tpr_shadow vnmi flexpriority ept vpid ept_ad
+    #   fsgsbase tsc_adjust bmi1 avx2 smep bmi2 erms invpcid mpx rdseed adx smap clflushopt intel_pt
+    #   xsaveopt xsavec xgetbv1 xsaves dtherm arat pln pts hwp hwp_notify hwp_act_window hwp_epp"
+    # }
+    def raw_cpu_data
+      @raw_cpu_data ||= begin
+        # turns each line into a hash of key value pairs
+        regex = /(?<name>[\s\w\-\(\)]+)\:\s+(?<value>[@\s\w\-\,\.\(\)]+)$/
+        `lscpu`.lines.each_with_object({}) do |line, acc|
+          m = line.match(regex)
+          name = normalize_name(m.named_captures['name'])
+          acc[name] = m.named_captures['value'].chomp if m
+          acc
+        end
+      end
+    end
   end
 end

data/lib/compute_unit/device.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
+require 'compute_unit'
 require 'compute_unit/logger'
 require 'compute_unit/cache_store'
 require 'compute_unit/utils'
-
 # This file supports reading from sysfs
 # More information about sysfs can be found here - https://www.kernel.org/doc/Documentation/filesystems/sysfs-pci.txt
 module ComputeUnit
@@ -127,7 +127,10 @@ module ComputeUnit
 
     def read_file(path, default = nil)
       File.read(path).chomp
-    rescue Errno::EINVAL, Errno::EPERM, Errno::ENOENT
+    rescue Errno::EINVAL, Errno::EPERM
+      default
+    rescue Errno::ENOENT
+      logger.warn("File #{path} does not exist, using defaults")
       default
     rescue Errno::EACCES
       logger.fatal('run this command as root or with sudo, using default value')
@@ -268,7 +271,7 @@ module ComputeUnit
                 logger.fatal(e.message)
                 default
               rescue Errno::ENOENT
-                logger.fatal("File #{path} does not exist")
+                logger.warn("File #{path} does not exist")
                 default
               rescue Errno::EACCES
                 logger.fatal('Run this command as root or with sudo')
@@ -286,7 +289,7 @@ module ComputeUnit
     rescue Errno::EINVAL, Errno::EPERM => e
       logger.fatal(e.message)
     rescue Errno::ENOENT
-      logger.fatal("File #{path} does not exist")
+      logger.warn("File #{path} does not exist")
     rescue Errno::EACCES
       logger.fatal('Run this command as root or with sudo')
     end

data/lib/compute_unit/gpu.rb

@@ -265,7 +265,7 @@ module ComputeUnit
     def self.find_all(use_opencl = false)
       require 'compute_unit/gpus/amd_gpu'
       require 'compute_unit/gpus/nvidia_gpu'
-      g = ComputeUnit::AmdGpu.find_all(use_opencl) + ComputeUnit::NvidiaGpu.find_all(use_opencl)
+      g = compute_classes.map { |klass| klass.find_all(use_opencl) }.flatten
       g.sort_by(&:index)
     end
 

data/lib/compute_unit/gpus/amd_gpu.rb

@@ -90,6 +90,16 @@ module ComputeUnit
       utilization
     end
 
+    # @return [Integer] - the temperature of the asic chip
+    def asic_temp
+      read_hwmon_data('temp2_input', 0).to_i / 1000
+    end
+
+    # @return [Integer] - temperature of the memory
+    def mem_temp
+      read_hwmon_data('temp3_input', 0).to_i / 1000
+    end
+
     # @return [Integer] - returns temp of gpu in celius
     def temp
       read_hwmon_data('temp1_input', 0).to_i / 1000
@@ -421,16 +431,6 @@ module ComputeUnit
       vddci_voltage_table.first[:volt]
     end
 
-    # @return [Integer] - the temperature of the asic chip
-    def asic_temp
-      read_hwmon_data('temp2_input', 0).to_i / 1000
-    end
-
-    # @return [Integer] - the temperature of the memory chips
-    def mem_temp
-      read_hwmon_data('temp3_input', 0).to_i / 1000
-    end
-
     def set_mem_clock_and_vddc(mem_clock, mem_volt)
       return unless experimental_on?
 

data/lib/compute_unit/logger.rb

@@ -8,7 +8,7 @@ module ComputeUnit
       if ENV['LOG_FILENAME'] && File.exist?(ENV['LOG_FILENAME'])
         ENV['LOG_FILENAME']
       else
-        STDOUT
+        STDERR
       end
     end
 
@@ -18,7 +18,7 @@ module ComputeUnit
         log.level = log_level
         log.progname = 'ComputeUnit'
         log.formatter = proc do |severity, datetime, progname, msg|
-          if Logger.log_file == STDOUT
+          if Logger.log_file == STDERR
             "#{severity} - #{progname}: #{msg}\n".send(color(severity))
           else
             "#{datetime} #{severity} - #{progname}: #{msg}\n".send(color(severity))

data/lib/compute_unit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ComputeUnit
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compute_unit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-25 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opencl_ruby_ffi