compute_unit 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce131c209f99ed5bd86a2439e56b2fcd8e0d7b85120db149d3c4427e6ea8ef0
-  data.tar.gz: 478ef837c6b68adecfc84bb6adc4f6120a8f8e119e371ce13f3503808e92788f
+  metadata.gz: 392d224e4b52410a749c91ddcc25c17c213c5c0b1210d535f3bd1b11c1e88f6f
+  data.tar.gz: 2043d45deb0e14470776ed90f04dbd89bdc02dea7b9a80b349fe4305e40f5055
 SHA512:
-  metadata.gz: 9f1f22c7a80b053fb7612bb0e40bd7f2ea609b4c747dcdf486875289d2edab9090d590ca333d33be763cc3cec55faa6ca3a8568dc8f8f212eea3adf3e629120b
-  data.tar.gz: 11b96609eec70c967865ecb476367210a356dfdec6a9b833929c4992e937ad8f568cdf5a01e4f1a7fa77cdcf941a245d20a55a5704385b7de1c4efc11855605d
+  metadata.gz: edd810f90429892d0b21d4889fd953c9b93453786b68fceb36ee8fed628e7ed650a42a4de0e535333e4a40833a43e62fd0b59c651a2d844fe60fa2dfaca76bd2
+  data.tar.gz: fad7d4f8fb84d70bb7613bbe4b0a34c24f108fcb8b58400a84e017ada8b4036e64d94f3be3c7a6007ab0f4164d38a7625a8b8b98c1fd27993540ea8e1b94e32d

data/CHANGELOG.md

@@ -1,6 +1,30 @@
 # Compute Unit Changelog
 
 ## Unrleased
+## 0.3.3
+* Fix bug with default database not being created
+
+## 0.3.2
+* Fix bug with default database not being created
+
+## 0.3.1
+Released 9/24/2020
+
+* Use the default system pcidb file instead of throwing error
+* Return default data if no hmon value exist
+
+## 0.3.0
+Released 6/16/2020
+
+* Add name method to the cpu class
+* Use constant for proc path
+* Use debug when kernel file doesn't exist
+
+## 0.2.1
+Released 6/6/2020
+
+* update rake and other gems
+
 ## 0.2.0
 Released 6/5/2020
 * Added more cpu methods for various POI.

data/Gemfile

@@ -2,17 +2,11 @@
 
 source 'https://rubygems.org'
 
-
-gem 'opencl_ruby_ffi', '~> 1.3.4'
-gem 'compute_unit', path: '.'
-
 group :test do
   gem 'pry'
   gem 'rubocop'
   gem 'rubocop-rspec'
   gem 'ruby-prof'
   gem 'simplecov'
-  gem 'rake', '~> 10.0'
-  gem 'rspec', '~> 3.0'
-  gem 'bundler', '~> 2.0'
 end
+gemspec

data/README.md

@@ -1,9 +1,9 @@
 # Compute Unit Ruby Library
-The compute unit library helps you write future abstractions and tooling for crypto mining, machine learning or just general purpose usage.  This library was extracted out of the crypto mining tool [Crossbelt](https://crossbelt.blockops.party) to help spur more tooling to ruby. 
+The compute unit library helps you write future abstractions and tooling for crypto mining, machine learning or just general purpose.  This library was extracted out of the crypto mining tool [Crossbelt](https://crossbelt.blockops.party) to help spur more tooling for ruby. 
 
 Uses the sysfs filesystem to quickly read and write compute unit data. More information about sysfs can be found [here](https://www.kernel.org/doc/Documentation/filesystems/sysfs-pci.txt)
 
-This library will:
+This library has the ability to:
 
  * Detect all compute devices such as cpu, gpu, and anything else we add to this library. 
  * Provide the ability to control GPU fans.
@@ -11,6 +11,7 @@ This library will:
  * Change or view voltage, core clock, memory clock and other tunning parameters used for overclocking.
  * Provide inventory data of all the devices with make, model and other important information. 
  * Provide realtime status information of various data points. Useful for real-time tunning. 
+ * Interact with the compute device via ruby.
 
 This library was open sourced to allow further refinement and usage throughout the ruby community. 
 Since machine learning is not popular on ruby due to device and program support, I hope this gem will 
@@ -34,17 +35,110 @@ Or install it yourself as:
 
 ## Usage
 
+Find all compute devices
 ```
 require 'compute_unit'
 devices = ComputeUnit.find_all
 
 ```
 
+Find just GPU devices and list the voltage table
+
+```ruby
+require 'compute_unit/gpu'
+
+gpu = ComputeUnit::Gpu.find_all.first
+gpu.voltage_table
+=> [{:pstate=>0, :clk=>852, :volt=>800, :type=>:sclk},
+ {:pstate=>1, :clk=>997, :volt=>860, :type=>:sclk},
+ {:pstate=>2, :clk=>1084, :volt=>860, :type=>:sclk},
+ {:pstate=>3, :clk=>1138, :volt=>860, :type=>:sclk},
+ {:pstate=>4, :clk=>1200, :volt=>860, :type=>:sclk},
+ {:pstate=>5, :clk=>1401, :volt=>860, :type=>:sclk},
+ {:pstate=>6, :clk=>1536, :volt=>860, :type=>:sclk},
+ {:pstate=>7, :clk=>1630, :volt=>1200, :type=>:sclk}]
+
+gpu.amdgpu_pm_info
+=> {:mclk=>{:value=>"1020", :unit=>"MHz"},
+ :sclk=>{:value=>"994", :unit=>"MHz"},
+ :pstate_sclk=>{:value=>"1138", :unit=>"MHz"},
+ :pstate_mclk=>{:value=>"800", :unit=>"MHz"},
+ :vddgfx=>{:value=>"862", :unit=>"mV"},
+ :average_gpu=>{:value=>"121.0", :unit=>"W"},
+ :temperature=>{:value=>"57", :unit=>"C"},
+ :load=>{:value=>"100", :unit=>"%"}} 
+
+```
+
+## Example CLI command
+There is a `list_computes` command that will enumerate all the compute devices found on the system.
+
+```ruby
+list_computes
+[
+  {
+    "uuid": "GPU0",
+    "gpuId": "GPU0",
+    "syspath": "/sys/bus/pci/devices/0000:03:00.0",
+    "pciLoc": "0000:03:00.0",
+    "name": "RX Vega56",
+    "bios": "113-D0500100-102",
+    "subType": "amdgpu",
+    "make": "AMD",
+    "model": "RX Vega56",
+    "vendor": "AMD",
+    "power": 121,
+    "utilization": 100,
+    "temperature": 57,
+    "status": 0,
+    "pstate": -1,
+    "fanSpeed": 2946,
+    "type": "GPU",
+    "maxTemp": null,
+    "mem": 1020,
+    "cor": 997,
+    "vlt": 862,
+    "mem_temp": 75,
+    "maxFan": null,
+    "dpm": null,
+    "vddci": null,
+    "maxPower": null,
+    "ocProfile": null,
+    "opencl_enabled": false
+  },
+  {
+    "chip_make": "GenuineIntel",
+    "make": "GenuineIntel",
+    "model": "Intel(R) Core(TM) i3-7100 CPU @ 3.90GHz",
+    "device_id": "590f",
+    "vendor_id": "8086",
+    "subsystem_device_id": "7a59",
+    "subsystem_vendor_id": "1462",
+    "device_class": "060000",
+    "temp": 33,
+    "minFreqMhz": 800,
+    "maxFreqMhz": 3900,
+    "currentFreqMhz": 3600,
+    "numCores": 2,
+    "numThreads": 2,
+    "nproc": 4,
+    "temps": {
+      "package_id_0": 33,
+      "core_0": 26,
+      "core_1": 33
+    }
+  }
+]
+```
+
 ### 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.
+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.  Just make sure you load your class before using the find_all method.
+
+
 
 ```ruby
 # coolproject/vegagpu.rb
+require 'cool_project/vega_gpu'
 module CoolProject
   class VegaGpu < ::ComputeUnit::Gpu::AmdGpu
     include CoolProject::Metrics
@@ -60,7 +154,7 @@ end
 
 Once you have your new class created all you need to do is load the class before running find all.
 
-```
+```ruby
 require 'compute_unit'
 require 'coolproject/vegagpu'
 require 'yaml'
@@ -84,6 +178,21 @@ There will likely be changes with reading and writing information to sysfs as ne
 * 4.15 - 4.20
 * 5.x 
 
+## OpenCL Usage
+The opencl_ruby_ffi gem is optionally used to gather additional info about the GPU.  This can sometimes result in better model info.  
+
+There is some caution when using OpenCL.  If a GPU is dead, OpenCL tends to hang/freeze thus forcing a reboot.  This is not a bug in the compute_unit or opencl_ruby_ffi gem but in the OpenCL library instead.
+
+Getting data from OpenCL also takes a long time!  So if you have multiple GPUs in your system this could takes multiple seconds to return data.  Because of this we cache the responses for the next query.  This response is cached until the system checksum changes.  This checksum is a special calculate of all the devices present in the system.  So if you ever added or changed the equipment in the system, a new OpenCL query would ensue. 
+
+To enable OpenCL you just need to pass a boolean value to any of the find_all methods:
+
+```ruby
+require 'compute_unit'
+devices = ComputeUnit.find_all(true)
+
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -96,7 +205,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/logicm
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT.
 
 ## Code of Conduct
 

data/compute_unit.gemspec

@@ -13,9 +13,9 @@ Gem::Specification.new do |spec|
   spec.summary       = 'A ruby library for compute unit devices'
   spec.description   = <<~EOF
 
-    A ruby library that searches uses the linux sysfs file system for compute unit devices such as
-    CPUS, GPUs and other ASIC compute devices. Allows programmatic access collect real time metrics from the kernel or relatated driver toolchain.
-    Is meant to be used as a toolchain to future build tooling on. This library also makes use of opencl toolchain and requires
+    A ruby library that searches the linux sysfs file system for compute unit devices such as
+    CPUS, GPUs and other ASIC compute devices. Allows programmatic access to collect real time metrics from the kernel or relatated driver toolchain.
+    Is meant to be used as a toolchain for future tools. This library also makes use of opencl library and requires
     the opencl_ruby_ffi gem.
 
   EOF
@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/-/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -36,8 +36,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'opencl_ruby_ffi', '~> 1.3.0'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'opencl_ruby_ffi', '~> 1.3.4'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/compute_unit.rb

@@ -11,23 +11,36 @@ module ComputeUnit
   SYS_DEVICE_PATH = File.join(SYSFS_PATH, 'bus/pci/devices')
   PCI_DATABASE_PATH = File.join(File.dirname(__dir__), 'pci.ids')
   PCI_DATABASE_URL = 'http://pci-ids.ucw.cz/v2.2/pci.ids'
+  DEFAULT_PCIDB_PATH = '/usr/share/hwdata/pci.ids'
 
+  # @param use_opencl [Boolean]
+  # @return [Array] - return a list of compute units
   def self.find_all(use_opencl = false)
     require 'compute_unit/gpu'
     require 'compute_unit/cpu'
     require 'compute_unit/asic'
-    raise Exceptions::InvalidPCIDatabase.new('Run: ComputeUnit.refresh_pci_database') unless File.exist?(PCI_DATABASE_PATH)
+
+    copy_default_database unless File.exist?(PCI_DATABASE_PATH)
 
     ComputeUnit::Gpu.find_all(use_opencl) +
       ComputeUnit::Cpu.find_all +
       ComputeUnit::Asic.find_all
   end
 
+  # copies the default pci database from linux filesystem over to the gem path
+  def self.copy_default_database
+    FileUtils.cp(DEFAULT_PCIDB_PATH, PCI_DATABASE_PATH)
+  end
+
+  # get a fresh copy of the database and then use find_all
+  # @param use_opencl [Boolean]
+  # @return [Array] - return a list of compute units
   def self.find_all_with_database(use_opencl = false)
     refresh_pci_database
     find_all(use_opencl)
   end
 
+  # downloads the pci database
   def self.refresh_pci_database
     ComputeUnit::Utils.check_for_root
     require 'net/http'

data/lib/compute_unit/cpu.rb

@@ -7,6 +7,8 @@ module ComputeUnit
     DEVICE_CLASS = '060000'
     DEVICE_CLASS_NAME = 'CPU'
     # @return [Array] - returns a list of device paths of all devices considered for display
+    alias name model
+
     def self.devices
       ComputeUnit::ComputeBase.devices.find_all do |device|
         ComputeUnit::Device.device_class(device) == DEVICE_CLASS

data/lib/compute_unit/device.rb

@@ -10,7 +10,7 @@ module ComputeUnit
   class Device
     # We can supply a mock sysfs path in order to test with containers and other scenarios
     SYSFS_DEVICES_PATH = File.join(ComputeUnit::SYSFS_PATH, 'bus', 'pci', 'devices')
-
+    PROC_PATH = ENV['PROC_PATH'] || '/proc'
     attr_reader :device_class_id,
                 :device_id,
                 :device_vendor_id,
@@ -130,7 +130,7 @@ module ComputeUnit
     rescue Errno::EINVAL, Errno::EPERM
       default
     rescue Errno::ENOENT
-      logger.warn("File #{path} does not exist, using defaults")
+      logger.debug("File #{path} does not exist, using defaults")
       default
     rescue Errno::EACCES
       logger.fatal('run this command as root or with sudo, using default value')
@@ -140,9 +140,9 @@ module ComputeUnit
     # @param item [String] - the name of the hwmon file to read from
     # @param default [Object] - the default value to return if the file is empty or not readable
     # @return [String] - the value of the item looked up
-    def read_hwmon_data(item, _default = nil)
+    def read_hwmon_data(item, default = nil)
       path = File.join(hwmon_path, item)
-      read_file(path)
+      read_file(path, default)
     end
 
     # @param item [String] - the name of the hwmon file to write to
@@ -271,7 +271,7 @@ module ComputeUnit
                 logger.fatal(e.message)
                 default
               rescue Errno::ENOENT
-                logger.warn("File #{path} does not exist")
+                logger.debug("File #{path} does not exist")
                 default
               rescue Errno::EACCES
                 logger.fatal('Run this command as root or with sudo')

data/lib/compute_unit/gpus/nvidia_gpu.rb

@@ -8,6 +8,7 @@ module ComputeUnit
     MAKE = 'Nvidia'
     SUBTYPE = 'nvidia'
     NVIDIA_SMI = '/usr/bin/nvidia-smi'
+    NVIDIA_PROC_PATH = ENV['NVIDIA_PROC_PATH'] || File.join(ComputeUnit::Device::PROC_PATH, 'driver', 'nvidia', 'gpus')
 
     def initialize(device_path, opts = {})
       data = self.class.read_information_file(device_path).merge(opts)
@@ -159,7 +160,7 @@ module ComputeUnit
     def information_file
       @information_file ||= begin
         device_name = File.basename(device_path)
-        File.join('/proc/driver/nvidia/gpus', device_name, 'information')
+        File.join(NVIDIA_PROC_PATH, device_name, 'information')
       end
     end
 
@@ -209,7 +210,8 @@ module ComputeUnit
     #  :device_minor=>"7"}
     def self.read_information_file(device_path)
       device_name = File.basename(device_path)
-      information_file = "/proc/driver/nvidia/gpus/#{device_name}/information"
+      information_file = File.join(NVIDIA_PROC_PATH, device_name, 'information')
+
       File.open(information_file, 'r') do |file|
         content = file.read
         content.scan(/\n?([\w\s]*):\s+(.*)/).map { |key, value| [key.downcase.tr(' ', '_').to_sym, value] }.to_h

data/lib/compute_unit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compute_unit
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Corey Osman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opencl_ruby_ffi
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -68,9 +68,9 @@ dependencies:
         version: '3.0'
 description: |2+
 
-  A ruby library that searches uses the linux sysfs file system for compute unit devices such as
-  CPUS, GPUs and other ASIC compute devices. Allows programmatic access collect real time metrics from the kernel or relatated driver toolchain.
-  Is meant to be used as a toolchain to future build tooling on. This library also makes use of opencl toolchain and requires
+  A ruby library that searches the linux sysfs file system for compute unit devices such as
+  CPUS, GPUs and other ASIC compute devices. Allows programmatic access to collect real time metrics from the kernel or relatated driver toolchain.
+  Is meant to be used as a toolchain for future tools. This library also makes use of opencl library and requires
   the opencl_ruby_ffi gem.
 
 email:
@@ -119,7 +119,7 @@ licenses:
 metadata:
   homepage_uri: https://gitlab.com/blockops/compute_unit
   source_code_uri: https://gitlab.com/blockops/compute_unit
-  changelog_uri: https://gitlab.com/blockops/compute_unit/CHANGELOG
+  changelog_uri: https://gitlab.com/blockops/compute_unit/-/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: